← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-16 16:40:10 UTC
  • mto: This revision was merged to the branch mainline in revision 6391.
  • Revision ID: jelmer@samba.org-20111216164010-z3hy00xrnclnkf7a
Update tests.

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-2011 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
 
65
75
import os
66
76
import sys
67
77
 
68
 
from bzrlib import commands
 
78
import bzrlib
69
79
from bzrlib.decorators import needs_write_lock
70
80
from bzrlib.lazy_import import lazy_import
71
81
lazy_import(globals(), """
72
 
import errno
73
82
import fnmatch
74
83
import re
75
84
from cStringIO import StringIO
76
85
 
77
 
import bzrlib
78
86
from bzrlib import (
79
87
    atomicfile,
80
 
    bzrdir,
 
88
    controldir,
81
89
    debug,
82
90
    errors,
 
91
    lazy_regex,
 
92
    library_state,
83
93
    lockdir,
84
94
    mail_client,
 
95
    mergetools,
85
96
    osutils,
86
 
    registry,
87
97
    symbol_versioning,
88
98
    trace,
89
99
    transport,
91
101
    urlutils,
92
102
    win32utils,
93
103
    )
 
104
from bzrlib.i18n import gettext
94
105
from bzrlib.util.configobj import configobj
95
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
    )
96
117
 
97
118
 
98
119
CHECK_IF_POSSIBLE=0
128
149
STORE_BRANCH = 3
129
150
STORE_GLOBAL = 4
130
151
 
131
 
_ConfigObj = None
132
 
def ConfigObj(*args, **kwargs):
133
 
    global _ConfigObj
134
 
    if _ConfigObj is None:
135
 
        class ConfigObj(configobj.ConfigObj):
136
 
 
137
 
            def get_bool(self, section, key):
138
 
                return self[section].as_bool(key)
139
 
 
140
 
            def get_value(self, section, name):
141
 
                # Try [] for the old DEFAULT section.
142
 
                if section == "DEFAULT":
143
 
                    try:
144
 
                        return self[name]
145
 
                    except KeyError:
146
 
                        pass
147
 
                return self[section][name]
148
 
        _ConfigObj = ConfigObj
149
 
    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
150
217
 
151
218
 
152
219
class Config(object):
159
226
        """Returns a unique ID for the config."""
160
227
        raise NotImplementedError(self.config_id)
161
228
 
 
229
    @deprecated_method(deprecated_in((2, 4, 0)))
162
230
    def get_editor(self):
163
231
        """Get the users pop up editor."""
164
232
        raise NotImplementedError
171
239
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
172
240
                                             sys.stdout)
173
241
 
174
 
 
175
242
    def get_mail_client(self):
176
243
        """Get a mail client to use"""
177
244
        selected_client = self.get_user_option('mail_client')
188
255
    def _get_signing_policy(self):
189
256
        """Template method to override signature creation policy."""
190
257
 
 
258
    option_ref_re = None
 
259
 
 
260
    def expand_options(self, string, env=None):
 
261
        """Expand option references in the string in the configuration context.
 
262
 
 
263
        :param string: The string containing option to expand.
 
264
 
 
265
        :param env: An option dict defining additional configuration options or
 
266
            overriding existing ones.
 
267
 
 
268
        :returns: The expanded string.
 
269
        """
 
270
        return self._expand_options_in_string(string, env)
 
271
 
 
272
    def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
 
273
        """Expand options in  a list of strings in the configuration context.
 
274
 
 
275
        :param slist: A list of strings.
 
276
 
 
277
        :param env: An option dict defining additional configuration options or
 
278
            overriding existing ones.
 
279
 
 
280
        :param _ref_stack: Private list containing the options being
 
281
            expanded to detect loops.
 
282
 
 
283
        :returns: The flatten list of expanded strings.
 
284
        """
 
285
        # expand options in each value separately flattening lists
 
286
        result = []
 
287
        for s in slist:
 
288
            value = self._expand_options_in_string(s, env, _ref_stack)
 
289
            if isinstance(value, list):
 
290
                result.extend(value)
 
291
            else:
 
292
                result.append(value)
 
293
        return result
 
294
 
 
295
    def _expand_options_in_string(self, string, env=None, _ref_stack=None):
 
296
        """Expand options in the string in the configuration context.
 
297
 
 
298
        :param string: The string to be expanded.
 
299
 
 
300
        :param env: An option dict defining additional configuration options or
 
301
            overriding existing ones.
 
302
 
 
303
        :param _ref_stack: Private list containing the options being
 
304
            expanded to detect loops.
 
305
 
 
306
        :returns: The expanded string.
 
307
        """
 
308
        if string is None:
 
309
            # Not much to expand there
 
310
            return None
 
311
        if _ref_stack is None:
 
312
            # What references are currently resolved (to detect loops)
 
313
            _ref_stack = []
 
314
        if self.option_ref_re is None:
 
315
            # We want to match the most embedded reference first (i.e. for
 
316
            # '{{foo}}' we will get '{foo}',
 
317
            # for '{bar{baz}}' we will get '{baz}'
 
318
            self.option_ref_re = re.compile('({[^{}]+})')
 
319
        result = string
 
320
        # We need to iterate until no more refs appear ({{foo}} will need two
 
321
        # iterations for example).
 
322
        while True:
 
323
            raw_chunks = self.option_ref_re.split(result)
 
324
            if len(raw_chunks) == 1:
 
325
                # Shorcut the trivial case: no refs
 
326
                return result
 
327
            chunks = []
 
328
            list_value = False
 
329
            # Split will isolate refs so that every other chunk is a ref
 
330
            chunk_is_ref = False
 
331
            for chunk in raw_chunks:
 
332
                if not chunk_is_ref:
 
333
                    if chunk:
 
334
                        # Keep only non-empty strings (or we get bogus empty
 
335
                        # slots when a list value is involved).
 
336
                        chunks.append(chunk)
 
337
                    chunk_is_ref = True
 
338
                else:
 
339
                    name = chunk[1:-1]
 
340
                    if name in _ref_stack:
 
341
                        raise errors.OptionExpansionLoop(string, _ref_stack)
 
342
                    _ref_stack.append(name)
 
343
                    value = self._expand_option(name, env, _ref_stack)
 
344
                    if value is None:
 
345
                        raise errors.ExpandingUnknownOption(name, string)
 
346
                    if isinstance(value, list):
 
347
                        list_value = True
 
348
                        chunks.extend(value)
 
349
                    else:
 
350
                        chunks.append(value)
 
351
                    _ref_stack.pop()
 
352
                    chunk_is_ref = False
 
353
            if list_value:
 
354
                # Once a list appears as the result of an expansion, all
 
355
                # callers will get a list result. This allows a consistent
 
356
                # behavior even when some options in the expansion chain
 
357
                # defined as strings (no comma in their value) but their
 
358
                # expanded value is a list.
 
359
                return self._expand_options_in_list(chunks, env, _ref_stack)
 
360
            else:
 
361
                result = ''.join(chunks)
 
362
        return result
 
363
 
 
364
    def _expand_option(self, name, env, _ref_stack):
 
365
        if env is not None and name in env:
 
366
            # Special case, values provided in env takes precedence over
 
367
            # anything else
 
368
            value = env[name]
 
369
        else:
 
370
            # FIXME: This is a limited implementation, what we really need is a
 
371
            # way to query the bzr config for the value of an option,
 
372
            # respecting the scope rules (That is, once we implement fallback
 
373
            # configs, getting the option value should restart from the top
 
374
            # config, not the current one) -- vila 20101222
 
375
            value = self.get_user_option(name, expand=False)
 
376
            if isinstance(value, list):
 
377
                value = self._expand_options_in_list(value, env, _ref_stack)
 
378
            else:
 
379
                value = self._expand_options_in_string(value, env, _ref_stack)
 
380
        return value
 
381
 
191
382
    def _get_user_option(self, option_name):
192
383
        """Template method to provide a user option."""
193
384
        return None
194
385
 
195
 
    def get_user_option(self, option_name):
196
 
        """Get a generic option - no special process, no default."""
197
 
        return self._get_user_option(option_name)
198
 
 
199
 
    def get_user_option_as_bool(self, option_name):
200
 
        """Get a generic option as a boolean - no special process, no default.
201
 
 
 
386
    def get_user_option(self, option_name, expand=None):
 
387
        """Get a generic option - no special process, no default.
 
388
 
 
389
        :param option_name: The queried option.
 
390
 
 
391
        :param expand: Whether options references should be expanded.
 
392
 
 
393
        :returns: The value of the option.
 
394
        """
 
395
        if expand is None:
 
396
            expand = _get_expand_default_value()
 
397
        value = self._get_user_option(option_name)
 
398
        if expand:
 
399
            if isinstance(value, list):
 
400
                value = self._expand_options_in_list(value)
 
401
            elif isinstance(value, dict):
 
402
                trace.warning('Cannot expand "%s":'
 
403
                              ' Dicts do not support option expansion'
 
404
                              % (option_name,))
 
405
            else:
 
406
                value = self._expand_options_in_string(value)
 
407
        for hook in OldConfigHooks['get']:
 
408
            hook(self, option_name, value)
 
409
        return value
 
410
 
 
411
    def get_user_option_as_bool(self, option_name, expand=None, default=None):
 
412
        """Get a generic option as a boolean.
 
413
 
 
414
        :param expand: Allow expanding references to other config values.
 
415
        :param default: Default value if nothing is configured
202
416
        :return None if the option doesn't exist or its value can't be
203
417
            interpreted as a boolean. Returns True or False otherwise.
204
418
        """
205
 
        s = self._get_user_option(option_name)
 
419
        s = self.get_user_option(option_name, expand=expand)
206
420
        if s is None:
207
421
            # The option doesn't exist
208
 
            return None
 
422
            return default
209
423
        val = ui.bool_from_string(s)
210
424
        if val is None:
211
425
            # The value can't be interpreted as a boolean
213
427
                          s, option_name)
214
428
        return val
215
429
 
216
 
    def get_user_option_as_list(self, option_name):
 
430
    def get_user_option_as_list(self, option_name, expand=None):
217
431
        """Get a generic option as a list - no special process, no default.
218
432
 
219
433
        :return None if the option doesn't exist. Returns the value as a list
220
434
            otherwise.
221
435
        """
222
 
        l = self._get_user_option(option_name)
 
436
        l = self.get_user_option(option_name, expand=expand)
223
437
        if isinstance(l, (str, unicode)):
224
 
            # A single value, most probably the user forgot the final ','
 
438
            # A single value, most probably the user forgot (or didn't care to
 
439
            # add) the final ','
225
440
            l = [l]
226
441
        return l
227
442
 
 
443
    def get_user_option_as_int_from_SI(self, option_name, default=None):
 
444
        """Get a generic option from a human readable size in SI units, e.g 10MB
 
445
 
 
446
        Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
447
        by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
448
        pedantic.
 
449
 
 
450
        :return Integer, expanded to its base-10 value if a proper SI unit is 
 
451
            found. If the option doesn't exist, or isn't a value in 
 
452
            SI units, return default (which defaults to None)
 
453
        """
 
454
        val = self.get_user_option(option_name)
 
455
        if isinstance(val, list):
 
456
            val = val[0]
 
457
        if val is None:
 
458
            val = default
 
459
        else:
 
460
            p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
 
461
            try:
 
462
                m = p.match(val)
 
463
                if m is not None:
 
464
                    val = int(m.group(1))
 
465
                    if m.group(2) is not None:
 
466
                        if m.group(2).lower() == 'k':
 
467
                            val *= 10**3
 
468
                        elif m.group(2).lower() == 'm':
 
469
                            val *= 10**6
 
470
                        elif m.group(2).lower() == 'g':
 
471
                            val *= 10**9
 
472
                else:
 
473
                    ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
 
474
                                               ' value {1!r} is not an SI unit.').format(
 
475
                                                option_name, val))
 
476
                    val = default
 
477
            except TypeError:
 
478
                val = default
 
479
        return val
 
480
 
 
481
    @deprecated_method(deprecated_in((2, 5, 0)))
228
482
    def gpg_signing_command(self):
229
483
        """What program should be used to sign signatures?"""
230
484
        result = self._gpg_signing_command()
247
501
        """See log_format()."""
248
502
        return None
249
503
 
 
504
    def validate_signatures_in_log(self):
 
505
        """Show GPG signature validity in log"""
 
506
        result = self._validate_signatures_in_log()
 
507
        if result == "true":
 
508
            result = True
 
509
        else:
 
510
            result = False
 
511
        return result
 
512
 
 
513
    def _validate_signatures_in_log(self):
 
514
        """See validate_signatures_in_log()."""
 
515
        return None
 
516
 
 
517
    @deprecated_method(deprecated_in((2, 5, 0)))
 
518
    def acceptable_keys(self):
 
519
        """Comma separated list of key patterns acceptable to 
 
520
        verify-signatures command"""
 
521
        result = self._acceptable_keys()
 
522
        return result
 
523
 
 
524
    def _acceptable_keys(self):
 
525
        """See acceptable_keys()."""
 
526
        return None
 
527
 
 
528
    @deprecated_method(deprecated_in((2, 5, 0)))
250
529
    def post_commit(self):
251
530
        """An ordered list of python functions to call.
252
531
 
271
550
        the concrete policy type is checked, and finally
272
551
        $EMAIL is examined.
273
552
        If no username can be found, errors.NoWhoami exception is raised.
274
 
 
275
 
        TODO: Check it's reasonably well-formed.
276
553
        """
277
554
        v = os.environ.get('BZR_EMAIL')
278
555
        if v:
279
556
            return v.decode(osutils.get_user_encoding())
280
 
 
281
557
        v = self._get_user_id()
282
558
        if v:
283
559
            return v
284
 
 
285
 
        v = os.environ.get('EMAIL')
286
 
        if v:
287
 
            return v.decode(osutils.get_user_encoding())
288
 
 
289
 
        raise errors.NoWhoami()
 
560
        return default_email()
290
561
 
291
562
    def ensure_username(self):
292
563
        """Raise errors.NoWhoami if username is not set.
295
566
        """
296
567
        self.username()
297
568
 
 
569
    @deprecated_method(deprecated_in((2, 5, 0)))
298
570
    def signature_checking(self):
299
571
        """What is the current policy for signature checking?."""
300
572
        policy = self._get_signature_checking()
302
574
            return policy
303
575
        return CHECK_IF_POSSIBLE
304
576
 
 
577
    @deprecated_method(deprecated_in((2, 5, 0)))
305
578
    def signing_policy(self):
306
579
        """What is the current policy for signature checking?."""
307
580
        policy = self._get_signing_policy()
309
582
            return policy
310
583
        return SIGN_WHEN_REQUIRED
311
584
 
 
585
    @deprecated_method(deprecated_in((2, 5, 0)))
312
586
    def signature_needed(self):
313
587
        """Is a signature needed when committing ?."""
314
588
        policy = self._get_signing_policy()
315
589
        if policy is None:
316
590
            policy = self._get_signature_checking()
317
591
            if policy is not None:
 
592
                #this warning should go away once check_signatures is
 
593
                #implemented (if not before)
318
594
                trace.warning("Please use create_signatures,"
319
595
                              " not check_signatures to set signing policy.")
320
 
            if policy == CHECK_ALWAYS:
321
 
                return True
322
596
        elif policy == SIGN_ALWAYS:
323
597
            return True
324
598
        return False
325
599
 
 
600
    @deprecated_method(deprecated_in((2, 5, 0)))
 
601
    def gpg_signing_key(self):
 
602
        """GPG user-id to sign commits"""
 
603
        key = self.get_user_option('gpg_signing_key')
 
604
        if key == "default" or key == None:
 
605
            return self.user_email()
 
606
        else:
 
607
            return key
 
608
 
326
609
    def get_alias(self, value):
327
610
        return self._get_alias(value)
328
611
 
357
640
        else:
358
641
            return True
359
642
 
 
643
    def get_merge_tools(self):
 
644
        tools = {}
 
645
        for (oname, value, section, conf_id, parser) in self._get_options():
 
646
            if oname.startswith('bzr.mergetool.'):
 
647
                tool_name = oname[len('bzr.mergetool.'):]
 
648
                tools[tool_name] = self.get_user_option(oname)
 
649
        trace.mutter('loaded merge tools: %r' % tools)
 
650
        return tools
 
651
 
 
652
    def find_merge_tool(self, name):
 
653
        # We fake a defaults mechanism here by checking if the given name can
 
654
        # be found in the known_merge_tools if it's not found in the config.
 
655
        # This should be done through the proposed config defaults mechanism
 
656
        # when it becomes available in the future.
 
657
        command_line = (self.get_user_option('bzr.mergetool.%s' % name,
 
658
                                             expand=False)
 
659
                        or mergetools.known_merge_tools.get(name, None))
 
660
        return command_line
 
661
 
 
662
 
 
663
class _ConfigHooks(hooks.Hooks):
 
664
    """A dict mapping hook names and a list of callables for configs.
 
665
    """
 
666
 
 
667
    def __init__(self):
 
668
        """Create the default hooks.
 
669
 
 
670
        These are all empty initially, because by default nothing should get
 
671
        notified.
 
672
        """
 
673
        super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
 
674
        self.add_hook('load',
 
675
                      'Invoked when a config store is loaded.'
 
676
                      ' The signature is (store).',
 
677
                      (2, 4))
 
678
        self.add_hook('save',
 
679
                      'Invoked when a config store is saved.'
 
680
                      ' The signature is (store).',
 
681
                      (2, 4))
 
682
        # The hooks for config options
 
683
        self.add_hook('get',
 
684
                      'Invoked when a config option is read.'
 
685
                      ' The signature is (stack, name, value).',
 
686
                      (2, 4))
 
687
        self.add_hook('set',
 
688
                      'Invoked when a config option is set.'
 
689
                      ' The signature is (stack, name, value).',
 
690
                      (2, 4))
 
691
        self.add_hook('remove',
 
692
                      'Invoked when a config option is removed.'
 
693
                      ' The signature is (stack, name).',
 
694
                      (2, 4))
 
695
ConfigHooks = _ConfigHooks()
 
696
 
 
697
 
 
698
class _OldConfigHooks(hooks.Hooks):
 
699
    """A dict mapping hook names and a list of callables for configs.
 
700
    """
 
701
 
 
702
    def __init__(self):
 
703
        """Create the default hooks.
 
704
 
 
705
        These are all empty initially, because by default nothing should get
 
706
        notified.
 
707
        """
 
708
        super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
 
709
        self.add_hook('load',
 
710
                      'Invoked when a config store is loaded.'
 
711
                      ' The signature is (config).',
 
712
                      (2, 4))
 
713
        self.add_hook('save',
 
714
                      'Invoked when a config store is saved.'
 
715
                      ' The signature is (config).',
 
716
                      (2, 4))
 
717
        # The hooks for config options
 
718
        self.add_hook('get',
 
719
                      'Invoked when a config option is read.'
 
720
                      ' The signature is (config, name, value).',
 
721
                      (2, 4))
 
722
        self.add_hook('set',
 
723
                      'Invoked when a config option is set.'
 
724
                      ' The signature is (config, name, value).',
 
725
                      (2, 4))
 
726
        self.add_hook('remove',
 
727
                      'Invoked when a config option is removed.'
 
728
                      ' The signature is (config, name).',
 
729
                      (2, 4))
 
730
OldConfigHooks = _OldConfigHooks()
 
731
 
360
732
 
361
733
class IniBasedConfig(Config):
362
734
    """A configuration policy that draws from ini files."""
423
795
            self._parser = ConfigObj(co_input, encoding='utf-8')
424
796
        except configobj.ConfigObjError, e:
425
797
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
798
        except UnicodeDecodeError:
 
799
            raise errors.ConfigContentError(self.file_name)
426
800
        # Make sure self.reload() will use the right file name
427
801
        self._parser.filename = self.file_name
 
802
        for hook in OldConfigHooks['load']:
 
803
            hook(self)
428
804
        return self._parser
429
805
 
430
806
    def reload(self):
433
809
            raise AssertionError('We need a file name to reload the config')
434
810
        if self._parser is not None:
435
811
            self._parser.reload()
 
812
        for hook in ConfigHooks['load']:
 
813
            hook(self)
436
814
 
437
815
    def _get_matching_sections(self):
438
816
        """Return an ordered list of (section_name, extra_path) pairs.
496
874
        config_id = self.config_id()
497
875
        for (section_name, section) in sections:
498
876
            for (name, value) in section.iteritems():
499
 
                yield (name, value, section_name, config_id)
 
877
                yield (name, parser._quote(value), section_name,
 
878
                       config_id, parser)
500
879
 
501
880
    def _get_option_policy(self, section, option_name):
502
881
        """Return the policy for the given (section, option_name) pair."""
509
888
        """See Config._get_signature_checking."""
510
889
        policy = self._get_user_option('check_signatures')
511
890
        if policy:
512
 
            return self._string_to_signature_policy(policy)
 
891
            return signature_policy_from_unicode(policy)
513
892
 
514
893
    def _get_signing_policy(self):
515
894
        """See Config._get_signing_policy"""
516
895
        policy = self._get_user_option('create_signatures')
517
896
        if policy:
518
 
            return self._string_to_signing_policy(policy)
 
897
            return signing_policy_from_unicode(policy)
519
898
 
520
899
    def _get_user_id(self):
521
900
        """Get the user id from the 'email' key in the current section."""
554
933
        """See Config.log_format."""
555
934
        return self._get_user_option('log_format')
556
935
 
 
936
    def _validate_signatures_in_log(self):
 
937
        """See Config.validate_signatures_in_log."""
 
938
        return self._get_user_option('validate_signatures_in_log')
 
939
 
 
940
    def _acceptable_keys(self):
 
941
        """See Config.acceptable_keys."""
 
942
        return self._get_user_option('acceptable_keys')
 
943
 
557
944
    def _post_commit(self):
558
945
        """See Config.post_commit."""
559
946
        return self._get_user_option('post_commit')
560
947
 
561
 
    def _string_to_signature_policy(self, signature_string):
562
 
        """Convert a string to a signing policy."""
563
 
        if signature_string.lower() == 'check-available':
564
 
            return CHECK_IF_POSSIBLE
565
 
        if signature_string.lower() == 'ignore':
566
 
            return CHECK_NEVER
567
 
        if signature_string.lower() == 'require':
568
 
            return CHECK_ALWAYS
569
 
        raise errors.BzrError("Invalid signatures policy '%s'"
570
 
                              % signature_string)
571
 
 
572
 
    def _string_to_signing_policy(self, signature_string):
573
 
        """Convert a string to a signing policy."""
574
 
        if signature_string.lower() == 'when-required':
575
 
            return SIGN_WHEN_REQUIRED
576
 
        if signature_string.lower() == 'never':
577
 
            return SIGN_NEVER
578
 
        if signature_string.lower() == 'always':
579
 
            return SIGN_ALWAYS
580
 
        raise errors.BzrError("Invalid signing policy '%s'"
581
 
                              % signature_string)
582
 
 
583
948
    def _get_alias(self, value):
584
949
        try:
585
950
            return self._get_parser().get_value("ALIASES",
609
974
        except KeyError:
610
975
            raise errors.NoSuchConfigOption(option_name)
611
976
        self._write_config_file()
 
977
        for hook in OldConfigHooks['remove']:
 
978
            hook(self, option_name)
612
979
 
613
980
    def _write_config_file(self):
614
981
        if self.file_name is None:
620
987
        atomic_file.commit()
621
988
        atomic_file.close()
622
989
        osutils.copy_ownership_from_path(self.file_name)
 
990
        for hook in OldConfigHooks['save']:
 
991
            hook(self)
623
992
 
624
993
 
625
994
class LockableConfig(IniBasedConfig):
652
1021
    def __init__(self, file_name):
653
1022
        super(LockableConfig, self).__init__(file_name=file_name)
654
1023
        self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
655
 
        self.transport = transport.get_transport(self.dir)
656
 
        self._lock = lockdir.LockDir(self.transport, 'lock')
 
1024
        # FIXME: It doesn't matter that we don't provide possible_transports
 
1025
        # below since this is currently used only for local config files ;
 
1026
        # local transports are not shared. But if/when we start using
 
1027
        # LockableConfig for other kind of transports, we will need to reuse
 
1028
        # whatever connection is already established -- vila 20100929
 
1029
        self.transport = transport.get_transport_from_path(self.dir)
 
1030
        self._lock = lockdir.LockDir(self.transport, self.lock_name)
657
1031
 
658
1032
    def _create_from_string(self, unicode_bytes, save):
659
1033
        super(LockableConfig, self)._create_from_string(unicode_bytes, False)
713
1087
        conf._create_from_string(str_or_unicode, save)
714
1088
        return conf
715
1089
 
 
1090
    @deprecated_method(deprecated_in((2, 4, 0)))
716
1091
    def get_editor(self):
717
1092
        return self._get_user_option('editor')
718
1093
 
747
1122
        self.reload()
748
1123
        self._get_parser().setdefault(section, {})[option] = value
749
1124
        self._write_config_file()
750
 
 
 
1125
        for hook in OldConfigHooks['set']:
 
1126
            hook(self, option, value)
751
1127
 
752
1128
    def _get_sections(self, name=None):
753
1129
        """See IniBasedConfig._get_sections()."""
772
1148
        super(LockableConfig, self).remove_user_option(option_name,
773
1149
                                                       section_name)
774
1150
 
 
1151
def _iter_for_location_by_parts(sections, location):
 
1152
    """Keep only the sessions matching the specified location.
 
1153
 
 
1154
    :param sections: An iterable of section names.
 
1155
 
 
1156
    :param location: An url or a local path to match against.
 
1157
 
 
1158
    :returns: An iterator of (section, extra_path, nb_parts) where nb is the
 
1159
        number of path components in the section name, section is the section
 
1160
        name and extra_path is the difference between location and the section
 
1161
        name.
 
1162
 
 
1163
    ``location`` will always be a local path and never a 'file://' url but the
 
1164
    section names themselves can be in either form.
 
1165
    """
 
1166
    location_parts = location.rstrip('/').split('/')
 
1167
 
 
1168
    for section in sections:
 
1169
        # location is a local path if possible, so we need to convert 'file://'
 
1170
        # urls in section names to local paths if necessary.
 
1171
 
 
1172
        # This also avoids having file:///path be a more exact
 
1173
        # match than '/path'.
 
1174
 
 
1175
        # FIXME: This still raises an issue if a user defines both file:///path
 
1176
        # *and* /path. Should we raise an error in this case -- vila 20110505
 
1177
 
 
1178
        if section.startswith('file://'):
 
1179
            section_path = urlutils.local_path_from_url(section)
 
1180
        else:
 
1181
            section_path = section
 
1182
        section_parts = section_path.rstrip('/').split('/')
 
1183
 
 
1184
        matched = True
 
1185
        if len(section_parts) > len(location_parts):
 
1186
            # More path components in the section, they can't match
 
1187
            matched = False
 
1188
        else:
 
1189
            # Rely on zip truncating in length to the length of the shortest
 
1190
            # argument sequence.
 
1191
            names = zip(location_parts, section_parts)
 
1192
            for name in names:
 
1193
                if not fnmatch.fnmatch(name[0], name[1]):
 
1194
                    matched = False
 
1195
                    break
 
1196
        if not matched:
 
1197
            continue
 
1198
        # build the path difference between the section and the location
 
1199
        extra_path = '/'.join(location_parts[len(section_parts):])
 
1200
        yield section, extra_path, len(section_parts)
 
1201
 
775
1202
 
776
1203
class LocationConfig(LockableConfig):
777
1204
    """A configuration object that gives the policy for a location."""
806
1233
 
807
1234
    def _get_matching_sections(self):
808
1235
        """Return an ordered list of section names matching this location."""
809
 
        sections = self._get_parser()
810
 
        location_names = self.location.split('/')
811
 
        if self.location.endswith('/'):
812
 
            del location_names[-1]
813
 
        matches=[]
814
 
        for section in sections:
815
 
            # location is a local path if possible, so we need
816
 
            # to convert 'file://' urls to local paths if necessary.
817
 
            # This also avoids having file:///path be a more exact
818
 
            # match than '/path'.
819
 
            if section.startswith('file://'):
820
 
                section_path = urlutils.local_path_from_url(section)
821
 
            else:
822
 
                section_path = section
823
 
            section_names = section_path.split('/')
824
 
            if section.endswith('/'):
825
 
                del section_names[-1]
826
 
            names = zip(location_names, section_names)
827
 
            matched = True
828
 
            for name in names:
829
 
                if not fnmatch.fnmatch(name[0], name[1]):
830
 
                    matched = False
831
 
                    break
832
 
            if not matched:
833
 
                continue
834
 
            # so, for the common prefix they matched.
835
 
            # if section is longer, no match.
836
 
            if len(section_names) > len(location_names):
837
 
                continue
838
 
            matches.append((len(section_names), section,
839
 
                            '/'.join(location_names[len(section_names):])))
 
1236
        matches = list(_iter_for_location_by_parts(self._get_parser(),
 
1237
                                                   self.location))
840
1238
        # put the longest (aka more specific) locations first
841
 
        matches.sort(reverse=True)
842
 
        sections = []
843
 
        for (length, section, extra_path) in matches:
844
 
            sections.append((section, extra_path))
 
1239
        matches.sort(
 
1240
            key=lambda (section, extra_path, length): (length, section),
 
1241
            reverse=True)
 
1242
        for (section, extra_path, length) in matches:
 
1243
            yield section, extra_path
845
1244
            # should we stop looking for parent configs here?
846
1245
            try:
847
1246
                if self._get_parser()[section].as_bool('ignore_parents'):
848
1247
                    break
849
1248
            except KeyError:
850
1249
                pass
851
 
        return sections
852
1250
 
853
1251
    def _get_sections(self, name=None):
854
1252
        """See IniBasedConfig._get_sections()."""
927
1325
        # the allowed values of store match the config policies
928
1326
        self._set_option_policy(location, option, store)
929
1327
        self._write_config_file()
 
1328
        for hook in OldConfigHooks['set']:
 
1329
            hook(self, option, value)
930
1330
 
931
1331
 
932
1332
class BranchConfig(Config):
994
1394
        e.g. "John Hacker <jhacker@example.com>"
995
1395
        This is looked up in the email controlfile for the branch.
996
1396
        """
997
 
        try:
998
 
            return (self.branch._transport.get_bytes("email")
999
 
                    .decode(osutils.get_user_encoding())
1000
 
                    .rstrip("\r\n"))
1001
 
        except errors.NoSuchFile, e:
1002
 
            pass
1003
 
 
1004
1397
        return self._get_best_value('_get_user_id')
1005
1398
 
1006
1399
    def _get_change_editor(self):
1042
1435
        config_id = self.config_id()
1043
1436
        for (section_name, section) in sections:
1044
1437
            for (name, value) in section.iteritems():
1045
 
                yield (name, value, section_name, config_id)
 
1438
                yield (name, value, section_name,
 
1439
                       config_id, branch_config._get_parser())
1046
1440
        # Then the global options
1047
1441
        for option in self._get_global_config()._get_options():
1048
1442
            yield option
1098
1492
        """See Config.log_format."""
1099
1493
        return self._get_best_value('_log_format')
1100
1494
 
 
1495
    def _validate_signatures_in_log(self):
 
1496
        """See Config.validate_signatures_in_log."""
 
1497
        return self._get_best_value('_validate_signatures_in_log')
 
1498
 
 
1499
    def _acceptable_keys(self):
 
1500
        """See Config.acceptable_keys."""
 
1501
        return self._get_best_value('_acceptable_keys')
 
1502
 
1101
1503
 
1102
1504
def ensure_config_dir_exists(path=None):
1103
1505
    """Make sure a configuration directory exists.
1121
1523
def config_dir():
1122
1524
    """Return per-user configuration directory.
1123
1525
 
1124
 
    By default this is ~/.bazaar/
 
1526
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
 
1527
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
 
1528
    that will be used instead.
1125
1529
 
1126
1530
    TODO: Global option --config-dir to override this.
1127
1531
    """
1128
1532
    base = os.environ.get('BZR_HOME', None)
1129
1533
    if sys.platform == 'win32':
 
1534
        # environ variables on Windows are in user encoding/mbcs. So decode
 
1535
        # before using one
 
1536
        if base is not None:
 
1537
            base = base.decode('mbcs')
1130
1538
        if base is None:
1131
1539
            base = win32utils.get_appdata_location_unicode()
1132
1540
        if base is None:
1133
1541
            base = os.environ.get('HOME', None)
 
1542
            if base is not None:
 
1543
                base = base.decode('mbcs')
1134
1544
        if base is None:
1135
1545
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1136
1546
                                  ' or HOME set')
1137
1547
        return osutils.pathjoin(base, 'bazaar', '2.0')
1138
1548
    else:
1139
 
        if base is None:
 
1549
        if base is not None:
 
1550
            base = base.decode(osutils._fs_enc)
 
1551
    if sys.platform == 'darwin':
 
1552
        if base is None:
 
1553
            # this takes into account $HOME
 
1554
            base = os.path.expanduser("~")
 
1555
        return osutils.pathjoin(base, '.bazaar')
 
1556
    else:
 
1557
        if base is None:
 
1558
            xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
 
1559
            if xdg_dir is None:
 
1560
                xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
 
1561
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
 
1562
            if osutils.isdir(xdg_dir):
 
1563
                trace.mutter(
 
1564
                    "Using configuration in XDG directory %s." % xdg_dir)
 
1565
                return xdg_dir
1140
1566
            base = os.path.expanduser("~")
1141
1567
        return osutils.pathjoin(base, ".bazaar")
1142
1568
 
1188
1614
        return os.path.expanduser('~/.cache')
1189
1615
 
1190
1616
 
 
1617
def _get_default_mail_domain():
 
1618
    """If possible, return the assumed default email domain.
 
1619
 
 
1620
    :returns: string mail domain, or None.
 
1621
    """
 
1622
    if sys.platform == 'win32':
 
1623
        # No implementation yet; patches welcome
 
1624
        return None
 
1625
    try:
 
1626
        f = open('/etc/mailname')
 
1627
    except (IOError, OSError), e:
 
1628
        return None
 
1629
    try:
 
1630
        domain = f.read().strip()
 
1631
        return domain
 
1632
    finally:
 
1633
        f.close()
 
1634
 
 
1635
 
 
1636
def default_email():
 
1637
    v = os.environ.get('BZR_EMAIL')
 
1638
    if v:
 
1639
        return v.decode(osutils.get_user_encoding())
 
1640
    v = os.environ.get('EMAIL')
 
1641
    if v:
 
1642
        return v.decode(osutils.get_user_encoding())
 
1643
    name, email = _auto_user_id()
 
1644
    if name and email:
 
1645
        return u'%s <%s>' % (name, email)
 
1646
    elif email:
 
1647
        return email
 
1648
    raise errors.NoWhoami()
 
1649
 
 
1650
 
 
1651
def email_from_store(unicode_str):
 
1652
    """Unlike other env vars, BZR_EMAIL takes precedence over config settings.
 
1653
 
 
1654
    Whatever comes from a config file is then overridden.
 
1655
    """
 
1656
    value = os.environ.get('BZR_EMAIL')
 
1657
    if value:
 
1658
        return value.decode(osutils.get_user_encoding())
 
1659
    return unicode_str
 
1660
 
 
1661
 
 
1662
def _auto_user_id():
 
1663
    """Calculate automatic user identification.
 
1664
 
 
1665
    :returns: (realname, email), either of which may be None if they can't be
 
1666
    determined.
 
1667
 
 
1668
    Only used when none is set in the environment or the id file.
 
1669
 
 
1670
    This only returns an email address if we can be fairly sure the 
 
1671
    address is reasonable, ie if /etc/mailname is set on unix.
 
1672
 
 
1673
    This doesn't use the FQDN as the default domain because that may be 
 
1674
    slow, and it doesn't use the hostname alone because that's not normally 
 
1675
    a reasonable address.
 
1676
    """
 
1677
    if sys.platform == 'win32':
 
1678
        # No implementation to reliably determine Windows default mail
 
1679
        # address; please add one.
 
1680
        return None, None
 
1681
 
 
1682
    default_mail_domain = _get_default_mail_domain()
 
1683
    if not default_mail_domain:
 
1684
        return None, None
 
1685
 
 
1686
    import pwd
 
1687
    uid = os.getuid()
 
1688
    try:
 
1689
        w = pwd.getpwuid(uid)
 
1690
    except KeyError:
 
1691
        trace.mutter('no passwd entry for uid %d?' % uid)
 
1692
        return None, None
 
1693
 
 
1694
    # we try utf-8 first, because on many variants (like Linux),
 
1695
    # /etc/passwd "should" be in utf-8, and because it's unlikely to give
 
1696
    # false positives.  (many users will have their user encoding set to
 
1697
    # latin-1, which cannot raise UnicodeError.)
 
1698
    try:
 
1699
        gecos = w.pw_gecos.decode('utf-8')
 
1700
        encoding = 'utf-8'
 
1701
    except UnicodeError:
 
1702
        try:
 
1703
            encoding = osutils.get_user_encoding()
 
1704
            gecos = w.pw_gecos.decode(encoding)
 
1705
        except UnicodeError, e:
 
1706
            trace.mutter("cannot decode passwd entry %s" % w)
 
1707
            return None, None
 
1708
    try:
 
1709
        username = w.pw_name.decode(encoding)
 
1710
    except UnicodeError, e:
 
1711
        trace.mutter("cannot decode passwd entry %s" % w)
 
1712
        return None, None
 
1713
 
 
1714
    comma = gecos.find(',')
 
1715
    if comma == -1:
 
1716
        realname = gecos
 
1717
    else:
 
1718
        realname = gecos[:comma]
 
1719
 
 
1720
    return realname, (username + '@' + default_mail_domain)
 
1721
 
 
1722
 
1191
1723
def parse_username(username):
1192
1724
    """Parse e-mail username and return a (name, address) tuple."""
1193
1725
    match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1284
1816
            self._config = ConfigObj(self._input, encoding='utf-8')
1285
1817
        except configobj.ConfigObjError, e:
1286
1818
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
1819
        except UnicodeError:
 
1820
            raise errors.ConfigContentError(self._filename)
1287
1821
        return self._config
1288
1822
 
1289
1823
    def _save(self):
1306
1840
        section[option_name] = value
1307
1841
        self._save()
1308
1842
 
1309
 
    def get_credentials(self, scheme, host, port=None, user=None, path=None, 
 
1843
    def get_credentials(self, scheme, host, port=None, user=None, path=None,
1310
1844
                        realm=None):
1311
1845
        """Returns the matching credentials from authentication.conf file.
1312
1846
 
1319
1853
        :param user: login (optional)
1320
1854
 
1321
1855
        :param path: the absolute path on the server (optional)
1322
 
        
 
1856
 
1323
1857
        :param realm: the http authentication realm (optional)
1324
1858
 
1325
1859
        :return: A dict containing the matching credentials or None.
1480
2014
            if ask:
1481
2015
                if prompt is None:
1482
2016
                    # Create a default prompt suitable for most cases
1483
 
                    prompt = scheme.upper() + ' %(host)s username'
 
2017
                    prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1484
2018
                # Special handling for optional fields in the prompt
1485
2019
                if port is not None:
1486
2020
                    prompt_host = '%s:%d' % (host, port)
1524
2058
        if password is None:
1525
2059
            if prompt is None:
1526
2060
                # Create a default prompt suitable for most cases
1527
 
                prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
 
2061
                prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
1528
2062
            # Special handling for optional fields in the prompt
1529
2063
            if port is not None:
1530
2064
                prompt_host = '%s:%d' % (host, port)
1725
2259
                section_obj = configobj[section]
1726
2260
            except KeyError:
1727
2261
                return default
1728
 
        return section_obj.get(name, default)
 
2262
        value = section_obj.get(name, default)
 
2263
        for hook in OldConfigHooks['get']:
 
2264
            hook(self, name, value)
 
2265
        return value
1729
2266
 
1730
2267
    def set_option(self, value, name, section=None):
1731
2268
        """Set the value associated with a named option.
1739
2276
            configobj[name] = value
1740
2277
        else:
1741
2278
            configobj.setdefault(section, {})[name] = value
 
2279
        for hook in OldConfigHooks['set']:
 
2280
            hook(self, name, value)
1742
2281
        self._set_configobj(configobj)
1743
2282
 
1744
2283
    def remove_option(self, option_name, section_name=None):
1747
2286
            del configobj[option_name]
1748
2287
        else:
1749
2288
            del configobj[section_name][option_name]
 
2289
        for hook in OldConfigHooks['remove']:
 
2290
            hook(self, option_name)
1750
2291
        self._set_configobj(configobj)
1751
2292
 
1752
2293
    def _get_config_file(self):
1753
2294
        try:
1754
 
            return StringIO(self._transport.get_bytes(self._filename))
 
2295
            f = StringIO(self._transport.get_bytes(self._filename))
 
2296
            for hook in OldConfigHooks['load']:
 
2297
                hook(self)
 
2298
            return f
1755
2299
        except errors.NoSuchFile:
1756
2300
            return StringIO()
 
2301
        except errors.PermissionDenied, e:
 
2302
            trace.warning("Permission denied while trying to open "
 
2303
                "configuration file %s.", urlutils.unescape_for_display(
 
2304
                urlutils.join(self._transport.base, self._filename), "utf-8"))
 
2305
            return StringIO()
 
2306
 
 
2307
    def _external_url(self):
 
2308
        return urlutils.join(self._transport.external_url(), self._filename)
1757
2309
 
1758
2310
    def _get_configobj(self):
1759
2311
        f = self._get_config_file()
1760
2312
        try:
1761
 
            return ConfigObj(f, encoding='utf-8')
 
2313
            try:
 
2314
                conf = ConfigObj(f, encoding='utf-8')
 
2315
            except configobj.ConfigObjError, e:
 
2316
                raise errors.ParseConfigError(e.errors, self._external_url())
 
2317
            except UnicodeDecodeError:
 
2318
                raise errors.ConfigContentError(self._external_url())
1762
2319
        finally:
1763
2320
            f.close()
 
2321
        return conf
1764
2322
 
1765
2323
    def _set_configobj(self, configobj):
1766
2324
        out_file = StringIO()
1767
2325
        configobj.write(out_file)
1768
2326
        out_file.seek(0)
1769
2327
        self._transport.put_file(self._filename, out_file)
1770
 
 
 
2328
        for hook in OldConfigHooks['save']:
 
2329
            hook(self)
 
2330
 
 
2331
 
 
2332
class Option(object):
 
2333
    """An option definition.
 
2334
 
 
2335
    The option *values* are stored in config files and found in sections.
 
2336
 
 
2337
    Here we define various properties about the option itself, its default
 
2338
    value, how to convert it from stores, what to do when invalid values are
 
2339
    encoutered, in which config files it can be stored.
 
2340
    """
 
2341
 
 
2342
    def __init__(self, name, default=None, default_from_env=None,
 
2343
                 help=None, from_unicode=None, invalid=None):
 
2344
        """Build an option definition.
 
2345
 
 
2346
        :param name: the name used to refer to the option.
 
2347
 
 
2348
        :param default: the default value to use when none exist in the config
 
2349
            stores. This is either a string that ``from_unicode`` will convert
 
2350
            into the proper type, a callable returning a unicode string so that
 
2351
            ``from_unicode`` can be used on the return value, or a python
 
2352
            object that can be stringified (so only the empty list is supported
 
2353
            for example).
 
2354
 
 
2355
        :param default_from_env: A list of environment variables which can
 
2356
           provide a default value. 'default' will be used only if none of the
 
2357
           variables specified here are set in the environment.
 
2358
 
 
2359
        :param help: a doc string to explain the option to the user.
 
2360
 
 
2361
        :param from_unicode: a callable to convert the unicode string
 
2362
            representing the option value in a store. This is not called for
 
2363
            the default value.
 
2364
 
 
2365
        :param invalid: the action to be taken when an invalid value is
 
2366
            encountered in a store. This is called only when from_unicode is
 
2367
            invoked to convert a string and returns None or raise ValueError or
 
2368
            TypeError. Accepted values are: None (ignore invalid values),
 
2369
            'warning' (emit a warning), 'error' (emit an error message and
 
2370
            terminates).
 
2371
        """
 
2372
        if default_from_env is None:
 
2373
            default_from_env = []
 
2374
        self.name = name
 
2375
        # Convert the default value to a unicode string so all values are
 
2376
        # strings internally before conversion (via from_unicode) is attempted.
 
2377
        if default is None:
 
2378
            self.default = None
 
2379
        elif isinstance(default, list):
 
2380
            # Only the empty list is supported
 
2381
            if default:
 
2382
                raise AssertionError(
 
2383
                    'Only empty lists are supported as default values')
 
2384
            self.default = u','
 
2385
        elif isinstance(default, (str, unicode, bool, int, float)):
 
2386
            # Rely on python to convert strings, booleans and integers
 
2387
            self.default = u'%s' % (default,)
 
2388
        elif callable(default):
 
2389
            self.default = default
 
2390
        else:
 
2391
            # other python objects are not expected
 
2392
            raise AssertionError('%r is not supported as a default value'
 
2393
                                 % (default,))
 
2394
        self.default_from_env = default_from_env
 
2395
        self.help = help
 
2396
        self.from_unicode = from_unicode
 
2397
        if invalid and invalid not in ('warning', 'error'):
 
2398
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
 
2399
        self.invalid = invalid
 
2400
 
 
2401
    def convert_from_unicode(self, unicode_value):
 
2402
        if self.from_unicode is None or unicode_value is None:
 
2403
            # Don't convert or nothing to convert
 
2404
            return unicode_value
 
2405
        try:
 
2406
            converted = self.from_unicode(unicode_value)
 
2407
        except (ValueError, TypeError):
 
2408
            # Invalid values are ignored
 
2409
            converted = None
 
2410
        if converted is None and self.invalid is not None:
 
2411
            # The conversion failed
 
2412
            if self.invalid == 'warning':
 
2413
                trace.warning('Value "%s" is not valid for "%s"',
 
2414
                              unicode_value, self.name)
 
2415
            elif self.invalid == 'error':
 
2416
                raise errors.ConfigOptionValueError(self.name, unicode_value)
 
2417
        return converted
 
2418
 
 
2419
    def get_default(self):
 
2420
        value = None
 
2421
        for var in self.default_from_env:
 
2422
            try:
 
2423
                # If the env variable is defined, its value is the default one
 
2424
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2425
                break
 
2426
            except KeyError:
 
2427
                continue
 
2428
        if value is None:
 
2429
            # Otherwise, fallback to the value defined at registration
 
2430
            if callable(self.default):
 
2431
                value = self.default()
 
2432
                if not isinstance(value, unicode):
 
2433
                    raise AssertionError(
 
2434
                    'Callable default values should be unicode')
 
2435
            else:
 
2436
                value = self.default
 
2437
        return value
 
2438
 
 
2439
    def get_help_text(self, additional_see_also=None, plain=True):
 
2440
        result = self.help
 
2441
        from bzrlib import help_topics
 
2442
        result += help_topics._format_see_also(additional_see_also)
 
2443
        if plain:
 
2444
            result = help_topics.help_as_plain_text(result)
 
2445
        return result
 
2446
 
 
2447
 
 
2448
# Predefined converters to get proper values from store
 
2449
 
 
2450
def bool_from_store(unicode_str):
 
2451
    return ui.bool_from_string(unicode_str)
 
2452
 
 
2453
 
 
2454
def int_from_store(unicode_str):
 
2455
    return int(unicode_str)
 
2456
 
 
2457
 
 
2458
def float_from_store(unicode_str):
 
2459
    return float(unicode_str)
 
2460
 
 
2461
 
 
2462
# Use a an empty dict to initialize an empty configobj avoiding all
 
2463
# parsing and encoding checks
 
2464
_list_converter_config = configobj.ConfigObj(
 
2465
    {}, encoding='utf-8', list_values=True, interpolation=False)
 
2466
 
 
2467
 
 
2468
def list_from_store(unicode_str):
 
2469
    if not isinstance(unicode_str, basestring):
 
2470
        raise TypeError
 
2471
    # Now inject our string directly as unicode. All callers got their value
 
2472
    # from configobj, so values that need to be quoted are already properly
 
2473
    # quoted.
 
2474
    _list_converter_config.reset()
 
2475
    _list_converter_config._parse([u"list=%s" % (unicode_str,)])
 
2476
    maybe_list = _list_converter_config['list']
 
2477
    # ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
 
2478
    if isinstance(maybe_list, basestring):
 
2479
        if maybe_list:
 
2480
            # A single value, most probably the user forgot (or didn't care to
 
2481
            # add) the final ','
 
2482
            l = [maybe_list]
 
2483
        else:
 
2484
            # The empty string, convert to empty list
 
2485
            l = []
 
2486
    else:
 
2487
        # We rely on ConfigObj providing us with a list already
 
2488
        l = maybe_list
 
2489
    return l
 
2490
 
 
2491
 
 
2492
class OptionRegistry(registry.Registry):
 
2493
    """Register config options by their name.
 
2494
 
 
2495
    This overrides ``registry.Registry`` to simplify registration by acquiring
 
2496
    some information from the option object itself.
 
2497
    """
 
2498
 
 
2499
    def register(self, option):
 
2500
        """Register a new option to its name.
 
2501
 
 
2502
        :param option: The option to register. Its name is used as the key.
 
2503
        """
 
2504
        super(OptionRegistry, self).register(option.name, option,
 
2505
                                             help=option.help)
 
2506
 
 
2507
    def register_lazy(self, key, module_name, member_name):
 
2508
        """Register a new option to be loaded on request.
 
2509
 
 
2510
        :param key: the key to request the option later. Since the registration
 
2511
            is lazy, it should be provided and match the option name.
 
2512
 
 
2513
        :param module_name: the python path to the module. Such as 'os.path'.
 
2514
 
 
2515
        :param member_name: the member of the module to return.  If empty or 
 
2516
                None, get() will return the module itself.
 
2517
        """
 
2518
        super(OptionRegistry, self).register_lazy(key,
 
2519
                                                  module_name, member_name)
 
2520
 
 
2521
    def get_help(self, key=None):
 
2522
        """Get the help text associated with the given key"""
 
2523
        option = self.get(key)
 
2524
        the_help = option.help
 
2525
        if callable(the_help):
 
2526
            return the_help(self, key)
 
2527
        return the_help
 
2528
 
 
2529
 
 
2530
option_registry = OptionRegistry()
 
2531
 
 
2532
 
 
2533
# Registered options in lexicographical order
 
2534
 
 
2535
option_registry.register(
 
2536
    Option('append_revisions_only',
 
2537
           default=None, from_unicode=bool_from_store, invalid='warning',
 
2538
           help='''\
 
2539
Whether to only append revisions to the mainline.
 
2540
 
 
2541
If this is set to true, then it is not possible to change the
 
2542
existing mainline of the branch.
 
2543
'''))
 
2544
option_registry.register(
 
2545
    Option('acceptable_keys',
 
2546
           default=None, from_unicode=list_from_store,
 
2547
           help="""\
 
2548
List of GPG key patterns which are acceptable for verification.
 
2549
"""))
 
2550
option_registry.register(
 
2551
    Option('bzr.workingtree.worth_saving_limit', default=10,
 
2552
           from_unicode=int_from_store,  invalid='warning',
 
2553
           help='''\
 
2554
How many changes before saving the dirstate.
 
2555
 
 
2556
-1 means that we will never rewrite the dirstate file for only
 
2557
stat-cache changes. Regardless of this setting, we will always rewrite
 
2558
the dirstate file if a file is added/removed/renamed/etc. This flag only
 
2559
affects the behavior of updating the dirstate file after we notice that
 
2560
a file has been touched.
 
2561
'''))
 
2562
option_registry.register(
 
2563
    Option('check_signatures', default=CHECK_IF_POSSIBLE,
 
2564
           from_unicode=signature_policy_from_unicode,
 
2565
           help='''\
 
2566
GPG checking policy.
 
2567
 
 
2568
Possible values: require, ignore, check-available (default)
 
2569
 
 
2570
this option will control whether bzr will require good gpg
 
2571
signatures, ignore them, or check them if they are
 
2572
present.
 
2573
'''))
 
2574
option_registry.register(
 
2575
    Option('create_signatures', default=SIGN_WHEN_REQUIRED,
 
2576
           from_unicode=signing_policy_from_unicode,
 
2577
           help='''\
 
2578
GPG Signing policy.
 
2579
 
 
2580
Possible values: always, never, when-required (default)
 
2581
 
 
2582
This option controls whether bzr will always create
 
2583
gpg signatures or not on commits.
 
2584
'''))
 
2585
option_registry.register(
 
2586
    Option('dirstate.fdatasync', default=True,
 
2587
           from_unicode=bool_from_store,
 
2588
           help='''\
 
2589
Flush dirstate changes onto physical disk?
 
2590
 
 
2591
If true (default), working tree metadata changes are flushed through the
 
2592
OS buffers to physical disk.  This is somewhat slower, but means data
 
2593
should not be lost if the machine crashes.  See also repository.fdatasync.
 
2594
'''))
 
2595
option_registry.register(
 
2596
    Option('debug_flags', default=[], from_unicode=list_from_store,
 
2597
           help='Debug flags to activate.'))
 
2598
option_registry.register(
 
2599
    Option('default_format', default='2a',
 
2600
           help='Format used when creating branches.'))
 
2601
option_registry.register(
 
2602
    Option('dpush_strict', default=None,
 
2603
           from_unicode=bool_from_store,
 
2604
           help='''\
 
2605
The default value for ``dpush --strict``.
 
2606
 
 
2607
If present, defines the ``--strict`` option default value for checking
 
2608
uncommitted changes before pushing into a different VCS without any
 
2609
custom bzr metadata.
 
2610
'''))
 
2611
option_registry.register(
 
2612
    Option('editor',
 
2613
           help='The command called to launch an editor to enter a message.'))
 
2614
option_registry.register(
 
2615
    Option('email', default=default_email,
 
2616
           from_unicode=email_from_store,
 
2617
           help='The users identity'))
 
2618
option_registry.register(
 
2619
    Option('gpg_signing_command',
 
2620
           default='gpg',
 
2621
           help="""\
 
2622
Program to use use for creating signatures.
 
2623
 
 
2624
This should support at least the -u and --clearsign options.
 
2625
"""))
 
2626
option_registry.register(
 
2627
    Option('gpg_signing_key',
 
2628
           default=None,
 
2629
           help="""\
 
2630
GPG key to use for signing.
 
2631
 
 
2632
This defaults to the first key associated with the users email.
 
2633
"""))
 
2634
option_registry.register(
 
2635
    Option('ignore_missing_extensions', default=False,
 
2636
           from_unicode=bool_from_store,
 
2637
           help='''\
 
2638
Control the missing extensions warning display.
 
2639
 
 
2640
The warning will not be emitted if set to True.
 
2641
'''))
 
2642
option_registry.register(
 
2643
    Option('language',
 
2644
           help='Language to translate messages into.'))
 
2645
option_registry.register(
 
2646
    Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
 
2647
           help='''\
 
2648
Steal locks that appears to be dead.
 
2649
 
 
2650
If set to True, bzr will check if a lock is supposed to be held by an
 
2651
active process from the same user on the same machine. If the user and
 
2652
machine match, but no process with the given PID is active, then bzr
 
2653
will automatically break the stale lock, and create a new lock for
 
2654
this process.
 
2655
Otherwise, bzr will prompt as normal to break the lock.
 
2656
'''))
 
2657
option_registry.register(
 
2658
    Option('log_format', default='long',
 
2659
           help= '''\
 
2660
Log format to use when displaying revisions.
 
2661
 
 
2662
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
 
2663
may be provided by plugins.
 
2664
'''))
 
2665
option_registry.register(
 
2666
    Option('output_encoding',
 
2667
           help= 'Unicode encoding for output'
 
2668
           ' (terminal encoding if not specified).'))
 
2669
option_registry.register(
 
2670
    Option('post_commit', default=None,
 
2671
           help='''\
 
2672
Post commit functions.
 
2673
 
 
2674
An ordered list of python functions to call, separated by spaces.
 
2675
 
 
2676
Each function takes branch, rev_id as parameters.
 
2677
'''))
 
2678
option_registry.register(
 
2679
    Option('push_strict', default=None,
 
2680
           from_unicode=bool_from_store,
 
2681
           help='''\
 
2682
The default value for ``push --strict``.
 
2683
 
 
2684
If present, defines the ``--strict`` option default value for checking
 
2685
uncommitted changes before sending a merge directive.
 
2686
'''))
 
2687
option_registry.register(
 
2688
    Option('repository.fdatasync', default=True,
 
2689
           from_unicode=bool_from_store,
 
2690
           help='''\
 
2691
Flush repository changes onto physical disk?
 
2692
 
 
2693
If true (default), repository changes are flushed through the OS buffers
 
2694
to physical disk.  This is somewhat slower, but means data should not be
 
2695
lost if the machine crashes.  See also dirstate.fdatasync.
 
2696
'''))
 
2697
option_registry.register_lazy('smtp_server',
 
2698
    'bzrlib.smtp_connection', 'smtp_server')
 
2699
option_registry.register_lazy('smtp_password',
 
2700
    'bzrlib.smtp_connection', 'smtp_password')
 
2701
option_registry.register_lazy('smtp_username',
 
2702
    'bzrlib.smtp_connection', 'smtp_username')
 
2703
option_registry.register(
 
2704
    Option('selftest.timeout',
 
2705
        default='600',
 
2706
        from_unicode=int_from_store,
 
2707
        help='Abort selftest if one test takes longer than this many seconds',
 
2708
        ))
 
2709
 
 
2710
option_registry.register(
 
2711
    Option('send_strict', default=None,
 
2712
           from_unicode=bool_from_store,
 
2713
           help='''\
 
2714
The default value for ``send --strict``.
 
2715
 
 
2716
If present, defines the ``--strict`` option default value for checking
 
2717
uncommitted changes before pushing.
 
2718
'''))
 
2719
 
 
2720
option_registry.register(
 
2721
    Option('serve.client_timeout',
 
2722
           default=300.0, from_unicode=float_from_store,
 
2723
           help="If we wait for a new request from a client for more than"
 
2724
                " X seconds, consider the client idle, and hangup."))
 
2725
 
 
2726
 
 
2727
class Section(object):
 
2728
    """A section defines a dict of option name => value.
 
2729
 
 
2730
    This is merely a read-only dict which can add some knowledge about the
 
2731
    options. It is *not* a python dict object though and doesn't try to mimic
 
2732
    its API.
 
2733
    """
 
2734
 
 
2735
    def __init__(self, section_id, options):
 
2736
        self.id = section_id
 
2737
        # We re-use the dict-like object received
 
2738
        self.options = options
 
2739
 
 
2740
    def get(self, name, default=None, expand=True):
 
2741
        return self.options.get(name, default)
 
2742
 
 
2743
    def iter_option_names(self):
 
2744
        for k in self.options.iterkeys():
 
2745
            yield k
 
2746
 
 
2747
    def __repr__(self):
 
2748
        # Mostly for debugging use
 
2749
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
 
2750
 
 
2751
 
 
2752
_NewlyCreatedOption = object()
 
2753
"""Was the option created during the MutableSection lifetime"""
 
2754
 
 
2755
 
 
2756
class MutableSection(Section):
 
2757
    """A section allowing changes and keeping track of the original values."""
 
2758
 
 
2759
    def __init__(self, section_id, options):
 
2760
        super(MutableSection, self).__init__(section_id, options)
 
2761
        self.orig = {}
 
2762
 
 
2763
    def set(self, name, value):
 
2764
        if name not in self.options:
 
2765
            # This is a new option
 
2766
            self.orig[name] = _NewlyCreatedOption
 
2767
        elif name not in self.orig:
 
2768
            self.orig[name] = self.get(name, None)
 
2769
        self.options[name] = value
 
2770
 
 
2771
    def remove(self, name):
 
2772
        if name not in self.orig:
 
2773
            self.orig[name] = self.get(name, None)
 
2774
        del self.options[name]
 
2775
 
 
2776
 
 
2777
class Store(object):
 
2778
    """Abstract interface to persistent storage for configuration options."""
 
2779
 
 
2780
    readonly_section_class = Section
 
2781
    mutable_section_class = MutableSection
 
2782
 
 
2783
    def is_loaded(self):
 
2784
        """Returns True if the Store has been loaded.
 
2785
 
 
2786
        This is used to implement lazy loading and ensure the persistent
 
2787
        storage is queried only when needed.
 
2788
        """
 
2789
        raise NotImplementedError(self.is_loaded)
 
2790
 
 
2791
    def load(self):
 
2792
        """Loads the Store from persistent storage."""
 
2793
        raise NotImplementedError(self.load)
 
2794
 
 
2795
    def _load_from_string(self, bytes):
 
2796
        """Create a store from a string in configobj syntax.
 
2797
 
 
2798
        :param bytes: A string representing the file content.
 
2799
        """
 
2800
        raise NotImplementedError(self._load_from_string)
 
2801
 
 
2802
    def unload(self):
 
2803
        """Unloads the Store.
 
2804
 
 
2805
        This should make is_loaded() return False. This is used when the caller
 
2806
        knows that the persistent storage has changed or may have change since
 
2807
        the last load.
 
2808
        """
 
2809
        raise NotImplementedError(self.unload)
 
2810
 
 
2811
    def save(self):
 
2812
        """Saves the Store to persistent storage."""
 
2813
        raise NotImplementedError(self.save)
 
2814
 
 
2815
    def external_url(self):
 
2816
        raise NotImplementedError(self.external_url)
 
2817
 
 
2818
    def get_sections(self):
 
2819
        """Returns an ordered iterable of existing sections.
 
2820
 
 
2821
        :returns: An iterable of (store, section).
 
2822
        """
 
2823
        raise NotImplementedError(self.get_sections)
 
2824
 
 
2825
    def get_mutable_section(self, section_id=None):
 
2826
        """Returns the specified mutable section.
 
2827
 
 
2828
        :param section_id: The section identifier
 
2829
        """
 
2830
        raise NotImplementedError(self.get_mutable_section)
 
2831
 
 
2832
    def __repr__(self):
 
2833
        # Mostly for debugging use
 
2834
        return "<config.%s(%s)>" % (self.__class__.__name__,
 
2835
                                    self.external_url())
 
2836
 
 
2837
 
 
2838
class CommandLineStore(Store):
 
2839
    "A store to carry command line overrides for the config options."""
 
2840
 
 
2841
    def __init__(self, opts=None):
 
2842
        super(CommandLineStore, self).__init__()
 
2843
        if opts is None:
 
2844
            opts = {}
 
2845
        self.options = {}
 
2846
 
 
2847
    def _reset(self):
 
2848
        # The dict should be cleared but not replaced so it can be shared.
 
2849
        self.options.clear()
 
2850
 
 
2851
    def _from_cmdline(self, overrides):
 
2852
        # Reset before accepting new definitions
 
2853
        self._reset()
 
2854
        for over in overrides:
 
2855
            try:
 
2856
                name, value = over.split('=', 1)
 
2857
            except ValueError:
 
2858
                raise errors.BzrCommandError(
 
2859
                    gettext("Invalid '%s', should be of the form 'name=value'")
 
2860
                    % (over,))
 
2861
            self.options[name] = value
 
2862
 
 
2863
    def external_url(self):
 
2864
        # Not an url but it makes debugging easier and is never needed
 
2865
        # otherwise
 
2866
        return 'cmdline'
 
2867
 
 
2868
    def get_sections(self):
 
2869
        yield self,  self.readonly_section_class('cmdline_overrides',
 
2870
                                                 self.options)
 
2871
 
 
2872
 
 
2873
class IniFileStore(Store):
 
2874
    """A config Store using ConfigObj for storage.
 
2875
 
 
2876
    :ivar transport: The transport object where the config file is located.
 
2877
 
 
2878
    :ivar file_name: The config file basename in the transport directory.
 
2879
 
 
2880
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
 
2881
        serialize/deserialize the config file.
 
2882
    """
 
2883
 
 
2884
    def __init__(self):
 
2885
        """A config Store using ConfigObj for storage.
 
2886
        """
 
2887
        super(IniFileStore, self).__init__()
 
2888
        self._config_obj = None
 
2889
 
 
2890
    def is_loaded(self):
 
2891
        return self._config_obj != None
 
2892
 
 
2893
    def unload(self):
 
2894
        self._config_obj = None
 
2895
 
 
2896
    def _load_content(self):
 
2897
        """Load the config file bytes.
 
2898
 
 
2899
        This should be provided by subclasses
 
2900
 
 
2901
        :return: Byte string
 
2902
        """
 
2903
        raise NotImplementedError(self._load_content)
 
2904
 
 
2905
    def _save_content(self, content):
 
2906
        """Save the config file bytes.
 
2907
 
 
2908
        This should be provided by subclasses
 
2909
 
 
2910
        :param content: Config file bytes to write
 
2911
        """
 
2912
        raise NotImplementedError(self._save_content)
 
2913
 
 
2914
    def load(self):
 
2915
        """Load the store from the associated file."""
 
2916
        if self.is_loaded():
 
2917
            return
 
2918
        content = self._load_content()
 
2919
        self._load_from_string(content)
 
2920
        for hook in ConfigHooks['load']:
 
2921
            hook(self)
 
2922
 
 
2923
    def _load_from_string(self, bytes):
 
2924
        """Create a config store from a string.
 
2925
 
 
2926
        :param bytes: A string representing the file content.
 
2927
        """
 
2928
        if self.is_loaded():
 
2929
            raise AssertionError('Already loaded: %r' % (self._config_obj,))
 
2930
        co_input = StringIO(bytes)
 
2931
        try:
 
2932
            # The config files are always stored utf8-encoded
 
2933
            self._config_obj = ConfigObj(co_input, encoding='utf-8',
 
2934
                                         list_values=False)
 
2935
        except configobj.ConfigObjError, e:
 
2936
            self._config_obj = None
 
2937
            raise errors.ParseConfigError(e.errors, self.external_url())
 
2938
        except UnicodeDecodeError:
 
2939
            raise errors.ConfigContentError(self.external_url())
 
2940
 
 
2941
    def save(self):
 
2942
        if not self.is_loaded():
 
2943
            # Nothing to save
 
2944
            return
 
2945
        out = StringIO()
 
2946
        self._config_obj.write(out)
 
2947
        self._save_content(out.getvalue())
 
2948
        for hook in ConfigHooks['save']:
 
2949
            hook(self)
 
2950
 
 
2951
    def get_sections(self):
 
2952
        """Get the configobj section in the file order.
 
2953
 
 
2954
        :returns: An iterable of (store, section).
 
2955
        """
 
2956
        # We need a loaded store
 
2957
        try:
 
2958
            self.load()
 
2959
        except (errors.NoSuchFile, errors.PermissionDenied):
 
2960
            # If the file can't be read, there is no sections
 
2961
            return
 
2962
        cobj = self._config_obj
 
2963
        if cobj.scalars:
 
2964
            yield self, self.readonly_section_class(None, cobj)
 
2965
        for section_name in cobj.sections:
 
2966
            yield (self,
 
2967
                   self.readonly_section_class(section_name,
 
2968
                                               cobj[section_name]))
 
2969
 
 
2970
    def get_mutable_section(self, section_id=None):
 
2971
        # We need a loaded store
 
2972
        try:
 
2973
            self.load()
 
2974
        except errors.NoSuchFile:
 
2975
            # The file doesn't exist, let's pretend it was empty
 
2976
            self._load_from_string('')
 
2977
        if section_id is None:
 
2978
            section = self._config_obj
 
2979
        else:
 
2980
            section = self._config_obj.setdefault(section_id, {})
 
2981
        return self.mutable_section_class(section_id, section)
 
2982
 
 
2983
 
 
2984
class TransportIniFileStore(IniFileStore):
 
2985
    """IniFileStore that loads files from a transport.
 
2986
    """
 
2987
 
 
2988
    def __init__(self, transport, file_name):
 
2989
        """A Store using a ini file on a Transport
 
2990
 
 
2991
        :param transport: The transport object where the config file is located.
 
2992
        :param file_name: The config file basename in the transport directory.
 
2993
        """
 
2994
        super(TransportIniFileStore, self).__init__()
 
2995
        self.transport = transport
 
2996
        self.file_name = file_name
 
2997
 
 
2998
    def _load_content(self):
 
2999
        try:
 
3000
            return self.transport.get_bytes(self.file_name)
 
3001
        except errors.PermissionDenied:
 
3002
            trace.warning("Permission denied while trying to load "
 
3003
                          "configuration store %s.", self.external_url())
 
3004
            raise
 
3005
 
 
3006
    def _save_content(self, content):
 
3007
        self.transport.put_bytes(self.file_name, content)
 
3008
 
 
3009
    def external_url(self):
 
3010
        # FIXME: external_url should really accepts an optional relpath
 
3011
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
3012
        # The following will do in the interim but maybe we don't want to
 
3013
        # expose a path here but rather a config ID and its associated
 
3014
        # object </hand wawe>.
 
3015
        return urlutils.join(self.transport.external_url(), self.file_name)
 
3016
 
 
3017
 
 
3018
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
 
3019
# unlockable stores for use with objects that can already ensure the locking
 
3020
# (think branches). If different stores (not based on ConfigObj) are created,
 
3021
# they may face the same issue.
 
3022
 
 
3023
 
 
3024
class LockableIniFileStore(TransportIniFileStore):
 
3025
    """A ConfigObjStore using locks on save to ensure store integrity."""
 
3026
 
 
3027
    def __init__(self, transport, file_name, lock_dir_name=None):
 
3028
        """A config Store using ConfigObj for storage.
 
3029
 
 
3030
        :param transport: The transport object where the config file is located.
 
3031
 
 
3032
        :param file_name: The config file basename in the transport directory.
 
3033
        """
 
3034
        if lock_dir_name is None:
 
3035
            lock_dir_name = 'lock'
 
3036
        self.lock_dir_name = lock_dir_name
 
3037
        super(LockableIniFileStore, self).__init__(transport, file_name)
 
3038
        self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
 
3039
 
 
3040
    def lock_write(self, token=None):
 
3041
        """Takes a write lock in the directory containing the config file.
 
3042
 
 
3043
        If the directory doesn't exist it is created.
 
3044
        """
 
3045
        # FIXME: This doesn't check the ownership of the created directories as
 
3046
        # ensure_config_dir_exists does. It should if the transport is local
 
3047
        # -- vila 2011-04-06
 
3048
        self.transport.create_prefix()
 
3049
        return self._lock.lock_write(token)
 
3050
 
 
3051
    def unlock(self):
 
3052
        self._lock.unlock()
 
3053
 
 
3054
    def break_lock(self):
 
3055
        self._lock.break_lock()
 
3056
 
 
3057
    @needs_write_lock
 
3058
    def save(self):
 
3059
        # We need to be able to override the undecorated implementation
 
3060
        self.save_without_locking()
 
3061
 
 
3062
    def save_without_locking(self):
 
3063
        super(LockableIniFileStore, self).save()
 
3064
 
 
3065
 
 
3066
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
 
3067
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
 
3068
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
 
3069
 
 
3070
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
 
3071
# functions or a registry will make it easier and clearer for tests, focusing
 
3072
# on the relevant parts of the API that needs testing -- vila 20110503 (based
 
3073
# on a poolie's remark)
 
3074
class GlobalStore(LockableIniFileStore):
 
3075
 
 
3076
    def __init__(self, possible_transports=None):
 
3077
        t = transport.get_transport_from_path(
 
3078
            config_dir(), possible_transports=possible_transports)
 
3079
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
3080
        self.id = 'bazaar'
 
3081
 
 
3082
 
 
3083
class LocationStore(LockableIniFileStore):
 
3084
 
 
3085
    def __init__(self, possible_transports=None):
 
3086
        t = transport.get_transport_from_path(
 
3087
            config_dir(), possible_transports=possible_transports)
 
3088
        super(LocationStore, self).__init__(t, 'locations.conf')
 
3089
        self.id = 'locations'
 
3090
 
 
3091
 
 
3092
class BranchStore(TransportIniFileStore):
 
3093
 
 
3094
    def __init__(self, branch):
 
3095
        super(BranchStore, self).__init__(branch.control_transport,
 
3096
                                          'branch.conf')
 
3097
        self.branch = branch
 
3098
        self.id = 'branch'
 
3099
 
 
3100
    def lock_write(self, token=None):
 
3101
        return self.branch.lock_write(token)
 
3102
 
 
3103
    def unlock(self):
 
3104
        return self.branch.unlock()
 
3105
 
 
3106
    @needs_write_lock
 
3107
    def save(self):
 
3108
        # We need to be able to override the undecorated implementation
 
3109
        self.save_without_locking()
 
3110
 
 
3111
    def save_without_locking(self):
 
3112
        super(BranchStore, self).save()
 
3113
 
 
3114
 
 
3115
class ControlStore(LockableIniFileStore):
 
3116
 
 
3117
    def __init__(self, bzrdir):
 
3118
        super(ControlStore, self).__init__(bzrdir.transport,
 
3119
                                          'control.conf',
 
3120
                                           lock_dir_name='branch_lock')
 
3121
 
 
3122
 
 
3123
class SectionMatcher(object):
 
3124
    """Select sections into a given Store.
 
3125
 
 
3126
    This is intended to be used to postpone getting an iterable of sections
 
3127
    from a store.
 
3128
    """
 
3129
 
 
3130
    def __init__(self, store):
 
3131
        self.store = store
 
3132
 
 
3133
    def get_sections(self):
 
3134
        # This is where we require loading the store so we can see all defined
 
3135
        # sections.
 
3136
        sections = self.store.get_sections()
 
3137
        # Walk the revisions in the order provided
 
3138
        for store, s in sections:
 
3139
            if self.match(s):
 
3140
                yield store, s
 
3141
 
 
3142
    def match(self, section):
 
3143
        """Does the proposed section match.
 
3144
 
 
3145
        :param section: A Section object.
 
3146
 
 
3147
        :returns: True if the section matches, False otherwise.
 
3148
        """
 
3149
        raise NotImplementedError(self.match)
 
3150
 
 
3151
 
 
3152
class NameMatcher(SectionMatcher):
 
3153
 
 
3154
    def __init__(self, store, section_id):
 
3155
        super(NameMatcher, self).__init__(store)
 
3156
        self.section_id = section_id
 
3157
 
 
3158
    def match(self, section):
 
3159
        return section.id == self.section_id
 
3160
 
 
3161
 
 
3162
class LocationSection(Section):
 
3163
 
 
3164
    def __init__(self, section, length, extra_path):
 
3165
        super(LocationSection, self).__init__(section.id, section.options)
 
3166
        self.length = length
 
3167
        self.extra_path = extra_path
 
3168
        self.locals = {'relpath': extra_path,
 
3169
                       'basename': urlutils.basename(extra_path)}
 
3170
 
 
3171
    def get(self, name, default=None, expand=True):
 
3172
        value = super(LocationSection, self).get(name, default)
 
3173
        if value is not None and expand:
 
3174
            policy_name = self.get(name + ':policy', None)
 
3175
            policy = _policy_value.get(policy_name, POLICY_NONE)
 
3176
            if policy == POLICY_APPENDPATH:
 
3177
                value = urlutils.join(value, self.extra_path)
 
3178
            # expand section local options right now (since POLICY_APPENDPATH
 
3179
            # will never add options references, it's ok to expand after it).
 
3180
            chunks = []
 
3181
            for is_ref, chunk in iter_option_refs(value):
 
3182
                if not is_ref:
 
3183
                    chunks.append(chunk)
 
3184
                else:
 
3185
                    ref = chunk[1:-1]
 
3186
                    if ref in self.locals:
 
3187
                        chunks.append(self.locals[ref])
 
3188
                    else:
 
3189
                        chunks.append(chunk)
 
3190
            value = ''.join(chunks)
 
3191
        return value
 
3192
 
 
3193
 
 
3194
class LocationMatcher(SectionMatcher):
 
3195
 
 
3196
    def __init__(self, store, location):
 
3197
        super(LocationMatcher, self).__init__(store)
 
3198
        if location.startswith('file://'):
 
3199
            location = urlutils.local_path_from_url(location)
 
3200
        self.location = location
 
3201
 
 
3202
    def _get_matching_sections(self):
 
3203
        """Get all sections matching ``location``."""
 
3204
        # We slightly diverge from LocalConfig here by allowing the no-name
 
3205
        # section as the most generic one and the lower priority.
 
3206
        no_name_section = None
 
3207
        all_sections = []
 
3208
        # Filter out the no_name_section so _iter_for_location_by_parts can be
 
3209
        # used (it assumes all sections have a name).
 
3210
        for _, section in self.store.get_sections():
 
3211
            if section.id is None:
 
3212
                no_name_section = section
 
3213
            else:
 
3214
                all_sections.append(section)
 
3215
        # Unfortunately _iter_for_location_by_parts deals with section names so
 
3216
        # we have to resync.
 
3217
        filtered_sections = _iter_for_location_by_parts(
 
3218
            [s.id for s in all_sections], self.location)
 
3219
        iter_all_sections = iter(all_sections)
 
3220
        matching_sections = []
 
3221
        if no_name_section is not None:
 
3222
            matching_sections.append(
 
3223
                LocationSection(no_name_section, 0, self.location))
 
3224
        for section_id, extra_path, length in filtered_sections:
 
3225
            # a section id is unique for a given store so it's safe to take the
 
3226
            # first matching section while iterating. Also, all filtered
 
3227
            # sections are part of 'all_sections' and will always be found
 
3228
            # there.
 
3229
            while True:
 
3230
                section = iter_all_sections.next()
 
3231
                if section_id == section.id:
 
3232
                    matching_sections.append(
 
3233
                        LocationSection(section, length, extra_path))
 
3234
                    break
 
3235
        return matching_sections
 
3236
 
 
3237
    def get_sections(self):
 
3238
        # Override the default implementation as we want to change the order
 
3239
        matching_sections = self._get_matching_sections()
 
3240
        # We want the longest (aka more specific) locations first
 
3241
        sections = sorted(matching_sections,
 
3242
                          key=lambda section: (section.length, section.id),
 
3243
                          reverse=True)
 
3244
        # Sections mentioning 'ignore_parents' restrict the selection
 
3245
        for section in sections:
 
3246
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
 
3247
            ignore = section.get('ignore_parents', None)
 
3248
            if ignore is not None:
 
3249
                ignore = ui.bool_from_string(ignore)
 
3250
            if ignore:
 
3251
                break
 
3252
            # Finally, we have a valid section
 
3253
            yield self.store, section
 
3254
 
 
3255
 
 
3256
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
 
3257
"""Describes an expandable option reference.
 
3258
 
 
3259
We want to match the most embedded reference first.
 
3260
 
 
3261
I.e. for '{{foo}}' we will get '{foo}',
 
3262
for '{bar{baz}}' we will get '{baz}'
 
3263
"""
 
3264
 
 
3265
def iter_option_refs(string):
 
3266
    # Split isolate refs so every other chunk is a ref
 
3267
    is_ref = False
 
3268
    for chunk  in _option_ref_re.split(string):
 
3269
        yield is_ref, chunk
 
3270
        is_ref = not is_ref
 
3271
 
 
3272
 
 
3273
class Stack(object):
 
3274
    """A stack of configurations where an option can be defined"""
 
3275
 
 
3276
    def __init__(self, sections_def, store=None, mutable_section_id=None):
 
3277
        """Creates a stack of sections with an optional store for changes.
 
3278
 
 
3279
        :param sections_def: A list of Section or callables that returns an
 
3280
            iterable of Section. This defines the Sections for the Stack and
 
3281
            can be called repeatedly if needed.
 
3282
 
 
3283
        :param store: The optional Store where modifications will be
 
3284
            recorded. If none is specified, no modifications can be done.
 
3285
 
 
3286
        :param mutable_section_id: The id of the MutableSection where changes
 
3287
            are recorded. This requires the ``store`` parameter to be
 
3288
            specified.
 
3289
        """
 
3290
        self.sections_def = sections_def
 
3291
        self.store = store
 
3292
        self.mutable_section_id = mutable_section_id
 
3293
 
 
3294
    def get(self, name, expand=None):
 
3295
        """Return the *first* option value found in the sections.
 
3296
 
 
3297
        This is where we guarantee that sections coming from Store are loaded
 
3298
        lazily: the loading is delayed until we need to either check that an
 
3299
        option exists or get its value, which in turn may require to discover
 
3300
        in which sections it can be defined. Both of these (section and option
 
3301
        existence) require loading the store (even partially).
 
3302
 
 
3303
        :param name: The queried option.
 
3304
 
 
3305
        :param expand: Whether options references should be expanded.
 
3306
 
 
3307
        :returns: The value of the option.
 
3308
        """
 
3309
        # FIXME: No caching of options nor sections yet -- vila 20110503
 
3310
        if expand is None:
 
3311
            expand = _get_expand_default_value()
 
3312
        value = None
 
3313
        # Ensuring lazy loading is achieved by delaying section matching (which
 
3314
        # implies querying the persistent storage) until it can't be avoided
 
3315
        # anymore by using callables to describe (possibly empty) section
 
3316
        # lists.
 
3317
        for sections in self.sections_def:
 
3318
            for store, section in sections():
 
3319
                value = section.get(name)
 
3320
                if value is not None:
 
3321
                    break
 
3322
            if value is not None:
 
3323
                break
 
3324
        # If the option is registered, it may provide additional info about
 
3325
        # value handling
 
3326
        try:
 
3327
            opt = option_registry.get(name)
 
3328
        except KeyError:
 
3329
            # Not registered
 
3330
            opt = None
 
3331
        def expand_and_convert(val):
 
3332
            # This may need to be called twice if the value is None or ends up
 
3333
            # being None during expansion or conversion.
 
3334
            if val is not None:
 
3335
                if expand:
 
3336
                    if isinstance(val, basestring):
 
3337
                        val = self._expand_options_in_string(val)
 
3338
                    else:
 
3339
                        trace.warning('Cannot expand "%s":'
 
3340
                                      ' %s does not support option expansion'
 
3341
                                      % (name, type(val)))
 
3342
                if opt is not None:
 
3343
                    val = opt.convert_from_unicode(val)
 
3344
            return val
 
3345
        value = expand_and_convert(value)
 
3346
        if opt is not None and value is None:
 
3347
            # If the option is registered, it may provide a default value
 
3348
            value = opt.get_default()
 
3349
            value = expand_and_convert(value)
 
3350
        for hook in ConfigHooks['get']:
 
3351
            hook(self, name, value)
 
3352
        return value
 
3353
 
 
3354
    def expand_options(self, string, env=None):
 
3355
        """Expand option references in the string in the configuration context.
 
3356
 
 
3357
        :param string: The string containing option(s) to expand.
 
3358
 
 
3359
        :param env: An option dict defining additional configuration options or
 
3360
            overriding existing ones.
 
3361
 
 
3362
        :returns: The expanded string.
 
3363
        """
 
3364
        return self._expand_options_in_string(string, env)
 
3365
 
 
3366
    def _expand_options_in_string(self, string, env=None, _refs=None):
 
3367
        """Expand options in the string in the configuration context.
 
3368
 
 
3369
        :param string: The string to be expanded.
 
3370
 
 
3371
        :param env: An option dict defining additional configuration options or
 
3372
            overriding existing ones.
 
3373
 
 
3374
        :param _refs: Private list (FIFO) containing the options being expanded
 
3375
            to detect loops.
 
3376
 
 
3377
        :returns: The expanded string.
 
3378
        """
 
3379
        if string is None:
 
3380
            # Not much to expand there
 
3381
            return None
 
3382
        if _refs is None:
 
3383
            # What references are currently resolved (to detect loops)
 
3384
            _refs = []
 
3385
        result = string
 
3386
        # We need to iterate until no more refs appear ({{foo}} will need two
 
3387
        # iterations for example).
 
3388
        expanded = True
 
3389
        while expanded:
 
3390
            expanded = False
 
3391
            chunks = []
 
3392
            for is_ref, chunk in iter_option_refs(result):
 
3393
                if not is_ref:
 
3394
                    chunks.append(chunk)
 
3395
                else:
 
3396
                    expanded = True
 
3397
                    name = chunk[1:-1]
 
3398
                    if name in _refs:
 
3399
                        raise errors.OptionExpansionLoop(string, _refs)
 
3400
                    _refs.append(name)
 
3401
                    value = self._expand_option(name, env, _refs)
 
3402
                    if value is None:
 
3403
                        raise errors.ExpandingUnknownOption(name, string)
 
3404
                    chunks.append(value)
 
3405
                    _refs.pop()
 
3406
            result = ''.join(chunks)
 
3407
        return result
 
3408
 
 
3409
    def _expand_option(self, name, env, _refs):
 
3410
        if env is not None and name in env:
 
3411
            # Special case, values provided in env takes precedence over
 
3412
            # anything else
 
3413
            value = env[name]
 
3414
        else:
 
3415
            value = self.get(name, expand=False)
 
3416
            value = self._expand_options_in_string(value, env, _refs)
 
3417
        return value
 
3418
 
 
3419
    def _get_mutable_section(self):
 
3420
        """Get the MutableSection for the Stack.
 
3421
 
 
3422
        This is where we guarantee that the mutable section is lazily loaded:
 
3423
        this means we won't load the corresponding store before setting a value
 
3424
        or deleting an option. In practice the store will often be loaded but
 
3425
        this helps catching some programming errors.
 
3426
        """
 
3427
        section = self.store.get_mutable_section(self.mutable_section_id)
 
3428
        return section
 
3429
 
 
3430
    def set(self, name, value):
 
3431
        """Set a new value for the option."""
 
3432
        section = self._get_mutable_section()
 
3433
        section.set(name, value)
 
3434
        for hook in ConfigHooks['set']:
 
3435
            hook(self, name, value)
 
3436
 
 
3437
    def remove(self, name):
 
3438
        """Remove an existing option."""
 
3439
        section = self._get_mutable_section()
 
3440
        section.remove(name)
 
3441
        for hook in ConfigHooks['remove']:
 
3442
            hook(self, name)
 
3443
 
 
3444
    def __repr__(self):
 
3445
        # Mostly for debugging use
 
3446
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
 
3447
 
 
3448
    def _get_overrides(self):
 
3449
        # Hack around library_state.initialize never called
 
3450
        if bzrlib.global_state is not None:
 
3451
            return bzrlib.global_state.cmdline_overrides.get_sections()
 
3452
        return []
 
3453
 
 
3454
 
 
3455
class _CompatibleStack(Stack):
 
3456
    """Place holder for compatibility with previous design.
 
3457
 
 
3458
    This is intended to ease the transition from the Config-based design to the
 
3459
    Stack-based design and should not be used nor relied upon by plugins.
 
3460
 
 
3461
    One assumption made here is that the daughter classes will all use Stores
 
3462
    derived from LockableIniFileStore).
 
3463
 
 
3464
    It implements set() and remove () by re-loading the store before applying
 
3465
    the modification and saving it.
 
3466
 
 
3467
    The long term plan being to implement a single write by store to save
 
3468
    all modifications, this class should not be used in the interim.
 
3469
    """
 
3470
 
 
3471
    def set(self, name, value):
 
3472
        # Force a reload
 
3473
        self.store.unload()
 
3474
        super(_CompatibleStack, self).set(name, value)
 
3475
        # Force a write to persistent storage
 
3476
        self.store.save()
 
3477
 
 
3478
    def remove(self, name):
 
3479
        # Force a reload
 
3480
        self.store.unload()
 
3481
        super(_CompatibleStack, self).remove(name)
 
3482
        # Force a write to persistent storage
 
3483
        self.store.save()
 
3484
 
 
3485
 
 
3486
class GlobalStack(_CompatibleStack):
 
3487
    """Global options only stack.
 
3488
 
 
3489
    The following sections are queried:
 
3490
 
 
3491
    * command-line overrides,
 
3492
 
 
3493
    * the 'DEFAULT' section in bazaar.conf
 
3494
 
 
3495
    This stack will use the ``DEFAULT`` section in bazaar.conf as its
 
3496
    MutableSection.
 
3497
    """
 
3498
 
 
3499
    def __init__(self):
 
3500
        gstore = GlobalStore()
 
3501
        super(GlobalStack, self).__init__(
 
3502
            [self._get_overrides,
 
3503
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3504
            gstore, mutable_section_id='DEFAULT')
 
3505
 
 
3506
 
 
3507
class LocationStack(_CompatibleStack):
 
3508
    """Per-location options falling back to global options stack.
 
3509
 
 
3510
 
 
3511
    The following sections are queried:
 
3512
 
 
3513
    * command-line overrides,
 
3514
 
 
3515
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3516
      defined by the number of path components in the section glob, higher
 
3517
      numbers first (from most specific section to most generic).
 
3518
 
 
3519
    * the 'DEFAULT' section in bazaar.conf
 
3520
 
 
3521
    This stack will use the ``location`` section in locations.conf as its
 
3522
    MutableSection.
 
3523
    """
 
3524
 
 
3525
    def __init__(self, location):
 
3526
        """Make a new stack for a location and global configuration.
 
3527
 
 
3528
        :param location: A URL prefix to """
 
3529
        lstore = LocationStore()
 
3530
        if location.startswith('file://'):
 
3531
            location = urlutils.local_path_from_url(location)
 
3532
        gstore = GlobalStore()
 
3533
        super(LocationStack, self).__init__(
 
3534
            [self._get_overrides,
 
3535
             LocationMatcher(lstore, location).get_sections,
 
3536
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3537
            lstore, mutable_section_id=location)
 
3538
 
 
3539
 
 
3540
class BranchStack(_CompatibleStack):
 
3541
    """Per-location options falling back to branch then global options stack.
 
3542
 
 
3543
    The following sections are queried:
 
3544
 
 
3545
    * command-line overrides,
 
3546
 
 
3547
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3548
      defined by the number of path components in the section glob, higher
 
3549
      numbers first (from most specific section to most generic),
 
3550
 
 
3551
    * the no-name section in branch.conf,
 
3552
 
 
3553
    * the ``DEFAULT`` section in ``bazaar.conf``.
 
3554
 
 
3555
    This stack will use the no-name section in ``branch.conf`` as its
 
3556
    MutableSection.
 
3557
    """
 
3558
 
 
3559
    def __init__(self, branch):
 
3560
        lstore = LocationStore()
 
3561
        bstore = branch._get_config_store()
 
3562
        gstore = GlobalStore()
 
3563
        super(BranchStack, self).__init__(
 
3564
            [self._get_overrides,
 
3565
             LocationMatcher(lstore, branch.base).get_sections,
 
3566
             NameMatcher(bstore, None).get_sections,
 
3567
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3568
            bstore)
 
3569
        self.branch = branch
 
3570
 
 
3571
 
 
3572
class RemoteControlStack(_CompatibleStack):
 
3573
    """Remote control-only options stack."""
 
3574
 
 
3575
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
3576
    # with the stack used for remote bzr dirs. RemoteControlStack only uses
 
3577
    # control.conf and is used only for stack options.
 
3578
 
 
3579
    def __init__(self, bzrdir):
 
3580
        cstore = bzrdir._get_config_store()
 
3581
        super(RemoteControlStack, self).__init__(
 
3582
            [NameMatcher(cstore, None).get_sections],
 
3583
            cstore)
 
3584
        self.bzrdir = bzrdir
 
3585
 
 
3586
 
 
3587
class RemoteBranchStack(_CompatibleStack):
 
3588
    """Remote branch-only options stack."""
 
3589
 
 
3590
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
3591
    # with the stack used for remote branches. RemoteBranchStack only uses
 
3592
    # branch.conf and is used only for the stack options.
 
3593
 
 
3594
    def __init__(self, branch):
 
3595
        bstore = branch._get_config_store()
 
3596
        super(RemoteBranchStack, self).__init__(
 
3597
            [NameMatcher(bstore, None).get_sections],
 
3598
            bstore)
 
3599
        self.branch = branch
 
3600
 
 
3601
# Use a an empty dict to initialize an empty configobj avoiding all
 
3602
# parsing and encoding checks
 
3603
_quoting_config = configobj.ConfigObj(
 
3604
    {}, encoding='utf-8', interpolation=False)
1771
3605
 
1772
3606
class cmd_config(commands.Command):
1773
3607
    __doc__ = """Display, set or remove a configuration option.
1774
3608
 
1775
 
    Display the MATCHING configuration options mentioning their scope (the
1776
 
    configuration file they are defined in). The active value that bzr will
1777
 
    take into account is the first one displayed.
 
3609
    Display the active value for a given option.
 
3610
 
 
3611
    If --all is specified, NAME is interpreted as a regular expression and all
 
3612
    matching options are displayed mentioning their scope. The active value
 
3613
    that bzr will take into account is the first one displayed for each option.
 
3614
 
 
3615
    If no NAME is given, --all .* is implied.
1778
3616
 
1779
3617
    Setting a value is achieved by using name=value without spaces. The value
1780
3618
    is set in the most relevant scope and can be checked by displaying the
1781
3619
    option again.
1782
3620
    """
1783
3621
 
1784
 
    aliases = ['conf']
1785
 
    takes_args = ['matching?']
 
3622
    takes_args = ['name?']
1786
3623
 
1787
3624
    takes_options = [
1788
3625
        'directory',
1789
3626
        # FIXME: This should be a registry option so that plugins can register
1790
 
        # their own config files (or not) -- vila 20101002
 
3627
        # their own config files (or not) and will also address
 
3628
        # http://pad.lv/788991 -- vila 20101115
1791
3629
        commands.Option('scope', help='Reduce the scope to the specified'
1792
 
                        ' configuration file',
 
3630
                        ' configuration file.',
1793
3631
                        type=unicode),
 
3632
        commands.Option('all',
 
3633
            help='Display all the defined values for the matching options.',
 
3634
            ),
1794
3635
        commands.Option('remove', help='Remove the option from'
1795
 
                        ' the configuration file'),
 
3636
                        ' the configuration file.'),
1796
3637
        ]
1797
3638
 
 
3639
    _see_also = ['configuration']
 
3640
 
1798
3641
    @commands.display_command
1799
 
    def run(self, matching=None, directory=None, scope=None, remove=False):
 
3642
    def run(self, name=None, all=False, directory=None, scope=None,
 
3643
            remove=False):
1800
3644
        if directory is None:
1801
3645
            directory = '.'
1802
3646
        directory = urlutils.normalize_url(directory)
1803
 
        if matching is None:
1804
 
            self._show_config('*', directory)
 
3647
        if remove and all:
 
3648
            raise errors.BzrError(
 
3649
                '--all and --remove are mutually exclusive.')
 
3650
        elif remove:
 
3651
            # Delete the option in the given scope
 
3652
            self._remove_config_option(name, directory, scope)
 
3653
        elif name is None:
 
3654
            # Defaults to all options
 
3655
            self._show_matching_options('.*', directory, scope)
1805
3656
        else:
1806
 
            if remove:
1807
 
                self._remove_config_option(matching, directory, scope)
 
3657
            try:
 
3658
                name, value = name.split('=', 1)
 
3659
            except ValueError:
 
3660
                # Display the option(s) value(s)
 
3661
                if all:
 
3662
                    self._show_matching_options(name, directory, scope)
 
3663
                else:
 
3664
                    self._show_value(name, directory, scope)
1808
3665
            else:
1809
 
                pos = matching.find('=')
1810
 
                if pos == -1:
1811
 
                    self._show_config(matching, directory)
1812
 
                else:
1813
 
                    self._set_config_option(matching[:pos], matching[pos+1:],
1814
 
                                            directory, scope)
 
3666
                if all:
 
3667
                    raise errors.BzrError(
 
3668
                        'Only one option can be set.')
 
3669
                # Set the option value
 
3670
                self._set_config_option(name, value, directory, scope)
1815
3671
 
1816
 
    def _get_configs(self, directory, scope=None):
1817
 
        """Iterate the configurations specified by ``directory`` and ``scope``.
 
3672
    def _get_stack(self, directory, scope=None):
 
3673
        """Get the configuration stack specified by ``directory`` and ``scope``.
1818
3674
 
1819
3675
        :param directory: Where the configurations are derived from.
1820
3676
 
1821
3677
        :param scope: A specific config to start from.
1822
3678
        """
 
3679
        # FIXME: scope should allow access to plugin-specific stacks (even
 
3680
        # reduced to the plugin-specific store), related to
 
3681
        # http://pad.lv/788991 -- vila 2011-11-15
1823
3682
        if scope is not None:
1824
3683
            if scope == 'bazaar':
1825
 
                yield GlobalConfig()
 
3684
                return GlobalStack()
1826
3685
            elif scope == 'locations':
1827
 
                yield LocationConfig(directory)
 
3686
                return LocationStack(directory)
1828
3687
            elif scope == 'branch':
1829
 
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
1830
 
                    directory)
1831
 
                yield br.get_config()
 
3688
                (_, br, _) = (
 
3689
                    controldir.ControlDir.open_containing_tree_or_branch(
 
3690
                        directory))
 
3691
                return br.get_config_stack()
 
3692
            raise errors.NoSuchConfig(scope)
1832
3693
        else:
1833
3694
            try:
1834
 
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
1835
 
                    directory)
1836
 
                yield br.get_config()
 
3695
                (_, br, _) = (
 
3696
                    controldir.ControlDir.open_containing_tree_or_branch(
 
3697
                        directory))
 
3698
                return br.get_config_stack()
1837
3699
            except errors.NotBranchError:
1838
 
                yield LocationConfig(directory)
1839
 
                yield GlobalConfig()
1840
 
 
1841
 
    def _show_config(self, matching, directory):
1842
 
        # Turn the glob into a regexp
1843
 
        matching_re = re.compile(fnmatch.translate(matching))
1844
 
        cur_conf_id = None
1845
 
        for c in self._get_configs(directory):
1846
 
            for (name, value, section, conf_id) in c._get_options():
1847
 
                if matching_re.search(name):
1848
 
                    if cur_conf_id != conf_id:
1849
 
                        self.outf.write('%s:\n' % (conf_id,))
1850
 
                        cur_conf_id = conf_id
1851
 
                    self.outf.write('  %s = %s\n' % (name, value))
 
3700
                return LocationStack(directory)
 
3701
 
 
3702
    def _show_value(self, name, directory, scope):
 
3703
        conf = self._get_stack(directory, scope)
 
3704
        value = conf.get(name, expand=True)
 
3705
        if value is not None:
 
3706
            # Quote the value appropriately
 
3707
            value = _quoting_config._quote(value)
 
3708
            self.outf.write('%s\n' % (value,))
 
3709
        else:
 
3710
            raise errors.NoSuchConfigOption(name)
 
3711
 
 
3712
    def _show_matching_options(self, name, directory, scope):
 
3713
        name = lazy_regex.lazy_compile(name)
 
3714
        # We want any error in the regexp to be raised *now* so we need to
 
3715
        # avoid the delay introduced by the lazy regexp.  But, we still do
 
3716
        # want the nicer errors raised by lazy_regex.
 
3717
        name._compile_and_collapse()
 
3718
        cur_store_id = None
 
3719
        cur_section = None
 
3720
        conf = self._get_stack(directory, scope)
 
3721
        for sections in conf.sections_def:
 
3722
            for store, section in sections():
 
3723
                for oname in section.iter_option_names():
 
3724
                    if name.search(oname):
 
3725
                        if cur_store_id != store.id:
 
3726
                            # Explain where the options are defined
 
3727
                            self.outf.write('%s:\n' % (store.id,))
 
3728
                            cur_store_id = store.id
 
3729
                            cur_section = None
 
3730
                        if (section.id not in (None, 'DEFAULT')
 
3731
                            and cur_section != section.id):
 
3732
                            # Display the section if it's not the default (or
 
3733
                            # only) one.
 
3734
                            self.outf.write('  [%s]\n' % (section.id,))
 
3735
                            cur_section = section.id
 
3736
                        value = section.get(oname, expand=False)
 
3737
                        value = _quoting_config._quote(value)
 
3738
                        self.outf.write('  %s = %s\n' % (oname, value))
1852
3739
 
1853
3740
    def _set_config_option(self, name, value, directory, scope):
1854
 
        for conf in self._get_configs(directory, scope):
1855
 
            conf.set_user_option(name, value)
1856
 
            break
1857
 
        else:
1858
 
            raise errors.NoSuchConfig(scope)
 
3741
        conf = self._get_stack(directory, scope)
 
3742
        conf.set(name, value)
1859
3743
 
1860
3744
    def _remove_config_option(self, name, directory, scope):
1861
 
        removed = False
1862
 
        for conf in self._get_configs(directory, scope):
1863
 
            for (section_name, section, conf_id) in conf._get_sections():
1864
 
                if scope is not None and conf_id != scope:
1865
 
                    # Not the right configuration file
1866
 
                    continue
1867
 
                if name in section:
1868
 
                    if conf_id != conf.config_id():
1869
 
                        conf = self._get_configs(directory, conf_id).next()
1870
 
                    # We use the first section in the first config where the
1871
 
                    # option is defined to remove it
1872
 
                    conf.remove_user_option(name, section_name)
1873
 
                    removed = True
1874
 
                    break
1875
 
            break
1876
 
        else:
1877
 
            raise errors.NoSuchConfig(scope)
1878
 
        if not removed:
 
3745
        if name is None:
 
3746
            raise errors.BzrCommandError(
 
3747
                '--remove expects an option to remove.')
 
3748
        conf = self._get_stack(directory, scope)
 
3749
        try:
 
3750
            conf.remove(name)
 
3751
        except KeyError:
1879
3752
            raise errors.NoSuchConfigOption(name)
 
3753
 
 
3754
 
 
3755
# Test registries
 
3756
#
 
3757
# We need adapters that can build a Store or a Stack in a test context. Test
 
3758
# classes, based on TestCaseWithTransport, can use the registry to parametrize
 
3759
# themselves. The builder will receive a test instance and should return a
 
3760
# ready-to-use store or stack.  Plugins that define new store/stacks can also
 
3761
# register themselves here to be tested against the tests defined in
 
3762
# bzrlib.tests.test_config. Note that the builder can be called multiple times
 
3763
# for the same test.
 
3764
 
 
3765
# The registered object should be a callable receiving a test instance
 
3766
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
 
3767
# object.
 
3768
test_store_builder_registry = registry.Registry()
 
3769
 
 
3770
# The registered object should be a callable receiving a test instance
 
3771
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
 
3772
# object.
 
3773
test_stack_builder_registry = registry.Registry()