/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Vincent Ladeuil
  • Date: 2012-01-05 17:56:30 UTC
  • mfrom: (6434 +trunk)
  • mto: This revision was merged to the branch mainline in revision 6468.
  • Revision ID: v.ladeuil+lp@free.fr-20120105175630-kp0kt0el27s40q0x
Merge trunk resolving conflicts

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