/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Patch Queue Manager
  • Date: 2011-12-14 21:50:54 UTC
  • mfrom: (6282.6.43 hpss-get-inventories)
  • Revision ID: pqm@pqm.ubuntu.com-20111214215054-kbzhlka9gtbd4zd7
(jelmer) Add HPSS call for retrieving inventories. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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