/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-30 14:12:36 UTC
  • mfrom: (6437.3.28 2.5)
  • mto: This revision was merged to the branch mainline in revision 6522.
  • Revision ID: jelmer@samba.org-20120130141236-66k8qj1he6q2nq3r
Merge 2.5 branch.

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
#
72
72
up=pull
73
73
"""
74
74
 
 
75
from __future__ import absolute_import
 
76
from cStringIO import StringIO
75
77
import os
76
 
import string
77
78
import sys
78
79
 
79
 
 
 
80
import bzrlib
80
81
from bzrlib.decorators import needs_write_lock
81
82
from bzrlib.lazy_import import lazy_import
82
83
lazy_import(globals(), """
83
84
import fnmatch
84
85
import re
85
 
from cStringIO import StringIO
86
86
 
87
87
from bzrlib import (
88
88
    atomicfile,
89
 
    bzrdir,
 
89
    controldir,
90
90
    debug,
91
91
    errors,
92
92
    lazy_regex,
 
93
    library_state,
93
94
    lockdir,
94
95
    mail_client,
95
96
    mergetools,
101
102
    urlutils,
102
103
    win32utils,
103
104
    )
 
105
from bzrlib.i18n import gettext
104
106
from bzrlib.util.configobj import configobj
105
107
""")
106
108
from bzrlib import (
149
151
STORE_GLOBAL = 4
150
152
 
151
153
 
 
154
def signature_policy_from_unicode(signature_string):
 
155
    """Convert a string to a signing policy."""
 
156
    if signature_string.lower() == 'check-available':
 
157
        return CHECK_IF_POSSIBLE
 
158
    if signature_string.lower() == 'ignore':
 
159
        return CHECK_NEVER
 
160
    if signature_string.lower() == 'require':
 
161
        return CHECK_ALWAYS
 
162
    raise ValueError("Invalid signatures policy '%s'"
 
163
                     % signature_string)
 
164
 
 
165
 
 
166
def signing_policy_from_unicode(signature_string):
 
167
    """Convert a string to a signing policy."""
 
168
    if signature_string.lower() == 'when-required':
 
169
        return SIGN_WHEN_REQUIRED
 
170
    if signature_string.lower() == 'never':
 
171
        return SIGN_NEVER
 
172
    if signature_string.lower() == 'always':
 
173
        return SIGN_ALWAYS
 
174
    raise ValueError("Invalid signing policy '%s'"
 
175
                     % signature_string)
 
176
 
 
177
 
152
178
class ConfigObj(configobj.ConfigObj):
153
179
 
154
180
    def __init__(self, infile=None, **kwargs):
414
440
            # add) the final ','
415
441
            l = [l]
416
442
        return l
417
 
        
418
 
    def get_user_option_as_int_from_SI(self,  option_name,  default=None):
 
443
 
 
444
    @deprecated_method(deprecated_in((2, 5, 0)))
 
445
    def get_user_option_as_int_from_SI(self, option_name, default=None):
419
446
        """Get a generic option from a human readable size in SI units, e.g 10MB
420
 
        
 
447
 
421
448
        Accepted suffixes are K,M,G. It is case-insensitive and may be followed
422
449
        by a trailing b (i.e. Kb, MB). This is intended to be practical and not
423
450
        pedantic.
424
 
        
 
451
 
425
452
        :return Integer, expanded to its base-10 value if a proper SI unit is 
426
453
            found. If the option doesn't exist, or isn't a value in 
427
454
            SI units, return default (which defaults to None)
452
479
            except TypeError:
453
480
                val = default
454
481
        return val
455
 
        
456
482
 
 
483
    @deprecated_method(deprecated_in((2, 5, 0)))
457
484
    def gpg_signing_command(self):
458
485
        """What program should be used to sign signatures?"""
459
486
        result = self._gpg_signing_command()
465
492
        """See gpg_signing_command()."""
466
493
        return None
467
494
 
 
495
    @deprecated_method(deprecated_in((2, 5, 0)))
468
496
    def log_format(self):
469
497
        """What log format should be used"""
470
498
        result = self._log_format()
489
517
        """See validate_signatures_in_log()."""
490
518
        return None
491
519
 
 
520
    @deprecated_method(deprecated_in((2, 5, 0)))
492
521
    def acceptable_keys(self):
493
522
        """Comma separated list of key patterns acceptable to 
494
523
        verify-signatures command"""
499
528
        """See acceptable_keys()."""
500
529
        return None
501
530
 
 
531
    @deprecated_method(deprecated_in((2, 5, 0)))
502
532
    def post_commit(self):
503
533
        """An ordered list of python functions to call.
504
534
 
530
560
        v = self._get_user_id()
531
561
        if v:
532
562
            return v
533
 
        v = os.environ.get('EMAIL')
534
 
        if v:
535
 
            return v.decode(osutils.get_user_encoding())
536
 
        name, email = _auto_user_id()
537
 
        if name and email:
538
 
            return '%s <%s>' % (name, email)
539
 
        elif email:
540
 
            return email
541
 
        raise errors.NoWhoami()
 
563
        return default_email()
542
564
 
543
565
    def ensure_username(self):
544
566
        """Raise errors.NoWhoami if username is not set.
547
569
        """
548
570
        self.username()
549
571
 
 
572
    @deprecated_method(deprecated_in((2, 5, 0)))
550
573
    def signature_checking(self):
551
574
        """What is the current policy for signature checking?."""
552
575
        policy = self._get_signature_checking()
554
577
            return policy
555
578
        return CHECK_IF_POSSIBLE
556
579
 
 
580
    @deprecated_method(deprecated_in((2, 5, 0)))
557
581
    def signing_policy(self):
558
582
        """What is the current policy for signature checking?."""
559
583
        policy = self._get_signing_policy()
561
585
            return policy
562
586
        return SIGN_WHEN_REQUIRED
563
587
 
 
588
    @deprecated_method(deprecated_in((2, 5, 0)))
564
589
    def signature_needed(self):
565
590
        """Is a signature needed when committing ?."""
566
591
        policy = self._get_signing_policy()
575
600
            return True
576
601
        return False
577
602
 
 
603
    @deprecated_method(deprecated_in((2, 5, 0)))
578
604
    def gpg_signing_key(self):
579
605
        """GPG user-id to sign commits"""
580
606
        key = self.get_user_option('gpg_signing_key')
865
891
        """See Config._get_signature_checking."""
866
892
        policy = self._get_user_option('check_signatures')
867
893
        if policy:
868
 
            return self._string_to_signature_policy(policy)
 
894
            return signature_policy_from_unicode(policy)
869
895
 
870
896
    def _get_signing_policy(self):
871
897
        """See Config._get_signing_policy"""
872
898
        policy = self._get_user_option('create_signatures')
873
899
        if policy:
874
 
            return self._string_to_signing_policy(policy)
 
900
            return signing_policy_from_unicode(policy)
875
901
 
876
902
    def _get_user_id(self):
877
903
        """Get the user id from the 'email' key in the current section."""
922
948
        """See Config.post_commit."""
923
949
        return self._get_user_option('post_commit')
924
950
 
925
 
    def _string_to_signature_policy(self, signature_string):
926
 
        """Convert a string to a signing policy."""
927
 
        if signature_string.lower() == 'check-available':
928
 
            return CHECK_IF_POSSIBLE
929
 
        if signature_string.lower() == 'ignore':
930
 
            return CHECK_NEVER
931
 
        if signature_string.lower() == 'require':
932
 
            return CHECK_ALWAYS
933
 
        raise errors.BzrError("Invalid signatures policy '%s'"
934
 
                              % signature_string)
935
 
 
936
 
    def _string_to_signing_policy(self, signature_string):
937
 
        """Convert a string to a signing policy."""
938
 
        if signature_string.lower() == 'when-required':
939
 
            return SIGN_WHEN_REQUIRED
940
 
        if signature_string.lower() == 'never':
941
 
            return SIGN_NEVER
942
 
        if signature_string.lower() == 'always':
943
 
            return SIGN_ALWAYS
944
 
        raise errors.BzrError("Invalid signing policy '%s'"
945
 
                              % signature_string)
946
 
 
947
951
    def _get_alias(self, value):
948
952
        try:
949
953
            return self._get_parser().get_value("ALIASES",
1393
1397
        e.g. "John Hacker <jhacker@example.com>"
1394
1398
        This is looked up in the email controlfile for the branch.
1395
1399
        """
1396
 
        try:
1397
 
            return (self.branch._transport.get_bytes("email")
1398
 
                    .decode(osutils.get_user_encoding())
1399
 
                    .rstrip("\r\n"))
1400
 
        except (errors.NoSuchFile, errors.PermissionDenied), e:
1401
 
            pass
1402
 
 
1403
1400
        return self._get_best_value('_get_user_id')
1404
1401
 
1405
1402
    def _get_change_editor(self):
1639
1636
        f.close()
1640
1637
 
1641
1638
 
 
1639
def default_email():
 
1640
    v = os.environ.get('BZR_EMAIL')
 
1641
    if v:
 
1642
        return v.decode(osutils.get_user_encoding())
 
1643
    v = os.environ.get('EMAIL')
 
1644
    if v:
 
1645
        return v.decode(osutils.get_user_encoding())
 
1646
    name, email = _auto_user_id()
 
1647
    if name and email:
 
1648
        return u'%s <%s>' % (name, email)
 
1649
    elif email:
 
1650
        return email
 
1651
    raise errors.NoWhoami()
 
1652
 
 
1653
 
1642
1654
def _auto_user_id():
1643
1655
    """Calculate automatic user identification.
1644
1656
 
1833
1845
        :param user: login (optional)
1834
1846
 
1835
1847
        :param path: the absolute path on the server (optional)
1836
 
        
 
1848
 
1837
1849
        :param realm: the http authentication realm (optional)
1838
1850
 
1839
1851
        :return: A dict containing the matching credentials or None.
2319
2331
    encoutered, in which config files it can be stored.
2320
2332
    """
2321
2333
 
2322
 
    def __init__(self, name, default=None, default_from_env=None,
2323
 
                 help=None,
2324
 
                 from_unicode=None, invalid=None):
 
2334
    def __init__(self, name, override_from_env=None,
 
2335
                 default=None, default_from_env=None,
 
2336
                 help=None, from_unicode=None, invalid=None, unquote=True):
2325
2337
        """Build an option definition.
2326
2338
 
2327
2339
        :param name: the name used to refer to the option.
2328
2340
 
 
2341
        :param override_from_env: A list of environment variables which can
 
2342
           provide override any configuration setting.
 
2343
 
2329
2344
        :param default: the default value to use when none exist in the config
2330
2345
            stores. This is either a string that ``from_unicode`` will convert
2331
 
            into the proper type or a python object that can be stringified (so
2332
 
            only the empty list is supported for example).
 
2346
            into the proper type, a callable returning a unicode string so that
 
2347
            ``from_unicode`` can be used on the return value, or a python
 
2348
            object that can be stringified (so only the empty list is supported
 
2349
            for example).
2333
2350
 
2334
2351
        :param default_from_env: A list of environment variables which can
2335
2352
           provide a default value. 'default' will be used only if none of the
2347
2364
            TypeError. Accepted values are: None (ignore invalid values),
2348
2365
            'warning' (emit a warning), 'error' (emit an error message and
2349
2366
            terminates).
 
2367
 
 
2368
        :param unquote: should the unicode value be unquoted before conversion.
 
2369
           This should be used only when the store providing the values cannot
 
2370
           safely unquote them (see http://pad.lv/906897). It is provided so
 
2371
           daughter classes can handle the quoting themselves.
2350
2372
        """
 
2373
        if override_from_env is None:
 
2374
            override_from_env = []
2351
2375
        if default_from_env is None:
2352
2376
            default_from_env = []
2353
2377
        self.name = name
 
2378
        self.override_from_env = override_from_env
2354
2379
        # Convert the default value to a unicode string so all values are
2355
2380
        # strings internally before conversion (via from_unicode) is attempted.
2356
2381
        if default is None:
2361
2386
                raise AssertionError(
2362
2387
                    'Only empty lists are supported as default values')
2363
2388
            self.default = u','
2364
 
        elif isinstance(default, (str, unicode, bool, int)):
 
2389
        elif isinstance(default, (str, unicode, bool, int, float)):
2365
2390
            # Rely on python to convert strings, booleans and integers
2366
2391
            self.default = u'%s' % (default,)
 
2392
        elif callable(default):
 
2393
            self.default = default
2367
2394
        else:
2368
2395
            # other python objects are not expected
2369
2396
            raise AssertionError('%r is not supported as a default value'
2371
2398
        self.default_from_env = default_from_env
2372
2399
        self.help = help
2373
2400
        self.from_unicode = from_unicode
 
2401
        self.unquote = unquote
2374
2402
        if invalid and invalid not in ('warning', 'error'):
2375
2403
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2376
2404
        self.invalid = invalid
2377
2405
 
2378
 
    def convert_from_unicode(self, unicode_value):
 
2406
    def convert_from_unicode(self, store, unicode_value):
 
2407
        if self.unquote and store is not None and unicode_value is not None:
 
2408
            unicode_value = store.unquote(unicode_value)
2379
2409
        if self.from_unicode is None or unicode_value is None:
2380
2410
            # Don't convert or nothing to convert
2381
2411
            return unicode_value
2393
2423
                raise errors.ConfigOptionValueError(self.name, unicode_value)
2394
2424
        return converted
2395
2425
 
 
2426
    def get_override(self):
 
2427
        value = None
 
2428
        for var in self.override_from_env:
 
2429
            try:
 
2430
                # If the env variable is defined, its value takes precedence
 
2431
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2432
                break
 
2433
            except KeyError:
 
2434
                continue
 
2435
        return value
 
2436
 
2396
2437
    def get_default(self):
2397
2438
        value = None
2398
2439
        for var in self.default_from_env:
2399
2440
            try:
2400
2441
                # If the env variable is defined, its value is the default one
2401
 
                value = os.environ[var]
 
2442
                value = os.environ[var].decode(osutils.get_user_encoding())
2402
2443
                break
2403
2444
            except KeyError:
2404
2445
                continue
2405
2446
        if value is None:
2406
2447
            # Otherwise, fallback to the value defined at registration
2407
 
            value = self.default
 
2448
            if callable(self.default):
 
2449
                value = self.default()
 
2450
                if not isinstance(value, unicode):
 
2451
                    raise AssertionError(
 
2452
                    'Callable default values should be unicode')
 
2453
            else:
 
2454
                value = self.default
2408
2455
        return value
2409
2456
 
2410
2457
    def get_help_text(self, additional_see_also=None, plain=True):
2426
2473
    return int(unicode_str)
2427
2474
 
2428
2475
 
 
2476
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
 
2477
 
 
2478
def int_SI_from_store(unicode_str):
 
2479
    """Convert a human readable size in SI units, e.g 10MB into an integer.
 
2480
 
 
2481
    Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
2482
    by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
2483
    pedantic.
 
2484
 
 
2485
    :return Integer, expanded to its base-10 value if a proper SI unit is 
 
2486
        found, None otherwise.
 
2487
    """
 
2488
    regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
 
2489
    p = re.compile(regexp, re.IGNORECASE)
 
2490
    m = p.match(unicode_str)
 
2491
    val = None
 
2492
    if m is not None:
 
2493
        val, _, unit = m.groups()
 
2494
        val = int(val)
 
2495
        if unit:
 
2496
            try:
 
2497
                coeff = _unit_suffixes[unit.upper()]
 
2498
            except KeyError:
 
2499
                raise ValueError(gettext('{0} is not an SI unit.').format(unit))
 
2500
            val *= coeff
 
2501
    return val
 
2502
 
 
2503
 
 
2504
def float_from_store(unicode_str):
 
2505
    return float(unicode_str)
 
2506
 
 
2507
 
2429
2508
# Use a an empty dict to initialize an empty configobj avoiding all
2430
2509
# parsing and encoding checks
2431
2510
_list_converter_config = configobj.ConfigObj(
2432
2511
    {}, encoding='utf-8', list_values=True, interpolation=False)
2433
2512
 
2434
2513
 
2435
 
def list_from_store(unicode_str):
2436
 
    if not isinstance(unicode_str, basestring):
2437
 
        raise TypeError
2438
 
    # Now inject our string directly as unicode. All callers got their value
2439
 
    # from configobj, so values that need to be quoted are already properly
2440
 
    # quoted.
2441
 
    _list_converter_config.reset()
2442
 
    _list_converter_config._parse([u"list=%s" % (unicode_str,)])
2443
 
    maybe_list = _list_converter_config['list']
2444
 
    # ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
2445
 
    if isinstance(maybe_list, basestring):
2446
 
        if maybe_list:
2447
 
            # A single value, most probably the user forgot (or didn't care to
2448
 
            # add) the final ','
2449
 
            l = [maybe_list]
 
2514
class ListOption(Option):
 
2515
 
 
2516
    def __init__(self, name, default=None, default_from_env=None,
 
2517
                 help=None, invalid=None):
 
2518
        """A list Option definition.
 
2519
 
 
2520
        This overrides the base class so the conversion from a unicode string
 
2521
        can take quoting into account.
 
2522
        """
 
2523
        super(ListOption, self).__init__(
 
2524
            name, default=default, default_from_env=default_from_env,
 
2525
            from_unicode=self.from_unicode, help=help,
 
2526
            invalid=invalid, unquote=False)
 
2527
 
 
2528
    def from_unicode(self, unicode_str):
 
2529
        if not isinstance(unicode_str, basestring):
 
2530
            raise TypeError
 
2531
        # Now inject our string directly as unicode. All callers got their
 
2532
        # value from configobj, so values that need to be quoted are already
 
2533
        # properly quoted.
 
2534
        _list_converter_config.reset()
 
2535
        _list_converter_config._parse([u"list=%s" % (unicode_str,)])
 
2536
        maybe_list = _list_converter_config['list']
 
2537
        if isinstance(maybe_list, basestring):
 
2538
            if maybe_list:
 
2539
                # A single value, most probably the user forgot (or didn't care
 
2540
                # to add) the final ','
 
2541
                l = [maybe_list]
 
2542
            else:
 
2543
                # The empty string, convert to empty list
 
2544
                l = []
2450
2545
        else:
2451
 
            # The empty string, convert to empty list
2452
 
            l = []
2453
 
    else:
2454
 
        # We rely on ConfigObj providing us with a list already
2455
 
        l = maybe_list
2456
 
    return l
 
2546
            # We rely on ConfigObj providing us with a list already
 
2547
            l = maybe_list
 
2548
        return l
2457
2549
 
2458
2550
 
2459
2551
class OptionRegistry(registry.Registry):
2500
2592
# Registered options in lexicographical order
2501
2593
 
2502
2594
option_registry.register(
 
2595
    Option('append_revisions_only',
 
2596
           default=None, from_unicode=bool_from_store, invalid='warning',
 
2597
           help='''\
 
2598
Whether to only append revisions to the mainline.
 
2599
 
 
2600
If this is set to true, then it is not possible to change the
 
2601
existing mainline of the branch.
 
2602
'''))
 
2603
option_registry.register(
 
2604
    ListOption('acceptable_keys',
 
2605
           default=None,
 
2606
           help="""\
 
2607
List of GPG key patterns which are acceptable for verification.
 
2608
"""))
 
2609
option_registry.register(
 
2610
    Option('add.maximum_file_size',
 
2611
           default=u'20MB', from_unicode=int_SI_from_store,
 
2612
           help="""\
 
2613
Size above which files should be added manually.
 
2614
 
 
2615
Files below this size are added automatically when using ``bzr add`` without
 
2616
arguments.
 
2617
 
 
2618
A negative value means disable the size check.
 
2619
"""))
 
2620
option_registry.register(
 
2621
    Option('bound',
 
2622
           default=None, from_unicode=bool_from_store,
 
2623
           help="""\
 
2624
Is the branch bound to ``bound_location``.
 
2625
 
 
2626
If set to "True", the branch should act as a checkout, and push each commit to
 
2627
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
2628
 
 
2629
See also: bound_location.
 
2630
"""))
 
2631
option_registry.register(
 
2632
    Option('bound_location',
 
2633
           default=None,
 
2634
           help="""\
 
2635
The location that commits should go to when acting as a checkout.
 
2636
 
 
2637
This option is normally set by ``bind``.
 
2638
 
 
2639
See also: bound.
 
2640
"""))
 
2641
option_registry.register(
 
2642
    Option('branch.fetch_tags', default=False,  from_unicode=bool_from_store,
 
2643
           help="""\
 
2644
Whether revisions associated with tags should be fetched.
 
2645
"""))
 
2646
option_registry.register(
2503
2647
    Option('bzr.workingtree.worth_saving_limit', default=10,
2504
2648
           from_unicode=int_from_store,  invalid='warning',
2505
2649
           help='''\
2512
2656
a file has been touched.
2513
2657
'''))
2514
2658
option_registry.register(
 
2659
    Option('check_signatures', default=CHECK_IF_POSSIBLE,
 
2660
           from_unicode=signature_policy_from_unicode,
 
2661
           help='''\
 
2662
GPG checking policy.
 
2663
 
 
2664
Possible values: require, ignore, check-available (default)
 
2665
 
 
2666
this option will control whether bzr will require good gpg
 
2667
signatures, ignore them, or check them if they are
 
2668
present.
 
2669
'''))
 
2670
option_registry.register(
 
2671
    Option('child_submit_format',
 
2672
           help='''The preferred format of submissions to this branch.'''))
 
2673
option_registry.register(
 
2674
    Option('child_submit_to',
 
2675
           help='''Where submissions to this branch are mailed to.'''))
 
2676
option_registry.register(
 
2677
    Option('create_signatures', default=SIGN_WHEN_REQUIRED,
 
2678
           from_unicode=signing_policy_from_unicode,
 
2679
           help='''\
 
2680
GPG Signing policy.
 
2681
 
 
2682
Possible values: always, never, when-required (default)
 
2683
 
 
2684
This option controls whether bzr will always create
 
2685
gpg signatures or not on commits.
 
2686
'''))
 
2687
option_registry.register(
2515
2688
    Option('dirstate.fdatasync', default=True,
2516
2689
           from_unicode=bool_from_store,
2517
2690
           help='''\
2522
2695
should not be lost if the machine crashes.  See also repository.fdatasync.
2523
2696
'''))
2524
2697
option_registry.register(
2525
 
    Option('debug_flags', default=[], from_unicode=list_from_store,
 
2698
    ListOption('debug_flags', default=[],
2526
2699
           help='Debug flags to activate.'))
2527
2700
option_registry.register(
2528
2701
    Option('default_format', default='2a',
2541
2714
    Option('editor',
2542
2715
           help='The command called to launch an editor to enter a message.'))
2543
2716
option_registry.register(
 
2717
    Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
 
2718
           help='The users identity'))
 
2719
option_registry.register(
 
2720
    Option('gpg_signing_command',
 
2721
           default='gpg',
 
2722
           help="""\
 
2723
Program to use use for creating signatures.
 
2724
 
 
2725
This should support at least the -u and --clearsign options.
 
2726
"""))
 
2727
option_registry.register(
 
2728
    Option('gpg_signing_key',
 
2729
           default=None,
 
2730
           help="""\
 
2731
GPG key to use for signing.
 
2732
 
 
2733
This defaults to the first key associated with the users email.
 
2734
"""))
 
2735
option_registry.register(
2544
2736
    Option('ignore_missing_extensions', default=False,
2545
2737
           from_unicode=bool_from_store,
2546
2738
           help='''\
2564
2756
Otherwise, bzr will prompt as normal to break the lock.
2565
2757
'''))
2566
2758
option_registry.register(
 
2759
    Option('log_format', default='long',
 
2760
           help= '''\
 
2761
Log format to use when displaying revisions.
 
2762
 
 
2763
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
 
2764
may be provided by plugins.
 
2765
'''))
 
2766
option_registry.register(
2567
2767
    Option('output_encoding',
2568
2768
           help= 'Unicode encoding for output'
2569
2769
           ' (terminal encoding if not specified).'))
2570
2770
option_registry.register(
 
2771
    Option('parent_location',
 
2772
           default=None,
 
2773
           help="""\
 
2774
The location of the default branch for pull or merge.
 
2775
 
 
2776
This option is normally set when creating a branch, the first ``pull`` or by
 
2777
``pull --remember``.
 
2778
"""))
 
2779
option_registry.register(
 
2780
    Option('post_commit', default=None,
 
2781
           help='''\
 
2782
Post commit functions.
 
2783
 
 
2784
An ordered list of python functions to call, separated by spaces.
 
2785
 
 
2786
Each function takes branch, rev_id as parameters.
 
2787
'''))
 
2788
option_registry.register(
 
2789
    Option('public_branch',
 
2790
           default=None,
 
2791
           help="""\
 
2792
A publically-accessible version of this branch.
 
2793
 
 
2794
This implies that the branch setting this option is not publically-accessible.
 
2795
Used and set by ``bzr send``.
 
2796
"""))
 
2797
option_registry.register(
 
2798
    Option('push_location',
 
2799
           default=None,
 
2800
           help="""\
 
2801
The location of the default branch for push.
 
2802
 
 
2803
This option is normally set by the first ``push`` or ``push --remember``.
 
2804
"""))
 
2805
option_registry.register(
2571
2806
    Option('push_strict', default=None,
2572
2807
           from_unicode=bool_from_store,
2573
2808
           help='''\
2586
2821
to physical disk.  This is somewhat slower, but means data should not be
2587
2822
lost if the machine crashes.  See also dirstate.fdatasync.
2588
2823
'''))
 
2824
option_registry.register_lazy('smtp_server',
 
2825
    'bzrlib.smtp_connection', 'smtp_server')
 
2826
option_registry.register_lazy('smtp_password',
 
2827
    'bzrlib.smtp_connection', 'smtp_password')
 
2828
option_registry.register_lazy('smtp_username',
 
2829
    'bzrlib.smtp_connection', 'smtp_username')
 
2830
option_registry.register(
 
2831
    Option('selftest.timeout',
 
2832
        default='600',
 
2833
        from_unicode=int_from_store,
 
2834
        help='Abort selftest if one test takes longer than this many seconds',
 
2835
        ))
 
2836
 
2589
2837
option_registry.register(
2590
2838
    Option('send_strict', default=None,
2591
2839
           from_unicode=bool_from_store,
2593
2841
The default value for ``send --strict``.
2594
2842
 
2595
2843
If present, defines the ``--strict`` option default value for checking
2596
 
uncommitted changes before pushing.
 
2844
uncommitted changes before sending a bundle.
2597
2845
'''))
2598
2846
 
 
2847
option_registry.register(
 
2848
    Option('serve.client_timeout',
 
2849
           default=300.0, from_unicode=float_from_store,
 
2850
           help="If we wait for a new request from a client for more than"
 
2851
                " X seconds, consider the client idle, and hangup."))
 
2852
option_registry.register(
 
2853
    Option('stacked_on_location',
 
2854
           default=None,
 
2855
           help="""The location where this branch is stacked on."""))
 
2856
option_registry.register(
 
2857
    Option('submit_branch',
 
2858
           default=None,
 
2859
           help="""\
 
2860
The branch you intend to submit your current work to.
 
2861
 
 
2862
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
 
2863
by the ``submit:`` revision spec.
 
2864
"""))
 
2865
option_registry.register(
 
2866
    Option('submit_to',
 
2867
           help='''Where submissions from this branch are mailed to.'''))
 
2868
 
 
2869
option_registry.register_lazy('ssl.ca_certs',
 
2870
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
 
2871
 
 
2872
option_registry.register_lazy('ssl.cert_reqs',
 
2873
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
 
2874
 
 
2875
 
2599
2876
 
2600
2877
class Section(object):
2601
2878
    """A section defines a dict of option name => value.
2610
2887
        # We re-use the dict-like object received
2611
2888
        self.options = options
2612
2889
 
2613
 
    def get(self, name, default=None):
 
2890
    def get(self, name, default=None, expand=True):
2614
2891
        return self.options.get(name, default)
2615
2892
 
 
2893
    def iter_option_names(self):
 
2894
        for k in self.options.iterkeys():
 
2895
            yield k
 
2896
 
2616
2897
    def __repr__(self):
2617
2898
        # Mostly for debugging use
2618
2899
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2620
2901
 
2621
2902
_NewlyCreatedOption = object()
2622
2903
"""Was the option created during the MutableSection lifetime"""
 
2904
_DeletedOption = object()
 
2905
"""Was the option deleted during the MutableSection lifetime"""
2623
2906
 
2624
2907
 
2625
2908
class MutableSection(Section):
2627
2910
 
2628
2911
    def __init__(self, section_id, options):
2629
2912
        super(MutableSection, self).__init__(section_id, options)
2630
 
        self.orig = {}
 
2913
        self.reset_changes()
2631
2914
 
2632
2915
    def set(self, name, value):
2633
2916
        if name not in self.options:
2642
2925
            self.orig[name] = self.get(name, None)
2643
2926
        del self.options[name]
2644
2927
 
 
2928
    def reset_changes(self):
 
2929
        self.orig = {}
 
2930
 
 
2931
    def apply_changes(self, dirty, store):
 
2932
        """Apply option value changes.
 
2933
 
 
2934
        ``self`` has been reloaded from the persistent storage. ``dirty``
 
2935
        contains the changes made since the previous loading.
 
2936
 
 
2937
        :param dirty: the mutable section containing the changes.
 
2938
 
 
2939
        :param store: the store containing the section
 
2940
        """
 
2941
        for k, expected in dirty.orig.iteritems():
 
2942
            actual = dirty.get(k, _DeletedOption)
 
2943
            reloaded = self.get(k, _NewlyCreatedOption)
 
2944
            if actual is _DeletedOption:
 
2945
                if k in self.options:
 
2946
                    self.remove(k)
 
2947
            else:
 
2948
                self.set(k, actual)
 
2949
            # Report concurrent updates in an ad-hoc way. This should only
 
2950
            # occurs when different processes try to update the same option
 
2951
            # which is not supported (as in: the config framework is not meant
 
2952
            # to be used a sharing mechanism).
 
2953
            if expected != reloaded:
 
2954
                if actual is _DeletedOption:
 
2955
                    actual = '<DELETED>'
 
2956
                if reloaded is _NewlyCreatedOption:
 
2957
                    reloaded = '<CREATED>'
 
2958
                if expected is _NewlyCreatedOption:
 
2959
                    expected = '<CREATED>'
 
2960
                # Someone changed the value since we get it from the persistent
 
2961
                # storage.
 
2962
                trace.warning(gettext(
 
2963
                        "Option {0} in section {1} of {2} was changed"
 
2964
                        " from {3} to {4}. The {5} value will be saved.".format(
 
2965
                            k, self.id, store.external_url(), expected,
 
2966
                            reloaded, actual)))
 
2967
        # No need to keep track of these changes
 
2968
        self.reset_changes()
 
2969
 
2645
2970
 
2646
2971
class Store(object):
2647
2972
    """Abstract interface to persistent storage for configuration options."""
2649
2974
    readonly_section_class = Section
2650
2975
    mutable_section_class = MutableSection
2651
2976
 
 
2977
    def __init__(self):
 
2978
        # Which sections need to be saved
 
2979
        self.dirty_sections = []
 
2980
 
2652
2981
    def is_loaded(self):
2653
2982
        """Returns True if the Store has been loaded.
2654
2983
 
2677
3006
        """
2678
3007
        raise NotImplementedError(self.unload)
2679
3008
 
 
3009
    def quote(self, value):
 
3010
        """Quote a configuration option value for storing purposes.
 
3011
 
 
3012
        This allows Stacks to present values as they will be stored.
 
3013
        """
 
3014
        return value
 
3015
 
 
3016
    def unquote(self, value):
 
3017
        """Unquote a configuration option value into unicode.
 
3018
 
 
3019
        The received value is quoted as stored.
 
3020
        """
 
3021
        return value
 
3022
 
2680
3023
    def save(self):
2681
3024
        """Saves the Store to persistent storage."""
2682
3025
        raise NotImplementedError(self.save)
2683
3026
 
 
3027
    def _need_saving(self):
 
3028
        for s in self.dirty_sections:
 
3029
            if s.orig:
 
3030
                # At least one dirty section contains a modification
 
3031
                return True
 
3032
        return False
 
3033
 
 
3034
    def apply_changes(self, dirty_sections):
 
3035
        """Apply changes from dirty sections while checking for coherency.
 
3036
 
 
3037
        The Store content is discarded and reloaded from persistent storage to
 
3038
        acquire up-to-date values.
 
3039
 
 
3040
        Dirty sections are MutableSection which kept track of the value they
 
3041
        are expected to update.
 
3042
        """
 
3043
        # We need an up-to-date version from the persistent storage, unload the
 
3044
        # store. The reload will occur when needed (triggered by the first
 
3045
        # get_mutable_section() call below.
 
3046
        self.unload()
 
3047
        # Apply the changes from the preserved dirty sections
 
3048
        for dirty in dirty_sections:
 
3049
            clean = self.get_mutable_section(dirty.id)
 
3050
            clean.apply_changes(dirty, self)
 
3051
        # Everything is clean now
 
3052
        self.dirty_sections = []
 
3053
 
 
3054
    def save_changes(self):
 
3055
        """Saves the Store to persistent storage if changes occurred.
 
3056
 
 
3057
        Apply the changes recorded in the mutable sections to a store content
 
3058
        refreshed from persistent storage.
 
3059
        """
 
3060
        raise NotImplementedError(self.save_changes)
 
3061
 
2684
3062
    def external_url(self):
2685
3063
        raise NotImplementedError(self.external_url)
2686
3064
 
2687
3065
    def get_sections(self):
2688
3066
        """Returns an ordered iterable of existing sections.
2689
3067
 
2690
 
        :returns: An iterable of (name, dict).
 
3068
        :returns: An iterable of (store, section).
2691
3069
        """
2692
3070
        raise NotImplementedError(self.get_sections)
2693
3071
 
2694
 
    def get_mutable_section(self, section_name=None):
 
3072
    def get_mutable_section(self, section_id=None):
2695
3073
        """Returns the specified mutable section.
2696
3074
 
2697
 
        :param section_name: The section identifier
 
3075
        :param section_id: The section identifier
2698
3076
        """
2699
3077
        raise NotImplementedError(self.get_mutable_section)
2700
3078
 
2704
3082
                                    self.external_url())
2705
3083
 
2706
3084
 
 
3085
class CommandLineStore(Store):
 
3086
    "A store to carry command line overrides for the config options."""
 
3087
 
 
3088
    def __init__(self, opts=None):
 
3089
        super(CommandLineStore, self).__init__()
 
3090
        if opts is None:
 
3091
            opts = {}
 
3092
        self.options = {}
 
3093
        self.id = 'cmdline'
 
3094
 
 
3095
    def _reset(self):
 
3096
        # The dict should be cleared but not replaced so it can be shared.
 
3097
        self.options.clear()
 
3098
 
 
3099
    def _from_cmdline(self, overrides):
 
3100
        # Reset before accepting new definitions
 
3101
        self._reset()
 
3102
        for over in overrides:
 
3103
            try:
 
3104
                name, value = over.split('=', 1)
 
3105
            except ValueError:
 
3106
                raise errors.BzrCommandError(
 
3107
                    gettext("Invalid '%s', should be of the form 'name=value'")
 
3108
                    % (over,))
 
3109
            self.options[name] = value
 
3110
 
 
3111
    def external_url(self):
 
3112
        # Not an url but it makes debugging easier and is never needed
 
3113
        # otherwise
 
3114
        return 'cmdline'
 
3115
 
 
3116
    def get_sections(self):
 
3117
        yield self,  self.readonly_section_class(None, self.options)
 
3118
 
 
3119
 
2707
3120
class IniFileStore(Store):
2708
3121
    """A config Store using ConfigObj for storage.
2709
3122
 
2710
 
    :ivar transport: The transport object where the config file is located.
2711
 
 
2712
 
    :ivar file_name: The config file basename in the transport directory.
2713
 
 
2714
3123
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
2715
3124
        serialize/deserialize the config file.
2716
3125
    """
2717
3126
 
2718
 
    def __init__(self, transport, file_name):
 
3127
    def __init__(self):
2719
3128
        """A config Store using ConfigObj for storage.
2720
 
 
2721
 
        :param transport: The transport object where the config file is located.
2722
 
 
2723
 
        :param file_name: The config file basename in the transport directory.
2724
3129
        """
2725
3130
        super(IniFileStore, self).__init__()
2726
 
        self.transport = transport
2727
 
        self.file_name = file_name
2728
3131
        self._config_obj = None
2729
3132
 
2730
3133
    def is_loaded(self):
2732
3135
 
2733
3136
    def unload(self):
2734
3137
        self._config_obj = None
 
3138
        self.dirty_sections = []
 
3139
 
 
3140
    def _load_content(self):
 
3141
        """Load the config file bytes.
 
3142
 
 
3143
        This should be provided by subclasses
 
3144
 
 
3145
        :return: Byte string
 
3146
        """
 
3147
        raise NotImplementedError(self._load_content)
 
3148
 
 
3149
    def _save_content(self, content):
 
3150
        """Save the config file bytes.
 
3151
 
 
3152
        This should be provided by subclasses
 
3153
 
 
3154
        :param content: Config file bytes to write
 
3155
        """
 
3156
        raise NotImplementedError(self._save_content)
2735
3157
 
2736
3158
    def load(self):
2737
3159
        """Load the store from the associated file."""
2738
3160
        if self.is_loaded():
2739
3161
            return
2740
 
        try:
2741
 
            content = self.transport.get_bytes(self.file_name)
2742
 
        except errors.PermissionDenied:
2743
 
            trace.warning("Permission denied while trying to load "
2744
 
                          "configuration store %s.", self.external_url())
2745
 
            raise
 
3162
        content = self._load_content()
2746
3163
        self._load_from_string(content)
2747
3164
        for hook in ConfigHooks['load']:
2748
3165
            hook(self)
2765
3182
        except UnicodeDecodeError:
2766
3183
            raise errors.ConfigContentError(self.external_url())
2767
3184
 
 
3185
    def save_changes(self):
 
3186
        if not self.is_loaded():
 
3187
            # Nothing to save
 
3188
            return
 
3189
        if not self._need_saving():
 
3190
            return
 
3191
        # Preserve the current version
 
3192
        current = self._config_obj
 
3193
        dirty_sections = list(self.dirty_sections)
 
3194
        self.apply_changes(dirty_sections)
 
3195
        # Save to the persistent storage
 
3196
        self.save()
 
3197
 
2768
3198
    def save(self):
2769
3199
        if not self.is_loaded():
2770
3200
            # Nothing to save
2771
3201
            return
2772
3202
        out = StringIO()
2773
3203
        self._config_obj.write(out)
2774
 
        self.transport.put_bytes(self.file_name, out.getvalue())
 
3204
        self._save_content(out.getvalue())
2775
3205
        for hook in ConfigHooks['save']:
2776
3206
            hook(self)
2777
3207
 
2778
 
    def external_url(self):
2779
 
        # FIXME: external_url should really accepts an optional relpath
2780
 
        # parameter (bug #750169) :-/ -- vila 2011-04-04
2781
 
        # The following will do in the interim but maybe we don't want to
2782
 
        # expose a path here but rather a config ID and its associated
2783
 
        # object </hand wawe>.
2784
 
        return urlutils.join(self.transport.external_url(), self.file_name)
2785
 
 
2786
3208
    def get_sections(self):
2787
3209
        """Get the configobj section in the file order.
2788
3210
 
2789
 
        :returns: An iterable of (name, dict).
 
3211
        :returns: An iterable of (store, section).
2790
3212
        """
2791
3213
        # We need a loaded store
2792
3214
        try:
2796
3218
            return
2797
3219
        cobj = self._config_obj
2798
3220
        if cobj.scalars:
2799
 
            yield self.readonly_section_class(None, cobj)
 
3221
            yield self, self.readonly_section_class(None, cobj)
2800
3222
        for section_name in cobj.sections:
2801
 
            yield self.readonly_section_class(section_name, cobj[section_name])
 
3223
            yield (self,
 
3224
                   self.readonly_section_class(section_name,
 
3225
                                               cobj[section_name]))
2802
3226
 
2803
 
    def get_mutable_section(self, section_name=None):
 
3227
    def get_mutable_section(self, section_id=None):
2804
3228
        # We need a loaded store
2805
3229
        try:
2806
3230
            self.load()
2807
3231
        except errors.NoSuchFile:
2808
3232
            # The file doesn't exist, let's pretend it was empty
2809
3233
            self._load_from_string('')
2810
 
        if section_name is None:
 
3234
        if section_id is None:
2811
3235
            section = self._config_obj
2812
3236
        else:
2813
 
            section = self._config_obj.setdefault(section_name, {})
2814
 
        return self.mutable_section_class(section_name, section)
 
3237
            section = self._config_obj.setdefault(section_id, {})
 
3238
        mutable_section = self.mutable_section_class(section_id, section)
 
3239
        # All mutable sections can become dirty
 
3240
        self.dirty_sections.append(mutable_section)
 
3241
        return mutable_section
 
3242
 
 
3243
    def quote(self, value):
 
3244
        try:
 
3245
            # configobj conflates automagical list values and quoting
 
3246
            self._config_obj.list_values = True
 
3247
            return self._config_obj._quote(value)
 
3248
        finally:
 
3249
            self._config_obj.list_values = False
 
3250
 
 
3251
    def unquote(self, value):
 
3252
        if value and isinstance(value, basestring):
 
3253
            # _unquote doesn't handle None nor empty strings nor anything that
 
3254
            # is not a string, really.
 
3255
            value = self._config_obj._unquote(value)
 
3256
        return value
 
3257
 
 
3258
    def external_url(self):
 
3259
        # Since an IniFileStore can be used without a file (at least in tests),
 
3260
        # it's better to provide something than raising a NotImplementedError.
 
3261
        # All daughter classes are supposed to provide an implementation
 
3262
        # anyway.
 
3263
        return 'In-Process Store, no URL'
 
3264
 
 
3265
class TransportIniFileStore(IniFileStore):
 
3266
    """IniFileStore that loads files from a transport.
 
3267
 
 
3268
    :ivar transport: The transport object where the config file is located.
 
3269
 
 
3270
    :ivar file_name: The config file basename in the transport directory.
 
3271
    """
 
3272
 
 
3273
    def __init__(self, transport, file_name):
 
3274
        """A Store using a ini file on a Transport
 
3275
 
 
3276
        :param transport: The transport object where the config file is located.
 
3277
        :param file_name: The config file basename in the transport directory.
 
3278
        """
 
3279
        super(TransportIniFileStore, self).__init__()
 
3280
        self.transport = transport
 
3281
        self.file_name = file_name
 
3282
 
 
3283
    def _load_content(self):
 
3284
        try:
 
3285
            return self.transport.get_bytes(self.file_name)
 
3286
        except errors.PermissionDenied:
 
3287
            trace.warning("Permission denied while trying to load "
 
3288
                          "configuration store %s.", self.external_url())
 
3289
            raise
 
3290
 
 
3291
    def _save_content(self, content):
 
3292
        self.transport.put_bytes(self.file_name, content)
 
3293
 
 
3294
    def external_url(self):
 
3295
        # FIXME: external_url should really accepts an optional relpath
 
3296
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
3297
        # The following will do in the interim but maybe we don't want to
 
3298
        # expose a path here but rather a config ID and its associated
 
3299
        # object </hand wawe>.
 
3300
        return urlutils.join(self.transport.external_url(), self.file_name)
2815
3301
 
2816
3302
 
2817
3303
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2820
3306
# they may face the same issue.
2821
3307
 
2822
3308
 
2823
 
class LockableIniFileStore(IniFileStore):
 
3309
class LockableIniFileStore(TransportIniFileStore):
2824
3310
    """A ConfigObjStore using locks on save to ensure store integrity."""
2825
3311
 
2826
3312
    def __init__(self, transport, file_name, lock_dir_name=None):
2876
3362
        t = transport.get_transport_from_path(
2877
3363
            config_dir(), possible_transports=possible_transports)
2878
3364
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
3365
        self.id = 'bazaar'
2879
3366
 
2880
3367
 
2881
3368
class LocationStore(LockableIniFileStore):
2884
3371
        t = transport.get_transport_from_path(
2885
3372
            config_dir(), possible_transports=possible_transports)
2886
3373
        super(LocationStore, self).__init__(t, 'locations.conf')
2887
 
 
2888
 
 
2889
 
class BranchStore(IniFileStore):
 
3374
        self.id = 'locations'
 
3375
 
 
3376
 
 
3377
class BranchStore(TransportIniFileStore):
2890
3378
 
2891
3379
    def __init__(self, branch):
2892
3380
        super(BranchStore, self).__init__(branch.control_transport,
2893
3381
                                          'branch.conf')
2894
3382
        self.branch = branch
 
3383
        self.id = 'branch'
2895
3384
 
2896
3385
    def lock_write(self, token=None):
2897
3386
        return self.branch.lock_write(token)
2914
3403
        super(ControlStore, self).__init__(bzrdir.transport,
2915
3404
                                          'control.conf',
2916
3405
                                           lock_dir_name='branch_lock')
 
3406
        self.id = 'control'
2917
3407
 
2918
3408
 
2919
3409
class SectionMatcher(object):
2931
3421
        # sections.
2932
3422
        sections = self.store.get_sections()
2933
3423
        # Walk the revisions in the order provided
2934
 
        for s in sections:
 
3424
        for store, s in sections:
2935
3425
            if self.match(s):
2936
 
                yield s
 
3426
                yield store, s
2937
3427
 
2938
3428
    def match(self, section):
2939
3429
        """Does the proposed section match.
2957
3447
 
2958
3448
class LocationSection(Section):
2959
3449
 
2960
 
    def __init__(self, section, length, extra_path):
 
3450
    def __init__(self, section, extra_path):
2961
3451
        super(LocationSection, self).__init__(section.id, section.options)
2962
 
        self.length = length
2963
3452
        self.extra_path = extra_path
 
3453
        self.locals = {'relpath': extra_path,
 
3454
                       'basename': urlutils.basename(extra_path)}
2964
3455
 
2965
 
    def get(self, name, default=None):
 
3456
    def get(self, name, default=None, expand=True):
2966
3457
        value = super(LocationSection, self).get(name, default)
2967
 
        if value is not None:
 
3458
        if value is not None and expand:
2968
3459
            policy_name = self.get(name + ':policy', None)
2969
3460
            policy = _policy_value.get(policy_name, POLICY_NONE)
2970
3461
            if policy == POLICY_APPENDPATH:
2971
3462
                value = urlutils.join(value, self.extra_path)
 
3463
            # expand section local options right now (since POLICY_APPENDPATH
 
3464
            # will never add options references, it's ok to expand after it).
 
3465
            chunks = []
 
3466
            for is_ref, chunk in iter_option_refs(value):
 
3467
                if not is_ref:
 
3468
                    chunks.append(chunk)
 
3469
                else:
 
3470
                    ref = chunk[1:-1]
 
3471
                    if ref in self.locals:
 
3472
                        chunks.append(self.locals[ref])
 
3473
                    else:
 
3474
                        chunks.append(chunk)
 
3475
            value = ''.join(chunks)
2972
3476
        return value
2973
3477
 
2974
3478
 
 
3479
class StartingPathMatcher(SectionMatcher):
 
3480
    """Select sections for a given location respecting the Store order."""
 
3481
 
 
3482
    # FIXME: Both local paths and urls can be used for section names as well as
 
3483
    # ``location`` to stay consistent with ``LocationMatcher`` which itself
 
3484
    # inherited the fuzziness from the previous ``LocationConfig``
 
3485
    # implementation. We probably need to revisit which encoding is allowed for
 
3486
    # both ``location`` and section names and how we normalize
 
3487
    # them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
 
3488
    # related too. -- vila 2012-01-04
 
3489
 
 
3490
    def __init__(self, store, location):
 
3491
        super(StartingPathMatcher, self).__init__(store)
 
3492
        if location.startswith('file://'):
 
3493
            location = urlutils.local_path_from_url(location)
 
3494
        self.location = location
 
3495
 
 
3496
    def get_sections(self):
 
3497
        """Get all sections matching ``location`` in the store.
 
3498
 
 
3499
        The most generic sections are described first in the store, then more
 
3500
        specific ones can be provided for reduced scopes.
 
3501
 
 
3502
        The returned section are therefore returned in the reversed order so
 
3503
        the most specific ones can be found first.
 
3504
        """
 
3505
        location_parts = self.location.rstrip('/').split('/')
 
3506
        store = self.store
 
3507
        sections = []
 
3508
        # Later sections are more specific, they should be returned first
 
3509
        for _, section in reversed(list(store.get_sections())):
 
3510
            if section.id is None:
 
3511
                # The no-name section is always included if present
 
3512
                yield store, LocationSection(section, self.location)
 
3513
                continue
 
3514
            section_path = section.id
 
3515
            if section_path.startswith('file://'):
 
3516
                # the location is already a local path or URL, convert the
 
3517
                # section id to the same format
 
3518
                section_path = urlutils.local_path_from_url(section_path)
 
3519
            if (self.location.startswith(section_path)
 
3520
                or fnmatch.fnmatch(self.location, section_path)):
 
3521
                section_parts = section_path.rstrip('/').split('/')
 
3522
                extra_path = '/'.join(location_parts[len(section_parts):])
 
3523
                yield store, LocationSection(section, extra_path)
 
3524
 
 
3525
 
2975
3526
class LocationMatcher(SectionMatcher):
2976
3527
 
2977
3528
    def __init__(self, store, location):
2988
3539
        all_sections = []
2989
3540
        # Filter out the no_name_section so _iter_for_location_by_parts can be
2990
3541
        # used (it assumes all sections have a name).
2991
 
        for section in self.store.get_sections():
 
3542
        for _, section in self.store.get_sections():
2992
3543
            if section.id is None:
2993
3544
                no_name_section = section
2994
3545
            else:
3001
3552
        matching_sections = []
3002
3553
        if no_name_section is not None:
3003
3554
            matching_sections.append(
3004
 
                LocationSection(no_name_section, 0, self.location))
 
3555
                (0, LocationSection(no_name_section, self.location)))
3005
3556
        for section_id, extra_path, length in filtered_sections:
3006
3557
            # a section id is unique for a given store so it's safe to take the
3007
3558
            # first matching section while iterating. Also, all filtered
3011
3562
                section = iter_all_sections.next()
3012
3563
                if section_id == section.id:
3013
3564
                    matching_sections.append(
3014
 
                        LocationSection(section, length, extra_path))
 
3565
                        (length, LocationSection(section, extra_path)))
3015
3566
                    break
3016
3567
        return matching_sections
3017
3568
 
3020
3571
        matching_sections = self._get_matching_sections()
3021
3572
        # We want the longest (aka more specific) locations first
3022
3573
        sections = sorted(matching_sections,
3023
 
                          key=lambda section: (section.length, section.id),
 
3574
                          key=lambda (length, section): (length, section.id),
3024
3575
                          reverse=True)
3025
3576
        # Sections mentioning 'ignore_parents' restrict the selection
3026
 
        for section in sections:
 
3577
        for _, section in sections:
3027
3578
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
3028
3579
            ignore = section.get('ignore_parents', None)
3029
3580
            if ignore is not None:
3031
3582
            if ignore:
3032
3583
                break
3033
3584
            # Finally, we have a valid section
3034
 
            yield section
 
3585
            yield self.store, section
 
3586
 
 
3587
 
 
3588
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
 
3589
"""Describes an expandable option reference.
 
3590
 
 
3591
We want to match the most embedded reference first.
 
3592
 
 
3593
I.e. for '{{foo}}' we will get '{foo}',
 
3594
for '{bar{baz}}' we will get '{baz}'
 
3595
"""
 
3596
 
 
3597
def iter_option_refs(string):
 
3598
    # Split isolate refs so every other chunk is a ref
 
3599
    is_ref = False
 
3600
    for chunk  in _option_ref_re.split(string):
 
3601
        yield is_ref, chunk
 
3602
        is_ref = not is_ref
3035
3603
 
3036
3604
 
3037
3605
class Stack(object):
3038
3606
    """A stack of configurations where an option can be defined"""
3039
3607
 
3040
 
    _option_ref_re = lazy_regex.lazy_compile('({[^{}]+})')
3041
 
    """Describes an exandable option reference.
3042
 
 
3043
 
    We want to match the most embedded reference first.
3044
 
 
3045
 
    I.e. for '{{foo}}' we will get '{foo}',
3046
 
    for '{bar{baz}}' we will get '{baz}'
3047
 
    """
3048
 
 
3049
 
    def __init__(self, sections_def, store=None, mutable_section_name=None):
 
3608
    def __init__(self, sections_def, store=None, mutable_section_id=None):
3050
3609
        """Creates a stack of sections with an optional store for changes.
3051
3610
 
3052
3611
        :param sections_def: A list of Section or callables that returns an
3056
3615
        :param store: The optional Store where modifications will be
3057
3616
            recorded. If none is specified, no modifications can be done.
3058
3617
 
3059
 
        :param mutable_section_name: The name of the MutableSection where
3060
 
            changes are recorded. This requires the ``store`` parameter to be
 
3618
        :param mutable_section_id: The id of the MutableSection where changes
 
3619
            are recorded. This requires the ``store`` parameter to be
3061
3620
            specified.
3062
3621
        """
3063
3622
        self.sections_def = sections_def
3064
3623
        self.store = store
3065
 
        self.mutable_section_name = mutable_section_name
 
3624
        self.mutable_section_id = mutable_section_id
3066
3625
 
3067
3626
    def get(self, name, expand=None):
3068
3627
        """Return the *first* option value found in the sections.
3083
3642
        if expand is None:
3084
3643
            expand = _get_expand_default_value()
3085
3644
        value = None
3086
 
        # Ensuring lazy loading is achieved by delaying section matching (which
3087
 
        # implies querying the persistent storage) until it can't be avoided
3088
 
        # anymore by using callables to describe (possibly empty) section
3089
 
        # lists.
3090
 
        for section_or_callable in self.sections_def:
3091
 
            # Each section can expand to multiple ones when a callable is used
3092
 
            if callable(section_or_callable):
3093
 
                sections = section_or_callable()
3094
 
            else:
3095
 
                sections = [section_or_callable]
3096
 
            for section in sections:
3097
 
                value = section.get(name)
3098
 
                if value is not None:
3099
 
                    break
3100
 
            if value is not None:
3101
 
                break
 
3645
        found_store = None # Where the option value has been found
3102
3646
        # If the option is registered, it may provide additional info about
3103
3647
        # value handling
3104
3648
        try:
3106
3650
        except KeyError:
3107
3651
            # Not registered
3108
3652
            opt = None
 
3653
 
3109
3654
        def expand_and_convert(val):
3110
 
            # This may need to be called twice if the value is None or ends up
3111
 
            # being None during expansion or conversion.
 
3655
            # This may need to be called in different contexts if the value is
 
3656
            # None or ends up being None during expansion or conversion.
3112
3657
            if val is not None:
3113
3658
                if expand:
3114
3659
                    if isinstance(val, basestring):
3117
3662
                        trace.warning('Cannot expand "%s":'
3118
3663
                                      ' %s does not support option expansion'
3119
3664
                                      % (name, type(val)))
3120
 
                if opt is not None:
3121
 
                    val = opt.convert_from_unicode(val)
 
3665
                if opt is None:
 
3666
                    val = found_store.unquote(val)
 
3667
                else:
 
3668
                    val = opt.convert_from_unicode(found_store, val)
3122
3669
            return val
3123
 
        value = expand_and_convert(value)
3124
 
        if opt is not None and value is None:
3125
 
            # If the option is registered, it may provide a default value
3126
 
            value = opt.get_default()
3127
 
            value = expand_and_convert(value)
 
3670
 
 
3671
        # First of all, check if the environment can override the configuration
 
3672
        # value
 
3673
        if opt is not None and opt.override_from_env:
 
3674
            value = opt.get_override()
 
3675
            value = expand_and_convert(value)
 
3676
        if value is None:
 
3677
            # Ensuring lazy loading is achieved by delaying section matching
 
3678
            # (which implies querying the persistent storage) until it can't be
 
3679
            # avoided anymore by using callables to describe (possibly empty)
 
3680
            # section lists.
 
3681
            for sections in self.sections_def:
 
3682
                for store, section in sections():
 
3683
                    value = section.get(name)
 
3684
                    if value is not None:
 
3685
                        found_store = store
 
3686
                        break
 
3687
                if value is not None:
 
3688
                    break
 
3689
            value = expand_and_convert(value)
 
3690
            if opt is not None and value is None:
 
3691
                # If the option is registered, it may provide a default value
 
3692
                value = opt.get_default()
 
3693
                value = expand_and_convert(value)
3128
3694
        for hook in ConfigHooks['get']:
3129
3695
            hook(self, name, value)
3130
3696
        return value
3163
3729
        result = string
3164
3730
        # We need to iterate until no more refs appear ({{foo}} will need two
3165
3731
        # iterations for example).
3166
 
        while True:
3167
 
            raw_chunks = Stack._option_ref_re.split(result)
3168
 
            if len(raw_chunks) == 1:
3169
 
                # Shorcut the trivial case: no refs
3170
 
                return result
 
3732
        expanded = True
 
3733
        while expanded:
 
3734
            expanded = False
3171
3735
            chunks = []
3172
 
            # Split will isolate refs so that every other chunk is a ref
3173
 
            chunk_is_ref = False
3174
 
            for chunk in raw_chunks:
3175
 
                if not chunk_is_ref:
 
3736
            for is_ref, chunk in iter_option_refs(result):
 
3737
                if not is_ref:
3176
3738
                    chunks.append(chunk)
3177
 
                    chunk_is_ref = True
3178
3739
                else:
 
3740
                    expanded = True
3179
3741
                    name = chunk[1:-1]
3180
3742
                    if name in _refs:
3181
3743
                        raise errors.OptionExpansionLoop(string, _refs)
3185
3747
                        raise errors.ExpandingUnknownOption(name, string)
3186
3748
                    chunks.append(value)
3187
3749
                    _refs.pop()
3188
 
                    chunk_is_ref = False
3189
3750
            result = ''.join(chunks)
3190
3751
        return result
3191
3752
 
3195
3756
            # anything else
3196
3757
            value = env[name]
3197
3758
        else:
3198
 
            # FIXME: This is a limited implementation, what we really need is a
3199
 
            # way to query the bzr config for the value of an option,
3200
 
            # respecting the scope rules (That is, once we implement fallback
3201
 
            # configs, getting the option value should restart from the top
3202
 
            # config, not the current one) -- vila 20101222
3203
3759
            value = self.get(name, expand=False)
3204
3760
            value = self._expand_options_in_string(value, env, _refs)
3205
3761
        return value
3210
3766
        This is where we guarantee that the mutable section is lazily loaded:
3211
3767
        this means we won't load the corresponding store before setting a value
3212
3768
        or deleting an option. In practice the store will often be loaded but
3213
 
        this allows helps catching some programming errors.
 
3769
        this helps catching some programming errors.
3214
3770
        """
3215
 
        section = self.store.get_mutable_section(self.mutable_section_name)
3216
 
        return section
 
3771
        store = self.store
 
3772
        section = store.get_mutable_section(self.mutable_section_id)
 
3773
        return store, section
3217
3774
 
3218
3775
    def set(self, name, value):
3219
3776
        """Set a new value for the option."""
3220
 
        section = self._get_mutable_section()
3221
 
        section.set(name, value)
 
3777
        store, section = self._get_mutable_section()
 
3778
        section.set(name, store.quote(value))
3222
3779
        for hook in ConfigHooks['set']:
3223
3780
            hook(self, name, value)
3224
3781
 
3225
3782
    def remove(self, name):
3226
3783
        """Remove an existing option."""
3227
 
        section = self._get_mutable_section()
 
3784
        _, section = self._get_mutable_section()
3228
3785
        section.remove(name)
3229
3786
        for hook in ConfigHooks['remove']:
3230
3787
            hook(self, name)
3233
3790
        # Mostly for debugging use
3234
3791
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3235
3792
 
 
3793
    def _get_overrides(self):
 
3794
        # Hack around library_state.initialize never called
 
3795
        if bzrlib.global_state is not None:
 
3796
            return bzrlib.global_state.cmdline_overrides.get_sections()
 
3797
        return []
 
3798
 
 
3799
 
 
3800
class MemoryStack(Stack):
 
3801
    """A configuration stack defined from a string.
 
3802
 
 
3803
    This is mainly intended for tests and requires no disk resources.
 
3804
    """
 
3805
 
 
3806
    def __init__(self, content=None):
 
3807
        """Create an in-memory stack from a given content.
 
3808
 
 
3809
        It uses a single store based on configobj and support reading and
 
3810
        writing options.
 
3811
 
 
3812
        :param content: The initial content of the store. If None, the store is
 
3813
            not loaded and ``_load_from_string`` can and should be used if
 
3814
            needed.
 
3815
        """
 
3816
        store = IniFileStore()
 
3817
        if content is not None:
 
3818
            store._load_from_string(content)
 
3819
        super(MemoryStack, self).__init__(
 
3820
            [store.get_sections], store)
 
3821
 
3236
3822
 
3237
3823
class _CompatibleStack(Stack):
3238
3824
    """Place holder for compatibility with previous design.
3243
3829
    One assumption made here is that the daughter classes will all use Stores
3244
3830
    derived from LockableIniFileStore).
3245
3831
 
3246
 
    It implements set() by re-loading the store before applying the
3247
 
    modification and saving it.
 
3832
    It implements set() and remove () by re-loading the store before applying
 
3833
    the modification and saving it.
3248
3834
 
3249
3835
    The long term plan being to implement a single write by store to save
3250
3836
    all modifications, this class should not be used in the interim.
3257
3843
        # Force a write to persistent storage
3258
3844
        self.store.save()
3259
3845
 
 
3846
    def remove(self, name):
 
3847
        # Force a reload
 
3848
        self.store.unload()
 
3849
        super(_CompatibleStack, self).remove(name)
 
3850
        # Force a write to persistent storage
 
3851
        self.store.save()
 
3852
 
3260
3853
 
3261
3854
class GlobalStack(_CompatibleStack):
3262
 
    """Global options only stack."""
 
3855
    """Global options only stack.
 
3856
 
 
3857
    The following sections are queried:
 
3858
 
 
3859
    * command-line overrides,
 
3860
 
 
3861
    * the 'DEFAULT' section in bazaar.conf
 
3862
 
 
3863
    This stack will use the ``DEFAULT`` section in bazaar.conf as its
 
3864
    MutableSection.
 
3865
    """
3263
3866
 
3264
3867
    def __init__(self):
3265
 
        # Get a GlobalStore
3266
3868
        gstore = GlobalStore()
3267
 
        super(GlobalStack, self).__init__([gstore.get_sections], gstore)
 
3869
        super(GlobalStack, self).__init__(
 
3870
            [self._get_overrides,
 
3871
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3872
            gstore, mutable_section_id='DEFAULT')
3268
3873
 
3269
3874
 
3270
3875
class LocationStack(_CompatibleStack):
3271
 
    """Per-location options falling back to global options stack."""
 
3876
    """Per-location options falling back to global options stack.
 
3877
 
 
3878
 
 
3879
    The following sections are queried:
 
3880
 
 
3881
    * command-line overrides,
 
3882
 
 
3883
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3884
      defined by the number of path components in the section glob, higher
 
3885
      numbers first (from most specific section to most generic).
 
3886
 
 
3887
    * the 'DEFAULT' section in bazaar.conf
 
3888
 
 
3889
    This stack will use the ``location`` section in locations.conf as its
 
3890
    MutableSection.
 
3891
    """
3272
3892
 
3273
3893
    def __init__(self, location):
3274
3894
        """Make a new stack for a location and global configuration.
3275
 
        
 
3895
 
3276
3896
        :param location: A URL prefix to """
3277
3897
        lstore = LocationStore()
3278
 
        matcher = LocationMatcher(lstore, location)
 
3898
        if location.startswith('file://'):
 
3899
            location = urlutils.local_path_from_url(location)
3279
3900
        gstore = GlobalStore()
3280
3901
        super(LocationStack, self).__init__(
3281
 
            [matcher.get_sections, gstore.get_sections], lstore)
 
3902
            [self._get_overrides,
 
3903
             LocationMatcher(lstore, location).get_sections,
 
3904
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3905
            lstore, mutable_section_id=location)
3282
3906
 
3283
3907
 
3284
3908
class BranchStack(_CompatibleStack):
3285
 
    """Per-location options falling back to branch then global options stack."""
 
3909
    """Per-location options falling back to branch then global options stack.
 
3910
 
 
3911
    The following sections are queried:
 
3912
 
 
3913
    * command-line overrides,
 
3914
 
 
3915
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3916
      defined by the number of path components in the section glob, higher
 
3917
      numbers first (from most specific section to most generic),
 
3918
 
 
3919
    * the no-name section in branch.conf,
 
3920
 
 
3921
    * the ``DEFAULT`` section in ``bazaar.conf``.
 
3922
 
 
3923
    This stack will use the no-name section in ``branch.conf`` as its
 
3924
    MutableSection.
 
3925
    """
3286
3926
 
3287
3927
    def __init__(self, branch):
3288
 
        bstore = BranchStore(branch)
3289
3928
        lstore = LocationStore()
3290
 
        matcher = LocationMatcher(lstore, branch.base)
 
3929
        bstore = branch._get_config_store()
3291
3930
        gstore = GlobalStore()
3292
3931
        super(BranchStack, self).__init__(
3293
 
            [matcher.get_sections, bstore.get_sections, gstore.get_sections],
 
3932
            [self._get_overrides,
 
3933
             LocationMatcher(lstore, branch.base).get_sections,
 
3934
             NameMatcher(bstore, None).get_sections,
 
3935
             NameMatcher(gstore, 'DEFAULT').get_sections],
3294
3936
            bstore)
3295
3937
        self.branch = branch
3296
3938
 
3298
3940
class RemoteControlStack(_CompatibleStack):
3299
3941
    """Remote control-only options stack."""
3300
3942
 
 
3943
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
3944
    # with the stack used for remote bzr dirs. RemoteControlStack only uses
 
3945
    # control.conf and is used only for stack options.
 
3946
 
3301
3947
    def __init__(self, bzrdir):
3302
 
        cstore = ControlStore(bzrdir)
 
3948
        cstore = bzrdir._get_config_store()
3303
3949
        super(RemoteControlStack, self).__init__(
3304
 
            [cstore.get_sections],
 
3950
            [NameMatcher(cstore, None).get_sections],
3305
3951
            cstore)
3306
3952
        self.bzrdir = bzrdir
3307
3953
 
3308
3954
 
3309
 
class RemoteBranchStack(_CompatibleStack):
3310
 
    """Remote branch-only options stack."""
 
3955
class BranchOnlyStack(_CompatibleStack):
 
3956
    """Branch-only options stack."""
 
3957
 
 
3958
    # FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
 
3959
    # stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
 
3960
    # -- vila 2011-12-16
3311
3961
 
3312
3962
    def __init__(self, branch):
3313
 
        bstore = BranchStore(branch)
3314
 
        super(RemoteBranchStack, self).__init__(
3315
 
            [bstore.get_sections],
 
3963
        bstore = branch._get_config_store()
 
3964
        super(BranchOnlyStack, self).__init__(
 
3965
            [NameMatcher(bstore, None).get_sections],
3316
3966
            bstore)
3317
3967
        self.branch = branch
3318
3968
 
3319
3969
 
 
3970
# Use a an empty dict to initialize an empty configobj avoiding all
 
3971
# parsing and encoding checks
 
3972
_quoting_config = configobj.ConfigObj(
 
3973
    {}, encoding='utf-8', interpolation=False, list_values=True)
 
3974
 
3320
3975
class cmd_config(commands.Command):
3321
3976
    __doc__ = """Display, set or remove a configuration option.
3322
3977
 
3338
3993
    takes_options = [
3339
3994
        'directory',
3340
3995
        # FIXME: This should be a registry option so that plugins can register
3341
 
        # their own config files (or not) -- vila 20101002
 
3996
        # their own config files (or not) and will also address
 
3997
        # http://pad.lv/788991 -- vila 20101115
3342
3998
        commands.Option('scope', help='Reduce the scope to the specified'
3343
 
                        ' configuration file',
 
3999
                        ' configuration file.',
3344
4000
                        type=unicode),
3345
4001
        commands.Option('all',
3346
4002
            help='Display all the defined values for the matching options.',
3347
4003
            ),
3348
4004
        commands.Option('remove', help='Remove the option from'
3349
 
                        ' the configuration file'),
 
4005
                        ' the configuration file.'),
3350
4006
        ]
3351
4007
 
3352
4008
    _see_also = ['configuration']
3382
4038
                # Set the option value
3383
4039
                self._set_config_option(name, value, directory, scope)
3384
4040
 
3385
 
    def _get_configs(self, directory, scope=None):
3386
 
        """Iterate the configurations specified by ``directory`` and ``scope``.
 
4041
    def _get_stack(self, directory, scope=None):
 
4042
        """Get the configuration stack specified by ``directory`` and ``scope``.
3387
4043
 
3388
4044
        :param directory: Where the configurations are derived from.
3389
4045
 
3390
4046
        :param scope: A specific config to start from.
3391
4047
        """
 
4048
        # FIXME: scope should allow access to plugin-specific stacks (even
 
4049
        # reduced to the plugin-specific store), related to
 
4050
        # http://pad.lv/788991 -- vila 2011-11-15
3392
4051
        if scope is not None:
3393
4052
            if scope == 'bazaar':
3394
 
                yield GlobalConfig()
 
4053
                return GlobalStack()
3395
4054
            elif scope == 'locations':
3396
 
                yield LocationConfig(directory)
 
4055
                return LocationStack(directory)
3397
4056
            elif scope == 'branch':
3398
 
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
3399
 
                    directory)
3400
 
                yield br.get_config()
 
4057
                (_, br, _) = (
 
4058
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4059
                        directory))
 
4060
                return br.get_config_stack()
 
4061
            raise errors.NoSuchConfig(scope)
3401
4062
        else:
3402
4063
            try:
3403
 
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
3404
 
                    directory)
3405
 
                yield br.get_config()
 
4064
                (_, br, _) = (
 
4065
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4066
                        directory))
 
4067
                return br.get_config_stack()
3406
4068
            except errors.NotBranchError:
3407
 
                yield LocationConfig(directory)
3408
 
                yield GlobalConfig()
 
4069
                return LocationStack(directory)
3409
4070
 
3410
4071
    def _show_value(self, name, directory, scope):
3411
 
        displayed = False
3412
 
        for c in self._get_configs(directory, scope):
3413
 
            if displayed:
3414
 
                break
3415
 
            for (oname, value, section, conf_id, parser) in c._get_options():
3416
 
                if name == oname:
3417
 
                    # Display only the first value and exit
3418
 
 
3419
 
                    # FIXME: We need to use get_user_option to take policies
3420
 
                    # into account and we need to make sure the option exists
3421
 
                    # too (hence the two for loops), this needs a better API
3422
 
                    # -- vila 20101117
3423
 
                    value = c.get_user_option(name)
3424
 
                    # Quote the value appropriately
3425
 
                    value = parser._quote(value)
3426
 
                    self.outf.write('%s\n' % (value,))
3427
 
                    displayed = True
3428
 
                    break
3429
 
        if not displayed:
 
4072
        conf = self._get_stack(directory, scope)
 
4073
        value = conf.get(name, expand=True)
 
4074
        if value is not None:
 
4075
            # Quote the value appropriately
 
4076
            value = _quoting_config._quote(value)
 
4077
            self.outf.write('%s\n' % (value,))
 
4078
        else:
3430
4079
            raise errors.NoSuchConfigOption(name)
3431
4080
 
3432
4081
    def _show_matching_options(self, name, directory, scope):
3435
4084
        # avoid the delay introduced by the lazy regexp.  But, we still do
3436
4085
        # want the nicer errors raised by lazy_regex.
3437
4086
        name._compile_and_collapse()
3438
 
        cur_conf_id = None
 
4087
        cur_store_id = None
3439
4088
        cur_section = None
3440
 
        for c in self._get_configs(directory, scope):
3441
 
            for (oname, value, section, conf_id, parser) in c._get_options():
3442
 
                if name.search(oname):
3443
 
                    if cur_conf_id != conf_id:
3444
 
                        # Explain where the options are defined
3445
 
                        self.outf.write('%s:\n' % (conf_id,))
3446
 
                        cur_conf_id = conf_id
3447
 
                        cur_section = None
3448
 
                    if (section not in (None, 'DEFAULT')
3449
 
                        and cur_section != section):
3450
 
                        # Display the section if it's not the default (or only)
3451
 
                        # one.
3452
 
                        self.outf.write('  [%s]\n' % (section,))
3453
 
                        cur_section = section
3454
 
                    self.outf.write('  %s = %s\n' % (oname, value))
 
4089
        conf = self._get_stack(directory, scope)
 
4090
        for sections in conf.sections_def:
 
4091
            for store, section in sections():
 
4092
                for oname in section.iter_option_names():
 
4093
                    if name.search(oname):
 
4094
                        if cur_store_id != store.id:
 
4095
                            # Explain where the options are defined
 
4096
                            self.outf.write('%s:\n' % (store.id,))
 
4097
                            cur_store_id = store.id
 
4098
                            cur_section = None
 
4099
                        if (section.id is not None
 
4100
                            and cur_section != section.id):
 
4101
                            # Display the section id as it appears in the store
 
4102
                            # (None doesn't appear by definition)
 
4103
                            self.outf.write('  [%s]\n' % (section.id,))
 
4104
                            cur_section = section.id
 
4105
                        value = section.get(oname, expand=False)
 
4106
                        # Since we don't use the stack, we need to restore a
 
4107
                        # proper quoting.
 
4108
                        try:
 
4109
                            opt = option_registry.get(oname)
 
4110
                            value = opt.convert_from_unicode(store, value)
 
4111
                        except KeyError:
 
4112
                            value = store.unquote(value)
 
4113
                        value = _quoting_config._quote(value)
 
4114
                        self.outf.write('  %s = %s\n' % (oname, value))
3455
4115
 
3456
4116
    def _set_config_option(self, name, value, directory, scope):
3457
 
        for conf in self._get_configs(directory, scope):
3458
 
            conf.set_user_option(name, value)
3459
 
            break
3460
 
        else:
3461
 
            raise errors.NoSuchConfig(scope)
 
4117
        conf = self._get_stack(directory, scope)
 
4118
        conf.set(name, value)
3462
4119
 
3463
4120
    def _remove_config_option(self, name, directory, scope):
3464
4121
        if name is None:
3465
4122
            raise errors.BzrCommandError(
3466
4123
                '--remove expects an option to remove.')
3467
 
        removed = False
3468
 
        for conf in self._get_configs(directory, scope):
3469
 
            for (section_name, section, conf_id) in conf._get_sections():
3470
 
                if scope is not None and conf_id != scope:
3471
 
                    # Not the right configuration file
3472
 
                    continue
3473
 
                if name in section:
3474
 
                    if conf_id != conf.config_id():
3475
 
                        conf = self._get_configs(directory, conf_id).next()
3476
 
                    # We use the first section in the first config where the
3477
 
                    # option is defined to remove it
3478
 
                    conf.remove_user_option(name, section_name)
3479
 
                    removed = True
3480
 
                    break
3481
 
            break
3482
 
        else:
3483
 
            raise errors.NoSuchConfig(scope)
3484
 
        if not removed:
 
4124
        conf = self._get_stack(directory, scope)
 
4125
        try:
 
4126
            conf.remove(name)
 
4127
        except KeyError:
3485
4128
            raise errors.NoSuchConfigOption(name)
3486
4129
 
 
4130
 
3487
4131
# Test registries
3488
4132
#
3489
4133
# We need adapters that can build a Store or a Stack in a test context. Test
3492
4136
# ready-to-use store or stack.  Plugins that define new store/stacks can also
3493
4137
# register themselves here to be tested against the tests defined in
3494
4138
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3495
 
# for the same tests.
 
4139
# for the same test.
3496
4140
 
3497
4141
# The registered object should be a callable receiving a test instance
3498
4142
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store