1508
2268
configobj[name] = value
1510
2270
configobj.setdefault(section, {})[name] = value
2271
for hook in OldConfigHooks['set']:
2272
hook(self, name, value)
2273
self._set_configobj(configobj)
2275
def remove_option(self, option_name, section_name=None):
2276
configobj = self._get_configobj()
2277
if section_name is None:
2278
del configobj[option_name]
2280
del configobj[section_name][option_name]
2281
for hook in OldConfigHooks['remove']:
2282
hook(self, option_name)
1511
2283
self._set_configobj(configobj)
1513
2285
def _get_config_file(self):
1515
return StringIO(self._transport.get_bytes(self._filename))
2287
f = StringIO(self._transport.get_bytes(self._filename))
2288
for hook in OldConfigHooks['load']:
1516
2291
except errors.NoSuchFile:
1517
2292
return StringIO()
2293
except errors.PermissionDenied, e:
2294
trace.warning("Permission denied while trying to open "
2295
"configuration file %s.", urlutils.unescape_for_display(
2296
urlutils.join(self._transport.base, self._filename), "utf-8"))
2299
def _external_url(self):
2300
return urlutils.join(self._transport.external_url(), self._filename)
1519
2302
def _get_configobj(self):
1520
return ConfigObj(self._get_config_file(), encoding='utf-8')
2303
f = self._get_config_file()
2306
conf = ConfigObj(f, encoding='utf-8')
2307
except configobj.ConfigObjError, e:
2308
raise errors.ParseConfigError(e.errors, self._external_url())
2309
except UnicodeDecodeError:
2310
raise errors.ConfigContentError(self._external_url())
1522
2315
def _set_configobj(self, configobj):
1523
2316
out_file = StringIO()
1524
2317
configobj.write(out_file)
1525
2318
out_file.seek(0)
1526
2319
self._transport.put_file(self._filename, out_file)
2320
for hook in OldConfigHooks['save']:
2324
class Option(object):
2325
"""An option definition.
2327
The option *values* are stored in config files and found in sections.
2329
Here we define various properties about the option itself, its default
2330
value, how to convert it from stores, what to do when invalid values are
2331
encoutered, in which config files it can be stored.
2334
def __init__(self, name, override_from_env=None,
2335
default=None, default_from_env=None,
2336
help=None, from_unicode=None, invalid=None, unquote=True):
2337
"""Build an option definition.
2339
:param name: the name used to refer to the option.
2341
:param override_from_env: A list of environment variables which can
2342
provide override any configuration setting.
2344
:param default: the default value to use when none exist in the config
2345
stores. This is either a string that ``from_unicode`` will convert
2346
into the proper type, a callable returning a unicode string so that
2347
``from_unicode`` can be used on the return value, or a python
2348
object that can be stringified (so only the empty list is supported
2351
:param default_from_env: A list of environment variables which can
2352
provide a default value. 'default' will be used only if none of the
2353
variables specified here are set in the environment.
2355
:param help: a doc string to explain the option to the user.
2357
:param from_unicode: a callable to convert the unicode string
2358
representing the option value in a store. This is not called for
2361
:param invalid: the action to be taken when an invalid value is
2362
encountered in a store. This is called only when from_unicode is
2363
invoked to convert a string and returns None or raise ValueError or
2364
TypeError. Accepted values are: None (ignore invalid values),
2365
'warning' (emit a warning), 'error' (emit an error message and
2368
:param unquote: should the unicode value be unquoted before conversion.
2369
This should be used only when the store providing the values cannot
2370
safely unquote them (see http://pad.lv/906897). It is provided so
2371
daughter classes can handle the quoting themselves.
2373
if override_from_env is None:
2374
override_from_env = []
2375
if default_from_env is None:
2376
default_from_env = []
2378
self.override_from_env = override_from_env
2379
# Convert the default value to a unicode string so all values are
2380
# strings internally before conversion (via from_unicode) is attempted.
2383
elif isinstance(default, list):
2384
# Only the empty list is supported
2386
raise AssertionError(
2387
'Only empty lists are supported as default values')
2389
elif isinstance(default, (str, unicode, bool, int, float)):
2390
# Rely on python to convert strings, booleans and integers
2391
self.default = u'%s' % (default,)
2392
elif callable(default):
2393
self.default = default
2395
# other python objects are not expected
2396
raise AssertionError('%r is not supported as a default value'
2398
self.default_from_env = default_from_env
2400
self.from_unicode = from_unicode
2401
self.unquote = unquote
2402
if invalid and invalid not in ('warning', 'error'):
2403
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2404
self.invalid = invalid
2406
def convert_from_unicode(self, store, unicode_value):
2407
if self.unquote and store is not None and unicode_value is not None:
2408
unicode_value = store.unquote(unicode_value)
2409
if self.from_unicode is None or unicode_value is None:
2410
# Don't convert or nothing to convert
2411
return unicode_value
2413
converted = self.from_unicode(unicode_value)
2414
except (ValueError, TypeError):
2415
# Invalid values are ignored
2417
if converted is None and self.invalid is not None:
2418
# The conversion failed
2419
if self.invalid == 'warning':
2420
trace.warning('Value "%s" is not valid for "%s"',
2421
unicode_value, self.name)
2422
elif self.invalid == 'error':
2423
raise errors.ConfigOptionValueError(self.name, unicode_value)
2426
def get_override(self):
2428
for var in self.override_from_env:
2430
# If the env variable is defined, its value takes precedence
2431
value = os.environ[var].decode(osutils.get_user_encoding())
2437
def get_default(self):
2439
for var in self.default_from_env:
2441
# If the env variable is defined, its value is the default one
2442
value = os.environ[var].decode(osutils.get_user_encoding())
2447
# Otherwise, fallback to the value defined at registration
2448
if callable(self.default):
2449
value = self.default()
2450
if not isinstance(value, unicode):
2451
raise AssertionError(
2452
'Callable default values should be unicode')
2454
value = self.default
2457
def get_help_text(self, additional_see_also=None, plain=True):
2459
from bzrlib import help_topics
2460
result += help_topics._format_see_also(additional_see_also)
2462
result = help_topics.help_as_plain_text(result)
2466
# Predefined converters to get proper values from store
2468
def bool_from_store(unicode_str):
2469
return ui.bool_from_string(unicode_str)
2472
def int_from_store(unicode_str):
2473
return int(unicode_str)
2476
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2478
def int_SI_from_store(unicode_str):
2479
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2481
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2482
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2485
:return Integer, expanded to its base-10 value if a proper SI unit is
2486
found, None otherwise.
2488
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2489
p = re.compile(regexp, re.IGNORECASE)
2490
m = p.match(unicode_str)
2493
val, _, unit = m.groups()
2497
coeff = _unit_suffixes[unit.upper()]
2499
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2504
def float_from_store(unicode_str):
2505
return float(unicode_str)
2508
# Use a an empty dict to initialize an empty configobj avoiding all
2509
# parsing and encoding checks
2510
_list_converter_config = configobj.ConfigObj(
2511
{}, encoding='utf-8', list_values=True, interpolation=False)
2514
class ListOption(Option):
2516
def __init__(self, name, default=None, default_from_env=None,
2517
help=None, invalid=None):
2518
"""A list Option definition.
2520
This overrides the base class so the conversion from a unicode string
2521
can take quoting into account.
2523
super(ListOption, self).__init__(
2524
name, default=default, default_from_env=default_from_env,
2525
from_unicode=self.from_unicode, help=help,
2526
invalid=invalid, unquote=False)
2528
def from_unicode(self, unicode_str):
2529
if not isinstance(unicode_str, basestring):
2531
# Now inject our string directly as unicode. All callers got their
2532
# value from configobj, so values that need to be quoted are already
2534
_list_converter_config.reset()
2535
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2536
maybe_list = _list_converter_config['list']
2537
if isinstance(maybe_list, basestring):
2539
# A single value, most probably the user forgot (or didn't care
2540
# to add) the final ','
2543
# The empty string, convert to empty list
2546
# We rely on ConfigObj providing us with a list already
2551
class OptionRegistry(registry.Registry):
2552
"""Register config options by their name.
2554
This overrides ``registry.Registry`` to simplify registration by acquiring
2555
some information from the option object itself.
2558
def register(self, option):
2559
"""Register a new option to its name.
2561
:param option: The option to register. Its name is used as the key.
2563
super(OptionRegistry, self).register(option.name, option,
2566
def register_lazy(self, key, module_name, member_name):
2567
"""Register a new option to be loaded on request.
2569
:param key: the key to request the option later. Since the registration
2570
is lazy, it should be provided and match the option name.
2572
:param module_name: the python path to the module. Such as 'os.path'.
2574
:param member_name: the member of the module to return. If empty or
2575
None, get() will return the module itself.
2577
super(OptionRegistry, self).register_lazy(key,
2578
module_name, member_name)
2580
def get_help(self, key=None):
2581
"""Get the help text associated with the given key"""
2582
option = self.get(key)
2583
the_help = option.help
2584
if callable(the_help):
2585
return the_help(self, key)
2589
option_registry = OptionRegistry()
2592
# Registered options in lexicographical order
2594
option_registry.register(
2595
Option('append_revisions_only',
2596
default=None, from_unicode=bool_from_store, invalid='warning',
2598
Whether to only append revisions to the mainline.
2600
If this is set to true, then it is not possible to change the
2601
existing mainline of the branch.
2603
option_registry.register(
2604
ListOption('acceptable_keys',
2607
List of GPG key patterns which are acceptable for verification.
2609
option_registry.register(
2610
Option('add.maximum_file_size',
2611
default=u'20MB', from_unicode=int_SI_from_store,
2613
Size above which files should be added manually.
2615
Files below this size are added automatically when using ``bzr add`` without
2618
A negative value means disable the size check.
2620
option_registry.register(
2622
default=None, from_unicode=bool_from_store,
2624
Is the branch bound to ``bound_location``.
2626
If set to "True", the branch should act as a checkout, and push each commit to
2627
the bound_location. This option is normally set by ``bind``/``unbind``.
2629
See also: bound_location.
2631
option_registry.register(
2632
Option('bound_location',
2635
The location that commits should go to when acting as a checkout.
2637
This option is normally set by ``bind``.
2641
option_registry.register(
2642
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2644
Whether revisions associated with tags should be fetched.
2646
option_registry.register(
2647
Option('bzr.workingtree.worth_saving_limit', default=10,
2648
from_unicode=int_from_store, invalid='warning',
2650
How many changes before saving the dirstate.
2652
-1 means that we will never rewrite the dirstate file for only
2653
stat-cache changes. Regardless of this setting, we will always rewrite
2654
the dirstate file if a file is added/removed/renamed/etc. This flag only
2655
affects the behavior of updating the dirstate file after we notice that
2656
a file has been touched.
2658
option_registry.register(
2659
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2660
from_unicode=signature_policy_from_unicode,
2662
GPG checking policy.
2664
Possible values: require, ignore, check-available (default)
2666
this option will control whether bzr will require good gpg
2667
signatures, ignore them, or check them if they are
2670
option_registry.register(
2671
Option('child_submit_format',
2672
help='''The preferred format of submissions to this branch.'''))
2673
option_registry.register(
2674
Option('child_submit_to',
2675
help='''Where submissions to this branch are mailed to.'''))
2676
option_registry.register(
2677
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2678
from_unicode=signing_policy_from_unicode,
2682
Possible values: always, never, when-required (default)
2684
This option controls whether bzr will always create
2685
gpg signatures or not on commits.
2687
option_registry.register(
2688
Option('dirstate.fdatasync', default=True,
2689
from_unicode=bool_from_store,
2691
Flush dirstate changes onto physical disk?
2693
If true (default), working tree metadata changes are flushed through the
2694
OS buffers to physical disk. This is somewhat slower, but means data
2695
should not be lost if the machine crashes. See also repository.fdatasync.
2697
option_registry.register(
2698
ListOption('debug_flags', default=[],
2699
help='Debug flags to activate.'))
2700
option_registry.register(
2701
Option('default_format', default='2a',
2702
help='Format used when creating branches.'))
2703
option_registry.register(
2704
Option('dpush_strict', default=None,
2705
from_unicode=bool_from_store,
2707
The default value for ``dpush --strict``.
2709
If present, defines the ``--strict`` option default value for checking
2710
uncommitted changes before pushing into a different VCS without any
2711
custom bzr metadata.
2713
option_registry.register(
2715
help='The command called to launch an editor to enter a message.'))
2716
option_registry.register(
2717
Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
2718
help='The users identity'))
2719
option_registry.register(
2720
Option('gpg_signing_command',
2723
Program to use use for creating signatures.
2725
This should support at least the -u and --clearsign options.
2727
option_registry.register(
2728
Option('gpg_signing_key',
2731
GPG key to use for signing.
2733
This defaults to the first key associated with the users email.
2735
option_registry.register(
2736
Option('ignore_missing_extensions', default=False,
2737
from_unicode=bool_from_store,
2739
Control the missing extensions warning display.
2741
The warning will not be emitted if set to True.
2743
option_registry.register(
2745
help='Language to translate messages into.'))
2746
option_registry.register(
2747
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2749
Steal locks that appears to be dead.
2751
If set to True, bzr will check if a lock is supposed to be held by an
2752
active process from the same user on the same machine. If the user and
2753
machine match, but no process with the given PID is active, then bzr
2754
will automatically break the stale lock, and create a new lock for
2756
Otherwise, bzr will prompt as normal to break the lock.
2758
option_registry.register(
2759
Option('log_format', default='long',
2761
Log format to use when displaying revisions.
2763
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2764
may be provided by plugins.
2766
option_registry.register(
2767
Option('output_encoding',
2768
help= 'Unicode encoding for output'
2769
' (terminal encoding if not specified).'))
2770
option_registry.register(
2771
Option('parent_location',
2774
The location of the default branch for pull or merge.
2776
This option is normally set when creating a branch, the first ``pull`` or by
2777
``pull --remember``.
2779
option_registry.register(
2780
Option('post_commit', default=None,
2782
Post commit functions.
2784
An ordered list of python functions to call, separated by spaces.
2786
Each function takes branch, rev_id as parameters.
2788
option_registry.register(
2789
Option('public_branch',
2792
A publically-accessible version of this branch.
2794
This implies that the branch setting this option is not publically-accessible.
2795
Used and set by ``bzr send``.
2797
option_registry.register(
2798
Option('push_location',
2801
The location of the default branch for push.
2803
This option is normally set by the first ``push`` or ``push --remember``.
2805
option_registry.register(
2806
Option('push_strict', default=None,
2807
from_unicode=bool_from_store,
2809
The default value for ``push --strict``.
2811
If present, defines the ``--strict`` option default value for checking
2812
uncommitted changes before sending a merge directive.
2814
option_registry.register(
2815
Option('repository.fdatasync', default=True,
2816
from_unicode=bool_from_store,
2818
Flush repository changes onto physical disk?
2820
If true (default), repository changes are flushed through the OS buffers
2821
to physical disk. This is somewhat slower, but means data should not be
2822
lost if the machine crashes. See also dirstate.fdatasync.
2824
option_registry.register_lazy('smtp_server',
2825
'bzrlib.smtp_connection', 'smtp_server')
2826
option_registry.register_lazy('smtp_password',
2827
'bzrlib.smtp_connection', 'smtp_password')
2828
option_registry.register_lazy('smtp_username',
2829
'bzrlib.smtp_connection', 'smtp_username')
2830
option_registry.register(
2831
Option('selftest.timeout',
2833
from_unicode=int_from_store,
2834
help='Abort selftest if one test takes longer than this many seconds',
2837
option_registry.register(
2838
Option('send_strict', default=None,
2839
from_unicode=bool_from_store,
2841
The default value for ``send --strict``.
2843
If present, defines the ``--strict`` option default value for checking
2844
uncommitted changes before sending a bundle.
2847
option_registry.register(
2848
Option('serve.client_timeout',
2849
default=300.0, from_unicode=float_from_store,
2850
help="If we wait for a new request from a client for more than"
2851
" X seconds, consider the client idle, and hangup."))
2852
option_registry.register(
2853
Option('stacked_on_location',
2855
help="""The location where this branch is stacked on."""))
2856
option_registry.register(
2857
Option('submit_branch',
2860
The branch you intend to submit your current work to.
2862
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2863
by the ``submit:`` revision spec.
2865
option_registry.register(
2867
help='''Where submissions from this branch are mailed to.'''))
2868
option_registry.register(
2869
ListOption('suppress_warnings',
2871
help="List of warning classes to suppress."))
2872
option_registry.register_lazy('ssl.ca_certs',
2873
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2875
option_registry.register_lazy('ssl.cert_reqs',
2876
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2880
class Section(object):
2881
"""A section defines a dict of option name => value.
2883
This is merely a read-only dict which can add some knowledge about the
2884
options. It is *not* a python dict object though and doesn't try to mimic
2888
def __init__(self, section_id, options):
2889
self.id = section_id
2890
# We re-use the dict-like object received
2891
self.options = options
2893
def get(self, name, default=None, expand=True):
2894
return self.options.get(name, default)
2896
def iter_option_names(self):
2897
for k in self.options.iterkeys():
2901
# Mostly for debugging use
2902
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2905
_NewlyCreatedOption = object()
2906
"""Was the option created during the MutableSection lifetime"""
2907
_DeletedOption = object()
2908
"""Was the option deleted during the MutableSection lifetime"""
2911
class MutableSection(Section):
2912
"""A section allowing changes and keeping track of the original values."""
2914
def __init__(self, section_id, options):
2915
super(MutableSection, self).__init__(section_id, options)
2916
self.reset_changes()
2918
def set(self, name, value):
2919
if name not in self.options:
2920
# This is a new option
2921
self.orig[name] = _NewlyCreatedOption
2922
elif name not in self.orig:
2923
self.orig[name] = self.get(name, None)
2924
self.options[name] = value
2926
def remove(self, name):
2927
if name not in self.orig:
2928
self.orig[name] = self.get(name, None)
2929
del self.options[name]
2931
def reset_changes(self):
2934
def apply_changes(self, dirty, store):
2935
"""Apply option value changes.
2937
``self`` has been reloaded from the persistent storage. ``dirty``
2938
contains the changes made since the previous loading.
2940
:param dirty: the mutable section containing the changes.
2942
:param store: the store containing the section
2944
for k, expected in dirty.orig.iteritems():
2945
actual = dirty.get(k, _DeletedOption)
2946
reloaded = self.get(k, _NewlyCreatedOption)
2947
if actual is _DeletedOption:
2948
if k in self.options:
2952
# Report concurrent updates in an ad-hoc way. This should only
2953
# occurs when different processes try to update the same option
2954
# which is not supported (as in: the config framework is not meant
2955
# to be used a sharing mechanism).
2956
if expected != reloaded:
2957
if actual is _DeletedOption:
2958
actual = '<DELETED>'
2959
if reloaded is _NewlyCreatedOption:
2960
reloaded = '<CREATED>'
2961
if expected is _NewlyCreatedOption:
2962
expected = '<CREATED>'
2963
# Someone changed the value since we get it from the persistent
2965
trace.warning(gettext(
2966
"Option {0} in section {1} of {2} was changed"
2967
" from {3} to {4}. The {5} value will be saved.".format(
2968
k, self.id, store.external_url(), expected,
2970
# No need to keep track of these changes
2971
self.reset_changes()
2974
class Store(object):
2975
"""Abstract interface to persistent storage for configuration options."""
2977
readonly_section_class = Section
2978
mutable_section_class = MutableSection
2981
# Which sections need to be saved
2982
self.dirty_sections = []
2984
def is_loaded(self):
2985
"""Returns True if the Store has been loaded.
2987
This is used to implement lazy loading and ensure the persistent
2988
storage is queried only when needed.
2990
raise NotImplementedError(self.is_loaded)
2993
"""Loads the Store from persistent storage."""
2994
raise NotImplementedError(self.load)
2996
def _load_from_string(self, bytes):
2997
"""Create a store from a string in configobj syntax.
2999
:param bytes: A string representing the file content.
3001
raise NotImplementedError(self._load_from_string)
3004
"""Unloads the Store.
3006
This should make is_loaded() return False. This is used when the caller
3007
knows that the persistent storage has changed or may have change since
3010
raise NotImplementedError(self.unload)
3012
def quote(self, value):
3013
"""Quote a configuration option value for storing purposes.
3015
This allows Stacks to present values as they will be stored.
3019
def unquote(self, value):
3020
"""Unquote a configuration option value into unicode.
3022
The received value is quoted as stored.
3027
"""Saves the Store to persistent storage."""
3028
raise NotImplementedError(self.save)
3030
def _need_saving(self):
3031
for s in self.dirty_sections:
3033
# At least one dirty section contains a modification
3037
def apply_changes(self, dirty_sections):
3038
"""Apply changes from dirty sections while checking for coherency.
3040
The Store content is discarded and reloaded from persistent storage to
3041
acquire up-to-date values.
3043
Dirty sections are MutableSection which kept track of the value they
3044
are expected to update.
3046
# We need an up-to-date version from the persistent storage, unload the
3047
# store. The reload will occur when needed (triggered by the first
3048
# get_mutable_section() call below.
3050
# Apply the changes from the preserved dirty sections
3051
for dirty in dirty_sections:
3052
clean = self.get_mutable_section(dirty.id)
3053
clean.apply_changes(dirty, self)
3054
# Everything is clean now
3055
self.dirty_sections = []
3057
def save_changes(self):
3058
"""Saves the Store to persistent storage if changes occurred.
3060
Apply the changes recorded in the mutable sections to a store content
3061
refreshed from persistent storage.
3063
raise NotImplementedError(self.save_changes)
3065
def external_url(self):
3066
raise NotImplementedError(self.external_url)
3068
def get_sections(self):
3069
"""Returns an ordered iterable of existing sections.
3071
:returns: An iterable of (store, section).
3073
raise NotImplementedError(self.get_sections)
3075
def get_mutable_section(self, section_id=None):
3076
"""Returns the specified mutable section.
3078
:param section_id: The section identifier
3080
raise NotImplementedError(self.get_mutable_section)
3083
# Mostly for debugging use
3084
return "<config.%s(%s)>" % (self.__class__.__name__,
3085
self.external_url())
3088
class CommandLineStore(Store):
3089
"A store to carry command line overrides for the config options."""
3091
def __init__(self, opts=None):
3092
super(CommandLineStore, self).__init__()
3099
# The dict should be cleared but not replaced so it can be shared.
3100
self.options.clear()
3102
def _from_cmdline(self, overrides):
3103
# Reset before accepting new definitions
3105
for over in overrides:
3107
name, value = over.split('=', 1)
3109
raise errors.BzrCommandError(
3110
gettext("Invalid '%s', should be of the form 'name=value'")
3112
self.options[name] = value
3114
def external_url(self):
3115
# Not an url but it makes debugging easier and is never needed
3119
def get_sections(self):
3120
yield self, self.readonly_section_class(None, self.options)
3123
class IniFileStore(Store):
3124
"""A config Store using ConfigObj for storage.
3126
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3127
serialize/deserialize the config file.
3131
"""A config Store using ConfigObj for storage.
3133
super(IniFileStore, self).__init__()
3134
self._config_obj = None
3136
def is_loaded(self):
3137
return self._config_obj != None
3140
self._config_obj = None
3141
self.dirty_sections = []
3143
def _load_content(self):
3144
"""Load the config file bytes.
3146
This should be provided by subclasses
3148
:return: Byte string
3150
raise NotImplementedError(self._load_content)
3152
def _save_content(self, content):
3153
"""Save the config file bytes.
3155
This should be provided by subclasses
3157
:param content: Config file bytes to write
3159
raise NotImplementedError(self._save_content)
3162
"""Load the store from the associated file."""
3163
if self.is_loaded():
3165
content = self._load_content()
3166
self._load_from_string(content)
3167
for hook in ConfigHooks['load']:
3170
def _load_from_string(self, bytes):
3171
"""Create a config store from a string.
3173
:param bytes: A string representing the file content.
3175
if self.is_loaded():
3176
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3177
co_input = StringIO(bytes)
3179
# The config files are always stored utf8-encoded
3180
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3182
except configobj.ConfigObjError, e:
3183
self._config_obj = None
3184
raise errors.ParseConfigError(e.errors, self.external_url())
3185
except UnicodeDecodeError:
3186
raise errors.ConfigContentError(self.external_url())
3188
def save_changes(self):
3189
if not self.is_loaded():
3192
if not self._need_saving():
3194
# Preserve the current version
3195
current = self._config_obj
3196
dirty_sections = list(self.dirty_sections)
3197
self.apply_changes(dirty_sections)
3198
# Save to the persistent storage
3202
if not self.is_loaded():
3206
self._config_obj.write(out)
3207
self._save_content(out.getvalue())
3208
for hook in ConfigHooks['save']:
3211
def get_sections(self):
3212
"""Get the configobj section in the file order.
3214
:returns: An iterable of (store, section).
3216
# We need a loaded store
3219
except (errors.NoSuchFile, errors.PermissionDenied):
3220
# If the file can't be read, there is no sections
3222
cobj = self._config_obj
3224
yield self, self.readonly_section_class(None, cobj)
3225
for section_name in cobj.sections:
3227
self.readonly_section_class(section_name,
3228
cobj[section_name]))
3230
def get_mutable_section(self, section_id=None):
3231
# We need a loaded store
3234
except errors.NoSuchFile:
3235
# The file doesn't exist, let's pretend it was empty
3236
self._load_from_string('')
3237
if section_id is None:
3238
section = self._config_obj
3240
section = self._config_obj.setdefault(section_id, {})
3241
mutable_section = self.mutable_section_class(section_id, section)
3242
# All mutable sections can become dirty
3243
self.dirty_sections.append(mutable_section)
3244
return mutable_section
3246
def quote(self, value):
3248
# configobj conflates automagical list values and quoting
3249
self._config_obj.list_values = True
3250
return self._config_obj._quote(value)
3252
self._config_obj.list_values = False
3254
def unquote(self, value):
3255
if value and isinstance(value, basestring):
3256
# _unquote doesn't handle None nor empty strings nor anything that
3257
# is not a string, really.
3258
value = self._config_obj._unquote(value)
3261
def external_url(self):
3262
# Since an IniFileStore can be used without a file (at least in tests),
3263
# it's better to provide something than raising a NotImplementedError.
3264
# All daughter classes are supposed to provide an implementation
3266
return 'In-Process Store, no URL'
3268
class TransportIniFileStore(IniFileStore):
3269
"""IniFileStore that loads files from a transport.
3271
:ivar transport: The transport object where the config file is located.
3273
:ivar file_name: The config file basename in the transport directory.
3276
def __init__(self, transport, file_name):
3277
"""A Store using a ini file on a Transport
3279
:param transport: The transport object where the config file is located.
3280
:param file_name: The config file basename in the transport directory.
3282
super(TransportIniFileStore, self).__init__()
3283
self.transport = transport
3284
self.file_name = file_name
3286
def _load_content(self):
3288
return self.transport.get_bytes(self.file_name)
3289
except errors.PermissionDenied:
3290
trace.warning("Permission denied while trying to load "
3291
"configuration store %s.", self.external_url())
3294
def _save_content(self, content):
3295
self.transport.put_bytes(self.file_name, content)
3297
def external_url(self):
3298
# FIXME: external_url should really accepts an optional relpath
3299
# parameter (bug #750169) :-/ -- vila 2011-04-04
3300
# The following will do in the interim but maybe we don't want to
3301
# expose a path here but rather a config ID and its associated
3302
# object </hand wawe>.
3303
return urlutils.join(self.transport.external_url(), self.file_name)
3306
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3307
# unlockable stores for use with objects that can already ensure the locking
3308
# (think branches). If different stores (not based on ConfigObj) are created,
3309
# they may face the same issue.
3312
class LockableIniFileStore(TransportIniFileStore):
3313
"""A ConfigObjStore using locks on save to ensure store integrity."""
3315
def __init__(self, transport, file_name, lock_dir_name=None):
3316
"""A config Store using ConfigObj for storage.
3318
:param transport: The transport object where the config file is located.
3320
:param file_name: The config file basename in the transport directory.
3322
if lock_dir_name is None:
3323
lock_dir_name = 'lock'
3324
self.lock_dir_name = lock_dir_name
3325
super(LockableIniFileStore, self).__init__(transport, file_name)
3326
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3328
def lock_write(self, token=None):
3329
"""Takes a write lock in the directory containing the config file.
3331
If the directory doesn't exist it is created.
3333
# FIXME: This doesn't check the ownership of the created directories as
3334
# ensure_config_dir_exists does. It should if the transport is local
3335
# -- vila 2011-04-06
3336
self.transport.create_prefix()
3337
return self._lock.lock_write(token)
3342
def break_lock(self):
3343
self._lock.break_lock()
3347
# We need to be able to override the undecorated implementation
3348
self.save_without_locking()
3350
def save_without_locking(self):
3351
super(LockableIniFileStore, self).save()
3354
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3355
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3356
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3358
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3359
# functions or a registry will make it easier and clearer for tests, focusing
3360
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3361
# on a poolie's remark)
3362
class GlobalStore(LockableIniFileStore):
3364
def __init__(self, possible_transports=None):
3365
t = transport.get_transport_from_path(
3366
config_dir(), possible_transports=possible_transports)
3367
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3371
class LocationStore(LockableIniFileStore):
3373
def __init__(self, possible_transports=None):
3374
t = transport.get_transport_from_path(
3375
config_dir(), possible_transports=possible_transports)
3376
super(LocationStore, self).__init__(t, 'locations.conf')
3377
self.id = 'locations'
3380
class BranchStore(TransportIniFileStore):
3382
def __init__(self, branch):
3383
super(BranchStore, self).__init__(branch.control_transport,
3385
self.branch = branch
3388
def lock_write(self, token=None):
3389
return self.branch.lock_write(token)
3392
return self.branch.unlock()
3396
# We need to be able to override the undecorated implementation
3397
self.save_without_locking()
3399
def save_without_locking(self):
3400
super(BranchStore, self).save()
3403
class ControlStore(LockableIniFileStore):
3405
def __init__(self, bzrdir):
3406
super(ControlStore, self).__init__(bzrdir.transport,
3408
lock_dir_name='branch_lock')
3412
class SectionMatcher(object):
3413
"""Select sections into a given Store.
3415
This is intended to be used to postpone getting an iterable of sections
3419
def __init__(self, store):
3422
def get_sections(self):
3423
# This is where we require loading the store so we can see all defined
3425
sections = self.store.get_sections()
3426
# Walk the revisions in the order provided
3427
for store, s in sections:
3431
def match(self, section):
3432
"""Does the proposed section match.
3434
:param section: A Section object.
3436
:returns: True if the section matches, False otherwise.
3438
raise NotImplementedError(self.match)
3441
class NameMatcher(SectionMatcher):
3443
def __init__(self, store, section_id):
3444
super(NameMatcher, self).__init__(store)
3445
self.section_id = section_id
3447
def match(self, section):
3448
return section.id == self.section_id
3451
class LocationSection(Section):
3453
def __init__(self, section, extra_path):
3454
super(LocationSection, self).__init__(section.id, section.options)
3455
self.extra_path = extra_path
3456
self.locals = {'relpath': extra_path,
3457
'basename': urlutils.basename(extra_path)}
3459
def get(self, name, default=None, expand=True):
3460
value = super(LocationSection, self).get(name, default)
3461
if value is not None and expand:
3462
policy_name = self.get(name + ':policy', None)
3463
policy = _policy_value.get(policy_name, POLICY_NONE)
3464
if policy == POLICY_APPENDPATH:
3465
value = urlutils.join(value, self.extra_path)
3466
# expand section local options right now (since POLICY_APPENDPATH
3467
# will never add options references, it's ok to expand after it).
3469
for is_ref, chunk in iter_option_refs(value):
3471
chunks.append(chunk)
3474
if ref in self.locals:
3475
chunks.append(self.locals[ref])
3477
chunks.append(chunk)
3478
value = ''.join(chunks)
3482
class StartingPathMatcher(SectionMatcher):
3483
"""Select sections for a given location respecting the Store order."""
3485
# FIXME: Both local paths and urls can be used for section names as well as
3486
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3487
# inherited the fuzziness from the previous ``LocationConfig``
3488
# implementation. We probably need to revisit which encoding is allowed for
3489
# both ``location`` and section names and how we normalize
3490
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3491
# related too. -- vila 2012-01-04
3493
def __init__(self, store, location):
3494
super(StartingPathMatcher, self).__init__(store)
3495
if location.startswith('file://'):
3496
location = urlutils.local_path_from_url(location)
3497
self.location = location
3499
def get_sections(self):
3500
"""Get all sections matching ``location`` in the store.
3502
The most generic sections are described first in the store, then more
3503
specific ones can be provided for reduced scopes.
3505
The returned section are therefore returned in the reversed order so
3506
the most specific ones can be found first.
3508
location_parts = self.location.rstrip('/').split('/')
3511
# Later sections are more specific, they should be returned first
3512
for _, section in reversed(list(store.get_sections())):
3513
if section.id is None:
3514
# The no-name section is always included if present
3515
yield store, LocationSection(section, self.location)
3517
section_path = section.id
3518
if section_path.startswith('file://'):
3519
# the location is already a local path or URL, convert the
3520
# section id to the same format
3521
section_path = urlutils.local_path_from_url(section_path)
3522
if (self.location.startswith(section_path)
3523
or fnmatch.fnmatch(self.location, section_path)):
3524
section_parts = section_path.rstrip('/').split('/')
3525
extra_path = '/'.join(location_parts[len(section_parts):])
3526
yield store, LocationSection(section, extra_path)
3529
class LocationMatcher(SectionMatcher):
3531
def __init__(self, store, location):
3532
super(LocationMatcher, self).__init__(store)
3533
if location.startswith('file://'):
3534
location = urlutils.local_path_from_url(location)
3535
self.location = location
3537
def _get_matching_sections(self):
3538
"""Get all sections matching ``location``."""
3539
# We slightly diverge from LocalConfig here by allowing the no-name
3540
# section as the most generic one and the lower priority.
3541
no_name_section = None
3543
# Filter out the no_name_section so _iter_for_location_by_parts can be
3544
# used (it assumes all sections have a name).
3545
for _, section in self.store.get_sections():
3546
if section.id is None:
3547
no_name_section = section
3549
all_sections.append(section)
3550
# Unfortunately _iter_for_location_by_parts deals with section names so
3551
# we have to resync.
3552
filtered_sections = _iter_for_location_by_parts(
3553
[s.id for s in all_sections], self.location)
3554
iter_all_sections = iter(all_sections)
3555
matching_sections = []
3556
if no_name_section is not None:
3557
matching_sections.append(
3558
(0, LocationSection(no_name_section, self.location)))
3559
for section_id, extra_path, length in filtered_sections:
3560
# a section id is unique for a given store so it's safe to take the
3561
# first matching section while iterating. Also, all filtered
3562
# sections are part of 'all_sections' and will always be found
3565
section = iter_all_sections.next()
3566
if section_id == section.id:
3567
matching_sections.append(
3568
(length, LocationSection(section, extra_path)))
3570
return matching_sections
3572
def get_sections(self):
3573
# Override the default implementation as we want to change the order
3574
matching_sections = self._get_matching_sections()
3575
# We want the longest (aka more specific) locations first
3576
sections = sorted(matching_sections,
3577
key=lambda (length, section): (length, section.id),
3579
# Sections mentioning 'ignore_parents' restrict the selection
3580
for _, section in sections:
3581
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3582
ignore = section.get('ignore_parents', None)
3583
if ignore is not None:
3584
ignore = ui.bool_from_string(ignore)
3587
# Finally, we have a valid section
3588
yield self.store, section
3591
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3592
"""Describes an expandable option reference.
3594
We want to match the most embedded reference first.
3596
I.e. for '{{foo}}' we will get '{foo}',
3597
for '{bar{baz}}' we will get '{baz}'
3600
def iter_option_refs(string):
3601
# Split isolate refs so every other chunk is a ref
3603
for chunk in _option_ref_re.split(string):
3608
class Stack(object):
3609
"""A stack of configurations where an option can be defined"""
3611
def __init__(self, sections_def, store=None, mutable_section_id=None):
3612
"""Creates a stack of sections with an optional store for changes.
3614
:param sections_def: A list of Section or callables that returns an
3615
iterable of Section. This defines the Sections for the Stack and
3616
can be called repeatedly if needed.
3618
:param store: The optional Store where modifications will be
3619
recorded. If none is specified, no modifications can be done.
3621
:param mutable_section_id: The id of the MutableSection where changes
3622
are recorded. This requires the ``store`` parameter to be
3625
self.sections_def = sections_def
3627
self.mutable_section_id = mutable_section_id
3629
def get(self, name, expand=None):
3630
"""Return the *first* option value found in the sections.
3632
This is where we guarantee that sections coming from Store are loaded
3633
lazily: the loading is delayed until we need to either check that an
3634
option exists or get its value, which in turn may require to discover
3635
in which sections it can be defined. Both of these (section and option
3636
existence) require loading the store (even partially).
3638
:param name: The queried option.
3640
:param expand: Whether options references should be expanded.
3642
:returns: The value of the option.
3644
# FIXME: No caching of options nor sections yet -- vila 20110503
3646
expand = _get_expand_default_value()
3648
found_store = None # Where the option value has been found
3649
# If the option is registered, it may provide additional info about
3652
opt = option_registry.get(name)
3657
def expand_and_convert(val):
3658
# This may need to be called in different contexts if the value is
3659
# None or ends up being None during expansion or conversion.
3662
if isinstance(val, basestring):
3663
val = self._expand_options_in_string(val)
3665
trace.warning('Cannot expand "%s":'
3666
' %s does not support option expansion'
3667
% (name, type(val)))
3669
val = found_store.unquote(val)
3671
val = opt.convert_from_unicode(found_store, val)
3674
# First of all, check if the environment can override the configuration
3676
if opt is not None and opt.override_from_env:
3677
value = opt.get_override()
3678
value = expand_and_convert(value)
3680
# Ensuring lazy loading is achieved by delaying section matching
3681
# (which implies querying the persistent storage) until it can't be
3682
# avoided anymore by using callables to describe (possibly empty)
3684
for sections in self.sections_def:
3685
for store, section in sections():
3686
value = section.get(name)
3687
if value is not None:
3690
if value is not None:
3692
value = expand_and_convert(value)
3693
if opt is not None and value is None:
3694
# If the option is registered, it may provide a default value
3695
value = opt.get_default()
3696
value = expand_and_convert(value)
3697
for hook in ConfigHooks['get']:
3698
hook(self, name, value)
3701
def expand_options(self, string, env=None):
3702
"""Expand option references in the string in the configuration context.
3704
:param string: The string containing option(s) to expand.
3706
:param env: An option dict defining additional configuration options or
3707
overriding existing ones.
3709
:returns: The expanded string.
3711
return self._expand_options_in_string(string, env)
3713
def _expand_options_in_string(self, string, env=None, _refs=None):
3714
"""Expand options in the string in the configuration context.
3716
:param string: The string to be expanded.
3718
:param env: An option dict defining additional configuration options or
3719
overriding existing ones.
3721
:param _refs: Private list (FIFO) containing the options being expanded
3724
:returns: The expanded string.
3727
# Not much to expand there
3730
# What references are currently resolved (to detect loops)
3733
# We need to iterate until no more refs appear ({{foo}} will need two
3734
# iterations for example).
3739
for is_ref, chunk in iter_option_refs(result):
3741
chunks.append(chunk)
3746
raise errors.OptionExpansionLoop(string, _refs)
3748
value = self._expand_option(name, env, _refs)
3750
raise errors.ExpandingUnknownOption(name, string)
3751
chunks.append(value)
3753
result = ''.join(chunks)
3756
def _expand_option(self, name, env, _refs):
3757
if env is not None and name in env:
3758
# Special case, values provided in env takes precedence over
3762
value = self.get(name, expand=False)
3763
value = self._expand_options_in_string(value, env, _refs)
3766
def _get_mutable_section(self):
3767
"""Get the MutableSection for the Stack.
3769
This is where we guarantee that the mutable section is lazily loaded:
3770
this means we won't load the corresponding store before setting a value
3771
or deleting an option. In practice the store will often be loaded but
3772
this helps catching some programming errors.
3775
section = store.get_mutable_section(self.mutable_section_id)
3776
return store, section
3778
def set(self, name, value):
3779
"""Set a new value for the option."""
3780
store, section = self._get_mutable_section()
3781
section.set(name, store.quote(value))
3782
for hook in ConfigHooks['set']:
3783
hook(self, name, value)
3785
def remove(self, name):
3786
"""Remove an existing option."""
3787
_, section = self._get_mutable_section()
3788
section.remove(name)
3789
for hook in ConfigHooks['remove']:
3793
# Mostly for debugging use
3794
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3796
def _get_overrides(self):
3797
# Hack around library_state.initialize never called
3798
if bzrlib.global_state is not None:
3799
return bzrlib.global_state.cmdline_overrides.get_sections()
3803
class MemoryStack(Stack):
3804
"""A configuration stack defined from a string.
3806
This is mainly intended for tests and requires no disk resources.
3809
def __init__(self, content=None):
3810
"""Create an in-memory stack from a given content.
3812
It uses a single store based on configobj and support reading and
3815
:param content: The initial content of the store. If None, the store is
3816
not loaded and ``_load_from_string`` can and should be used if
3819
store = IniFileStore()
3820
if content is not None:
3821
store._load_from_string(content)
3822
super(MemoryStack, self).__init__(
3823
[store.get_sections], store)
3826
class _CompatibleStack(Stack):
3827
"""Place holder for compatibility with previous design.
3829
This is intended to ease the transition from the Config-based design to the
3830
Stack-based design and should not be used nor relied upon by plugins.
3832
One assumption made here is that the daughter classes will all use Stores
3833
derived from LockableIniFileStore).
3835
It implements set() and remove () by re-loading the store before applying
3836
the modification and saving it.
3838
The long term plan being to implement a single write by store to save
3839
all modifications, this class should not be used in the interim.
3842
def set(self, name, value):
3845
super(_CompatibleStack, self).set(name, value)
3846
# Force a write to persistent storage
3849
def remove(self, name):
3852
super(_CompatibleStack, self).remove(name)
3853
# Force a write to persistent storage
3857
class GlobalStack(_CompatibleStack):
3858
"""Global options only stack.
3860
The following sections are queried:
3862
* command-line overrides,
3864
* the 'DEFAULT' section in bazaar.conf
3866
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3871
gstore = GlobalStore()
3872
super(GlobalStack, self).__init__(
3873
[self._get_overrides,
3874
NameMatcher(gstore, 'DEFAULT').get_sections],
3875
gstore, mutable_section_id='DEFAULT')
3878
class LocationStack(_CompatibleStack):
3879
"""Per-location options falling back to global options stack.
3882
The following sections are queried:
3884
* command-line overrides,
3886
* the sections matching ``location`` in ``locations.conf``, the order being
3887
defined by the number of path components in the section glob, higher
3888
numbers first (from most specific section to most generic).
3890
* the 'DEFAULT' section in bazaar.conf
3892
This stack will use the ``location`` section in locations.conf as its
3896
def __init__(self, location):
3897
"""Make a new stack for a location and global configuration.
3899
:param location: A URL prefix to """
3900
lstore = LocationStore()
3901
if location.startswith('file://'):
3902
location = urlutils.local_path_from_url(location)
3903
gstore = GlobalStore()
3904
super(LocationStack, self).__init__(
3905
[self._get_overrides,
3906
LocationMatcher(lstore, location).get_sections,
3907
NameMatcher(gstore, 'DEFAULT').get_sections],
3908
lstore, mutable_section_id=location)
3911
class BranchStack(_CompatibleStack):
3912
"""Per-location options falling back to branch then global options stack.
3914
The following sections are queried:
3916
* command-line overrides,
3918
* the sections matching ``location`` in ``locations.conf``, the order being
3919
defined by the number of path components in the section glob, higher
3920
numbers first (from most specific section to most generic),
3922
* the no-name section in branch.conf,
3924
* the ``DEFAULT`` section in ``bazaar.conf``.
3926
This stack will use the no-name section in ``branch.conf`` as its
3930
def __init__(self, branch):
3931
lstore = LocationStore()
3932
bstore = branch._get_config_store()
3933
gstore = GlobalStore()
3934
super(BranchStack, self).__init__(
3935
[self._get_overrides,
3936
LocationMatcher(lstore, branch.base).get_sections,
3937
NameMatcher(bstore, None).get_sections,
3938
NameMatcher(gstore, 'DEFAULT').get_sections],
3940
self.branch = branch
3943
class RemoteControlStack(_CompatibleStack):
3944
"""Remote control-only options stack."""
3946
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3947
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3948
# control.conf and is used only for stack options.
3950
def __init__(self, bzrdir):
3951
cstore = bzrdir._get_config_store()
3952
super(RemoteControlStack, self).__init__(
3953
[NameMatcher(cstore, None).get_sections],
3955
self.bzrdir = bzrdir
3958
class BranchOnlyStack(_CompatibleStack):
3959
"""Branch-only options stack."""
3961
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
3962
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
3963
# -- vila 2011-12-16
3965
def __init__(self, branch):
3966
bstore = branch._get_config_store()
3967
super(BranchOnlyStack, self).__init__(
3968
[NameMatcher(bstore, None).get_sections],
3970
self.branch = branch
3973
# Use a an empty dict to initialize an empty configobj avoiding all
3974
# parsing and encoding checks
3975
_quoting_config = configobj.ConfigObj(
3976
{}, encoding='utf-8', interpolation=False, list_values=True)
3978
class cmd_config(commands.Command):
3979
__doc__ = """Display, set or remove a configuration option.
3981
Display the active value for a given option.
3983
If --all is specified, NAME is interpreted as a regular expression and all
3984
matching options are displayed mentioning their scope. The active value
3985
that bzr will take into account is the first one displayed for each option.
3987
If no NAME is given, --all .* is implied.
3989
Setting a value is achieved by using name=value without spaces. The value
3990
is set in the most relevant scope and can be checked by displaying the
3994
takes_args = ['name?']
3998
# FIXME: This should be a registry option so that plugins can register
3999
# their own config files (or not) and will also address
4000
# http://pad.lv/788991 -- vila 20101115
4001
commands.Option('scope', help='Reduce the scope to the specified'
4002
' configuration file.',
4004
commands.Option('all',
4005
help='Display all the defined values for the matching options.',
4007
commands.Option('remove', help='Remove the option from'
4008
' the configuration file.'),
4011
_see_also = ['configuration']
4013
@commands.display_command
4014
def run(self, name=None, all=False, directory=None, scope=None,
4016
if directory is None:
4018
directory = urlutils.normalize_url(directory)
4020
raise errors.BzrError(
4021
'--all and --remove are mutually exclusive.')
4023
# Delete the option in the given scope
4024
self._remove_config_option(name, directory, scope)
4026
# Defaults to all options
4027
self._show_matching_options('.*', directory, scope)
4030
name, value = name.split('=', 1)
4032
# Display the option(s) value(s)
4034
self._show_matching_options(name, directory, scope)
4036
self._show_value(name, directory, scope)
4039
raise errors.BzrError(
4040
'Only one option can be set.')
4041
# Set the option value
4042
self._set_config_option(name, value, directory, scope)
4044
def _get_stack(self, directory, scope=None):
4045
"""Get the configuration stack specified by ``directory`` and ``scope``.
4047
:param directory: Where the configurations are derived from.
4049
:param scope: A specific config to start from.
4051
# FIXME: scope should allow access to plugin-specific stacks (even
4052
# reduced to the plugin-specific store), related to
4053
# http://pad.lv/788991 -- vila 2011-11-15
4054
if scope is not None:
4055
if scope == 'bazaar':
4056
return GlobalStack()
4057
elif scope == 'locations':
4058
return LocationStack(directory)
4059
elif scope == 'branch':
4061
controldir.ControlDir.open_containing_tree_or_branch(
4063
return br.get_config_stack()
4064
raise errors.NoSuchConfig(scope)
4068
controldir.ControlDir.open_containing_tree_or_branch(
4070
return br.get_config_stack()
4071
except errors.NotBranchError:
4072
return LocationStack(directory)
4074
def _show_value(self, name, directory, scope):
4075
conf = self._get_stack(directory, scope)
4076
value = conf.get(name, expand=True)
4077
if value is not None:
4078
# Quote the value appropriately
4079
value = _quoting_config._quote(value)
4080
self.outf.write('%s\n' % (value,))
4082
raise errors.NoSuchConfigOption(name)
4084
def _show_matching_options(self, name, directory, scope):
4085
name = lazy_regex.lazy_compile(name)
4086
# We want any error in the regexp to be raised *now* so we need to
4087
# avoid the delay introduced by the lazy regexp. But, we still do
4088
# want the nicer errors raised by lazy_regex.
4089
name._compile_and_collapse()
4092
conf = self._get_stack(directory, scope)
4093
for sections in conf.sections_def:
4094
for store, section in sections():
4095
for oname in section.iter_option_names():
4096
if name.search(oname):
4097
if cur_store_id != store.id:
4098
# Explain where the options are defined
4099
self.outf.write('%s:\n' % (store.id,))
4100
cur_store_id = store.id
4102
if (section.id is not None
4103
and cur_section != section.id):
4104
# Display the section id as it appears in the store
4105
# (None doesn't appear by definition)
4106
self.outf.write(' [%s]\n' % (section.id,))
4107
cur_section = section.id
4108
value = section.get(oname, expand=False)
4109
# Since we don't use the stack, we need to restore a
4112
opt = option_registry.get(oname)
4113
value = opt.convert_from_unicode(store, value)
4115
value = store.unquote(value)
4116
value = _quoting_config._quote(value)
4117
self.outf.write(' %s = %s\n' % (oname, value))
4119
def _set_config_option(self, name, value, directory, scope):
4120
conf = self._get_stack(directory, scope)
4121
conf.set(name, value)
4123
def _remove_config_option(self, name, directory, scope):
4125
raise errors.BzrCommandError(
4126
'--remove expects an option to remove.')
4127
conf = self._get_stack(directory, scope)
4131
raise errors.NoSuchConfigOption(name)
4136
# We need adapters that can build a Store or a Stack in a test context. Test
4137
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4138
# themselves. The builder will receive a test instance and should return a
4139
# ready-to-use store or stack. Plugins that define new store/stacks can also
4140
# register themselves here to be tested against the tests defined in
4141
# bzrlib.tests.test_config. Note that the builder can be called multiple times
4142
# for the same test.
4144
# The registered object should be a callable receiving a test instance
4145
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4147
test_store_builder_registry = registry.Registry()
4149
# The registered object should be a callable receiving a test instance
4150
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4152
test_stack_builder_registry = registry.Registry()