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
2410
def convert_from_unicode(self, store, unicode_value):
2411
if self.unquote and store is not None and unicode_value is not None:
2412
unicode_value = store.unquote(unicode_value)
2413
if self.from_unicode is None or unicode_value is None:
2414
# Don't convert or nothing to convert
2415
return unicode_value
2417
converted = self.from_unicode(unicode_value)
2418
except (ValueError, TypeError):
2419
# Invalid values are ignored
2421
if converted is None and self.invalid is not None:
2422
# The conversion failed
2423
if self.invalid == 'warning':
2424
trace.warning('Value "%s" is not valid for "%s"',
2425
unicode_value, self.name)
2426
elif self.invalid == 'error':
2427
raise errors.ConfigOptionValueError(self.name, unicode_value)
2430
def get_override(self):
2432
for var in self.override_from_env:
2434
# If the env variable is defined, its value takes precedence
2435
value = os.environ[var].decode(osutils.get_user_encoding())
2441
def get_default(self):
2443
for var in self.default_from_env:
2445
# If the env variable is defined, its value is the default one
2446
value = os.environ[var].decode(osutils.get_user_encoding())
2451
# Otherwise, fallback to the value defined at registration
2452
if callable(self.default):
2453
value = self.default()
2454
if not isinstance(value, unicode):
2455
raise AssertionError(
2456
'Callable default values should be unicode')
2458
value = self.default
2461
def get_help_text(self, additional_see_also=None, plain=True):
2463
from bzrlib import help_topics
2464
result += help_topics._format_see_also(additional_see_also)
2466
result = help_topics.help_as_plain_text(result)
2470
# Predefined converters to get proper values from store
2472
def bool_from_store(unicode_str):
2473
return ui.bool_from_string(unicode_str)
2476
def int_from_store(unicode_str):
2477
return int(unicode_str)
2480
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2482
def int_SI_from_store(unicode_str):
2483
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2485
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2486
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2489
:return Integer, expanded to its base-10 value if a proper SI unit is
2490
found, None otherwise.
2492
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2493
p = re.compile(regexp, re.IGNORECASE)
2494
m = p.match(unicode_str)
2497
val, _, unit = m.groups()
2501
coeff = _unit_suffixes[unit.upper()]
2503
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2508
def float_from_store(unicode_str):
2509
return float(unicode_str)
2512
# Use a an empty dict to initialize an empty configobj avoiding all
2513
# parsing and encoding checks
2514
_list_converter_config = configobj.ConfigObj(
2515
{}, encoding='utf-8', list_values=True, interpolation=False)
2518
class ListOption(Option):
2520
def __init__(self, name, default=None, default_from_env=None,
2521
help=None, invalid=None):
2522
"""A list Option definition.
2524
This overrides the base class so the conversion from a unicode string
2525
can take quoting into account.
2527
super(ListOption, self).__init__(
2528
name, default=default, default_from_env=default_from_env,
2529
from_unicode=self.from_unicode, help=help,
2530
invalid=invalid, unquote=False)
2532
def from_unicode(self, unicode_str):
2533
if not isinstance(unicode_str, basestring):
2535
# Now inject our string directly as unicode. All callers got their
2536
# value from configobj, so values that need to be quoted are already
2538
_list_converter_config.reset()
2539
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2540
maybe_list = _list_converter_config['list']
2541
if isinstance(maybe_list, basestring):
2543
# A single value, most probably the user forgot (or didn't care
2544
# to add) the final ','
2547
# The empty string, convert to empty list
2550
# We rely on ConfigObj providing us with a list already
2555
class RegistryOption(Option):
2556
"""Option for a choice from a registry."""
2558
def __init__(self, name, registry, default_from_env=None,
2559
help=None, invalid=None):
2560
"""A registry based Option definition.
2562
This overrides the base class so the conversion from a unicode string
2563
can take quoting into account.
2565
super(RegistryOption, self).__init__(
2566
name, default=lambda: unicode(registry.default_key),
2567
default_from_env=default_from_env,
2568
from_unicode=self.from_unicode, help=help,
2569
invalid=invalid, unquote=False)
2570
self.registry = registry
2572
def from_unicode(self, unicode_str):
2573
if not isinstance(unicode_str, basestring):
2576
return self.registry.get(unicode_str)
2579
"Invalid value %s for %s."
2580
"See help for a list of possible values." % (unicode_str,
2585
ret = [self._help, "\n\nThe following values are supported:\n"]
2586
for key in self.registry.keys():
2587
ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
2591
class OptionRegistry(registry.Registry):
2592
"""Register config options by their name.
2594
This overrides ``registry.Registry`` to simplify registration by acquiring
2595
some information from the option object itself.
2598
def register(self, option):
2599
"""Register a new option to its name.
2601
:param option: The option to register. Its name is used as the key.
2603
super(OptionRegistry, self).register(option.name, option,
2606
def register_lazy(self, key, module_name, member_name):
2607
"""Register a new option to be loaded on request.
2609
:param key: the key to request the option later. Since the registration
2610
is lazy, it should be provided and match the option name.
2612
:param module_name: the python path to the module. Such as 'os.path'.
2614
:param member_name: the member of the module to return. If empty or
2615
None, get() will return the module itself.
2617
super(OptionRegistry, self).register_lazy(key,
2618
module_name, member_name)
2620
def get_help(self, key=None):
2621
"""Get the help text associated with the given key"""
2622
option = self.get(key)
2623
the_help = option.help
2624
if callable(the_help):
2625
return the_help(self, key)
2629
option_registry = OptionRegistry()
2632
# Registered options in lexicographical order
2634
option_registry.register(
2635
Option('append_revisions_only',
2636
default=None, from_unicode=bool_from_store, invalid='warning',
2638
Whether to only append revisions to the mainline.
2640
If this is set to true, then it is not possible to change the
2641
existing mainline of the branch.
2643
option_registry.register(
2644
ListOption('acceptable_keys',
2647
List of GPG key patterns which are acceptable for verification.
2649
option_registry.register(
2650
Option('add.maximum_file_size',
2651
default=u'20MB', from_unicode=int_SI_from_store,
2653
Size above which files should be added manually.
2655
Files below this size are added automatically when using ``bzr add`` without
2658
A negative value means disable the size check.
2660
option_registry.register(
2662
default=None, from_unicode=bool_from_store,
2664
Is the branch bound to ``bound_location``.
2666
If set to "True", the branch should act as a checkout, and push each commit to
2667
the bound_location. This option is normally set by ``bind``/``unbind``.
2669
See also: bound_location.
2671
option_registry.register(
2672
Option('bound_location',
2675
The location that commits should go to when acting as a checkout.
2677
This option is normally set by ``bind``.
2681
option_registry.register(
2682
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2684
Whether revisions associated with tags should be fetched.
2686
option_registry.register(
2687
Option('bzr.workingtree.worth_saving_limit', default=10,
2688
from_unicode=int_from_store, invalid='warning',
2690
How many changes before saving the dirstate.
2692
-1 means that we will never rewrite the dirstate file for only
2693
stat-cache changes. Regardless of this setting, we will always rewrite
2694
the dirstate file if a file is added/removed/renamed/etc. This flag only
2695
affects the behavior of updating the dirstate file after we notice that
2696
a file has been touched.
2698
option_registry.register(
2699
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2700
from_unicode=signature_policy_from_unicode,
2702
GPG checking policy.
2704
Possible values: require, ignore, check-available (default)
2706
this option will control whether bzr will require good gpg
2707
signatures, ignore them, or check them if they are
2710
option_registry.register(
2711
Option('child_submit_format',
2712
help='''The preferred format of submissions to this branch.'''))
2713
option_registry.register(
2714
Option('child_submit_to',
2715
help='''Where submissions to this branch are mailed to.'''))
2716
option_registry.register(
2717
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2718
from_unicode=signing_policy_from_unicode,
2722
Possible values: always, never, when-required (default)
2724
This option controls whether bzr will always create
2725
gpg signatures or not on commits.
2727
option_registry.register(
2728
Option('dirstate.fdatasync', default=True,
2729
from_unicode=bool_from_store,
2731
Flush dirstate changes onto physical disk?
2733
If true (default), working tree metadata changes are flushed through the
2734
OS buffers to physical disk. This is somewhat slower, but means data
2735
should not be lost if the machine crashes. See also repository.fdatasync.
2737
option_registry.register(
2738
ListOption('debug_flags', default=[],
2739
help='Debug flags to activate.'))
2740
option_registry.register(
2741
Option('default_format', default='2a',
2742
help='Format used when creating branches.'))
2743
option_registry.register(
2744
Option('dpush_strict', default=None,
2745
from_unicode=bool_from_store,
2747
The default value for ``dpush --strict``.
2749
If present, defines the ``--strict`` option default value for checking
2750
uncommitted changes before pushing into a different VCS without any
2751
custom bzr metadata.
2753
option_registry.register(
2755
help='The command called to launch an editor to enter a message.'))
2756
option_registry.register(
2757
Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
2758
help='The users identity'))
2759
option_registry.register(
2760
Option('gpg_signing_command',
2763
Program to use use for creating signatures.
2765
This should support at least the -u and --clearsign options.
2767
option_registry.register(
2768
Option('gpg_signing_key',
2771
GPG key to use for signing.
2773
This defaults to the first key associated with the users email.
2775
option_registry.register(
2776
Option('ignore_missing_extensions', default=False,
2777
from_unicode=bool_from_store,
2779
Control the missing extensions warning display.
2781
The warning will not be emitted if set to True.
2783
option_registry.register(
2785
help='Language to translate messages into.'))
2786
option_registry.register(
2787
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2789
Steal locks that appears to be dead.
2791
If set to True, bzr will check if a lock is supposed to be held by an
2792
active process from the same user on the same machine. If the user and
2793
machine match, but no process with the given PID is active, then bzr
2794
will automatically break the stale lock, and create a new lock for
2796
Otherwise, bzr will prompt as normal to break the lock.
2798
option_registry.register(
2799
Option('log_format', default='long',
2801
Log format to use when displaying revisions.
2803
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2804
may be provided by plugins.
2806
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
2808
option_registry.register(
2809
Option('output_encoding',
2810
help= 'Unicode encoding for output'
2811
' (terminal encoding if not specified).'))
2812
option_registry.register(
2813
Option('parent_location',
2816
The location of the default branch for pull or merge.
2818
This option is normally set when creating a branch, the first ``pull`` or by
2819
``pull --remember``.
2821
option_registry.register(
2822
Option('post_commit', default=None,
2824
Post commit functions.
2826
An ordered list of python functions to call, separated by spaces.
2828
Each function takes branch, rev_id as parameters.
2830
option_registry.register(
2831
Option('public_branch',
2834
A publically-accessible version of this branch.
2836
This implies that the branch setting this option is not publically-accessible.
2837
Used and set by ``bzr send``.
2839
option_registry.register(
2840
Option('push_location',
2843
The location of the default branch for push.
2845
This option is normally set by the first ``push`` or ``push --remember``.
2847
option_registry.register(
2848
Option('push_strict', default=None,
2849
from_unicode=bool_from_store,
2851
The default value for ``push --strict``.
2853
If present, defines the ``--strict`` option default value for checking
2854
uncommitted changes before sending a merge directive.
2856
option_registry.register(
2857
Option('repository.fdatasync', default=True,
2858
from_unicode=bool_from_store,
2860
Flush repository changes onto physical disk?
2862
If true (default), repository changes are flushed through the OS buffers
2863
to physical disk. This is somewhat slower, but means data should not be
2864
lost if the machine crashes. See also dirstate.fdatasync.
2866
option_registry.register_lazy('smtp_server',
2867
'bzrlib.smtp_connection', 'smtp_server')
2868
option_registry.register_lazy('smtp_password',
2869
'bzrlib.smtp_connection', 'smtp_password')
2870
option_registry.register_lazy('smtp_username',
2871
'bzrlib.smtp_connection', 'smtp_username')
2872
option_registry.register(
2873
Option('selftest.timeout',
2875
from_unicode=int_from_store,
2876
help='Abort selftest if one test takes longer than this many seconds',
2879
option_registry.register(
2880
Option('send_strict', default=None,
2881
from_unicode=bool_from_store,
2883
The default value for ``send --strict``.
2885
If present, defines the ``--strict`` option default value for checking
2886
uncommitted changes before sending a bundle.
2889
option_registry.register(
2890
Option('serve.client_timeout',
2891
default=300.0, from_unicode=float_from_store,
2892
help="If we wait for a new request from a client for more than"
2893
" X seconds, consider the client idle, and hangup."))
2894
option_registry.register(
2895
Option('stacked_on_location',
2897
help="""The location where this branch is stacked on."""))
2898
option_registry.register(
2899
Option('submit_branch',
2902
The branch you intend to submit your current work to.
2904
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2905
by the ``submit:`` revision spec.
2907
option_registry.register(
2909
help='''Where submissions from this branch are mailed to.'''))
2910
option_registry.register(
2911
ListOption('suppress_warnings',
2913
help="List of warning classes to suppress."))
2914
option_registry.register(
2915
Option('validate_signatures_in_log', default=False,
2916
from_unicode=bool_from_store, invalid='warning',
2917
help='''Whether to validate signatures in bzr log.'''))
2918
option_registry.register_lazy('ssl.ca_certs',
2919
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2921
option_registry.register_lazy('ssl.cert_reqs',
2922
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2926
class Section(object):
2927
"""A section defines a dict of option name => value.
2929
This is merely a read-only dict which can add some knowledge about the
2930
options. It is *not* a python dict object though and doesn't try to mimic
2934
def __init__(self, section_id, options):
2935
self.id = section_id
2936
# We re-use the dict-like object received
2937
self.options = options
2939
def get(self, name, default=None, expand=True):
2940
return self.options.get(name, default)
2942
def iter_option_names(self):
2943
for k in self.options.iterkeys():
2947
# Mostly for debugging use
2948
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2951
_NewlyCreatedOption = object()
2952
"""Was the option created during the MutableSection lifetime"""
2953
_DeletedOption = object()
2954
"""Was the option deleted during the MutableSection lifetime"""
2957
class MutableSection(Section):
2958
"""A section allowing changes and keeping track of the original values."""
2960
def __init__(self, section_id, options):
2961
super(MutableSection, self).__init__(section_id, options)
2962
self.reset_changes()
2964
def set(self, name, value):
2965
if name not in self.options:
2966
# This is a new option
2967
self.orig[name] = _NewlyCreatedOption
2968
elif name not in self.orig:
2969
self.orig[name] = self.get(name, None)
2970
self.options[name] = value
2972
def remove(self, name):
2973
if name not in self.orig:
2974
self.orig[name] = self.get(name, None)
2975
del self.options[name]
2977
def reset_changes(self):
2980
def apply_changes(self, dirty, store):
2981
"""Apply option value changes.
2983
``self`` has been reloaded from the persistent storage. ``dirty``
2984
contains the changes made since the previous loading.
2986
:param dirty: the mutable section containing the changes.
2988
:param store: the store containing the section
2990
for k, expected in dirty.orig.iteritems():
2991
actual = dirty.get(k, _DeletedOption)
2992
reloaded = self.get(k, _NewlyCreatedOption)
2993
if actual is _DeletedOption:
2994
if k in self.options:
2998
# Report concurrent updates in an ad-hoc way. This should only
2999
# occurs when different processes try to update the same option
3000
# which is not supported (as in: the config framework is not meant
3001
# to be used a sharing mechanism).
3002
if expected != reloaded:
3003
if actual is _DeletedOption:
3004
actual = '<DELETED>'
3005
if reloaded is _NewlyCreatedOption:
3006
reloaded = '<CREATED>'
3007
if expected is _NewlyCreatedOption:
3008
expected = '<CREATED>'
3009
# Someone changed the value since we get it from the persistent
3011
trace.warning(gettext(
3012
"Option {0} in section {1} of {2} was changed"
3013
" from {3} to {4}. The {5} value will be saved.".format(
3014
k, self.id, store.external_url(), expected,
3016
# No need to keep track of these changes
3017
self.reset_changes()
3020
class Store(object):
3021
"""Abstract interface to persistent storage for configuration options."""
3023
readonly_section_class = Section
3024
mutable_section_class = MutableSection
3027
# Which sections need to be saved
3028
self.dirty_sections = []
3030
def is_loaded(self):
3031
"""Returns True if the Store has been loaded.
3033
This is used to implement lazy loading and ensure the persistent
3034
storage is queried only when needed.
3036
raise NotImplementedError(self.is_loaded)
3039
"""Loads the Store from persistent storage."""
3040
raise NotImplementedError(self.load)
3042
def _load_from_string(self, bytes):
3043
"""Create a store from a string in configobj syntax.
3045
:param bytes: A string representing the file content.
3047
raise NotImplementedError(self._load_from_string)
3050
"""Unloads the Store.
3052
This should make is_loaded() return False. This is used when the caller
3053
knows that the persistent storage has changed or may have change since
3056
raise NotImplementedError(self.unload)
3058
def quote(self, value):
3059
"""Quote a configuration option value for storing purposes.
3061
This allows Stacks to present values as they will be stored.
3065
def unquote(self, value):
3066
"""Unquote a configuration option value into unicode.
3068
The received value is quoted as stored.
3073
"""Saves the Store to persistent storage."""
3074
raise NotImplementedError(self.save)
3076
def _need_saving(self):
3077
for s in self.dirty_sections:
3079
# At least one dirty section contains a modification
3083
def apply_changes(self, dirty_sections):
3084
"""Apply changes from dirty sections while checking for coherency.
3086
The Store content is discarded and reloaded from persistent storage to
3087
acquire up-to-date values.
3089
Dirty sections are MutableSection which kept track of the value they
3090
are expected to update.
3092
# We need an up-to-date version from the persistent storage, unload the
3093
# store. The reload will occur when needed (triggered by the first
3094
# get_mutable_section() call below.
3096
# Apply the changes from the preserved dirty sections
3097
for dirty in dirty_sections:
3098
clean = self.get_mutable_section(dirty.id)
3099
clean.apply_changes(dirty, self)
3100
# Everything is clean now
3101
self.dirty_sections = []
3103
def save_changes(self):
3104
"""Saves the Store to persistent storage if changes occurred.
3106
Apply the changes recorded in the mutable sections to a store content
3107
refreshed from persistent storage.
3109
raise NotImplementedError(self.save_changes)
3111
def external_url(self):
3112
raise NotImplementedError(self.external_url)
3114
def get_sections(self):
3115
"""Returns an ordered iterable of existing sections.
3117
:returns: An iterable of (store, section).
3119
raise NotImplementedError(self.get_sections)
3121
def get_mutable_section(self, section_id=None):
3122
"""Returns the specified mutable section.
3124
:param section_id: The section identifier
3126
raise NotImplementedError(self.get_mutable_section)
3129
# Mostly for debugging use
3130
return "<config.%s(%s)>" % (self.__class__.__name__,
3131
self.external_url())
3134
class CommandLineStore(Store):
3135
"A store to carry command line overrides for the config options."""
3137
def __init__(self, opts=None):
3138
super(CommandLineStore, self).__init__()
3145
# The dict should be cleared but not replaced so it can be shared.
3146
self.options.clear()
3148
def _from_cmdline(self, overrides):
3149
# Reset before accepting new definitions
3151
for over in overrides:
3153
name, value = over.split('=', 1)
3155
raise errors.BzrCommandError(
3156
gettext("Invalid '%s', should be of the form 'name=value'")
3158
self.options[name] = value
3160
def external_url(self):
3161
# Not an url but it makes debugging easier and is never needed
3165
def get_sections(self):
3166
yield self, self.readonly_section_class(None, self.options)
3169
class IniFileStore(Store):
3170
"""A config Store using ConfigObj for storage.
3172
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3173
serialize/deserialize the config file.
3177
"""A config Store using ConfigObj for storage.
3179
super(IniFileStore, self).__init__()
3180
self._config_obj = None
3182
def is_loaded(self):
3183
return self._config_obj != None
3186
self._config_obj = None
3187
self.dirty_sections = []
3189
def _load_content(self):
3190
"""Load the config file bytes.
3192
This should be provided by subclasses
3194
:return: Byte string
3196
raise NotImplementedError(self._load_content)
3198
def _save_content(self, content):
3199
"""Save the config file bytes.
3201
This should be provided by subclasses
3203
:param content: Config file bytes to write
3205
raise NotImplementedError(self._save_content)
3208
"""Load the store from the associated file."""
3209
if self.is_loaded():
3211
content = self._load_content()
3212
self._load_from_string(content)
3213
for hook in ConfigHooks['load']:
3216
def _load_from_string(self, bytes):
3217
"""Create a config store from a string.
3219
:param bytes: A string representing the file content.
3221
if self.is_loaded():
3222
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3223
co_input = StringIO(bytes)
3225
# The config files are always stored utf8-encoded
3226
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3228
except configobj.ConfigObjError, e:
3229
self._config_obj = None
3230
raise errors.ParseConfigError(e.errors, self.external_url())
3231
except UnicodeDecodeError:
3232
raise errors.ConfigContentError(self.external_url())
3234
def save_changes(self):
3235
if not self.is_loaded():
3238
if not self._need_saving():
3240
# Preserve the current version
3241
current = self._config_obj
3242
dirty_sections = list(self.dirty_sections)
3243
self.apply_changes(dirty_sections)
3244
# Save to the persistent storage
3248
if not self.is_loaded():
3252
self._config_obj.write(out)
3253
self._save_content(out.getvalue())
3254
for hook in ConfigHooks['save']:
3257
def get_sections(self):
3258
"""Get the configobj section in the file order.
3260
:returns: An iterable of (store, section).
3262
# We need a loaded store
3265
except (errors.NoSuchFile, errors.PermissionDenied):
3266
# If the file can't be read, there is no sections
3268
cobj = self._config_obj
3270
yield self, self.readonly_section_class(None, cobj)
3271
for section_name in cobj.sections:
3273
self.readonly_section_class(section_name,
3274
cobj[section_name]))
3276
def get_mutable_section(self, section_id=None):
3277
# We need a loaded store
3280
except errors.NoSuchFile:
3281
# The file doesn't exist, let's pretend it was empty
3282
self._load_from_string('')
3283
if section_id is None:
3284
section = self._config_obj
3286
section = self._config_obj.setdefault(section_id, {})
3287
mutable_section = self.mutable_section_class(section_id, section)
3288
# All mutable sections can become dirty
3289
self.dirty_sections.append(mutable_section)
3290
return mutable_section
3292
def quote(self, value):
3294
# configobj conflates automagical list values and quoting
3295
self._config_obj.list_values = True
3296
return self._config_obj._quote(value)
3298
self._config_obj.list_values = False
3300
def unquote(self, value):
3301
if value and isinstance(value, basestring):
3302
# _unquote doesn't handle None nor empty strings nor anything that
3303
# is not a string, really.
3304
value = self._config_obj._unquote(value)
3307
def external_url(self):
3308
# Since an IniFileStore can be used without a file (at least in tests),
3309
# it's better to provide something than raising a NotImplementedError.
3310
# All daughter classes are supposed to provide an implementation
3312
return 'In-Process Store, no URL'
3314
class TransportIniFileStore(IniFileStore):
3315
"""IniFileStore that loads files from a transport.
3317
:ivar transport: The transport object where the config file is located.
3319
:ivar file_name: The config file basename in the transport directory.
3322
def __init__(self, transport, file_name):
3323
"""A Store using a ini file on a Transport
3325
:param transport: The transport object where the config file is located.
3326
:param file_name: The config file basename in the transport directory.
3328
super(TransportIniFileStore, self).__init__()
3329
self.transport = transport
3330
self.file_name = file_name
3332
def _load_content(self):
3334
return self.transport.get_bytes(self.file_name)
3335
except errors.PermissionDenied:
3336
trace.warning("Permission denied while trying to load "
3337
"configuration store %s.", self.external_url())
3340
def _save_content(self, content):
3341
self.transport.put_bytes(self.file_name, content)
3343
def external_url(self):
3344
# FIXME: external_url should really accepts an optional relpath
3345
# parameter (bug #750169) :-/ -- vila 2011-04-04
3346
# The following will do in the interim but maybe we don't want to
3347
# expose a path here but rather a config ID and its associated
3348
# object </hand wawe>.
3349
return urlutils.join(self.transport.external_url(), self.file_name)
3352
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3353
# unlockable stores for use with objects that can already ensure the locking
3354
# (think branches). If different stores (not based on ConfigObj) are created,
3355
# they may face the same issue.
3358
class LockableIniFileStore(TransportIniFileStore):
3359
"""A ConfigObjStore using locks on save to ensure store integrity."""
3361
def __init__(self, transport, file_name, lock_dir_name=None):
3362
"""A config Store using ConfigObj for storage.
3364
:param transport: The transport object where the config file is located.
3366
:param file_name: The config file basename in the transport directory.
3368
if lock_dir_name is None:
3369
lock_dir_name = 'lock'
3370
self.lock_dir_name = lock_dir_name
3371
super(LockableIniFileStore, self).__init__(transport, file_name)
3372
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3374
def lock_write(self, token=None):
3375
"""Takes a write lock in the directory containing the config file.
3377
If the directory doesn't exist it is created.
3379
# FIXME: This doesn't check the ownership of the created directories as
3380
# ensure_config_dir_exists does. It should if the transport is local
3381
# -- vila 2011-04-06
3382
self.transport.create_prefix()
3383
return self._lock.lock_write(token)
3388
def break_lock(self):
3389
self._lock.break_lock()
3393
# We need to be able to override the undecorated implementation
3394
self.save_without_locking()
3396
def save_without_locking(self):
3397
super(LockableIniFileStore, self).save()
3400
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3401
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3402
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3404
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3405
# functions or a registry will make it easier and clearer for tests, focusing
3406
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3407
# on a poolie's remark)
3408
class GlobalStore(LockableIniFileStore):
3410
def __init__(self, possible_transports=None):
3411
t = transport.get_transport_from_path(
3412
config_dir(), possible_transports=possible_transports)
3413
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3417
class LocationStore(LockableIniFileStore):
3419
def __init__(self, possible_transports=None):
3420
t = transport.get_transport_from_path(
3421
config_dir(), possible_transports=possible_transports)
3422
super(LocationStore, self).__init__(t, 'locations.conf')
3423
self.id = 'locations'
3426
class BranchStore(TransportIniFileStore):
3428
def __init__(self, branch):
3429
super(BranchStore, self).__init__(branch.control_transport,
3431
self.branch = branch
3434
def lock_write(self, token=None):
3435
return self.branch.lock_write(token)
3438
return self.branch.unlock()
3442
# We need to be able to override the undecorated implementation
3443
self.save_without_locking()
3445
def save_without_locking(self):
3446
super(BranchStore, self).save()
3449
class ControlStore(LockableIniFileStore):
3451
def __init__(self, bzrdir):
3452
super(ControlStore, self).__init__(bzrdir.transport,
3454
lock_dir_name='branch_lock')
3458
class SectionMatcher(object):
3459
"""Select sections into a given Store.
3461
This is intended to be used to postpone getting an iterable of sections
3465
def __init__(self, store):
3468
def get_sections(self):
3469
# This is where we require loading the store so we can see all defined
3471
sections = self.store.get_sections()
3472
# Walk the revisions in the order provided
3473
for store, s in sections:
3477
def match(self, section):
3478
"""Does the proposed section match.
3480
:param section: A Section object.
3482
:returns: True if the section matches, False otherwise.
3484
raise NotImplementedError(self.match)
3487
class NameMatcher(SectionMatcher):
3489
def __init__(self, store, section_id):
3490
super(NameMatcher, self).__init__(store)
3491
self.section_id = section_id
3493
def match(self, section):
3494
return section.id == self.section_id
3497
class LocationSection(Section):
3499
def __init__(self, section, extra_path):
3500
super(LocationSection, self).__init__(section.id, section.options)
3501
self.extra_path = extra_path
3502
self.locals = {'relpath': extra_path,
3503
'basename': urlutils.basename(extra_path)}
3505
def get(self, name, default=None, expand=True):
3506
value = super(LocationSection, self).get(name, default)
3507
if value is not None and expand:
3508
policy_name = self.get(name + ':policy', None)
3509
policy = _policy_value.get(policy_name, POLICY_NONE)
3510
if policy == POLICY_APPENDPATH:
3511
value = urlutils.join(value, self.extra_path)
3512
# expand section local options right now (since POLICY_APPENDPATH
3513
# will never add options references, it's ok to expand after it).
3515
for is_ref, chunk in iter_option_refs(value):
3517
chunks.append(chunk)
3520
if ref in self.locals:
3521
chunks.append(self.locals[ref])
3523
chunks.append(chunk)
3524
value = ''.join(chunks)
3528
class StartingPathMatcher(SectionMatcher):
3529
"""Select sections for a given location respecting the Store order."""
3531
# FIXME: Both local paths and urls can be used for section names as well as
3532
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3533
# inherited the fuzziness from the previous ``LocationConfig``
3534
# implementation. We probably need to revisit which encoding is allowed for
3535
# both ``location`` and section names and how we normalize
3536
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3537
# related too. -- vila 2012-01-04
3539
def __init__(self, store, location):
3540
super(StartingPathMatcher, self).__init__(store)
3541
if location.startswith('file://'):
3542
location = urlutils.local_path_from_url(location)
3543
self.location = location
3545
def get_sections(self):
3546
"""Get all sections matching ``location`` in the store.
3548
The most generic sections are described first in the store, then more
3549
specific ones can be provided for reduced scopes.
3551
The returned section are therefore returned in the reversed order so
3552
the most specific ones can be found first.
3554
location_parts = self.location.rstrip('/').split('/')
3557
# Later sections are more specific, they should be returned first
3558
for _, section in reversed(list(store.get_sections())):
3559
if section.id is None:
3560
# The no-name section is always included if present
3561
yield store, LocationSection(section, self.location)
3563
section_path = section.id
3564
if section_path.startswith('file://'):
3565
# the location is already a local path or URL, convert the
3566
# section id to the same format
3567
section_path = urlutils.local_path_from_url(section_path)
3568
if (self.location.startswith(section_path)
3569
or fnmatch.fnmatch(self.location, section_path)):
3570
section_parts = section_path.rstrip('/').split('/')
3571
extra_path = '/'.join(location_parts[len(section_parts):])
3572
yield store, LocationSection(section, extra_path)
3575
class LocationMatcher(SectionMatcher):
3577
def __init__(self, store, location):
3578
super(LocationMatcher, self).__init__(store)
3579
if location.startswith('file://'):
3580
location = urlutils.local_path_from_url(location)
3581
self.location = location
3583
def _get_matching_sections(self):
3584
"""Get all sections matching ``location``."""
3585
# We slightly diverge from LocalConfig here by allowing the no-name
3586
# section as the most generic one and the lower priority.
3587
no_name_section = None
3589
# Filter out the no_name_section so _iter_for_location_by_parts can be
3590
# used (it assumes all sections have a name).
3591
for _, section in self.store.get_sections():
3592
if section.id is None:
3593
no_name_section = section
3595
all_sections.append(section)
3596
# Unfortunately _iter_for_location_by_parts deals with section names so
3597
# we have to resync.
3598
filtered_sections = _iter_for_location_by_parts(
3599
[s.id for s in all_sections], self.location)
3600
iter_all_sections = iter(all_sections)
3601
matching_sections = []
3602
if no_name_section is not None:
3603
matching_sections.append(
3604
(0, LocationSection(no_name_section, self.location)))
3605
for section_id, extra_path, length in filtered_sections:
3606
# a section id is unique for a given store so it's safe to take the
3607
# first matching section while iterating. Also, all filtered
3608
# sections are part of 'all_sections' and will always be found
3611
section = iter_all_sections.next()
3612
if section_id == section.id:
3613
matching_sections.append(
3614
(length, LocationSection(section, extra_path)))
3616
return matching_sections
3618
def get_sections(self):
3619
# Override the default implementation as we want to change the order
3620
matching_sections = self._get_matching_sections()
3621
# We want the longest (aka more specific) locations first
3622
sections = sorted(matching_sections,
3623
key=lambda (length, section): (length, section.id),
3625
# Sections mentioning 'ignore_parents' restrict the selection
3626
for _, section in sections:
3627
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3628
ignore = section.get('ignore_parents', None)
3629
if ignore is not None:
3630
ignore = ui.bool_from_string(ignore)
3633
# Finally, we have a valid section
3634
yield self.store, section
3637
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3638
"""Describes an expandable option reference.
3640
We want to match the most embedded reference first.
3642
I.e. for '{{foo}}' we will get '{foo}',
3643
for '{bar{baz}}' we will get '{baz}'
3646
def iter_option_refs(string):
3647
# Split isolate refs so every other chunk is a ref
3649
for chunk in _option_ref_re.split(string):
3654
class Stack(object):
3655
"""A stack of configurations where an option can be defined"""
3657
def __init__(self, sections_def, store=None, mutable_section_id=None):
3658
"""Creates a stack of sections with an optional store for changes.
3660
:param sections_def: A list of Section or callables that returns an
3661
iterable of Section. This defines the Sections for the Stack and
3662
can be called repeatedly if needed.
3664
:param store: The optional Store where modifications will be
3665
recorded. If none is specified, no modifications can be done.
3667
:param mutable_section_id: The id of the MutableSection where changes
3668
are recorded. This requires the ``store`` parameter to be
3671
self.sections_def = sections_def
3673
self.mutable_section_id = mutable_section_id
3675
def get(self, name, expand=None):
3676
"""Return the *first* option value found in the sections.
3678
This is where we guarantee that sections coming from Store are loaded
3679
lazily: the loading is delayed until we need to either check that an
3680
option exists or get its value, which in turn may require to discover
3681
in which sections it can be defined. Both of these (section and option
3682
existence) require loading the store (even partially).
3684
:param name: The queried option.
3686
:param expand: Whether options references should be expanded.
3688
:returns: The value of the option.
3690
# FIXME: No caching of options nor sections yet -- vila 20110503
3692
expand = _get_expand_default_value()
3694
found_store = None # Where the option value has been found
3695
# If the option is registered, it may provide additional info about
3698
opt = option_registry.get(name)
3703
def expand_and_convert(val):
3704
# This may need to be called in different contexts if the value is
3705
# None or ends up being None during expansion or conversion.
3708
if isinstance(val, basestring):
3709
val = self._expand_options_in_string(val)
3711
trace.warning('Cannot expand "%s":'
3712
' %s does not support option expansion'
3713
% (name, type(val)))
3715
val = found_store.unquote(val)
3717
val = opt.convert_from_unicode(found_store, val)
3720
# First of all, check if the environment can override the configuration
3722
if opt is not None and opt.override_from_env:
3723
value = opt.get_override()
3724
value = expand_and_convert(value)
3726
# Ensuring lazy loading is achieved by delaying section matching
3727
# (which implies querying the persistent storage) until it can't be
3728
# avoided anymore by using callables to describe (possibly empty)
3730
for sections in self.sections_def:
3731
for store, section in sections():
3732
value = section.get(name)
3733
if value is not None:
3736
if value is not None:
3738
value = expand_and_convert(value)
3739
if opt is not None and value is None:
3740
# If the option is registered, it may provide a default value
3741
value = opt.get_default()
3742
value = expand_and_convert(value)
3743
for hook in ConfigHooks['get']:
3744
hook(self, name, value)
3747
def expand_options(self, string, env=None):
3748
"""Expand option references in the string in the configuration context.
3750
:param string: The string containing option(s) to expand.
3752
:param env: An option dict defining additional configuration options or
3753
overriding existing ones.
3755
:returns: The expanded string.
3757
return self._expand_options_in_string(string, env)
3759
def _expand_options_in_string(self, string, env=None, _refs=None):
3760
"""Expand options in the string in the configuration context.
3762
:param string: The string to be expanded.
3764
:param env: An option dict defining additional configuration options or
3765
overriding existing ones.
3767
:param _refs: Private list (FIFO) containing the options being expanded
3770
:returns: The expanded string.
3773
# Not much to expand there
3776
# What references are currently resolved (to detect loops)
3779
# We need to iterate until no more refs appear ({{foo}} will need two
3780
# iterations for example).
3785
for is_ref, chunk in iter_option_refs(result):
3787
chunks.append(chunk)
3792
raise errors.OptionExpansionLoop(string, _refs)
3794
value = self._expand_option(name, env, _refs)
3796
raise errors.ExpandingUnknownOption(name, string)
3797
chunks.append(value)
3799
result = ''.join(chunks)
3802
def _expand_option(self, name, env, _refs):
3803
if env is not None and name in env:
3804
# Special case, values provided in env takes precedence over
3808
value = self.get(name, expand=False)
3809
value = self._expand_options_in_string(value, env, _refs)
3812
def _get_mutable_section(self):
3813
"""Get the MutableSection for the Stack.
3815
This is where we guarantee that the mutable section is lazily loaded:
3816
this means we won't load the corresponding store before setting a value
3817
or deleting an option. In practice the store will often be loaded but
3818
this helps catching some programming errors.
3821
section = store.get_mutable_section(self.mutable_section_id)
3822
return store, section
3824
def set(self, name, value):
3825
"""Set a new value for the option."""
3826
store, section = self._get_mutable_section()
3827
section.set(name, store.quote(value))
3828
for hook in ConfigHooks['set']:
3829
hook(self, name, value)
3831
def remove(self, name):
3832
"""Remove an existing option."""
3833
_, section = self._get_mutable_section()
3834
section.remove(name)
3835
for hook in ConfigHooks['remove']:
3839
# Mostly for debugging use
3840
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3842
def _get_overrides(self):
3843
# Hack around library_state.initialize never called
3844
if bzrlib.global_state is not None:
3845
return bzrlib.global_state.cmdline_overrides.get_sections()
3849
class MemoryStack(Stack):
3850
"""A configuration stack defined from a string.
3852
This is mainly intended for tests and requires no disk resources.
3855
def __init__(self, content=None):
3856
"""Create an in-memory stack from a given content.
3858
It uses a single store based on configobj and support reading and
3861
:param content: The initial content of the store. If None, the store is
3862
not loaded and ``_load_from_string`` can and should be used if
3865
store = IniFileStore()
3866
if content is not None:
3867
store._load_from_string(content)
3868
super(MemoryStack, self).__init__(
3869
[store.get_sections], store)
3872
class _CompatibleStack(Stack):
3873
"""Place holder for compatibility with previous design.
3875
This is intended to ease the transition from the Config-based design to the
3876
Stack-based design and should not be used nor relied upon by plugins.
3878
One assumption made here is that the daughter classes will all use Stores
3879
derived from LockableIniFileStore).
3881
It implements set() and remove () by re-loading the store before applying
3882
the modification and saving it.
3884
The long term plan being to implement a single write by store to save
3885
all modifications, this class should not be used in the interim.
3888
def set(self, name, value):
3891
super(_CompatibleStack, self).set(name, value)
3892
# Force a write to persistent storage
3895
def remove(self, name):
3898
super(_CompatibleStack, self).remove(name)
3899
# Force a write to persistent storage
3903
class GlobalStack(_CompatibleStack):
3904
"""Global options only stack.
3906
The following sections are queried:
3908
* command-line overrides,
3910
* the 'DEFAULT' section in bazaar.conf
3912
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3917
gstore = GlobalStore()
3918
super(GlobalStack, self).__init__(
3919
[self._get_overrides,
3920
NameMatcher(gstore, 'DEFAULT').get_sections],
3921
gstore, mutable_section_id='DEFAULT')
3924
class LocationStack(_CompatibleStack):
3925
"""Per-location options falling back to global options stack.
3928
The following sections are queried:
3930
* command-line overrides,
3932
* the sections matching ``location`` in ``locations.conf``, the order being
3933
defined by the number of path components in the section glob, higher
3934
numbers first (from most specific section to most generic).
3936
* the 'DEFAULT' section in bazaar.conf
3938
This stack will use the ``location`` section in locations.conf as its
3942
def __init__(self, location):
3943
"""Make a new stack for a location and global configuration.
3945
:param location: A URL prefix to """
3946
lstore = LocationStore()
3947
if location.startswith('file://'):
3948
location = urlutils.local_path_from_url(location)
3949
gstore = GlobalStore()
3950
super(LocationStack, self).__init__(
3951
[self._get_overrides,
3952
LocationMatcher(lstore, location).get_sections,
3953
NameMatcher(gstore, 'DEFAULT').get_sections],
3954
lstore, mutable_section_id=location)
3957
class BranchStack(_CompatibleStack):
3958
"""Per-location options falling back to branch then global options stack.
3960
The following sections are queried:
3962
* command-line overrides,
3964
* the sections matching ``location`` in ``locations.conf``, the order being
3965
defined by the number of path components in the section glob, higher
3966
numbers first (from most specific section to most generic),
3968
* the no-name section in branch.conf,
3970
* the ``DEFAULT`` section in ``bazaar.conf``.
3972
This stack will use the no-name section in ``branch.conf`` as its
3976
def __init__(self, branch):
3977
lstore = LocationStore()
3978
bstore = branch._get_config_store()
3979
gstore = GlobalStore()
3980
super(BranchStack, self).__init__(
3981
[self._get_overrides,
3982
LocationMatcher(lstore, branch.base).get_sections,
3983
NameMatcher(bstore, None).get_sections,
3984
NameMatcher(gstore, 'DEFAULT').get_sections],
3986
self.branch = branch
3989
class RemoteControlStack(_CompatibleStack):
3990
"""Remote control-only options stack."""
3992
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3993
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3994
# control.conf and is used only for stack options.
3996
def __init__(self, bzrdir):
3997
cstore = bzrdir._get_config_store()
3998
super(RemoteControlStack, self).__init__(
3999
[NameMatcher(cstore, None).get_sections],
4001
self.bzrdir = bzrdir
4004
class BranchOnlyStack(_CompatibleStack):
4005
"""Branch-only options stack."""
4007
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
4008
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
4009
# -- vila 2011-12-16
4011
def __init__(self, branch):
4012
bstore = branch._get_config_store()
4013
super(BranchOnlyStack, self).__init__(
4014
[NameMatcher(bstore, None).get_sections],
4016
self.branch = branch
4019
# Use a an empty dict to initialize an empty configobj avoiding all
4020
# parsing and encoding checks
4021
_quoting_config = configobj.ConfigObj(
4022
{}, encoding='utf-8', interpolation=False, list_values=True)
4024
class cmd_config(commands.Command):
4025
__doc__ = """Display, set or remove a configuration option.
4027
Display the active value for a given option.
4029
If --all is specified, NAME is interpreted as a regular expression and all
4030
matching options are displayed mentioning their scope. The active value
4031
that bzr will take into account is the first one displayed for each option.
4033
If no NAME is given, --all .* is implied.
4035
Setting a value is achieved by using name=value without spaces. The value
4036
is set in the most relevant scope and can be checked by displaying the
4040
takes_args = ['name?']
4044
# FIXME: This should be a registry option so that plugins can register
4045
# their own config files (or not) and will also address
4046
# http://pad.lv/788991 -- vila 20101115
4047
commands.Option('scope', help='Reduce the scope to the specified'
4048
' configuration file.',
4050
commands.Option('all',
4051
help='Display all the defined values for the matching options.',
4053
commands.Option('remove', help='Remove the option from'
4054
' the configuration file.'),
4057
_see_also = ['configuration']
4059
@commands.display_command
4060
def run(self, name=None, all=False, directory=None, scope=None,
4062
if directory is None:
4064
directory = urlutils.normalize_url(directory)
4066
raise errors.BzrError(
4067
'--all and --remove are mutually exclusive.')
4069
# Delete the option in the given scope
4070
self._remove_config_option(name, directory, scope)
4072
# Defaults to all options
4073
self._show_matching_options('.*', directory, scope)
4076
name, value = name.split('=', 1)
4078
# Display the option(s) value(s)
4080
self._show_matching_options(name, directory, scope)
4082
self._show_value(name, directory, scope)
4085
raise errors.BzrError(
4086
'Only one option can be set.')
4087
# Set the option value
4088
self._set_config_option(name, value, directory, scope)
4090
def _get_stack(self, directory, scope=None):
4091
"""Get the configuration stack specified by ``directory`` and ``scope``.
4093
:param directory: Where the configurations are derived from.
4095
:param scope: A specific config to start from.
4097
# FIXME: scope should allow access to plugin-specific stacks (even
4098
# reduced to the plugin-specific store), related to
4099
# http://pad.lv/788991 -- vila 2011-11-15
4100
if scope is not None:
4101
if scope == 'bazaar':
4102
return GlobalStack()
4103
elif scope == 'locations':
4104
return LocationStack(directory)
4105
elif scope == 'branch':
4107
controldir.ControlDir.open_containing_tree_or_branch(
4109
return br.get_config_stack()
4110
raise errors.NoSuchConfig(scope)
4114
controldir.ControlDir.open_containing_tree_or_branch(
4116
return br.get_config_stack()
4117
except errors.NotBranchError:
4118
return LocationStack(directory)
4120
def _show_value(self, name, directory, scope):
4121
conf = self._get_stack(directory, scope)
4122
value = conf.get(name, expand=True)
4123
if value is not None:
4124
# Quote the value appropriately
4125
value = _quoting_config._quote(value)
4126
self.outf.write('%s\n' % (value,))
4128
raise errors.NoSuchConfigOption(name)
4130
def _show_matching_options(self, name, directory, scope):
4131
name = lazy_regex.lazy_compile(name)
4132
# We want any error in the regexp to be raised *now* so we need to
4133
# avoid the delay introduced by the lazy regexp. But, we still do
4134
# want the nicer errors raised by lazy_regex.
4135
name._compile_and_collapse()
4138
conf = self._get_stack(directory, scope)
4139
for sections in conf.sections_def:
4140
for store, section in sections():
4141
for oname in section.iter_option_names():
4142
if name.search(oname):
4143
if cur_store_id != store.id:
4144
# Explain where the options are defined
4145
self.outf.write('%s:\n' % (store.id,))
4146
cur_store_id = store.id
4148
if (section.id is not None
4149
and cur_section != section.id):
4150
# Display the section id as it appears in the store
4151
# (None doesn't appear by definition)
4152
self.outf.write(' [%s]\n' % (section.id,))
4153
cur_section = section.id
4154
value = section.get(oname, expand=False)
4155
# Since we don't use the stack, we need to restore a
4158
opt = option_registry.get(oname)
4159
value = opt.convert_from_unicode(store, value)
4161
value = store.unquote(value)
4162
value = _quoting_config._quote(value)
4163
self.outf.write(' %s = %s\n' % (oname, value))
4165
def _set_config_option(self, name, value, directory, scope):
4166
conf = self._get_stack(directory, scope)
4167
conf.set(name, value)
4169
def _remove_config_option(self, name, directory, scope):
4171
raise errors.BzrCommandError(
4172
'--remove expects an option to remove.')
4173
conf = self._get_stack(directory, scope)
4177
raise errors.NoSuchConfigOption(name)
4182
# We need adapters that can build a Store or a Stack in a test context. Test
4183
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4184
# themselves. The builder will receive a test instance and should return a
4185
# ready-to-use store or stack. Plugins that define new store/stacks can also
4186
# register themselves here to be tested against the tests defined in
4187
# bzrlib.tests.test_config. Note that the builder can be called multiple times
4188
# for the same test.
4190
# The registered object should be a callable receiving a test instance
4191
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4193
test_store_builder_registry = registry.Registry()
4195
# The registered object should be a callable receiving a test instance
4196
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4198
test_stack_builder_registry = registry.Registry()