2259
1497
configobj[name] = value
2261
1499
configobj.setdefault(section, {})[name] = value
2262
for hook in OldConfigHooks['set']:
2263
hook(self, name, value)
2264
self._set_configobj(configobj)
2266
def remove_option(self, option_name, section_name=None):
2267
configobj = self._get_configobj()
2268
if section_name is None:
2269
del configobj[option_name]
2271
del configobj[section_name][option_name]
2272
for hook in OldConfigHooks['remove']:
2273
hook(self, option_name)
2274
1500
self._set_configobj(configobj)
2276
1502
def _get_config_file(self):
2278
f = StringIO(self._transport.get_bytes(self._filename))
2279
for hook in OldConfigHooks['load']:
1504
return StringIO(self._transport.get_bytes(self._filename))
2282
1505
except errors.NoSuchFile:
2283
1506
return StringIO()
2284
except errors.PermissionDenied, e:
2285
trace.warning("Permission denied while trying to open "
2286
"configuration file %s.", urlutils.unescape_for_display(
2287
urlutils.join(self._transport.base, self._filename), "utf-8"))
2290
def _external_url(self):
2291
return urlutils.join(self._transport.external_url(), self._filename)
2293
1508
def _get_configobj(self):
2294
f = self._get_config_file()
2297
conf = ConfigObj(f, encoding='utf-8')
2298
except configobj.ConfigObjError, e:
2299
raise errors.ParseConfigError(e.errors, self._external_url())
2300
except UnicodeDecodeError:
2301
raise errors.ConfigContentError(self._external_url())
1509
return ConfigObj(self._get_config_file(), encoding='utf-8')
2306
1511
def _set_configobj(self, configobj):
2307
1512
out_file = StringIO()
2308
1513
configobj.write(out_file)
2309
1514
out_file.seek(0)
2310
1515
self._transport.put_file(self._filename, out_file)
2311
for hook in OldConfigHooks['save']:
2315
class Option(object):
2316
"""An option definition.
2318
The option *values* are stored in config files and found in sections.
2320
Here we define various properties about the option itself, its default
2321
value, how to convert it from stores, what to do when invalid values are
2322
encoutered, in which config files it can be stored.
2325
def __init__(self, name, default=None, default_from_env=None,
2327
from_unicode=None, invalid=None):
2328
"""Build an option definition.
2330
:param name: the name used to refer to the option.
2332
:param default: the default value to use when none exist in the config
2333
stores. This is either a string that ``from_unicode`` will convert
2334
into the proper type or a python object that can be stringified (so
2335
only the empty list is supported for example).
2337
:param default_from_env: A list of environment variables which can
2338
provide a default value. 'default' will be used only if none of the
2339
variables specified here are set in the environment.
2341
:param help: a doc string to explain the option to the user.
2343
:param from_unicode: a callable to convert the unicode string
2344
representing the option value in a store. This is not called for
2347
:param invalid: the action to be taken when an invalid value is
2348
encountered in a store. This is called only when from_unicode is
2349
invoked to convert a string and returns None or raise ValueError or
2350
TypeError. Accepted values are: None (ignore invalid values),
2351
'warning' (emit a warning), 'error' (emit an error message and
2354
if default_from_env is None:
2355
default_from_env = []
2357
# Convert the default value to a unicode string so all values are
2358
# strings internally before conversion (via from_unicode) is attempted.
2361
elif isinstance(default, list):
2362
# Only the empty list is supported
2364
raise AssertionError(
2365
'Only empty lists are supported as default values')
2367
elif isinstance(default, (str, unicode, bool, int, float)):
2368
# Rely on python to convert strings, booleans and integers
2369
self.default = u'%s' % (default,)
2371
# other python objects are not expected
2372
raise AssertionError('%r is not supported as a default value'
2374
self.default_from_env = default_from_env
2376
self.from_unicode = from_unicode
2377
if invalid and invalid not in ('warning', 'error'):
2378
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2379
self.invalid = invalid
2381
def convert_from_unicode(self, unicode_value):
2382
if self.from_unicode is None or unicode_value is None:
2383
# Don't convert or nothing to convert
2384
return unicode_value
2386
converted = self.from_unicode(unicode_value)
2387
except (ValueError, TypeError):
2388
# Invalid values are ignored
2390
if converted is None and self.invalid is not None:
2391
# The conversion failed
2392
if self.invalid == 'warning':
2393
trace.warning('Value "%s" is not valid for "%s"',
2394
unicode_value, self.name)
2395
elif self.invalid == 'error':
2396
raise errors.ConfigOptionValueError(self.name, unicode_value)
2399
def get_default(self):
2401
for var in self.default_from_env:
2403
# If the env variable is defined, its value is the default one
2404
value = os.environ[var]
2409
# Otherwise, fallback to the value defined at registration
2410
value = self.default
2413
def get_help_text(self, additional_see_also=None, plain=True):
2415
from bzrlib import help_topics
2416
result += help_topics._format_see_also(additional_see_also)
2418
result = help_topics.help_as_plain_text(result)
2422
# Predefined converters to get proper values from store
2424
def bool_from_store(unicode_str):
2425
return ui.bool_from_string(unicode_str)
2428
def int_from_store(unicode_str):
2429
return int(unicode_str)
2432
def float_from_store(unicode_str):
2433
return float(unicode_str)
2437
# Use a an empty dict to initialize an empty configobj avoiding all
2438
# parsing and encoding checks
2439
_list_converter_config = configobj.ConfigObj(
2440
{}, encoding='utf-8', list_values=True, interpolation=False)
2443
def list_from_store(unicode_str):
2444
if not isinstance(unicode_str, basestring):
2446
# Now inject our string directly as unicode. All callers got their value
2447
# from configobj, so values that need to be quoted are already properly
2449
_list_converter_config.reset()
2450
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2451
maybe_list = _list_converter_config['list']
2452
# ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
2453
if isinstance(maybe_list, basestring):
2455
# A single value, most probably the user forgot (or didn't care to
2456
# add) the final ','
2459
# The empty string, convert to empty list
2462
# We rely on ConfigObj providing us with a list already
2467
class OptionRegistry(registry.Registry):
2468
"""Register config options by their name.
2470
This overrides ``registry.Registry`` to simplify registration by acquiring
2471
some information from the option object itself.
2474
def register(self, option):
2475
"""Register a new option to its name.
2477
:param option: The option to register. Its name is used as the key.
2479
super(OptionRegistry, self).register(option.name, option,
2482
def register_lazy(self, key, module_name, member_name):
2483
"""Register a new option to be loaded on request.
2485
:param key: the key to request the option later. Since the registration
2486
is lazy, it should be provided and match the option name.
2488
:param module_name: the python path to the module. Such as 'os.path'.
2490
:param member_name: the member of the module to return. If empty or
2491
None, get() will return the module itself.
2493
super(OptionRegistry, self).register_lazy(key,
2494
module_name, member_name)
2496
def get_help(self, key=None):
2497
"""Get the help text associated with the given key"""
2498
option = self.get(key)
2499
the_help = option.help
2500
if callable(the_help):
2501
return the_help(self, key)
2505
option_registry = OptionRegistry()
2508
# Registered options in lexicographical order
2510
option_registry.register(
2511
Option('bzr.workingtree.worth_saving_limit', default=10,
2512
from_unicode=int_from_store, invalid='warning',
2514
How many changes before saving the dirstate.
2516
-1 means that we will never rewrite the dirstate file for only
2517
stat-cache changes. Regardless of this setting, we will always rewrite
2518
the dirstate file if a file is added/removed/renamed/etc. This flag only
2519
affects the behavior of updating the dirstate file after we notice that
2520
a file has been touched.
2522
option_registry.register(
2523
Option('dirstate.fdatasync', default=True,
2524
from_unicode=bool_from_store,
2526
Flush dirstate changes onto physical disk?
2528
If true (default), working tree metadata changes are flushed through the
2529
OS buffers to physical disk. This is somewhat slower, but means data
2530
should not be lost if the machine crashes. See also repository.fdatasync.
2532
option_registry.register(
2533
Option('debug_flags', default=[], from_unicode=list_from_store,
2534
help='Debug flags to activate.'))
2535
option_registry.register(
2536
Option('default_format', default='2a',
2537
help='Format used when creating branches.'))
2538
option_registry.register(
2539
Option('dpush_strict', default=None,
2540
from_unicode=bool_from_store,
2542
The default value for ``dpush --strict``.
2544
If present, defines the ``--strict`` option default value for checking
2545
uncommitted changes before pushing into a different VCS without any
2546
custom bzr metadata.
2548
option_registry.register(
2550
help='The command called to launch an editor to enter a message.'))
2551
option_registry.register(
2552
Option('ignore_missing_extensions', default=False,
2553
from_unicode=bool_from_store,
2555
Control the missing extensions warning display.
2557
The warning will not be emitted if set to True.
2559
option_registry.register(
2561
help='Language to translate messages into.'))
2562
option_registry.register(
2563
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2565
Steal locks that appears to be dead.
2567
If set to True, bzr will check if a lock is supposed to be held by an
2568
active process from the same user on the same machine. If the user and
2569
machine match, but no process with the given PID is active, then bzr
2570
will automatically break the stale lock, and create a new lock for
2572
Otherwise, bzr will prompt as normal to break the lock.
2574
option_registry.register(
2575
Option('log_format', default='long',
2577
Log format to use when displaying revisions.
2579
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2580
may be provided by plugins.
2582
option_registry.register(
2583
Option('output_encoding',
2584
help= 'Unicode encoding for output'
2585
' (terminal encoding if not specified).'))
2586
option_registry.register(
2587
Option('push_strict', default=None,
2588
from_unicode=bool_from_store,
2590
The default value for ``push --strict``.
2592
If present, defines the ``--strict`` option default value for checking
2593
uncommitted changes before sending a merge directive.
2595
option_registry.register(
2596
Option('repository.fdatasync', default=True,
2597
from_unicode=bool_from_store,
2599
Flush repository changes onto physical disk?
2601
If true (default), repository changes are flushed through the OS buffers
2602
to physical disk. This is somewhat slower, but means data should not be
2603
lost if the machine crashes. See also dirstate.fdatasync.
2606
option_registry.register(
2607
Option('selftest.timeout',
2609
from_unicode=int_from_store,
2610
help='Abort selftest if one test takes longer than this many seconds',
2613
option_registry.register(
2614
Option('send_strict', default=None,
2615
from_unicode=bool_from_store,
2617
The default value for ``send --strict``.
2619
If present, defines the ``--strict`` option default value for checking
2620
uncommitted changes before pushing.
2623
option_registry.register(
2624
Option('serve.client_timeout',
2625
default=300.0, from_unicode=float_from_store,
2626
help="If we wait for a new request from a client for more than"
2627
" X seconds, consider the client idle, and hangup."))
2630
class Section(object):
2631
"""A section defines a dict of option name => value.
2633
This is merely a read-only dict which can add some knowledge about the
2634
options. It is *not* a python dict object though and doesn't try to mimic
2638
def __init__(self, section_id, options):
2639
self.id = section_id
2640
# We re-use the dict-like object received
2641
self.options = options
2643
def get(self, name, default=None, expand=True):
2644
return self.options.get(name, default)
2646
def iter_option_names(self):
2647
for k in self.options.iterkeys():
2651
# Mostly for debugging use
2652
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2655
_NewlyCreatedOption = object()
2656
"""Was the option created during the MutableSection lifetime"""
2659
class MutableSection(Section):
2660
"""A section allowing changes and keeping track of the original values."""
2662
def __init__(self, section_id, options):
2663
super(MutableSection, self).__init__(section_id, options)
2666
def set(self, name, value):
2667
if name not in self.options:
2668
# This is a new option
2669
self.orig[name] = _NewlyCreatedOption
2670
elif name not in self.orig:
2671
self.orig[name] = self.get(name, None)
2672
self.options[name] = value
2674
def remove(self, name):
2675
if name not in self.orig:
2676
self.orig[name] = self.get(name, None)
2677
del self.options[name]
2680
class Store(object):
2681
"""Abstract interface to persistent storage for configuration options."""
2683
readonly_section_class = Section
2684
mutable_section_class = MutableSection
2686
def is_loaded(self):
2687
"""Returns True if the Store has been loaded.
2689
This is used to implement lazy loading and ensure the persistent
2690
storage is queried only when needed.
2692
raise NotImplementedError(self.is_loaded)
2695
"""Loads the Store from persistent storage."""
2696
raise NotImplementedError(self.load)
2698
def _load_from_string(self, bytes):
2699
"""Create a store from a string in configobj syntax.
2701
:param bytes: A string representing the file content.
2703
raise NotImplementedError(self._load_from_string)
2706
"""Unloads the Store.
2708
This should make is_loaded() return False. This is used when the caller
2709
knows that the persistent storage has changed or may have change since
2712
raise NotImplementedError(self.unload)
2715
"""Saves the Store to persistent storage."""
2716
raise NotImplementedError(self.save)
2718
def external_url(self):
2719
raise NotImplementedError(self.external_url)
2721
def get_sections(self):
2722
"""Returns an ordered iterable of existing sections.
2724
:returns: An iterable of (store, section).
2726
raise NotImplementedError(self.get_sections)
2728
def get_mutable_section(self, section_id=None):
2729
"""Returns the specified mutable section.
2731
:param section_id: The section identifier
2733
raise NotImplementedError(self.get_mutable_section)
2736
# Mostly for debugging use
2737
return "<config.%s(%s)>" % (self.__class__.__name__,
2738
self.external_url())
2741
class CommandLineStore(Store):
2742
"A store to carry command line overrides for the config options."""
2744
def __init__(self, opts=None):
2745
super(CommandLineStore, self).__init__()
2751
# The dict should be cleared but not replaced so it can be shared.
2752
self.options.clear()
2754
def _from_cmdline(self, overrides):
2755
# Reset before accepting new definitions
2757
for over in overrides:
2759
name, value = over.split('=', 1)
2761
raise errors.BzrCommandError(
2762
gettext("Invalid '%s', should be of the form 'name=value'")
2764
self.options[name] = value
2766
def external_url(self):
2767
# Not an url but it makes debugging easier and is never needed
2771
def get_sections(self):
2772
yield self, self.readonly_section_class('cmdline_overrides',
2776
class IniFileStore(Store):
2777
"""A config Store using ConfigObj for storage.
2779
:ivar transport: The transport object where the config file is located.
2781
:ivar file_name: The config file basename in the transport directory.
2783
:ivar _config_obj: Private member to hold the ConfigObj instance used to
2784
serialize/deserialize the config file.
2788
"""A config Store using ConfigObj for storage.
2790
super(IniFileStore, self).__init__()
2791
self._config_obj = None
2793
def is_loaded(self):
2794
return self._config_obj != None
2797
self._config_obj = None
2799
def _load_content(self):
2800
"""Load the config file bytes.
2802
This should be provided by subclasses
2804
:return: Byte string
2806
raise NotImplementedError(self._load_content)
2808
def _save_content(self, content):
2809
"""Save the config file bytes.
2811
This should be provided by subclasses
2813
:param content: Config file bytes to write
2815
raise NotImplementedError(self._save_content)
2818
"""Load the store from the associated file."""
2819
if self.is_loaded():
2821
content = self._load_content()
2822
self._load_from_string(content)
2823
for hook in ConfigHooks['load']:
2826
def _load_from_string(self, bytes):
2827
"""Create a config store from a string.
2829
:param bytes: A string representing the file content.
2831
if self.is_loaded():
2832
raise AssertionError('Already loaded: %r' % (self._config_obj,))
2833
co_input = StringIO(bytes)
2835
# The config files are always stored utf8-encoded
2836
self._config_obj = ConfigObj(co_input, encoding='utf-8',
2838
except configobj.ConfigObjError, e:
2839
self._config_obj = None
2840
raise errors.ParseConfigError(e.errors, self.external_url())
2841
except UnicodeDecodeError:
2842
raise errors.ConfigContentError(self.external_url())
2845
if not self.is_loaded():
2849
self._config_obj.write(out)
2850
self._save_content(out.getvalue())
2851
for hook in ConfigHooks['save']:
2854
def get_sections(self):
2855
"""Get the configobj section in the file order.
2857
:returns: An iterable of (store, section).
2859
# We need a loaded store
2862
except (errors.NoSuchFile, errors.PermissionDenied):
2863
# If the file can't be read, there is no sections
2865
cobj = self._config_obj
2867
yield self, self.readonly_section_class(None, cobj)
2868
for section_name in cobj.sections:
2870
self.readonly_section_class(section_name,
2871
cobj[section_name]))
2873
def get_mutable_section(self, section_id=None):
2874
# We need a loaded store
2877
except errors.NoSuchFile:
2878
# The file doesn't exist, let's pretend it was empty
2879
self._load_from_string('')
2880
if section_id is None:
2881
section = self._config_obj
2883
section = self._config_obj.setdefault(section_id, {})
2884
return self.mutable_section_class(section_id, section)
2887
class TransportIniFileStore(IniFileStore):
2888
"""IniFileStore that loads files from a transport.
2891
def __init__(self, transport, file_name):
2892
"""A Store using a ini file on a Transport
2894
:param transport: The transport object where the config file is located.
2895
:param file_name: The config file basename in the transport directory.
2897
super(TransportIniFileStore, self).__init__()
2898
self.transport = transport
2899
self.file_name = file_name
2901
def _load_content(self):
2903
return self.transport.get_bytes(self.file_name)
2904
except errors.PermissionDenied:
2905
trace.warning("Permission denied while trying to load "
2906
"configuration store %s.", self.external_url())
2909
def _save_content(self, content):
2910
self.transport.put_bytes(self.file_name, content)
2912
def external_url(self):
2913
# FIXME: external_url should really accepts an optional relpath
2914
# parameter (bug #750169) :-/ -- vila 2011-04-04
2915
# The following will do in the interim but maybe we don't want to
2916
# expose a path here but rather a config ID and its associated
2917
# object </hand wawe>.
2918
return urlutils.join(self.transport.external_url(), self.file_name)
2921
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2922
# unlockable stores for use with objects that can already ensure the locking
2923
# (think branches). If different stores (not based on ConfigObj) are created,
2924
# they may face the same issue.
2927
class LockableIniFileStore(TransportIniFileStore):
2928
"""A ConfigObjStore using locks on save to ensure store integrity."""
2930
def __init__(self, transport, file_name, lock_dir_name=None):
2931
"""A config Store using ConfigObj for storage.
2933
:param transport: The transport object where the config file is located.
2935
:param file_name: The config file basename in the transport directory.
2937
if lock_dir_name is None:
2938
lock_dir_name = 'lock'
2939
self.lock_dir_name = lock_dir_name
2940
super(LockableIniFileStore, self).__init__(transport, file_name)
2941
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
2943
def lock_write(self, token=None):
2944
"""Takes a write lock in the directory containing the config file.
2946
If the directory doesn't exist it is created.
2948
# FIXME: This doesn't check the ownership of the created directories as
2949
# ensure_config_dir_exists does. It should if the transport is local
2950
# -- vila 2011-04-06
2951
self.transport.create_prefix()
2952
return self._lock.lock_write(token)
2957
def break_lock(self):
2958
self._lock.break_lock()
2962
# We need to be able to override the undecorated implementation
2963
self.save_without_locking()
2965
def save_without_locking(self):
2966
super(LockableIniFileStore, self).save()
2969
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
2970
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
2971
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
2973
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
2974
# functions or a registry will make it easier and clearer for tests, focusing
2975
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2976
# on a poolie's remark)
2977
class GlobalStore(LockableIniFileStore):
2979
def __init__(self, possible_transports=None):
2980
t = transport.get_transport_from_path(
2981
config_dir(), possible_transports=possible_transports)
2982
super(GlobalStore, self).__init__(t, 'bazaar.conf')
2986
class LocationStore(LockableIniFileStore):
2988
def __init__(self, possible_transports=None):
2989
t = transport.get_transport_from_path(
2990
config_dir(), possible_transports=possible_transports)
2991
super(LocationStore, self).__init__(t, 'locations.conf')
2992
self.id = 'locations'
2995
class BranchStore(TransportIniFileStore):
2997
def __init__(self, branch):
2998
super(BranchStore, self).__init__(branch.control_transport,
3000
self.branch = branch
3003
def lock_write(self, token=None):
3004
return self.branch.lock_write(token)
3007
return self.branch.unlock()
3011
# We need to be able to override the undecorated implementation
3012
self.save_without_locking()
3014
def save_without_locking(self):
3015
super(BranchStore, self).save()
3018
class ControlStore(LockableIniFileStore):
3020
def __init__(self, bzrdir):
3021
super(ControlStore, self).__init__(bzrdir.transport,
3023
lock_dir_name='branch_lock')
3026
class SectionMatcher(object):
3027
"""Select sections into a given Store.
3029
This is intended to be used to postpone getting an iterable of sections
3033
def __init__(self, store):
3036
def get_sections(self):
3037
# This is where we require loading the store so we can see all defined
3039
sections = self.store.get_sections()
3040
# Walk the revisions in the order provided
3041
for store, s in sections:
3045
def match(self, section):
3046
"""Does the proposed section match.
3048
:param section: A Section object.
3050
:returns: True if the section matches, False otherwise.
3052
raise NotImplementedError(self.match)
3055
class NameMatcher(SectionMatcher):
3057
def __init__(self, store, section_id):
3058
super(NameMatcher, self).__init__(store)
3059
self.section_id = section_id
3061
def match(self, section):
3062
return section.id == self.section_id
3065
class LocationSection(Section):
3067
def __init__(self, section, length, extra_path):
3068
super(LocationSection, self).__init__(section.id, section.options)
3069
self.length = length
3070
self.extra_path = extra_path
3071
self.locals = {'relpath': extra_path,
3072
'basename': urlutils.basename(extra_path)}
3074
def get(self, name, default=None, expand=True):
3075
value = super(LocationSection, self).get(name, default)
3076
if value is not None and expand:
3077
policy_name = self.get(name + ':policy', None)
3078
policy = _policy_value.get(policy_name, POLICY_NONE)
3079
if policy == POLICY_APPENDPATH:
3080
value = urlutils.join(value, self.extra_path)
3081
# expand section local options right now (since POLICY_APPENDPATH
3082
# will never add options references, it's ok to expand after it).
3084
for is_ref, chunk in iter_option_refs(value):
3086
chunks.append(chunk)
3089
if ref in self.locals:
3090
chunks.append(self.locals[ref])
3092
chunks.append(chunk)
3093
value = ''.join(chunks)
3097
class LocationMatcher(SectionMatcher):
3099
def __init__(self, store, location):
3100
super(LocationMatcher, self).__init__(store)
3101
if location.startswith('file://'):
3102
location = urlutils.local_path_from_url(location)
3103
self.location = location
3105
def _get_matching_sections(self):
3106
"""Get all sections matching ``location``."""
3107
# We slightly diverge from LocalConfig here by allowing the no-name
3108
# section as the most generic one and the lower priority.
3109
no_name_section = None
3111
# Filter out the no_name_section so _iter_for_location_by_parts can be
3112
# used (it assumes all sections have a name).
3113
for _, section in self.store.get_sections():
3114
if section.id is None:
3115
no_name_section = section
3117
all_sections.append(section)
3118
# Unfortunately _iter_for_location_by_parts deals with section names so
3119
# we have to resync.
3120
filtered_sections = _iter_for_location_by_parts(
3121
[s.id for s in all_sections], self.location)
3122
iter_all_sections = iter(all_sections)
3123
matching_sections = []
3124
if no_name_section is not None:
3125
matching_sections.append(
3126
LocationSection(no_name_section, 0, self.location))
3127
for section_id, extra_path, length in filtered_sections:
3128
# a section id is unique for a given store so it's safe to take the
3129
# first matching section while iterating. Also, all filtered
3130
# sections are part of 'all_sections' and will always be found
3133
section = iter_all_sections.next()
3134
if section_id == section.id:
3135
matching_sections.append(
3136
LocationSection(section, length, extra_path))
3138
return matching_sections
3140
def get_sections(self):
3141
# Override the default implementation as we want to change the order
3142
matching_sections = self._get_matching_sections()
3143
# We want the longest (aka more specific) locations first
3144
sections = sorted(matching_sections,
3145
key=lambda section: (section.length, section.id),
3147
# Sections mentioning 'ignore_parents' restrict the selection
3148
for section in sections:
3149
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3150
ignore = section.get('ignore_parents', None)
3151
if ignore is not None:
3152
ignore = ui.bool_from_string(ignore)
3155
# Finally, we have a valid section
3156
yield self.store, section
3159
_option_ref_re = lazy_regex.lazy_compile('({[^{}]+})')
3160
"""Describes an expandable option reference.
3162
We want to match the most embedded reference first.
3164
I.e. for '{{foo}}' we will get '{foo}',
3165
for '{bar{baz}}' we will get '{baz}'
3168
def iter_option_refs(string):
3169
# Split isolate refs so every other chunk is a ref
3171
for chunk in _option_ref_re.split(string):
3176
class Stack(object):
3177
"""A stack of configurations where an option can be defined"""
3179
def __init__(self, sections_def, store=None, mutable_section_id=None):
3180
"""Creates a stack of sections with an optional store for changes.
3182
:param sections_def: A list of Section or callables that returns an
3183
iterable of Section. This defines the Sections for the Stack and
3184
can be called repeatedly if needed.
3186
:param store: The optional Store where modifications will be
3187
recorded. If none is specified, no modifications can be done.
3189
:param mutable_section_id: The id of the MutableSection where changes
3190
are recorded. This requires the ``store`` parameter to be
3193
self.sections_def = sections_def
3195
self.mutable_section_id = mutable_section_id
3197
def get(self, name, expand=None):
3198
"""Return the *first* option value found in the sections.
3200
This is where we guarantee that sections coming from Store are loaded
3201
lazily: the loading is delayed until we need to either check that an
3202
option exists or get its value, which in turn may require to discover
3203
in which sections it can be defined. Both of these (section and option
3204
existence) require loading the store (even partially).
3206
:param name: The queried option.
3208
:param expand: Whether options references should be expanded.
3210
:returns: The value of the option.
3212
# FIXME: No caching of options nor sections yet -- vila 20110503
3214
expand = _get_expand_default_value()
3216
# Ensuring lazy loading is achieved by delaying section matching (which
3217
# implies querying the persistent storage) until it can't be avoided
3218
# anymore by using callables to describe (possibly empty) section
3220
for sections in self.sections_def:
3221
for store, section in sections():
3222
value = section.get(name)
3223
if value is not None:
3225
if value is not None:
3227
# If the option is registered, it may provide additional info about
3230
opt = option_registry.get(name)
3234
def expand_and_convert(val):
3235
# This may need to be called twice if the value is None or ends up
3236
# being None during expansion or conversion.
3239
if isinstance(val, basestring):
3240
val = self._expand_options_in_string(val)
3242
trace.warning('Cannot expand "%s":'
3243
' %s does not support option expansion'
3244
% (name, type(val)))
3246
val = opt.convert_from_unicode(val)
3248
value = expand_and_convert(value)
3249
if opt is not None and value is None:
3250
# If the option is registered, it may provide a default value
3251
value = opt.get_default()
3252
value = expand_and_convert(value)
3253
for hook in ConfigHooks['get']:
3254
hook(self, name, value)
3257
def expand_options(self, string, env=None):
3258
"""Expand option references in the string in the configuration context.
3260
:param string: The string containing option(s) to expand.
3262
:param env: An option dict defining additional configuration options or
3263
overriding existing ones.
3265
:returns: The expanded string.
3267
return self._expand_options_in_string(string, env)
3269
def _expand_options_in_string(self, string, env=None, _refs=None):
3270
"""Expand options in the string in the configuration context.
3272
:param string: The string to be expanded.
3274
:param env: An option dict defining additional configuration options or
3275
overriding existing ones.
3277
:param _refs: Private list (FIFO) containing the options being expanded
3280
:returns: The expanded string.
3283
# Not much to expand there
3286
# What references are currently resolved (to detect loops)
3289
# We need to iterate until no more refs appear ({{foo}} will need two
3290
# iterations for example).
3295
for is_ref, chunk in iter_option_refs(result):
3297
chunks.append(chunk)
3302
raise errors.OptionExpansionLoop(string, _refs)
3304
value = self._expand_option(name, env, _refs)
3306
raise errors.ExpandingUnknownOption(name, string)
3307
chunks.append(value)
3309
result = ''.join(chunks)
3312
def _expand_option(self, name, env, _refs):
3313
if env is not None and name in env:
3314
# Special case, values provided in env takes precedence over
3318
value = self.get(name, expand=False)
3319
value = self._expand_options_in_string(value, env, _refs)
3322
def _get_mutable_section(self):
3323
"""Get the MutableSection for the Stack.
3325
This is where we guarantee that the mutable section is lazily loaded:
3326
this means we won't load the corresponding store before setting a value
3327
or deleting an option. In practice the store will often be loaded but
3328
this helps catching some programming errors.
3330
section = self.store.get_mutable_section(self.mutable_section_id)
3333
def set(self, name, value):
3334
"""Set a new value for the option."""
3335
section = self._get_mutable_section()
3336
section.set(name, value)
3337
for hook in ConfigHooks['set']:
3338
hook(self, name, value)
3340
def remove(self, name):
3341
"""Remove an existing option."""
3342
section = self._get_mutable_section()
3343
section.remove(name)
3344
for hook in ConfigHooks['remove']:
3348
# Mostly for debugging use
3349
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3351
def _get_overrides(self):
3352
# Hack around library_state.initialize never called
3353
if bzrlib.global_state is not None:
3354
return bzrlib.global_state.cmdline_overrides.get_sections()
3358
class _CompatibleStack(Stack):
3359
"""Place holder for compatibility with previous design.
3361
This is intended to ease the transition from the Config-based design to the
3362
Stack-based design and should not be used nor relied upon by plugins.
3364
One assumption made here is that the daughter classes will all use Stores
3365
derived from LockableIniFileStore).
3367
It implements set() and remove () by re-loading the store before applying
3368
the modification and saving it.
3370
The long term plan being to implement a single write by store to save
3371
all modifications, this class should not be used in the interim.
3374
def set(self, name, value):
3377
super(_CompatibleStack, self).set(name, value)
3378
# Force a write to persistent storage
3381
def remove(self, name):
3384
super(_CompatibleStack, self).remove(name)
3385
# Force a write to persistent storage
3389
class GlobalStack(_CompatibleStack):
3390
"""Global options only stack."""
3394
gstore = GlobalStore()
3395
super(GlobalStack, self).__init__(
3396
[self._get_overrides, NameMatcher(gstore, 'DEFAULT').get_sections],
3397
gstore, mutable_section_id='DEFAULT')
3400
class LocationStack(_CompatibleStack):
3401
"""Per-location options falling back to global options stack."""
3403
def __init__(self, location):
3404
"""Make a new stack for a location and global configuration.
3406
:param location: A URL prefix to """
3407
lstore = LocationStore()
3408
if location.startswith('file://'):
3409
location = urlutils.local_path_from_url(location)
3410
matcher = LocationMatcher(lstore, location)
3411
gstore = GlobalStore()
3412
super(LocationStack, self).__init__(
3413
[self._get_overrides,
3414
matcher.get_sections, NameMatcher(gstore, 'DEFAULT').get_sections],
3415
lstore, mutable_section_id=location)
3418
class BranchStack(_CompatibleStack):
3419
"""Per-location options falling back to branch then global options stack."""
3421
def __init__(self, branch):
3422
bstore = branch._get_config_store()
3423
lstore = LocationStore()
3424
matcher = LocationMatcher(lstore, branch.base)
3425
gstore = GlobalStore()
3426
super(BranchStack, self).__init__(
3427
[self._get_overrides,
3428
matcher.get_sections, bstore.get_sections,
3429
NameMatcher(gstore, 'DEFAULT').get_sections],
3431
self.branch = branch
3434
class RemoteControlStack(_CompatibleStack):
3435
"""Remote control-only options stack."""
3437
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3438
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3439
# control.conf and is used only for stack options.
3441
def __init__(self, bzrdir):
3442
cstore = bzrdir._get_config_store()
3443
super(RemoteControlStack, self).__init__(
3444
[cstore.get_sections],
3446
self.bzrdir = bzrdir
3449
class RemoteBranchStack(_CompatibleStack):
3450
"""Remote branch-only options stack."""
3452
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3453
# with the stack used for remote branches. RemoteBranchStack only uses
3454
# branch.conf and is used only for the stack options.
3456
def __init__(self, branch):
3457
bstore = branch._get_config_store()
3458
super(RemoteBranchStack, self).__init__(
3459
[bstore.get_sections],
3461
self.branch = branch
3463
# Use a an empty dict to initialize an empty configobj avoiding all
3464
# parsing and encoding checks
3465
_quoting_config = configobj.ConfigObj(
3466
{}, encoding='utf-8', interpolation=False)
3468
class cmd_config(commands.Command):
3469
__doc__ = """Display, set or remove a configuration option.
3471
Display the active value for a given option.
3473
If --all is specified, NAME is interpreted as a regular expression and all
3474
matching options are displayed mentioning their scope. The active value
3475
that bzr will take into account is the first one displayed for each option.
3477
If no NAME is given, --all .* is implied.
3479
Setting a value is achieved by using name=value without spaces. The value
3480
is set in the most relevant scope and can be checked by displaying the
3484
takes_args = ['name?']
3488
# FIXME: This should be a registry option so that plugins can register
3489
# their own config files (or not) and will also address
3490
# http://pad.lv/788991 -- vila 20101115
3491
commands.Option('scope', help='Reduce the scope to the specified'
3492
' configuration file.',
3494
commands.Option('all',
3495
help='Display all the defined values for the matching options.',
3497
commands.Option('remove', help='Remove the option from'
3498
' the configuration file.'),
3501
_see_also = ['configuration']
3503
@commands.display_command
3504
def run(self, name=None, all=False, directory=None, scope=None,
3506
if directory is None:
3508
directory = urlutils.normalize_url(directory)
3510
raise errors.BzrError(
3511
'--all and --remove are mutually exclusive.')
3513
# Delete the option in the given scope
3514
self._remove_config_option(name, directory, scope)
3516
# Defaults to all options
3517
self._show_matching_options('.*', directory, scope)
3520
name, value = name.split('=', 1)
3522
# Display the option(s) value(s)
3524
self._show_matching_options(name, directory, scope)
3526
self._show_value(name, directory, scope)
3529
raise errors.BzrError(
3530
'Only one option can be set.')
3531
# Set the option value
3532
self._set_config_option(name, value, directory, scope)
3534
def _get_stack(self, directory, scope=None):
3535
"""Get the configuration stack specified by ``directory`` and ``scope``.
3537
:param directory: Where the configurations are derived from.
3539
:param scope: A specific config to start from.
3541
# FIXME: scope should allow access to plugin-specific stacks (even
3542
# reduced to the plugin-specific store), related to
3543
# http://pad.lv/788991 -- vila 2011-11-15
3544
if scope is not None:
3545
if scope == 'bazaar':
3546
return GlobalStack()
3547
elif scope == 'locations':
3548
return LocationStack(directory)
3549
elif scope == 'branch':
3551
controldir.ControlDir.open_containing_tree_or_branch(
3553
return br.get_config_stack()
3554
raise errors.NoSuchConfig(scope)
3558
controldir.ControlDir.open_containing_tree_or_branch(
3560
return br.get_config_stack()
3561
except errors.NotBranchError:
3562
return LocationStack(directory)
3564
def _show_value(self, name, directory, scope):
3565
conf = self._get_stack(directory, scope)
3566
value = conf.get(name, expand=True)
3567
if value is not None:
3568
# Quote the value appropriately
3569
value = _quoting_config._quote(value)
3570
self.outf.write('%s\n' % (value,))
3572
raise errors.NoSuchConfigOption(name)
3574
def _show_matching_options(self, name, directory, scope):
3575
name = lazy_regex.lazy_compile(name)
3576
# We want any error in the regexp to be raised *now* so we need to
3577
# avoid the delay introduced by the lazy regexp. But, we still do
3578
# want the nicer errors raised by lazy_regex.
3579
name._compile_and_collapse()
3582
conf = self._get_stack(directory, scope)
3583
for sections in conf.sections_def:
3584
for store, section in sections():
3585
for oname in section.iter_option_names():
3586
if name.search(oname):
3587
if cur_store_id != store.id:
3588
# Explain where the options are defined
3589
self.outf.write('%s:\n' % (store.id,))
3590
cur_store_id = store.id
3592
if (section.id not in (None, 'DEFAULT')
3593
and cur_section != section.id):
3594
# Display the section if it's not the default (or
3596
self.outf.write(' [%s]\n' % (section.id,))
3597
cur_section = section.id
3598
value = section.get(oname, expand=False)
3599
value = _quoting_config._quote(value)
3600
self.outf.write(' %s = %s\n' % (oname, value))
3602
def _set_config_option(self, name, value, directory, scope):
3603
conf = self._get_stack(directory, scope)
3604
conf.set(name, value)
3606
def _remove_config_option(self, name, directory, scope):
3608
raise errors.BzrCommandError(
3609
'--remove expects an option to remove.')
3610
conf = self._get_stack(directory, scope)
3614
raise errors.NoSuchConfigOption(name)
3619
# We need adapters that can build a Store or a Stack in a test context. Test
3620
# classes, based on TestCaseWithTransport, can use the registry to parametrize
3621
# themselves. The builder will receive a test instance and should return a
3622
# ready-to-use store or stack. Plugins that define new store/stacks can also
3623
# register themselves here to be tested against the tests defined in
3624
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3625
# for the same test.
3627
# The registered object should be a callable receiving a test instance
3628
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
3630
test_store_builder_registry = registry.Registry()
3632
# The registered object should be a callable receiving a test instance
3633
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
3635
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
