← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Patch Queue Manager
  • Date: 2011-09-22 14:12:18 UTC
  • mfrom: (6155.3.1 jam)
  • Revision ID: pqm@pqm.ubuntu.com-20110922141218-86s4uu6nqvourw4f
(jameinel) Cleanup comments bzrlib/smart/__init__.py (John A Meinel)

Show diffs side-by-side

added added

removed removed

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