/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Fabien Meghazi
  • Date: 2014-02-14 10:29:49 UTC
  • mto: This revision was merged to the branch mainline in revision 6596.
  • Revision ID: fme@openerp.com-20140214102949-mee83zlgwq5caakt
Also honor $XDG_CONFIG_HOME specification on Mac OS X platform

Show diffs side-by-side

added added

removed removed

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