← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Vincent Ladeuil
  • Date: 2015-09-08 07:59:37 UTC
  • mto: This revision was merged to the branch mainline in revision 6604.
  • Revision ID: v.ladeuil+lp@free.fr-20150908075937-u63hgo67v3c2lapt
Skip the missed test in test_transport.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/config.py
1
 
# Copyright (C) 2005-2011 Canonical Ltd
 
1
# Copyright (C) 2005-2012 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#            and others
4
4
#
31
31
log_format=name-of-format
32
32
validate_signatures_in_log=true|false(default)
33
33
acceptable_keys=pattern1,pattern2
 
34
gpg_signing_key=amy@example.com
34
35
 
35
36
in locations.conf, you specify the url of a branch and options for it.
36
37
Wildcards may be used - * and ? as normal in shell completion. Options
54
55
                   turns on create_signatures.
55
56
create_signatures - this option controls whether bzr will always create
56
57
                    gpg signatures or not on commits.  There is an unused
57
 
                    option which in future is expected to work if               
 
58
                    option which in future is expected to work if
58
59
                    branch settings require signatures.
59
60
log_format - this option sets the default log format.  Possible values are
60
61
             long, short, line, or a plugin can register new formats.
71
72
up=pull
72
73
"""
73
74
 
 
75
from __future__ import absolute_import
 
76
from cStringIO import StringIO
74
77
import os
75
 
import string
76
78
import sys
77
79
 
78
 
 
 
80
import bzrlib
79
81
from bzrlib.decorators import needs_write_lock
80
82
from bzrlib.lazy_import import lazy_import
81
83
lazy_import(globals(), """
 
84
import base64
82
85
import fnmatch
83
86
import re
84
 
from cStringIO import StringIO
85
87
 
86
88
from bzrlib import (
87
89
    atomicfile,
88
 
    bzrdir,
 
90
    controldir,
89
91
    debug,
 
92
    directory_service,
90
93
    errors,
91
94
    lazy_regex,
 
95
    library_state,
92
96
    lockdir,
93
 
    mail_client,
94
97
    mergetools,
95
98
    osutils,
96
99
    symbol_versioning,
100
103
    urlutils,
101
104
    win32utils,
102
105
    )
 
106
from bzrlib.i18n import gettext
103
107
from bzrlib.util.configobj import configobj
104
108
""")
105
109
from bzrlib import (
106
110
    commands,
107
111
    hooks,
 
112
    lazy_regex,
108
113
    registry,
109
114
    )
110
115
from bzrlib.symbol_versioning import (
147
152
STORE_GLOBAL = 4
148
153
 
149
154
 
 
155
def signature_policy_from_unicode(signature_string):
 
156
    """Convert a string to a signing policy."""
 
157
    if signature_string.lower() == 'check-available':
 
158
        return CHECK_IF_POSSIBLE
 
159
    if signature_string.lower() == 'ignore':
 
160
        return CHECK_NEVER
 
161
    if signature_string.lower() == 'require':
 
162
        return CHECK_ALWAYS
 
163
    raise ValueError("Invalid signatures policy '%s'"
 
164
                     % signature_string)
 
165
 
 
166
 
 
167
def signing_policy_from_unicode(signature_string):
 
168
    """Convert a string to a signing policy."""
 
169
    if signature_string.lower() == 'when-required':
 
170
        return SIGN_WHEN_REQUIRED
 
171
    if signature_string.lower() == 'never':
 
172
        return SIGN_NEVER
 
173
    if signature_string.lower() == 'always':
 
174
        return SIGN_ALWAYS
 
175
    raise ValueError("Invalid signing policy '%s'"
 
176
                     % signature_string)
 
177
 
 
178
 
150
179
class ConfigObj(configobj.ConfigObj):
151
180
 
152
181
    def __init__(self, infile=None, **kwargs):
168
197
        return self[section][name]
169
198
 
170
199
 
171
 
# FIXME: Until we can guarantee that each config file is loaded once and
172
 
# only once for a given bzrlib session, we don't want to re-read the file every
173
 
# time we query for an option so we cache the value (bad ! watch out for tests
174
 
# needing to restore the proper value).This shouldn't be part of 2.4.0 final,
175
 
# yell at mgz^W vila and the RM if this is still present at that time
176
 
# -- vila 20110219
177
 
_expand_default_value = None
178
 
def _get_expand_default_value():
179
 
    global _expand_default_value
180
 
    if _expand_default_value is not None:
181
 
        return _expand_default_value
182
 
    conf = GlobalConfig()
183
 
    # Note that we must not use None for the expand value below or we'll run
184
 
    # into infinite recursion. Using False really would be quite silly ;)
185
 
    expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
186
 
    if expand is None:
187
 
        # This is an opt-in feature, you *really* need to clearly say you want
188
 
        # to activate it !
189
 
        expand = False
190
 
    _expand_default_value = expand
191
 
    return expand
192
 
 
193
 
 
194
200
class Config(object):
195
201
    """A configuration policy - what username, editor, gpg needs etc."""
196
202
 
201
207
        """Returns a unique ID for the config."""
202
208
        raise NotImplementedError(self.config_id)
203
209
 
204
 
    @deprecated_method(deprecated_in((2, 4, 0)))
205
 
    def get_editor(self):
206
 
        """Get the users pop up editor."""
207
 
        raise NotImplementedError
208
 
 
209
210
    def get_change_editor(self, old_tree, new_tree):
210
211
        from bzrlib import diff
211
212
        cmd = self._get_change_editor()
214
215
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
215
216
                                             sys.stdout)
216
217
 
217
 
    def get_mail_client(self):
218
 
        """Get a mail client to use"""
219
 
        selected_client = self.get_user_option('mail_client')
220
 
        _registry = mail_client.mail_client_registry
221
 
        try:
222
 
            mail_client_class = _registry.get(selected_client)
223
 
        except KeyError:
224
 
            raise errors.UnknownMailClient(selected_client)
225
 
        return mail_client_class(self)
226
 
 
227
218
    def _get_signature_checking(self):
228
219
        """Template method to override signature checking policy."""
229
220
 
358
349
        """Template method to provide a user option."""
359
350
        return None
360
351
 
361
 
    def get_user_option(self, option_name, expand=None):
 
352
    def get_user_option(self, option_name, expand=True):
362
353
        """Get a generic option - no special process, no default.
363
354
 
364
355
        :param option_name: The queried option.
367
358
 
368
359
        :returns: The value of the option.
369
360
        """
370
 
        if expand is None:
371
 
            expand = _get_expand_default_value()
372
361
        value = self._get_user_option(option_name)
373
362
        if expand:
374
363
            if isinstance(value, list):
415
404
            l = [l]
416
405
        return l
417
406
 
 
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)))
418
447
    def gpg_signing_command(self):
419
448
        """What program should be used to sign signatures?"""
420
449
        result = self._gpg_signing_command()
426
455
        """See gpg_signing_command()."""
427
456
        return None
428
457
 
 
458
    @deprecated_method(deprecated_in((2, 5, 0)))
429
459
    def log_format(self):
430
460
        """What log format should be used"""
431
461
        result = self._log_format()
450
480
        """See validate_signatures_in_log()."""
451
481
        return None
452
482
 
 
483
    @deprecated_method(deprecated_in((2, 5, 0)))
453
484
    def acceptable_keys(self):
454
485
        """Comma separated list of key patterns acceptable to 
455
486
        verify-signatures command"""
460
491
        """See acceptable_keys()."""
461
492
        return None
462
493
 
 
494
    @deprecated_method(deprecated_in((2, 5, 0)))
463
495
    def post_commit(self):
464
496
        """An ordered list of python functions to call.
465
497
 
491
523
        v = self._get_user_id()
492
524
        if v:
493
525
            return v
494
 
        v = os.environ.get('EMAIL')
495
 
        if v:
496
 
            return v.decode(osutils.get_user_encoding())
497
 
        name, email = _auto_user_id()
498
 
        if name and email:
499
 
            return '%s <%s>' % (name, email)
500
 
        elif email:
501
 
            return email
502
 
        raise errors.NoWhoami()
 
526
        return default_email()
503
527
 
504
528
    def ensure_username(self):
505
529
        """Raise errors.NoWhoami if username is not set.
508
532
        """
509
533
        self.username()
510
534
 
 
535
    @deprecated_method(deprecated_in((2, 5, 0)))
511
536
    def signature_checking(self):
512
537
        """What is the current policy for signature checking?."""
513
538
        policy = self._get_signature_checking()
515
540
            return policy
516
541
        return CHECK_IF_POSSIBLE
517
542
 
 
543
    @deprecated_method(deprecated_in((2, 5, 0)))
518
544
    def signing_policy(self):
519
545
        """What is the current policy for signature checking?."""
520
546
        policy = self._get_signing_policy()
522
548
            return policy
523
549
        return SIGN_WHEN_REQUIRED
524
550
 
 
551
    @deprecated_method(deprecated_in((2, 5, 0)))
525
552
    def signature_needed(self):
526
553
        """Is a signature needed when committing ?."""
527
554
        policy = self._get_signing_policy()
536
563
            return True
537
564
        return False
538
565
 
 
566
    @deprecated_method(deprecated_in((2, 5, 0)))
 
567
    def gpg_signing_key(self):
 
568
        """GPG user-id to sign commits"""
 
569
        key = self.get_user_option('gpg_signing_key')
 
570
        if key == "default" or key == None:
 
571
            return self.user_email()
 
572
        else:
 
573
            return key
 
574
 
539
575
    def get_alias(self, value):
540
576
        return self._get_alias(value)
541
577
 
575
611
        for (oname, value, section, conf_id, parser) in self._get_options():
576
612
            if oname.startswith('bzr.mergetool.'):
577
613
                tool_name = oname[len('bzr.mergetool.'):]
578
 
                tools[tool_name] = value
 
614
                tools[tool_name] = self.get_user_option(oname, False)
579
615
        trace.mutter('loaded merge tools: %r' % tools)
580
616
        return tools
581
617
 
818
854
        """See Config._get_signature_checking."""
819
855
        policy = self._get_user_option('check_signatures')
820
856
        if policy:
821
 
            return self._string_to_signature_policy(policy)
 
857
            return signature_policy_from_unicode(policy)
822
858
 
823
859
    def _get_signing_policy(self):
824
860
        """See Config._get_signing_policy"""
825
861
        policy = self._get_user_option('create_signatures')
826
862
        if policy:
827
 
            return self._string_to_signing_policy(policy)
 
863
            return signing_policy_from_unicode(policy)
828
864
 
829
865
    def _get_user_id(self):
830
866
        """Get the user id from the 'email' key in the current section."""
875
911
        """See Config.post_commit."""
876
912
        return self._get_user_option('post_commit')
877
913
 
878
 
    def _string_to_signature_policy(self, signature_string):
879
 
        """Convert a string to a signing policy."""
880
 
        if signature_string.lower() == 'check-available':
881
 
            return CHECK_IF_POSSIBLE
882
 
        if signature_string.lower() == 'ignore':
883
 
            return CHECK_NEVER
884
 
        if signature_string.lower() == 'require':
885
 
            return CHECK_ALWAYS
886
 
        raise errors.BzrError("Invalid signatures policy '%s'"
887
 
                              % signature_string)
888
 
 
889
 
    def _string_to_signing_policy(self, signature_string):
890
 
        """Convert a string to a signing policy."""
891
 
        if signature_string.lower() == 'when-required':
892
 
            return SIGN_WHEN_REQUIRED
893
 
        if signature_string.lower() == 'never':
894
 
            return SIGN_NEVER
895
 
        if signature_string.lower() == 'always':
896
 
            return SIGN_ALWAYS
897
 
        raise errors.BzrError("Invalid signing policy '%s'"
898
 
                              % signature_string)
899
 
 
900
914
    def _get_alias(self, value):
901
915
        try:
902
916
            return self._get_parser().get_value("ALIASES",
978
992
        # local transports are not shared. But if/when we start using
979
993
        # LockableConfig for other kind of transports, we will need to reuse
980
994
        # whatever connection is already established -- vila 20100929
981
 
        self.transport = transport.get_transport(self.dir)
 
995
        self.transport = transport.get_transport_from_path(self.dir)
982
996
        self._lock = lockdir.LockDir(self.transport, self.lock_name)
983
997
 
984
998
    def _create_from_string(self, unicode_bytes, save):
1039
1053
        conf._create_from_string(str_or_unicode, save)
1040
1054
        return conf
1041
1055
 
1042
 
    @deprecated_method(deprecated_in((2, 4, 0)))
1043
 
    def get_editor(self):
1044
 
        return self._get_user_option('editor')
1045
 
 
1046
1056
    @needs_write_lock
1047
1057
    def set_user_option(self, option, value):
1048
1058
        """Save option and its value in the configuration."""
1346
1356
        e.g. "John Hacker <jhacker@example.com>"
1347
1357
        This is looked up in the email controlfile for the branch.
1348
1358
        """
1349
 
        try:
1350
 
            return (self.branch._transport.get_bytes("email")
1351
 
                    .decode(osutils.get_user_encoding())
1352
 
                    .rstrip("\r\n"))
1353
 
        except errors.NoSuchFile, e:
1354
 
            pass
1355
 
 
1356
1359
        return self._get_best_value('_get_user_id')
1357
1360
 
1358
1361
    def _get_change_editor(self):
1438
1441
        value = self._get_explicit_nickname()
1439
1442
        if value is not None:
1440
1443
            return value
 
1444
        if self.branch.name:
 
1445
            return self.branch.name
1441
1446
        return urlutils.unescape(self.branch.base.split('/')[-2])
1442
1447
 
1443
1448
    def has_explicit_nickname(self):
1480
1485
 
1481
1486
 
1482
1487
def config_dir():
1483
 
    """Return per-user configuration directory.
 
1488
    """Return per-user configuration directory as unicode string
1484
1489
 
1485
1490
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1486
 
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
 
1491
    and Linux.  On Mac OS X and Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1487
1492
    that will be used instead.
1488
1493
 
1489
1494
    TODO: Global option --config-dir to override this.
1490
1495
    """
1491
 
    base = os.environ.get('BZR_HOME', None)
 
1496
    base = osutils.path_from_environ('BZR_HOME')
1492
1497
    if sys.platform == 'win32':
1493
 
        # environ variables on Windows are in user encoding/mbcs. So decode
1494
 
        # before using one
1495
 
        if base is not None:
1496
 
            base = base.decode('mbcs')
1497
 
        if base is None:
1498
 
            base = win32utils.get_appdata_location_unicode()
1499
 
        if base is None:
1500
 
            base = os.environ.get('HOME', None)
1501
 
            if base is not None:
1502
 
                base = base.decode('mbcs')
1503
 
        if base is None:
1504
 
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1505
 
                                  ' or HOME set')
 
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.
1506
1504
        return osutils.pathjoin(base, 'bazaar', '2.0')
1507
 
    elif sys.platform == 'darwin':
1508
 
        if base is None:
1509
 
            # this takes into account $HOME
1510
 
            base = os.path.expanduser("~")
1511
 
        return osutils.pathjoin(base, '.bazaar')
1512
 
    else:
1513
 
        if base is None:
1514
 
 
1515
 
            xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
1516
 
            if xdg_dir is None:
1517
 
                xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
1518
 
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1519
 
            if osutils.isdir(xdg_dir):
1520
 
                trace.mutter(
1521
 
                    "Using configuration in XDG directory %s." % xdg_dir)
1522
 
                return xdg_dir
1523
 
 
1524
 
            base = os.path.expanduser("~")
1525
 
        return osutils.pathjoin(base, ".bazaar")
 
1505
    if base is None:
 
1506
        xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
 
1507
        if xdg_dir is None:
 
1508
            xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
 
1509
        xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
 
1510
        if osutils.isdir(xdg_dir):
 
1511
            trace.mutter(
 
1512
                "Using configuration in XDG directory %s." % xdg_dir)
 
1513
            return xdg_dir
 
1514
        base = osutils._get_home_dir()
 
1515
    return osutils.pathjoin(base, ".bazaar")
1526
1516
 
1527
1517
 
1528
1518
def config_filename():
1565
1555
def xdg_cache_dir():
1566
1556
    # See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1567
1557
    # Possibly this should be different on Windows?
1568
 
    e = os.environ.get('XDG_CACHE_DIR', None)
 
1558
    e = os.environ.get('XDG_CACHE_HOME', None)
1569
1559
    if e:
1570
1560
        return e
1571
1561
    else:
1572
1562
        return os.path.expanduser('~/.cache')
1573
1563
 
1574
1564
 
1575
 
def _get_default_mail_domain():
 
1565
def _get_default_mail_domain(mailname_file='/etc/mailname'):
1576
1566
    """If possible, return the assumed default email domain.
1577
1567
 
1578
1568
    :returns: string mail domain, or None.
1581
1571
        # No implementation yet; patches welcome
1582
1572
        return None
1583
1573
    try:
1584
 
        f = open('/etc/mailname')
 
1574
        f = open(mailname_file)
1585
1575
    except (IOError, OSError), e:
1586
1576
        return None
1587
1577
    try:
1588
 
        domain = f.read().strip()
 
1578
        domain = f.readline().strip()
1589
1579
        return domain
1590
1580
    finally:
1591
1581
        f.close()
1592
1582
 
1593
1583
 
 
1584
def default_email():
 
1585
    v = os.environ.get('BZR_EMAIL')
 
1586
    if v:
 
1587
        return v.decode(osutils.get_user_encoding())
 
1588
    v = os.environ.get('EMAIL')
 
1589
    if v:
 
1590
        return v.decode(osutils.get_user_encoding())
 
1591
    name, email = _auto_user_id()
 
1592
    if name and email:
 
1593
        return u'%s <%s>' % (name, email)
 
1594
    elif email:
 
1595
        return email
 
1596
    raise errors.NoWhoami()
 
1597
 
 
1598
 
1594
1599
def _auto_user_id():
1595
1600
    """Calculate automatic user identification.
1596
1601
 
1785
1790
        :param user: login (optional)
1786
1791
 
1787
1792
        :param path: the absolute path on the server (optional)
1788
 
        
 
1793
 
1789
1794
        :param realm: the http authentication realm (optional)
1790
1795
 
1791
1796
        :return: A dict containing the matching credentials or None.
2126
2131
credential_store_registry.default_key = 'plain'
2127
2132
 
2128
2133
 
 
2134
class Base64CredentialStore(CredentialStore):
 
2135
    __doc__ = """Base64 credential store for the authentication.conf file"""
 
2136
 
 
2137
    def decode_password(self, credentials):
 
2138
        """See CredentialStore.decode_password."""
 
2139
        # GZ 2012-07-28: Will raise binascii.Error if password is not base64,
 
2140
        #                should probably propogate as something more useful.
 
2141
        return base64.decodestring(credentials['password'])
 
2142
 
 
2143
credential_store_registry.register('base64', Base64CredentialStore,
 
2144
                                   help=Base64CredentialStore.__doc__)
 
2145
 
 
2146
 
2129
2147
class BzrDirConfig(object):
2130
2148
 
2131
2149
    def __init__(self, bzrdir):
2137
2155
 
2138
2156
        It may be set to a location, or None.
2139
2157
 
2140
 
        This policy affects all branches contained by this bzrdir, except for
2141
 
        those under repositories.
 
2158
        This policy affects all branches contained by this control dir, except
 
2159
        for those under repositories.
2142
2160
        """
2143
2161
        if self._config is None:
2144
 
            raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
 
2162
            raise errors.BzrError("Cannot set configuration in %s"
 
2163
                                  % self._bzrdir)
2145
2164
        if value is None:
2146
2165
            self._config.set_option('', 'default_stack_on')
2147
2166
        else:
2152
2171
 
2153
2172
        This will either be a location, or None.
2154
2173
 
2155
 
        This policy affects all branches contained by this bzrdir, except for
2156
 
        those under repositories.
 
2174
        This policy affects all branches contained by this control dir, except
 
2175
        for those under repositories.
2157
2176
        """
2158
2177
        if self._config is None:
2159
2178
            return None
2230
2249
            return f
2231
2250
        except errors.NoSuchFile:
2232
2251
            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()
2233
2257
 
2234
2258
    def _external_url(self):
2235
2259
        return urlutils.join(self._transport.external_url(), self._filename)
2262
2286
    The option *values* are stored in config files and found in sections.
2263
2287
 
2264
2288
    Here we define various properties about the option itself, its default
2265
 
    value, in which config files it can be stored, etc (TBC).
 
2289
    value, how to convert it from stores, what to do when invalid values are
 
2290
    encoutered, in which config files it can be stored.
2266
2291
    """
2267
2292
 
2268
 
    def __init__(self, name, default=None):
 
2293
    def __init__(self, name, override_from_env=None,
 
2294
                 default=None, default_from_env=None,
 
2295
                 help=None, from_unicode=None, invalid=None, unquote=True):
 
2296
        """Build an option definition.
 
2297
 
 
2298
        :param name: the name used to refer to the option.
 
2299
 
 
2300
        :param override_from_env: A list of environment variables which can
 
2301
           provide override any configuration setting.
 
2302
 
 
2303
        :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.
 
2313
 
 
2314
        :param help: a doc string to explain the option to the user.
 
2315
 
 
2316
        :param from_unicode: a callable to convert the unicode string
 
2317
            representing the option value in a store or its default value.
 
2318
 
 
2319
        :param invalid: the action to be taken when an invalid value is
 
2320
            encountered in a store. This is called only when from_unicode is
 
2321
            invoked to convert a string and returns None or raise ValueError or
 
2322
            TypeError. Accepted values are: None (ignore invalid values),
 
2323
            'warning' (emit a warning), 'error' (emit an error message and
 
2324
            terminates).
 
2325
 
 
2326
        :param unquote: should the unicode value be unquoted before conversion.
 
2327
           This should be used only when the store providing the values cannot
 
2328
           safely unquote them (see http://pad.lv/906897). It is provided so
 
2329
           daughter classes can handle the quoting themselves.
 
2330
        """
 
2331
        if override_from_env is None:
 
2332
            override_from_env = []
 
2333
        if default_from_env is None:
 
2334
            default_from_env = []
2269
2335
        self.name = name
2270
 
        self.default = default
 
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
 
2358
        self.from_unicode = from_unicode
 
2359
        self.unquote = unquote
 
2360
        if invalid and invalid not in ('warning', 'error'):
 
2361
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
 
2362
        self.invalid = invalid
 
2363
 
 
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
2271
2398
 
2272
2399
    def get_default(self):
2273
 
        return self.default
2274
 
 
2275
 
 
2276
 
# Options registry
2277
 
 
2278
 
option_registry = registry.Registry()
2279
 
 
2280
 
 
2281
 
option_registry.register(
2282
 
    'editor', Option('editor'),
2283
 
    help='The command called to launch an editor to enter a message.')
 
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
 
2422
 
 
2423
    def get_help_text(self, additional_see_also=None, plain=True):
 
2424
        result = self.help
 
2425
        from bzrlib import help_topics
 
2426
        result += help_topics._format_see_also(additional_see_also)
 
2427
        if plain:
 
2428
            result = help_topics.help_as_plain_text(result)
 
2429
        return result
 
2430
 
 
2431
 
 
2432
# Predefined converters to get proper values from store
 
2433
 
 
2434
def bool_from_store(unicode_str):
 
2435
    return ui.bool_from_string(unicode_str)
 
2436
 
 
2437
 
 
2438
def int_from_store(unicode_str):
 
2439
    return int(unicode_str)
 
2440
 
 
2441
 
 
2442
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
 
2443
 
 
2444
def int_SI_from_store(unicode_str):
 
2445
    """Convert a human readable size in SI units, e.g 10MB into an integer.
 
2446
 
 
2447
    Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
2448
    by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
2449
    pedantic.
 
2450
 
 
2451
    :return Integer, expanded to its base-10 value if a proper SI unit is 
 
2452
        found, None otherwise.
 
2453
    """
 
2454
    regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
 
2455
    p = re.compile(regexp, re.IGNORECASE)
 
2456
    m = p.match(unicode_str)
 
2457
    val = None
 
2458
    if m is not None:
 
2459
        val, _, unit = m.groups()
 
2460
        val = int(val)
 
2461
        if unit:
 
2462
            try:
 
2463
                coeff = _unit_suffixes[unit.upper()]
 
2464
            except KeyError:
 
2465
                raise ValueError(gettext('{0} is not an SI unit.').format(unit))
 
2466
            val *= coeff
 
2467
    return val
 
2468
 
 
2469
 
 
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 = []
 
2511
        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)*})')
 
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
 
2568
 
 
2569
 
 
2570
class OptionRegistry(registry.Registry):
 
2571
    """Register config options by their name.
 
2572
 
 
2573
    This overrides ``registry.Registry`` to simplify registration by acquiring
 
2574
    some information from the option object itself.
 
2575
    """
 
2576
 
 
2577
    def _check_option_name(self, option_name):
 
2578
        """Ensures an option name is valid.
 
2579
 
 
2580
        :param option_name: The name to validate.
 
2581
        """
 
2582
        if _option_ref_re.match('{%s}' % option_name) is None:
 
2583
            raise errors.IllegalOptionName(option_name)
 
2584
 
 
2585
    def register(self, option):
 
2586
        """Register a new option to its name.
 
2587
 
 
2588
        :param option: The option to register. Its name is used as the key.
 
2589
        """
 
2590
        self._check_option_name(option.name)
 
2591
        super(OptionRegistry, self).register(option.name, option,
 
2592
                                             help=option.help)
 
2593
 
 
2594
    def register_lazy(self, key, module_name, member_name):
 
2595
        """Register a new option to be loaded on request.
 
2596
 
 
2597
        :param key: the key to request the option later. Since the registration
 
2598
            is lazy, it should be provided and match the option name.
 
2599
 
 
2600
        :param module_name: the python path to the module. Such as 'os.path'.
 
2601
 
 
2602
        :param member_name: the member of the module to return.  If empty or 
 
2603
                None, get() will return the module itself.
 
2604
        """
 
2605
        self._check_option_name(key)
 
2606
        super(OptionRegistry, self).register_lazy(key,
 
2607
                                                  module_name, member_name)
 
2608
 
 
2609
    def get_help(self, key=None):
 
2610
        """Get the help text associated with the given key"""
 
2611
        option = self.get(key)
 
2612
        the_help = option.help
 
2613
        if callable(the_help):
 
2614
            return the_help(self, key)
 
2615
        return the_help
 
2616
 
 
2617
 
 
2618
option_registry = OptionRegistry()
 
2619
 
 
2620
 
 
2621
# Registered options in lexicographical order
 
2622
 
 
2623
option_registry.register(
 
2624
    Option('append_revisions_only',
 
2625
           default=None, from_unicode=bool_from_store, invalid='warning',
 
2626
           help='''\
 
2627
Whether to only append revisions to the mainline.
 
2628
 
 
2629
If this is set to true, then it is not possible to change the
 
2630
existing mainline of the branch.
 
2631
'''))
 
2632
option_registry.register(
 
2633
    ListOption('acceptable_keys',
 
2634
           default=None,
 
2635
           help="""\
 
2636
List of GPG key patterns which are acceptable for verification.
 
2637
"""))
 
2638
option_registry.register(
 
2639
    Option('add.maximum_file_size',
 
2640
           default=u'20MB', from_unicode=int_SI_from_store,
 
2641
           help="""\
 
2642
Size above which files should be added manually.
 
2643
 
 
2644
Files below this size are added automatically when using ``bzr add`` without
 
2645
arguments.
 
2646
 
 
2647
A negative value means disable the size check.
 
2648
"""))
 
2649
option_registry.register(
 
2650
    Option('bound',
 
2651
           default=None, from_unicode=bool_from_store,
 
2652
           help="""\
 
2653
Is the branch bound to ``bound_location``.
 
2654
 
 
2655
If set to "True", the branch should act as a checkout, and push each commit to
 
2656
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
2657
 
 
2658
See also: bound_location.
 
2659
"""))
 
2660
option_registry.register(
 
2661
    Option('bound_location',
 
2662
           default=None,
 
2663
           help="""\
 
2664
The location that commits should go to when acting as a checkout.
 
2665
 
 
2666
This option is normally set by ``bind``.
 
2667
 
 
2668
See also: bound.
 
2669
"""))
 
2670
option_registry.register(
 
2671
    Option('branch.fetch_tags', default=False,  from_unicode=bool_from_store,
 
2672
           help="""\
 
2673
Whether revisions associated with tags should be fetched.
 
2674
"""))
 
2675
option_registry.register_lazy(
 
2676
    'bzr.transform.orphan_policy', 'bzrlib.transform', 'opt_transform_orphan')
 
2677
option_registry.register(
 
2678
    Option('bzr.workingtree.worth_saving_limit', default=10,
 
2679
           from_unicode=int_from_store,  invalid='warning',
 
2680
           help='''\
 
2681
How many changes before saving the dirstate.
 
2682
 
 
2683
-1 means that we will never rewrite the dirstate file for only
 
2684
stat-cache changes. Regardless of this setting, we will always rewrite
 
2685
the dirstate file if a file is added/removed/renamed/etc. This flag only
 
2686
affects the behavior of updating the dirstate file after we notice that
 
2687
a file has been touched.
 
2688
'''))
 
2689
option_registry.register(
 
2690
    Option('bugtracker', default=None,
 
2691
           help='''\
 
2692
Default bug tracker to use.
 
2693
 
 
2694
This bug tracker will be used for example when marking bugs
 
2695
as fixed using ``bzr commit --fixes``, if no explicit
 
2696
bug tracker was specified.
 
2697
'''))
 
2698
option_registry.register(
 
2699
    Option('check_signatures', default=CHECK_IF_POSSIBLE,
 
2700
           from_unicode=signature_policy_from_unicode,
 
2701
           help='''\
 
2702
GPG checking policy.
 
2703
 
 
2704
Possible values: require, ignore, check-available (default)
 
2705
 
 
2706
this option will control whether bzr will require good gpg
 
2707
signatures, ignore them, or check them if they are
 
2708
present.
 
2709
'''))
 
2710
option_registry.register(
 
2711
    Option('child_submit_format',
 
2712
           help='''The preferred format of submissions to this branch.'''))
 
2713
option_registry.register(
 
2714
    Option('child_submit_to',
 
2715
           help='''Where submissions to this branch are mailed to.'''))
 
2716
option_registry.register(
 
2717
    Option('create_signatures', default=SIGN_WHEN_REQUIRED,
 
2718
           from_unicode=signing_policy_from_unicode,
 
2719
           help='''\
 
2720
GPG Signing policy.
 
2721
 
 
2722
Possible values: always, never, when-required (default)
 
2723
 
 
2724
This option controls whether bzr will always create
 
2725
gpg signatures or not on commits.
 
2726
'''))
 
2727
option_registry.register(
 
2728
    Option('dirstate.fdatasync', default=True,
 
2729
           from_unicode=bool_from_store,
 
2730
           help='''\
 
2731
Flush dirstate changes onto physical disk?
 
2732
 
 
2733
If true (default), working tree metadata changes are flushed through the
 
2734
OS buffers to physical disk.  This is somewhat slower, but means data
 
2735
should not be lost if the machine crashes.  See also repository.fdatasync.
 
2736
'''))
 
2737
option_registry.register(
 
2738
    ListOption('debug_flags', default=[],
 
2739
           help='Debug flags to activate.'))
 
2740
option_registry.register(
 
2741
    Option('default_format', default='2a',
 
2742
           help='Format used when creating branches.'))
 
2743
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
    Option('editor',
 
2755
           help='The command called to launch an editor to enter a message.'))
 
2756
option_registry.register(
 
2757
    Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
 
2758
           help='The users identity'))
 
2759
option_registry.register(
 
2760
    Option('gpg_signing_command',
 
2761
           default='gpg',
 
2762
           help="""\
 
2763
Program to use use for creating signatures.
 
2764
 
 
2765
This should support at least the -u and --clearsign options.
 
2766
"""))
 
2767
option_registry.register(
 
2768
    Option('gpg_signing_key',
 
2769
           default=None,
 
2770
           help="""\
 
2771
GPG key to use for signing.
 
2772
 
 
2773
This defaults to the first key associated with the users email.
 
2774
"""))
 
2775
option_registry.register(
 
2776
    Option('ignore_missing_extensions', default=False,
 
2777
           from_unicode=bool_from_store,
 
2778
           help='''\
 
2779
Control the missing extensions warning display.
 
2780
 
 
2781
The warning will not be emitted if set to True.
 
2782
'''))
 
2783
option_registry.register(
 
2784
    Option('language',
 
2785
           help='Language to translate messages into.'))
 
2786
option_registry.register(
 
2787
    Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
 
2788
           help='''\
 
2789
Steal locks that appears to be dead.
 
2790
 
 
2791
If set to True, bzr will check if a lock is supposed to be held by an
 
2792
active process from the same user on the same machine. If the user and
 
2793
machine match, but no process with the given PID is active, then bzr
 
2794
will automatically break the stale lock, and create a new lock for
 
2795
this process.
 
2796
Otherwise, bzr will prompt as normal to break the lock.
 
2797
'''))
 
2798
option_registry.register(
 
2799
    Option('log_format', default='long',
 
2800
           help= '''\
 
2801
Log format to use when displaying revisions.
 
2802
 
 
2803
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
 
2804
may be provided by plugins.
 
2805
'''))
 
2806
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
 
2807
    'opt_mail_client')
 
2808
option_registry.register(
 
2809
    Option('output_encoding',
 
2810
           help= 'Unicode encoding for output'
 
2811
           ' (terminal encoding if not specified).'))
 
2812
option_registry.register(
 
2813
    Option('parent_location',
 
2814
           default=None,
 
2815
           help="""\
 
2816
The location of the default branch for pull or merge.
 
2817
 
 
2818
This option is normally set when creating a branch, the first ``pull`` or by
 
2819
``pull --remember``.
 
2820
"""))
 
2821
option_registry.register(
 
2822
    Option('post_commit', default=None,
 
2823
           help='''\
 
2824
Post commit functions.
 
2825
 
 
2826
An ordered list of python functions to call, separated by spaces.
 
2827
 
 
2828
Each function takes branch, rev_id as parameters.
 
2829
'''))
 
2830
option_registry.register_lazy('progress_bar', 'bzrlib.ui.text',
 
2831
                              'opt_progress_bar')
 
2832
option_registry.register(
 
2833
    Option('public_branch',
 
2834
           default=None,
 
2835
           help="""\
 
2836
A publically-accessible version of this branch.
 
2837
 
 
2838
This implies that the branch setting this option is not publically-accessible.
 
2839
Used and set by ``bzr send``.
 
2840
"""))
 
2841
option_registry.register(
 
2842
    Option('push_location',
 
2843
           default=None,
 
2844
           help="""\
 
2845
The location of the default branch for push.
 
2846
 
 
2847
This option is normally set by the first ``push`` or ``push --remember``.
 
2848
"""))
 
2849
option_registry.register(
 
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,
 
2861
           help='''\
 
2862
Flush repository changes onto physical disk?
 
2863
 
 
2864
If true (default), repository changes are flushed through the OS buffers
 
2865
to physical disk.  This is somewhat slower, but means data should not be
 
2866
lost if the machine crashes.  See also dirstate.fdatasync.
 
2867
'''))
 
2868
option_registry.register_lazy('smtp_server',
 
2869
    'bzrlib.smtp_connection', 'smtp_server')
 
2870
option_registry.register_lazy('smtp_password',
 
2871
    'bzrlib.smtp_connection', 'smtp_password')
 
2872
option_registry.register_lazy('smtp_username',
 
2873
    'bzrlib.smtp_connection', 'smtp_username')
 
2874
option_registry.register(
 
2875
    Option('selftest.timeout',
 
2876
        default='600',
 
2877
        from_unicode=int_from_store,
 
2878
        help='Abort selftest if one test takes longer than this many seconds',
 
2879
        ))
 
2880
 
 
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')
2284
2925
 
2285
2926
 
2286
2927
class Section(object):
2296
2937
        # We re-use the dict-like object received
2297
2938
        self.options = options
2298
2939
 
2299
 
    def get(self, name, default=None):
 
2940
    def get(self, name, default=None, expand=True):
2300
2941
        return self.options.get(name, default)
2301
2942
 
 
2943
    def iter_option_names(self):
 
2944
        for k in self.options.iterkeys():
 
2945
            yield k
 
2946
 
2302
2947
    def __repr__(self):
2303
2948
        # Mostly for debugging use
2304
2949
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2306
2951
 
2307
2952
_NewlyCreatedOption = object()
2308
2953
"""Was the option created during the MutableSection lifetime"""
 
2954
_DeletedOption = object()
 
2955
"""Was the option deleted during the MutableSection lifetime"""
2309
2956
 
2310
2957
 
2311
2958
class MutableSection(Section):
2313
2960
 
2314
2961
    def __init__(self, section_id, options):
2315
2962
        super(MutableSection, self).__init__(section_id, options)
2316
 
        self.orig = {}
 
2963
        self.reset_changes()
2317
2964
 
2318
2965
    def set(self, name, value):
2319
2966
        if name not in self.options:
2324
2971
        self.options[name] = value
2325
2972
 
2326
2973
    def remove(self, name):
2327
 
        if name not in self.orig:
 
2974
        if name not in self.orig and name in self.options:
2328
2975
            self.orig[name] = self.get(name, None)
2329
2976
        del self.options[name]
2330
2977
 
 
2978
    def reset_changes(self):
 
2979
        self.orig = {}
 
2980
 
 
2981
    def apply_changes(self, dirty, store):
 
2982
        """Apply option value changes.
 
2983
 
 
2984
        ``self`` has been reloaded from the persistent storage. ``dirty``
 
2985
        contains the changes made since the previous loading.
 
2986
 
 
2987
        :param dirty: the mutable section containing the changes.
 
2988
 
 
2989
        :param store: the store containing the section
 
2990
        """
 
2991
        for k, expected in dirty.orig.iteritems():
 
2992
            actual = dirty.get(k, _DeletedOption)
 
2993
            reloaded = self.get(k, _NewlyCreatedOption)
 
2994
            if actual is _DeletedOption:
 
2995
                if k in self.options:
 
2996
                    self.remove(k)
 
2997
            else:
 
2998
                self.set(k, actual)
 
2999
            # Report concurrent updates in an ad-hoc way. This should only
 
3000
            # occurs when different processes try to update the same option
 
3001
            # which is not supported (as in: the config framework is not meant
 
3002
            # to be used as a sharing mechanism).
 
3003
            if expected != reloaded:
 
3004
                if actual is _DeletedOption:
 
3005
                    actual = '<DELETED>'
 
3006
                if reloaded is _NewlyCreatedOption:
 
3007
                    reloaded = '<CREATED>'
 
3008
                if expected is _NewlyCreatedOption:
 
3009
                    expected = '<CREATED>'
 
3010
                # Someone changed the value since we get it from the persistent
 
3011
                # storage.
 
3012
                trace.warning(gettext(
 
3013
                        "Option {0} in section {1} of {2} was changed"
 
3014
                        " from {3} to {4}. The {5} value will be saved.".format(
 
3015
                            k, self.id, store.external_url(), expected,
 
3016
                            reloaded, actual)))
 
3017
        # No need to keep track of these changes
 
3018
        self.reset_changes()
 
3019
 
2331
3020
 
2332
3021
class Store(object):
2333
3022
    """Abstract interface to persistent storage for configuration options."""
2335
3024
    readonly_section_class = Section
2336
3025
    mutable_section_class = MutableSection
2337
3026
 
 
3027
    def __init__(self):
 
3028
        # Which sections need to be saved (by section id). We use a dict here
 
3029
        # so the dirty sections can be shared by multiple callers.
 
3030
        self.dirty_sections = {}
 
3031
 
2338
3032
    def is_loaded(self):
2339
3033
        """Returns True if the Store has been loaded.
2340
3034
 
2363
3057
        """
2364
3058
        raise NotImplementedError(self.unload)
2365
3059
 
 
3060
    def quote(self, value):
 
3061
        """Quote a configuration option value for storing purposes.
 
3062
 
 
3063
        This allows Stacks to present values as they will be stored.
 
3064
        """
 
3065
        return value
 
3066
 
 
3067
    def unquote(self, value):
 
3068
        """Unquote a configuration option value into unicode.
 
3069
 
 
3070
        The received value is quoted as stored.
 
3071
        """
 
3072
        return value
 
3073
 
2366
3074
    def save(self):
2367
3075
        """Saves the Store to persistent storage."""
2368
3076
        raise NotImplementedError(self.save)
2369
3077
 
 
3078
    def _need_saving(self):
 
3079
        for s in self.dirty_sections.values():
 
3080
            if s.orig:
 
3081
                # At least one dirty section contains a modification
 
3082
                return True
 
3083
        return False
 
3084
 
 
3085
    def apply_changes(self, dirty_sections):
 
3086
        """Apply changes from dirty sections while checking for coherency.
 
3087
 
 
3088
        The Store content is discarded and reloaded from persistent storage to
 
3089
        acquire up-to-date values.
 
3090
 
 
3091
        Dirty sections are MutableSection which kept track of the value they
 
3092
        are expected to update.
 
3093
        """
 
3094
        # We need an up-to-date version from the persistent storage, unload the
 
3095
        # store. The reload will occur when needed (triggered by the first
 
3096
        # get_mutable_section() call below.
 
3097
        self.unload()
 
3098
        # Apply the changes from the preserved dirty sections
 
3099
        for section_id, dirty in dirty_sections.iteritems():
 
3100
            clean = self.get_mutable_section(section_id)
 
3101
            clean.apply_changes(dirty, self)
 
3102
        # Everything is clean now
 
3103
        self.dirty_sections = {}
 
3104
 
 
3105
    def save_changes(self):
 
3106
        """Saves the Store to persistent storage if changes occurred.
 
3107
 
 
3108
        Apply the changes recorded in the mutable sections to a store content
 
3109
        refreshed from persistent storage.
 
3110
        """
 
3111
        raise NotImplementedError(self.save_changes)
 
3112
 
2370
3113
    def external_url(self):
2371
3114
        raise NotImplementedError(self.external_url)
2372
3115
 
2373
3116
    def get_sections(self):
2374
3117
        """Returns an ordered iterable of existing sections.
2375
3118
 
2376
 
        :returns: An iterable of (name, dict).
 
3119
        :returns: An iterable of (store, section).
2377
3120
        """
2378
3121
        raise NotImplementedError(self.get_sections)
2379
3122
 
2380
 
    def get_mutable_section(self, section_name=None):
 
3123
    def get_mutable_section(self, section_id=None):
2381
3124
        """Returns the specified mutable section.
2382
3125
 
2383
 
        :param section_name: The section identifier
 
3126
        :param section_id: The section identifier
2384
3127
        """
2385
3128
        raise NotImplementedError(self.get_mutable_section)
2386
3129
 
2390
3133
                                    self.external_url())
2391
3134
 
2392
3135
 
 
3136
class CommandLineStore(Store):
 
3137
    "A store to carry command line overrides for the config options."""
 
3138
 
 
3139
    def __init__(self, opts=None):
 
3140
        super(CommandLineStore, self).__init__()
 
3141
        if opts is None:
 
3142
            opts = {}
 
3143
        self.options = {}
 
3144
        self.id = 'cmdline'
 
3145
 
 
3146
    def _reset(self):
 
3147
        # The dict should be cleared but not replaced so it can be shared.
 
3148
        self.options.clear()
 
3149
 
 
3150
    def _from_cmdline(self, overrides):
 
3151
        # Reset before accepting new definitions
 
3152
        self._reset()
 
3153
        for over in overrides:
 
3154
            try:
 
3155
                name, value = over.split('=', 1)
 
3156
            except ValueError:
 
3157
                raise errors.BzrCommandError(
 
3158
                    gettext("Invalid '%s', should be of the form 'name=value'")
 
3159
                    % (over,))
 
3160
            self.options[name] = value
 
3161
 
 
3162
    def external_url(self):
 
3163
        # Not an url but it makes debugging easier and is never needed
 
3164
        # otherwise
 
3165
        return 'cmdline'
 
3166
 
 
3167
    def get_sections(self):
 
3168
        yield self,  self.readonly_section_class(None, self.options)
 
3169
 
 
3170
 
2393
3171
class IniFileStore(Store):
2394
3172
    """A config Store using ConfigObj for storage.
2395
3173
 
2396
 
    :ivar transport: The transport object where the config file is located.
2397
 
 
2398
 
    :ivar file_name: The config file basename in the transport directory.
2399
 
 
2400
3174
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
2401
3175
        serialize/deserialize the config file.
2402
3176
    """
2403
3177
 
2404
 
    def __init__(self, transport, file_name):
 
3178
    def __init__(self):
2405
3179
        """A config Store using ConfigObj for storage.
2406
 
 
2407
 
        :param transport: The transport object where the config file is located.
2408
 
 
2409
 
        :param file_name: The config file basename in the transport directory.
2410
3180
        """
2411
3181
        super(IniFileStore, self).__init__()
2412
 
        self.transport = transport
2413
 
        self.file_name = file_name
2414
3182
        self._config_obj = None
2415
3183
 
2416
3184
    def is_loaded(self):
2418
3186
 
2419
3187
    def unload(self):
2420
3188
        self._config_obj = None
 
3189
        self.dirty_sections = {}
 
3190
 
 
3191
    def _load_content(self):
 
3192
        """Load the config file bytes.
 
3193
 
 
3194
        This should be provided by subclasses
 
3195
 
 
3196
        :return: Byte string
 
3197
        """
 
3198
        raise NotImplementedError(self._load_content)
 
3199
 
 
3200
    def _save_content(self, content):
 
3201
        """Save the config file bytes.
 
3202
 
 
3203
        This should be provided by subclasses
 
3204
 
 
3205
        :param content: Config file bytes to write
 
3206
        """
 
3207
        raise NotImplementedError(self._save_content)
2421
3208
 
2422
3209
    def load(self):
2423
3210
        """Load the store from the associated file."""
2424
3211
        if self.is_loaded():
2425
3212
            return
2426
 
        content = self.transport.get_bytes(self.file_name)
 
3213
        content = self._load_content()
2427
3214
        self._load_from_string(content)
2428
3215
        for hook in ConfigHooks['load']:
2429
3216
            hook(self)
2438
3225
        co_input = StringIO(bytes)
2439
3226
        try:
2440
3227
            # The config files are always stored utf8-encoded
2441
 
            self._config_obj = ConfigObj(co_input, encoding='utf-8')
 
3228
            self._config_obj = ConfigObj(co_input, encoding='utf-8',
 
3229
                                         list_values=False)
2442
3230
        except configobj.ConfigObjError, e:
2443
3231
            self._config_obj = None
2444
3232
            raise errors.ParseConfigError(e.errors, self.external_url())
2445
3233
        except UnicodeDecodeError:
2446
3234
            raise errors.ConfigContentError(self.external_url())
2447
3235
 
 
3236
    def save_changes(self):
 
3237
        if not self.is_loaded():
 
3238
            # Nothing to save
 
3239
            return
 
3240
        if not self._need_saving():
 
3241
            return
 
3242
        # Preserve the current version
 
3243
        dirty_sections = dict(self.dirty_sections.items())
 
3244
        self.apply_changes(dirty_sections)
 
3245
        # Save to the persistent storage
 
3246
        self.save()
 
3247
 
2448
3248
    def save(self):
2449
3249
        if not self.is_loaded():
2450
3250
            # Nothing to save
2451
3251
            return
2452
3252
        out = StringIO()
2453
3253
        self._config_obj.write(out)
2454
 
        self.transport.put_bytes(self.file_name, out.getvalue())
 
3254
        self._save_content(out.getvalue())
2455
3255
        for hook in ConfigHooks['save']:
2456
3256
            hook(self)
2457
3257
 
2458
 
    def external_url(self):
2459
 
        # FIXME: external_url should really accepts an optional relpath
2460
 
        # parameter (bug #750169) :-/ -- vila 2011-04-04
2461
 
        # The following will do in the interim but maybe we don't want to
2462
 
        # expose a path here but rather a config ID and its associated
2463
 
        # object </hand wawe>.
2464
 
        return urlutils.join(self.transport.external_url(), self.file_name)
2465
 
 
2466
3258
    def get_sections(self):
2467
3259
        """Get the configobj section in the file order.
2468
3260
 
2469
 
        :returns: An iterable of (name, dict).
 
3261
        :returns: An iterable of (store, section).
2470
3262
        """
2471
3263
        # We need a loaded store
2472
3264
        try:
2473
3265
            self.load()
2474
 
        except errors.NoSuchFile:
2475
 
            # If the file doesn't exist, there is no sections
 
3266
        except (errors.NoSuchFile, errors.PermissionDenied):
 
3267
            # If the file can't be read, there is no sections
2476
3268
            return
2477
3269
        cobj = self._config_obj
2478
3270
        if cobj.scalars:
2479
 
            yield self.readonly_section_class(None, cobj)
 
3271
            yield self, self.readonly_section_class(None, cobj)
2480
3272
        for section_name in cobj.sections:
2481
 
            yield self.readonly_section_class(section_name, cobj[section_name])
 
3273
            yield (self,
 
3274
                   self.readonly_section_class(section_name,
 
3275
                                               cobj[section_name]))
2482
3276
 
2483
 
    def get_mutable_section(self, section_name=None):
 
3277
    def get_mutable_section(self, section_id=None):
2484
3278
        # We need a loaded store
2485
3279
        try:
2486
3280
            self.load()
2487
3281
        except errors.NoSuchFile:
2488
3282
            # The file doesn't exist, let's pretend it was empty
2489
3283
            self._load_from_string('')
2490
 
        if section_name is None:
 
3284
        if section_id in self.dirty_sections:
 
3285
            # We already created a mutable section for this id
 
3286
            return self.dirty_sections[section_id]
 
3287
        if section_id is None:
2491
3288
            section = self._config_obj
2492
3289
        else:
2493
 
            section = self._config_obj.setdefault(section_name, {})
2494
 
        return self.mutable_section_class(section_name, section)
 
3290
            section = self._config_obj.setdefault(section_id, {})
 
3291
        mutable_section = self.mutable_section_class(section_id, section)
 
3292
        # All mutable sections can become dirty
 
3293
        self.dirty_sections[section_id] = mutable_section
 
3294
        return mutable_section
 
3295
 
 
3296
    def quote(self, value):
 
3297
        try:
 
3298
            # configobj conflates automagical list values and quoting
 
3299
            self._config_obj.list_values = True
 
3300
            return self._config_obj._quote(value)
 
3301
        finally:
 
3302
            self._config_obj.list_values = False
 
3303
 
 
3304
    def unquote(self, value):
 
3305
        if value and isinstance(value, basestring):
 
3306
            # _unquote doesn't handle None nor empty strings nor anything that
 
3307
            # is not a string, really.
 
3308
            value = self._config_obj._unquote(value)
 
3309
        return value
 
3310
 
 
3311
    def external_url(self):
 
3312
        # Since an IniFileStore can be used without a file (at least in tests),
 
3313
        # it's better to provide something than raising a NotImplementedError.
 
3314
        # All daughter classes are supposed to provide an implementation
 
3315
        # anyway.
 
3316
        return 'In-Process Store, no URL'
 
3317
 
 
3318
 
 
3319
class TransportIniFileStore(IniFileStore):
 
3320
    """IniFileStore that loads files from a transport.
 
3321
 
 
3322
    :ivar transport: The transport object where the config file is located.
 
3323
 
 
3324
    :ivar file_name: The config file basename in the transport directory.
 
3325
    """
 
3326
 
 
3327
    def __init__(self, transport, file_name):
 
3328
        """A Store using a ini file on a Transport
 
3329
 
 
3330
        :param transport: The transport object where the config file is located.
 
3331
        :param file_name: The config file basename in the transport directory.
 
3332
        """
 
3333
        super(TransportIniFileStore, self).__init__()
 
3334
        self.transport = transport
 
3335
        self.file_name = file_name
 
3336
 
 
3337
    def _load_content(self):
 
3338
        try:
 
3339
            return self.transport.get_bytes(self.file_name)
 
3340
        except errors.PermissionDenied:
 
3341
            trace.warning("Permission denied while trying to load "
 
3342
                          "configuration store %s.", self.external_url())
 
3343
            raise
 
3344
 
 
3345
    def _save_content(self, content):
 
3346
        self.transport.put_bytes(self.file_name, content)
 
3347
 
 
3348
    def external_url(self):
 
3349
        # FIXME: external_url should really accepts an optional relpath
 
3350
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
3351
        # The following will do in the interim but maybe we don't want to
 
3352
        # expose a path here but rather a config ID and its associated
 
3353
        # object </hand wawe>.
 
3354
        return urlutils.join(self.transport.external_url(), self.file_name)
2495
3355
 
2496
3356
 
2497
3357
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2500
3360
# they may face the same issue.
2501
3361
 
2502
3362
 
2503
 
class LockableIniFileStore(IniFileStore):
 
3363
class LockableIniFileStore(TransportIniFileStore):
2504
3364
    """A ConfigObjStore using locks on save to ensure store integrity."""
2505
3365
 
2506
3366
    def __init__(self, transport, file_name, lock_dir_name=None):
2551
3411
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2552
3412
# on a poolie's remark)
2553
3413
class GlobalStore(LockableIniFileStore):
 
3414
    """A config store for global options.
 
3415
 
 
3416
    There is a single GlobalStore for a given process.
 
3417
    """
2554
3418
 
2555
3419
    def __init__(self, possible_transports=None):
2556
 
        t = transport.get_transport(config_dir(),
2557
 
                                    possible_transports=possible_transports)
 
3420
        t = transport.get_transport_from_path(
 
3421
            config_dir(), possible_transports=possible_transports)
2558
3422
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
3423
        self.id = 'bazaar'
2559
3424
 
2560
3425
 
2561
3426
class LocationStore(LockableIniFileStore):
 
3427
    """A config store for options specific to a location.
 
3428
 
 
3429
    There is a single LocationStore for a given process.
 
3430
    """
2562
3431
 
2563
3432
    def __init__(self, possible_transports=None):
2564
 
        t = transport.get_transport(config_dir(),
2565
 
                                    possible_transports=possible_transports)
 
3433
        t = transport.get_transport_from_path(
 
3434
            config_dir(), possible_transports=possible_transports)
2566
3435
        super(LocationStore, self).__init__(t, 'locations.conf')
2567
 
 
2568
 
 
2569
 
class BranchStore(IniFileStore):
 
3436
        self.id = 'locations'
 
3437
 
 
3438
 
 
3439
class BranchStore(TransportIniFileStore):
 
3440
    """A config store for branch options.
 
3441
 
 
3442
    There is a single BranchStore for a given branch.
 
3443
    """
2570
3444
 
2571
3445
    def __init__(self, branch):
2572
3446
        super(BranchStore, self).__init__(branch.control_transport,
2573
3447
                                          'branch.conf')
2574
3448
        self.branch = branch
2575
 
 
2576
 
    def lock_write(self, token=None):
2577
 
        return self.branch.lock_write(token)
2578
 
 
2579
 
    def unlock(self):
2580
 
        return self.branch.unlock()
2581
 
 
2582
 
    @needs_write_lock
2583
 
    def save(self):
2584
 
        # We need to be able to override the undecorated implementation
2585
 
        self.save_without_locking()
2586
 
 
2587
 
    def save_without_locking(self):
2588
 
        super(BranchStore, self).save()
 
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'
2589
3459
 
2590
3460
 
2591
3461
class SectionMatcher(object):
2592
3462
    """Select sections into a given Store.
2593
3463
 
2594
 
    This intended to be used to postpone getting an iterable of sections from a
2595
 
    store.
 
3464
    This is intended to be used to postpone getting an iterable of sections
 
3465
    from a store.
2596
3466
    """
2597
3467
 
2598
3468
    def __init__(self, store):
2603
3473
        # sections.
2604
3474
        sections = self.store.get_sections()
2605
3475
        # Walk the revisions in the order provided
2606
 
        for s in sections:
 
3476
        for store, s in sections:
2607
3477
            if self.match(s):
2608
 
                yield s
2609
 
 
2610
 
    def match(self, secion):
 
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
        """
2611
3487
        raise NotImplementedError(self.match)
2612
3488
 
2613
3489
 
 
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
 
2614
3500
class LocationSection(Section):
2615
3501
 
2616
 
    def __init__(self, section, length, extra_path):
 
3502
    def __init__(self, section, extra_path, branch_name=None):
2617
3503
        super(LocationSection, self).__init__(section.id, section.options)
2618
 
        self.length = length
2619
3504
        self.extra_path = extra_path
 
3505
        if branch_name is None:
 
3506
            branch_name = ''
 
3507
        self.locals = {'relpath': extra_path,
 
3508
                       'basename': urlutils.basename(extra_path),
 
3509
                       'branchname': branch_name}
2620
3510
 
2621
 
    def get(self, name, default=None):
 
3511
    def get(self, name, default=None, expand=True):
2622
3512
        value = super(LocationSection, self).get(name, default)
2623
 
        if value is not None:
 
3513
        if value is not None and expand:
2624
3514
            policy_name = self.get(name + ':policy', None)
2625
3515
            policy = _policy_value.get(policy_name, POLICY_NONE)
2626
3516
            if policy == POLICY_APPENDPATH:
2627
3517
                value = urlutils.join(value, self.extra_path)
 
3518
            # expand section local options right now (since POLICY_APPENDPATH
 
3519
            # will never add options references, it's ok to expand after it).
 
3520
            chunks = []
 
3521
            for is_ref, chunk in iter_option_refs(value):
 
3522
                if not is_ref:
 
3523
                    chunks.append(chunk)
 
3524
                else:
 
3525
                    ref = chunk[1:-1]
 
3526
                    if ref in self.locals:
 
3527
                        chunks.append(self.locals[ref])
 
3528
                    else:
 
3529
                        chunks.append(chunk)
 
3530
            value = ''.join(chunks)
2628
3531
        return value
2629
3532
 
2630
3533
 
 
3534
class StartingPathMatcher(SectionMatcher):
 
3535
    """Select sections for a given location respecting the Store order."""
 
3536
 
 
3537
    # FIXME: Both local paths and urls can be used for section names as well as
 
3538
    # ``location`` to stay consistent with ``LocationMatcher`` which itself
 
3539
    # inherited the fuzziness from the previous ``LocationConfig``
 
3540
    # implementation. We probably need to revisit which encoding is allowed for
 
3541
    # both ``location`` and section names and how we normalize
 
3542
    # them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
 
3543
    # related too. -- vila 2012-01-04
 
3544
 
 
3545
    def __init__(self, store, location):
 
3546
        super(StartingPathMatcher, self).__init__(store)
 
3547
        if location.startswith('file://'):
 
3548
            location = urlutils.local_path_from_url(location)
 
3549
        self.location = location
 
3550
 
 
3551
    def get_sections(self):
 
3552
        """Get all sections matching ``location`` in the store.
 
3553
 
 
3554
        The most generic sections are described first in the store, then more
 
3555
        specific ones can be provided for reduced scopes.
 
3556
 
 
3557
        The returned section are therefore returned in the reversed order so
 
3558
        the most specific ones can be found first.
 
3559
        """
 
3560
        location_parts = self.location.rstrip('/').split('/')
 
3561
        store = self.store
 
3562
        # Later sections are more specific, they should be returned first
 
3563
        for _, section in reversed(list(store.get_sections())):
 
3564
            if section.id is None:
 
3565
                # The no-name section is always included if present
 
3566
                yield store, LocationSection(section, self.location)
 
3567
                continue
 
3568
            section_path = section.id
 
3569
            if section_path.startswith('file://'):
 
3570
                # the location is already a local path or URL, convert the
 
3571
                # section id to the same format
 
3572
                section_path = urlutils.local_path_from_url(section_path)
 
3573
            if (self.location.startswith(section_path)
 
3574
                or fnmatch.fnmatch(self.location, section_path)):
 
3575
                section_parts = section_path.rstrip('/').split('/')
 
3576
                extra_path = '/'.join(location_parts[len(section_parts):])
 
3577
                yield store, LocationSection(section, extra_path)
 
3578
 
 
3579
 
2631
3580
class LocationMatcher(SectionMatcher):
2632
3581
 
2633
3582
    def __init__(self, store, location):
2634
3583
        super(LocationMatcher, self).__init__(store)
 
3584
        url, params = urlutils.split_segment_parameters(location)
2635
3585
        if location.startswith('file://'):
2636
3586
            location = urlutils.local_path_from_url(location)
2637
3587
        self.location = location
 
3588
        branch_name = params.get('branch')
 
3589
        if branch_name is None:
 
3590
            self.branch_name = urlutils.basename(self.location)
 
3591
        else:
 
3592
            self.branch_name = urlutils.unescape(branch_name)
2638
3593
 
2639
3594
    def _get_matching_sections(self):
2640
3595
        """Get all sections matching ``location``."""
2641
3596
        # We slightly diverge from LocalConfig here by allowing the no-name
2642
3597
        # section as the most generic one and the lower priority.
2643
3598
        no_name_section = None
2644
 
        sections = []
 
3599
        all_sections = []
2645
3600
        # Filter out the no_name_section so _iter_for_location_by_parts can be
2646
3601
        # used (it assumes all sections have a name).
2647
 
        for section in self.store.get_sections():
 
3602
        for _, section in self.store.get_sections():
2648
3603
            if section.id is None:
2649
3604
                no_name_section = section
2650
3605
            else:
2651
 
                sections.append(section)
 
3606
                all_sections.append(section)
2652
3607
        # Unfortunately _iter_for_location_by_parts deals with section names so
2653
3608
        # we have to resync.
2654
3609
        filtered_sections = _iter_for_location_by_parts(
2655
 
            [s.id for s in sections], self.location)
2656
 
        iter_sections = iter(sections)
 
3610
            [s.id for s in all_sections], self.location)
 
3611
        iter_all_sections = iter(all_sections)
2657
3612
        matching_sections = []
2658
3613
        if no_name_section is not None:
2659
3614
            matching_sections.append(
2660
 
                LocationSection(no_name_section, 0, self.location))
 
3615
                (0, LocationSection(no_name_section, self.location)))
2661
3616
        for section_id, extra_path, length in filtered_sections:
2662
 
            # a section id is unique for a given store so it's safe to iterate
2663
 
            # again
2664
 
            section = iter_sections.next()
2665
 
            if section_id == section.id:
2666
 
                matching_sections.append(
2667
 
                    LocationSection(section, length, extra_path))
 
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
2668
3628
        return matching_sections
2669
3629
 
2670
3630
    def get_sections(self):
2672
3632
        matching_sections = self._get_matching_sections()
2673
3633
        # We want the longest (aka more specific) locations first
2674
3634
        sections = sorted(matching_sections,
2675
 
                          key=lambda section: (section.length, section.id),
 
3635
                          key=lambda (length, section): (length, section.id),
2676
3636
                          reverse=True)
2677
3637
        # Sections mentioning 'ignore_parents' restrict the selection
2678
 
        for section in sections:
 
3638
        for _, section in sections:
2679
3639
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
2680
3640
            ignore = section.get('ignore_parents', None)
2681
3641
            if ignore is not None:
2683
3643
            if ignore:
2684
3644
                break
2685
3645
            # Finally, we have a valid section
2686
 
            yield section
2687
 
 
 
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
2688
3653
 
2689
3654
class Stack(object):
2690
3655
    """A stack of configurations where an option can be defined"""
2691
3656
 
2692
 
    def __init__(self, sections_def, store=None, mutable_section_name=None):
 
3657
    def __init__(self, sections_def, store=None, mutable_section_id=None):
2693
3658
        """Creates a stack of sections with an optional store for changes.
2694
3659
 
2695
3660
        :param sections_def: A list of Section or callables that returns an
2699
3664
        :param store: The optional Store where modifications will be
2700
3665
            recorded. If none is specified, no modifications can be done.
2701
3666
 
2702
 
        :param mutable_section_name: The name of the MutableSection where
2703
 
            changes are recorded. This requires the ``store`` parameter to be
 
3667
        :param mutable_section_id: The id of the MutableSection where changes
 
3668
            are recorded. This requires the ``store`` parameter to be
2704
3669
            specified.
2705
3670
        """
2706
3671
        self.sections_def = sections_def
2707
3672
        self.store = store
2708
 
        self.mutable_section_name = mutable_section_name
2709
 
 
2710
 
    def get(self, name):
 
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):
2711
3686
        """Return the *first* option value found in the sections.
2712
3687
 
2713
3688
        This is where we guarantee that sections coming from Store are loaded
2715
3690
        option exists or get its value, which in turn may require to discover
2716
3691
        in which sections it can be defined. Both of these (section and option
2717
3692
        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.
2718
3702
        """
2719
3703
        # FIXME: No caching of options nor sections yet -- vila 20110503
2720
3704
        value = None
2721
 
        # Ensuring lazy loading is achieved by delaying section matching (which
2722
 
        # implies querying the persistent storage) until it can't be avoided
2723
 
        # anymore by using callables to describe (possibly empty) section
2724
 
        # lists.
2725
 
        for section_or_callable in self.sections_def:
2726
 
            # Each section can expand to multiple ones when a callable is used
2727
 
            if callable(section_or_callable):
2728
 
                sections = section_or_callable()
2729
 
            else:
2730
 
                sections = [section_or_callable]
2731
 
            for section in sections:
 
3705
        found_store = None # Where the option value has been found
 
3706
        # If the option is registered, it may provide additional info about
 
3707
        # value handling
 
3708
        try:
 
3709
            opt = option_registry.get(name)
 
3710
        except KeyError:
 
3711
            # Not registered
 
3712
            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)
 
3736
        if value is None:
 
3737
            for store, section in self.iter_sections():
2732
3738
                value = section.get(name)
2733
3739
                if value is not None:
 
3740
                    found_store = store
2734
3741
                    break
2735
 
            if value is not None:
2736
 
                break
2737
 
        if value is None:
2738
 
            # If the option is registered, it may provide a default value
2739
 
            try:
2740
 
                opt = option_registry.get(name)
2741
 
            except KeyError:
2742
 
                # Not registered
2743
 
                opt = None
2744
 
            if opt is not None:
 
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
2745
3745
                value = opt.get_default()
 
3746
                value = expand_and_convert(value)
2746
3747
        for hook in ConfigHooks['get']:
2747
3748
            hook(self, name, value)
2748
3749
        return value
2749
3750
 
 
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
 
2750
3816
    def _get_mutable_section(self):
2751
3817
        """Get the MutableSection for the Stack.
2752
3818
 
2753
3819
        This is where we guarantee that the mutable section is lazily loaded:
2754
3820
        this means we won't load the corresponding store before setting a value
2755
3821
        or deleting an option. In practice the store will often be loaded but
2756
 
        this allows helps catching some programming errors.
 
3822
        this helps catching some programming errors.
2757
3823
        """
2758
 
        section = self.store.get_mutable_section(self.mutable_section_name)
2759
 
        return section
 
3824
        store = self.store
 
3825
        section = store.get_mutable_section(self.mutable_section_id)
 
3826
        return store, section
2760
3827
 
2761
3828
    def set(self, name, value):
2762
3829
        """Set a new value for the option."""
2763
 
        section = self._get_mutable_section()
2764
 
        section.set(name, value)
 
3830
        store, section = self._get_mutable_section()
 
3831
        section.set(name, store.quote(value))
2765
3832
        for hook in ConfigHooks['set']:
2766
3833
            hook(self, name, value)
2767
3834
 
2768
3835
    def remove(self, name):
2769
3836
        """Remove an existing option."""
2770
 
        section = self._get_mutable_section()
 
3837
        _, section = self._get_mutable_section()
2771
3838
        section.remove(name)
2772
3839
        for hook in ConfigHooks['remove']:
2773
3840
            hook(self, name)
2776
3843
        # Mostly for debugging use
2777
3844
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
2778
3845
 
 
3846
    def _get_overrides(self):
 
3847
        # FIXME: Hack around library_state.initialize never called
 
3848
        if bzrlib.global_state is not None:
 
3849
            return bzrlib.global_state.cmdline_overrides.get_sections()
 
3850
        return []
 
3851
 
 
3852
    def get_shared_store(self, store, state=None):
 
3853
        """Get a known shared store.
 
3854
 
 
3855
        Store urls uniquely identify them and are used to ensure a single copy
 
3856
        is shared across all users.
 
3857
 
 
3858
        :param store: The store known to the caller.
 
3859
 
 
3860
        :param state: The library state where the known stores are kept.
 
3861
 
 
3862
        :returns: The store received if it's not a known one, an already known
 
3863
            otherwise.
 
3864
        """
 
3865
        if state is None:
 
3866
            state = bzrlib.global_state
 
3867
        if state is None:
 
3868
            global _shared_stores_at_exit_installed
 
3869
            stores = _shared_stores
 
3870
            def save_config_changes():
 
3871
                for k, store in stores.iteritems():
 
3872
                    store.save_changes()
 
3873
            if not _shared_stores_at_exit_installed:
 
3874
                # FIXME: Ugly hack waiting for library_state to always be
 
3875
                # available. -- vila 20120731
 
3876
                import atexit
 
3877
                atexit.register(save_config_changes)
 
3878
                _shared_stores_at_exit_installed = True
 
3879
        else:
 
3880
            stores = state.config_stores
 
3881
        url = store.external_url()
 
3882
        try:
 
3883
            return stores[url]
 
3884
        except KeyError:
 
3885
            stores[url] = store
 
3886
            return store
 
3887
 
 
3888
 
 
3889
class MemoryStack(Stack):
 
3890
    """A configuration stack defined from a string.
 
3891
 
 
3892
    This is mainly intended for tests and requires no disk resources.
 
3893
    """
 
3894
 
 
3895
    def __init__(self, content=None):
 
3896
        """Create an in-memory stack from a given content.
 
3897
 
 
3898
        It uses a single store based on configobj and support reading and
 
3899
        writing options.
 
3900
 
 
3901
        :param content: The initial content of the store. If None, the store is
 
3902
            not loaded and ``_load_from_string`` can and should be used if
 
3903
            needed.
 
3904
        """
 
3905
        store = IniFileStore()
 
3906
        if content is not None:
 
3907
            store._load_from_string(content)
 
3908
        super(MemoryStack, self).__init__(
 
3909
            [store.get_sections], store)
 
3910
 
2779
3911
 
2780
3912
class _CompatibleStack(Stack):
2781
3913
    """Place holder for compatibility with previous design.
2786
3918
    One assumption made here is that the daughter classes will all use Stores
2787
3919
    derived from LockableIniFileStore).
2788
3920
 
2789
 
    It implements set() by re-loading the store before applying the
2790
 
    modification and saving it.
 
3921
    It implements set() and remove () by re-loading the store before applying
 
3922
    the modification and saving it.
2791
3923
 
2792
3924
    The long term plan being to implement a single write by store to save
2793
3925
    all modifications, this class should not be used in the interim.
2800
3932
        # Force a write to persistent storage
2801
3933
        self.store.save()
2802
3934
 
2803
 
 
2804
 
class GlobalStack(_CompatibleStack):
 
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
    """
2805
3955
 
2806
3956
    def __init__(self):
2807
 
        # Get a GlobalStore
2808
 
        gstore = GlobalStore()
2809
 
        super(GlobalStack, self).__init__([gstore.get_sections], gstore)
2810
 
 
2811
 
 
2812
 
class LocationStack(_CompatibleStack):
 
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
    """
2813
3981
 
2814
3982
    def __init__(self, location):
2815
 
        lstore = LocationStore()
2816
 
        matcher = LocationMatcher(lstore, location)
2817
 
        gstore = GlobalStore()
 
3983
        """Make a new stack for a location and global configuration.
 
3984
 
 
3985
        :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())
2818
3990
        super(LocationStack, self).__init__(
2819
 
            [matcher.get_sections, gstore.get_sections], lstore)
2820
 
 
2821
 
class BranchStack(_CompatibleStack):
 
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
    """
2822
4015
 
2823
4016
    def __init__(self, branch):
2824
 
        bstore = BranchStore(branch)
2825
 
        lstore = LocationStore()
2826
 
        matcher = LocationMatcher(lstore, branch.base)
2827
 
        gstore = GlobalStore()
 
4017
        lstore = self.get_shared_store(LocationStore())
 
4018
        bstore = branch._get_config_store()
 
4019
        gstore = self.get_shared_store(GlobalStore())
2828
4020
        super(BranchStack, self).__init__(
2829
 
            [matcher.get_sections, bstore.get_sections, gstore.get_sections],
2830
 
            bstore)
2831
 
        self.branch = branch
 
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()
2832
4093
 
2833
4094
 
2834
4095
class cmd_config(commands.Command):
2835
4096
    __doc__ = """Display, set or remove a configuration option.
2836
4097
 
2837
 
    Display the active value for a given option.
 
4098
    Display the active value for option NAME.
2838
4099
 
2839
4100
    If --all is specified, NAME is interpreted as a regular expression and all
2840
 
    matching options are displayed mentioning their scope. The active value
2841
 
    that bzr will take into account is the first one displayed for each option.
2842
 
 
2843
 
    If no NAME is given, --all .* is implied.
2844
 
 
2845
 
    Setting a value is achieved by using name=value without spaces. The value
 
4101
    matching options are displayed mentioning their scope and without resolving
 
4102
    option references in the value). The active value that bzr will take into
 
4103
    account is the first one displayed for each option.
 
4104
 
 
4105
    If NAME is not given, --all .* is implied (all options are displayed for the
 
4106
    current scope).
 
4107
 
 
4108
    Setting a value is achieved by using NAME=value without spaces. The value
2846
4109
    is set in the most relevant scope and can be checked by displaying the
2847
4110
    option again.
 
4111
 
 
4112
    Removing a value is achieved by using --remove NAME.
2848
4113
    """
2849
4114
 
2850
4115
    takes_args = ['name?']
2852
4117
    takes_options = [
2853
4118
        'directory',
2854
4119
        # FIXME: This should be a registry option so that plugins can register
2855
 
        # their own config files (or not) -- vila 20101002
 
4120
        # their own config files (or not) and will also address
 
4121
        # http://pad.lv/788991 -- vila 20101115
2856
4122
        commands.Option('scope', help='Reduce the scope to the specified'
2857
 
                        ' configuration file',
 
4123
                        ' configuration file.',
2858
4124
                        type=unicode),
2859
4125
        commands.Option('all',
2860
4126
            help='Display all the defined values for the matching options.',
2861
4127
            ),
2862
4128
        commands.Option('remove', help='Remove the option from'
2863
 
                        ' the configuration file'),
 
4129
                        ' the configuration file.'),
2864
4130
        ]
2865
4131
 
2866
4132
    _see_also = ['configuration']
2870
4136
            remove=False):
2871
4137
        if directory is None:
2872
4138
            directory = '.'
 
4139
        directory = directory_service.directories.dereference(directory)
2873
4140
        directory = urlutils.normalize_url(directory)
2874
4141
        if remove and all:
2875
4142
            raise errors.BzrError(
2896
4163
                # Set the option value
2897
4164
                self._set_config_option(name, value, directory, scope)
2898
4165
 
2899
 
    def _get_configs(self, directory, scope=None):
2900
 
        """Iterate the configurations specified by ``directory`` and ``scope``.
 
4166
    def _get_stack(self, directory, scope=None, write_access=False):
 
4167
        """Get the configuration stack specified by ``directory`` and ``scope``.
2901
4168
 
2902
4169
        :param directory: Where the configurations are derived from.
2903
4170
 
2904
4171
        :param scope: A specific config to start from.
 
4172
 
 
4173
        :param write_access: Whether a write access to the stack will be
 
4174
            attempted.
2905
4175
        """
 
4176
        # FIXME: scope should allow access to plugin-specific stacks (even
 
4177
        # reduced to the plugin-specific store), related to
 
4178
        # http://pad.lv/788991 -- vila 2011-11-15
2906
4179
        if scope is not None:
2907
4180
            if scope == 'bazaar':
2908
 
                yield GlobalConfig()
 
4181
                return GlobalStack()
2909
4182
            elif scope == 'locations':
2910
 
                yield LocationConfig(directory)
 
4183
                return LocationStack(directory)
2911
4184
            elif scope == 'branch':
2912
 
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2913
 
                    directory)
2914
 
                yield br.get_config()
 
4185
                (_, br, _) = (
 
4186
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4187
                        directory))
 
4188
                if write_access:
 
4189
                    self.add_cleanup(br.lock_write().unlock)
 
4190
                return br.get_config_stack()
 
4191
            raise errors.NoSuchConfig(scope)
2915
4192
        else:
2916
4193
            try:
2917
 
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2918
 
                    directory)
2919
 
                yield br.get_config()
 
4194
                (_, br, _) = (
 
4195
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4196
                        directory))
 
4197
                if write_access:
 
4198
                    self.add_cleanup(br.lock_write().unlock)
 
4199
                return br.get_config_stack()
2920
4200
            except errors.NotBranchError:
2921
 
                yield LocationConfig(directory)
2922
 
                yield GlobalConfig()
 
4201
                return LocationStack(directory)
 
4202
 
 
4203
    def _quote_multiline(self, value):
 
4204
        if '\n' in value:
 
4205
            value = '"""' + value + '"""'
 
4206
        return value
2923
4207
 
2924
4208
    def _show_value(self, name, directory, scope):
2925
 
        displayed = False
2926
 
        for c in self._get_configs(directory, scope):
2927
 
            if displayed:
2928
 
                break
2929
 
            for (oname, value, section, conf_id, parser) in c._get_options():
2930
 
                if name == oname:
2931
 
                    # Display only the first value and exit
2932
 
 
2933
 
                    # FIXME: We need to use get_user_option to take policies
2934
 
                    # into account and we need to make sure the option exists
2935
 
                    # too (hence the two for loops), this needs a better API
2936
 
                    # -- vila 20101117
2937
 
                    value = c.get_user_option(name)
2938
 
                    # Quote the value appropriately
2939
 
                    value = parser._quote(value)
2940
 
                    self.outf.write('%s\n' % (value,))
2941
 
                    displayed = True
2942
 
                    break
2943
 
        if not displayed:
 
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:
2944
4216
            raise errors.NoSuchConfigOption(name)
2945
4217
 
2946
4218
    def _show_matching_options(self, name, directory, scope):
2949
4221
        # avoid the delay introduced by the lazy regexp.  But, we still do
2950
4222
        # want the nicer errors raised by lazy_regex.
2951
4223
        name._compile_and_collapse()
2952
 
        cur_conf_id = None
 
4224
        cur_store_id = None
2953
4225
        cur_section = None
2954
 
        for c in self._get_configs(directory, scope):
2955
 
            for (oname, value, section, conf_id, parser) in c._get_options():
 
4226
        conf = self._get_stack(directory, scope)
 
4227
        for store, section in conf.iter_sections():
 
4228
            for oname in section.iter_option_names():
2956
4229
                if name.search(oname):
2957
 
                    if cur_conf_id != conf_id:
 
4230
                    if cur_store_id != store.id:
2958
4231
                        # Explain where the options are defined
2959
 
                        self.outf.write('%s:\n' % (conf_id,))
2960
 
                        cur_conf_id = conf_id
 
4232
                        self.outf.write('%s:\n' % (store.id,))
 
4233
                        cur_store_id = store.id
2961
4234
                        cur_section = None
2962
 
                    if (section not in (None, 'DEFAULT')
2963
 
                        and cur_section != section):
2964
 
                        # Display the section if it's not the default (or only)
2965
 
                        # one.
2966
 
                        self.outf.write('  [%s]\n' % (section,))
2967
 
                        cur_section = section
 
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)
2968
4243
                    self.outf.write('  %s = %s\n' % (oname, value))
2969
4244
 
2970
4245
    def _set_config_option(self, name, value, directory, scope):
2971
 
        for conf in self._get_configs(directory, scope):
2972
 
            conf.set_user_option(name, value)
2973
 
            break
2974
 
        else:
2975
 
            raise errors.NoSuchConfig(scope)
 
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()
2976
4250
 
2977
4251
    def _remove_config_option(self, name, directory, scope):
2978
4252
        if name is None:
2979
4253
            raise errors.BzrCommandError(
2980
4254
                '--remove expects an option to remove.')
2981
 
        removed = False
2982
 
        for conf in self._get_configs(directory, scope):
2983
 
            for (section_name, section, conf_id) in conf._get_sections():
2984
 
                if scope is not None and conf_id != scope:
2985
 
                    # Not the right configuration file
2986
 
                    continue
2987
 
                if name in section:
2988
 
                    if conf_id != conf.config_id():
2989
 
                        conf = self._get_configs(directory, conf_id).next()
2990
 
                    # We use the first section in the first config where the
2991
 
                    # option is defined to remove it
2992
 
                    conf.remove_user_option(name, section_name)
2993
 
                    removed = True
2994
 
                    break
2995
 
            break
2996
 
        else:
2997
 
            raise errors.NoSuchConfig(scope)
2998
 
        if not removed:
 
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:
2999
4261
            raise errors.NoSuchConfigOption(name)
3000
4262
 
 
4263
 
3001
4264
# Test registries
3002
4265
#
3003
4266
# We need adapters that can build a Store or a Stack in a test context. Test
3006
4269
# ready-to-use store or stack.  Plugins that define new store/stacks can also
3007
4270
# register themselves here to be tested against the tests defined in
3008
4271
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3009
 
# for the same tests.
 
4272
# for the same test.
3010
4273
 
3011
4274
# The registered object should be a callable receiving a test instance
3012
4275
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store