← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Patch Queue Manager
  • Date: 2015-12-17 18:39:00 UTC
  • mfrom: (6606.1.2 fix-float)
  • Revision ID: pqm@pqm.ubuntu.com-20151217183900-0719du2uv1kwu3lc
(vila) Inline testtools private method to fix an issue in xenial (the
 private implementation has changed in an backward incompatible way).
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/config.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2012 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#            and others
4
4
#
55
55
                   turns on create_signatures.
56
56
create_signatures - this option controls whether bzr will always create
57
57
                    gpg signatures or not on commits.  There is an unused
58
 
                    option which in future is expected to work if               
 
58
                    option which in future is expected to work if
59
59
                    branch settings require signatures.
60
60
log_format - this option sets the default log format.  Possible values are
61
61
             long, short, line, or a plugin can register new formats.
72
72
up=pull
73
73
"""
74
74
 
 
75
from __future__ import absolute_import
 
76
from cStringIO import StringIO
75
77
import os
76
 
import string
77
78
import sys
78
79
 
79
 
 
 
80
import bzrlib
80
81
from bzrlib.decorators import needs_write_lock
81
82
from bzrlib.lazy_import import lazy_import
82
83
lazy_import(globals(), """
 
84
import base64
83
85
import fnmatch
84
86
import re
85
 
from cStringIO import StringIO
86
87
 
87
88
from bzrlib import (
88
89
    atomicfile,
89
 
    bzrdir,
 
90
    controldir,
90
91
    debug,
 
92
    directory_service,
91
93
    errors,
92
94
    lazy_regex,
 
95
    library_state,
93
96
    lockdir,
94
 
    mail_client,
95
97
    mergetools,
96
98
    osutils,
97
99
    symbol_versioning,
101
103
    urlutils,
102
104
    win32utils,
103
105
    )
 
106
from bzrlib.i18n import gettext
104
107
from bzrlib.util.configobj import configobj
105
108
""")
106
109
from bzrlib import (
149
152
STORE_GLOBAL = 4
150
153
 
151
154
 
 
155
def signature_policy_from_unicode(signature_string):
 
156
    """Convert a string to a signing policy."""
 
157
    if signature_string.lower() == 'check-available':
 
158
        return CHECK_IF_POSSIBLE
 
159
    if signature_string.lower() == 'ignore':
 
160
        return CHECK_NEVER
 
161
    if signature_string.lower() == 'require':
 
162
        return CHECK_ALWAYS
 
163
    raise ValueError("Invalid signatures policy '%s'"
 
164
                     % signature_string)
 
165
 
 
166
 
 
167
def signing_policy_from_unicode(signature_string):
 
168
    """Convert a string to a signing policy."""
 
169
    if signature_string.lower() == 'when-required':
 
170
        return SIGN_WHEN_REQUIRED
 
171
    if signature_string.lower() == 'never':
 
172
        return SIGN_NEVER
 
173
    if signature_string.lower() == 'always':
 
174
        return SIGN_ALWAYS
 
175
    raise ValueError("Invalid signing policy '%s'"
 
176
                     % signature_string)
 
177
 
 
178
 
152
179
class ConfigObj(configobj.ConfigObj):
153
180
 
154
181
    def __init__(self, infile=None, **kwargs):
170
197
        return self[section][name]
171
198
 
172
199
 
173
 
# FIXME: Until we can guarantee that each config file is loaded once and
174
 
# only once for a given bzrlib session, we don't want to re-read the file every
175
 
# time we query for an option so we cache the value (bad ! watch out for tests
176
 
# needing to restore the proper value). -- 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
200
class Config(object):
195
201
    """A configuration policy - what username, editor, gpg needs etc."""
196
202
 
201
207
        """Returns a unique ID for the config."""
202
208
        raise NotImplementedError(self.config_id)
203
209
 
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
210
    def get_change_editor(self, old_tree, new_tree):
210
211
        from bzrlib import diff
211
212
        cmd = self._get_change_editor()
214
215
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
215
216
                                             sys.stdout)
216
217
 
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
218
    def _get_signature_checking(self):
228
219
        """Template method to override signature checking policy."""
229
220
 
358
349
        """Template method to provide a user option."""
359
350
        return None
360
351
 
361
 
    def get_user_option(self, option_name, expand=None):
 
352
    def get_user_option(self, option_name, expand=True):
362
353
        """Get a generic option - no special process, no default.
363
354
 
364
355
        :param option_name: The queried option.
367
358
 
368
359
        :returns: The value of the option.
369
360
        """
370
 
        if expand is None:
371
 
            expand = _get_expand_default_value()
372
361
        value = self._get_user_option(option_name)
373
362
        if expand:
374
363
            if isinstance(value, list):
414
403
            # add) the final ','
415
404
            l = [l]
416
405
        return l
417
 
        
418
 
    def get_user_option_as_int_from_SI(self,  option_name,  default=None):
 
406
 
 
407
    @deprecated_method(deprecated_in((2, 5, 0)))
 
408
    def get_user_option_as_int_from_SI(self, option_name, default=None):
419
409
        """Get a generic option from a human readable size in SI units, e.g 10MB
420
 
        
 
410
 
421
411
        Accepted suffixes are K,M,G. It is case-insensitive and may be followed
422
412
        by a trailing b (i.e. Kb, MB). This is intended to be practical and not
423
413
        pedantic.
424
 
        
 
414
 
425
415
        :return Integer, expanded to its base-10 value if a proper SI unit is 
426
416
            found. If the option doesn't exist, or isn't a value in 
427
417
            SI units, return default (which defaults to None)
452
442
            except TypeError:
453
443
                val = default
454
444
        return val
455
 
        
456
445
 
 
446
    @deprecated_method(deprecated_in((2, 5, 0)))
457
447
    def gpg_signing_command(self):
458
448
        """What program should be used to sign signatures?"""
459
449
        result = self._gpg_signing_command()
465
455
        """See gpg_signing_command()."""
466
456
        return None
467
457
 
 
458
    @deprecated_method(deprecated_in((2, 5, 0)))
468
459
    def log_format(self):
469
460
        """What log format should be used"""
470
461
        result = self._log_format()
489
480
        """See validate_signatures_in_log()."""
490
481
        return None
491
482
 
 
483
    @deprecated_method(deprecated_in((2, 5, 0)))
492
484
    def acceptable_keys(self):
493
485
        """Comma separated list of key patterns acceptable to 
494
486
        verify-signatures command"""
499
491
        """See acceptable_keys()."""
500
492
        return None
501
493
 
 
494
    @deprecated_method(deprecated_in((2, 5, 0)))
502
495
    def post_commit(self):
503
496
        """An ordered list of python functions to call.
504
497
 
530
523
        v = self._get_user_id()
531
524
        if v:
532
525
            return v
533
 
        v = os.environ.get('EMAIL')
534
 
        if v:
535
 
            return v.decode(osutils.get_user_encoding())
536
 
        name, email = _auto_user_id()
537
 
        if name and email:
538
 
            return '%s <%s>' % (name, email)
539
 
        elif email:
540
 
            return email
541
 
        raise errors.NoWhoami()
 
526
        return default_email()
542
527
 
543
528
    def ensure_username(self):
544
529
        """Raise errors.NoWhoami if username is not set.
547
532
        """
548
533
        self.username()
549
534
 
 
535
    @deprecated_method(deprecated_in((2, 5, 0)))
550
536
    def signature_checking(self):
551
537
        """What is the current policy for signature checking?."""
552
538
        policy = self._get_signature_checking()
554
540
            return policy
555
541
        return CHECK_IF_POSSIBLE
556
542
 
 
543
    @deprecated_method(deprecated_in((2, 5, 0)))
557
544
    def signing_policy(self):
558
545
        """What is the current policy for signature checking?."""
559
546
        policy = self._get_signing_policy()
561
548
            return policy
562
549
        return SIGN_WHEN_REQUIRED
563
550
 
 
551
    @deprecated_method(deprecated_in((2, 5, 0)))
564
552
    def signature_needed(self):
565
553
        """Is a signature needed when committing ?."""
566
554
        policy = self._get_signing_policy()
575
563
            return True
576
564
        return False
577
565
 
 
566
    @deprecated_method(deprecated_in((2, 5, 0)))
578
567
    def gpg_signing_key(self):
579
568
        """GPG user-id to sign commits"""
580
569
        key = self.get_user_option('gpg_signing_key')
622
611
        for (oname, value, section, conf_id, parser) in self._get_options():
623
612
            if oname.startswith('bzr.mergetool.'):
624
613
                tool_name = oname[len('bzr.mergetool.'):]
625
 
                tools[tool_name] = self.get_user_option(oname)
 
614
                tools[tool_name] = self.get_user_option(oname, False)
626
615
        trace.mutter('loaded merge tools: %r' % tools)
627
616
        return tools
628
617
 
865
854
        """See Config._get_signature_checking."""
866
855
        policy = self._get_user_option('check_signatures')
867
856
        if policy:
868
 
            return self._string_to_signature_policy(policy)
 
857
            return signature_policy_from_unicode(policy)
869
858
 
870
859
    def _get_signing_policy(self):
871
860
        """See Config._get_signing_policy"""
872
861
        policy = self._get_user_option('create_signatures')
873
862
        if policy:
874
 
            return self._string_to_signing_policy(policy)
 
863
            return signing_policy_from_unicode(policy)
875
864
 
876
865
    def _get_user_id(self):
877
866
        """Get the user id from the 'email' key in the current section."""
922
911
        """See Config.post_commit."""
923
912
        return self._get_user_option('post_commit')
924
913
 
925
 
    def _string_to_signature_policy(self, signature_string):
926
 
        """Convert a string to a signing policy."""
927
 
        if signature_string.lower() == 'check-available':
928
 
            return CHECK_IF_POSSIBLE
929
 
        if signature_string.lower() == 'ignore':
930
 
            return CHECK_NEVER
931
 
        if signature_string.lower() == 'require':
932
 
            return CHECK_ALWAYS
933
 
        raise errors.BzrError("Invalid signatures policy '%s'"
934
 
                              % signature_string)
935
 
 
936
 
    def _string_to_signing_policy(self, signature_string):
937
 
        """Convert a string to a signing policy."""
938
 
        if signature_string.lower() == 'when-required':
939
 
            return SIGN_WHEN_REQUIRED
940
 
        if signature_string.lower() == 'never':
941
 
            return SIGN_NEVER
942
 
        if signature_string.lower() == 'always':
943
 
            return SIGN_ALWAYS
944
 
        raise errors.BzrError("Invalid signing policy '%s'"
945
 
                              % signature_string)
946
 
 
947
914
    def _get_alias(self, value):
948
915
        try:
949
916
            return self._get_parser().get_value("ALIASES",
1086
1053
        conf._create_from_string(str_or_unicode, save)
1087
1054
        return conf
1088
1055
 
1089
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1090
 
    def get_editor(self):
1091
 
        return self._get_user_option('editor')
1092
 
 
1093
1056
    @needs_write_lock
1094
1057
    def set_user_option(self, option, value):
1095
1058
        """Save option and its value in the configuration."""
1393
1356
        e.g. "John Hacker <jhacker@example.com>"
1394
1357
        This is looked up in the email controlfile for the branch.
1395
1358
        """
1396
 
        try:
1397
 
            return (self.branch._transport.get_bytes("email")
1398
 
                    .decode(osutils.get_user_encoding())
1399
 
                    .rstrip("\r\n"))
1400
 
        except (errors.NoSuchFile, errors.PermissionDenied), e:
1401
 
            pass
1402
 
 
1403
1359
        return self._get_best_value('_get_user_id')
1404
1360
 
1405
1361
    def _get_change_editor(self):
1485
1441
        value = self._get_explicit_nickname()
1486
1442
        if value is not None:
1487
1443
            return value
 
1444
        if self.branch.name:
 
1445
            return self.branch.name
1488
1446
        return urlutils.unescape(self.branch.base.split('/')[-2])
1489
1447
 
1490
1448
    def has_explicit_nickname(self):
1527
1485
 
1528
1486
 
1529
1487
def config_dir():
1530
 
    """Return per-user configuration directory.
 
1488
    """Return per-user configuration directory as unicode string
1531
1489
 
1532
1490
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1533
 
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
 
1491
    and Linux.  On Mac OS X and Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1534
1492
    that will be used instead.
1535
1493
 
1536
1494
    TODO: Global option --config-dir to override this.
1537
1495
    """
1538
 
    base = os.environ.get('BZR_HOME', None)
 
1496
    base = osutils.path_from_environ('BZR_HOME')
1539
1497
    if sys.platform == 'win32':
1540
 
        # environ variables on Windows are in user encoding/mbcs. So decode
1541
 
        # before using one
1542
 
        if base is not None:
1543
 
            base = base.decode('mbcs')
1544
 
        if base is None:
1545
 
            base = win32utils.get_appdata_location_unicode()
1546
 
        if base is None:
1547
 
            base = os.environ.get('HOME', None)
1548
 
            if base is not None:
1549
 
                base = base.decode('mbcs')
1550
 
        if base is None:
1551
 
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1552
 
                                  ' or HOME set')
 
1498
        if base is None:
 
1499
            base = win32utils.get_appdata_location()
 
1500
        if base is None:
 
1501
            base = win32utils.get_home_location()
 
1502
        # GZ 2012-02-01: Really the two level subdirs only make sense inside
 
1503
        #                APPDATA, but hard to move. See bug 348640 for more.
1553
1504
        return osutils.pathjoin(base, 'bazaar', '2.0')
1554
 
    else:
1555
 
        if base is not None:
1556
 
            base = base.decode(osutils._fs_enc)
1557
 
    if sys.platform == 'darwin':
1558
 
        if base is None:
1559
 
            # this takes into account $HOME
1560
 
            base = os.path.expanduser("~")
1561
 
        return osutils.pathjoin(base, '.bazaar')
1562
 
    else:
1563
 
        if base is None:
1564
 
            xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
1565
 
            if xdg_dir is None:
1566
 
                xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
1567
 
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1568
 
            if osutils.isdir(xdg_dir):
1569
 
                trace.mutter(
1570
 
                    "Using configuration in XDG directory %s." % xdg_dir)
1571
 
                return xdg_dir
1572
 
            base = os.path.expanduser("~")
1573
 
        return osutils.pathjoin(base, ".bazaar")
 
1505
    if base is None:
 
1506
        xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
 
1507
        if xdg_dir is None:
 
1508
            xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
 
1509
        xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
 
1510
        if osutils.isdir(xdg_dir):
 
1511
            trace.mutter(
 
1512
                "Using configuration in XDG directory %s." % xdg_dir)
 
1513
            return xdg_dir
 
1514
        base = osutils._get_home_dir()
 
1515
    return osutils.pathjoin(base, ".bazaar")
1574
1516
 
1575
1517
 
1576
1518
def config_filename():
1613
1555
def xdg_cache_dir():
1614
1556
    # See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1615
1557
    # Possibly this should be different on Windows?
1616
 
    e = os.environ.get('XDG_CACHE_DIR', None)
 
1558
    e = os.environ.get('XDG_CACHE_HOME', None)
1617
1559
    if e:
1618
1560
        return e
1619
1561
    else:
1620
1562
        return os.path.expanduser('~/.cache')
1621
1563
 
1622
1564
 
1623
 
def _get_default_mail_domain():
 
1565
def _get_default_mail_domain(mailname_file='/etc/mailname'):
1624
1566
    """If possible, return the assumed default email domain.
1625
1567
 
1626
1568
    :returns: string mail domain, or None.
1629
1571
        # No implementation yet; patches welcome
1630
1572
        return None
1631
1573
    try:
1632
 
        f = open('/etc/mailname')
 
1574
        f = open(mailname_file)
1633
1575
    except (IOError, OSError), e:
1634
1576
        return None
1635
1577
    try:
1636
 
        domain = f.read().strip()
 
1578
        domain = f.readline().strip()
1637
1579
        return domain
1638
1580
    finally:
1639
1581
        f.close()
1640
1582
 
1641
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
 
1642
1599
def _auto_user_id():
1643
1600
    """Calculate automatic user identification.
1644
1601
 
1833
1790
        :param user: login (optional)
1834
1791
 
1835
1792
        :param path: the absolute path on the server (optional)
1836
 
        
 
1793
 
1837
1794
        :param realm: the http authentication realm (optional)
1838
1795
 
1839
1796
        :return: A dict containing the matching credentials or None.
2174
2131
credential_store_registry.default_key = 'plain'
2175
2132
 
2176
2133
 
 
2134
class Base64CredentialStore(CredentialStore):
 
2135
    __doc__ = """Base64 credential store for the authentication.conf file"""
 
2136
 
 
2137
    def decode_password(self, credentials):
 
2138
        """See CredentialStore.decode_password."""
 
2139
        # GZ 2012-07-28: Will raise binascii.Error if password is not base64,
 
2140
        #                should probably propogate as something more useful.
 
2141
        return base64.decodestring(credentials['password'])
 
2142
 
 
2143
credential_store_registry.register('base64', Base64CredentialStore,
 
2144
                                   help=Base64CredentialStore.__doc__)
 
2145
 
 
2146
 
2177
2147
class BzrDirConfig(object):
2178
2148
 
2179
2149
    def __init__(self, bzrdir):
2185
2155
 
2186
2156
        It may be set to a location, or None.
2187
2157
 
2188
 
        This policy affects all branches contained by this bzrdir, except for
2189
 
        those under repositories.
 
2158
        This policy affects all branches contained by this control dir, except
 
2159
        for those under repositories.
2190
2160
        """
2191
2161
        if self._config is None:
2192
 
            raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
 
2162
            raise errors.BzrError("Cannot set configuration in %s"
 
2163
                                  % self._bzrdir)
2193
2164
        if value is None:
2194
2165
            self._config.set_option('', 'default_stack_on')
2195
2166
        else:
2200
2171
 
2201
2172
        This will either be a location, or None.
2202
2173
 
2203
 
        This policy affects all branches contained by this bzrdir, except for
2204
 
        those under repositories.
 
2174
        This policy affects all branches contained by this control dir, except
 
2175
        for those under repositories.
2205
2176
        """
2206
2177
        if self._config is None:
2207
2178
            return None
2319
2290
    encoutered, in which config files it can be stored.
2320
2291
    """
2321
2292
 
2322
 
    def __init__(self, name, default=None, default_from_env=None,
2323
 
                 help=None,
2324
 
                 from_unicode=None, invalid=None):
 
2293
    def __init__(self, name, override_from_env=None,
 
2294
                 default=None, default_from_env=None,
 
2295
                 help=None, from_unicode=None, invalid=None, unquote=True):
2325
2296
        """Build an option definition.
2326
2297
 
2327
2298
        :param name: the name used to refer to the option.
2328
2299
 
 
2300
        :param override_from_env: A list of environment variables which can
 
2301
           provide override any configuration setting.
 
2302
 
2329
2303
        :param default: the default value to use when none exist in the config
2330
2304
            stores. This is either a string that ``from_unicode`` will convert
2331
 
            into the proper type or a python object that can be stringified (so
2332
 
            only the empty list is supported for example).
 
2305
            into the proper type, a callable returning a unicode string so that
 
2306
            ``from_unicode`` can be used on the return value, or a python
 
2307
            object that can be stringified (so only the empty list is supported
 
2308
            for example).
2333
2309
 
2334
2310
        :param default_from_env: A list of environment variables which can
2335
2311
           provide a default value. 'default' will be used only if none of the
2338
2314
        :param help: a doc string to explain the option to the user.
2339
2315
 
2340
2316
        :param from_unicode: a callable to convert the unicode string
2341
 
            representing the option value in a store. This is not called for
2342
 
            the default value.
 
2317
            representing the option value in a store or its default value.
2343
2318
 
2344
2319
        :param invalid: the action to be taken when an invalid value is
2345
2320
            encountered in a store. This is called only when from_unicode is
2347
2322
            TypeError. Accepted values are: None (ignore invalid values),
2348
2323
            'warning' (emit a warning), 'error' (emit an error message and
2349
2324
            terminates).
 
2325
 
 
2326
        :param unquote: should the unicode value be unquoted before conversion.
 
2327
           This should be used only when the store providing the values cannot
 
2328
           safely unquote them (see http://pad.lv/906897). It is provided so
 
2329
           daughter classes can handle the quoting themselves.
2350
2330
        """
 
2331
        if override_from_env is None:
 
2332
            override_from_env = []
2351
2333
        if default_from_env is None:
2352
2334
            default_from_env = []
2353
2335
        self.name = name
 
2336
        self.override_from_env = override_from_env
2354
2337
        # Convert the default value to a unicode string so all values are
2355
2338
        # strings internally before conversion (via from_unicode) is attempted.
2356
2339
        if default is None:
2364
2347
        elif isinstance(default, (str, unicode, bool, int, float)):
2365
2348
            # Rely on python to convert strings, booleans and integers
2366
2349
            self.default = u'%s' % (default,)
 
2350
        elif callable(default):
 
2351
            self.default = default
2367
2352
        else:
2368
2353
            # other python objects are not expected
2369
2354
            raise AssertionError('%r is not supported as a default value'
2370
2355
                                 % (default,))
2371
2356
        self.default_from_env = default_from_env
2372
 
        self.help = help
 
2357
        self._help = help
2373
2358
        self.from_unicode = from_unicode
 
2359
        self.unquote = unquote
2374
2360
        if invalid and invalid not in ('warning', 'error'):
2375
2361
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2376
2362
        self.invalid = invalid
2377
2363
 
2378
 
    def convert_from_unicode(self, unicode_value):
 
2364
    @property
 
2365
    def help(self):
 
2366
        return self._help
 
2367
 
 
2368
    def convert_from_unicode(self, store, unicode_value):
 
2369
        if self.unquote and store is not None and unicode_value is not None:
 
2370
            unicode_value = store.unquote(unicode_value)
2379
2371
        if self.from_unicode is None or unicode_value is None:
2380
2372
            # Don't convert or nothing to convert
2381
2373
            return unicode_value
2393
2385
                raise errors.ConfigOptionValueError(self.name, unicode_value)
2394
2386
        return converted
2395
2387
 
 
2388
    def get_override(self):
 
2389
        value = None
 
2390
        for var in self.override_from_env:
 
2391
            try:
 
2392
                # If the env variable is defined, its value takes precedence
 
2393
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2394
                break
 
2395
            except KeyError:
 
2396
                continue
 
2397
        return value
 
2398
 
2396
2399
    def get_default(self):
2397
2400
        value = None
2398
2401
        for var in self.default_from_env:
2399
2402
            try:
2400
2403
                # If the env variable is defined, its value is the default one
2401
 
                value = os.environ[var]
 
2404
                value = os.environ[var].decode(osutils.get_user_encoding())
2402
2405
                break
2403
2406
            except KeyError:
2404
2407
                continue
2405
2408
        if value is None:
2406
2409
            # Otherwise, fallback to the value defined at registration
2407
 
            value = self.default
 
2410
            if callable(self.default):
 
2411
                value = self.default()
 
2412
                if not isinstance(value, unicode):
 
2413
                    raise AssertionError(
 
2414
                        "Callable default value for '%s' should be unicode"
 
2415
                        % (self.name))
 
2416
            else:
 
2417
                value = self.default
2408
2418
        return value
2409
2419
 
 
2420
    def get_help_topic(self):
 
2421
        return self.name
 
2422
 
2410
2423
    def get_help_text(self, additional_see_also=None, plain=True):
2411
2424
        result = self.help
2412
2425
        from bzrlib import help_topics
2426
2439
    return int(unicode_str)
2427
2440
 
2428
2441
 
 
2442
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
 
2443
 
 
2444
def int_SI_from_store(unicode_str):
 
2445
    """Convert a human readable size in SI units, e.g 10MB into an integer.
 
2446
 
 
2447
    Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
2448
    by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
2449
    pedantic.
 
2450
 
 
2451
    :return Integer, expanded to its base-10 value if a proper SI unit is 
 
2452
        found, None otherwise.
 
2453
    """
 
2454
    regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
 
2455
    p = re.compile(regexp, re.IGNORECASE)
 
2456
    m = p.match(unicode_str)
 
2457
    val = None
 
2458
    if m is not None:
 
2459
        val, _, unit = m.groups()
 
2460
        val = int(val)
 
2461
        if unit:
 
2462
            try:
 
2463
                coeff = _unit_suffixes[unit.upper()]
 
2464
            except KeyError:
 
2465
                raise ValueError(gettext('{0} is not an SI unit.').format(unit))
 
2466
            val *= coeff
 
2467
    return val
 
2468
 
 
2469
 
2429
2470
def float_from_store(unicode_str):
2430
2471
    return float(unicode_str)
2431
2472
 
2432
2473
 
2433
 
 
2434
 
# Use a an empty dict to initialize an empty configobj avoiding all
2435
 
# parsing and encoding checks
 
2474
# Use an empty dict to initialize an empty configobj avoiding all parsing and
 
2475
# encoding checks
2436
2476
_list_converter_config = configobj.ConfigObj(
2437
2477
    {}, encoding='utf-8', list_values=True, interpolation=False)
2438
2478
 
2439
2479
 
2440
 
def list_from_store(unicode_str):
2441
 
    if not isinstance(unicode_str, basestring):
2442
 
        raise TypeError
2443
 
    # Now inject our string directly as unicode. All callers got their value
2444
 
    # from configobj, so values that need to be quoted are already properly
2445
 
    # quoted.
2446
 
    _list_converter_config.reset()
2447
 
    _list_converter_config._parse([u"list=%s" % (unicode_str,)])
2448
 
    maybe_list = _list_converter_config['list']
2449
 
    # ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
2450
 
    if isinstance(maybe_list, basestring):
2451
 
        if maybe_list:
2452
 
            # A single value, most probably the user forgot (or didn't care to
2453
 
            # add) the final ','
2454
 
            l = [maybe_list]
 
2480
class ListOption(Option):
 
2481
 
 
2482
    def __init__(self, name, default=None, default_from_env=None,
 
2483
                 help=None, invalid=None):
 
2484
        """A list Option definition.
 
2485
 
 
2486
        This overrides the base class so the conversion from a unicode string
 
2487
        can take quoting into account.
 
2488
        """
 
2489
        super(ListOption, self).__init__(
 
2490
            name, default=default, default_from_env=default_from_env,
 
2491
            from_unicode=self.from_unicode, help=help,
 
2492
            invalid=invalid, unquote=False)
 
2493
 
 
2494
    def from_unicode(self, unicode_str):
 
2495
        if not isinstance(unicode_str, basestring):
 
2496
            raise TypeError
 
2497
        # Now inject our string directly as unicode. All callers got their
 
2498
        # value from configobj, so values that need to be quoted are already
 
2499
        # properly quoted.
 
2500
        _list_converter_config.reset()
 
2501
        _list_converter_config._parse([u"list=%s" % (unicode_str,)])
 
2502
        maybe_list = _list_converter_config['list']
 
2503
        if isinstance(maybe_list, basestring):
 
2504
            if maybe_list:
 
2505
                # A single value, most probably the user forgot (or didn't care
 
2506
                # to add) the final ','
 
2507
                l = [maybe_list]
 
2508
            else:
 
2509
                # The empty string, convert to empty list
 
2510
                l = []
2455
2511
        else:
2456
 
            # The empty string, convert to empty list
2457
 
            l = []
2458
 
    else:
2459
 
        # We rely on ConfigObj providing us with a list already
2460
 
        l = maybe_list
2461
 
    return l
 
2512
            # We rely on ConfigObj providing us with a list already
 
2513
            l = maybe_list
 
2514
        return l
 
2515
 
 
2516
 
 
2517
class RegistryOption(Option):
 
2518
    """Option for a choice from a registry."""
 
2519
 
 
2520
    def __init__(self, name, registry, default_from_env=None,
 
2521
                 help=None, invalid=None):
 
2522
        """A registry based Option definition.
 
2523
 
 
2524
        This overrides the base class so the conversion from a unicode string
 
2525
        can take quoting into account.
 
2526
        """
 
2527
        super(RegistryOption, self).__init__(
 
2528
            name, default=lambda: unicode(registry.default_key),
 
2529
            default_from_env=default_from_env,
 
2530
            from_unicode=self.from_unicode, help=help,
 
2531
            invalid=invalid, unquote=False)
 
2532
        self.registry = registry
 
2533
 
 
2534
    def from_unicode(self, unicode_str):
 
2535
        if not isinstance(unicode_str, basestring):
 
2536
            raise TypeError
 
2537
        try:
 
2538
            return self.registry.get(unicode_str)
 
2539
        except KeyError:
 
2540
            raise ValueError(
 
2541
                "Invalid value %s for %s."
 
2542
                "See help for a list of possible values." % (unicode_str,
 
2543
                    self.name))
 
2544
 
 
2545
    @property
 
2546
    def help(self):
 
2547
        ret = [self._help, "\n\nThe following values are supported:\n"]
 
2548
        for key in self.registry.keys():
 
2549
            ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
 
2550
        return "".join(ret)
 
2551
 
 
2552
 
 
2553
_option_ref_re = lazy_regex.lazy_compile('({[^\d\W](?:\.\w|\w)*})')
 
2554
"""Describes an expandable option reference.
 
2555
 
 
2556
We want to match the most embedded reference first.
 
2557
 
 
2558
I.e. for '{{foo}}' we will get '{foo}',
 
2559
for '{bar{baz}}' we will get '{baz}'
 
2560
"""
 
2561
 
 
2562
def iter_option_refs(string):
 
2563
    # Split isolate refs so every other chunk is a ref
 
2564
    is_ref = False
 
2565
    for chunk  in _option_ref_re.split(string):
 
2566
        yield is_ref, chunk
 
2567
        is_ref = not is_ref
2462
2568
 
2463
2569
 
2464
2570
class OptionRegistry(registry.Registry):
2468
2574
    some information from the option object itself.
2469
2575
    """
2470
2576
 
 
2577
    def _check_option_name(self, option_name):
 
2578
        """Ensures an option name is valid.
 
2579
 
 
2580
        :param option_name: The name to validate.
 
2581
        """
 
2582
        if _option_ref_re.match('{%s}' % option_name) is None:
 
2583
            raise errors.IllegalOptionName(option_name)
 
2584
 
2471
2585
    def register(self, option):
2472
2586
        """Register a new option to its name.
2473
2587
 
2474
2588
        :param option: The option to register. Its name is used as the key.
2475
2589
        """
 
2590
        self._check_option_name(option.name)
2476
2591
        super(OptionRegistry, self).register(option.name, option,
2477
2592
                                             help=option.help)
2478
2593
 
2487
2602
        :param member_name: the member of the module to return.  If empty or 
2488
2603
                None, get() will return the module itself.
2489
2604
        """
 
2605
        self._check_option_name(key)
2490
2606
        super(OptionRegistry, self).register_lazy(key,
2491
2607
                                                  module_name, member_name)
2492
2608
 
2505
2621
# Registered options in lexicographical order
2506
2622
 
2507
2623
option_registry.register(
 
2624
    Option('append_revisions_only',
 
2625
           default=None, from_unicode=bool_from_store, invalid='warning',
 
2626
           help='''\
 
2627
Whether to only append revisions to the mainline.
 
2628
 
 
2629
If this is set to true, then it is not possible to change the
 
2630
existing mainline of the branch.
 
2631
'''))
 
2632
option_registry.register(
 
2633
    ListOption('acceptable_keys',
 
2634
           default=None,
 
2635
           help="""\
 
2636
List of GPG key patterns which are acceptable for verification.
 
2637
"""))
 
2638
option_registry.register(
 
2639
    Option('add.maximum_file_size',
 
2640
           default=u'20MB', from_unicode=int_SI_from_store,
 
2641
           help="""\
 
2642
Size above which files should be added manually.
 
2643
 
 
2644
Files below this size are added automatically when using ``bzr add`` without
 
2645
arguments.
 
2646
 
 
2647
A negative value means disable the size check.
 
2648
"""))
 
2649
option_registry.register(
 
2650
    Option('bound',
 
2651
           default=None, from_unicode=bool_from_store,
 
2652
           help="""\
 
2653
Is the branch bound to ``bound_location``.
 
2654
 
 
2655
If set to "True", the branch should act as a checkout, and push each commit to
 
2656
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
2657
 
 
2658
See also: bound_location.
 
2659
"""))
 
2660
option_registry.register(
 
2661
    Option('bound_location',
 
2662
           default=None,
 
2663
           help="""\
 
2664
The location that commits should go to when acting as a checkout.
 
2665
 
 
2666
This option is normally set by ``bind``.
 
2667
 
 
2668
See also: bound.
 
2669
"""))
 
2670
option_registry.register(
 
2671
    Option('branch.fetch_tags', default=False,  from_unicode=bool_from_store,
 
2672
           help="""\
 
2673
Whether revisions associated with tags should be fetched.
 
2674
"""))
 
2675
option_registry.register_lazy(
 
2676
    'bzr.transform.orphan_policy', 'bzrlib.transform', 'opt_transform_orphan')
 
2677
option_registry.register(
2508
2678
    Option('bzr.workingtree.worth_saving_limit', default=10,
2509
2679
           from_unicode=int_from_store,  invalid='warning',
2510
2680
           help='''\
2517
2687
a file has been touched.
2518
2688
'''))
2519
2689
option_registry.register(
 
2690
    Option('bugtracker', default=None,
 
2691
           help='''\
 
2692
Default bug tracker to use.
 
2693
 
 
2694
This bug tracker will be used for example when marking bugs
 
2695
as fixed using ``bzr commit --fixes``, if no explicit
 
2696
bug tracker was specified.
 
2697
'''))
 
2698
option_registry.register(
 
2699
    Option('check_signatures', default=CHECK_IF_POSSIBLE,
 
2700
           from_unicode=signature_policy_from_unicode,
 
2701
           help='''\
 
2702
GPG checking policy.
 
2703
 
 
2704
Possible values: require, ignore, check-available (default)
 
2705
 
 
2706
this option will control whether bzr will require good gpg
 
2707
signatures, ignore them, or check them if they are
 
2708
present.
 
2709
'''))
 
2710
option_registry.register(
 
2711
    Option('child_submit_format',
 
2712
           help='''The preferred format of submissions to this branch.'''))
 
2713
option_registry.register(
 
2714
    Option('child_submit_to',
 
2715
           help='''Where submissions to this branch are mailed to.'''))
 
2716
option_registry.register(
 
2717
    Option('create_signatures', default=SIGN_WHEN_REQUIRED,
 
2718
           from_unicode=signing_policy_from_unicode,
 
2719
           help='''\
 
2720
GPG Signing policy.
 
2721
 
 
2722
Possible values: always, never, when-required (default)
 
2723
 
 
2724
This option controls whether bzr will always create
 
2725
gpg signatures or not on commits.
 
2726
'''))
 
2727
option_registry.register(
2520
2728
    Option('dirstate.fdatasync', default=True,
2521
2729
           from_unicode=bool_from_store,
2522
2730
           help='''\
2527
2735
should not be lost if the machine crashes.  See also repository.fdatasync.
2528
2736
'''))
2529
2737
option_registry.register(
2530
 
    Option('debug_flags', default=[], from_unicode=list_from_store,
 
2738
    ListOption('debug_flags', default=[],
2531
2739
           help='Debug flags to activate.'))
2532
2740
option_registry.register(
2533
2741
    Option('default_format', default='2a',
2546
2754
    Option('editor',
2547
2755
           help='The command called to launch an editor to enter a message.'))
2548
2756
option_registry.register(
 
2757
    Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
 
2758
           help='The users identity'))
 
2759
option_registry.register(
 
2760
    Option('gpg_signing_command',
 
2761
           default='gpg',
 
2762
           help="""\
 
2763
Program to use use for creating signatures.
 
2764
 
 
2765
This should support at least the -u and --clearsign options.
 
2766
"""))
 
2767
option_registry.register(
 
2768
    Option('gpg_signing_key',
 
2769
           default=None,
 
2770
           help="""\
 
2771
GPG key to use for signing.
 
2772
 
 
2773
This defaults to the first key associated with the users email.
 
2774
"""))
 
2775
option_registry.register(
2549
2776
    Option('ignore_missing_extensions', default=False,
2550
2777
           from_unicode=bool_from_store,
2551
2778
           help='''\
2569
2796
Otherwise, bzr will prompt as normal to break the lock.
2570
2797
'''))
2571
2798
option_registry.register(
 
2799
    Option('log_format', default='long',
 
2800
           help= '''\
 
2801
Log format to use when displaying revisions.
 
2802
 
 
2803
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
 
2804
may be provided by plugins.
 
2805
'''))
 
2806
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
 
2807
    'opt_mail_client')
 
2808
option_registry.register(
2572
2809
    Option('output_encoding',
2573
2810
           help= 'Unicode encoding for output'
2574
2811
           ' (terminal encoding if not specified).'))
2575
2812
option_registry.register(
 
2813
    Option('parent_location',
 
2814
           default=None,
 
2815
           help="""\
 
2816
The location of the default branch for pull or merge.
 
2817
 
 
2818
This option is normally set when creating a branch, the first ``pull`` or by
 
2819
``pull --remember``.
 
2820
"""))
 
2821
option_registry.register(
 
2822
    Option('post_commit', default=None,
 
2823
           help='''\
 
2824
Post commit functions.
 
2825
 
 
2826
An ordered list of python functions to call, separated by spaces.
 
2827
 
 
2828
Each function takes branch, rev_id as parameters.
 
2829
'''))
 
2830
option_registry.register_lazy('progress_bar', 'bzrlib.ui.text',
 
2831
                              'opt_progress_bar')
 
2832
option_registry.register(
 
2833
    Option('public_branch',
 
2834
           default=None,
 
2835
           help="""\
 
2836
A publically-accessible version of this branch.
 
2837
 
 
2838
This implies that the branch setting this option is not publically-accessible.
 
2839
Used and set by ``bzr send``.
 
2840
"""))
 
2841
option_registry.register(
 
2842
    Option('push_location',
 
2843
           default=None,
 
2844
           help="""\
 
2845
The location of the default branch for push.
 
2846
 
 
2847
This option is normally set by the first ``push`` or ``push --remember``.
 
2848
"""))
 
2849
option_registry.register(
2576
2850
    Option('push_strict', default=None,
2577
2851
           from_unicode=bool_from_store,
2578
2852
           help='''\
2591
2865
to physical disk.  This is somewhat slower, but means data should not be
2592
2866
lost if the machine crashes.  See also dirstate.fdatasync.
2593
2867
'''))
 
2868
option_registry.register_lazy('smtp_server',
 
2869
    'bzrlib.smtp_connection', 'smtp_server')
 
2870
option_registry.register_lazy('smtp_password',
 
2871
    'bzrlib.smtp_connection', 'smtp_password')
 
2872
option_registry.register_lazy('smtp_username',
 
2873
    'bzrlib.smtp_connection', 'smtp_username')
 
2874
option_registry.register(
 
2875
    Option('selftest.timeout',
 
2876
        default='600',
 
2877
        from_unicode=int_from_store,
 
2878
        help='Abort selftest if one test takes longer than this many seconds',
 
2879
        ))
 
2880
 
2594
2881
option_registry.register(
2595
2882
    Option('send_strict', default=None,
2596
2883
           from_unicode=bool_from_store,
2598
2885
The default value for ``send --strict``.
2599
2886
 
2600
2887
If present, defines the ``--strict`` option default value for checking
2601
 
uncommitted changes before pushing.
 
2888
uncommitted changes before sending a bundle.
2602
2889
'''))
2603
2890
 
2604
2891
option_registry.register(
2606
2893
           default=300.0, from_unicode=float_from_store,
2607
2894
           help="If we wait for a new request from a client for more than"
2608
2895
                " X seconds, consider the client idle, and hangup."))
 
2896
option_registry.register(
 
2897
    Option('stacked_on_location',
 
2898
           default=None,
 
2899
           help="""The location where this branch is stacked on."""))
 
2900
option_registry.register(
 
2901
    Option('submit_branch',
 
2902
           default=None,
 
2903
           help="""\
 
2904
The branch you intend to submit your current work to.
 
2905
 
 
2906
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
 
2907
by the ``submit:`` revision spec.
 
2908
"""))
 
2909
option_registry.register(
 
2910
    Option('submit_to',
 
2911
           help='''Where submissions from this branch are mailed to.'''))
 
2912
option_registry.register(
 
2913
    ListOption('suppress_warnings',
 
2914
           default=[],
 
2915
           help="List of warning classes to suppress."))
 
2916
option_registry.register(
 
2917
    Option('validate_signatures_in_log', default=False,
 
2918
           from_unicode=bool_from_store, invalid='warning',
 
2919
           help='''Whether to validate signatures in bzr log.'''))
 
2920
option_registry.register_lazy('ssl.ca_certs',
 
2921
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
 
2922
 
 
2923
option_registry.register_lazy('ssl.cert_reqs',
 
2924
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
2609
2925
 
2610
2926
 
2611
2927
class Section(object):
2621
2937
        # We re-use the dict-like object received
2622
2938
        self.options = options
2623
2939
 
2624
 
    def get(self, name, default=None):
 
2940
    def get(self, name, default=None, expand=True):
2625
2941
        return self.options.get(name, default)
2626
2942
 
 
2943
    def iter_option_names(self):
 
2944
        for k in self.options.iterkeys():
 
2945
            yield k
 
2946
 
2627
2947
    def __repr__(self):
2628
2948
        # Mostly for debugging use
2629
2949
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2631
2951
 
2632
2952
_NewlyCreatedOption = object()
2633
2953
"""Was the option created during the MutableSection lifetime"""
 
2954
_DeletedOption = object()
 
2955
"""Was the option deleted during the MutableSection lifetime"""
2634
2956
 
2635
2957
 
2636
2958
class MutableSection(Section):
2638
2960
 
2639
2961
    def __init__(self, section_id, options):
2640
2962
        super(MutableSection, self).__init__(section_id, options)
2641
 
        self.orig = {}
 
2963
        self.reset_changes()
2642
2964
 
2643
2965
    def set(self, name, value):
2644
2966
        if name not in self.options:
2649
2971
        self.options[name] = value
2650
2972
 
2651
2973
    def remove(self, name):
2652
 
        if name not in self.orig:
 
2974
        if name not in self.orig and name in self.options:
2653
2975
            self.orig[name] = self.get(name, None)
2654
2976
        del self.options[name]
2655
2977
 
 
2978
    def reset_changes(self):
 
2979
        self.orig = {}
 
2980
 
 
2981
    def apply_changes(self, dirty, store):
 
2982
        """Apply option value changes.
 
2983
 
 
2984
        ``self`` has been reloaded from the persistent storage. ``dirty``
 
2985
        contains the changes made since the previous loading.
 
2986
 
 
2987
        :param dirty: the mutable section containing the changes.
 
2988
 
 
2989
        :param store: the store containing the section
 
2990
        """
 
2991
        for k, expected in dirty.orig.iteritems():
 
2992
            actual = dirty.get(k, _DeletedOption)
 
2993
            reloaded = self.get(k, _NewlyCreatedOption)
 
2994
            if actual is _DeletedOption:
 
2995
                if k in self.options:
 
2996
                    self.remove(k)
 
2997
            else:
 
2998
                self.set(k, actual)
 
2999
            # Report concurrent updates in an ad-hoc way. This should only
 
3000
            # occurs when different processes try to update the same option
 
3001
            # which is not supported (as in: the config framework is not meant
 
3002
            # to be used as a sharing mechanism).
 
3003
            if expected != reloaded:
 
3004
                if actual is _DeletedOption:
 
3005
                    actual = '<DELETED>'
 
3006
                if reloaded is _NewlyCreatedOption:
 
3007
                    reloaded = '<CREATED>'
 
3008
                if expected is _NewlyCreatedOption:
 
3009
                    expected = '<CREATED>'
 
3010
                # Someone changed the value since we get it from the persistent
 
3011
                # storage.
 
3012
                trace.warning(gettext(
 
3013
                        "Option {0} in section {1} of {2} was changed"
 
3014
                        " from {3} to {4}. The {5} value will be saved.".format(
 
3015
                            k, self.id, store.external_url(), expected,
 
3016
                            reloaded, actual)))
 
3017
        # No need to keep track of these changes
 
3018
        self.reset_changes()
 
3019
 
2656
3020
 
2657
3021
class Store(object):
2658
3022
    """Abstract interface to persistent storage for configuration options."""
2660
3024
    readonly_section_class = Section
2661
3025
    mutable_section_class = MutableSection
2662
3026
 
 
3027
    def __init__(self):
 
3028
        # Which sections need to be saved (by section id). We use a dict here
 
3029
        # so the dirty sections can be shared by multiple callers.
 
3030
        self.dirty_sections = {}
 
3031
 
2663
3032
    def is_loaded(self):
2664
3033
        """Returns True if the Store has been loaded.
2665
3034
 
2688
3057
        """
2689
3058
        raise NotImplementedError(self.unload)
2690
3059
 
 
3060
    def quote(self, value):
 
3061
        """Quote a configuration option value for storing purposes.
 
3062
 
 
3063
        This allows Stacks to present values as they will be stored.
 
3064
        """
 
3065
        return value
 
3066
 
 
3067
    def unquote(self, value):
 
3068
        """Unquote a configuration option value into unicode.
 
3069
 
 
3070
        The received value is quoted as stored.
 
3071
        """
 
3072
        return value
 
3073
 
2691
3074
    def save(self):
2692
3075
        """Saves the Store to persistent storage."""
2693
3076
        raise NotImplementedError(self.save)
2694
3077
 
 
3078
    def _need_saving(self):
 
3079
        for s in self.dirty_sections.values():
 
3080
            if s.orig:
 
3081
                # At least one dirty section contains a modification
 
3082
                return True
 
3083
        return False
 
3084
 
 
3085
    def apply_changes(self, dirty_sections):
 
3086
        """Apply changes from dirty sections while checking for coherency.
 
3087
 
 
3088
        The Store content is discarded and reloaded from persistent storage to
 
3089
        acquire up-to-date values.
 
3090
 
 
3091
        Dirty sections are MutableSection which kept track of the value they
 
3092
        are expected to update.
 
3093
        """
 
3094
        # We need an up-to-date version from the persistent storage, unload the
 
3095
        # store. The reload will occur when needed (triggered by the first
 
3096
        # get_mutable_section() call below.
 
3097
        self.unload()
 
3098
        # Apply the changes from the preserved dirty sections
 
3099
        for section_id, dirty in dirty_sections.iteritems():
 
3100
            clean = self.get_mutable_section(section_id)
 
3101
            clean.apply_changes(dirty, self)
 
3102
        # Everything is clean now
 
3103
        self.dirty_sections = {}
 
3104
 
 
3105
    def save_changes(self):
 
3106
        """Saves the Store to persistent storage if changes occurred.
 
3107
 
 
3108
        Apply the changes recorded in the mutable sections to a store content
 
3109
        refreshed from persistent storage.
 
3110
        """
 
3111
        raise NotImplementedError(self.save_changes)
 
3112
 
2695
3113
    def external_url(self):
2696
3114
        raise NotImplementedError(self.external_url)
2697
3115
 
2698
3116
    def get_sections(self):
2699
3117
        """Returns an ordered iterable of existing sections.
2700
3118
 
2701
 
        :returns: An iterable of (name, dict).
 
3119
        :returns: An iterable of (store, section).
2702
3120
        """
2703
3121
        raise NotImplementedError(self.get_sections)
2704
3122
 
2705
 
    def get_mutable_section(self, section_name=None):
 
3123
    def get_mutable_section(self, section_id=None):
2706
3124
        """Returns the specified mutable section.
2707
3125
 
2708
 
        :param section_name: The section identifier
 
3126
        :param section_id: The section identifier
2709
3127
        """
2710
3128
        raise NotImplementedError(self.get_mutable_section)
2711
3129
 
2715
3133
                                    self.external_url())
2716
3134
 
2717
3135
 
 
3136
class CommandLineStore(Store):
 
3137
    "A store to carry command line overrides for the config options."""
 
3138
 
 
3139
    def __init__(self, opts=None):
 
3140
        super(CommandLineStore, self).__init__()
 
3141
        if opts is None:
 
3142
            opts = {}
 
3143
        self.options = {}
 
3144
        self.id = 'cmdline'
 
3145
 
 
3146
    def _reset(self):
 
3147
        # The dict should be cleared but not replaced so it can be shared.
 
3148
        self.options.clear()
 
3149
 
 
3150
    def _from_cmdline(self, overrides):
 
3151
        # Reset before accepting new definitions
 
3152
        self._reset()
 
3153
        for over in overrides:
 
3154
            try:
 
3155
                name, value = over.split('=', 1)
 
3156
            except ValueError:
 
3157
                raise errors.BzrCommandError(
 
3158
                    gettext("Invalid '%s', should be of the form 'name=value'")
 
3159
                    % (over,))
 
3160
            self.options[name] = value
 
3161
 
 
3162
    def external_url(self):
 
3163
        # Not an url but it makes debugging easier and is never needed
 
3164
        # otherwise
 
3165
        return 'cmdline'
 
3166
 
 
3167
    def get_sections(self):
 
3168
        yield self,  self.readonly_section_class(None, self.options)
 
3169
 
 
3170
 
2718
3171
class IniFileStore(Store):
2719
3172
    """A config Store using ConfigObj for storage.
2720
3173
 
2721
 
    :ivar transport: The transport object where the config file is located.
2722
 
 
2723
 
    :ivar file_name: The config file basename in the transport directory.
2724
 
 
2725
3174
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
2726
3175
        serialize/deserialize the config file.
2727
3176
    """
2728
3177
 
2729
 
    def __init__(self, transport, file_name):
 
3178
    def __init__(self):
2730
3179
        """A config Store using ConfigObj for storage.
2731
 
 
2732
 
        :param transport: The transport object where the config file is located.
2733
 
 
2734
 
        :param file_name: The config file basename in the transport directory.
2735
3180
        """
2736
3181
        super(IniFileStore, self).__init__()
2737
 
        self.transport = transport
2738
 
        self.file_name = file_name
2739
3182
        self._config_obj = None
2740
3183
 
2741
3184
    def is_loaded(self):
2743
3186
 
2744
3187
    def unload(self):
2745
3188
        self._config_obj = None
 
3189
        self.dirty_sections = {}
 
3190
 
 
3191
    def _load_content(self):
 
3192
        """Load the config file bytes.
 
3193
 
 
3194
        This should be provided by subclasses
 
3195
 
 
3196
        :return: Byte string
 
3197
        """
 
3198
        raise NotImplementedError(self._load_content)
 
3199
 
 
3200
    def _save_content(self, content):
 
3201
        """Save the config file bytes.
 
3202
 
 
3203
        This should be provided by subclasses
 
3204
 
 
3205
        :param content: Config file bytes to write
 
3206
        """
 
3207
        raise NotImplementedError(self._save_content)
2746
3208
 
2747
3209
    def load(self):
2748
3210
        """Load the store from the associated file."""
2749
3211
        if self.is_loaded():
2750
3212
            return
2751
 
        try:
2752
 
            content = self.transport.get_bytes(self.file_name)
2753
 
        except errors.PermissionDenied:
2754
 
            trace.warning("Permission denied while trying to load "
2755
 
                          "configuration store %s.", self.external_url())
2756
 
            raise
 
3213
        content = self._load_content()
2757
3214
        self._load_from_string(content)
2758
3215
        for hook in ConfigHooks['load']:
2759
3216
            hook(self)
2776
3233
        except UnicodeDecodeError:
2777
3234
            raise errors.ConfigContentError(self.external_url())
2778
3235
 
 
3236
    def save_changes(self):
 
3237
        if not self.is_loaded():
 
3238
            # Nothing to save
 
3239
            return
 
3240
        if not self._need_saving():
 
3241
            return
 
3242
        # Preserve the current version
 
3243
        dirty_sections = dict(self.dirty_sections.items())
 
3244
        self.apply_changes(dirty_sections)
 
3245
        # Save to the persistent storage
 
3246
        self.save()
 
3247
 
2779
3248
    def save(self):
2780
3249
        if not self.is_loaded():
2781
3250
            # Nothing to save
2782
3251
            return
2783
3252
        out = StringIO()
2784
3253
        self._config_obj.write(out)
2785
 
        self.transport.put_bytes(self.file_name, out.getvalue())
 
3254
        self._save_content(out.getvalue())
2786
3255
        for hook in ConfigHooks['save']:
2787
3256
            hook(self)
2788
3257
 
2789
 
    def external_url(self):
2790
 
        # FIXME: external_url should really accepts an optional relpath
2791
 
        # parameter (bug #750169) :-/ -- vila 2011-04-04
2792
 
        # The following will do in the interim but maybe we don't want to
2793
 
        # expose a path here but rather a config ID and its associated
2794
 
        # object </hand wawe>.
2795
 
        return urlutils.join(self.transport.external_url(), self.file_name)
2796
 
 
2797
3258
    def get_sections(self):
2798
3259
        """Get the configobj section in the file order.
2799
3260
 
2800
 
        :returns: An iterable of (name, dict).
 
3261
        :returns: An iterable of (store, section).
2801
3262
        """
2802
3263
        # We need a loaded store
2803
3264
        try:
2807
3268
            return
2808
3269
        cobj = self._config_obj
2809
3270
        if cobj.scalars:
2810
 
            yield self.readonly_section_class(None, cobj)
 
3271
            yield self, self.readonly_section_class(None, cobj)
2811
3272
        for section_name in cobj.sections:
2812
 
            yield self.readonly_section_class(section_name, cobj[section_name])
 
3273
            yield (self,
 
3274
                   self.readonly_section_class(section_name,
 
3275
                                               cobj[section_name]))
2813
3276
 
2814
 
    def get_mutable_section(self, section_name=None):
 
3277
    def get_mutable_section(self, section_id=None):
2815
3278
        # We need a loaded store
2816
3279
        try:
2817
3280
            self.load()
2818
3281
        except errors.NoSuchFile:
2819
3282
            # The file doesn't exist, let's pretend it was empty
2820
3283
            self._load_from_string('')
2821
 
        if section_name is None:
 
3284
        if section_id in self.dirty_sections:
 
3285
            # We already created a mutable section for this id
 
3286
            return self.dirty_sections[section_id]
 
3287
        if section_id is None:
2822
3288
            section = self._config_obj
2823
3289
        else:
2824
 
            section = self._config_obj.setdefault(section_name, {})
2825
 
        return self.mutable_section_class(section_name, section)
 
3290
            section = self._config_obj.setdefault(section_id, {})
 
3291
        mutable_section = self.mutable_section_class(section_id, section)
 
3292
        # All mutable sections can become dirty
 
3293
        self.dirty_sections[section_id] = mutable_section
 
3294
        return mutable_section
 
3295
 
 
3296
    def quote(self, value):
 
3297
        try:
 
3298
            # configobj conflates automagical list values and quoting
 
3299
            self._config_obj.list_values = True
 
3300
            return self._config_obj._quote(value)
 
3301
        finally:
 
3302
            self._config_obj.list_values = False
 
3303
 
 
3304
    def unquote(self, value):
 
3305
        if value and isinstance(value, basestring):
 
3306
            # _unquote doesn't handle None nor empty strings nor anything that
 
3307
            # is not a string, really.
 
3308
            value = self._config_obj._unquote(value)
 
3309
        return value
 
3310
 
 
3311
    def external_url(self):
 
3312
        # Since an IniFileStore can be used without a file (at least in tests),
 
3313
        # it's better to provide something than raising a NotImplementedError.
 
3314
        # All daughter classes are supposed to provide an implementation
 
3315
        # anyway.
 
3316
        return 'In-Process Store, no URL'
 
3317
 
 
3318
 
 
3319
class TransportIniFileStore(IniFileStore):
 
3320
    """IniFileStore that loads files from a transport.
 
3321
 
 
3322
    :ivar transport: The transport object where the config file is located.
 
3323
 
 
3324
    :ivar file_name: The config file basename in the transport directory.
 
3325
    """
 
3326
 
 
3327
    def __init__(self, transport, file_name):
 
3328
        """A Store using a ini file on a Transport
 
3329
 
 
3330
        :param transport: The transport object where the config file is located.
 
3331
        :param file_name: The config file basename in the transport directory.
 
3332
        """
 
3333
        super(TransportIniFileStore, self).__init__()
 
3334
        self.transport = transport
 
3335
        self.file_name = file_name
 
3336
 
 
3337
    def _load_content(self):
 
3338
        try:
 
3339
            return self.transport.get_bytes(self.file_name)
 
3340
        except errors.PermissionDenied:
 
3341
            trace.warning("Permission denied while trying to load "
 
3342
                          "configuration store %s.", self.external_url())
 
3343
            raise
 
3344
 
 
3345
    def _save_content(self, content):
 
3346
        self.transport.put_bytes(self.file_name, content)
 
3347
 
 
3348
    def external_url(self):
 
3349
        # FIXME: external_url should really accepts an optional relpath
 
3350
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
3351
        # The following will do in the interim but maybe we don't want to
 
3352
        # expose a path here but rather a config ID and its associated
 
3353
        # object </hand wawe>.
 
3354
        return urlutils.join(self.transport.external_url(), self.file_name)
2826
3355
 
2827
3356
 
2828
3357
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2831
3360
# they may face the same issue.
2832
3361
 
2833
3362
 
2834
 
class LockableIniFileStore(IniFileStore):
 
3363
class LockableIniFileStore(TransportIniFileStore):
2835
3364
    """A ConfigObjStore using locks on save to ensure store integrity."""
2836
3365
 
2837
3366
    def __init__(self, transport, file_name, lock_dir_name=None):
2882
3411
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2883
3412
# on a poolie's remark)
2884
3413
class GlobalStore(LockableIniFileStore):
 
3414
    """A config store for global options.
 
3415
 
 
3416
    There is a single GlobalStore for a given process.
 
3417
    """
2885
3418
 
2886
3419
    def __init__(self, possible_transports=None):
2887
3420
        t = transport.get_transport_from_path(
2888
3421
            config_dir(), possible_transports=possible_transports)
2889
3422
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
3423
        self.id = 'bazaar'
2890
3424
 
2891
3425
 
2892
3426
class LocationStore(LockableIniFileStore):
 
3427
    """A config store for options specific to a location.
 
3428
 
 
3429
    There is a single LocationStore for a given process.
 
3430
    """
2893
3431
 
2894
3432
    def __init__(self, possible_transports=None):
2895
3433
        t = transport.get_transport_from_path(
2896
3434
            config_dir(), possible_transports=possible_transports)
2897
3435
        super(LocationStore, self).__init__(t, 'locations.conf')
2898
 
 
2899
 
 
2900
 
class BranchStore(IniFileStore):
 
3436
        self.id = 'locations'
 
3437
 
 
3438
 
 
3439
class BranchStore(TransportIniFileStore):
 
3440
    """A config store for branch options.
 
3441
 
 
3442
    There is a single BranchStore for a given branch.
 
3443
    """
2901
3444
 
2902
3445
    def __init__(self, branch):
2903
3446
        super(BranchStore, self).__init__(branch.control_transport,
2904
3447
                                          'branch.conf')
2905
3448
        self.branch = branch
2906
 
 
2907
 
    def lock_write(self, token=None):
2908
 
        return self.branch.lock_write(token)
2909
 
 
2910
 
    def unlock(self):
2911
 
        return self.branch.unlock()
2912
 
 
2913
 
    @needs_write_lock
2914
 
    def save(self):
2915
 
        # We need to be able to override the undecorated implementation
2916
 
        self.save_without_locking()
2917
 
 
2918
 
    def save_without_locking(self):
2919
 
        super(BranchStore, self).save()
 
3449
        self.id = 'branch'
2920
3450
 
2921
3451
 
2922
3452
class ControlStore(LockableIniFileStore):
2925
3455
        super(ControlStore, self).__init__(bzrdir.transport,
2926
3456
                                          'control.conf',
2927
3457
                                           lock_dir_name='branch_lock')
 
3458
        self.id = 'control'
2928
3459
 
2929
3460
 
2930
3461
class SectionMatcher(object):
2942
3473
        # sections.
2943
3474
        sections = self.store.get_sections()
2944
3475
        # Walk the revisions in the order provided
2945
 
        for s in sections:
 
3476
        for store, s in sections:
2946
3477
            if self.match(s):
2947
 
                yield s
 
3478
                yield store, s
2948
3479
 
2949
3480
    def match(self, section):
2950
3481
        """Does the proposed section match.
2968
3499
 
2969
3500
class LocationSection(Section):
2970
3501
 
2971
 
    def __init__(self, section, length, extra_path):
 
3502
    def __init__(self, section, extra_path, branch_name=None):
2972
3503
        super(LocationSection, self).__init__(section.id, section.options)
2973
 
        self.length = length
2974
3504
        self.extra_path = extra_path
 
3505
        if branch_name is None:
 
3506
            branch_name = ''
 
3507
        self.locals = {'relpath': extra_path,
 
3508
                       'basename': urlutils.basename(extra_path),
 
3509
                       'branchname': branch_name}
2975
3510
 
2976
 
    def get(self, name, default=None):
 
3511
    def get(self, name, default=None, expand=True):
2977
3512
        value = super(LocationSection, self).get(name, default)
2978
 
        if value is not None:
 
3513
        if value is not None and expand:
2979
3514
            policy_name = self.get(name + ':policy', None)
2980
3515
            policy = _policy_value.get(policy_name, POLICY_NONE)
2981
3516
            if policy == POLICY_APPENDPATH:
2982
3517
                value = urlutils.join(value, self.extra_path)
 
3518
            # expand section local options right now (since POLICY_APPENDPATH
 
3519
            # will never add options references, it's ok to expand after it).
 
3520
            chunks = []
 
3521
            for is_ref, chunk in iter_option_refs(value):
 
3522
                if not is_ref:
 
3523
                    chunks.append(chunk)
 
3524
                else:
 
3525
                    ref = chunk[1:-1]
 
3526
                    if ref in self.locals:
 
3527
                        chunks.append(self.locals[ref])
 
3528
                    else:
 
3529
                        chunks.append(chunk)
 
3530
            value = ''.join(chunks)
2983
3531
        return value
2984
3532
 
2985
3533
 
 
3534
class StartingPathMatcher(SectionMatcher):
 
3535
    """Select sections for a given location respecting the Store order."""
 
3536
 
 
3537
    # FIXME: Both local paths and urls can be used for section names as well as
 
3538
    # ``location`` to stay consistent with ``LocationMatcher`` which itself
 
3539
    # inherited the fuzziness from the previous ``LocationConfig``
 
3540
    # implementation. We probably need to revisit which encoding is allowed for
 
3541
    # both ``location`` and section names and how we normalize
 
3542
    # them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
 
3543
    # related too. -- vila 2012-01-04
 
3544
 
 
3545
    def __init__(self, store, location):
 
3546
        super(StartingPathMatcher, self).__init__(store)
 
3547
        if location.startswith('file://'):
 
3548
            location = urlutils.local_path_from_url(location)
 
3549
        self.location = location
 
3550
 
 
3551
    def get_sections(self):
 
3552
        """Get all sections matching ``location`` in the store.
 
3553
 
 
3554
        The most generic sections are described first in the store, then more
 
3555
        specific ones can be provided for reduced scopes.
 
3556
 
 
3557
        The returned section are therefore returned in the reversed order so
 
3558
        the most specific ones can be found first.
 
3559
        """
 
3560
        location_parts = self.location.rstrip('/').split('/')
 
3561
        store = self.store
 
3562
        # Later sections are more specific, they should be returned first
 
3563
        for _, section in reversed(list(store.get_sections())):
 
3564
            if section.id is None:
 
3565
                # The no-name section is always included if present
 
3566
                yield store, LocationSection(section, self.location)
 
3567
                continue
 
3568
            section_path = section.id
 
3569
            if section_path.startswith('file://'):
 
3570
                # the location is already a local path or URL, convert the
 
3571
                # section id to the same format
 
3572
                section_path = urlutils.local_path_from_url(section_path)
 
3573
            if (self.location.startswith(section_path)
 
3574
                or fnmatch.fnmatch(self.location, section_path)):
 
3575
                section_parts = section_path.rstrip('/').split('/')
 
3576
                extra_path = '/'.join(location_parts[len(section_parts):])
 
3577
                yield store, LocationSection(section, extra_path)
 
3578
 
 
3579
 
2986
3580
class LocationMatcher(SectionMatcher):
2987
3581
 
2988
3582
    def __init__(self, store, location):
2989
3583
        super(LocationMatcher, self).__init__(store)
 
3584
        url, params = urlutils.split_segment_parameters(location)
2990
3585
        if location.startswith('file://'):
2991
3586
            location = urlutils.local_path_from_url(location)
2992
3587
        self.location = location
 
3588
        branch_name = params.get('branch')
 
3589
        if branch_name is None:
 
3590
            self.branch_name = urlutils.basename(self.location)
 
3591
        else:
 
3592
            self.branch_name = urlutils.unescape(branch_name)
2993
3593
 
2994
3594
    def _get_matching_sections(self):
2995
3595
        """Get all sections matching ``location``."""
2999
3599
        all_sections = []
3000
3600
        # Filter out the no_name_section so _iter_for_location_by_parts can be
3001
3601
        # used (it assumes all sections have a name).
3002
 
        for section in self.store.get_sections():
 
3602
        for _, section in self.store.get_sections():
3003
3603
            if section.id is None:
3004
3604
                no_name_section = section
3005
3605
            else:
3012
3612
        matching_sections = []
3013
3613
        if no_name_section is not None:
3014
3614
            matching_sections.append(
3015
 
                LocationSection(no_name_section, 0, self.location))
 
3615
                (0, LocationSection(no_name_section, self.location)))
3016
3616
        for section_id, extra_path, length in filtered_sections:
3017
3617
            # a section id is unique for a given store so it's safe to take the
3018
3618
            # first matching section while iterating. Also, all filtered
3021
3621
            while True:
3022
3622
                section = iter_all_sections.next()
3023
3623
                if section_id == section.id:
3024
 
                    matching_sections.append(
3025
 
                        LocationSection(section, length, extra_path))
 
3624
                    section = LocationSection(section, extra_path,
 
3625
                                              self.branch_name)
 
3626
                    matching_sections.append((length, section))
3026
3627
                    break
3027
3628
        return matching_sections
3028
3629
 
3031
3632
        matching_sections = self._get_matching_sections()
3032
3633
        # We want the longest (aka more specific) locations first
3033
3634
        sections = sorted(matching_sections,
3034
 
                          key=lambda section: (section.length, section.id),
 
3635
                          key=lambda (length, section): (length, section.id),
3035
3636
                          reverse=True)
3036
3637
        # Sections mentioning 'ignore_parents' restrict the selection
3037
 
        for section in sections:
 
3638
        for _, section in sections:
3038
3639
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
3039
3640
            ignore = section.get('ignore_parents', None)
3040
3641
            if ignore is not None:
3042
3643
            if ignore:
3043
3644
                break
3044
3645
            # Finally, we have a valid section
3045
 
            yield section
3046
 
 
 
3646
            yield self.store, section
 
3647
 
 
3648
 
 
3649
# FIXME: _shared_stores should be an attribute of a library state once a
 
3650
# library_state object is always available.
 
3651
_shared_stores = {}
 
3652
_shared_stores_at_exit_installed = False
3047
3653
 
3048
3654
class Stack(object):
3049
3655
    """A stack of configurations where an option can be defined"""
3050
3656
 
3051
 
    _option_ref_re = lazy_regex.lazy_compile('({[^{}]+})')
3052
 
    """Describes an exandable option reference.
3053
 
 
3054
 
    We want to match the most embedded reference first.
3055
 
 
3056
 
    I.e. for '{{foo}}' we will get '{foo}',
3057
 
    for '{bar{baz}}' we will get '{baz}'
3058
 
    """
3059
 
 
3060
 
    def __init__(self, sections_def, store=None, mutable_section_name=None):
 
3657
    def __init__(self, sections_def, store=None, mutable_section_id=None):
3061
3658
        """Creates a stack of sections with an optional store for changes.
3062
3659
 
3063
3660
        :param sections_def: A list of Section or callables that returns an
3067
3664
        :param store: The optional Store where modifications will be
3068
3665
            recorded. If none is specified, no modifications can be done.
3069
3666
 
3070
 
        :param mutable_section_name: The name of the MutableSection where
3071
 
            changes are recorded. This requires the ``store`` parameter to be
 
3667
        :param mutable_section_id: The id of the MutableSection where changes
 
3668
            are recorded. This requires the ``store`` parameter to be
3072
3669
            specified.
3073
3670
        """
3074
3671
        self.sections_def = sections_def
3075
3672
        self.store = store
3076
 
        self.mutable_section_name = mutable_section_name
3077
 
 
3078
 
    def get(self, name, expand=None):
 
3673
        self.mutable_section_id = mutable_section_id
 
3674
 
 
3675
    def iter_sections(self):
 
3676
        """Iterate all the defined sections."""
 
3677
        # Ensuring lazy loading is achieved by delaying section matching (which
 
3678
        # implies querying the persistent storage) until it can't be avoided
 
3679
        # anymore by using callables to describe (possibly empty) section
 
3680
        # lists.
 
3681
        for sections in self.sections_def:
 
3682
            for store, section in sections():
 
3683
                yield store, section
 
3684
 
 
3685
    def get(self, name, expand=True, convert=True):
3079
3686
        """Return the *first* option value found in the sections.
3080
3687
 
3081
3688
        This is where we guarantee that sections coming from Store are loaded
3088
3695
 
3089
3696
        :param expand: Whether options references should be expanded.
3090
3697
 
 
3698
        :param convert: Whether the option value should be converted from
 
3699
            unicode (do nothing for non-registered options).
 
3700
 
3091
3701
        :returns: The value of the option.
3092
3702
        """
3093
3703
        # FIXME: No caching of options nor sections yet -- vila 20110503
3094
 
        if expand is None:
3095
 
            expand = _get_expand_default_value()
3096
3704
        value = None
3097
 
        # Ensuring lazy loading is achieved by delaying section matching (which
3098
 
        # implies querying the persistent storage) until it can't be avoided
3099
 
        # anymore by using callables to describe (possibly empty) section
3100
 
        # lists.
3101
 
        for section_or_callable in self.sections_def:
3102
 
            # Each section can expand to multiple ones when a callable is used
3103
 
            if callable(section_or_callable):
3104
 
                sections = section_or_callable()
3105
 
            else:
3106
 
                sections = [section_or_callable]
3107
 
            for section in sections:
3108
 
                value = section.get(name)
3109
 
                if value is not None:
3110
 
                    break
3111
 
            if value is not None:
3112
 
                break
 
3705
        found_store = None # Where the option value has been found
3113
3706
        # If the option is registered, it may provide additional info about
3114
3707
        # value handling
3115
3708
        try:
3117
3710
        except KeyError:
3118
3711
            # Not registered
3119
3712
            opt = None
 
3713
 
3120
3714
        def expand_and_convert(val):
3121
 
            # This may need to be called twice if the value is None or ends up
3122
 
            # being None during expansion or conversion.
 
3715
            # This may need to be called in different contexts if the value is
 
3716
            # None or ends up being None during expansion or conversion.
3123
3717
            if val is not None:
3124
3718
                if expand:
3125
3719
                    if isinstance(val, basestring):
3128
3722
                        trace.warning('Cannot expand "%s":'
3129
3723
                                      ' %s does not support option expansion'
3130
3724
                                      % (name, type(val)))
3131
 
                if opt is not None:
3132
 
                    val = opt.convert_from_unicode(val)
 
3725
                if opt is None:
 
3726
                    val = found_store.unquote(val)
 
3727
                elif convert:
 
3728
                    val = opt.convert_from_unicode(found_store, val)
3133
3729
            return val
3134
 
        value = expand_and_convert(value)
3135
 
        if opt is not None and value is None:
3136
 
            # If the option is registered, it may provide a default value
3137
 
            value = opt.get_default()
3138
 
            value = expand_and_convert(value)
 
3730
 
 
3731
        # First of all, check if the environment can override the configuration
 
3732
        # value
 
3733
        if opt is not None and opt.override_from_env:
 
3734
            value = opt.get_override()
 
3735
            value = expand_and_convert(value)
 
3736
        if value is None:
 
3737
            for store, section in self.iter_sections():
 
3738
                value = section.get(name)
 
3739
                if value is not None:
 
3740
                    found_store = store
 
3741
                    break
 
3742
            value = expand_and_convert(value)
 
3743
            if opt is not None and value is None:
 
3744
                # If the option is registered, it may provide a default value
 
3745
                value = opt.get_default()
 
3746
                value = expand_and_convert(value)
3139
3747
        for hook in ConfigHooks['get']:
3140
3748
            hook(self, name, value)
3141
3749
        return value
3174
3782
        result = string
3175
3783
        # We need to iterate until no more refs appear ({{foo}} will need two
3176
3784
        # iterations for example).
3177
 
        while True:
3178
 
            raw_chunks = Stack._option_ref_re.split(result)
3179
 
            if len(raw_chunks) == 1:
3180
 
                # Shorcut the trivial case: no refs
3181
 
                return result
 
3785
        expanded = True
 
3786
        while expanded:
 
3787
            expanded = False
3182
3788
            chunks = []
3183
 
            # Split will isolate refs so that every other chunk is a ref
3184
 
            chunk_is_ref = False
3185
 
            for chunk in raw_chunks:
3186
 
                if not chunk_is_ref:
 
3789
            for is_ref, chunk in iter_option_refs(result):
 
3790
                if not is_ref:
3187
3791
                    chunks.append(chunk)
3188
 
                    chunk_is_ref = True
3189
3792
                else:
 
3793
                    expanded = True
3190
3794
                    name = chunk[1:-1]
3191
3795
                    if name in _refs:
3192
3796
                        raise errors.OptionExpansionLoop(string, _refs)
3196
3800
                        raise errors.ExpandingUnknownOption(name, string)
3197
3801
                    chunks.append(value)
3198
3802
                    _refs.pop()
3199
 
                    chunk_is_ref = False
3200
3803
            result = ''.join(chunks)
3201
3804
        return result
3202
3805
 
3206
3809
            # anything else
3207
3810
            value = env[name]
3208
3811
        else:
3209
 
            # FIXME: This is a limited implementation, what we really need is a
3210
 
            # way to query the bzr config for the value of an option,
3211
 
            # respecting the scope rules (That is, once we implement fallback
3212
 
            # configs, getting the option value should restart from the top
3213
 
            # config, not the current one) -- vila 20101222
3214
 
            value = self.get(name, expand=False)
 
3812
            value = self.get(name, expand=False, convert=False)
3215
3813
            value = self._expand_options_in_string(value, env, _refs)
3216
3814
        return value
3217
3815
 
3221
3819
        This is where we guarantee that the mutable section is lazily loaded:
3222
3820
        this means we won't load the corresponding store before setting a value
3223
3821
        or deleting an option. In practice the store will often be loaded but
3224
 
        this allows helps catching some programming errors.
 
3822
        this helps catching some programming errors.
3225
3823
        """
3226
 
        section = self.store.get_mutable_section(self.mutable_section_name)
3227
 
        return section
 
3824
        store = self.store
 
3825
        section = store.get_mutable_section(self.mutable_section_id)
 
3826
        return store, section
3228
3827
 
3229
3828
    def set(self, name, value):
3230
3829
        """Set a new value for the option."""
3231
 
        section = self._get_mutable_section()
3232
 
        section.set(name, value)
 
3830
        store, section = self._get_mutable_section()
 
3831
        section.set(name, store.quote(value))
3233
3832
        for hook in ConfigHooks['set']:
3234
3833
            hook(self, name, value)
3235
3834
 
3236
3835
    def remove(self, name):
3237
3836
        """Remove an existing option."""
3238
 
        section = self._get_mutable_section()
 
3837
        _, section = self._get_mutable_section()
3239
3838
        section.remove(name)
3240
3839
        for hook in ConfigHooks['remove']:
3241
3840
            hook(self, name)
3244
3843
        # Mostly for debugging use
3245
3844
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3246
3845
 
 
3846
    def _get_overrides(self):
 
3847
        # FIXME: Hack around library_state.initialize never called
 
3848
        if bzrlib.global_state is not None:
 
3849
            return bzrlib.global_state.cmdline_overrides.get_sections()
 
3850
        return []
 
3851
 
 
3852
    def get_shared_store(self, store, state=None):
 
3853
        """Get a known shared store.
 
3854
 
 
3855
        Store urls uniquely identify them and are used to ensure a single copy
 
3856
        is shared across all users.
 
3857
 
 
3858
        :param store: The store known to the caller.
 
3859
 
 
3860
        :param state: The library state where the known stores are kept.
 
3861
 
 
3862
        :returns: The store received if it's not a known one, an already known
 
3863
            otherwise.
 
3864
        """
 
3865
        if state is None:
 
3866
            state = bzrlib.global_state
 
3867
        if state is None:
 
3868
            global _shared_stores_at_exit_installed
 
3869
            stores = _shared_stores
 
3870
            def save_config_changes():
 
3871
                for k, store in stores.iteritems():
 
3872
                    store.save_changes()
 
3873
            if not _shared_stores_at_exit_installed:
 
3874
                # FIXME: Ugly hack waiting for library_state to always be
 
3875
                # available. -- vila 20120731
 
3876
                import atexit
 
3877
                atexit.register(save_config_changes)
 
3878
                _shared_stores_at_exit_installed = True
 
3879
        else:
 
3880
            stores = state.config_stores
 
3881
        url = store.external_url()
 
3882
        try:
 
3883
            return stores[url]
 
3884
        except KeyError:
 
3885
            stores[url] = store
 
3886
            return store
 
3887
 
 
3888
 
 
3889
class MemoryStack(Stack):
 
3890
    """A configuration stack defined from a string.
 
3891
 
 
3892
    This is mainly intended for tests and requires no disk resources.
 
3893
    """
 
3894
 
 
3895
    def __init__(self, content=None):
 
3896
        """Create an in-memory stack from a given content.
 
3897
 
 
3898
        It uses a single store based on configobj and support reading and
 
3899
        writing options.
 
3900
 
 
3901
        :param content: The initial content of the store. If None, the store is
 
3902
            not loaded and ``_load_from_string`` can and should be used if
 
3903
            needed.
 
3904
        """
 
3905
        store = IniFileStore()
 
3906
        if content is not None:
 
3907
            store._load_from_string(content)
 
3908
        super(MemoryStack, self).__init__(
 
3909
            [store.get_sections], store)
 
3910
 
3247
3911
 
3248
3912
class _CompatibleStack(Stack):
3249
3913
    """Place holder for compatibility with previous design.
3254
3918
    One assumption made here is that the daughter classes will all use Stores
3255
3919
    derived from LockableIniFileStore).
3256
3920
 
3257
 
    It implements set() by re-loading the store before applying the
3258
 
    modification and saving it.
 
3921
    It implements set() and remove () by re-loading the store before applying
 
3922
    the modification and saving it.
3259
3923
 
3260
3924
    The long term plan being to implement a single write by store to save
3261
3925
    all modifications, this class should not be used in the interim.
3268
3932
        # Force a write to persistent storage
3269
3933
        self.store.save()
3270
3934
 
3271
 
 
3272
 
class GlobalStack(_CompatibleStack):
3273
 
    """Global options only stack."""
 
3935
    def remove(self, name):
 
3936
        # Force a reload
 
3937
        self.store.unload()
 
3938
        super(_CompatibleStack, self).remove(name)
 
3939
        # Force a write to persistent storage
 
3940
        self.store.save()
 
3941
 
 
3942
 
 
3943
class GlobalStack(Stack):
 
3944
    """Global options only stack.
 
3945
 
 
3946
    The following sections are queried:
 
3947
 
 
3948
    * command-line overrides,
 
3949
 
 
3950
    * the 'DEFAULT' section in bazaar.conf
 
3951
 
 
3952
    This stack will use the ``DEFAULT`` section in bazaar.conf as its
 
3953
    MutableSection.
 
3954
    """
3274
3955
 
3275
3956
    def __init__(self):
3276
 
        # Get a GlobalStore
3277
 
        gstore = GlobalStore()
3278
 
        super(GlobalStack, self).__init__([gstore.get_sections], gstore)
3279
 
 
3280
 
 
3281
 
class LocationStack(_CompatibleStack):
3282
 
    """Per-location options falling back to global options stack."""
 
3957
        gstore = self.get_shared_store(GlobalStore())
 
3958
        super(GlobalStack, self).__init__(
 
3959
            [self._get_overrides,
 
3960
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3961
            gstore, mutable_section_id='DEFAULT')
 
3962
 
 
3963
 
 
3964
class LocationStack(Stack):
 
3965
    """Per-location options falling back to global options stack.
 
3966
 
 
3967
 
 
3968
    The following sections are queried:
 
3969
 
 
3970
    * command-line overrides,
 
3971
 
 
3972
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3973
      defined by the number of path components in the section glob, higher
 
3974
      numbers first (from most specific section to most generic).
 
3975
 
 
3976
    * the 'DEFAULT' section in bazaar.conf
 
3977
 
 
3978
    This stack will use the ``location`` section in locations.conf as its
 
3979
    MutableSection.
 
3980
    """
3283
3981
 
3284
3982
    def __init__(self, location):
3285
3983
        """Make a new stack for a location and global configuration.
3286
 
        
 
3984
 
3287
3985
        :param location: A URL prefix to """
3288
 
        lstore = LocationStore()
3289
 
        matcher = LocationMatcher(lstore, location)
3290
 
        gstore = GlobalStore()
 
3986
        lstore = self.get_shared_store(LocationStore())
 
3987
        if location.startswith('file://'):
 
3988
            location = urlutils.local_path_from_url(location)
 
3989
        gstore = self.get_shared_store(GlobalStore())
3291
3990
        super(LocationStack, self).__init__(
3292
 
            [matcher.get_sections, gstore.get_sections], lstore)
3293
 
 
3294
 
 
3295
 
class BranchStack(_CompatibleStack):
3296
 
    """Per-location options falling back to branch then global options stack."""
 
3991
            [self._get_overrides,
 
3992
             LocationMatcher(lstore, location).get_sections,
 
3993
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3994
            lstore, mutable_section_id=location)
 
3995
 
 
3996
 
 
3997
class BranchStack(Stack):
 
3998
    """Per-location options falling back to branch then global options stack.
 
3999
 
 
4000
    The following sections are queried:
 
4001
 
 
4002
    * command-line overrides,
 
4003
 
 
4004
    * the sections matching ``location`` in ``locations.conf``, the order being
 
4005
      defined by the number of path components in the section glob, higher
 
4006
      numbers first (from most specific section to most generic),
 
4007
 
 
4008
    * the no-name section in branch.conf,
 
4009
 
 
4010
    * the ``DEFAULT`` section in ``bazaar.conf``.
 
4011
 
 
4012
    This stack will use the no-name section in ``branch.conf`` as its
 
4013
    MutableSection.
 
4014
    """
3297
4015
 
3298
4016
    def __init__(self, branch):
3299
 
        bstore = BranchStore(branch)
3300
 
        lstore = LocationStore()
3301
 
        matcher = LocationMatcher(lstore, branch.base)
3302
 
        gstore = GlobalStore()
 
4017
        lstore = self.get_shared_store(LocationStore())
 
4018
        bstore = branch._get_config_store()
 
4019
        gstore = self.get_shared_store(GlobalStore())
3303
4020
        super(BranchStack, self).__init__(
3304
 
            [matcher.get_sections, bstore.get_sections, gstore.get_sections],
 
4021
            [self._get_overrides,
 
4022
             LocationMatcher(lstore, branch.base).get_sections,
 
4023
             NameMatcher(bstore, None).get_sections,
 
4024
             NameMatcher(gstore, 'DEFAULT').get_sections],
3305
4025
            bstore)
3306
4026
        self.branch = branch
3307
4027
 
3308
 
 
3309
 
class RemoteControlStack(_CompatibleStack):
 
4028
    def lock_write(self, token=None):
 
4029
        return self.branch.lock_write(token)
 
4030
 
 
4031
    def unlock(self):
 
4032
        return self.branch.unlock()
 
4033
 
 
4034
    @needs_write_lock
 
4035
    def set(self, name, value):
 
4036
        super(BranchStack, self).set(name, value)
 
4037
        # Unlocking the branch will trigger a store.save_changes() so the last
 
4038
        # unlock saves all the changes.
 
4039
 
 
4040
    @needs_write_lock
 
4041
    def remove(self, name):
 
4042
        super(BranchStack, self).remove(name)
 
4043
        # Unlocking the branch will trigger a store.save_changes() so the last
 
4044
        # unlock saves all the changes.
 
4045
 
 
4046
 
 
4047
class RemoteControlStack(Stack):
3310
4048
    """Remote control-only options stack."""
3311
4049
 
 
4050
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
4051
    # with the stack used for remote bzr dirs. RemoteControlStack only uses
 
4052
    # control.conf and is used only for stack options.
 
4053
 
3312
4054
    def __init__(self, bzrdir):
3313
 
        cstore = ControlStore(bzrdir)
 
4055
        cstore = bzrdir._get_config_store()
3314
4056
        super(RemoteControlStack, self).__init__(
3315
 
            [cstore.get_sections],
 
4057
            [NameMatcher(cstore, None).get_sections],
3316
4058
            cstore)
3317
4059
        self.bzrdir = bzrdir
3318
4060
 
3319
4061
 
3320
 
class RemoteBranchStack(_CompatibleStack):
3321
 
    """Remote branch-only options stack."""
 
4062
class BranchOnlyStack(Stack):
 
4063
    """Branch-only options stack."""
 
4064
 
 
4065
    # FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
 
4066
    # stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
 
4067
    # -- vila 2011-12-16
3322
4068
 
3323
4069
    def __init__(self, branch):
3324
 
        bstore = BranchStore(branch)
3325
 
        super(RemoteBranchStack, self).__init__(
3326
 
            [bstore.get_sections],
 
4070
        bstore = branch._get_config_store()
 
4071
        super(BranchOnlyStack, self).__init__(
 
4072
            [NameMatcher(bstore, None).get_sections],
3327
4073
            bstore)
3328
4074
        self.branch = branch
3329
4075
 
 
4076
    def lock_write(self, token=None):
 
4077
        return self.branch.lock_write(token)
 
4078
 
 
4079
    def unlock(self):
 
4080
        return self.branch.unlock()
 
4081
 
 
4082
    @needs_write_lock
 
4083
    def set(self, name, value):
 
4084
        super(BranchOnlyStack, self).set(name, value)
 
4085
        # Force a write to persistent storage
 
4086
        self.store.save_changes()
 
4087
 
 
4088
    @needs_write_lock
 
4089
    def remove(self, name):
 
4090
        super(BranchOnlyStack, self).remove(name)
 
4091
        # Force a write to persistent storage
 
4092
        self.store.save_changes()
 
4093
 
3330
4094
 
3331
4095
class cmd_config(commands.Command):
3332
4096
    __doc__ = """Display, set or remove a configuration option.
3333
4097
 
3334
 
    Display the active value for a given option.
 
4098
    Display the active value for option NAME.
3335
4099
 
3336
4100
    If --all is specified, NAME is interpreted as a regular expression and all
3337
 
    matching options are displayed mentioning their scope. The active value
3338
 
    that bzr will take into account is the first one displayed for each option.
3339
 
 
3340
 
    If no NAME is given, --all .* is implied.
3341
 
 
3342
 
    Setting a value is achieved by using name=value without spaces. The value
 
4101
    matching options are displayed mentioning their scope and without resolving
 
4102
    option references in the value). The active value that bzr will take into
 
4103
    account is the first one displayed for each option.
 
4104
 
 
4105
    If NAME is not given, --all .* is implied (all options are displayed for the
 
4106
    current scope).
 
4107
 
 
4108
    Setting a value is achieved by using NAME=value without spaces. The value
3343
4109
    is set in the most relevant scope and can be checked by displaying the
3344
4110
    option again.
 
4111
 
 
4112
    Removing a value is achieved by using --remove NAME.
3345
4113
    """
3346
4114
 
3347
4115
    takes_args = ['name?']
3349
4117
    takes_options = [
3350
4118
        'directory',
3351
4119
        # FIXME: This should be a registry option so that plugins can register
3352
 
        # their own config files (or not) -- vila 20101002
 
4120
        # their own config files (or not) and will also address
 
4121
        # http://pad.lv/788991 -- vila 20101115
3353
4122
        commands.Option('scope', help='Reduce the scope to the specified'
3354
 
                        ' configuration file',
 
4123
                        ' configuration file.',
3355
4124
                        type=unicode),
3356
4125
        commands.Option('all',
3357
4126
            help='Display all the defined values for the matching options.',
3358
4127
            ),
3359
4128
        commands.Option('remove', help='Remove the option from'
3360
 
                        ' the configuration file'),
 
4129
                        ' the configuration file.'),
3361
4130
        ]
3362
4131
 
3363
4132
    _see_also = ['configuration']
3367
4136
            remove=False):
3368
4137
        if directory is None:
3369
4138
            directory = '.'
 
4139
        directory = directory_service.directories.dereference(directory)
3370
4140
        directory = urlutils.normalize_url(directory)
3371
4141
        if remove and all:
3372
4142
            raise errors.BzrError(
3393
4163
                # Set the option value
3394
4164
                self._set_config_option(name, value, directory, scope)
3395
4165
 
3396
 
    def _get_configs(self, directory, scope=None):
3397
 
        """Iterate the configurations specified by ``directory`` and ``scope``.
 
4166
    def _get_stack(self, directory, scope=None, write_access=False):
 
4167
        """Get the configuration stack specified by ``directory`` and ``scope``.
3398
4168
 
3399
4169
        :param directory: Where the configurations are derived from.
3400
4170
 
3401
4171
        :param scope: A specific config to start from.
 
4172
 
 
4173
        :param write_access: Whether a write access to the stack will be
 
4174
            attempted.
3402
4175
        """
 
4176
        # FIXME: scope should allow access to plugin-specific stacks (even
 
4177
        # reduced to the plugin-specific store), related to
 
4178
        # http://pad.lv/788991 -- vila 2011-11-15
3403
4179
        if scope is not None:
3404
4180
            if scope == 'bazaar':
3405
 
                yield GlobalConfig()
 
4181
                return GlobalStack()
3406
4182
            elif scope == 'locations':
3407
 
                yield LocationConfig(directory)
 
4183
                return LocationStack(directory)
3408
4184
            elif scope == 'branch':
3409
 
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
3410
 
                    directory)
3411
 
                yield br.get_config()
 
4185
                (_, br, _) = (
 
4186
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4187
                        directory))
 
4188
                if write_access:
 
4189
                    self.add_cleanup(br.lock_write().unlock)
 
4190
                return br.get_config_stack()
 
4191
            raise errors.NoSuchConfig(scope)
3412
4192
        else:
3413
4193
            try:
3414
 
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
3415
 
                    directory)
3416
 
                yield br.get_config()
 
4194
                (_, br, _) = (
 
4195
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4196
                        directory))
 
4197
                if write_access:
 
4198
                    self.add_cleanup(br.lock_write().unlock)
 
4199
                return br.get_config_stack()
3417
4200
            except errors.NotBranchError:
3418
 
                yield LocationConfig(directory)
3419
 
                yield GlobalConfig()
 
4201
                return LocationStack(directory)
 
4202
 
 
4203
    def _quote_multiline(self, value):
 
4204
        if '\n' in value:
 
4205
            value = '"""' + value + '"""'
 
4206
        return value
3420
4207
 
3421
4208
    def _show_value(self, name, directory, scope):
3422
 
        displayed = False
3423
 
        for c in self._get_configs(directory, scope):
3424
 
            if displayed:
3425
 
                break
3426
 
            for (oname, value, section, conf_id, parser) in c._get_options():
3427
 
                if name == oname:
3428
 
                    # Display only the first value and exit
3429
 
 
3430
 
                    # FIXME: We need to use get_user_option to take policies
3431
 
                    # into account and we need to make sure the option exists
3432
 
                    # too (hence the two for loops), this needs a better API
3433
 
                    # -- vila 20101117
3434
 
                    value = c.get_user_option(name)
3435
 
                    # Quote the value appropriately
3436
 
                    value = parser._quote(value)
3437
 
                    self.outf.write('%s\n' % (value,))
3438
 
                    displayed = True
3439
 
                    break
3440
 
        if not displayed:
 
4209
        conf = self._get_stack(directory, scope)
 
4210
        value = conf.get(name, expand=True, convert=False)
 
4211
        if value is not None:
 
4212
            # Quote the value appropriately
 
4213
            value = self._quote_multiline(value)
 
4214
            self.outf.write('%s\n' % (value,))
 
4215
        else:
3441
4216
            raise errors.NoSuchConfigOption(name)
3442
4217
 
3443
4218
    def _show_matching_options(self, name, directory, scope):
3446
4221
        # avoid the delay introduced by the lazy regexp.  But, we still do
3447
4222
        # want the nicer errors raised by lazy_regex.
3448
4223
        name._compile_and_collapse()
3449
 
        cur_conf_id = None
 
4224
        cur_store_id = None
3450
4225
        cur_section = None
3451
 
        for c in self._get_configs(directory, scope):
3452
 
            for (oname, value, section, conf_id, parser) in c._get_options():
 
4226
        conf = self._get_stack(directory, scope)
 
4227
        for store, section in conf.iter_sections():
 
4228
            for oname in section.iter_option_names():
3453
4229
                if name.search(oname):
3454
 
                    if cur_conf_id != conf_id:
 
4230
                    if cur_store_id != store.id:
3455
4231
                        # Explain where the options are defined
3456
 
                        self.outf.write('%s:\n' % (conf_id,))
3457
 
                        cur_conf_id = conf_id
 
4232
                        self.outf.write('%s:\n' % (store.id,))
 
4233
                        cur_store_id = store.id
3458
4234
                        cur_section = None
3459
 
                    if (section not in (None, 'DEFAULT')
3460
 
                        and cur_section != section):
3461
 
                        # Display the section if it's not the default (or only)
3462
 
                        # one.
3463
 
                        self.outf.write('  [%s]\n' % (section,))
3464
 
                        cur_section = section
 
4235
                    if (section.id is not None and cur_section != section.id):
 
4236
                        # Display the section id as it appears in the store
 
4237
                        # (None doesn't appear by definition)
 
4238
                        self.outf.write('  [%s]\n' % (section.id,))
 
4239
                        cur_section = section.id
 
4240
                    value = section.get(oname, expand=False)
 
4241
                    # Quote the value appropriately
 
4242
                    value = self._quote_multiline(value)
3465
4243
                    self.outf.write('  %s = %s\n' % (oname, value))
3466
4244
 
3467
4245
    def _set_config_option(self, name, value, directory, scope):
3468
 
        for conf in self._get_configs(directory, scope):
3469
 
            conf.set_user_option(name, value)
3470
 
            break
3471
 
        else:
3472
 
            raise errors.NoSuchConfig(scope)
 
4246
        conf = self._get_stack(directory, scope, write_access=True)
 
4247
        conf.set(name, value)
 
4248
        # Explicitly save the changes
 
4249
        conf.store.save_changes()
3473
4250
 
3474
4251
    def _remove_config_option(self, name, directory, scope):
3475
4252
        if name is None:
3476
4253
            raise errors.BzrCommandError(
3477
4254
                '--remove expects an option to remove.')
3478
 
        removed = False
3479
 
        for conf in self._get_configs(directory, scope):
3480
 
            for (section_name, section, conf_id) in conf._get_sections():
3481
 
                if scope is not None and conf_id != scope:
3482
 
                    # Not the right configuration file
3483
 
                    continue
3484
 
                if name in section:
3485
 
                    if conf_id != conf.config_id():
3486
 
                        conf = self._get_configs(directory, conf_id).next()
3487
 
                    # We use the first section in the first config where the
3488
 
                    # option is defined to remove it
3489
 
                    conf.remove_user_option(name, section_name)
3490
 
                    removed = True
3491
 
                    break
3492
 
            break
3493
 
        else:
3494
 
            raise errors.NoSuchConfig(scope)
3495
 
        if not removed:
 
4255
        conf = self._get_stack(directory, scope, write_access=True)
 
4256
        try:
 
4257
            conf.remove(name)
 
4258
            # Explicitly save the changes
 
4259
            conf.store.save_changes()
 
4260
        except KeyError:
3496
4261
            raise errors.NoSuchConfigOption(name)
3497
4262
 
 
4263
 
3498
4264
# Test registries
3499
4265
#
3500
4266
# We need adapters that can build a Store or a Stack in a test context. Test
3503
4269
# ready-to-use store or stack.  Plugins that define new store/stacks can also
3504
4270
# register themselves here to be tested against the tests defined in
3505
4271
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3506
 
# for the same tests.
 
4272
# for the same test.
3507
4273
 
3508
4274
# The registered object should be a callable receiving a test instance
3509
4275
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store