← 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-19 13:23:58 UTC
  • mto: This revision was merged to the branch mainline in revision 6386.
  • Revision ID: jelmer@canonical.com-20111219132358-uvs5a6y92gomzacd
Move importing from future until after doc string, otherwise the doc string will disappear.

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