/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: Ross Lagerwall
  • Date: 2012-08-07 06:32:51 UTC
  • mto: (6437.63.5 2.5)
  • mto: This revision was merged to the branch mainline in revision 6558.
  • Revision ID: rosslagerwall@gmail.com-20120807063251-x9p03ghg2ws8oqjc
Add bzrlib/locale to .bzrignore

bzrlib/locale is generated with ./setup.py build_mo which is in turn called
by ./setup.py build

Show diffs side-by-side

added added

removed removed

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