/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-27 21:59:34 UTC
  • mto: This revision was merged to the branch mainline in revision 6452.
  • Revision ID: jelmer@samba.org-20120127215934-d5lupaxico234zn6
Convert 'suppress_warnings' option to config stacks.

Show diffs side-by-side

added added

removed removed

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