/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-02-23 18:48:26 UTC
  • mto: This revision was merged to the branch mainline in revision 6474.
  • Revision ID: jelmer@samba.org-20120223184826-9fsmk02x92ms9kmf
Fix use of file_id.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/config.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2012 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#            and others
4
4
#
29
29
create_signatures=always|never|when-required(default)
30
30
gpg_signing_command=name-of-program
31
31
log_format=name-of-format
 
32
validate_signatures_in_log=true|false(default)
 
33
acceptable_keys=pattern1,pattern2
 
34
gpg_signing_key=amy@example.com
32
35
 
33
36
in locations.conf, you specify the url of a branch and options for it.
34
37
Wildcards may be used - * and ? as normal in shell completion. Options
39
42
email= as above
40
43
check_signatures= as above
41
44
create_signatures= as above.
 
45
validate_signatures_in_log=as above
 
46
acceptable_keys=as above
42
47
 
43
48
explanation of options
44
49
----------------------
45
50
editor - this option sets the pop up editor to use during commits.
46
51
email - this option sets the user id bzr will use when committing.
47
 
check_signatures - this option controls whether bzr will require good gpg
 
52
check_signatures - this option will control whether bzr will require good gpg
48
53
                   signatures, ignore them, or check them if they are
49
 
                   present.
 
54
                   present.  Currently it is unused except that check_signatures
 
55
                   turns on create_signatures.
50
56
create_signatures - this option controls whether bzr will always create
51
 
                    gpg signatures, never create them, or create them if the
52
 
                    branch is configured to require them.
 
57
                    gpg signatures or not on commits.  There is an unused
 
58
                    option which in future is expected to work if
 
59
                    branch settings require signatures.
53
60
log_format - this option sets the default log format.  Possible values are
54
61
             long, short, line, or a plugin can register new formats.
 
62
validate_signatures_in_log - show GPG signature validity in log output
 
63
acceptable_keys - comma separated list of key patterns acceptable for
 
64
                  verify-signatures command
55
65
 
56
66
In bazaar.conf you can also define aliases in the ALIASES sections, example
57
67
 
62
72
up=pull
63
73
"""
64
74
 
 
75
from __future__ import absolute_import
 
76
from cStringIO import StringIO
65
77
import os
66
78
import sys
67
79
 
 
80
import bzrlib
 
81
from bzrlib.decorators import needs_write_lock
68
82
from bzrlib.lazy_import import lazy_import
69
83
lazy_import(globals(), """
70
 
import errno
71
 
from fnmatch import fnmatch
 
84
import fnmatch
72
85
import re
73
 
from cStringIO import StringIO
74
86
 
75
 
import bzrlib
76
87
from bzrlib import (
 
88
    atomicfile,
 
89
    controldir,
77
90
    debug,
78
91
    errors,
79
 
    mail_client,
 
92
    lazy_regex,
 
93
    library_state,
 
94
    lockdir,
 
95
    mergetools,
80
96
    osutils,
81
 
    registry,
82
97
    symbol_versioning,
83
98
    trace,
 
99
    transport,
84
100
    ui,
85
101
    urlutils,
86
102
    win32utils,
87
103
    )
 
104
from bzrlib.i18n import gettext
88
105
from bzrlib.util.configobj import configobj
89
106
""")
 
107
from bzrlib import (
 
108
    commands,
 
109
    hooks,
 
110
    lazy_regex,
 
111
    registry,
 
112
    )
 
113
from bzrlib.symbol_versioning import (
 
114
    deprecated_in,
 
115
    deprecated_method,
 
116
    )
90
117
 
91
118
 
92
119
CHECK_IF_POSSIBLE=0
122
149
STORE_BRANCH = 3
123
150
STORE_GLOBAL = 4
124
151
 
125
 
_ConfigObj = None
126
 
def ConfigObj(*args, **kwargs):
127
 
    global _ConfigObj
128
 
    if _ConfigObj is None:
129
 
        class ConfigObj(configobj.ConfigObj):
130
 
 
131
 
            def get_bool(self, section, key):
132
 
                return self[section].as_bool(key)
133
 
 
134
 
            def get_value(self, section, name):
135
 
                # Try [] for the old DEFAULT section.
136
 
                if section == "DEFAULT":
137
 
                    try:
138
 
                        return self[name]
139
 
                    except KeyError:
140
 
                        pass
141
 
                return self[section][name]
142
 
        _ConfigObj = ConfigObj
143
 
    return _ConfigObj(*args, **kwargs)
 
152
 
 
153
def signature_policy_from_unicode(signature_string):
 
154
    """Convert a string to a signing policy."""
 
155
    if signature_string.lower() == 'check-available':
 
156
        return CHECK_IF_POSSIBLE
 
157
    if signature_string.lower() == 'ignore':
 
158
        return CHECK_NEVER
 
159
    if signature_string.lower() == 'require':
 
160
        return CHECK_ALWAYS
 
161
    raise ValueError("Invalid signatures policy '%s'"
 
162
                     % signature_string)
 
163
 
 
164
 
 
165
def signing_policy_from_unicode(signature_string):
 
166
    """Convert a string to a signing policy."""
 
167
    if signature_string.lower() == 'when-required':
 
168
        return SIGN_WHEN_REQUIRED
 
169
    if signature_string.lower() == 'never':
 
170
        return SIGN_NEVER
 
171
    if signature_string.lower() == 'always':
 
172
        return SIGN_ALWAYS
 
173
    raise ValueError("Invalid signing policy '%s'"
 
174
                     % signature_string)
 
175
 
 
176
 
 
177
class ConfigObj(configobj.ConfigObj):
 
178
 
 
179
    def __init__(self, infile=None, **kwargs):
 
180
        # We define our own interpolation mechanism calling it option expansion
 
181
        super(ConfigObj, self).__init__(infile=infile,
 
182
                                        interpolation=False,
 
183
                                        **kwargs)
 
184
 
 
185
    def get_bool(self, section, key):
 
186
        return self[section].as_bool(key)
 
187
 
 
188
    def get_value(self, section, name):
 
189
        # Try [] for the old DEFAULT section.
 
190
        if section == "DEFAULT":
 
191
            try:
 
192
                return self[name]
 
193
            except KeyError:
 
194
                pass
 
195
        return self[section][name]
 
196
 
 
197
 
 
198
# FIXME: Until we can guarantee that each config file is loaded once and
 
199
# only once for a given bzrlib session, we don't want to re-read the file every
 
200
# time we query for an option so we cache the value (bad ! watch out for tests
 
201
# needing to restore the proper value). -- vila 20110219
 
202
_expand_default_value = None
 
203
def _get_expand_default_value():
 
204
    global _expand_default_value
 
205
    if _expand_default_value is not None:
 
206
        return _expand_default_value
 
207
    conf = GlobalConfig()
 
208
    # Note that we must not use None for the expand value below or we'll run
 
209
    # into infinite recursion. Using False really would be quite silly ;)
 
210
    expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
 
211
    if expand is None:
 
212
        # This is an opt-in feature, you *really* need to clearly say you want
 
213
        # to activate it !
 
214
        expand = False
 
215
    _expand_default_value = expand
 
216
    return expand
144
217
 
145
218
 
146
219
class Config(object):
149
222
    def __init__(self):
150
223
        super(Config, self).__init__()
151
224
 
 
225
    def config_id(self):
 
226
        """Returns a unique ID for the config."""
 
227
        raise NotImplementedError(self.config_id)
 
228
 
 
229
    @deprecated_method(deprecated_in((2, 4, 0)))
152
230
    def get_editor(self):
153
231
        """Get the users pop up editor."""
154
232
        raise NotImplementedError
161
239
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
162
240
                                             sys.stdout)
163
241
 
164
 
 
165
 
    def get_mail_client(self):
166
 
        """Get a mail client to use"""
167
 
        selected_client = self.get_user_option('mail_client')
168
 
        _registry = mail_client.mail_client_registry
169
 
        try:
170
 
            mail_client_class = _registry.get(selected_client)
171
 
        except KeyError:
172
 
            raise errors.UnknownMailClient(selected_client)
173
 
        return mail_client_class(self)
174
 
 
175
242
    def _get_signature_checking(self):
176
243
        """Template method to override signature checking policy."""
177
244
 
178
245
    def _get_signing_policy(self):
179
246
        """Template method to override signature creation policy."""
180
247
 
 
248
    option_ref_re = None
 
249
 
 
250
    def expand_options(self, string, env=None):
 
251
        """Expand option references in the string in the configuration context.
 
252
 
 
253
        :param string: The string containing option to expand.
 
254
 
 
255
        :param env: An option dict defining additional configuration options or
 
256
            overriding existing ones.
 
257
 
 
258
        :returns: The expanded string.
 
259
        """
 
260
        return self._expand_options_in_string(string, env)
 
261
 
 
262
    def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
 
263
        """Expand options in  a list of strings in the configuration context.
 
264
 
 
265
        :param slist: A list of strings.
 
266
 
 
267
        :param env: An option dict defining additional configuration options or
 
268
            overriding existing ones.
 
269
 
 
270
        :param _ref_stack: Private list containing the options being
 
271
            expanded to detect loops.
 
272
 
 
273
        :returns: The flatten list of expanded strings.
 
274
        """
 
275
        # expand options in each value separately flattening lists
 
276
        result = []
 
277
        for s in slist:
 
278
            value = self._expand_options_in_string(s, env, _ref_stack)
 
279
            if isinstance(value, list):
 
280
                result.extend(value)
 
281
            else:
 
282
                result.append(value)
 
283
        return result
 
284
 
 
285
    def _expand_options_in_string(self, string, env=None, _ref_stack=None):
 
286
        """Expand options in the string in the configuration context.
 
287
 
 
288
        :param string: The string to be expanded.
 
289
 
 
290
        :param env: An option dict defining additional configuration options or
 
291
            overriding existing ones.
 
292
 
 
293
        :param _ref_stack: Private list containing the options being
 
294
            expanded to detect loops.
 
295
 
 
296
        :returns: The expanded string.
 
297
        """
 
298
        if string is None:
 
299
            # Not much to expand there
 
300
            return None
 
301
        if _ref_stack is None:
 
302
            # What references are currently resolved (to detect loops)
 
303
            _ref_stack = []
 
304
        if self.option_ref_re is None:
 
305
            # We want to match the most embedded reference first (i.e. for
 
306
            # '{{foo}}' we will get '{foo}',
 
307
            # for '{bar{baz}}' we will get '{baz}'
 
308
            self.option_ref_re = re.compile('({[^{}]+})')
 
309
        result = string
 
310
        # We need to iterate until no more refs appear ({{foo}} will need two
 
311
        # iterations for example).
 
312
        while True:
 
313
            raw_chunks = self.option_ref_re.split(result)
 
314
            if len(raw_chunks) == 1:
 
315
                # Shorcut the trivial case: no refs
 
316
                return result
 
317
            chunks = []
 
318
            list_value = False
 
319
            # Split will isolate refs so that every other chunk is a ref
 
320
            chunk_is_ref = False
 
321
            for chunk in raw_chunks:
 
322
                if not chunk_is_ref:
 
323
                    if chunk:
 
324
                        # Keep only non-empty strings (or we get bogus empty
 
325
                        # slots when a list value is involved).
 
326
                        chunks.append(chunk)
 
327
                    chunk_is_ref = True
 
328
                else:
 
329
                    name = chunk[1:-1]
 
330
                    if name in _ref_stack:
 
331
                        raise errors.OptionExpansionLoop(string, _ref_stack)
 
332
                    _ref_stack.append(name)
 
333
                    value = self._expand_option(name, env, _ref_stack)
 
334
                    if value is None:
 
335
                        raise errors.ExpandingUnknownOption(name, string)
 
336
                    if isinstance(value, list):
 
337
                        list_value = True
 
338
                        chunks.extend(value)
 
339
                    else:
 
340
                        chunks.append(value)
 
341
                    _ref_stack.pop()
 
342
                    chunk_is_ref = False
 
343
            if list_value:
 
344
                # Once a list appears as the result of an expansion, all
 
345
                # callers will get a list result. This allows a consistent
 
346
                # behavior even when some options in the expansion chain
 
347
                # defined as strings (no comma in their value) but their
 
348
                # expanded value is a list.
 
349
                return self._expand_options_in_list(chunks, env, _ref_stack)
 
350
            else:
 
351
                result = ''.join(chunks)
 
352
        return result
 
353
 
 
354
    def _expand_option(self, name, env, _ref_stack):
 
355
        if env is not None and name in env:
 
356
            # Special case, values provided in env takes precedence over
 
357
            # anything else
 
358
            value = env[name]
 
359
        else:
 
360
            # FIXME: This is a limited implementation, what we really need is a
 
361
            # way to query the bzr config for the value of an option,
 
362
            # respecting the scope rules (That is, once we implement fallback
 
363
            # configs, getting the option value should restart from the top
 
364
            # config, not the current one) -- vila 20101222
 
365
            value = self.get_user_option(name, expand=False)
 
366
            if isinstance(value, list):
 
367
                value = self._expand_options_in_list(value, env, _ref_stack)
 
368
            else:
 
369
                value = self._expand_options_in_string(value, env, _ref_stack)
 
370
        return value
 
371
 
181
372
    def _get_user_option(self, option_name):
182
373
        """Template method to provide a user option."""
183
374
        return None
184
375
 
185
 
    def get_user_option(self, option_name):
186
 
        """Get a generic option - no special process, no default."""
187
 
        return self._get_user_option(option_name)
188
 
 
189
 
    def get_user_option_as_bool(self, option_name):
190
 
        """Get a generic option as a boolean - no special process, no default.
191
 
 
 
376
    def get_user_option(self, option_name, expand=None):
 
377
        """Get a generic option - no special process, no default.
 
378
 
 
379
        :param option_name: The queried option.
 
380
 
 
381
        :param expand: Whether options references should be expanded.
 
382
 
 
383
        :returns: The value of the option.
 
384
        """
 
385
        if expand is None:
 
386
            expand = _get_expand_default_value()
 
387
        value = self._get_user_option(option_name)
 
388
        if expand:
 
389
            if isinstance(value, list):
 
390
                value = self._expand_options_in_list(value)
 
391
            elif isinstance(value, dict):
 
392
                trace.warning('Cannot expand "%s":'
 
393
                              ' Dicts do not support option expansion'
 
394
                              % (option_name,))
 
395
            else:
 
396
                value = self._expand_options_in_string(value)
 
397
        for hook in OldConfigHooks['get']:
 
398
            hook(self, option_name, value)
 
399
        return value
 
400
 
 
401
    def get_user_option_as_bool(self, option_name, expand=None, default=None):
 
402
        """Get a generic option as a boolean.
 
403
 
 
404
        :param expand: Allow expanding references to other config values.
 
405
        :param default: Default value if nothing is configured
192
406
        :return None if the option doesn't exist or its value can't be
193
407
            interpreted as a boolean. Returns True or False otherwise.
194
408
        """
195
 
        s = self._get_user_option(option_name)
 
409
        s = self.get_user_option(option_name, expand=expand)
196
410
        if s is None:
197
411
            # The option doesn't exist
198
 
            return None
 
412
            return default
199
413
        val = ui.bool_from_string(s)
200
414
        if val is None:
201
415
            # The value can't be interpreted as a boolean
203
417
                          s, option_name)
204
418
        return val
205
419
 
206
 
    def get_user_option_as_list(self, option_name):
 
420
    def get_user_option_as_list(self, option_name, expand=None):
207
421
        """Get a generic option as a list - no special process, no default.
208
422
 
209
423
        :return None if the option doesn't exist. Returns the value as a list
210
424
            otherwise.
211
425
        """
212
 
        l = self._get_user_option(option_name)
 
426
        l = self.get_user_option(option_name, expand=expand)
213
427
        if isinstance(l, (str, unicode)):
214
 
            # A single value, most probably the user forgot the final ','
 
428
            # A single value, most probably the user forgot (or didn't care to
 
429
            # add) the final ','
215
430
            l = [l]
216
431
        return l
217
432
 
 
433
    @deprecated_method(deprecated_in((2, 5, 0)))
 
434
    def get_user_option_as_int_from_SI(self, option_name, default=None):
 
435
        """Get a generic option from a human readable size in SI units, e.g 10MB
 
436
 
 
437
        Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
438
        by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
439
        pedantic.
 
440
 
 
441
        :return Integer, expanded to its base-10 value if a proper SI unit is 
 
442
            found. If the option doesn't exist, or isn't a value in 
 
443
            SI units, return default (which defaults to None)
 
444
        """
 
445
        val = self.get_user_option(option_name)
 
446
        if isinstance(val, list):
 
447
            val = val[0]
 
448
        if val is None:
 
449
            val = default
 
450
        else:
 
451
            p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
 
452
            try:
 
453
                m = p.match(val)
 
454
                if m is not None:
 
455
                    val = int(m.group(1))
 
456
                    if m.group(2) is not None:
 
457
                        if m.group(2).lower() == 'k':
 
458
                            val *= 10**3
 
459
                        elif m.group(2).lower() == 'm':
 
460
                            val *= 10**6
 
461
                        elif m.group(2).lower() == 'g':
 
462
                            val *= 10**9
 
463
                else:
 
464
                    ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
 
465
                                               ' value {1!r} is not an SI unit.').format(
 
466
                                                option_name, val))
 
467
                    val = default
 
468
            except TypeError:
 
469
                val = default
 
470
        return val
 
471
 
 
472
    @deprecated_method(deprecated_in((2, 5, 0)))
218
473
    def gpg_signing_command(self):
219
474
        """What program should be used to sign signatures?"""
220
475
        result = self._gpg_signing_command()
226
481
        """See gpg_signing_command()."""
227
482
        return None
228
483
 
 
484
    @deprecated_method(deprecated_in((2, 5, 0)))
229
485
    def log_format(self):
230
486
        """What log format should be used"""
231
487
        result = self._log_format()
237
493
        """See log_format()."""
238
494
        return None
239
495
 
 
496
    def validate_signatures_in_log(self):
 
497
        """Show GPG signature validity in log"""
 
498
        result = self._validate_signatures_in_log()
 
499
        if result == "true":
 
500
            result = True
 
501
        else:
 
502
            result = False
 
503
        return result
 
504
 
 
505
    def _validate_signatures_in_log(self):
 
506
        """See validate_signatures_in_log()."""
 
507
        return None
 
508
 
 
509
    @deprecated_method(deprecated_in((2, 5, 0)))
 
510
    def acceptable_keys(self):
 
511
        """Comma separated list of key patterns acceptable to 
 
512
        verify-signatures command"""
 
513
        result = self._acceptable_keys()
 
514
        return result
 
515
 
 
516
    def _acceptable_keys(self):
 
517
        """See acceptable_keys()."""
 
518
        return None
 
519
 
 
520
    @deprecated_method(deprecated_in((2, 5, 0)))
240
521
    def post_commit(self):
241
522
        """An ordered list of python functions to call.
242
523
 
257
538
 
258
539
        Something similar to 'Martin Pool <mbp@sourcefrog.net>'
259
540
 
260
 
        $BZR_EMAIL can be set to override this (as well as the
261
 
        deprecated $BZREMAIL), then
 
541
        $BZR_EMAIL can be set to override this, then
262
542
        the concrete policy type is checked, and finally
263
543
        $EMAIL is examined.
264
 
        If none is found, a reasonable default is (hopefully)
265
 
        created.
266
 
 
267
 
        TODO: Check it's reasonably well-formed.
 
544
        If no username can be found, errors.NoWhoami exception is raised.
268
545
        """
269
546
        v = os.environ.get('BZR_EMAIL')
270
547
        if v:
271
548
            return v.decode(osutils.get_user_encoding())
272
 
 
273
549
        v = self._get_user_id()
274
550
        if v:
275
551
            return v
276
 
 
277
 
        v = os.environ.get('EMAIL')
278
 
        if v:
279
 
            return v.decode(osutils.get_user_encoding())
280
 
 
281
 
        name, email = _auto_user_id()
282
 
        if name:
283
 
            return '%s <%s>' % (name, email)
284
 
        else:
285
 
            return email
286
 
 
 
552
        return default_email()
 
553
 
 
554
    def ensure_username(self):
 
555
        """Raise errors.NoWhoami if username is not set.
 
556
 
 
557
        This method relies on the username() function raising the error.
 
558
        """
 
559
        self.username()
 
560
 
 
561
    @deprecated_method(deprecated_in((2, 5, 0)))
287
562
    def signature_checking(self):
288
563
        """What is the current policy for signature checking?."""
289
564
        policy = self._get_signature_checking()
291
566
            return policy
292
567
        return CHECK_IF_POSSIBLE
293
568
 
 
569
    @deprecated_method(deprecated_in((2, 5, 0)))
294
570
    def signing_policy(self):
295
571
        """What is the current policy for signature checking?."""
296
572
        policy = self._get_signing_policy()
298
574
            return policy
299
575
        return SIGN_WHEN_REQUIRED
300
576
 
 
577
    @deprecated_method(deprecated_in((2, 5, 0)))
301
578
    def signature_needed(self):
302
579
        """Is a signature needed when committing ?."""
303
580
        policy = self._get_signing_policy()
304
581
        if policy is None:
305
582
            policy = self._get_signature_checking()
306
583
            if policy is not None:
 
584
                #this warning should go away once check_signatures is
 
585
                #implemented (if not before)
307
586
                trace.warning("Please use create_signatures,"
308
587
                              " not check_signatures to set signing policy.")
309
 
            if policy == CHECK_ALWAYS:
310
 
                return True
311
588
        elif policy == SIGN_ALWAYS:
312
589
            return True
313
590
        return False
314
591
 
 
592
    @deprecated_method(deprecated_in((2, 5, 0)))
 
593
    def gpg_signing_key(self):
 
594
        """GPG user-id to sign commits"""
 
595
        key = self.get_user_option('gpg_signing_key')
 
596
        if key == "default" or key == None:
 
597
            return self.user_email()
 
598
        else:
 
599
            return key
 
600
 
315
601
    def get_alias(self, value):
316
602
        return self._get_alias(value)
317
603
 
346
632
        else:
347
633
            return True
348
634
 
 
635
    def get_merge_tools(self):
 
636
        tools = {}
 
637
        for (oname, value, section, conf_id, parser) in self._get_options():
 
638
            if oname.startswith('bzr.mergetool.'):
 
639
                tool_name = oname[len('bzr.mergetool.'):]
 
640
                tools[tool_name] = self.get_user_option(oname)
 
641
        trace.mutter('loaded merge tools: %r' % tools)
 
642
        return tools
 
643
 
 
644
    def find_merge_tool(self, name):
 
645
        # We fake a defaults mechanism here by checking if the given name can
 
646
        # be found in the known_merge_tools if it's not found in the config.
 
647
        # This should be done through the proposed config defaults mechanism
 
648
        # when it becomes available in the future.
 
649
        command_line = (self.get_user_option('bzr.mergetool.%s' % name,
 
650
                                             expand=False)
 
651
                        or mergetools.known_merge_tools.get(name, None))
 
652
        return command_line
 
653
 
 
654
 
 
655
class _ConfigHooks(hooks.Hooks):
 
656
    """A dict mapping hook names and a list of callables for configs.
 
657
    """
 
658
 
 
659
    def __init__(self):
 
660
        """Create the default hooks.
 
661
 
 
662
        These are all empty initially, because by default nothing should get
 
663
        notified.
 
664
        """
 
665
        super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
 
666
        self.add_hook('load',
 
667
                      'Invoked when a config store is loaded.'
 
668
                      ' The signature is (store).',
 
669
                      (2, 4))
 
670
        self.add_hook('save',
 
671
                      'Invoked when a config store is saved.'
 
672
                      ' The signature is (store).',
 
673
                      (2, 4))
 
674
        # The hooks for config options
 
675
        self.add_hook('get',
 
676
                      'Invoked when a config option is read.'
 
677
                      ' The signature is (stack, name, value).',
 
678
                      (2, 4))
 
679
        self.add_hook('set',
 
680
                      'Invoked when a config option is set.'
 
681
                      ' The signature is (stack, name, value).',
 
682
                      (2, 4))
 
683
        self.add_hook('remove',
 
684
                      'Invoked when a config option is removed.'
 
685
                      ' The signature is (stack, name).',
 
686
                      (2, 4))
 
687
ConfigHooks = _ConfigHooks()
 
688
 
 
689
 
 
690
class _OldConfigHooks(hooks.Hooks):
 
691
    """A dict mapping hook names and a list of callables for configs.
 
692
    """
 
693
 
 
694
    def __init__(self):
 
695
        """Create the default hooks.
 
696
 
 
697
        These are all empty initially, because by default nothing should get
 
698
        notified.
 
699
        """
 
700
        super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
 
701
        self.add_hook('load',
 
702
                      'Invoked when a config store is loaded.'
 
703
                      ' The signature is (config).',
 
704
                      (2, 4))
 
705
        self.add_hook('save',
 
706
                      'Invoked when a config store is saved.'
 
707
                      ' The signature is (config).',
 
708
                      (2, 4))
 
709
        # The hooks for config options
 
710
        self.add_hook('get',
 
711
                      'Invoked when a config option is read.'
 
712
                      ' The signature is (config, name, value).',
 
713
                      (2, 4))
 
714
        self.add_hook('set',
 
715
                      'Invoked when a config option is set.'
 
716
                      ' The signature is (config, name, value).',
 
717
                      (2, 4))
 
718
        self.add_hook('remove',
 
719
                      'Invoked when a config option is removed.'
 
720
                      ' The signature is (config, name).',
 
721
                      (2, 4))
 
722
OldConfigHooks = _OldConfigHooks()
 
723
 
349
724
 
350
725
class IniBasedConfig(Config):
351
726
    """A configuration policy that draws from ini files."""
352
727
 
353
 
    def __init__(self, get_filename):
 
728
    def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
 
729
                 file_name=None):
 
730
        """Base class for configuration files using an ini-like syntax.
 
731
 
 
732
        :param file_name: The configuration file path.
 
733
        """
354
734
        super(IniBasedConfig, self).__init__()
355
 
        self._get_filename = get_filename
 
735
        self.file_name = file_name
 
736
        if symbol_versioning.deprecated_passed(get_filename):
 
737
            symbol_versioning.warn(
 
738
                'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
 
739
                ' Use file_name instead.',
 
740
                DeprecationWarning,
 
741
                stacklevel=2)
 
742
            if get_filename is not None:
 
743
                self.file_name = get_filename()
 
744
        else:
 
745
            self.file_name = file_name
 
746
        self._content = None
356
747
        self._parser = None
357
748
 
358
 
    def _get_parser(self, file=None):
 
749
    @classmethod
 
750
    def from_string(cls, str_or_unicode, file_name=None, save=False):
 
751
        """Create a config object from a string.
 
752
 
 
753
        :param str_or_unicode: A string representing the file content. This will
 
754
            be utf-8 encoded.
 
755
 
 
756
        :param file_name: The configuration file path.
 
757
 
 
758
        :param _save: Whether the file should be saved upon creation.
 
759
        """
 
760
        conf = cls(file_name=file_name)
 
761
        conf._create_from_string(str_or_unicode, save)
 
762
        return conf
 
763
 
 
764
    def _create_from_string(self, str_or_unicode, save):
 
765
        self._content = StringIO(str_or_unicode.encode('utf-8'))
 
766
        # Some tests use in-memory configs, some other always need the config
 
767
        # file to exist on disk.
 
768
        if save:
 
769
            self._write_config_file()
 
770
 
 
771
    def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
359
772
        if self._parser is not None:
360
773
            return self._parser
361
 
        if file is None:
362
 
            input = self._get_filename()
 
774
        if symbol_versioning.deprecated_passed(file):
 
775
            symbol_versioning.warn(
 
776
                'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
 
777
                ' Use IniBasedConfig(_content=xxx) instead.',
 
778
                DeprecationWarning,
 
779
                stacklevel=2)
 
780
        if self._content is not None:
 
781
            co_input = self._content
 
782
        elif self.file_name is None:
 
783
            raise AssertionError('We have no content to create the config')
363
784
        else:
364
 
            input = file
 
785
            co_input = self.file_name
365
786
        try:
366
 
            self._parser = ConfigObj(input, encoding='utf-8')
 
787
            self._parser = ConfigObj(co_input, encoding='utf-8')
367
788
        except configobj.ConfigObjError, e:
368
789
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
790
        except UnicodeDecodeError:
 
791
            raise errors.ConfigContentError(self.file_name)
 
792
        # Make sure self.reload() will use the right file name
 
793
        self._parser.filename = self.file_name
 
794
        for hook in OldConfigHooks['load']:
 
795
            hook(self)
369
796
        return self._parser
370
797
 
 
798
    def reload(self):
 
799
        """Reload the config file from disk."""
 
800
        if self.file_name is None:
 
801
            raise AssertionError('We need a file name to reload the config')
 
802
        if self._parser is not None:
 
803
            self._parser.reload()
 
804
        for hook in ConfigHooks['load']:
 
805
            hook(self)
 
806
 
371
807
    def _get_matching_sections(self):
372
808
        """Return an ordered list of (section_name, extra_path) pairs.
373
809
 
384
820
        """Override this to define the section used by the config."""
385
821
        return "DEFAULT"
386
822
 
 
823
    def _get_sections(self, name=None):
 
824
        """Returns an iterator of the sections specified by ``name``.
 
825
 
 
826
        :param name: The section name. If None is supplied, the default
 
827
            configurations are yielded.
 
828
 
 
829
        :return: A tuple (name, section, config_id) for all sections that will
 
830
            be walked by user_get_option() in the 'right' order. The first one
 
831
            is where set_user_option() will update the value.
 
832
        """
 
833
        parser = self._get_parser()
 
834
        if name is not None:
 
835
            yield (name, parser[name], self.config_id())
 
836
        else:
 
837
            # No section name has been given so we fallback to the configobj
 
838
            # itself which holds the variables defined outside of any section.
 
839
            yield (None, parser, self.config_id())
 
840
 
 
841
    def _get_options(self, sections=None):
 
842
        """Return an ordered list of (name, value, section, config_id) tuples.
 
843
 
 
844
        All options are returned with their associated value and the section
 
845
        they appeared in. ``config_id`` is a unique identifier for the
 
846
        configuration file the option is defined in.
 
847
 
 
848
        :param sections: Default to ``_get_matching_sections`` if not
 
849
            specified. This gives a better control to daughter classes about
 
850
            which sections should be searched. This is a list of (name,
 
851
            configobj) tuples.
 
852
        """
 
853
        opts = []
 
854
        if sections is None:
 
855
            parser = self._get_parser()
 
856
            sections = []
 
857
            for (section_name, _) in self._get_matching_sections():
 
858
                try:
 
859
                    section = parser[section_name]
 
860
                except KeyError:
 
861
                    # This could happen for an empty file for which we define a
 
862
                    # DEFAULT section. FIXME: Force callers to provide sections
 
863
                    # instead ? -- vila 20100930
 
864
                    continue
 
865
                sections.append((section_name, section))
 
866
        config_id = self.config_id()
 
867
        for (section_name, section) in sections:
 
868
            for (name, value) in section.iteritems():
 
869
                yield (name, parser._quote(value), section_name,
 
870
                       config_id, parser)
 
871
 
387
872
    def _get_option_policy(self, section, option_name):
388
873
        """Return the policy for the given (section, option_name) pair."""
389
874
        return POLICY_NONE
395
880
        """See Config._get_signature_checking."""
396
881
        policy = self._get_user_option('check_signatures')
397
882
        if policy:
398
 
            return self._string_to_signature_policy(policy)
 
883
            return signature_policy_from_unicode(policy)
399
884
 
400
885
    def _get_signing_policy(self):
401
886
        """See Config._get_signing_policy"""
402
887
        policy = self._get_user_option('create_signatures')
403
888
        if policy:
404
 
            return self._string_to_signing_policy(policy)
 
889
            return signing_policy_from_unicode(policy)
405
890
 
406
891
    def _get_user_id(self):
407
892
        """Get the user id from the 'email' key in the current section."""
440
925
        """See Config.log_format."""
441
926
        return self._get_user_option('log_format')
442
927
 
 
928
    def _validate_signatures_in_log(self):
 
929
        """See Config.validate_signatures_in_log."""
 
930
        return self._get_user_option('validate_signatures_in_log')
 
931
 
 
932
    def _acceptable_keys(self):
 
933
        """See Config.acceptable_keys."""
 
934
        return self._get_user_option('acceptable_keys')
 
935
 
443
936
    def _post_commit(self):
444
937
        """See Config.post_commit."""
445
938
        return self._get_user_option('post_commit')
446
939
 
447
 
    def _string_to_signature_policy(self, signature_string):
448
 
        """Convert a string to a signing policy."""
449
 
        if signature_string.lower() == 'check-available':
450
 
            return CHECK_IF_POSSIBLE
451
 
        if signature_string.lower() == 'ignore':
452
 
            return CHECK_NEVER
453
 
        if signature_string.lower() == 'require':
454
 
            return CHECK_ALWAYS
455
 
        raise errors.BzrError("Invalid signatures policy '%s'"
456
 
                              % signature_string)
457
 
 
458
 
    def _string_to_signing_policy(self, signature_string):
459
 
        """Convert a string to a signing policy."""
460
 
        if signature_string.lower() == 'when-required':
461
 
            return SIGN_WHEN_REQUIRED
462
 
        if signature_string.lower() == 'never':
463
 
            return SIGN_NEVER
464
 
        if signature_string.lower() == 'always':
465
 
            return SIGN_ALWAYS
466
 
        raise errors.BzrError("Invalid signing policy '%s'"
467
 
                              % signature_string)
468
 
 
469
940
    def _get_alias(self, value):
470
941
        try:
471
942
            return self._get_parser().get_value("ALIASES",
476
947
    def _get_nickname(self):
477
948
        return self.get_user_option('nickname')
478
949
 
479
 
 
480
 
class GlobalConfig(IniBasedConfig):
 
950
    def remove_user_option(self, option_name, section_name=None):
 
951
        """Remove a user option and save the configuration file.
 
952
 
 
953
        :param option_name: The option to be removed.
 
954
 
 
955
        :param section_name: The section the option is defined in, default to
 
956
            the default section.
 
957
        """
 
958
        self.reload()
 
959
        parser = self._get_parser()
 
960
        if section_name is None:
 
961
            section = parser
 
962
        else:
 
963
            section = parser[section_name]
 
964
        try:
 
965
            del section[option_name]
 
966
        except KeyError:
 
967
            raise errors.NoSuchConfigOption(option_name)
 
968
        self._write_config_file()
 
969
        for hook in OldConfigHooks['remove']:
 
970
            hook(self, option_name)
 
971
 
 
972
    def _write_config_file(self):
 
973
        if self.file_name is None:
 
974
            raise AssertionError('We cannot save, self.file_name is None')
 
975
        conf_dir = os.path.dirname(self.file_name)
 
976
        ensure_config_dir_exists(conf_dir)
 
977
        atomic_file = atomicfile.AtomicFile(self.file_name)
 
978
        self._get_parser().write(atomic_file)
 
979
        atomic_file.commit()
 
980
        atomic_file.close()
 
981
        osutils.copy_ownership_from_path(self.file_name)
 
982
        for hook in OldConfigHooks['save']:
 
983
            hook(self)
 
984
 
 
985
 
 
986
class LockableConfig(IniBasedConfig):
 
987
    """A configuration needing explicit locking for access.
 
988
 
 
989
    If several processes try to write the config file, the accesses need to be
 
990
    serialized.
 
991
 
 
992
    Daughter classes should decorate all methods that update a config with the
 
993
    ``@needs_write_lock`` decorator (they call, directly or indirectly, the
 
994
    ``_write_config_file()`` method. These methods (typically ``set_option()``
 
995
    and variants must reload the config file from disk before calling
 
996
    ``_write_config_file()``), this can be achieved by calling the
 
997
    ``self.reload()`` method. Note that the lock scope should cover both the
 
998
    reading and the writing of the config file which is why the decorator can't
 
999
    be applied to ``_write_config_file()`` only.
 
1000
 
 
1001
    This should be enough to implement the following logic:
 
1002
    - lock for exclusive write access,
 
1003
    - reload the config file from disk,
 
1004
    - set the new value
 
1005
    - unlock
 
1006
 
 
1007
    This logic guarantees that a writer can update a value without erasing an
 
1008
    update made by another writer.
 
1009
    """
 
1010
 
 
1011
    lock_name = 'lock'
 
1012
 
 
1013
    def __init__(self, file_name):
 
1014
        super(LockableConfig, self).__init__(file_name=file_name)
 
1015
        self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
 
1016
        # FIXME: It doesn't matter that we don't provide possible_transports
 
1017
        # below since this is currently used only for local config files ;
 
1018
        # local transports are not shared. But if/when we start using
 
1019
        # LockableConfig for other kind of transports, we will need to reuse
 
1020
        # whatever connection is already established -- vila 20100929
 
1021
        self.transport = transport.get_transport_from_path(self.dir)
 
1022
        self._lock = lockdir.LockDir(self.transport, self.lock_name)
 
1023
 
 
1024
    def _create_from_string(self, unicode_bytes, save):
 
1025
        super(LockableConfig, self)._create_from_string(unicode_bytes, False)
 
1026
        if save:
 
1027
            # We need to handle the saving here (as opposed to IniBasedConfig)
 
1028
            # to be able to lock
 
1029
            self.lock_write()
 
1030
            self._write_config_file()
 
1031
            self.unlock()
 
1032
 
 
1033
    def lock_write(self, token=None):
 
1034
        """Takes a write lock in the directory containing the config file.
 
1035
 
 
1036
        If the directory doesn't exist it is created.
 
1037
        """
 
1038
        ensure_config_dir_exists(self.dir)
 
1039
        return self._lock.lock_write(token)
 
1040
 
 
1041
    def unlock(self):
 
1042
        self._lock.unlock()
 
1043
 
 
1044
    def break_lock(self):
 
1045
        self._lock.break_lock()
 
1046
 
 
1047
    @needs_write_lock
 
1048
    def remove_user_option(self, option_name, section_name=None):
 
1049
        super(LockableConfig, self).remove_user_option(option_name,
 
1050
                                                       section_name)
 
1051
 
 
1052
    def _write_config_file(self):
 
1053
        if self._lock is None or not self._lock.is_held:
 
1054
            # NB: if the following exception is raised it probably means a
 
1055
            # missing @needs_write_lock decorator on one of the callers.
 
1056
            raise errors.ObjectNotLocked(self)
 
1057
        super(LockableConfig, self)._write_config_file()
 
1058
 
 
1059
 
 
1060
class GlobalConfig(LockableConfig):
481
1061
    """The configuration that should be used for a specific location."""
482
1062
 
 
1063
    def __init__(self):
 
1064
        super(GlobalConfig, self).__init__(file_name=config_filename())
 
1065
 
 
1066
    def config_id(self):
 
1067
        return 'bazaar'
 
1068
 
 
1069
    @classmethod
 
1070
    def from_string(cls, str_or_unicode, save=False):
 
1071
        """Create a config object from a string.
 
1072
 
 
1073
        :param str_or_unicode: A string representing the file content. This
 
1074
            will be utf-8 encoded.
 
1075
 
 
1076
        :param save: Whether the file should be saved upon creation.
 
1077
        """
 
1078
        conf = cls()
 
1079
        conf._create_from_string(str_or_unicode, save)
 
1080
        return conf
 
1081
 
 
1082
    @deprecated_method(deprecated_in((2, 4, 0)))
483
1083
    def get_editor(self):
484
1084
        return self._get_user_option('editor')
485
1085
 
486
 
    def __init__(self):
487
 
        super(GlobalConfig, self).__init__(config_filename)
488
 
 
 
1086
    @needs_write_lock
489
1087
    def set_user_option(self, option, value):
490
1088
        """Save option and its value in the configuration."""
491
1089
        self._set_option(option, value, 'DEFAULT')
497
1095
        else:
498
1096
            return {}
499
1097
 
 
1098
    @needs_write_lock
500
1099
    def set_alias(self, alias_name, alias_command):
501
1100
        """Save the alias in the configuration."""
502
1101
        self._set_option(alias_name, alias_command, 'ALIASES')
503
1102
 
 
1103
    @needs_write_lock
504
1104
    def unset_alias(self, alias_name):
505
1105
        """Unset an existing alias."""
 
1106
        self.reload()
506
1107
        aliases = self._get_parser().get('ALIASES')
507
1108
        if not aliases or alias_name not in aliases:
508
1109
            raise errors.NoSuchAlias(alias_name)
510
1111
        self._write_config_file()
511
1112
 
512
1113
    def _set_option(self, option, value, section):
513
 
        # FIXME: RBC 20051029 This should refresh the parser and also take a
514
 
        # file lock on bazaar.conf.
515
 
        conf_dir = os.path.dirname(self._get_filename())
516
 
        ensure_config_dir_exists(conf_dir)
 
1114
        self.reload()
517
1115
        self._get_parser().setdefault(section, {})[option] = value
518
1116
        self._write_config_file()
519
 
 
520
 
    def _write_config_file(self):
521
 
        path = self._get_filename()
522
 
        f = open(path, 'wb')
523
 
        osutils.copy_ownership_from_path(path)
524
 
        self._get_parser().write(f)
525
 
        f.close()
526
 
 
527
 
 
528
 
class LocationConfig(IniBasedConfig):
 
1117
        for hook in OldConfigHooks['set']:
 
1118
            hook(self, option, value)
 
1119
 
 
1120
    def _get_sections(self, name=None):
 
1121
        """See IniBasedConfig._get_sections()."""
 
1122
        parser = self._get_parser()
 
1123
        # We don't give access to options defined outside of any section, we
 
1124
        # used the DEFAULT section by... default.
 
1125
        if name in (None, 'DEFAULT'):
 
1126
            # This could happen for an empty file where the DEFAULT section
 
1127
            # doesn't exist yet. So we force DEFAULT when yielding
 
1128
            name = 'DEFAULT'
 
1129
            if 'DEFAULT' not in parser:
 
1130
               parser['DEFAULT']= {}
 
1131
        yield (name, parser[name], self.config_id())
 
1132
 
 
1133
    @needs_write_lock
 
1134
    def remove_user_option(self, option_name, section_name=None):
 
1135
        if section_name is None:
 
1136
            # We need to force the default section.
 
1137
            section_name = 'DEFAULT'
 
1138
        # We need to avoid the LockableConfig implementation or we'll lock
 
1139
        # twice
 
1140
        super(LockableConfig, self).remove_user_option(option_name,
 
1141
                                                       section_name)
 
1142
 
 
1143
def _iter_for_location_by_parts(sections, location):
 
1144
    """Keep only the sessions matching the specified location.
 
1145
 
 
1146
    :param sections: An iterable of section names.
 
1147
 
 
1148
    :param location: An url or a local path to match against.
 
1149
 
 
1150
    :returns: An iterator of (section, extra_path, nb_parts) where nb is the
 
1151
        number of path components in the section name, section is the section
 
1152
        name and extra_path is the difference between location and the section
 
1153
        name.
 
1154
 
 
1155
    ``location`` will always be a local path and never a 'file://' url but the
 
1156
    section names themselves can be in either form.
 
1157
    """
 
1158
    location_parts = location.rstrip('/').split('/')
 
1159
 
 
1160
    for section in sections:
 
1161
        # location is a local path if possible, so we need to convert 'file://'
 
1162
        # urls in section names to local paths if necessary.
 
1163
 
 
1164
        # This also avoids having file:///path be a more exact
 
1165
        # match than '/path'.
 
1166
 
 
1167
        # FIXME: This still raises an issue if a user defines both file:///path
 
1168
        # *and* /path. Should we raise an error in this case -- vila 20110505
 
1169
 
 
1170
        if section.startswith('file://'):
 
1171
            section_path = urlutils.local_path_from_url(section)
 
1172
        else:
 
1173
            section_path = section
 
1174
        section_parts = section_path.rstrip('/').split('/')
 
1175
 
 
1176
        matched = True
 
1177
        if len(section_parts) > len(location_parts):
 
1178
            # More path components in the section, they can't match
 
1179
            matched = False
 
1180
        else:
 
1181
            # Rely on zip truncating in length to the length of the shortest
 
1182
            # argument sequence.
 
1183
            names = zip(location_parts, section_parts)
 
1184
            for name in names:
 
1185
                if not fnmatch.fnmatch(name[0], name[1]):
 
1186
                    matched = False
 
1187
                    break
 
1188
        if not matched:
 
1189
            continue
 
1190
        # build the path difference between the section and the location
 
1191
        extra_path = '/'.join(location_parts[len(section_parts):])
 
1192
        yield section, extra_path, len(section_parts)
 
1193
 
 
1194
 
 
1195
class LocationConfig(LockableConfig):
529
1196
    """A configuration object that gives the policy for a location."""
530
1197
 
531
1198
    def __init__(self, location):
532
 
        name_generator = locations_config_filename
533
 
        if (not os.path.exists(name_generator()) and
534
 
                os.path.exists(branches_config_filename())):
535
 
            if sys.platform == 'win32':
536
 
                trace.warning('Please rename %s to %s'
537
 
                              % (branches_config_filename(),
538
 
                                 locations_config_filename()))
539
 
            else:
540
 
                trace.warning('Please rename ~/.bazaar/branches.conf'
541
 
                              ' to ~/.bazaar/locations.conf')
542
 
            name_generator = branches_config_filename
543
 
        super(LocationConfig, self).__init__(name_generator)
 
1199
        super(LocationConfig, self).__init__(
 
1200
            file_name=locations_config_filename())
544
1201
        # local file locations are looked up by local path, rather than
545
1202
        # by file url. This is because the config file is a user
546
1203
        # file, and we would rather not expose the user to file urls.
548
1205
            location = urlutils.local_path_from_url(location)
549
1206
        self.location = location
550
1207
 
 
1208
    def config_id(self):
 
1209
        return 'locations'
 
1210
 
 
1211
    @classmethod
 
1212
    def from_string(cls, str_or_unicode, location, save=False):
 
1213
        """Create a config object from a string.
 
1214
 
 
1215
        :param str_or_unicode: A string representing the file content. This will
 
1216
            be utf-8 encoded.
 
1217
 
 
1218
        :param location: The location url to filter the configuration.
 
1219
 
 
1220
        :param save: Whether the file should be saved upon creation.
 
1221
        """
 
1222
        conf = cls(location)
 
1223
        conf._create_from_string(str_or_unicode, save)
 
1224
        return conf
 
1225
 
551
1226
    def _get_matching_sections(self):
552
1227
        """Return an ordered list of section names matching this location."""
553
 
        sections = self._get_parser()
554
 
        location_names = self.location.split('/')
555
 
        if self.location.endswith('/'):
556
 
            del location_names[-1]
557
 
        matches=[]
558
 
        for section in sections:
559
 
            # location is a local path if possible, so we need
560
 
            # to convert 'file://' urls to local paths if necessary.
561
 
            # This also avoids having file:///path be a more exact
562
 
            # match than '/path'.
563
 
            if section.startswith('file://'):
564
 
                section_path = urlutils.local_path_from_url(section)
565
 
            else:
566
 
                section_path = section
567
 
            section_names = section_path.split('/')
568
 
            if section.endswith('/'):
569
 
                del section_names[-1]
570
 
            names = zip(location_names, section_names)
571
 
            matched = True
572
 
            for name in names:
573
 
                if not fnmatch(name[0], name[1]):
574
 
                    matched = False
575
 
                    break
576
 
            if not matched:
577
 
                continue
578
 
            # so, for the common prefix they matched.
579
 
            # if section is longer, no match.
580
 
            if len(section_names) > len(location_names):
581
 
                continue
582
 
            matches.append((len(section_names), section,
583
 
                            '/'.join(location_names[len(section_names):])))
584
 
        matches.sort(reverse=True)
585
 
        sections = []
586
 
        for (length, section, extra_path) in matches:
587
 
            sections.append((section, extra_path))
 
1228
        matches = list(_iter_for_location_by_parts(self._get_parser(),
 
1229
                                                   self.location))
 
1230
        # put the longest (aka more specific) locations first
 
1231
        matches.sort(
 
1232
            key=lambda (section, extra_path, length): (length, section),
 
1233
            reverse=True)
 
1234
        for (section, extra_path, length) in matches:
 
1235
            yield section, extra_path
588
1236
            # should we stop looking for parent configs here?
589
1237
            try:
590
1238
                if self._get_parser()[section].as_bool('ignore_parents'):
591
1239
                    break
592
1240
            except KeyError:
593
1241
                pass
594
 
        return sections
 
1242
 
 
1243
    def _get_sections(self, name=None):
 
1244
        """See IniBasedConfig._get_sections()."""
 
1245
        # We ignore the name here as the only sections handled are named with
 
1246
        # the location path and we don't expose embedded sections either.
 
1247
        parser = self._get_parser()
 
1248
        for name, extra_path in self._get_matching_sections():
 
1249
            yield (name, parser[name], self.config_id())
595
1250
 
596
1251
    def _get_option_policy(self, section, option_name):
597
1252
        """Return the policy for the given (section, option_name) pair."""
641
1296
            if policy_key in self._get_parser()[section]:
642
1297
                del self._get_parser()[section][policy_key]
643
1298
 
 
1299
    @needs_write_lock
644
1300
    def set_user_option(self, option, value, store=STORE_LOCATION):
645
1301
        """Save option and its value in the configuration."""
646
1302
        if store not in [STORE_LOCATION,
648
1304
                         STORE_LOCATION_APPENDPATH]:
649
1305
            raise ValueError('bad storage policy %r for %r' %
650
1306
                (store, option))
651
 
        # FIXME: RBC 20051029 This should refresh the parser and also take a
652
 
        # file lock on locations.conf.
653
 
        conf_dir = os.path.dirname(self._get_filename())
654
 
        ensure_config_dir_exists(conf_dir)
 
1307
        self.reload()
655
1308
        location = self.location
656
1309
        if location.endswith('/'):
657
1310
            location = location[:-1]
658
 
        if (not location in self._get_parser() and
659
 
            not location + '/' in self._get_parser()):
660
 
            self._get_parser()[location]={}
661
 
        elif location + '/' in self._get_parser():
 
1311
        parser = self._get_parser()
 
1312
        if not location in parser and not location + '/' in parser:
 
1313
            parser[location] = {}
 
1314
        elif location + '/' in parser:
662
1315
            location = location + '/'
663
 
        self._get_parser()[location][option]=value
 
1316
        parser[location][option]=value
664
1317
        # the allowed values of store match the config policies
665
1318
        self._set_option_policy(location, option, store)
666
 
        self._get_parser().write(file(self._get_filename(), 'wb'))
 
1319
        self._write_config_file()
 
1320
        for hook in OldConfigHooks['set']:
 
1321
            hook(self, option, value)
667
1322
 
668
1323
 
669
1324
class BranchConfig(Config):
670
1325
    """A configuration object giving the policy for a branch."""
671
1326
 
 
1327
    def __init__(self, branch):
 
1328
        super(BranchConfig, self).__init__()
 
1329
        self._location_config = None
 
1330
        self._branch_data_config = None
 
1331
        self._global_config = None
 
1332
        self.branch = branch
 
1333
        self.option_sources = (self._get_location_config,
 
1334
                               self._get_branch_data_config,
 
1335
                               self._get_global_config)
 
1336
 
 
1337
    def config_id(self):
 
1338
        return 'branch'
 
1339
 
672
1340
    def _get_branch_data_config(self):
673
1341
        if self._branch_data_config is None:
674
1342
            self._branch_data_config = TreeConfig(self.branch)
 
1343
            self._branch_data_config.config_id = self.config_id
675
1344
        return self._branch_data_config
676
1345
 
677
1346
    def _get_location_config(self):
717
1386
        e.g. "John Hacker <jhacker@example.com>"
718
1387
        This is looked up in the email controlfile for the branch.
719
1388
        """
720
 
        try:
721
 
            return (self.branch._transport.get_bytes("email")
722
 
                    .decode(osutils.get_user_encoding())
723
 
                    .rstrip("\r\n"))
724
 
        except errors.NoSuchFile, e:
725
 
            pass
726
 
 
727
1389
        return self._get_best_value('_get_user_id')
728
1390
 
729
1391
    def _get_change_editor(self):
745
1407
                return value
746
1408
        return None
747
1409
 
 
1410
    def _get_sections(self, name=None):
 
1411
        """See IniBasedConfig.get_sections()."""
 
1412
        for source in self.option_sources:
 
1413
            for section in source()._get_sections(name):
 
1414
                yield section
 
1415
 
 
1416
    def _get_options(self, sections=None):
 
1417
        opts = []
 
1418
        # First the locations options
 
1419
        for option in self._get_location_config()._get_options():
 
1420
            yield option
 
1421
        # Then the branch options
 
1422
        branch_config = self._get_branch_data_config()
 
1423
        if sections is None:
 
1424
            sections = [('DEFAULT', branch_config._get_parser())]
 
1425
        # FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
 
1426
        # Config itself has no notion of sections :( -- vila 20101001
 
1427
        config_id = self.config_id()
 
1428
        for (section_name, section) in sections:
 
1429
            for (name, value) in section.iteritems():
 
1430
                yield (name, value, section_name,
 
1431
                       config_id, branch_config._get_parser())
 
1432
        # Then the global options
 
1433
        for option in self._get_global_config()._get_options():
 
1434
            yield option
 
1435
 
748
1436
    def set_user_option(self, name, value, store=STORE_BRANCH,
749
1437
        warn_masked=False):
750
1438
        if store == STORE_BRANCH:
768
1456
                        trace.warning('Value "%s" is masked by "%s" from'
769
1457
                                      ' branch.conf', value, mask_value)
770
1458
 
 
1459
    def remove_user_option(self, option_name, section_name=None):
 
1460
        self._get_branch_data_config().remove_option(option_name, section_name)
 
1461
 
771
1462
    def _gpg_signing_command(self):
772
1463
        """See Config.gpg_signing_command."""
773
1464
        return self._get_safe_value('_gpg_signing_command')
774
1465
 
775
 
    def __init__(self, branch):
776
 
        super(BranchConfig, self).__init__()
777
 
        self._location_config = None
778
 
        self._branch_data_config = None
779
 
        self._global_config = None
780
 
        self.branch = branch
781
 
        self.option_sources = (self._get_location_config,
782
 
                               self._get_branch_data_config,
783
 
                               self._get_global_config)
784
 
 
785
1466
    def _post_commit(self):
786
1467
        """See Config.post_commit."""
787
1468
        return self._get_safe_value('_post_commit')
803
1484
        """See Config.log_format."""
804
1485
        return self._get_best_value('_log_format')
805
1486
 
 
1487
    def _validate_signatures_in_log(self):
 
1488
        """See Config.validate_signatures_in_log."""
 
1489
        return self._get_best_value('_validate_signatures_in_log')
 
1490
 
 
1491
    def _acceptable_keys(self):
 
1492
        """See Config.acceptable_keys."""
 
1493
        return self._get_best_value('_acceptable_keys')
 
1494
 
806
1495
 
807
1496
def ensure_config_dir_exists(path=None):
808
1497
    """Make sure a configuration directory exists.
817
1506
            parent_dir = os.path.dirname(path)
818
1507
            if not os.path.isdir(parent_dir):
819
1508
                trace.mutter('creating config parent directory: %r', parent_dir)
820
 
            os.mkdir(parent_dir)
 
1509
                os.mkdir(parent_dir)
821
1510
        trace.mutter('creating config directory: %r', path)
822
1511
        os.mkdir(path)
823
1512
        osutils.copy_ownership_from_path(path)
824
1513
 
825
1514
 
826
1515
def config_dir():
827
 
    """Return per-user configuration directory.
 
1516
    """Return per-user configuration directory as unicode string
828
1517
 
829
 
    By default this is ~/.bazaar/
 
1518
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
 
1519
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
 
1520
    that will be used instead.
830
1521
 
831
1522
    TODO: Global option --config-dir to override this.
832
1523
    """
833
 
    base = os.environ.get('BZR_HOME', None)
 
1524
    base = osutils.path_from_environ('BZR_HOME')
834
1525
    if sys.platform == 'win32':
835
1526
        if base is None:
836
 
            base = win32utils.get_appdata_location_unicode()
837
 
        if base is None:
838
 
            base = os.environ.get('HOME', None)
839
 
        if base is None:
840
 
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
841
 
                                  ' or HOME set')
 
1527
            base = win32utils.get_appdata_location()
 
1528
        if base is None:
 
1529
            base = win32utils.get_home_location()
 
1530
        # GZ 2012-02-01: Really the two level subdirs only make sense inside
 
1531
        #                APPDATA, but hard to move. See bug 348640 for more.
842
1532
        return osutils.pathjoin(base, 'bazaar', '2.0')
843
 
    else:
844
 
        # cygwin, linux, and darwin all have a $HOME directory
845
 
        if base is None:
846
 
            base = os.path.expanduser("~")
847
 
        return osutils.pathjoin(base, ".bazaar")
 
1533
    if base is None:
 
1534
        # GZ 2012-02-01: What should OSX use instead of XDG if anything?
 
1535
        if sys.platform != 'darwin':
 
1536
            xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
 
1537
            if xdg_dir is None:
 
1538
                xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
 
1539
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
 
1540
            if osutils.isdir(xdg_dir):
 
1541
                trace.mutter(
 
1542
                    "Using configuration in XDG directory %s." % xdg_dir)
 
1543
                return xdg_dir
 
1544
        base = osutils._get_home_dir()
 
1545
    return osutils.pathjoin(base, ".bazaar")
848
1546
 
849
1547
 
850
1548
def config_filename():
852
1550
    return osutils.pathjoin(config_dir(), 'bazaar.conf')
853
1551
 
854
1552
 
855
 
def branches_config_filename():
856
 
    """Return per-user configuration ini file filename."""
857
 
    return osutils.pathjoin(config_dir(), 'branches.conf')
858
 
 
859
 
 
860
1553
def locations_config_filename():
861
1554
    """Return per-user configuration ini file filename."""
862
1555
    return osutils.pathjoin(config_dir(), 'locations.conf')
899
1592
        return os.path.expanduser('~/.cache')
900
1593
 
901
1594
 
 
1595
def _get_default_mail_domain():
 
1596
    """If possible, return the assumed default email domain.
 
1597
 
 
1598
    :returns: string mail domain, or None.
 
1599
    """
 
1600
    if sys.platform == 'win32':
 
1601
        # No implementation yet; patches welcome
 
1602
        return None
 
1603
    try:
 
1604
        f = open('/etc/mailname')
 
1605
    except (IOError, OSError), e:
 
1606
        return None
 
1607
    try:
 
1608
        domain = f.read().strip()
 
1609
        return domain
 
1610
    finally:
 
1611
        f.close()
 
1612
 
 
1613
 
 
1614
def default_email():
 
1615
    v = os.environ.get('BZR_EMAIL')
 
1616
    if v:
 
1617
        return v.decode(osutils.get_user_encoding())
 
1618
    v = os.environ.get('EMAIL')
 
1619
    if v:
 
1620
        return v.decode(osutils.get_user_encoding())
 
1621
    name, email = _auto_user_id()
 
1622
    if name and email:
 
1623
        return u'%s <%s>' % (name, email)
 
1624
    elif email:
 
1625
        return email
 
1626
    raise errors.NoWhoami()
 
1627
 
 
1628
 
902
1629
def _auto_user_id():
903
1630
    """Calculate automatic user identification.
904
1631
 
905
 
    Returns (realname, email).
 
1632
    :returns: (realname, email), either of which may be None if they can't be
 
1633
    determined.
906
1634
 
907
1635
    Only used when none is set in the environment or the id file.
908
1636
 
909
 
    This previously used the FQDN as the default domain, but that can
910
 
    be very slow on machines where DNS is broken.  So now we simply
911
 
    use the hostname.
 
1637
    This only returns an email address if we can be fairly sure the 
 
1638
    address is reasonable, ie if /etc/mailname is set on unix.
 
1639
 
 
1640
    This doesn't use the FQDN as the default domain because that may be 
 
1641
    slow, and it doesn't use the hostname alone because that's not normally 
 
1642
    a reasonable address.
912
1643
    """
913
 
    import socket
914
 
 
915
1644
    if sys.platform == 'win32':
916
 
        name = win32utils.get_user_name_unicode()
917
 
        if name is None:
918
 
            raise errors.BzrError("Cannot autodetect user name.\n"
919
 
                                  "Please, set your name with command like:\n"
920
 
                                  'bzr whoami "Your Name <name@domain.com>"')
921
 
        host = win32utils.get_host_name_unicode()
922
 
        if host is None:
923
 
            host = socket.gethostname()
924
 
        return name, (name + '@' + host)
925
 
 
926
 
    try:
927
 
        import pwd
928
 
        uid = os.getuid()
929
 
        try:
930
 
            w = pwd.getpwuid(uid)
931
 
        except KeyError:
932
 
            raise errors.BzrCommandError('Unable to determine your name.  '
933
 
                'Please use "bzr whoami" to set it.')
934
 
 
935
 
        # we try utf-8 first, because on many variants (like Linux),
936
 
        # /etc/passwd "should" be in utf-8, and because it's unlikely to give
937
 
        # false positives.  (many users will have their user encoding set to
938
 
        # latin-1, which cannot raise UnicodeError.)
939
 
        try:
940
 
            gecos = w.pw_gecos.decode('utf-8')
941
 
            encoding = 'utf-8'
942
 
        except UnicodeError:
943
 
            try:
944
 
                encoding = osutils.get_user_encoding()
945
 
                gecos = w.pw_gecos.decode(encoding)
946
 
            except UnicodeError:
947
 
                raise errors.BzrCommandError('Unable to determine your name.  '
948
 
                   'Use "bzr whoami" to set it.')
949
 
        try:
950
 
            username = w.pw_name.decode(encoding)
951
 
        except UnicodeError:
952
 
            raise errors.BzrCommandError('Unable to determine your name.  '
953
 
                'Use "bzr whoami" to set it.')
954
 
 
955
 
        comma = gecos.find(',')
956
 
        if comma == -1:
957
 
            realname = gecos
958
 
        else:
959
 
            realname = gecos[:comma]
960
 
        if not realname:
961
 
            realname = username
962
 
 
963
 
    except ImportError:
964
 
        import getpass
965
 
        try:
966
 
            user_encoding = osutils.get_user_encoding()
967
 
            realname = username = getpass.getuser().decode(user_encoding)
968
 
        except UnicodeDecodeError:
969
 
            raise errors.BzrError("Can't decode username as %s." % \
970
 
                    user_encoding)
971
 
 
972
 
    return realname, (username + '@' + socket.gethostname())
 
1645
        # No implementation to reliably determine Windows default mail
 
1646
        # address; please add one.
 
1647
        return None, None
 
1648
 
 
1649
    default_mail_domain = _get_default_mail_domain()
 
1650
    if not default_mail_domain:
 
1651
        return None, None
 
1652
 
 
1653
    import pwd
 
1654
    uid = os.getuid()
 
1655
    try:
 
1656
        w = pwd.getpwuid(uid)
 
1657
    except KeyError:
 
1658
        trace.mutter('no passwd entry for uid %d?' % uid)
 
1659
        return None, None
 
1660
 
 
1661
    # we try utf-8 first, because on many variants (like Linux),
 
1662
    # /etc/passwd "should" be in utf-8, and because it's unlikely to give
 
1663
    # false positives.  (many users will have their user encoding set to
 
1664
    # latin-1, which cannot raise UnicodeError.)
 
1665
    try:
 
1666
        gecos = w.pw_gecos.decode('utf-8')
 
1667
        encoding = 'utf-8'
 
1668
    except UnicodeError:
 
1669
        try:
 
1670
            encoding = osutils.get_user_encoding()
 
1671
            gecos = w.pw_gecos.decode(encoding)
 
1672
        except UnicodeError, e:
 
1673
            trace.mutter("cannot decode passwd entry %s" % w)
 
1674
            return None, None
 
1675
    try:
 
1676
        username = w.pw_name.decode(encoding)
 
1677
    except UnicodeError, e:
 
1678
        trace.mutter("cannot decode passwd entry %s" % w)
 
1679
        return None, None
 
1680
 
 
1681
    comma = gecos.find(',')
 
1682
    if comma == -1:
 
1683
        realname = gecos
 
1684
    else:
 
1685
        realname = gecos[:comma]
 
1686
 
 
1687
    return realname, (username + '@' + default_mail_domain)
973
1688
 
974
1689
 
975
1690
def parse_username(username):
1020
1735
 
1021
1736
    def set_option(self, value, name, section=None):
1022
1737
        """Set a per-branch configuration option"""
 
1738
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1739
        # higher levels providing the right lock -- vila 20101004
1023
1740
        self.branch.lock_write()
1024
1741
        try:
1025
1742
            self._config.set_option(value, name, section)
1026
1743
        finally:
1027
1744
            self.branch.unlock()
1028
1745
 
 
1746
    def remove_option(self, option_name, section_name=None):
 
1747
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1748
        # higher levels providing the right lock -- vila 20101004
 
1749
        self.branch.lock_write()
 
1750
        try:
 
1751
            self._config.remove_option(option_name, section_name)
 
1752
        finally:
 
1753
            self.branch.unlock()
 
1754
 
1029
1755
 
1030
1756
class AuthenticationConfig(object):
1031
1757
    """The authentication configuration file based on a ini file.
1057
1783
            self._config = ConfigObj(self._input, encoding='utf-8')
1058
1784
        except configobj.ConfigObjError, e:
1059
1785
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
1786
        except UnicodeError:
 
1787
            raise errors.ConfigContentError(self._filename)
1060
1788
        return self._config
1061
1789
 
1062
1790
    def _save(self):
1063
1791
        """Save the config file, only tests should use it for now."""
1064
1792
        conf_dir = os.path.dirname(self._filename)
1065
1793
        ensure_config_dir_exists(conf_dir)
1066
 
        self._get_config().write(file(self._filename, 'wb'))
 
1794
        f = file(self._filename, 'wb')
 
1795
        try:
 
1796
            self._get_config().write(f)
 
1797
        finally:
 
1798
            f.close()
1067
1799
 
1068
1800
    def _set_option(self, section_name, option_name, value):
1069
1801
        """Set an authentication configuration option"""
1075
1807
        section[option_name] = value
1076
1808
        self._save()
1077
1809
 
1078
 
    def get_credentials(self, scheme, host, port=None, user=None, path=None, 
 
1810
    def get_credentials(self, scheme, host, port=None, user=None, path=None,
1079
1811
                        realm=None):
1080
1812
        """Returns the matching credentials from authentication.conf file.
1081
1813
 
1088
1820
        :param user: login (optional)
1089
1821
 
1090
1822
        :param path: the absolute path on the server (optional)
1091
 
        
 
1823
 
1092
1824
        :param realm: the http authentication realm (optional)
1093
1825
 
1094
1826
        :return: A dict containing the matching credentials or None.
1249
1981
            if ask:
1250
1982
                if prompt is None:
1251
1983
                    # Create a default prompt suitable for most cases
1252
 
                    prompt = scheme.upper() + ' %(host)s username'
 
1984
                    prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1253
1985
                # Special handling for optional fields in the prompt
1254
1986
                if port is not None:
1255
1987
                    prompt_host = '%s:%d' % (host, port)
1293
2025
        if password is None:
1294
2026
            if prompt is None:
1295
2027
                # Create a default prompt suitable for most cases
1296
 
                prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
 
2028
                prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
1297
2029
            # Special handling for optional fields in the prompt
1298
2030
            if port is not None:
1299
2031
                prompt_host = '%s:%d' % (host, port)
1470
2202
    """A Config that reads/writes a config file on a Transport.
1471
2203
 
1472
2204
    It is a low-level object that considers config data to be name/value pairs
1473
 
    that may be associated with a section.  Assigning meaning to the these
1474
 
    values is done at higher levels like TreeConfig.
 
2205
    that may be associated with a section.  Assigning meaning to these values
 
2206
    is done at higher levels like TreeConfig.
1475
2207
    """
1476
2208
 
1477
2209
    def __init__(self, transport, filename):
1494
2226
                section_obj = configobj[section]
1495
2227
            except KeyError:
1496
2228
                return default
1497
 
        return section_obj.get(name, default)
 
2229
        value = section_obj.get(name, default)
 
2230
        for hook in OldConfigHooks['get']:
 
2231
            hook(self, name, value)
 
2232
        return value
1498
2233
 
1499
2234
    def set_option(self, value, name, section=None):
1500
2235
        """Set the value associated with a named option.
1508
2243
            configobj[name] = value
1509
2244
        else:
1510
2245
            configobj.setdefault(section, {})[name] = value
 
2246
        for hook in OldConfigHooks['set']:
 
2247
            hook(self, name, value)
 
2248
        self._set_configobj(configobj)
 
2249
 
 
2250
    def remove_option(self, option_name, section_name=None):
 
2251
        configobj = self._get_configobj()
 
2252
        if section_name is None:
 
2253
            del configobj[option_name]
 
2254
        else:
 
2255
            del configobj[section_name][option_name]
 
2256
        for hook in OldConfigHooks['remove']:
 
2257
            hook(self, option_name)
1511
2258
        self._set_configobj(configobj)
1512
2259
 
1513
2260
    def _get_config_file(self):
1514
2261
        try:
1515
 
            return StringIO(self._transport.get_bytes(self._filename))
 
2262
            f = StringIO(self._transport.get_bytes(self._filename))
 
2263
            for hook in OldConfigHooks['load']:
 
2264
                hook(self)
 
2265
            return f
1516
2266
        except errors.NoSuchFile:
1517
2267
            return StringIO()
 
2268
        except errors.PermissionDenied, e:
 
2269
            trace.warning("Permission denied while trying to open "
 
2270
                "configuration file %s.", urlutils.unescape_for_display(
 
2271
                urlutils.join(self._transport.base, self._filename), "utf-8"))
 
2272
            return StringIO()
 
2273
 
 
2274
    def _external_url(self):
 
2275
        return urlutils.join(self._transport.external_url(), self._filename)
1518
2276
 
1519
2277
    def _get_configobj(self):
1520
 
        return ConfigObj(self._get_config_file(), encoding='utf-8')
 
2278
        f = self._get_config_file()
 
2279
        try:
 
2280
            try:
 
2281
                conf = ConfigObj(f, encoding='utf-8')
 
2282
            except configobj.ConfigObjError, e:
 
2283
                raise errors.ParseConfigError(e.errors, self._external_url())
 
2284
            except UnicodeDecodeError:
 
2285
                raise errors.ConfigContentError(self._external_url())
 
2286
        finally:
 
2287
            f.close()
 
2288
        return conf
1521
2289
 
1522
2290
    def _set_configobj(self, configobj):
1523
2291
        out_file = StringIO()
1524
2292
        configobj.write(out_file)
1525
2293
        out_file.seek(0)
1526
2294
        self._transport.put_file(self._filename, out_file)
 
2295
        for hook in OldConfigHooks['save']:
 
2296
            hook(self)
 
2297
 
 
2298
 
 
2299
class Option(object):
 
2300
    """An option definition.
 
2301
 
 
2302
    The option *values* are stored in config files and found in sections.
 
2303
 
 
2304
    Here we define various properties about the option itself, its default
 
2305
    value, how to convert it from stores, what to do when invalid values are
 
2306
    encoutered, in which config files it can be stored.
 
2307
    """
 
2308
 
 
2309
    def __init__(self, name, override_from_env=None,
 
2310
                 default=None, default_from_env=None,
 
2311
                 help=None, from_unicode=None, invalid=None, unquote=True):
 
2312
        """Build an option definition.
 
2313
 
 
2314
        :param name: the name used to refer to the option.
 
2315
 
 
2316
        :param override_from_env: A list of environment variables which can
 
2317
           provide override any configuration setting.
 
2318
 
 
2319
        :param default: the default value to use when none exist in the config
 
2320
            stores. This is either a string that ``from_unicode`` will convert
 
2321
            into the proper type, a callable returning a unicode string so that
 
2322
            ``from_unicode`` can be used on the return value, or a python
 
2323
            object that can be stringified (so only the empty list is supported
 
2324
            for example).
 
2325
 
 
2326
        :param default_from_env: A list of environment variables which can
 
2327
           provide a default value. 'default' will be used only if none of the
 
2328
           variables specified here are set in the environment.
 
2329
 
 
2330
        :param help: a doc string to explain the option to the user.
 
2331
 
 
2332
        :param from_unicode: a callable to convert the unicode string
 
2333
            representing the option value in a store. This is not called for
 
2334
            the default value.
 
2335
 
 
2336
        :param invalid: the action to be taken when an invalid value is
 
2337
            encountered in a store. This is called only when from_unicode is
 
2338
            invoked to convert a string and returns None or raise ValueError or
 
2339
            TypeError. Accepted values are: None (ignore invalid values),
 
2340
            'warning' (emit a warning), 'error' (emit an error message and
 
2341
            terminates).
 
2342
 
 
2343
        :param unquote: should the unicode value be unquoted before conversion.
 
2344
           This should be used only when the store providing the values cannot
 
2345
           safely unquote them (see http://pad.lv/906897). It is provided so
 
2346
           daughter classes can handle the quoting themselves.
 
2347
        """
 
2348
        if override_from_env is None:
 
2349
            override_from_env = []
 
2350
        if default_from_env is None:
 
2351
            default_from_env = []
 
2352
        self.name = name
 
2353
        self.override_from_env = override_from_env
 
2354
        # Convert the default value to a unicode string so all values are
 
2355
        # strings internally before conversion (via from_unicode) is attempted.
 
2356
        if default is None:
 
2357
            self.default = None
 
2358
        elif isinstance(default, list):
 
2359
            # Only the empty list is supported
 
2360
            if default:
 
2361
                raise AssertionError(
 
2362
                    'Only empty lists are supported as default values')
 
2363
            self.default = u','
 
2364
        elif isinstance(default, (str, unicode, bool, int, float)):
 
2365
            # Rely on python to convert strings, booleans and integers
 
2366
            self.default = u'%s' % (default,)
 
2367
        elif callable(default):
 
2368
            self.default = default
 
2369
        else:
 
2370
            # other python objects are not expected
 
2371
            raise AssertionError('%r is not supported as a default value'
 
2372
                                 % (default,))
 
2373
        self.default_from_env = default_from_env
 
2374
        self._help = help
 
2375
        self.from_unicode = from_unicode
 
2376
        self.unquote = unquote
 
2377
        if invalid and invalid not in ('warning', 'error'):
 
2378
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
 
2379
        self.invalid = invalid
 
2380
 
 
2381
    @property
 
2382
    def help(self):
 
2383
        return self._help
 
2384
 
 
2385
    def convert_from_unicode(self, store, unicode_value):
 
2386
        if self.unquote and store is not None and unicode_value is not None:
 
2387
            unicode_value = store.unquote(unicode_value)
 
2388
        if self.from_unicode is None or unicode_value is None:
 
2389
            # Don't convert or nothing to convert
 
2390
            return unicode_value
 
2391
        try:
 
2392
            converted = self.from_unicode(unicode_value)
 
2393
        except (ValueError, TypeError):
 
2394
            # Invalid values are ignored
 
2395
            converted = None
 
2396
        if converted is None and self.invalid is not None:
 
2397
            # The conversion failed
 
2398
            if self.invalid == 'warning':
 
2399
                trace.warning('Value "%s" is not valid for "%s"',
 
2400
                              unicode_value, self.name)
 
2401
            elif self.invalid == 'error':
 
2402
                raise errors.ConfigOptionValueError(self.name, unicode_value)
 
2403
        return converted
 
2404
 
 
2405
    def get_override(self):
 
2406
        value = None
 
2407
        for var in self.override_from_env:
 
2408
            try:
 
2409
                # If the env variable is defined, its value takes precedence
 
2410
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2411
                break
 
2412
            except KeyError:
 
2413
                continue
 
2414
        return value
 
2415
 
 
2416
    def get_default(self):
 
2417
        value = None
 
2418
        for var in self.default_from_env:
 
2419
            try:
 
2420
                # If the env variable is defined, its value is the default one
 
2421
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2422
                break
 
2423
            except KeyError:
 
2424
                continue
 
2425
        if value is None:
 
2426
            # Otherwise, fallback to the value defined at registration
 
2427
            if callable(self.default):
 
2428
                value = self.default()
 
2429
                if not isinstance(value, unicode):
 
2430
                    raise AssertionError(
 
2431
                    'Callable default values should be unicode')
 
2432
            else:
 
2433
                value = self.default
 
2434
        return value
 
2435
 
 
2436
    def get_help_text(self, additional_see_also=None, plain=True):
 
2437
        result = self.help
 
2438
        from bzrlib import help_topics
 
2439
        result += help_topics._format_see_also(additional_see_also)
 
2440
        if plain:
 
2441
            result = help_topics.help_as_plain_text(result)
 
2442
        return result
 
2443
 
 
2444
 
 
2445
# Predefined converters to get proper values from store
 
2446
 
 
2447
def bool_from_store(unicode_str):
 
2448
    return ui.bool_from_string(unicode_str)
 
2449
 
 
2450
 
 
2451
def int_from_store(unicode_str):
 
2452
    return int(unicode_str)
 
2453
 
 
2454
 
 
2455
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
 
2456
 
 
2457
def int_SI_from_store(unicode_str):
 
2458
    """Convert a human readable size in SI units, e.g 10MB into an integer.
 
2459
 
 
2460
    Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
2461
    by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
2462
    pedantic.
 
2463
 
 
2464
    :return Integer, expanded to its base-10 value if a proper SI unit is 
 
2465
        found, None otherwise.
 
2466
    """
 
2467
    regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
 
2468
    p = re.compile(regexp, re.IGNORECASE)
 
2469
    m = p.match(unicode_str)
 
2470
    val = None
 
2471
    if m is not None:
 
2472
        val, _, unit = m.groups()
 
2473
        val = int(val)
 
2474
        if unit:
 
2475
            try:
 
2476
                coeff = _unit_suffixes[unit.upper()]
 
2477
            except KeyError:
 
2478
                raise ValueError(gettext('{0} is not an SI unit.').format(unit))
 
2479
            val *= coeff
 
2480
    return val
 
2481
 
 
2482
 
 
2483
def float_from_store(unicode_str):
 
2484
    return float(unicode_str)
 
2485
 
 
2486
 
 
2487
# Use a an empty dict to initialize an empty configobj avoiding all
 
2488
# parsing and encoding checks
 
2489
_list_converter_config = configobj.ConfigObj(
 
2490
    {}, encoding='utf-8', list_values=True, interpolation=False)
 
2491
 
 
2492
 
 
2493
class ListOption(Option):
 
2494
 
 
2495
    def __init__(self, name, default=None, default_from_env=None,
 
2496
                 help=None, invalid=None):
 
2497
        """A list Option definition.
 
2498
 
 
2499
        This overrides the base class so the conversion from a unicode string
 
2500
        can take quoting into account.
 
2501
        """
 
2502
        super(ListOption, self).__init__(
 
2503
            name, default=default, default_from_env=default_from_env,
 
2504
            from_unicode=self.from_unicode, help=help,
 
2505
            invalid=invalid, unquote=False)
 
2506
 
 
2507
    def from_unicode(self, unicode_str):
 
2508
        if not isinstance(unicode_str, basestring):
 
2509
            raise TypeError
 
2510
        # Now inject our string directly as unicode. All callers got their
 
2511
        # value from configobj, so values that need to be quoted are already
 
2512
        # properly quoted.
 
2513
        _list_converter_config.reset()
 
2514
        _list_converter_config._parse([u"list=%s" % (unicode_str,)])
 
2515
        maybe_list = _list_converter_config['list']
 
2516
        if isinstance(maybe_list, basestring):
 
2517
            if maybe_list:
 
2518
                # A single value, most probably the user forgot (or didn't care
 
2519
                # to add) the final ','
 
2520
                l = [maybe_list]
 
2521
            else:
 
2522
                # The empty string, convert to empty list
 
2523
                l = []
 
2524
        else:
 
2525
            # We rely on ConfigObj providing us with a list already
 
2526
            l = maybe_list
 
2527
        return l
 
2528
 
 
2529
 
 
2530
class RegistryOption(Option):
 
2531
    """Option for a choice from a registry."""
 
2532
 
 
2533
    def __init__(self, name, registry, default_from_env=None,
 
2534
                 help=None, invalid=None):
 
2535
        """A registry based Option definition.
 
2536
 
 
2537
        This overrides the base class so the conversion from a unicode string
 
2538
        can take quoting into account.
 
2539
        """
 
2540
        super(RegistryOption, self).__init__(
 
2541
            name, default=lambda: unicode(registry.default_key),
 
2542
            default_from_env=default_from_env,
 
2543
            from_unicode=self.from_unicode, help=help,
 
2544
            invalid=invalid, unquote=False)
 
2545
        self.registry = registry
 
2546
 
 
2547
    def from_unicode(self, unicode_str):
 
2548
        if not isinstance(unicode_str, basestring):
 
2549
            raise TypeError
 
2550
        try:
 
2551
            return self.registry.get(unicode_str)
 
2552
        except KeyError:
 
2553
            raise ValueError(
 
2554
                "Invalid value %s for %s."
 
2555
                "See help for a list of possible values." % (unicode_str,
 
2556
                    self.name))
 
2557
 
 
2558
    @property
 
2559
    def help(self):
 
2560
        ret = [self._help, "\n\nThe following values are supported:\n"]
 
2561
        for key in self.registry.keys():
 
2562
            ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
 
2563
        return "".join(ret)
 
2564
 
 
2565
 
 
2566
class OptionRegistry(registry.Registry):
 
2567
    """Register config options by their name.
 
2568
 
 
2569
    This overrides ``registry.Registry`` to simplify registration by acquiring
 
2570
    some information from the option object itself.
 
2571
    """
 
2572
 
 
2573
    def register(self, option):
 
2574
        """Register a new option to its name.
 
2575
 
 
2576
        :param option: The option to register. Its name is used as the key.
 
2577
        """
 
2578
        super(OptionRegistry, self).register(option.name, option,
 
2579
                                             help=option.help)
 
2580
 
 
2581
    def register_lazy(self, key, module_name, member_name):
 
2582
        """Register a new option to be loaded on request.
 
2583
 
 
2584
        :param key: the key to request the option later. Since the registration
 
2585
            is lazy, it should be provided and match the option name.
 
2586
 
 
2587
        :param module_name: the python path to the module. Such as 'os.path'.
 
2588
 
 
2589
        :param member_name: the member of the module to return.  If empty or 
 
2590
                None, get() will return the module itself.
 
2591
        """
 
2592
        super(OptionRegistry, self).register_lazy(key,
 
2593
                                                  module_name, member_name)
 
2594
 
 
2595
    def get_help(self, key=None):
 
2596
        """Get the help text associated with the given key"""
 
2597
        option = self.get(key)
 
2598
        the_help = option.help
 
2599
        if callable(the_help):
 
2600
            return the_help(self, key)
 
2601
        return the_help
 
2602
 
 
2603
 
 
2604
option_registry = OptionRegistry()
 
2605
 
 
2606
 
 
2607
# Registered options in lexicographical order
 
2608
 
 
2609
option_registry.register(
 
2610
    Option('append_revisions_only',
 
2611
           default=None, from_unicode=bool_from_store, invalid='warning',
 
2612
           help='''\
 
2613
Whether to only append revisions to the mainline.
 
2614
 
 
2615
If this is set to true, then it is not possible to change the
 
2616
existing mainline of the branch.
 
2617
'''))
 
2618
option_registry.register(
 
2619
    ListOption('acceptable_keys',
 
2620
           default=None,
 
2621
           help="""\
 
2622
List of GPG key patterns which are acceptable for verification.
 
2623
"""))
 
2624
option_registry.register(
 
2625
    Option('add.maximum_file_size',
 
2626
           default=u'20MB', from_unicode=int_SI_from_store,
 
2627
           help="""\
 
2628
Size above which files should be added manually.
 
2629
 
 
2630
Files below this size are added automatically when using ``bzr add`` without
 
2631
arguments.
 
2632
 
 
2633
A negative value means disable the size check.
 
2634
"""))
 
2635
option_registry.register(
 
2636
    Option('bound',
 
2637
           default=None, from_unicode=bool_from_store,
 
2638
           help="""\
 
2639
Is the branch bound to ``bound_location``.
 
2640
 
 
2641
If set to "True", the branch should act as a checkout, and push each commit to
 
2642
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
2643
 
 
2644
See also: bound_location.
 
2645
"""))
 
2646
option_registry.register(
 
2647
    Option('bound_location',
 
2648
           default=None,
 
2649
           help="""\
 
2650
The location that commits should go to when acting as a checkout.
 
2651
 
 
2652
This option is normally set by ``bind``.
 
2653
 
 
2654
See also: bound.
 
2655
"""))
 
2656
option_registry.register(
 
2657
    Option('branch.fetch_tags', default=False,  from_unicode=bool_from_store,
 
2658
           help="""\
 
2659
Whether revisions associated with tags should be fetched.
 
2660
"""))
 
2661
option_registry.register_lazy(
 
2662
    'bzr.transform.orphan_policy', 'bzrlib.transform', 'opt_transform_orphan')
 
2663
option_registry.register(
 
2664
    Option('bzr.workingtree.worth_saving_limit', default=10,
 
2665
           from_unicode=int_from_store,  invalid='warning',
 
2666
           help='''\
 
2667
How many changes before saving the dirstate.
 
2668
 
 
2669
-1 means that we will never rewrite the dirstate file for only
 
2670
stat-cache changes. Regardless of this setting, we will always rewrite
 
2671
the dirstate file if a file is added/removed/renamed/etc. This flag only
 
2672
affects the behavior of updating the dirstate file after we notice that
 
2673
a file has been touched.
 
2674
'''))
 
2675
option_registry.register(
 
2676
    Option('bugtracker', default=None,
 
2677
           help='''\
 
2678
Default bug tracker to use.
 
2679
 
 
2680
This bug tracker will be used for example when marking bugs
 
2681
as fixed using ``bzr commit --fixes``, if no explicit
 
2682
bug tracker was specified.
 
2683
'''))
 
2684
option_registry.register(
 
2685
    Option('check_signatures', default=CHECK_IF_POSSIBLE,
 
2686
           from_unicode=signature_policy_from_unicode,
 
2687
           help='''\
 
2688
GPG checking policy.
 
2689
 
 
2690
Possible values: require, ignore, check-available (default)
 
2691
 
 
2692
this option will control whether bzr will require good gpg
 
2693
signatures, ignore them, or check them if they are
 
2694
present.
 
2695
'''))
 
2696
option_registry.register(
 
2697
    Option('child_submit_format',
 
2698
           help='''The preferred format of submissions to this branch.'''))
 
2699
option_registry.register(
 
2700
    Option('child_submit_to',
 
2701
           help='''Where submissions to this branch are mailed to.'''))
 
2702
option_registry.register(
 
2703
    Option('create_signatures', default=SIGN_WHEN_REQUIRED,
 
2704
           from_unicode=signing_policy_from_unicode,
 
2705
           help='''\
 
2706
GPG Signing policy.
 
2707
 
 
2708
Possible values: always, never, when-required (default)
 
2709
 
 
2710
This option controls whether bzr will always create
 
2711
gpg signatures or not on commits.
 
2712
'''))
 
2713
option_registry.register(
 
2714
    Option('dirstate.fdatasync', default=True,
 
2715
           from_unicode=bool_from_store,
 
2716
           help='''\
 
2717
Flush dirstate changes onto physical disk?
 
2718
 
 
2719
If true (default), working tree metadata changes are flushed through the
 
2720
OS buffers to physical disk.  This is somewhat slower, but means data
 
2721
should not be lost if the machine crashes.  See also repository.fdatasync.
 
2722
'''))
 
2723
option_registry.register(
 
2724
    ListOption('debug_flags', default=[],
 
2725
           help='Debug flags to activate.'))
 
2726
option_registry.register(
 
2727
    Option('default_format', default='2a',
 
2728
           help='Format used when creating branches.'))
 
2729
option_registry.register(
 
2730
    Option('dpush_strict', default=None,
 
2731
           from_unicode=bool_from_store,
 
2732
           help='''\
 
2733
The default value for ``dpush --strict``.
 
2734
 
 
2735
If present, defines the ``--strict`` option default value for checking
 
2736
uncommitted changes before pushing into a different VCS without any
 
2737
custom bzr metadata.
 
2738
'''))
 
2739
option_registry.register(
 
2740
    Option('editor',
 
2741
           help='The command called to launch an editor to enter a message.'))
 
2742
option_registry.register(
 
2743
    Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
 
2744
           help='The users identity'))
 
2745
option_registry.register(
 
2746
    Option('gpg_signing_command',
 
2747
           default='gpg',
 
2748
           help="""\
 
2749
Program to use use for creating signatures.
 
2750
 
 
2751
This should support at least the -u and --clearsign options.
 
2752
"""))
 
2753
option_registry.register(
 
2754
    Option('gpg_signing_key',
 
2755
           default=None,
 
2756
           help="""\
 
2757
GPG key to use for signing.
 
2758
 
 
2759
This defaults to the first key associated with the users email.
 
2760
"""))
 
2761
option_registry.register(
 
2762
    Option('ignore_missing_extensions', default=False,
 
2763
           from_unicode=bool_from_store,
 
2764
           help='''\
 
2765
Control the missing extensions warning display.
 
2766
 
 
2767
The warning will not be emitted if set to True.
 
2768
'''))
 
2769
option_registry.register(
 
2770
    Option('language',
 
2771
           help='Language to translate messages into.'))
 
2772
option_registry.register(
 
2773
    Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
 
2774
           help='''\
 
2775
Steal locks that appears to be dead.
 
2776
 
 
2777
If set to True, bzr will check if a lock is supposed to be held by an
 
2778
active process from the same user on the same machine. If the user and
 
2779
machine match, but no process with the given PID is active, then bzr
 
2780
will automatically break the stale lock, and create a new lock for
 
2781
this process.
 
2782
Otherwise, bzr will prompt as normal to break the lock.
 
2783
'''))
 
2784
option_registry.register(
 
2785
    Option('log_format', default='long',
 
2786
           help= '''\
 
2787
Log format to use when displaying revisions.
 
2788
 
 
2789
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
 
2790
may be provided by plugins.
 
2791
'''))
 
2792
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
 
2793
    'opt_mail_client')
 
2794
option_registry.register(
 
2795
    Option('output_encoding',
 
2796
           help= 'Unicode encoding for output'
 
2797
           ' (terminal encoding if not specified).'))
 
2798
option_registry.register(
 
2799
    Option('parent_location',
 
2800
           default=None,
 
2801
           help="""\
 
2802
The location of the default branch for pull or merge.
 
2803
 
 
2804
This option is normally set when creating a branch, the first ``pull`` or by
 
2805
``pull --remember``.
 
2806
"""))
 
2807
option_registry.register(
 
2808
    Option('post_commit', default=None,
 
2809
           help='''\
 
2810
Post commit functions.
 
2811
 
 
2812
An ordered list of python functions to call, separated by spaces.
 
2813
 
 
2814
Each function takes branch, rev_id as parameters.
 
2815
'''))
 
2816
option_registry.register(
 
2817
    Option('public_branch',
 
2818
           default=None,
 
2819
           help="""\
 
2820
A publically-accessible version of this branch.
 
2821
 
 
2822
This implies that the branch setting this option is not publically-accessible.
 
2823
Used and set by ``bzr send``.
 
2824
"""))
 
2825
option_registry.register(
 
2826
    Option('push_location',
 
2827
           default=None,
 
2828
           help="""\
 
2829
The location of the default branch for push.
 
2830
 
 
2831
This option is normally set by the first ``push`` or ``push --remember``.
 
2832
"""))
 
2833
option_registry.register(
 
2834
    Option('push_strict', default=None,
 
2835
           from_unicode=bool_from_store,
 
2836
           help='''\
 
2837
The default value for ``push --strict``.
 
2838
 
 
2839
If present, defines the ``--strict`` option default value for checking
 
2840
uncommitted changes before sending a merge directive.
 
2841
'''))
 
2842
option_registry.register(
 
2843
    Option('repository.fdatasync', default=True,
 
2844
           from_unicode=bool_from_store,
 
2845
           help='''\
 
2846
Flush repository changes onto physical disk?
 
2847
 
 
2848
If true (default), repository changes are flushed through the OS buffers
 
2849
to physical disk.  This is somewhat slower, but means data should not be
 
2850
lost if the machine crashes.  See also dirstate.fdatasync.
 
2851
'''))
 
2852
option_registry.register_lazy('smtp_server',
 
2853
    'bzrlib.smtp_connection', 'smtp_server')
 
2854
option_registry.register_lazy('smtp_password',
 
2855
    'bzrlib.smtp_connection', 'smtp_password')
 
2856
option_registry.register_lazy('smtp_username',
 
2857
    'bzrlib.smtp_connection', 'smtp_username')
 
2858
option_registry.register(
 
2859
    Option('selftest.timeout',
 
2860
        default='600',
 
2861
        from_unicode=int_from_store,
 
2862
        help='Abort selftest if one test takes longer than this many seconds',
 
2863
        ))
 
2864
 
 
2865
option_registry.register(
 
2866
    Option('send_strict', default=None,
 
2867
           from_unicode=bool_from_store,
 
2868
           help='''\
 
2869
The default value for ``send --strict``.
 
2870
 
 
2871
If present, defines the ``--strict`` option default value for checking
 
2872
uncommitted changes before sending a bundle.
 
2873
'''))
 
2874
 
 
2875
option_registry.register(
 
2876
    Option('serve.client_timeout',
 
2877
           default=300.0, from_unicode=float_from_store,
 
2878
           help="If we wait for a new request from a client for more than"
 
2879
                " X seconds, consider the client idle, and hangup."))
 
2880
option_registry.register(
 
2881
    Option('stacked_on_location',
 
2882
           default=None,
 
2883
           help="""The location where this branch is stacked on."""))
 
2884
option_registry.register(
 
2885
    Option('submit_branch',
 
2886
           default=None,
 
2887
           help="""\
 
2888
The branch you intend to submit your current work to.
 
2889
 
 
2890
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
 
2891
by the ``submit:`` revision spec.
 
2892
"""))
 
2893
option_registry.register(
 
2894
    Option('submit_to',
 
2895
           help='''Where submissions from this branch are mailed to.'''))
 
2896
option_registry.register(
 
2897
    ListOption('suppress_warnings',
 
2898
           default=[],
 
2899
           help="List of warning classes to suppress."))
 
2900
option_registry.register(
 
2901
    Option('validate_signatures_in_log', default=False,
 
2902
           from_unicode=bool_from_store, invalid='warning',
 
2903
           help='''Whether to validate signatures in bzr log.'''))
 
2904
option_registry.register_lazy('ssl.ca_certs',
 
2905
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
 
2906
 
 
2907
option_registry.register_lazy('ssl.cert_reqs',
 
2908
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
 
2909
 
 
2910
 
 
2911
class Section(object):
 
2912
    """A section defines a dict of option name => value.
 
2913
 
 
2914
    This is merely a read-only dict which can add some knowledge about the
 
2915
    options. It is *not* a python dict object though and doesn't try to mimic
 
2916
    its API.
 
2917
    """
 
2918
 
 
2919
    def __init__(self, section_id, options):
 
2920
        self.id = section_id
 
2921
        # We re-use the dict-like object received
 
2922
        self.options = options
 
2923
 
 
2924
    def get(self, name, default=None, expand=True):
 
2925
        return self.options.get(name, default)
 
2926
 
 
2927
    def iter_option_names(self):
 
2928
        for k in self.options.iterkeys():
 
2929
            yield k
 
2930
 
 
2931
    def __repr__(self):
 
2932
        # Mostly for debugging use
 
2933
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
 
2934
 
 
2935
 
 
2936
_NewlyCreatedOption = object()
 
2937
"""Was the option created during the MutableSection lifetime"""
 
2938
_DeletedOption = object()
 
2939
"""Was the option deleted during the MutableSection lifetime"""
 
2940
 
 
2941
 
 
2942
class MutableSection(Section):
 
2943
    """A section allowing changes and keeping track of the original values."""
 
2944
 
 
2945
    def __init__(self, section_id, options):
 
2946
        super(MutableSection, self).__init__(section_id, options)
 
2947
        self.reset_changes()
 
2948
 
 
2949
    def set(self, name, value):
 
2950
        if name not in self.options:
 
2951
            # This is a new option
 
2952
            self.orig[name] = _NewlyCreatedOption
 
2953
        elif name not in self.orig:
 
2954
            self.orig[name] = self.get(name, None)
 
2955
        self.options[name] = value
 
2956
 
 
2957
    def remove(self, name):
 
2958
        if name not in self.orig:
 
2959
            self.orig[name] = self.get(name, None)
 
2960
        del self.options[name]
 
2961
 
 
2962
    def reset_changes(self):
 
2963
        self.orig = {}
 
2964
 
 
2965
    def apply_changes(self, dirty, store):
 
2966
        """Apply option value changes.
 
2967
 
 
2968
        ``self`` has been reloaded from the persistent storage. ``dirty``
 
2969
        contains the changes made since the previous loading.
 
2970
 
 
2971
        :param dirty: the mutable section containing the changes.
 
2972
 
 
2973
        :param store: the store containing the section
 
2974
        """
 
2975
        for k, expected in dirty.orig.iteritems():
 
2976
            actual = dirty.get(k, _DeletedOption)
 
2977
            reloaded = self.get(k, _NewlyCreatedOption)
 
2978
            if actual is _DeletedOption:
 
2979
                if k in self.options:
 
2980
                    self.remove(k)
 
2981
            else:
 
2982
                self.set(k, actual)
 
2983
            # Report concurrent updates in an ad-hoc way. This should only
 
2984
            # occurs when different processes try to update the same option
 
2985
            # which is not supported (as in: the config framework is not meant
 
2986
            # to be used a sharing mechanism).
 
2987
            if expected != reloaded:
 
2988
                if actual is _DeletedOption:
 
2989
                    actual = '<DELETED>'
 
2990
                if reloaded is _NewlyCreatedOption:
 
2991
                    reloaded = '<CREATED>'
 
2992
                if expected is _NewlyCreatedOption:
 
2993
                    expected = '<CREATED>'
 
2994
                # Someone changed the value since we get it from the persistent
 
2995
                # storage.
 
2996
                trace.warning(gettext(
 
2997
                        "Option {0} in section {1} of {2} was changed"
 
2998
                        " from {3} to {4}. The {5} value will be saved.".format(
 
2999
                            k, self.id, store.external_url(), expected,
 
3000
                            reloaded, actual)))
 
3001
        # No need to keep track of these changes
 
3002
        self.reset_changes()
 
3003
 
 
3004
 
 
3005
class Store(object):
 
3006
    """Abstract interface to persistent storage for configuration options."""
 
3007
 
 
3008
    readonly_section_class = Section
 
3009
    mutable_section_class = MutableSection
 
3010
 
 
3011
    def __init__(self):
 
3012
        # Which sections need to be saved
 
3013
        self.dirty_sections = []
 
3014
 
 
3015
    def is_loaded(self):
 
3016
        """Returns True if the Store has been loaded.
 
3017
 
 
3018
        This is used to implement lazy loading and ensure the persistent
 
3019
        storage is queried only when needed.
 
3020
        """
 
3021
        raise NotImplementedError(self.is_loaded)
 
3022
 
 
3023
    def load(self):
 
3024
        """Loads the Store from persistent storage."""
 
3025
        raise NotImplementedError(self.load)
 
3026
 
 
3027
    def _load_from_string(self, bytes):
 
3028
        """Create a store from a string in configobj syntax.
 
3029
 
 
3030
        :param bytes: A string representing the file content.
 
3031
        """
 
3032
        raise NotImplementedError(self._load_from_string)
 
3033
 
 
3034
    def unload(self):
 
3035
        """Unloads the Store.
 
3036
 
 
3037
        This should make is_loaded() return False. This is used when the caller
 
3038
        knows that the persistent storage has changed or may have change since
 
3039
        the last load.
 
3040
        """
 
3041
        raise NotImplementedError(self.unload)
 
3042
 
 
3043
    def quote(self, value):
 
3044
        """Quote a configuration option value for storing purposes.
 
3045
 
 
3046
        This allows Stacks to present values as they will be stored.
 
3047
        """
 
3048
        return value
 
3049
 
 
3050
    def unquote(self, value):
 
3051
        """Unquote a configuration option value into unicode.
 
3052
 
 
3053
        The received value is quoted as stored.
 
3054
        """
 
3055
        return value
 
3056
 
 
3057
    def save(self):
 
3058
        """Saves the Store to persistent storage."""
 
3059
        raise NotImplementedError(self.save)
 
3060
 
 
3061
    def _need_saving(self):
 
3062
        for s in self.dirty_sections:
 
3063
            if s.orig:
 
3064
                # At least one dirty section contains a modification
 
3065
                return True
 
3066
        return False
 
3067
 
 
3068
    def apply_changes(self, dirty_sections):
 
3069
        """Apply changes from dirty sections while checking for coherency.
 
3070
 
 
3071
        The Store content is discarded and reloaded from persistent storage to
 
3072
        acquire up-to-date values.
 
3073
 
 
3074
        Dirty sections are MutableSection which kept track of the value they
 
3075
        are expected to update.
 
3076
        """
 
3077
        # We need an up-to-date version from the persistent storage, unload the
 
3078
        # store. The reload will occur when needed (triggered by the first
 
3079
        # get_mutable_section() call below.
 
3080
        self.unload()
 
3081
        # Apply the changes from the preserved dirty sections
 
3082
        for dirty in dirty_sections:
 
3083
            clean = self.get_mutable_section(dirty.id)
 
3084
            clean.apply_changes(dirty, self)
 
3085
        # Everything is clean now
 
3086
        self.dirty_sections = []
 
3087
 
 
3088
    def save_changes(self):
 
3089
        """Saves the Store to persistent storage if changes occurred.
 
3090
 
 
3091
        Apply the changes recorded in the mutable sections to a store content
 
3092
        refreshed from persistent storage.
 
3093
        """
 
3094
        raise NotImplementedError(self.save_changes)
 
3095
 
 
3096
    def external_url(self):
 
3097
        raise NotImplementedError(self.external_url)
 
3098
 
 
3099
    def get_sections(self):
 
3100
        """Returns an ordered iterable of existing sections.
 
3101
 
 
3102
        :returns: An iterable of (store, section).
 
3103
        """
 
3104
        raise NotImplementedError(self.get_sections)
 
3105
 
 
3106
    def get_mutable_section(self, section_id=None):
 
3107
        """Returns the specified mutable section.
 
3108
 
 
3109
        :param section_id: The section identifier
 
3110
        """
 
3111
        raise NotImplementedError(self.get_mutable_section)
 
3112
 
 
3113
    def __repr__(self):
 
3114
        # Mostly for debugging use
 
3115
        return "<config.%s(%s)>" % (self.__class__.__name__,
 
3116
                                    self.external_url())
 
3117
 
 
3118
 
 
3119
class CommandLineStore(Store):
 
3120
    "A store to carry command line overrides for the config options."""
 
3121
 
 
3122
    def __init__(self, opts=None):
 
3123
        super(CommandLineStore, self).__init__()
 
3124
        if opts is None:
 
3125
            opts = {}
 
3126
        self.options = {}
 
3127
        self.id = 'cmdline'
 
3128
 
 
3129
    def _reset(self):
 
3130
        # The dict should be cleared but not replaced so it can be shared.
 
3131
        self.options.clear()
 
3132
 
 
3133
    def _from_cmdline(self, overrides):
 
3134
        # Reset before accepting new definitions
 
3135
        self._reset()
 
3136
        for over in overrides:
 
3137
            try:
 
3138
                name, value = over.split('=', 1)
 
3139
            except ValueError:
 
3140
                raise errors.BzrCommandError(
 
3141
                    gettext("Invalid '%s', should be of the form 'name=value'")
 
3142
                    % (over,))
 
3143
            self.options[name] = value
 
3144
 
 
3145
    def external_url(self):
 
3146
        # Not an url but it makes debugging easier and is never needed
 
3147
        # otherwise
 
3148
        return 'cmdline'
 
3149
 
 
3150
    def get_sections(self):
 
3151
        yield self,  self.readonly_section_class(None, self.options)
 
3152
 
 
3153
 
 
3154
class IniFileStore(Store):
 
3155
    """A config Store using ConfigObj for storage.
 
3156
 
 
3157
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
 
3158
        serialize/deserialize the config file.
 
3159
    """
 
3160
 
 
3161
    def __init__(self):
 
3162
        """A config Store using ConfigObj for storage.
 
3163
        """
 
3164
        super(IniFileStore, self).__init__()
 
3165
        self._config_obj = None
 
3166
 
 
3167
    def is_loaded(self):
 
3168
        return self._config_obj != None
 
3169
 
 
3170
    def unload(self):
 
3171
        self._config_obj = None
 
3172
        self.dirty_sections = []
 
3173
 
 
3174
    def _load_content(self):
 
3175
        """Load the config file bytes.
 
3176
 
 
3177
        This should be provided by subclasses
 
3178
 
 
3179
        :return: Byte string
 
3180
        """
 
3181
        raise NotImplementedError(self._load_content)
 
3182
 
 
3183
    def _save_content(self, content):
 
3184
        """Save the config file bytes.
 
3185
 
 
3186
        This should be provided by subclasses
 
3187
 
 
3188
        :param content: Config file bytes to write
 
3189
        """
 
3190
        raise NotImplementedError(self._save_content)
 
3191
 
 
3192
    def load(self):
 
3193
        """Load the store from the associated file."""
 
3194
        if self.is_loaded():
 
3195
            return
 
3196
        content = self._load_content()
 
3197
        self._load_from_string(content)
 
3198
        for hook in ConfigHooks['load']:
 
3199
            hook(self)
 
3200
 
 
3201
    def _load_from_string(self, bytes):
 
3202
        """Create a config store from a string.
 
3203
 
 
3204
        :param bytes: A string representing the file content.
 
3205
        """
 
3206
        if self.is_loaded():
 
3207
            raise AssertionError('Already loaded: %r' % (self._config_obj,))
 
3208
        co_input = StringIO(bytes)
 
3209
        try:
 
3210
            # The config files are always stored utf8-encoded
 
3211
            self._config_obj = ConfigObj(co_input, encoding='utf-8',
 
3212
                                         list_values=False)
 
3213
        except configobj.ConfigObjError, e:
 
3214
            self._config_obj = None
 
3215
            raise errors.ParseConfigError(e.errors, self.external_url())
 
3216
        except UnicodeDecodeError:
 
3217
            raise errors.ConfigContentError(self.external_url())
 
3218
 
 
3219
    def save_changes(self):
 
3220
        if not self.is_loaded():
 
3221
            # Nothing to save
 
3222
            return
 
3223
        if not self._need_saving():
 
3224
            return
 
3225
        # Preserve the current version
 
3226
        current = self._config_obj
 
3227
        dirty_sections = list(self.dirty_sections)
 
3228
        self.apply_changes(dirty_sections)
 
3229
        # Save to the persistent storage
 
3230
        self.save()
 
3231
 
 
3232
    def save(self):
 
3233
        if not self.is_loaded():
 
3234
            # Nothing to save
 
3235
            return
 
3236
        out = StringIO()
 
3237
        self._config_obj.write(out)
 
3238
        self._save_content(out.getvalue())
 
3239
        for hook in ConfigHooks['save']:
 
3240
            hook(self)
 
3241
 
 
3242
    def get_sections(self):
 
3243
        """Get the configobj section in the file order.
 
3244
 
 
3245
        :returns: An iterable of (store, section).
 
3246
        """
 
3247
        # We need a loaded store
 
3248
        try:
 
3249
            self.load()
 
3250
        except (errors.NoSuchFile, errors.PermissionDenied):
 
3251
            # If the file can't be read, there is no sections
 
3252
            return
 
3253
        cobj = self._config_obj
 
3254
        if cobj.scalars:
 
3255
            yield self, self.readonly_section_class(None, cobj)
 
3256
        for section_name in cobj.sections:
 
3257
            yield (self,
 
3258
                   self.readonly_section_class(section_name,
 
3259
                                               cobj[section_name]))
 
3260
 
 
3261
    def get_mutable_section(self, section_id=None):
 
3262
        # We need a loaded store
 
3263
        try:
 
3264
            self.load()
 
3265
        except errors.NoSuchFile:
 
3266
            # The file doesn't exist, let's pretend it was empty
 
3267
            self._load_from_string('')
 
3268
        if section_id is None:
 
3269
            section = self._config_obj
 
3270
        else:
 
3271
            section = self._config_obj.setdefault(section_id, {})
 
3272
        mutable_section = self.mutable_section_class(section_id, section)
 
3273
        # All mutable sections can become dirty
 
3274
        self.dirty_sections.append(mutable_section)
 
3275
        return mutable_section
 
3276
 
 
3277
    def quote(self, value):
 
3278
        try:
 
3279
            # configobj conflates automagical list values and quoting
 
3280
            self._config_obj.list_values = True
 
3281
            return self._config_obj._quote(value)
 
3282
        finally:
 
3283
            self._config_obj.list_values = False
 
3284
 
 
3285
    def unquote(self, value):
 
3286
        if value and isinstance(value, basestring):
 
3287
            # _unquote doesn't handle None nor empty strings nor anything that
 
3288
            # is not a string, really.
 
3289
            value = self._config_obj._unquote(value)
 
3290
        return value
 
3291
 
 
3292
    def external_url(self):
 
3293
        # Since an IniFileStore can be used without a file (at least in tests),
 
3294
        # it's better to provide something than raising a NotImplementedError.
 
3295
        # All daughter classes are supposed to provide an implementation
 
3296
        # anyway.
 
3297
        return 'In-Process Store, no URL'
 
3298
 
 
3299
class TransportIniFileStore(IniFileStore):
 
3300
    """IniFileStore that loads files from a transport.
 
3301
 
 
3302
    :ivar transport: The transport object where the config file is located.
 
3303
 
 
3304
    :ivar file_name: The config file basename in the transport directory.
 
3305
    """
 
3306
 
 
3307
    def __init__(self, transport, file_name):
 
3308
        """A Store using a ini file on a Transport
 
3309
 
 
3310
        :param transport: The transport object where the config file is located.
 
3311
        :param file_name: The config file basename in the transport directory.
 
3312
        """
 
3313
        super(TransportIniFileStore, self).__init__()
 
3314
        self.transport = transport
 
3315
        self.file_name = file_name
 
3316
 
 
3317
    def _load_content(self):
 
3318
        try:
 
3319
            return self.transport.get_bytes(self.file_name)
 
3320
        except errors.PermissionDenied:
 
3321
            trace.warning("Permission denied while trying to load "
 
3322
                          "configuration store %s.", self.external_url())
 
3323
            raise
 
3324
 
 
3325
    def _save_content(self, content):
 
3326
        self.transport.put_bytes(self.file_name, content)
 
3327
 
 
3328
    def external_url(self):
 
3329
        # FIXME: external_url should really accepts an optional relpath
 
3330
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
3331
        # The following will do in the interim but maybe we don't want to
 
3332
        # expose a path here but rather a config ID and its associated
 
3333
        # object </hand wawe>.
 
3334
        return urlutils.join(self.transport.external_url(), self.file_name)
 
3335
 
 
3336
 
 
3337
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
 
3338
# unlockable stores for use with objects that can already ensure the locking
 
3339
# (think branches). If different stores (not based on ConfigObj) are created,
 
3340
# they may face the same issue.
 
3341
 
 
3342
 
 
3343
class LockableIniFileStore(TransportIniFileStore):
 
3344
    """A ConfigObjStore using locks on save to ensure store integrity."""
 
3345
 
 
3346
    def __init__(self, transport, file_name, lock_dir_name=None):
 
3347
        """A config Store using ConfigObj for storage.
 
3348
 
 
3349
        :param transport: The transport object where the config file is located.
 
3350
 
 
3351
        :param file_name: The config file basename in the transport directory.
 
3352
        """
 
3353
        if lock_dir_name is None:
 
3354
            lock_dir_name = 'lock'
 
3355
        self.lock_dir_name = lock_dir_name
 
3356
        super(LockableIniFileStore, self).__init__(transport, file_name)
 
3357
        self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
 
3358
 
 
3359
    def lock_write(self, token=None):
 
3360
        """Takes a write lock in the directory containing the config file.
 
3361
 
 
3362
        If the directory doesn't exist it is created.
 
3363
        """
 
3364
        # FIXME: This doesn't check the ownership of the created directories as
 
3365
        # ensure_config_dir_exists does. It should if the transport is local
 
3366
        # -- vila 2011-04-06
 
3367
        self.transport.create_prefix()
 
3368
        return self._lock.lock_write(token)
 
3369
 
 
3370
    def unlock(self):
 
3371
        self._lock.unlock()
 
3372
 
 
3373
    def break_lock(self):
 
3374
        self._lock.break_lock()
 
3375
 
 
3376
    @needs_write_lock
 
3377
    def save(self):
 
3378
        # We need to be able to override the undecorated implementation
 
3379
        self.save_without_locking()
 
3380
 
 
3381
    def save_without_locking(self):
 
3382
        super(LockableIniFileStore, self).save()
 
3383
 
 
3384
 
 
3385
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
 
3386
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
 
3387
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
 
3388
 
 
3389
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
 
3390
# functions or a registry will make it easier and clearer for tests, focusing
 
3391
# on the relevant parts of the API that needs testing -- vila 20110503 (based
 
3392
# on a poolie's remark)
 
3393
class GlobalStore(LockableIniFileStore):
 
3394
 
 
3395
    def __init__(self, possible_transports=None):
 
3396
        t = transport.get_transport_from_path(
 
3397
            config_dir(), possible_transports=possible_transports)
 
3398
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
3399
        self.id = 'bazaar'
 
3400
 
 
3401
 
 
3402
class LocationStore(LockableIniFileStore):
 
3403
 
 
3404
    def __init__(self, possible_transports=None):
 
3405
        t = transport.get_transport_from_path(
 
3406
            config_dir(), possible_transports=possible_transports)
 
3407
        super(LocationStore, self).__init__(t, 'locations.conf')
 
3408
        self.id = 'locations'
 
3409
 
 
3410
 
 
3411
class BranchStore(TransportIniFileStore):
 
3412
 
 
3413
    def __init__(self, branch):
 
3414
        super(BranchStore, self).__init__(branch.control_transport,
 
3415
                                          'branch.conf')
 
3416
        self.branch = branch
 
3417
        self.id = 'branch'
 
3418
 
 
3419
 
 
3420
class ControlStore(LockableIniFileStore):
 
3421
 
 
3422
    def __init__(self, bzrdir):
 
3423
        super(ControlStore, self).__init__(bzrdir.transport,
 
3424
                                          'control.conf',
 
3425
                                           lock_dir_name='branch_lock')
 
3426
        self.id = 'control'
 
3427
 
 
3428
 
 
3429
class SectionMatcher(object):
 
3430
    """Select sections into a given Store.
 
3431
 
 
3432
    This is intended to be used to postpone getting an iterable of sections
 
3433
    from a store.
 
3434
    """
 
3435
 
 
3436
    def __init__(self, store):
 
3437
        self.store = store
 
3438
 
 
3439
    def get_sections(self):
 
3440
        # This is where we require loading the store so we can see all defined
 
3441
        # sections.
 
3442
        sections = self.store.get_sections()
 
3443
        # Walk the revisions in the order provided
 
3444
        for store, s in sections:
 
3445
            if self.match(s):
 
3446
                yield store, s
 
3447
 
 
3448
    def match(self, section):
 
3449
        """Does the proposed section match.
 
3450
 
 
3451
        :param section: A Section object.
 
3452
 
 
3453
        :returns: True if the section matches, False otherwise.
 
3454
        """
 
3455
        raise NotImplementedError(self.match)
 
3456
 
 
3457
 
 
3458
class NameMatcher(SectionMatcher):
 
3459
 
 
3460
    def __init__(self, store, section_id):
 
3461
        super(NameMatcher, self).__init__(store)
 
3462
        self.section_id = section_id
 
3463
 
 
3464
    def match(self, section):
 
3465
        return section.id == self.section_id
 
3466
 
 
3467
 
 
3468
class LocationSection(Section):
 
3469
 
 
3470
    def __init__(self, section, extra_path):
 
3471
        super(LocationSection, self).__init__(section.id, section.options)
 
3472
        self.extra_path = extra_path
 
3473
        self.locals = {'relpath': extra_path,
 
3474
                       'basename': urlutils.basename(extra_path)}
 
3475
 
 
3476
    def get(self, name, default=None, expand=True):
 
3477
        value = super(LocationSection, self).get(name, default)
 
3478
        if value is not None and expand:
 
3479
            policy_name = self.get(name + ':policy', None)
 
3480
            policy = _policy_value.get(policy_name, POLICY_NONE)
 
3481
            if policy == POLICY_APPENDPATH:
 
3482
                value = urlutils.join(value, self.extra_path)
 
3483
            # expand section local options right now (since POLICY_APPENDPATH
 
3484
            # will never add options references, it's ok to expand after it).
 
3485
            chunks = []
 
3486
            for is_ref, chunk in iter_option_refs(value):
 
3487
                if not is_ref:
 
3488
                    chunks.append(chunk)
 
3489
                else:
 
3490
                    ref = chunk[1:-1]
 
3491
                    if ref in self.locals:
 
3492
                        chunks.append(self.locals[ref])
 
3493
                    else:
 
3494
                        chunks.append(chunk)
 
3495
            value = ''.join(chunks)
 
3496
        return value
 
3497
 
 
3498
 
 
3499
class StartingPathMatcher(SectionMatcher):
 
3500
    """Select sections for a given location respecting the Store order."""
 
3501
 
 
3502
    # FIXME: Both local paths and urls can be used for section names as well as
 
3503
    # ``location`` to stay consistent with ``LocationMatcher`` which itself
 
3504
    # inherited the fuzziness from the previous ``LocationConfig``
 
3505
    # implementation. We probably need to revisit which encoding is allowed for
 
3506
    # both ``location`` and section names and how we normalize
 
3507
    # them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
 
3508
    # related too. -- vila 2012-01-04
 
3509
 
 
3510
    def __init__(self, store, location):
 
3511
        super(StartingPathMatcher, self).__init__(store)
 
3512
        if location.startswith('file://'):
 
3513
            location = urlutils.local_path_from_url(location)
 
3514
        self.location = location
 
3515
 
 
3516
    def get_sections(self):
 
3517
        """Get all sections matching ``location`` in the store.
 
3518
 
 
3519
        The most generic sections are described first in the store, then more
 
3520
        specific ones can be provided for reduced scopes.
 
3521
 
 
3522
        The returned section are therefore returned in the reversed order so
 
3523
        the most specific ones can be found first.
 
3524
        """
 
3525
        location_parts = self.location.rstrip('/').split('/')
 
3526
        store = self.store
 
3527
        sections = []
 
3528
        # Later sections are more specific, they should be returned first
 
3529
        for _, section in reversed(list(store.get_sections())):
 
3530
            if section.id is None:
 
3531
                # The no-name section is always included if present
 
3532
                yield store, LocationSection(section, self.location)
 
3533
                continue
 
3534
            section_path = section.id
 
3535
            if section_path.startswith('file://'):
 
3536
                # the location is already a local path or URL, convert the
 
3537
                # section id to the same format
 
3538
                section_path = urlutils.local_path_from_url(section_path)
 
3539
            if (self.location.startswith(section_path)
 
3540
                or fnmatch.fnmatch(self.location, section_path)):
 
3541
                section_parts = section_path.rstrip('/').split('/')
 
3542
                extra_path = '/'.join(location_parts[len(section_parts):])
 
3543
                yield store, LocationSection(section, extra_path)
 
3544
 
 
3545
 
 
3546
class LocationMatcher(SectionMatcher):
 
3547
 
 
3548
    def __init__(self, store, location):
 
3549
        super(LocationMatcher, self).__init__(store)
 
3550
        if location.startswith('file://'):
 
3551
            location = urlutils.local_path_from_url(location)
 
3552
        self.location = location
 
3553
 
 
3554
    def _get_matching_sections(self):
 
3555
        """Get all sections matching ``location``."""
 
3556
        # We slightly diverge from LocalConfig here by allowing the no-name
 
3557
        # section as the most generic one and the lower priority.
 
3558
        no_name_section = None
 
3559
        all_sections = []
 
3560
        # Filter out the no_name_section so _iter_for_location_by_parts can be
 
3561
        # used (it assumes all sections have a name).
 
3562
        for _, section in self.store.get_sections():
 
3563
            if section.id is None:
 
3564
                no_name_section = section
 
3565
            else:
 
3566
                all_sections.append(section)
 
3567
        # Unfortunately _iter_for_location_by_parts deals with section names so
 
3568
        # we have to resync.
 
3569
        filtered_sections = _iter_for_location_by_parts(
 
3570
            [s.id for s in all_sections], self.location)
 
3571
        iter_all_sections = iter(all_sections)
 
3572
        matching_sections = []
 
3573
        if no_name_section is not None:
 
3574
            matching_sections.append(
 
3575
                (0, LocationSection(no_name_section, self.location)))
 
3576
        for section_id, extra_path, length in filtered_sections:
 
3577
            # a section id is unique for a given store so it's safe to take the
 
3578
            # first matching section while iterating. Also, all filtered
 
3579
            # sections are part of 'all_sections' and will always be found
 
3580
            # there.
 
3581
            while True:
 
3582
                section = iter_all_sections.next()
 
3583
                if section_id == section.id:
 
3584
                    matching_sections.append(
 
3585
                        (length, LocationSection(section, extra_path)))
 
3586
                    break
 
3587
        return matching_sections
 
3588
 
 
3589
    def get_sections(self):
 
3590
        # Override the default implementation as we want to change the order
 
3591
        matching_sections = self._get_matching_sections()
 
3592
        # We want the longest (aka more specific) locations first
 
3593
        sections = sorted(matching_sections,
 
3594
                          key=lambda (length, section): (length, section.id),
 
3595
                          reverse=True)
 
3596
        # Sections mentioning 'ignore_parents' restrict the selection
 
3597
        for _, section in sections:
 
3598
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
 
3599
            ignore = section.get('ignore_parents', None)
 
3600
            if ignore is not None:
 
3601
                ignore = ui.bool_from_string(ignore)
 
3602
            if ignore:
 
3603
                break
 
3604
            # Finally, we have a valid section
 
3605
            yield self.store, section
 
3606
 
 
3607
 
 
3608
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
 
3609
"""Describes an expandable option reference.
 
3610
 
 
3611
We want to match the most embedded reference first.
 
3612
 
 
3613
I.e. for '{{foo}}' we will get '{foo}',
 
3614
for '{bar{baz}}' we will get '{baz}'
 
3615
"""
 
3616
 
 
3617
def iter_option_refs(string):
 
3618
    # Split isolate refs so every other chunk is a ref
 
3619
    is_ref = False
 
3620
    for chunk  in _option_ref_re.split(string):
 
3621
        yield is_ref, chunk
 
3622
        is_ref = not is_ref
 
3623
 
 
3624
 
 
3625
class Stack(object):
 
3626
    """A stack of configurations where an option can be defined"""
 
3627
 
 
3628
    def __init__(self, sections_def, store=None, mutable_section_id=None):
 
3629
        """Creates a stack of sections with an optional store for changes.
 
3630
 
 
3631
        :param sections_def: A list of Section or callables that returns an
 
3632
            iterable of Section. This defines the Sections for the Stack and
 
3633
            can be called repeatedly if needed.
 
3634
 
 
3635
        :param store: The optional Store where modifications will be
 
3636
            recorded. If none is specified, no modifications can be done.
 
3637
 
 
3638
        :param mutable_section_id: The id of the MutableSection where changes
 
3639
            are recorded. This requires the ``store`` parameter to be
 
3640
            specified.
 
3641
        """
 
3642
        self.sections_def = sections_def
 
3643
        self.store = store
 
3644
        self.mutable_section_id = mutable_section_id
 
3645
 
 
3646
    def get(self, name, expand=None):
 
3647
        """Return the *first* option value found in the sections.
 
3648
 
 
3649
        This is where we guarantee that sections coming from Store are loaded
 
3650
        lazily: the loading is delayed until we need to either check that an
 
3651
        option exists or get its value, which in turn may require to discover
 
3652
        in which sections it can be defined. Both of these (section and option
 
3653
        existence) require loading the store (even partially).
 
3654
 
 
3655
        :param name: The queried option.
 
3656
 
 
3657
        :param expand: Whether options references should be expanded.
 
3658
 
 
3659
        :returns: The value of the option.
 
3660
        """
 
3661
        # FIXME: No caching of options nor sections yet -- vila 20110503
 
3662
        if expand is None:
 
3663
            expand = _get_expand_default_value()
 
3664
        value = None
 
3665
        found_store = None # Where the option value has been found
 
3666
        # If the option is registered, it may provide additional info about
 
3667
        # value handling
 
3668
        try:
 
3669
            opt = option_registry.get(name)
 
3670
        except KeyError:
 
3671
            # Not registered
 
3672
            opt = None
 
3673
 
 
3674
        def expand_and_convert(val):
 
3675
            # This may need to be called in different contexts if the value is
 
3676
            # None or ends up being None during expansion or conversion.
 
3677
            if val is not None:
 
3678
                if expand:
 
3679
                    if isinstance(val, basestring):
 
3680
                        val = self._expand_options_in_string(val)
 
3681
                    else:
 
3682
                        trace.warning('Cannot expand "%s":'
 
3683
                                      ' %s does not support option expansion'
 
3684
                                      % (name, type(val)))
 
3685
                if opt is None:
 
3686
                    val = found_store.unquote(val)
 
3687
                else:
 
3688
                    val = opt.convert_from_unicode(found_store, val)
 
3689
            return val
 
3690
 
 
3691
        # First of all, check if the environment can override the configuration
 
3692
        # value
 
3693
        if opt is not None and opt.override_from_env:
 
3694
            value = opt.get_override()
 
3695
            value = expand_and_convert(value)
 
3696
        if value is None:
 
3697
            # Ensuring lazy loading is achieved by delaying section matching
 
3698
            # (which implies querying the persistent storage) until it can't be
 
3699
            # avoided anymore by using callables to describe (possibly empty)
 
3700
            # section lists.
 
3701
            for sections in self.sections_def:
 
3702
                for store, section in sections():
 
3703
                    value = section.get(name)
 
3704
                    if value is not None:
 
3705
                        found_store = store
 
3706
                        break
 
3707
                if value is not None:
 
3708
                    break
 
3709
            value = expand_and_convert(value)
 
3710
            if opt is not None and value is None:
 
3711
                # If the option is registered, it may provide a default value
 
3712
                value = opt.get_default()
 
3713
                value = expand_and_convert(value)
 
3714
        for hook in ConfigHooks['get']:
 
3715
            hook(self, name, value)
 
3716
        return value
 
3717
 
 
3718
    def expand_options(self, string, env=None):
 
3719
        """Expand option references in the string in the configuration context.
 
3720
 
 
3721
        :param string: The string containing option(s) to expand.
 
3722
 
 
3723
        :param env: An option dict defining additional configuration options or
 
3724
            overriding existing ones.
 
3725
 
 
3726
        :returns: The expanded string.
 
3727
        """
 
3728
        return self._expand_options_in_string(string, env)
 
3729
 
 
3730
    def _expand_options_in_string(self, string, env=None, _refs=None):
 
3731
        """Expand options in the string in the configuration context.
 
3732
 
 
3733
        :param string: The string to be expanded.
 
3734
 
 
3735
        :param env: An option dict defining additional configuration options or
 
3736
            overriding existing ones.
 
3737
 
 
3738
        :param _refs: Private list (FIFO) containing the options being expanded
 
3739
            to detect loops.
 
3740
 
 
3741
        :returns: The expanded string.
 
3742
        """
 
3743
        if string is None:
 
3744
            # Not much to expand there
 
3745
            return None
 
3746
        if _refs is None:
 
3747
            # What references are currently resolved (to detect loops)
 
3748
            _refs = []
 
3749
        result = string
 
3750
        # We need to iterate until no more refs appear ({{foo}} will need two
 
3751
        # iterations for example).
 
3752
        expanded = True
 
3753
        while expanded:
 
3754
            expanded = False
 
3755
            chunks = []
 
3756
            for is_ref, chunk in iter_option_refs(result):
 
3757
                if not is_ref:
 
3758
                    chunks.append(chunk)
 
3759
                else:
 
3760
                    expanded = True
 
3761
                    name = chunk[1:-1]
 
3762
                    if name in _refs:
 
3763
                        raise errors.OptionExpansionLoop(string, _refs)
 
3764
                    _refs.append(name)
 
3765
                    value = self._expand_option(name, env, _refs)
 
3766
                    if value is None:
 
3767
                        raise errors.ExpandingUnknownOption(name, string)
 
3768
                    chunks.append(value)
 
3769
                    _refs.pop()
 
3770
            result = ''.join(chunks)
 
3771
        return result
 
3772
 
 
3773
    def _expand_option(self, name, env, _refs):
 
3774
        if env is not None and name in env:
 
3775
            # Special case, values provided in env takes precedence over
 
3776
            # anything else
 
3777
            value = env[name]
 
3778
        else:
 
3779
            value = self.get(name, expand=False)
 
3780
            value = self._expand_options_in_string(value, env, _refs)
 
3781
        return value
 
3782
 
 
3783
    def _get_mutable_section(self):
 
3784
        """Get the MutableSection for the Stack.
 
3785
 
 
3786
        This is where we guarantee that the mutable section is lazily loaded:
 
3787
        this means we won't load the corresponding store before setting a value
 
3788
        or deleting an option. In practice the store will often be loaded but
 
3789
        this helps catching some programming errors.
 
3790
        """
 
3791
        store = self.store
 
3792
        section = store.get_mutable_section(self.mutable_section_id)
 
3793
        return store, section
 
3794
 
 
3795
    def set(self, name, value):
 
3796
        """Set a new value for the option."""
 
3797
        store, section = self._get_mutable_section()
 
3798
        section.set(name, store.quote(value))
 
3799
        for hook in ConfigHooks['set']:
 
3800
            hook(self, name, value)
 
3801
 
 
3802
    def remove(self, name):
 
3803
        """Remove an existing option."""
 
3804
        _, section = self._get_mutable_section()
 
3805
        section.remove(name)
 
3806
        for hook in ConfigHooks['remove']:
 
3807
            hook(self, name)
 
3808
 
 
3809
    def __repr__(self):
 
3810
        # Mostly for debugging use
 
3811
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
 
3812
 
 
3813
    def _get_overrides(self):
 
3814
        # Hack around library_state.initialize never called
 
3815
        if bzrlib.global_state is not None:
 
3816
            return bzrlib.global_state.cmdline_overrides.get_sections()
 
3817
        return []
 
3818
 
 
3819
 
 
3820
class MemoryStack(Stack):
 
3821
    """A configuration stack defined from a string.
 
3822
 
 
3823
    This is mainly intended for tests and requires no disk resources.
 
3824
    """
 
3825
 
 
3826
    def __init__(self, content=None):
 
3827
        """Create an in-memory stack from a given content.
 
3828
 
 
3829
        It uses a single store based on configobj and support reading and
 
3830
        writing options.
 
3831
 
 
3832
        :param content: The initial content of the store. If None, the store is
 
3833
            not loaded and ``_load_from_string`` can and should be used if
 
3834
            needed.
 
3835
        """
 
3836
        store = IniFileStore()
 
3837
        if content is not None:
 
3838
            store._load_from_string(content)
 
3839
        super(MemoryStack, self).__init__(
 
3840
            [store.get_sections], store)
 
3841
 
 
3842
 
 
3843
class _CompatibleStack(Stack):
 
3844
    """Place holder for compatibility with previous design.
 
3845
 
 
3846
    This is intended to ease the transition from the Config-based design to the
 
3847
    Stack-based design and should not be used nor relied upon by plugins.
 
3848
 
 
3849
    One assumption made here is that the daughter classes will all use Stores
 
3850
    derived from LockableIniFileStore).
 
3851
 
 
3852
    It implements set() and remove () by re-loading the store before applying
 
3853
    the modification and saving it.
 
3854
 
 
3855
    The long term plan being to implement a single write by store to save
 
3856
    all modifications, this class should not be used in the interim.
 
3857
    """
 
3858
 
 
3859
    def set(self, name, value):
 
3860
        # Force a reload
 
3861
        self.store.unload()
 
3862
        super(_CompatibleStack, self).set(name, value)
 
3863
        # Force a write to persistent storage
 
3864
        self.store.save()
 
3865
 
 
3866
    def remove(self, name):
 
3867
        # Force a reload
 
3868
        self.store.unload()
 
3869
        super(_CompatibleStack, self).remove(name)
 
3870
        # Force a write to persistent storage
 
3871
        self.store.save()
 
3872
 
 
3873
 
 
3874
class GlobalStack(_CompatibleStack):
 
3875
    """Global options only stack.
 
3876
 
 
3877
    The following sections are queried:
 
3878
 
 
3879
    * command-line overrides,
 
3880
 
 
3881
    * the 'DEFAULT' section in bazaar.conf
 
3882
 
 
3883
    This stack will use the ``DEFAULT`` section in bazaar.conf as its
 
3884
    MutableSection.
 
3885
    """
 
3886
 
 
3887
    def __init__(self):
 
3888
        gstore = GlobalStore()
 
3889
        super(GlobalStack, self).__init__(
 
3890
            [self._get_overrides,
 
3891
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3892
            gstore, mutable_section_id='DEFAULT')
 
3893
 
 
3894
 
 
3895
class LocationStack(_CompatibleStack):
 
3896
    """Per-location options falling back to global options stack.
 
3897
 
 
3898
 
 
3899
    The following sections are queried:
 
3900
 
 
3901
    * command-line overrides,
 
3902
 
 
3903
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3904
      defined by the number of path components in the section glob, higher
 
3905
      numbers first (from most specific section to most generic).
 
3906
 
 
3907
    * the 'DEFAULT' section in bazaar.conf
 
3908
 
 
3909
    This stack will use the ``location`` section in locations.conf as its
 
3910
    MutableSection.
 
3911
    """
 
3912
 
 
3913
    def __init__(self, location):
 
3914
        """Make a new stack for a location and global configuration.
 
3915
 
 
3916
        :param location: A URL prefix to """
 
3917
        lstore = LocationStore()
 
3918
        if location.startswith('file://'):
 
3919
            location = urlutils.local_path_from_url(location)
 
3920
        gstore = GlobalStore()
 
3921
        super(LocationStack, self).__init__(
 
3922
            [self._get_overrides,
 
3923
             LocationMatcher(lstore, location).get_sections,
 
3924
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3925
            lstore, mutable_section_id=location)
 
3926
 
 
3927
 
 
3928
class BranchStack(Stack):
 
3929
    """Per-location options falling back to branch then global options stack.
 
3930
 
 
3931
    The following sections are queried:
 
3932
 
 
3933
    * command-line overrides,
 
3934
 
 
3935
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3936
      defined by the number of path components in the section glob, higher
 
3937
      numbers first (from most specific section to most generic),
 
3938
 
 
3939
    * the no-name section in branch.conf,
 
3940
 
 
3941
    * the ``DEFAULT`` section in ``bazaar.conf``.
 
3942
 
 
3943
    This stack will use the no-name section in ``branch.conf`` as its
 
3944
    MutableSection.
 
3945
    """
 
3946
 
 
3947
    def __init__(self, branch):
 
3948
        lstore = LocationStore()
 
3949
        bstore = branch._get_config_store()
 
3950
        gstore = GlobalStore()
 
3951
        super(BranchStack, self).__init__(
 
3952
            [self._get_overrides,
 
3953
             LocationMatcher(lstore, branch.base).get_sections,
 
3954
             NameMatcher(bstore, None).get_sections,
 
3955
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3956
            bstore)
 
3957
        self.branch = branch
 
3958
 
 
3959
    def lock_write(self, token=None):
 
3960
        return self.branch.lock_write(token)
 
3961
 
 
3962
    def unlock(self):
 
3963
        return self.branch.unlock()
 
3964
 
 
3965
    @needs_write_lock
 
3966
    def set(self, name, value):
 
3967
        super(BranchStack, self).set(name, value)
 
3968
        # Unlocking the branch will trigger a store.save_changes() so the last
 
3969
        # unlock saves all the changes.
 
3970
 
 
3971
    @needs_write_lock
 
3972
    def remove(self, name):
 
3973
        super(BranchStack, self).remove(name)
 
3974
        # Unlocking the branch will trigger a store.save_changes() so the last
 
3975
        # unlock saves all the changes.
 
3976
 
 
3977
 
 
3978
class RemoteControlStack(_CompatibleStack):
 
3979
    """Remote control-only options stack."""
 
3980
 
 
3981
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
3982
    # with the stack used for remote bzr dirs. RemoteControlStack only uses
 
3983
    # control.conf and is used only for stack options.
 
3984
 
 
3985
    def __init__(self, bzrdir):
 
3986
        cstore = bzrdir._get_config_store()
 
3987
        super(RemoteControlStack, self).__init__(
 
3988
            [NameMatcher(cstore, None).get_sections],
 
3989
            cstore)
 
3990
        self.bzrdir = bzrdir
 
3991
 
 
3992
 
 
3993
class BranchOnlyStack(Stack):
 
3994
    """Branch-only options stack."""
 
3995
 
 
3996
    # FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
 
3997
    # stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
 
3998
    # -- vila 2011-12-16
 
3999
 
 
4000
    def __init__(self, branch):
 
4001
        bstore = branch._get_config_store()
 
4002
        super(BranchOnlyStack, self).__init__(
 
4003
            [NameMatcher(bstore, None).get_sections],
 
4004
            bstore)
 
4005
        self.branch = branch
 
4006
 
 
4007
    def lock_write(self, token=None):
 
4008
        return self.branch.lock_write(token)
 
4009
 
 
4010
    def unlock(self):
 
4011
        return self.branch.unlock()
 
4012
 
 
4013
    @needs_write_lock
 
4014
    def set(self, name, value):
 
4015
        super(BranchOnlyStack, self).set(name, value)
 
4016
        # Force a write to persistent storage
 
4017
        self.store.save_changes()
 
4018
 
 
4019
    @needs_write_lock
 
4020
    def remove(self, name):
 
4021
        super(BranchOnlyStack, self).remove(name)
 
4022
        # Force a write to persistent storage
 
4023
        self.store.save_changes()
 
4024
 
 
4025
 
 
4026
# Use a an empty dict to initialize an empty configobj avoiding all
 
4027
# parsing and encoding checks
 
4028
_quoting_config = configobj.ConfigObj(
 
4029
    {}, encoding='utf-8', interpolation=False, list_values=True)
 
4030
 
 
4031
class cmd_config(commands.Command):
 
4032
    __doc__ = """Display, set or remove a configuration option.
 
4033
 
 
4034
    Display the active value for a given option.
 
4035
 
 
4036
    If --all is specified, NAME is interpreted as a regular expression and all
 
4037
    matching options are displayed mentioning their scope. The active value
 
4038
    that bzr will take into account is the first one displayed for each option.
 
4039
 
 
4040
    If no NAME is given, --all .* is implied.
 
4041
 
 
4042
    Setting a value is achieved by using name=value without spaces. The value
 
4043
    is set in the most relevant scope and can be checked by displaying the
 
4044
    option again.
 
4045
    """
 
4046
 
 
4047
    takes_args = ['name?']
 
4048
 
 
4049
    takes_options = [
 
4050
        'directory',
 
4051
        # FIXME: This should be a registry option so that plugins can register
 
4052
        # their own config files (or not) and will also address
 
4053
        # http://pad.lv/788991 -- vila 20101115
 
4054
        commands.Option('scope', help='Reduce the scope to the specified'
 
4055
                        ' configuration file.',
 
4056
                        type=unicode),
 
4057
        commands.Option('all',
 
4058
            help='Display all the defined values for the matching options.',
 
4059
            ),
 
4060
        commands.Option('remove', help='Remove the option from'
 
4061
                        ' the configuration file.'),
 
4062
        ]
 
4063
 
 
4064
    _see_also = ['configuration']
 
4065
 
 
4066
    @commands.display_command
 
4067
    def run(self, name=None, all=False, directory=None, scope=None,
 
4068
            remove=False):
 
4069
        if directory is None:
 
4070
            directory = '.'
 
4071
        directory = urlutils.normalize_url(directory)
 
4072
        if remove and all:
 
4073
            raise errors.BzrError(
 
4074
                '--all and --remove are mutually exclusive.')
 
4075
        elif remove:
 
4076
            # Delete the option in the given scope
 
4077
            self._remove_config_option(name, directory, scope)
 
4078
        elif name is None:
 
4079
            # Defaults to all options
 
4080
            self._show_matching_options('.*', directory, scope)
 
4081
        else:
 
4082
            try:
 
4083
                name, value = name.split('=', 1)
 
4084
            except ValueError:
 
4085
                # Display the option(s) value(s)
 
4086
                if all:
 
4087
                    self._show_matching_options(name, directory, scope)
 
4088
                else:
 
4089
                    self._show_value(name, directory, scope)
 
4090
            else:
 
4091
                if all:
 
4092
                    raise errors.BzrError(
 
4093
                        'Only one option can be set.')
 
4094
                # Set the option value
 
4095
                self._set_config_option(name, value, directory, scope)
 
4096
 
 
4097
    def _get_stack(self, directory, scope=None, write_access=False):
 
4098
        """Get the configuration stack specified by ``directory`` and ``scope``.
 
4099
 
 
4100
        :param directory: Where the configurations are derived from.
 
4101
 
 
4102
        :param scope: A specific config to start from.
 
4103
 
 
4104
        :param write_access: Whether a write access to the stack will be
 
4105
            attempted.
 
4106
        """
 
4107
        # FIXME: scope should allow access to plugin-specific stacks (even
 
4108
        # reduced to the plugin-specific store), related to
 
4109
        # http://pad.lv/788991 -- vila 2011-11-15
 
4110
        if scope is not None:
 
4111
            if scope == 'bazaar':
 
4112
                return GlobalStack()
 
4113
            elif scope == 'locations':
 
4114
                return LocationStack(directory)
 
4115
            elif scope == 'branch':
 
4116
                (_, br, _) = (
 
4117
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4118
                        directory))
 
4119
                if write_access:
 
4120
                    self.add_cleanup(br.lock_write().unlock)
 
4121
                return br.get_config_stack()
 
4122
            raise errors.NoSuchConfig(scope)
 
4123
        else:
 
4124
            try:
 
4125
                (_, br, _) = (
 
4126
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4127
                        directory))
 
4128
                if write_access:
 
4129
                    self.add_cleanup(br.lock_write().unlock)
 
4130
                return br.get_config_stack()
 
4131
            except errors.NotBranchError:
 
4132
                return LocationStack(directory)
 
4133
 
 
4134
    def _show_value(self, name, directory, scope):
 
4135
        conf = self._get_stack(directory, scope)
 
4136
        value = conf.get(name, expand=True)
 
4137
        if value is not None:
 
4138
            # Quote the value appropriately
 
4139
            value = _quoting_config._quote(value)
 
4140
            self.outf.write('%s\n' % (value,))
 
4141
        else:
 
4142
            raise errors.NoSuchConfigOption(name)
 
4143
 
 
4144
    def _show_matching_options(self, name, directory, scope):
 
4145
        name = lazy_regex.lazy_compile(name)
 
4146
        # We want any error in the regexp to be raised *now* so we need to
 
4147
        # avoid the delay introduced by the lazy regexp.  But, we still do
 
4148
        # want the nicer errors raised by lazy_regex.
 
4149
        name._compile_and_collapse()
 
4150
        cur_store_id = None
 
4151
        cur_section = None
 
4152
        conf = self._get_stack(directory, scope)
 
4153
        for sections in conf.sections_def:
 
4154
            for store, section in sections():
 
4155
                for oname in section.iter_option_names():
 
4156
                    if name.search(oname):
 
4157
                        if cur_store_id != store.id:
 
4158
                            # Explain where the options are defined
 
4159
                            self.outf.write('%s:\n' % (store.id,))
 
4160
                            cur_store_id = store.id
 
4161
                            cur_section = None
 
4162
                        if (section.id is not None
 
4163
                            and cur_section != section.id):
 
4164
                            # Display the section id as it appears in the store
 
4165
                            # (None doesn't appear by definition)
 
4166
                            self.outf.write('  [%s]\n' % (section.id,))
 
4167
                            cur_section = section.id
 
4168
                        value = section.get(oname, expand=False)
 
4169
                        # Since we don't use the stack, we need to restore a
 
4170
                        # proper quoting.
 
4171
                        try:
 
4172
                            opt = option_registry.get(oname)
 
4173
                            value = opt.convert_from_unicode(store, value)
 
4174
                        except KeyError:
 
4175
                            value = store.unquote(value)
 
4176
                        value = _quoting_config._quote(value)
 
4177
                        self.outf.write('  %s = %s\n' % (oname, value))
 
4178
 
 
4179
    def _set_config_option(self, name, value, directory, scope):
 
4180
        conf = self._get_stack(directory, scope, write_access=True)
 
4181
        conf.set(name, value)
 
4182
 
 
4183
    def _remove_config_option(self, name, directory, scope):
 
4184
        if name is None:
 
4185
            raise errors.BzrCommandError(
 
4186
                '--remove expects an option to remove.')
 
4187
        conf = self._get_stack(directory, scope, write_access=True)
 
4188
        try:
 
4189
            conf.remove(name)
 
4190
        except KeyError:
 
4191
            raise errors.NoSuchConfigOption(name)
 
4192
 
 
4193
 
 
4194
# Test registries
 
4195
#
 
4196
# We need adapters that can build a Store or a Stack in a test context. Test
 
4197
# classes, based on TestCaseWithTransport, can use the registry to parametrize
 
4198
# themselves. The builder will receive a test instance and should return a
 
4199
# ready-to-use store or stack.  Plugins that define new store/stacks can also
 
4200
# register themselves here to be tested against the tests defined in
 
4201
# bzrlib.tests.test_config. Note that the builder can be called multiple times
 
4202
# for the same test.
 
4203
 
 
4204
# The registered object should be a callable receiving a test instance
 
4205
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
 
4206
# object.
 
4207
test_store_builder_registry = registry.Registry()
 
4208
 
 
4209
# The registered object should be a callable receiving a test instance
 
4210
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
 
4211
# object.
 
4212
test_stack_builder_registry = registry.Registry()