/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

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