/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

(jam) Merge 2.4 into trunk, including bugs #825027 and #837293

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