2256
1578
configobj[name] = value
2258
1580
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)
2271
1581
self._set_configobj(configobj)
2273
1583
def _get_config_file(self):
2275
f = StringIO(self._transport.get_bytes(self._filename))
2276
for hook in OldConfigHooks['load']:
1585
return StringIO(self._transport.get_bytes(self._filename))
2279
1586
except errors.NoSuchFile:
2280
1587
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)
2290
1589
def _get_configobj(self):
2291
1590
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())
1592
return ConfigObj(f, encoding='utf-8')
2303
1596
def _set_configobj(self, configobj):
2304
1597
out_file = StringIO()
2305
1598
configobj.write(out_file)
2306
1599
out_file.seek(0)
2307
1600
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, float)):
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
def float_from_store(unicode_str):
2430
return float(unicode_str)
2434
# Use a an empty dict to initialize an empty configobj avoiding all
2435
# parsing and encoding checks
2436
_list_converter_config = configobj.ConfigObj(
2437
{}, encoding='utf-8', list_values=True, interpolation=False)
2440
def list_from_store(unicode_str):
2441
if not isinstance(unicode_str, basestring):
2443
# Now inject our string directly as unicode. All callers got their value
2444
# from configobj, so values that need to be quoted are already properly
2446
_list_converter_config.reset()
2447
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2448
maybe_list = _list_converter_config['list']
2449
# ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
2450
if isinstance(maybe_list, basestring):
2452
# A single value, most probably the user forgot (or didn't care to
2453
# add) the final ','
2456
# The empty string, convert to empty list
2459
# We rely on ConfigObj providing us with a list already
2464
class OptionRegistry(registry.Registry):
2465
"""Register config options by their name.
2467
This overrides ``registry.Registry`` to simplify registration by acquiring
2468
some information from the option object itself.
2471
def register(self, option):
2472
"""Register a new option to its name.
2474
:param option: The option to register. Its name is used as the key.
2476
super(OptionRegistry, self).register(option.name, option,
2479
def register_lazy(self, key, module_name, member_name):
2480
"""Register a new option to be loaded on request.
2482
:param key: the key to request the option later. Since the registration
2483
is lazy, it should be provided and match the option name.
2485
:param module_name: the python path to the module. Such as 'os.path'.
2487
:param member_name: the member of the module to return. If empty or
2488
None, get() will return the module itself.
2490
super(OptionRegistry, self).register_lazy(key,
2491
module_name, member_name)
2493
def get_help(self, key=None):
2494
"""Get the help text associated with the given key"""
2495
option = self.get(key)
2496
the_help = option.help
2497
if callable(the_help):
2498
return the_help(self, key)
2502
option_registry = OptionRegistry()
2505
# Registered options in lexicographical order
2507
option_registry.register(
2508
Option('bzr.workingtree.worth_saving_limit', default=10,
2509
from_unicode=int_from_store, invalid='warning',
2511
How many changes before saving the dirstate.
2513
-1 means that we will never rewrite the dirstate file for only
2514
stat-cache changes. Regardless of this setting, we will always rewrite
2515
the dirstate file if a file is added/removed/renamed/etc. This flag only
2516
affects the behavior of updating the dirstate file after we notice that
2517
a file has been touched.
2519
option_registry.register(
2520
Option('dirstate.fdatasync', default=True,
2521
from_unicode=bool_from_store,
2523
Flush dirstate changes onto physical disk?
2525
If true (default), working tree metadata changes are flushed through the
2526
OS buffers to physical disk. This is somewhat slower, but means data
2527
should not be lost if the machine crashes. See also repository.fdatasync.
2529
option_registry.register(
2530
Option('debug_flags', default=[], from_unicode=list_from_store,
2531
help='Debug flags to activate.'))
2532
option_registry.register(
2533
Option('default_format', default='2a',
2534
help='Format used when creating branches.'))
2535
option_registry.register(
2536
Option('dpush_strict', default=None,
2537
from_unicode=bool_from_store,
2539
The default value for ``dpush --strict``.
2541
If present, defines the ``--strict`` option default value for checking
2542
uncommitted changes before pushing into a different VCS without any
2543
custom bzr metadata.
2545
option_registry.register(
2547
help='The command called to launch an editor to enter a message.'))
2548
option_registry.register(
2549
Option('ignore_missing_extensions', default=False,
2550
from_unicode=bool_from_store,
2552
Control the missing extensions warning display.
2554
The warning will not be emitted if set to True.
2556
option_registry.register(
2558
help='Language to translate messages into.'))
2559
option_registry.register(
2560
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2562
Steal locks that appears to be dead.
2564
If set to True, bzr will check if a lock is supposed to be held by an
2565
active process from the same user on the same machine. If the user and
2566
machine match, but no process with the given PID is active, then bzr
2567
will automatically break the stale lock, and create a new lock for
2569
Otherwise, bzr will prompt as normal to break the lock.
2571
option_registry.register(
2572
Option('output_encoding',
2573
help= 'Unicode encoding for output'
2574
' (terminal encoding if not specified).'))
2575
option_registry.register(
2576
Option('push_strict', default=None,
2577
from_unicode=bool_from_store,
2579
The default value for ``push --strict``.
2581
If present, defines the ``--strict`` option default value for checking
2582
uncommitted changes before sending a merge directive.
2584
option_registry.register(
2585
Option('repository.fdatasync', default=True,
2586
from_unicode=bool_from_store,
2588
Flush repository changes onto physical disk?
2590
If true (default), repository changes are flushed through the OS buffers
2591
to physical disk. This is somewhat slower, but means data should not be
2592
lost if the machine crashes. See also dirstate.fdatasync.
2594
option_registry.register(
2595
Option('send_strict', default=None,
2596
from_unicode=bool_from_store,
2598
The default value for ``send --strict``.
2600
If present, defines the ``--strict`` option default value for checking
2601
uncommitted changes before pushing.
2604
option_registry.register(
2605
Option('serve.client_timeout',
2606
default=300.0, from_unicode=float_from_store,
2607
help="If we wait for a new request from a client for more than"
2608
" X seconds, consider the client idle, and hangup."))
2611
class Section(object):
2612
"""A section defines a dict of option name => value.
2614
This is merely a read-only dict which can add some knowledge about the
2615
options. It is *not* a python dict object though and doesn't try to mimic
2619
def __init__(self, section_id, options):
2620
self.id = section_id
2621
# We re-use the dict-like object received
2622
self.options = options
2624
def get(self, name, default=None):
2625
return self.options.get(name, default)
2628
# Mostly for debugging use
2629
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2632
_NewlyCreatedOption = object()
2633
"""Was the option created during the MutableSection lifetime"""
2636
class MutableSection(Section):
2637
"""A section allowing changes and keeping track of the original values."""
2639
def __init__(self, section_id, options):
2640
super(MutableSection, self).__init__(section_id, options)
2643
def set(self, name, value):
2644
if name not in self.options:
2645
# This is a new option
2646
self.orig[name] = _NewlyCreatedOption
2647
elif name not in self.orig:
2648
self.orig[name] = self.get(name, None)
2649
self.options[name] = value
2651
def remove(self, name):
2652
if name not in self.orig:
2653
self.orig[name] = self.get(name, None)
2654
del self.options[name]
2657
class Store(object):
2658
"""Abstract interface to persistent storage for configuration options."""
2660
readonly_section_class = Section
2661
mutable_section_class = MutableSection
2663
def is_loaded(self):
2664
"""Returns True if the Store has been loaded.
2666
This is used to implement lazy loading and ensure the persistent
2667
storage is queried only when needed.
2669
raise NotImplementedError(self.is_loaded)
2672
"""Loads the Store from persistent storage."""
2673
raise NotImplementedError(self.load)
2675
def _load_from_string(self, bytes):
2676
"""Create a store from a string in configobj syntax.
2678
:param bytes: A string representing the file content.
2680
raise NotImplementedError(self._load_from_string)
2683
"""Unloads the Store.
2685
This should make is_loaded() return False. This is used when the caller
2686
knows that the persistent storage has changed or may have change since
2689
raise NotImplementedError(self.unload)
2692
"""Saves the Store to persistent storage."""
2693
raise NotImplementedError(self.save)
2695
def external_url(self):
2696
raise NotImplementedError(self.external_url)
2698
def get_sections(self):
2699
"""Returns an ordered iterable of existing sections.
2701
:returns: An iterable of (name, dict).
2703
raise NotImplementedError(self.get_sections)
2705
def get_mutable_section(self, section_name=None):
2706
"""Returns the specified mutable section.
2708
:param section_name: The section identifier
2710
raise NotImplementedError(self.get_mutable_section)
2713
# Mostly for debugging use
2714
return "<config.%s(%s)>" % (self.__class__.__name__,
2715
self.external_url())
2718
class IniFileStore(Store):
2719
"""A config Store using ConfigObj for storage.
2721
:ivar transport: The transport object where the config file is located.
2723
:ivar file_name: The config file basename in the transport directory.
2725
:ivar _config_obj: Private member to hold the ConfigObj instance used to
2726
serialize/deserialize the config file.
2729
def __init__(self, transport, file_name):
2730
"""A config Store using ConfigObj for storage.
2732
:param transport: The transport object where the config file is located.
2734
:param file_name: The config file basename in the transport directory.
2736
super(IniFileStore, self).__init__()
2737
self.transport = transport
2738
self.file_name = file_name
2739
self._config_obj = None
2741
def is_loaded(self):
2742
return self._config_obj != None
2745
self._config_obj = None
2748
"""Load the store from the associated file."""
2749
if self.is_loaded():
2752
content = self.transport.get_bytes(self.file_name)
2753
except errors.PermissionDenied:
2754
trace.warning("Permission denied while trying to load "
2755
"configuration store %s.", self.external_url())
2757
self._load_from_string(content)
2758
for hook in ConfigHooks['load']:
2761
def _load_from_string(self, bytes):
2762
"""Create a config store from a string.
2764
:param bytes: A string representing the file content.
2766
if self.is_loaded():
2767
raise AssertionError('Already loaded: %r' % (self._config_obj,))
2768
co_input = StringIO(bytes)
2770
# The config files are always stored utf8-encoded
2771
self._config_obj = ConfigObj(co_input, encoding='utf-8',
2773
except configobj.ConfigObjError, e:
2774
self._config_obj = None
2775
raise errors.ParseConfigError(e.errors, self.external_url())
2776
except UnicodeDecodeError:
2777
raise errors.ConfigContentError(self.external_url())
2780
if not self.is_loaded():
2784
self._config_obj.write(out)
2785
self.transport.put_bytes(self.file_name, out.getvalue())
2786
for hook in ConfigHooks['save']:
2789
def external_url(self):
2790
# FIXME: external_url should really accepts an optional relpath
2791
# parameter (bug #750169) :-/ -- vila 2011-04-04
2792
# The following will do in the interim but maybe we don't want to
2793
# expose a path here but rather a config ID and its associated
2794
# object </hand wawe>.
2795
return urlutils.join(self.transport.external_url(), self.file_name)
2797
def get_sections(self):
2798
"""Get the configobj section in the file order.
2800
:returns: An iterable of (name, dict).
2802
# We need a loaded store
2805
except (errors.NoSuchFile, errors.PermissionDenied):
2806
# If the file can't be read, there is no sections
2808
cobj = self._config_obj
2810
yield self.readonly_section_class(None, cobj)
2811
for section_name in cobj.sections:
2812
yield self.readonly_section_class(section_name, cobj[section_name])
2814
def get_mutable_section(self, section_name=None):
2815
# We need a loaded store
2818
except errors.NoSuchFile:
2819
# The file doesn't exist, let's pretend it was empty
2820
self._load_from_string('')
2821
if section_name is None:
2822
section = self._config_obj
2824
section = self._config_obj.setdefault(section_name, {})
2825
return self.mutable_section_class(section_name, section)
2828
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2829
# unlockable stores for use with objects that can already ensure the locking
2830
# (think branches). If different stores (not based on ConfigObj) are created,
2831
# they may face the same issue.
2834
class LockableIniFileStore(IniFileStore):
2835
"""A ConfigObjStore using locks on save to ensure store integrity."""
2837
def __init__(self, transport, file_name, lock_dir_name=None):
2838
"""A config Store using ConfigObj for storage.
2840
:param transport: The transport object where the config file is located.
2842
:param file_name: The config file basename in the transport directory.
2844
if lock_dir_name is None:
2845
lock_dir_name = 'lock'
2846
self.lock_dir_name = lock_dir_name
2847
super(LockableIniFileStore, self).__init__(transport, file_name)
2848
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
2850
def lock_write(self, token=None):
2851
"""Takes a write lock in the directory containing the config file.
2853
If the directory doesn't exist it is created.
2855
# FIXME: This doesn't check the ownership of the created directories as
2856
# ensure_config_dir_exists does. It should if the transport is local
2857
# -- vila 2011-04-06
2858
self.transport.create_prefix()
2859
return self._lock.lock_write(token)
2864
def break_lock(self):
2865
self._lock.break_lock()
2869
# We need to be able to override the undecorated implementation
2870
self.save_without_locking()
2872
def save_without_locking(self):
2873
super(LockableIniFileStore, self).save()
2876
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
2877
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
2878
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
2880
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
2881
# functions or a registry will make it easier and clearer for tests, focusing
2882
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2883
# on a poolie's remark)
2884
class GlobalStore(LockableIniFileStore):
2886
def __init__(self, possible_transports=None):
2887
t = transport.get_transport_from_path(
2888
config_dir(), possible_transports=possible_transports)
2889
super(GlobalStore, self).__init__(t, 'bazaar.conf')
2892
class LocationStore(LockableIniFileStore):
2894
def __init__(self, possible_transports=None):
2895
t = transport.get_transport_from_path(
2896
config_dir(), possible_transports=possible_transports)
2897
super(LocationStore, self).__init__(t, 'locations.conf')
2900
class BranchStore(IniFileStore):
2902
def __init__(self, branch):
2903
super(BranchStore, self).__init__(branch.control_transport,
2905
self.branch = branch
2907
def lock_write(self, token=None):
2908
return self.branch.lock_write(token)
2911
return self.branch.unlock()
2915
# We need to be able to override the undecorated implementation
2916
self.save_without_locking()
2918
def save_without_locking(self):
2919
super(BranchStore, self).save()
2922
class ControlStore(LockableIniFileStore):
2924
def __init__(self, bzrdir):
2925
super(ControlStore, self).__init__(bzrdir.transport,
2927
lock_dir_name='branch_lock')
2930
class SectionMatcher(object):
2931
"""Select sections into a given Store.
2933
This is intended to be used to postpone getting an iterable of sections
2937
def __init__(self, store):
2940
def get_sections(self):
2941
# This is where we require loading the store so we can see all defined
2943
sections = self.store.get_sections()
2944
# Walk the revisions in the order provided
2949
def match(self, section):
2950
"""Does the proposed section match.
2952
:param section: A Section object.
2954
:returns: True if the section matches, False otherwise.
2956
raise NotImplementedError(self.match)
2959
class NameMatcher(SectionMatcher):
2961
def __init__(self, store, section_id):
2962
super(NameMatcher, self).__init__(store)
2963
self.section_id = section_id
2965
def match(self, section):
2966
return section.id == self.section_id
2969
class LocationSection(Section):
2971
def __init__(self, section, length, extra_path):
2972
super(LocationSection, self).__init__(section.id, section.options)
2973
self.length = length
2974
self.extra_path = extra_path
2976
def get(self, name, default=None):
2977
value = super(LocationSection, self).get(name, default)
2978
if value is not None:
2979
policy_name = self.get(name + ':policy', None)
2980
policy = _policy_value.get(policy_name, POLICY_NONE)
2981
if policy == POLICY_APPENDPATH:
2982
value = urlutils.join(value, self.extra_path)
2986
class LocationMatcher(SectionMatcher):
2988
def __init__(self, store, location):
2989
super(LocationMatcher, self).__init__(store)
2990
if location.startswith('file://'):
2991
location = urlutils.local_path_from_url(location)
2992
self.location = location
2994
def _get_matching_sections(self):
2995
"""Get all sections matching ``location``."""
2996
# We slightly diverge from LocalConfig here by allowing the no-name
2997
# section as the most generic one and the lower priority.
2998
no_name_section = None
3000
# Filter out the no_name_section so _iter_for_location_by_parts can be
3001
# used (it assumes all sections have a name).
3002
for section in self.store.get_sections():
3003
if section.id is None:
3004
no_name_section = section
3006
all_sections.append(section)
3007
# Unfortunately _iter_for_location_by_parts deals with section names so
3008
# we have to resync.
3009
filtered_sections = _iter_for_location_by_parts(
3010
[s.id for s in all_sections], self.location)
3011
iter_all_sections = iter(all_sections)
3012
matching_sections = []
3013
if no_name_section is not None:
3014
matching_sections.append(
3015
LocationSection(no_name_section, 0, self.location))
3016
for section_id, extra_path, length in filtered_sections:
3017
# a section id is unique for a given store so it's safe to take the
3018
# first matching section while iterating. Also, all filtered
3019
# sections are part of 'all_sections' and will always be found
3022
section = iter_all_sections.next()
3023
if section_id == section.id:
3024
matching_sections.append(
3025
LocationSection(section, length, extra_path))
3027
return matching_sections
3029
def get_sections(self):
3030
# Override the default implementation as we want to change the order
3031
matching_sections = self._get_matching_sections()
3032
# We want the longest (aka more specific) locations first
3033
sections = sorted(matching_sections,
3034
key=lambda section: (section.length, section.id),
3036
# Sections mentioning 'ignore_parents' restrict the selection
3037
for section in sections:
3038
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3039
ignore = section.get('ignore_parents', None)
3040
if ignore is not None:
3041
ignore = ui.bool_from_string(ignore)
3044
# Finally, we have a valid section
3048
class Stack(object):
3049
"""A stack of configurations where an option can be defined"""
3051
_option_ref_re = lazy_regex.lazy_compile('({[^{}]+})')
3052
"""Describes an exandable option reference.
3054
We want to match the most embedded reference first.
3056
I.e. for '{{foo}}' we will get '{foo}',
3057
for '{bar{baz}}' we will get '{baz}'
3060
def __init__(self, sections_def, store=None, mutable_section_name=None):
3061
"""Creates a stack of sections with an optional store for changes.
3063
:param sections_def: A list of Section or callables that returns an
3064
iterable of Section. This defines the Sections for the Stack and
3065
can be called repeatedly if needed.
3067
:param store: The optional Store where modifications will be
3068
recorded. If none is specified, no modifications can be done.
3070
:param mutable_section_name: The name of the MutableSection where
3071
changes are recorded. This requires the ``store`` parameter to be
3074
self.sections_def = sections_def
3076
self.mutable_section_name = mutable_section_name
3078
def get(self, name, expand=None):
3079
"""Return the *first* option value found in the sections.
3081
This is where we guarantee that sections coming from Store are loaded
3082
lazily: the loading is delayed until we need to either check that an
3083
option exists or get its value, which in turn may require to discover
3084
in which sections it can be defined. Both of these (section and option
3085
existence) require loading the store (even partially).
3087
:param name: The queried option.
3089
:param expand: Whether options references should be expanded.
3091
:returns: The value of the option.
3093
# FIXME: No caching of options nor sections yet -- vila 20110503
3095
expand = _get_expand_default_value()
3097
# Ensuring lazy loading is achieved by delaying section matching (which
3098
# implies querying the persistent storage) until it can't be avoided
3099
# anymore by using callables to describe (possibly empty) section
3101
for section_or_callable in self.sections_def:
3102
# Each section can expand to multiple ones when a callable is used
3103
if callable(section_or_callable):
3104
sections = section_or_callable()
3106
sections = [section_or_callable]
3107
for section in sections:
3108
value = section.get(name)
3109
if value is not None:
3111
if value is not None:
3113
# If the option is registered, it may provide additional info about
3116
opt = option_registry.get(name)
3120
def expand_and_convert(val):
3121
# This may need to be called twice if the value is None or ends up
3122
# being None during expansion or conversion.
3125
if isinstance(val, basestring):
3126
val = self._expand_options_in_string(val)
3128
trace.warning('Cannot expand "%s":'
3129
' %s does not support option expansion'
3130
% (name, type(val)))
3132
val = opt.convert_from_unicode(val)
3134
value = expand_and_convert(value)
3135
if opt is not None and value is None:
3136
# If the option is registered, it may provide a default value
3137
value = opt.get_default()
3138
value = expand_and_convert(value)
3139
for hook in ConfigHooks['get']:
3140
hook(self, name, value)
3143
def expand_options(self, string, env=None):
3144
"""Expand option references in the string in the configuration context.
3146
:param string: The string containing option(s) to expand.
3148
:param env: An option dict defining additional configuration options or
3149
overriding existing ones.
3151
:returns: The expanded string.
3153
return self._expand_options_in_string(string, env)
3155
def _expand_options_in_string(self, string, env=None, _refs=None):
3156
"""Expand options in the string in the configuration context.
3158
:param string: The string to be expanded.
3160
:param env: An option dict defining additional configuration options or
3161
overriding existing ones.
3163
:param _refs: Private list (FIFO) containing the options being expanded
3166
:returns: The expanded string.
3169
# Not much to expand there
3172
# What references are currently resolved (to detect loops)
3175
# We need to iterate until no more refs appear ({{foo}} will need two
3176
# iterations for example).
3178
raw_chunks = Stack._option_ref_re.split(result)
3179
if len(raw_chunks) == 1:
3180
# Shorcut the trivial case: no refs
3183
# Split will isolate refs so that every other chunk is a ref
3184
chunk_is_ref = False
3185
for chunk in raw_chunks:
3186
if not chunk_is_ref:
3187
chunks.append(chunk)
3192
raise errors.OptionExpansionLoop(string, _refs)
3194
value = self._expand_option(name, env, _refs)
3196
raise errors.ExpandingUnknownOption(name, string)
3197
chunks.append(value)
3199
chunk_is_ref = False
3200
result = ''.join(chunks)
3203
def _expand_option(self, name, env, _refs):
3204
if env is not None and name in env:
3205
# Special case, values provided in env takes precedence over
3209
# FIXME: This is a limited implementation, what we really need is a
3210
# way to query the bzr config for the value of an option,
3211
# respecting the scope rules (That is, once we implement fallback
3212
# configs, getting the option value should restart from the top
3213
# config, not the current one) -- vila 20101222
3214
value = self.get(name, expand=False)
3215
value = self._expand_options_in_string(value, env, _refs)
3218
def _get_mutable_section(self):
3219
"""Get the MutableSection for the Stack.
3221
This is where we guarantee that the mutable section is lazily loaded:
3222
this means we won't load the corresponding store before setting a value
3223
or deleting an option. In practice the store will often be loaded but
3224
this allows helps catching some programming errors.
3226
section = self.store.get_mutable_section(self.mutable_section_name)
3229
def set(self, name, value):
3230
"""Set a new value for the option."""
3231
section = self._get_mutable_section()
3232
section.set(name, value)
3233
for hook in ConfigHooks['set']:
3234
hook(self, name, value)
3236
def remove(self, name):
3237
"""Remove an existing option."""
3238
section = self._get_mutable_section()
3239
section.remove(name)
3240
for hook in ConfigHooks['remove']:
3244
# Mostly for debugging use
3245
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3248
class _CompatibleStack(Stack):
3249
"""Place holder for compatibility with previous design.
3251
This is intended to ease the transition from the Config-based design to the
3252
Stack-based design and should not be used nor relied upon by plugins.
3254
One assumption made here is that the daughter classes will all use Stores
3255
derived from LockableIniFileStore).
3257
It implements set() by re-loading the store before applying the
3258
modification and saving it.
3260
The long term plan being to implement a single write by store to save
3261
all modifications, this class should not be used in the interim.
3264
def set(self, name, value):
3267
super(_CompatibleStack, self).set(name, value)
3268
# Force a write to persistent storage
3272
class GlobalStack(_CompatibleStack):
3273
"""Global options only stack."""
3277
gstore = GlobalStore()
3278
super(GlobalStack, self).__init__([gstore.get_sections], gstore)
3281
class LocationStack(_CompatibleStack):
3282
"""Per-location options falling back to global options stack."""
3284
def __init__(self, location):
3285
"""Make a new stack for a location and global configuration.
3287
:param location: A URL prefix to """
3288
lstore = LocationStore()
3289
matcher = LocationMatcher(lstore, location)
3290
gstore = GlobalStore()
3291
super(LocationStack, self).__init__(
3292
[matcher.get_sections, gstore.get_sections], lstore)
3295
class BranchStack(_CompatibleStack):
3296
"""Per-location options falling back to branch then global options stack."""
3298
def __init__(self, branch):
3299
bstore = BranchStore(branch)
3300
lstore = LocationStore()
3301
matcher = LocationMatcher(lstore, branch.base)
3302
gstore = GlobalStore()
3303
super(BranchStack, self).__init__(
3304
[matcher.get_sections, bstore.get_sections, gstore.get_sections],
3306
self.branch = branch
3309
class RemoteControlStack(_CompatibleStack):
3310
"""Remote control-only options stack."""
3312
def __init__(self, bzrdir):
3313
cstore = ControlStore(bzrdir)
3314
super(RemoteControlStack, self).__init__(
3315
[cstore.get_sections],
3317
self.bzrdir = bzrdir
3320
class RemoteBranchStack(_CompatibleStack):
3321
"""Remote branch-only options stack."""
3323
def __init__(self, branch):
3324
bstore = BranchStore(branch)
3325
super(RemoteBranchStack, self).__init__(
3326
[bstore.get_sections],
3328
self.branch = branch
3331
class cmd_config(commands.Command):
3332
__doc__ = """Display, set or remove a configuration option.
3334
Display the active value for a given option.
3336
If --all is specified, NAME is interpreted as a regular expression and all
3337
matching options are displayed mentioning their scope. The active value
3338
that bzr will take into account is the first one displayed for each option.
3340
If no NAME is given, --all .* is implied.
3342
Setting a value is achieved by using name=value without spaces. The value
3343
is set in the most relevant scope and can be checked by displaying the
3347
takes_args = ['name?']
3351
# FIXME: This should be a registry option so that plugins can register
3352
# their own config files (or not) -- vila 20101002
3353
commands.Option('scope', help='Reduce the scope to the specified'
3354
' configuration file',
3356
commands.Option('all',
3357
help='Display all the defined values for the matching options.',
3359
commands.Option('remove', help='Remove the option from'
3360
' the configuration file'),
3363
_see_also = ['configuration']
3365
@commands.display_command
3366
def run(self, name=None, all=False, directory=None, scope=None,
3368
if directory is None:
3370
directory = urlutils.normalize_url(directory)
3372
raise errors.BzrError(
3373
'--all and --remove are mutually exclusive.')
3375
# Delete the option in the given scope
3376
self._remove_config_option(name, directory, scope)
3378
# Defaults to all options
3379
self._show_matching_options('.*', directory, scope)
3382
name, value = name.split('=', 1)
3384
# Display the option(s) value(s)
3386
self._show_matching_options(name, directory, scope)
3388
self._show_value(name, directory, scope)
3391
raise errors.BzrError(
3392
'Only one option can be set.')
3393
# Set the option value
3394
self._set_config_option(name, value, directory, scope)
3396
def _get_configs(self, directory, scope=None):
3397
"""Iterate the configurations specified by ``directory`` and ``scope``.
3399
:param directory: Where the configurations are derived from.
3401
:param scope: A specific config to start from.
3403
if scope is not None:
3404
if scope == 'bazaar':
3405
yield GlobalConfig()
3406
elif scope == 'locations':
3407
yield LocationConfig(directory)
3408
elif scope == 'branch':
3409
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
3411
yield br.get_config()
3414
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
3416
yield br.get_config()
3417
except errors.NotBranchError:
3418
yield LocationConfig(directory)
3419
yield GlobalConfig()
3421
def _show_value(self, name, directory, scope):
3423
for c in self._get_configs(directory, scope):
3426
for (oname, value, section, conf_id, parser) in c._get_options():
3428
# Display only the first value and exit
3430
# FIXME: We need to use get_user_option to take policies
3431
# into account and we need to make sure the option exists
3432
# too (hence the two for loops), this needs a better API
3434
value = c.get_user_option(name)
3435
# Quote the value appropriately
3436
value = parser._quote(value)
3437
self.outf.write('%s\n' % (value,))
3441
raise errors.NoSuchConfigOption(name)
3443
def _show_matching_options(self, name, directory, scope):
3444
name = lazy_regex.lazy_compile(name)
3445
# We want any error in the regexp to be raised *now* so we need to
3446
# avoid the delay introduced by the lazy regexp. But, we still do
3447
# want the nicer errors raised by lazy_regex.
3448
name._compile_and_collapse()
3451
for c in self._get_configs(directory, scope):
3452
for (oname, value, section, conf_id, parser) in c._get_options():
3453
if name.search(oname):
3454
if cur_conf_id != conf_id:
3455
# Explain where the options are defined
3456
self.outf.write('%s:\n' % (conf_id,))
3457
cur_conf_id = conf_id
3459
if (section not in (None, 'DEFAULT')
3460
and cur_section != section):
3461
# Display the section if it's not the default (or only)
3463
self.outf.write(' [%s]\n' % (section,))
3464
cur_section = section
3465
self.outf.write(' %s = %s\n' % (oname, value))
3467
def _set_config_option(self, name, value, directory, scope):
3468
for conf in self._get_configs(directory, scope):
3469
conf.set_user_option(name, value)
3472
raise errors.NoSuchConfig(scope)
3474
def _remove_config_option(self, name, directory, scope):
3476
raise errors.BzrCommandError(
3477
'--remove expects an option to remove.')
3479
for conf in self._get_configs(directory, scope):
3480
for (section_name, section, conf_id) in conf._get_sections():
3481
if scope is not None and conf_id != scope:
3482
# Not the right configuration file
3485
if conf_id != conf.config_id():
3486
conf = self._get_configs(directory, conf_id).next()
3487
# We use the first section in the first config where the
3488
# option is defined to remove it
3489
conf.remove_user_option(name, section_name)
3494
raise errors.NoSuchConfig(scope)
3496
raise errors.NoSuchConfigOption(name)
3500
# We need adapters that can build a Store or a Stack in a test context. Test
3501
# classes, based on TestCaseWithTransport, can use the registry to parametrize
3502
# themselves. The builder will receive a test instance and should return a
3503
# ready-to-use store or stack. Plugins that define new store/stacks can also
3504
# register themselves here to be tested against the tests defined in
3505
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3506
# for the same tests.
3508
# The registered object should be a callable receiving a test instance
3509
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
3511
test_store_builder_registry = registry.Registry()
3513
# The registered object should be a callable receiving a test instance
3514
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
3516
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
