1508
2243
configobj[name] = value
1510
2245
configobj.setdefault(section, {})[name] = value
2246
for hook in OldConfigHooks['set']:
2247
hook(self, name, value)
2248
self._set_configobj(configobj)
2250
def remove_option(self, option_name, section_name=None):
2251
configobj = self._get_configobj()
2252
if section_name is None:
2253
del configobj[option_name]
2255
del configobj[section_name][option_name]
2256
for hook in OldConfigHooks['remove']:
2257
hook(self, option_name)
1511
2258
self._set_configobj(configobj)
1513
2260
def _get_config_file(self):
1515
return StringIO(self._transport.get_bytes(self._filename))
2262
f = StringIO(self._transport.get_bytes(self._filename))
2263
for hook in OldConfigHooks['load']:
1516
2266
except errors.NoSuchFile:
1517
2267
return StringIO()
2268
except errors.PermissionDenied, e:
2269
trace.warning("Permission denied while trying to open "
2270
"configuration file %s.", urlutils.unescape_for_display(
2271
urlutils.join(self._transport.base, self._filename), "utf-8"))
2274
def _external_url(self):
2275
return urlutils.join(self._transport.external_url(), self._filename)
1519
2277
def _get_configobj(self):
1520
return ConfigObj(self._get_config_file(), encoding='utf-8')
2278
f = self._get_config_file()
2281
conf = ConfigObj(f, encoding='utf-8')
2282
except configobj.ConfigObjError, e:
2283
raise errors.ParseConfigError(e.errors, self._external_url())
2284
except UnicodeDecodeError:
2285
raise errors.ConfigContentError(self._external_url())
1522
2290
def _set_configobj(self, configobj):
1523
2291
out_file = StringIO()
1524
2292
configobj.write(out_file)
1525
2293
out_file.seek(0)
1526
2294
self._transport.put_file(self._filename, out_file)
2295
for hook in OldConfigHooks['save']:
2299
class Option(object):
2300
"""An option definition.
2302
The option *values* are stored in config files and found in sections.
2304
Here we define various properties about the option itself, its default
2305
value, how to convert it from stores, what to do when invalid values are
2306
encoutered, in which config files it can be stored.
2309
def __init__(self, name, override_from_env=None,
2310
default=None, default_from_env=None,
2311
help=None, from_unicode=None, invalid=None, unquote=True):
2312
"""Build an option definition.
2314
:param name: the name used to refer to the option.
2316
:param override_from_env: A list of environment variables which can
2317
provide override any configuration setting.
2319
:param default: the default value to use when none exist in the config
2320
stores. This is either a string that ``from_unicode`` will convert
2321
into the proper type, a callable returning a unicode string so that
2322
``from_unicode`` can be used on the return value, or a python
2323
object that can be stringified (so only the empty list is supported
2326
:param default_from_env: A list of environment variables which can
2327
provide a default value. 'default' will be used only if none of the
2328
variables specified here are set in the environment.
2330
:param help: a doc string to explain the option to the user.
2332
:param from_unicode: a callable to convert the unicode string
2333
representing the option value in a store. This is not called for
2336
:param invalid: the action to be taken when an invalid value is
2337
encountered in a store. This is called only when from_unicode is
2338
invoked to convert a string and returns None or raise ValueError or
2339
TypeError. Accepted values are: None (ignore invalid values),
2340
'warning' (emit a warning), 'error' (emit an error message and
2343
:param unquote: should the unicode value be unquoted before conversion.
2344
This should be used only when the store providing the values cannot
2345
safely unquote them (see http://pad.lv/906897). It is provided so
2346
daughter classes can handle the quoting themselves.
2348
if override_from_env is None:
2349
override_from_env = []
2350
if default_from_env is None:
2351
default_from_env = []
2353
self.override_from_env = override_from_env
2354
# Convert the default value to a unicode string so all values are
2355
# strings internally before conversion (via from_unicode) is attempted.
2358
elif isinstance(default, list):
2359
# Only the empty list is supported
2361
raise AssertionError(
2362
'Only empty lists are supported as default values')
2364
elif isinstance(default, (str, unicode, bool, int, float)):
2365
# Rely on python to convert strings, booleans and integers
2366
self.default = u'%s' % (default,)
2367
elif callable(default):
2368
self.default = default
2370
# other python objects are not expected
2371
raise AssertionError('%r is not supported as a default value'
2373
self.default_from_env = default_from_env
2375
self.from_unicode = from_unicode
2376
self.unquote = unquote
2377
if invalid and invalid not in ('warning', 'error'):
2378
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2379
self.invalid = invalid
2385
def convert_from_unicode(self, store, unicode_value):
2386
if self.unquote and store is not None and unicode_value is not None:
2387
unicode_value = store.unquote(unicode_value)
2388
if self.from_unicode is None or unicode_value is None:
2389
# Don't convert or nothing to convert
2390
return unicode_value
2392
converted = self.from_unicode(unicode_value)
2393
except (ValueError, TypeError):
2394
# Invalid values are ignored
2396
if converted is None and self.invalid is not None:
2397
# The conversion failed
2398
if self.invalid == 'warning':
2399
trace.warning('Value "%s" is not valid for "%s"',
2400
unicode_value, self.name)
2401
elif self.invalid == 'error':
2402
raise errors.ConfigOptionValueError(self.name, unicode_value)
2405
def get_override(self):
2407
for var in self.override_from_env:
2409
# If the env variable is defined, its value takes precedence
2410
value = os.environ[var].decode(osutils.get_user_encoding())
2416
def get_default(self):
2418
for var in self.default_from_env:
2420
# If the env variable is defined, its value is the default one
2421
value = os.environ[var].decode(osutils.get_user_encoding())
2426
# Otherwise, fallback to the value defined at registration
2427
if callable(self.default):
2428
value = self.default()
2429
if not isinstance(value, unicode):
2430
raise AssertionError(
2431
'Callable default values should be unicode')
2433
value = self.default
2436
def get_help_text(self, additional_see_also=None, plain=True):
2438
from bzrlib import help_topics
2439
result += help_topics._format_see_also(additional_see_also)
2441
result = help_topics.help_as_plain_text(result)
2445
# Predefined converters to get proper values from store
2447
def bool_from_store(unicode_str):
2448
return ui.bool_from_string(unicode_str)
2451
def int_from_store(unicode_str):
2452
return int(unicode_str)
2455
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2457
def int_SI_from_store(unicode_str):
2458
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2460
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2461
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2464
:return Integer, expanded to its base-10 value if a proper SI unit is
2465
found, None otherwise.
2467
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2468
p = re.compile(regexp, re.IGNORECASE)
2469
m = p.match(unicode_str)
2472
val, _, unit = m.groups()
2476
coeff = _unit_suffixes[unit.upper()]
2478
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2483
def float_from_store(unicode_str):
2484
return float(unicode_str)
2487
# Use a an empty dict to initialize an empty configobj avoiding all
2488
# parsing and encoding checks
2489
_list_converter_config = configobj.ConfigObj(
2490
{}, encoding='utf-8', list_values=True, interpolation=False)
2493
class ListOption(Option):
2495
def __init__(self, name, default=None, default_from_env=None,
2496
help=None, invalid=None):
2497
"""A list Option definition.
2499
This overrides the base class so the conversion from a unicode string
2500
can take quoting into account.
2502
super(ListOption, self).__init__(
2503
name, default=default, default_from_env=default_from_env,
2504
from_unicode=self.from_unicode, help=help,
2505
invalid=invalid, unquote=False)
2507
def from_unicode(self, unicode_str):
2508
if not isinstance(unicode_str, basestring):
2510
# Now inject our string directly as unicode. All callers got their
2511
# value from configobj, so values that need to be quoted are already
2513
_list_converter_config.reset()
2514
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2515
maybe_list = _list_converter_config['list']
2516
if isinstance(maybe_list, basestring):
2518
# A single value, most probably the user forgot (or didn't care
2519
# to add) the final ','
2522
# The empty string, convert to empty list
2525
# We rely on ConfigObj providing us with a list already
2530
class RegistryOption(Option):
2531
"""Option for a choice from a registry."""
2533
def __init__(self, name, registry, default_from_env=None,
2534
help=None, invalid=None):
2535
"""A registry based Option definition.
2537
This overrides the base class so the conversion from a unicode string
2538
can take quoting into account.
2540
super(RegistryOption, self).__init__(
2541
name, default=lambda: unicode(registry.default_key),
2542
default_from_env=default_from_env,
2543
from_unicode=self.from_unicode, help=help,
2544
invalid=invalid, unquote=False)
2545
self.registry = registry
2547
def from_unicode(self, unicode_str):
2548
if not isinstance(unicode_str, basestring):
2551
return self.registry.get(unicode_str)
2554
"Invalid value %s for %s."
2555
"See help for a list of possible values." % (unicode_str,
2560
ret = [self._help, "\n\nThe following values are supported:\n"]
2561
for key in self.registry.keys():
2562
ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
2566
class OptionRegistry(registry.Registry):
2567
"""Register config options by their name.
2569
This overrides ``registry.Registry`` to simplify registration by acquiring
2570
some information from the option object itself.
2573
def register(self, option):
2574
"""Register a new option to its name.
2576
:param option: The option to register. Its name is used as the key.
2578
super(OptionRegistry, self).register(option.name, option,
2581
def register_lazy(self, key, module_name, member_name):
2582
"""Register a new option to be loaded on request.
2584
:param key: the key to request the option later. Since the registration
2585
is lazy, it should be provided and match the option name.
2587
:param module_name: the python path to the module. Such as 'os.path'.
2589
:param member_name: the member of the module to return. If empty or
2590
None, get() will return the module itself.
2592
super(OptionRegistry, self).register_lazy(key,
2593
module_name, member_name)
2595
def get_help(self, key=None):
2596
"""Get the help text associated with the given key"""
2597
option = self.get(key)
2598
the_help = option.help
2599
if callable(the_help):
2600
return the_help(self, key)
2604
option_registry = OptionRegistry()
2607
# Registered options in lexicographical order
2609
option_registry.register(
2610
Option('append_revisions_only',
2611
default=None, from_unicode=bool_from_store, invalid='warning',
2613
Whether to only append revisions to the mainline.
2615
If this is set to true, then it is not possible to change the
2616
existing mainline of the branch.
2618
option_registry.register(
2619
ListOption('acceptable_keys',
2622
List of GPG key patterns which are acceptable for verification.
2624
option_registry.register(
2625
Option('add.maximum_file_size',
2626
default=u'20MB', from_unicode=int_SI_from_store,
2628
Size above which files should be added manually.
2630
Files below this size are added automatically when using ``bzr add`` without
2633
A negative value means disable the size check.
2635
option_registry.register(
2637
default=None, from_unicode=bool_from_store,
2639
Is the branch bound to ``bound_location``.
2641
If set to "True", the branch should act as a checkout, and push each commit to
2642
the bound_location. This option is normally set by ``bind``/``unbind``.
2644
See also: bound_location.
2646
option_registry.register(
2647
Option('bound_location',
2650
The location that commits should go to when acting as a checkout.
2652
This option is normally set by ``bind``.
2656
option_registry.register(
2657
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2659
Whether revisions associated with tags should be fetched.
2661
option_registry.register_lazy(
2662
'bzr.transform.orphan_policy', 'bzrlib.transform', 'opt_transform_orphan')
2663
option_registry.register(
2664
Option('bzr.workingtree.worth_saving_limit', default=10,
2665
from_unicode=int_from_store, invalid='warning',
2667
How many changes before saving the dirstate.
2669
-1 means that we will never rewrite the dirstate file for only
2670
stat-cache changes. Regardless of this setting, we will always rewrite
2671
the dirstate file if a file is added/removed/renamed/etc. This flag only
2672
affects the behavior of updating the dirstate file after we notice that
2673
a file has been touched.
2675
option_registry.register(
2676
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2677
from_unicode=signature_policy_from_unicode,
2679
GPG checking policy.
2681
Possible values: require, ignore, check-available (default)
2683
this option will control whether bzr will require good gpg
2684
signatures, ignore them, or check them if they are
2687
option_registry.register(
2688
Option('child_submit_format',
2689
help='''The preferred format of submissions to this branch.'''))
2690
option_registry.register(
2691
Option('child_submit_to',
2692
help='''Where submissions to this branch are mailed to.'''))
2693
option_registry.register(
2694
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2695
from_unicode=signing_policy_from_unicode,
2699
Possible values: always, never, when-required (default)
2701
This option controls whether bzr will always create
2702
gpg signatures or not on commits.
2704
option_registry.register(
2705
Option('dirstate.fdatasync', default=True,
2706
from_unicode=bool_from_store,
2708
Flush dirstate changes onto physical disk?
2710
If true (default), working tree metadata changes are flushed through the
2711
OS buffers to physical disk. This is somewhat slower, but means data
2712
should not be lost if the machine crashes. See also repository.fdatasync.
2714
option_registry.register(
2715
ListOption('debug_flags', default=[],
2716
help='Debug flags to activate.'))
2717
option_registry.register(
2718
Option('default_format', default='2a',
2719
help='Format used when creating branches.'))
2720
option_registry.register(
2721
Option('dpush_strict', default=None,
2722
from_unicode=bool_from_store,
2724
The default value for ``dpush --strict``.
2726
If present, defines the ``--strict`` option default value for checking
2727
uncommitted changes before pushing into a different VCS without any
2728
custom bzr metadata.
2730
option_registry.register(
2732
help='The command called to launch an editor to enter a message.'))
2733
option_registry.register(
2734
Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
2735
help='The users identity'))
2736
option_registry.register(
2737
Option('gpg_signing_command',
2740
Program to use use for creating signatures.
2742
This should support at least the -u and --clearsign options.
2744
option_registry.register(
2745
Option('gpg_signing_key',
2748
GPG key to use for signing.
2750
This defaults to the first key associated with the users email.
2752
option_registry.register(
2753
Option('ignore_missing_extensions', default=False,
2754
from_unicode=bool_from_store,
2756
Control the missing extensions warning display.
2758
The warning will not be emitted if set to True.
2760
option_registry.register(
2762
help='Language to translate messages into.'))
2763
option_registry.register(
2764
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2766
Steal locks that appears to be dead.
2768
If set to True, bzr will check if a lock is supposed to be held by an
2769
active process from the same user on the same machine. If the user and
2770
machine match, but no process with the given PID is active, then bzr
2771
will automatically break the stale lock, and create a new lock for
2773
Otherwise, bzr will prompt as normal to break the lock.
2775
option_registry.register(
2776
Option('log_format', default='long',
2778
Log format to use when displaying revisions.
2780
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2781
may be provided by plugins.
2783
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
2785
option_registry.register(
2786
Option('output_encoding',
2787
help= 'Unicode encoding for output'
2788
' (terminal encoding if not specified).'))
2789
option_registry.register(
2790
Option('parent_location',
2793
The location of the default branch for pull or merge.
2795
This option is normally set when creating a branch, the first ``pull`` or by
2796
``pull --remember``.
2798
option_registry.register(
2799
Option('post_commit', default=None,
2801
Post commit functions.
2803
An ordered list of python functions to call, separated by spaces.
2805
Each function takes branch, rev_id as parameters.
2807
option_registry.register(
2808
Option('public_branch',
2811
A publically-accessible version of this branch.
2813
This implies that the branch setting this option is not publically-accessible.
2814
Used and set by ``bzr send``.
2816
option_registry.register(
2817
Option('push_location',
2820
The location of the default branch for push.
2822
This option is normally set by the first ``push`` or ``push --remember``.
2824
option_registry.register(
2825
Option('push_strict', default=None,
2826
from_unicode=bool_from_store,
2828
The default value for ``push --strict``.
2830
If present, defines the ``--strict`` option default value for checking
2831
uncommitted changes before sending a merge directive.
2833
option_registry.register(
2834
Option('repository.fdatasync', default=True,
2835
from_unicode=bool_from_store,
2837
Flush repository changes onto physical disk?
2839
If true (default), repository changes are flushed through the OS buffers
2840
to physical disk. This is somewhat slower, but means data should not be
2841
lost if the machine crashes. See also dirstate.fdatasync.
2843
option_registry.register_lazy('smtp_server',
2844
'bzrlib.smtp_connection', 'smtp_server')
2845
option_registry.register_lazy('smtp_password',
2846
'bzrlib.smtp_connection', 'smtp_password')
2847
option_registry.register_lazy('smtp_username',
2848
'bzrlib.smtp_connection', 'smtp_username')
2849
option_registry.register(
2850
Option('selftest.timeout',
2852
from_unicode=int_from_store,
2853
help='Abort selftest if one test takes longer than this many seconds',
2856
option_registry.register(
2857
Option('send_strict', default=None,
2858
from_unicode=bool_from_store,
2860
The default value for ``send --strict``.
2862
If present, defines the ``--strict`` option default value for checking
2863
uncommitted changes before sending a bundle.
2866
option_registry.register(
2867
Option('serve.client_timeout',
2868
default=300.0, from_unicode=float_from_store,
2869
help="If we wait for a new request from a client for more than"
2870
" X seconds, consider the client idle, and hangup."))
2871
option_registry.register(
2872
Option('stacked_on_location',
2874
help="""The location where this branch is stacked on."""))
2875
option_registry.register(
2876
Option('submit_branch',
2879
The branch you intend to submit your current work to.
2881
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2882
by the ``submit:`` revision spec.
2884
option_registry.register(
2886
help='''Where submissions from this branch are mailed to.'''))
2887
option_registry.register(
2888
ListOption('suppress_warnings',
2890
help="List of warning classes to suppress."))
2891
option_registry.register(
2892
Option('validate_signatures_in_log', default=False,
2893
from_unicode=bool_from_store, invalid='warning',
2894
help='''Whether to validate signatures in bzr log.'''))
2895
option_registry.register_lazy('ssl.ca_certs',
2896
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2898
option_registry.register_lazy('ssl.cert_reqs',
2899
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2903
class Section(object):
2904
"""A section defines a dict of option name => value.
2906
This is merely a read-only dict which can add some knowledge about the
2907
options. It is *not* a python dict object though and doesn't try to mimic
2911
def __init__(self, section_id, options):
2912
self.id = section_id
2913
# We re-use the dict-like object received
2914
self.options = options
2916
def get(self, name, default=None, expand=True):
2917
return self.options.get(name, default)
2919
def iter_option_names(self):
2920
for k in self.options.iterkeys():
2924
# Mostly for debugging use
2925
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2928
_NewlyCreatedOption = object()
2929
"""Was the option created during the MutableSection lifetime"""
2930
_DeletedOption = object()
2931
"""Was the option deleted during the MutableSection lifetime"""
2934
class MutableSection(Section):
2935
"""A section allowing changes and keeping track of the original values."""
2937
def __init__(self, section_id, options):
2938
super(MutableSection, self).__init__(section_id, options)
2939
self.reset_changes()
2941
def set(self, name, value):
2942
if name not in self.options:
2943
# This is a new option
2944
self.orig[name] = _NewlyCreatedOption
2945
elif name not in self.orig:
2946
self.orig[name] = self.get(name, None)
2947
self.options[name] = value
2949
def remove(self, name):
2950
if name not in self.orig:
2951
self.orig[name] = self.get(name, None)
2952
del self.options[name]
2954
def reset_changes(self):
2957
def apply_changes(self, dirty, store):
2958
"""Apply option value changes.
2960
``self`` has been reloaded from the persistent storage. ``dirty``
2961
contains the changes made since the previous loading.
2963
:param dirty: the mutable section containing the changes.
2965
:param store: the store containing the section
2967
for k, expected in dirty.orig.iteritems():
2968
actual = dirty.get(k, _DeletedOption)
2969
reloaded = self.get(k, _NewlyCreatedOption)
2970
if actual is _DeletedOption:
2971
if k in self.options:
2975
# Report concurrent updates in an ad-hoc way. This should only
2976
# occurs when different processes try to update the same option
2977
# which is not supported (as in: the config framework is not meant
2978
# to be used a sharing mechanism).
2979
if expected != reloaded:
2980
if actual is _DeletedOption:
2981
actual = '<DELETED>'
2982
if reloaded is _NewlyCreatedOption:
2983
reloaded = '<CREATED>'
2984
if expected is _NewlyCreatedOption:
2985
expected = '<CREATED>'
2986
# Someone changed the value since we get it from the persistent
2988
trace.warning(gettext(
2989
"Option {0} in section {1} of {2} was changed"
2990
" from {3} to {4}. The {5} value will be saved.".format(
2991
k, self.id, store.external_url(), expected,
2993
# No need to keep track of these changes
2994
self.reset_changes()
2997
class Store(object):
2998
"""Abstract interface to persistent storage for configuration options."""
3000
readonly_section_class = Section
3001
mutable_section_class = MutableSection
3004
# Which sections need to be saved
3005
self.dirty_sections = []
3007
def is_loaded(self):
3008
"""Returns True if the Store has been loaded.
3010
This is used to implement lazy loading and ensure the persistent
3011
storage is queried only when needed.
3013
raise NotImplementedError(self.is_loaded)
3016
"""Loads the Store from persistent storage."""
3017
raise NotImplementedError(self.load)
3019
def _load_from_string(self, bytes):
3020
"""Create a store from a string in configobj syntax.
3022
:param bytes: A string representing the file content.
3024
raise NotImplementedError(self._load_from_string)
3027
"""Unloads the Store.
3029
This should make is_loaded() return False. This is used when the caller
3030
knows that the persistent storage has changed or may have change since
3033
raise NotImplementedError(self.unload)
3035
def quote(self, value):
3036
"""Quote a configuration option value for storing purposes.
3038
This allows Stacks to present values as they will be stored.
3042
def unquote(self, value):
3043
"""Unquote a configuration option value into unicode.
3045
The received value is quoted as stored.
3050
"""Saves the Store to persistent storage."""
3051
raise NotImplementedError(self.save)
3053
def _need_saving(self):
3054
for s in self.dirty_sections:
3056
# At least one dirty section contains a modification
3060
def apply_changes(self, dirty_sections):
3061
"""Apply changes from dirty sections while checking for coherency.
3063
The Store content is discarded and reloaded from persistent storage to
3064
acquire up-to-date values.
3066
Dirty sections are MutableSection which kept track of the value they
3067
are expected to update.
3069
# We need an up-to-date version from the persistent storage, unload the
3070
# store. The reload will occur when needed (triggered by the first
3071
# get_mutable_section() call below.
3073
# Apply the changes from the preserved dirty sections
3074
for dirty in dirty_sections:
3075
clean = self.get_mutable_section(dirty.id)
3076
clean.apply_changes(dirty, self)
3077
# Everything is clean now
3078
self.dirty_sections = []
3080
def save_changes(self):
3081
"""Saves the Store to persistent storage if changes occurred.
3083
Apply the changes recorded in the mutable sections to a store content
3084
refreshed from persistent storage.
3086
raise NotImplementedError(self.save_changes)
3088
def external_url(self):
3089
raise NotImplementedError(self.external_url)
3091
def get_sections(self):
3092
"""Returns an ordered iterable of existing sections.
3094
:returns: An iterable of (store, section).
3096
raise NotImplementedError(self.get_sections)
3098
def get_mutable_section(self, section_id=None):
3099
"""Returns the specified mutable section.
3101
:param section_id: The section identifier
3103
raise NotImplementedError(self.get_mutable_section)
3106
# Mostly for debugging use
3107
return "<config.%s(%s)>" % (self.__class__.__name__,
3108
self.external_url())
3111
class CommandLineStore(Store):
3112
"A store to carry command line overrides for the config options."""
3114
def __init__(self, opts=None):
3115
super(CommandLineStore, self).__init__()
3122
# The dict should be cleared but not replaced so it can be shared.
3123
self.options.clear()
3125
def _from_cmdline(self, overrides):
3126
# Reset before accepting new definitions
3128
for over in overrides:
3130
name, value = over.split('=', 1)
3132
raise errors.BzrCommandError(
3133
gettext("Invalid '%s', should be of the form 'name=value'")
3135
self.options[name] = value
3137
def external_url(self):
3138
# Not an url but it makes debugging easier and is never needed
3142
def get_sections(self):
3143
yield self, self.readonly_section_class(None, self.options)
3146
class IniFileStore(Store):
3147
"""A config Store using ConfigObj for storage.
3149
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3150
serialize/deserialize the config file.
3154
"""A config Store using ConfigObj for storage.
3156
super(IniFileStore, self).__init__()
3157
self._config_obj = None
3159
def is_loaded(self):
3160
return self._config_obj != None
3163
self._config_obj = None
3164
self.dirty_sections = []
3166
def _load_content(self):
3167
"""Load the config file bytes.
3169
This should be provided by subclasses
3171
:return: Byte string
3173
raise NotImplementedError(self._load_content)
3175
def _save_content(self, content):
3176
"""Save the config file bytes.
3178
This should be provided by subclasses
3180
:param content: Config file bytes to write
3182
raise NotImplementedError(self._save_content)
3185
"""Load the store from the associated file."""
3186
if self.is_loaded():
3188
content = self._load_content()
3189
self._load_from_string(content)
3190
for hook in ConfigHooks['load']:
3193
def _load_from_string(self, bytes):
3194
"""Create a config store from a string.
3196
:param bytes: A string representing the file content.
3198
if self.is_loaded():
3199
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3200
co_input = StringIO(bytes)
3202
# The config files are always stored utf8-encoded
3203
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3205
except configobj.ConfigObjError, e:
3206
self._config_obj = None
3207
raise errors.ParseConfigError(e.errors, self.external_url())
3208
except UnicodeDecodeError:
3209
raise errors.ConfigContentError(self.external_url())
3211
def save_changes(self):
3212
if not self.is_loaded():
3215
if not self._need_saving():
3217
# Preserve the current version
3218
current = self._config_obj
3219
dirty_sections = list(self.dirty_sections)
3220
self.apply_changes(dirty_sections)
3221
# Save to the persistent storage
3225
if not self.is_loaded():
3229
self._config_obj.write(out)
3230
self._save_content(out.getvalue())
3231
for hook in ConfigHooks['save']:
3234
def get_sections(self):
3235
"""Get the configobj section in the file order.
3237
:returns: An iterable of (store, section).
3239
# We need a loaded store
3242
except (errors.NoSuchFile, errors.PermissionDenied):
3243
# If the file can't be read, there is no sections
3245
cobj = self._config_obj
3247
yield self, self.readonly_section_class(None, cobj)
3248
for section_name in cobj.sections:
3250
self.readonly_section_class(section_name,
3251
cobj[section_name]))
3253
def get_mutable_section(self, section_id=None):
3254
# We need a loaded store
3257
except errors.NoSuchFile:
3258
# The file doesn't exist, let's pretend it was empty
3259
self._load_from_string('')
3260
if section_id is None:
3261
section = self._config_obj
3263
section = self._config_obj.setdefault(section_id, {})
3264
mutable_section = self.mutable_section_class(section_id, section)
3265
# All mutable sections can become dirty
3266
self.dirty_sections.append(mutable_section)
3267
return mutable_section
3269
def quote(self, value):
3271
# configobj conflates automagical list values and quoting
3272
self._config_obj.list_values = True
3273
return self._config_obj._quote(value)
3275
self._config_obj.list_values = False
3277
def unquote(self, value):
3278
if value and isinstance(value, basestring):
3279
# _unquote doesn't handle None nor empty strings nor anything that
3280
# is not a string, really.
3281
value = self._config_obj._unquote(value)
3284
def external_url(self):
3285
# Since an IniFileStore can be used without a file (at least in tests),
3286
# it's better to provide something than raising a NotImplementedError.
3287
# All daughter classes are supposed to provide an implementation
3289
return 'In-Process Store, no URL'
3291
class TransportIniFileStore(IniFileStore):
3292
"""IniFileStore that loads files from a transport.
3294
:ivar transport: The transport object where the config file is located.
3296
:ivar file_name: The config file basename in the transport directory.
3299
def __init__(self, transport, file_name):
3300
"""A Store using a ini file on a Transport
3302
:param transport: The transport object where the config file is located.
3303
:param file_name: The config file basename in the transport directory.
3305
super(TransportIniFileStore, self).__init__()
3306
self.transport = transport
3307
self.file_name = file_name
3309
def _load_content(self):
3311
return self.transport.get_bytes(self.file_name)
3312
except errors.PermissionDenied:
3313
trace.warning("Permission denied while trying to load "
3314
"configuration store %s.", self.external_url())
3317
def _save_content(self, content):
3318
self.transport.put_bytes(self.file_name, content)
3320
def external_url(self):
3321
# FIXME: external_url should really accepts an optional relpath
3322
# parameter (bug #750169) :-/ -- vila 2011-04-04
3323
# The following will do in the interim but maybe we don't want to
3324
# expose a path here but rather a config ID and its associated
3325
# object </hand wawe>.
3326
return urlutils.join(self.transport.external_url(), self.file_name)
3329
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3330
# unlockable stores for use with objects that can already ensure the locking
3331
# (think branches). If different stores (not based on ConfigObj) are created,
3332
# they may face the same issue.
3335
class LockableIniFileStore(TransportIniFileStore):
3336
"""A ConfigObjStore using locks on save to ensure store integrity."""
3338
def __init__(self, transport, file_name, lock_dir_name=None):
3339
"""A config Store using ConfigObj for storage.
3341
:param transport: The transport object where the config file is located.
3343
:param file_name: The config file basename in the transport directory.
3345
if lock_dir_name is None:
3346
lock_dir_name = 'lock'
3347
self.lock_dir_name = lock_dir_name
3348
super(LockableIniFileStore, self).__init__(transport, file_name)
3349
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3351
def lock_write(self, token=None):
3352
"""Takes a write lock in the directory containing the config file.
3354
If the directory doesn't exist it is created.
3356
# FIXME: This doesn't check the ownership of the created directories as
3357
# ensure_config_dir_exists does. It should if the transport is local
3358
# -- vila 2011-04-06
3359
self.transport.create_prefix()
3360
return self._lock.lock_write(token)
3365
def break_lock(self):
3366
self._lock.break_lock()
3370
# We need to be able to override the undecorated implementation
3371
self.save_without_locking()
3373
def save_without_locking(self):
3374
super(LockableIniFileStore, self).save()
3377
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3378
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3379
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3381
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3382
# functions or a registry will make it easier and clearer for tests, focusing
3383
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3384
# on a poolie's remark)
3385
class GlobalStore(LockableIniFileStore):
3387
def __init__(self, possible_transports=None):
3388
t = transport.get_transport_from_path(
3389
config_dir(), possible_transports=possible_transports)
3390
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3394
class LocationStore(LockableIniFileStore):
3396
def __init__(self, possible_transports=None):
3397
t = transport.get_transport_from_path(
3398
config_dir(), possible_transports=possible_transports)
3399
super(LocationStore, self).__init__(t, 'locations.conf')
3400
self.id = 'locations'
3403
class BranchStore(TransportIniFileStore):
3405
def __init__(self, branch):
3406
super(BranchStore, self).__init__(branch.control_transport,
3408
self.branch = branch
3411
def lock_write(self, token=None):
3412
return self.branch.lock_write(token)
3415
return self.branch.unlock()
3419
# We need to be able to override the undecorated implementation
3420
self.save_without_locking()
3422
def save_without_locking(self):
3423
super(BranchStore, self).save()
3426
class ControlStore(LockableIniFileStore):
3428
def __init__(self, bzrdir):
3429
super(ControlStore, self).__init__(bzrdir.transport,
3431
lock_dir_name='branch_lock')
3435
class SectionMatcher(object):
3436
"""Select sections into a given Store.
3438
This is intended to be used to postpone getting an iterable of sections
3442
def __init__(self, store):
3445
def get_sections(self):
3446
# This is where we require loading the store so we can see all defined
3448
sections = self.store.get_sections()
3449
# Walk the revisions in the order provided
3450
for store, s in sections:
3454
def match(self, section):
3455
"""Does the proposed section match.
3457
:param section: A Section object.
3459
:returns: True if the section matches, False otherwise.
3461
raise NotImplementedError(self.match)
3464
class NameMatcher(SectionMatcher):
3466
def __init__(self, store, section_id):
3467
super(NameMatcher, self).__init__(store)
3468
self.section_id = section_id
3470
def match(self, section):
3471
return section.id == self.section_id
3474
class LocationSection(Section):
3476
def __init__(self, section, extra_path):
3477
super(LocationSection, self).__init__(section.id, section.options)
3478
self.extra_path = extra_path
3479
self.locals = {'relpath': extra_path,
3480
'basename': urlutils.basename(extra_path)}
3482
def get(self, name, default=None, expand=True):
3483
value = super(LocationSection, self).get(name, default)
3484
if value is not None and expand:
3485
policy_name = self.get(name + ':policy', None)
3486
policy = _policy_value.get(policy_name, POLICY_NONE)
3487
if policy == POLICY_APPENDPATH:
3488
value = urlutils.join(value, self.extra_path)
3489
# expand section local options right now (since POLICY_APPENDPATH
3490
# will never add options references, it's ok to expand after it).
3492
for is_ref, chunk in iter_option_refs(value):
3494
chunks.append(chunk)
3497
if ref in self.locals:
3498
chunks.append(self.locals[ref])
3500
chunks.append(chunk)
3501
value = ''.join(chunks)
3505
class StartingPathMatcher(SectionMatcher):
3506
"""Select sections for a given location respecting the Store order."""
3508
# FIXME: Both local paths and urls can be used for section names as well as
3509
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3510
# inherited the fuzziness from the previous ``LocationConfig``
3511
# implementation. We probably need to revisit which encoding is allowed for
3512
# both ``location`` and section names and how we normalize
3513
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3514
# related too. -- vila 2012-01-04
3516
def __init__(self, store, location):
3517
super(StartingPathMatcher, self).__init__(store)
3518
if location.startswith('file://'):
3519
location = urlutils.local_path_from_url(location)
3520
self.location = location
3522
def get_sections(self):
3523
"""Get all sections matching ``location`` in the store.
3525
The most generic sections are described first in the store, then more
3526
specific ones can be provided for reduced scopes.
3528
The returned section are therefore returned in the reversed order so
3529
the most specific ones can be found first.
3531
location_parts = self.location.rstrip('/').split('/')
3534
# Later sections are more specific, they should be returned first
3535
for _, section in reversed(list(store.get_sections())):
3536
if section.id is None:
3537
# The no-name section is always included if present
3538
yield store, LocationSection(section, self.location)
3540
section_path = section.id
3541
if section_path.startswith('file://'):
3542
# the location is already a local path or URL, convert the
3543
# section id to the same format
3544
section_path = urlutils.local_path_from_url(section_path)
3545
if (self.location.startswith(section_path)
3546
or fnmatch.fnmatch(self.location, section_path)):
3547
section_parts = section_path.rstrip('/').split('/')
3548
extra_path = '/'.join(location_parts[len(section_parts):])
3549
yield store, LocationSection(section, extra_path)
3552
class LocationMatcher(SectionMatcher):
3554
def __init__(self, store, location):
3555
super(LocationMatcher, self).__init__(store)
3556
if location.startswith('file://'):
3557
location = urlutils.local_path_from_url(location)
3558
self.location = location
3560
def _get_matching_sections(self):
3561
"""Get all sections matching ``location``."""
3562
# We slightly diverge from LocalConfig here by allowing the no-name
3563
# section as the most generic one and the lower priority.
3564
no_name_section = None
3566
# Filter out the no_name_section so _iter_for_location_by_parts can be
3567
# used (it assumes all sections have a name).
3568
for _, section in self.store.get_sections():
3569
if section.id is None:
3570
no_name_section = section
3572
all_sections.append(section)
3573
# Unfortunately _iter_for_location_by_parts deals with section names so
3574
# we have to resync.
3575
filtered_sections = _iter_for_location_by_parts(
3576
[s.id for s in all_sections], self.location)
3577
iter_all_sections = iter(all_sections)
3578
matching_sections = []
3579
if no_name_section is not None:
3580
matching_sections.append(
3581
(0, LocationSection(no_name_section, self.location)))
3582
for section_id, extra_path, length in filtered_sections:
3583
# a section id is unique for a given store so it's safe to take the
3584
# first matching section while iterating. Also, all filtered
3585
# sections are part of 'all_sections' and will always be found
3588
section = iter_all_sections.next()
3589
if section_id == section.id:
3590
matching_sections.append(
3591
(length, LocationSection(section, extra_path)))
3593
return matching_sections
3595
def get_sections(self):
3596
# Override the default implementation as we want to change the order
3597
matching_sections = self._get_matching_sections()
3598
# We want the longest (aka more specific) locations first
3599
sections = sorted(matching_sections,
3600
key=lambda (length, section): (length, section.id),
3602
# Sections mentioning 'ignore_parents' restrict the selection
3603
for _, section in sections:
3604
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3605
ignore = section.get('ignore_parents', None)
3606
if ignore is not None:
3607
ignore = ui.bool_from_string(ignore)
3610
# Finally, we have a valid section
3611
yield self.store, section
3614
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3615
"""Describes an expandable option reference.
3617
We want to match the most embedded reference first.
3619
I.e. for '{{foo}}' we will get '{foo}',
3620
for '{bar{baz}}' we will get '{baz}'
3623
def iter_option_refs(string):
3624
# Split isolate refs so every other chunk is a ref
3626
for chunk in _option_ref_re.split(string):
3631
class Stack(object):
3632
"""A stack of configurations where an option can be defined"""
3634
def __init__(self, sections_def, store=None, mutable_section_id=None):
3635
"""Creates a stack of sections with an optional store for changes.
3637
:param sections_def: A list of Section or callables that returns an
3638
iterable of Section. This defines the Sections for the Stack and
3639
can be called repeatedly if needed.
3641
:param store: The optional Store where modifications will be
3642
recorded. If none is specified, no modifications can be done.
3644
:param mutable_section_id: The id of the MutableSection where changes
3645
are recorded. This requires the ``store`` parameter to be
3648
self.sections_def = sections_def
3650
self.mutable_section_id = mutable_section_id
3652
def get(self, name, expand=None):
3653
"""Return the *first* option value found in the sections.
3655
This is where we guarantee that sections coming from Store are loaded
3656
lazily: the loading is delayed until we need to either check that an
3657
option exists or get its value, which in turn may require to discover
3658
in which sections it can be defined. Both of these (section and option
3659
existence) require loading the store (even partially).
3661
:param name: The queried option.
3663
:param expand: Whether options references should be expanded.
3665
:returns: The value of the option.
3667
# FIXME: No caching of options nor sections yet -- vila 20110503
3669
expand = _get_expand_default_value()
3671
found_store = None # Where the option value has been found
3672
# If the option is registered, it may provide additional info about
3675
opt = option_registry.get(name)
3680
def expand_and_convert(val):
3681
# This may need to be called in different contexts if the value is
3682
# None or ends up being None during expansion or conversion.
3685
if isinstance(val, basestring):
3686
val = self._expand_options_in_string(val)
3688
trace.warning('Cannot expand "%s":'
3689
' %s does not support option expansion'
3690
% (name, type(val)))
3692
val = found_store.unquote(val)
3694
val = opt.convert_from_unicode(found_store, val)
3697
# First of all, check if the environment can override the configuration
3699
if opt is not None and opt.override_from_env:
3700
value = opt.get_override()
3701
value = expand_and_convert(value)
3703
# Ensuring lazy loading is achieved by delaying section matching
3704
# (which implies querying the persistent storage) until it can't be
3705
# avoided anymore by using callables to describe (possibly empty)
3707
for sections in self.sections_def:
3708
for store, section in sections():
3709
value = section.get(name)
3710
if value is not None:
3713
if value is not None:
3715
value = expand_and_convert(value)
3716
if opt is not None and value is None:
3717
# If the option is registered, it may provide a default value
3718
value = opt.get_default()
3719
value = expand_and_convert(value)
3720
for hook in ConfigHooks['get']:
3721
hook(self, name, value)
3724
def expand_options(self, string, env=None):
3725
"""Expand option references in the string in the configuration context.
3727
:param string: The string containing option(s) to expand.
3729
:param env: An option dict defining additional configuration options or
3730
overriding existing ones.
3732
:returns: The expanded string.
3734
return self._expand_options_in_string(string, env)
3736
def _expand_options_in_string(self, string, env=None, _refs=None):
3737
"""Expand options in the string in the configuration context.
3739
:param string: The string to be expanded.
3741
:param env: An option dict defining additional configuration options or
3742
overriding existing ones.
3744
:param _refs: Private list (FIFO) containing the options being expanded
3747
:returns: The expanded string.
3750
# Not much to expand there
3753
# What references are currently resolved (to detect loops)
3756
# We need to iterate until no more refs appear ({{foo}} will need two
3757
# iterations for example).
3762
for is_ref, chunk in iter_option_refs(result):
3764
chunks.append(chunk)
3769
raise errors.OptionExpansionLoop(string, _refs)
3771
value = self._expand_option(name, env, _refs)
3773
raise errors.ExpandingUnknownOption(name, string)
3774
chunks.append(value)
3776
result = ''.join(chunks)
3779
def _expand_option(self, name, env, _refs):
3780
if env is not None and name in env:
3781
# Special case, values provided in env takes precedence over
3785
value = self.get(name, expand=False)
3786
value = self._expand_options_in_string(value, env, _refs)
3789
def _get_mutable_section(self):
3790
"""Get the MutableSection for the Stack.
3792
This is where we guarantee that the mutable section is lazily loaded:
3793
this means we won't load the corresponding store before setting a value
3794
or deleting an option. In practice the store will often be loaded but
3795
this helps catching some programming errors.
3798
section = store.get_mutable_section(self.mutable_section_id)
3799
return store, section
3801
def set(self, name, value):
3802
"""Set a new value for the option."""
3803
store, section = self._get_mutable_section()
3804
section.set(name, store.quote(value))
3805
for hook in ConfigHooks['set']:
3806
hook(self, name, value)
3808
def remove(self, name):
3809
"""Remove an existing option."""
3810
_, section = self._get_mutable_section()
3811
section.remove(name)
3812
for hook in ConfigHooks['remove']:
3816
# Mostly for debugging use
3817
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3819
def _get_overrides(self):
3820
# Hack around library_state.initialize never called
3821
if bzrlib.global_state is not None:
3822
return bzrlib.global_state.cmdline_overrides.get_sections()
3826
class MemoryStack(Stack):
3827
"""A configuration stack defined from a string.
3829
This is mainly intended for tests and requires no disk resources.
3832
def __init__(self, content=None):
3833
"""Create an in-memory stack from a given content.
3835
It uses a single store based on configobj and support reading and
3838
:param content: The initial content of the store. If None, the store is
3839
not loaded and ``_load_from_string`` can and should be used if
3842
store = IniFileStore()
3843
if content is not None:
3844
store._load_from_string(content)
3845
super(MemoryStack, self).__init__(
3846
[store.get_sections], store)
3849
class _CompatibleStack(Stack):
3850
"""Place holder for compatibility with previous design.
3852
This is intended to ease the transition from the Config-based design to the
3853
Stack-based design and should not be used nor relied upon by plugins.
3855
One assumption made here is that the daughter classes will all use Stores
3856
derived from LockableIniFileStore).
3858
It implements set() and remove () by re-loading the store before applying
3859
the modification and saving it.
3861
The long term plan being to implement a single write by store to save
3862
all modifications, this class should not be used in the interim.
3865
def set(self, name, value):
3868
super(_CompatibleStack, self).set(name, value)
3869
# Force a write to persistent storage
3872
def remove(self, name):
3875
super(_CompatibleStack, self).remove(name)
3876
# Force a write to persistent storage
3880
class GlobalStack(_CompatibleStack):
3881
"""Global options only stack.
3883
The following sections are queried:
3885
* command-line overrides,
3887
* the 'DEFAULT' section in bazaar.conf
3889
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3894
gstore = GlobalStore()
3895
super(GlobalStack, self).__init__(
3896
[self._get_overrides,
3897
NameMatcher(gstore, 'DEFAULT').get_sections],
3898
gstore, mutable_section_id='DEFAULT')
3901
class LocationStack(_CompatibleStack):
3902
"""Per-location options falling back to global options stack.
3905
The following sections are queried:
3907
* command-line overrides,
3909
* the sections matching ``location`` in ``locations.conf``, the order being
3910
defined by the number of path components in the section glob, higher
3911
numbers first (from most specific section to most generic).
3913
* the 'DEFAULT' section in bazaar.conf
3915
This stack will use the ``location`` section in locations.conf as its
3919
def __init__(self, location):
3920
"""Make a new stack for a location and global configuration.
3922
:param location: A URL prefix to """
3923
lstore = LocationStore()
3924
if location.startswith('file://'):
3925
location = urlutils.local_path_from_url(location)
3926
gstore = GlobalStore()
3927
super(LocationStack, self).__init__(
3928
[self._get_overrides,
3929
LocationMatcher(lstore, location).get_sections,
3930
NameMatcher(gstore, 'DEFAULT').get_sections],
3931
lstore, mutable_section_id=location)
3934
class BranchStack(_CompatibleStack):
3935
"""Per-location options falling back to branch then global options stack.
3937
The following sections are queried:
3939
* command-line overrides,
3941
* the sections matching ``location`` in ``locations.conf``, the order being
3942
defined by the number of path components in the section glob, higher
3943
numbers first (from most specific section to most generic),
3945
* the no-name section in branch.conf,
3947
* the ``DEFAULT`` section in ``bazaar.conf``.
3949
This stack will use the no-name section in ``branch.conf`` as its
3953
def __init__(self, branch):
3954
lstore = LocationStore()
3955
bstore = branch._get_config_store()
3956
gstore = GlobalStore()
3957
super(BranchStack, self).__init__(
3958
[self._get_overrides,
3959
LocationMatcher(lstore, branch.base).get_sections,
3960
NameMatcher(bstore, None).get_sections,
3961
NameMatcher(gstore, 'DEFAULT').get_sections],
3963
self.branch = branch
3966
class RemoteControlStack(_CompatibleStack):
3967
"""Remote control-only options stack."""
3969
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3970
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3971
# control.conf and is used only for stack options.
3973
def __init__(self, bzrdir):
3974
cstore = bzrdir._get_config_store()
3975
super(RemoteControlStack, self).__init__(
3976
[NameMatcher(cstore, None).get_sections],
3978
self.bzrdir = bzrdir
3981
class BranchOnlyStack(_CompatibleStack):
3982
"""Branch-only options stack."""
3984
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
3985
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
3986
# -- vila 2011-12-16
3988
def __init__(self, branch):
3989
bstore = branch._get_config_store()
3990
super(BranchOnlyStack, self).__init__(
3991
[NameMatcher(bstore, None).get_sections],
3993
self.branch = branch
3996
# Use a an empty dict to initialize an empty configobj avoiding all
3997
# parsing and encoding checks
3998
_quoting_config = configobj.ConfigObj(
3999
{}, encoding='utf-8', interpolation=False, list_values=True)
4001
class cmd_config(commands.Command):
4002
__doc__ = """Display, set or remove a configuration option.
4004
Display the active value for a given option.
4006
If --all is specified, NAME is interpreted as a regular expression and all
4007
matching options are displayed mentioning their scope. The active value
4008
that bzr will take into account is the first one displayed for each option.
4010
If no NAME is given, --all .* is implied.
4012
Setting a value is achieved by using name=value without spaces. The value
4013
is set in the most relevant scope and can be checked by displaying the
4017
takes_args = ['name?']
4021
# FIXME: This should be a registry option so that plugins can register
4022
# their own config files (or not) and will also address
4023
# http://pad.lv/788991 -- vila 20101115
4024
commands.Option('scope', help='Reduce the scope to the specified'
4025
' configuration file.',
4027
commands.Option('all',
4028
help='Display all the defined values for the matching options.',
4030
commands.Option('remove', help='Remove the option from'
4031
' the configuration file.'),
4034
_see_also = ['configuration']
4036
@commands.display_command
4037
def run(self, name=None, all=False, directory=None, scope=None,
4039
if directory is None:
4041
directory = urlutils.normalize_url(directory)
4043
raise errors.BzrError(
4044
'--all and --remove are mutually exclusive.')
4046
# Delete the option in the given scope
4047
self._remove_config_option(name, directory, scope)
4049
# Defaults to all options
4050
self._show_matching_options('.*', directory, scope)
4053
name, value = name.split('=', 1)
4055
# Display the option(s) value(s)
4057
self._show_matching_options(name, directory, scope)
4059
self._show_value(name, directory, scope)
4062
raise errors.BzrError(
4063
'Only one option can be set.')
4064
# Set the option value
4065
self._set_config_option(name, value, directory, scope)
4067
def _get_stack(self, directory, scope=None):
4068
"""Get the configuration stack specified by ``directory`` and ``scope``.
4070
:param directory: Where the configurations are derived from.
4072
:param scope: A specific config to start from.
4074
# FIXME: scope should allow access to plugin-specific stacks (even
4075
# reduced to the plugin-specific store), related to
4076
# http://pad.lv/788991 -- vila 2011-11-15
4077
if scope is not None:
4078
if scope == 'bazaar':
4079
return GlobalStack()
4080
elif scope == 'locations':
4081
return LocationStack(directory)
4082
elif scope == 'branch':
4084
controldir.ControlDir.open_containing_tree_or_branch(
4086
return br.get_config_stack()
4087
raise errors.NoSuchConfig(scope)
4091
controldir.ControlDir.open_containing_tree_or_branch(
4093
return br.get_config_stack()
4094
except errors.NotBranchError:
4095
return LocationStack(directory)
4097
def _show_value(self, name, directory, scope):
4098
conf = self._get_stack(directory, scope)
4099
value = conf.get(name, expand=True)
4100
if value is not None:
4101
# Quote the value appropriately
4102
value = _quoting_config._quote(value)
4103
self.outf.write('%s\n' % (value,))
4105
raise errors.NoSuchConfigOption(name)
4107
def _show_matching_options(self, name, directory, scope):
4108
name = lazy_regex.lazy_compile(name)
4109
# We want any error in the regexp to be raised *now* so we need to
4110
# avoid the delay introduced by the lazy regexp. But, we still do
4111
# want the nicer errors raised by lazy_regex.
4112
name._compile_and_collapse()
4115
conf = self._get_stack(directory, scope)
4116
for sections in conf.sections_def:
4117
for store, section in sections():
4118
for oname in section.iter_option_names():
4119
if name.search(oname):
4120
if cur_store_id != store.id:
4121
# Explain where the options are defined
4122
self.outf.write('%s:\n' % (store.id,))
4123
cur_store_id = store.id
4125
if (section.id is not None
4126
and cur_section != section.id):
4127
# Display the section id as it appears in the store
4128
# (None doesn't appear by definition)
4129
self.outf.write(' [%s]\n' % (section.id,))
4130
cur_section = section.id
4131
value = section.get(oname, expand=False)
4132
# Since we don't use the stack, we need to restore a
4135
opt = option_registry.get(oname)
4136
value = opt.convert_from_unicode(store, value)
4138
value = store.unquote(value)
4139
value = _quoting_config._quote(value)
4140
self.outf.write(' %s = %s\n' % (oname, value))
4142
def _set_config_option(self, name, value, directory, scope):
4143
conf = self._get_stack(directory, scope)
4144
conf.set(name, value)
4146
def _remove_config_option(self, name, directory, scope):
4148
raise errors.BzrCommandError(
4149
'--remove expects an option to remove.')
4150
conf = self._get_stack(directory, scope)
4154
raise errors.NoSuchConfigOption(name)
4159
# We need adapters that can build a Store or a Stack in a test context. Test
4160
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4161
# themselves. The builder will receive a test instance and should return a
4162
# ready-to-use store or stack. Plugins that define new store/stacks can also
4163
# register themselves here to be tested against the tests defined in
4164
# bzrlib.tests.test_config. Note that the builder can be called multiple times
4165
# for the same test.
4167
# The registered object should be a callable receiving a test instance
4168
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4170
test_store_builder_registry = registry.Registry()
4172
# The registered object should be a callable receiving a test instance
4173
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4175
test_stack_builder_registry = registry.Registry()