/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

Convert more stuff to use config stacks.

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