← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Launchpad Translations on behalf of bzr-core
  • Date: 2012-12-14 04:30:33 UTC
  • mto: (6581.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6582.
  • Revision ID: launchpad_translations_on_behalf_of_bzr-core-20121214043033-aysfz8gx6zi7ygmm
Launchpad automatic translations update.

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