1508
2256
configobj[name] = value
1510
2258
configobj.setdefault(section, {})[name] = value
2259
for hook in OldConfigHooks['set']:
2260
hook(self, name, value)
2261
self._set_configobj(configobj)
2263
def remove_option(self, option_name, section_name=None):
2264
configobj = self._get_configobj()
2265
if section_name is None:
2266
del configobj[option_name]
2268
del configobj[section_name][option_name]
2269
for hook in OldConfigHooks['remove']:
2270
hook(self, option_name)
1511
2271
self._set_configobj(configobj)
1513
2273
def _get_config_file(self):
1515
return StringIO(self._transport.get_bytes(self._filename))
2275
f = StringIO(self._transport.get_bytes(self._filename))
2276
for hook in OldConfigHooks['load']:
1516
2279
except errors.NoSuchFile:
1517
2280
return StringIO()
2281
except errors.PermissionDenied, e:
2282
trace.warning("Permission denied while trying to open "
2283
"configuration file %s.", urlutils.unescape_for_display(
2284
urlutils.join(self._transport.base, self._filename), "utf-8"))
2287
def _external_url(self):
2288
return urlutils.join(self._transport.external_url(), self._filename)
1519
2290
def _get_configobj(self):
1520
return ConfigObj(self._get_config_file(), encoding='utf-8')
2291
f = self._get_config_file()
2294
conf = ConfigObj(f, encoding='utf-8')
2295
except configobj.ConfigObjError, e:
2296
raise errors.ParseConfigError(e.errors, self._external_url())
2297
except UnicodeDecodeError:
2298
raise errors.ConfigContentError(self._external_url())
1522
2303
def _set_configobj(self, configobj):
1523
2304
out_file = StringIO()
1524
2305
configobj.write(out_file)
1525
2306
out_file.seek(0)
1526
2307
self._transport.put_file(self._filename, out_file)
2308
for hook in OldConfigHooks['save']:
2312
class Option(object):
2313
"""An option definition.
2315
The option *values* are stored in config files and found in sections.
2317
Here we define various properties about the option itself, its default
2318
value, how to convert it from stores, what to do when invalid values are
2319
encoutered, in which config files it can be stored.
2322
def __init__(self, name, default=None, default_from_env=None,
2324
from_unicode=None, invalid=None):
2325
"""Build an option definition.
2327
:param name: the name used to refer to the option.
2329
:param default: the default value to use when none exist in the config
2330
stores. This is either a string that ``from_unicode`` will convert
2331
into the proper type or a python object that can be stringified (so
2332
only the empty list is supported for example).
2334
:param default_from_env: A list of environment variables which can
2335
provide a default value. 'default' will be used only if none of the
2336
variables specified here are set in the environment.
2338
:param help: a doc string to explain the option to the user.
2340
:param from_unicode: a callable to convert the unicode string
2341
representing the option value in a store. This is not called for
2344
:param invalid: the action to be taken when an invalid value is
2345
encountered in a store. This is called only when from_unicode is
2346
invoked to convert a string and returns None or raise ValueError or
2347
TypeError. Accepted values are: None (ignore invalid values),
2348
'warning' (emit a warning), 'error' (emit an error message and
2351
if default_from_env is None:
2352
default_from_env = []
2354
# Convert the default value to a unicode string so all values are
2355
# strings internally before conversion (via from_unicode) is attempted.
2358
elif isinstance(default, list):
2359
# Only the empty list is supported
2361
raise AssertionError(
2362
'Only empty lists are supported as default values')
2364
elif isinstance(default, (str, unicode, bool, int)):
2365
# Rely on python to convert strings, booleans and integers
2366
self.default = u'%s' % (default,)
2368
# other python objects are not expected
2369
raise AssertionError('%r is not supported as a default value'
2371
self.default_from_env = default_from_env
2373
self.from_unicode = from_unicode
2374
if invalid and invalid not in ('warning', 'error'):
2375
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2376
self.invalid = invalid
2378
def convert_from_unicode(self, unicode_value):
2379
if self.from_unicode is None or unicode_value is None:
2380
# Don't convert or nothing to convert
2381
return unicode_value
2383
converted = self.from_unicode(unicode_value)
2384
except (ValueError, TypeError):
2385
# Invalid values are ignored
2387
if converted is None and self.invalid is not None:
2388
# The conversion failed
2389
if self.invalid == 'warning':
2390
trace.warning('Value "%s" is not valid for "%s"',
2391
unicode_value, self.name)
2392
elif self.invalid == 'error':
2393
raise errors.ConfigOptionValueError(self.name, unicode_value)
2396
def get_default(self):
2398
for var in self.default_from_env:
2400
# If the env variable is defined, its value is the default one
2401
value = os.environ[var]
2406
# Otherwise, fallback to the value defined at registration
2407
value = self.default
2410
def get_help_text(self, additional_see_also=None, plain=True):
2412
from bzrlib import help_topics
2413
result += help_topics._format_see_also(additional_see_also)
2415
result = help_topics.help_as_plain_text(result)
2419
# Predefined converters to get proper values from store
2421
def bool_from_store(unicode_str):
2422
return ui.bool_from_string(unicode_str)
2425
def int_from_store(unicode_str):
2426
return int(unicode_str)
2429
# Use a an empty dict to initialize an empty configobj avoiding all
2430
# parsing and encoding checks
2431
_list_converter_config = configobj.ConfigObj(
2432
{}, encoding='utf-8', list_values=True, interpolation=False)
2435
def list_from_store(unicode_str):
2436
if not isinstance(unicode_str, basestring):
2438
# Now inject our string directly as unicode. All callers got their value
2439
# from configobj, so values that need to be quoted are already properly
2441
_list_converter_config.reset()
2442
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2443
maybe_list = _list_converter_config['list']
2444
# ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
2445
if isinstance(maybe_list, basestring):
2447
# A single value, most probably the user forgot (or didn't care to
2448
# add) the final ','
2451
# The empty string, convert to empty list
2454
# We rely on ConfigObj providing us with a list already
2459
class OptionRegistry(registry.Registry):
2460
"""Register config options by their name.
2462
This overrides ``registry.Registry`` to simplify registration by acquiring
2463
some information from the option object itself.
2466
def register(self, option):
2467
"""Register a new option to its name.
2469
:param option: The option to register. Its name is used as the key.
2471
super(OptionRegistry, self).register(option.name, option,
2474
def register_lazy(self, key, module_name, member_name):
2475
"""Register a new option to be loaded on request.
2477
:param key: the key to request the option later. Since the registration
2478
is lazy, it should be provided and match the option name.
2480
:param module_name: the python path to the module. Such as 'os.path'.
2482
:param member_name: the member of the module to return. If empty or
2483
None, get() will return the module itself.
2485
super(OptionRegistry, self).register_lazy(key,
2486
module_name, member_name)
2488
def get_help(self, key=None):
2489
"""Get the help text associated with the given key"""
2490
option = self.get(key)
2491
the_help = option.help
2492
if callable(the_help):
2493
return the_help(self, key)
2497
option_registry = OptionRegistry()
2500
# Registered options in lexicographical order
2502
option_registry.register(
2503
Option('bzr.workingtree.worth_saving_limit', default=10,
2504
from_unicode=int_from_store, invalid='warning',
2506
How many changes before saving the dirstate.
2508
-1 means that we will never rewrite the dirstate file for only
2509
stat-cache changes. Regardless of this setting, we will always rewrite
2510
the dirstate file if a file is added/removed/renamed/etc. This flag only
2511
affects the behavior of updating the dirstate file after we notice that
2512
a file has been touched.
2514
option_registry.register(
2515
Option('dirstate.fdatasync', default=True,
2516
from_unicode=bool_from_store,
2518
Flush dirstate changes onto physical disk?
2520
If true (default), working tree metadata changes are flushed through the
2521
OS buffers to physical disk. This is somewhat slower, but means data
2522
should not be lost if the machine crashes. See also repository.fdatasync.
2524
option_registry.register(
2525
Option('debug_flags', default=[], from_unicode=list_from_store,
2526
help='Debug flags to activate.'))
2527
option_registry.register(
2528
Option('default_format', default='2a',
2529
help='Format used when creating branches.'))
2530
option_registry.register(
2532
help='The command called to launch an editor to enter a message.'))
2533
option_registry.register(
2534
Option('ignore_missing_extensions', default=False,
2535
from_unicode=bool_from_store,
2537
Control the missing extensions warning display.
2539
The warning will not be emitted if set to True.
2541
option_registry.register(
2543
help='Language to translate messages into.'))
2544
option_registry.register(
2545
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2547
Steal locks that appears to be dead.
2549
If set to True, bzr will check if a lock is supposed to be held by an
2550
active process from the same user on the same machine. If the user and
2551
machine match, but no process with the given PID is active, then bzr
2552
will automatically break the stale lock, and create a new lock for
2554
Otherwise, bzr will prompt as normal to break the lock.
2556
option_registry.register(
2557
Option('output_encoding',
2558
help= 'Unicode encoding for output'
2559
' (terminal encoding if not specified).'))
2560
option_registry.register(
2561
Option('repository.fdatasync', default=True,
2562
from_unicode=bool_from_store,
2564
Flush repository changes onto physical disk?
2566
If true (default), repository changes are flushed through the OS buffers
2567
to physical disk. This is somewhat slower, but means data should not be
2568
lost if the machine crashes. See also dirstate.fdatasync.
2572
class Section(object):
2573
"""A section defines a dict of option name => value.
2575
This is merely a read-only dict which can add some knowledge about the
2576
options. It is *not* a python dict object though and doesn't try to mimic
2580
def __init__(self, section_id, options):
2581
self.id = section_id
2582
# We re-use the dict-like object received
2583
self.options = options
2585
def get(self, name, default=None):
2586
return self.options.get(name, default)
2589
# Mostly for debugging use
2590
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2593
_NewlyCreatedOption = object()
2594
"""Was the option created during the MutableSection lifetime"""
2597
class MutableSection(Section):
2598
"""A section allowing changes and keeping track of the original values."""
2600
def __init__(self, section_id, options):
2601
super(MutableSection, self).__init__(section_id, options)
2604
def set(self, name, value):
2605
if name not in self.options:
2606
# This is a new option
2607
self.orig[name] = _NewlyCreatedOption
2608
elif name not in self.orig:
2609
self.orig[name] = self.get(name, None)
2610
self.options[name] = value
2612
def remove(self, name):
2613
if name not in self.orig:
2614
self.orig[name] = self.get(name, None)
2615
del self.options[name]
2618
class Store(object):
2619
"""Abstract interface to persistent storage for configuration options."""
2621
readonly_section_class = Section
2622
mutable_section_class = MutableSection
2624
def is_loaded(self):
2625
"""Returns True if the Store has been loaded.
2627
This is used to implement lazy loading and ensure the persistent
2628
storage is queried only when needed.
2630
raise NotImplementedError(self.is_loaded)
2633
"""Loads the Store from persistent storage."""
2634
raise NotImplementedError(self.load)
2636
def _load_from_string(self, bytes):
2637
"""Create a store from a string in configobj syntax.
2639
:param bytes: A string representing the file content.
2641
raise NotImplementedError(self._load_from_string)
2644
"""Unloads the Store.
2646
This should make is_loaded() return False. This is used when the caller
2647
knows that the persistent storage has changed or may have change since
2650
raise NotImplementedError(self.unload)
2653
"""Saves the Store to persistent storage."""
2654
raise NotImplementedError(self.save)
2656
def external_url(self):
2657
raise NotImplementedError(self.external_url)
2659
def get_sections(self):
2660
"""Returns an ordered iterable of existing sections.
2662
:returns: An iterable of (name, dict).
2664
raise NotImplementedError(self.get_sections)
2666
def get_mutable_section(self, section_name=None):
2667
"""Returns the specified mutable section.
2669
:param section_name: The section identifier
2671
raise NotImplementedError(self.get_mutable_section)
2674
# Mostly for debugging use
2675
return "<config.%s(%s)>" % (self.__class__.__name__,
2676
self.external_url())
2679
class IniFileStore(Store):
2680
"""A config Store using ConfigObj for storage.
2682
:ivar transport: The transport object where the config file is located.
2684
:ivar file_name: The config file basename in the transport directory.
2686
:ivar _config_obj: Private member to hold the ConfigObj instance used to
2687
serialize/deserialize the config file.
2690
def __init__(self, transport, file_name):
2691
"""A config Store using ConfigObj for storage.
2693
:param transport: The transport object where the config file is located.
2695
:param file_name: The config file basename in the transport directory.
2697
super(IniFileStore, self).__init__()
2698
self.transport = transport
2699
self.file_name = file_name
2700
self._config_obj = None
2702
def is_loaded(self):
2703
return self._config_obj != None
2706
self._config_obj = None
2709
"""Load the store from the associated file."""
2710
if self.is_loaded():
2713
content = self.transport.get_bytes(self.file_name)
2714
except errors.PermissionDenied:
2715
trace.warning("Permission denied while trying to load "
2716
"configuration store %s.", self.external_url())
2718
self._load_from_string(content)
2719
for hook in ConfigHooks['load']:
2722
def _load_from_string(self, bytes):
2723
"""Create a config store from a string.
2725
:param bytes: A string representing the file content.
2727
if self.is_loaded():
2728
raise AssertionError('Already loaded: %r' % (self._config_obj,))
2729
co_input = StringIO(bytes)
2731
# The config files are always stored utf8-encoded
2732
self._config_obj = ConfigObj(co_input, encoding='utf-8',
2734
except configobj.ConfigObjError, e:
2735
self._config_obj = None
2736
raise errors.ParseConfigError(e.errors, self.external_url())
2737
except UnicodeDecodeError:
2738
raise errors.ConfigContentError(self.external_url())
2741
if not self.is_loaded():
2745
self._config_obj.write(out)
2746
self.transport.put_bytes(self.file_name, out.getvalue())
2747
for hook in ConfigHooks['save']:
2750
def external_url(self):
2751
# FIXME: external_url should really accepts an optional relpath
2752
# parameter (bug #750169) :-/ -- vila 2011-04-04
2753
# The following will do in the interim but maybe we don't want to
2754
# expose a path here but rather a config ID and its associated
2755
# object </hand wawe>.
2756
return urlutils.join(self.transport.external_url(), self.file_name)
2758
def get_sections(self):
2759
"""Get the configobj section in the file order.
2761
:returns: An iterable of (name, dict).
2763
# We need a loaded store
2766
except (errors.NoSuchFile, errors.PermissionDenied):
2767
# If the file can't be read, there is no sections
2769
cobj = self._config_obj
2771
yield self.readonly_section_class(None, cobj)
2772
for section_name in cobj.sections:
2773
yield self.readonly_section_class(section_name, cobj[section_name])
2775
def get_mutable_section(self, section_name=None):
2776
# We need a loaded store
2779
except errors.NoSuchFile:
2780
# The file doesn't exist, let's pretend it was empty
2781
self._load_from_string('')
2782
if section_name is None:
2783
section = self._config_obj
2785
section = self._config_obj.setdefault(section_name, {})
2786
return self.mutable_section_class(section_name, section)
2789
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2790
# unlockable stores for use with objects that can already ensure the locking
2791
# (think branches). If different stores (not based on ConfigObj) are created,
2792
# they may face the same issue.
2795
class LockableIniFileStore(IniFileStore):
2796
"""A ConfigObjStore using locks on save to ensure store integrity."""
2798
def __init__(self, transport, file_name, lock_dir_name=None):
2799
"""A config Store using ConfigObj for storage.
2801
:param transport: The transport object where the config file is located.
2803
:param file_name: The config file basename in the transport directory.
2805
if lock_dir_name is None:
2806
lock_dir_name = 'lock'
2807
self.lock_dir_name = lock_dir_name
2808
super(LockableIniFileStore, self).__init__(transport, file_name)
2809
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
2811
def lock_write(self, token=None):
2812
"""Takes a write lock in the directory containing the config file.
2814
If the directory doesn't exist it is created.
2816
# FIXME: This doesn't check the ownership of the created directories as
2817
# ensure_config_dir_exists does. It should if the transport is local
2818
# -- vila 2011-04-06
2819
self.transport.create_prefix()
2820
return self._lock.lock_write(token)
2825
def break_lock(self):
2826
self._lock.break_lock()
2830
# We need to be able to override the undecorated implementation
2831
self.save_without_locking()
2833
def save_without_locking(self):
2834
super(LockableIniFileStore, self).save()
2837
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
2838
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
2839
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
2841
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
2842
# functions or a registry will make it easier and clearer for tests, focusing
2843
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2844
# on a poolie's remark)
2845
class GlobalStore(LockableIniFileStore):
2847
def __init__(self, possible_transports=None):
2848
t = transport.get_transport_from_path(
2849
config_dir(), possible_transports=possible_transports)
2850
super(GlobalStore, self).__init__(t, 'bazaar.conf')
2853
class LocationStore(LockableIniFileStore):
2855
def __init__(self, possible_transports=None):
2856
t = transport.get_transport_from_path(
2857
config_dir(), possible_transports=possible_transports)
2858
super(LocationStore, self).__init__(t, 'locations.conf')
2861
class BranchStore(IniFileStore):
2863
def __init__(self, branch):
2864
super(BranchStore, self).__init__(branch.control_transport,
2866
self.branch = branch
2868
def lock_write(self, token=None):
2869
return self.branch.lock_write(token)
2872
return self.branch.unlock()
2876
# We need to be able to override the undecorated implementation
2877
self.save_without_locking()
2879
def save_without_locking(self):
2880
super(BranchStore, self).save()
2883
class ControlStore(LockableIniFileStore):
2885
def __init__(self, bzrdir):
2886
super(ControlStore, self).__init__(bzrdir.transport,
2888
lock_dir_name='branch_lock')
2891
class SectionMatcher(object):
2892
"""Select sections into a given Store.
2894
This intended to be used to postpone getting an iterable of sections from a
2898
def __init__(self, store):
2901
def get_sections(self):
2902
# This is where we require loading the store so we can see all defined
2904
sections = self.store.get_sections()
2905
# Walk the revisions in the order provided
2910
def match(self, secion):
2911
raise NotImplementedError(self.match)
2914
class LocationSection(Section):
2916
def __init__(self, section, length, extra_path):
2917
super(LocationSection, self).__init__(section.id, section.options)
2918
self.length = length
2919
self.extra_path = extra_path
2921
def get(self, name, default=None):
2922
value = super(LocationSection, self).get(name, default)
2923
if value is not None:
2924
policy_name = self.get(name + ':policy', None)
2925
policy = _policy_value.get(policy_name, POLICY_NONE)
2926
if policy == POLICY_APPENDPATH:
2927
value = urlutils.join(value, self.extra_path)
2931
class LocationMatcher(SectionMatcher):
2933
def __init__(self, store, location):
2934
super(LocationMatcher, self).__init__(store)
2935
if location.startswith('file://'):
2936
location = urlutils.local_path_from_url(location)
2937
self.location = location
2939
def _get_matching_sections(self):
2940
"""Get all sections matching ``location``."""
2941
# We slightly diverge from LocalConfig here by allowing the no-name
2942
# section as the most generic one and the lower priority.
2943
no_name_section = None
2945
# Filter out the no_name_section so _iter_for_location_by_parts can be
2946
# used (it assumes all sections have a name).
2947
for section in self.store.get_sections():
2948
if section.id is None:
2949
no_name_section = section
2951
all_sections.append(section)
2952
# Unfortunately _iter_for_location_by_parts deals with section names so
2953
# we have to resync.
2954
filtered_sections = _iter_for_location_by_parts(
2955
[s.id for s in all_sections], self.location)
2956
iter_all_sections = iter(all_sections)
2957
matching_sections = []
2958
if no_name_section is not None:
2959
matching_sections.append(
2960
LocationSection(no_name_section, 0, self.location))
2961
for section_id, extra_path, length in filtered_sections:
2962
# a section id is unique for a given store so it's safe to take the
2963
# first matching section while iterating. Also, all filtered
2964
# sections are part of 'all_sections' and will always be found
2967
section = iter_all_sections.next()
2968
if section_id == section.id:
2969
matching_sections.append(
2970
LocationSection(section, length, extra_path))
2972
return matching_sections
2974
def get_sections(self):
2975
# Override the default implementation as we want to change the order
2976
matching_sections = self._get_matching_sections()
2977
# We want the longest (aka more specific) locations first
2978
sections = sorted(matching_sections,
2979
key=lambda section: (section.length, section.id),
2981
# Sections mentioning 'ignore_parents' restrict the selection
2982
for section in sections:
2983
# FIXME: We really want to use as_bool below -- vila 2011-04-07
2984
ignore = section.get('ignore_parents', None)
2985
if ignore is not None:
2986
ignore = ui.bool_from_string(ignore)
2989
# Finally, we have a valid section
2993
class Stack(object):
2994
"""A stack of configurations where an option can be defined"""
2996
_option_ref_re = lazy_regex.lazy_compile('({[^{}]+})')
2997
"""Describes an exandable option reference.
2999
We want to match the most embedded reference first.
3001
I.e. for '{{foo}}' we will get '{foo}',
3002
for '{bar{baz}}' we will get '{baz}'
3005
def __init__(self, sections_def, store=None, mutable_section_name=None):
3006
"""Creates a stack of sections with an optional store for changes.
3008
:param sections_def: A list of Section or callables that returns an
3009
iterable of Section. This defines the Sections for the Stack and
3010
can be called repeatedly if needed.
3012
:param store: The optional Store where modifications will be
3013
recorded. If none is specified, no modifications can be done.
3015
:param mutable_section_name: The name of the MutableSection where
3016
changes are recorded. This requires the ``store`` parameter to be
3019
self.sections_def = sections_def
3021
self.mutable_section_name = mutable_section_name
3023
def get(self, name, expand=None):
3024
"""Return the *first* option value found in the sections.
3026
This is where we guarantee that sections coming from Store are loaded
3027
lazily: the loading is delayed until we need to either check that an
3028
option exists or get its value, which in turn may require to discover
3029
in which sections it can be defined. Both of these (section and option
3030
existence) require loading the store (even partially).
3032
:param name: The queried option.
3034
:param expand: Whether options references should be expanded.
3036
:returns: The value of the option.
3038
# FIXME: No caching of options nor sections yet -- vila 20110503
3040
expand = _get_expand_default_value()
3042
# Ensuring lazy loading is achieved by delaying section matching (which
3043
# implies querying the persistent storage) until it can't be avoided
3044
# anymore by using callables to describe (possibly empty) section
3046
for section_or_callable in self.sections_def:
3047
# Each section can expand to multiple ones when a callable is used
3048
if callable(section_or_callable):
3049
sections = section_or_callable()
3051
sections = [section_or_callable]
3052
for section in sections:
3053
value = section.get(name)
3054
if value is not None:
3056
if value is not None:
3058
# If the option is registered, it may provide additional info about
3061
opt = option_registry.get(name)
3065
def expand_and_convert(val):
3066
# This may need to be called twice if the value is None or ends up
3067
# being None during expansion or conversion.
3070
if isinstance(val, basestring):
3071
val = self._expand_options_in_string(val)
3073
trace.warning('Cannot expand "%s":'
3074
' %s does not support option expansion'
3075
% (name, type(val)))
3077
val = opt.convert_from_unicode(val)
3079
value = expand_and_convert(value)
3080
if opt is not None and value is None:
3081
# If the option is registered, it may provide a default value
3082
value = opt.get_default()
3083
value = expand_and_convert(value)
3084
for hook in ConfigHooks['get']:
3085
hook(self, name, value)
3088
def expand_options(self, string, env=None):
3089
"""Expand option references in the string in the configuration context.
3091
:param string: The string containing option(s) to expand.
3093
:param env: An option dict defining additional configuration options or
3094
overriding existing ones.
3096
:returns: The expanded string.
3098
return self._expand_options_in_string(string, env)
3100
def _expand_options_in_string(self, string, env=None, _refs=None):
3101
"""Expand options in the string in the configuration context.
3103
:param string: The string to be expanded.
3105
:param env: An option dict defining additional configuration options or
3106
overriding existing ones.
3108
:param _refs: Private list (FIFO) containing the options being expanded
3111
:returns: The expanded string.
3114
# Not much to expand there
3117
# What references are currently resolved (to detect loops)
3120
# We need to iterate until no more refs appear ({{foo}} will need two
3121
# iterations for example).
3123
raw_chunks = Stack._option_ref_re.split(result)
3124
if len(raw_chunks) == 1:
3125
# Shorcut the trivial case: no refs
3128
# Split will isolate refs so that every other chunk is a ref
3129
chunk_is_ref = False
3130
for chunk in raw_chunks:
3131
if not chunk_is_ref:
3132
chunks.append(chunk)
3137
raise errors.OptionExpansionLoop(string, _refs)
3139
value = self._expand_option(name, env, _refs)
3141
raise errors.ExpandingUnknownOption(name, string)
3142
chunks.append(value)
3144
chunk_is_ref = False
3145
result = ''.join(chunks)
3148
def _expand_option(self, name, env, _refs):
3149
if env is not None and name in env:
3150
# Special case, values provided in env takes precedence over
3154
# FIXME: This is a limited implementation, what we really need is a
3155
# way to query the bzr config for the value of an option,
3156
# respecting the scope rules (That is, once we implement fallback
3157
# configs, getting the option value should restart from the top
3158
# config, not the current one) -- vila 20101222
3159
value = self.get(name, expand=False)
3160
value = self._expand_options_in_string(value, env, _refs)
3163
def _get_mutable_section(self):
3164
"""Get the MutableSection for the Stack.
3166
This is where we guarantee that the mutable section is lazily loaded:
3167
this means we won't load the corresponding store before setting a value
3168
or deleting an option. In practice the store will often be loaded but
3169
this allows helps catching some programming errors.
3171
section = self.store.get_mutable_section(self.mutable_section_name)
3174
def set(self, name, value):
3175
"""Set a new value for the option."""
3176
section = self._get_mutable_section()
3177
section.set(name, value)
3178
for hook in ConfigHooks['set']:
3179
hook(self, name, value)
3181
def remove(self, name):
3182
"""Remove an existing option."""
3183
section = self._get_mutable_section()
3184
section.remove(name)
3185
for hook in ConfigHooks['remove']:
3189
# Mostly for debugging use
3190
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3193
class _CompatibleStack(Stack):
3194
"""Place holder for compatibility with previous design.
3196
This is intended to ease the transition from the Config-based design to the
3197
Stack-based design and should not be used nor relied upon by plugins.
3199
One assumption made here is that the daughter classes will all use Stores
3200
derived from LockableIniFileStore).
3202
It implements set() by re-loading the store before applying the
3203
modification and saving it.
3205
The long term plan being to implement a single write by store to save
3206
all modifications, this class should not be used in the interim.
3209
def set(self, name, value):
3212
super(_CompatibleStack, self).set(name, value)
3213
# Force a write to persistent storage
3217
class GlobalStack(_CompatibleStack):
3218
"""Global options only stack."""
3222
gstore = GlobalStore()
3223
super(GlobalStack, self).__init__([gstore.get_sections], gstore)
3226
class LocationStack(_CompatibleStack):
3227
"""Per-location options falling back to global options stack."""
3229
def __init__(self, location):
3230
"""Make a new stack for a location and global configuration.
3232
:param location: A URL prefix to """
3233
lstore = LocationStore()
3234
matcher = LocationMatcher(lstore, location)
3235
gstore = GlobalStore()
3236
super(LocationStack, self).__init__(
3237
[matcher.get_sections, gstore.get_sections], lstore)
3240
class BranchStack(_CompatibleStack):
3241
"""Per-location options falling back to branch then global options stack."""
3243
def __init__(self, branch):
3244
bstore = BranchStore(branch)
3245
lstore = LocationStore()
3246
matcher = LocationMatcher(lstore, branch.base)
3247
gstore = GlobalStore()
3248
super(BranchStack, self).__init__(
3249
[matcher.get_sections, bstore.get_sections, gstore.get_sections],
3251
self.branch = branch
3254
class RemoteControlStack(_CompatibleStack):
3255
"""Remote control-only options stack."""
3257
def __init__(self, bzrdir):
3258
cstore = ControlStore(bzrdir)
3259
super(RemoteControlStack, self).__init__(
3260
[cstore.get_sections],
3262
self.bzrdir = bzrdir
3265
class RemoteBranchStack(_CompatibleStack):
3266
"""Remote branch-only options stack."""
3268
def __init__(self, branch):
3269
bstore = BranchStore(branch)
3270
super(RemoteBranchStack, self).__init__(
3271
[bstore.get_sections],
3273
self.branch = branch
3276
class cmd_config(commands.Command):
3277
__doc__ = """Display, set or remove a configuration option.
3279
Display the active value for a given option.
3281
If --all is specified, NAME is interpreted as a regular expression and all
3282
matching options are displayed mentioning their scope. The active value
3283
that bzr will take into account is the first one displayed for each option.
3285
If no NAME is given, --all .* is implied.
3287
Setting a value is achieved by using name=value without spaces. The value
3288
is set in the most relevant scope and can be checked by displaying the
3292
takes_args = ['name?']
3296
# FIXME: This should be a registry option so that plugins can register
3297
# their own config files (or not) -- vila 20101002
3298
commands.Option('scope', help='Reduce the scope to the specified'
3299
' configuration file',
3301
commands.Option('all',
3302
help='Display all the defined values for the matching options.',
3304
commands.Option('remove', help='Remove the option from'
3305
' the configuration file'),
3308
_see_also = ['configuration']
3310
@commands.display_command
3311
def run(self, name=None, all=False, directory=None, scope=None,
3313
if directory is None:
3315
directory = urlutils.normalize_url(directory)
3317
raise errors.BzrError(
3318
'--all and --remove are mutually exclusive.')
3320
# Delete the option in the given scope
3321
self._remove_config_option(name, directory, scope)
3323
# Defaults to all options
3324
self._show_matching_options('.*', directory, scope)
3327
name, value = name.split('=', 1)
3329
# Display the option(s) value(s)
3331
self._show_matching_options(name, directory, scope)
3333
self._show_value(name, directory, scope)
3336
raise errors.BzrError(
3337
'Only one option can be set.')
3338
# Set the option value
3339
self._set_config_option(name, value, directory, scope)
3341
def _get_configs(self, directory, scope=None):
3342
"""Iterate the configurations specified by ``directory`` and ``scope``.
3344
:param directory: Where the configurations are derived from.
3346
:param scope: A specific config to start from.
3348
if scope is not None:
3349
if scope == 'bazaar':
3350
yield GlobalConfig()
3351
elif scope == 'locations':
3352
yield LocationConfig(directory)
3353
elif scope == 'branch':
3354
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
3356
yield br.get_config()
3359
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
3361
yield br.get_config()
3362
except errors.NotBranchError:
3363
yield LocationConfig(directory)
3364
yield GlobalConfig()
3366
def _show_value(self, name, directory, scope):
3368
for c in self._get_configs(directory, scope):
3371
for (oname, value, section, conf_id, parser) in c._get_options():
3373
# Display only the first value and exit
3375
# FIXME: We need to use get_user_option to take policies
3376
# into account and we need to make sure the option exists
3377
# too (hence the two for loops), this needs a better API
3379
value = c.get_user_option(name)
3380
# Quote the value appropriately
3381
value = parser._quote(value)
3382
self.outf.write('%s\n' % (value,))
3386
raise errors.NoSuchConfigOption(name)
3388
def _show_matching_options(self, name, directory, scope):
3389
name = lazy_regex.lazy_compile(name)
3390
# We want any error in the regexp to be raised *now* so we need to
3391
# avoid the delay introduced by the lazy regexp. But, we still do
3392
# want the nicer errors raised by lazy_regex.
3393
name._compile_and_collapse()
3396
for c in self._get_configs(directory, scope):
3397
for (oname, value, section, conf_id, parser) in c._get_options():
3398
if name.search(oname):
3399
if cur_conf_id != conf_id:
3400
# Explain where the options are defined
3401
self.outf.write('%s:\n' % (conf_id,))
3402
cur_conf_id = conf_id
3404
if (section not in (None, 'DEFAULT')
3405
and cur_section != section):
3406
# Display the section if it's not the default (or only)
3408
self.outf.write(' [%s]\n' % (section,))
3409
cur_section = section
3410
self.outf.write(' %s = %s\n' % (oname, value))
3412
def _set_config_option(self, name, value, directory, scope):
3413
for conf in self._get_configs(directory, scope):
3414
conf.set_user_option(name, value)
3417
raise errors.NoSuchConfig(scope)
3419
def _remove_config_option(self, name, directory, scope):
3421
raise errors.BzrCommandError(
3422
'--remove expects an option to remove.')
3424
for conf in self._get_configs(directory, scope):
3425
for (section_name, section, conf_id) in conf._get_sections():
3426
if scope is not None and conf_id != scope:
3427
# Not the right configuration file
3430
if conf_id != conf.config_id():
3431
conf = self._get_configs(directory, conf_id).next()
3432
# We use the first section in the first config where the
3433
# option is defined to remove it
3434
conf.remove_user_option(name, section_name)
3439
raise errors.NoSuchConfig(scope)
3441
raise errors.NoSuchConfigOption(name)
3445
# We need adapters that can build a Store or a Stack in a test context. Test
3446
# classes, based on TestCaseWithTransport, can use the registry to parametrize
3447
# themselves. The builder will receive a test instance and should return a
3448
# ready-to-use store or stack. Plugins that define new store/stacks can also
3449
# register themselves here to be tested against the tests defined in
3450
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3451
# for the same tests.
3453
# The registered object should be a callable receiving a test instance
3454
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
3456
test_store_builder_registry = registry.Registry()
3458
# The registered object should be a callable receiving a test instance
3459
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
3461
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
