← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-13 17:25:29 UTC
  • mfrom: (6499 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6501.
  • Revision ID: v.ladeuil+lp@free.fr-20120313172529-i0suyjnepsor25i7
Merge trunk

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/config.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2012 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#            and others
4
4
#
55
55
                   turns on create_signatures.
56
56
create_signatures - this option controls whether bzr will always create
57
57
                    gpg signatures or not on commits.  There is an unused
58
 
                    option which in future is expected to work if               
 
58
                    option which in future is expected to work if
59
59
                    branch settings require signatures.
60
60
log_format - this option sets the default log format.  Possible values are
61
61
             long, short, line, or a plugin can register new formats.
72
72
up=pull
73
73
"""
74
74
 
 
75
from __future__ import absolute_import
 
76
from cStringIO import StringIO
75
77
import os
76
 
import string
77
78
import sys
78
79
 
79
 
 
 
80
import bzrlib
80
81
from bzrlib.decorators import needs_write_lock
81
82
from bzrlib.lazy_import import lazy_import
82
83
lazy_import(globals(), """
83
84
import fnmatch
84
85
import re
85
 
from cStringIO import StringIO
86
86
 
87
87
from bzrlib import (
88
88
    atomicfile,
89
 
    bzrdir,
 
89
    controldir,
90
90
    debug,
91
91
    errors,
92
92
    lazy_regex,
 
93
    library_state,
93
94
    lockdir,
94
 
    mail_client,
95
95
    mergetools,
96
96
    osutils,
97
97
    symbol_versioning,
101
101
    urlutils,
102
102
    win32utils,
103
103
    )
 
104
from bzrlib.i18n import gettext
104
105
from bzrlib.util.configobj import configobj
105
106
""")
106
107
from bzrlib import (
107
108
    commands,
108
109
    hooks,
 
110
    lazy_regex,
109
111
    registry,
110
112
    )
111
113
from bzrlib.symbol_versioning import (
148
150
STORE_GLOBAL = 4
149
151
 
150
152
 
 
153
def signature_policy_from_unicode(signature_string):
 
154
    """Convert a string to a signing policy."""
 
155
    if signature_string.lower() == 'check-available':
 
156
        return CHECK_IF_POSSIBLE
 
157
    if signature_string.lower() == 'ignore':
 
158
        return CHECK_NEVER
 
159
    if signature_string.lower() == 'require':
 
160
        return CHECK_ALWAYS
 
161
    raise ValueError("Invalid signatures policy '%s'"
 
162
                     % signature_string)
 
163
 
 
164
 
 
165
def signing_policy_from_unicode(signature_string):
 
166
    """Convert a string to a signing policy."""
 
167
    if signature_string.lower() == 'when-required':
 
168
        return SIGN_WHEN_REQUIRED
 
169
    if signature_string.lower() == 'never':
 
170
        return SIGN_NEVER
 
171
    if signature_string.lower() == 'always':
 
172
        return SIGN_ALWAYS
 
173
    raise ValueError("Invalid signing policy '%s'"
 
174
                     % signature_string)
 
175
 
 
176
 
151
177
class ConfigObj(configobj.ConfigObj):
152
178
 
153
179
    def __init__(self, infile=None, **kwargs):
169
195
        return self[section][name]
170
196
 
171
197
 
172
 
# FIXME: Until we can guarantee that each config file is loaded once and
173
 
# only once for a given bzrlib session, we don't want to re-read the file every
174
 
# time we query for an option so we cache the value (bad ! watch out for tests
175
 
# needing to restore the proper value).This shouldn't be part of 2.4.0 final,
176
 
# yell at mgz^W vila and the RM if this is still present at that time
177
 
# -- vila 20110219
178
 
_expand_default_value = None
179
 
def _get_expand_default_value():
180
 
    global _expand_default_value
181
 
    if _expand_default_value is not None:
182
 
        return _expand_default_value
183
 
    conf = GlobalConfig()
184
 
    # Note that we must not use None for the expand value below or we'll run
185
 
    # into infinite recursion. Using False really would be quite silly ;)
186
 
    expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
187
 
    if expand is None:
188
 
        # This is an opt-in feature, you *really* need to clearly say you want
189
 
        # to activate it !
190
 
        expand = False
191
 
    _expand_default_value = expand
192
 
    return expand
193
 
 
194
 
 
195
198
class Config(object):
196
199
    """A configuration policy - what username, editor, gpg needs etc."""
197
200
 
215
218
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
216
219
                                             sys.stdout)
217
220
 
218
 
    def get_mail_client(self):
219
 
        """Get a mail client to use"""
220
 
        selected_client = self.get_user_option('mail_client')
221
 
        _registry = mail_client.mail_client_registry
222
 
        try:
223
 
            mail_client_class = _registry.get(selected_client)
224
 
        except KeyError:
225
 
            raise errors.UnknownMailClient(selected_client)
226
 
        return mail_client_class(self)
227
 
 
228
221
    def _get_signature_checking(self):
229
222
        """Template method to override signature checking policy."""
230
223
 
359
352
        """Template method to provide a user option."""
360
353
        return None
361
354
 
362
 
    def get_user_option(self, option_name, expand=None):
 
355
    def get_user_option(self, option_name, expand=True):
363
356
        """Get a generic option - no special process, no default.
364
357
 
365
358
        :param option_name: The queried option.
368
361
 
369
362
        :returns: The value of the option.
370
363
        """
371
 
        if expand is None:
372
 
            expand = _get_expand_default_value()
373
364
        value = self._get_user_option(option_name)
374
365
        if expand:
375
366
            if isinstance(value, list):
416
407
            l = [l]
417
408
        return l
418
409
 
 
410
    @deprecated_method(deprecated_in((2, 5, 0)))
 
411
    def get_user_option_as_int_from_SI(self, option_name, default=None):
 
412
        """Get a generic option from a human readable size in SI units, e.g 10MB
 
413
 
 
414
        Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
415
        by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
416
        pedantic.
 
417
 
 
418
        :return Integer, expanded to its base-10 value if a proper SI unit is 
 
419
            found. If the option doesn't exist, or isn't a value in 
 
420
            SI units, return default (which defaults to None)
 
421
        """
 
422
        val = self.get_user_option(option_name)
 
423
        if isinstance(val, list):
 
424
            val = val[0]
 
425
        if val is None:
 
426
            val = default
 
427
        else:
 
428
            p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
 
429
            try:
 
430
                m = p.match(val)
 
431
                if m is not None:
 
432
                    val = int(m.group(1))
 
433
                    if m.group(2) is not None:
 
434
                        if m.group(2).lower() == 'k':
 
435
                            val *= 10**3
 
436
                        elif m.group(2).lower() == 'm':
 
437
                            val *= 10**6
 
438
                        elif m.group(2).lower() == 'g':
 
439
                            val *= 10**9
 
440
                else:
 
441
                    ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
 
442
                                               ' value {1!r} is not an SI unit.').format(
 
443
                                                option_name, val))
 
444
                    val = default
 
445
            except TypeError:
 
446
                val = default
 
447
        return val
 
448
 
 
449
    @deprecated_method(deprecated_in((2, 5, 0)))
419
450
    def gpg_signing_command(self):
420
451
        """What program should be used to sign signatures?"""
421
452
        result = self._gpg_signing_command()
427
458
        """See gpg_signing_command()."""
428
459
        return None
429
460
 
 
461
    @deprecated_method(deprecated_in((2, 5, 0)))
430
462
    def log_format(self):
431
463
        """What log format should be used"""
432
464
        result = self._log_format()
451
483
        """See validate_signatures_in_log()."""
452
484
        return None
453
485
 
 
486
    @deprecated_method(deprecated_in((2, 5, 0)))
454
487
    def acceptable_keys(self):
455
488
        """Comma separated list of key patterns acceptable to 
456
489
        verify-signatures command"""
461
494
        """See acceptable_keys()."""
462
495
        return None
463
496
 
 
497
    @deprecated_method(deprecated_in((2, 5, 0)))
464
498
    def post_commit(self):
465
499
        """An ordered list of python functions to call.
466
500
 
492
526
        v = self._get_user_id()
493
527
        if v:
494
528
            return v
495
 
        v = os.environ.get('EMAIL')
496
 
        if v:
497
 
            return v.decode(osutils.get_user_encoding())
498
 
        name, email = _auto_user_id()
499
 
        if name and email:
500
 
            return '%s <%s>' % (name, email)
501
 
        elif email:
502
 
            return email
503
 
        raise errors.NoWhoami()
 
529
        return default_email()
504
530
 
505
531
    def ensure_username(self):
506
532
        """Raise errors.NoWhoami if username is not set.
509
535
        """
510
536
        self.username()
511
537
 
 
538
    @deprecated_method(deprecated_in((2, 5, 0)))
512
539
    def signature_checking(self):
513
540
        """What is the current policy for signature checking?."""
514
541
        policy = self._get_signature_checking()
516
543
            return policy
517
544
        return CHECK_IF_POSSIBLE
518
545
 
 
546
    @deprecated_method(deprecated_in((2, 5, 0)))
519
547
    def signing_policy(self):
520
548
        """What is the current policy for signature checking?."""
521
549
        policy = self._get_signing_policy()
523
551
            return policy
524
552
        return SIGN_WHEN_REQUIRED
525
553
 
 
554
    @deprecated_method(deprecated_in((2, 5, 0)))
526
555
    def signature_needed(self):
527
556
        """Is a signature needed when committing ?."""
528
557
        policy = self._get_signing_policy()
537
566
            return True
538
567
        return False
539
568
 
 
569
    @deprecated_method(deprecated_in((2, 5, 0)))
540
570
    def gpg_signing_key(self):
541
571
        """GPG user-id to sign commits"""
542
572
        key = self.get_user_option('gpg_signing_key')
584
614
        for (oname, value, section, conf_id, parser) in self._get_options():
585
615
            if oname.startswith('bzr.mergetool.'):
586
616
                tool_name = oname[len('bzr.mergetool.'):]
587
 
                tools[tool_name] = value
 
617
                tools[tool_name] = self.get_user_option(oname, False)
588
618
        trace.mutter('loaded merge tools: %r' % tools)
589
619
        return tools
590
620
 
827
857
        """See Config._get_signature_checking."""
828
858
        policy = self._get_user_option('check_signatures')
829
859
        if policy:
830
 
            return self._string_to_signature_policy(policy)
 
860
            return signature_policy_from_unicode(policy)
831
861
 
832
862
    def _get_signing_policy(self):
833
863
        """See Config._get_signing_policy"""
834
864
        policy = self._get_user_option('create_signatures')
835
865
        if policy:
836
 
            return self._string_to_signing_policy(policy)
 
866
            return signing_policy_from_unicode(policy)
837
867
 
838
868
    def _get_user_id(self):
839
869
        """Get the user id from the 'email' key in the current section."""
884
914
        """See Config.post_commit."""
885
915
        return self._get_user_option('post_commit')
886
916
 
887
 
    def _string_to_signature_policy(self, signature_string):
888
 
        """Convert a string to a signing policy."""
889
 
        if signature_string.lower() == 'check-available':
890
 
            return CHECK_IF_POSSIBLE
891
 
        if signature_string.lower() == 'ignore':
892
 
            return CHECK_NEVER
893
 
        if signature_string.lower() == 'require':
894
 
            return CHECK_ALWAYS
895
 
        raise errors.BzrError("Invalid signatures policy '%s'"
896
 
                              % signature_string)
897
 
 
898
 
    def _string_to_signing_policy(self, signature_string):
899
 
        """Convert a string to a signing policy."""
900
 
        if signature_string.lower() == 'when-required':
901
 
            return SIGN_WHEN_REQUIRED
902
 
        if signature_string.lower() == 'never':
903
 
            return SIGN_NEVER
904
 
        if signature_string.lower() == 'always':
905
 
            return SIGN_ALWAYS
906
 
        raise errors.BzrError("Invalid signing policy '%s'"
907
 
                              % signature_string)
908
 
 
909
917
    def _get_alias(self, value):
910
918
        try:
911
919
            return self._get_parser().get_value("ALIASES",
987
995
        # local transports are not shared. But if/when we start using
988
996
        # LockableConfig for other kind of transports, we will need to reuse
989
997
        # whatever connection is already established -- vila 20100929
990
 
        self.transport = transport.get_transport(self.dir)
 
998
        self.transport = transport.get_transport_from_path(self.dir)
991
999
        self._lock = lockdir.LockDir(self.transport, self.lock_name)
992
1000
 
993
1001
    def _create_from_string(self, unicode_bytes, save):
1355
1363
        e.g. "John Hacker <jhacker@example.com>"
1356
1364
        This is looked up in the email controlfile for the branch.
1357
1365
        """
1358
 
        try:
1359
 
            return (self.branch._transport.get_bytes("email")
1360
 
                    .decode(osutils.get_user_encoding())
1361
 
                    .rstrip("\r\n"))
1362
 
        except errors.NoSuchFile, e:
1363
 
            pass
1364
 
 
1365
1366
        return self._get_best_value('_get_user_id')
1366
1367
 
1367
1368
    def _get_change_editor(self):
1447
1448
        value = self._get_explicit_nickname()
1448
1449
        if value is not None:
1449
1450
            return value
 
1451
        if self.branch.name:
 
1452
            return self.branch.name
1450
1453
        return urlutils.unescape(self.branch.base.split('/')[-2])
1451
1454
 
1452
1455
    def has_explicit_nickname(self):
1489
1492
 
1490
1493
 
1491
1494
def config_dir():
1492
 
    """Return per-user configuration directory.
 
1495
    """Return per-user configuration directory as unicode string
1493
1496
 
1494
1497
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1495
1498
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1497
1500
 
1498
1501
    TODO: Global option --config-dir to override this.
1499
1502
    """
1500
 
    base = os.environ.get('BZR_HOME', None)
 
1503
    base = osutils.path_from_environ('BZR_HOME')
1501
1504
    if sys.platform == 'win32':
1502
 
        # environ variables on Windows are in user encoding/mbcs. So decode
1503
 
        # before using one
1504
 
        if base is not None:
1505
 
            base = base.decode('mbcs')
1506
 
        if base is None:
1507
 
            base = win32utils.get_appdata_location_unicode()
1508
 
        if base is None:
1509
 
            base = os.environ.get('HOME', None)
1510
 
            if base is not None:
1511
 
                base = base.decode('mbcs')
1512
 
        if base is None:
1513
 
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1514
 
                                  ' or HOME set')
 
1505
        if base is None:
 
1506
            base = win32utils.get_appdata_location()
 
1507
        if base is None:
 
1508
            base = win32utils.get_home_location()
 
1509
        # GZ 2012-02-01: Really the two level subdirs only make sense inside
 
1510
        #                APPDATA, but hard to move. See bug 348640 for more.
1515
1511
        return osutils.pathjoin(base, 'bazaar', '2.0')
1516
 
    elif sys.platform == 'darwin':
1517
 
        if base is None:
1518
 
            # this takes into account $HOME
1519
 
            base = os.path.expanduser("~")
1520
 
        return osutils.pathjoin(base, '.bazaar')
1521
 
    else:
1522
 
        if base is None:
1523
 
 
1524
 
            xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
 
1512
    if base is None:
 
1513
        # GZ 2012-02-01: What should OSX use instead of XDG if anything?
 
1514
        if sys.platform != 'darwin':
 
1515
            xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
1525
1516
            if xdg_dir is None:
1526
 
                xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
 
1517
                xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
1527
1518
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1528
1519
            if osutils.isdir(xdg_dir):
1529
1520
                trace.mutter(
1530
1521
                    "Using configuration in XDG directory %s." % xdg_dir)
1531
1522
                return xdg_dir
1532
 
 
1533
 
            base = os.path.expanduser("~")
1534
 
        return osutils.pathjoin(base, ".bazaar")
 
1523
        base = osutils._get_home_dir()
 
1524
    return osutils.pathjoin(base, ".bazaar")
1535
1525
 
1536
1526
 
1537
1527
def config_filename():
1600
1590
        f.close()
1601
1591
 
1602
1592
 
 
1593
def default_email():
 
1594
    v = os.environ.get('BZR_EMAIL')
 
1595
    if v:
 
1596
        return v.decode(osutils.get_user_encoding())
 
1597
    v = os.environ.get('EMAIL')
 
1598
    if v:
 
1599
        return v.decode(osutils.get_user_encoding())
 
1600
    name, email = _auto_user_id()
 
1601
    if name and email:
 
1602
        return u'%s <%s>' % (name, email)
 
1603
    elif email:
 
1604
        return email
 
1605
    raise errors.NoWhoami()
 
1606
 
 
1607
 
1603
1608
def _auto_user_id():
1604
1609
    """Calculate automatic user identification.
1605
1610
 
1794
1799
        :param user: login (optional)
1795
1800
 
1796
1801
        :param path: the absolute path on the server (optional)
1797
 
        
 
1802
 
1798
1803
        :param realm: the http authentication realm (optional)
1799
1804
 
1800
1805
        :return: A dict containing the matching credentials or None.
2146
2151
 
2147
2152
        It may be set to a location, or None.
2148
2153
 
2149
 
        This policy affects all branches contained by this bzrdir, except for
2150
 
        those under repositories.
 
2154
        This policy affects all branches contained by this control dir, except
 
2155
        for those under repositories.
2151
2156
        """
2152
2157
        if self._config is None:
2153
2158
            raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2161
2166
 
2162
2167
        This will either be a location, or None.
2163
2168
 
2164
 
        This policy affects all branches contained by this bzrdir, except for
2165
 
        those under repositories.
 
2169
        This policy affects all branches contained by this control dir, except
 
2170
        for those under repositories.
2166
2171
        """
2167
2172
        if self._config is None:
2168
2173
            return None
2239
2244
            return f
2240
2245
        except errors.NoSuchFile:
2241
2246
            return StringIO()
 
2247
        except errors.PermissionDenied, e:
 
2248
            trace.warning("Permission denied while trying to open "
 
2249
                "configuration file %s.", urlutils.unescape_for_display(
 
2250
                urlutils.join(self._transport.base, self._filename), "utf-8"))
 
2251
            return StringIO()
2242
2252
 
2243
2253
    def _external_url(self):
2244
2254
        return urlutils.join(self._transport.external_url(), self._filename)
2271
2281
    The option *values* are stored in config files and found in sections.
2272
2282
 
2273
2283
    Here we define various properties about the option itself, its default
2274
 
    value, in which config files it can be stored, etc (TBC).
 
2284
    value, how to convert it from stores, what to do when invalid values are
 
2285
    encoutered, in which config files it can be stored.
2275
2286
    """
2276
2287
 
2277
 
    def __init__(self, name, default=None):
 
2288
    def __init__(self, name, override_from_env=None,
 
2289
                 default=None, default_from_env=None,
 
2290
                 help=None, from_unicode=None, invalid=None, unquote=True):
 
2291
        """Build an option definition.
 
2292
 
 
2293
        :param name: the name used to refer to the option.
 
2294
 
 
2295
        :param override_from_env: A list of environment variables which can
 
2296
           provide override any configuration setting.
 
2297
 
 
2298
        :param default: the default value to use when none exist in the config
 
2299
            stores. This is either a string that ``from_unicode`` will convert
 
2300
            into the proper type, a callable returning a unicode string so that
 
2301
            ``from_unicode`` can be used on the return value, or a python
 
2302
            object that can be stringified (so only the empty list is supported
 
2303
            for example).
 
2304
 
 
2305
        :param default_from_env: A list of environment variables which can
 
2306
           provide a default value. 'default' will be used only if none of the
 
2307
           variables specified here are set in the environment.
 
2308
 
 
2309
        :param help: a doc string to explain the option to the user.
 
2310
 
 
2311
        :param from_unicode: a callable to convert the unicode string
 
2312
            representing the option value in a store. This is not called for
 
2313
            the default value.
 
2314
 
 
2315
        :param invalid: the action to be taken when an invalid value is
 
2316
            encountered in a store. This is called only when from_unicode is
 
2317
            invoked to convert a string and returns None or raise ValueError or
 
2318
            TypeError. Accepted values are: None (ignore invalid values),
 
2319
            'warning' (emit a warning), 'error' (emit an error message and
 
2320
            terminates).
 
2321
 
 
2322
        :param unquote: should the unicode value be unquoted before conversion.
 
2323
           This should be used only when the store providing the values cannot
 
2324
           safely unquote them (see http://pad.lv/906897). It is provided so
 
2325
           daughter classes can handle the quoting themselves.
 
2326
        """
 
2327
        if override_from_env is None:
 
2328
            override_from_env = []
 
2329
        if default_from_env is None:
 
2330
            default_from_env = []
2278
2331
        self.name = name
2279
 
        self.default = default
 
2332
        self.override_from_env = override_from_env
 
2333
        # Convert the default value to a unicode string so all values are
 
2334
        # strings internally before conversion (via from_unicode) is attempted.
 
2335
        if default is None:
 
2336
            self.default = None
 
2337
        elif isinstance(default, list):
 
2338
            # Only the empty list is supported
 
2339
            if default:
 
2340
                raise AssertionError(
 
2341
                    'Only empty lists are supported as default values')
 
2342
            self.default = u','
 
2343
        elif isinstance(default, (str, unicode, bool, int, float)):
 
2344
            # Rely on python to convert strings, booleans and integers
 
2345
            self.default = u'%s' % (default,)
 
2346
        elif callable(default):
 
2347
            self.default = default
 
2348
        else:
 
2349
            # other python objects are not expected
 
2350
            raise AssertionError('%r is not supported as a default value'
 
2351
                                 % (default,))
 
2352
        self.default_from_env = default_from_env
 
2353
        self._help = help
 
2354
        self.from_unicode = from_unicode
 
2355
        self.unquote = unquote
 
2356
        if invalid and invalid not in ('warning', 'error'):
 
2357
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
 
2358
        self.invalid = invalid
 
2359
 
 
2360
    @property
 
2361
    def help(self):
 
2362
        return self._help
 
2363
 
 
2364
    def convert_from_unicode(self, store, unicode_value):
 
2365
        if self.unquote and store is not None and unicode_value is not None:
 
2366
            unicode_value = store.unquote(unicode_value)
 
2367
        if self.from_unicode is None or unicode_value is None:
 
2368
            # Don't convert or nothing to convert
 
2369
            return unicode_value
 
2370
        try:
 
2371
            converted = self.from_unicode(unicode_value)
 
2372
        except (ValueError, TypeError):
 
2373
            # Invalid values are ignored
 
2374
            converted = None
 
2375
        if converted is None and self.invalid is not None:
 
2376
            # The conversion failed
 
2377
            if self.invalid == 'warning':
 
2378
                trace.warning('Value "%s" is not valid for "%s"',
 
2379
                              unicode_value, self.name)
 
2380
            elif self.invalid == 'error':
 
2381
                raise errors.ConfigOptionValueError(self.name, unicode_value)
 
2382
        return converted
 
2383
 
 
2384
    def get_override(self):
 
2385
        value = None
 
2386
        for var in self.override_from_env:
 
2387
            try:
 
2388
                # If the env variable is defined, its value takes precedence
 
2389
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2390
                break
 
2391
            except KeyError:
 
2392
                continue
 
2393
        return value
2280
2394
 
2281
2395
    def get_default(self):
2282
 
        return self.default
2283
 
 
2284
 
 
2285
 
# Options registry
2286
 
 
2287
 
option_registry = registry.Registry()
2288
 
 
2289
 
 
2290
 
option_registry.register(
2291
 
    'editor', Option('editor'),
2292
 
    help='The command called to launch an editor to enter a message.')
 
2396
        value = None
 
2397
        for var in self.default_from_env:
 
2398
            try:
 
2399
                # If the env variable is defined, its value is the default one
 
2400
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2401
                break
 
2402
            except KeyError:
 
2403
                continue
 
2404
        if value is None:
 
2405
            # Otherwise, fallback to the value defined at registration
 
2406
            if callable(self.default):
 
2407
                value = self.default()
 
2408
                if not isinstance(value, unicode):
 
2409
                    raise AssertionError(
 
2410
                    'Callable default values should be unicode')
 
2411
            else:
 
2412
                value = self.default
 
2413
        return value
 
2414
 
 
2415
    def get_help_topic(self):
 
2416
        return self.name
 
2417
 
 
2418
    def get_help_text(self, additional_see_also=None, plain=True):
 
2419
        result = self.help
 
2420
        from bzrlib import help_topics
 
2421
        result += help_topics._format_see_also(additional_see_also)
 
2422
        if plain:
 
2423
            result = help_topics.help_as_plain_text(result)
 
2424
        return result
 
2425
 
 
2426
 
 
2427
# Predefined converters to get proper values from store
 
2428
 
 
2429
def bool_from_store(unicode_str):
 
2430
    return ui.bool_from_string(unicode_str)
 
2431
 
 
2432
 
 
2433
def int_from_store(unicode_str):
 
2434
    return int(unicode_str)
 
2435
 
 
2436
 
 
2437
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
 
2438
 
 
2439
def int_SI_from_store(unicode_str):
 
2440
    """Convert a human readable size in SI units, e.g 10MB into an integer.
 
2441
 
 
2442
    Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
2443
    by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
2444
    pedantic.
 
2445
 
 
2446
    :return Integer, expanded to its base-10 value if a proper SI unit is 
 
2447
        found, None otherwise.
 
2448
    """
 
2449
    regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
 
2450
    p = re.compile(regexp, re.IGNORECASE)
 
2451
    m = p.match(unicode_str)
 
2452
    val = None
 
2453
    if m is not None:
 
2454
        val, _, unit = m.groups()
 
2455
        val = int(val)
 
2456
        if unit:
 
2457
            try:
 
2458
                coeff = _unit_suffixes[unit.upper()]
 
2459
            except KeyError:
 
2460
                raise ValueError(gettext('{0} is not an SI unit.').format(unit))
 
2461
            val *= coeff
 
2462
    return val
 
2463
 
 
2464
 
 
2465
def float_from_store(unicode_str):
 
2466
    return float(unicode_str)
 
2467
 
 
2468
 
 
2469
# Use a an empty dict to initialize an empty configobj avoiding all
 
2470
# parsing and encoding checks
 
2471
_list_converter_config = configobj.ConfigObj(
 
2472
    {}, encoding='utf-8', list_values=True, interpolation=False)
 
2473
 
 
2474
 
 
2475
class ListOption(Option):
 
2476
 
 
2477
    def __init__(self, name, default=None, default_from_env=None,
 
2478
                 help=None, invalid=None):
 
2479
        """A list Option definition.
 
2480
 
 
2481
        This overrides the base class so the conversion from a unicode string
 
2482
        can take quoting into account.
 
2483
        """
 
2484
        super(ListOption, self).__init__(
 
2485
            name, default=default, default_from_env=default_from_env,
 
2486
            from_unicode=self.from_unicode, help=help,
 
2487
            invalid=invalid, unquote=False)
 
2488
 
 
2489
    def from_unicode(self, unicode_str):
 
2490
        if not isinstance(unicode_str, basestring):
 
2491
            raise TypeError
 
2492
        # Now inject our string directly as unicode. All callers got their
 
2493
        # value from configobj, so values that need to be quoted are already
 
2494
        # properly quoted.
 
2495
        _list_converter_config.reset()
 
2496
        _list_converter_config._parse([u"list=%s" % (unicode_str,)])
 
2497
        maybe_list = _list_converter_config['list']
 
2498
        if isinstance(maybe_list, basestring):
 
2499
            if maybe_list:
 
2500
                # A single value, most probably the user forgot (or didn't care
 
2501
                # to add) the final ','
 
2502
                l = [maybe_list]
 
2503
            else:
 
2504
                # The empty string, convert to empty list
 
2505
                l = []
 
2506
        else:
 
2507
            # We rely on ConfigObj providing us with a list already
 
2508
            l = maybe_list
 
2509
        return l
 
2510
 
 
2511
 
 
2512
class RegistryOption(Option):
 
2513
    """Option for a choice from a registry."""
 
2514
 
 
2515
    def __init__(self, name, registry, default_from_env=None,
 
2516
                 help=None, invalid=None):
 
2517
        """A registry based Option definition.
 
2518
 
 
2519
        This overrides the base class so the conversion from a unicode string
 
2520
        can take quoting into account.
 
2521
        """
 
2522
        super(RegistryOption, self).__init__(
 
2523
            name, default=lambda: unicode(registry.default_key),
 
2524
            default_from_env=default_from_env,
 
2525
            from_unicode=self.from_unicode, help=help,
 
2526
            invalid=invalid, unquote=False)
 
2527
        self.registry = registry
 
2528
 
 
2529
    def from_unicode(self, unicode_str):
 
2530
        if not isinstance(unicode_str, basestring):
 
2531
            raise TypeError
 
2532
        try:
 
2533
            return self.registry.get(unicode_str)
 
2534
        except KeyError:
 
2535
            raise ValueError(
 
2536
                "Invalid value %s for %s."
 
2537
                "See help for a list of possible values." % (unicode_str,
 
2538
                    self.name))
 
2539
 
 
2540
    @property
 
2541
    def help(self):
 
2542
        ret = [self._help, "\n\nThe following values are supported:\n"]
 
2543
        for key in self.registry.keys():
 
2544
            ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
 
2545
        return "".join(ret)
 
2546
 
 
2547
 
 
2548
class OptionRegistry(registry.Registry):
 
2549
    """Register config options by their name.
 
2550
 
 
2551
    This overrides ``registry.Registry`` to simplify registration by acquiring
 
2552
    some information from the option object itself.
 
2553
    """
 
2554
 
 
2555
    def register(self, option):
 
2556
        """Register a new option to its name.
 
2557
 
 
2558
        :param option: The option to register. Its name is used as the key.
 
2559
        """
 
2560
        super(OptionRegistry, self).register(option.name, option,
 
2561
                                             help=option.help)
 
2562
 
 
2563
    def register_lazy(self, key, module_name, member_name):
 
2564
        """Register a new option to be loaded on request.
 
2565
 
 
2566
        :param key: the key to request the option later. Since the registration
 
2567
            is lazy, it should be provided and match the option name.
 
2568
 
 
2569
        :param module_name: the python path to the module. Such as 'os.path'.
 
2570
 
 
2571
        :param member_name: the member of the module to return.  If empty or 
 
2572
                None, get() will return the module itself.
 
2573
        """
 
2574
        super(OptionRegistry, self).register_lazy(key,
 
2575
                                                  module_name, member_name)
 
2576
 
 
2577
    def get_help(self, key=None):
 
2578
        """Get the help text associated with the given key"""
 
2579
        option = self.get(key)
 
2580
        the_help = option.help
 
2581
        if callable(the_help):
 
2582
            return the_help(self, key)
 
2583
        return the_help
 
2584
 
 
2585
 
 
2586
option_registry = OptionRegistry()
 
2587
 
 
2588
 
 
2589
# Registered options in lexicographical order
 
2590
 
 
2591
option_registry.register(
 
2592
    Option('append_revisions_only',
 
2593
           default=None, from_unicode=bool_from_store, invalid='warning',
 
2594
           help='''\
 
2595
Whether to only append revisions to the mainline.
 
2596
 
 
2597
If this is set to true, then it is not possible to change the
 
2598
existing mainline of the branch.
 
2599
'''))
 
2600
option_registry.register(
 
2601
    ListOption('acceptable_keys',
 
2602
           default=None,
 
2603
           help="""\
 
2604
List of GPG key patterns which are acceptable for verification.
 
2605
"""))
 
2606
option_registry.register(
 
2607
    Option('add.maximum_file_size',
 
2608
           default=u'20MB', from_unicode=int_SI_from_store,
 
2609
           help="""\
 
2610
Size above which files should be added manually.
 
2611
 
 
2612
Files below this size are added automatically when using ``bzr add`` without
 
2613
arguments.
 
2614
 
 
2615
A negative value means disable the size check.
 
2616
"""))
 
2617
option_registry.register(
 
2618
    Option('bound',
 
2619
           default=None, from_unicode=bool_from_store,
 
2620
           help="""\
 
2621
Is the branch bound to ``bound_location``.
 
2622
 
 
2623
If set to "True", the branch should act as a checkout, and push each commit to
 
2624
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
2625
 
 
2626
See also: bound_location.
 
2627
"""))
 
2628
option_registry.register(
 
2629
    Option('bound_location',
 
2630
           default=None,
 
2631
           help="""\
 
2632
The location that commits should go to when acting as a checkout.
 
2633
 
 
2634
This option is normally set by ``bind``.
 
2635
 
 
2636
See also: bound.
 
2637
"""))
 
2638
option_registry.register(
 
2639
    Option('branch.fetch_tags', default=False,  from_unicode=bool_from_store,
 
2640
           help="""\
 
2641
Whether revisions associated with tags should be fetched.
 
2642
"""))
 
2643
option_registry.register_lazy(
 
2644
    'bzr.transform.orphan_policy', 'bzrlib.transform', 'opt_transform_orphan')
 
2645
option_registry.register(
 
2646
    Option('bzr.workingtree.worth_saving_limit', default=10,
 
2647
           from_unicode=int_from_store,  invalid='warning',
 
2648
           help='''\
 
2649
How many changes before saving the dirstate.
 
2650
 
 
2651
-1 means that we will never rewrite the dirstate file for only
 
2652
stat-cache changes. Regardless of this setting, we will always rewrite
 
2653
the dirstate file if a file is added/removed/renamed/etc. This flag only
 
2654
affects the behavior of updating the dirstate file after we notice that
 
2655
a file has been touched.
 
2656
'''))
 
2657
option_registry.register(
 
2658
    Option('bugtracker', default=None,
 
2659
           help='''\
 
2660
Default bug tracker to use.
 
2661
 
 
2662
This bug tracker will be used for example when marking bugs
 
2663
as fixed using ``bzr commit --fixes``, if no explicit
 
2664
bug tracker was specified.
 
2665
'''))
 
2666
option_registry.register(
 
2667
    Option('check_signatures', default=CHECK_IF_POSSIBLE,
 
2668
           from_unicode=signature_policy_from_unicode,
 
2669
           help='''\
 
2670
GPG checking policy.
 
2671
 
 
2672
Possible values: require, ignore, check-available (default)
 
2673
 
 
2674
this option will control whether bzr will require good gpg
 
2675
signatures, ignore them, or check them if they are
 
2676
present.
 
2677
'''))
 
2678
option_registry.register(
 
2679
    Option('child_submit_format',
 
2680
           help='''The preferred format of submissions to this branch.'''))
 
2681
option_registry.register(
 
2682
    Option('child_submit_to',
 
2683
           help='''Where submissions to this branch are mailed to.'''))
 
2684
option_registry.register(
 
2685
    Option('create_signatures', default=SIGN_WHEN_REQUIRED,
 
2686
           from_unicode=signing_policy_from_unicode,
 
2687
           help='''\
 
2688
GPG Signing policy.
 
2689
 
 
2690
Possible values: always, never, when-required (default)
 
2691
 
 
2692
This option controls whether bzr will always create
 
2693
gpg signatures or not on commits.
 
2694
'''))
 
2695
option_registry.register(
 
2696
    Option('dirstate.fdatasync', default=True,
 
2697
           from_unicode=bool_from_store,
 
2698
           help='''\
 
2699
Flush dirstate changes onto physical disk?
 
2700
 
 
2701
If true (default), working tree metadata changes are flushed through the
 
2702
OS buffers to physical disk.  This is somewhat slower, but means data
 
2703
should not be lost if the machine crashes.  See also repository.fdatasync.
 
2704
'''))
 
2705
option_registry.register(
 
2706
    ListOption('debug_flags', default=[],
 
2707
           help='Debug flags to activate.'))
 
2708
option_registry.register(
 
2709
    Option('default_format', default='2a',
 
2710
           help='Format used when creating branches.'))
 
2711
option_registry.register(
 
2712
    Option('dpush_strict', default=None,
 
2713
           from_unicode=bool_from_store,
 
2714
           help='''\
 
2715
The default value for ``dpush --strict``.
 
2716
 
 
2717
If present, defines the ``--strict`` option default value for checking
 
2718
uncommitted changes before pushing into a different VCS without any
 
2719
custom bzr metadata.
 
2720
'''))
 
2721
option_registry.register(
 
2722
    Option('editor',
 
2723
           help='The command called to launch an editor to enter a message.'))
 
2724
option_registry.register(
 
2725
    Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
 
2726
           help='The users identity'))
 
2727
option_registry.register(
 
2728
    Option('gpg_signing_command',
 
2729
           default='gpg',
 
2730
           help="""\
 
2731
Program to use use for creating signatures.
 
2732
 
 
2733
This should support at least the -u and --clearsign options.
 
2734
"""))
 
2735
option_registry.register(
 
2736
    Option('gpg_signing_key',
 
2737
           default=None,
 
2738
           help="""\
 
2739
GPG key to use for signing.
 
2740
 
 
2741
This defaults to the first key associated with the users email.
 
2742
"""))
 
2743
option_registry.register(
 
2744
    Option('ignore_missing_extensions', default=False,
 
2745
           from_unicode=bool_from_store,
 
2746
           help='''\
 
2747
Control the missing extensions warning display.
 
2748
 
 
2749
The warning will not be emitted if set to True.
 
2750
'''))
 
2751
option_registry.register(
 
2752
    Option('language',
 
2753
           help='Language to translate messages into.'))
 
2754
option_registry.register(
 
2755
    Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
 
2756
           help='''\
 
2757
Steal locks that appears to be dead.
 
2758
 
 
2759
If set to True, bzr will check if a lock is supposed to be held by an
 
2760
active process from the same user on the same machine. If the user and
 
2761
machine match, but no process with the given PID is active, then bzr
 
2762
will automatically break the stale lock, and create a new lock for
 
2763
this process.
 
2764
Otherwise, bzr will prompt as normal to break the lock.
 
2765
'''))
 
2766
option_registry.register(
 
2767
    Option('log_format', default='long',
 
2768
           help= '''\
 
2769
Log format to use when displaying revisions.
 
2770
 
 
2771
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
 
2772
may be provided by plugins.
 
2773
'''))
 
2774
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
 
2775
    'opt_mail_client')
 
2776
option_registry.register(
 
2777
    Option('output_encoding',
 
2778
           help= 'Unicode encoding for output'
 
2779
           ' (terminal encoding if not specified).'))
 
2780
option_registry.register(
 
2781
    Option('parent_location',
 
2782
           default=None,
 
2783
           help="""\
 
2784
The location of the default branch for pull or merge.
 
2785
 
 
2786
This option is normally set when creating a branch, the first ``pull`` or by
 
2787
``pull --remember``.
 
2788
"""))
 
2789
option_registry.register(
 
2790
    Option('post_commit', default=None,
 
2791
           help='''\
 
2792
Post commit functions.
 
2793
 
 
2794
An ordered list of python functions to call, separated by spaces.
 
2795
 
 
2796
Each function takes branch, rev_id as parameters.
 
2797
'''))
 
2798
option_registry.register(
 
2799
    Option('public_branch',
 
2800
           default=None,
 
2801
           help="""\
 
2802
A publically-accessible version of this branch.
 
2803
 
 
2804
This implies that the branch setting this option is not publically-accessible.
 
2805
Used and set by ``bzr send``.
 
2806
"""))
 
2807
option_registry.register(
 
2808
    Option('push_location',
 
2809
           default=None,
 
2810
           help="""\
 
2811
The location of the default branch for push.
 
2812
 
 
2813
This option is normally set by the first ``push`` or ``push --remember``.
 
2814
"""))
 
2815
option_registry.register(
 
2816
    Option('push_strict', default=None,
 
2817
           from_unicode=bool_from_store,
 
2818
           help='''\
 
2819
The default value for ``push --strict``.
 
2820
 
 
2821
If present, defines the ``--strict`` option default value for checking
 
2822
uncommitted changes before sending a merge directive.
 
2823
'''))
 
2824
option_registry.register(
 
2825
    Option('repository.fdatasync', default=True,
 
2826
           from_unicode=bool_from_store,
 
2827
           help='''\
 
2828
Flush repository changes onto physical disk?
 
2829
 
 
2830
If true (default), repository changes are flushed through the OS buffers
 
2831
to physical disk.  This is somewhat slower, but means data should not be
 
2832
lost if the machine crashes.  See also dirstate.fdatasync.
 
2833
'''))
 
2834
option_registry.register_lazy('smtp_server',
 
2835
    'bzrlib.smtp_connection', 'smtp_server')
 
2836
option_registry.register_lazy('smtp_password',
 
2837
    'bzrlib.smtp_connection', 'smtp_password')
 
2838
option_registry.register_lazy('smtp_username',
 
2839
    'bzrlib.smtp_connection', 'smtp_username')
 
2840
option_registry.register(
 
2841
    Option('selftest.timeout',
 
2842
        default='600',
 
2843
        from_unicode=int_from_store,
 
2844
        help='Abort selftest if one test takes longer than this many seconds',
 
2845
        ))
 
2846
 
 
2847
option_registry.register(
 
2848
    Option('send_strict', default=None,
 
2849
           from_unicode=bool_from_store,
 
2850
           help='''\
 
2851
The default value for ``send --strict``.
 
2852
 
 
2853
If present, defines the ``--strict`` option default value for checking
 
2854
uncommitted changes before sending a bundle.
 
2855
'''))
 
2856
 
 
2857
option_registry.register(
 
2858
    Option('serve.client_timeout',
 
2859
           default=300.0, from_unicode=float_from_store,
 
2860
           help="If we wait for a new request from a client for more than"
 
2861
                " X seconds, consider the client idle, and hangup."))
 
2862
option_registry.register(
 
2863
    Option('stacked_on_location',
 
2864
           default=None,
 
2865
           help="""The location where this branch is stacked on."""))
 
2866
option_registry.register(
 
2867
    Option('submit_branch',
 
2868
           default=None,
 
2869
           help="""\
 
2870
The branch you intend to submit your current work to.
 
2871
 
 
2872
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
 
2873
by the ``submit:`` revision spec.
 
2874
"""))
 
2875
option_registry.register(
 
2876
    Option('submit_to',
 
2877
           help='''Where submissions from this branch are mailed to.'''))
 
2878
option_registry.register(
 
2879
    ListOption('suppress_warnings',
 
2880
           default=[],
 
2881
           help="List of warning classes to suppress."))
 
2882
option_registry.register(
 
2883
    Option('validate_signatures_in_log', default=False,
 
2884
           from_unicode=bool_from_store, invalid='warning',
 
2885
           help='''Whether to validate signatures in bzr log.'''))
 
2886
option_registry.register_lazy('ssl.ca_certs',
 
2887
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
 
2888
 
 
2889
option_registry.register_lazy('ssl.cert_reqs',
 
2890
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2293
2891
 
2294
2892
 
2295
2893
class Section(object):
2305
2903
        # We re-use the dict-like object received
2306
2904
        self.options = options
2307
2905
 
2308
 
    def get(self, name, default=None):
 
2906
    def get(self, name, default=None, expand=True):
2309
2907
        return self.options.get(name, default)
2310
2908
 
 
2909
    def iter_option_names(self):
 
2910
        for k in self.options.iterkeys():
 
2911
            yield k
 
2912
 
2311
2913
    def __repr__(self):
2312
2914
        # Mostly for debugging use
2313
2915
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2315
2917
 
2316
2918
_NewlyCreatedOption = object()
2317
2919
"""Was the option created during the MutableSection lifetime"""
 
2920
_DeletedOption = object()
 
2921
"""Was the option deleted during the MutableSection lifetime"""
2318
2922
 
2319
2923
 
2320
2924
class MutableSection(Section):
2322
2926
 
2323
2927
    def __init__(self, section_id, options):
2324
2928
        super(MutableSection, self).__init__(section_id, options)
2325
 
        self.orig = {}
 
2929
        self.reset_changes()
2326
2930
 
2327
2931
    def set(self, name, value):
2328
2932
        if name not in self.options:
2337
2941
            self.orig[name] = self.get(name, None)
2338
2942
        del self.options[name]
2339
2943
 
 
2944
    def reset_changes(self):
 
2945
        self.orig = {}
 
2946
 
 
2947
    def apply_changes(self, dirty, store):
 
2948
        """Apply option value changes.
 
2949
 
 
2950
        ``self`` has been reloaded from the persistent storage. ``dirty``
 
2951
        contains the changes made since the previous loading.
 
2952
 
 
2953
        :param dirty: the mutable section containing the changes.
 
2954
 
 
2955
        :param store: the store containing the section
 
2956
        """
 
2957
        for k, expected in dirty.orig.iteritems():
 
2958
            actual = dirty.get(k, _DeletedOption)
 
2959
            reloaded = self.get(k, _NewlyCreatedOption)
 
2960
            if actual is _DeletedOption:
 
2961
                if k in self.options:
 
2962
                    self.remove(k)
 
2963
            else:
 
2964
                self.set(k, actual)
 
2965
            # Report concurrent updates in an ad-hoc way. This should only
 
2966
            # occurs when different processes try to update the same option
 
2967
            # which is not supported (as in: the config framework is not meant
 
2968
            # to be used a sharing mechanism).
 
2969
            if expected != reloaded:
 
2970
                if actual is _DeletedOption:
 
2971
                    actual = '<DELETED>'
 
2972
                if reloaded is _NewlyCreatedOption:
 
2973
                    reloaded = '<CREATED>'
 
2974
                if expected is _NewlyCreatedOption:
 
2975
                    expected = '<CREATED>'
 
2976
                # Someone changed the value since we get it from the persistent
 
2977
                # storage.
 
2978
                trace.warning(gettext(
 
2979
                        "Option {0} in section {1} of {2} was changed"
 
2980
                        " from {3} to {4}. The {5} value will be saved.".format(
 
2981
                            k, self.id, store.external_url(), expected,
 
2982
                            reloaded, actual)))
 
2983
        # No need to keep track of these changes
 
2984
        self.reset_changes()
 
2985
 
2340
2986
 
2341
2987
class Store(object):
2342
2988
    """Abstract interface to persistent storage for configuration options."""
2344
2990
    readonly_section_class = Section
2345
2991
    mutable_section_class = MutableSection
2346
2992
 
 
2993
    def __init__(self):
 
2994
        # Which sections need to be saved
 
2995
        self.dirty_sections = []
 
2996
 
2347
2997
    def is_loaded(self):
2348
2998
        """Returns True if the Store has been loaded.
2349
2999
 
2372
3022
        """
2373
3023
        raise NotImplementedError(self.unload)
2374
3024
 
 
3025
    def quote(self, value):
 
3026
        """Quote a configuration option value for storing purposes.
 
3027
 
 
3028
        This allows Stacks to present values as they will be stored.
 
3029
        """
 
3030
        return value
 
3031
 
 
3032
    def unquote(self, value):
 
3033
        """Unquote a configuration option value into unicode.
 
3034
 
 
3035
        The received value is quoted as stored.
 
3036
        """
 
3037
        return value
 
3038
 
2375
3039
    def save(self):
2376
3040
        """Saves the Store to persistent storage."""
2377
3041
        raise NotImplementedError(self.save)
2378
3042
 
 
3043
    def _need_saving(self):
 
3044
        for s in self.dirty_sections:
 
3045
            if s.orig:
 
3046
                # At least one dirty section contains a modification
 
3047
                return True
 
3048
        return False
 
3049
 
 
3050
    def apply_changes(self, dirty_sections):
 
3051
        """Apply changes from dirty sections while checking for coherency.
 
3052
 
 
3053
        The Store content is discarded and reloaded from persistent storage to
 
3054
        acquire up-to-date values.
 
3055
 
 
3056
        Dirty sections are MutableSection which kept track of the value they
 
3057
        are expected to update.
 
3058
        """
 
3059
        # We need an up-to-date version from the persistent storage, unload the
 
3060
        # store. The reload will occur when needed (triggered by the first
 
3061
        # get_mutable_section() call below.
 
3062
        self.unload()
 
3063
        # Apply the changes from the preserved dirty sections
 
3064
        for dirty in dirty_sections:
 
3065
            clean = self.get_mutable_section(dirty.id)
 
3066
            clean.apply_changes(dirty, self)
 
3067
        # Everything is clean now
 
3068
        self.dirty_sections = []
 
3069
 
 
3070
    def save_changes(self):
 
3071
        """Saves the Store to persistent storage if changes occurred.
 
3072
 
 
3073
        Apply the changes recorded in the mutable sections to a store content
 
3074
        refreshed from persistent storage.
 
3075
        """
 
3076
        raise NotImplementedError(self.save_changes)
 
3077
 
2379
3078
    def external_url(self):
2380
3079
        raise NotImplementedError(self.external_url)
2381
3080
 
2382
3081
    def get_sections(self):
2383
3082
        """Returns an ordered iterable of existing sections.
2384
3083
 
2385
 
        :returns: An iterable of (name, dict).
 
3084
        :returns: An iterable of (store, section).
2386
3085
        """
2387
3086
        raise NotImplementedError(self.get_sections)
2388
3087
 
2389
 
    def get_mutable_section(self, section_name=None):
 
3088
    def get_mutable_section(self, section_id=None):
2390
3089
        """Returns the specified mutable section.
2391
3090
 
2392
 
        :param section_name: The section identifier
 
3091
        :param section_id: The section identifier
2393
3092
        """
2394
3093
        raise NotImplementedError(self.get_mutable_section)
2395
3094
 
2399
3098
                                    self.external_url())
2400
3099
 
2401
3100
 
 
3101
class CommandLineStore(Store):
 
3102
    "A store to carry command line overrides for the config options."""
 
3103
 
 
3104
    def __init__(self, opts=None):
 
3105
        super(CommandLineStore, self).__init__()
 
3106
        if opts is None:
 
3107
            opts = {}
 
3108
        self.options = {}
 
3109
        self.id = 'cmdline'
 
3110
 
 
3111
    def _reset(self):
 
3112
        # The dict should be cleared but not replaced so it can be shared.
 
3113
        self.options.clear()
 
3114
 
 
3115
    def _from_cmdline(self, overrides):
 
3116
        # Reset before accepting new definitions
 
3117
        self._reset()
 
3118
        for over in overrides:
 
3119
            try:
 
3120
                name, value = over.split('=', 1)
 
3121
            except ValueError:
 
3122
                raise errors.BzrCommandError(
 
3123
                    gettext("Invalid '%s', should be of the form 'name=value'")
 
3124
                    % (over,))
 
3125
            self.options[name] = value
 
3126
 
 
3127
    def external_url(self):
 
3128
        # Not an url but it makes debugging easier and is never needed
 
3129
        # otherwise
 
3130
        return 'cmdline'
 
3131
 
 
3132
    def get_sections(self):
 
3133
        yield self,  self.readonly_section_class(None, self.options)
 
3134
 
 
3135
 
2402
3136
class IniFileStore(Store):
2403
3137
    """A config Store using ConfigObj for storage.
2404
3138
 
2405
 
    :ivar transport: The transport object where the config file is located.
2406
 
 
2407
 
    :ivar file_name: The config file basename in the transport directory.
2408
 
 
2409
3139
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
2410
3140
        serialize/deserialize the config file.
2411
3141
    """
2412
3142
 
2413
 
    def __init__(self, transport, file_name):
 
3143
    def __init__(self):
2414
3144
        """A config Store using ConfigObj for storage.
2415
 
 
2416
 
        :param transport: The transport object where the config file is located.
2417
 
 
2418
 
        :param file_name: The config file basename in the transport directory.
2419
3145
        """
2420
3146
        super(IniFileStore, self).__init__()
2421
 
        self.transport = transport
2422
 
        self.file_name = file_name
2423
3147
        self._config_obj = None
2424
3148
 
2425
3149
    def is_loaded(self):
2427
3151
 
2428
3152
    def unload(self):
2429
3153
        self._config_obj = None
 
3154
        self.dirty_sections = []
 
3155
 
 
3156
    def _load_content(self):
 
3157
        """Load the config file bytes.
 
3158
 
 
3159
        This should be provided by subclasses
 
3160
 
 
3161
        :return: Byte string
 
3162
        """
 
3163
        raise NotImplementedError(self._load_content)
 
3164
 
 
3165
    def _save_content(self, content):
 
3166
        """Save the config file bytes.
 
3167
 
 
3168
        This should be provided by subclasses
 
3169
 
 
3170
        :param content: Config file bytes to write
 
3171
        """
 
3172
        raise NotImplementedError(self._save_content)
2430
3173
 
2431
3174
    def load(self):
2432
3175
        """Load the store from the associated file."""
2433
3176
        if self.is_loaded():
2434
3177
            return
2435
 
        content = self.transport.get_bytes(self.file_name)
 
3178
        content = self._load_content()
2436
3179
        self._load_from_string(content)
2437
3180
        for hook in ConfigHooks['load']:
2438
3181
            hook(self)
2447
3190
        co_input = StringIO(bytes)
2448
3191
        try:
2449
3192
            # The config files are always stored utf8-encoded
2450
 
            self._config_obj = ConfigObj(co_input, encoding='utf-8')
 
3193
            self._config_obj = ConfigObj(co_input, encoding='utf-8',
 
3194
                                         list_values=False)
2451
3195
        except configobj.ConfigObjError, e:
2452
3196
            self._config_obj = None
2453
3197
            raise errors.ParseConfigError(e.errors, self.external_url())
2454
3198
        except UnicodeDecodeError:
2455
3199
            raise errors.ConfigContentError(self.external_url())
2456
3200
 
 
3201
    def save_changes(self):
 
3202
        if not self.is_loaded():
 
3203
            # Nothing to save
 
3204
            return
 
3205
        if not self._need_saving():
 
3206
            return
 
3207
        # Preserve the current version
 
3208
        current = self._config_obj
 
3209
        dirty_sections = list(self.dirty_sections)
 
3210
        self.apply_changes(dirty_sections)
 
3211
        # Save to the persistent storage
 
3212
        self.save()
 
3213
 
2457
3214
    def save(self):
2458
3215
        if not self.is_loaded():
2459
3216
            # Nothing to save
2460
3217
            return
2461
3218
        out = StringIO()
2462
3219
        self._config_obj.write(out)
2463
 
        self.transport.put_bytes(self.file_name, out.getvalue())
 
3220
        self._save_content(out.getvalue())
2464
3221
        for hook in ConfigHooks['save']:
2465
3222
            hook(self)
2466
3223
 
2467
 
    def external_url(self):
2468
 
        # FIXME: external_url should really accepts an optional relpath
2469
 
        # parameter (bug #750169) :-/ -- vila 2011-04-04
2470
 
        # The following will do in the interim but maybe we don't want to
2471
 
        # expose a path here but rather a config ID and its associated
2472
 
        # object </hand wawe>.
2473
 
        return urlutils.join(self.transport.external_url(), self.file_name)
2474
 
 
2475
3224
    def get_sections(self):
2476
3225
        """Get the configobj section in the file order.
2477
3226
 
2478
 
        :returns: An iterable of (name, dict).
 
3227
        :returns: An iterable of (store, section).
2479
3228
        """
2480
3229
        # We need a loaded store
2481
3230
        try:
2482
3231
            self.load()
2483
 
        except errors.NoSuchFile:
2484
 
            # If the file doesn't exist, there is no sections
 
3232
        except (errors.NoSuchFile, errors.PermissionDenied):
 
3233
            # If the file can't be read, there is no sections
2485
3234
            return
2486
3235
        cobj = self._config_obj
2487
3236
        if cobj.scalars:
2488
 
            yield self.readonly_section_class(None, cobj)
 
3237
            yield self, self.readonly_section_class(None, cobj)
2489
3238
        for section_name in cobj.sections:
2490
 
            yield self.readonly_section_class(section_name, cobj[section_name])
 
3239
            yield (self,
 
3240
                   self.readonly_section_class(section_name,
 
3241
                                               cobj[section_name]))
2491
3242
 
2492
 
    def get_mutable_section(self, section_name=None):
 
3243
    def get_mutable_section(self, section_id=None):
2493
3244
        # We need a loaded store
2494
3245
        try:
2495
3246
            self.load()
2496
3247
        except errors.NoSuchFile:
2497
3248
            # The file doesn't exist, let's pretend it was empty
2498
3249
            self._load_from_string('')
2499
 
        if section_name is None:
 
3250
        if section_id is None:
2500
3251
            section = self._config_obj
2501
3252
        else:
2502
 
            section = self._config_obj.setdefault(section_name, {})
2503
 
        return self.mutable_section_class(section_name, section)
 
3253
            section = self._config_obj.setdefault(section_id, {})
 
3254
        mutable_section = self.mutable_section_class(section_id, section)
 
3255
        # All mutable sections can become dirty
 
3256
        self.dirty_sections.append(mutable_section)
 
3257
        return mutable_section
 
3258
 
 
3259
    def quote(self, value):
 
3260
        try:
 
3261
            # configobj conflates automagical list values and quoting
 
3262
            self._config_obj.list_values = True
 
3263
            return self._config_obj._quote(value)
 
3264
        finally:
 
3265
            self._config_obj.list_values = False
 
3266
 
 
3267
    def unquote(self, value):
 
3268
        if value and isinstance(value, basestring):
 
3269
            # _unquote doesn't handle None nor empty strings nor anything that
 
3270
            # is not a string, really.
 
3271
            value = self._config_obj._unquote(value)
 
3272
        return value
 
3273
 
 
3274
    def external_url(self):
 
3275
        # Since an IniFileStore can be used without a file (at least in tests),
 
3276
        # it's better to provide something than raising a NotImplementedError.
 
3277
        # All daughter classes are supposed to provide an implementation
 
3278
        # anyway.
 
3279
        return 'In-Process Store, no URL'
 
3280
 
 
3281
class TransportIniFileStore(IniFileStore):
 
3282
    """IniFileStore that loads files from a transport.
 
3283
 
 
3284
    :ivar transport: The transport object where the config file is located.
 
3285
 
 
3286
    :ivar file_name: The config file basename in the transport directory.
 
3287
    """
 
3288
 
 
3289
    def __init__(self, transport, file_name):
 
3290
        """A Store using a ini file on a Transport
 
3291
 
 
3292
        :param transport: The transport object where the config file is located.
 
3293
        :param file_name: The config file basename in the transport directory.
 
3294
        """
 
3295
        super(TransportIniFileStore, self).__init__()
 
3296
        self.transport = transport
 
3297
        self.file_name = file_name
 
3298
 
 
3299
    def _load_content(self):
 
3300
        try:
 
3301
            return self.transport.get_bytes(self.file_name)
 
3302
        except errors.PermissionDenied:
 
3303
            trace.warning("Permission denied while trying to load "
 
3304
                          "configuration store %s.", self.external_url())
 
3305
            raise
 
3306
 
 
3307
    def _save_content(self, content):
 
3308
        self.transport.put_bytes(self.file_name, content)
 
3309
 
 
3310
    def external_url(self):
 
3311
        # FIXME: external_url should really accepts an optional relpath
 
3312
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
3313
        # The following will do in the interim but maybe we don't want to
 
3314
        # expose a path here but rather a config ID and its associated
 
3315
        # object </hand wawe>.
 
3316
        return urlutils.join(self.transport.external_url(), self.file_name)
2504
3317
 
2505
3318
 
2506
3319
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2509
3322
# they may face the same issue.
2510
3323
 
2511
3324
 
2512
 
class LockableIniFileStore(IniFileStore):
 
3325
class LockableIniFileStore(TransportIniFileStore):
2513
3326
    """A ConfigObjStore using locks on save to ensure store integrity."""
2514
3327
 
2515
3328
    def __init__(self, transport, file_name, lock_dir_name=None):
2562
3375
class GlobalStore(LockableIniFileStore):
2563
3376
 
2564
3377
    def __init__(self, possible_transports=None):
2565
 
        t = transport.get_transport(config_dir(),
2566
 
                                    possible_transports=possible_transports)
 
3378
        t = transport.get_transport_from_path(
 
3379
            config_dir(), possible_transports=possible_transports)
2567
3380
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
3381
        self.id = 'bazaar'
2568
3382
 
2569
3383
 
2570
3384
class LocationStore(LockableIniFileStore):
2571
3385
 
2572
3386
    def __init__(self, possible_transports=None):
2573
 
        t = transport.get_transport(config_dir(),
2574
 
                                    possible_transports=possible_transports)
 
3387
        t = transport.get_transport_from_path(
 
3388
            config_dir(), possible_transports=possible_transports)
2575
3389
        super(LocationStore, self).__init__(t, 'locations.conf')
2576
 
 
2577
 
 
2578
 
class BranchStore(IniFileStore):
 
3390
        self.id = 'locations'
 
3391
 
 
3392
 
 
3393
class BranchStore(TransportIniFileStore):
2579
3394
 
2580
3395
    def __init__(self, branch):
2581
3396
        super(BranchStore, self).__init__(branch.control_transport,
2582
3397
                                          'branch.conf')
2583
3398
        self.branch = branch
2584
 
 
2585
 
    def lock_write(self, token=None):
2586
 
        return self.branch.lock_write(token)
2587
 
 
2588
 
    def unlock(self):
2589
 
        return self.branch.unlock()
2590
 
 
2591
 
    @needs_write_lock
2592
 
    def save(self):
2593
 
        # We need to be able to override the undecorated implementation
2594
 
        self.save_without_locking()
2595
 
 
2596
 
    def save_without_locking(self):
2597
 
        super(BranchStore, self).save()
 
3399
        self.id = 'branch'
 
3400
 
 
3401
 
 
3402
class ControlStore(LockableIniFileStore):
 
3403
 
 
3404
    def __init__(self, bzrdir):
 
3405
        super(ControlStore, self).__init__(bzrdir.transport,
 
3406
                                          'control.conf',
 
3407
                                           lock_dir_name='branch_lock')
 
3408
        self.id = 'control'
2598
3409
 
2599
3410
 
2600
3411
class SectionMatcher(object):
2601
3412
    """Select sections into a given Store.
2602
3413
 
2603
 
    This intended to be used to postpone getting an iterable of sections from a
2604
 
    store.
 
3414
    This is intended to be used to postpone getting an iterable of sections
 
3415
    from a store.
2605
3416
    """
2606
3417
 
2607
3418
    def __init__(self, store):
2612
3423
        # sections.
2613
3424
        sections = self.store.get_sections()
2614
3425
        # Walk the revisions in the order provided
2615
 
        for s in sections:
 
3426
        for store, s in sections:
2616
3427
            if self.match(s):
2617
 
                yield s
2618
 
 
2619
 
    def match(self, secion):
 
3428
                yield store, s
 
3429
 
 
3430
    def match(self, section):
 
3431
        """Does the proposed section match.
 
3432
 
 
3433
        :param section: A Section object.
 
3434
 
 
3435
        :returns: True if the section matches, False otherwise.
 
3436
        """
2620
3437
        raise NotImplementedError(self.match)
2621
3438
 
2622
3439
 
 
3440
class NameMatcher(SectionMatcher):
 
3441
 
 
3442
    def __init__(self, store, section_id):
 
3443
        super(NameMatcher, self).__init__(store)
 
3444
        self.section_id = section_id
 
3445
 
 
3446
    def match(self, section):
 
3447
        return section.id == self.section_id
 
3448
 
 
3449
 
2623
3450
class LocationSection(Section):
2624
3451
 
2625
 
    def __init__(self, section, length, extra_path):
 
3452
    def __init__(self, section, extra_path):
2626
3453
        super(LocationSection, self).__init__(section.id, section.options)
2627
 
        self.length = length
2628
3454
        self.extra_path = extra_path
 
3455
        self.locals = {'relpath': extra_path,
 
3456
                       'basename': urlutils.basename(extra_path)}
2629
3457
 
2630
 
    def get(self, name, default=None):
 
3458
    def get(self, name, default=None, expand=True):
2631
3459
        value = super(LocationSection, self).get(name, default)
2632
 
        if value is not None:
 
3460
        if value is not None and expand:
2633
3461
            policy_name = self.get(name + ':policy', None)
2634
3462
            policy = _policy_value.get(policy_name, POLICY_NONE)
2635
3463
            if policy == POLICY_APPENDPATH:
2636
3464
                value = urlutils.join(value, self.extra_path)
 
3465
            # expand section local options right now (since POLICY_APPENDPATH
 
3466
            # will never add options references, it's ok to expand after it).
 
3467
            chunks = []
 
3468
            for is_ref, chunk in iter_option_refs(value):
 
3469
                if not is_ref:
 
3470
                    chunks.append(chunk)
 
3471
                else:
 
3472
                    ref = chunk[1:-1]
 
3473
                    if ref in self.locals:
 
3474
                        chunks.append(self.locals[ref])
 
3475
                    else:
 
3476
                        chunks.append(chunk)
 
3477
            value = ''.join(chunks)
2637
3478
        return value
2638
3479
 
2639
3480
 
 
3481
class StartingPathMatcher(SectionMatcher):
 
3482
    """Select sections for a given location respecting the Store order."""
 
3483
 
 
3484
    # FIXME: Both local paths and urls can be used for section names as well as
 
3485
    # ``location`` to stay consistent with ``LocationMatcher`` which itself
 
3486
    # inherited the fuzziness from the previous ``LocationConfig``
 
3487
    # implementation. We probably need to revisit which encoding is allowed for
 
3488
    # both ``location`` and section names and how we normalize
 
3489
    # them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
 
3490
    # related too. -- vila 2012-01-04
 
3491
 
 
3492
    def __init__(self, store, location):
 
3493
        super(StartingPathMatcher, self).__init__(store)
 
3494
        if location.startswith('file://'):
 
3495
            location = urlutils.local_path_from_url(location)
 
3496
        self.location = location
 
3497
 
 
3498
    def get_sections(self):
 
3499
        """Get all sections matching ``location`` in the store.
 
3500
 
 
3501
        The most generic sections are described first in the store, then more
 
3502
        specific ones can be provided for reduced scopes.
 
3503
 
 
3504
        The returned section are therefore returned in the reversed order so
 
3505
        the most specific ones can be found first.
 
3506
        """
 
3507
        location_parts = self.location.rstrip('/').split('/')
 
3508
        store = self.store
 
3509
        sections = []
 
3510
        # Later sections are more specific, they should be returned first
 
3511
        for _, section in reversed(list(store.get_sections())):
 
3512
            if section.id is None:
 
3513
                # The no-name section is always included if present
 
3514
                yield store, LocationSection(section, self.location)
 
3515
                continue
 
3516
            section_path = section.id
 
3517
            if section_path.startswith('file://'):
 
3518
                # the location is already a local path or URL, convert the
 
3519
                # section id to the same format
 
3520
                section_path = urlutils.local_path_from_url(section_path)
 
3521
            if (self.location.startswith(section_path)
 
3522
                or fnmatch.fnmatch(self.location, section_path)):
 
3523
                section_parts = section_path.rstrip('/').split('/')
 
3524
                extra_path = '/'.join(location_parts[len(section_parts):])
 
3525
                yield store, LocationSection(section, extra_path)
 
3526
 
 
3527
 
2640
3528
class LocationMatcher(SectionMatcher):
2641
3529
 
2642
3530
    def __init__(self, store, location):
2650
3538
        # We slightly diverge from LocalConfig here by allowing the no-name
2651
3539
        # section as the most generic one and the lower priority.
2652
3540
        no_name_section = None
2653
 
        sections = []
 
3541
        all_sections = []
2654
3542
        # Filter out the no_name_section so _iter_for_location_by_parts can be
2655
3543
        # used (it assumes all sections have a name).
2656
 
        for section in self.store.get_sections():
 
3544
        for _, section in self.store.get_sections():
2657
3545
            if section.id is None:
2658
3546
                no_name_section = section
2659
3547
            else:
2660
 
                sections.append(section)
 
3548
                all_sections.append(section)
2661
3549
        # Unfortunately _iter_for_location_by_parts deals with section names so
2662
3550
        # we have to resync.
2663
3551
        filtered_sections = _iter_for_location_by_parts(
2664
 
            [s.id for s in sections], self.location)
2665
 
        iter_sections = iter(sections)
 
3552
            [s.id for s in all_sections], self.location)
 
3553
        iter_all_sections = iter(all_sections)
2666
3554
        matching_sections = []
2667
3555
        if no_name_section is not None:
2668
3556
            matching_sections.append(
2669
 
                LocationSection(no_name_section, 0, self.location))
 
3557
                (0, LocationSection(no_name_section, self.location)))
2670
3558
        for section_id, extra_path, length in filtered_sections:
2671
 
            # a section id is unique for a given store so it's safe to iterate
2672
 
            # again
2673
 
            section = iter_sections.next()
2674
 
            if section_id == section.id:
2675
 
                matching_sections.append(
2676
 
                    LocationSection(section, length, extra_path))
 
3559
            # a section id is unique for a given store so it's safe to take the
 
3560
            # first matching section while iterating. Also, all filtered
 
3561
            # sections are part of 'all_sections' and will always be found
 
3562
            # there.
 
3563
            while True:
 
3564
                section = iter_all_sections.next()
 
3565
                if section_id == section.id:
 
3566
                    matching_sections.append(
 
3567
                        (length, LocationSection(section, extra_path)))
 
3568
                    break
2677
3569
        return matching_sections
2678
3570
 
2679
3571
    def get_sections(self):
2681
3573
        matching_sections = self._get_matching_sections()
2682
3574
        # We want the longest (aka more specific) locations first
2683
3575
        sections = sorted(matching_sections,
2684
 
                          key=lambda section: (section.length, section.id),
 
3576
                          key=lambda (length, section): (length, section.id),
2685
3577
                          reverse=True)
2686
3578
        # Sections mentioning 'ignore_parents' restrict the selection
2687
 
        for section in sections:
 
3579
        for _, section in sections:
2688
3580
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
2689
3581
            ignore = section.get('ignore_parents', None)
2690
3582
            if ignore is not None:
2692
3584
            if ignore:
2693
3585
                break
2694
3586
            # Finally, we have a valid section
2695
 
            yield section
 
3587
            yield self.store, section
 
3588
 
 
3589
 
 
3590
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
 
3591
"""Describes an expandable option reference.
 
3592
 
 
3593
We want to match the most embedded reference first.
 
3594
 
 
3595
I.e. for '{{foo}}' we will get '{foo}',
 
3596
for '{bar{baz}}' we will get '{baz}'
 
3597
"""
 
3598
 
 
3599
def iter_option_refs(string):
 
3600
    # Split isolate refs so every other chunk is a ref
 
3601
    is_ref = False
 
3602
    for chunk  in _option_ref_re.split(string):
 
3603
        yield is_ref, chunk
 
3604
        is_ref = not is_ref
2696
3605
 
2697
3606
 
2698
3607
class Stack(object):
2699
3608
    """A stack of configurations where an option can be defined"""
2700
3609
 
2701
 
    def __init__(self, sections_def, store=None, mutable_section_name=None):
 
3610
    def __init__(self, sections_def, store=None, mutable_section_id=None):
2702
3611
        """Creates a stack of sections with an optional store for changes.
2703
3612
 
2704
3613
        :param sections_def: A list of Section or callables that returns an
2708
3617
        :param store: The optional Store where modifications will be
2709
3618
            recorded. If none is specified, no modifications can be done.
2710
3619
 
2711
 
        :param mutable_section_name: The name of the MutableSection where
2712
 
            changes are recorded. This requires the ``store`` parameter to be
 
3620
        :param mutable_section_id: The id of the MutableSection where changes
 
3621
            are recorded. This requires the ``store`` parameter to be
2713
3622
            specified.
2714
3623
        """
2715
3624
        self.sections_def = sections_def
2716
3625
        self.store = store
2717
 
        self.mutable_section_name = mutable_section_name
2718
 
 
2719
 
    def get(self, name):
 
3626
        self.mutable_section_id = mutable_section_id
 
3627
 
 
3628
    def iter_sections(self):
 
3629
        """Iterate all the defined sections."""
 
3630
        # Ensuring lazy loading is achieved by delaying section matching (which
 
3631
        # implies querying the persistent storage) until it can't be avoided
 
3632
        # anymore by using callables to describe (possibly empty) section
 
3633
        # lists.
 
3634
        for sections in self.sections_def:
 
3635
            for store, section in sections():
 
3636
                yield store, section
 
3637
 
 
3638
    def get(self, name, expand=True, convert=True):
2720
3639
        """Return the *first* option value found in the sections.
2721
3640
 
2722
3641
        This is where we guarantee that sections coming from Store are loaded
2724
3643
        option exists or get its value, which in turn may require to discover
2725
3644
        in which sections it can be defined. Both of these (section and option
2726
3645
        existence) require loading the store (even partially).
 
3646
 
 
3647
        :param name: The queried option.
 
3648
 
 
3649
        :param expand: Whether options references should be expanded.
 
3650
 
 
3651
        :param convert: Whether the option value should be converted from
 
3652
            unicode (do nothing for non-registered options).
 
3653
 
 
3654
        :returns: The value of the option.
2727
3655
        """
2728
3656
        # FIXME: No caching of options nor sections yet -- vila 20110503
2729
3657
        value = None
2730
 
        # Ensuring lazy loading is achieved by delaying section matching (which
2731
 
        # implies querying the persistent storage) until it can't be avoided
2732
 
        # anymore by using callables to describe (possibly empty) section
2733
 
        # lists.
2734
 
        for section_or_callable in self.sections_def:
2735
 
            # Each section can expand to multiple ones when a callable is used
2736
 
            if callable(section_or_callable):
2737
 
                sections = section_or_callable()
2738
 
            else:
2739
 
                sections = [section_or_callable]
2740
 
            for section in sections:
 
3658
        found_store = None # Where the option value has been found
 
3659
        # If the option is registered, it may provide additional info about
 
3660
        # value handling
 
3661
        try:
 
3662
            opt = option_registry.get(name)
 
3663
        except KeyError:
 
3664
            # Not registered
 
3665
            opt = None
 
3666
 
 
3667
        def expand_and_convert(val):
 
3668
            # This may need to be called in different contexts if the value is
 
3669
            # None or ends up being None during expansion or conversion.
 
3670
            if val is not None:
 
3671
                if expand:
 
3672
                    if isinstance(val, basestring):
 
3673
                        val = self._expand_options_in_string(val)
 
3674
                    else:
 
3675
                        trace.warning('Cannot expand "%s":'
 
3676
                                      ' %s does not support option expansion'
 
3677
                                      % (name, type(val)))
 
3678
                if opt is None:
 
3679
                    val = found_store.unquote(val)
 
3680
                elif convert:
 
3681
                    val = opt.convert_from_unicode(found_store, val)
 
3682
            return val
 
3683
 
 
3684
        # First of all, check if the environment can override the configuration
 
3685
        # value
 
3686
        if opt is not None and opt.override_from_env:
 
3687
            value = opt.get_override()
 
3688
            value = expand_and_convert(value)
 
3689
        if value is None:
 
3690
            for store, section in self.iter_sections():
2741
3691
                value = section.get(name)
2742
3692
                if value is not None:
 
3693
                    found_store = store
2743
3694
                    break
2744
 
            if value is not None:
2745
 
                break
2746
 
        if value is None:
2747
 
            # If the option is registered, it may provide a default value
2748
 
            try:
2749
 
                opt = option_registry.get(name)
2750
 
            except KeyError:
2751
 
                # Not registered
2752
 
                opt = None
2753
 
            if opt is not None:
 
3695
            value = expand_and_convert(value)
 
3696
            if opt is not None and value is None:
 
3697
                # If the option is registered, it may provide a default value
2754
3698
                value = opt.get_default()
 
3699
                value = expand_and_convert(value)
2755
3700
        for hook in ConfigHooks['get']:
2756
3701
            hook(self, name, value)
2757
3702
        return value
2758
3703
 
 
3704
    def expand_options(self, string, env=None):
 
3705
        """Expand option references in the string in the configuration context.
 
3706
 
 
3707
        :param string: The string containing option(s) to expand.
 
3708
 
 
3709
        :param env: An option dict defining additional configuration options or
 
3710
            overriding existing ones.
 
3711
 
 
3712
        :returns: The expanded string.
 
3713
        """
 
3714
        return self._expand_options_in_string(string, env)
 
3715
 
 
3716
    def _expand_options_in_string(self, string, env=None, _refs=None):
 
3717
        """Expand options in the string in the configuration context.
 
3718
 
 
3719
        :param string: The string to be expanded.
 
3720
 
 
3721
        :param env: An option dict defining additional configuration options or
 
3722
            overriding existing ones.
 
3723
 
 
3724
        :param _refs: Private list (FIFO) containing the options being expanded
 
3725
            to detect loops.
 
3726
 
 
3727
        :returns: The expanded string.
 
3728
        """
 
3729
        if string is None:
 
3730
            # Not much to expand there
 
3731
            return None
 
3732
        if _refs is None:
 
3733
            # What references are currently resolved (to detect loops)
 
3734
            _refs = []
 
3735
        result = string
 
3736
        # We need to iterate until no more refs appear ({{foo}} will need two
 
3737
        # iterations for example).
 
3738
        expanded = True
 
3739
        while expanded:
 
3740
            expanded = False
 
3741
            chunks = []
 
3742
            for is_ref, chunk in iter_option_refs(result):
 
3743
                if not is_ref:
 
3744
                    chunks.append(chunk)
 
3745
                else:
 
3746
                    expanded = True
 
3747
                    name = chunk[1:-1]
 
3748
                    if name in _refs:
 
3749
                        raise errors.OptionExpansionLoop(string, _refs)
 
3750
                    _refs.append(name)
 
3751
                    value = self._expand_option(name, env, _refs)
 
3752
                    if value is None:
 
3753
                        raise errors.ExpandingUnknownOption(name, string)
 
3754
                    chunks.append(value)
 
3755
                    _refs.pop()
 
3756
            result = ''.join(chunks)
 
3757
        return result
 
3758
 
 
3759
    def _expand_option(self, name, env, _refs):
 
3760
        if env is not None and name in env:
 
3761
            # Special case, values provided in env takes precedence over
 
3762
            # anything else
 
3763
            value = env[name]
 
3764
        else:
 
3765
            value = self.get(name, expand=False, convert=False)
 
3766
            value = self._expand_options_in_string(value, env, _refs)
 
3767
        return value
 
3768
 
2759
3769
    def _get_mutable_section(self):
2760
3770
        """Get the MutableSection for the Stack.
2761
3771
 
2762
3772
        This is where we guarantee that the mutable section is lazily loaded:
2763
3773
        this means we won't load the corresponding store before setting a value
2764
3774
        or deleting an option. In practice the store will often be loaded but
2765
 
        this allows helps catching some programming errors.
 
3775
        this helps catching some programming errors.
2766
3776
        """
2767
 
        section = self.store.get_mutable_section(self.mutable_section_name)
2768
 
        return section
 
3777
        store = self.store
 
3778
        section = store.get_mutable_section(self.mutable_section_id)
 
3779
        return store, section
2769
3780
 
2770
3781
    def set(self, name, value):
2771
3782
        """Set a new value for the option."""
2772
 
        section = self._get_mutable_section()
2773
 
        section.set(name, value)
 
3783
        store, section = self._get_mutable_section()
 
3784
        section.set(name, store.quote(value))
2774
3785
        for hook in ConfigHooks['set']:
2775
3786
            hook(self, name, value)
2776
3787
 
2777
3788
    def remove(self, name):
2778
3789
        """Remove an existing option."""
2779
 
        section = self._get_mutable_section()
 
3790
        _, section = self._get_mutable_section()
2780
3791
        section.remove(name)
2781
3792
        for hook in ConfigHooks['remove']:
2782
3793
            hook(self, name)
2785
3796
        # Mostly for debugging use
2786
3797
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
2787
3798
 
 
3799
    def _get_overrides(self):
 
3800
        # Hack around library_state.initialize never called
 
3801
        if bzrlib.global_state is not None:
 
3802
            return bzrlib.global_state.cmdline_overrides.get_sections()
 
3803
        return []
 
3804
 
 
3805
 
 
3806
class MemoryStack(Stack):
 
3807
    """A configuration stack defined from a string.
 
3808
 
 
3809
    This is mainly intended for tests and requires no disk resources.
 
3810
    """
 
3811
 
 
3812
    def __init__(self, content=None):
 
3813
        """Create an in-memory stack from a given content.
 
3814
 
 
3815
        It uses a single store based on configobj and support reading and
 
3816
        writing options.
 
3817
 
 
3818
        :param content: The initial content of the store. If None, the store is
 
3819
            not loaded and ``_load_from_string`` can and should be used if
 
3820
            needed.
 
3821
        """
 
3822
        store = IniFileStore()
 
3823
        if content is not None:
 
3824
            store._load_from_string(content)
 
3825
        super(MemoryStack, self).__init__(
 
3826
            [store.get_sections], store)
 
3827
 
2788
3828
 
2789
3829
class _CompatibleStack(Stack):
2790
3830
    """Place holder for compatibility with previous design.
2795
3835
    One assumption made here is that the daughter classes will all use Stores
2796
3836
    derived from LockableIniFileStore).
2797
3837
 
2798
 
    It implements set() by re-loading the store before applying the
2799
 
    modification and saving it.
 
3838
    It implements set() and remove () by re-loading the store before applying
 
3839
    the modification and saving it.
2800
3840
 
2801
3841
    The long term plan being to implement a single write by store to save
2802
3842
    all modifications, this class should not be used in the interim.
2809
3849
        # Force a write to persistent storage
2810
3850
        self.store.save()
2811
3851
 
 
3852
    def remove(self, name):
 
3853
        # Force a reload
 
3854
        self.store.unload()
 
3855
        super(_CompatibleStack, self).remove(name)
 
3856
        # Force a write to persistent storage
 
3857
        self.store.save()
 
3858
 
2812
3859
 
2813
3860
class GlobalStack(_CompatibleStack):
 
3861
    """Global options only stack.
 
3862
 
 
3863
    The following sections are queried:
 
3864
 
 
3865
    * command-line overrides,
 
3866
 
 
3867
    * the 'DEFAULT' section in bazaar.conf
 
3868
 
 
3869
    This stack will use the ``DEFAULT`` section in bazaar.conf as its
 
3870
    MutableSection.
 
3871
    """
2814
3872
 
2815
3873
    def __init__(self):
2816
 
        # Get a GlobalStore
2817
3874
        gstore = GlobalStore()
2818
 
        super(GlobalStack, self).__init__([gstore.get_sections], gstore)
 
3875
        super(GlobalStack, self).__init__(
 
3876
            [self._get_overrides,
 
3877
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3878
            gstore, mutable_section_id='DEFAULT')
2819
3879
 
2820
3880
 
2821
3881
class LocationStack(_CompatibleStack):
 
3882
    """Per-location options falling back to global options stack.
 
3883
 
 
3884
 
 
3885
    The following sections are queried:
 
3886
 
 
3887
    * command-line overrides,
 
3888
 
 
3889
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3890
      defined by the number of path components in the section glob, higher
 
3891
      numbers first (from most specific section to most generic).
 
3892
 
 
3893
    * the 'DEFAULT' section in bazaar.conf
 
3894
 
 
3895
    This stack will use the ``location`` section in locations.conf as its
 
3896
    MutableSection.
 
3897
    """
2822
3898
 
2823
3899
    def __init__(self, location):
 
3900
        """Make a new stack for a location and global configuration.
 
3901
 
 
3902
        :param location: A URL prefix to """
2824
3903
        lstore = LocationStore()
2825
 
        matcher = LocationMatcher(lstore, location)
 
3904
        if location.startswith('file://'):
 
3905
            location = urlutils.local_path_from_url(location)
2826
3906
        gstore = GlobalStore()
2827
3907
        super(LocationStack, self).__init__(
2828
 
            [matcher.get_sections, gstore.get_sections], lstore)
2829
 
 
2830
 
class BranchStack(_CompatibleStack):
 
3908
            [self._get_overrides,
 
3909
             LocationMatcher(lstore, location).get_sections,
 
3910
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3911
            lstore, mutable_section_id=location)
 
3912
 
 
3913
 
 
3914
class BranchStack(Stack):
 
3915
    """Per-location options falling back to branch then global options stack.
 
3916
 
 
3917
    The following sections are queried:
 
3918
 
 
3919
    * command-line overrides,
 
3920
 
 
3921
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3922
      defined by the number of path components in the section glob, higher
 
3923
      numbers first (from most specific section to most generic),
 
3924
 
 
3925
    * the no-name section in branch.conf,
 
3926
 
 
3927
    * the ``DEFAULT`` section in ``bazaar.conf``.
 
3928
 
 
3929
    This stack will use the no-name section in ``branch.conf`` as its
 
3930
    MutableSection.
 
3931
    """
2831
3932
 
2832
3933
    def __init__(self, branch):
2833
 
        bstore = BranchStore(branch)
2834
3934
        lstore = LocationStore()
2835
 
        matcher = LocationMatcher(lstore, branch.base)
 
3935
        bstore = branch._get_config_store()
2836
3936
        gstore = GlobalStore()
2837
3937
        super(BranchStack, self).__init__(
2838
 
            [matcher.get_sections, bstore.get_sections, gstore.get_sections],
2839
 
            bstore)
2840
 
        self.branch = branch
 
3938
            [self._get_overrides,
 
3939
             LocationMatcher(lstore, branch.base).get_sections,
 
3940
             NameMatcher(bstore, None).get_sections,
 
3941
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3942
            bstore)
 
3943
        self.branch = branch
 
3944
 
 
3945
    def lock_write(self, token=None):
 
3946
        return self.branch.lock_write(token)
 
3947
 
 
3948
    def unlock(self):
 
3949
        return self.branch.unlock()
 
3950
 
 
3951
    @needs_write_lock
 
3952
    def set(self, name, value):
 
3953
        super(BranchStack, self).set(name, value)
 
3954
        # Unlocking the branch will trigger a store.save_changes() so the last
 
3955
        # unlock saves all the changes.
 
3956
 
 
3957
    @needs_write_lock
 
3958
    def remove(self, name):
 
3959
        super(BranchStack, self).remove(name)
 
3960
        # Unlocking the branch will trigger a store.save_changes() so the last
 
3961
        # unlock saves all the changes.
 
3962
 
 
3963
 
 
3964
class RemoteControlStack(_CompatibleStack):
 
3965
    """Remote control-only options stack."""
 
3966
 
 
3967
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
3968
    # with the stack used for remote bzr dirs. RemoteControlStack only uses
 
3969
    # control.conf and is used only for stack options.
 
3970
 
 
3971
    def __init__(self, bzrdir):
 
3972
        cstore = bzrdir._get_config_store()
 
3973
        super(RemoteControlStack, self).__init__(
 
3974
            [NameMatcher(cstore, None).get_sections],
 
3975
            cstore)
 
3976
        self.bzrdir = bzrdir
 
3977
 
 
3978
 
 
3979
class BranchOnlyStack(Stack):
 
3980
    """Branch-only options stack."""
 
3981
 
 
3982
    # FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
 
3983
    # stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
 
3984
    # -- vila 2011-12-16
 
3985
 
 
3986
    def __init__(self, branch):
 
3987
        bstore = branch._get_config_store()
 
3988
        super(BranchOnlyStack, self).__init__(
 
3989
            [NameMatcher(bstore, None).get_sections],
 
3990
            bstore)
 
3991
        self.branch = branch
 
3992
 
 
3993
    def lock_write(self, token=None):
 
3994
        return self.branch.lock_write(token)
 
3995
 
 
3996
    def unlock(self):
 
3997
        return self.branch.unlock()
 
3998
 
 
3999
    @needs_write_lock
 
4000
    def set(self, name, value):
 
4001
        super(BranchOnlyStack, self).set(name, value)
 
4002
        # Force a write to persistent storage
 
4003
        self.store.save_changes()
 
4004
 
 
4005
    @needs_write_lock
 
4006
    def remove(self, name):
 
4007
        super(BranchOnlyStack, self).remove(name)
 
4008
        # Force a write to persistent storage
 
4009
        self.store.save_changes()
2841
4010
 
2842
4011
 
2843
4012
class cmd_config(commands.Command):
2861
4030
    takes_options = [
2862
4031
        'directory',
2863
4032
        # FIXME: This should be a registry option so that plugins can register
2864
 
        # their own config files (or not) -- vila 20101002
 
4033
        # their own config files (or not) and will also address
 
4034
        # http://pad.lv/788991 -- vila 20101115
2865
4035
        commands.Option('scope', help='Reduce the scope to the specified'
2866
 
                        ' configuration file',
 
4036
                        ' configuration file.',
2867
4037
                        type=unicode),
2868
4038
        commands.Option('all',
2869
4039
            help='Display all the defined values for the matching options.',
2870
4040
            ),
2871
4041
        commands.Option('remove', help='Remove the option from'
2872
 
                        ' the configuration file'),
 
4042
                        ' the configuration file.'),
2873
4043
        ]
2874
4044
 
2875
4045
    _see_also = ['configuration']
2905
4075
                # Set the option value
2906
4076
                self._set_config_option(name, value, directory, scope)
2907
4077
 
2908
 
    def _get_configs(self, directory, scope=None):
2909
 
        """Iterate the configurations specified by ``directory`` and ``scope``.
 
4078
    def _get_stack(self, directory, scope=None, write_access=False):
 
4079
        """Get the configuration stack specified by ``directory`` and ``scope``.
2910
4080
 
2911
4081
        :param directory: Where the configurations are derived from.
2912
4082
 
2913
4083
        :param scope: A specific config to start from.
 
4084
 
 
4085
        :param write_access: Whether a write access to the stack will be
 
4086
            attempted.
2914
4087
        """
 
4088
        # FIXME: scope should allow access to plugin-specific stacks (even
 
4089
        # reduced to the plugin-specific store), related to
 
4090
        # http://pad.lv/788991 -- vila 2011-11-15
2915
4091
        if scope is not None:
2916
4092
            if scope == 'bazaar':
2917
 
                yield GlobalConfig()
 
4093
                return GlobalStack()
2918
4094
            elif scope == 'locations':
2919
 
                yield LocationConfig(directory)
 
4095
                return LocationStack(directory)
2920
4096
            elif scope == 'branch':
2921
 
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2922
 
                    directory)
2923
 
                yield br.get_config()
 
4097
                (_, br, _) = (
 
4098
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4099
                        directory))
 
4100
                if write_access:
 
4101
                    self.add_cleanup(br.lock_write().unlock)
 
4102
                return br.get_config_stack()
 
4103
            raise errors.NoSuchConfig(scope)
2924
4104
        else:
2925
4105
            try:
2926
 
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2927
 
                    directory)
2928
 
                yield br.get_config()
 
4106
                (_, br, _) = (
 
4107
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4108
                        directory))
 
4109
                if write_access:
 
4110
                    self.add_cleanup(br.lock_write().unlock)
 
4111
                return br.get_config_stack()
2929
4112
            except errors.NotBranchError:
2930
 
                yield LocationConfig(directory)
2931
 
                yield GlobalConfig()
 
4113
                return LocationStack(directory)
 
4114
 
 
4115
    def _quote_multiline(self, value):
 
4116
        if '\n' in value:
 
4117
            value = '"""' + value + '"""'
 
4118
        return value
2932
4119
 
2933
4120
    def _show_value(self, name, directory, scope):
2934
 
        displayed = False
2935
 
        for c in self._get_configs(directory, scope):
2936
 
            if displayed:
2937
 
                break
2938
 
            for (oname, value, section, conf_id, parser) in c._get_options():
2939
 
                if name == oname:
2940
 
                    # Display only the first value and exit
2941
 
 
2942
 
                    # FIXME: We need to use get_user_option to take policies
2943
 
                    # into account and we need to make sure the option exists
2944
 
                    # too (hence the two for loops), this needs a better API
2945
 
                    # -- vila 20101117
2946
 
                    value = c.get_user_option(name)
2947
 
                    # Quote the value appropriately
2948
 
                    value = parser._quote(value)
2949
 
                    self.outf.write('%s\n' % (value,))
2950
 
                    displayed = True
2951
 
                    break
2952
 
        if not displayed:
 
4121
        conf = self._get_stack(directory, scope)
 
4122
        value = conf.get(name, expand=True, convert=False)
 
4123
        if value is not None:
 
4124
            # Quote the value appropriately
 
4125
            value = self._quote_multiline(value)
 
4126
            self.outf.write('%s\n' % (value,))
 
4127
        else:
2953
4128
            raise errors.NoSuchConfigOption(name)
2954
4129
 
2955
4130
    def _show_matching_options(self, name, directory, scope):
2958
4133
        # avoid the delay introduced by the lazy regexp.  But, we still do
2959
4134
        # want the nicer errors raised by lazy_regex.
2960
4135
        name._compile_and_collapse()
2961
 
        cur_conf_id = None
 
4136
        cur_store_id = None
2962
4137
        cur_section = None
2963
 
        for c in self._get_configs(directory, scope):
2964
 
            for (oname, value, section, conf_id, parser) in c._get_options():
 
4138
        conf = self._get_stack(directory, scope)
 
4139
        for store, section in conf.iter_sections():
 
4140
            for oname in section.iter_option_names():
2965
4141
                if name.search(oname):
2966
 
                    if cur_conf_id != conf_id:
 
4142
                    if cur_store_id != store.id:
2967
4143
                        # Explain where the options are defined
2968
 
                        self.outf.write('%s:\n' % (conf_id,))
2969
 
                        cur_conf_id = conf_id
 
4144
                        self.outf.write('%s:\n' % (store.id,))
 
4145
                        cur_store_id = store.id
2970
4146
                        cur_section = None
2971
 
                    if (section not in (None, 'DEFAULT')
2972
 
                        and cur_section != section):
2973
 
                        # Display the section if it's not the default (or only)
2974
 
                        # one.
2975
 
                        self.outf.write('  [%s]\n' % (section,))
2976
 
                        cur_section = section
 
4147
                    if (section.id is not None and cur_section != section.id):
 
4148
                        # Display the section id as it appears in the store
 
4149
                        # (None doesn't appear by definition)
 
4150
                        self.outf.write('  [%s]\n' % (section.id,))
 
4151
                        cur_section = section.id
 
4152
                    value = section.get(oname, expand=False)
 
4153
                    # Quote the value appropriately
 
4154
                    value = self._quote_multiline(value)
2977
4155
                    self.outf.write('  %s = %s\n' % (oname, value))
2978
4156
 
2979
4157
    def _set_config_option(self, name, value, directory, scope):
2980
 
        for conf in self._get_configs(directory, scope):
2981
 
            conf.set_user_option(name, value)
2982
 
            break
2983
 
        else:
2984
 
            raise errors.NoSuchConfig(scope)
 
4158
        conf = self._get_stack(directory, scope, write_access=True)
 
4159
        conf.set(name, value)
2985
4160
 
2986
4161
    def _remove_config_option(self, name, directory, scope):
2987
4162
        if name is None:
2988
4163
            raise errors.BzrCommandError(
2989
4164
                '--remove expects an option to remove.')
2990
 
        removed = False
2991
 
        for conf in self._get_configs(directory, scope):
2992
 
            for (section_name, section, conf_id) in conf._get_sections():
2993
 
                if scope is not None and conf_id != scope:
2994
 
                    # Not the right configuration file
2995
 
                    continue
2996
 
                if name in section:
2997
 
                    if conf_id != conf.config_id():
2998
 
                        conf = self._get_configs(directory, conf_id).next()
2999
 
                    # We use the first section in the first config where the
3000
 
                    # option is defined to remove it
3001
 
                    conf.remove_user_option(name, section_name)
3002
 
                    removed = True
3003
 
                    break
3004
 
            break
3005
 
        else:
3006
 
            raise errors.NoSuchConfig(scope)
3007
 
        if not removed:
 
4165
        conf = self._get_stack(directory, scope, write_access=True)
 
4166
        try:
 
4167
            conf.remove(name)
 
4168
        except KeyError:
3008
4169
            raise errors.NoSuchConfigOption(name)
3009
4170
 
 
4171
 
3010
4172
# Test registries
3011
4173
#
3012
4174
# We need adapters that can build a Store or a Stack in a test context. Test
3015
4177
# ready-to-use store or stack.  Plugins that define new store/stacks can also
3016
4178
# register themselves here to be tested against the tests defined in
3017
4179
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3018
 
# for the same tests.
 
4180
# for the same test.
3019
4181
 
3020
4182
# The registered object should be a callable receiving a test instance
3021
4183
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store