/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-03-14 11:30:42 UTC
  • mto: This revision was merged to the branch mainline in revision 6503.
  • Revision ID: jelmer@samba.org-20120314113042-0n8v6jg3xbca18q3
Remove unused helper _enumerate_history.

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