← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Alexander Belchenko
  • Date: 2012-02-29 12:35:23 UTC
  • mto: (6437.23.21 2.5)
  • mto: This revision was merged to the branch mainline in revision 6493.
  • Revision ID: bialix@ukr.net-20120229123523-giercg9s8ck7ufg1
Standalone bzr.exe includes QtTest library from PyQt4 framework that required for QBzr tests. (Alexander Belchenko, #928963)

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')
790
1482
        value = self._get_explicit_nickname()
791
1483
        if value is not None:
792
1484
            return value
 
1485
        if self.branch.name:
 
1486
            return self.branch.name
793
1487
        return urlutils.unescape(self.branch.base.split('/')[-2])
794
1488
 
795
1489
    def has_explicit_nickname(self):
803
1497
        """See Config.log_format."""
804
1498
        return self._get_best_value('_log_format')
805
1499
 
 
1500
    def _validate_signatures_in_log(self):
 
1501
        """See Config.validate_signatures_in_log."""
 
1502
        return self._get_best_value('_validate_signatures_in_log')
 
1503
 
 
1504
    def _acceptable_keys(self):
 
1505
        """See Config.acceptable_keys."""
 
1506
        return self._get_best_value('_acceptable_keys')
 
1507
 
806
1508
 
807
1509
def ensure_config_dir_exists(path=None):
808
1510
    """Make sure a configuration directory exists.
817
1519
            parent_dir = os.path.dirname(path)
818
1520
            if not os.path.isdir(parent_dir):
819
1521
                trace.mutter('creating config parent directory: %r', parent_dir)
820
 
            os.mkdir(parent_dir)
 
1522
                os.mkdir(parent_dir)
821
1523
        trace.mutter('creating config directory: %r', path)
822
1524
        os.mkdir(path)
823
1525
        osutils.copy_ownership_from_path(path)
824
1526
 
825
1527
 
826
1528
def config_dir():
827
 
    """Return per-user configuration directory.
 
1529
    """Return per-user configuration directory as unicode string
828
1530
 
829
 
    By default this is ~/.bazaar/
 
1531
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
 
1532
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
 
1533
    that will be used instead.
830
1534
 
831
1535
    TODO: Global option --config-dir to override this.
832
1536
    """
833
 
    base = os.environ.get('BZR_HOME', None)
 
1537
    base = osutils.path_from_environ('BZR_HOME')
834
1538
    if sys.platform == 'win32':
835
1539
        if base is None:
836
 
            base = win32utils.get_appdata_location_unicode()
837
 
        if base is None:
838
 
            base = os.environ.get('HOME', None)
839
 
        if base is None:
840
 
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
841
 
                                  ' or HOME set')
 
1540
            base = win32utils.get_appdata_location()
 
1541
        if base is None:
 
1542
            base = win32utils.get_home_location()
 
1543
        # GZ 2012-02-01: Really the two level subdirs only make sense inside
 
1544
        #                APPDATA, but hard to move. See bug 348640 for more.
842
1545
        return osutils.pathjoin(base, 'bazaar', '2.0')
843
 
    else:
844
 
        # cygwin, linux, and darwin all have a $HOME directory
845
 
        if base is None:
846
 
            base = os.path.expanduser("~")
847
 
        return osutils.pathjoin(base, ".bazaar")
 
1546
    if base is None:
 
1547
        # GZ 2012-02-01: What should OSX use instead of XDG if anything?
 
1548
        if sys.platform != 'darwin':
 
1549
            xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
 
1550
            if xdg_dir is None:
 
1551
                xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
 
1552
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
 
1553
            if osutils.isdir(xdg_dir):
 
1554
                trace.mutter(
 
1555
                    "Using configuration in XDG directory %s." % xdg_dir)
 
1556
                return xdg_dir
 
1557
        base = osutils._get_home_dir()
 
1558
    return osutils.pathjoin(base, ".bazaar")
848
1559
 
849
1560
 
850
1561
def config_filename():
852
1563
    return osutils.pathjoin(config_dir(), 'bazaar.conf')
853
1564
 
854
1565
 
855
 
def branches_config_filename():
856
 
    """Return per-user configuration ini file filename."""
857
 
    return osutils.pathjoin(config_dir(), 'branches.conf')
858
 
 
859
 
 
860
1566
def locations_config_filename():
861
1567
    """Return per-user configuration ini file filename."""
862
1568
    return osutils.pathjoin(config_dir(), 'locations.conf')
899
1605
        return os.path.expanduser('~/.cache')
900
1606
 
901
1607
 
 
1608
def _get_default_mail_domain():
 
1609
    """If possible, return the assumed default email domain.
 
1610
 
 
1611
    :returns: string mail domain, or None.
 
1612
    """
 
1613
    if sys.platform == 'win32':
 
1614
        # No implementation yet; patches welcome
 
1615
        return None
 
1616
    try:
 
1617
        f = open('/etc/mailname')
 
1618
    except (IOError, OSError), e:
 
1619
        return None
 
1620
    try:
 
1621
        domain = f.read().strip()
 
1622
        return domain
 
1623
    finally:
 
1624
        f.close()
 
1625
 
 
1626
 
 
1627
def default_email():
 
1628
    v = os.environ.get('BZR_EMAIL')
 
1629
    if v:
 
1630
        return v.decode(osutils.get_user_encoding())
 
1631
    v = os.environ.get('EMAIL')
 
1632
    if v:
 
1633
        return v.decode(osutils.get_user_encoding())
 
1634
    name, email = _auto_user_id()
 
1635
    if name and email:
 
1636
        return u'%s <%s>' % (name, email)
 
1637
    elif email:
 
1638
        return email
 
1639
    raise errors.NoWhoami()
 
1640
 
 
1641
 
902
1642
def _auto_user_id():
903
1643
    """Calculate automatic user identification.
904
1644
 
905
 
    Returns (realname, email).
 
1645
    :returns: (realname, email), either of which may be None if they can't be
 
1646
    determined.
906
1647
 
907
1648
    Only used when none is set in the environment or the id file.
908
1649
 
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.
 
1650
    This only returns an email address if we can be fairly sure the 
 
1651
    address is reasonable, ie if /etc/mailname is set on unix.
 
1652
 
 
1653
    This doesn't use the FQDN as the default domain because that may be 
 
1654
    slow, and it doesn't use the hostname alone because that's not normally 
 
1655
    a reasonable address.
912
1656
    """
913
 
    import socket
914
 
 
915
1657
    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())
 
1658
        # No implementation to reliably determine Windows default mail
 
1659
        # address; please add one.
 
1660
        return None, None
 
1661
 
 
1662
    default_mail_domain = _get_default_mail_domain()
 
1663
    if not default_mail_domain:
 
1664
        return None, None
 
1665
 
 
1666
    import pwd
 
1667
    uid = os.getuid()
 
1668
    try:
 
1669
        w = pwd.getpwuid(uid)
 
1670
    except KeyError:
 
1671
        trace.mutter('no passwd entry for uid %d?' % uid)
 
1672
        return None, None
 
1673
 
 
1674
    # we try utf-8 first, because on many variants (like Linux),
 
1675
    # /etc/passwd "should" be in utf-8, and because it's unlikely to give
 
1676
    # false positives.  (many users will have their user encoding set to
 
1677
    # latin-1, which cannot raise UnicodeError.)
 
1678
    try:
 
1679
        gecos = w.pw_gecos.decode('utf-8')
 
1680
        encoding = 'utf-8'
 
1681
    except UnicodeError:
 
1682
        try:
 
1683
            encoding = osutils.get_user_encoding()
 
1684
            gecos = w.pw_gecos.decode(encoding)
 
1685
        except UnicodeError, e:
 
1686
            trace.mutter("cannot decode passwd entry %s" % w)
 
1687
            return None, None
 
1688
    try:
 
1689
        username = w.pw_name.decode(encoding)
 
1690
    except UnicodeError, e:
 
1691
        trace.mutter("cannot decode passwd entry %s" % w)
 
1692
        return None, None
 
1693
 
 
1694
    comma = gecos.find(',')
 
1695
    if comma == -1:
 
1696
        realname = gecos
 
1697
    else:
 
1698
        realname = gecos[:comma]
 
1699
 
 
1700
    return realname, (username + '@' + default_mail_domain)
973
1701
 
974
1702
 
975
1703
def parse_username(username):
1020
1748
 
1021
1749
    def set_option(self, value, name, section=None):
1022
1750
        """Set a per-branch configuration option"""
 
1751
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1752
        # higher levels providing the right lock -- vila 20101004
1023
1753
        self.branch.lock_write()
1024
1754
        try:
1025
1755
            self._config.set_option(value, name, section)
1026
1756
        finally:
1027
1757
            self.branch.unlock()
1028
1758
 
 
1759
    def remove_option(self, option_name, section_name=None):
 
1760
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1761
        # higher levels providing the right lock -- vila 20101004
 
1762
        self.branch.lock_write()
 
1763
        try:
 
1764
            self._config.remove_option(option_name, section_name)
 
1765
        finally:
 
1766
            self.branch.unlock()
 
1767
 
1029
1768
 
1030
1769
class AuthenticationConfig(object):
1031
1770
    """The authentication configuration file based on a ini file.
1057
1796
            self._config = ConfigObj(self._input, encoding='utf-8')
1058
1797
        except configobj.ConfigObjError, e:
1059
1798
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
1799
        except UnicodeError:
 
1800
            raise errors.ConfigContentError(self._filename)
1060
1801
        return self._config
1061
1802
 
1062
1803
    def _save(self):
1063
1804
        """Save the config file, only tests should use it for now."""
1064
1805
        conf_dir = os.path.dirname(self._filename)
1065
1806
        ensure_config_dir_exists(conf_dir)
1066
 
        self._get_config().write(file(self._filename, 'wb'))
 
1807
        f = file(self._filename, 'wb')
 
1808
        try:
 
1809
            self._get_config().write(f)
 
1810
        finally:
 
1811
            f.close()
1067
1812
 
1068
1813
    def _set_option(self, section_name, option_name, value):
1069
1814
        """Set an authentication configuration option"""
1075
1820
        section[option_name] = value
1076
1821
        self._save()
1077
1822
 
1078
 
    def get_credentials(self, scheme, host, port=None, user=None, path=None, 
 
1823
    def get_credentials(self, scheme, host, port=None, user=None, path=None,
1079
1824
                        realm=None):
1080
1825
        """Returns the matching credentials from authentication.conf file.
1081
1826
 
1088
1833
        :param user: login (optional)
1089
1834
 
1090
1835
        :param path: the absolute path on the server (optional)
1091
 
        
 
1836
 
1092
1837
        :param realm: the http authentication realm (optional)
1093
1838
 
1094
1839
        :return: A dict containing the matching credentials or None.
1249
1994
            if ask:
1250
1995
                if prompt is None:
1251
1996
                    # Create a default prompt suitable for most cases
1252
 
                    prompt = scheme.upper() + ' %(host)s username'
 
1997
                    prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1253
1998
                # Special handling for optional fields in the prompt
1254
1999
                if port is not None:
1255
2000
                    prompt_host = '%s:%d' % (host, port)
1293
2038
        if password is None:
1294
2039
            if prompt is None:
1295
2040
                # Create a default prompt suitable for most cases
1296
 
                prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
 
2041
                prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
1297
2042
            # Special handling for optional fields in the prompt
1298
2043
            if port is not None:
1299
2044
                prompt_host = '%s:%d' % (host, port)
1470
2215
    """A Config that reads/writes a config file on a Transport.
1471
2216
 
1472
2217
    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.
 
2218
    that may be associated with a section.  Assigning meaning to these values
 
2219
    is done at higher levels like TreeConfig.
1475
2220
    """
1476
2221
 
1477
2222
    def __init__(self, transport, filename):
1494
2239
                section_obj = configobj[section]
1495
2240
            except KeyError:
1496
2241
                return default
1497
 
        return section_obj.get(name, default)
 
2242
        value = section_obj.get(name, default)
 
2243
        for hook in OldConfigHooks['get']:
 
2244
            hook(self, name, value)
 
2245
        return value
1498
2246
 
1499
2247
    def set_option(self, value, name, section=None):
1500
2248
        """Set the value associated with a named option.
1508
2256
            configobj[name] = value
1509
2257
        else:
1510
2258
            configobj.setdefault(section, {})[name] = value
 
2259
        for hook in OldConfigHooks['set']:
 
2260
            hook(self, name, value)
 
2261
        self._set_configobj(configobj)
 
2262
 
 
2263
    def remove_option(self, option_name, section_name=None):
 
2264
        configobj = self._get_configobj()
 
2265
        if section_name is None:
 
2266
            del configobj[option_name]
 
2267
        else:
 
2268
            del configobj[section_name][option_name]
 
2269
        for hook in OldConfigHooks['remove']:
 
2270
            hook(self, option_name)
1511
2271
        self._set_configobj(configobj)
1512
2272
 
1513
2273
    def _get_config_file(self):
1514
2274
        try:
1515
 
            return StringIO(self._transport.get_bytes(self._filename))
 
2275
            f = StringIO(self._transport.get_bytes(self._filename))
 
2276
            for hook in OldConfigHooks['load']:
 
2277
                hook(self)
 
2278
            return f
1516
2279
        except errors.NoSuchFile:
1517
2280
            return StringIO()
 
2281
        except errors.PermissionDenied, e:
 
2282
            trace.warning("Permission denied while trying to open "
 
2283
                "configuration file %s.", urlutils.unescape_for_display(
 
2284
                urlutils.join(self._transport.base, self._filename), "utf-8"))
 
2285
            return StringIO()
 
2286
 
 
2287
    def _external_url(self):
 
2288
        return urlutils.join(self._transport.external_url(), self._filename)
1518
2289
 
1519
2290
    def _get_configobj(self):
1520
 
        return ConfigObj(self._get_config_file(), encoding='utf-8')
 
2291
        f = self._get_config_file()
 
2292
        try:
 
2293
            try:
 
2294
                conf = ConfigObj(f, encoding='utf-8')
 
2295
            except configobj.ConfigObjError, e:
 
2296
                raise errors.ParseConfigError(e.errors, self._external_url())
 
2297
            except UnicodeDecodeError:
 
2298
                raise errors.ConfigContentError(self._external_url())
 
2299
        finally:
 
2300
            f.close()
 
2301
        return conf
1521
2302
 
1522
2303
    def _set_configobj(self, configobj):
1523
2304
        out_file = StringIO()
1524
2305
        configobj.write(out_file)
1525
2306
        out_file.seek(0)
1526
2307
        self._transport.put_file(self._filename, out_file)
 
2308
        for hook in OldConfigHooks['save']:
 
2309
            hook(self)
 
2310
 
 
2311
 
 
2312
class Option(object):
 
2313
    """An option definition.
 
2314
 
 
2315
    The option *values* are stored in config files and found in sections.
 
2316
 
 
2317
    Here we define various properties about the option itself, its default
 
2318
    value, how to convert it from stores, what to do when invalid values are
 
2319
    encoutered, in which config files it can be stored.
 
2320
    """
 
2321
 
 
2322
    def __init__(self, name, override_from_env=None,
 
2323
                 default=None, default_from_env=None,
 
2324
                 help=None, from_unicode=None, invalid=None, unquote=True):
 
2325
        """Build an option definition.
 
2326
 
 
2327
        :param name: the name used to refer to the option.
 
2328
 
 
2329
        :param override_from_env: A list of environment variables which can
 
2330
           provide override any configuration setting.
 
2331
 
 
2332
        :param default: the default value to use when none exist in the config
 
2333
            stores. This is either a string that ``from_unicode`` will convert
 
2334
            into the proper type, a callable returning a unicode string so that
 
2335
            ``from_unicode`` can be used on the return value, or a python
 
2336
            object that can be stringified (so only the empty list is supported
 
2337
            for example).
 
2338
 
 
2339
        :param default_from_env: A list of environment variables which can
 
2340
           provide a default value. 'default' will be used only if none of the
 
2341
           variables specified here are set in the environment.
 
2342
 
 
2343
        :param help: a doc string to explain the option to the user.
 
2344
 
 
2345
        :param from_unicode: a callable to convert the unicode string
 
2346
            representing the option value in a store. This is not called for
 
2347
            the default value.
 
2348
 
 
2349
        :param invalid: the action to be taken when an invalid value is
 
2350
            encountered in a store. This is called only when from_unicode is
 
2351
            invoked to convert a string and returns None or raise ValueError or
 
2352
            TypeError. Accepted values are: None (ignore invalid values),
 
2353
            'warning' (emit a warning), 'error' (emit an error message and
 
2354
            terminates).
 
2355
 
 
2356
        :param unquote: should the unicode value be unquoted before conversion.
 
2357
           This should be used only when the store providing the values cannot
 
2358
           safely unquote them (see http://pad.lv/906897). It is provided so
 
2359
           daughter classes can handle the quoting themselves.
 
2360
        """
 
2361
        if override_from_env is None:
 
2362
            override_from_env = []
 
2363
        if default_from_env is None:
 
2364
            default_from_env = []
 
2365
        self.name = name
 
2366
        self.override_from_env = override_from_env
 
2367
        # Convert the default value to a unicode string so all values are
 
2368
        # strings internally before conversion (via from_unicode) is attempted.
 
2369
        if default is None:
 
2370
            self.default = None
 
2371
        elif isinstance(default, list):
 
2372
            # Only the empty list is supported
 
2373
            if default:
 
2374
                raise AssertionError(
 
2375
                    'Only empty lists are supported as default values')
 
2376
            self.default = u','
 
2377
        elif isinstance(default, (str, unicode, bool, int, float)):
 
2378
            # Rely on python to convert strings, booleans and integers
 
2379
            self.default = u'%s' % (default,)
 
2380
        elif callable(default):
 
2381
            self.default = default
 
2382
        else:
 
2383
            # other python objects are not expected
 
2384
            raise AssertionError('%r is not supported as a default value'
 
2385
                                 % (default,))
 
2386
        self.default_from_env = default_from_env
 
2387
        self.help = help
 
2388
        self.from_unicode = from_unicode
 
2389
        self.unquote = unquote
 
2390
        if invalid and invalid not in ('warning', 'error'):
 
2391
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
 
2392
        self.invalid = invalid
 
2393
 
 
2394
    def convert_from_unicode(self, store, unicode_value):
 
2395
        if self.unquote and store is not None and unicode_value is not None:
 
2396
            unicode_value = store.unquote(unicode_value)
 
2397
        if self.from_unicode is None or unicode_value is None:
 
2398
            # Don't convert or nothing to convert
 
2399
            return unicode_value
 
2400
        try:
 
2401
            converted = self.from_unicode(unicode_value)
 
2402
        except (ValueError, TypeError):
 
2403
            # Invalid values are ignored
 
2404
            converted = None
 
2405
        if converted is None and self.invalid is not None:
 
2406
            # The conversion failed
 
2407
            if self.invalid == 'warning':
 
2408
                trace.warning('Value "%s" is not valid for "%s"',
 
2409
                              unicode_value, self.name)
 
2410
            elif self.invalid == 'error':
 
2411
                raise errors.ConfigOptionValueError(self.name, unicode_value)
 
2412
        return converted
 
2413
 
 
2414
    def get_override(self):
 
2415
        value = None
 
2416
        for var in self.override_from_env:
 
2417
            try:
 
2418
                # If the env variable is defined, its value takes precedence
 
2419
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2420
                break
 
2421
            except KeyError:
 
2422
                continue
 
2423
        return value
 
2424
 
 
2425
    def get_default(self):
 
2426
        value = None
 
2427
        for var in self.default_from_env:
 
2428
            try:
 
2429
                # If the env variable is defined, its value is the default one
 
2430
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2431
                break
 
2432
            except KeyError:
 
2433
                continue
 
2434
        if value is None:
 
2435
            # Otherwise, fallback to the value defined at registration
 
2436
            if callable(self.default):
 
2437
                value = self.default()
 
2438
                if not isinstance(value, unicode):
 
2439
                    raise AssertionError(
 
2440
                    'Callable default values should be unicode')
 
2441
            else:
 
2442
                value = self.default
 
2443
        return value
 
2444
 
 
2445
    def get_help_text(self, additional_see_also=None, plain=True):
 
2446
        result = self.help
 
2447
        from bzrlib import help_topics
 
2448
        result += help_topics._format_see_also(additional_see_also)
 
2449
        if plain:
 
2450
            result = help_topics.help_as_plain_text(result)
 
2451
        return result
 
2452
 
 
2453
 
 
2454
# Predefined converters to get proper values from store
 
2455
 
 
2456
def bool_from_store(unicode_str):
 
2457
    return ui.bool_from_string(unicode_str)
 
2458
 
 
2459
 
 
2460
def int_from_store(unicode_str):
 
2461
    return int(unicode_str)
 
2462
 
 
2463
 
 
2464
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
 
2465
 
 
2466
def int_SI_from_store(unicode_str):
 
2467
    """Convert a human readable size in SI units, e.g 10MB into an integer.
 
2468
 
 
2469
    Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
2470
    by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
2471
    pedantic.
 
2472
 
 
2473
    :return Integer, expanded to its base-10 value if a proper SI unit is 
 
2474
        found, None otherwise.
 
2475
    """
 
2476
    regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
 
2477
    p = re.compile(regexp, re.IGNORECASE)
 
2478
    m = p.match(unicode_str)
 
2479
    val = None
 
2480
    if m is not None:
 
2481
        val, _, unit = m.groups()
 
2482
        val = int(val)
 
2483
        if unit:
 
2484
            try:
 
2485
                coeff = _unit_suffixes[unit.upper()]
 
2486
            except KeyError:
 
2487
                raise ValueError(gettext('{0} is not an SI unit.').format(unit))
 
2488
            val *= coeff
 
2489
    return val
 
2490
 
 
2491
 
 
2492
def float_from_store(unicode_str):
 
2493
    return float(unicode_str)
 
2494
 
 
2495
 
 
2496
# Use a an empty dict to initialize an empty configobj avoiding all
 
2497
# parsing and encoding checks
 
2498
_list_converter_config = configobj.ConfigObj(
 
2499
    {}, encoding='utf-8', list_values=True, interpolation=False)
 
2500
 
 
2501
 
 
2502
class ListOption(Option):
 
2503
 
 
2504
    def __init__(self, name, default=None, default_from_env=None,
 
2505
                 help=None, invalid=None):
 
2506
        """A list Option definition.
 
2507
 
 
2508
        This overrides the base class so the conversion from a unicode string
 
2509
        can take quoting into account.
 
2510
        """
 
2511
        super(ListOption, self).__init__(
 
2512
            name, default=default, default_from_env=default_from_env,
 
2513
            from_unicode=self.from_unicode, help=help,
 
2514
            invalid=invalid, unquote=False)
 
2515
 
 
2516
    def from_unicode(self, unicode_str):
 
2517
        if not isinstance(unicode_str, basestring):
 
2518
            raise TypeError
 
2519
        # Now inject our string directly as unicode. All callers got their
 
2520
        # value from configobj, so values that need to be quoted are already
 
2521
        # properly quoted.
 
2522
        _list_converter_config.reset()
 
2523
        _list_converter_config._parse([u"list=%s" % (unicode_str,)])
 
2524
        maybe_list = _list_converter_config['list']
 
2525
        if isinstance(maybe_list, basestring):
 
2526
            if maybe_list:
 
2527
                # A single value, most probably the user forgot (or didn't care
 
2528
                # to add) the final ','
 
2529
                l = [maybe_list]
 
2530
            else:
 
2531
                # The empty string, convert to empty list
 
2532
                l = []
 
2533
        else:
 
2534
            # We rely on ConfigObj providing us with a list already
 
2535
            l = maybe_list
 
2536
        return l
 
2537
 
 
2538
 
 
2539
class OptionRegistry(registry.Registry):
 
2540
    """Register config options by their name.
 
2541
 
 
2542
    This overrides ``registry.Registry`` to simplify registration by acquiring
 
2543
    some information from the option object itself.
 
2544
    """
 
2545
 
 
2546
    def register(self, option):
 
2547
        """Register a new option to its name.
 
2548
 
 
2549
        :param option: The option to register. Its name is used as the key.
 
2550
        """
 
2551
        super(OptionRegistry, self).register(option.name, option,
 
2552
                                             help=option.help)
 
2553
 
 
2554
    def register_lazy(self, key, module_name, member_name):
 
2555
        """Register a new option to be loaded on request.
 
2556
 
 
2557
        :param key: the key to request the option later. Since the registration
 
2558
            is lazy, it should be provided and match the option name.
 
2559
 
 
2560
        :param module_name: the python path to the module. Such as 'os.path'.
 
2561
 
 
2562
        :param member_name: the member of the module to return.  If empty or 
 
2563
                None, get() will return the module itself.
 
2564
        """
 
2565
        super(OptionRegistry, self).register_lazy(key,
 
2566
                                                  module_name, member_name)
 
2567
 
 
2568
    def get_help(self, key=None):
 
2569
        """Get the help text associated with the given key"""
 
2570
        option = self.get(key)
 
2571
        the_help = option.help
 
2572
        if callable(the_help):
 
2573
            return the_help(self, key)
 
2574
        return the_help
 
2575
 
 
2576
 
 
2577
option_registry = OptionRegistry()
 
2578
 
 
2579
 
 
2580
# Registered options in lexicographical order
 
2581
 
 
2582
option_registry.register(
 
2583
    Option('append_revisions_only',
 
2584
           default=None, from_unicode=bool_from_store, invalid='warning',
 
2585
           help='''\
 
2586
Whether to only append revisions to the mainline.
 
2587
 
 
2588
If this is set to true, then it is not possible to change the
 
2589
existing mainline of the branch.
 
2590
'''))
 
2591
option_registry.register(
 
2592
    ListOption('acceptable_keys',
 
2593
           default=None,
 
2594
           help="""\
 
2595
List of GPG key patterns which are acceptable for verification.
 
2596
"""))
 
2597
option_registry.register(
 
2598
    Option('add.maximum_file_size',
 
2599
           default=u'20MB', from_unicode=int_SI_from_store,
 
2600
           help="""\
 
2601
Size above which files should be added manually.
 
2602
 
 
2603
Files below this size are added automatically when using ``bzr add`` without
 
2604
arguments.
 
2605
 
 
2606
A negative value means disable the size check.
 
2607
"""))
 
2608
option_registry.register(
 
2609
    Option('bound',
 
2610
           default=None, from_unicode=bool_from_store,
 
2611
           help="""\
 
2612
Is the branch bound to ``bound_location``.
 
2613
 
 
2614
If set to "True", the branch should act as a checkout, and push each commit to
 
2615
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
2616
 
 
2617
See also: bound_location.
 
2618
"""))
 
2619
option_registry.register(
 
2620
    Option('bound_location',
 
2621
           default=None,
 
2622
           help="""\
 
2623
The location that commits should go to when acting as a checkout.
 
2624
 
 
2625
This option is normally set by ``bind``.
 
2626
 
 
2627
See also: bound.
 
2628
"""))
 
2629
option_registry.register(
 
2630
    Option('branch.fetch_tags', default=False,  from_unicode=bool_from_store,
 
2631
           help="""\
 
2632
Whether revisions associated with tags should be fetched.
 
2633
"""))
 
2634
option_registry.register(
 
2635
    Option('bzr.workingtree.worth_saving_limit', default=10,
 
2636
           from_unicode=int_from_store,  invalid='warning',
 
2637
           help='''\
 
2638
How many changes before saving the dirstate.
 
2639
 
 
2640
-1 means that we will never rewrite the dirstate file for only
 
2641
stat-cache changes. Regardless of this setting, we will always rewrite
 
2642
the dirstate file if a file is added/removed/renamed/etc. This flag only
 
2643
affects the behavior of updating the dirstate file after we notice that
 
2644
a file has been touched.
 
2645
'''))
 
2646
option_registry.register(
 
2647
    Option('check_signatures', default=CHECK_IF_POSSIBLE,
 
2648
           from_unicode=signature_policy_from_unicode,
 
2649
           help='''\
 
2650
GPG checking policy.
 
2651
 
 
2652
Possible values: require, ignore, check-available (default)
 
2653
 
 
2654
this option will control whether bzr will require good gpg
 
2655
signatures, ignore them, or check them if they are
 
2656
present.
 
2657
'''))
 
2658
option_registry.register(
 
2659
    Option('child_submit_format',
 
2660
           help='''The preferred format of submissions to this branch.'''))
 
2661
option_registry.register(
 
2662
    Option('child_submit_to',
 
2663
           help='''Where submissions to this branch are mailed to.'''))
 
2664
option_registry.register(
 
2665
    Option('create_signatures', default=SIGN_WHEN_REQUIRED,
 
2666
           from_unicode=signing_policy_from_unicode,
 
2667
           help='''\
 
2668
GPG Signing policy.
 
2669
 
 
2670
Possible values: always, never, when-required (default)
 
2671
 
 
2672
This option controls whether bzr will always create
 
2673
gpg signatures or not on commits.
 
2674
'''))
 
2675
option_registry.register(
 
2676
    Option('dirstate.fdatasync', default=True,
 
2677
           from_unicode=bool_from_store,
 
2678
           help='''\
 
2679
Flush dirstate changes onto physical disk?
 
2680
 
 
2681
If true (default), working tree metadata changes are flushed through the
 
2682
OS buffers to physical disk.  This is somewhat slower, but means data
 
2683
should not be lost if the machine crashes.  See also repository.fdatasync.
 
2684
'''))
 
2685
option_registry.register(
 
2686
    ListOption('debug_flags', default=[],
 
2687
           help='Debug flags to activate.'))
 
2688
option_registry.register(
 
2689
    Option('default_format', default='2a',
 
2690
           help='Format used when creating branches.'))
 
2691
option_registry.register(
 
2692
    Option('dpush_strict', default=None,
 
2693
           from_unicode=bool_from_store,
 
2694
           help='''\
 
2695
The default value for ``dpush --strict``.
 
2696
 
 
2697
If present, defines the ``--strict`` option default value for checking
 
2698
uncommitted changes before pushing into a different VCS without any
 
2699
custom bzr metadata.
 
2700
'''))
 
2701
option_registry.register(
 
2702
    Option('editor',
 
2703
           help='The command called to launch an editor to enter a message.'))
 
2704
option_registry.register(
 
2705
    Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
 
2706
           help='The users identity'))
 
2707
option_registry.register(
 
2708
    Option('gpg_signing_command',
 
2709
           default='gpg',
 
2710
           help="""\
 
2711
Program to use use for creating signatures.
 
2712
 
 
2713
This should support at least the -u and --clearsign options.
 
2714
"""))
 
2715
option_registry.register(
 
2716
    Option('gpg_signing_key',
 
2717
           default=None,
 
2718
           help="""\
 
2719
GPG key to use for signing.
 
2720
 
 
2721
This defaults to the first key associated with the users email.
 
2722
"""))
 
2723
option_registry.register(
 
2724
    Option('ignore_missing_extensions', default=False,
 
2725
           from_unicode=bool_from_store,
 
2726
           help='''\
 
2727
Control the missing extensions warning display.
 
2728
 
 
2729
The warning will not be emitted if set to True.
 
2730
'''))
 
2731
option_registry.register(
 
2732
    Option('language',
 
2733
           help='Language to translate messages into.'))
 
2734
option_registry.register(
 
2735
    Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
 
2736
           help='''\
 
2737
Steal locks that appears to be dead.
 
2738
 
 
2739
If set to True, bzr will check if a lock is supposed to be held by an
 
2740
active process from the same user on the same machine. If the user and
 
2741
machine match, but no process with the given PID is active, then bzr
 
2742
will automatically break the stale lock, and create a new lock for
 
2743
this process.
 
2744
Otherwise, bzr will prompt as normal to break the lock.
 
2745
'''))
 
2746
option_registry.register(
 
2747
    Option('log_format', default='long',
 
2748
           help= '''\
 
2749
Log format to use when displaying revisions.
 
2750
 
 
2751
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
 
2752
may be provided by plugins.
 
2753
'''))
 
2754
option_registry.register(
 
2755
    Option('output_encoding',
 
2756
           help= 'Unicode encoding for output'
 
2757
           ' (terminal encoding if not specified).'))
 
2758
option_registry.register(
 
2759
    Option('parent_location',
 
2760
           default=None,
 
2761
           help="""\
 
2762
The location of the default branch for pull or merge.
 
2763
 
 
2764
This option is normally set when creating a branch, the first ``pull`` or by
 
2765
``pull --remember``.
 
2766
"""))
 
2767
option_registry.register(
 
2768
    Option('post_commit', default=None,
 
2769
           help='''\
 
2770
Post commit functions.
 
2771
 
 
2772
An ordered list of python functions to call, separated by spaces.
 
2773
 
 
2774
Each function takes branch, rev_id as parameters.
 
2775
'''))
 
2776
option_registry.register(
 
2777
    Option('public_branch',
 
2778
           default=None,
 
2779
           help="""\
 
2780
A publically-accessible version of this branch.
 
2781
 
 
2782
This implies that the branch setting this option is not publically-accessible.
 
2783
Used and set by ``bzr send``.
 
2784
"""))
 
2785
option_registry.register(
 
2786
    Option('push_location',
 
2787
           default=None,
 
2788
           help="""\
 
2789
The location of the default branch for push.
 
2790
 
 
2791
This option is normally set by the first ``push`` or ``push --remember``.
 
2792
"""))
 
2793
option_registry.register(
 
2794
    Option('push_strict', default=None,
 
2795
           from_unicode=bool_from_store,
 
2796
           help='''\
 
2797
The default value for ``push --strict``.
 
2798
 
 
2799
If present, defines the ``--strict`` option default value for checking
 
2800
uncommitted changes before sending a merge directive.
 
2801
'''))
 
2802
option_registry.register(
 
2803
    Option('repository.fdatasync', default=True,
 
2804
           from_unicode=bool_from_store,
 
2805
           help='''\
 
2806
Flush repository changes onto physical disk?
 
2807
 
 
2808
If true (default), repository changes are flushed through the OS buffers
 
2809
to physical disk.  This is somewhat slower, but means data should not be
 
2810
lost if the machine crashes.  See also dirstate.fdatasync.
 
2811
'''))
 
2812
option_registry.register_lazy('smtp_server',
 
2813
    'bzrlib.smtp_connection', 'smtp_server')
 
2814
option_registry.register_lazy('smtp_password',
 
2815
    'bzrlib.smtp_connection', 'smtp_password')
 
2816
option_registry.register_lazy('smtp_username',
 
2817
    'bzrlib.smtp_connection', 'smtp_username')
 
2818
option_registry.register(
 
2819
    Option('selftest.timeout',
 
2820
        default='600',
 
2821
        from_unicode=int_from_store,
 
2822
        help='Abort selftest if one test takes longer than this many seconds',
 
2823
        ))
 
2824
 
 
2825
option_registry.register(
 
2826
    Option('send_strict', default=None,
 
2827
           from_unicode=bool_from_store,
 
2828
           help='''\
 
2829
The default value for ``send --strict``.
 
2830
 
 
2831
If present, defines the ``--strict`` option default value for checking
 
2832
uncommitted changes before sending a bundle.
 
2833
'''))
 
2834
 
 
2835
option_registry.register(
 
2836
    Option('serve.client_timeout',
 
2837
           default=300.0, from_unicode=float_from_store,
 
2838
           help="If we wait for a new request from a client for more than"
 
2839
                " X seconds, consider the client idle, and hangup."))
 
2840
option_registry.register(
 
2841
    Option('stacked_on_location',
 
2842
           default=None,
 
2843
           help="""The location where this branch is stacked on."""))
 
2844
option_registry.register(
 
2845
    Option('submit_branch',
 
2846
           default=None,
 
2847
           help="""\
 
2848
The branch you intend to submit your current work to.
 
2849
 
 
2850
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
 
2851
by the ``submit:`` revision spec.
 
2852
"""))
 
2853
option_registry.register(
 
2854
    Option('submit_to',
 
2855
           help='''Where submissions from this branch are mailed to.'''))
 
2856
 
 
2857
option_registry.register_lazy('ssl.ca_certs',
 
2858
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
 
2859
 
 
2860
option_registry.register_lazy('ssl.cert_reqs',
 
2861
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
 
2862
 
 
2863
 
 
2864
 
 
2865
class Section(object):
 
2866
    """A section defines a dict of option name => value.
 
2867
 
 
2868
    This is merely a read-only dict which can add some knowledge about the
 
2869
    options. It is *not* a python dict object though and doesn't try to mimic
 
2870
    its API.
 
2871
    """
 
2872
 
 
2873
    def __init__(self, section_id, options):
 
2874
        self.id = section_id
 
2875
        # We re-use the dict-like object received
 
2876
        self.options = options
 
2877
 
 
2878
    def get(self, name, default=None, expand=True):
 
2879
        return self.options.get(name, default)
 
2880
 
 
2881
    def iter_option_names(self):
 
2882
        for k in self.options.iterkeys():
 
2883
            yield k
 
2884
 
 
2885
    def __repr__(self):
 
2886
        # Mostly for debugging use
 
2887
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
 
2888
 
 
2889
 
 
2890
_NewlyCreatedOption = object()
 
2891
"""Was the option created during the MutableSection lifetime"""
 
2892
_DeletedOption = object()
 
2893
"""Was the option deleted during the MutableSection lifetime"""
 
2894
 
 
2895
 
 
2896
class MutableSection(Section):
 
2897
    """A section allowing changes and keeping track of the original values."""
 
2898
 
 
2899
    def __init__(self, section_id, options):
 
2900
        super(MutableSection, self).__init__(section_id, options)
 
2901
        self.reset_changes()
 
2902
 
 
2903
    def set(self, name, value):
 
2904
        if name not in self.options:
 
2905
            # This is a new option
 
2906
            self.orig[name] = _NewlyCreatedOption
 
2907
        elif name not in self.orig:
 
2908
            self.orig[name] = self.get(name, None)
 
2909
        self.options[name] = value
 
2910
 
 
2911
    def remove(self, name):
 
2912
        if name not in self.orig:
 
2913
            self.orig[name] = self.get(name, None)
 
2914
        del self.options[name]
 
2915
 
 
2916
    def reset_changes(self):
 
2917
        self.orig = {}
 
2918
 
 
2919
    def apply_changes(self, dirty, store):
 
2920
        """Apply option value changes.
 
2921
 
 
2922
        ``self`` has been reloaded from the persistent storage. ``dirty``
 
2923
        contains the changes made since the previous loading.
 
2924
 
 
2925
        :param dirty: the mutable section containing the changes.
 
2926
 
 
2927
        :param store: the store containing the section
 
2928
        """
 
2929
        for k, expected in dirty.orig.iteritems():
 
2930
            actual = dirty.get(k, _DeletedOption)
 
2931
            reloaded = self.get(k, _NewlyCreatedOption)
 
2932
            if actual is _DeletedOption:
 
2933
                if k in self.options:
 
2934
                    self.remove(k)
 
2935
            else:
 
2936
                self.set(k, actual)
 
2937
            # Report concurrent updates in an ad-hoc way. This should only
 
2938
            # occurs when different processes try to update the same option
 
2939
            # which is not supported (as in: the config framework is not meant
 
2940
            # to be used a sharing mechanism).
 
2941
            if expected != reloaded:
 
2942
                if actual is _DeletedOption:
 
2943
                    actual = '<DELETED>'
 
2944
                if reloaded is _NewlyCreatedOption:
 
2945
                    reloaded = '<CREATED>'
 
2946
                if expected is _NewlyCreatedOption:
 
2947
                    expected = '<CREATED>'
 
2948
                # Someone changed the value since we get it from the persistent
 
2949
                # storage.
 
2950
                trace.warning(gettext(
 
2951
                        "Option {0} in section {1} of {2} was changed"
 
2952
                        " from {3} to {4}. The {5} value will be saved.".format(
 
2953
                            k, self.id, store.external_url(), expected,
 
2954
                            reloaded, actual)))
 
2955
        # No need to keep track of these changes
 
2956
        self.reset_changes()
 
2957
 
 
2958
 
 
2959
class Store(object):
 
2960
    """Abstract interface to persistent storage for configuration options."""
 
2961
 
 
2962
    readonly_section_class = Section
 
2963
    mutable_section_class = MutableSection
 
2964
 
 
2965
    def __init__(self):
 
2966
        # Which sections need to be saved
 
2967
        self.dirty_sections = []
 
2968
 
 
2969
    def is_loaded(self):
 
2970
        """Returns True if the Store has been loaded.
 
2971
 
 
2972
        This is used to implement lazy loading and ensure the persistent
 
2973
        storage is queried only when needed.
 
2974
        """
 
2975
        raise NotImplementedError(self.is_loaded)
 
2976
 
 
2977
    def load(self):
 
2978
        """Loads the Store from persistent storage."""
 
2979
        raise NotImplementedError(self.load)
 
2980
 
 
2981
    def _load_from_string(self, bytes):
 
2982
        """Create a store from a string in configobj syntax.
 
2983
 
 
2984
        :param bytes: A string representing the file content.
 
2985
        """
 
2986
        raise NotImplementedError(self._load_from_string)
 
2987
 
 
2988
    def unload(self):
 
2989
        """Unloads the Store.
 
2990
 
 
2991
        This should make is_loaded() return False. This is used when the caller
 
2992
        knows that the persistent storage has changed or may have change since
 
2993
        the last load.
 
2994
        """
 
2995
        raise NotImplementedError(self.unload)
 
2996
 
 
2997
    def quote(self, value):
 
2998
        """Quote a configuration option value for storing purposes.
 
2999
 
 
3000
        This allows Stacks to present values as they will be stored.
 
3001
        """
 
3002
        return value
 
3003
 
 
3004
    def unquote(self, value):
 
3005
        """Unquote a configuration option value into unicode.
 
3006
 
 
3007
        The received value is quoted as stored.
 
3008
        """
 
3009
        return value
 
3010
 
 
3011
    def save(self):
 
3012
        """Saves the Store to persistent storage."""
 
3013
        raise NotImplementedError(self.save)
 
3014
 
 
3015
    def _need_saving(self):
 
3016
        for s in self.dirty_sections:
 
3017
            if s.orig:
 
3018
                # At least one dirty section contains a modification
 
3019
                return True
 
3020
        return False
 
3021
 
 
3022
    def apply_changes(self, dirty_sections):
 
3023
        """Apply changes from dirty sections while checking for coherency.
 
3024
 
 
3025
        The Store content is discarded and reloaded from persistent storage to
 
3026
        acquire up-to-date values.
 
3027
 
 
3028
        Dirty sections are MutableSection which kept track of the value they
 
3029
        are expected to update.
 
3030
        """
 
3031
        # We need an up-to-date version from the persistent storage, unload the
 
3032
        # store. The reload will occur when needed (triggered by the first
 
3033
        # get_mutable_section() call below.
 
3034
        self.unload()
 
3035
        # Apply the changes from the preserved dirty sections
 
3036
        for dirty in dirty_sections:
 
3037
            clean = self.get_mutable_section(dirty.id)
 
3038
            clean.apply_changes(dirty, self)
 
3039
        # Everything is clean now
 
3040
        self.dirty_sections = []
 
3041
 
 
3042
    def save_changes(self):
 
3043
        """Saves the Store to persistent storage if changes occurred.
 
3044
 
 
3045
        Apply the changes recorded in the mutable sections to a store content
 
3046
        refreshed from persistent storage.
 
3047
        """
 
3048
        raise NotImplementedError(self.save_changes)
 
3049
 
 
3050
    def external_url(self):
 
3051
        raise NotImplementedError(self.external_url)
 
3052
 
 
3053
    def get_sections(self):
 
3054
        """Returns an ordered iterable of existing sections.
 
3055
 
 
3056
        :returns: An iterable of (store, section).
 
3057
        """
 
3058
        raise NotImplementedError(self.get_sections)
 
3059
 
 
3060
    def get_mutable_section(self, section_id=None):
 
3061
        """Returns the specified mutable section.
 
3062
 
 
3063
        :param section_id: The section identifier
 
3064
        """
 
3065
        raise NotImplementedError(self.get_mutable_section)
 
3066
 
 
3067
    def __repr__(self):
 
3068
        # Mostly for debugging use
 
3069
        return "<config.%s(%s)>" % (self.__class__.__name__,
 
3070
                                    self.external_url())
 
3071
 
 
3072
 
 
3073
class CommandLineStore(Store):
 
3074
    "A store to carry command line overrides for the config options."""
 
3075
 
 
3076
    def __init__(self, opts=None):
 
3077
        super(CommandLineStore, self).__init__()
 
3078
        if opts is None:
 
3079
            opts = {}
 
3080
        self.options = {}
 
3081
        self.id = 'cmdline'
 
3082
 
 
3083
    def _reset(self):
 
3084
        # The dict should be cleared but not replaced so it can be shared.
 
3085
        self.options.clear()
 
3086
 
 
3087
    def _from_cmdline(self, overrides):
 
3088
        # Reset before accepting new definitions
 
3089
        self._reset()
 
3090
        for over in overrides:
 
3091
            try:
 
3092
                name, value = over.split('=', 1)
 
3093
            except ValueError:
 
3094
                raise errors.BzrCommandError(
 
3095
                    gettext("Invalid '%s', should be of the form 'name=value'")
 
3096
                    % (over,))
 
3097
            self.options[name] = value
 
3098
 
 
3099
    def external_url(self):
 
3100
        # Not an url but it makes debugging easier and is never needed
 
3101
        # otherwise
 
3102
        return 'cmdline'
 
3103
 
 
3104
    def get_sections(self):
 
3105
        yield self,  self.readonly_section_class(None, self.options)
 
3106
 
 
3107
 
 
3108
class IniFileStore(Store):
 
3109
    """A config Store using ConfigObj for storage.
 
3110
 
 
3111
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
 
3112
        serialize/deserialize the config file.
 
3113
    """
 
3114
 
 
3115
    def __init__(self):
 
3116
        """A config Store using ConfigObj for storage.
 
3117
        """
 
3118
        super(IniFileStore, self).__init__()
 
3119
        self._config_obj = None
 
3120
 
 
3121
    def is_loaded(self):
 
3122
        return self._config_obj != None
 
3123
 
 
3124
    def unload(self):
 
3125
        self._config_obj = None
 
3126
        self.dirty_sections = []
 
3127
 
 
3128
    def _load_content(self):
 
3129
        """Load the config file bytes.
 
3130
 
 
3131
        This should be provided by subclasses
 
3132
 
 
3133
        :return: Byte string
 
3134
        """
 
3135
        raise NotImplementedError(self._load_content)
 
3136
 
 
3137
    def _save_content(self, content):
 
3138
        """Save the config file bytes.
 
3139
 
 
3140
        This should be provided by subclasses
 
3141
 
 
3142
        :param content: Config file bytes to write
 
3143
        """
 
3144
        raise NotImplementedError(self._save_content)
 
3145
 
 
3146
    def load(self):
 
3147
        """Load the store from the associated file."""
 
3148
        if self.is_loaded():
 
3149
            return
 
3150
        content = self._load_content()
 
3151
        self._load_from_string(content)
 
3152
        for hook in ConfigHooks['load']:
 
3153
            hook(self)
 
3154
 
 
3155
    def _load_from_string(self, bytes):
 
3156
        """Create a config store from a string.
 
3157
 
 
3158
        :param bytes: A string representing the file content.
 
3159
        """
 
3160
        if self.is_loaded():
 
3161
            raise AssertionError('Already loaded: %r' % (self._config_obj,))
 
3162
        co_input = StringIO(bytes)
 
3163
        try:
 
3164
            # The config files are always stored utf8-encoded
 
3165
            self._config_obj = ConfigObj(co_input, encoding='utf-8',
 
3166
                                         list_values=False)
 
3167
        except configobj.ConfigObjError, e:
 
3168
            self._config_obj = None
 
3169
            raise errors.ParseConfigError(e.errors, self.external_url())
 
3170
        except UnicodeDecodeError:
 
3171
            raise errors.ConfigContentError(self.external_url())
 
3172
 
 
3173
    def save_changes(self):
 
3174
        if not self.is_loaded():
 
3175
            # Nothing to save
 
3176
            return
 
3177
        if not self._need_saving():
 
3178
            return
 
3179
        # Preserve the current version
 
3180
        current = self._config_obj
 
3181
        dirty_sections = list(self.dirty_sections)
 
3182
        self.apply_changes(dirty_sections)
 
3183
        # Save to the persistent storage
 
3184
        self.save()
 
3185
 
 
3186
    def save(self):
 
3187
        if not self.is_loaded():
 
3188
            # Nothing to save
 
3189
            return
 
3190
        out = StringIO()
 
3191
        self._config_obj.write(out)
 
3192
        self._save_content(out.getvalue())
 
3193
        for hook in ConfigHooks['save']:
 
3194
            hook(self)
 
3195
 
 
3196
    def get_sections(self):
 
3197
        """Get the configobj section in the file order.
 
3198
 
 
3199
        :returns: An iterable of (store, section).
 
3200
        """
 
3201
        # We need a loaded store
 
3202
        try:
 
3203
            self.load()
 
3204
        except (errors.NoSuchFile, errors.PermissionDenied):
 
3205
            # If the file can't be read, there is no sections
 
3206
            return
 
3207
        cobj = self._config_obj
 
3208
        if cobj.scalars:
 
3209
            yield self, self.readonly_section_class(None, cobj)
 
3210
        for section_name in cobj.sections:
 
3211
            yield (self,
 
3212
                   self.readonly_section_class(section_name,
 
3213
                                               cobj[section_name]))
 
3214
 
 
3215
    def get_mutable_section(self, section_id=None):
 
3216
        # We need a loaded store
 
3217
        try:
 
3218
            self.load()
 
3219
        except errors.NoSuchFile:
 
3220
            # The file doesn't exist, let's pretend it was empty
 
3221
            self._load_from_string('')
 
3222
        if section_id is None:
 
3223
            section = self._config_obj
 
3224
        else:
 
3225
            section = self._config_obj.setdefault(section_id, {})
 
3226
        mutable_section = self.mutable_section_class(section_id, section)
 
3227
        # All mutable sections can become dirty
 
3228
        self.dirty_sections.append(mutable_section)
 
3229
        return mutable_section
 
3230
 
 
3231
    def quote(self, value):
 
3232
        try:
 
3233
            # configobj conflates automagical list values and quoting
 
3234
            self._config_obj.list_values = True
 
3235
            return self._config_obj._quote(value)
 
3236
        finally:
 
3237
            self._config_obj.list_values = False
 
3238
 
 
3239
    def unquote(self, value):
 
3240
        if value and isinstance(value, basestring):
 
3241
            # _unquote doesn't handle None nor empty strings nor anything that
 
3242
            # is not a string, really.
 
3243
            value = self._config_obj._unquote(value)
 
3244
        return value
 
3245
 
 
3246
    def external_url(self):
 
3247
        # Since an IniFileStore can be used without a file (at least in tests),
 
3248
        # it's better to provide something than raising a NotImplementedError.
 
3249
        # All daughter classes are supposed to provide an implementation
 
3250
        # anyway.
 
3251
        return 'In-Process Store, no URL'
 
3252
 
 
3253
class TransportIniFileStore(IniFileStore):
 
3254
    """IniFileStore that loads files from a transport.
 
3255
 
 
3256
    :ivar transport: The transport object where the config file is located.
 
3257
 
 
3258
    :ivar file_name: The config file basename in the transport directory.
 
3259
    """
 
3260
 
 
3261
    def __init__(self, transport, file_name):
 
3262
        """A Store using a ini file on a Transport
 
3263
 
 
3264
        :param transport: The transport object where the config file is located.
 
3265
        :param file_name: The config file basename in the transport directory.
 
3266
        """
 
3267
        super(TransportIniFileStore, self).__init__()
 
3268
        self.transport = transport
 
3269
        self.file_name = file_name
 
3270
 
 
3271
    def _load_content(self):
 
3272
        try:
 
3273
            return self.transport.get_bytes(self.file_name)
 
3274
        except errors.PermissionDenied:
 
3275
            trace.warning("Permission denied while trying to load "
 
3276
                          "configuration store %s.", self.external_url())
 
3277
            raise
 
3278
 
 
3279
    def _save_content(self, content):
 
3280
        self.transport.put_bytes(self.file_name, content)
 
3281
 
 
3282
    def external_url(self):
 
3283
        # FIXME: external_url should really accepts an optional relpath
 
3284
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
3285
        # The following will do in the interim but maybe we don't want to
 
3286
        # expose a path here but rather a config ID and its associated
 
3287
        # object </hand wawe>.
 
3288
        return urlutils.join(self.transport.external_url(), self.file_name)
 
3289
 
 
3290
 
 
3291
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
 
3292
# unlockable stores for use with objects that can already ensure the locking
 
3293
# (think branches). If different stores (not based on ConfigObj) are created,
 
3294
# they may face the same issue.
 
3295
 
 
3296
 
 
3297
class LockableIniFileStore(TransportIniFileStore):
 
3298
    """A ConfigObjStore using locks on save to ensure store integrity."""
 
3299
 
 
3300
    def __init__(self, transport, file_name, lock_dir_name=None):
 
3301
        """A config Store using ConfigObj for storage.
 
3302
 
 
3303
        :param transport: The transport object where the config file is located.
 
3304
 
 
3305
        :param file_name: The config file basename in the transport directory.
 
3306
        """
 
3307
        if lock_dir_name is None:
 
3308
            lock_dir_name = 'lock'
 
3309
        self.lock_dir_name = lock_dir_name
 
3310
        super(LockableIniFileStore, self).__init__(transport, file_name)
 
3311
        self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
 
3312
 
 
3313
    def lock_write(self, token=None):
 
3314
        """Takes a write lock in the directory containing the config file.
 
3315
 
 
3316
        If the directory doesn't exist it is created.
 
3317
        """
 
3318
        # FIXME: This doesn't check the ownership of the created directories as
 
3319
        # ensure_config_dir_exists does. It should if the transport is local
 
3320
        # -- vila 2011-04-06
 
3321
        self.transport.create_prefix()
 
3322
        return self._lock.lock_write(token)
 
3323
 
 
3324
    def unlock(self):
 
3325
        self._lock.unlock()
 
3326
 
 
3327
    def break_lock(self):
 
3328
        self._lock.break_lock()
 
3329
 
 
3330
    @needs_write_lock
 
3331
    def save(self):
 
3332
        # We need to be able to override the undecorated implementation
 
3333
        self.save_without_locking()
 
3334
 
 
3335
    def save_without_locking(self):
 
3336
        super(LockableIniFileStore, self).save()
 
3337
 
 
3338
 
 
3339
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
 
3340
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
 
3341
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
 
3342
 
 
3343
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
 
3344
# functions or a registry will make it easier and clearer for tests, focusing
 
3345
# on the relevant parts of the API that needs testing -- vila 20110503 (based
 
3346
# on a poolie's remark)
 
3347
class GlobalStore(LockableIniFileStore):
 
3348
 
 
3349
    def __init__(self, possible_transports=None):
 
3350
        t = transport.get_transport_from_path(
 
3351
            config_dir(), possible_transports=possible_transports)
 
3352
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
3353
        self.id = 'bazaar'
 
3354
 
 
3355
 
 
3356
class LocationStore(LockableIniFileStore):
 
3357
 
 
3358
    def __init__(self, possible_transports=None):
 
3359
        t = transport.get_transport_from_path(
 
3360
            config_dir(), possible_transports=possible_transports)
 
3361
        super(LocationStore, self).__init__(t, 'locations.conf')
 
3362
        self.id = 'locations'
 
3363
 
 
3364
 
 
3365
class BranchStore(TransportIniFileStore):
 
3366
 
 
3367
    def __init__(self, branch):
 
3368
        super(BranchStore, self).__init__(branch.control_transport,
 
3369
                                          'branch.conf')
 
3370
        self.branch = branch
 
3371
        self.id = 'branch'
 
3372
 
 
3373
    def lock_write(self, token=None):
 
3374
        return self.branch.lock_write(token)
 
3375
 
 
3376
    def unlock(self):
 
3377
        return self.branch.unlock()
 
3378
 
 
3379
    @needs_write_lock
 
3380
    def save(self):
 
3381
        # We need to be able to override the undecorated implementation
 
3382
        self.save_without_locking()
 
3383
 
 
3384
    def save_without_locking(self):
 
3385
        super(BranchStore, self).save()
 
3386
 
 
3387
 
 
3388
class ControlStore(LockableIniFileStore):
 
3389
 
 
3390
    def __init__(self, bzrdir):
 
3391
        super(ControlStore, self).__init__(bzrdir.transport,
 
3392
                                          'control.conf',
 
3393
                                           lock_dir_name='branch_lock')
 
3394
        self.id = 'control'
 
3395
 
 
3396
 
 
3397
class SectionMatcher(object):
 
3398
    """Select sections into a given Store.
 
3399
 
 
3400
    This is intended to be used to postpone getting an iterable of sections
 
3401
    from a store.
 
3402
    """
 
3403
 
 
3404
    def __init__(self, store):
 
3405
        self.store = store
 
3406
 
 
3407
    def get_sections(self):
 
3408
        # This is where we require loading the store so we can see all defined
 
3409
        # sections.
 
3410
        sections = self.store.get_sections()
 
3411
        # Walk the revisions in the order provided
 
3412
        for store, s in sections:
 
3413
            if self.match(s):
 
3414
                yield store, s
 
3415
 
 
3416
    def match(self, section):
 
3417
        """Does the proposed section match.
 
3418
 
 
3419
        :param section: A Section object.
 
3420
 
 
3421
        :returns: True if the section matches, False otherwise.
 
3422
        """
 
3423
        raise NotImplementedError(self.match)
 
3424
 
 
3425
 
 
3426
class NameMatcher(SectionMatcher):
 
3427
 
 
3428
    def __init__(self, store, section_id):
 
3429
        super(NameMatcher, self).__init__(store)
 
3430
        self.section_id = section_id
 
3431
 
 
3432
    def match(self, section):
 
3433
        return section.id == self.section_id
 
3434
 
 
3435
 
 
3436
class LocationSection(Section):
 
3437
 
 
3438
    def __init__(self, section, extra_path):
 
3439
        super(LocationSection, self).__init__(section.id, section.options)
 
3440
        self.extra_path = extra_path
 
3441
        self.locals = {'relpath': extra_path,
 
3442
                       'basename': urlutils.basename(extra_path)}
 
3443
 
 
3444
    def get(self, name, default=None, expand=True):
 
3445
        value = super(LocationSection, self).get(name, default)
 
3446
        if value is not None and expand:
 
3447
            policy_name = self.get(name + ':policy', None)
 
3448
            policy = _policy_value.get(policy_name, POLICY_NONE)
 
3449
            if policy == POLICY_APPENDPATH:
 
3450
                value = urlutils.join(value, self.extra_path)
 
3451
            # expand section local options right now (since POLICY_APPENDPATH
 
3452
            # will never add options references, it's ok to expand after it).
 
3453
            chunks = []
 
3454
            for is_ref, chunk in iter_option_refs(value):
 
3455
                if not is_ref:
 
3456
                    chunks.append(chunk)
 
3457
                else:
 
3458
                    ref = chunk[1:-1]
 
3459
                    if ref in self.locals:
 
3460
                        chunks.append(self.locals[ref])
 
3461
                    else:
 
3462
                        chunks.append(chunk)
 
3463
            value = ''.join(chunks)
 
3464
        return value
 
3465
 
 
3466
 
 
3467
class StartingPathMatcher(SectionMatcher):
 
3468
    """Select sections for a given location respecting the Store order."""
 
3469
 
 
3470
    # FIXME: Both local paths and urls can be used for section names as well as
 
3471
    # ``location`` to stay consistent with ``LocationMatcher`` which itself
 
3472
    # inherited the fuzziness from the previous ``LocationConfig``
 
3473
    # implementation. We probably need to revisit which encoding is allowed for
 
3474
    # both ``location`` and section names and how we normalize
 
3475
    # them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
 
3476
    # related too. -- vila 2012-01-04
 
3477
 
 
3478
    def __init__(self, store, location):
 
3479
        super(StartingPathMatcher, self).__init__(store)
 
3480
        if location.startswith('file://'):
 
3481
            location = urlutils.local_path_from_url(location)
 
3482
        self.location = location
 
3483
 
 
3484
    def get_sections(self):
 
3485
        """Get all sections matching ``location`` in the store.
 
3486
 
 
3487
        The most generic sections are described first in the store, then more
 
3488
        specific ones can be provided for reduced scopes.
 
3489
 
 
3490
        The returned section are therefore returned in the reversed order so
 
3491
        the most specific ones can be found first.
 
3492
        """
 
3493
        location_parts = self.location.rstrip('/').split('/')
 
3494
        store = self.store
 
3495
        sections = []
 
3496
        # Later sections are more specific, they should be returned first
 
3497
        for _, section in reversed(list(store.get_sections())):
 
3498
            if section.id is None:
 
3499
                # The no-name section is always included if present
 
3500
                yield store, LocationSection(section, self.location)
 
3501
                continue
 
3502
            section_path = section.id
 
3503
            if section_path.startswith('file://'):
 
3504
                # the location is already a local path or URL, convert the
 
3505
                # section id to the same format
 
3506
                section_path = urlutils.local_path_from_url(section_path)
 
3507
            if (self.location.startswith(section_path)
 
3508
                or fnmatch.fnmatch(self.location, section_path)):
 
3509
                section_parts = section_path.rstrip('/').split('/')
 
3510
                extra_path = '/'.join(location_parts[len(section_parts):])
 
3511
                yield store, LocationSection(section, extra_path)
 
3512
 
 
3513
 
 
3514
class LocationMatcher(SectionMatcher):
 
3515
 
 
3516
    def __init__(self, store, location):
 
3517
        super(LocationMatcher, self).__init__(store)
 
3518
        if location.startswith('file://'):
 
3519
            location = urlutils.local_path_from_url(location)
 
3520
        self.location = location
 
3521
 
 
3522
    def _get_matching_sections(self):
 
3523
        """Get all sections matching ``location``."""
 
3524
        # We slightly diverge from LocalConfig here by allowing the no-name
 
3525
        # section as the most generic one and the lower priority.
 
3526
        no_name_section = None
 
3527
        all_sections = []
 
3528
        # Filter out the no_name_section so _iter_for_location_by_parts can be
 
3529
        # used (it assumes all sections have a name).
 
3530
        for _, section in self.store.get_sections():
 
3531
            if section.id is None:
 
3532
                no_name_section = section
 
3533
            else:
 
3534
                all_sections.append(section)
 
3535
        # Unfortunately _iter_for_location_by_parts deals with section names so
 
3536
        # we have to resync.
 
3537
        filtered_sections = _iter_for_location_by_parts(
 
3538
            [s.id for s in all_sections], self.location)
 
3539
        iter_all_sections = iter(all_sections)
 
3540
        matching_sections = []
 
3541
        if no_name_section is not None:
 
3542
            matching_sections.append(
 
3543
                (0, LocationSection(no_name_section, self.location)))
 
3544
        for section_id, extra_path, length in filtered_sections:
 
3545
            # a section id is unique for a given store so it's safe to take the
 
3546
            # first matching section while iterating. Also, all filtered
 
3547
            # sections are part of 'all_sections' and will always be found
 
3548
            # there.
 
3549
            while True:
 
3550
                section = iter_all_sections.next()
 
3551
                if section_id == section.id:
 
3552
                    matching_sections.append(
 
3553
                        (length, LocationSection(section, extra_path)))
 
3554
                    break
 
3555
        return matching_sections
 
3556
 
 
3557
    def get_sections(self):
 
3558
        # Override the default implementation as we want to change the order
 
3559
        matching_sections = self._get_matching_sections()
 
3560
        # We want the longest (aka more specific) locations first
 
3561
        sections = sorted(matching_sections,
 
3562
                          key=lambda (length, section): (length, section.id),
 
3563
                          reverse=True)
 
3564
        # Sections mentioning 'ignore_parents' restrict the selection
 
3565
        for _, section in sections:
 
3566
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
 
3567
            ignore = section.get('ignore_parents', None)
 
3568
            if ignore is not None:
 
3569
                ignore = ui.bool_from_string(ignore)
 
3570
            if ignore:
 
3571
                break
 
3572
            # Finally, we have a valid section
 
3573
            yield self.store, section
 
3574
 
 
3575
 
 
3576
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
 
3577
"""Describes an expandable option reference.
 
3578
 
 
3579
We want to match the most embedded reference first.
 
3580
 
 
3581
I.e. for '{{foo}}' we will get '{foo}',
 
3582
for '{bar{baz}}' we will get '{baz}'
 
3583
"""
 
3584
 
 
3585
def iter_option_refs(string):
 
3586
    # Split isolate refs so every other chunk is a ref
 
3587
    is_ref = False
 
3588
    for chunk  in _option_ref_re.split(string):
 
3589
        yield is_ref, chunk
 
3590
        is_ref = not is_ref
 
3591
 
 
3592
 
 
3593
class Stack(object):
 
3594
    """A stack of configurations where an option can be defined"""
 
3595
 
 
3596
    def __init__(self, sections_def, store=None, mutable_section_id=None):
 
3597
        """Creates a stack of sections with an optional store for changes.
 
3598
 
 
3599
        :param sections_def: A list of Section or callables that returns an
 
3600
            iterable of Section. This defines the Sections for the Stack and
 
3601
            can be called repeatedly if needed.
 
3602
 
 
3603
        :param store: The optional Store where modifications will be
 
3604
            recorded. If none is specified, no modifications can be done.
 
3605
 
 
3606
        :param mutable_section_id: The id of the MutableSection where changes
 
3607
            are recorded. This requires the ``store`` parameter to be
 
3608
            specified.
 
3609
        """
 
3610
        self.sections_def = sections_def
 
3611
        self.store = store
 
3612
        self.mutable_section_id = mutable_section_id
 
3613
 
 
3614
    def get(self, name, expand=None):
 
3615
        """Return the *first* option value found in the sections.
 
3616
 
 
3617
        This is where we guarantee that sections coming from Store are loaded
 
3618
        lazily: the loading is delayed until we need to either check that an
 
3619
        option exists or get its value, which in turn may require to discover
 
3620
        in which sections it can be defined. Both of these (section and option
 
3621
        existence) require loading the store (even partially).
 
3622
 
 
3623
        :param name: The queried option.
 
3624
 
 
3625
        :param expand: Whether options references should be expanded.
 
3626
 
 
3627
        :returns: The value of the option.
 
3628
        """
 
3629
        # FIXME: No caching of options nor sections yet -- vila 20110503
 
3630
        if expand is None:
 
3631
            expand = _get_expand_default_value()
 
3632
        value = None
 
3633
        found_store = None # Where the option value has been found
 
3634
        # If the option is registered, it may provide additional info about
 
3635
        # value handling
 
3636
        try:
 
3637
            opt = option_registry.get(name)
 
3638
        except KeyError:
 
3639
            # Not registered
 
3640
            opt = None
 
3641
 
 
3642
        def expand_and_convert(val):
 
3643
            # This may need to be called in different contexts if the value is
 
3644
            # None or ends up being None during expansion or conversion.
 
3645
            if val is not None:
 
3646
                if expand:
 
3647
                    if isinstance(val, basestring):
 
3648
                        val = self._expand_options_in_string(val)
 
3649
                    else:
 
3650
                        trace.warning('Cannot expand "%s":'
 
3651
                                      ' %s does not support option expansion'
 
3652
                                      % (name, type(val)))
 
3653
                if opt is None:
 
3654
                    val = found_store.unquote(val)
 
3655
                else:
 
3656
                    val = opt.convert_from_unicode(found_store, val)
 
3657
            return val
 
3658
 
 
3659
        # First of all, check if the environment can override the configuration
 
3660
        # value
 
3661
        if opt is not None and opt.override_from_env:
 
3662
            value = opt.get_override()
 
3663
            value = expand_and_convert(value)
 
3664
        if value is None:
 
3665
            # Ensuring lazy loading is achieved by delaying section matching
 
3666
            # (which implies querying the persistent storage) until it can't be
 
3667
            # avoided anymore by using callables to describe (possibly empty)
 
3668
            # section lists.
 
3669
            for sections in self.sections_def:
 
3670
                for store, section in sections():
 
3671
                    value = section.get(name)
 
3672
                    if value is not None:
 
3673
                        found_store = store
 
3674
                        break
 
3675
                if value is not None:
 
3676
                    break
 
3677
            value = expand_and_convert(value)
 
3678
            if opt is not None and value is None:
 
3679
                # If the option is registered, it may provide a default value
 
3680
                value = opt.get_default()
 
3681
                value = expand_and_convert(value)
 
3682
        for hook in ConfigHooks['get']:
 
3683
            hook(self, name, value)
 
3684
        return value
 
3685
 
 
3686
    def expand_options(self, string, env=None):
 
3687
        """Expand option references in the string in the configuration context.
 
3688
 
 
3689
        :param string: The string containing option(s) to expand.
 
3690
 
 
3691
        :param env: An option dict defining additional configuration options or
 
3692
            overriding existing ones.
 
3693
 
 
3694
        :returns: The expanded string.
 
3695
        """
 
3696
        return self._expand_options_in_string(string, env)
 
3697
 
 
3698
    def _expand_options_in_string(self, string, env=None, _refs=None):
 
3699
        """Expand options in the string in the configuration context.
 
3700
 
 
3701
        :param string: The string to be expanded.
 
3702
 
 
3703
        :param env: An option dict defining additional configuration options or
 
3704
            overriding existing ones.
 
3705
 
 
3706
        :param _refs: Private list (FIFO) containing the options being expanded
 
3707
            to detect loops.
 
3708
 
 
3709
        :returns: The expanded string.
 
3710
        """
 
3711
        if string is None:
 
3712
            # Not much to expand there
 
3713
            return None
 
3714
        if _refs is None:
 
3715
            # What references are currently resolved (to detect loops)
 
3716
            _refs = []
 
3717
        result = string
 
3718
        # We need to iterate until no more refs appear ({{foo}} will need two
 
3719
        # iterations for example).
 
3720
        expanded = True
 
3721
        while expanded:
 
3722
            expanded = False
 
3723
            chunks = []
 
3724
            for is_ref, chunk in iter_option_refs(result):
 
3725
                if not is_ref:
 
3726
                    chunks.append(chunk)
 
3727
                else:
 
3728
                    expanded = True
 
3729
                    name = chunk[1:-1]
 
3730
                    if name in _refs:
 
3731
                        raise errors.OptionExpansionLoop(string, _refs)
 
3732
                    _refs.append(name)
 
3733
                    value = self._expand_option(name, env, _refs)
 
3734
                    if value is None:
 
3735
                        raise errors.ExpandingUnknownOption(name, string)
 
3736
                    chunks.append(value)
 
3737
                    _refs.pop()
 
3738
            result = ''.join(chunks)
 
3739
        return result
 
3740
 
 
3741
    def _expand_option(self, name, env, _refs):
 
3742
        if env is not None and name in env:
 
3743
            # Special case, values provided in env takes precedence over
 
3744
            # anything else
 
3745
            value = env[name]
 
3746
        else:
 
3747
            value = self.get(name, expand=False)
 
3748
            value = self._expand_options_in_string(value, env, _refs)
 
3749
        return value
 
3750
 
 
3751
    def _get_mutable_section(self):
 
3752
        """Get the MutableSection for the Stack.
 
3753
 
 
3754
        This is where we guarantee that the mutable section is lazily loaded:
 
3755
        this means we won't load the corresponding store before setting a value
 
3756
        or deleting an option. In practice the store will often be loaded but
 
3757
        this helps catching some programming errors.
 
3758
        """
 
3759
        store = self.store
 
3760
        section = store.get_mutable_section(self.mutable_section_id)
 
3761
        return store, section
 
3762
 
 
3763
    def set(self, name, value):
 
3764
        """Set a new value for the option."""
 
3765
        store, section = self._get_mutable_section()
 
3766
        section.set(name, store.quote(value))
 
3767
        for hook in ConfigHooks['set']:
 
3768
            hook(self, name, value)
 
3769
 
 
3770
    def remove(self, name):
 
3771
        """Remove an existing option."""
 
3772
        _, section = self._get_mutable_section()
 
3773
        section.remove(name)
 
3774
        for hook in ConfigHooks['remove']:
 
3775
            hook(self, name)
 
3776
 
 
3777
    def __repr__(self):
 
3778
        # Mostly for debugging use
 
3779
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
 
3780
 
 
3781
    def _get_overrides(self):
 
3782
        # Hack around library_state.initialize never called
 
3783
        if bzrlib.global_state is not None:
 
3784
            return bzrlib.global_state.cmdline_overrides.get_sections()
 
3785
        return []
 
3786
 
 
3787
 
 
3788
class MemoryStack(Stack):
 
3789
    """A configuration stack defined from a string.
 
3790
 
 
3791
    This is mainly intended for tests and requires no disk resources.
 
3792
    """
 
3793
 
 
3794
    def __init__(self, content=None):
 
3795
        """Create an in-memory stack from a given content.
 
3796
 
 
3797
        It uses a single store based on configobj and support reading and
 
3798
        writing options.
 
3799
 
 
3800
        :param content: The initial content of the store. If None, the store is
 
3801
            not loaded and ``_load_from_string`` can and should be used if
 
3802
            needed.
 
3803
        """
 
3804
        store = IniFileStore()
 
3805
        if content is not None:
 
3806
            store._load_from_string(content)
 
3807
        super(MemoryStack, self).__init__(
 
3808
            [store.get_sections], store)
 
3809
 
 
3810
 
 
3811
class _CompatibleStack(Stack):
 
3812
    """Place holder for compatibility with previous design.
 
3813
 
 
3814
    This is intended to ease the transition from the Config-based design to the
 
3815
    Stack-based design and should not be used nor relied upon by plugins.
 
3816
 
 
3817
    One assumption made here is that the daughter classes will all use Stores
 
3818
    derived from LockableIniFileStore).
 
3819
 
 
3820
    It implements set() and remove () by re-loading the store before applying
 
3821
    the modification and saving it.
 
3822
 
 
3823
    The long term plan being to implement a single write by store to save
 
3824
    all modifications, this class should not be used in the interim.
 
3825
    """
 
3826
 
 
3827
    def set(self, name, value):
 
3828
        # Force a reload
 
3829
        self.store.unload()
 
3830
        super(_CompatibleStack, self).set(name, value)
 
3831
        # Force a write to persistent storage
 
3832
        self.store.save()
 
3833
 
 
3834
    def remove(self, name):
 
3835
        # Force a reload
 
3836
        self.store.unload()
 
3837
        super(_CompatibleStack, self).remove(name)
 
3838
        # Force a write to persistent storage
 
3839
        self.store.save()
 
3840
 
 
3841
 
 
3842
class GlobalStack(_CompatibleStack):
 
3843
    """Global options only stack.
 
3844
 
 
3845
    The following sections are queried:
 
3846
 
 
3847
    * command-line overrides,
 
3848
 
 
3849
    * the 'DEFAULT' section in bazaar.conf
 
3850
 
 
3851
    This stack will use the ``DEFAULT`` section in bazaar.conf as its
 
3852
    MutableSection.
 
3853
    """
 
3854
 
 
3855
    def __init__(self):
 
3856
        gstore = GlobalStore()
 
3857
        super(GlobalStack, self).__init__(
 
3858
            [self._get_overrides,
 
3859
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3860
            gstore, mutable_section_id='DEFAULT')
 
3861
 
 
3862
 
 
3863
class LocationStack(_CompatibleStack):
 
3864
    """Per-location options falling back to global options stack.
 
3865
 
 
3866
 
 
3867
    The following sections are queried:
 
3868
 
 
3869
    * command-line overrides,
 
3870
 
 
3871
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3872
      defined by the number of path components in the section glob, higher
 
3873
      numbers first (from most specific section to most generic).
 
3874
 
 
3875
    * the 'DEFAULT' section in bazaar.conf
 
3876
 
 
3877
    This stack will use the ``location`` section in locations.conf as its
 
3878
    MutableSection.
 
3879
    """
 
3880
 
 
3881
    def __init__(self, location):
 
3882
        """Make a new stack for a location and global configuration.
 
3883
 
 
3884
        :param location: A URL prefix to """
 
3885
        lstore = LocationStore()
 
3886
        if location.startswith('file://'):
 
3887
            location = urlutils.local_path_from_url(location)
 
3888
        gstore = GlobalStore()
 
3889
        super(LocationStack, self).__init__(
 
3890
            [self._get_overrides,
 
3891
             LocationMatcher(lstore, location).get_sections,
 
3892
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3893
            lstore, mutable_section_id=location)
 
3894
 
 
3895
 
 
3896
class BranchStack(_CompatibleStack):
 
3897
    """Per-location options falling back to branch then global options stack.
 
3898
 
 
3899
    The following sections are queried:
 
3900
 
 
3901
    * command-line overrides,
 
3902
 
 
3903
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3904
      defined by the number of path components in the section glob, higher
 
3905
      numbers first (from most specific section to most generic),
 
3906
 
 
3907
    * the no-name section in branch.conf,
 
3908
 
 
3909
    * the ``DEFAULT`` section in ``bazaar.conf``.
 
3910
 
 
3911
    This stack will use the no-name section in ``branch.conf`` as its
 
3912
    MutableSection.
 
3913
    """
 
3914
 
 
3915
    def __init__(self, branch):
 
3916
        lstore = LocationStore()
 
3917
        bstore = branch._get_config_store()
 
3918
        gstore = GlobalStore()
 
3919
        super(BranchStack, self).__init__(
 
3920
            [self._get_overrides,
 
3921
             LocationMatcher(lstore, branch.base).get_sections,
 
3922
             NameMatcher(bstore, None).get_sections,
 
3923
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3924
            bstore)
 
3925
        self.branch = branch
 
3926
 
 
3927
 
 
3928
class RemoteControlStack(_CompatibleStack):
 
3929
    """Remote control-only options stack."""
 
3930
 
 
3931
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
3932
    # with the stack used for remote bzr dirs. RemoteControlStack only uses
 
3933
    # control.conf and is used only for stack options.
 
3934
 
 
3935
    def __init__(self, bzrdir):
 
3936
        cstore = bzrdir._get_config_store()
 
3937
        super(RemoteControlStack, self).__init__(
 
3938
            [NameMatcher(cstore, None).get_sections],
 
3939
            cstore)
 
3940
        self.bzrdir = bzrdir
 
3941
 
 
3942
 
 
3943
class BranchOnlyStack(_CompatibleStack):
 
3944
    """Branch-only options stack."""
 
3945
 
 
3946
    # FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
 
3947
    # stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
 
3948
    # -- vila 2011-12-16
 
3949
 
 
3950
    def __init__(self, branch):
 
3951
        bstore = branch._get_config_store()
 
3952
        super(BranchOnlyStack, self).__init__(
 
3953
            [NameMatcher(bstore, None).get_sections],
 
3954
            bstore)
 
3955
        self.branch = branch
 
3956
 
 
3957
 
 
3958
# Use a an empty dict to initialize an empty configobj avoiding all
 
3959
# parsing and encoding checks
 
3960
_quoting_config = configobj.ConfigObj(
 
3961
    {}, encoding='utf-8', interpolation=False, list_values=True)
 
3962
 
 
3963
class cmd_config(commands.Command):
 
3964
    __doc__ = """Display, set or remove a configuration option.
 
3965
 
 
3966
    Display the active value for a given option.
 
3967
 
 
3968
    If --all is specified, NAME is interpreted as a regular expression and all
 
3969
    matching options are displayed mentioning their scope. The active value
 
3970
    that bzr will take into account is the first one displayed for each option.
 
3971
 
 
3972
    If no NAME is given, --all .* is implied.
 
3973
 
 
3974
    Setting a value is achieved by using name=value without spaces. The value
 
3975
    is set in the most relevant scope and can be checked by displaying the
 
3976
    option again.
 
3977
    """
 
3978
 
 
3979
    takes_args = ['name?']
 
3980
 
 
3981
    takes_options = [
 
3982
        'directory',
 
3983
        # FIXME: This should be a registry option so that plugins can register
 
3984
        # their own config files (or not) and will also address
 
3985
        # http://pad.lv/788991 -- vila 20101115
 
3986
        commands.Option('scope', help='Reduce the scope to the specified'
 
3987
                        ' configuration file.',
 
3988
                        type=unicode),
 
3989
        commands.Option('all',
 
3990
            help='Display all the defined values for the matching options.',
 
3991
            ),
 
3992
        commands.Option('remove', help='Remove the option from'
 
3993
                        ' the configuration file.'),
 
3994
        ]
 
3995
 
 
3996
    _see_also = ['configuration']
 
3997
 
 
3998
    @commands.display_command
 
3999
    def run(self, name=None, all=False, directory=None, scope=None,
 
4000
            remove=False):
 
4001
        if directory is None:
 
4002
            directory = '.'
 
4003
        directory = urlutils.normalize_url(directory)
 
4004
        if remove and all:
 
4005
            raise errors.BzrError(
 
4006
                '--all and --remove are mutually exclusive.')
 
4007
        elif remove:
 
4008
            # Delete the option in the given scope
 
4009
            self._remove_config_option(name, directory, scope)
 
4010
        elif name is None:
 
4011
            # Defaults to all options
 
4012
            self._show_matching_options('.*', directory, scope)
 
4013
        else:
 
4014
            try:
 
4015
                name, value = name.split('=', 1)
 
4016
            except ValueError:
 
4017
                # Display the option(s) value(s)
 
4018
                if all:
 
4019
                    self._show_matching_options(name, directory, scope)
 
4020
                else:
 
4021
                    self._show_value(name, directory, scope)
 
4022
            else:
 
4023
                if all:
 
4024
                    raise errors.BzrError(
 
4025
                        'Only one option can be set.')
 
4026
                # Set the option value
 
4027
                self._set_config_option(name, value, directory, scope)
 
4028
 
 
4029
    def _get_stack(self, directory, scope=None):
 
4030
        """Get the configuration stack specified by ``directory`` and ``scope``.
 
4031
 
 
4032
        :param directory: Where the configurations are derived from.
 
4033
 
 
4034
        :param scope: A specific config to start from.
 
4035
        """
 
4036
        # FIXME: scope should allow access to plugin-specific stacks (even
 
4037
        # reduced to the plugin-specific store), related to
 
4038
        # http://pad.lv/788991 -- vila 2011-11-15
 
4039
        if scope is not None:
 
4040
            if scope == 'bazaar':
 
4041
                return GlobalStack()
 
4042
            elif scope == 'locations':
 
4043
                return LocationStack(directory)
 
4044
            elif scope == 'branch':
 
4045
                (_, br, _) = (
 
4046
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4047
                        directory))
 
4048
                return br.get_config_stack()
 
4049
            raise errors.NoSuchConfig(scope)
 
4050
        else:
 
4051
            try:
 
4052
                (_, br, _) = (
 
4053
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4054
                        directory))
 
4055
                return br.get_config_stack()
 
4056
            except errors.NotBranchError:
 
4057
                return LocationStack(directory)
 
4058
 
 
4059
    def _show_value(self, name, directory, scope):
 
4060
        conf = self._get_stack(directory, scope)
 
4061
        value = conf.get(name, expand=True)
 
4062
        if value is not None:
 
4063
            # Quote the value appropriately
 
4064
            value = _quoting_config._quote(value)
 
4065
            self.outf.write('%s\n' % (value,))
 
4066
        else:
 
4067
            raise errors.NoSuchConfigOption(name)
 
4068
 
 
4069
    def _show_matching_options(self, name, directory, scope):
 
4070
        name = lazy_regex.lazy_compile(name)
 
4071
        # We want any error in the regexp to be raised *now* so we need to
 
4072
        # avoid the delay introduced by the lazy regexp.  But, we still do
 
4073
        # want the nicer errors raised by lazy_regex.
 
4074
        name._compile_and_collapse()
 
4075
        cur_store_id = None
 
4076
        cur_section = None
 
4077
        conf = self._get_stack(directory, scope)
 
4078
        for sections in conf.sections_def:
 
4079
            for store, section in sections():
 
4080
                for oname in section.iter_option_names():
 
4081
                    if name.search(oname):
 
4082
                        if cur_store_id != store.id:
 
4083
                            # Explain where the options are defined
 
4084
                            self.outf.write('%s:\n' % (store.id,))
 
4085
                            cur_store_id = store.id
 
4086
                            cur_section = None
 
4087
                        if (section.id is not None
 
4088
                            and cur_section != section.id):
 
4089
                            # Display the section id as it appears in the store
 
4090
                            # (None doesn't appear by definition)
 
4091
                            self.outf.write('  [%s]\n' % (section.id,))
 
4092
                            cur_section = section.id
 
4093
                        value = section.get(oname, expand=False)
 
4094
                        # Since we don't use the stack, we need to restore a
 
4095
                        # proper quoting.
 
4096
                        try:
 
4097
                            opt = option_registry.get(oname)
 
4098
                            value = opt.convert_from_unicode(store, value)
 
4099
                        except KeyError:
 
4100
                            value = store.unquote(value)
 
4101
                        value = _quoting_config._quote(value)
 
4102
                        self.outf.write('  %s = %s\n' % (oname, value))
 
4103
 
 
4104
    def _set_config_option(self, name, value, directory, scope):
 
4105
        conf = self._get_stack(directory, scope)
 
4106
        conf.set(name, value)
 
4107
 
 
4108
    def _remove_config_option(self, name, directory, scope):
 
4109
        if name is None:
 
4110
            raise errors.BzrCommandError(
 
4111
                '--remove expects an option to remove.')
 
4112
        conf = self._get_stack(directory, scope)
 
4113
        try:
 
4114
            conf.remove(name)
 
4115
        except KeyError:
 
4116
            raise errors.NoSuchConfigOption(name)
 
4117
 
 
4118
 
 
4119
# Test registries
 
4120
#
 
4121
# We need adapters that can build a Store or a Stack in a test context. Test
 
4122
# classes, based on TestCaseWithTransport, can use the registry to parametrize
 
4123
# themselves. The builder will receive a test instance and should return a
 
4124
# ready-to-use store or stack.  Plugins that define new store/stacks can also
 
4125
# register themselves here to be tested against the tests defined in
 
4126
# bzrlib.tests.test_config. Note that the builder can be called multiple times
 
4127
# for the same test.
 
4128
 
 
4129
# The registered object should be a callable receiving a test instance
 
4130
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
 
4131
# object.
 
4132
test_store_builder_registry = registry.Registry()
 
4133
 
 
4134
# The registered object should be a callable receiving a test instance
 
4135
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
 
4136
# object.
 
4137
test_stack_builder_registry = registry.Registry()