← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Martin Packman
  • Date: 2011-12-19 10:37:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6394.
  • Revision ID: martin.packman@canonical.com-20111219103757-b85as9n9pb7e6qvn
Add tests for deprecated unicode wrapper functions in win32utils

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-2011 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
 
63
73
"""
64
74
 
65
75
import os
 
76
import string
66
77
import sys
67
78
 
 
79
 
 
80
import bzrlib
 
81
from bzrlib.decorators import needs_write_lock
68
82
from bzrlib.lazy_import import lazy_import
69
83
lazy_import(globals(), """
70
 
import errno
71
 
from fnmatch import fnmatch
 
84
import fnmatch
72
85
import re
73
86
from cStringIO import StringIO
74
87
 
75
 
import bzrlib
76
88
from bzrlib import (
 
89
    atomicfile,
 
90
    controldir,
77
91
    debug,
78
92
    errors,
 
93
    lazy_regex,
 
94
    library_state,
 
95
    lockdir,
79
96
    mail_client,
 
97
    mergetools,
80
98
    osutils,
81
 
    registry,
82
99
    symbol_versioning,
83
100
    trace,
 
101
    transport,
84
102
    ui,
85
103
    urlutils,
86
104
    win32utils,
87
105
    )
 
106
from bzrlib.i18n import gettext
88
107
from bzrlib.util.configobj import configobj
89
108
""")
 
109
from bzrlib import (
 
110
    commands,
 
111
    hooks,
 
112
    lazy_regex,
 
113
    registry,
 
114
    )
 
115
from bzrlib.symbol_versioning import (
 
116
    deprecated_in,
 
117
    deprecated_method,
 
118
    )
90
119
 
91
120
 
92
121
CHECK_IF_POSSIBLE=0
122
151
STORE_BRANCH = 3
123
152
STORE_GLOBAL = 4
124
153
 
125
 
_ConfigObj = None
126
 
def ConfigObj(*args, **kwargs):
127
 
    global _ConfigObj
128
 
    if _ConfigObj is None:
129
 
        class ConfigObj(configobj.ConfigObj):
130
 
 
131
 
            def get_bool(self, section, key):
132
 
                return self[section].as_bool(key)
133
 
 
134
 
            def get_value(self, section, name):
135
 
                # Try [] for the old DEFAULT section.
136
 
                if section == "DEFAULT":
137
 
                    try:
138
 
                        return self[name]
139
 
                    except KeyError:
140
 
                        pass
141
 
                return self[section][name]
142
 
        _ConfigObj = ConfigObj
143
 
    return _ConfigObj(*args, **kwargs)
 
154
 
 
155
class ConfigObj(configobj.ConfigObj):
 
156
 
 
157
    def __init__(self, infile=None, **kwargs):
 
158
        # We define our own interpolation mechanism calling it option expansion
 
159
        super(ConfigObj, self).__init__(infile=infile,
 
160
                                        interpolation=False,
 
161
                                        **kwargs)
 
162
 
 
163
    def get_bool(self, section, key):
 
164
        return self[section].as_bool(key)
 
165
 
 
166
    def get_value(self, section, name):
 
167
        # Try [] for the old DEFAULT section.
 
168
        if section == "DEFAULT":
 
169
            try:
 
170
                return self[name]
 
171
            except KeyError:
 
172
                pass
 
173
        return self[section][name]
 
174
 
 
175
 
 
176
# FIXME: Until we can guarantee that each config file is loaded once and
 
177
# only once for a given bzrlib session, we don't want to re-read the file every
 
178
# time we query for an option so we cache the value (bad ! watch out for tests
 
179
# needing to restore the proper value). -- vila 20110219
 
180
_expand_default_value = None
 
181
def _get_expand_default_value():
 
182
    global _expand_default_value
 
183
    if _expand_default_value is not None:
 
184
        return _expand_default_value
 
185
    conf = GlobalConfig()
 
186
    # Note that we must not use None for the expand value below or we'll run
 
187
    # into infinite recursion. Using False really would be quite silly ;)
 
188
    expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
 
189
    if expand is None:
 
190
        # This is an opt-in feature, you *really* need to clearly say you want
 
191
        # to activate it !
 
192
        expand = False
 
193
    _expand_default_value = expand
 
194
    return expand
144
195
 
145
196
 
146
197
class Config(object):
149
200
    def __init__(self):
150
201
        super(Config, self).__init__()
151
202
 
 
203
    def config_id(self):
 
204
        """Returns a unique ID for the config."""
 
205
        raise NotImplementedError(self.config_id)
 
206
 
 
207
    @deprecated_method(deprecated_in((2, 4, 0)))
152
208
    def get_editor(self):
153
209
        """Get the users pop up editor."""
154
210
        raise NotImplementedError
161
217
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
162
218
                                             sys.stdout)
163
219
 
164
 
 
165
220
    def get_mail_client(self):
166
221
        """Get a mail client to use"""
167
222
        selected_client = self.get_user_option('mail_client')
178
233
    def _get_signing_policy(self):
179
234
        """Template method to override signature creation policy."""
180
235
 
 
236
    option_ref_re = None
 
237
 
 
238
    def expand_options(self, string, env=None):
 
239
        """Expand option references in the string in the configuration context.
 
240
 
 
241
        :param string: The string containing option to expand.
 
242
 
 
243
        :param env: An option dict defining additional configuration options or
 
244
            overriding existing ones.
 
245
 
 
246
        :returns: The expanded string.
 
247
        """
 
248
        return self._expand_options_in_string(string, env)
 
249
 
 
250
    def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
 
251
        """Expand options in  a list of strings in the configuration context.
 
252
 
 
253
        :param slist: A list of strings.
 
254
 
 
255
        :param env: An option dict defining additional configuration options or
 
256
            overriding existing ones.
 
257
 
 
258
        :param _ref_stack: Private list containing the options being
 
259
            expanded to detect loops.
 
260
 
 
261
        :returns: The flatten list of expanded strings.
 
262
        """
 
263
        # expand options in each value separately flattening lists
 
264
        result = []
 
265
        for s in slist:
 
266
            value = self._expand_options_in_string(s, env, _ref_stack)
 
267
            if isinstance(value, list):
 
268
                result.extend(value)
 
269
            else:
 
270
                result.append(value)
 
271
        return result
 
272
 
 
273
    def _expand_options_in_string(self, string, env=None, _ref_stack=None):
 
274
        """Expand options in the string in the configuration context.
 
275
 
 
276
        :param string: The string to be expanded.
 
277
 
 
278
        :param env: An option dict defining additional configuration options or
 
279
            overriding existing ones.
 
280
 
 
281
        :param _ref_stack: Private list containing the options being
 
282
            expanded to detect loops.
 
283
 
 
284
        :returns: The expanded string.
 
285
        """
 
286
        if string is None:
 
287
            # Not much to expand there
 
288
            return None
 
289
        if _ref_stack is None:
 
290
            # What references are currently resolved (to detect loops)
 
291
            _ref_stack = []
 
292
        if self.option_ref_re is None:
 
293
            # We want to match the most embedded reference first (i.e. for
 
294
            # '{{foo}}' we will get '{foo}',
 
295
            # for '{bar{baz}}' we will get '{baz}'
 
296
            self.option_ref_re = re.compile('({[^{}]+})')
 
297
        result = string
 
298
        # We need to iterate until no more refs appear ({{foo}} will need two
 
299
        # iterations for example).
 
300
        while True:
 
301
            raw_chunks = self.option_ref_re.split(result)
 
302
            if len(raw_chunks) == 1:
 
303
                # Shorcut the trivial case: no refs
 
304
                return result
 
305
            chunks = []
 
306
            list_value = False
 
307
            # Split will isolate refs so that every other chunk is a ref
 
308
            chunk_is_ref = False
 
309
            for chunk in raw_chunks:
 
310
                if not chunk_is_ref:
 
311
                    if chunk:
 
312
                        # Keep only non-empty strings (or we get bogus empty
 
313
                        # slots when a list value is involved).
 
314
                        chunks.append(chunk)
 
315
                    chunk_is_ref = True
 
316
                else:
 
317
                    name = chunk[1:-1]
 
318
                    if name in _ref_stack:
 
319
                        raise errors.OptionExpansionLoop(string, _ref_stack)
 
320
                    _ref_stack.append(name)
 
321
                    value = self._expand_option(name, env, _ref_stack)
 
322
                    if value is None:
 
323
                        raise errors.ExpandingUnknownOption(name, string)
 
324
                    if isinstance(value, list):
 
325
                        list_value = True
 
326
                        chunks.extend(value)
 
327
                    else:
 
328
                        chunks.append(value)
 
329
                    _ref_stack.pop()
 
330
                    chunk_is_ref = False
 
331
            if list_value:
 
332
                # Once a list appears as the result of an expansion, all
 
333
                # callers will get a list result. This allows a consistent
 
334
                # behavior even when some options in the expansion chain
 
335
                # defined as strings (no comma in their value) but their
 
336
                # expanded value is a list.
 
337
                return self._expand_options_in_list(chunks, env, _ref_stack)
 
338
            else:
 
339
                result = ''.join(chunks)
 
340
        return result
 
341
 
 
342
    def _expand_option(self, name, env, _ref_stack):
 
343
        if env is not None and name in env:
 
344
            # Special case, values provided in env takes precedence over
 
345
            # anything else
 
346
            value = env[name]
 
347
        else:
 
348
            # FIXME: This is a limited implementation, what we really need is a
 
349
            # way to query the bzr config for the value of an option,
 
350
            # respecting the scope rules (That is, once we implement fallback
 
351
            # configs, getting the option value should restart from the top
 
352
            # config, not the current one) -- vila 20101222
 
353
            value = self.get_user_option(name, expand=False)
 
354
            if isinstance(value, list):
 
355
                value = self._expand_options_in_list(value, env, _ref_stack)
 
356
            else:
 
357
                value = self._expand_options_in_string(value, env, _ref_stack)
 
358
        return value
 
359
 
181
360
    def _get_user_option(self, option_name):
182
361
        """Template method to provide a user option."""
183
362
        return None
184
363
 
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
 
 
 
364
    def get_user_option(self, option_name, expand=None):
 
365
        """Get a generic option - no special process, no default.
 
366
 
 
367
        :param option_name: The queried option.
 
368
 
 
369
        :param expand: Whether options references should be expanded.
 
370
 
 
371
        :returns: The value of the option.
 
372
        """
 
373
        if expand is None:
 
374
            expand = _get_expand_default_value()
 
375
        value = self._get_user_option(option_name)
 
376
        if expand:
 
377
            if isinstance(value, list):
 
378
                value = self._expand_options_in_list(value)
 
379
            elif isinstance(value, dict):
 
380
                trace.warning('Cannot expand "%s":'
 
381
                              ' Dicts do not support option expansion'
 
382
                              % (option_name,))
 
383
            else:
 
384
                value = self._expand_options_in_string(value)
 
385
        for hook in OldConfigHooks['get']:
 
386
            hook(self, option_name, value)
 
387
        return value
 
388
 
 
389
    def get_user_option_as_bool(self, option_name, expand=None, default=None):
 
390
        """Get a generic option as a boolean.
 
391
 
 
392
        :param expand: Allow expanding references to other config values.
 
393
        :param default: Default value if nothing is configured
192
394
        :return None if the option doesn't exist or its value can't be
193
395
            interpreted as a boolean. Returns True or False otherwise.
194
396
        """
195
 
        s = self._get_user_option(option_name)
 
397
        s = self.get_user_option(option_name, expand=expand)
196
398
        if s is None:
197
399
            # The option doesn't exist
198
 
            return None
 
400
            return default
199
401
        val = ui.bool_from_string(s)
200
402
        if val is None:
201
403
            # The value can't be interpreted as a boolean
203
405
                          s, option_name)
204
406
        return val
205
407
 
206
 
    def get_user_option_as_list(self, option_name):
 
408
    def get_user_option_as_list(self, option_name, expand=None):
207
409
        """Get a generic option as a list - no special process, no default.
208
410
 
209
411
        :return None if the option doesn't exist. Returns the value as a list
210
412
            otherwise.
211
413
        """
212
 
        l = self._get_user_option(option_name)
 
414
        l = self.get_user_option(option_name, expand=expand)
213
415
        if isinstance(l, (str, unicode)):
214
 
            # A single value, most probably the user forgot the final ','
 
416
            # A single value, most probably the user forgot (or didn't care to
 
417
            # add) the final ','
215
418
            l = [l]
216
419
        return l
 
420
        
 
421
    def get_user_option_as_int_from_SI(self,  option_name,  default=None):
 
422
        """Get a generic option from a human readable size in SI units, e.g 10MB
 
423
        
 
424
        Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
425
        by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
426
        pedantic.
 
427
        
 
428
        :return Integer, expanded to its base-10 value if a proper SI unit is 
 
429
            found. If the option doesn't exist, or isn't a value in 
 
430
            SI units, return default (which defaults to None)
 
431
        """
 
432
        val = self.get_user_option(option_name)
 
433
        if isinstance(val, list):
 
434
            val = val[0]
 
435
        if val is None:
 
436
            val = default
 
437
        else:
 
438
            p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
 
439
            try:
 
440
                m = p.match(val)
 
441
                if m is not None:
 
442
                    val = int(m.group(1))
 
443
                    if m.group(2) is not None:
 
444
                        if m.group(2).lower() == 'k':
 
445
                            val *= 10**3
 
446
                        elif m.group(2).lower() == 'm':
 
447
                            val *= 10**6
 
448
                        elif m.group(2).lower() == 'g':
 
449
                            val *= 10**9
 
450
                else:
 
451
                    ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
 
452
                                               ' value {1!r} is not an SI unit.').format(
 
453
                                                option_name, val))
 
454
                    val = default
 
455
            except TypeError:
 
456
                val = default
 
457
        return val
 
458
        
217
459
 
218
460
    def gpg_signing_command(self):
219
461
        """What program should be used to sign signatures?"""
237
479
        """See log_format()."""
238
480
        return None
239
481
 
 
482
    def validate_signatures_in_log(self):
 
483
        """Show GPG signature validity in log"""
 
484
        result = self._validate_signatures_in_log()
 
485
        if result == "true":
 
486
            result = True
 
487
        else:
 
488
            result = False
 
489
        return result
 
490
 
 
491
    def _validate_signatures_in_log(self):
 
492
        """See validate_signatures_in_log()."""
 
493
        return None
 
494
 
 
495
    def acceptable_keys(self):
 
496
        """Comma separated list of key patterns acceptable to 
 
497
        verify-signatures command"""
 
498
        result = self._acceptable_keys()
 
499
        return result
 
500
 
 
501
    def _acceptable_keys(self):
 
502
        """See acceptable_keys()."""
 
503
        return None
 
504
 
240
505
    def post_commit(self):
241
506
        """An ordered list of python functions to call.
242
507
 
257
522
 
258
523
        Something similar to 'Martin Pool <mbp@sourcefrog.net>'
259
524
 
260
 
        $BZR_EMAIL can be set to override this (as well as the
261
 
        deprecated $BZREMAIL), then
 
525
        $BZR_EMAIL can be set to override this, then
262
526
        the concrete policy type is checked, and finally
263
527
        $EMAIL is examined.
264
 
        If none is found, a reasonable default is (hopefully)
265
 
        created.
266
 
 
267
 
        TODO: Check it's reasonably well-formed.
 
528
        If no username can be found, errors.NoWhoami exception is raised.
268
529
        """
269
530
        v = os.environ.get('BZR_EMAIL')
270
531
        if v:
271
532
            return v.decode(osutils.get_user_encoding())
272
 
 
273
533
        v = self._get_user_id()
274
534
        if v:
275
535
            return v
276
 
 
277
536
        v = os.environ.get('EMAIL')
278
537
        if v:
279
538
            return v.decode(osutils.get_user_encoding())
280
 
 
281
539
        name, email = _auto_user_id()
282
 
        if name:
 
540
        if name and email:
283
541
            return '%s <%s>' % (name, email)
284
 
        else:
 
542
        elif email:
285
543
            return email
 
544
        raise errors.NoWhoami()
 
545
 
 
546
    def ensure_username(self):
 
547
        """Raise errors.NoWhoami if username is not set.
 
548
 
 
549
        This method relies on the username() function raising the error.
 
550
        """
 
551
        self.username()
286
552
 
287
553
    def signature_checking(self):
288
554
        """What is the current policy for signature checking?."""
304
570
        if policy is None:
305
571
            policy = self._get_signature_checking()
306
572
            if policy is not None:
 
573
                #this warning should go away once check_signatures is
 
574
                #implemented (if not before)
307
575
                trace.warning("Please use create_signatures,"
308
576
                              " not check_signatures to set signing policy.")
309
 
            if policy == CHECK_ALWAYS:
310
 
                return True
311
577
        elif policy == SIGN_ALWAYS:
312
578
            return True
313
579
        return False
314
580
 
 
581
    def gpg_signing_key(self):
 
582
        """GPG user-id to sign commits"""
 
583
        key = self.get_user_option('gpg_signing_key')
 
584
        if key == "default" or key == None:
 
585
            return self.user_email()
 
586
        else:
 
587
            return key
 
588
 
315
589
    def get_alias(self, value):
316
590
        return self._get_alias(value)
317
591
 
346
620
        else:
347
621
            return True
348
622
 
 
623
    def get_merge_tools(self):
 
624
        tools = {}
 
625
        for (oname, value, section, conf_id, parser) in self._get_options():
 
626
            if oname.startswith('bzr.mergetool.'):
 
627
                tool_name = oname[len('bzr.mergetool.'):]
 
628
                tools[tool_name] = self.get_user_option(oname)
 
629
        trace.mutter('loaded merge tools: %r' % tools)
 
630
        return tools
 
631
 
 
632
    def find_merge_tool(self, name):
 
633
        # We fake a defaults mechanism here by checking if the given name can
 
634
        # be found in the known_merge_tools if it's not found in the config.
 
635
        # This should be done through the proposed config defaults mechanism
 
636
        # when it becomes available in the future.
 
637
        command_line = (self.get_user_option('bzr.mergetool.%s' % name,
 
638
                                             expand=False)
 
639
                        or mergetools.known_merge_tools.get(name, None))
 
640
        return command_line
 
641
 
 
642
 
 
643
class _ConfigHooks(hooks.Hooks):
 
644
    """A dict mapping hook names and a list of callables for configs.
 
645
    """
 
646
 
 
647
    def __init__(self):
 
648
        """Create the default hooks.
 
649
 
 
650
        These are all empty initially, because by default nothing should get
 
651
        notified.
 
652
        """
 
653
        super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
 
654
        self.add_hook('load',
 
655
                      'Invoked when a config store is loaded.'
 
656
                      ' The signature is (store).',
 
657
                      (2, 4))
 
658
        self.add_hook('save',
 
659
                      'Invoked when a config store is saved.'
 
660
                      ' The signature is (store).',
 
661
                      (2, 4))
 
662
        # The hooks for config options
 
663
        self.add_hook('get',
 
664
                      'Invoked when a config option is read.'
 
665
                      ' The signature is (stack, name, value).',
 
666
                      (2, 4))
 
667
        self.add_hook('set',
 
668
                      'Invoked when a config option is set.'
 
669
                      ' The signature is (stack, name, value).',
 
670
                      (2, 4))
 
671
        self.add_hook('remove',
 
672
                      'Invoked when a config option is removed.'
 
673
                      ' The signature is (stack, name).',
 
674
                      (2, 4))
 
675
ConfigHooks = _ConfigHooks()
 
676
 
 
677
 
 
678
class _OldConfigHooks(hooks.Hooks):
 
679
    """A dict mapping hook names and a list of callables for configs.
 
680
    """
 
681
 
 
682
    def __init__(self):
 
683
        """Create the default hooks.
 
684
 
 
685
        These are all empty initially, because by default nothing should get
 
686
        notified.
 
687
        """
 
688
        super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
 
689
        self.add_hook('load',
 
690
                      'Invoked when a config store is loaded.'
 
691
                      ' The signature is (config).',
 
692
                      (2, 4))
 
693
        self.add_hook('save',
 
694
                      'Invoked when a config store is saved.'
 
695
                      ' The signature is (config).',
 
696
                      (2, 4))
 
697
        # The hooks for config options
 
698
        self.add_hook('get',
 
699
                      'Invoked when a config option is read.'
 
700
                      ' The signature is (config, name, value).',
 
701
                      (2, 4))
 
702
        self.add_hook('set',
 
703
                      'Invoked when a config option is set.'
 
704
                      ' The signature is (config, name, value).',
 
705
                      (2, 4))
 
706
        self.add_hook('remove',
 
707
                      'Invoked when a config option is removed.'
 
708
                      ' The signature is (config, name).',
 
709
                      (2, 4))
 
710
OldConfigHooks = _OldConfigHooks()
 
711
 
349
712
 
350
713
class IniBasedConfig(Config):
351
714
    """A configuration policy that draws from ini files."""
352
715
 
353
 
    def __init__(self, get_filename):
 
716
    def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
 
717
                 file_name=None):
 
718
        """Base class for configuration files using an ini-like syntax.
 
719
 
 
720
        :param file_name: The configuration file path.
 
721
        """
354
722
        super(IniBasedConfig, self).__init__()
355
 
        self._get_filename = get_filename
 
723
        self.file_name = file_name
 
724
        if symbol_versioning.deprecated_passed(get_filename):
 
725
            symbol_versioning.warn(
 
726
                'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
 
727
                ' Use file_name instead.',
 
728
                DeprecationWarning,
 
729
                stacklevel=2)
 
730
            if get_filename is not None:
 
731
                self.file_name = get_filename()
 
732
        else:
 
733
            self.file_name = file_name
 
734
        self._content = None
356
735
        self._parser = None
357
736
 
358
 
    def _get_parser(self, file=None):
 
737
    @classmethod
 
738
    def from_string(cls, str_or_unicode, file_name=None, save=False):
 
739
        """Create a config object from a string.
 
740
 
 
741
        :param str_or_unicode: A string representing the file content. This will
 
742
            be utf-8 encoded.
 
743
 
 
744
        :param file_name: The configuration file path.
 
745
 
 
746
        :param _save: Whether the file should be saved upon creation.
 
747
        """
 
748
        conf = cls(file_name=file_name)
 
749
        conf._create_from_string(str_or_unicode, save)
 
750
        return conf
 
751
 
 
752
    def _create_from_string(self, str_or_unicode, save):
 
753
        self._content = StringIO(str_or_unicode.encode('utf-8'))
 
754
        # Some tests use in-memory configs, some other always need the config
 
755
        # file to exist on disk.
 
756
        if save:
 
757
            self._write_config_file()
 
758
 
 
759
    def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
359
760
        if self._parser is not None:
360
761
            return self._parser
361
 
        if file is None:
362
 
            input = self._get_filename()
 
762
        if symbol_versioning.deprecated_passed(file):
 
763
            symbol_versioning.warn(
 
764
                'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
 
765
                ' Use IniBasedConfig(_content=xxx) instead.',
 
766
                DeprecationWarning,
 
767
                stacklevel=2)
 
768
        if self._content is not None:
 
769
            co_input = self._content
 
770
        elif self.file_name is None:
 
771
            raise AssertionError('We have no content to create the config')
363
772
        else:
364
 
            input = file
 
773
            co_input = self.file_name
365
774
        try:
366
 
            self._parser = ConfigObj(input, encoding='utf-8')
 
775
            self._parser = ConfigObj(co_input, encoding='utf-8')
367
776
        except configobj.ConfigObjError, e:
368
777
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
778
        except UnicodeDecodeError:
 
779
            raise errors.ConfigContentError(self.file_name)
 
780
        # Make sure self.reload() will use the right file name
 
781
        self._parser.filename = self.file_name
 
782
        for hook in OldConfigHooks['load']:
 
783
            hook(self)
369
784
        return self._parser
370
785
 
 
786
    def reload(self):
 
787
        """Reload the config file from disk."""
 
788
        if self.file_name is None:
 
789
            raise AssertionError('We need a file name to reload the config')
 
790
        if self._parser is not None:
 
791
            self._parser.reload()
 
792
        for hook in ConfigHooks['load']:
 
793
            hook(self)
 
794
 
371
795
    def _get_matching_sections(self):
372
796
        """Return an ordered list of (section_name, extra_path) pairs.
373
797
 
384
808
        """Override this to define the section used by the config."""
385
809
        return "DEFAULT"
386
810
 
 
811
    def _get_sections(self, name=None):
 
812
        """Returns an iterator of the sections specified by ``name``.
 
813
 
 
814
        :param name: The section name. If None is supplied, the default
 
815
            configurations are yielded.
 
816
 
 
817
        :return: A tuple (name, section, config_id) for all sections that will
 
818
            be walked by user_get_option() in the 'right' order. The first one
 
819
            is where set_user_option() will update the value.
 
820
        """
 
821
        parser = self._get_parser()
 
822
        if name is not None:
 
823
            yield (name, parser[name], self.config_id())
 
824
        else:
 
825
            # No section name has been given so we fallback to the configobj
 
826
            # itself which holds the variables defined outside of any section.
 
827
            yield (None, parser, self.config_id())
 
828
 
 
829
    def _get_options(self, sections=None):
 
830
        """Return an ordered list of (name, value, section, config_id) tuples.
 
831
 
 
832
        All options are returned with their associated value and the section
 
833
        they appeared in. ``config_id`` is a unique identifier for the
 
834
        configuration file the option is defined in.
 
835
 
 
836
        :param sections: Default to ``_get_matching_sections`` if not
 
837
            specified. This gives a better control to daughter classes about
 
838
            which sections should be searched. This is a list of (name,
 
839
            configobj) tuples.
 
840
        """
 
841
        opts = []
 
842
        if sections is None:
 
843
            parser = self._get_parser()
 
844
            sections = []
 
845
            for (section_name, _) in self._get_matching_sections():
 
846
                try:
 
847
                    section = parser[section_name]
 
848
                except KeyError:
 
849
                    # This could happen for an empty file for which we define a
 
850
                    # DEFAULT section. FIXME: Force callers to provide sections
 
851
                    # instead ? -- vila 20100930
 
852
                    continue
 
853
                sections.append((section_name, section))
 
854
        config_id = self.config_id()
 
855
        for (section_name, section) in sections:
 
856
            for (name, value) in section.iteritems():
 
857
                yield (name, parser._quote(value), section_name,
 
858
                       config_id, parser)
 
859
 
387
860
    def _get_option_policy(self, section, option_name):
388
861
        """Return the policy for the given (section, option_name) pair."""
389
862
        return POLICY_NONE
440
913
        """See Config.log_format."""
441
914
        return self._get_user_option('log_format')
442
915
 
 
916
    def _validate_signatures_in_log(self):
 
917
        """See Config.validate_signatures_in_log."""
 
918
        return self._get_user_option('validate_signatures_in_log')
 
919
 
 
920
    def _acceptable_keys(self):
 
921
        """See Config.acceptable_keys."""
 
922
        return self._get_user_option('acceptable_keys')
 
923
 
443
924
    def _post_commit(self):
444
925
        """See Config.post_commit."""
445
926
        return self._get_user_option('post_commit')
476
957
    def _get_nickname(self):
477
958
        return self.get_user_option('nickname')
478
959
 
479
 
 
480
 
class GlobalConfig(IniBasedConfig):
 
960
    def remove_user_option(self, option_name, section_name=None):
 
961
        """Remove a user option and save the configuration file.
 
962
 
 
963
        :param option_name: The option to be removed.
 
964
 
 
965
        :param section_name: The section the option is defined in, default to
 
966
            the default section.
 
967
        """
 
968
        self.reload()
 
969
        parser = self._get_parser()
 
970
        if section_name is None:
 
971
            section = parser
 
972
        else:
 
973
            section = parser[section_name]
 
974
        try:
 
975
            del section[option_name]
 
976
        except KeyError:
 
977
            raise errors.NoSuchConfigOption(option_name)
 
978
        self._write_config_file()
 
979
        for hook in OldConfigHooks['remove']:
 
980
            hook(self, option_name)
 
981
 
 
982
    def _write_config_file(self):
 
983
        if self.file_name is None:
 
984
            raise AssertionError('We cannot save, self.file_name is None')
 
985
        conf_dir = os.path.dirname(self.file_name)
 
986
        ensure_config_dir_exists(conf_dir)
 
987
        atomic_file = atomicfile.AtomicFile(self.file_name)
 
988
        self._get_parser().write(atomic_file)
 
989
        atomic_file.commit()
 
990
        atomic_file.close()
 
991
        osutils.copy_ownership_from_path(self.file_name)
 
992
        for hook in OldConfigHooks['save']:
 
993
            hook(self)
 
994
 
 
995
 
 
996
class LockableConfig(IniBasedConfig):
 
997
    """A configuration needing explicit locking for access.
 
998
 
 
999
    If several processes try to write the config file, the accesses need to be
 
1000
    serialized.
 
1001
 
 
1002
    Daughter classes should decorate all methods that update a config with the
 
1003
    ``@needs_write_lock`` decorator (they call, directly or indirectly, the
 
1004
    ``_write_config_file()`` method. These methods (typically ``set_option()``
 
1005
    and variants must reload the config file from disk before calling
 
1006
    ``_write_config_file()``), this can be achieved by calling the
 
1007
    ``self.reload()`` method. Note that the lock scope should cover both the
 
1008
    reading and the writing of the config file which is why the decorator can't
 
1009
    be applied to ``_write_config_file()`` only.
 
1010
 
 
1011
    This should be enough to implement the following logic:
 
1012
    - lock for exclusive write access,
 
1013
    - reload the config file from disk,
 
1014
    - set the new value
 
1015
    - unlock
 
1016
 
 
1017
    This logic guarantees that a writer can update a value without erasing an
 
1018
    update made by another writer.
 
1019
    """
 
1020
 
 
1021
    lock_name = 'lock'
 
1022
 
 
1023
    def __init__(self, file_name):
 
1024
        super(LockableConfig, self).__init__(file_name=file_name)
 
1025
        self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
 
1026
        # FIXME: It doesn't matter that we don't provide possible_transports
 
1027
        # below since this is currently used only for local config files ;
 
1028
        # local transports are not shared. But if/when we start using
 
1029
        # LockableConfig for other kind of transports, we will need to reuse
 
1030
        # whatever connection is already established -- vila 20100929
 
1031
        self.transport = transport.get_transport_from_path(self.dir)
 
1032
        self._lock = lockdir.LockDir(self.transport, self.lock_name)
 
1033
 
 
1034
    def _create_from_string(self, unicode_bytes, save):
 
1035
        super(LockableConfig, self)._create_from_string(unicode_bytes, False)
 
1036
        if save:
 
1037
            # We need to handle the saving here (as opposed to IniBasedConfig)
 
1038
            # to be able to lock
 
1039
            self.lock_write()
 
1040
            self._write_config_file()
 
1041
            self.unlock()
 
1042
 
 
1043
    def lock_write(self, token=None):
 
1044
        """Takes a write lock in the directory containing the config file.
 
1045
 
 
1046
        If the directory doesn't exist it is created.
 
1047
        """
 
1048
        ensure_config_dir_exists(self.dir)
 
1049
        return self._lock.lock_write(token)
 
1050
 
 
1051
    def unlock(self):
 
1052
        self._lock.unlock()
 
1053
 
 
1054
    def break_lock(self):
 
1055
        self._lock.break_lock()
 
1056
 
 
1057
    @needs_write_lock
 
1058
    def remove_user_option(self, option_name, section_name=None):
 
1059
        super(LockableConfig, self).remove_user_option(option_name,
 
1060
                                                       section_name)
 
1061
 
 
1062
    def _write_config_file(self):
 
1063
        if self._lock is None or not self._lock.is_held:
 
1064
            # NB: if the following exception is raised it probably means a
 
1065
            # missing @needs_write_lock decorator on one of the callers.
 
1066
            raise errors.ObjectNotLocked(self)
 
1067
        super(LockableConfig, self)._write_config_file()
 
1068
 
 
1069
 
 
1070
class GlobalConfig(LockableConfig):
481
1071
    """The configuration that should be used for a specific location."""
482
1072
 
 
1073
    def __init__(self):
 
1074
        super(GlobalConfig, self).__init__(file_name=config_filename())
 
1075
 
 
1076
    def config_id(self):
 
1077
        return 'bazaar'
 
1078
 
 
1079
    @classmethod
 
1080
    def from_string(cls, str_or_unicode, save=False):
 
1081
        """Create a config object from a string.
 
1082
 
 
1083
        :param str_or_unicode: A string representing the file content. This
 
1084
            will be utf-8 encoded.
 
1085
 
 
1086
        :param save: Whether the file should be saved upon creation.
 
1087
        """
 
1088
        conf = cls()
 
1089
        conf._create_from_string(str_or_unicode, save)
 
1090
        return conf
 
1091
 
 
1092
    @deprecated_method(deprecated_in((2, 4, 0)))
483
1093
    def get_editor(self):
484
1094
        return self._get_user_option('editor')
485
1095
 
486
 
    def __init__(self):
487
 
        super(GlobalConfig, self).__init__(config_filename)
488
 
 
 
1096
    @needs_write_lock
489
1097
    def set_user_option(self, option, value):
490
1098
        """Save option and its value in the configuration."""
491
1099
        self._set_option(option, value, 'DEFAULT')
497
1105
        else:
498
1106
            return {}
499
1107
 
 
1108
    @needs_write_lock
500
1109
    def set_alias(self, alias_name, alias_command):
501
1110
        """Save the alias in the configuration."""
502
1111
        self._set_option(alias_name, alias_command, 'ALIASES')
503
1112
 
 
1113
    @needs_write_lock
504
1114
    def unset_alias(self, alias_name):
505
1115
        """Unset an existing alias."""
 
1116
        self.reload()
506
1117
        aliases = self._get_parser().get('ALIASES')
507
1118
        if not aliases or alias_name not in aliases:
508
1119
            raise errors.NoSuchAlias(alias_name)
510
1121
        self._write_config_file()
511
1122
 
512
1123
    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)
 
1124
        self.reload()
517
1125
        self._get_parser().setdefault(section, {})[option] = value
518
1126
        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):
 
1127
        for hook in OldConfigHooks['set']:
 
1128
            hook(self, option, value)
 
1129
 
 
1130
    def _get_sections(self, name=None):
 
1131
        """See IniBasedConfig._get_sections()."""
 
1132
        parser = self._get_parser()
 
1133
        # We don't give access to options defined outside of any section, we
 
1134
        # used the DEFAULT section by... default.
 
1135
        if name in (None, 'DEFAULT'):
 
1136
            # This could happen for an empty file where the DEFAULT section
 
1137
            # doesn't exist yet. So we force DEFAULT when yielding
 
1138
            name = 'DEFAULT'
 
1139
            if 'DEFAULT' not in parser:
 
1140
               parser['DEFAULT']= {}
 
1141
        yield (name, parser[name], self.config_id())
 
1142
 
 
1143
    @needs_write_lock
 
1144
    def remove_user_option(self, option_name, section_name=None):
 
1145
        if section_name is None:
 
1146
            # We need to force the default section.
 
1147
            section_name = 'DEFAULT'
 
1148
        # We need to avoid the LockableConfig implementation or we'll lock
 
1149
        # twice
 
1150
        super(LockableConfig, self).remove_user_option(option_name,
 
1151
                                                       section_name)
 
1152
 
 
1153
def _iter_for_location_by_parts(sections, location):
 
1154
    """Keep only the sessions matching the specified location.
 
1155
 
 
1156
    :param sections: An iterable of section names.
 
1157
 
 
1158
    :param location: An url or a local path to match against.
 
1159
 
 
1160
    :returns: An iterator of (section, extra_path, nb_parts) where nb is the
 
1161
        number of path components in the section name, section is the section
 
1162
        name and extra_path is the difference between location and the section
 
1163
        name.
 
1164
 
 
1165
    ``location`` will always be a local path and never a 'file://' url but the
 
1166
    section names themselves can be in either form.
 
1167
    """
 
1168
    location_parts = location.rstrip('/').split('/')
 
1169
 
 
1170
    for section in sections:
 
1171
        # location is a local path if possible, so we need to convert 'file://'
 
1172
        # urls in section names to local paths if necessary.
 
1173
 
 
1174
        # This also avoids having file:///path be a more exact
 
1175
        # match than '/path'.
 
1176
 
 
1177
        # FIXME: This still raises an issue if a user defines both file:///path
 
1178
        # *and* /path. Should we raise an error in this case -- vila 20110505
 
1179
 
 
1180
        if section.startswith('file://'):
 
1181
            section_path = urlutils.local_path_from_url(section)
 
1182
        else:
 
1183
            section_path = section
 
1184
        section_parts = section_path.rstrip('/').split('/')
 
1185
 
 
1186
        matched = True
 
1187
        if len(section_parts) > len(location_parts):
 
1188
            # More path components in the section, they can't match
 
1189
            matched = False
 
1190
        else:
 
1191
            # Rely on zip truncating in length to the length of the shortest
 
1192
            # argument sequence.
 
1193
            names = zip(location_parts, section_parts)
 
1194
            for name in names:
 
1195
                if not fnmatch.fnmatch(name[0], name[1]):
 
1196
                    matched = False
 
1197
                    break
 
1198
        if not matched:
 
1199
            continue
 
1200
        # build the path difference between the section and the location
 
1201
        extra_path = '/'.join(location_parts[len(section_parts):])
 
1202
        yield section, extra_path, len(section_parts)
 
1203
 
 
1204
 
 
1205
class LocationConfig(LockableConfig):
529
1206
    """A configuration object that gives the policy for a location."""
530
1207
 
531
1208
    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)
 
1209
        super(LocationConfig, self).__init__(
 
1210
            file_name=locations_config_filename())
544
1211
        # local file locations are looked up by local path, rather than
545
1212
        # by file url. This is because the config file is a user
546
1213
        # file, and we would rather not expose the user to file urls.
548
1215
            location = urlutils.local_path_from_url(location)
549
1216
        self.location = location
550
1217
 
 
1218
    def config_id(self):
 
1219
        return 'locations'
 
1220
 
 
1221
    @classmethod
 
1222
    def from_string(cls, str_or_unicode, location, save=False):
 
1223
        """Create a config object from a string.
 
1224
 
 
1225
        :param str_or_unicode: A string representing the file content. This will
 
1226
            be utf-8 encoded.
 
1227
 
 
1228
        :param location: The location url to filter the configuration.
 
1229
 
 
1230
        :param save: Whether the file should be saved upon creation.
 
1231
        """
 
1232
        conf = cls(location)
 
1233
        conf._create_from_string(str_or_unicode, save)
 
1234
        return conf
 
1235
 
551
1236
    def _get_matching_sections(self):
552
1237
        """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))
 
1238
        matches = list(_iter_for_location_by_parts(self._get_parser(),
 
1239
                                                   self.location))
 
1240
        # put the longest (aka more specific) locations first
 
1241
        matches.sort(
 
1242
            key=lambda (section, extra_path, length): (length, section),
 
1243
            reverse=True)
 
1244
        for (section, extra_path, length) in matches:
 
1245
            yield section, extra_path
588
1246
            # should we stop looking for parent configs here?
589
1247
            try:
590
1248
                if self._get_parser()[section].as_bool('ignore_parents'):
591
1249
                    break
592
1250
            except KeyError:
593
1251
                pass
594
 
        return sections
 
1252
 
 
1253
    def _get_sections(self, name=None):
 
1254
        """See IniBasedConfig._get_sections()."""
 
1255
        # We ignore the name here as the only sections handled are named with
 
1256
        # the location path and we don't expose embedded sections either.
 
1257
        parser = self._get_parser()
 
1258
        for name, extra_path in self._get_matching_sections():
 
1259
            yield (name, parser[name], self.config_id())
595
1260
 
596
1261
    def _get_option_policy(self, section, option_name):
597
1262
        """Return the policy for the given (section, option_name) pair."""
641
1306
            if policy_key in self._get_parser()[section]:
642
1307
                del self._get_parser()[section][policy_key]
643
1308
 
 
1309
    @needs_write_lock
644
1310
    def set_user_option(self, option, value, store=STORE_LOCATION):
645
1311
        """Save option and its value in the configuration."""
646
1312
        if store not in [STORE_LOCATION,
648
1314
                         STORE_LOCATION_APPENDPATH]:
649
1315
            raise ValueError('bad storage policy %r for %r' %
650
1316
                (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)
 
1317
        self.reload()
655
1318
        location = self.location
656
1319
        if location.endswith('/'):
657
1320
            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():
 
1321
        parser = self._get_parser()
 
1322
        if not location in parser and not location + '/' in parser:
 
1323
            parser[location] = {}
 
1324
        elif location + '/' in parser:
662
1325
            location = location + '/'
663
 
        self._get_parser()[location][option]=value
 
1326
        parser[location][option]=value
664
1327
        # the allowed values of store match the config policies
665
1328
        self._set_option_policy(location, option, store)
666
 
        self._get_parser().write(file(self._get_filename(), 'wb'))
 
1329
        self._write_config_file()
 
1330
        for hook in OldConfigHooks['set']:
 
1331
            hook(self, option, value)
667
1332
 
668
1333
 
669
1334
class BranchConfig(Config):
670
1335
    """A configuration object giving the policy for a branch."""
671
1336
 
 
1337
    def __init__(self, branch):
 
1338
        super(BranchConfig, self).__init__()
 
1339
        self._location_config = None
 
1340
        self._branch_data_config = None
 
1341
        self._global_config = None
 
1342
        self.branch = branch
 
1343
        self.option_sources = (self._get_location_config,
 
1344
                               self._get_branch_data_config,
 
1345
                               self._get_global_config)
 
1346
 
 
1347
    def config_id(self):
 
1348
        return 'branch'
 
1349
 
672
1350
    def _get_branch_data_config(self):
673
1351
        if self._branch_data_config is None:
674
1352
            self._branch_data_config = TreeConfig(self.branch)
 
1353
            self._branch_data_config.config_id = self.config_id
675
1354
        return self._branch_data_config
676
1355
 
677
1356
    def _get_location_config(self):
721
1400
            return (self.branch._transport.get_bytes("email")
722
1401
                    .decode(osutils.get_user_encoding())
723
1402
                    .rstrip("\r\n"))
724
 
        except errors.NoSuchFile, e:
 
1403
        except (errors.NoSuchFile, errors.PermissionDenied), e:
725
1404
            pass
726
1405
 
727
1406
        return self._get_best_value('_get_user_id')
745
1424
                return value
746
1425
        return None
747
1426
 
 
1427
    def _get_sections(self, name=None):
 
1428
        """See IniBasedConfig.get_sections()."""
 
1429
        for source in self.option_sources:
 
1430
            for section in source()._get_sections(name):
 
1431
                yield section
 
1432
 
 
1433
    def _get_options(self, sections=None):
 
1434
        opts = []
 
1435
        # First the locations options
 
1436
        for option in self._get_location_config()._get_options():
 
1437
            yield option
 
1438
        # Then the branch options
 
1439
        branch_config = self._get_branch_data_config()
 
1440
        if sections is None:
 
1441
            sections = [('DEFAULT', branch_config._get_parser())]
 
1442
        # FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
 
1443
        # Config itself has no notion of sections :( -- vila 20101001
 
1444
        config_id = self.config_id()
 
1445
        for (section_name, section) in sections:
 
1446
            for (name, value) in section.iteritems():
 
1447
                yield (name, value, section_name,
 
1448
                       config_id, branch_config._get_parser())
 
1449
        # Then the global options
 
1450
        for option in self._get_global_config()._get_options():
 
1451
            yield option
 
1452
 
748
1453
    def set_user_option(self, name, value, store=STORE_BRANCH,
749
1454
        warn_masked=False):
750
1455
        if store == STORE_BRANCH:
768
1473
                        trace.warning('Value "%s" is masked by "%s" from'
769
1474
                                      ' branch.conf', value, mask_value)
770
1475
 
 
1476
    def remove_user_option(self, option_name, section_name=None):
 
1477
        self._get_branch_data_config().remove_option(option_name, section_name)
 
1478
 
771
1479
    def _gpg_signing_command(self):
772
1480
        """See Config.gpg_signing_command."""
773
1481
        return self._get_safe_value('_gpg_signing_command')
774
1482
 
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
1483
    def _post_commit(self):
786
1484
        """See Config.post_commit."""
787
1485
        return self._get_safe_value('_post_commit')
803
1501
        """See Config.log_format."""
804
1502
        return self._get_best_value('_log_format')
805
1503
 
 
1504
    def _validate_signatures_in_log(self):
 
1505
        """See Config.validate_signatures_in_log."""
 
1506
        return self._get_best_value('_validate_signatures_in_log')
 
1507
 
 
1508
    def _acceptable_keys(self):
 
1509
        """See Config.acceptable_keys."""
 
1510
        return self._get_best_value('_acceptable_keys')
 
1511
 
806
1512
 
807
1513
def ensure_config_dir_exists(path=None):
808
1514
    """Make sure a configuration directory exists.
817
1523
            parent_dir = os.path.dirname(path)
818
1524
            if not os.path.isdir(parent_dir):
819
1525
                trace.mutter('creating config parent directory: %r', parent_dir)
820
 
            os.mkdir(parent_dir)
 
1526
                os.mkdir(parent_dir)
821
1527
        trace.mutter('creating config directory: %r', path)
822
1528
        os.mkdir(path)
823
1529
        osutils.copy_ownership_from_path(path)
826
1532
def config_dir():
827
1533
    """Return per-user configuration directory.
828
1534
 
829
 
    By default this is ~/.bazaar/
 
1535
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
 
1536
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
 
1537
    that will be used instead.
830
1538
 
831
1539
    TODO: Global option --config-dir to override this.
832
1540
    """
833
1541
    base = os.environ.get('BZR_HOME', None)
834
1542
    if sys.platform == 'win32':
 
1543
        # environ variables on Windows are in user encoding/mbcs. So decode
 
1544
        # before using one
 
1545
        if base is not None:
 
1546
            base = base.decode('mbcs')
835
1547
        if base is None:
836
1548
            base = win32utils.get_appdata_location_unicode()
837
1549
        if base is None:
838
1550
            base = os.environ.get('HOME', None)
 
1551
            if base is not None:
 
1552
                base = base.decode('mbcs')
839
1553
        if base is None:
840
1554
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
841
1555
                                  ' or HOME set')
842
1556
        return osutils.pathjoin(base, 'bazaar', '2.0')
843
1557
    else:
844
 
        # cygwin, linux, and darwin all have a $HOME directory
845
 
        if base is None:
 
1558
        if base is not None:
 
1559
            base = base.decode(osutils._fs_enc)
 
1560
    if sys.platform == 'darwin':
 
1561
        if base is None:
 
1562
            # this takes into account $HOME
 
1563
            base = os.path.expanduser("~")
 
1564
        return osutils.pathjoin(base, '.bazaar')
 
1565
    else:
 
1566
        if base is None:
 
1567
            xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
 
1568
            if xdg_dir is None:
 
1569
                xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
 
1570
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
 
1571
            if osutils.isdir(xdg_dir):
 
1572
                trace.mutter(
 
1573
                    "Using configuration in XDG directory %s." % xdg_dir)
 
1574
                return xdg_dir
846
1575
            base = os.path.expanduser("~")
847
1576
        return osutils.pathjoin(base, ".bazaar")
848
1577
 
852
1581
    return osutils.pathjoin(config_dir(), 'bazaar.conf')
853
1582
 
854
1583
 
855
 
def branches_config_filename():
856
 
    """Return per-user configuration ini file filename."""
857
 
    return osutils.pathjoin(config_dir(), 'branches.conf')
858
 
 
859
 
 
860
1584
def locations_config_filename():
861
1585
    """Return per-user configuration ini file filename."""
862
1586
    return osutils.pathjoin(config_dir(), 'locations.conf')
899
1623
        return os.path.expanduser('~/.cache')
900
1624
 
901
1625
 
 
1626
def _get_default_mail_domain():
 
1627
    """If possible, return the assumed default email domain.
 
1628
 
 
1629
    :returns: string mail domain, or None.
 
1630
    """
 
1631
    if sys.platform == 'win32':
 
1632
        # No implementation yet; patches welcome
 
1633
        return None
 
1634
    try:
 
1635
        f = open('/etc/mailname')
 
1636
    except (IOError, OSError), e:
 
1637
        return None
 
1638
    try:
 
1639
        domain = f.read().strip()
 
1640
        return domain
 
1641
    finally:
 
1642
        f.close()
 
1643
 
 
1644
 
902
1645
def _auto_user_id():
903
1646
    """Calculate automatic user identification.
904
1647
 
905
 
    Returns (realname, email).
 
1648
    :returns: (realname, email), either of which may be None if they can't be
 
1649
    determined.
906
1650
 
907
1651
    Only used when none is set in the environment or the id file.
908
1652
 
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.
 
1653
    This only returns an email address if we can be fairly sure the 
 
1654
    address is reasonable, ie if /etc/mailname is set on unix.
 
1655
 
 
1656
    This doesn't use the FQDN as the default domain because that may be 
 
1657
    slow, and it doesn't use the hostname alone because that's not normally 
 
1658
    a reasonable address.
912
1659
    """
913
 
    import socket
914
 
 
915
1660
    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())
 
1661
        # No implementation to reliably determine Windows default mail
 
1662
        # address; please add one.
 
1663
        return None, None
 
1664
 
 
1665
    default_mail_domain = _get_default_mail_domain()
 
1666
    if not default_mail_domain:
 
1667
        return None, None
 
1668
 
 
1669
    import pwd
 
1670
    uid = os.getuid()
 
1671
    try:
 
1672
        w = pwd.getpwuid(uid)
 
1673
    except KeyError:
 
1674
        trace.mutter('no passwd entry for uid %d?' % uid)
 
1675
        return None, None
 
1676
 
 
1677
    # we try utf-8 first, because on many variants (like Linux),
 
1678
    # /etc/passwd "should" be in utf-8, and because it's unlikely to give
 
1679
    # false positives.  (many users will have their user encoding set to
 
1680
    # latin-1, which cannot raise UnicodeError.)
 
1681
    try:
 
1682
        gecos = w.pw_gecos.decode('utf-8')
 
1683
        encoding = 'utf-8'
 
1684
    except UnicodeError:
 
1685
        try:
 
1686
            encoding = osutils.get_user_encoding()
 
1687
            gecos = w.pw_gecos.decode(encoding)
 
1688
        except UnicodeError, e:
 
1689
            trace.mutter("cannot decode passwd entry %s" % w)
 
1690
            return None, None
 
1691
    try:
 
1692
        username = w.pw_name.decode(encoding)
 
1693
    except UnicodeError, e:
 
1694
        trace.mutter("cannot decode passwd entry %s" % w)
 
1695
        return None, None
 
1696
 
 
1697
    comma = gecos.find(',')
 
1698
    if comma == -1:
 
1699
        realname = gecos
 
1700
    else:
 
1701
        realname = gecos[:comma]
 
1702
 
 
1703
    return realname, (username + '@' + default_mail_domain)
973
1704
 
974
1705
 
975
1706
def parse_username(username):
1020
1751
 
1021
1752
    def set_option(self, value, name, section=None):
1022
1753
        """Set a per-branch configuration option"""
 
1754
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1755
        # higher levels providing the right lock -- vila 20101004
1023
1756
        self.branch.lock_write()
1024
1757
        try:
1025
1758
            self._config.set_option(value, name, section)
1026
1759
        finally:
1027
1760
            self.branch.unlock()
1028
1761
 
 
1762
    def remove_option(self, option_name, section_name=None):
 
1763
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1764
        # higher levels providing the right lock -- vila 20101004
 
1765
        self.branch.lock_write()
 
1766
        try:
 
1767
            self._config.remove_option(option_name, section_name)
 
1768
        finally:
 
1769
            self.branch.unlock()
 
1770
 
1029
1771
 
1030
1772
class AuthenticationConfig(object):
1031
1773
    """The authentication configuration file based on a ini file.
1057
1799
            self._config = ConfigObj(self._input, encoding='utf-8')
1058
1800
        except configobj.ConfigObjError, e:
1059
1801
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
1802
        except UnicodeError:
 
1803
            raise errors.ConfigContentError(self._filename)
1060
1804
        return self._config
1061
1805
 
1062
1806
    def _save(self):
1063
1807
        """Save the config file, only tests should use it for now."""
1064
1808
        conf_dir = os.path.dirname(self._filename)
1065
1809
        ensure_config_dir_exists(conf_dir)
1066
 
        self._get_config().write(file(self._filename, 'wb'))
 
1810
        f = file(self._filename, 'wb')
 
1811
        try:
 
1812
            self._get_config().write(f)
 
1813
        finally:
 
1814
            f.close()
1067
1815
 
1068
1816
    def _set_option(self, section_name, option_name, value):
1069
1817
        """Set an authentication configuration option"""
1075
1823
        section[option_name] = value
1076
1824
        self._save()
1077
1825
 
1078
 
    def get_credentials(self, scheme, host, port=None, user=None, path=None, 
 
1826
    def get_credentials(self, scheme, host, port=None, user=None, path=None,
1079
1827
                        realm=None):
1080
1828
        """Returns the matching credentials from authentication.conf file.
1081
1829
 
1249
1997
            if ask:
1250
1998
                if prompt is None:
1251
1999
                    # Create a default prompt suitable for most cases
1252
 
                    prompt = scheme.upper() + ' %(host)s username'
 
2000
                    prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1253
2001
                # Special handling for optional fields in the prompt
1254
2002
                if port is not None:
1255
2003
                    prompt_host = '%s:%d' % (host, port)
1293
2041
        if password is None:
1294
2042
            if prompt is None:
1295
2043
                # Create a default prompt suitable for most cases
1296
 
                prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
 
2044
                prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
1297
2045
            # Special handling for optional fields in the prompt
1298
2046
            if port is not None:
1299
2047
                prompt_host = '%s:%d' % (host, port)
1470
2218
    """A Config that reads/writes a config file on a Transport.
1471
2219
 
1472
2220
    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.
 
2221
    that may be associated with a section.  Assigning meaning to these values
 
2222
    is done at higher levels like TreeConfig.
1475
2223
    """
1476
2224
 
1477
2225
    def __init__(self, transport, filename):
1494
2242
                section_obj = configobj[section]
1495
2243
            except KeyError:
1496
2244
                return default
1497
 
        return section_obj.get(name, default)
 
2245
        value = section_obj.get(name, default)
 
2246
        for hook in OldConfigHooks['get']:
 
2247
            hook(self, name, value)
 
2248
        return value
1498
2249
 
1499
2250
    def set_option(self, value, name, section=None):
1500
2251
        """Set the value associated with a named option.
1508
2259
            configobj[name] = value
1509
2260
        else:
1510
2261
            configobj.setdefault(section, {})[name] = value
 
2262
        for hook in OldConfigHooks['set']:
 
2263
            hook(self, name, value)
 
2264
        self._set_configobj(configobj)
 
2265
 
 
2266
    def remove_option(self, option_name, section_name=None):
 
2267
        configobj = self._get_configobj()
 
2268
        if section_name is None:
 
2269
            del configobj[option_name]
 
2270
        else:
 
2271
            del configobj[section_name][option_name]
 
2272
        for hook in OldConfigHooks['remove']:
 
2273
            hook(self, option_name)
1511
2274
        self._set_configobj(configobj)
1512
2275
 
1513
2276
    def _get_config_file(self):
1514
2277
        try:
1515
 
            return StringIO(self._transport.get_bytes(self._filename))
 
2278
            f = StringIO(self._transport.get_bytes(self._filename))
 
2279
            for hook in OldConfigHooks['load']:
 
2280
                hook(self)
 
2281
            return f
1516
2282
        except errors.NoSuchFile:
1517
2283
            return StringIO()
 
2284
        except errors.PermissionDenied, e:
 
2285
            trace.warning("Permission denied while trying to open "
 
2286
                "configuration file %s.", urlutils.unescape_for_display(
 
2287
                urlutils.join(self._transport.base, self._filename), "utf-8"))
 
2288
            return StringIO()
 
2289
 
 
2290
    def _external_url(self):
 
2291
        return urlutils.join(self._transport.external_url(), self._filename)
1518
2292
 
1519
2293
    def _get_configobj(self):
1520
 
        return ConfigObj(self._get_config_file(), encoding='utf-8')
 
2294
        f = self._get_config_file()
 
2295
        try:
 
2296
            try:
 
2297
                conf = ConfigObj(f, encoding='utf-8')
 
2298
            except configobj.ConfigObjError, e:
 
2299
                raise errors.ParseConfigError(e.errors, self._external_url())
 
2300
            except UnicodeDecodeError:
 
2301
                raise errors.ConfigContentError(self._external_url())
 
2302
        finally:
 
2303
            f.close()
 
2304
        return conf
1521
2305
 
1522
2306
    def _set_configobj(self, configobj):
1523
2307
        out_file = StringIO()
1524
2308
        configobj.write(out_file)
1525
2309
        out_file.seek(0)
1526
2310
        self._transport.put_file(self._filename, out_file)
 
2311
        for hook in OldConfigHooks['save']:
 
2312
            hook(self)
 
2313
 
 
2314
 
 
2315
class Option(object):
 
2316
    """An option definition.
 
2317
 
 
2318
    The option *values* are stored in config files and found in sections.
 
2319
 
 
2320
    Here we define various properties about the option itself, its default
 
2321
    value, how to convert it from stores, what to do when invalid values are
 
2322
    encoutered, in which config files it can be stored.
 
2323
    """
 
2324
 
 
2325
    def __init__(self, name, default=None, default_from_env=None,
 
2326
                 help=None,
 
2327
                 from_unicode=None, invalid=None):
 
2328
        """Build an option definition.
 
2329
 
 
2330
        :param name: the name used to refer to the option.
 
2331
 
 
2332
        :param default: the default value to use when none exist in the config
 
2333
            stores. This is either a string that ``from_unicode`` will convert
 
2334
            into the proper type, a callable returning a unicode string so that
 
2335
            ``from_unicode`` can be used on the return value, or a python
 
2336
            object that can be stringified (so only the empty list is supported
 
2337
            for example).
 
2338
 
 
2339
        :param default_from_env: A list of environment variables which can
 
2340
           provide a default value. 'default' will be used only if none of the
 
2341
           variables specified here are set in the environment.
 
2342
 
 
2343
        :param help: a doc string to explain the option to the user.
 
2344
 
 
2345
        :param from_unicode: a callable to convert the unicode string
 
2346
            representing the option value in a store. This is not called for
 
2347
            the default value.
 
2348
 
 
2349
        :param invalid: the action to be taken when an invalid value is
 
2350
            encountered in a store. This is called only when from_unicode is
 
2351
            invoked to convert a string and returns None or raise ValueError or
 
2352
            TypeError. Accepted values are: None (ignore invalid values),
 
2353
            'warning' (emit a warning), 'error' (emit an error message and
 
2354
            terminates).
 
2355
        """
 
2356
        if default_from_env is None:
 
2357
            default_from_env = []
 
2358
        self.name = name
 
2359
        # Convert the default value to a unicode string so all values are
 
2360
        # strings internally before conversion (via from_unicode) is attempted.
 
2361
        if default is None:
 
2362
            self.default = None
 
2363
        elif isinstance(default, list):
 
2364
            # Only the empty list is supported
 
2365
            if default:
 
2366
                raise AssertionError(
 
2367
                    'Only empty lists are supported as default values')
 
2368
            self.default = u','
 
2369
        elif isinstance(default, (str, unicode, bool, int, float)):
 
2370
            # Rely on python to convert strings, booleans and integers
 
2371
            self.default = u'%s' % (default,)
 
2372
        elif callable(default):
 
2373
            self.default = default
 
2374
        else:
 
2375
            # other python objects are not expected
 
2376
            raise AssertionError('%r is not supported as a default value'
 
2377
                                 % (default,))
 
2378
        self.default_from_env = default_from_env
 
2379
        self.help = help
 
2380
        self.from_unicode = from_unicode
 
2381
        if invalid and invalid not in ('warning', 'error'):
 
2382
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
 
2383
        self.invalid = invalid
 
2384
 
 
2385
    def convert_from_unicode(self, unicode_value):
 
2386
        if self.from_unicode is None or unicode_value is None:
 
2387
            # Don't convert or nothing to convert
 
2388
            return unicode_value
 
2389
        try:
 
2390
            converted = self.from_unicode(unicode_value)
 
2391
        except (ValueError, TypeError):
 
2392
            # Invalid values are ignored
 
2393
            converted = None
 
2394
        if converted is None and self.invalid is not None:
 
2395
            # The conversion failed
 
2396
            if self.invalid == 'warning':
 
2397
                trace.warning('Value "%s" is not valid for "%s"',
 
2398
                              unicode_value, self.name)
 
2399
            elif self.invalid == 'error':
 
2400
                raise errors.ConfigOptionValueError(self.name, unicode_value)
 
2401
        return converted
 
2402
 
 
2403
    def get_default(self):
 
2404
        value = None
 
2405
        for var in self.default_from_env:
 
2406
            try:
 
2407
                # If the env variable is defined, its value is the default one
 
2408
                value = os.environ[var]
 
2409
                break
 
2410
            except KeyError:
 
2411
                continue
 
2412
        if value is None:
 
2413
            # Otherwise, fallback to the value defined at registration
 
2414
            if callable(self.default):
 
2415
                value = self.default()
 
2416
                if not isinstance(value, unicode):
 
2417
                    raise AssertionError(
 
2418
                    'Callable default values should be unicode')
 
2419
            else:
 
2420
                value = self.default
 
2421
        return value
 
2422
 
 
2423
    def get_help_text(self, additional_see_also=None, plain=True):
 
2424
        result = self.help
 
2425
        from bzrlib import help_topics
 
2426
        result += help_topics._format_see_also(additional_see_also)
 
2427
        if plain:
 
2428
            result = help_topics.help_as_plain_text(result)
 
2429
        return result
 
2430
 
 
2431
 
 
2432
# Predefined converters to get proper values from store
 
2433
 
 
2434
def bool_from_store(unicode_str):
 
2435
    return ui.bool_from_string(unicode_str)
 
2436
 
 
2437
 
 
2438
def int_from_store(unicode_str):
 
2439
    return int(unicode_str)
 
2440
 
 
2441
 
 
2442
def float_from_store(unicode_str):
 
2443
    return float(unicode_str)
 
2444
 
 
2445
 
 
2446
 
 
2447
# Use a an empty dict to initialize an empty configobj avoiding all
 
2448
# parsing and encoding checks
 
2449
_list_converter_config = configobj.ConfigObj(
 
2450
    {}, encoding='utf-8', list_values=True, interpolation=False)
 
2451
 
 
2452
 
 
2453
def list_from_store(unicode_str):
 
2454
    if not isinstance(unicode_str, basestring):
 
2455
        raise TypeError
 
2456
    # Now inject our string directly as unicode. All callers got their value
 
2457
    # from configobj, so values that need to be quoted are already properly
 
2458
    # quoted.
 
2459
    _list_converter_config.reset()
 
2460
    _list_converter_config._parse([u"list=%s" % (unicode_str,)])
 
2461
    maybe_list = _list_converter_config['list']
 
2462
    # ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
 
2463
    if isinstance(maybe_list, basestring):
 
2464
        if maybe_list:
 
2465
            # A single value, most probably the user forgot (or didn't care to
 
2466
            # add) the final ','
 
2467
            l = [maybe_list]
 
2468
        else:
 
2469
            # The empty string, convert to empty list
 
2470
            l = []
 
2471
    else:
 
2472
        # We rely on ConfigObj providing us with a list already
 
2473
        l = maybe_list
 
2474
    return l
 
2475
 
 
2476
 
 
2477
class OptionRegistry(registry.Registry):
 
2478
    """Register config options by their name.
 
2479
 
 
2480
    This overrides ``registry.Registry`` to simplify registration by acquiring
 
2481
    some information from the option object itself.
 
2482
    """
 
2483
 
 
2484
    def register(self, option):
 
2485
        """Register a new option to its name.
 
2486
 
 
2487
        :param option: The option to register. Its name is used as the key.
 
2488
        """
 
2489
        super(OptionRegistry, self).register(option.name, option,
 
2490
                                             help=option.help)
 
2491
 
 
2492
    def register_lazy(self, key, module_name, member_name):
 
2493
        """Register a new option to be loaded on request.
 
2494
 
 
2495
        :param key: the key to request the option later. Since the registration
 
2496
            is lazy, it should be provided and match the option name.
 
2497
 
 
2498
        :param module_name: the python path to the module. Such as 'os.path'.
 
2499
 
 
2500
        :param member_name: the member of the module to return.  If empty or 
 
2501
                None, get() will return the module itself.
 
2502
        """
 
2503
        super(OptionRegistry, self).register_lazy(key,
 
2504
                                                  module_name, member_name)
 
2505
 
 
2506
    def get_help(self, key=None):
 
2507
        """Get the help text associated with the given key"""
 
2508
        option = self.get(key)
 
2509
        the_help = option.help
 
2510
        if callable(the_help):
 
2511
            return the_help(self, key)
 
2512
        return the_help
 
2513
 
 
2514
 
 
2515
option_registry = OptionRegistry()
 
2516
 
 
2517
 
 
2518
# Registered options in lexicographical order
 
2519
 
 
2520
option_registry.register(
 
2521
    Option('bzr.workingtree.worth_saving_limit', default=10,
 
2522
           from_unicode=int_from_store,  invalid='warning',
 
2523
           help='''\
 
2524
How many changes before saving the dirstate.
 
2525
 
 
2526
-1 means that we will never rewrite the dirstate file for only
 
2527
stat-cache changes. Regardless of this setting, we will always rewrite
 
2528
the dirstate file if a file is added/removed/renamed/etc. This flag only
 
2529
affects the behavior of updating the dirstate file after we notice that
 
2530
a file has been touched.
 
2531
'''))
 
2532
option_registry.register(
 
2533
    Option('dirstate.fdatasync', default=True,
 
2534
           from_unicode=bool_from_store,
 
2535
           help='''\
 
2536
Flush dirstate changes onto physical disk?
 
2537
 
 
2538
If true (default), working tree metadata changes are flushed through the
 
2539
OS buffers to physical disk.  This is somewhat slower, but means data
 
2540
should not be lost if the machine crashes.  See also repository.fdatasync.
 
2541
'''))
 
2542
option_registry.register(
 
2543
    Option('debug_flags', default=[], from_unicode=list_from_store,
 
2544
           help='Debug flags to activate.'))
 
2545
option_registry.register(
 
2546
    Option('default_format', default='2a',
 
2547
           help='Format used when creating branches.'))
 
2548
option_registry.register(
 
2549
    Option('dpush_strict', default=None,
 
2550
           from_unicode=bool_from_store,
 
2551
           help='''\
 
2552
The default value for ``dpush --strict``.
 
2553
 
 
2554
If present, defines the ``--strict`` option default value for checking
 
2555
uncommitted changes before pushing into a different VCS without any
 
2556
custom bzr metadata.
 
2557
'''))
 
2558
option_registry.register(
 
2559
    Option('editor',
 
2560
           help='The command called to launch an editor to enter a message.'))
 
2561
option_registry.register(
 
2562
    Option('ignore_missing_extensions', default=False,
 
2563
           from_unicode=bool_from_store,
 
2564
           help='''\
 
2565
Control the missing extensions warning display.
 
2566
 
 
2567
The warning will not be emitted if set to True.
 
2568
'''))
 
2569
option_registry.register(
 
2570
    Option('language',
 
2571
           help='Language to translate messages into.'))
 
2572
option_registry.register(
 
2573
    Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
 
2574
           help='''\
 
2575
Steal locks that appears to be dead.
 
2576
 
 
2577
If set to True, bzr will check if a lock is supposed to be held by an
 
2578
active process from the same user on the same machine. If the user and
 
2579
machine match, but no process with the given PID is active, then bzr
 
2580
will automatically break the stale lock, and create a new lock for
 
2581
this process.
 
2582
Otherwise, bzr will prompt as normal to break the lock.
 
2583
'''))
 
2584
option_registry.register(
 
2585
    Option('log_format', default='long',
 
2586
           help= '''\
 
2587
Log format to use when displaying revisions.
 
2588
 
 
2589
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
 
2590
may be provided by plugins.
 
2591
'''))
 
2592
option_registry.register(
 
2593
    Option('output_encoding',
 
2594
           help= 'Unicode encoding for output'
 
2595
           ' (terminal encoding if not specified).'))
 
2596
option_registry.register(
 
2597
    Option('push_strict', default=None,
 
2598
           from_unicode=bool_from_store,
 
2599
           help='''\
 
2600
The default value for ``push --strict``.
 
2601
 
 
2602
If present, defines the ``--strict`` option default value for checking
 
2603
uncommitted changes before sending a merge directive.
 
2604
'''))
 
2605
option_registry.register(
 
2606
    Option('repository.fdatasync', default=True,
 
2607
           from_unicode=bool_from_store,
 
2608
           help='''\
 
2609
Flush repository changes onto physical disk?
 
2610
 
 
2611
If true (default), repository changes are flushed through the OS buffers
 
2612
to physical disk.  This is somewhat slower, but means data should not be
 
2613
lost if the machine crashes.  See also dirstate.fdatasync.
 
2614
'''))
 
2615
 
 
2616
option_registry.register(
 
2617
    Option('selftest.timeout',
 
2618
        default='600',
 
2619
        from_unicode=int_from_store,
 
2620
        help='Abort selftest if one test takes longer than this many seconds',
 
2621
        ))
 
2622
 
 
2623
option_registry.register(
 
2624
    Option('send_strict', default=None,
 
2625
           from_unicode=bool_from_store,
 
2626
           help='''\
 
2627
The default value for ``send --strict``.
 
2628
 
 
2629
If present, defines the ``--strict`` option default value for checking
 
2630
uncommitted changes before pushing.
 
2631
'''))
 
2632
 
 
2633
option_registry.register(
 
2634
    Option('serve.client_timeout',
 
2635
           default=300.0, from_unicode=float_from_store,
 
2636
           help="If we wait for a new request from a client for more than"
 
2637
                " X seconds, consider the client idle, and hangup."))
 
2638
 
 
2639
 
 
2640
class Section(object):
 
2641
    """A section defines a dict of option name => value.
 
2642
 
 
2643
    This is merely a read-only dict which can add some knowledge about the
 
2644
    options. It is *not* a python dict object though and doesn't try to mimic
 
2645
    its API.
 
2646
    """
 
2647
 
 
2648
    def __init__(self, section_id, options):
 
2649
        self.id = section_id
 
2650
        # We re-use the dict-like object received
 
2651
        self.options = options
 
2652
 
 
2653
    def get(self, name, default=None, expand=True):
 
2654
        return self.options.get(name, default)
 
2655
 
 
2656
    def iter_option_names(self):
 
2657
        for k in self.options.iterkeys():
 
2658
            yield k
 
2659
 
 
2660
    def __repr__(self):
 
2661
        # Mostly for debugging use
 
2662
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
 
2663
 
 
2664
 
 
2665
_NewlyCreatedOption = object()
 
2666
"""Was the option created during the MutableSection lifetime"""
 
2667
 
 
2668
 
 
2669
class MutableSection(Section):
 
2670
    """A section allowing changes and keeping track of the original values."""
 
2671
 
 
2672
    def __init__(self, section_id, options):
 
2673
        super(MutableSection, self).__init__(section_id, options)
 
2674
        self.orig = {}
 
2675
 
 
2676
    def set(self, name, value):
 
2677
        if name not in self.options:
 
2678
            # This is a new option
 
2679
            self.orig[name] = _NewlyCreatedOption
 
2680
        elif name not in self.orig:
 
2681
            self.orig[name] = self.get(name, None)
 
2682
        self.options[name] = value
 
2683
 
 
2684
    def remove(self, name):
 
2685
        if name not in self.orig:
 
2686
            self.orig[name] = self.get(name, None)
 
2687
        del self.options[name]
 
2688
 
 
2689
 
 
2690
class Store(object):
 
2691
    """Abstract interface to persistent storage for configuration options."""
 
2692
 
 
2693
    readonly_section_class = Section
 
2694
    mutable_section_class = MutableSection
 
2695
 
 
2696
    def is_loaded(self):
 
2697
        """Returns True if the Store has been loaded.
 
2698
 
 
2699
        This is used to implement lazy loading and ensure the persistent
 
2700
        storage is queried only when needed.
 
2701
        """
 
2702
        raise NotImplementedError(self.is_loaded)
 
2703
 
 
2704
    def load(self):
 
2705
        """Loads the Store from persistent storage."""
 
2706
        raise NotImplementedError(self.load)
 
2707
 
 
2708
    def _load_from_string(self, bytes):
 
2709
        """Create a store from a string in configobj syntax.
 
2710
 
 
2711
        :param bytes: A string representing the file content.
 
2712
        """
 
2713
        raise NotImplementedError(self._load_from_string)
 
2714
 
 
2715
    def unload(self):
 
2716
        """Unloads the Store.
 
2717
 
 
2718
        This should make is_loaded() return False. This is used when the caller
 
2719
        knows that the persistent storage has changed or may have change since
 
2720
        the last load.
 
2721
        """
 
2722
        raise NotImplementedError(self.unload)
 
2723
 
 
2724
    def save(self):
 
2725
        """Saves the Store to persistent storage."""
 
2726
        raise NotImplementedError(self.save)
 
2727
 
 
2728
    def external_url(self):
 
2729
        raise NotImplementedError(self.external_url)
 
2730
 
 
2731
    def get_sections(self):
 
2732
        """Returns an ordered iterable of existing sections.
 
2733
 
 
2734
        :returns: An iterable of (store, section).
 
2735
        """
 
2736
        raise NotImplementedError(self.get_sections)
 
2737
 
 
2738
    def get_mutable_section(self, section_id=None):
 
2739
        """Returns the specified mutable section.
 
2740
 
 
2741
        :param section_id: The section identifier
 
2742
        """
 
2743
        raise NotImplementedError(self.get_mutable_section)
 
2744
 
 
2745
    def __repr__(self):
 
2746
        # Mostly for debugging use
 
2747
        return "<config.%s(%s)>" % (self.__class__.__name__,
 
2748
                                    self.external_url())
 
2749
 
 
2750
 
 
2751
class CommandLineStore(Store):
 
2752
    "A store to carry command line overrides for the config options."""
 
2753
 
 
2754
    def __init__(self, opts=None):
 
2755
        super(CommandLineStore, self).__init__()
 
2756
        if opts is None:
 
2757
            opts = {}
 
2758
        self.options = {}
 
2759
 
 
2760
    def _reset(self):
 
2761
        # The dict should be cleared but not replaced so it can be shared.
 
2762
        self.options.clear()
 
2763
 
 
2764
    def _from_cmdline(self, overrides):
 
2765
        # Reset before accepting new definitions
 
2766
        self._reset()
 
2767
        for over in overrides:
 
2768
            try:
 
2769
                name, value = over.split('=', 1)
 
2770
            except ValueError:
 
2771
                raise errors.BzrCommandError(
 
2772
                    gettext("Invalid '%s', should be of the form 'name=value'")
 
2773
                    % (over,))
 
2774
            self.options[name] = value
 
2775
 
 
2776
    def external_url(self):
 
2777
        # Not an url but it makes debugging easier and is never needed
 
2778
        # otherwise
 
2779
        return 'cmdline'
 
2780
 
 
2781
    def get_sections(self):
 
2782
        yield self,  self.readonly_section_class('cmdline_overrides',
 
2783
                                                 self.options)
 
2784
 
 
2785
 
 
2786
class IniFileStore(Store):
 
2787
    """A config Store using ConfigObj for storage.
 
2788
 
 
2789
    :ivar transport: The transport object where the config file is located.
 
2790
 
 
2791
    :ivar file_name: The config file basename in the transport directory.
 
2792
 
 
2793
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
 
2794
        serialize/deserialize the config file.
 
2795
    """
 
2796
 
 
2797
    def __init__(self):
 
2798
        """A config Store using ConfigObj for storage.
 
2799
        """
 
2800
        super(IniFileStore, self).__init__()
 
2801
        self._config_obj = None
 
2802
 
 
2803
    def is_loaded(self):
 
2804
        return self._config_obj != None
 
2805
 
 
2806
    def unload(self):
 
2807
        self._config_obj = None
 
2808
 
 
2809
    def _load_content(self):
 
2810
        """Load the config file bytes.
 
2811
 
 
2812
        This should be provided by subclasses
 
2813
 
 
2814
        :return: Byte string
 
2815
        """
 
2816
        raise NotImplementedError(self._load_content)
 
2817
 
 
2818
    def _save_content(self, content):
 
2819
        """Save the config file bytes.
 
2820
 
 
2821
        This should be provided by subclasses
 
2822
 
 
2823
        :param content: Config file bytes to write
 
2824
        """
 
2825
        raise NotImplementedError(self._save_content)
 
2826
 
 
2827
    def load(self):
 
2828
        """Load the store from the associated file."""
 
2829
        if self.is_loaded():
 
2830
            return
 
2831
        content = self._load_content()
 
2832
        self._load_from_string(content)
 
2833
        for hook in ConfigHooks['load']:
 
2834
            hook(self)
 
2835
 
 
2836
    def _load_from_string(self, bytes):
 
2837
        """Create a config store from a string.
 
2838
 
 
2839
        :param bytes: A string representing the file content.
 
2840
        """
 
2841
        if self.is_loaded():
 
2842
            raise AssertionError('Already loaded: %r' % (self._config_obj,))
 
2843
        co_input = StringIO(bytes)
 
2844
        try:
 
2845
            # The config files are always stored utf8-encoded
 
2846
            self._config_obj = ConfigObj(co_input, encoding='utf-8',
 
2847
                                         list_values=False)
 
2848
        except configobj.ConfigObjError, e:
 
2849
            self._config_obj = None
 
2850
            raise errors.ParseConfigError(e.errors, self.external_url())
 
2851
        except UnicodeDecodeError:
 
2852
            raise errors.ConfigContentError(self.external_url())
 
2853
 
 
2854
    def save(self):
 
2855
        if not self.is_loaded():
 
2856
            # Nothing to save
 
2857
            return
 
2858
        out = StringIO()
 
2859
        self._config_obj.write(out)
 
2860
        self._save_content(out.getvalue())
 
2861
        for hook in ConfigHooks['save']:
 
2862
            hook(self)
 
2863
 
 
2864
    def get_sections(self):
 
2865
        """Get the configobj section in the file order.
 
2866
 
 
2867
        :returns: An iterable of (store, section).
 
2868
        """
 
2869
        # We need a loaded store
 
2870
        try:
 
2871
            self.load()
 
2872
        except (errors.NoSuchFile, errors.PermissionDenied):
 
2873
            # If the file can't be read, there is no sections
 
2874
            return
 
2875
        cobj = self._config_obj
 
2876
        if cobj.scalars:
 
2877
            yield self, self.readonly_section_class(None, cobj)
 
2878
        for section_name in cobj.sections:
 
2879
            yield (self,
 
2880
                   self.readonly_section_class(section_name,
 
2881
                                               cobj[section_name]))
 
2882
 
 
2883
    def get_mutable_section(self, section_id=None):
 
2884
        # We need a loaded store
 
2885
        try:
 
2886
            self.load()
 
2887
        except errors.NoSuchFile:
 
2888
            # The file doesn't exist, let's pretend it was empty
 
2889
            self._load_from_string('')
 
2890
        if section_id is None:
 
2891
            section = self._config_obj
 
2892
        else:
 
2893
            section = self._config_obj.setdefault(section_id, {})
 
2894
        return self.mutable_section_class(section_id, section)
 
2895
 
 
2896
 
 
2897
class TransportIniFileStore(IniFileStore):
 
2898
    """IniFileStore that loads files from a transport.
 
2899
    """
 
2900
 
 
2901
    def __init__(self, transport, file_name):
 
2902
        """A Store using a ini file on a Transport
 
2903
 
 
2904
        :param transport: The transport object where the config file is located.
 
2905
        :param file_name: The config file basename in the transport directory.
 
2906
        """
 
2907
        super(TransportIniFileStore, self).__init__()
 
2908
        self.transport = transport
 
2909
        self.file_name = file_name
 
2910
 
 
2911
    def _load_content(self):
 
2912
        try:
 
2913
            return self.transport.get_bytes(self.file_name)
 
2914
        except errors.PermissionDenied:
 
2915
            trace.warning("Permission denied while trying to load "
 
2916
                          "configuration store %s.", self.external_url())
 
2917
            raise
 
2918
 
 
2919
    def _save_content(self, content):
 
2920
        self.transport.put_bytes(self.file_name, content)
 
2921
 
 
2922
    def external_url(self):
 
2923
        # FIXME: external_url should really accepts an optional relpath
 
2924
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
2925
        # The following will do in the interim but maybe we don't want to
 
2926
        # expose a path here but rather a config ID and its associated
 
2927
        # object </hand wawe>.
 
2928
        return urlutils.join(self.transport.external_url(), self.file_name)
 
2929
 
 
2930
 
 
2931
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
 
2932
# unlockable stores for use with objects that can already ensure the locking
 
2933
# (think branches). If different stores (not based on ConfigObj) are created,
 
2934
# they may face the same issue.
 
2935
 
 
2936
 
 
2937
class LockableIniFileStore(TransportIniFileStore):
 
2938
    """A ConfigObjStore using locks on save to ensure store integrity."""
 
2939
 
 
2940
    def __init__(self, transport, file_name, lock_dir_name=None):
 
2941
        """A config Store using ConfigObj for storage.
 
2942
 
 
2943
        :param transport: The transport object where the config file is located.
 
2944
 
 
2945
        :param file_name: The config file basename in the transport directory.
 
2946
        """
 
2947
        if lock_dir_name is None:
 
2948
            lock_dir_name = 'lock'
 
2949
        self.lock_dir_name = lock_dir_name
 
2950
        super(LockableIniFileStore, self).__init__(transport, file_name)
 
2951
        self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
 
2952
 
 
2953
    def lock_write(self, token=None):
 
2954
        """Takes a write lock in the directory containing the config file.
 
2955
 
 
2956
        If the directory doesn't exist it is created.
 
2957
        """
 
2958
        # FIXME: This doesn't check the ownership of the created directories as
 
2959
        # ensure_config_dir_exists does. It should if the transport is local
 
2960
        # -- vila 2011-04-06
 
2961
        self.transport.create_prefix()
 
2962
        return self._lock.lock_write(token)
 
2963
 
 
2964
    def unlock(self):
 
2965
        self._lock.unlock()
 
2966
 
 
2967
    def break_lock(self):
 
2968
        self._lock.break_lock()
 
2969
 
 
2970
    @needs_write_lock
 
2971
    def save(self):
 
2972
        # We need to be able to override the undecorated implementation
 
2973
        self.save_without_locking()
 
2974
 
 
2975
    def save_without_locking(self):
 
2976
        super(LockableIniFileStore, self).save()
 
2977
 
 
2978
 
 
2979
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
 
2980
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
 
2981
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
 
2982
 
 
2983
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
 
2984
# functions or a registry will make it easier and clearer for tests, focusing
 
2985
# on the relevant parts of the API that needs testing -- vila 20110503 (based
 
2986
# on a poolie's remark)
 
2987
class GlobalStore(LockableIniFileStore):
 
2988
 
 
2989
    def __init__(self, possible_transports=None):
 
2990
        t = transport.get_transport_from_path(
 
2991
            config_dir(), possible_transports=possible_transports)
 
2992
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
2993
        self.id = 'bazaar'
 
2994
 
 
2995
 
 
2996
class LocationStore(LockableIniFileStore):
 
2997
 
 
2998
    def __init__(self, possible_transports=None):
 
2999
        t = transport.get_transport_from_path(
 
3000
            config_dir(), possible_transports=possible_transports)
 
3001
        super(LocationStore, self).__init__(t, 'locations.conf')
 
3002
        self.id = 'locations'
 
3003
 
 
3004
 
 
3005
class BranchStore(TransportIniFileStore):
 
3006
 
 
3007
    def __init__(self, branch):
 
3008
        super(BranchStore, self).__init__(branch.control_transport,
 
3009
                                          'branch.conf')
 
3010
        self.branch = branch
 
3011
        self.id = 'branch'
 
3012
 
 
3013
    def lock_write(self, token=None):
 
3014
        return self.branch.lock_write(token)
 
3015
 
 
3016
    def unlock(self):
 
3017
        return self.branch.unlock()
 
3018
 
 
3019
    @needs_write_lock
 
3020
    def save(self):
 
3021
        # We need to be able to override the undecorated implementation
 
3022
        self.save_without_locking()
 
3023
 
 
3024
    def save_without_locking(self):
 
3025
        super(BranchStore, self).save()
 
3026
 
 
3027
 
 
3028
class ControlStore(LockableIniFileStore):
 
3029
 
 
3030
    def __init__(self, bzrdir):
 
3031
        super(ControlStore, self).__init__(bzrdir.transport,
 
3032
                                          'control.conf',
 
3033
                                           lock_dir_name='branch_lock')
 
3034
 
 
3035
 
 
3036
class SectionMatcher(object):
 
3037
    """Select sections into a given Store.
 
3038
 
 
3039
    This is intended to be used to postpone getting an iterable of sections
 
3040
    from a store.
 
3041
    """
 
3042
 
 
3043
    def __init__(self, store):
 
3044
        self.store = store
 
3045
 
 
3046
    def get_sections(self):
 
3047
        # This is where we require loading the store so we can see all defined
 
3048
        # sections.
 
3049
        sections = self.store.get_sections()
 
3050
        # Walk the revisions in the order provided
 
3051
        for store, s in sections:
 
3052
            if self.match(s):
 
3053
                yield store, s
 
3054
 
 
3055
    def match(self, section):
 
3056
        """Does the proposed section match.
 
3057
 
 
3058
        :param section: A Section object.
 
3059
 
 
3060
        :returns: True if the section matches, False otherwise.
 
3061
        """
 
3062
        raise NotImplementedError(self.match)
 
3063
 
 
3064
 
 
3065
class NameMatcher(SectionMatcher):
 
3066
 
 
3067
    def __init__(self, store, section_id):
 
3068
        super(NameMatcher, self).__init__(store)
 
3069
        self.section_id = section_id
 
3070
 
 
3071
    def match(self, section):
 
3072
        return section.id == self.section_id
 
3073
 
 
3074
 
 
3075
class LocationSection(Section):
 
3076
 
 
3077
    def __init__(self, section, length, extra_path):
 
3078
        super(LocationSection, self).__init__(section.id, section.options)
 
3079
        self.length = length
 
3080
        self.extra_path = extra_path
 
3081
        self.locals = {'relpath': extra_path,
 
3082
                       'basename': urlutils.basename(extra_path)}
 
3083
 
 
3084
    def get(self, name, default=None, expand=True):
 
3085
        value = super(LocationSection, self).get(name, default)
 
3086
        if value is not None and expand:
 
3087
            policy_name = self.get(name + ':policy', None)
 
3088
            policy = _policy_value.get(policy_name, POLICY_NONE)
 
3089
            if policy == POLICY_APPENDPATH:
 
3090
                value = urlutils.join(value, self.extra_path)
 
3091
            # expand section local options right now (since POLICY_APPENDPATH
 
3092
            # will never add options references, it's ok to expand after it).
 
3093
            chunks = []
 
3094
            for is_ref, chunk in iter_option_refs(value):
 
3095
                if not is_ref:
 
3096
                    chunks.append(chunk)
 
3097
                else:
 
3098
                    ref = chunk[1:-1]
 
3099
                    if ref in self.locals:
 
3100
                        chunks.append(self.locals[ref])
 
3101
                    else:
 
3102
                        chunks.append(chunk)
 
3103
            value = ''.join(chunks)
 
3104
        return value
 
3105
 
 
3106
 
 
3107
class LocationMatcher(SectionMatcher):
 
3108
 
 
3109
    def __init__(self, store, location):
 
3110
        super(LocationMatcher, self).__init__(store)
 
3111
        if location.startswith('file://'):
 
3112
            location = urlutils.local_path_from_url(location)
 
3113
        self.location = location
 
3114
 
 
3115
    def _get_matching_sections(self):
 
3116
        """Get all sections matching ``location``."""
 
3117
        # We slightly diverge from LocalConfig here by allowing the no-name
 
3118
        # section as the most generic one and the lower priority.
 
3119
        no_name_section = None
 
3120
        all_sections = []
 
3121
        # Filter out the no_name_section so _iter_for_location_by_parts can be
 
3122
        # used (it assumes all sections have a name).
 
3123
        for _, section in self.store.get_sections():
 
3124
            if section.id is None:
 
3125
                no_name_section = section
 
3126
            else:
 
3127
                all_sections.append(section)
 
3128
        # Unfortunately _iter_for_location_by_parts deals with section names so
 
3129
        # we have to resync.
 
3130
        filtered_sections = _iter_for_location_by_parts(
 
3131
            [s.id for s in all_sections], self.location)
 
3132
        iter_all_sections = iter(all_sections)
 
3133
        matching_sections = []
 
3134
        if no_name_section is not None:
 
3135
            matching_sections.append(
 
3136
                LocationSection(no_name_section, 0, self.location))
 
3137
        for section_id, extra_path, length in filtered_sections:
 
3138
            # a section id is unique for a given store so it's safe to take the
 
3139
            # first matching section while iterating. Also, all filtered
 
3140
            # sections are part of 'all_sections' and will always be found
 
3141
            # there.
 
3142
            while True:
 
3143
                section = iter_all_sections.next()
 
3144
                if section_id == section.id:
 
3145
                    matching_sections.append(
 
3146
                        LocationSection(section, length, extra_path))
 
3147
                    break
 
3148
        return matching_sections
 
3149
 
 
3150
    def get_sections(self):
 
3151
        # Override the default implementation as we want to change the order
 
3152
        matching_sections = self._get_matching_sections()
 
3153
        # We want the longest (aka more specific) locations first
 
3154
        sections = sorted(matching_sections,
 
3155
                          key=lambda section: (section.length, section.id),
 
3156
                          reverse=True)
 
3157
        # Sections mentioning 'ignore_parents' restrict the selection
 
3158
        for section in sections:
 
3159
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
 
3160
            ignore = section.get('ignore_parents', None)
 
3161
            if ignore is not None:
 
3162
                ignore = ui.bool_from_string(ignore)
 
3163
            if ignore:
 
3164
                break
 
3165
            # Finally, we have a valid section
 
3166
            yield self.store, section
 
3167
 
 
3168
 
 
3169
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
 
3170
"""Describes an expandable option reference.
 
3171
 
 
3172
We want to match the most embedded reference first.
 
3173
 
 
3174
I.e. for '{{foo}}' we will get '{foo}',
 
3175
for '{bar{baz}}' we will get '{baz}'
 
3176
"""
 
3177
 
 
3178
def iter_option_refs(string):
 
3179
    # Split isolate refs so every other chunk is a ref
 
3180
    is_ref = False
 
3181
    for chunk  in _option_ref_re.split(string):
 
3182
        yield is_ref, chunk
 
3183
        is_ref = not is_ref
 
3184
 
 
3185
 
 
3186
class Stack(object):
 
3187
    """A stack of configurations where an option can be defined"""
 
3188
 
 
3189
    def __init__(self, sections_def, store=None, mutable_section_id=None):
 
3190
        """Creates a stack of sections with an optional store for changes.
 
3191
 
 
3192
        :param sections_def: A list of Section or callables that returns an
 
3193
            iterable of Section. This defines the Sections for the Stack and
 
3194
            can be called repeatedly if needed.
 
3195
 
 
3196
        :param store: The optional Store where modifications will be
 
3197
            recorded. If none is specified, no modifications can be done.
 
3198
 
 
3199
        :param mutable_section_id: The id of the MutableSection where changes
 
3200
            are recorded. This requires the ``store`` parameter to be
 
3201
            specified.
 
3202
        """
 
3203
        self.sections_def = sections_def
 
3204
        self.store = store
 
3205
        self.mutable_section_id = mutable_section_id
 
3206
 
 
3207
    def get(self, name, expand=None):
 
3208
        """Return the *first* option value found in the sections.
 
3209
 
 
3210
        This is where we guarantee that sections coming from Store are loaded
 
3211
        lazily: the loading is delayed until we need to either check that an
 
3212
        option exists or get its value, which in turn may require to discover
 
3213
        in which sections it can be defined. Both of these (section and option
 
3214
        existence) require loading the store (even partially).
 
3215
 
 
3216
        :param name: The queried option.
 
3217
 
 
3218
        :param expand: Whether options references should be expanded.
 
3219
 
 
3220
        :returns: The value of the option.
 
3221
        """
 
3222
        # FIXME: No caching of options nor sections yet -- vila 20110503
 
3223
        if expand is None:
 
3224
            expand = _get_expand_default_value()
 
3225
        value = None
 
3226
        # Ensuring lazy loading is achieved by delaying section matching (which
 
3227
        # implies querying the persistent storage) until it can't be avoided
 
3228
        # anymore by using callables to describe (possibly empty) section
 
3229
        # lists.
 
3230
        for sections in self.sections_def:
 
3231
            for store, section in sections():
 
3232
                value = section.get(name)
 
3233
                if value is not None:
 
3234
                    break
 
3235
            if value is not None:
 
3236
                break
 
3237
        # If the option is registered, it may provide additional info about
 
3238
        # value handling
 
3239
        try:
 
3240
            opt = option_registry.get(name)
 
3241
        except KeyError:
 
3242
            # Not registered
 
3243
            opt = None
 
3244
        def expand_and_convert(val):
 
3245
            # This may need to be called twice if the value is None or ends up
 
3246
            # being None during expansion or conversion.
 
3247
            if val is not None:
 
3248
                if expand:
 
3249
                    if isinstance(val, basestring):
 
3250
                        val = self._expand_options_in_string(val)
 
3251
                    else:
 
3252
                        trace.warning('Cannot expand "%s":'
 
3253
                                      ' %s does not support option expansion'
 
3254
                                      % (name, type(val)))
 
3255
                if opt is not None:
 
3256
                    val = opt.convert_from_unicode(val)
 
3257
            return val
 
3258
        value = expand_and_convert(value)
 
3259
        if opt is not None and value is None:
 
3260
            # If the option is registered, it may provide a default value
 
3261
            value = opt.get_default()
 
3262
            value = expand_and_convert(value)
 
3263
        for hook in ConfigHooks['get']:
 
3264
            hook(self, name, value)
 
3265
        return value
 
3266
 
 
3267
    def expand_options(self, string, env=None):
 
3268
        """Expand option references in the string in the configuration context.
 
3269
 
 
3270
        :param string: The string containing option(s) to expand.
 
3271
 
 
3272
        :param env: An option dict defining additional configuration options or
 
3273
            overriding existing ones.
 
3274
 
 
3275
        :returns: The expanded string.
 
3276
        """
 
3277
        return self._expand_options_in_string(string, env)
 
3278
 
 
3279
    def _expand_options_in_string(self, string, env=None, _refs=None):
 
3280
        """Expand options in the string in the configuration context.
 
3281
 
 
3282
        :param string: The string to be expanded.
 
3283
 
 
3284
        :param env: An option dict defining additional configuration options or
 
3285
            overriding existing ones.
 
3286
 
 
3287
        :param _refs: Private list (FIFO) containing the options being expanded
 
3288
            to detect loops.
 
3289
 
 
3290
        :returns: The expanded string.
 
3291
        """
 
3292
        if string is None:
 
3293
            # Not much to expand there
 
3294
            return None
 
3295
        if _refs is None:
 
3296
            # What references are currently resolved (to detect loops)
 
3297
            _refs = []
 
3298
        result = string
 
3299
        # We need to iterate until no more refs appear ({{foo}} will need two
 
3300
        # iterations for example).
 
3301
        expanded = True
 
3302
        while expanded:
 
3303
            expanded = False
 
3304
            chunks = []
 
3305
            for is_ref, chunk in iter_option_refs(result):
 
3306
                if not is_ref:
 
3307
                    chunks.append(chunk)
 
3308
                else:
 
3309
                    expanded = True
 
3310
                    name = chunk[1:-1]
 
3311
                    if name in _refs:
 
3312
                        raise errors.OptionExpansionLoop(string, _refs)
 
3313
                    _refs.append(name)
 
3314
                    value = self._expand_option(name, env, _refs)
 
3315
                    if value is None:
 
3316
                        raise errors.ExpandingUnknownOption(name, string)
 
3317
                    chunks.append(value)
 
3318
                    _refs.pop()
 
3319
            result = ''.join(chunks)
 
3320
        return result
 
3321
 
 
3322
    def _expand_option(self, name, env, _refs):
 
3323
        if env is not None and name in env:
 
3324
            # Special case, values provided in env takes precedence over
 
3325
            # anything else
 
3326
            value = env[name]
 
3327
        else:
 
3328
            value = self.get(name, expand=False)
 
3329
            value = self._expand_options_in_string(value, env, _refs)
 
3330
        return value
 
3331
 
 
3332
    def _get_mutable_section(self):
 
3333
        """Get the MutableSection for the Stack.
 
3334
 
 
3335
        This is where we guarantee that the mutable section is lazily loaded:
 
3336
        this means we won't load the corresponding store before setting a value
 
3337
        or deleting an option. In practice the store will often be loaded but
 
3338
        this helps catching some programming errors.
 
3339
        """
 
3340
        section = self.store.get_mutable_section(self.mutable_section_id)
 
3341
        return section
 
3342
 
 
3343
    def set(self, name, value):
 
3344
        """Set a new value for the option."""
 
3345
        section = self._get_mutable_section()
 
3346
        section.set(name, value)
 
3347
        for hook in ConfigHooks['set']:
 
3348
            hook(self, name, value)
 
3349
 
 
3350
    def remove(self, name):
 
3351
        """Remove an existing option."""
 
3352
        section = self._get_mutable_section()
 
3353
        section.remove(name)
 
3354
        for hook in ConfigHooks['remove']:
 
3355
            hook(self, name)
 
3356
 
 
3357
    def __repr__(self):
 
3358
        # Mostly for debugging use
 
3359
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
 
3360
 
 
3361
    def _get_overrides(self):
 
3362
        # Hack around library_state.initialize never called
 
3363
        if bzrlib.global_state is not None:
 
3364
            return bzrlib.global_state.cmdline_overrides.get_sections()
 
3365
        return []
 
3366
 
 
3367
 
 
3368
class _CompatibleStack(Stack):
 
3369
    """Place holder for compatibility with previous design.
 
3370
 
 
3371
    This is intended to ease the transition from the Config-based design to the
 
3372
    Stack-based design and should not be used nor relied upon by plugins.
 
3373
 
 
3374
    One assumption made here is that the daughter classes will all use Stores
 
3375
    derived from LockableIniFileStore).
 
3376
 
 
3377
    It implements set() and remove () by re-loading the store before applying
 
3378
    the modification and saving it.
 
3379
 
 
3380
    The long term plan being to implement a single write by store to save
 
3381
    all modifications, this class should not be used in the interim.
 
3382
    """
 
3383
 
 
3384
    def set(self, name, value):
 
3385
        # Force a reload
 
3386
        self.store.unload()
 
3387
        super(_CompatibleStack, self).set(name, value)
 
3388
        # Force a write to persistent storage
 
3389
        self.store.save()
 
3390
 
 
3391
    def remove(self, name):
 
3392
        # Force a reload
 
3393
        self.store.unload()
 
3394
        super(_CompatibleStack, self).remove(name)
 
3395
        # Force a write to persistent storage
 
3396
        self.store.save()
 
3397
 
 
3398
 
 
3399
class GlobalStack(_CompatibleStack):
 
3400
    """Global options only stack."""
 
3401
 
 
3402
    def __init__(self):
 
3403
        # Get a GlobalStore
 
3404
        gstore = GlobalStore()
 
3405
        super(GlobalStack, self).__init__(
 
3406
            [self._get_overrides, NameMatcher(gstore, 'DEFAULT').get_sections],
 
3407
            gstore, mutable_section_id='DEFAULT')
 
3408
 
 
3409
 
 
3410
class LocationStack(_CompatibleStack):
 
3411
    """Per-location options falling back to global options stack."""
 
3412
 
 
3413
    def __init__(self, location):
 
3414
        """Make a new stack for a location and global configuration.
 
3415
        
 
3416
        :param location: A URL prefix to """
 
3417
        lstore = LocationStore()
 
3418
        if location.startswith('file://'):
 
3419
            location = urlutils.local_path_from_url(location)
 
3420
        matcher = LocationMatcher(lstore, location)
 
3421
        gstore = GlobalStore()
 
3422
        super(LocationStack, self).__init__(
 
3423
            [self._get_overrides,
 
3424
             matcher.get_sections, NameMatcher(gstore, 'DEFAULT').get_sections],
 
3425
            lstore, mutable_section_id=location)
 
3426
 
 
3427
 
 
3428
class BranchStack(_CompatibleStack):
 
3429
    """Per-location options falling back to branch then global options stack."""
 
3430
 
 
3431
    def __init__(self, branch):
 
3432
        bstore = branch._get_config_store()
 
3433
        lstore = LocationStore()
 
3434
        matcher = LocationMatcher(lstore, branch.base)
 
3435
        gstore = GlobalStore()
 
3436
        super(BranchStack, self).__init__(
 
3437
            [self._get_overrides,
 
3438
             matcher.get_sections, bstore.get_sections,
 
3439
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3440
            bstore)
 
3441
        self.branch = branch
 
3442
 
 
3443
 
 
3444
class RemoteControlStack(_CompatibleStack):
 
3445
    """Remote control-only options stack."""
 
3446
 
 
3447
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
3448
    # with the stack used for remote bzr dirs. RemoteControlStack only uses
 
3449
    # control.conf and is used only for stack options.
 
3450
 
 
3451
    def __init__(self, bzrdir):
 
3452
        cstore = bzrdir._get_config_store()
 
3453
        super(RemoteControlStack, self).__init__(
 
3454
            [cstore.get_sections],
 
3455
            cstore)
 
3456
        self.bzrdir = bzrdir
 
3457
 
 
3458
 
 
3459
class RemoteBranchStack(_CompatibleStack):
 
3460
    """Remote branch-only options stack."""
 
3461
 
 
3462
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
3463
    # with the stack used for remote branches. RemoteBranchStack only uses
 
3464
    # branch.conf and is used only for the stack options.
 
3465
 
 
3466
    def __init__(self, branch):
 
3467
        bstore = branch._get_config_store()
 
3468
        super(RemoteBranchStack, self).__init__(
 
3469
            [bstore.get_sections],
 
3470
            bstore)
 
3471
        self.branch = branch
 
3472
 
 
3473
# Use a an empty dict to initialize an empty configobj avoiding all
 
3474
# parsing and encoding checks
 
3475
_quoting_config = configobj.ConfigObj(
 
3476
    {}, encoding='utf-8', interpolation=False)
 
3477
 
 
3478
class cmd_config(commands.Command):
 
3479
    __doc__ = """Display, set or remove a configuration option.
 
3480
 
 
3481
    Display the active value for a given option.
 
3482
 
 
3483
    If --all is specified, NAME is interpreted as a regular expression and all
 
3484
    matching options are displayed mentioning their scope. The active value
 
3485
    that bzr will take into account is the first one displayed for each option.
 
3486
 
 
3487
    If no NAME is given, --all .* is implied.
 
3488
 
 
3489
    Setting a value is achieved by using name=value without spaces. The value
 
3490
    is set in the most relevant scope and can be checked by displaying the
 
3491
    option again.
 
3492
    """
 
3493
 
 
3494
    takes_args = ['name?']
 
3495
 
 
3496
    takes_options = [
 
3497
        'directory',
 
3498
        # FIXME: This should be a registry option so that plugins can register
 
3499
        # their own config files (or not) and will also address
 
3500
        # http://pad.lv/788991 -- vila 20101115
 
3501
        commands.Option('scope', help='Reduce the scope to the specified'
 
3502
                        ' configuration file.',
 
3503
                        type=unicode),
 
3504
        commands.Option('all',
 
3505
            help='Display all the defined values for the matching options.',
 
3506
            ),
 
3507
        commands.Option('remove', help='Remove the option from'
 
3508
                        ' the configuration file.'),
 
3509
        ]
 
3510
 
 
3511
    _see_also = ['configuration']
 
3512
 
 
3513
    @commands.display_command
 
3514
    def run(self, name=None, all=False, directory=None, scope=None,
 
3515
            remove=False):
 
3516
        if directory is None:
 
3517
            directory = '.'
 
3518
        directory = urlutils.normalize_url(directory)
 
3519
        if remove and all:
 
3520
            raise errors.BzrError(
 
3521
                '--all and --remove are mutually exclusive.')
 
3522
        elif remove:
 
3523
            # Delete the option in the given scope
 
3524
            self._remove_config_option(name, directory, scope)
 
3525
        elif name is None:
 
3526
            # Defaults to all options
 
3527
            self._show_matching_options('.*', directory, scope)
 
3528
        else:
 
3529
            try:
 
3530
                name, value = name.split('=', 1)
 
3531
            except ValueError:
 
3532
                # Display the option(s) value(s)
 
3533
                if all:
 
3534
                    self._show_matching_options(name, directory, scope)
 
3535
                else:
 
3536
                    self._show_value(name, directory, scope)
 
3537
            else:
 
3538
                if all:
 
3539
                    raise errors.BzrError(
 
3540
                        'Only one option can be set.')
 
3541
                # Set the option value
 
3542
                self._set_config_option(name, value, directory, scope)
 
3543
 
 
3544
    def _get_stack(self, directory, scope=None):
 
3545
        """Get the configuration stack specified by ``directory`` and ``scope``.
 
3546
 
 
3547
        :param directory: Where the configurations are derived from.
 
3548
 
 
3549
        :param scope: A specific config to start from.
 
3550
        """
 
3551
        # FIXME: scope should allow access to plugin-specific stacks (even
 
3552
        # reduced to the plugin-specific store), related to
 
3553
        # http://pad.lv/788991 -- vila 2011-11-15
 
3554
        if scope is not None:
 
3555
            if scope == 'bazaar':
 
3556
                return GlobalStack()
 
3557
            elif scope == 'locations':
 
3558
                return LocationStack(directory)
 
3559
            elif scope == 'branch':
 
3560
                (_, br, _) = (
 
3561
                    controldir.ControlDir.open_containing_tree_or_branch(
 
3562
                        directory))
 
3563
                return br.get_config_stack()
 
3564
            raise errors.NoSuchConfig(scope)
 
3565
        else:
 
3566
            try:
 
3567
                (_, br, _) = (
 
3568
                    controldir.ControlDir.open_containing_tree_or_branch(
 
3569
                        directory))
 
3570
                return br.get_config_stack()
 
3571
            except errors.NotBranchError:
 
3572
                return LocationStack(directory)
 
3573
 
 
3574
    def _show_value(self, name, directory, scope):
 
3575
        conf = self._get_stack(directory, scope)
 
3576
        value = conf.get(name, expand=True)
 
3577
        if value is not None:
 
3578
            # Quote the value appropriately
 
3579
            value = _quoting_config._quote(value)
 
3580
            self.outf.write('%s\n' % (value,))
 
3581
        else:
 
3582
            raise errors.NoSuchConfigOption(name)
 
3583
 
 
3584
    def _show_matching_options(self, name, directory, scope):
 
3585
        name = lazy_regex.lazy_compile(name)
 
3586
        # We want any error in the regexp to be raised *now* so we need to
 
3587
        # avoid the delay introduced by the lazy regexp.  But, we still do
 
3588
        # want the nicer errors raised by lazy_regex.
 
3589
        name._compile_and_collapse()
 
3590
        cur_store_id = None
 
3591
        cur_section = None
 
3592
        conf = self._get_stack(directory, scope)
 
3593
        for sections in conf.sections_def:
 
3594
            for store, section in sections():
 
3595
                for oname in section.iter_option_names():
 
3596
                    if name.search(oname):
 
3597
                        if cur_store_id != store.id:
 
3598
                            # Explain where the options are defined
 
3599
                            self.outf.write('%s:\n' % (store.id,))
 
3600
                            cur_store_id = store.id
 
3601
                            cur_section = None
 
3602
                        if (section.id not in (None, 'DEFAULT')
 
3603
                            and cur_section != section.id):
 
3604
                            # Display the section if it's not the default (or
 
3605
                            # only) one.
 
3606
                            self.outf.write('  [%s]\n' % (section.id,))
 
3607
                            cur_section = section.id
 
3608
                        value = section.get(oname, expand=False)
 
3609
                        value = _quoting_config._quote(value)
 
3610
                        self.outf.write('  %s = %s\n' % (oname, value))
 
3611
 
 
3612
    def _set_config_option(self, name, value, directory, scope):
 
3613
        conf = self._get_stack(directory, scope)
 
3614
        conf.set(name, value)
 
3615
 
 
3616
    def _remove_config_option(self, name, directory, scope):
 
3617
        if name is None:
 
3618
            raise errors.BzrCommandError(
 
3619
                '--remove expects an option to remove.')
 
3620
        conf = self._get_stack(directory, scope)
 
3621
        try:
 
3622
            conf.remove(name)
 
3623
        except KeyError:
 
3624
            raise errors.NoSuchConfigOption(name)
 
3625
 
 
3626
 
 
3627
# Test registries
 
3628
#
 
3629
# We need adapters that can build a Store or a Stack in a test context. Test
 
3630
# classes, based on TestCaseWithTransport, can use the registry to parametrize
 
3631
# themselves. The builder will receive a test instance and should return a
 
3632
# ready-to-use store or stack.  Plugins that define new store/stacks can also
 
3633
# register themselves here to be tested against the tests defined in
 
3634
# bzrlib.tests.test_config. Note that the builder can be called multiple times
 
3635
# for the same test.
 
3636
 
 
3637
# The registered object should be a callable receiving a test instance
 
3638
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
 
3639
# object.
 
3640
test_store_builder_registry = registry.Registry()
 
3641
 
 
3642
# The registered object should be a callable receiving a test instance
 
3643
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
 
3644
# object.
 
3645
test_stack_builder_registry = registry.Registry()