1508
2222
configobj[name] = value
1510
2224
configobj.setdefault(section, {})[name] = value
2225
for hook in OldConfigHooks['set']:
2226
hook(self, name, value)
2227
self._set_configobj(configobj)
2229
def remove_option(self, option_name, section_name=None):
2230
configobj = self._get_configobj()
2231
if section_name is None:
2232
del configobj[option_name]
2234
del configobj[section_name][option_name]
2235
for hook in OldConfigHooks['remove']:
2236
hook(self, option_name)
1511
2237
self._set_configobj(configobj)
1513
2239
def _get_config_file(self):
1515
return StringIO(self._transport.get_bytes(self._filename))
2241
f = StringIO(self._transport.get_bytes(self._filename))
2242
for hook in OldConfigHooks['load']:
1516
2245
except errors.NoSuchFile:
1517
2246
return StringIO()
2247
except errors.PermissionDenied, e:
2248
trace.warning("Permission denied while trying to open "
2249
"configuration file %s.", urlutils.unescape_for_display(
2250
urlutils.join(self._transport.base, self._filename), "utf-8"))
2253
def _external_url(self):
2254
return urlutils.join(self._transport.external_url(), self._filename)
1519
2256
def _get_configobj(self):
1520
return ConfigObj(self._get_config_file(), encoding='utf-8')
2257
f = self._get_config_file()
2260
conf = ConfigObj(f, encoding='utf-8')
2261
except configobj.ConfigObjError, e:
2262
raise errors.ParseConfigError(e.errors, self._external_url())
2263
except UnicodeDecodeError:
2264
raise errors.ConfigContentError(self._external_url())
1522
2269
def _set_configobj(self, configobj):
1523
2270
out_file = StringIO()
1524
2271
configobj.write(out_file)
1525
2272
out_file.seek(0)
1526
2273
self._transport.put_file(self._filename, out_file)
2274
for hook in OldConfigHooks['save']:
2278
class Option(object):
2279
"""An option definition.
2281
The option *values* are stored in config files and found in sections.
2283
Here we define various properties about the option itself, its default
2284
value, how to convert it from stores, what to do when invalid values are
2285
encoutered, in which config files it can be stored.
2288
def __init__(self, name, override_from_env=None,
2289
default=None, default_from_env=None,
2290
help=None, from_unicode=None, invalid=None, unquote=True):
2291
"""Build an option definition.
2293
:param name: the name used to refer to the option.
2295
:param override_from_env: A list of environment variables which can
2296
provide override any configuration setting.
2298
:param default: the default value to use when none exist in the config
2299
stores. This is either a string that ``from_unicode`` will convert
2300
into the proper type, a callable returning a unicode string so that
2301
``from_unicode`` can be used on the return value, or a python
2302
object that can be stringified (so only the empty list is supported
2305
:param default_from_env: A list of environment variables which can
2306
provide a default value. 'default' will be used only if none of the
2307
variables specified here are set in the environment.
2309
:param help: a doc string to explain the option to the user.
2311
:param from_unicode: a callable to convert the unicode string
2312
representing the option value in a store. This is not called for
2315
:param invalid: the action to be taken when an invalid value is
2316
encountered in a store. This is called only when from_unicode is
2317
invoked to convert a string and returns None or raise ValueError or
2318
TypeError. Accepted values are: None (ignore invalid values),
2319
'warning' (emit a warning), 'error' (emit an error message and
2322
:param unquote: should the unicode value be unquoted before conversion.
2323
This should be used only when the store providing the values cannot
2324
safely unquote them (see http://pad.lv/906897). It is provided so
2325
daughter classes can handle the quoting themselves.
2327
if override_from_env is None:
2328
override_from_env = []
2329
if default_from_env is None:
2330
default_from_env = []
2332
self.override_from_env = override_from_env
2333
# Convert the default value to a unicode string so all values are
2334
# strings internally before conversion (via from_unicode) is attempted.
2337
elif isinstance(default, list):
2338
# Only the empty list is supported
2340
raise AssertionError(
2341
'Only empty lists are supported as default values')
2343
elif isinstance(default, (str, unicode, bool, int, float)):
2344
# Rely on python to convert strings, booleans and integers
2345
self.default = u'%s' % (default,)
2346
elif callable(default):
2347
self.default = default
2349
# other python objects are not expected
2350
raise AssertionError('%r is not supported as a default value'
2352
self.default_from_env = default_from_env
2354
self.from_unicode = from_unicode
2355
self.unquote = unquote
2356
if invalid and invalid not in ('warning', 'error'):
2357
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2358
self.invalid = invalid
2364
def convert_from_unicode(self, store, unicode_value):
2365
if self.unquote and store is not None and unicode_value is not None:
2366
unicode_value = store.unquote(unicode_value)
2367
if self.from_unicode is None or unicode_value is None:
2368
# Don't convert or nothing to convert
2369
return unicode_value
2371
converted = self.from_unicode(unicode_value)
2372
except (ValueError, TypeError):
2373
# Invalid values are ignored
2375
if converted is None and self.invalid is not None:
2376
# The conversion failed
2377
if self.invalid == 'warning':
2378
trace.warning('Value "%s" is not valid for "%s"',
2379
unicode_value, self.name)
2380
elif self.invalid == 'error':
2381
raise errors.ConfigOptionValueError(self.name, unicode_value)
2384
def get_override(self):
2386
for var in self.override_from_env:
2388
# If the env variable is defined, its value takes precedence
2389
value = os.environ[var].decode(osutils.get_user_encoding())
2395
def get_default(self):
2397
for var in self.default_from_env:
2399
# If the env variable is defined, its value is the default one
2400
value = os.environ[var].decode(osutils.get_user_encoding())
2405
# Otherwise, fallback to the value defined at registration
2406
if callable(self.default):
2407
value = self.default()
2408
if not isinstance(value, unicode):
2409
raise AssertionError(
2410
'Callable default values should be unicode')
2412
value = self.default
2415
def get_help_topic(self):
2418
def get_help_text(self, additional_see_also=None, plain=True):
2420
from bzrlib import help_topics
2421
result += help_topics._format_see_also(additional_see_also)
2423
result = help_topics.help_as_plain_text(result)
2427
# Predefined converters to get proper values from store
2429
def bool_from_store(unicode_str):
2430
return ui.bool_from_string(unicode_str)
2433
def int_from_store(unicode_str):
2434
return int(unicode_str)
2437
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2439
def int_SI_from_store(unicode_str):
2440
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2442
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2443
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2446
:return Integer, expanded to its base-10 value if a proper SI unit is
2447
found, None otherwise.
2449
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2450
p = re.compile(regexp, re.IGNORECASE)
2451
m = p.match(unicode_str)
2454
val, _, unit = m.groups()
2458
coeff = _unit_suffixes[unit.upper()]
2460
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2465
def float_from_store(unicode_str):
2466
return float(unicode_str)
2469
# Use a an empty dict to initialize an empty configobj avoiding all
2470
# parsing and encoding checks
2471
_list_converter_config = configobj.ConfigObj(
2472
{}, encoding='utf-8', list_values=True, interpolation=False)
2475
class ListOption(Option):
2477
def __init__(self, name, default=None, default_from_env=None,
2478
help=None, invalid=None):
2479
"""A list Option definition.
2481
This overrides the base class so the conversion from a unicode string
2482
can take quoting into account.
2484
super(ListOption, self).__init__(
2485
name, default=default, default_from_env=default_from_env,
2486
from_unicode=self.from_unicode, help=help,
2487
invalid=invalid, unquote=False)
2489
def from_unicode(self, unicode_str):
2490
if not isinstance(unicode_str, basestring):
2492
# Now inject our string directly as unicode. All callers got their
2493
# value from configobj, so values that need to be quoted are already
2495
_list_converter_config.reset()
2496
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2497
maybe_list = _list_converter_config['list']
2498
if isinstance(maybe_list, basestring):
2500
# A single value, most probably the user forgot (or didn't care
2501
# to add) the final ','
2504
# The empty string, convert to empty list
2507
# We rely on ConfigObj providing us with a list already
2512
class RegistryOption(Option):
2513
"""Option for a choice from a registry."""
2515
def __init__(self, name, registry, default_from_env=None,
2516
help=None, invalid=None):
2517
"""A registry based Option definition.
2519
This overrides the base class so the conversion from a unicode string
2520
can take quoting into account.
2522
super(RegistryOption, self).__init__(
2523
name, default=lambda: unicode(registry.default_key),
2524
default_from_env=default_from_env,
2525
from_unicode=self.from_unicode, help=help,
2526
invalid=invalid, unquote=False)
2527
self.registry = registry
2529
def from_unicode(self, unicode_str):
2530
if not isinstance(unicode_str, basestring):
2533
return self.registry.get(unicode_str)
2536
"Invalid value %s for %s."
2537
"See help for a list of possible values." % (unicode_str,
2542
ret = [self._help, "\n\nThe following values are supported:\n"]
2543
for key in self.registry.keys():
2544
ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
2548
class OptionRegistry(registry.Registry):
2549
"""Register config options by their name.
2551
This overrides ``registry.Registry`` to simplify registration by acquiring
2552
some information from the option object itself.
2555
def register(self, option):
2556
"""Register a new option to its name.
2558
:param option: The option to register. Its name is used as the key.
2560
super(OptionRegistry, self).register(option.name, option,
2563
def register_lazy(self, key, module_name, member_name):
2564
"""Register a new option to be loaded on request.
2566
:param key: the key to request the option later. Since the registration
2567
is lazy, it should be provided and match the option name.
2569
:param module_name: the python path to the module. Such as 'os.path'.
2571
:param member_name: the member of the module to return. If empty or
2572
None, get() will return the module itself.
2574
super(OptionRegistry, self).register_lazy(key,
2575
module_name, member_name)
2577
def get_help(self, key=None):
2578
"""Get the help text associated with the given key"""
2579
option = self.get(key)
2580
the_help = option.help
2581
if callable(the_help):
2582
return the_help(self, key)
2586
option_registry = OptionRegistry()
2589
# Registered options in lexicographical order
2591
option_registry.register(
2592
Option('append_revisions_only',
2593
default=None, from_unicode=bool_from_store, invalid='warning',
2595
Whether to only append revisions to the mainline.
2597
If this is set to true, then it is not possible to change the
2598
existing mainline of the branch.
2600
option_registry.register(
2601
ListOption('acceptable_keys',
2604
List of GPG key patterns which are acceptable for verification.
2606
option_registry.register(
2607
Option('add.maximum_file_size',
2608
default=u'20MB', from_unicode=int_SI_from_store,
2610
Size above which files should be added manually.
2612
Files below this size are added automatically when using ``bzr add`` without
2615
A negative value means disable the size check.
2617
option_registry.register(
2619
default=None, from_unicode=bool_from_store,
2621
Is the branch bound to ``bound_location``.
2623
If set to "True", the branch should act as a checkout, and push each commit to
2624
the bound_location. This option is normally set by ``bind``/``unbind``.
2626
See also: bound_location.
2628
option_registry.register(
2629
Option('bound_location',
2632
The location that commits should go to when acting as a checkout.
2634
This option is normally set by ``bind``.
2638
option_registry.register(
2639
Option('branch.fetch_tags', default=False, from_unicode=bool_from_store,
2641
Whether revisions associated with tags should be fetched.
2643
option_registry.register_lazy(
2644
'bzr.transform.orphan_policy', 'bzrlib.transform', 'opt_transform_orphan')
2645
option_registry.register(
2646
Option('bzr.workingtree.worth_saving_limit', default=10,
2647
from_unicode=int_from_store, invalid='warning',
2649
How many changes before saving the dirstate.
2651
-1 means that we will never rewrite the dirstate file for only
2652
stat-cache changes. Regardless of this setting, we will always rewrite
2653
the dirstate file if a file is added/removed/renamed/etc. This flag only
2654
affects the behavior of updating the dirstate file after we notice that
2655
a file has been touched.
2657
option_registry.register(
2658
Option('bugtracker', default=None,
2660
Default bug tracker to use.
2662
This bug tracker will be used for example when marking bugs
2663
as fixed using ``bzr commit --fixes``, if no explicit
2664
bug tracker was specified.
2666
option_registry.register(
2667
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2668
from_unicode=signature_policy_from_unicode,
2670
GPG checking policy.
2672
Possible values: require, ignore, check-available (default)
2674
this option will control whether bzr will require good gpg
2675
signatures, ignore them, or check them if they are
2678
option_registry.register(
2679
Option('child_submit_format',
2680
help='''The preferred format of submissions to this branch.'''))
2681
option_registry.register(
2682
Option('child_submit_to',
2683
help='''Where submissions to this branch are mailed to.'''))
2684
option_registry.register(
2685
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2686
from_unicode=signing_policy_from_unicode,
2690
Possible values: always, never, when-required (default)
2692
This option controls whether bzr will always create
2693
gpg signatures or not on commits.
2695
option_registry.register(
2696
Option('dirstate.fdatasync', default=True,
2697
from_unicode=bool_from_store,
2699
Flush dirstate changes onto physical disk?
2701
If true (default), working tree metadata changes are flushed through the
2702
OS buffers to physical disk. This is somewhat slower, but means data
2703
should not be lost if the machine crashes. See also repository.fdatasync.
2705
option_registry.register(
2706
ListOption('debug_flags', default=[],
2707
help='Debug flags to activate.'))
2708
option_registry.register(
2709
Option('default_format', default='2a',
2710
help='Format used when creating branches.'))
2711
option_registry.register(
2712
Option('dpush_strict', default=None,
2713
from_unicode=bool_from_store,
2715
The default value for ``dpush --strict``.
2717
If present, defines the ``--strict`` option default value for checking
2718
uncommitted changes before pushing into a different VCS without any
2719
custom bzr metadata.
2721
option_registry.register(
2723
help='The command called to launch an editor to enter a message.'))
2724
option_registry.register(
2725
Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
2726
help='The users identity'))
2727
option_registry.register(
2728
Option('gpg_signing_command',
2731
Program to use use for creating signatures.
2733
This should support at least the -u and --clearsign options.
2735
option_registry.register(
2736
Option('gpg_signing_key',
2739
GPG key to use for signing.
2741
This defaults to the first key associated with the users email.
2743
option_registry.register(
2744
Option('ignore_missing_extensions', default=False,
2745
from_unicode=bool_from_store,
2747
Control the missing extensions warning display.
2749
The warning will not be emitted if set to True.
2751
option_registry.register(
2753
help='Language to translate messages into.'))
2754
option_registry.register(
2755
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2757
Steal locks that appears to be dead.
2759
If set to True, bzr will check if a lock is supposed to be held by an
2760
active process from the same user on the same machine. If the user and
2761
machine match, but no process with the given PID is active, then bzr
2762
will automatically break the stale lock, and create a new lock for
2764
Otherwise, bzr will prompt as normal to break the lock.
2766
option_registry.register(
2767
Option('log_format', default='long',
2769
Log format to use when displaying revisions.
2771
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2772
may be provided by plugins.
2774
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
2776
option_registry.register(
2777
Option('output_encoding',
2778
help= 'Unicode encoding for output'
2779
' (terminal encoding if not specified).'))
2780
option_registry.register(
2781
Option('parent_location',
2784
The location of the default branch for pull or merge.
2786
This option is normally set when creating a branch, the first ``pull`` or by
2787
``pull --remember``.
2789
option_registry.register(
2790
Option('post_commit', default=None,
2792
Post commit functions.
2794
An ordered list of python functions to call, separated by spaces.
2796
Each function takes branch, rev_id as parameters.
2798
option_registry.register(
2799
Option('public_branch',
2802
A publically-accessible version of this branch.
2804
This implies that the branch setting this option is not publically-accessible.
2805
Used and set by ``bzr send``.
2807
option_registry.register(
2808
Option('push_location',
2811
The location of the default branch for push.
2813
This option is normally set by the first ``push`` or ``push --remember``.
2815
option_registry.register(
2816
Option('push_strict', default=None,
2817
from_unicode=bool_from_store,
2819
The default value for ``push --strict``.
2821
If present, defines the ``--strict`` option default value for checking
2822
uncommitted changes before sending a merge directive.
2824
option_registry.register(
2825
Option('repository.fdatasync', default=True,
2826
from_unicode=bool_from_store,
2828
Flush repository changes onto physical disk?
2830
If true (default), repository changes are flushed through the OS buffers
2831
to physical disk. This is somewhat slower, but means data should not be
2832
lost if the machine crashes. See also dirstate.fdatasync.
2834
option_registry.register_lazy('smtp_server',
2835
'bzrlib.smtp_connection', 'smtp_server')
2836
option_registry.register_lazy('smtp_password',
2837
'bzrlib.smtp_connection', 'smtp_password')
2838
option_registry.register_lazy('smtp_username',
2839
'bzrlib.smtp_connection', 'smtp_username')
2840
option_registry.register(
2841
Option('selftest.timeout',
2843
from_unicode=int_from_store,
2844
help='Abort selftest if one test takes longer than this many seconds',
2847
option_registry.register(
2848
Option('send_strict', default=None,
2849
from_unicode=bool_from_store,
2851
The default value for ``send --strict``.
2853
If present, defines the ``--strict`` option default value for checking
2854
uncommitted changes before sending a bundle.
2857
option_registry.register(
2858
Option('serve.client_timeout',
2859
default=300.0, from_unicode=float_from_store,
2860
help="If we wait for a new request from a client for more than"
2861
" X seconds, consider the client idle, and hangup."))
2862
option_registry.register(
2863
Option('stacked_on_location',
2865
help="""The location where this branch is stacked on."""))
2866
option_registry.register(
2867
Option('submit_branch',
2870
The branch you intend to submit your current work to.
2872
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2873
by the ``submit:`` revision spec.
2875
option_registry.register(
2877
help='''Where submissions from this branch are mailed to.'''))
2878
option_registry.register(
2879
ListOption('suppress_warnings',
2881
help="List of warning classes to suppress."))
2882
option_registry.register(
2883
Option('validate_signatures_in_log', default=False,
2884
from_unicode=bool_from_store, invalid='warning',
2885
help='''Whether to validate signatures in bzr log.'''))
2886
option_registry.register_lazy('ssl.ca_certs',
2887
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
2889
option_registry.register_lazy('ssl.cert_reqs',
2890
'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2893
class Section(object):
2894
"""A section defines a dict of option name => value.
2896
This is merely a read-only dict which can add some knowledge about the
2897
options. It is *not* a python dict object though and doesn't try to mimic
2901
def __init__(self, section_id, options):
2902
self.id = section_id
2903
# We re-use the dict-like object received
2904
self.options = options
2906
def get(self, name, default=None, expand=True):
2907
return self.options.get(name, default)
2909
def iter_option_names(self):
2910
for k in self.options.iterkeys():
2914
# Mostly for debugging use
2915
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2918
_NewlyCreatedOption = object()
2919
"""Was the option created during the MutableSection lifetime"""
2920
_DeletedOption = object()
2921
"""Was the option deleted during the MutableSection lifetime"""
2924
class MutableSection(Section):
2925
"""A section allowing changes and keeping track of the original values."""
2927
def __init__(self, section_id, options):
2928
super(MutableSection, self).__init__(section_id, options)
2929
self.reset_changes()
2931
def set(self, name, value):
2932
if name not in self.options:
2933
# This is a new option
2934
self.orig[name] = _NewlyCreatedOption
2935
elif name not in self.orig:
2936
self.orig[name] = self.get(name, None)
2937
self.options[name] = value
2939
def remove(self, name):
2940
if name not in self.orig:
2941
self.orig[name] = self.get(name, None)
2942
del self.options[name]
2944
def reset_changes(self):
2947
def apply_changes(self, dirty, store):
2948
"""Apply option value changes.
2950
``self`` has been reloaded from the persistent storage. ``dirty``
2951
contains the changes made since the previous loading.
2953
:param dirty: the mutable section containing the changes.
2955
:param store: the store containing the section
2957
for k, expected in dirty.orig.iteritems():
2958
actual = dirty.get(k, _DeletedOption)
2959
reloaded = self.get(k, _NewlyCreatedOption)
2960
if actual is _DeletedOption:
2961
if k in self.options:
2965
# Report concurrent updates in an ad-hoc way. This should only
2966
# occurs when different processes try to update the same option
2967
# which is not supported (as in: the config framework is not meant
2968
# to be used a sharing mechanism).
2969
if expected != reloaded:
2970
if actual is _DeletedOption:
2971
actual = '<DELETED>'
2972
if reloaded is _NewlyCreatedOption:
2973
reloaded = '<CREATED>'
2974
if expected is _NewlyCreatedOption:
2975
expected = '<CREATED>'
2976
# Someone changed the value since we get it from the persistent
2978
trace.warning(gettext(
2979
"Option {0} in section {1} of {2} was changed"
2980
" from {3} to {4}. The {5} value will be saved.".format(
2981
k, self.id, store.external_url(), expected,
2983
# No need to keep track of these changes
2984
self.reset_changes()
2987
class Store(object):
2988
"""Abstract interface to persistent storage for configuration options."""
2990
readonly_section_class = Section
2991
mutable_section_class = MutableSection
2994
# Which sections need to be saved
2995
self.dirty_sections = []
2997
def is_loaded(self):
2998
"""Returns True if the Store has been loaded.
3000
This is used to implement lazy loading and ensure the persistent
3001
storage is queried only when needed.
3003
raise NotImplementedError(self.is_loaded)
3006
"""Loads the Store from persistent storage."""
3007
raise NotImplementedError(self.load)
3009
def _load_from_string(self, bytes):
3010
"""Create a store from a string in configobj syntax.
3012
:param bytes: A string representing the file content.
3014
raise NotImplementedError(self._load_from_string)
3017
"""Unloads the Store.
3019
This should make is_loaded() return False. This is used when the caller
3020
knows that the persistent storage has changed or may have change since
3023
raise NotImplementedError(self.unload)
3025
def quote(self, value):
3026
"""Quote a configuration option value for storing purposes.
3028
This allows Stacks to present values as they will be stored.
3032
def unquote(self, value):
3033
"""Unquote a configuration option value into unicode.
3035
The received value is quoted as stored.
3040
"""Saves the Store to persistent storage."""
3041
raise NotImplementedError(self.save)
3043
def _need_saving(self):
3044
for s in self.dirty_sections:
3046
# At least one dirty section contains a modification
3050
def apply_changes(self, dirty_sections):
3051
"""Apply changes from dirty sections while checking for coherency.
3053
The Store content is discarded and reloaded from persistent storage to
3054
acquire up-to-date values.
3056
Dirty sections are MutableSection which kept track of the value they
3057
are expected to update.
3059
# We need an up-to-date version from the persistent storage, unload the
3060
# store. The reload will occur when needed (triggered by the first
3061
# get_mutable_section() call below.
3063
# Apply the changes from the preserved dirty sections
3064
for dirty in dirty_sections:
3065
clean = self.get_mutable_section(dirty.id)
3066
clean.apply_changes(dirty, self)
3067
# Everything is clean now
3068
self.dirty_sections = []
3070
def save_changes(self):
3071
"""Saves the Store to persistent storage if changes occurred.
3073
Apply the changes recorded in the mutable sections to a store content
3074
refreshed from persistent storage.
3076
raise NotImplementedError(self.save_changes)
3078
def external_url(self):
3079
raise NotImplementedError(self.external_url)
3081
def get_sections(self):
3082
"""Returns an ordered iterable of existing sections.
3084
:returns: An iterable of (store, section).
3086
raise NotImplementedError(self.get_sections)
3088
def get_mutable_section(self, section_id=None):
3089
"""Returns the specified mutable section.
3091
:param section_id: The section identifier
3093
raise NotImplementedError(self.get_mutable_section)
3096
# Mostly for debugging use
3097
return "<config.%s(%s)>" % (self.__class__.__name__,
3098
self.external_url())
3101
class CommandLineStore(Store):
3102
"A store to carry command line overrides for the config options."""
3104
def __init__(self, opts=None):
3105
super(CommandLineStore, self).__init__()
3112
# The dict should be cleared but not replaced so it can be shared.
3113
self.options.clear()
3115
def _from_cmdline(self, overrides):
3116
# Reset before accepting new definitions
3118
for over in overrides:
3120
name, value = over.split('=', 1)
3122
raise errors.BzrCommandError(
3123
gettext("Invalid '%s', should be of the form 'name=value'")
3125
self.options[name] = value
3127
def external_url(self):
3128
# Not an url but it makes debugging easier and is never needed
3132
def get_sections(self):
3133
yield self, self.readonly_section_class(None, self.options)
3136
class IniFileStore(Store):
3137
"""A config Store using ConfigObj for storage.
3139
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3140
serialize/deserialize the config file.
3144
"""A config Store using ConfigObj for storage.
3146
super(IniFileStore, self).__init__()
3147
self._config_obj = None
3149
def is_loaded(self):
3150
return self._config_obj != None
3153
self._config_obj = None
3154
self.dirty_sections = []
3156
def _load_content(self):
3157
"""Load the config file bytes.
3159
This should be provided by subclasses
3161
:return: Byte string
3163
raise NotImplementedError(self._load_content)
3165
def _save_content(self, content):
3166
"""Save the config file bytes.
3168
This should be provided by subclasses
3170
:param content: Config file bytes to write
3172
raise NotImplementedError(self._save_content)
3175
"""Load the store from the associated file."""
3176
if self.is_loaded():
3178
content = self._load_content()
3179
self._load_from_string(content)
3180
for hook in ConfigHooks['load']:
3183
def _load_from_string(self, bytes):
3184
"""Create a config store from a string.
3186
:param bytes: A string representing the file content.
3188
if self.is_loaded():
3189
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3190
co_input = StringIO(bytes)
3192
# The config files are always stored utf8-encoded
3193
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3195
except configobj.ConfigObjError, e:
3196
self._config_obj = None
3197
raise errors.ParseConfigError(e.errors, self.external_url())
3198
except UnicodeDecodeError:
3199
raise errors.ConfigContentError(self.external_url())
3201
def save_changes(self):
3202
if not self.is_loaded():
3205
if not self._need_saving():
3207
# Preserve the current version
3208
current = self._config_obj
3209
dirty_sections = list(self.dirty_sections)
3210
self.apply_changes(dirty_sections)
3211
# Save to the persistent storage
3215
if not self.is_loaded():
3219
self._config_obj.write(out)
3220
self._save_content(out.getvalue())
3221
for hook in ConfigHooks['save']:
3224
def get_sections(self):
3225
"""Get the configobj section in the file order.
3227
:returns: An iterable of (store, section).
3229
# We need a loaded store
3232
except (errors.NoSuchFile, errors.PermissionDenied):
3233
# If the file can't be read, there is no sections
3235
cobj = self._config_obj
3237
yield self, self.readonly_section_class(None, cobj)
3238
for section_name in cobj.sections:
3240
self.readonly_section_class(section_name,
3241
cobj[section_name]))
3243
def get_mutable_section(self, section_id=None):
3244
# We need a loaded store
3247
except errors.NoSuchFile:
3248
# The file doesn't exist, let's pretend it was empty
3249
self._load_from_string('')
3250
if section_id is None:
3251
section = self._config_obj
3253
section = self._config_obj.setdefault(section_id, {})
3254
mutable_section = self.mutable_section_class(section_id, section)
3255
# All mutable sections can become dirty
3256
self.dirty_sections.append(mutable_section)
3257
return mutable_section
3259
def quote(self, value):
3261
# configobj conflates automagical list values and quoting
3262
self._config_obj.list_values = True
3263
return self._config_obj._quote(value)
3265
self._config_obj.list_values = False
3267
def unquote(self, value):
3268
if value and isinstance(value, basestring):
3269
# _unquote doesn't handle None nor empty strings nor anything that
3270
# is not a string, really.
3271
value = self._config_obj._unquote(value)
3274
def external_url(self):
3275
# Since an IniFileStore can be used without a file (at least in tests),
3276
# it's better to provide something than raising a NotImplementedError.
3277
# All daughter classes are supposed to provide an implementation
3279
return 'In-Process Store, no URL'
3281
class TransportIniFileStore(IniFileStore):
3282
"""IniFileStore that loads files from a transport.
3284
:ivar transport: The transport object where the config file is located.
3286
:ivar file_name: The config file basename in the transport directory.
3289
def __init__(self, transport, file_name):
3290
"""A Store using a ini file on a Transport
3292
:param transport: The transport object where the config file is located.
3293
:param file_name: The config file basename in the transport directory.
3295
super(TransportIniFileStore, self).__init__()
3296
self.transport = transport
3297
self.file_name = file_name
3299
def _load_content(self):
3301
return self.transport.get_bytes(self.file_name)
3302
except errors.PermissionDenied:
3303
trace.warning("Permission denied while trying to load "
3304
"configuration store %s.", self.external_url())
3307
def _save_content(self, content):
3308
self.transport.put_bytes(self.file_name, content)
3310
def external_url(self):
3311
# FIXME: external_url should really accepts an optional relpath
3312
# parameter (bug #750169) :-/ -- vila 2011-04-04
3313
# The following will do in the interim but maybe we don't want to
3314
# expose a path here but rather a config ID and its associated
3315
# object </hand wawe>.
3316
return urlutils.join(self.transport.external_url(), self.file_name)
3319
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3320
# unlockable stores for use with objects that can already ensure the locking
3321
# (think branches). If different stores (not based on ConfigObj) are created,
3322
# they may face the same issue.
3325
class LockableIniFileStore(TransportIniFileStore):
3326
"""A ConfigObjStore using locks on save to ensure store integrity."""
3328
def __init__(self, transport, file_name, lock_dir_name=None):
3329
"""A config Store using ConfigObj for storage.
3331
:param transport: The transport object where the config file is located.
3333
:param file_name: The config file basename in the transport directory.
3335
if lock_dir_name is None:
3336
lock_dir_name = 'lock'
3337
self.lock_dir_name = lock_dir_name
3338
super(LockableIniFileStore, self).__init__(transport, file_name)
3339
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3341
def lock_write(self, token=None):
3342
"""Takes a write lock in the directory containing the config file.
3344
If the directory doesn't exist it is created.
3346
# FIXME: This doesn't check the ownership of the created directories as
3347
# ensure_config_dir_exists does. It should if the transport is local
3348
# -- vila 2011-04-06
3349
self.transport.create_prefix()
3350
return self._lock.lock_write(token)
3355
def break_lock(self):
3356
self._lock.break_lock()
3360
# We need to be able to override the undecorated implementation
3361
self.save_without_locking()
3363
def save_without_locking(self):
3364
super(LockableIniFileStore, self).save()
3367
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3368
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3369
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3371
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3372
# functions or a registry will make it easier and clearer for tests, focusing
3373
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3374
# on a poolie's remark)
3375
class GlobalStore(LockableIniFileStore):
3377
def __init__(self, possible_transports=None):
3378
t = transport.get_transport_from_path(
3379
config_dir(), possible_transports=possible_transports)
3380
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3384
class LocationStore(LockableIniFileStore):
3386
def __init__(self, possible_transports=None):
3387
t = transport.get_transport_from_path(
3388
config_dir(), possible_transports=possible_transports)
3389
super(LocationStore, self).__init__(t, 'locations.conf')
3390
self.id = 'locations'
3393
class BranchStore(TransportIniFileStore):
3395
def __init__(self, branch):
3396
super(BranchStore, self).__init__(branch.control_transport,
3398
self.branch = branch
3402
class ControlStore(LockableIniFileStore):
3404
def __init__(self, bzrdir):
3405
super(ControlStore, self).__init__(bzrdir.transport,
3407
lock_dir_name='branch_lock')
3411
class SectionMatcher(object):
3412
"""Select sections into a given Store.
3414
This is intended to be used to postpone getting an iterable of sections
3418
def __init__(self, store):
3421
def get_sections(self):
3422
# This is where we require loading the store so we can see all defined
3424
sections = self.store.get_sections()
3425
# Walk the revisions in the order provided
3426
for store, s in sections:
3430
def match(self, section):
3431
"""Does the proposed section match.
3433
:param section: A Section object.
3435
:returns: True if the section matches, False otherwise.
3437
raise NotImplementedError(self.match)
3440
class NameMatcher(SectionMatcher):
3442
def __init__(self, store, section_id):
3443
super(NameMatcher, self).__init__(store)
3444
self.section_id = section_id
3446
def match(self, section):
3447
return section.id == self.section_id
3450
class LocationSection(Section):
3452
def __init__(self, section, extra_path):
3453
super(LocationSection, self).__init__(section.id, section.options)
3454
self.extra_path = extra_path
3455
self.locals = {'relpath': extra_path,
3456
'basename': urlutils.basename(extra_path)}
3458
def get(self, name, default=None, expand=True):
3459
value = super(LocationSection, self).get(name, default)
3460
if value is not None and expand:
3461
policy_name = self.get(name + ':policy', None)
3462
policy = _policy_value.get(policy_name, POLICY_NONE)
3463
if policy == POLICY_APPENDPATH:
3464
value = urlutils.join(value, self.extra_path)
3465
# expand section local options right now (since POLICY_APPENDPATH
3466
# will never add options references, it's ok to expand after it).
3468
for is_ref, chunk in iter_option_refs(value):
3470
chunks.append(chunk)
3473
if ref in self.locals:
3474
chunks.append(self.locals[ref])
3476
chunks.append(chunk)
3477
value = ''.join(chunks)
3481
class StartingPathMatcher(SectionMatcher):
3482
"""Select sections for a given location respecting the Store order."""
3484
# FIXME: Both local paths and urls can be used for section names as well as
3485
# ``location`` to stay consistent with ``LocationMatcher`` which itself
3486
# inherited the fuzziness from the previous ``LocationConfig``
3487
# implementation. We probably need to revisit which encoding is allowed for
3488
# both ``location`` and section names and how we normalize
3489
# them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
3490
# related too. -- vila 2012-01-04
3492
def __init__(self, store, location):
3493
super(StartingPathMatcher, self).__init__(store)
3494
if location.startswith('file://'):
3495
location = urlutils.local_path_from_url(location)
3496
self.location = location
3498
def get_sections(self):
3499
"""Get all sections matching ``location`` in the store.
3501
The most generic sections are described first in the store, then more
3502
specific ones can be provided for reduced scopes.
3504
The returned section are therefore returned in the reversed order so
3505
the most specific ones can be found first.
3507
location_parts = self.location.rstrip('/').split('/')
3510
# Later sections are more specific, they should be returned first
3511
for _, section in reversed(list(store.get_sections())):
3512
if section.id is None:
3513
# The no-name section is always included if present
3514
yield store, LocationSection(section, self.location)
3516
section_path = section.id
3517
if section_path.startswith('file://'):
3518
# the location is already a local path or URL, convert the
3519
# section id to the same format
3520
section_path = urlutils.local_path_from_url(section_path)
3521
if (self.location.startswith(section_path)
3522
or fnmatch.fnmatch(self.location, section_path)):
3523
section_parts = section_path.rstrip('/').split('/')
3524
extra_path = '/'.join(location_parts[len(section_parts):])
3525
yield store, LocationSection(section, extra_path)
3528
class LocationMatcher(SectionMatcher):
3530
def __init__(self, store, location):
3531
super(LocationMatcher, self).__init__(store)
3532
if location.startswith('file://'):
3533
location = urlutils.local_path_from_url(location)
3534
self.location = location
3536
def _get_matching_sections(self):
3537
"""Get all sections matching ``location``."""
3538
# We slightly diverge from LocalConfig here by allowing the no-name
3539
# section as the most generic one and the lower priority.
3540
no_name_section = None
3542
# Filter out the no_name_section so _iter_for_location_by_parts can be
3543
# used (it assumes all sections have a name).
3544
for _, section in self.store.get_sections():
3545
if section.id is None:
3546
no_name_section = section
3548
all_sections.append(section)
3549
# Unfortunately _iter_for_location_by_parts deals with section names so
3550
# we have to resync.
3551
filtered_sections = _iter_for_location_by_parts(
3552
[s.id for s in all_sections], self.location)
3553
iter_all_sections = iter(all_sections)
3554
matching_sections = []
3555
if no_name_section is not None:
3556
matching_sections.append(
3557
(0, LocationSection(no_name_section, self.location)))
3558
for section_id, extra_path, length in filtered_sections:
3559
# a section id is unique for a given store so it's safe to take the
3560
# first matching section while iterating. Also, all filtered
3561
# sections are part of 'all_sections' and will always be found
3564
section = iter_all_sections.next()
3565
if section_id == section.id:
3566
matching_sections.append(
3567
(length, LocationSection(section, extra_path)))
3569
return matching_sections
3571
def get_sections(self):
3572
# Override the default implementation as we want to change the order
3573
matching_sections = self._get_matching_sections()
3574
# We want the longest (aka more specific) locations first
3575
sections = sorted(matching_sections,
3576
key=lambda (length, section): (length, section.id),
3578
# Sections mentioning 'ignore_parents' restrict the selection
3579
for _, section in sections:
3580
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3581
ignore = section.get('ignore_parents', None)
3582
if ignore is not None:
3583
ignore = ui.bool_from_string(ignore)
3586
# Finally, we have a valid section
3587
yield self.store, section
3590
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3591
"""Describes an expandable option reference.
3593
We want to match the most embedded reference first.
3595
I.e. for '{{foo}}' we will get '{foo}',
3596
for '{bar{baz}}' we will get '{baz}'
3599
def iter_option_refs(string):
3600
# Split isolate refs so every other chunk is a ref
3602
for chunk in _option_ref_re.split(string):
3607
class Stack(object):
3608
"""A stack of configurations where an option can be defined"""
3610
def __init__(self, sections_def, store=None, mutable_section_id=None):
3611
"""Creates a stack of sections with an optional store for changes.
3613
:param sections_def: A list of Section or callables that returns an
3614
iterable of Section. This defines the Sections for the Stack and
3615
can be called repeatedly if needed.
3617
:param store: The optional Store where modifications will be
3618
recorded. If none is specified, no modifications can be done.
3620
:param mutable_section_id: The id of the MutableSection where changes
3621
are recorded. This requires the ``store`` parameter to be
3624
self.sections_def = sections_def
3626
self.mutable_section_id = mutable_section_id
3628
def iter_sections(self):
3629
"""Iterate all the defined sections."""
3630
# Ensuring lazy loading is achieved by delaying section matching (which
3631
# implies querying the persistent storage) until it can't be avoided
3632
# anymore by using callables to describe (possibly empty) section
3634
for sections in self.sections_def:
3635
for store, section in sections():
3636
yield store, section
3638
def get(self, name, expand=True, convert=True):
3639
"""Return the *first* option value found in the sections.
3641
This is where we guarantee that sections coming from Store are loaded
3642
lazily: the loading is delayed until we need to either check that an
3643
option exists or get its value, which in turn may require to discover
3644
in which sections it can be defined. Both of these (section and option
3645
existence) require loading the store (even partially).
3647
:param name: The queried option.
3649
:param expand: Whether options references should be expanded.
3651
:param convert: Whether the option value should be converted from
3652
unicode (do nothing for non-registered options).
3654
:returns: The value of the option.
3656
# FIXME: No caching of options nor sections yet -- vila 20110503
3658
found_store = None # Where the option value has been found
3659
# If the option is registered, it may provide additional info about
3662
opt = option_registry.get(name)
3667
def expand_and_convert(val):
3668
# This may need to be called in different contexts if the value is
3669
# None or ends up being None during expansion or conversion.
3672
if isinstance(val, basestring):
3673
val = self._expand_options_in_string(val)
3675
trace.warning('Cannot expand "%s":'
3676
' %s does not support option expansion'
3677
% (name, type(val)))
3679
val = found_store.unquote(val)
3681
val = opt.convert_from_unicode(found_store, val)
3684
# First of all, check if the environment can override the configuration
3686
if opt is not None and opt.override_from_env:
3687
value = opt.get_override()
3688
value = expand_and_convert(value)
3690
for store, section in self.iter_sections():
3691
value = section.get(name)
3692
if value is not None:
3695
value = expand_and_convert(value)
3696
if opt is not None and value is None:
3697
# If the option is registered, it may provide a default value
3698
value = opt.get_default()
3699
value = expand_and_convert(value)
3700
for hook in ConfigHooks['get']:
3701
hook(self, name, value)
3704
def expand_options(self, string, env=None):
3705
"""Expand option references in the string in the configuration context.
3707
:param string: The string containing option(s) to expand.
3709
:param env: An option dict defining additional configuration options or
3710
overriding existing ones.
3712
:returns: The expanded string.
3714
return self._expand_options_in_string(string, env)
3716
def _expand_options_in_string(self, string, env=None, _refs=None):
3717
"""Expand options in the string in the configuration context.
3719
:param string: The string to be expanded.
3721
:param env: An option dict defining additional configuration options or
3722
overriding existing ones.
3724
:param _refs: Private list (FIFO) containing the options being expanded
3727
:returns: The expanded string.
3730
# Not much to expand there
3733
# What references are currently resolved (to detect loops)
3736
# We need to iterate until no more refs appear ({{foo}} will need two
3737
# iterations for example).
3742
for is_ref, chunk in iter_option_refs(result):
3744
chunks.append(chunk)
3749
raise errors.OptionExpansionLoop(string, _refs)
3751
value = self._expand_option(name, env, _refs)
3753
raise errors.ExpandingUnknownOption(name, string)
3754
chunks.append(value)
3756
result = ''.join(chunks)
3759
def _expand_option(self, name, env, _refs):
3760
if env is not None and name in env:
3761
# Special case, values provided in env takes precedence over
3765
value = self.get(name, expand=False, convert=False)
3766
value = self._expand_options_in_string(value, env, _refs)
3769
def _get_mutable_section(self):
3770
"""Get the MutableSection for the Stack.
3772
This is where we guarantee that the mutable section is lazily loaded:
3773
this means we won't load the corresponding store before setting a value
3774
or deleting an option. In practice the store will often be loaded but
3775
this helps catching some programming errors.
3778
section = store.get_mutable_section(self.mutable_section_id)
3779
return store, section
3781
def set(self, name, value):
3782
"""Set a new value for the option."""
3783
store, section = self._get_mutable_section()
3784
section.set(name, store.quote(value))
3785
for hook in ConfigHooks['set']:
3786
hook(self, name, value)
3788
def remove(self, name):
3789
"""Remove an existing option."""
3790
_, section = self._get_mutable_section()
3791
section.remove(name)
3792
for hook in ConfigHooks['remove']:
3796
# Mostly for debugging use
3797
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3799
def _get_overrides(self):
3800
# Hack around library_state.initialize never called
3801
if bzrlib.global_state is not None:
3802
return bzrlib.global_state.cmdline_overrides.get_sections()
3806
class MemoryStack(Stack):
3807
"""A configuration stack defined from a string.
3809
This is mainly intended for tests and requires no disk resources.
3812
def __init__(self, content=None):
3813
"""Create an in-memory stack from a given content.
3815
It uses a single store based on configobj and support reading and
3818
:param content: The initial content of the store. If None, the store is
3819
not loaded and ``_load_from_string`` can and should be used if
3822
store = IniFileStore()
3823
if content is not None:
3824
store._load_from_string(content)
3825
super(MemoryStack, self).__init__(
3826
[store.get_sections], store)
3829
class _CompatibleStack(Stack):
3830
"""Place holder for compatibility with previous design.
3832
This is intended to ease the transition from the Config-based design to the
3833
Stack-based design and should not be used nor relied upon by plugins.
3835
One assumption made here is that the daughter classes will all use Stores
3836
derived from LockableIniFileStore).
3838
It implements set() and remove () by re-loading the store before applying
3839
the modification and saving it.
3841
The long term plan being to implement a single write by store to save
3842
all modifications, this class should not be used in the interim.
3845
def set(self, name, value):
3848
super(_CompatibleStack, self).set(name, value)
3849
# Force a write to persistent storage
3852
def remove(self, name):
3855
super(_CompatibleStack, self).remove(name)
3856
# Force a write to persistent storage
3860
class GlobalStack(_CompatibleStack):
3861
"""Global options only stack.
3863
The following sections are queried:
3865
* command-line overrides,
3867
* the 'DEFAULT' section in bazaar.conf
3869
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3874
gstore = GlobalStore()
3875
super(GlobalStack, self).__init__(
3876
[self._get_overrides,
3877
NameMatcher(gstore, 'DEFAULT').get_sections],
3878
gstore, mutable_section_id='DEFAULT')
3881
class LocationStack(_CompatibleStack):
3882
"""Per-location options falling back to global options stack.
3885
The following sections are queried:
3887
* command-line overrides,
3889
* the sections matching ``location`` in ``locations.conf``, the order being
3890
defined by the number of path components in the section glob, higher
3891
numbers first (from most specific section to most generic).
3893
* the 'DEFAULT' section in bazaar.conf
3895
This stack will use the ``location`` section in locations.conf as its
3899
def __init__(self, location):
3900
"""Make a new stack for a location and global configuration.
3902
:param location: A URL prefix to """
3903
lstore = LocationStore()
3904
if location.startswith('file://'):
3905
location = urlutils.local_path_from_url(location)
3906
gstore = GlobalStore()
3907
super(LocationStack, self).__init__(
3908
[self._get_overrides,
3909
LocationMatcher(lstore, location).get_sections,
3910
NameMatcher(gstore, 'DEFAULT').get_sections],
3911
lstore, mutable_section_id=location)
3914
class BranchStack(Stack):
3915
"""Per-location options falling back to branch then global options stack.
3917
The following sections are queried:
3919
* command-line overrides,
3921
* the sections matching ``location`` in ``locations.conf``, the order being
3922
defined by the number of path components in the section glob, higher
3923
numbers first (from most specific section to most generic),
3925
* the no-name section in branch.conf,
3927
* the ``DEFAULT`` section in ``bazaar.conf``.
3929
This stack will use the no-name section in ``branch.conf`` as its
3933
def __init__(self, branch):
3934
lstore = LocationStore()
3935
bstore = branch._get_config_store()
3936
gstore = GlobalStore()
3937
super(BranchStack, self).__init__(
3938
[self._get_overrides,
3939
LocationMatcher(lstore, branch.base).get_sections,
3940
NameMatcher(bstore, None).get_sections,
3941
NameMatcher(gstore, 'DEFAULT').get_sections],
3943
self.branch = branch
3945
def lock_write(self, token=None):
3946
return self.branch.lock_write(token)
3949
return self.branch.unlock()
3952
def set(self, name, value):
3953
super(BranchStack, self).set(name, value)
3954
# Unlocking the branch will trigger a store.save_changes() so the last
3955
# unlock saves all the changes.
3958
def remove(self, name):
3959
super(BranchStack, self).remove(name)
3960
# Unlocking the branch will trigger a store.save_changes() so the last
3961
# unlock saves all the changes.
3964
class RemoteControlStack(_CompatibleStack):
3965
"""Remote control-only options stack."""
3967
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3968
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3969
# control.conf and is used only for stack options.
3971
def __init__(self, bzrdir):
3972
cstore = bzrdir._get_config_store()
3973
super(RemoteControlStack, self).__init__(
3974
[NameMatcher(cstore, None).get_sections],
3976
self.bzrdir = bzrdir
3979
class BranchOnlyStack(Stack):
3980
"""Branch-only options stack."""
3982
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
3983
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
3984
# -- vila 2011-12-16
3986
def __init__(self, branch):
3987
bstore = branch._get_config_store()
3988
super(BranchOnlyStack, self).__init__(
3989
[NameMatcher(bstore, None).get_sections],
3991
self.branch = branch
3993
def lock_write(self, token=None):
3994
return self.branch.lock_write(token)
3997
return self.branch.unlock()
4000
def set(self, name, value):
4001
super(BranchOnlyStack, self).set(name, value)
4002
# Force a write to persistent storage
4003
self.store.save_changes()
4006
def remove(self, name):
4007
super(BranchOnlyStack, self).remove(name)
4008
# Force a write to persistent storage
4009
self.store.save_changes()
4012
class cmd_config(commands.Command):
4013
__doc__ = """Display, set or remove a configuration option.
4015
Display the active value for a given option.
4017
If --all is specified, NAME is interpreted as a regular expression and all
4018
matching options are displayed mentioning their scope. The active value
4019
that bzr will take into account is the first one displayed for each option.
4021
If no NAME is given, --all .* is implied.
4023
Setting a value is achieved by using name=value without spaces. The value
4024
is set in the most relevant scope and can be checked by displaying the
4028
takes_args = ['name?']
4032
# FIXME: This should be a registry option so that plugins can register
4033
# their own config files (or not) and will also address
4034
# http://pad.lv/788991 -- vila 20101115
4035
commands.Option('scope', help='Reduce the scope to the specified'
4036
' configuration file.',
4038
commands.Option('all',
4039
help='Display all the defined values for the matching options.',
4041
commands.Option('remove', help='Remove the option from'
4042
' the configuration file.'),
4045
_see_also = ['configuration']
4047
@commands.display_command
4048
def run(self, name=None, all=False, directory=None, scope=None,
4050
if directory is None:
4052
directory = urlutils.normalize_url(directory)
4054
raise errors.BzrError(
4055
'--all and --remove are mutually exclusive.')
4057
# Delete the option in the given scope
4058
self._remove_config_option(name, directory, scope)
4060
# Defaults to all options
4061
self._show_matching_options('.*', directory, scope)
4064
name, value = name.split('=', 1)
4066
# Display the option(s) value(s)
4068
self._show_matching_options(name, directory, scope)
4070
self._show_value(name, directory, scope)
4073
raise errors.BzrError(
4074
'Only one option can be set.')
4075
# Set the option value
4076
self._set_config_option(name, value, directory, scope)
4078
def _get_stack(self, directory, scope=None, write_access=False):
4079
"""Get the configuration stack specified by ``directory`` and ``scope``.
4081
:param directory: Where the configurations are derived from.
4083
:param scope: A specific config to start from.
4085
:param write_access: Whether a write access to the stack will be
4088
# FIXME: scope should allow access to plugin-specific stacks (even
4089
# reduced to the plugin-specific store), related to
4090
# http://pad.lv/788991 -- vila 2011-11-15
4091
if scope is not None:
4092
if scope == 'bazaar':
4093
return GlobalStack()
4094
elif scope == 'locations':
4095
return LocationStack(directory)
4096
elif scope == 'branch':
4098
controldir.ControlDir.open_containing_tree_or_branch(
4101
self.add_cleanup(br.lock_write().unlock)
4102
return br.get_config_stack()
4103
raise errors.NoSuchConfig(scope)
4107
controldir.ControlDir.open_containing_tree_or_branch(
4110
self.add_cleanup(br.lock_write().unlock)
4111
return br.get_config_stack()
4112
except errors.NotBranchError:
4113
return LocationStack(directory)
4115
def _quote_multiline(self, value):
4117
value = '"""' + value + '"""'
4120
def _show_value(self, name, directory, scope):
4121
conf = self._get_stack(directory, scope)
4122
value = conf.get(name, expand=True, convert=False)
4123
if value is not None:
4124
# Quote the value appropriately
4125
value = self._quote_multiline(value)
4126
self.outf.write('%s\n' % (value,))
4128
raise errors.NoSuchConfigOption(name)
4130
def _show_matching_options(self, name, directory, scope):
4131
name = lazy_regex.lazy_compile(name)
4132
# We want any error in the regexp to be raised *now* so we need to
4133
# avoid the delay introduced by the lazy regexp. But, we still do
4134
# want the nicer errors raised by lazy_regex.
4135
name._compile_and_collapse()
4138
conf = self._get_stack(directory, scope)
4139
for store, section in conf.iter_sections():
4140
for oname in section.iter_option_names():
4141
if name.search(oname):
4142
if cur_store_id != store.id:
4143
# Explain where the options are defined
4144
self.outf.write('%s:\n' % (store.id,))
4145
cur_store_id = store.id
4147
if (section.id is not None and cur_section != section.id):
4148
# Display the section id as it appears in the store
4149
# (None doesn't appear by definition)
4150
self.outf.write(' [%s]\n' % (section.id,))
4151
cur_section = section.id
4152
value = section.get(oname, expand=False)
4153
# Quote the value appropriately
4154
value = self._quote_multiline(value)
4155
self.outf.write(' %s = %s\n' % (oname, value))
4157
def _set_config_option(self, name, value, directory, scope):
4158
conf = self._get_stack(directory, scope, write_access=True)
4159
conf.set(name, value)
4161
def _remove_config_option(self, name, directory, scope):
4163
raise errors.BzrCommandError(
4164
'--remove expects an option to remove.')
4165
conf = self._get_stack(directory, scope, write_access=True)
4169
raise errors.NoSuchConfigOption(name)
4174
# We need adapters that can build a Store or a Stack in a test context. Test
4175
# classes, based on TestCaseWithTransport, can use the registry to parametrize
4176
# themselves. The builder will receive a test instance and should return a
4177
# ready-to-use store or stack. Plugins that define new store/stacks can also
4178
# register themselves here to be tested against the tests defined in
4179
# bzrlib.tests.test_config. Note that the builder can be called multiple times
4180
# for the same test.
4182
# The registered object should be a callable receiving a test instance
4183
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
4185
test_store_builder_registry = registry.Registry()
4187
# The registered object should be a callable receiving a test instance
4188
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
4190
test_stack_builder_registry = registry.Registry()