← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-08-17 18:13:57 UTC
  • mfrom: (5268.7.29 transport-segments)
  • Revision ID: pqm@pqm.ubuntu.com-20110817181357-y5q5eth1hk8bl3om
(jelmer) Allow specifying the colocated branch to use in the branch URL,
 and retrieving the branch name using ControlDir._get_selected_branch.
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/config.py
1
 
# Copyright (C) 2005-2014, 2016 Canonical Ltd
 
1
# Copyright (C) 2005-2011 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
77
75
import os
 
76
import string
78
77
import sys
79
78
 
80
 
import bzrlib
 
79
 
81
80
from bzrlib.decorators import needs_write_lock
82
81
from bzrlib.lazy_import import lazy_import
83
82
lazy_import(globals(), """
84
 
import base64
85
83
import fnmatch
86
84
import re
 
85
from cStringIO import StringIO
87
86
 
88
87
from bzrlib import (
89
88
    atomicfile,
90
 
    controldir,
 
89
    bzrdir,
91
90
    debug,
92
 
    directory_service,
93
91
    errors,
94
92
    lazy_regex,
95
 
    library_state,
96
93
    lockdir,
 
94
    mail_client,
97
95
    mergetools,
98
96
    osutils,
99
97
    symbol_versioning,
103
101
    urlutils,
104
102
    win32utils,
105
103
    )
106
 
from bzrlib.i18n import gettext
107
104
from bzrlib.util.configobj import configobj
108
105
""")
109
106
from bzrlib import (
110
107
    commands,
111
108
    hooks,
112
 
    lazy_regex,
113
109
    registry,
114
110
    )
115
111
from bzrlib.symbol_versioning import (
152
148
STORE_GLOBAL = 4
153
149
 
154
150
 
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
 
 
179
151
class ConfigObj(configobj.ConfigObj):
180
152
 
181
153
    def __init__(self, infile=None, **kwargs):
197
169
        return self[section][name]
198
170
 
199
171
 
 
172
# FIXME: Until we can guarantee that each config file is loaded once and
 
173
# only once for a given bzrlib session, we don't want to re-read the file every
 
174
# time we query for an option so we cache the value (bad ! watch out for tests
 
175
# needing to restore the proper value). -- vila 20110219
 
176
_expand_default_value = None
 
177
def _get_expand_default_value():
 
178
    global _expand_default_value
 
179
    if _expand_default_value is not None:
 
180
        return _expand_default_value
 
181
    conf = GlobalConfig()
 
182
    # Note that we must not use None for the expand value below or we'll run
 
183
    # into infinite recursion. Using False really would be quite silly ;)
 
184
    expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
 
185
    if expand is None:
 
186
        # This is an opt-in feature, you *really* need to clearly say you want
 
187
        # to activate it !
 
188
        expand = False
 
189
    _expand_default_value = expand
 
190
    return expand
 
191
 
 
192
 
200
193
class Config(object):
201
194
    """A configuration policy - what username, editor, gpg needs etc."""
202
195
 
207
200
        """Returns a unique ID for the config."""
208
201
        raise NotImplementedError(self.config_id)
209
202
 
 
203
    @deprecated_method(deprecated_in((2, 4, 0)))
 
204
    def get_editor(self):
 
205
        """Get the users pop up editor."""
 
206
        raise NotImplementedError
 
207
 
210
208
    def get_change_editor(self, old_tree, new_tree):
211
209
        from bzrlib import diff
212
210
        cmd = self._get_change_editor()
215
213
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
216
214
                                             sys.stdout)
217
215
 
 
216
    def get_mail_client(self):
 
217
        """Get a mail client to use"""
 
218
        selected_client = self.get_user_option('mail_client')
 
219
        _registry = mail_client.mail_client_registry
 
220
        try:
 
221
            mail_client_class = _registry.get(selected_client)
 
222
        except KeyError:
 
223
            raise errors.UnknownMailClient(selected_client)
 
224
        return mail_client_class(self)
 
225
 
218
226
    def _get_signature_checking(self):
219
227
        """Template method to override signature checking policy."""
220
228
 
349
357
        """Template method to provide a user option."""
350
358
        return None
351
359
 
352
 
    def get_user_option(self, option_name, expand=True):
 
360
    def get_user_option(self, option_name, expand=None):
353
361
        """Get a generic option - no special process, no default.
354
362
 
355
363
        :param option_name: The queried option.
358
366
 
359
367
        :returns: The value of the option.
360
368
        """
 
369
        if expand is None:
 
370
            expand = _get_expand_default_value()
361
371
        value = self._get_user_option(option_name)
362
372
        if expand:
363
373
            if isinstance(value, list):
404
414
            l = [l]
405
415
        return l
406
416
 
407
 
    @deprecated_method(deprecated_in((2, 5, 0)))
408
 
    def get_user_option_as_int_from_SI(self, option_name, default=None):
409
 
        """Get a generic option from a human readable size in SI units, e.g 10MB
410
 
 
411
 
        Accepted suffixes are K,M,G. It is case-insensitive and may be followed
412
 
        by a trailing b (i.e. Kb, MB). This is intended to be practical and not
413
 
        pedantic.
414
 
 
415
 
        :return Integer, expanded to its base-10 value if a proper SI unit is 
416
 
            found. If the option doesn't exist, or isn't a value in 
417
 
            SI units, return default (which defaults to None)
418
 
        """
419
 
        val = self.get_user_option(option_name)
420
 
        if isinstance(val, list):
421
 
            val = val[0]
422
 
        if val is None:
423
 
            val = default
424
 
        else:
425
 
            p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
426
 
            try:
427
 
                m = p.match(val)
428
 
                if m is not None:
429
 
                    val = int(m.group(1))
430
 
                    if m.group(2) is not None:
431
 
                        if m.group(2).lower() == 'k':
432
 
                            val *= 10**3
433
 
                        elif m.group(2).lower() == 'm':
434
 
                            val *= 10**6
435
 
                        elif m.group(2).lower() == 'g':
436
 
                            val *= 10**9
437
 
                else:
438
 
                    ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
439
 
                                               ' value {1!r} is not an SI unit.').format(
440
 
                                                option_name, val))
441
 
                    val = default
442
 
            except TypeError:
443
 
                val = default
444
 
        return val
445
 
 
446
 
    @deprecated_method(deprecated_in((2, 5, 0)))
447
417
    def gpg_signing_command(self):
448
418
        """What program should be used to sign signatures?"""
449
419
        result = self._gpg_signing_command()
455
425
        """See gpg_signing_command()."""
456
426
        return None
457
427
 
458
 
    @deprecated_method(deprecated_in((2, 5, 0)))
459
428
    def log_format(self):
460
429
        """What log format should be used"""
461
430
        result = self._log_format()
480
449
        """See validate_signatures_in_log()."""
481
450
        return None
482
451
 
483
 
    @deprecated_method(deprecated_in((2, 5, 0)))
484
452
    def acceptable_keys(self):
485
453
        """Comma separated list of key patterns acceptable to 
486
454
        verify-signatures command"""
491
459
        """See acceptable_keys()."""
492
460
        return None
493
461
 
494
 
    @deprecated_method(deprecated_in((2, 5, 0)))
495
462
    def post_commit(self):
496
463
        """An ordered list of python functions to call.
497
464
 
523
490
        v = self._get_user_id()
524
491
        if v:
525
492
            return v
526
 
        return default_email()
 
493
        v = os.environ.get('EMAIL')
 
494
        if v:
 
495
            return v.decode(osutils.get_user_encoding())
 
496
        name, email = _auto_user_id()
 
497
        if name and email:
 
498
            return '%s <%s>' % (name, email)
 
499
        elif email:
 
500
            return email
 
501
        raise errors.NoWhoami()
527
502
 
528
503
    def ensure_username(self):
529
504
        """Raise errors.NoWhoami if username is not set.
532
507
        """
533
508
        self.username()
534
509
 
535
 
    @deprecated_method(deprecated_in((2, 5, 0)))
536
510
    def signature_checking(self):
537
511
        """What is the current policy for signature checking?."""
538
512
        policy = self._get_signature_checking()
540
514
            return policy
541
515
        return CHECK_IF_POSSIBLE
542
516
 
543
 
    @deprecated_method(deprecated_in((2, 5, 0)))
544
517
    def signing_policy(self):
545
518
        """What is the current policy for signature checking?."""
546
519
        policy = self._get_signing_policy()
548
521
            return policy
549
522
        return SIGN_WHEN_REQUIRED
550
523
 
551
 
    @deprecated_method(deprecated_in((2, 5, 0)))
552
524
    def signature_needed(self):
553
525
        """Is a signature needed when committing ?."""
554
526
        policy = self._get_signing_policy()
563
535
            return True
564
536
        return False
565
537
 
566
 
    @deprecated_method(deprecated_in((2, 5, 0)))
567
538
    def gpg_signing_key(self):
568
539
        """GPG user-id to sign commits"""
569
540
        key = self.get_user_option('gpg_signing_key')
611
582
        for (oname, value, section, conf_id, parser) in self._get_options():
612
583
            if oname.startswith('bzr.mergetool.'):
613
584
                tool_name = oname[len('bzr.mergetool.'):]
614
 
                tools[tool_name] = self.get_user_option(oname, False)
 
585
                tools[tool_name] = value
615
586
        trace.mutter('loaded merge tools: %r' % tools)
616
587
        return tools
617
588
 
854
825
        """See Config._get_signature_checking."""
855
826
        policy = self._get_user_option('check_signatures')
856
827
        if policy:
857
 
            return signature_policy_from_unicode(policy)
 
828
            return self._string_to_signature_policy(policy)
858
829
 
859
830
    def _get_signing_policy(self):
860
831
        """See Config._get_signing_policy"""
861
832
        policy = self._get_user_option('create_signatures')
862
833
        if policy:
863
 
            return signing_policy_from_unicode(policy)
 
834
            return self._string_to_signing_policy(policy)
864
835
 
865
836
    def _get_user_id(self):
866
837
        """Get the user id from the 'email' key in the current section."""
911
882
        """See Config.post_commit."""
912
883
        return self._get_user_option('post_commit')
913
884
 
 
885
    def _string_to_signature_policy(self, signature_string):
 
886
        """Convert a string to a signing policy."""
 
887
        if signature_string.lower() == 'check-available':
 
888
            return CHECK_IF_POSSIBLE
 
889
        if signature_string.lower() == 'ignore':
 
890
            return CHECK_NEVER
 
891
        if signature_string.lower() == 'require':
 
892
            return CHECK_ALWAYS
 
893
        raise errors.BzrError("Invalid signatures policy '%s'"
 
894
                              % signature_string)
 
895
 
 
896
    def _string_to_signing_policy(self, signature_string):
 
897
        """Convert a string to a signing policy."""
 
898
        if signature_string.lower() == 'when-required':
 
899
            return SIGN_WHEN_REQUIRED
 
900
        if signature_string.lower() == 'never':
 
901
            return SIGN_NEVER
 
902
        if signature_string.lower() == 'always':
 
903
            return SIGN_ALWAYS
 
904
        raise errors.BzrError("Invalid signing policy '%s'"
 
905
                              % signature_string)
 
906
 
914
907
    def _get_alias(self, value):
915
908
        try:
916
909
            return self._get_parser().get_value("ALIASES",
992
985
        # local transports are not shared. But if/when we start using
993
986
        # LockableConfig for other kind of transports, we will need to reuse
994
987
        # whatever connection is already established -- vila 20100929
995
 
        self.transport = transport.get_transport_from_path(self.dir)
 
988
        self.transport = transport.get_transport(self.dir)
996
989
        self._lock = lockdir.LockDir(self.transport, self.lock_name)
997
990
 
998
991
    def _create_from_string(self, unicode_bytes, save):
1053
1046
        conf._create_from_string(str_or_unicode, save)
1054
1047
        return conf
1055
1048
 
 
1049
    @deprecated_method(deprecated_in((2, 4, 0)))
 
1050
    def get_editor(self):
 
1051
        return self._get_user_option('editor')
 
1052
 
1056
1053
    @needs_write_lock
1057
1054
    def set_user_option(self, option, value):
1058
1055
        """Save option and its value in the configuration."""
1356
1353
        e.g. "John Hacker <jhacker@example.com>"
1357
1354
        This is looked up in the email controlfile for the branch.
1358
1355
        """
 
1356
        try:
 
1357
            return (self.branch._transport.get_bytes("email")
 
1358
                    .decode(osutils.get_user_encoding())
 
1359
                    .rstrip("\r\n"))
 
1360
        except errors.NoSuchFile, e:
 
1361
            pass
 
1362
 
1359
1363
        return self._get_best_value('_get_user_id')
1360
1364
 
1361
1365
    def _get_change_editor(self):
1441
1445
        value = self._get_explicit_nickname()
1442
1446
        if value is not None:
1443
1447
            return value
1444
 
        if self.branch.name:
1445
 
            return self.branch.name
1446
1448
        return urlutils.unescape(self.branch.base.split('/')[-2])
1447
1449
 
1448
1450
    def has_explicit_nickname(self):
1485
1487
 
1486
1488
 
1487
1489
def config_dir():
1488
 
    """Return per-user configuration directory as unicode string
 
1490
    """Return per-user configuration directory.
1489
1491
 
1490
1492
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1491
 
    and Linux.  On Mac OS X and Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
 
1493
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1492
1494
    that will be used instead.
1493
1495
 
1494
1496
    TODO: Global option --config-dir to override this.
1495
1497
    """
1496
 
    base = osutils.path_from_environ('BZR_HOME')
 
1498
    base = os.environ.get('BZR_HOME', None)
1497
1499
    if sys.platform == 'win32':
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.
 
1500
        # environ variables on Windows are in user encoding/mbcs. So decode
 
1501
        # before using one
 
1502
        if base is not None:
 
1503
            base = base.decode('mbcs')
 
1504
        if base is None:
 
1505
            base = win32utils.get_appdata_location_unicode()
 
1506
        if base is None:
 
1507
            base = os.environ.get('HOME', None)
 
1508
            if base is not None:
 
1509
                base = base.decode('mbcs')
 
1510
        if base is None:
 
1511
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
 
1512
                                  ' or HOME set')
1504
1513
        return osutils.pathjoin(base, 'bazaar', '2.0')
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")
 
1514
    else:
 
1515
        if base is not None:
 
1516
            base = base.decode(osutils._fs_enc)
 
1517
    if sys.platform == 'darwin':
 
1518
        if base is None:
 
1519
            # this takes into account $HOME
 
1520
            base = os.path.expanduser("~")
 
1521
        return osutils.pathjoin(base, '.bazaar')
 
1522
    else:
 
1523
        if base is None:
 
1524
            xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
 
1525
            if xdg_dir is None:
 
1526
                xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
 
1527
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
 
1528
            if osutils.isdir(xdg_dir):
 
1529
                trace.mutter(
 
1530
                    "Using configuration in XDG directory %s." % xdg_dir)
 
1531
                return xdg_dir
 
1532
            base = os.path.expanduser("~")
 
1533
        return osutils.pathjoin(base, ".bazaar")
1516
1534
 
1517
1535
 
1518
1536
def config_filename():
1555
1573
def xdg_cache_dir():
1556
1574
    # See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1557
1575
    # Possibly this should be different on Windows?
1558
 
    e = os.environ.get('XDG_CACHE_HOME', None)
 
1576
    e = os.environ.get('XDG_CACHE_DIR', None)
1559
1577
    if e:
1560
1578
        return e
1561
1579
    else:
1562
1580
        return os.path.expanduser('~/.cache')
1563
1581
 
1564
1582
 
1565
 
def _get_default_mail_domain(mailname_file='/etc/mailname'):
 
1583
def _get_default_mail_domain():
1566
1584
    """If possible, return the assumed default email domain.
1567
1585
 
1568
1586
    :returns: string mail domain, or None.
1571
1589
        # No implementation yet; patches welcome
1572
1590
        return None
1573
1591
    try:
1574
 
        f = open(mailname_file)
 
1592
        f = open('/etc/mailname')
1575
1593
    except (IOError, OSError), e:
1576
1594
        return None
1577
1595
    try:
1578
 
        domain = f.readline().strip()
 
1596
        domain = f.read().strip()
1579
1597
        return domain
1580
1598
    finally:
1581
1599
        f.close()
1582
1600
 
1583
1601
 
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
 
 
1599
1602
def _auto_user_id():
1600
1603
    """Calculate automatic user identification.
1601
1604
 
1790
1793
        :param user: login (optional)
1791
1794
 
1792
1795
        :param path: the absolute path on the server (optional)
1793
 
 
 
1796
        
1794
1797
        :param realm: the http authentication realm (optional)
1795
1798
 
1796
1799
        :return: A dict containing the matching credentials or None.
2131
2134
credential_store_registry.default_key = 'plain'
2132
2135
 
2133
2136
 
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
 
 
2147
2137
class BzrDirConfig(object):
2148
2138
 
2149
2139
    def __init__(self, bzrdir):
2155
2145
 
2156
2146
        It may be set to a location, or None.
2157
2147
 
2158
 
        This policy affects all branches contained by this control dir, except
2159
 
        for those under repositories.
 
2148
        This policy affects all branches contained by this bzrdir, except for
 
2149
        those under repositories.
2160
2150
        """
2161
2151
        if self._config is None:
2162
 
            raise errors.BzrError("Cannot set configuration in %s"
2163
 
                                  % self._bzrdir)
 
2152
            raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2164
2153
        if value is None:
2165
2154
            self._config.set_option('', 'default_stack_on')
2166
2155
        else:
2171
2160
 
2172
2161
        This will either be a location, or None.
2173
2162
 
2174
 
        This policy affects all branches contained by this control dir, except
2175
 
        for those under repositories.
 
2163
        This policy affects all branches contained by this bzrdir, except for
 
2164
        those under repositories.
2176
2165
        """
2177
2166
        if self._config is None:
2178
2167
            return None
2249
2238
            return f
2250
2239
        except errors.NoSuchFile:
2251
2240
            return StringIO()
2252
 
        except errors.PermissionDenied, e:
2253
 
            trace.warning("Permission denied while trying to open "
2254
 
                "configuration file %s.", urlutils.unescape_for_display(
2255
 
                urlutils.join(self._transport.base, self._filename), "utf-8"))
2256
 
            return StringIO()
2257
2241
 
2258
2242
    def _external_url(self):
2259
2243
        return urlutils.join(self._transport.external_url(), self._filename)
2290
2274
    encoutered, in which config files it can be stored.
2291
2275
    """
2292
2276
 
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):
 
2277
    def __init__(self, name, default=None, help=None, from_unicode=None,
 
2278
                 invalid=None):
2296
2279
        """Build an option definition.
2297
2280
 
2298
2281
        :param name: the name used to refer to the option.
2299
2282
 
2300
 
        :param override_from_env: A list of environment variables which can
2301
 
           provide override any configuration setting.
2302
 
 
2303
2283
        :param default: the default value to use when none exist in the config
2304
 
            stores. This is either a string that ``from_unicode`` will convert
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).
2309
 
 
2310
 
        :param default_from_env: A list of environment variables which can
2311
 
           provide a default value. 'default' will be used only if none of the
2312
 
           variables specified here are set in the environment.
 
2284
            stores.
2313
2285
 
2314
2286
        :param help: a doc string to explain the option to the user.
2315
2287
 
2316
2288
        :param from_unicode: a callable to convert the unicode string
2317
 
            representing the option value in a store or its default value.
 
2289
            representing the option value in a store. This is not called for
 
2290
            the default value.
2318
2291
 
2319
2292
        :param invalid: the action to be taken when an invalid value is
2320
2293
            encountered in a store. This is called only when from_unicode is
2322
2295
            TypeError. Accepted values are: None (ignore invalid values),
2323
2296
            'warning' (emit a warning), 'error' (emit an error message and
2324
2297
            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.
2330
2298
        """
2331
 
        if override_from_env is None:
2332
 
            override_from_env = []
2333
 
        if default_from_env is None:
2334
 
            default_from_env = []
2335
2299
        self.name = name
2336
 
        self.override_from_env = override_from_env
2337
 
        # Convert the default value to a unicode string so all values are
2338
 
        # strings internally before conversion (via from_unicode) is attempted.
2339
 
        if default is None:
2340
 
            self.default = None
2341
 
        elif isinstance(default, list):
2342
 
            # Only the empty list is supported
2343
 
            if default:
2344
 
                raise AssertionError(
2345
 
                    'Only empty lists are supported as default values')
2346
 
            self.default = u','
2347
 
        elif isinstance(default, (str, unicode, bool, int, float)):
2348
 
            # Rely on python to convert strings, booleans and integers
2349
 
            self.default = u'%s' % (default,)
2350
 
        elif callable(default):
2351
 
            self.default = default
2352
 
        else:
2353
 
            # other python objects are not expected
2354
 
            raise AssertionError('%r is not supported as a default value'
2355
 
                                 % (default,))
2356
 
        self.default_from_env = default_from_env
2357
 
        self._help = help
 
2300
        self.default = default
 
2301
        self.help = help
2358
2302
        self.from_unicode = from_unicode
2359
 
        self.unquote = unquote
2360
2303
        if invalid and invalid not in ('warning', 'error'):
2361
2304
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2362
2305
        self.invalid = invalid
2363
2306
 
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)
2371
 
        if self.from_unicode is None or unicode_value is None:
2372
 
            # Don't convert or nothing to convert
2373
 
            return unicode_value
2374
 
        try:
2375
 
            converted = self.from_unicode(unicode_value)
2376
 
        except (ValueError, TypeError):
2377
 
            # Invalid values are ignored
2378
 
            converted = None
2379
 
        if converted is None and self.invalid is not None:
2380
 
            # The conversion failed
2381
 
            if self.invalid == 'warning':
2382
 
                trace.warning('Value "%s" is not valid for "%s"',
2383
 
                              unicode_value, self.name)
2384
 
            elif self.invalid == 'error':
2385
 
                raise errors.ConfigOptionValueError(self.name, unicode_value)
2386
 
        return converted
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
 
 
2399
2307
    def get_default(self):
2400
 
        value = None
2401
 
        for var in self.default_from_env:
2402
 
            try:
2403
 
                # If the env variable is defined, its value is the default one
2404
 
                value = os.environ[var].decode(osutils.get_user_encoding())
2405
 
                break
2406
 
            except KeyError:
2407
 
                continue
2408
 
        if value is None:
2409
 
            # Otherwise, fallback to the value defined at registration
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
2418
 
        return value
2419
 
 
2420
 
    def get_help_topic(self):
2421
 
        return self.name
 
2308
        return self.default
2422
2309
 
2423
2310
    def get_help_text(self, additional_see_also=None, plain=True):
2424
2311
        result = self.help
2439
2326
    return int(unicode_str)
2440
2327
 
2441
2328
 
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
 
 
2470
 
def float_from_store(unicode_str):
2471
 
    return float(unicode_str)
2472
 
 
2473
 
 
2474
 
# Use an empty dict to initialize an empty configobj avoiding all parsing and
2475
 
# encoding checks
2476
 
_list_converter_config = configobj.ConfigObj(
2477
 
    {}, encoding='utf-8', list_values=True, interpolation=False)
2478
 
 
2479
 
 
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 = []
 
2329
def list_from_store(unicode_str):
 
2330
    # ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
 
2331
    if isinstance(unicode_str, (str, unicode)):
 
2332
        if unicode_str:
 
2333
            # A single value, most probably the user forgot (or didn't care to
 
2334
            # add) the final ','
 
2335
            l = [unicode_str]
2511
2336
        else:
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|\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
 
2337
            # The empty string, convert to empty list
 
2338
            l = []
 
2339
    else:
 
2340
        # We rely on ConfigObj providing us with a list already
 
2341
        l = unicode_str
 
2342
    return l
2568
2343
 
2569
2344
 
2570
2345
class OptionRegistry(registry.Registry):
2574
2349
    some information from the option object itself.
2575
2350
    """
2576
2351
 
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
 
 
2585
2352
    def register(self, option):
2586
2353
        """Register a new option to its name.
2587
2354
 
2588
2355
        :param option: The option to register. Its name is used as the key.
2589
2356
        """
2590
 
        self._check_option_name(option.name)
2591
2357
        super(OptionRegistry, self).register(option.name, option,
2592
2358
                                             help=option.help)
2593
2359
 
2602
2368
        :param member_name: the member of the module to return.  If empty or 
2603
2369
                None, get() will return the module itself.
2604
2370
        """
2605
 
        self._check_option_name(key)
2606
2371
        super(OptionRegistry, self).register_lazy(key,
2607
2372
                                                  module_name, member_name)
2608
2373
 
2621
2386
# Registered options in lexicographical order
2622
2387
 
2623
2388
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(
2678
2389
    Option('bzr.workingtree.worth_saving_limit', default=10,
2679
2390
           from_unicode=int_from_store,  invalid='warning',
2680
2391
           help='''\
2687
2398
a file has been touched.
2688
2399
'''))
2689
2400
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(
2728
2401
    Option('dirstate.fdatasync', default=True,
2729
2402
           from_unicode=bool_from_store,
2730
2403
           help='''\
2735
2408
should not be lost if the machine crashes.  See also repository.fdatasync.
2736
2409
'''))
2737
2410
option_registry.register(
2738
 
    ListOption('debug_flags', default=[],
 
2411
    Option('debug_flags', default=[], from_unicode=list_from_store,
2739
2412
           help='Debug flags to activate.'))
2740
2413
option_registry.register(
2741
2414
    Option('default_format', default='2a',
2742
2415
           help='Format used when creating branches.'))
2743
2416
option_registry.register(
2744
 
    Option('dpush_strict', default=None,
2745
 
           from_unicode=bool_from_store,
2746
 
           help='''\
2747
 
The default value for ``dpush --strict``.
2748
 
 
2749
 
If present, defines the ``--strict`` option default value for checking
2750
 
uncommitted changes before pushing into a different VCS without any
2751
 
custom bzr metadata.
2752
 
'''))
2753
 
option_registry.register(
2754
2417
    Option('editor',
2755
2418
           help='The command called to launch an editor to enter a message.'))
2756
2419
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(
2776
2420
    Option('ignore_missing_extensions', default=False,
2777
2421
           from_unicode=bool_from_store,
2778
2422
           help='''\
2796
2440
Otherwise, bzr will prompt as normal to break the lock.
2797
2441
'''))
2798
2442
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(
2809
2443
    Option('output_encoding',
2810
2444
           help= 'Unicode encoding for output'
2811
2445
           ' (terminal encoding if not specified).'))
2812
2446
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(
2850
 
    Option('push_strict', default=None,
2851
 
           from_unicode=bool_from_store,
2852
 
           help='''\
2853
 
The default value for ``push --strict``.
2854
 
 
2855
 
If present, defines the ``--strict`` option default value for checking
2856
 
uncommitted changes before sending a merge directive.
2857
 
'''))
2858
 
option_registry.register(
2859
 
    Option('repository.fdatasync', default=True,
2860
 
           from_unicode=bool_from_store,
 
2447
    Option('repository.fdatasync', default=True, from_unicode=bool_from_store,
2861
2448
           help='''\
2862
2449
Flush repository changes onto physical disk?
2863
2450
 
2865
2452
to physical disk.  This is somewhat slower, but means data should not be
2866
2453
lost if the machine crashes.  See also dirstate.fdatasync.
2867
2454
'''))
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
 
 
2881
 
option_registry.register(
2882
 
    Option('send_strict', default=None,
2883
 
           from_unicode=bool_from_store,
2884
 
           help='''\
2885
 
The default value for ``send --strict``.
2886
 
 
2887
 
If present, defines the ``--strict`` option default value for checking
2888
 
uncommitted changes before sending a bundle.
2889
 
'''))
2890
 
 
2891
 
option_registry.register(
2892
 
    Option('serve.client_timeout',
2893
 
           default=300.0, from_unicode=float_from_store,
2894
 
           help="If we wait for a new request from a client for more than"
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')
2925
2455
 
2926
2456
 
2927
2457
class Section(object):
2937
2467
        # We re-use the dict-like object received
2938
2468
        self.options = options
2939
2469
 
2940
 
    def get(self, name, default=None, expand=True):
 
2470
    def get(self, name, default=None):
2941
2471
        return self.options.get(name, default)
2942
2472
 
2943
 
    def iter_option_names(self):
2944
 
        for k in self.options.iterkeys():
2945
 
            yield k
2946
 
 
2947
2473
    def __repr__(self):
2948
2474
        # Mostly for debugging use
2949
2475
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2951
2477
 
2952
2478
_NewlyCreatedOption = object()
2953
2479
"""Was the option created during the MutableSection lifetime"""
2954
 
_DeletedOption = object()
2955
 
"""Was the option deleted during the MutableSection lifetime"""
2956
2480
 
2957
2481
 
2958
2482
class MutableSection(Section):
2960
2484
 
2961
2485
    def __init__(self, section_id, options):
2962
2486
        super(MutableSection, self).__init__(section_id, options)
2963
 
        self.reset_changes()
 
2487
        self.orig = {}
2964
2488
 
2965
2489
    def set(self, name, value):
2966
2490
        if name not in self.options:
2971
2495
        self.options[name] = value
2972
2496
 
2973
2497
    def remove(self, name):
2974
 
        if name not in self.orig and name in self.options:
 
2498
        if name not in self.orig:
2975
2499
            self.orig[name] = self.get(name, None)
2976
2500
        del self.options[name]
2977
2501
 
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
 
 
3020
2502
 
3021
2503
class Store(object):
3022
2504
    """Abstract interface to persistent storage for configuration options."""
3024
2506
    readonly_section_class = Section
3025
2507
    mutable_section_class = MutableSection
3026
2508
 
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
 
 
3032
2509
    def is_loaded(self):
3033
2510
        """Returns True if the Store has been loaded.
3034
2511
 
3057
2534
        """
3058
2535
        raise NotImplementedError(self.unload)
3059
2536
 
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
 
 
3074
2537
    def save(self):
3075
2538
        """Saves the Store to persistent storage."""
3076
2539
        raise NotImplementedError(self.save)
3077
2540
 
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
 
 
3113
2541
    def external_url(self):
3114
2542
        raise NotImplementedError(self.external_url)
3115
2543
 
3116
2544
    def get_sections(self):
3117
2545
        """Returns an ordered iterable of existing sections.
3118
2546
 
3119
 
        :returns: An iterable of (store, section).
 
2547
        :returns: An iterable of (name, dict).
3120
2548
        """
3121
2549
        raise NotImplementedError(self.get_sections)
3122
2550
 
3123
 
    def get_mutable_section(self, section_id=None):
 
2551
    def get_mutable_section(self, section_name=None):
3124
2552
        """Returns the specified mutable section.
3125
2553
 
3126
 
        :param section_id: The section identifier
 
2554
        :param section_name: The section identifier
3127
2555
        """
3128
2556
        raise NotImplementedError(self.get_mutable_section)
3129
2557
 
3133
2561
                                    self.external_url())
3134
2562
 
3135
2563
 
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
 
 
3171
2564
class IniFileStore(Store):
3172
2565
    """A config Store using ConfigObj for storage.
3173
2566
 
 
2567
    :ivar transport: The transport object where the config file is located.
 
2568
 
 
2569
    :ivar file_name: The config file basename in the transport directory.
 
2570
 
3174
2571
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
3175
2572
        serialize/deserialize the config file.
3176
2573
    """
3177
2574
 
3178
 
    def __init__(self):
 
2575
    def __init__(self, transport, file_name):
3179
2576
        """A config Store using ConfigObj for storage.
 
2577
 
 
2578
        :param transport: The transport object where the config file is located.
 
2579
 
 
2580
        :param file_name: The config file basename in the transport directory.
3180
2581
        """
3181
2582
        super(IniFileStore, self).__init__()
 
2583
        self.transport = transport
 
2584
        self.file_name = file_name
3182
2585
        self._config_obj = None
3183
2586
 
3184
2587
    def is_loaded(self):
3186
2589
 
3187
2590
    def unload(self):
3188
2591
        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)
3208
2592
 
3209
2593
    def load(self):
3210
2594
        """Load the store from the associated file."""
3211
2595
        if self.is_loaded():
3212
2596
            return
3213
 
        content = self._load_content()
 
2597
        content = self.transport.get_bytes(self.file_name)
3214
2598
        self._load_from_string(content)
3215
2599
        for hook in ConfigHooks['load']:
3216
2600
            hook(self)
3225
2609
        co_input = StringIO(bytes)
3226
2610
        try:
3227
2611
            # The config files are always stored utf8-encoded
3228
 
            self._config_obj = ConfigObj(co_input, encoding='utf-8',
3229
 
                                         list_values=False)
 
2612
            self._config_obj = ConfigObj(co_input, encoding='utf-8')
3230
2613
        except configobj.ConfigObjError, e:
3231
2614
            self._config_obj = None
3232
2615
            raise errors.ParseConfigError(e.errors, self.external_url())
3233
2616
        except UnicodeDecodeError:
3234
2617
            raise errors.ConfigContentError(self.external_url())
3235
2618
 
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
 
 
3248
2619
    def save(self):
3249
2620
        if not self.is_loaded():
3250
2621
            # Nothing to save
3251
2622
            return
3252
2623
        out = StringIO()
3253
2624
        self._config_obj.write(out)
3254
 
        self._save_content(out.getvalue())
 
2625
        self.transport.put_bytes(self.file_name, out.getvalue())
3255
2626
        for hook in ConfigHooks['save']:
3256
2627
            hook(self)
3257
2628
 
 
2629
    def external_url(self):
 
2630
        # FIXME: external_url should really accepts an optional relpath
 
2631
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
2632
        # The following will do in the interim but maybe we don't want to
 
2633
        # expose a path here but rather a config ID and its associated
 
2634
        # object </hand wawe>.
 
2635
        return urlutils.join(self.transport.external_url(), self.file_name)
 
2636
 
3258
2637
    def get_sections(self):
3259
2638
        """Get the configobj section in the file order.
3260
2639
 
3261
 
        :returns: An iterable of (store, section).
 
2640
        :returns: An iterable of (name, dict).
3262
2641
        """
3263
2642
        # We need a loaded store
3264
2643
        try:
3265
2644
            self.load()
3266
 
        except (errors.NoSuchFile, errors.PermissionDenied):
3267
 
            # If the file can't be read, there is no sections
 
2645
        except errors.NoSuchFile:
 
2646
            # If the file doesn't exist, there is no sections
3268
2647
            return
3269
2648
        cobj = self._config_obj
3270
2649
        if cobj.scalars:
3271
 
            yield self, self.readonly_section_class(None, cobj)
 
2650
            yield self.readonly_section_class(None, cobj)
3272
2651
        for section_name in cobj.sections:
3273
 
            yield (self,
3274
 
                   self.readonly_section_class(section_name,
3275
 
                                               cobj[section_name]))
 
2652
            yield self.readonly_section_class(section_name, cobj[section_name])
3276
2653
 
3277
 
    def get_mutable_section(self, section_id=None):
 
2654
    def get_mutable_section(self, section_name=None):
3278
2655
        # We need a loaded store
3279
2656
        try:
3280
2657
            self.load()
3281
2658
        except errors.NoSuchFile:
3282
2659
            # The file doesn't exist, let's pretend it was empty
3283
2660
            self._load_from_string('')
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:
 
2661
        if section_name is None:
3288
2662
            section = self._config_obj
3289
2663
        else:
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)
 
2664
            section = self._config_obj.setdefault(section_name, {})
 
2665
        return self.mutable_section_class(section_name, section)
3355
2666
 
3356
2667
 
3357
2668
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3360
2671
# they may face the same issue.
3361
2672
 
3362
2673
 
3363
 
class LockableIniFileStore(TransportIniFileStore):
 
2674
class LockableIniFileStore(IniFileStore):
3364
2675
    """A ConfigObjStore using locks on save to ensure store integrity."""
3365
2676
 
3366
2677
    def __init__(self, transport, file_name, lock_dir_name=None):
3411
2722
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3412
2723
# on a poolie's remark)
3413
2724
class GlobalStore(LockableIniFileStore):
3414
 
    """A config store for global options.
3415
 
 
3416
 
    There is a single GlobalStore for a given process.
3417
 
    """
3418
2725
 
3419
2726
    def __init__(self, possible_transports=None):
3420
2727
        t = transport.get_transport_from_path(
3421
2728
            config_dir(), possible_transports=possible_transports)
3422
2729
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
3423
 
        self.id = 'bazaar'
3424
2730
 
3425
2731
 
3426
2732
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
 
    """
3431
2733
 
3432
2734
    def __init__(self, possible_transports=None):
3433
2735
        t = transport.get_transport_from_path(
3434
2736
            config_dir(), possible_transports=possible_transports)
3435
2737
        super(LocationStore, self).__init__(t, 'locations.conf')
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
 
    """
 
2738
 
 
2739
 
 
2740
class BranchStore(IniFileStore):
3444
2741
 
3445
2742
    def __init__(self, branch):
3446
2743
        super(BranchStore, self).__init__(branch.control_transport,
3447
2744
                                          'branch.conf')
3448
2745
        self.branch = branch
3449
 
        self.id = 'branch'
3450
 
 
3451
 
 
3452
 
class ControlStore(LockableIniFileStore):
3453
 
 
3454
 
    def __init__(self, bzrdir):
3455
 
        super(ControlStore, self).__init__(bzrdir.transport,
3456
 
                                          'control.conf',
3457
 
                                           lock_dir_name='branch_lock')
3458
 
        self.id = 'control'
 
2746
 
 
2747
    def lock_write(self, token=None):
 
2748
        return self.branch.lock_write(token)
 
2749
 
 
2750
    def unlock(self):
 
2751
        return self.branch.unlock()
 
2752
 
 
2753
    @needs_write_lock
 
2754
    def save(self):
 
2755
        # We need to be able to override the undecorated implementation
 
2756
        self.save_without_locking()
 
2757
 
 
2758
    def save_without_locking(self):
 
2759
        super(BranchStore, self).save()
3459
2760
 
3460
2761
 
3461
2762
class SectionMatcher(object):
3462
2763
    """Select sections into a given Store.
3463
2764
 
3464
 
    This is intended to be used to postpone getting an iterable of sections
3465
 
    from a store.
 
2765
    This intended to be used to postpone getting an iterable of sections from a
 
2766
    store.
3466
2767
    """
3467
2768
 
3468
2769
    def __init__(self, store):
3473
2774
        # sections.
3474
2775
        sections = self.store.get_sections()
3475
2776
        # Walk the revisions in the order provided
3476
 
        for store, s in sections:
 
2777
        for s in sections:
3477
2778
            if self.match(s):
3478
 
                yield store, s
3479
 
 
3480
 
    def match(self, section):
3481
 
        """Does the proposed section match.
3482
 
 
3483
 
        :param section: A Section object.
3484
 
 
3485
 
        :returns: True if the section matches, False otherwise.
3486
 
        """
 
2779
                yield s
 
2780
 
 
2781
    def match(self, secion):
3487
2782
        raise NotImplementedError(self.match)
3488
2783
 
3489
2784
 
3490
 
class NameMatcher(SectionMatcher):
3491
 
 
3492
 
    def __init__(self, store, section_id):
3493
 
        super(NameMatcher, self).__init__(store)
3494
 
        self.section_id = section_id
3495
 
 
3496
 
    def match(self, section):
3497
 
        return section.id == self.section_id
3498
 
 
3499
 
 
3500
2785
class LocationSection(Section):
3501
2786
 
3502
 
    def __init__(self, section, extra_path, branch_name=None):
 
2787
    def __init__(self, section, length, extra_path):
3503
2788
        super(LocationSection, self).__init__(section.id, section.options)
 
2789
        self.length = length
3504
2790
        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}
3510
2791
 
3511
 
    def get(self, name, default=None, expand=True):
 
2792
    def get(self, name, default=None):
3512
2793
        value = super(LocationSection, self).get(name, default)
3513
 
        if value is not None and expand:
 
2794
        if value is not None:
3514
2795
            policy_name = self.get(name + ':policy', None)
3515
2796
            policy = _policy_value.get(policy_name, POLICY_NONE)
3516
2797
            if policy == POLICY_APPENDPATH:
3517
2798
                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)
3531
2799
        return value
3532
2800
 
3533
2801
 
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
 
 
3580
2802
class LocationMatcher(SectionMatcher):
3581
2803
 
3582
2804
    def __init__(self, store, location):
3583
2805
        super(LocationMatcher, self).__init__(store)
3584
 
        url, params = urlutils.split_segment_parameters(location)
3585
2806
        if location.startswith('file://'):
3586
2807
            location = urlutils.local_path_from_url(location)
3587
2808
        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)
3593
2809
 
3594
2810
    def _get_matching_sections(self):
3595
2811
        """Get all sections matching ``location``."""
3596
2812
        # We slightly diverge from LocalConfig here by allowing the no-name
3597
2813
        # section as the most generic one and the lower priority.
3598
2814
        no_name_section = None
3599
 
        all_sections = []
 
2815
        sections = []
3600
2816
        # Filter out the no_name_section so _iter_for_location_by_parts can be
3601
2817
        # used (it assumes all sections have a name).
3602
 
        for _, section in self.store.get_sections():
 
2818
        for section in self.store.get_sections():
3603
2819
            if section.id is None:
3604
2820
                no_name_section = section
3605
2821
            else:
3606
 
                all_sections.append(section)
 
2822
                sections.append(section)
3607
2823
        # Unfortunately _iter_for_location_by_parts deals with section names so
3608
2824
        # we have to resync.
3609
2825
        filtered_sections = _iter_for_location_by_parts(
3610
 
            [s.id for s in all_sections], self.location)
3611
 
        iter_all_sections = iter(all_sections)
 
2826
            [s.id for s in sections], self.location)
 
2827
        iter_sections = iter(sections)
3612
2828
        matching_sections = []
3613
2829
        if no_name_section is not None:
3614
2830
            matching_sections.append(
3615
 
                (0, LocationSection(no_name_section, self.location)))
 
2831
                LocationSection(no_name_section, 0, self.location))
3616
2832
        for section_id, extra_path, length in filtered_sections:
3617
 
            # a section id is unique for a given store so it's safe to take the
3618
 
            # first matching section while iterating. Also, all filtered
3619
 
            # sections are part of 'all_sections' and will always be found
3620
 
            # there.
3621
 
            while True:
3622
 
                section = iter_all_sections.next()
3623
 
                if section_id == section.id:
3624
 
                    section = LocationSection(section, extra_path,
3625
 
                                              self.branch_name)
3626
 
                    matching_sections.append((length, section))
3627
 
                    break
 
2833
            # a section id is unique for a given store so it's safe to iterate
 
2834
            # again
 
2835
            section = iter_sections.next()
 
2836
            if section_id == section.id:
 
2837
                matching_sections.append(
 
2838
                    LocationSection(section, length, extra_path))
3628
2839
        return matching_sections
3629
2840
 
3630
2841
    def get_sections(self):
3632
2843
        matching_sections = self._get_matching_sections()
3633
2844
        # We want the longest (aka more specific) locations first
3634
2845
        sections = sorted(matching_sections,
3635
 
                          key=lambda (length, section): (length, section.id),
 
2846
                          key=lambda section: (section.length, section.id),
3636
2847
                          reverse=True)
3637
2848
        # Sections mentioning 'ignore_parents' restrict the selection
3638
 
        for _, section in sections:
 
2849
        for section in sections:
3639
2850
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
3640
2851
            ignore = section.get('ignore_parents', None)
3641
2852
            if ignore is not None:
3643
2854
            if ignore:
3644
2855
                break
3645
2856
            # Finally, we have a valid section
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
 
2857
            yield section
 
2858
 
3653
2859
 
3654
2860
class Stack(object):
3655
2861
    """A stack of configurations where an option can be defined"""
3656
2862
 
3657
 
    def __init__(self, sections_def, store=None, mutable_section_id=None):
 
2863
    def __init__(self, sections_def, store=None, mutable_section_name=None):
3658
2864
        """Creates a stack of sections with an optional store for changes.
3659
2865
 
3660
2866
        :param sections_def: A list of Section or callables that returns an
3664
2870
        :param store: The optional Store where modifications will be
3665
2871
            recorded. If none is specified, no modifications can be done.
3666
2872
 
3667
 
        :param mutable_section_id: The id of the MutableSection where changes
3668
 
            are recorded. This requires the ``store`` parameter to be
 
2873
        :param mutable_section_name: The name of the MutableSection where
 
2874
            changes are recorded. This requires the ``store`` parameter to be
3669
2875
            specified.
3670
2876
        """
3671
2877
        self.sections_def = sections_def
3672
2878
        self.store = store
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):
 
2879
        self.mutable_section_name = mutable_section_name
 
2880
 
 
2881
    def get(self, name):
3686
2882
        """Return the *first* option value found in the sections.
3687
2883
 
3688
2884
        This is where we guarantee that sections coming from Store are loaded
3690
2886
        option exists or get its value, which in turn may require to discover
3691
2887
        in which sections it can be defined. Both of these (section and option
3692
2888
        existence) require loading the store (even partially).
3693
 
 
3694
 
        :param name: The queried option.
3695
 
 
3696
 
        :param expand: Whether options references should be expanded.
3697
 
 
3698
 
        :param convert: Whether the option value should be converted from
3699
 
            unicode (do nothing for non-registered options).
3700
 
 
3701
 
        :returns: The value of the option.
3702
2889
        """
3703
2890
        # FIXME: No caching of options nor sections yet -- vila 20110503
3704
2891
        value = None
3705
 
        found_store = None # Where the option value has been found
 
2892
        # Ensuring lazy loading is achieved by delaying section matching (which
 
2893
        # implies querying the persistent storage) until it can't be avoided
 
2894
        # anymore by using callables to describe (possibly empty) section
 
2895
        # lists.
 
2896
        for section_or_callable in self.sections_def:
 
2897
            # Each section can expand to multiple ones when a callable is used
 
2898
            if callable(section_or_callable):
 
2899
                sections = section_or_callable()
 
2900
            else:
 
2901
                sections = [section_or_callable]
 
2902
            for section in sections:
 
2903
                value = section.get(name)
 
2904
                if value is not None:
 
2905
                    break
 
2906
            if value is not None:
 
2907
                break
3706
2908
        # If the option is registered, it may provide additional info about
3707
2909
        # value handling
3708
2910
        try:
3710
2912
        except KeyError:
3711
2913
            # Not registered
3712
2914
            opt = None
3713
 
 
3714
 
        def expand_and_convert(val):
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.
3717
 
            if val is not None:
3718
 
                if expand:
3719
 
                    if isinstance(val, basestring):
3720
 
                        val = self._expand_options_in_string(val)
3721
 
                    else:
3722
 
                        trace.warning('Cannot expand "%s":'
3723
 
                                      ' %s does not support option expansion'
3724
 
                                      % (name, type(val)))
3725
 
                if opt is None:
3726
 
                    val = found_store.unquote(val)
3727
 
                elif convert:
3728
 
                    val = opt.convert_from_unicode(found_store, val)
3729
 
            return val
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)
 
2915
        if (opt is not None and opt.from_unicode is not None
 
2916
            and value is not None):
 
2917
            # If a value exists and the option provides a converter, use it
 
2918
            try:
 
2919
                converted = opt.from_unicode(value)
 
2920
            except (ValueError, TypeError):
 
2921
                # Invalid values are ignored
 
2922
                converted = None
 
2923
            if converted is None and opt.invalid is not None:
 
2924
                # The conversion failed
 
2925
                if opt.invalid == 'warning':
 
2926
                    trace.warning('Value "%s" is not valid for "%s"',
 
2927
                                  value, name)
 
2928
                elif opt.invalid == 'error':
 
2929
                    raise errors.ConfigOptionValueError(name, value)
 
2930
            value = converted
3736
2931
        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
 
2932
            # If the option is registered, it may provide a default value
 
2933
            if opt is not None:
3745
2934
                value = opt.get_default()
3746
 
                value = expand_and_convert(value)
3747
2935
        for hook in ConfigHooks['get']:
3748
2936
            hook(self, name, value)
3749
2937
        return value
3750
2938
 
3751
 
    def expand_options(self, string, env=None):
3752
 
        """Expand option references in the string in the configuration context.
3753
 
 
3754
 
        :param string: The string containing option(s) to expand.
3755
 
 
3756
 
        :param env: An option dict defining additional configuration options or
3757
 
            overriding existing ones.
3758
 
 
3759
 
        :returns: The expanded string.
3760
 
        """
3761
 
        return self._expand_options_in_string(string, env)
3762
 
 
3763
 
    def _expand_options_in_string(self, string, env=None, _refs=None):
3764
 
        """Expand options in the string in the configuration context.
3765
 
 
3766
 
        :param string: The string to be expanded.
3767
 
 
3768
 
        :param env: An option dict defining additional configuration options or
3769
 
            overriding existing ones.
3770
 
 
3771
 
        :param _refs: Private list (FIFO) containing the options being expanded
3772
 
            to detect loops.
3773
 
 
3774
 
        :returns: The expanded string.
3775
 
        """
3776
 
        if string is None:
3777
 
            # Not much to expand there
3778
 
            return None
3779
 
        if _refs is None:
3780
 
            # What references are currently resolved (to detect loops)
3781
 
            _refs = []
3782
 
        result = string
3783
 
        # We need to iterate until no more refs appear ({{foo}} will need two
3784
 
        # iterations for example).
3785
 
        expanded = True
3786
 
        while expanded:
3787
 
            expanded = False
3788
 
            chunks = []
3789
 
            for is_ref, chunk in iter_option_refs(result):
3790
 
                if not is_ref:
3791
 
                    chunks.append(chunk)
3792
 
                else:
3793
 
                    expanded = True
3794
 
                    name = chunk[1:-1]
3795
 
                    if name in _refs:
3796
 
                        raise errors.OptionExpansionLoop(string, _refs)
3797
 
                    _refs.append(name)
3798
 
                    value = self._expand_option(name, env, _refs)
3799
 
                    if value is None:
3800
 
                        raise errors.ExpandingUnknownOption(name, string)
3801
 
                    chunks.append(value)
3802
 
                    _refs.pop()
3803
 
            result = ''.join(chunks)
3804
 
        return result
3805
 
 
3806
 
    def _expand_option(self, name, env, _refs):
3807
 
        if env is not None and name in env:
3808
 
            # Special case, values provided in env takes precedence over
3809
 
            # anything else
3810
 
            value = env[name]
3811
 
        else:
3812
 
            value = self.get(name, expand=False, convert=False)
3813
 
            value = self._expand_options_in_string(value, env, _refs)
3814
 
        return value
3815
 
 
3816
2939
    def _get_mutable_section(self):
3817
2940
        """Get the MutableSection for the Stack.
3818
2941
 
3819
2942
        This is where we guarantee that the mutable section is lazily loaded:
3820
2943
        this means we won't load the corresponding store before setting a value
3821
2944
        or deleting an option. In practice the store will often be loaded but
3822
 
        this helps catching some programming errors.
 
2945
        this allows helps catching some programming errors.
3823
2946
        """
3824
 
        store = self.store
3825
 
        section = store.get_mutable_section(self.mutable_section_id)
3826
 
        return store, section
 
2947
        section = self.store.get_mutable_section(self.mutable_section_name)
 
2948
        return section
3827
2949
 
3828
2950
    def set(self, name, value):
3829
2951
        """Set a new value for the option."""
3830
 
        store, section = self._get_mutable_section()
3831
 
        section.set(name, store.quote(value))
 
2952
        section = self._get_mutable_section()
 
2953
        section.set(name, value)
3832
2954
        for hook in ConfigHooks['set']:
3833
2955
            hook(self, name, value)
3834
2956
 
3835
2957
    def remove(self, name):
3836
2958
        """Remove an existing option."""
3837
 
        _, section = self._get_mutable_section()
 
2959
        section = self._get_mutable_section()
3838
2960
        section.remove(name)
3839
2961
        for hook in ConfigHooks['remove']:
3840
2962
            hook(self, name)
3843
2965
        # Mostly for debugging use
3844
2966
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3845
2967
 
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
 
 
3911
2968
 
3912
2969
class _CompatibleStack(Stack):
3913
2970
    """Place holder for compatibility with previous design.
3918
2975
    One assumption made here is that the daughter classes will all use Stores
3919
2976
    derived from LockableIniFileStore).
3920
2977
 
3921
 
    It implements set() and remove () by re-loading the store before applying
3922
 
    the modification and saving it.
 
2978
    It implements set() by re-loading the store before applying the
 
2979
    modification and saving it.
3923
2980
 
3924
2981
    The long term plan being to implement a single write by store to save
3925
2982
    all modifications, this class should not be used in the interim.
3932
2989
        # Force a write to persistent storage
3933
2990
        self.store.save()
3934
2991
 
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
 
    """
 
2992
 
 
2993
class GlobalStack(_CompatibleStack):
3955
2994
 
3956
2995
    def __init__(self):
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
 
    """
 
2996
        # Get a GlobalStore
 
2997
        gstore = GlobalStore()
 
2998
        super(GlobalStack, self).__init__([gstore.get_sections], gstore)
 
2999
 
 
3000
 
 
3001
class LocationStack(_CompatibleStack):
3981
3002
 
3982
3003
    def __init__(self, location):
3983
3004
        """Make a new stack for a location and global configuration.
3984
 
 
 
3005
        
3985
3006
        :param location: A URL prefix to """
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())
 
3007
        lstore = LocationStore()
 
3008
        matcher = LocationMatcher(lstore, location)
 
3009
        gstore = GlobalStore()
3990
3010
        super(LocationStack, self).__init__(
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
 
    """
 
3011
            [matcher.get_sections, gstore.get_sections], lstore)
 
3012
 
 
3013
class BranchStack(_CompatibleStack):
4015
3014
 
4016
3015
    def __init__(self, branch):
4017
 
        lstore = self.get_shared_store(LocationStore())
4018
 
        bstore = branch._get_config_store()
4019
 
        gstore = self.get_shared_store(GlobalStore())
 
3016
        bstore = BranchStore(branch)
 
3017
        lstore = LocationStore()
 
3018
        matcher = LocationMatcher(lstore, branch.base)
 
3019
        gstore = GlobalStore()
4020
3020
        super(BranchStack, self).__init__(
4021
 
            [self._get_overrides,
4022
 
             LocationMatcher(lstore, branch.base).get_sections,
4023
 
             NameMatcher(bstore, None).get_sections,
4024
 
             NameMatcher(gstore, 'DEFAULT').get_sections],
4025
 
            bstore)
4026
 
        self.branch = branch
4027
 
 
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):
4048
 
    """Remote control-only options stack."""
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
 
 
4054
 
    def __init__(self, bzrdir):
4055
 
        cstore = bzrdir._get_config_store()
4056
 
        super(RemoteControlStack, self).__init__(
4057
 
            [NameMatcher(cstore, None).get_sections],
4058
 
            cstore)
4059
 
        self.bzrdir = bzrdir
4060
 
 
4061
 
 
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
4068
 
 
4069
 
    def __init__(self, branch):
4070
 
        bstore = branch._get_config_store()
4071
 
        super(BranchOnlyStack, self).__init__(
4072
 
            [NameMatcher(bstore, None).get_sections],
4073
 
            bstore)
4074
 
        self.branch = branch
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()
 
3021
            [matcher.get_sections, bstore.get_sections, gstore.get_sections],
 
3022
            bstore)
 
3023
        self.branch = branch
4093
3024
 
4094
3025
 
4095
3026
class cmd_config(commands.Command):
4096
3027
    __doc__ = """Display, set or remove a configuration option.
4097
3028
 
4098
 
    Display the active value for option NAME.
 
3029
    Display the active value for a given option.
4099
3030
 
4100
3031
    If --all is specified, NAME is interpreted as a regular expression and all
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
 
3032
    matching options are displayed mentioning their scope. The active value
 
3033
    that bzr will take into account is the first one displayed for each option.
 
3034
 
 
3035
    If no NAME is given, --all .* is implied.
 
3036
 
 
3037
    Setting a value is achieved by using name=value without spaces. The value
4109
3038
    is set in the most relevant scope and can be checked by displaying the
4110
3039
    option again.
4111
 
 
4112
 
    Removing a value is achieved by using --remove NAME.
4113
3040
    """
4114
3041
 
4115
3042
    takes_args = ['name?']
4117
3044
    takes_options = [
4118
3045
        'directory',
4119
3046
        # FIXME: This should be a registry option so that plugins can register
4120
 
        # their own config files (or not) and will also address
4121
 
        # http://pad.lv/788991 -- vila 20101115
 
3047
        # their own config files (or not) -- vila 20101002
4122
3048
        commands.Option('scope', help='Reduce the scope to the specified'
4123
 
                        ' configuration file.',
 
3049
                        ' configuration file',
4124
3050
                        type=unicode),
4125
3051
        commands.Option('all',
4126
3052
            help='Display all the defined values for the matching options.',
4127
3053
            ),
4128
3054
        commands.Option('remove', help='Remove the option from'
4129
 
                        ' the configuration file.'),
 
3055
                        ' the configuration file'),
4130
3056
        ]
4131
3057
 
4132
3058
    _see_also = ['configuration']
4136
3062
            remove=False):
4137
3063
        if directory is None:
4138
3064
            directory = '.'
4139
 
        directory = directory_service.directories.dereference(directory)
4140
3065
        directory = urlutils.normalize_url(directory)
4141
3066
        if remove and all:
4142
3067
            raise errors.BzrError(
4163
3088
                # Set the option value
4164
3089
                self._set_config_option(name, value, directory, scope)
4165
3090
 
4166
 
    def _get_stack(self, directory, scope=None, write_access=False):
4167
 
        """Get the configuration stack specified by ``directory`` and ``scope``.
 
3091
    def _get_configs(self, directory, scope=None):
 
3092
        """Iterate the configurations specified by ``directory`` and ``scope``.
4168
3093
 
4169
3094
        :param directory: Where the configurations are derived from.
4170
3095
 
4171
3096
        :param scope: A specific config to start from.
4172
 
 
4173
 
        :param write_access: Whether a write access to the stack will be
4174
 
            attempted.
4175
3097
        """
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
4179
3098
        if scope is not None:
4180
3099
            if scope == 'bazaar':
4181
 
                return GlobalStack()
 
3100
                yield GlobalConfig()
4182
3101
            elif scope == 'locations':
4183
 
                return LocationStack(directory)
 
3102
                yield LocationConfig(directory)
4184
3103
            elif scope == 'branch':
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)
 
3104
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
 
3105
                    directory)
 
3106
                yield br.get_config()
4192
3107
        else:
4193
3108
            try:
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()
 
3109
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
 
3110
                    directory)
 
3111
                yield br.get_config()
4200
3112
            except errors.NotBranchError:
4201
 
                return LocationStack(directory)
4202
 
 
4203
 
    def _quote_multiline(self, value):
4204
 
        if '\n' in value:
4205
 
            value = '"""' + value + '"""'
4206
 
        return value
 
3113
                yield LocationConfig(directory)
 
3114
                yield GlobalConfig()
4207
3115
 
4208
3116
    def _show_value(self, name, directory, scope):
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:
 
3117
        displayed = False
 
3118
        for c in self._get_configs(directory, scope):
 
3119
            if displayed:
 
3120
                break
 
3121
            for (oname, value, section, conf_id, parser) in c._get_options():
 
3122
                if name == oname:
 
3123
                    # Display only the first value and exit
 
3124
 
 
3125
                    # FIXME: We need to use get_user_option to take policies
 
3126
                    # into account and we need to make sure the option exists
 
3127
                    # too (hence the two for loops), this needs a better API
 
3128
                    # -- vila 20101117
 
3129
                    value = c.get_user_option(name)
 
3130
                    # Quote the value appropriately
 
3131
                    value = parser._quote(value)
 
3132
                    self.outf.write('%s\n' % (value,))
 
3133
                    displayed = True
 
3134
                    break
 
3135
        if not displayed:
4216
3136
            raise errors.NoSuchConfigOption(name)
4217
3137
 
4218
3138
    def _show_matching_options(self, name, directory, scope):
4221
3141
        # avoid the delay introduced by the lazy regexp.  But, we still do
4222
3142
        # want the nicer errors raised by lazy_regex.
4223
3143
        name._compile_and_collapse()
4224
 
        cur_store_id = None
 
3144
        cur_conf_id = None
4225
3145
        cur_section = None
4226
 
        conf = self._get_stack(directory, scope)
4227
 
        for store, section in conf.iter_sections():
4228
 
            for oname in section.iter_option_names():
 
3146
        for c in self._get_configs(directory, scope):
 
3147
            for (oname, value, section, conf_id, parser) in c._get_options():
4229
3148
                if name.search(oname):
4230
 
                    if cur_store_id != store.id:
 
3149
                    if cur_conf_id != conf_id:
4231
3150
                        # Explain where the options are defined
4232
 
                        self.outf.write('%s:\n' % (store.id,))
4233
 
                        cur_store_id = store.id
 
3151
                        self.outf.write('%s:\n' % (conf_id,))
 
3152
                        cur_conf_id = conf_id
4234
3153
                        cur_section = None
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)
 
3154
                    if (section not in (None, 'DEFAULT')
 
3155
                        and cur_section != section):
 
3156
                        # Display the section if it's not the default (or only)
 
3157
                        # one.
 
3158
                        self.outf.write('  [%s]\n' % (section,))
 
3159
                        cur_section = section
4243
3160
                    self.outf.write('  %s = %s\n' % (oname, value))
4244
3161
 
4245
3162
    def _set_config_option(self, name, value, directory, 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()
 
3163
        for conf in self._get_configs(directory, scope):
 
3164
            conf.set_user_option(name, value)
 
3165
            break
 
3166
        else:
 
3167
            raise errors.NoSuchConfig(scope)
4250
3168
 
4251
3169
    def _remove_config_option(self, name, directory, scope):
4252
3170
        if name is None:
4253
3171
            raise errors.BzrCommandError(
4254
3172
                '--remove expects an option to remove.')
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:
 
3173
        removed = False
 
3174
        for conf in self._get_configs(directory, scope):
 
3175
            for (section_name, section, conf_id) in conf._get_sections():
 
3176
                if scope is not None and conf_id != scope:
 
3177
                    # Not the right configuration file
 
3178
                    continue
 
3179
                if name in section:
 
3180
                    if conf_id != conf.config_id():
 
3181
                        conf = self._get_configs(directory, conf_id).next()
 
3182
                    # We use the first section in the first config where the
 
3183
                    # option is defined to remove it
 
3184
                    conf.remove_user_option(name, section_name)
 
3185
                    removed = True
 
3186
                    break
 
3187
            break
 
3188
        else:
 
3189
            raise errors.NoSuchConfig(scope)
 
3190
        if not removed:
4261
3191
            raise errors.NoSuchConfigOption(name)
4262
3192
 
4263
 
 
4264
3193
# Test registries
4265
3194
#
4266
3195
# We need adapters that can build a Store or a Stack in a test context. Test
4269
3198
# ready-to-use store or stack.  Plugins that define new store/stacks can also
4270
3199
# register themselves here to be tested against the tests defined in
4271
3200
# bzrlib.tests.test_config. Note that the builder can be called multiple times
4272
 
# for the same test.
 
3201
# for the same tests.
4273
3202
 
4274
3203
# The registered object should be a callable receiving a test instance
4275
3204
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store