/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Vincent Ladeuil
  • Date: 2011-09-30 14:28:48 UTC
  • mto: This revision was merged to the branch mainline in revision 6201.
  • Revision ID: v.ladeuil+lp@free.fr-20110930142848-vjva0cr3l5rawzxn
Add script tests and documentation.

Show diffs side-by-side

added added

removed removed

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