/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: Jelmer Vernooij
  • Date: 2012-08-28 20:49:22 UTC
  • mto: This revision was merged to the branch mainline in revision 6556.
  • Revision ID: jelmer@samba.org-20120828204922-o8ok2komaeab6o2v
Inline traceback specification.

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