← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Jelmer Vernooij
  • Date: 2012-04-16 11:08:11 UTC
  • mfrom: (6521 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6522.
  • Revision ID: jelmer@samba.org-20120416110811-0y996ihqy9o2bb1t
Merge bzr.dev.

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