/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Jelmer Vernooij
  • Date: 2011-12-18 15:43:47 UTC
  • mto: This revision was merged to the branch mainline in revision 6383.
  • Revision ID: jelmer@samba.org-20111218154347-d42sxp2qzn36uo2r
Add urlutils.quote / urlutils.unquote.

Show diffs side-by-side

added added

removed removed

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