← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Aaron Bentley
  • Date: 2012-07-19 15:44:55 UTC
  • mto: This revision was merged to the branch mainline in revision 6540.
  • Revision ID: aaron@aaronbentley.com-20120719154455-j7y8fm7o9y95vo38
Eliminate get_stored_uncommitted from API.

Show diffs side-by-side

added added

removed removed

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