/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: Patch Queue Manager
  • Date: 2012-02-23 19:39:07 UTC
  • mfrom: (6468.3.3 bzr)
  • Revision ID: pqm@pqm.ubuntu.com-20120223193907-11erj8xxjmrchawp
(jelmer) Use Tree.iter_children() in a couple more places. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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