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
class Config(object):
199
"""A configuration policy - what username, editor, gpg needs etc."""
202
super(Config, self).__init__()
205
"""Returns a unique ID for the config."""
206
raise NotImplementedError(self.config_id)
208
@deprecated_method(deprecated_in((2, 4, 0)))
209
def get_editor(self):
210
"""Get the users pop up editor."""
211
raise NotImplementedError
213
def get_change_editor(self, old_tree, new_tree):
214
from bzrlib import diff
215
cmd = self._get_change_editor()
218
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
221
def _get_signature_checking(self):
222
"""Template method to override signature checking policy."""
224
def _get_signing_policy(self):
225
"""Template method to override signature creation policy."""
229
def expand_options(self, string, env=None):
230
"""Expand option references in the string in the configuration context.
232
:param string: The string containing option to expand.
234
:param env: An option dict defining additional configuration options or
235
overriding existing ones.
237
:returns: The expanded string.
239
return self._expand_options_in_string(string, env)
241
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
242
"""Expand options in a list of strings in the configuration context.
244
:param slist: A list of strings.
246
:param env: An option dict defining additional configuration options or
247
overriding existing ones.
249
:param _ref_stack: Private list containing the options being
250
expanded to detect loops.
252
:returns: The flatten list of expanded strings.
254
# expand options in each value separately flattening lists
257
value = self._expand_options_in_string(s, env, _ref_stack)
258
if isinstance(value, list):
264
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
265
"""Expand options in the string in the configuration context.
267
:param string: The string to be expanded.
269
:param env: An option dict defining additional configuration options or
270
overriding existing ones.
272
:param _ref_stack: Private list containing the options being
273
expanded to detect loops.
275
:returns: The expanded string.
278
# Not much to expand there
280
if _ref_stack is None:
281
# What references are currently resolved (to detect loops)
283
if self.option_ref_re is None:
284
# We want to match the most embedded reference first (i.e. for
285
# '{{foo}}' we will get '{foo}',
286
# for '{bar{baz}}' we will get '{baz}'
287
self.option_ref_re = re.compile('({[^{}]+})')
289
# We need to iterate until no more refs appear ({{foo}} will need two
290
# iterations for example).
292
raw_chunks = self.option_ref_re.split(result)
293
if len(raw_chunks) == 1:
294
# Shorcut the trivial case: no refs
298
# Split will isolate refs so that every other chunk is a ref
300
for chunk in raw_chunks:
303
# Keep only non-empty strings (or we get bogus empty
304
# slots when a list value is involved).
309
if name in _ref_stack:
310
raise errors.OptionExpansionLoop(string, _ref_stack)
311
_ref_stack.append(name)
312
value = self._expand_option(name, env, _ref_stack)
314
raise errors.ExpandingUnknownOption(name, string)
315
if isinstance(value, list):
323
# Once a list appears as the result of an expansion, all
324
# callers will get a list result. This allows a consistent
325
# behavior even when some options in the expansion chain
326
# defined as strings (no comma in their value) but their
327
# expanded value is a list.
328
return self._expand_options_in_list(chunks, env, _ref_stack)
330
result = ''.join(chunks)
333
def _expand_option(self, name, env, _ref_stack):
334
if env is not None and name in env:
335
# Special case, values provided in env takes precedence over
339
# FIXME: This is a limited implementation, what we really need is a
340
# way to query the bzr config for the value of an option,
341
# respecting the scope rules (That is, once we implement fallback
342
# configs, getting the option value should restart from the top
343
# config, not the current one) -- vila 20101222
344
value = self.get_user_option(name, expand=False)
345
if isinstance(value, list):
346
value = self._expand_options_in_list(value, env, _ref_stack)
348
value = self._expand_options_in_string(value, env, _ref_stack)
351
def _get_user_option(self, option_name):
352
"""Template method to provide a user option."""
355
def get_user_option(self, option_name, expand=True):
356
"""Get a generic option - no special process, no default.
358
:param option_name: The queried option.
360
:param expand: Whether options references should be expanded.
362
:returns: The value of the option.
364
value = self._get_user_option(option_name)
366
if isinstance(value, list):
367
value = self._expand_options_in_list(value)
368
elif isinstance(value, dict):
369
trace.warning('Cannot expand "%s":'
370
' Dicts do not support option expansion'
373
value = self._expand_options_in_string(value)
374
for hook in OldConfigHooks['get']:
375
hook(self, option_name, value)
378
def get_user_option_as_bool(self, option_name, expand=None, default=None):
379
"""Get a generic option as a boolean.
381
:param expand: Allow expanding references to other config values.
382
:param default: Default value if nothing is configured
383
:return None if the option doesn't exist or its value can't be
384
interpreted as a boolean. Returns True or False otherwise.
386
s = self.get_user_option(option_name, expand=expand)
388
# The option doesn't exist
390
val = ui.bool_from_string(s)
392
# The value can't be interpreted as a boolean
393
trace.warning('Value "%s" is not a boolean for "%s"',
397
def get_user_option_as_list(self, option_name, expand=None):
398
"""Get a generic option as a list - no special process, no default.
400
:return None if the option doesn't exist. Returns the value as a list
403
l = self.get_user_option(option_name, expand=expand)
404
if isinstance(l, (str, unicode)):
405
# A single value, most probably the user forgot (or didn't care to
410
@deprecated_method(deprecated_in((2, 5, 0)))
411
def get_user_option_as_int_from_SI(self, option_name, default=None):
412
"""Get a generic option from a human readable size in SI units, e.g 10MB
414
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
415
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
418
:return Integer, expanded to its base-10 value if a proper SI unit is
419
found. If the option doesn't exist, or isn't a value in
420
SI units, return default (which defaults to None)
422
val = self.get_user_option(option_name)
423
if isinstance(val, list):
428
p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
432
val = int(m.group(1))
433
if m.group(2) is not None:
434
if m.group(2).lower() == 'k':
436
elif m.group(2).lower() == 'm':
438
elif m.group(2).lower() == 'g':
441
ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
442
' value {1!r} is not an SI unit.').format(
449
@deprecated_method(deprecated_in((2, 5, 0)))
450
def gpg_signing_command(self):
451
"""What program should be used to sign signatures?"""
452
result = self._gpg_signing_command()
457
def _gpg_signing_command(self):
458
"""See gpg_signing_command()."""
461
@deprecated_method(deprecated_in((2, 5, 0)))
462
def log_format(self):
463
"""What log format should be used"""
464
result = self._log_format()
469
def _log_format(self):
470
"""See log_format()."""
473
def validate_signatures_in_log(self):
474
"""Show GPG signature validity in log"""
475
result = self._validate_signatures_in_log()
482
def _validate_signatures_in_log(self):
483
"""See validate_signatures_in_log()."""
486
@deprecated_method(deprecated_in((2, 5, 0)))
487
def acceptable_keys(self):
488
"""Comma separated list of key patterns acceptable to
489
verify-signatures command"""
490
result = self._acceptable_keys()
493
def _acceptable_keys(self):
494
"""See acceptable_keys()."""
497
@deprecated_method(deprecated_in((2, 5, 0)))
498
def post_commit(self):
499
"""An ordered list of python functions to call.
501
Each function takes branch, rev_id as parameters.
503
return self._post_commit()
505
def _post_commit(self):
506
"""See Config.post_commit."""
509
def user_email(self):
510
"""Return just the email component of a username."""
511
return extract_email_address(self.username())
514
"""Return email-style username.
516
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
518
$BZR_EMAIL can be set to override this, then
519
the concrete policy type is checked, and finally
521
If no username can be found, errors.NoWhoami exception is raised.
523
v = os.environ.get('BZR_EMAIL')
525
return v.decode(osutils.get_user_encoding())
526
v = self._get_user_id()
529
return default_email()
531
def ensure_username(self):
532
"""Raise errors.NoWhoami if username is not set.
534
This method relies on the username() function raising the error.
538
@deprecated_method(deprecated_in((2, 5, 0)))
539
def signature_checking(self):
540
"""What is the current policy for signature checking?."""
541
policy = self._get_signature_checking()
542
if policy is not None:
544
return CHECK_IF_POSSIBLE
546
@deprecated_method(deprecated_in((2, 5, 0)))
547
def signing_policy(self):
548
"""What is the current policy for signature checking?."""
549
policy = self._get_signing_policy()
550
if policy is not None:
552
return SIGN_WHEN_REQUIRED
554
@deprecated_method(deprecated_in((2, 5, 0)))
555
def signature_needed(self):
556
"""Is a signature needed when committing ?."""
557
policy = self._get_signing_policy()
559
policy = self._get_signature_checking()
560
if policy is not None:
561
#this warning should go away once check_signatures is
562
#implemented (if not before)
563
trace.warning("Please use create_signatures,"
564
" not check_signatures to set signing policy.")
565
elif policy == SIGN_ALWAYS:
569
@deprecated_method(deprecated_in((2, 5, 0)))
570
def gpg_signing_key(self):
571
"""GPG user-id to sign commits"""
572
key = self.get_user_option('gpg_signing_key')
573
if key == "default" or key == None:
574
return self.user_email()
578
def get_alias(self, value):
579
return self._get_alias(value)
581
def _get_alias(self, value):
584
def get_nickname(self):
585
return self._get_nickname()
587
def _get_nickname(self):
590
def get_bzr_remote_path(self):
592
return os.environ['BZR_REMOTE_PATH']
594
path = self.get_user_option("bzr_remote_path")
599
def suppress_warning(self, warning):
600
"""Should the warning be suppressed or emitted.
602
:param warning: The name of the warning being tested.
604
:returns: True if the warning should be suppressed, False otherwise.
606
warnings = self.get_user_option_as_list('suppress_warnings')
607
if warnings is None or warning not in warnings:
612
def get_merge_tools(self):
614
for (oname, value, section, conf_id, parser) in self._get_options():
615
if oname.startswith('bzr.mergetool.'):
616
tool_name = oname[len('bzr.mergetool.'):]
617
tools[tool_name] = self.get_user_option(oname, False)
618
trace.mutter('loaded merge tools: %r' % tools)
621
def find_merge_tool(self, name):
622
# We fake a defaults mechanism here by checking if the given name can
623
# be found in the known_merge_tools if it's not found in the config.
624
# This should be done through the proposed config defaults mechanism
625
# when it becomes available in the future.
626
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
628
or mergetools.known_merge_tools.get(name, None))
632
class _ConfigHooks(hooks.Hooks):
633
"""A dict mapping hook names and a list of callables for configs.
637
"""Create the default hooks.
639
These are all empty initially, because by default nothing should get
642
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
643
self.add_hook('load',
644
'Invoked when a config store is loaded.'
645
' The signature is (store).',
647
self.add_hook('save',
648
'Invoked when a config store is saved.'
649
' The signature is (store).',
651
# The hooks for config options
653
'Invoked when a config option is read.'
654
' The signature is (stack, name, value).',
657
'Invoked when a config option is set.'
658
' The signature is (stack, name, value).',
660
self.add_hook('remove',
661
'Invoked when a config option is removed.'
662
' The signature is (stack, name).',
664
ConfigHooks = _ConfigHooks()
667
class _OldConfigHooks(hooks.Hooks):
668
"""A dict mapping hook names and a list of callables for configs.
672
"""Create the default hooks.
674
These are all empty initially, because by default nothing should get
677
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
678
self.add_hook('load',
679
'Invoked when a config store is loaded.'
680
' The signature is (config).',
682
self.add_hook('save',
683
'Invoked when a config store is saved.'
684
' The signature is (config).',
686
# The hooks for config options
688
'Invoked when a config option is read.'
689
' The signature is (config, name, value).',
692
'Invoked when a config option is set.'
693
' The signature is (config, name, value).',
695
self.add_hook('remove',
696
'Invoked when a config option is removed.'
697
' The signature is (config, name).',
699
OldConfigHooks = _OldConfigHooks()
702
class IniBasedConfig(Config):
703
"""A configuration policy that draws from ini files."""
705
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
707
"""Base class for configuration files using an ini-like syntax.
709
:param file_name: The configuration file path.
711
super(IniBasedConfig, self).__init__()
712
self.file_name = file_name
713
if symbol_versioning.deprecated_passed(get_filename):
714
symbol_versioning.warn(
715
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
716
' Use file_name instead.',
719
if get_filename is not None:
720
self.file_name = get_filename()
722
self.file_name = file_name
727
def from_string(cls, str_or_unicode, file_name=None, save=False):
728
"""Create a config object from a string.
730
:param str_or_unicode: A string representing the file content. This will
733
:param file_name: The configuration file path.
735
:param _save: Whether the file should be saved upon creation.
737
conf = cls(file_name=file_name)
738
conf._create_from_string(str_or_unicode, save)
741
def _create_from_string(self, str_or_unicode, save):
742
self._content = StringIO(str_or_unicode.encode('utf-8'))
743
# Some tests use in-memory configs, some other always need the config
744
# file to exist on disk.
746
self._write_config_file()
748
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
749
if self._parser is not None:
751
if symbol_versioning.deprecated_passed(file):
752
symbol_versioning.warn(
753
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
754
' Use IniBasedConfig(_content=xxx) instead.',
757
if self._content is not None:
758
co_input = self._content
759
elif self.file_name is None:
760
raise AssertionError('We have no content to create the config')
762
co_input = self.file_name
764
self._parser = ConfigObj(co_input, encoding='utf-8')
765
except configobj.ConfigObjError, e:
766
raise errors.ParseConfigError(e.errors, e.config.filename)
767
except UnicodeDecodeError:
768
raise errors.ConfigContentError(self.file_name)
769
# Make sure self.reload() will use the right file name
770
self._parser.filename = self.file_name
771
for hook in OldConfigHooks['load']:
776
"""Reload the config file from disk."""
777
if self.file_name is None:
778
raise AssertionError('We need a file name to reload the config')
779
if self._parser is not None:
780
self._parser.reload()
781
for hook in ConfigHooks['load']:
784
def _get_matching_sections(self):
785
"""Return an ordered list of (section_name, extra_path) pairs.
787
If the section contains inherited configuration, extra_path is
788
a string containing the additional path components.
790
section = self._get_section()
791
if section is not None:
792
return [(section, '')]
796
def _get_section(self):
797
"""Override this to define the section used by the config."""
800
def _get_sections(self, name=None):
801
"""Returns an iterator of the sections specified by ``name``.
803
:param name: The section name. If None is supplied, the default
804
configurations are yielded.
806
:return: A tuple (name, section, config_id) for all sections that will
807
be walked by user_get_option() in the 'right' order. The first one
808
is where set_user_option() will update the value.
810
parser = self._get_parser()
812
yield (name, parser[name], self.config_id())
814
# No section name has been given so we fallback to the configobj
815
# itself which holds the variables defined outside of any section.
816
yield (None, parser, self.config_id())
818
def _get_options(self, sections=None):
819
"""Return an ordered list of (name, value, section, config_id) tuples.
821
All options are returned with their associated value and the section
822
they appeared in. ``config_id`` is a unique identifier for the
823
configuration file the option is defined in.
825
:param sections: Default to ``_get_matching_sections`` if not
826
specified. This gives a better control to daughter classes about
827
which sections should be searched. This is a list of (name,
832
parser = self._get_parser()
834
for (section_name, _) in self._get_matching_sections():
836
section = parser[section_name]
838
# This could happen for an empty file for which we define a
839
# DEFAULT section. FIXME: Force callers to provide sections
840
# instead ? -- vila 20100930
842
sections.append((section_name, section))
843
config_id = self.config_id()
844
for (section_name, section) in sections:
845
for (name, value) in section.iteritems():
846
yield (name, parser._quote(value), section_name,
849
def _get_option_policy(self, section, option_name):
850
"""Return the policy for the given (section, option_name) pair."""
853
def _get_change_editor(self):
854
return self.get_user_option('change_editor')
856
def _get_signature_checking(self):
857
"""See Config._get_signature_checking."""
858
policy = self._get_user_option('check_signatures')
860
return signature_policy_from_unicode(policy)
862
def _get_signing_policy(self):
863
"""See Config._get_signing_policy"""
864
policy = self._get_user_option('create_signatures')
866
return signing_policy_from_unicode(policy)
868
def _get_user_id(self):
869
"""Get the user id from the 'email' key in the current section."""
870
return self._get_user_option('email')
872
def _get_user_option(self, option_name):
873
"""See Config._get_user_option."""
874
for (section, extra_path) in self._get_matching_sections():
876
value = self._get_parser().get_value(section, option_name)
879
policy = self._get_option_policy(section, option_name)
880
if policy == POLICY_NONE:
882
elif policy == POLICY_NORECURSE:
883
# norecurse items only apply to the exact path
888
elif policy == POLICY_APPENDPATH:
890
value = urlutils.join(value, extra_path)
893
raise AssertionError('Unexpected config policy %r' % policy)
897
def _gpg_signing_command(self):
898
"""See Config.gpg_signing_command."""
899
return self._get_user_option('gpg_signing_command')
901
def _log_format(self):
902
"""See Config.log_format."""
903
return self._get_user_option('log_format')
905
def _validate_signatures_in_log(self):
906
"""See Config.validate_signatures_in_log."""
907
return self._get_user_option('validate_signatures_in_log')
909
def _acceptable_keys(self):
910
"""See Config.acceptable_keys."""
911
return self._get_user_option('acceptable_keys')
913
def _post_commit(self):
914
"""See Config.post_commit."""
915
return self._get_user_option('post_commit')
917
def _get_alias(self, value):
919
return self._get_parser().get_value("ALIASES",
924
def _get_nickname(self):
925
return self.get_user_option('nickname')
927
def remove_user_option(self, option_name, section_name=None):
928
"""Remove a user option and save the configuration file.
930
:param option_name: The option to be removed.
932
:param section_name: The section the option is defined in, default to
936
parser = self._get_parser()
937
if section_name is None:
940
section = parser[section_name]
942
del section[option_name]
944
raise errors.NoSuchConfigOption(option_name)
945
self._write_config_file()
946
for hook in OldConfigHooks['remove']:
947
hook(self, option_name)
949
def _write_config_file(self):
950
if self.file_name is None:
951
raise AssertionError('We cannot save, self.file_name is None')
952
conf_dir = os.path.dirname(self.file_name)
953
ensure_config_dir_exists(conf_dir)
954
atomic_file = atomicfile.AtomicFile(self.file_name)
955
self._get_parser().write(atomic_file)
958
osutils.copy_ownership_from_path(self.file_name)
959
for hook in OldConfigHooks['save']:
963
class LockableConfig(IniBasedConfig):
964
"""A configuration needing explicit locking for access.
966
If several processes try to write the config file, the accesses need to be
969
Daughter classes should decorate all methods that update a config with the
970
``@needs_write_lock`` decorator (they call, directly or indirectly, the
971
``_write_config_file()`` method. These methods (typically ``set_option()``
972
and variants must reload the config file from disk before calling
973
``_write_config_file()``), this can be achieved by calling the
974
``self.reload()`` method. Note that the lock scope should cover both the
975
reading and the writing of the config file which is why the decorator can't
976
be applied to ``_write_config_file()`` only.
978
This should be enough to implement the following logic:
979
- lock for exclusive write access,
980
- reload the config file from disk,
984
This logic guarantees that a writer can update a value without erasing an
985
update made by another writer.
990
def __init__(self, file_name):
991
super(LockableConfig, self).__init__(file_name=file_name)
992
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
993
# FIXME: It doesn't matter that we don't provide possible_transports
994
# below since this is currently used only for local config files ;
995
# local transports are not shared. But if/when we start using
996
# LockableConfig for other kind of transports, we will need to reuse
997
# whatever connection is already established -- vila 20100929
998
self.transport = transport.get_transport_from_path(self.dir)
999
self._lock = lockdir.LockDir(self.transport, self.lock_name)
1001
def _create_from_string(self, unicode_bytes, save):
1002
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
1004
# We need to handle the saving here (as opposed to IniBasedConfig)
1005
# to be able to lock
1007
self._write_config_file()
1010
def lock_write(self, token=None):
1011
"""Takes a write lock in the directory containing the config file.
1013
If the directory doesn't exist it is created.
1015
ensure_config_dir_exists(self.dir)
1016
return self._lock.lock_write(token)
1021
def break_lock(self):
1022
self._lock.break_lock()
1025
def remove_user_option(self, option_name, section_name=None):
1026
super(LockableConfig, self).remove_user_option(option_name,
1029
def _write_config_file(self):
1030
if self._lock is None or not self._lock.is_held:
1031
# NB: if the following exception is raised it probably means a
1032
# missing @needs_write_lock decorator on one of the callers.
1033
raise errors.ObjectNotLocked(self)
1034
super(LockableConfig, self)._write_config_file()
1037
class GlobalConfig(LockableConfig):
1038
"""The configuration that should be used for a specific location."""
1041
super(GlobalConfig, self).__init__(file_name=config_filename())
1043
def config_id(self):
1047
def from_string(cls, str_or_unicode, save=False):
1048
"""Create a config object from a string.
1050
:param str_or_unicode: A string representing the file content. This
1051
will be utf-8 encoded.
1053
:param save: Whether the file should be saved upon creation.
1056
conf._create_from_string(str_or_unicode, save)
1059
@deprecated_method(deprecated_in((2, 4, 0)))
1060
def get_editor(self):
1061
return self._get_user_option('editor')
1064
def set_user_option(self, option, value):
1065
"""Save option and its value in the configuration."""
1066
self._set_option(option, value, 'DEFAULT')
1068
def get_aliases(self):
1069
"""Return the aliases section."""
1070
if 'ALIASES' in self._get_parser():
1071
return self._get_parser()['ALIASES']
1076
def set_alias(self, alias_name, alias_command):
1077
"""Save the alias in the configuration."""
1078
self._set_option(alias_name, alias_command, 'ALIASES')
1081
def unset_alias(self, alias_name):
1082
"""Unset an existing alias."""
1084
aliases = self._get_parser().get('ALIASES')
1085
if not aliases or alias_name not in aliases:
1086
raise errors.NoSuchAlias(alias_name)
1087
del aliases[alias_name]
1088
self._write_config_file()
1090
def _set_option(self, option, value, section):
1092
self._get_parser().setdefault(section, {})[option] = value
1093
self._write_config_file()
1094
for hook in OldConfigHooks['set']:
1095
hook(self, option, value)
1097
def _get_sections(self, name=None):
1098
"""See IniBasedConfig._get_sections()."""
1099
parser = self._get_parser()
1100
# We don't give access to options defined outside of any section, we
1101
# used the DEFAULT section by... default.
1102
if name in (None, 'DEFAULT'):
1103
# This could happen for an empty file where the DEFAULT section
1104
# doesn't exist yet. So we force DEFAULT when yielding
1106
if 'DEFAULT' not in parser:
1107
parser['DEFAULT']= {}
1108
yield (name, parser[name], self.config_id())
1111
def remove_user_option(self, option_name, section_name=None):
1112
if section_name is None:
1113
# We need to force the default section.
1114
section_name = 'DEFAULT'
1115
# We need to avoid the LockableConfig implementation or we'll lock
1117
super(LockableConfig, self).remove_user_option(option_name,
1120
def _iter_for_location_by_parts(sections, location):
1121
"""Keep only the sessions matching the specified location.
1123
:param sections: An iterable of section names.
1125
:param location: An url or a local path to match against.
1127
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1128
number of path components in the section name, section is the section
1129
name and extra_path is the difference between location and the section
1132
``location`` will always be a local path and never a 'file://' url but the
1133
section names themselves can be in either form.
1135
location_parts = location.rstrip('/').split('/')
1137
for section in sections:
1138
# location is a local path if possible, so we need to convert 'file://'
1139
# urls in section names to local paths if necessary.
1141
# This also avoids having file:///path be a more exact
1142
# match than '/path'.
1144
# FIXME: This still raises an issue if a user defines both file:///path
1145
# *and* /path. Should we raise an error in this case -- vila 20110505
1147
if section.startswith('file://'):
1148
section_path = urlutils.local_path_from_url(section)
1150
section_path = section
1151
section_parts = section_path.rstrip('/').split('/')
1154
if len(section_parts) > len(location_parts):
1155
# More path components in the section, they can't match
1158
# Rely on zip truncating in length to the length of the shortest
1159
# argument sequence.
1160
names = zip(location_parts, section_parts)
1162
if not fnmatch.fnmatch(name[0], name[1]):
1167
# build the path difference between the section and the location
1168
extra_path = '/'.join(location_parts[len(section_parts):])
1169
yield section, extra_path, len(section_parts)
1172
class LocationConfig(LockableConfig):
1173
"""A configuration object that gives the policy for a location."""
1175
def __init__(self, location):
1176
super(LocationConfig, self).__init__(
1177
file_name=locations_config_filename())
1178
# local file locations are looked up by local path, rather than
1179
# by file url. This is because the config file is a user
1180
# file, and we would rather not expose the user to file urls.
1181
if location.startswith('file://'):
1182
location = urlutils.local_path_from_url(location)
1183
self.location = location
1185
def config_id(self):
1189
def from_string(cls, str_or_unicode, location, save=False):
1190
"""Create a config object from a string.
1192
:param str_or_unicode: A string representing the file content. This will
1195
:param location: The location url to filter the configuration.
1197
:param save: Whether the file should be saved upon creation.
1199
conf = cls(location)
1200
conf._create_from_string(str_or_unicode, save)
1203
def _get_matching_sections(self):
1204
"""Return an ordered list of section names matching this location."""
1205
matches = list(_iter_for_location_by_parts(self._get_parser(),
1207
# put the longest (aka more specific) locations first
1209
key=lambda (section, extra_path, length): (length, section),
1211
for (section, extra_path, length) in matches:
1212
yield section, extra_path
1213
# should we stop looking for parent configs here?
1215
if self._get_parser()[section].as_bool('ignore_parents'):
1220
def _get_sections(self, name=None):
1221
"""See IniBasedConfig._get_sections()."""
1222
# We ignore the name here as the only sections handled are named with
1223
# the location path and we don't expose embedded sections either.
1224
parser = self._get_parser()
1225
for name, extra_path in self._get_matching_sections():
1226
yield (name, parser[name], self.config_id())
1228
def _get_option_policy(self, section, option_name):
1229
"""Return the policy for the given (section, option_name) pair."""
1230
# check for the old 'recurse=False' flag
1232
recurse = self._get_parser()[section].as_bool('recurse')
1236
return POLICY_NORECURSE
1238
policy_key = option_name + ':policy'
1240
policy_name = self._get_parser()[section][policy_key]
1244
return _policy_value[policy_name]
1246
def _set_option_policy(self, section, option_name, option_policy):
1247
"""Set the policy for the given option name in the given section."""
1248
# The old recurse=False option affects all options in the
1249
# section. To handle multiple policies in the section, we
1250
# need to convert it to a policy_norecurse key.
1252
recurse = self._get_parser()[section].as_bool('recurse')
1256
symbol_versioning.warn(
1257
'The recurse option is deprecated as of 0.14. '
1258
'The section "%s" has been converted to use policies.'
1261
del self._get_parser()[section]['recurse']
1263
for key in self._get_parser()[section].keys():
1264
if not key.endswith(':policy'):
1265
self._get_parser()[section][key +
1266
':policy'] = 'norecurse'
1268
policy_key = option_name + ':policy'
1269
policy_name = _policy_name[option_policy]
1270
if policy_name is not None:
1271
self._get_parser()[section][policy_key] = policy_name
1273
if policy_key in self._get_parser()[section]:
1274
del self._get_parser()[section][policy_key]
1277
def set_user_option(self, option, value, store=STORE_LOCATION):
1278
"""Save option and its value in the configuration."""
1279
if store not in [STORE_LOCATION,
1280
STORE_LOCATION_NORECURSE,
1281
STORE_LOCATION_APPENDPATH]:
1282
raise ValueError('bad storage policy %r for %r' %
1285
location = self.location
1286
if location.endswith('/'):
1287
location = location[:-1]
1288
parser = self._get_parser()
1289
if not location in parser and not location + '/' in parser:
1290
parser[location] = {}
1291
elif location + '/' in parser:
1292
location = location + '/'
1293
parser[location][option]=value
1294
# the allowed values of store match the config policies
1295
self._set_option_policy(location, option, store)
1296
self._write_config_file()
1297
for hook in OldConfigHooks['set']:
1298
hook(self, option, value)
1301
class BranchConfig(Config):
1302
"""A configuration object giving the policy for a branch."""
1304
def __init__(self, branch):
1305
super(BranchConfig, self).__init__()
1306
self._location_config = None
1307
self._branch_data_config = None
1308
self._global_config = None
1309
self.branch = branch
1310
self.option_sources = (self._get_location_config,
1311
self._get_branch_data_config,
1312
self._get_global_config)
1314
def config_id(self):
1317
def _get_branch_data_config(self):
1318
if self._branch_data_config is None:
1319
self._branch_data_config = TreeConfig(self.branch)
1320
self._branch_data_config.config_id = self.config_id
1321
return self._branch_data_config
1323
def _get_location_config(self):
1324
if self._location_config is None:
1325
self._location_config = LocationConfig(self.branch.base)
1326
return self._location_config
1328
def _get_global_config(self):
1329
if self._global_config is None:
1330
self._global_config = GlobalConfig()
1331
return self._global_config
1333
def _get_best_value(self, option_name):
1334
"""This returns a user option from local, tree or global config.
1336
They are tried in that order. Use get_safe_value if trusted values
1339
for source in self.option_sources:
1340
value = getattr(source(), option_name)()
1341
if value is not None:
1345
def _get_safe_value(self, option_name):
1346
"""This variant of get_best_value never returns untrusted values.
1348
It does not return values from the branch data, because the branch may
1349
not be controlled by the user.
1351
We may wish to allow locations.conf to control whether branches are
1352
trusted in the future.
1354
for source in (self._get_location_config, self._get_global_config):
1355
value = getattr(source(), option_name)()
1356
if value is not None:
1360
def _get_user_id(self):
1361
"""Return the full user id for the branch.
1363
e.g. "John Hacker <jhacker@example.com>"
1364
This is looked up in the email controlfile for the branch.
1366
return self._get_best_value('_get_user_id')
1368
def _get_change_editor(self):
1369
return self._get_best_value('_get_change_editor')
1371
def _get_signature_checking(self):
1372
"""See Config._get_signature_checking."""
1373
return self._get_best_value('_get_signature_checking')
1375
def _get_signing_policy(self):
1376
"""See Config._get_signing_policy."""
1377
return self._get_best_value('_get_signing_policy')
1379
def _get_user_option(self, option_name):
1380
"""See Config._get_user_option."""
1381
for source in self.option_sources:
1382
value = source()._get_user_option(option_name)
1383
if value is not None:
1387
def _get_sections(self, name=None):
1388
"""See IniBasedConfig.get_sections()."""
1389
for source in self.option_sources:
1390
for section in source()._get_sections(name):
1393
def _get_options(self, sections=None):
1395
# First the locations options
1396
for option in self._get_location_config()._get_options():
1398
# Then the branch options
1399
branch_config = self._get_branch_data_config()
1400
if sections is None:
1401
sections = [('DEFAULT', branch_config._get_parser())]
1402
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1403
# Config itself has no notion of sections :( -- vila 20101001
1404
config_id = self.config_id()
1405
for (section_name, section) in sections:
1406
for (name, value) in section.iteritems():
1407
yield (name, value, section_name,
1408
config_id, branch_config._get_parser())
1409
# Then the global options
1410
for option in self._get_global_config()._get_options():
1413
def set_user_option(self, name, value, store=STORE_BRANCH,
1415
if store == STORE_BRANCH:
1416
self._get_branch_data_config().set_option(value, name)
1417
elif store == STORE_GLOBAL:
1418
self._get_global_config().set_user_option(name, value)
1420
self._get_location_config().set_user_option(name, value, store)
1423
if store in (STORE_GLOBAL, STORE_BRANCH):
1424
mask_value = self._get_location_config().get_user_option(name)
1425
if mask_value is not None:
1426
trace.warning('Value "%s" is masked by "%s" from'
1427
' locations.conf', value, mask_value)
1429
if store == STORE_GLOBAL:
1430
branch_config = self._get_branch_data_config()
1431
mask_value = branch_config.get_user_option(name)
1432
if mask_value is not None:
1433
trace.warning('Value "%s" is masked by "%s" from'
1434
' branch.conf', value, mask_value)
1436
def remove_user_option(self, option_name, section_name=None):
1437
self._get_branch_data_config().remove_option(option_name, section_name)
1439
def _gpg_signing_command(self):
1440
"""See Config.gpg_signing_command."""
1441
return self._get_safe_value('_gpg_signing_command')
1443
def _post_commit(self):
1444
"""See Config.post_commit."""
1445
return self._get_safe_value('_post_commit')
1447
def _get_nickname(self):
1448
value = self._get_explicit_nickname()
1449
if value is not None:
1451
if self.branch.name:
1452
return self.branch.name
1453
return urlutils.unescape(self.branch.base.split('/')[-2])
1455
def has_explicit_nickname(self):
1456
"""Return true if a nickname has been explicitly assigned."""
1457
return self._get_explicit_nickname() is not None
1459
def _get_explicit_nickname(self):
1460
return self._get_best_value('_get_nickname')
1462
def _log_format(self):
1463
"""See Config.log_format."""
1464
return self._get_best_value('_log_format')
1466
def _validate_signatures_in_log(self):
1467
"""See Config.validate_signatures_in_log."""
1468
return self._get_best_value('_validate_signatures_in_log')
1470
def _acceptable_keys(self):
1471
"""See Config.acceptable_keys."""
1472
return self._get_best_value('_acceptable_keys')
1475
def ensure_config_dir_exists(path=None):
1476
"""Make sure a configuration directory exists.
1477
This makes sure that the directory exists.
1478
On windows, since configuration directories are 2 levels deep,
1479
it makes sure both the directory and the parent directory exists.
1483
if not os.path.isdir(path):
1484
if sys.platform == 'win32':
1485
parent_dir = os.path.dirname(path)
1486
if not os.path.isdir(parent_dir):
1487
trace.mutter('creating config parent directory: %r', parent_dir)
1488
os.mkdir(parent_dir)
1489
trace.mutter('creating config directory: %r', path)
1491
osutils.copy_ownership_from_path(path)
1495
"""Return per-user configuration directory as unicode string
1497
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1498
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1499
that will be used instead.
1501
TODO: Global option --config-dir to override this.
1503
base = osutils.path_from_environ('BZR_HOME')
1504
if sys.platform == 'win32':
1506
base = win32utils.get_appdata_location()
1508
base = win32utils.get_home_location()
1509
# GZ 2012-02-01: Really the two level subdirs only make sense inside
1510
# APPDATA, but hard to move. See bug 348640 for more.
1511
return osutils.pathjoin(base, 'bazaar', '2.0')
1513
# GZ 2012-02-01: What should OSX use instead of XDG if anything?
1514
if sys.platform != 'darwin':
1515
xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
1517
xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
1518
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1519
if osutils.isdir(xdg_dir):
1521
"Using configuration in XDG directory %s." % xdg_dir)
1523
base = osutils._get_home_dir()
1524
return osutils.pathjoin(base, ".bazaar")
1527
def config_filename():
1528
"""Return per-user configuration ini file filename."""
1529
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1532
def locations_config_filename():
1533
"""Return per-user configuration ini file filename."""
1534
return osutils.pathjoin(config_dir(), 'locations.conf')
1537
def authentication_config_filename():
1538
"""Return per-user authentication ini file filename."""
1539
return osutils.pathjoin(config_dir(), 'authentication.conf')
1542
def user_ignore_config_filename():
1543
"""Return the user default ignore filename"""
1544
return osutils.pathjoin(config_dir(), 'ignore')
1548
"""Return the directory name to store crash files.
1550
This doesn't implicitly create it.
1552
On Windows it's in the config directory; elsewhere it's /var/crash
1553
which may be monitored by apport. It can be overridden by
1556
if sys.platform == 'win32':
1557
return osutils.pathjoin(config_dir(), 'Crash')
1559
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1561
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1564
def xdg_cache_dir():
1565
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1566
# Possibly this should be different on Windows?
1567
e = os.environ.get('XDG_CACHE_DIR', None)
1571
return os.path.expanduser('~/.cache')
1574
def _get_default_mail_domain():
1575
"""If possible, return the assumed default email domain.
1577
:returns: string mail domain, or None.
1579
if sys.platform == 'win32':
1580
# No implementation yet; patches welcome
1583
f = open('/etc/mailname')
1584
except (IOError, OSError), e:
1587
domain = f.read().strip()
1593
def default_email():
1594
v = os.environ.get('BZR_EMAIL')
1596
return v.decode(osutils.get_user_encoding())
1597
v = os.environ.get('EMAIL')
1599
return v.decode(osutils.get_user_encoding())
1600
name, email = _auto_user_id()
1602
return u'%s <%s>' % (name, email)
1605
raise errors.NoWhoami()
1608
def _auto_user_id():
1609
"""Calculate automatic user identification.
1611
:returns: (realname, email), either of which may be None if they can't be
1614
Only used when none is set in the environment or the id file.
1616
This only returns an email address if we can be fairly sure the
1617
address is reasonable, ie if /etc/mailname is set on unix.
1619
This doesn't use the FQDN as the default domain because that may be
1620
slow, and it doesn't use the hostname alone because that's not normally
1621
a reasonable address.
1623
if sys.platform == 'win32':
1624
# No implementation to reliably determine Windows default mail
1625
# address; please add one.
1628
default_mail_domain = _get_default_mail_domain()
1629
if not default_mail_domain:
1635
w = pwd.getpwuid(uid)
1637
trace.mutter('no passwd entry for uid %d?' % uid)
1640
# we try utf-8 first, because on many variants (like Linux),
1641
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1642
# false positives. (many users will have their user encoding set to
1643
# latin-1, which cannot raise UnicodeError.)
1645
gecos = w.pw_gecos.decode('utf-8')
1647
except UnicodeError:
1649
encoding = osutils.get_user_encoding()
1650
gecos = w.pw_gecos.decode(encoding)
1651
except UnicodeError, e:
1652
trace.mutter("cannot decode passwd entry %s" % w)
1655
username = w.pw_name.decode(encoding)
1656
except UnicodeError, e:
1657
trace.mutter("cannot decode passwd entry %s" % w)
1660
comma = gecos.find(',')
1664
realname = gecos[:comma]
1666
return realname, (username + '@' + default_mail_domain)
1669
def parse_username(username):
1670
"""Parse e-mail username and return a (name, address) tuple."""
1671
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1673
return (username, '')
1675
return (match.group(1), match.group(2))
1678
def extract_email_address(e):
1679
"""Return just the address part of an email string.
1681
That is just the user@domain part, nothing else.
1682
This part is required to contain only ascii characters.
1683
If it can't be extracted, raises an error.
1685
>>> extract_email_address('Jane Tester <jane@test.com>')
1688
name, email = parse_username(e)
1690
raise errors.NoEmailInUsername(e)
1694
class TreeConfig(IniBasedConfig):
1695
"""Branch configuration data associated with its contents, not location"""
1697
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1699
def __init__(self, branch):
1700
self._config = branch._get_config()
1701
self.branch = branch
1703
def _get_parser(self, file=None):
1704
if file is not None:
1705
return IniBasedConfig._get_parser(file)
1706
return self._config._get_configobj()
1708
def get_option(self, name, section=None, default=None):
1709
self.branch.lock_read()
1711
return self._config.get_option(name, section, default)
1713
self.branch.unlock()
1715
def set_option(self, value, name, section=None):
1716
"""Set a per-branch configuration option"""
1717
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1718
# higher levels providing the right lock -- vila 20101004
1719
self.branch.lock_write()
1721
self._config.set_option(value, name, section)
1723
self.branch.unlock()
1725
def remove_option(self, option_name, section_name=None):
1726
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1727
# higher levels providing the right lock -- vila 20101004
1728
self.branch.lock_write()
1730
self._config.remove_option(option_name, section_name)
1732
self.branch.unlock()
1735
class AuthenticationConfig(object):
1736
"""The authentication configuration file based on a ini file.
1738
Implements the authentication.conf file described in
1739
doc/developers/authentication-ring.txt.
1742
def __init__(self, _file=None):
1743
self._config = None # The ConfigObj
1745
self._filename = authentication_config_filename()
1746
self._input = self._filename = authentication_config_filename()
1748
# Tests can provide a string as _file
1749
self._filename = None
1752
def _get_config(self):
1753
if self._config is not None:
1756
# FIXME: Should we validate something here ? Includes: empty
1757
# sections are useless, at least one of
1758
# user/password/password_encoding should be defined, etc.
1760
# Note: the encoding below declares that the file itself is utf-8
1761
# encoded, but the values in the ConfigObj are always Unicode.
1762
self._config = ConfigObj(self._input, encoding='utf-8')
1763
except configobj.ConfigObjError, e:
1764
raise errors.ParseConfigError(e.errors, e.config.filename)
1765
except UnicodeError:
1766
raise errors.ConfigContentError(self._filename)
1770
"""Save the config file, only tests should use it for now."""
1771
conf_dir = os.path.dirname(self._filename)
1772
ensure_config_dir_exists(conf_dir)
1773
f = file(self._filename, 'wb')
1775
self._get_config().write(f)
1779
def _set_option(self, section_name, option_name, value):
1780
"""Set an authentication configuration option"""
1781
conf = self._get_config()
1782
section = conf.get(section_name)
1785
section = conf[section]
1786
section[option_name] = value
1789
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1791
"""Returns the matching credentials from authentication.conf file.
1793
:param scheme: protocol
1795
:param host: the server address
1797
:param port: the associated port (optional)
1799
:param user: login (optional)
1801
:param path: the absolute path on the server (optional)
1803
:param realm: the http authentication realm (optional)
1805
:return: A dict containing the matching credentials or None.
1807
- name: the section name of the credentials in the
1808
authentication.conf file,
1809
- user: can't be different from the provided user if any,
1810
- scheme: the server protocol,
1811
- host: the server address,
1812
- port: the server port (can be None),
1813
- path: the absolute server path (can be None),
1814
- realm: the http specific authentication realm (can be None),
1815
- password: the decoded password, could be None if the credential
1816
defines only the user
1817
- verify_certificates: https specific, True if the server
1818
certificate should be verified, False otherwise.
1821
for auth_def_name, auth_def in self._get_config().items():
1822
if type(auth_def) is not configobj.Section:
1823
raise ValueError("%s defined outside a section" % auth_def_name)
1825
a_scheme, a_host, a_user, a_path = map(
1826
auth_def.get, ['scheme', 'host', 'user', 'path'])
1829
a_port = auth_def.as_int('port')
1833
raise ValueError("'port' not numeric in %s" % auth_def_name)
1835
a_verify_certificates = auth_def.as_bool('verify_certificates')
1837
a_verify_certificates = True
1840
"'verify_certificates' not boolean in %s" % auth_def_name)
1843
if a_scheme is not None and scheme != a_scheme:
1845
if a_host is not None:
1846
if not (host == a_host
1847
or (a_host.startswith('.') and host.endswith(a_host))):
1849
if a_port is not None and port != a_port:
1851
if (a_path is not None and path is not None
1852
and not path.startswith(a_path)):
1854
if (a_user is not None and user is not None
1855
and a_user != user):
1856
# Never contradict the caller about the user to be used
1861
# Prepare a credentials dictionary with additional keys
1862
# for the credential providers
1863
credentials = dict(name=auth_def_name,
1870
password=auth_def.get('password', None),
1871
verify_certificates=a_verify_certificates)
1872
# Decode the password in the credentials (or get one)
1873
self.decode_password(credentials,
1874
auth_def.get('password_encoding', None))
1875
if 'auth' in debug.debug_flags:
1876
trace.mutter("Using authentication section: %r", auth_def_name)
1879
if credentials is None:
1880
# No credentials were found in authentication.conf, try the fallback
1881
# credentials stores.
1882
credentials = credential_store_registry.get_fallback_credentials(
1883
scheme, host, port, user, path, realm)
1887
def set_credentials(self, name, host, user, scheme=None, password=None,
1888
port=None, path=None, verify_certificates=None,
1890
"""Set authentication credentials for a host.
1892
Any existing credentials with matching scheme, host, port and path
1893
will be deleted, regardless of name.
1895
:param name: An arbitrary name to describe this set of credentials.
1896
:param host: Name of the host that accepts these credentials.
1897
:param user: The username portion of these credentials.
1898
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1900
:param password: Password portion of these credentials.
1901
:param port: The IP port on the host that these credentials apply to.
1902
:param path: A filesystem path on the host that these credentials
1904
:param verify_certificates: On https, verify server certificates if
1906
:param realm: The http authentication realm (optional).
1908
values = {'host': host, 'user': user}
1909
if password is not None:
1910
values['password'] = password
1911
if scheme is not None:
1912
values['scheme'] = scheme
1913
if port is not None:
1914
values['port'] = '%d' % port
1915
if path is not None:
1916
values['path'] = path
1917
if verify_certificates is not None:
1918
values['verify_certificates'] = str(verify_certificates)
1919
if realm is not None:
1920
values['realm'] = realm
1921
config = self._get_config()
1923
for section, existing_values in config.items():
1924
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1925
if existing_values.get(key) != values.get(key):
1929
config.update({name: values})
1932
def get_user(self, scheme, host, port=None, realm=None, path=None,
1933
prompt=None, ask=False, default=None):
1934
"""Get a user from authentication file.
1936
:param scheme: protocol
1938
:param host: the server address
1940
:param port: the associated port (optional)
1942
:param realm: the realm sent by the server (optional)
1944
:param path: the absolute path on the server (optional)
1946
:param ask: Ask the user if there is no explicitly configured username
1949
:param default: The username returned if none is defined (optional).
1951
:return: The found user.
1953
credentials = self.get_credentials(scheme, host, port, user=None,
1954
path=path, realm=realm)
1955
if credentials is not None:
1956
user = credentials['user']
1962
# Create a default prompt suitable for most cases
1963
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1964
# Special handling for optional fields in the prompt
1965
if port is not None:
1966
prompt_host = '%s:%d' % (host, port)
1969
user = ui.ui_factory.get_username(prompt, host=prompt_host)
1974
def get_password(self, scheme, host, user, port=None,
1975
realm=None, path=None, prompt=None):
1976
"""Get a password from authentication file or prompt the user for one.
1978
:param scheme: protocol
1980
:param host: the server address
1982
:param port: the associated port (optional)
1986
:param realm: the realm sent by the server (optional)
1988
:param path: the absolute path on the server (optional)
1990
:return: The found password or the one entered by the user.
1992
credentials = self.get_credentials(scheme, host, port, user, path,
1994
if credentials is not None:
1995
password = credentials['password']
1996
if password is not None and scheme is 'ssh':
1997
trace.warning('password ignored in section [%s],'
1998
' use an ssh agent instead'
1999
% credentials['name'])
2003
# Prompt user only if we could't find a password
2004
if password is None:
2006
# Create a default prompt suitable for most cases
2007
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
2008
# Special handling for optional fields in the prompt
2009
if port is not None:
2010
prompt_host = '%s:%d' % (host, port)
2013
password = ui.ui_factory.get_password(prompt,
2014
host=prompt_host, user=user)
2017
def decode_password(self, credentials, encoding):
2019
cs = credential_store_registry.get_credential_store(encoding)
2021
raise ValueError('%r is not a known password_encoding' % encoding)
2022
credentials['password'] = cs.decode_password(credentials)
2026
class CredentialStoreRegistry(registry.Registry):
2027
"""A class that registers credential stores.
2029
A credential store provides access to credentials via the password_encoding
2030
field in authentication.conf sections.
2032
Except for stores provided by bzr itself, most stores are expected to be
2033
provided by plugins that will therefore use
2034
register_lazy(password_encoding, module_name, member_name, help=help,
2035
fallback=fallback) to install themselves.
2037
A fallback credential store is one that is queried if no credentials can be
2038
found via authentication.conf.
2041
def get_credential_store(self, encoding=None):
2042
cs = self.get(encoding)
2047
def is_fallback(self, name):
2048
"""Check if the named credentials store should be used as fallback."""
2049
return self.get_info(name)
2051
def get_fallback_credentials(self, scheme, host, port=None, user=None,
2052
path=None, realm=None):
2053
"""Request credentials from all fallback credentials stores.
2055
The first credentials store that can provide credentials wins.
2058
for name in self.keys():
2059
if not self.is_fallback(name):
2061
cs = self.get_credential_store(name)
2062
credentials = cs.get_credentials(scheme, host, port, user,
2064
if credentials is not None:
2065
# We found some credentials
2069
def register(self, key, obj, help=None, override_existing=False,
2071
"""Register a new object to a name.
2073
:param key: This is the key to use to request the object later.
2074
:param obj: The object to register.
2075
:param help: Help text for this entry. This may be a string or
2076
a callable. If it is a callable, it should take two
2077
parameters (registry, key): this registry and the key that
2078
the help was registered under.
2079
:param override_existing: Raise KeyErorr if False and something has
2080
already been registered for that key. If True, ignore if there
2081
is an existing key (always register the new value).
2082
:param fallback: Whether this credential store should be
2085
return super(CredentialStoreRegistry,
2086
self).register(key, obj, help, info=fallback,
2087
override_existing=override_existing)
2089
def register_lazy(self, key, module_name, member_name,
2090
help=None, override_existing=False,
2092
"""Register a new credential store to be loaded on request.
2094
:param module_name: The python path to the module. Such as 'os.path'.
2095
:param member_name: The member of the module to return. If empty or
2096
None, get() will return the module itself.
2097
:param help: Help text for this entry. This may be a string or
2099
:param override_existing: If True, replace the existing object
2100
with the new one. If False, if there is already something
2101
registered with the same key, raise a KeyError
2102
:param fallback: Whether this credential store should be
2105
return super(CredentialStoreRegistry, self).register_lazy(
2106
key, module_name, member_name, help,
2107
info=fallback, override_existing=override_existing)
2110
credential_store_registry = CredentialStoreRegistry()
2113
class CredentialStore(object):
2114
"""An abstract class to implement storage for credentials"""
2116
def decode_password(self, credentials):
2117
"""Returns a clear text password for the provided credentials."""
2118
raise NotImplementedError(self.decode_password)
2120
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2122
"""Return the matching credentials from this credential store.
2124
This method is only called on fallback credential stores.
2126
raise NotImplementedError(self.get_credentials)
2130
class PlainTextCredentialStore(CredentialStore):
2131
__doc__ = """Plain text credential store for the authentication.conf file"""
2133
def decode_password(self, credentials):
2134
"""See CredentialStore.decode_password."""
2135
return credentials['password']
2138
credential_store_registry.register('plain', PlainTextCredentialStore,
2139
help=PlainTextCredentialStore.__doc__)
2140
credential_store_registry.default_key = 'plain'
2143
class BzrDirConfig(object):
2145
def __init__(self, bzrdir):
2146
self._bzrdir = bzrdir
2147
self._config = bzrdir._get_config()
2149
def set_default_stack_on(self, value):
2150
"""Set the default stacking location.
2152
It may be set to a location, or None.
2154
This policy affects all branches contained by this control dir, except
2155
for those under repositories.
2157
if self._config is None:
2158
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2160
self._config.set_option('', 'default_stack_on')
2162
self._config.set_option(value, 'default_stack_on')
2164
def get_default_stack_on(self):
2165
"""Return the default stacking location.
2167
This will either be a location, or None.
2169
This policy affects all branches contained by this control dir, except
2170
for those under repositories.
2172
if self._config is None:
2174
value = self._config.get_option('default_stack_on')
2180
class TransportConfig(object):
2181
"""A Config that reads/writes a config file on a Transport.
2183
It is a low-level object that considers config data to be name/value pairs
2184
that may be associated with a section. Assigning meaning to these values
2185
is done at higher levels like TreeConfig.
2188
def __init__(self, transport, filename):
2189
self._transport = transport
2190
self._filename = filename
2192
def get_option(self, name, section=None, default=None):
2193
"""Return the value associated with a named option.
2195
:param name: The name of the value
2196
:param section: The section the option is in (if any)
2197
:param default: The value to return if the value is not set
2198
:return: The value or default value
2200
configobj = self._get_configobj()
2202
section_obj = configobj
2205
section_obj = configobj[section]
2208
value = section_obj.get(name, default)
2209
for hook in OldConfigHooks['get']:
2210
hook(self, name, value)
2213
def set_option(self, value, name, section=None):
2214
"""Set the value associated with a named option.
2216
:param value: The value to set
2217
:param name: The name of the value to set
2218
:param section: The section the option is in (if any)
2220
configobj = self._get_configobj()
2222
configobj[name] = value
2224
configobj.setdefault(section, {})[name] = value
2225
for hook in OldConfigHooks['set']:
2226
hook(self, name, value)
2227
self._set_configobj(configobj)
2229
def remove_option(self, option_name, section_name=None):
2230
configobj = self._get_configobj()
2231
if section_name is None:
2232
del configobj[option_name]
2234
del configobj[section_name][option_name]
2235
for hook in OldConfigHooks['remove']:
2236
hook(self, option_name)
2237
self._set_configobj(configobj)
2239
def _get_config_file(self):
2241
f = StringIO(self._transport.get_bytes(self._filename))
2242
for hook in OldConfigHooks['load']:
2245
except errors.NoSuchFile:
2247
except errors.PermissionDenied, e:
2248
trace.warning("Permission denied while trying to open "
2249
"configuration file %s.", urlutils.unescape_for_display(
2250
urlutils.join(self._transport.base, self._filename), "utf-8"))
2253
def _external_url(self):
2254
return urlutils.join(self._transport.external_url(), self._filename)
2256
def _get_configobj(self):
2257
f = self._get_config_file()
2260
conf = ConfigObj(f, encoding='utf-8')
2261
except configobj.ConfigObjError, e:
2262
raise errors.ParseConfigError(e.errors, self._external_url())
2263
except UnicodeDecodeError:
2264
raise errors.ConfigContentError(self._external_url())
2269
def _set_configobj(self, configobj):
2270
out_file = StringIO()
2271
configobj.write(out_file)
2273
self._transport.put_file(self._filename, out_file)
2274
for hook in OldConfigHooks['save']:
2278
class Option(object):
2279
"""An option definition.
2281
The option *values* are stored in config files and found in sections.
2283
Here we define various properties about the option itself, its default
2284
value, how to convert it from stores, what to do when invalid values are
2285
encoutered, in which config files it can be stored.
2288
def __init__(self, name, override_from_env=None,
2289
default=None, default_from_env=None,
2290
help=None, from_unicode=None, invalid=None, unquote=True):
2291
"""Build an option definition.
2293
:param name: the name used to refer to the option.
2295
:param override_from_env: A list of environment variables which can
2296
provide override any configuration setting.
2298
:param default: the default value to use when none exist in the config
2299
stores. This is either a string that ``from_unicode`` will convert
2300
into the proper type, a callable returning a unicode string so that
2301
``from_unicode`` can be used on the return value, or a python
2302
object that can be stringified (so only the empty list is supported
2305
:param default_from_env: A list of environment variables which can
2306
provide a default value. 'default' will be used only if none of the
2307
variables specified here are set in the environment.
2309
:param help: a doc string to explain the option to the user.
2311
:param from_unicode: a callable to convert the unicode string
2312
representing the option value in a store. This is not called for
2315
:param invalid: the action to be taken when an invalid value is
2316
encountered in a store. This is called only when from_unicode is
2317
invoked to convert a string and returns None or raise ValueError or
2318
TypeError. Accepted values are: None (ignore invalid values),
2319
'warning' (emit a warning), 'error' (emit an error message and
2322
:param unquote: should the unicode value be unquoted before conversion.
2323
This should be used only when the store providing the values cannot
2324
safely unquote them (see http://pad.lv/906897). It is provided so
2325
daughter classes can handle the quoting themselves.
2327
if override_from_env is None:
2328
override_from_env = []
2329
if default_from_env is None:
2330
default_from_env = []
2332
self.override_from_env = override_from_env
2333
# Convert the default value to a unicode string so all values are
2334
# strings internally before conversion (via from_unicode) is attempted.
2337
elif isinstance(default, list):
2338
# Only the empty list is supported
2340
raise AssertionError(
2341
'Only empty lists are supported as default values')
2343
elif isinstance(default, (str, unicode, bool, int, float)):
2344
# Rely on python to convert strings, booleans and integers
2345
self.default = u'%s' % (default,)
2346
elif callable(default):
2347
self.default = default
2349
# other python objects are not expected
2350
raise AssertionError('%r is not supported as a default value'
2352
self.default_from_env = default_from_env
2354
self.from_unicode = from_unicode
2355
self.unquote = unquote
2356
if invalid and invalid not in ('warning', 'error'):
2357
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2358
self.invalid = invalid
2364
def convert_from_unicode(self, store, unicode_value):
2365
if self.unquote and store is not None and unicode_value is not None:
2366
unicode_value = store.unquote(unicode_value)
2367
if self.from_unicode is None or unicode_value is None:
2368
# Don't convert or nothing to convert
2369
return unicode_value
2371
converted = self.from_unicode(unicode_value)
2372
except (ValueError, TypeError):
2373
# Invalid values are ignored
2375
if converted is None and self.invalid is not None:
2376
# The conversion failed
2377
if self.invalid == 'warning':
2378
trace.warning('Value "%s" is not valid for "%s"',
2379
unicode_value, self.name)
2380
elif self.invalid == 'error':
2381
raise errors.ConfigOptionValueError(self.name, unicode_value)
2384
def get_override(self):
2386
for var in self.override_from_env:
2388
# If the env variable is defined, its value takes precedence
2389
value = os.environ[var].decode(osutils.get_user_encoding())
2395
def get_default(self):
2397
for var in self.default_from_env:
2399
# If the env variable is defined, its value is the default one
2400
value = os.environ[var].decode(osutils.get_user_encoding())
2405
# Otherwise, fallback to the value defined at registration
2406
if callable(self.default):
2407
value = self.default()
2408
if not isinstance(value, unicode):
2409
raise AssertionError(
2410
'Callable default values should be unicode')
2412
value = self.default
2415
def get_help_topic(self):
2418
def get_help_text(self, additional_see_also=None, plain=True):
2420
from bzrlib import help_topics
2421
result += help_topics._format_see_also(additional_see_also)
2423
result = help_topics.help_as_plain_text(result)
2427
# Predefined converters to get proper values from store
2429
def bool_from_store(unicode_str):
2430
return ui.bool_from_string(unicode_str)
2433
def int_from_store(unicode_str):
2434
return int(unicode_str)
2437
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2439
def int_SI_from_store(unicode_str):
2440
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2442
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2443
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2446
:return Integer, expanded to its base-10 value if a proper SI unit is
2447
found, None otherwise.
2449
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2450
p = re.compile(regexp, re.IGNORECASE)
2451
m = p.match(unicode_str)
2454
val, _, unit = m.groups()
2458
coeff = _unit_suffixes[unit.upper()]
2460
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2465
def float_from_store(unicode_str):
2466
return float(unicode_str)
2469
# Use a an empty dict to initialize an empty configobj avoiding all
2470
# parsing and encoding checks
2471
_list_converter_config = configobj.ConfigObj(
2472
{}, encoding='utf-8', list_values=True, interpolation=False)
2475
class ListOption(Option):
2477
def __init__(self, name, default=None, default_from_env=None,
2478
help=None, invalid=None):
2479
"""A list Option definition.
2481
This overrides the base class so the conversion from a unicode string
2482
can take quoting into account.
2484
super(ListOption, self).__init__(
2485
name, default=default, default_from_env=default_from_env,
2486
from_unicode=self.from_unicode, help=help,
2487
invalid=invalid, unquote=False)
2489
def from_unicode(self, unicode_str):
2490
if not isinstance(unicode_str, basestring):
2492
# Now inject our string directly as unicode. All callers got their
2493
# value from configobj, so values that need to be quoted are already
2495
_list_converter_config.reset()
2496
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2497
maybe_list = _list_converter_config['list']
2498
if isinstance(maybe_list, basestring):
2500
# A single value, most probably the user forgot (or didn't care
2501
# to add) the final ','
2504
# The empty string, convert to empty list
2507
# We rely on ConfigObj providing us with a list already
2512
class RegistryOption(Option):
2513
"""Option for a choice from a registry."""
2515
def __init__(self, name, registry, default_from_env=None,
2516
help=None, invalid=None):
2517
"""A registry based Option definition.
2519
This overrides the base class so the conversion from a unicode string
2520
can take quoting into account.
2522
super(RegistryOption, self).__init__(
2523
name, default=lambda: unicode(registry.default_key),
2524
default_from_env=default_from_env,
2525
from_unicode=self.from_unicode, help=help,
2526
invalid=invalid, unquote=False)
2527
self.registry = registry
2529
def from_unicode(self, unicode_str):
2530
if not isinstance(unicode_str, basestring):
2533
return self.registry.get(unicode_str)
2536
"Invalid value %s for %s."
2537
"See help for a list of possible values." % (unicode_str,
2542
ret = [self._help, "\n\nThe following values are supported:\n"]
2543
for key in self.registry.keys():
2544
ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
2548
class OptionRegistry(registry.Registry):
2549
"""Register config options by their name.
2551
This overrides ``registry.Registry`` to simplify registration by acquiring
2552
some information from the option object itself.
2555
def register(self, option):
2556
"""Register a new option to its name.
2558
:param option: The option to register. Its name is used as the key.
2560
super(OptionRegistry, self).register(option.name, option,
2563
def register_lazy(self, key, module_name, member_name):
2564
"""Register a new option to be loaded on request.
2566
:param key: the key to request the option later. Since the registration
2567
is lazy, it should be provided and match the option name.
2569
:param module_name: the python path to the module. Such as 'os.path'.
2571
:param member_name: the member of the module to return. If empty or
2572
None, get() will return the module itself.
2574
super(OptionRegistry, self).register_lazy(key,
2575
module_name, member_name)
2577
def get_help(self, key=None):
2578
"""Get the help text associated with the given key"""
2579
option = self.get(key)
2580
the_help = option.help
2581
if callable(the_help):
2582
return the_help(self, key)
2586
option_registry = OptionRegistry()
2589
# Registered options in lexicographical order
2591
option_registry.register(
2592
Option('append_revisions_only',
2593
default=None, from_unicode=bool_from_store, invalid='warning',
2595
Whether to only append revisions to the mainline.
2597
If this is set to true, then it is not possible to change the
2598
existing mainline of the branch.
2600
option_registry.register(
2601
ListOption('acceptable_keys',
2604
List of GPG key patterns which are acceptable for verification.
2606
option_registry.register(
2607
Option('add.maximum_file_size',
2608
default=u'20MB', from_unicode=int_SI_from_store,
2610
Size above which files should be added manually.
2612
Files below this size are added automatically when using ``bzr add`` without
2615
A negative value means disable the size check.
2617
option_registry.register(
2619
default=None, from_unicode=bool_from_store,
2621
Is the branch bound to ``bound_location``.
2623
If set to "True", the branch should act as a checkout, and push each commit to
2624
the bound_location. This option is normally set by ``bind``/``unbind``.
2626
See also: bound_location.
2628
option_registry.register(
2629
Option('bound_location',
2632
The location that commits should go to when acting as a checkout.
2634
This option is normally set by ``bind``.
2638
option_registry.register(
2639
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2641
Whether revisions associated with tags should be fetched.
2643
option_registry.register_lazy(
2644
'bzr.transform.orphan_policy', 'bzrlib.transform', 'opt_transform_orphan')
2645
option_registry.register(
2646
Option('bzr.workingtree.worth_saving_limit', default=10,
2647
from_unicode=int_from_store, invalid='warning',
2649
How many changes before saving the dirstate.
2651
-1 means that we will never rewrite the dirstate file for only
2652
stat-cache changes. Regardless of this setting, we will always rewrite
2653
the dirstate file if a file is added/removed/renamed/etc. This flag only
2654
affects the behavior of updating the dirstate file after we notice that
2655
a file has been touched.
2657
option_registry.register(
2658
Option('bugtracker', default=None,
2660
Default bug tracker to use.
2662
This bug tracker will be used for example when marking bugs
2663
as fixed using ``bzr commit --fixes``, if no explicit
2664
bug tracker was specified.
2666
option_registry.register(
2667
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2668
from_unicode=signature_policy_from_unicode,
2670
GPG checking policy.
2672
Possible values: require, ignore, check-available (default)
2674
this option will control whether bzr will require good gpg
2675
signatures, ignore them, or check them if they are
2678
option_registry.register(
2679
Option('child_submit_format',
2680
help='''The preferred format of submissions to this branch.'''))
2681
option_registry.register(
2682
Option('child_submit_to',
2683
help='''Where submissions to this branch are mailed to.'''))
2684
option_registry.register(
2685
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2686
from_unicode=signing_policy_from_unicode,
2690
Possible values: always, never, when-required (default)
2692
This option controls whether bzr will always create
2693
gpg signatures or not on commits.
2695
option_registry.register(
2696
Option('dirstate.fdatasync', default=True,
2697
from_unicode=bool_from_store,
2699
Flush dirstate changes onto physical disk?
2701
If true (default), working tree metadata changes are flushed through the
2702
OS buffers to physical disk. This is somewhat slower, but means data
2703
should not be lost if the machine crashes. See also repository.fdatasync.
2705
option_registry.register(
2706
ListOption('debug_flags', default=[],
2707
help='Debug flags to activate.'))
2708
option_registry.register(
2709
Option('default_format', default='2a',
2710
help='Format used when creating branches.'))
2711
option_registry.register(
2712
Option('dpush_strict', default=None,
2713
from_unicode=bool_from_store,
2715
The default value for ``dpush --strict``.
2717
If present, defines the ``--strict`` option default value for checking
2718
uncommitted changes before pushing into a different VCS without any
2719
custom bzr metadata.
2721
option_registry.register(
2723
help='The command called to launch an editor to enter a message.'))
2724
option_registry.register(
2725
Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
2726
help='The users identity'))
2727
option_registry.register(
2728
Option('gpg_signing_command',
2731
Program to use use for creating signatures.
2733
This should support at least the -u and --clearsign options.
2735
option_registry.register(
2736
Option('gpg_signing_key',
2739
GPG key to use for signing.
2741
This defaults to the first key associated with the users email.
2743
option_registry.register(
2744
Option('ignore_missing_extensions', default=False,
2745
from_unicode=bool_from_store,
2747
Control the missing extensions warning display.
2749
The warning will not be emitted if set to True.
2751
option_registry.register(
2753
help='Language to translate messages into.'))
2754
option_registry.register(
2755
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2757
Steal locks that appears to be dead.
2759
If set to True, bzr will check if a lock is supposed to be held by an
2760
active process from the same user on the same machine. If the user and
2761
machine match, but no process with the given PID is active, then bzr
2762
will automatically break the stale lock, and create a new lock for
2764
Otherwise, bzr will prompt as normal to break the lock.
2766
option_registry.register(
2767
Option('log_format', default='long',
2769
Log format to use when displaying revisions.
2771
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2772
may be provided by plugins.
2774
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
2776
option_registry.register(
2777
Option('output_encoding',
2778
help= 'Unicode encoding for output'
2779
' (terminal encoding if not specified).'))
2780
option_registry.register(
2781
Option('parent_location',
2784
The location of the default branch for pull or merge.
2786
This option is normally set when creating a branch, the first ``pull`` or by
2787
``pull --remember``.
2789
option_registry.register(
2790
Option('post_commit', default=None,
2792
Post commit functions.
2794
An ordered list of python functions to call, separated by spaces.
2796
Each function takes branch, rev_id as parameters.
2798
option_registry.register(
2799
Option('public_branch',
2802
A publically-accessible version of this branch.
2804
This implies that the branch setting this option is not publically-accessible.
2805
Used and set by ``bzr send``.
2807
option_registry.register(
2808
Option('push_location',
2811
The location of the default branch for push.
2813
This option is normally set by the first ``push`` or ``push --remember``.
2815
option_registry.register(
2816
Option('push_strict', default=None,
2817
from_unicode=bool_from_store,
2819
The default value for ``push --strict``.
2821
If present, defines the ``--strict`` option default value for checking
2822
uncommitted changes before sending a merge directive.
2824
option_registry.register(
2825
Option('repository.fdatasync', default=True,
2826
from_unicode=bool_from_store,
2828
Flush repository changes onto physical disk?
2830
If true (default), repository changes are flushed through the OS buffers
2831
to physical disk. This is somewhat slower, but means data should not be
2832
lost if the machine crashes. See also dirstate.fdatasync.
2834
option_registry.register_lazy('smtp_server',
2835
'bzrlib.smtp_connection', 'smtp_server')
2836
option_registry.register_lazy('smtp_password',
2837
'bzrlib.smtp_connection', 'smtp_password')
2838
option_registry.register_lazy('smtp_username',
2839
'bzrlib.smtp_connection', 'smtp_username')
2840
option_registry.register(
2841
Option('selftest.timeout',
2843
from_unicode=int_from_store,
2844
help='Abort selftest if one test takes longer than this many seconds',
2847
option_registry.register(
2848
Option('send_strict', default=None,
2849
from_unicode=bool_from_store,
2851
The default value for ``send --strict``.
2853
If present, defines the ``--strict`` option default value for checking
2854
uncommitted changes before sending a bundle.
2857
option_registry.register(
2858
Option('serve.client_timeout',
2859
default=300.0, from_unicode=float_from_store,
2860
help="If we wait for a new request from a client for more than"
2861
" X seconds, consider the client idle, and hangup."))
2862
option_registry.register(
2863
Option('stacked_on_location',
2865
help="""The location where this branch is stacked on."""))
2866
option_registry.register(
2867
Option('submit_branch',
2870
The branch you intend to submit your current work to.
2872
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2873
by the ``submit:`` revision spec.
2875
option_registry.register(
2877
help='''Where submissions from this branch are mailed to.'''))
2878
option_registry.register(
2879
ListOption('suppress_warnings',
2881
help="List of warning classes to suppress."))
2882
option_registry.register(
2883
Option('validate_signatures_in_log', default=False,
2884
from_unicode=bool_from_store, invalid='warning',
2885
help='''Whether to validate signatures in bzr log.'''))
2886
option_registry.register_lazy('ssl.ca_certs',
2887
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2889
option_registry.register_lazy('ssl.cert_reqs',
2890
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2893
class Section(object):
2894
"""A section defines a dict of option name => value.
2896
This is merely a read-only dict which can add some knowledge about the
2897
options. It is *not* a python dict object though and doesn't try to mimic
2901
def __init__(self, section_id, options):
2902
self.id = section_id
2903
# We re-use the dict-like object received
2904
self.options = options
2906
def get(self, name, default=None, expand=True):
2907
return self.options.get(name, default)
2909
def iter_option_names(self):
2910
for k in self.options.iterkeys():
2914
# Mostly for debugging use
2915
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2918
_NewlyCreatedOption = object()
2919
"""Was the option created during the MutableSection lifetime"""
2920
_DeletedOption = object()
2921
"""Was the option deleted during the MutableSection lifetime"""
2924
class MutableSection(Section):
2925
"""A section allowing changes and keeping track of the original values."""
2927
def __init__(self, section_id, options):
2928
super(MutableSection, self).__init__(section_id, options)
2929
self.reset_changes()
2931
def set(self, name, value):
2932
if name not in self.options:
2933
# This is a new option
2934
self.orig[name] = _NewlyCreatedOption
2935
elif name not in self.orig:
2936
self.orig[name] = self.get(name, None)
2937
self.options[name] = value
2939
def remove(self, name):
2940
if name not in self.orig:
2941
self.orig[name] = self.get(name, None)
2942
del self.options[name]
2944
def reset_changes(self):
2947
def apply_changes(self, dirty, store):
2948
"""Apply option value changes.
2950
``self`` has been reloaded from the persistent storage. ``dirty``
2951
contains the changes made since the previous loading.
2953
:param dirty: the mutable section containing the changes.
2955
:param store: the store containing the section
2957
for k, expected in dirty.orig.iteritems():
2958
actual = dirty.get(k, _DeletedOption)
2959
reloaded = self.get(k, _NewlyCreatedOption)
2960
if actual is _DeletedOption:
2961
if k in self.options:
2965
# Report concurrent updates in an ad-hoc way. This should only
2966
# occurs when different processes try to update the same option
2967
# which is not supported (as in: the config framework is not meant
2968
# to be used a sharing mechanism).
2969
if expected != reloaded:
2970
if actual is _DeletedOption:
2971
actual = '<DELETED>'
2972
if reloaded is _NewlyCreatedOption:
2973
reloaded = '<CREATED>'
2974
if expected is _NewlyCreatedOption:
2975
expected = '<CREATED>'
2976
# Someone changed the value since we get it from the persistent
2978
trace.warning(gettext(
2979
"Option {0} in section {1} of {2} was changed"
2980
" from {3} to {4}. The {5} value will be saved.".format(
2981
k, self.id, store.external_url(), expected,
2983
# No need to keep track of these changes
2984
self.reset_changes()
2987
class Store(object):
2988
"""Abstract interface to persistent storage for configuration options."""
2990
readonly_section_class = Section
2991
mutable_section_class = MutableSection
2994
# Which sections need to be saved
2995
self.dirty_sections = []
2997
def is_loaded(self):
2998
"""Returns True if the Store has been loaded.
3000
This is used to implement lazy loading and ensure the persistent
3001
storage is queried only when needed.
3003
raise NotImplementedError(self.is_loaded)
3006
"""Loads the Store from persistent storage."""
3007
raise NotImplementedError(self.load)
3009
def _load_from_string(self, bytes):
3010
"""Create a store from a string in configobj syntax.
3012
:param bytes: A string representing the file content.
3014
raise NotImplementedError(self._load_from_string)
3017
"""Unloads the Store.
3019
This should make is_loaded() return False. This is used when the caller
3020
knows that the persistent storage has changed or may have change since
3023
raise NotImplementedError(self.unload)
3025
def quote(self, value):
3026
"""Quote a configuration option value for storing purposes.
3028
This allows Stacks to present values as they will be stored.
3032
def unquote(self, value):
3033
"""Unquote a configuration option value into unicode.
3035
The received value is quoted as stored.
3040
"""Saves the Store to persistent storage."""
3041
raise NotImplementedError(self.save)
3043
def _need_saving(self):
3044
for s in self.dirty_sections:
3046
# At least one dirty section contains a modification
3050
def apply_changes(self, dirty_sections):
3051
"""Apply changes from dirty sections while checking for coherency.
3053
The Store content is discarded and reloaded from persistent storage to
3054
acquire up-to-date values.
3056
Dirty sections are MutableSection which kept track of the value they
3057
are expected to update.
3059
# We need an up-to-date version from the persistent storage, unload the
3060
# store. The reload will occur when needed (triggered by the first
3061
# get_mutable_section() call below.
3063
# Apply the changes from the preserved dirty sections
3064
for dirty in dirty_sections:
3065
clean = self.get_mutable_section(dirty.id)
3066
clean.apply_changes(dirty, self)
3067
# Everything is clean now
3068
self.dirty_sections = []
3070
def save_changes(self):
3071
"""Saves the Store to persistent storage if changes occurred.
3073
Apply the changes recorded in the mutable sections to a store content
3074
refreshed from persistent storage.
3076
raise NotImplementedError(self.save_changes)
3078
def external_url(self):
3079
raise NotImplementedError(self.external_url)
3081
def get_sections(self):
3082
"""Returns an ordered iterable of existing sections.
3084
:returns: An iterable of (store, section).
3086
raise NotImplementedError(self.get_sections)
3088
def get_mutable_section(self, section_id=None):
3089
"""Returns the specified mutable section.
3091
:param section_id: The section identifier
3093
raise NotImplementedError(self.get_mutable_section)
3096
# Mostly for debugging use
3097
return "<config.%s(%s)>" % (self.__class__.__name__,
3098
self.external_url())
3101
class CommandLineStore(Store):
3102
"A store to carry command line overrides for the config options."""
3104
def __init__(self, opts=None):
3105
super(CommandLineStore, self).__init__()
3112
# The dict should be cleared but not replaced so it can be shared.
3113
self.options.clear()
3115
def _from_cmdline(self, overrides):
3116
# Reset before accepting new definitions
3118
for over in overrides:
3120
name, value = over.split('=', 1)
3122
raise errors.BzrCommandError(
3123
gettext("Invalid '%s', should be of the form 'name=value'")
3125
self.options[name] = value
3127
def external_url(self):
3128
# Not an url but it makes debugging easier and is never needed
3132
def get_sections(self):
3133
yield self, self.readonly_section_class(None, self.options)
3136
class IniFileStore(Store):
3137
"""A config Store using ConfigObj for storage.
3139
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3140
serialize/deserialize the config file.
3144
"""A config Store using ConfigObj for storage.
3146
super(IniFileStore, self).__init__()
3147
self._config_obj = None
3149
def is_loaded(self):
3150
return self._config_obj != None
3153
self._config_obj = None
3154
self.dirty_sections = []
3156
def _load_content(self):
3157
"""Load the config file bytes.
3159
This should be provided by subclasses
3161
:return: Byte string
3163
raise NotImplementedError(self._load_content)
3165
def _save_content(self, content):
3166
"""Save the config file bytes.
3168
This should be provided by subclasses
3170
:param content: Config file bytes to write
3172
raise NotImplementedError(self._save_content)
3175
"""Load the store from the associated file."""
3176
if self.is_loaded():
3178
content = self._load_content()
3179
self._load_from_string(content)
3180
for hook in ConfigHooks['load']:
3183
def _load_from_string(self, bytes):
3184
"""Create a config store from a string.
3186
:param bytes: A string representing the file content.
3188
if self.is_loaded():
3189
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3190
co_input = StringIO(bytes)
3192
# The config files are always stored utf8-encoded
3193
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3195
except configobj.ConfigObjError, e:
3196
self._config_obj = None
3197
raise errors.ParseConfigError(e.errors, self.external_url())
3198
except UnicodeDecodeError:
3199
raise errors.ConfigContentError(self.external_url())
3201
def save_changes(self):
3202
if not self.is_loaded():
3205
if not self._need_saving():
3207
# Preserve the current version
3208
current = self._config_obj
3209
dirty_sections = list(self.dirty_sections)
3210
self.apply_changes(dirty_sections)
3211
# Save to the persistent storage
3215
if not self.is_loaded():
3219
self._config_obj.write(out)
3220
self._save_content(out.getvalue())
3221
for hook in ConfigHooks['save']:
3224
def get_sections(self):
3225
"""Get the configobj section in the file order.
3227
:returns: An iterable of (store, section).
3229
# We need a loaded store
3232
except (errors.NoSuchFile, errors.PermissionDenied):
3233
# If the file can't be read, there is no sections
3235
cobj = self._config_obj
3237
yield self, self.readonly_section_class(None, cobj)
3238
for section_name in cobj.sections:
3240
self.readonly_section_class(section_name,
3241
cobj[section_name]))
3243
def get_mutable_section(self, section_id=None):
3244
# We need a loaded store
3247
except errors.NoSuchFile:
3248
# The file doesn't exist, let's pretend it was empty
3249
self._load_from_string('')
3250
if section_id is None:
3251
section = self._config_obj
3253
section = self._config_obj.setdefault(section_id, {})
3254
mutable_section = self.mutable_section_class(section_id, section)
3255
# All mutable sections can become dirty
3256
self.dirty_sections.append(mutable_section)
3257
return mutable_section
3259
def quote(self, value):
3261
# configobj conflates automagical list values and quoting
3262
self._config_obj.list_values = True
3263
return self._config_obj._quote(value)
3265
self._config_obj.list_values = False
3267
def unquote(self, value):
3268
if value and isinstance(value, basestring):
3269
# _unquote doesn't handle None nor empty strings nor anything that
3270
# is not a string, really.
3271
value = self._config_obj._unquote(value)
3274
def external_url(self):
3275
# Since an IniFileStore can be used without a file (at least in tests),
3276
# it's better to provide something than raising a NotImplementedError.
3277
# All daughter classes are supposed to provide an implementation
3279
return 'In-Process Store, no URL'
3281
class TransportIniFileStore(IniFileStore):
3282
"""IniFileStore that loads files from a transport.
3284
:ivar transport: The transport object where the config file is located.
3286
:ivar file_name: The config file basename in the transport directory.
3289
def __init__(self, transport, file_name):
3290
"""A Store using a ini file on a Transport
3292
:param transport: The transport object where the config file is located.
3293
:param file_name: The config file basename in the transport directory.
3295
super(TransportIniFileStore, self).__init__()
3296
self.transport = transport
3297
self.file_name = file_name
3299
def _load_content(self):
3301
return self.transport.get_bytes(self.file_name)
3302
except errors.PermissionDenied:
3303
trace.warning("Permission denied while trying to load "
3304
"configuration store %s.", self.external_url())
3307
def _save_content(self, content):
3308
self.transport.put_bytes(self.file_name, content)
3310
def external_url(self):
3311
# FIXME: external_url should really accepts an optional relpath
3312
# parameter (bug #750169) :-/ -- vila 2011-04-04
3313
# The following will do in the interim but maybe we don't want to
3314
# expose a path here but rather a config ID and its associated
3315
# object </hand wawe>.
3316
return urlutils.join(self.transport.external_url(), self.file_name)
3319
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3320
# unlockable stores for use with objects that can already ensure the locking
3321
# (think branches). If different stores (not based on ConfigObj) are created,
3322
# they may face the same issue.
3325
class LockableIniFileStore(TransportIniFileStore):
3326
"""A ConfigObjStore using locks on save to ensure store integrity."""
3328
def __init__(self, transport, file_name, lock_dir_name=None):
3329
"""A config Store using ConfigObj for storage.
3331
:param transport: The transport object where the config file is located.
3333
:param file_name: The config file basename in the transport directory.
3335
if lock_dir_name is None:
3336
lock_dir_name = 'lock'
3337
self.lock_dir_name = lock_dir_name
3338
super(LockableIniFileStore, self).__init__(transport, file_name)
3339
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3341
def lock_write(self, token=None):
3342
"""Takes a write lock in the directory containing the config file.
3344
If the directory doesn't exist it is created.
3346
# FIXME: This doesn't check the ownership of the created directories as
3347
# ensure_config_dir_exists does. It should if the transport is local
3348
# -- vila 2011-04-06
3349
self.transport.create_prefix()
3350
return self._lock.lock_write(token)
3355
def break_lock(self):
3356
self._lock.break_lock()
3360
# We need to be able to override the undecorated implementation
3361
self.save_without_locking()
3363
def save_without_locking(self):
3364
super(LockableIniFileStore, self).save()
3367
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3368
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3369
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3371
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3372
# functions or a registry will make it easier and clearer for tests, focusing
3373
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3374
# on a poolie's remark)
3375
class GlobalStore(LockableIniFileStore):
3377
def __init__(self, possible_transports=None):
3378
t = transport.get_transport_from_path(
3379
config_dir(), possible_transports=possible_transports)
3380
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3384
class LocationStore(LockableIniFileStore):
3386
def __init__(self, possible_transports=None):
3387
t = transport.get_transport_from_path(
3388
config_dir(), possible_transports=possible_transports)
3389
super(LocationStore, self).__init__(t, 'locations.conf')
3390
self.id = 'locations'
3393
class BranchStore(TransportIniFileStore):
3395
def __init__(self, branch):
3396
super(BranchStore, self).__init__(branch.control_transport,
3398
self.branch = branch
3402
class ControlStore(LockableIniFileStore):
3404
def __init__(self, bzrdir):
3405
super(ControlStore, self).__init__(bzrdir.transport,
3407
lock_dir_name='branch_lock')
3411
class SectionMatcher(object):
3412
"""Select sections into a given Store.
3414
This is intended to be used to postpone getting an iterable of sections
3418
def __init__(self, store):
3421
def get_sections(self):
3422
# This is where we require loading the store so we can see all defined
3424
sections = self.store.get_sections()
3425
# Walk the revisions in the order provided
3426
for store, s in sections:
3430
def match(self, section):
3431
"""Does the proposed section match.
3433
:param section: A Section object.
3435
:returns: True if the section matches, False otherwise.
3437
raise NotImplementedError(self.match)
3440
class NameMatcher(SectionMatcher):
3442
def __init__(self, store, section_id):
3443
super(NameMatcher, self).__init__(store)
3444
self.section_id = section_id
3446
def match(self, section):
3447
return section.id == self.section_id
3450
class LocationSection(Section):
3452
def __init__(self, section, extra_path):
3453
super(LocationSection, self).__init__(section.id, section.options)
3454
self.extra_path = extra_path
3455
self.locals = {'relpath': extra_path,
3456
'basename': urlutils.basename(extra_path)}
3458
def get(self, name, default=None, expand=True):
3459
value = super(LocationSection, self).get(name, default)
3460
if value is not None and expand:
3461
policy_name = self.get(name + ':policy', None)
3462
policy = _policy_value.get(policy_name, POLICY_NONE)
3463
if policy == POLICY_APPENDPATH:
3464
value = urlutils.join(value, self.extra_path)
3465
# expand section local options right now (since POLICY_APPENDPATH
3466
# will never add options references, it's ok to expand after it).
3468
for is_ref, chunk in iter_option_refs(value):
3470
chunks.append(chunk)
3473
if ref in self.locals:
3474
chunks.append(self.locals[ref])
3476
chunks.append(chunk)
3477
value = ''.join(chunks)
3481
class StartingPathMatcher(SectionMatcher):
3482
"""Select sections for a given location respecting the Store order."""
3484
# FIXME: Both local paths and urls can be used for section names as well as
3485
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3486
# inherited the fuzziness from the previous ``LocationConfig``
3487
# implementation. We probably need to revisit which encoding is allowed for
3488
# both ``location`` and section names and how we normalize
3489
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3490
# related too. -- vila 2012-01-04
3492
def __init__(self, store, location):
3493
super(StartingPathMatcher, self).__init__(store)
3494
if location.startswith('file://'):
3495
location = urlutils.local_path_from_url(location)
3496
self.location = location
3498
def get_sections(self):
3499
"""Get all sections matching ``location`` in the store.
3501
The most generic sections are described first in the store, then more
3502
specific ones can be provided for reduced scopes.
3504
The returned section are therefore returned in the reversed order so
3505
the most specific ones can be found first.
3507
location_parts = self.location.rstrip('/').split('/')
3510
# Later sections are more specific, they should be returned first
3511
for _, section in reversed(list(store.get_sections())):
3512
if section.id is None:
3513
# The no-name section is always included if present
3514
yield store, LocationSection(section, self.location)
3516
section_path = section.id
3517
if section_path.startswith('file://'):
3518
# the location is already a local path or URL, convert the
3519
# section id to the same format
3520
section_path = urlutils.local_path_from_url(section_path)
3521
if (self.location.startswith(section_path)
3522
or fnmatch.fnmatch(self.location, section_path)):
3523
section_parts = section_path.rstrip('/').split('/')
3524
extra_path = '/'.join(location_parts[len(section_parts):])
3525
yield store, LocationSection(section, extra_path)
3528
class LocationMatcher(SectionMatcher):
3530
def __init__(self, store, location):
3531
super(LocationMatcher, self).__init__(store)
3532
if location.startswith('file://'):
3533
location = urlutils.local_path_from_url(location)
3534
self.location = location
3536
def _get_matching_sections(self):
3537
"""Get all sections matching ``location``."""
3538
# We slightly diverge from LocalConfig here by allowing the no-name
3539
# section as the most generic one and the lower priority.
3540
no_name_section = None
3542
# Filter out the no_name_section so _iter_for_location_by_parts can be
3543
# used (it assumes all sections have a name).
3544
for _, section in self.store.get_sections():
3545
if section.id is None:
3546
no_name_section = section
3548
all_sections.append(section)
3549
# Unfortunately _iter_for_location_by_parts deals with section names so
3550
# we have to resync.
3551
filtered_sections = _iter_for_location_by_parts(
3552
[s.id for s in all_sections], self.location)
3553
iter_all_sections = iter(all_sections)
3554
matching_sections = []
3555
if no_name_section is not None:
3556
matching_sections.append(
3557
(0, LocationSection(no_name_section, self.location)))
3558
for section_id, extra_path, length in filtered_sections:
3559
# a section id is unique for a given store so it's safe to take the
3560
# first matching section while iterating. Also, all filtered
3561
# sections are part of 'all_sections' and will always be found
3564
section = iter_all_sections.next()
3565
if section_id == section.id:
3566
matching_sections.append(
3567
(length, LocationSection(section, extra_path)))
3569
return matching_sections
3571
def get_sections(self):
3572
# Override the default implementation as we want to change the order
3573
matching_sections = self._get_matching_sections()
3574
# We want the longest (aka more specific) locations first
3575
sections = sorted(matching_sections,
3576
key=lambda (length, section): (length, section.id),
3578
# Sections mentioning 'ignore_parents' restrict the selection
3579
for _, section in sections:
3580
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3581
ignore = section.get('ignore_parents', None)
3582
if ignore is not None:
3583
ignore = ui.bool_from_string(ignore)
3586
# Finally, we have a valid section
3587
yield self.store, section
3590
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3591
"""Describes an expandable option reference.
3593
We want to match the most embedded reference first.
3595
I.e. for '{{foo}}' we will get '{foo}',
3596
for '{bar{baz}}' we will get '{baz}'
3599
def iter_option_refs(string):
3600
# Split isolate refs so every other chunk is a ref
3602
for chunk in _option_ref_re.split(string):
3607
class Stack(object):
3608
"""A stack of configurations where an option can be defined"""
3610
def __init__(self, sections_def, store=None, mutable_section_id=None):
3611
"""Creates a stack of sections with an optional store for changes.
3613
:param sections_def: A list of Section or callables that returns an
3614
iterable of Section. This defines the Sections for the Stack and
3615
can be called repeatedly if needed.
3617
:param store: The optional Store where modifications will be
3618
recorded. If none is specified, no modifications can be done.
3620
:param mutable_section_id: The id of the MutableSection where changes
3621
are recorded. This requires the ``store`` parameter to be
3624
self.sections_def = sections_def
3626
self.mutable_section_id = mutable_section_id
3628
def iter_sections(self):
3629
"""Iterate all the defined sections."""
3630
# Ensuring lazy loading is achieved by delaying section matching (which
3631
# implies querying the persistent storage) until it can't be avoided
3632
# anymore by using callables to describe (possibly empty) section
3634
for sections in self.sections_def:
3635
for store, section in sections():
3636
yield store, section
3638
def get(self, name, expand=True, convert=True):
3639
"""Return the *first* option value found in the sections.
3641
This is where we guarantee that sections coming from Store are loaded
3642
lazily: the loading is delayed until we need to either check that an
3643
option exists or get its value, which in turn may require to discover
3644
in which sections it can be defined. Both of these (section and option
3645
existence) require loading the store (even partially).
3647
:param name: The queried option.
3649
:param expand: Whether options references should be expanded.
3651
:param convert: Whether the option value should be converted from
3652
unicode (do nothing for non-registered options).
3654
:returns: The value of the option.
3656
# FIXME: No caching of options nor sections yet -- vila 20110503
3658
found_store = None # Where the option value has been found
3659
# If the option is registered, it may provide additional info about
3662
opt = option_registry.get(name)
3667
def expand_and_convert(val):
3668
# This may need to be called in different contexts if the value is
3669
# None or ends up being None during expansion or conversion.
3672
if isinstance(val, basestring):
3673
val = self._expand_options_in_string(val)
3675
trace.warning('Cannot expand "%s":'
3676
' %s does not support option expansion'
3677
% (name, type(val)))
3679
val = found_store.unquote(val)
3681
val = opt.convert_from_unicode(found_store, val)
3684
# First of all, check if the environment can override the configuration
3686
if opt is not None and opt.override_from_env:
3687
value = opt.get_override()
3688
value = expand_and_convert(value)
3690
for store, section in self.iter_sections():
3691
value = section.get(name)
3692
if value is not None:
3695
value = expand_and_convert(value)
3696
if opt is not None and value is None:
3697
# If the option is registered, it may provide a default value
3698
value = opt.get_default()
3699
value = expand_and_convert(value)
3700
for hook in ConfigHooks['get']:
3701
hook(self, name, value)
3704
def expand_options(self, string, env=None):
3705
"""Expand option references in the string in the configuration context.
3707
:param string: The string containing option(s) to expand.
3709
:param env: An option dict defining additional configuration options or
3710
overriding existing ones.
3712
:returns: The expanded string.
3714
return self._expand_options_in_string(string, env)
3716
def _expand_options_in_string(self, string, env=None, _refs=None):
3717
"""Expand options in the string in the configuration context.
3719
:param string: The string to be expanded.
3721
:param env: An option dict defining additional configuration options or
3722
overriding existing ones.
3724
:param _refs: Private list (FIFO) containing the options being expanded
3727
:returns: The expanded string.
3730
# Not much to expand there
3733
# What references are currently resolved (to detect loops)
3736
# We need to iterate until no more refs appear ({{foo}} will need two
3737
# iterations for example).
3742
for is_ref, chunk in iter_option_refs(result):
3744
chunks.append(chunk)
3749
raise errors.OptionExpansionLoop(string, _refs)
3751
value = self._expand_option(name, env, _refs)
3753
raise errors.ExpandingUnknownOption(name, string)
3754
chunks.append(value)
3756
result = ''.join(chunks)
3759
def _expand_option(self, name, env, _refs):
3760
if env is not None and name in env:
3761
# Special case, values provided in env takes precedence over
3765
value = self.get(name, expand=False, convert=False)
3766
value = self._expand_options_in_string(value, env, _refs)
3769
def _get_mutable_section(self):
3770
"""Get the MutableSection for the Stack.
3772
This is where we guarantee that the mutable section is lazily loaded:
3773
this means we won't load the corresponding store before setting a value
3774
or deleting an option. In practice the store will often be loaded but
3775
this helps catching some programming errors.
3778
section = store.get_mutable_section(self.mutable_section_id)
3779
return store, section
3781
def set(self, name, value):
3782
"""Set a new value for the option."""
3783
store, section = self._get_mutable_section()
3784
section.set(name, store.quote(value))
3785
for hook in ConfigHooks['set']:
3786
hook(self, name, value)
3788
def remove(self, name):
3789
"""Remove an existing option."""
3790
_, section = self._get_mutable_section()
3791
section.remove(name)
3792
for hook in ConfigHooks['remove']:
3796
# Mostly for debugging use
3797
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3799
def _get_overrides(self):
3800
# Hack around library_state.initialize never called
3801
if bzrlib.global_state is not None:
3802
return bzrlib.global_state.cmdline_overrides.get_sections()
3806
class MemoryStack(Stack):
3807
"""A configuration stack defined from a string.
3809
This is mainly intended for tests and requires no disk resources.
3812
def __init__(self, content=None):
3813
"""Create an in-memory stack from a given content.
3815
It uses a single store based on configobj and support reading and
3818
:param content: The initial content of the store. If None, the store is
3819
not loaded and ``_load_from_string`` can and should be used if
3822
store = IniFileStore()
3823
if content is not None:
3824
store._load_from_string(content)
3825
super(MemoryStack, self).__init__(
3826
[store.get_sections], store)
3829
class _CompatibleStack(Stack):
3830
"""Place holder for compatibility with previous design.
3832
This is intended to ease the transition from the Config-based design to the
3833
Stack-based design and should not be used nor relied upon by plugins.
3835
One assumption made here is that the daughter classes will all use Stores
3836
derived from LockableIniFileStore).
3838
It implements set() and remove () by re-loading the store before applying
3839
the modification and saving it.
3841
The long term plan being to implement a single write by store to save
3842
all modifications, this class should not be used in the interim.
3845
def set(self, name, value):
3848
super(_CompatibleStack, self).set(name, value)
3849
# Force a write to persistent storage
3852
def remove(self, name):
3855
super(_CompatibleStack, self).remove(name)
3856
# Force a write to persistent storage
3860
class GlobalStack(_CompatibleStack):
3861
"""Global options only stack.
3863
The following sections are queried:
3865
* command-line overrides,
3867
* the 'DEFAULT' section in bazaar.conf
3869
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3874
gstore = GlobalStore()
3875
super(GlobalStack, self).__init__(
3876
[self._get_overrides,
3877
NameMatcher(gstore, 'DEFAULT').get_sections],
3878
gstore, mutable_section_id='DEFAULT')
3881
class LocationStack(_CompatibleStack):
3882
"""Per-location options falling back to global options stack.
3885
The following sections are queried:
3887
* command-line overrides,
3889
* the sections matching ``location`` in ``locations.conf``, the order being
3890
defined by the number of path components in the section glob, higher
3891
numbers first (from most specific section to most generic).
3893
* the 'DEFAULT' section in bazaar.conf
3895
This stack will use the ``location`` section in locations.conf as its
3899
def __init__(self, location):
3900
"""Make a new stack for a location and global configuration.
3902
:param location: A URL prefix to """
3903
lstore = LocationStore()
3904
if location.startswith('file://'):
3905
location = urlutils.local_path_from_url(location)
3906
gstore = GlobalStore()
3907
super(LocationStack, self).__init__(
3908
[self._get_overrides,
3909
LocationMatcher(lstore, location).get_sections,
3910
NameMatcher(gstore, 'DEFAULT').get_sections],
3911
lstore, mutable_section_id=location)
3914
class BranchStack(Stack):
3915
"""Per-location options falling back to branch then global options stack.
3917
The following sections are queried:
3919
* command-line overrides,
3921
* the sections matching ``location`` in ``locations.conf``, the order being
3922
defined by the number of path components in the section glob, higher
3923
numbers first (from most specific section to most generic),
3925
* the no-name section in branch.conf,
3927
* the ``DEFAULT`` section in ``bazaar.conf``.
3929
This stack will use the no-name section in ``branch.conf`` as its
3933
def __init__(self, branch):
3934
lstore = LocationStore()
3935
bstore = branch._get_config_store()
3936
gstore = GlobalStore()
3937
super(BranchStack, self).__init__(
3938
[self._get_overrides,
3939
LocationMatcher(lstore, branch.base).get_sections,
3940
NameMatcher(bstore, None).get_sections,
3941
NameMatcher(gstore, 'DEFAULT').get_sections],
3943
self.branch = branch
3945
def lock_write(self, token=None):
3946
return self.branch.lock_write(token)
3949
return self.branch.unlock()
3952
def set(self, name, value):
3953
super(BranchStack, self).set(name, value)
3954
# Unlocking the branch will trigger a store.save_changes() so the last
3955
# unlock saves all the changes.
3958
def remove(self, name):
3959
super(BranchStack, self).remove(name)
3960
# Unlocking the branch will trigger a store.save_changes() so the last
3961
# unlock saves all the changes.
3964
class RemoteControlStack(_CompatibleStack):
3965
"""Remote control-only options stack."""
3967
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3968
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3969
# control.conf and is used only for stack options.
3971
def __init__(self, bzrdir):
3972
cstore = bzrdir._get_config_store()
3973
super(RemoteControlStack, self).__init__(
3974
[NameMatcher(cstore, None).get_sections],
3976
self.bzrdir = bzrdir
3979
class BranchOnlyStack(Stack):
3980
"""Branch-only options stack."""
3982
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
3983
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
3984
# -- vila 2011-12-16
3986
def __init__(self, branch):
3987
bstore = branch._get_config_store()
3988
super(BranchOnlyStack, self).__init__(
3989
[NameMatcher(bstore, None).get_sections],
3991
self.branch = branch
3993
def lock_write(self, token=None):
3994
return self.branch.lock_write(token)
3997
return self.branch.unlock()
4000
def set(self, name, value):
4001
super(BranchOnlyStack, self).set(name, value)
4002
# Force a write to persistent storage
4003
self.store.save_changes()
4006
def remove(self, name):
4007
super(BranchOnlyStack, self).remove(name)
4008
# Force a write to persistent storage
4009
self.store.save_changes()
4012
class cmd_config(commands.Command):
4013
__doc__ = """Display, set or remove a configuration option.
4015
Display the active value for a given option.
4017
If --all is specified, NAME is interpreted as a regular expression and all
4018
matching options are displayed mentioning their scope. The active value
4019
that bzr will take into account is the first one displayed for each option.
4021
If no NAME is given, --all .* is implied.
4023
Setting a value is achieved by using name=value without spaces. The value
4024
is set in the most relevant scope and can be checked by displaying the
4028
takes_args = ['name?']
4032
# FIXME: This should be a registry option so that plugins can register
4033
# their own config files (or not) and will also address
4034
# http://pad.lv/788991 -- vila 20101115
4035
commands.Option('scope', help='Reduce the scope to the specified'
4036
' configuration file.',
4038
commands.Option('all',
4039
help='Display all the defined values for the matching options.',
4041
commands.Option('remove', help='Remove the option from'
4042
' the configuration file.'),
4045
_see_also = ['configuration']
4047
@commands.display_command
4048
def run(self, name=None, all=False, directory=None, scope=None,
4050
if directory is None:
4052
directory = urlutils.normalize_url(directory)
4054
raise errors.BzrError(
4055
'--all and --remove are mutually exclusive.')
4057
# Delete the option in the given scope
4058
self._remove_config_option(name, directory, scope)
4060
# Defaults to all options
4061
self._show_matching_options('.*', directory, scope)
4064
name, value = name.split('=', 1)
4066
# Display the option(s) value(s)
4068
self._show_matching_options(name, directory, scope)
4070
self._show_value(name, directory, scope)
4073
raise errors.BzrError(
4074
'Only one option can be set.')
4075
# Set the option value
4076
self._set_config_option(name, value, directory, scope)
4078
def _get_stack(self, directory, scope=None, write_access=False):
4079
"""Get the configuration stack specified by ``directory`` and ``scope``.
4081
:param directory: Where the configurations are derived from.
4083
:param scope: A specific config to start from.
4085
:param write_access: Whether a write access to the stack will be
4088
# FIXME: scope should allow access to plugin-specific stacks (even
4089
# reduced to the plugin-specific store), related to
4090
# http://pad.lv/788991 -- vila 2011-11-15
4091
if scope is not None:
4092
if scope == 'bazaar':
4093
return GlobalStack()
4094
elif scope == 'locations':
4095
return LocationStack(directory)
4096
elif scope == 'branch':
4098
controldir.ControlDir.open_containing_tree_or_branch(
4101
self.add_cleanup(br.lock_write().unlock)
4102
return br.get_config_stack()
4103
raise errors.NoSuchConfig(scope)
4107
controldir.ControlDir.open_containing_tree_or_branch(
4110
self.add_cleanup(br.lock_write().unlock)
4111
return br.get_config_stack()
4112
except errors.NotBranchError:
4113
return LocationStack(directory)
4115
def _quote_multiline(self, value):
4117
value = '"""' + value + '"""'
4120
def _show_value(self, name, directory, scope):
4121
conf = self._get_stack(directory, scope)
4122
value = conf.get(name, expand=True, convert=False)
4123
if value is not None:
4124
# Quote the value appropriately
4125
value = self._quote_multiline(value)
4126
self.outf.write('%s\n' % (value,))
4128
raise errors.NoSuchConfigOption(name)
4130
def _show_matching_options(self, name, directory, scope):
4131
name = lazy_regex.lazy_compile(name)
4132
# We want any error in the regexp to be raised *now* so we need to
4133
# avoid the delay introduced by the lazy regexp. But, we still do
4134
# want the nicer errors raised by lazy_regex.
4135
name._compile_and_collapse()
4138
conf = self._get_stack(directory, scope)
4139
for store, section in conf.iter_sections():
4140
for oname in section.iter_option_names():
4141
if name.search(oname):
4142
if cur_store_id != store.id:
4143
# Explain where the options are defined
4144
self.outf.write('%s:\n' % (store.id,))
4145
cur_store_id = store.id
4147
if (section.id is not None and cur_section != section.id):
4148
# Display the section id as it appears in the store
4149
# (None doesn't appear by definition)
4150
self.outf.write(' [%s]\n' % (section.id,))
4151
cur_section = section.id
4152
value = section.get(oname, expand=False)
4153
# Quote the value appropriately
4154
value = self._quote_multiline(value)
4155
self.outf.write(' %s = %s\n' % (oname, value))
4157
def _set_config_option(self, name, value, directory, scope):
4158
conf = self._get_stack(directory, scope, write_access=True)
4159
conf.set(name, value)
4161
def _remove_config_option(self, name, directory, scope):
4163
raise errors.BzrCommandError(
4164
'--remove expects an option to remove.')
4165
conf = self._get_stack(directory, scope, write_access=True)
4169
raise errors.NoSuchConfigOption(name)
4174
# We need adapters that can build a Store or a Stack in a test context. Test
4175
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4176
# themselves. The builder will receive a test instance and should return a
4177
# ready-to-use store or stack. Plugins that define new store/stacks can also
4178
# register themselves here to be tested against the tests defined in
4179
# bzrlib.tests.test_config. Note that the builder can be called multiple times
4180
# for the same test.
4182
# The registered object should be a callable receiving a test instance
4183
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4185
test_store_builder_registry = registry.Registry()
4187
# The registered object should be a callable receiving a test instance
4188
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4190
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
