← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Vincent Ladeuil
  • Date: 2013-10-04 09:56:23 UTC
  • mto: (6588.1.1 trunk)
  • mto: This revision was merged to the branch mainline in revision 6589.
  • Revision ID: v.ladeuil+lp@free.fr-20131004095623-xlan34vg0y51gdb5
https://launchpad.net/bugs/1235099
Stricter checks on configuration option names

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/config.py
1
 
# Copyright (C) 2005 Canonical Ltd
 
1
# Copyright (C) 2005-2012 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
 
3
#            and others
3
4
#
4
5
# This program is free software; you can redistribute it and/or modify
5
6
# it under the terms of the GNU General Public License as published by
13
14
#
14
15
# You should have received a copy of the GNU General Public License
15
16
# along with this program; if not, write to the Free Software
16
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17
18
 
18
19
"""Configuration that affects the behaviour of Bazaar.
19
20
 
28
29
create_signatures=always|never|when-required(default)
29
30
gpg_signing_command=name-of-program
30
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
31
35
 
32
36
in locations.conf, you specify the url of a branch and options for it.
33
37
Wildcards may be used - * and ? as normal in shell completion. Options
36
40
[/home/robertc/source]
37
41
recurse=False|True(default)
38
42
email= as above
39
 
check_signatures= as above 
 
43
check_signatures= as above
40
44
create_signatures= as above.
 
45
validate_signatures_in_log=as above
 
46
acceptable_keys=as above
41
47
 
42
48
explanation of options
43
49
----------------------
44
50
editor - this option sets the pop up editor to use during commits.
45
51
email - this option sets the user id bzr will use when committing.
46
 
check_signatures - this option controls whether bzr will require good gpg
47
 
                   signatures, ignore them, or check them if they are 
48
 
                   present.
49
 
create_signatures - this option controls whether bzr will always create 
50
 
                    gpg signatures, never create them, or create them if the
51
 
                    branch is configured to require them.
 
52
check_signatures - this option will control whether bzr will require good gpg
 
53
                   signatures, ignore them, or check them if they are
 
54
                   present.  Currently it is unused except that check_signatures
 
55
                   turns on create_signatures.
 
56
create_signatures - this option controls whether bzr will always create
 
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.
52
60
log_format - this option sets the default log format.  Possible values are
53
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
54
65
 
55
66
In bazaar.conf you can also define aliases in the ALIASES sections, example
56
67
 
61
72
up=pull
62
73
"""
63
74
 
 
75
from __future__ import absolute_import
 
76
from cStringIO import StringIO
64
77
import os
65
78
import sys
66
79
 
 
80
import bzrlib
 
81
from bzrlib.decorators import needs_write_lock
67
82
from bzrlib.lazy_import import lazy_import
68
83
lazy_import(globals(), """
69
 
import errno
70
 
from fnmatch import fnmatch
 
84
import base64
 
85
import fnmatch
71
86
import re
72
 
from StringIO import StringIO
73
87
 
74
 
import bzrlib
75
88
from bzrlib import (
 
89
    atomicfile,
 
90
    controldir,
 
91
    debug,
 
92
    directory_service,
76
93
    errors,
 
94
    lazy_regex,
 
95
    library_state,
 
96
    lockdir,
 
97
    mergetools,
77
98
    osutils,
78
99
    symbol_versioning,
 
100
    trace,
 
101
    transport,
 
102
    ui,
79
103
    urlutils,
80
104
    win32utils,
81
105
    )
82
 
import bzrlib.util.configobj.configobj as configobj
 
106
from bzrlib.i18n import gettext
 
107
from bzrlib.util.configobj import configobj
83
108
""")
84
 
 
85
 
from bzrlib.trace import mutter, warning
 
109
from bzrlib import (
 
110
    commands,
 
111
    hooks,
 
112
    lazy_regex,
 
113
    registry,
 
114
    )
 
115
from bzrlib.symbol_versioning import (
 
116
    deprecated_in,
 
117
    deprecated_method,
 
118
    )
86
119
 
87
120
 
88
121
CHECK_IF_POSSIBLE=0
119
152
STORE_GLOBAL = 4
120
153
 
121
154
 
 
155
def signature_policy_from_unicode(signature_string):
 
156
    """Convert a string to a signing policy."""
 
157
    if signature_string.lower() == 'check-available':
 
158
        return CHECK_IF_POSSIBLE
 
159
    if signature_string.lower() == 'ignore':
 
160
        return CHECK_NEVER
 
161
    if signature_string.lower() == 'require':
 
162
        return CHECK_ALWAYS
 
163
    raise ValueError("Invalid signatures policy '%s'"
 
164
                     % signature_string)
 
165
 
 
166
 
 
167
def signing_policy_from_unicode(signature_string):
 
168
    """Convert a string to a signing policy."""
 
169
    if signature_string.lower() == 'when-required':
 
170
        return SIGN_WHEN_REQUIRED
 
171
    if signature_string.lower() == 'never':
 
172
        return SIGN_NEVER
 
173
    if signature_string.lower() == 'always':
 
174
        return SIGN_ALWAYS
 
175
    raise ValueError("Invalid signing policy '%s'"
 
176
                     % signature_string)
 
177
 
 
178
 
122
179
class ConfigObj(configobj.ConfigObj):
123
180
 
 
181
    def __init__(self, infile=None, **kwargs):
 
182
        # We define our own interpolation mechanism calling it option expansion
 
183
        super(ConfigObj, self).__init__(infile=infile,
 
184
                                        interpolation=False,
 
185
                                        **kwargs)
 
186
 
124
187
    def get_bool(self, section, key):
125
188
        return self[section].as_bool(key)
126
189
 
137
200
class Config(object):
138
201
    """A configuration policy - what username, editor, gpg needs etc."""
139
202
 
140
 
    def get_editor(self):
141
 
        """Get the users pop up editor."""
142
 
        raise NotImplementedError
 
203
    def __init__(self):
 
204
        super(Config, self).__init__()
 
205
 
 
206
    def config_id(self):
 
207
        """Returns a unique ID for the config."""
 
208
        raise NotImplementedError(self.config_id)
 
209
 
 
210
    def get_change_editor(self, old_tree, new_tree):
 
211
        from bzrlib import diff
 
212
        cmd = self._get_change_editor()
 
213
        if cmd is None:
 
214
            return None
 
215
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
 
216
                                             sys.stdout)
143
217
 
144
218
    def _get_signature_checking(self):
145
219
        """Template method to override signature checking policy."""
147
221
    def _get_signing_policy(self):
148
222
        """Template method to override signature creation policy."""
149
223
 
 
224
    option_ref_re = None
 
225
 
 
226
    def expand_options(self, string, env=None):
 
227
        """Expand option references in the string in the configuration context.
 
228
 
 
229
        :param string: The string containing option to expand.
 
230
 
 
231
        :param env: An option dict defining additional configuration options or
 
232
            overriding existing ones.
 
233
 
 
234
        :returns: The expanded string.
 
235
        """
 
236
        return self._expand_options_in_string(string, env)
 
237
 
 
238
    def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
 
239
        """Expand options in  a list of strings in the configuration context.
 
240
 
 
241
        :param slist: A list of strings.
 
242
 
 
243
        :param env: An option dict defining additional configuration options or
 
244
            overriding existing ones.
 
245
 
 
246
        :param _ref_stack: Private list containing the options being
 
247
            expanded to detect loops.
 
248
 
 
249
        :returns: The flatten list of expanded strings.
 
250
        """
 
251
        # expand options in each value separately flattening lists
 
252
        result = []
 
253
        for s in slist:
 
254
            value = self._expand_options_in_string(s, env, _ref_stack)
 
255
            if isinstance(value, list):
 
256
                result.extend(value)
 
257
            else:
 
258
                result.append(value)
 
259
        return result
 
260
 
 
261
    def _expand_options_in_string(self, string, env=None, _ref_stack=None):
 
262
        """Expand options in the string in the configuration context.
 
263
 
 
264
        :param string: The string to be expanded.
 
265
 
 
266
        :param env: An option dict defining additional configuration options or
 
267
            overriding existing ones.
 
268
 
 
269
        :param _ref_stack: Private list containing the options being
 
270
            expanded to detect loops.
 
271
 
 
272
        :returns: The expanded string.
 
273
        """
 
274
        if string is None:
 
275
            # Not much to expand there
 
276
            return None
 
277
        if _ref_stack is None:
 
278
            # What references are currently resolved (to detect loops)
 
279
            _ref_stack = []
 
280
        if self.option_ref_re is None:
 
281
            # We want to match the most embedded reference first (i.e. for
 
282
            # '{{foo}}' we will get '{foo}',
 
283
            # for '{bar{baz}}' we will get '{baz}'
 
284
            self.option_ref_re = re.compile('({[^{}]+})')
 
285
        result = string
 
286
        # We need to iterate until no more refs appear ({{foo}} will need two
 
287
        # iterations for example).
 
288
        while True:
 
289
            raw_chunks = self.option_ref_re.split(result)
 
290
            if len(raw_chunks) == 1:
 
291
                # Shorcut the trivial case: no refs
 
292
                return result
 
293
            chunks = []
 
294
            list_value = False
 
295
            # Split will isolate refs so that every other chunk is a ref
 
296
            chunk_is_ref = False
 
297
            for chunk in raw_chunks:
 
298
                if not chunk_is_ref:
 
299
                    if chunk:
 
300
                        # Keep only non-empty strings (or we get bogus empty
 
301
                        # slots when a list value is involved).
 
302
                        chunks.append(chunk)
 
303
                    chunk_is_ref = True
 
304
                else:
 
305
                    name = chunk[1:-1]
 
306
                    if name in _ref_stack:
 
307
                        raise errors.OptionExpansionLoop(string, _ref_stack)
 
308
                    _ref_stack.append(name)
 
309
                    value = self._expand_option(name, env, _ref_stack)
 
310
                    if value is None:
 
311
                        raise errors.ExpandingUnknownOption(name, string)
 
312
                    if isinstance(value, list):
 
313
                        list_value = True
 
314
                        chunks.extend(value)
 
315
                    else:
 
316
                        chunks.append(value)
 
317
                    _ref_stack.pop()
 
318
                    chunk_is_ref = False
 
319
            if list_value:
 
320
                # Once a list appears as the result of an expansion, all
 
321
                # callers will get a list result. This allows a consistent
 
322
                # behavior even when some options in the expansion chain
 
323
                # defined as strings (no comma in their value) but their
 
324
                # expanded value is a list.
 
325
                return self._expand_options_in_list(chunks, env, _ref_stack)
 
326
            else:
 
327
                result = ''.join(chunks)
 
328
        return result
 
329
 
 
330
    def _expand_option(self, name, env, _ref_stack):
 
331
        if env is not None and name in env:
 
332
            # Special case, values provided in env takes precedence over
 
333
            # anything else
 
334
            value = env[name]
 
335
        else:
 
336
            # FIXME: This is a limited implementation, what we really need is a
 
337
            # way to query the bzr config for the value of an option,
 
338
            # respecting the scope rules (That is, once we implement fallback
 
339
            # configs, getting the option value should restart from the top
 
340
            # config, not the current one) -- vila 20101222
 
341
            value = self.get_user_option(name, expand=False)
 
342
            if isinstance(value, list):
 
343
                value = self._expand_options_in_list(value, env, _ref_stack)
 
344
            else:
 
345
                value = self._expand_options_in_string(value, env, _ref_stack)
 
346
        return value
 
347
 
150
348
    def _get_user_option(self, option_name):
151
349
        """Template method to provide a user option."""
152
350
        return None
153
351
 
154
 
    def get_user_option(self, option_name):
155
 
        """Get a generic option - no special process, no default."""
156
 
        return self._get_user_option(option_name)
157
 
 
 
352
    def get_user_option(self, option_name, expand=True):
 
353
        """Get a generic option - no special process, no default.
 
354
 
 
355
        :param option_name: The queried option.
 
356
 
 
357
        :param expand: Whether options references should be expanded.
 
358
 
 
359
        :returns: The value of the option.
 
360
        """
 
361
        value = self._get_user_option(option_name)
 
362
        if expand:
 
363
            if isinstance(value, list):
 
364
                value = self._expand_options_in_list(value)
 
365
            elif isinstance(value, dict):
 
366
                trace.warning('Cannot expand "%s":'
 
367
                              ' Dicts do not support option expansion'
 
368
                              % (option_name,))
 
369
            else:
 
370
                value = self._expand_options_in_string(value)
 
371
        for hook in OldConfigHooks['get']:
 
372
            hook(self, option_name, value)
 
373
        return value
 
374
 
 
375
    def get_user_option_as_bool(self, option_name, expand=None, default=None):
 
376
        """Get a generic option as a boolean.
 
377
 
 
378
        :param expand: Allow expanding references to other config values.
 
379
        :param default: Default value if nothing is configured
 
380
        :return None if the option doesn't exist or its value can't be
 
381
            interpreted as a boolean. Returns True or False otherwise.
 
382
        """
 
383
        s = self.get_user_option(option_name, expand=expand)
 
384
        if s is None:
 
385
            # The option doesn't exist
 
386
            return default
 
387
        val = ui.bool_from_string(s)
 
388
        if val is None:
 
389
            # The value can't be interpreted as a boolean
 
390
            trace.warning('Value "%s" is not a boolean for "%s"',
 
391
                          s, option_name)
 
392
        return val
 
393
 
 
394
    def get_user_option_as_list(self, option_name, expand=None):
 
395
        """Get a generic option as a list - no special process, no default.
 
396
 
 
397
        :return None if the option doesn't exist. Returns the value as a list
 
398
            otherwise.
 
399
        """
 
400
        l = self.get_user_option(option_name, expand=expand)
 
401
        if isinstance(l, (str, unicode)):
 
402
            # A single value, most probably the user forgot (or didn't care to
 
403
            # add) the final ','
 
404
            l = [l]
 
405
        return l
 
406
 
 
407
    @deprecated_method(deprecated_in((2, 5, 0)))
 
408
    def get_user_option_as_int_from_SI(self, option_name, default=None):
 
409
        """Get a generic option from a human readable size in SI units, e.g 10MB
 
410
 
 
411
        Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
412
        by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
413
        pedantic.
 
414
 
 
415
        :return Integer, expanded to its base-10 value if a proper SI unit is 
 
416
            found. If the option doesn't exist, or isn't a value in 
 
417
            SI units, return default (which defaults to None)
 
418
        """
 
419
        val = self.get_user_option(option_name)
 
420
        if isinstance(val, list):
 
421
            val = val[0]
 
422
        if val is None:
 
423
            val = default
 
424
        else:
 
425
            p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
 
426
            try:
 
427
                m = p.match(val)
 
428
                if m is not None:
 
429
                    val = int(m.group(1))
 
430
                    if m.group(2) is not None:
 
431
                        if m.group(2).lower() == 'k':
 
432
                            val *= 10**3
 
433
                        elif m.group(2).lower() == 'm':
 
434
                            val *= 10**6
 
435
                        elif m.group(2).lower() == 'g':
 
436
                            val *= 10**9
 
437
                else:
 
438
                    ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
 
439
                                               ' value {1!r} is not an SI unit.').format(
 
440
                                                option_name, val))
 
441
                    val = default
 
442
            except TypeError:
 
443
                val = default
 
444
        return val
 
445
 
 
446
    @deprecated_method(deprecated_in((2, 5, 0)))
158
447
    def gpg_signing_command(self):
159
448
        """What program should be used to sign signatures?"""
160
449
        result = self._gpg_signing_command()
166
455
        """See gpg_signing_command()."""
167
456
        return None
168
457
 
 
458
    @deprecated_method(deprecated_in((2, 5, 0)))
169
459
    def log_format(self):
170
460
        """What log format should be used"""
171
461
        result = self._log_format()
177
467
        """See log_format()."""
178
468
        return None
179
469
 
180
 
    def __init__(self):
181
 
        super(Config, self).__init__()
182
 
 
 
470
    def validate_signatures_in_log(self):
 
471
        """Show GPG signature validity in log"""
 
472
        result = self._validate_signatures_in_log()
 
473
        if result == "true":
 
474
            result = True
 
475
        else:
 
476
            result = False
 
477
        return result
 
478
 
 
479
    def _validate_signatures_in_log(self):
 
480
        """See validate_signatures_in_log()."""
 
481
        return None
 
482
 
 
483
    @deprecated_method(deprecated_in((2, 5, 0)))
 
484
    def acceptable_keys(self):
 
485
        """Comma separated list of key patterns acceptable to 
 
486
        verify-signatures command"""
 
487
        result = self._acceptable_keys()
 
488
        return result
 
489
 
 
490
    def _acceptable_keys(self):
 
491
        """See acceptable_keys()."""
 
492
        return None
 
493
 
 
494
    @deprecated_method(deprecated_in((2, 5, 0)))
183
495
    def post_commit(self):
184
496
        """An ordered list of python functions to call.
185
497
 
197
509
 
198
510
    def username(self):
199
511
        """Return email-style username.
200
 
    
 
512
 
201
513
        Something similar to 'Martin Pool <mbp@sourcefrog.net>'
202
 
        
203
 
        $BZR_EMAIL can be set to override this (as well as the
204
 
        deprecated $BZREMAIL), then
 
514
 
 
515
        $BZR_EMAIL can be set to override this, then
205
516
        the concrete policy type is checked, and finally
206
517
        $EMAIL is examined.
207
 
        If none is found, a reasonable default is (hopefully)
208
 
        created.
209
 
    
210
 
        TODO: Check it's reasonably well-formed.
 
518
        If no username can be found, errors.NoWhoami exception is raised.
211
519
        """
212
520
        v = os.environ.get('BZR_EMAIL')
213
521
        if v:
214
 
            return v.decode(bzrlib.user_encoding)
215
 
        v = os.environ.get('BZREMAIL')
216
 
        if v:
217
 
            warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
218
 
            return v.decode(bzrlib.user_encoding)
219
 
    
 
522
            return v.decode(osutils.get_user_encoding())
220
523
        v = self._get_user_id()
221
524
        if v:
222
525
            return v
223
 
        
224
 
        v = os.environ.get('EMAIL')
225
 
        if v:
226
 
            return v.decode(bzrlib.user_encoding)
227
 
 
228
 
        name, email = _auto_user_id()
229
 
        if name:
230
 
            return '%s <%s>' % (name, email)
231
 
        else:
232
 
            return email
233
 
 
 
526
        return default_email()
 
527
 
 
528
    def ensure_username(self):
 
529
        """Raise errors.NoWhoami if username is not set.
 
530
 
 
531
        This method relies on the username() function raising the error.
 
532
        """
 
533
        self.username()
 
534
 
 
535
    @deprecated_method(deprecated_in((2, 5, 0)))
234
536
    def signature_checking(self):
235
537
        """What is the current policy for signature checking?."""
236
538
        policy = self._get_signature_checking()
238
540
            return policy
239
541
        return CHECK_IF_POSSIBLE
240
542
 
 
543
    @deprecated_method(deprecated_in((2, 5, 0)))
241
544
    def signing_policy(self):
242
545
        """What is the current policy for signature checking?."""
243
546
        policy = self._get_signing_policy()
245
548
            return policy
246
549
        return SIGN_WHEN_REQUIRED
247
550
 
 
551
    @deprecated_method(deprecated_in((2, 5, 0)))
248
552
    def signature_needed(self):
249
553
        """Is a signature needed when committing ?."""
250
554
        policy = self._get_signing_policy()
251
555
        if policy is None:
252
556
            policy = self._get_signature_checking()
253
557
            if policy is not None:
254
 
                warning("Please use create_signatures, not check_signatures "
255
 
                        "to set signing policy.")
256
 
            if policy == CHECK_ALWAYS:
257
 
                return True
 
558
                #this warning should go away once check_signatures is
 
559
                #implemented (if not before)
 
560
                trace.warning("Please use create_signatures,"
 
561
                              " not check_signatures to set signing policy.")
258
562
        elif policy == SIGN_ALWAYS:
259
563
            return True
260
564
        return False
261
565
 
 
566
    @deprecated_method(deprecated_in((2, 5, 0)))
 
567
    def gpg_signing_key(self):
 
568
        """GPG user-id to sign commits"""
 
569
        key = self.get_user_option('gpg_signing_key')
 
570
        if key == "default" or key == None:
 
571
            return self.user_email()
 
572
        else:
 
573
            return key
 
574
 
262
575
    def get_alias(self, value):
263
576
        return self._get_alias(value)
264
577
 
271
584
    def _get_nickname(self):
272
585
        return None
273
586
 
 
587
    def get_bzr_remote_path(self):
 
588
        try:
 
589
            return os.environ['BZR_REMOTE_PATH']
 
590
        except KeyError:
 
591
            path = self.get_user_option("bzr_remote_path")
 
592
            if path is None:
 
593
                path = 'bzr'
 
594
            return path
 
595
 
 
596
    def suppress_warning(self, warning):
 
597
        """Should the warning be suppressed or emitted.
 
598
 
 
599
        :param warning: The name of the warning being tested.
 
600
 
 
601
        :returns: True if the warning should be suppressed, False otherwise.
 
602
        """
 
603
        warnings = self.get_user_option_as_list('suppress_warnings')
 
604
        if warnings is None or warning not in warnings:
 
605
            return False
 
606
        else:
 
607
            return True
 
608
 
 
609
    def get_merge_tools(self):
 
610
        tools = {}
 
611
        for (oname, value, section, conf_id, parser) in self._get_options():
 
612
            if oname.startswith('bzr.mergetool.'):
 
613
                tool_name = oname[len('bzr.mergetool.'):]
 
614
                tools[tool_name] = self.get_user_option(oname, False)
 
615
        trace.mutter('loaded merge tools: %r' % tools)
 
616
        return tools
 
617
 
 
618
    def find_merge_tool(self, name):
 
619
        # We fake a defaults mechanism here by checking if the given name can
 
620
        # be found in the known_merge_tools if it's not found in the config.
 
621
        # This should be done through the proposed config defaults mechanism
 
622
        # when it becomes available in the future.
 
623
        command_line = (self.get_user_option('bzr.mergetool.%s' % name,
 
624
                                             expand=False)
 
625
                        or mergetools.known_merge_tools.get(name, None))
 
626
        return command_line
 
627
 
 
628
 
 
629
class _ConfigHooks(hooks.Hooks):
 
630
    """A dict mapping hook names and a list of callables for configs.
 
631
    """
 
632
 
 
633
    def __init__(self):
 
634
        """Create the default hooks.
 
635
 
 
636
        These are all empty initially, because by default nothing should get
 
637
        notified.
 
638
        """
 
639
        super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
 
640
        self.add_hook('load',
 
641
                      'Invoked when a config store is loaded.'
 
642
                      ' The signature is (store).',
 
643
                      (2, 4))
 
644
        self.add_hook('save',
 
645
                      'Invoked when a config store is saved.'
 
646
                      ' The signature is (store).',
 
647
                      (2, 4))
 
648
        # The hooks for config options
 
649
        self.add_hook('get',
 
650
                      'Invoked when a config option is read.'
 
651
                      ' The signature is (stack, name, value).',
 
652
                      (2, 4))
 
653
        self.add_hook('set',
 
654
                      'Invoked when a config option is set.'
 
655
                      ' The signature is (stack, name, value).',
 
656
                      (2, 4))
 
657
        self.add_hook('remove',
 
658
                      'Invoked when a config option is removed.'
 
659
                      ' The signature is (stack, name).',
 
660
                      (2, 4))
 
661
ConfigHooks = _ConfigHooks()
 
662
 
 
663
 
 
664
class _OldConfigHooks(hooks.Hooks):
 
665
    """A dict mapping hook names and a list of callables for configs.
 
666
    """
 
667
 
 
668
    def __init__(self):
 
669
        """Create the default hooks.
 
670
 
 
671
        These are all empty initially, because by default nothing should get
 
672
        notified.
 
673
        """
 
674
        super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
 
675
        self.add_hook('load',
 
676
                      'Invoked when a config store is loaded.'
 
677
                      ' The signature is (config).',
 
678
                      (2, 4))
 
679
        self.add_hook('save',
 
680
                      'Invoked when a config store is saved.'
 
681
                      ' The signature is (config).',
 
682
                      (2, 4))
 
683
        # The hooks for config options
 
684
        self.add_hook('get',
 
685
                      'Invoked when a config option is read.'
 
686
                      ' The signature is (config, name, value).',
 
687
                      (2, 4))
 
688
        self.add_hook('set',
 
689
                      'Invoked when a config option is set.'
 
690
                      ' The signature is (config, name, value).',
 
691
                      (2, 4))
 
692
        self.add_hook('remove',
 
693
                      'Invoked when a config option is removed.'
 
694
                      ' The signature is (config, name).',
 
695
                      (2, 4))
 
696
OldConfigHooks = _OldConfigHooks()
 
697
 
274
698
 
275
699
class IniBasedConfig(Config):
276
700
    """A configuration policy that draws from ini files."""
277
701
 
278
 
    def _get_parser(self, file=None):
 
702
    def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
 
703
                 file_name=None):
 
704
        """Base class for configuration files using an ini-like syntax.
 
705
 
 
706
        :param file_name: The configuration file path.
 
707
        """
 
708
        super(IniBasedConfig, self).__init__()
 
709
        self.file_name = file_name
 
710
        if symbol_versioning.deprecated_passed(get_filename):
 
711
            symbol_versioning.warn(
 
712
                'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
 
713
                ' Use file_name instead.',
 
714
                DeprecationWarning,
 
715
                stacklevel=2)
 
716
            if get_filename is not None:
 
717
                self.file_name = get_filename()
 
718
        else:
 
719
            self.file_name = file_name
 
720
        self._content = None
 
721
        self._parser = None
 
722
 
 
723
    @classmethod
 
724
    def from_string(cls, str_or_unicode, file_name=None, save=False):
 
725
        """Create a config object from a string.
 
726
 
 
727
        :param str_or_unicode: A string representing the file content. This will
 
728
            be utf-8 encoded.
 
729
 
 
730
        :param file_name: The configuration file path.
 
731
 
 
732
        :param _save: Whether the file should be saved upon creation.
 
733
        """
 
734
        conf = cls(file_name=file_name)
 
735
        conf._create_from_string(str_or_unicode, save)
 
736
        return conf
 
737
 
 
738
    def _create_from_string(self, str_or_unicode, save):
 
739
        self._content = StringIO(str_or_unicode.encode('utf-8'))
 
740
        # Some tests use in-memory configs, some other always need the config
 
741
        # file to exist on disk.
 
742
        if save:
 
743
            self._write_config_file()
 
744
 
 
745
    def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
279
746
        if self._parser is not None:
280
747
            return self._parser
281
 
        if file is None:
282
 
            input = self._get_filename()
 
748
        if symbol_versioning.deprecated_passed(file):
 
749
            symbol_versioning.warn(
 
750
                'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
 
751
                ' Use IniBasedConfig(_content=xxx) instead.',
 
752
                DeprecationWarning,
 
753
                stacklevel=2)
 
754
        if self._content is not None:
 
755
            co_input = self._content
 
756
        elif self.file_name is None:
 
757
            raise AssertionError('We have no content to create the config')
283
758
        else:
284
 
            input = file
 
759
            co_input = self.file_name
285
760
        try:
286
 
            self._parser = ConfigObj(input, encoding='utf-8')
 
761
            self._parser = ConfigObj(co_input, encoding='utf-8')
287
762
        except configobj.ConfigObjError, e:
288
763
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
764
        except UnicodeDecodeError:
 
765
            raise errors.ConfigContentError(self.file_name)
 
766
        # Make sure self.reload() will use the right file name
 
767
        self._parser.filename = self.file_name
 
768
        for hook in OldConfigHooks['load']:
 
769
            hook(self)
289
770
        return self._parser
290
771
 
 
772
    def reload(self):
 
773
        """Reload the config file from disk."""
 
774
        if self.file_name is None:
 
775
            raise AssertionError('We need a file name to reload the config')
 
776
        if self._parser is not None:
 
777
            self._parser.reload()
 
778
        for hook in ConfigHooks['load']:
 
779
            hook(self)
 
780
 
291
781
    def _get_matching_sections(self):
292
782
        """Return an ordered list of (section_name, extra_path) pairs.
293
783
 
304
794
        """Override this to define the section used by the config."""
305
795
        return "DEFAULT"
306
796
 
 
797
    def _get_sections(self, name=None):
 
798
        """Returns an iterator of the sections specified by ``name``.
 
799
 
 
800
        :param name: The section name. If None is supplied, the default
 
801
            configurations are yielded.
 
802
 
 
803
        :return: A tuple (name, section, config_id) for all sections that will
 
804
            be walked by user_get_option() in the 'right' order. The first one
 
805
            is where set_user_option() will update the value.
 
806
        """
 
807
        parser = self._get_parser()
 
808
        if name is not None:
 
809
            yield (name, parser[name], self.config_id())
 
810
        else:
 
811
            # No section name has been given so we fallback to the configobj
 
812
            # itself which holds the variables defined outside of any section.
 
813
            yield (None, parser, self.config_id())
 
814
 
 
815
    def _get_options(self, sections=None):
 
816
        """Return an ordered list of (name, value, section, config_id) tuples.
 
817
 
 
818
        All options are returned with their associated value and the section
 
819
        they appeared in. ``config_id`` is a unique identifier for the
 
820
        configuration file the option is defined in.
 
821
 
 
822
        :param sections: Default to ``_get_matching_sections`` if not
 
823
            specified. This gives a better control to daughter classes about
 
824
            which sections should be searched. This is a list of (name,
 
825
            configobj) tuples.
 
826
        """
 
827
        opts = []
 
828
        if sections is None:
 
829
            parser = self._get_parser()
 
830
            sections = []
 
831
            for (section_name, _) in self._get_matching_sections():
 
832
                try:
 
833
                    section = parser[section_name]
 
834
                except KeyError:
 
835
                    # This could happen for an empty file for which we define a
 
836
                    # DEFAULT section. FIXME: Force callers to provide sections
 
837
                    # instead ? -- vila 20100930
 
838
                    continue
 
839
                sections.append((section_name, section))
 
840
        config_id = self.config_id()
 
841
        for (section_name, section) in sections:
 
842
            for (name, value) in section.iteritems():
 
843
                yield (name, parser._quote(value), section_name,
 
844
                       config_id, parser)
 
845
 
307
846
    def _get_option_policy(self, section, option_name):
308
847
        """Return the policy for the given (section, option_name) pair."""
309
848
        return POLICY_NONE
310
849
 
 
850
    def _get_change_editor(self):
 
851
        return self.get_user_option('change_editor')
 
852
 
311
853
    def _get_signature_checking(self):
312
854
        """See Config._get_signature_checking."""
313
855
        policy = self._get_user_option('check_signatures')
314
856
        if policy:
315
 
            return self._string_to_signature_policy(policy)
 
857
            return signature_policy_from_unicode(policy)
316
858
 
317
859
    def _get_signing_policy(self):
318
860
        """See Config._get_signing_policy"""
319
861
        policy = self._get_user_option('create_signatures')
320
862
        if policy:
321
 
            return self._string_to_signing_policy(policy)
 
863
            return signing_policy_from_unicode(policy)
322
864
 
323
865
    def _get_user_id(self):
324
866
        """Get the user id from the 'email' key in the current section."""
357
899
        """See Config.log_format."""
358
900
        return self._get_user_option('log_format')
359
901
 
360
 
    def __init__(self, get_filename):
361
 
        super(IniBasedConfig, self).__init__()
362
 
        self._get_filename = get_filename
363
 
        self._parser = None
364
 
        
 
902
    def _validate_signatures_in_log(self):
 
903
        """See Config.validate_signatures_in_log."""
 
904
        return self._get_user_option('validate_signatures_in_log')
 
905
 
 
906
    def _acceptable_keys(self):
 
907
        """See Config.acceptable_keys."""
 
908
        return self._get_user_option('acceptable_keys')
 
909
 
365
910
    def _post_commit(self):
366
911
        """See Config.post_commit."""
367
912
        return self._get_user_option('post_commit')
368
913
 
369
 
    def _string_to_signature_policy(self, signature_string):
370
 
        """Convert a string to a signing policy."""
371
 
        if signature_string.lower() == 'check-available':
372
 
            return CHECK_IF_POSSIBLE
373
 
        if signature_string.lower() == 'ignore':
374
 
            return CHECK_NEVER
375
 
        if signature_string.lower() == 'require':
376
 
            return CHECK_ALWAYS
377
 
        raise errors.BzrError("Invalid signatures policy '%s'"
378
 
                              % signature_string)
379
 
 
380
 
    def _string_to_signing_policy(self, signature_string):
381
 
        """Convert a string to a signing policy."""
382
 
        if signature_string.lower() == 'when-required':
383
 
            return SIGN_WHEN_REQUIRED
384
 
        if signature_string.lower() == 'never':
385
 
            return SIGN_NEVER
386
 
        if signature_string.lower() == 'always':
387
 
            return SIGN_ALWAYS
388
 
        raise errors.BzrError("Invalid signing policy '%s'"
389
 
                              % signature_string)
390
 
 
391
914
    def _get_alias(self, value):
392
915
        try:
393
 
            return self._get_parser().get_value("ALIASES", 
 
916
            return self._get_parser().get_value("ALIASES",
394
917
                                                value)
395
918
        except KeyError:
396
919
            pass
398
921
    def _get_nickname(self):
399
922
        return self.get_user_option('nickname')
400
923
 
401
 
 
402
 
class GlobalConfig(IniBasedConfig):
 
924
    def remove_user_option(self, option_name, section_name=None):
 
925
        """Remove a user option and save the configuration file.
 
926
 
 
927
        :param option_name: The option to be removed.
 
928
 
 
929
        :param section_name: The section the option is defined in, default to
 
930
            the default section.
 
931
        """
 
932
        self.reload()
 
933
        parser = self._get_parser()
 
934
        if section_name is None:
 
935
            section = parser
 
936
        else:
 
937
            section = parser[section_name]
 
938
        try:
 
939
            del section[option_name]
 
940
        except KeyError:
 
941
            raise errors.NoSuchConfigOption(option_name)
 
942
        self._write_config_file()
 
943
        for hook in OldConfigHooks['remove']:
 
944
            hook(self, option_name)
 
945
 
 
946
    def _write_config_file(self):
 
947
        if self.file_name is None:
 
948
            raise AssertionError('We cannot save, self.file_name is None')
 
949
        conf_dir = os.path.dirname(self.file_name)
 
950
        ensure_config_dir_exists(conf_dir)
 
951
        atomic_file = atomicfile.AtomicFile(self.file_name)
 
952
        self._get_parser().write(atomic_file)
 
953
        atomic_file.commit()
 
954
        atomic_file.close()
 
955
        osutils.copy_ownership_from_path(self.file_name)
 
956
        for hook in OldConfigHooks['save']:
 
957
            hook(self)
 
958
 
 
959
 
 
960
class LockableConfig(IniBasedConfig):
 
961
    """A configuration needing explicit locking for access.
 
962
 
 
963
    If several processes try to write the config file, the accesses need to be
 
964
    serialized.
 
965
 
 
966
    Daughter classes should decorate all methods that update a config with the
 
967
    ``@needs_write_lock`` decorator (they call, directly or indirectly, the
 
968
    ``_write_config_file()`` method. These methods (typically ``set_option()``
 
969
    and variants must reload the config file from disk before calling
 
970
    ``_write_config_file()``), this can be achieved by calling the
 
971
    ``self.reload()`` method. Note that the lock scope should cover both the
 
972
    reading and the writing of the config file which is why the decorator can't
 
973
    be applied to ``_write_config_file()`` only.
 
974
 
 
975
    This should be enough to implement the following logic:
 
976
    - lock for exclusive write access,
 
977
    - reload the config file from disk,
 
978
    - set the new value
 
979
    - unlock
 
980
 
 
981
    This logic guarantees that a writer can update a value without erasing an
 
982
    update made by another writer.
 
983
    """
 
984
 
 
985
    lock_name = 'lock'
 
986
 
 
987
    def __init__(self, file_name):
 
988
        super(LockableConfig, self).__init__(file_name=file_name)
 
989
        self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
 
990
        # FIXME: It doesn't matter that we don't provide possible_transports
 
991
        # below since this is currently used only for local config files ;
 
992
        # local transports are not shared. But if/when we start using
 
993
        # LockableConfig for other kind of transports, we will need to reuse
 
994
        # whatever connection is already established -- vila 20100929
 
995
        self.transport = transport.get_transport_from_path(self.dir)
 
996
        self._lock = lockdir.LockDir(self.transport, self.lock_name)
 
997
 
 
998
    def _create_from_string(self, unicode_bytes, save):
 
999
        super(LockableConfig, self)._create_from_string(unicode_bytes, False)
 
1000
        if save:
 
1001
            # We need to handle the saving here (as opposed to IniBasedConfig)
 
1002
            # to be able to lock
 
1003
            self.lock_write()
 
1004
            self._write_config_file()
 
1005
            self.unlock()
 
1006
 
 
1007
    def lock_write(self, token=None):
 
1008
        """Takes a write lock in the directory containing the config file.
 
1009
 
 
1010
        If the directory doesn't exist it is created.
 
1011
        """
 
1012
        ensure_config_dir_exists(self.dir)
 
1013
        return self._lock.lock_write(token)
 
1014
 
 
1015
    def unlock(self):
 
1016
        self._lock.unlock()
 
1017
 
 
1018
    def break_lock(self):
 
1019
        self._lock.break_lock()
 
1020
 
 
1021
    @needs_write_lock
 
1022
    def remove_user_option(self, option_name, section_name=None):
 
1023
        super(LockableConfig, self).remove_user_option(option_name,
 
1024
                                                       section_name)
 
1025
 
 
1026
    def _write_config_file(self):
 
1027
        if self._lock is None or not self._lock.is_held:
 
1028
            # NB: if the following exception is raised it probably means a
 
1029
            # missing @needs_write_lock decorator on one of the callers.
 
1030
            raise errors.ObjectNotLocked(self)
 
1031
        super(LockableConfig, self)._write_config_file()
 
1032
 
 
1033
 
 
1034
class GlobalConfig(LockableConfig):
403
1035
    """The configuration that should be used for a specific location."""
404
1036
 
405
 
    def get_editor(self):
406
 
        return self._get_user_option('editor')
407
 
 
408
1037
    def __init__(self):
409
 
        super(GlobalConfig, self).__init__(config_filename)
410
 
 
 
1038
        super(GlobalConfig, self).__init__(file_name=config_filename())
 
1039
 
 
1040
    def config_id(self):
 
1041
        return 'bazaar'
 
1042
 
 
1043
    @classmethod
 
1044
    def from_string(cls, str_or_unicode, save=False):
 
1045
        """Create a config object from a string.
 
1046
 
 
1047
        :param str_or_unicode: A string representing the file content. This
 
1048
            will be utf-8 encoded.
 
1049
 
 
1050
        :param save: Whether the file should be saved upon creation.
 
1051
        """
 
1052
        conf = cls()
 
1053
        conf._create_from_string(str_or_unicode, save)
 
1054
        return conf
 
1055
 
 
1056
    @needs_write_lock
411
1057
    def set_user_option(self, option, value):
412
1058
        """Save option and its value in the configuration."""
413
 
        # FIXME: RBC 20051029 This should refresh the parser and also take a
414
 
        # file lock on bazaar.conf.
415
 
        conf_dir = os.path.dirname(self._get_filename())
416
 
        ensure_config_dir_exists(conf_dir)
417
 
        if 'DEFAULT' not in self._get_parser():
418
 
            self._get_parser()['DEFAULT'] = {}
419
 
        self._get_parser()['DEFAULT'][option] = value
420
 
        f = open(self._get_filename(), 'wb')
421
 
        self._get_parser().write(f)
422
 
        f.close()
423
 
 
424
 
 
425
 
class LocationConfig(IniBasedConfig):
 
1059
        self._set_option(option, value, 'DEFAULT')
 
1060
 
 
1061
    def get_aliases(self):
 
1062
        """Return the aliases section."""
 
1063
        if 'ALIASES' in self._get_parser():
 
1064
            return self._get_parser()['ALIASES']
 
1065
        else:
 
1066
            return {}
 
1067
 
 
1068
    @needs_write_lock
 
1069
    def set_alias(self, alias_name, alias_command):
 
1070
        """Save the alias in the configuration."""
 
1071
        self._set_option(alias_name, alias_command, 'ALIASES')
 
1072
 
 
1073
    @needs_write_lock
 
1074
    def unset_alias(self, alias_name):
 
1075
        """Unset an existing alias."""
 
1076
        self.reload()
 
1077
        aliases = self._get_parser().get('ALIASES')
 
1078
        if not aliases or alias_name not in aliases:
 
1079
            raise errors.NoSuchAlias(alias_name)
 
1080
        del aliases[alias_name]
 
1081
        self._write_config_file()
 
1082
 
 
1083
    def _set_option(self, option, value, section):
 
1084
        self.reload()
 
1085
        self._get_parser().setdefault(section, {})[option] = value
 
1086
        self._write_config_file()
 
1087
        for hook in OldConfigHooks['set']:
 
1088
            hook(self, option, value)
 
1089
 
 
1090
    def _get_sections(self, name=None):
 
1091
        """See IniBasedConfig._get_sections()."""
 
1092
        parser = self._get_parser()
 
1093
        # We don't give access to options defined outside of any section, we
 
1094
        # used the DEFAULT section by... default.
 
1095
        if name in (None, 'DEFAULT'):
 
1096
            # This could happen for an empty file where the DEFAULT section
 
1097
            # doesn't exist yet. So we force DEFAULT when yielding
 
1098
            name = 'DEFAULT'
 
1099
            if 'DEFAULT' not in parser:
 
1100
               parser['DEFAULT']= {}
 
1101
        yield (name, parser[name], self.config_id())
 
1102
 
 
1103
    @needs_write_lock
 
1104
    def remove_user_option(self, option_name, section_name=None):
 
1105
        if section_name is None:
 
1106
            # We need to force the default section.
 
1107
            section_name = 'DEFAULT'
 
1108
        # We need to avoid the LockableConfig implementation or we'll lock
 
1109
        # twice
 
1110
        super(LockableConfig, self).remove_user_option(option_name,
 
1111
                                                       section_name)
 
1112
 
 
1113
def _iter_for_location_by_parts(sections, location):
 
1114
    """Keep only the sessions matching the specified location.
 
1115
 
 
1116
    :param sections: An iterable of section names.
 
1117
 
 
1118
    :param location: An url or a local path to match against.
 
1119
 
 
1120
    :returns: An iterator of (section, extra_path, nb_parts) where nb is the
 
1121
        number of path components in the section name, section is the section
 
1122
        name and extra_path is the difference between location and the section
 
1123
        name.
 
1124
 
 
1125
    ``location`` will always be a local path and never a 'file://' url but the
 
1126
    section names themselves can be in either form.
 
1127
    """
 
1128
    location_parts = location.rstrip('/').split('/')
 
1129
 
 
1130
    for section in sections:
 
1131
        # location is a local path if possible, so we need to convert 'file://'
 
1132
        # urls in section names to local paths if necessary.
 
1133
 
 
1134
        # This also avoids having file:///path be a more exact
 
1135
        # match than '/path'.
 
1136
 
 
1137
        # FIXME: This still raises an issue if a user defines both file:///path
 
1138
        # *and* /path. Should we raise an error in this case -- vila 20110505
 
1139
 
 
1140
        if section.startswith('file://'):
 
1141
            section_path = urlutils.local_path_from_url(section)
 
1142
        else:
 
1143
            section_path = section
 
1144
        section_parts = section_path.rstrip('/').split('/')
 
1145
 
 
1146
        matched = True
 
1147
        if len(section_parts) > len(location_parts):
 
1148
            # More path components in the section, they can't match
 
1149
            matched = False
 
1150
        else:
 
1151
            # Rely on zip truncating in length to the length of the shortest
 
1152
            # argument sequence.
 
1153
            names = zip(location_parts, section_parts)
 
1154
            for name in names:
 
1155
                if not fnmatch.fnmatch(name[0], name[1]):
 
1156
                    matched = False
 
1157
                    break
 
1158
        if not matched:
 
1159
            continue
 
1160
        # build the path difference between the section and the location
 
1161
        extra_path = '/'.join(location_parts[len(section_parts):])
 
1162
        yield section, extra_path, len(section_parts)
 
1163
 
 
1164
 
 
1165
class LocationConfig(LockableConfig):
426
1166
    """A configuration object that gives the policy for a location."""
427
1167
 
428
1168
    def __init__(self, location):
429
 
        name_generator = locations_config_filename
430
 
        if (not os.path.exists(name_generator()) and 
431
 
                os.path.exists(branches_config_filename())):
432
 
            if sys.platform == 'win32':
433
 
                warning('Please rename %s to %s' 
434
 
                         % (branches_config_filename(),
435
 
                            locations_config_filename()))
436
 
            else:
437
 
                warning('Please rename ~/.bazaar/branches.conf'
438
 
                        ' to ~/.bazaar/locations.conf')
439
 
            name_generator = branches_config_filename
440
 
        super(LocationConfig, self).__init__(name_generator)
 
1169
        super(LocationConfig, self).__init__(
 
1170
            file_name=locations_config_filename())
441
1171
        # local file locations are looked up by local path, rather than
442
1172
        # by file url. This is because the config file is a user
443
1173
        # file, and we would rather not expose the user to file urls.
445
1175
            location = urlutils.local_path_from_url(location)
446
1176
        self.location = location
447
1177
 
 
1178
    def config_id(self):
 
1179
        return 'locations'
 
1180
 
 
1181
    @classmethod
 
1182
    def from_string(cls, str_or_unicode, location, save=False):
 
1183
        """Create a config object from a string.
 
1184
 
 
1185
        :param str_or_unicode: A string representing the file content. This will
 
1186
            be utf-8 encoded.
 
1187
 
 
1188
        :param location: The location url to filter the configuration.
 
1189
 
 
1190
        :param save: Whether the file should be saved upon creation.
 
1191
        """
 
1192
        conf = cls(location)
 
1193
        conf._create_from_string(str_or_unicode, save)
 
1194
        return conf
 
1195
 
448
1196
    def _get_matching_sections(self):
449
1197
        """Return an ordered list of section names matching this location."""
450
 
        sections = self._get_parser()
451
 
        location_names = self.location.split('/')
452
 
        if self.location.endswith('/'):
453
 
            del location_names[-1]
454
 
        matches=[]
455
 
        for section in sections:
456
 
            # location is a local path if possible, so we need
457
 
            # to convert 'file://' urls to local paths if necessary.
458
 
            # This also avoids having file:///path be a more exact
459
 
            # match than '/path'.
460
 
            if section.startswith('file://'):
461
 
                section_path = urlutils.local_path_from_url(section)
462
 
            else:
463
 
                section_path = section
464
 
            section_names = section_path.split('/')
465
 
            if section.endswith('/'):
466
 
                del section_names[-1]
467
 
            names = zip(location_names, section_names)
468
 
            matched = True
469
 
            for name in names:
470
 
                if not fnmatch(name[0], name[1]):
471
 
                    matched = False
472
 
                    break
473
 
            if not matched:
474
 
                continue
475
 
            # so, for the common prefix they matched.
476
 
            # if section is longer, no match.
477
 
            if len(section_names) > len(location_names):
478
 
                continue
479
 
            matches.append((len(section_names), section,
480
 
                            '/'.join(location_names[len(section_names):])))
481
 
        matches.sort(reverse=True)
482
 
        sections = []
483
 
        for (length, section, extra_path) in matches:
484
 
            sections.append((section, extra_path))
 
1198
        matches = list(_iter_for_location_by_parts(self._get_parser(),
 
1199
                                                   self.location))
 
1200
        # put the longest (aka more specific) locations first
 
1201
        matches.sort(
 
1202
            key=lambda (section, extra_path, length): (length, section),
 
1203
            reverse=True)
 
1204
        for (section, extra_path, length) in matches:
 
1205
            yield section, extra_path
485
1206
            # should we stop looking for parent configs here?
486
1207
            try:
487
1208
                if self._get_parser()[section].as_bool('ignore_parents'):
488
1209
                    break
489
1210
            except KeyError:
490
1211
                pass
491
 
        return sections
 
1212
 
 
1213
    def _get_sections(self, name=None):
 
1214
        """See IniBasedConfig._get_sections()."""
 
1215
        # We ignore the name here as the only sections handled are named with
 
1216
        # the location path and we don't expose embedded sections either.
 
1217
        parser = self._get_parser()
 
1218
        for name, extra_path in self._get_matching_sections():
 
1219
            yield (name, parser[name], self.config_id())
492
1220
 
493
1221
    def _get_option_policy(self, section, option_name):
494
1222
        """Return the policy for the given (section, option_name) pair."""
538
1266
            if policy_key in self._get_parser()[section]:
539
1267
                del self._get_parser()[section][policy_key]
540
1268
 
 
1269
    @needs_write_lock
541
1270
    def set_user_option(self, option, value, store=STORE_LOCATION):
542
1271
        """Save option and its value in the configuration."""
543
 
        assert store in [STORE_LOCATION,
 
1272
        if store not in [STORE_LOCATION,
544
1273
                         STORE_LOCATION_NORECURSE,
545
 
                         STORE_LOCATION_APPENDPATH], 'bad storage policy'
546
 
        # FIXME: RBC 20051029 This should refresh the parser and also take a
547
 
        # file lock on locations.conf.
548
 
        conf_dir = os.path.dirname(self._get_filename())
549
 
        ensure_config_dir_exists(conf_dir)
 
1274
                         STORE_LOCATION_APPENDPATH]:
 
1275
            raise ValueError('bad storage policy %r for %r' %
 
1276
                (store, option))
 
1277
        self.reload()
550
1278
        location = self.location
551
1279
        if location.endswith('/'):
552
1280
            location = location[:-1]
553
 
        if (not location in self._get_parser() and
554
 
            not location + '/' in self._get_parser()):
555
 
            self._get_parser()[location]={}
556
 
        elif location + '/' in self._get_parser():
 
1281
        parser = self._get_parser()
 
1282
        if not location in parser and not location + '/' in parser:
 
1283
            parser[location] = {}
 
1284
        elif location + '/' in parser:
557
1285
            location = location + '/'
558
 
        self._get_parser()[location][option]=value
 
1286
        parser[location][option]=value
559
1287
        # the allowed values of store match the config policies
560
1288
        self._set_option_policy(location, option, store)
561
 
        self._get_parser().write(file(self._get_filename(), 'wb'))
 
1289
        self._write_config_file()
 
1290
        for hook in OldConfigHooks['set']:
 
1291
            hook(self, option, value)
562
1292
 
563
1293
 
564
1294
class BranchConfig(Config):
565
1295
    """A configuration object giving the policy for a branch."""
566
1296
 
 
1297
    def __init__(self, branch):
 
1298
        super(BranchConfig, self).__init__()
 
1299
        self._location_config = None
 
1300
        self._branch_data_config = None
 
1301
        self._global_config = None
 
1302
        self.branch = branch
 
1303
        self.option_sources = (self._get_location_config,
 
1304
                               self._get_branch_data_config,
 
1305
                               self._get_global_config)
 
1306
 
 
1307
    def config_id(self):
 
1308
        return 'branch'
 
1309
 
567
1310
    def _get_branch_data_config(self):
568
1311
        if self._branch_data_config is None:
569
1312
            self._branch_data_config = TreeConfig(self.branch)
 
1313
            self._branch_data_config.config_id = self.config_id
570
1314
        return self._branch_data_config
571
1315
 
572
1316
    def _get_location_config(self):
593
1337
 
594
1338
    def _get_safe_value(self, option_name):
595
1339
        """This variant of get_best_value never returns untrusted values.
596
 
        
 
1340
 
597
1341
        It does not return values from the branch data, because the branch may
598
1342
        not be controlled by the user.
599
1343
 
608
1352
 
609
1353
    def _get_user_id(self):
610
1354
        """Return the full user id for the branch.
611
 
    
612
 
        e.g. "John Hacker <jhacker@foo.org>"
 
1355
 
 
1356
        e.g. "John Hacker <jhacker@example.com>"
613
1357
        This is looked up in the email controlfile for the branch.
614
1358
        """
615
 
        try:
616
 
            return (self.branch.control_files.get_utf8("email") 
617
 
                    .read()
618
 
                    .decode(bzrlib.user_encoding)
619
 
                    .rstrip("\r\n"))
620
 
        except errors.NoSuchFile, e:
621
 
            pass
622
 
        
623
1359
        return self._get_best_value('_get_user_id')
624
1360
 
 
1361
    def _get_change_editor(self):
 
1362
        return self._get_best_value('_get_change_editor')
 
1363
 
625
1364
    def _get_signature_checking(self):
626
1365
        """See Config._get_signature_checking."""
627
1366
        return self._get_best_value('_get_signature_checking')
638
1377
                return value
639
1378
        return None
640
1379
 
641
 
    def set_user_option(self, name, value, store=STORE_BRANCH):
 
1380
    def _get_sections(self, name=None):
 
1381
        """See IniBasedConfig.get_sections()."""
 
1382
        for source in self.option_sources:
 
1383
            for section in source()._get_sections(name):
 
1384
                yield section
 
1385
 
 
1386
    def _get_options(self, sections=None):
 
1387
        opts = []
 
1388
        # First the locations options
 
1389
        for option in self._get_location_config()._get_options():
 
1390
            yield option
 
1391
        # Then the branch options
 
1392
        branch_config = self._get_branch_data_config()
 
1393
        if sections is None:
 
1394
            sections = [('DEFAULT', branch_config._get_parser())]
 
1395
        # FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
 
1396
        # Config itself has no notion of sections :( -- vila 20101001
 
1397
        config_id = self.config_id()
 
1398
        for (section_name, section) in sections:
 
1399
            for (name, value) in section.iteritems():
 
1400
                yield (name, value, section_name,
 
1401
                       config_id, branch_config._get_parser())
 
1402
        # Then the global options
 
1403
        for option in self._get_global_config()._get_options():
 
1404
            yield option
 
1405
 
 
1406
    def set_user_option(self, name, value, store=STORE_BRANCH,
 
1407
        warn_masked=False):
642
1408
        if store == STORE_BRANCH:
643
1409
            self._get_branch_data_config().set_option(value, name)
644
1410
        elif store == STORE_GLOBAL:
645
1411
            self._get_global_config().set_user_option(name, value)
646
1412
        else:
647
1413
            self._get_location_config().set_user_option(name, value, store)
 
1414
        if not warn_masked:
 
1415
            return
 
1416
        if store in (STORE_GLOBAL, STORE_BRANCH):
 
1417
            mask_value = self._get_location_config().get_user_option(name)
 
1418
            if mask_value is not None:
 
1419
                trace.warning('Value "%s" is masked by "%s" from'
 
1420
                              ' locations.conf', value, mask_value)
 
1421
            else:
 
1422
                if store == STORE_GLOBAL:
 
1423
                    branch_config = self._get_branch_data_config()
 
1424
                    mask_value = branch_config.get_user_option(name)
 
1425
                    if mask_value is not None:
 
1426
                        trace.warning('Value "%s" is masked by "%s" from'
 
1427
                                      ' branch.conf', value, mask_value)
 
1428
 
 
1429
    def remove_user_option(self, option_name, section_name=None):
 
1430
        self._get_branch_data_config().remove_option(option_name, section_name)
648
1431
 
649
1432
    def _gpg_signing_command(self):
650
1433
        """See Config.gpg_signing_command."""
651
1434
        return self._get_safe_value('_gpg_signing_command')
652
 
        
653
 
    def __init__(self, branch):
654
 
        super(BranchConfig, self).__init__()
655
 
        self._location_config = None
656
 
        self._branch_data_config = None
657
 
        self._global_config = None
658
 
        self.branch = branch
659
 
        self.option_sources = (self._get_location_config, 
660
 
                               self._get_branch_data_config,
661
 
                               self._get_global_config)
662
1435
 
663
1436
    def _post_commit(self):
664
1437
        """See Config.post_commit."""
668
1441
        value = self._get_explicit_nickname()
669
1442
        if value is not None:
670
1443
            return value
 
1444
        if self.branch.name:
 
1445
            return self.branch.name
671
1446
        return urlutils.unescape(self.branch.base.split('/')[-2])
672
1447
 
673
1448
    def has_explicit_nickname(self):
681
1456
        """See Config.log_format."""
682
1457
        return self._get_best_value('_log_format')
683
1458
 
 
1459
    def _validate_signatures_in_log(self):
 
1460
        """See Config.validate_signatures_in_log."""
 
1461
        return self._get_best_value('_validate_signatures_in_log')
 
1462
 
 
1463
    def _acceptable_keys(self):
 
1464
        """See Config.acceptable_keys."""
 
1465
        return self._get_best_value('_acceptable_keys')
 
1466
 
684
1467
 
685
1468
def ensure_config_dir_exists(path=None):
686
1469
    """Make sure a configuration directory exists.
694
1477
        if sys.platform == 'win32':
695
1478
            parent_dir = os.path.dirname(path)
696
1479
            if not os.path.isdir(parent_dir):
697
 
                mutter('creating config parent directory: %r', parent_dir)
698
 
            os.mkdir(parent_dir)
699
 
        mutter('creating config directory: %r', path)
 
1480
                trace.mutter('creating config parent directory: %r', parent_dir)
 
1481
                os.mkdir(parent_dir)
 
1482
        trace.mutter('creating config directory: %r', path)
700
1483
        os.mkdir(path)
 
1484
        osutils.copy_ownership_from_path(path)
701
1485
 
702
1486
 
703
1487
def config_dir():
704
 
    """Return per-user configuration directory.
705
 
 
706
 
    By default this is ~/.bazaar/
707
 
    
 
1488
    """Return per-user configuration directory as unicode string
 
1489
 
 
1490
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
 
1491
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
 
1492
    that will be used instead.
 
1493
 
708
1494
    TODO: Global option --config-dir to override this.
709
1495
    """
710
 
    base = os.environ.get('BZR_HOME', None)
 
1496
    base = osutils.path_from_environ('BZR_HOME')
711
1497
    if sys.platform == 'win32':
712
1498
        if base is None:
713
 
            base = win32utils.get_appdata_location_unicode()
714
 
        if base is None:
715
 
            base = os.environ.get('HOME', None)
716
 
        if base is None:
717
 
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
 
1499
            base = win32utils.get_appdata_location()
 
1500
        if base is None:
 
1501
            base = win32utils.get_home_location()
 
1502
        # GZ 2012-02-01: Really the two level subdirs only make sense inside
 
1503
        #                APPDATA, but hard to move. See bug 348640 for more.
718
1504
        return osutils.pathjoin(base, 'bazaar', '2.0')
719
 
    else:
720
 
        # cygwin, linux, and darwin all have a $HOME directory
721
 
        if base is None:
722
 
            base = os.path.expanduser("~")
723
 
        return osutils.pathjoin(base, ".bazaar")
 
1505
    if base is None:
 
1506
        # GZ 2012-02-01: What should OSX use instead of XDG if anything?
 
1507
        if sys.platform != 'darwin':
 
1508
            xdg_dir = osutils.path_from_environ('XDG_CONFIG_HOME')
 
1509
            if xdg_dir is None:
 
1510
                xdg_dir = osutils.pathjoin(osutils._get_home_dir(), ".config")
 
1511
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
 
1512
            if osutils.isdir(xdg_dir):
 
1513
                trace.mutter(
 
1514
                    "Using configuration in XDG directory %s." % xdg_dir)
 
1515
                return xdg_dir
 
1516
        base = osutils._get_home_dir()
 
1517
    return osutils.pathjoin(base, ".bazaar")
724
1518
 
725
1519
 
726
1520
def config_filename():
728
1522
    return osutils.pathjoin(config_dir(), 'bazaar.conf')
729
1523
 
730
1524
 
731
 
def branches_config_filename():
732
 
    """Return per-user configuration ini file filename."""
733
 
    return osutils.pathjoin(config_dir(), 'branches.conf')
734
 
 
735
 
 
736
1525
def locations_config_filename():
737
1526
    """Return per-user configuration ini file filename."""
738
1527
    return osutils.pathjoin(config_dir(), 'locations.conf')
739
1528
 
740
1529
 
 
1530
def authentication_config_filename():
 
1531
    """Return per-user authentication ini file filename."""
 
1532
    return osutils.pathjoin(config_dir(), 'authentication.conf')
 
1533
 
 
1534
 
741
1535
def user_ignore_config_filename():
742
1536
    """Return the user default ignore filename"""
743
1537
    return osutils.pathjoin(config_dir(), 'ignore')
744
1538
 
745
1539
 
 
1540
def crash_dir():
 
1541
    """Return the directory name to store crash files.
 
1542
 
 
1543
    This doesn't implicitly create it.
 
1544
 
 
1545
    On Windows it's in the config directory; elsewhere it's /var/crash
 
1546
    which may be monitored by apport.  It can be overridden by
 
1547
    $APPORT_CRASH_DIR.
 
1548
    """
 
1549
    if sys.platform == 'win32':
 
1550
        return osutils.pathjoin(config_dir(), 'Crash')
 
1551
    else:
 
1552
        # XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
 
1553
        # 2010-01-31
 
1554
        return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
 
1555
 
 
1556
 
 
1557
def xdg_cache_dir():
 
1558
    # See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
 
1559
    # Possibly this should be different on Windows?
 
1560
    e = os.environ.get('XDG_CACHE_DIR', None)
 
1561
    if e:
 
1562
        return e
 
1563
    else:
 
1564
        return os.path.expanduser('~/.cache')
 
1565
 
 
1566
 
 
1567
def _get_default_mail_domain(mailname_file='/etc/mailname'):
 
1568
    """If possible, return the assumed default email domain.
 
1569
 
 
1570
    :returns: string mail domain, or None.
 
1571
    """
 
1572
    if sys.platform == 'win32':
 
1573
        # No implementation yet; patches welcome
 
1574
        return None
 
1575
    try:
 
1576
        f = open(mailname_file)
 
1577
    except (IOError, OSError), e:
 
1578
        return None
 
1579
    try:
 
1580
        domain = f.readline().strip()
 
1581
        return domain
 
1582
    finally:
 
1583
        f.close()
 
1584
 
 
1585
 
 
1586
def default_email():
 
1587
    v = os.environ.get('BZR_EMAIL')
 
1588
    if v:
 
1589
        return v.decode(osutils.get_user_encoding())
 
1590
    v = os.environ.get('EMAIL')
 
1591
    if v:
 
1592
        return v.decode(osutils.get_user_encoding())
 
1593
    name, email = _auto_user_id()
 
1594
    if name and email:
 
1595
        return u'%s <%s>' % (name, email)
 
1596
    elif email:
 
1597
        return email
 
1598
    raise errors.NoWhoami()
 
1599
 
 
1600
 
746
1601
def _auto_user_id():
747
1602
    """Calculate automatic user identification.
748
1603
 
749
 
    Returns (realname, email).
 
1604
    :returns: (realname, email), either of which may be None if they can't be
 
1605
    determined.
750
1606
 
751
1607
    Only used when none is set in the environment or the id file.
752
1608
 
753
 
    This previously used the FQDN as the default domain, but that can
754
 
    be very slow on machines where DNS is broken.  So now we simply
755
 
    use the hostname.
 
1609
    This only returns an email address if we can be fairly sure the 
 
1610
    address is reasonable, ie if /etc/mailname is set on unix.
 
1611
 
 
1612
    This doesn't use the FQDN as the default domain because that may be 
 
1613
    slow, and it doesn't use the hostname alone because that's not normally 
 
1614
    a reasonable address.
756
1615
    """
757
 
    import socket
758
 
 
759
1616
    if sys.platform == 'win32':
760
 
        name = win32utils.get_user_name_unicode()
761
 
        if name is None:
762
 
            raise errors.BzrError("Cannot autodetect user name.\n"
763
 
                                  "Please, set your name with command like:\n"
764
 
                                  'bzr whoami "Your Name <name@domain.com>"')
765
 
        host = win32utils.get_host_name_unicode()
766
 
        if host is None:
767
 
            host = socket.gethostname()
768
 
        return name, (name + '@' + host)
769
 
 
 
1617
        # No implementation to reliably determine Windows default mail
 
1618
        # address; please add one.
 
1619
        return None, None
 
1620
 
 
1621
    default_mail_domain = _get_default_mail_domain()
 
1622
    if not default_mail_domain:
 
1623
        return None, None
 
1624
 
 
1625
    import pwd
 
1626
    uid = os.getuid()
770
1627
    try:
771
 
        import pwd
772
 
        uid = os.getuid()
773
1628
        w = pwd.getpwuid(uid)
774
 
 
775
 
        # we try utf-8 first, because on many variants (like Linux),
776
 
        # /etc/passwd "should" be in utf-8, and because it's unlikely to give
777
 
        # false positives.  (many users will have their user encoding set to
778
 
        # latin-1, which cannot raise UnicodeError.)
779
 
        try:
780
 
            gecos = w.pw_gecos.decode('utf-8')
781
 
            encoding = 'utf-8'
782
 
        except UnicodeError:
783
 
            try:
784
 
                gecos = w.pw_gecos.decode(bzrlib.user_encoding)
785
 
                encoding = bzrlib.user_encoding
786
 
            except UnicodeError:
787
 
                raise errors.BzrCommandError('Unable to determine your name.  '
788
 
                   'Use "bzr whoami" to set it.')
789
 
        try:
790
 
            username = w.pw_name.decode(encoding)
791
 
        except UnicodeError:
792
 
            raise errors.BzrCommandError('Unable to determine your name.  '
793
 
                'Use "bzr whoami" to set it.')
794
 
 
795
 
        comma = gecos.find(',')
796
 
        if comma == -1:
797
 
            realname = gecos
798
 
        else:
799
 
            realname = gecos[:comma]
800
 
        if not realname:
801
 
            realname = username
802
 
 
803
 
    except ImportError:
804
 
        import getpass
805
 
        try:
806
 
            realname = username = getpass.getuser().decode(bzrlib.user_encoding)
807
 
        except UnicodeDecodeError:
808
 
            raise errors.BzrError("Can't decode username as %s." % \
809
 
                    bzrlib.user_encoding)
810
 
 
811
 
    return realname, (username + '@' + socket.gethostname())
 
1629
    except KeyError:
 
1630
        trace.mutter('no passwd entry for uid %d?' % uid)
 
1631
        return None, None
 
1632
 
 
1633
    # we try utf-8 first, because on many variants (like Linux),
 
1634
    # /etc/passwd "should" be in utf-8, and because it's unlikely to give
 
1635
    # false positives.  (many users will have their user encoding set to
 
1636
    # latin-1, which cannot raise UnicodeError.)
 
1637
    try:
 
1638
        gecos = w.pw_gecos.decode('utf-8')
 
1639
        encoding = 'utf-8'
 
1640
    except UnicodeError:
 
1641
        try:
 
1642
            encoding = osutils.get_user_encoding()
 
1643
            gecos = w.pw_gecos.decode(encoding)
 
1644
        except UnicodeError, e:
 
1645
            trace.mutter("cannot decode passwd entry %s" % w)
 
1646
            return None, None
 
1647
    try:
 
1648
        username = w.pw_name.decode(encoding)
 
1649
    except UnicodeError, e:
 
1650
        trace.mutter("cannot decode passwd entry %s" % w)
 
1651
        return None, None
 
1652
 
 
1653
    comma = gecos.find(',')
 
1654
    if comma == -1:
 
1655
        realname = gecos
 
1656
    else:
 
1657
        realname = gecos[:comma]
 
1658
 
 
1659
    return realname, (username + '@' + default_mail_domain)
 
1660
 
 
1661
 
 
1662
def parse_username(username):
 
1663
    """Parse e-mail username and return a (name, address) tuple."""
 
1664
    match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
 
1665
    if match is None:
 
1666
        return (username, '')
 
1667
    else:
 
1668
        return (match.group(1), match.group(2))
812
1669
 
813
1670
 
814
1671
def extract_email_address(e):
815
1672
    """Return just the address part of an email string.
816
 
    
817
 
    That is just the user@domain part, nothing else. 
 
1673
 
 
1674
    That is just the user@domain part, nothing else.
818
1675
    This part is required to contain only ascii characters.
819
1676
    If it can't be extracted, raises an error.
820
 
    
 
1677
 
821
1678
    >>> extract_email_address('Jane Tester <jane@test.com>')
822
1679
    "jane@test.com"
823
1680
    """
824
 
    m = re.search(r'[\w+.-]+@[\w+.-]+', e)
825
 
    if not m:
 
1681
    name, email = parse_username(e)
 
1682
    if not email:
826
1683
        raise errors.NoEmailInUsername(e)
827
 
    return m.group(0)
 
1684
    return email
828
1685
 
829
1686
 
830
1687
class TreeConfig(IniBasedConfig):
831
1688
    """Branch configuration data associated with its contents, not location"""
 
1689
 
 
1690
    # XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
 
1691
 
832
1692
    def __init__(self, branch):
 
1693
        self._config = branch._get_config()
833
1694
        self.branch = branch
834
1695
 
835
1696
    def _get_parser(self, file=None):
836
1697
        if file is not None:
837
1698
            return IniBasedConfig._get_parser(file)
838
 
        return self._get_config()
839
 
 
840
 
    def _get_config(self):
841
 
        try:
842
 
            obj = ConfigObj(self.branch.control_files.get('branch.conf'), 
843
 
                            encoding='utf-8')
844
 
        except errors.NoSuchFile:
845
 
            obj = ConfigObj(encoding='utf=8')
846
 
        return obj
 
1699
        return self._config._get_configobj()
847
1700
 
848
1701
    def get_option(self, name, section=None, default=None):
849
1702
        self.branch.lock_read()
850
1703
        try:
851
 
            obj = self._get_config()
852
 
            try:
853
 
                if section is not None:
854
 
                    obj[section]
855
 
                result = obj[name]
856
 
            except KeyError:
857
 
                result = default
 
1704
            return self._config.get_option(name, section, default)
858
1705
        finally:
859
1706
            self.branch.unlock()
860
 
        return result
861
1707
 
862
1708
    def set_option(self, value, name, section=None):
863
1709
        """Set a per-branch configuration option"""
864
 
        self.branch.lock_write()
865
 
        try:
866
 
            cfg_obj = self._get_config()
867
 
            if section is None:
868
 
                obj = cfg_obj
869
 
            else:
870
 
                try:
871
 
                    obj = cfg_obj[section]
872
 
                except KeyError:
873
 
                    cfg_obj[section] = {}
874
 
                    obj = cfg_obj[section]
875
 
            obj[name] = value
876
 
            out_file = StringIO()
877
 
            cfg_obj.write(out_file)
878
 
            out_file.seek(0)
879
 
            self.branch.control_files.put('branch.conf', out_file)
880
 
        finally:
881
 
            self.branch.unlock()
 
1710
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1711
        # higher levels providing the right lock -- vila 20101004
 
1712
        self.branch.lock_write()
 
1713
        try:
 
1714
            self._config.set_option(value, name, section)
 
1715
        finally:
 
1716
            self.branch.unlock()
 
1717
 
 
1718
    def remove_option(self, option_name, section_name=None):
 
1719
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1720
        # higher levels providing the right lock -- vila 20101004
 
1721
        self.branch.lock_write()
 
1722
        try:
 
1723
            self._config.remove_option(option_name, section_name)
 
1724
        finally:
 
1725
            self.branch.unlock()
 
1726
 
 
1727
 
 
1728
class AuthenticationConfig(object):
 
1729
    """The authentication configuration file based on a ini file.
 
1730
 
 
1731
    Implements the authentication.conf file described in
 
1732
    doc/developers/authentication-ring.txt.
 
1733
    """
 
1734
 
 
1735
    def __init__(self, _file=None):
 
1736
        self._config = None # The ConfigObj
 
1737
        if _file is None:
 
1738
            self._filename = authentication_config_filename()
 
1739
            self._input = self._filename = authentication_config_filename()
 
1740
        else:
 
1741
            # Tests can provide a string as _file
 
1742
            self._filename = None
 
1743
            self._input = _file
 
1744
 
 
1745
    def _get_config(self):
 
1746
        if self._config is not None:
 
1747
            return self._config
 
1748
        try:
 
1749
            # FIXME: Should we validate something here ? Includes: empty
 
1750
            # sections are useless, at least one of
 
1751
            # user/password/password_encoding should be defined, etc.
 
1752
 
 
1753
            # Note: the encoding below declares that the file itself is utf-8
 
1754
            # encoded, but the values in the ConfigObj are always Unicode.
 
1755
            self._config = ConfigObj(self._input, encoding='utf-8')
 
1756
        except configobj.ConfigObjError, e:
 
1757
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
1758
        except UnicodeError:
 
1759
            raise errors.ConfigContentError(self._filename)
 
1760
        return self._config
 
1761
 
 
1762
    def _save(self):
 
1763
        """Save the config file, only tests should use it for now."""
 
1764
        conf_dir = os.path.dirname(self._filename)
 
1765
        ensure_config_dir_exists(conf_dir)
 
1766
        f = file(self._filename, 'wb')
 
1767
        try:
 
1768
            self._get_config().write(f)
 
1769
        finally:
 
1770
            f.close()
 
1771
 
 
1772
    def _set_option(self, section_name, option_name, value):
 
1773
        """Set an authentication configuration option"""
 
1774
        conf = self._get_config()
 
1775
        section = conf.get(section_name)
 
1776
        if section is None:
 
1777
            conf[section] = {}
 
1778
            section = conf[section]
 
1779
        section[option_name] = value
 
1780
        self._save()
 
1781
 
 
1782
    def get_credentials(self, scheme, host, port=None, user=None, path=None,
 
1783
                        realm=None):
 
1784
        """Returns the matching credentials from authentication.conf file.
 
1785
 
 
1786
        :param scheme: protocol
 
1787
 
 
1788
        :param host: the server address
 
1789
 
 
1790
        :param port: the associated port (optional)
 
1791
 
 
1792
        :param user: login (optional)
 
1793
 
 
1794
        :param path: the absolute path on the server (optional)
 
1795
 
 
1796
        :param realm: the http authentication realm (optional)
 
1797
 
 
1798
        :return: A dict containing the matching credentials or None.
 
1799
           This includes:
 
1800
           - name: the section name of the credentials in the
 
1801
             authentication.conf file,
 
1802
           - user: can't be different from the provided user if any,
 
1803
           - scheme: the server protocol,
 
1804
           - host: the server address,
 
1805
           - port: the server port (can be None),
 
1806
           - path: the absolute server path (can be None),
 
1807
           - realm: the http specific authentication realm (can be None),
 
1808
           - password: the decoded password, could be None if the credential
 
1809
             defines only the user
 
1810
           - verify_certificates: https specific, True if the server
 
1811
             certificate should be verified, False otherwise.
 
1812
        """
 
1813
        credentials = None
 
1814
        for auth_def_name, auth_def in self._get_config().items():
 
1815
            if type(auth_def) is not configobj.Section:
 
1816
                raise ValueError("%s defined outside a section" % auth_def_name)
 
1817
 
 
1818
            a_scheme, a_host, a_user, a_path = map(
 
1819
                auth_def.get, ['scheme', 'host', 'user', 'path'])
 
1820
 
 
1821
            try:
 
1822
                a_port = auth_def.as_int('port')
 
1823
            except KeyError:
 
1824
                a_port = None
 
1825
            except ValueError:
 
1826
                raise ValueError("'port' not numeric in %s" % auth_def_name)
 
1827
            try:
 
1828
                a_verify_certificates = auth_def.as_bool('verify_certificates')
 
1829
            except KeyError:
 
1830
                a_verify_certificates = True
 
1831
            except ValueError:
 
1832
                raise ValueError(
 
1833
                    "'verify_certificates' not boolean in %s" % auth_def_name)
 
1834
 
 
1835
            # Attempt matching
 
1836
            if a_scheme is not None and scheme != a_scheme:
 
1837
                continue
 
1838
            if a_host is not None:
 
1839
                if not (host == a_host
 
1840
                        or (a_host.startswith('.') and host.endswith(a_host))):
 
1841
                    continue
 
1842
            if a_port is not None and port != a_port:
 
1843
                continue
 
1844
            if (a_path is not None and path is not None
 
1845
                and not path.startswith(a_path)):
 
1846
                continue
 
1847
            if (a_user is not None and user is not None
 
1848
                and a_user != user):
 
1849
                # Never contradict the caller about the user to be used
 
1850
                continue
 
1851
            if a_user is None:
 
1852
                # Can't find a user
 
1853
                continue
 
1854
            # Prepare a credentials dictionary with additional keys
 
1855
            # for the credential providers
 
1856
            credentials = dict(name=auth_def_name,
 
1857
                               user=a_user,
 
1858
                               scheme=a_scheme,
 
1859
                               host=host,
 
1860
                               port=port,
 
1861
                               path=path,
 
1862
                               realm=realm,
 
1863
                               password=auth_def.get('password', None),
 
1864
                               verify_certificates=a_verify_certificates)
 
1865
            # Decode the password in the credentials (or get one)
 
1866
            self.decode_password(credentials,
 
1867
                                 auth_def.get('password_encoding', None))
 
1868
            if 'auth' in debug.debug_flags:
 
1869
                trace.mutter("Using authentication section: %r", auth_def_name)
 
1870
            break
 
1871
 
 
1872
        if credentials is None:
 
1873
            # No credentials were found in authentication.conf, try the fallback
 
1874
            # credentials stores.
 
1875
            credentials = credential_store_registry.get_fallback_credentials(
 
1876
                scheme, host, port, user, path, realm)
 
1877
 
 
1878
        return credentials
 
1879
 
 
1880
    def set_credentials(self, name, host, user, scheme=None, password=None,
 
1881
                        port=None, path=None, verify_certificates=None,
 
1882
                        realm=None):
 
1883
        """Set authentication credentials for a host.
 
1884
 
 
1885
        Any existing credentials with matching scheme, host, port and path
 
1886
        will be deleted, regardless of name.
 
1887
 
 
1888
        :param name: An arbitrary name to describe this set of credentials.
 
1889
        :param host: Name of the host that accepts these credentials.
 
1890
        :param user: The username portion of these credentials.
 
1891
        :param scheme: The URL scheme (e.g. ssh, http) the credentials apply
 
1892
            to.
 
1893
        :param password: Password portion of these credentials.
 
1894
        :param port: The IP port on the host that these credentials apply to.
 
1895
        :param path: A filesystem path on the host that these credentials
 
1896
            apply to.
 
1897
        :param verify_certificates: On https, verify server certificates if
 
1898
            True.
 
1899
        :param realm: The http authentication realm (optional).
 
1900
        """
 
1901
        values = {'host': host, 'user': user}
 
1902
        if password is not None:
 
1903
            values['password'] = password
 
1904
        if scheme is not None:
 
1905
            values['scheme'] = scheme
 
1906
        if port is not None:
 
1907
            values['port'] = '%d' % port
 
1908
        if path is not None:
 
1909
            values['path'] = path
 
1910
        if verify_certificates is not None:
 
1911
            values['verify_certificates'] = str(verify_certificates)
 
1912
        if realm is not None:
 
1913
            values['realm'] = realm
 
1914
        config = self._get_config()
 
1915
        for_deletion = []
 
1916
        for section, existing_values in config.items():
 
1917
            for key in ('scheme', 'host', 'port', 'path', 'realm'):
 
1918
                if existing_values.get(key) != values.get(key):
 
1919
                    break
 
1920
            else:
 
1921
                del config[section]
 
1922
        config.update({name: values})
 
1923
        self._save()
 
1924
 
 
1925
    def get_user(self, scheme, host, port=None, realm=None, path=None,
 
1926
                 prompt=None, ask=False, default=None):
 
1927
        """Get a user from authentication file.
 
1928
 
 
1929
        :param scheme: protocol
 
1930
 
 
1931
        :param host: the server address
 
1932
 
 
1933
        :param port: the associated port (optional)
 
1934
 
 
1935
        :param realm: the realm sent by the server (optional)
 
1936
 
 
1937
        :param path: the absolute path on the server (optional)
 
1938
 
 
1939
        :param ask: Ask the user if there is no explicitly configured username 
 
1940
                    (optional)
 
1941
 
 
1942
        :param default: The username returned if none is defined (optional).
 
1943
 
 
1944
        :return: The found user.
 
1945
        """
 
1946
        credentials = self.get_credentials(scheme, host, port, user=None,
 
1947
                                           path=path, realm=realm)
 
1948
        if credentials is not None:
 
1949
            user = credentials['user']
 
1950
        else:
 
1951
            user = None
 
1952
        if user is None:
 
1953
            if ask:
 
1954
                if prompt is None:
 
1955
                    # Create a default prompt suitable for most cases
 
1956
                    prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
 
1957
                # Special handling for optional fields in the prompt
 
1958
                if port is not None:
 
1959
                    prompt_host = '%s:%d' % (host, port)
 
1960
                else:
 
1961
                    prompt_host = host
 
1962
                user = ui.ui_factory.get_username(prompt, host=prompt_host)
 
1963
            else:
 
1964
                user = default
 
1965
        return user
 
1966
 
 
1967
    def get_password(self, scheme, host, user, port=None,
 
1968
                     realm=None, path=None, prompt=None):
 
1969
        """Get a password from authentication file or prompt the user for one.
 
1970
 
 
1971
        :param scheme: protocol
 
1972
 
 
1973
        :param host: the server address
 
1974
 
 
1975
        :param port: the associated port (optional)
 
1976
 
 
1977
        :param user: login
 
1978
 
 
1979
        :param realm: the realm sent by the server (optional)
 
1980
 
 
1981
        :param path: the absolute path on the server (optional)
 
1982
 
 
1983
        :return: The found password or the one entered by the user.
 
1984
        """
 
1985
        credentials = self.get_credentials(scheme, host, port, user, path,
 
1986
                                           realm)
 
1987
        if credentials is not None:
 
1988
            password = credentials['password']
 
1989
            if password is not None and scheme is 'ssh':
 
1990
                trace.warning('password ignored in section [%s],'
 
1991
                              ' use an ssh agent instead'
 
1992
                              % credentials['name'])
 
1993
                password = None
 
1994
        else:
 
1995
            password = None
 
1996
        # Prompt user only if we could't find a password
 
1997
        if password is None:
 
1998
            if prompt is None:
 
1999
                # Create a default prompt suitable for most cases
 
2000
                prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
 
2001
            # Special handling for optional fields in the prompt
 
2002
            if port is not None:
 
2003
                prompt_host = '%s:%d' % (host, port)
 
2004
            else:
 
2005
                prompt_host = host
 
2006
            password = ui.ui_factory.get_password(prompt,
 
2007
                                                  host=prompt_host, user=user)
 
2008
        return password
 
2009
 
 
2010
    def decode_password(self, credentials, encoding):
 
2011
        try:
 
2012
            cs = credential_store_registry.get_credential_store(encoding)
 
2013
        except KeyError:
 
2014
            raise ValueError('%r is not a known password_encoding' % encoding)
 
2015
        credentials['password'] = cs.decode_password(credentials)
 
2016
        return credentials
 
2017
 
 
2018
 
 
2019
class CredentialStoreRegistry(registry.Registry):
 
2020
    """A class that registers credential stores.
 
2021
 
 
2022
    A credential store provides access to credentials via the password_encoding
 
2023
    field in authentication.conf sections.
 
2024
 
 
2025
    Except for stores provided by bzr itself, most stores are expected to be
 
2026
    provided by plugins that will therefore use
 
2027
    register_lazy(password_encoding, module_name, member_name, help=help,
 
2028
    fallback=fallback) to install themselves.
 
2029
 
 
2030
    A fallback credential store is one that is queried if no credentials can be
 
2031
    found via authentication.conf.
 
2032
    """
 
2033
 
 
2034
    def get_credential_store(self, encoding=None):
 
2035
        cs = self.get(encoding)
 
2036
        if callable(cs):
 
2037
            cs = cs()
 
2038
        return cs
 
2039
 
 
2040
    def is_fallback(self, name):
 
2041
        """Check if the named credentials store should be used as fallback."""
 
2042
        return self.get_info(name)
 
2043
 
 
2044
    def get_fallback_credentials(self, scheme, host, port=None, user=None,
 
2045
                                 path=None, realm=None):
 
2046
        """Request credentials from all fallback credentials stores.
 
2047
 
 
2048
        The first credentials store that can provide credentials wins.
 
2049
        """
 
2050
        credentials = None
 
2051
        for name in self.keys():
 
2052
            if not self.is_fallback(name):
 
2053
                continue
 
2054
            cs = self.get_credential_store(name)
 
2055
            credentials = cs.get_credentials(scheme, host, port, user,
 
2056
                                             path, realm)
 
2057
            if credentials is not None:
 
2058
                # We found some credentials
 
2059
                break
 
2060
        return credentials
 
2061
 
 
2062
    def register(self, key, obj, help=None, override_existing=False,
 
2063
                 fallback=False):
 
2064
        """Register a new object to a name.
 
2065
 
 
2066
        :param key: This is the key to use to request the object later.
 
2067
        :param obj: The object to register.
 
2068
        :param help: Help text for this entry. This may be a string or
 
2069
                a callable. If it is a callable, it should take two
 
2070
                parameters (registry, key): this registry and the key that
 
2071
                the help was registered under.
 
2072
        :param override_existing: Raise KeyErorr if False and something has
 
2073
                already been registered for that key. If True, ignore if there
 
2074
                is an existing key (always register the new value).
 
2075
        :param fallback: Whether this credential store should be 
 
2076
                used as fallback.
 
2077
        """
 
2078
        return super(CredentialStoreRegistry,
 
2079
                     self).register(key, obj, help, info=fallback,
 
2080
                                    override_existing=override_existing)
 
2081
 
 
2082
    def register_lazy(self, key, module_name, member_name,
 
2083
                      help=None, override_existing=False,
 
2084
                      fallback=False):
 
2085
        """Register a new credential store to be loaded on request.
 
2086
 
 
2087
        :param module_name: The python path to the module. Such as 'os.path'.
 
2088
        :param member_name: The member of the module to return.  If empty or
 
2089
                None, get() will return the module itself.
 
2090
        :param help: Help text for this entry. This may be a string or
 
2091
                a callable.
 
2092
        :param override_existing: If True, replace the existing object
 
2093
                with the new one. If False, if there is already something
 
2094
                registered with the same key, raise a KeyError
 
2095
        :param fallback: Whether this credential store should be 
 
2096
                used as fallback.
 
2097
        """
 
2098
        return super(CredentialStoreRegistry, self).register_lazy(
 
2099
            key, module_name, member_name, help,
 
2100
            info=fallback, override_existing=override_existing)
 
2101
 
 
2102
 
 
2103
credential_store_registry = CredentialStoreRegistry()
 
2104
 
 
2105
 
 
2106
class CredentialStore(object):
 
2107
    """An abstract class to implement storage for credentials"""
 
2108
 
 
2109
    def decode_password(self, credentials):
 
2110
        """Returns a clear text password for the provided credentials."""
 
2111
        raise NotImplementedError(self.decode_password)
 
2112
 
 
2113
    def get_credentials(self, scheme, host, port=None, user=None, path=None,
 
2114
                        realm=None):
 
2115
        """Return the matching credentials from this credential store.
 
2116
 
 
2117
        This method is only called on fallback credential stores.
 
2118
        """
 
2119
        raise NotImplementedError(self.get_credentials)
 
2120
 
 
2121
 
 
2122
 
 
2123
class PlainTextCredentialStore(CredentialStore):
 
2124
    __doc__ = """Plain text credential store for the authentication.conf file"""
 
2125
 
 
2126
    def decode_password(self, credentials):
 
2127
        """See CredentialStore.decode_password."""
 
2128
        return credentials['password']
 
2129
 
 
2130
 
 
2131
credential_store_registry.register('plain', PlainTextCredentialStore,
 
2132
                                   help=PlainTextCredentialStore.__doc__)
 
2133
credential_store_registry.default_key = 'plain'
 
2134
 
 
2135
 
 
2136
class Base64CredentialStore(CredentialStore):
 
2137
    __doc__ = """Base64 credential store for the authentication.conf file"""
 
2138
 
 
2139
    def decode_password(self, credentials):
 
2140
        """See CredentialStore.decode_password."""
 
2141
        # GZ 2012-07-28: Will raise binascii.Error if password is not base64,
 
2142
        #                should probably propogate as something more useful.
 
2143
        return base64.decodestring(credentials['password'])
 
2144
 
 
2145
credential_store_registry.register('base64', Base64CredentialStore,
 
2146
                                   help=Base64CredentialStore.__doc__)
 
2147
 
 
2148
 
 
2149
class BzrDirConfig(object):
 
2150
 
 
2151
    def __init__(self, bzrdir):
 
2152
        self._bzrdir = bzrdir
 
2153
        self._config = bzrdir._get_config()
 
2154
 
 
2155
    def set_default_stack_on(self, value):
 
2156
        """Set the default stacking location.
 
2157
 
 
2158
        It may be set to a location, or None.
 
2159
 
 
2160
        This policy affects all branches contained by this control dir, except
 
2161
        for those under repositories.
 
2162
        """
 
2163
        if self._config is None:
 
2164
            raise errors.BzrError("Cannot set configuration in %s"
 
2165
                                  % self._bzrdir)
 
2166
        if value is None:
 
2167
            self._config.set_option('', 'default_stack_on')
 
2168
        else:
 
2169
            self._config.set_option(value, 'default_stack_on')
 
2170
 
 
2171
    def get_default_stack_on(self):
 
2172
        """Return the default stacking location.
 
2173
 
 
2174
        This will either be a location, or None.
 
2175
 
 
2176
        This policy affects all branches contained by this control dir, except
 
2177
        for those under repositories.
 
2178
        """
 
2179
        if self._config is None:
 
2180
            return None
 
2181
        value = self._config.get_option('default_stack_on')
 
2182
        if value == '':
 
2183
            value = None
 
2184
        return value
 
2185
 
 
2186
 
 
2187
class TransportConfig(object):
 
2188
    """A Config that reads/writes a config file on a Transport.
 
2189
 
 
2190
    It is a low-level object that considers config data to be name/value pairs
 
2191
    that may be associated with a section.  Assigning meaning to these values
 
2192
    is done at higher levels like TreeConfig.
 
2193
    """
 
2194
 
 
2195
    def __init__(self, transport, filename):
 
2196
        self._transport = transport
 
2197
        self._filename = filename
 
2198
 
 
2199
    def get_option(self, name, section=None, default=None):
 
2200
        """Return the value associated with a named option.
 
2201
 
 
2202
        :param name: The name of the value
 
2203
        :param section: The section the option is in (if any)
 
2204
        :param default: The value to return if the value is not set
 
2205
        :return: The value or default value
 
2206
        """
 
2207
        configobj = self._get_configobj()
 
2208
        if section is None:
 
2209
            section_obj = configobj
 
2210
        else:
 
2211
            try:
 
2212
                section_obj = configobj[section]
 
2213
            except KeyError:
 
2214
                return default
 
2215
        value = section_obj.get(name, default)
 
2216
        for hook in OldConfigHooks['get']:
 
2217
            hook(self, name, value)
 
2218
        return value
 
2219
 
 
2220
    def set_option(self, value, name, section=None):
 
2221
        """Set the value associated with a named option.
 
2222
 
 
2223
        :param value: The value to set
 
2224
        :param name: The name of the value to set
 
2225
        :param section: The section the option is in (if any)
 
2226
        """
 
2227
        configobj = self._get_configobj()
 
2228
        if section is None:
 
2229
            configobj[name] = value
 
2230
        else:
 
2231
            configobj.setdefault(section, {})[name] = value
 
2232
        for hook in OldConfigHooks['set']:
 
2233
            hook(self, name, value)
 
2234
        self._set_configobj(configobj)
 
2235
 
 
2236
    def remove_option(self, option_name, section_name=None):
 
2237
        configobj = self._get_configobj()
 
2238
        if section_name is None:
 
2239
            del configobj[option_name]
 
2240
        else:
 
2241
            del configobj[section_name][option_name]
 
2242
        for hook in OldConfigHooks['remove']:
 
2243
            hook(self, option_name)
 
2244
        self._set_configobj(configobj)
 
2245
 
 
2246
    def _get_config_file(self):
 
2247
        try:
 
2248
            f = StringIO(self._transport.get_bytes(self._filename))
 
2249
            for hook in OldConfigHooks['load']:
 
2250
                hook(self)
 
2251
            return f
 
2252
        except errors.NoSuchFile:
 
2253
            return StringIO()
 
2254
        except errors.PermissionDenied, e:
 
2255
            trace.warning("Permission denied while trying to open "
 
2256
                "configuration file %s.", urlutils.unescape_for_display(
 
2257
                urlutils.join(self._transport.base, self._filename), "utf-8"))
 
2258
            return StringIO()
 
2259
 
 
2260
    def _external_url(self):
 
2261
        return urlutils.join(self._transport.external_url(), self._filename)
 
2262
 
 
2263
    def _get_configobj(self):
 
2264
        f = self._get_config_file()
 
2265
        try:
 
2266
            try:
 
2267
                conf = ConfigObj(f, encoding='utf-8')
 
2268
            except configobj.ConfigObjError, e:
 
2269
                raise errors.ParseConfigError(e.errors, self._external_url())
 
2270
            except UnicodeDecodeError:
 
2271
                raise errors.ConfigContentError(self._external_url())
 
2272
        finally:
 
2273
            f.close()
 
2274
        return conf
 
2275
 
 
2276
    def _set_configobj(self, configobj):
 
2277
        out_file = StringIO()
 
2278
        configobj.write(out_file)
 
2279
        out_file.seek(0)
 
2280
        self._transport.put_file(self._filename, out_file)
 
2281
        for hook in OldConfigHooks['save']:
 
2282
            hook(self)
 
2283
 
 
2284
 
 
2285
class Option(object):
 
2286
    """An option definition.
 
2287
 
 
2288
    The option *values* are stored in config files and found in sections.
 
2289
 
 
2290
    Here we define various properties about the option itself, its default
 
2291
    value, how to convert it from stores, what to do when invalid values are
 
2292
    encoutered, in which config files it can be stored.
 
2293
    """
 
2294
 
 
2295
    def __init__(self, name, override_from_env=None,
 
2296
                 default=None, default_from_env=None,
 
2297
                 help=None, from_unicode=None, invalid=None, unquote=True):
 
2298
        """Build an option definition.
 
2299
 
 
2300
        :param name: the name used to refer to the option.
 
2301
 
 
2302
        :param override_from_env: A list of environment variables which can
 
2303
           provide override any configuration setting.
 
2304
 
 
2305
        :param default: the default value to use when none exist in the config
 
2306
            stores. This is either a string that ``from_unicode`` will convert
 
2307
            into the proper type, a callable returning a unicode string so that
 
2308
            ``from_unicode`` can be used on the return value, or a python
 
2309
            object that can be stringified (so only the empty list is supported
 
2310
            for example).
 
2311
 
 
2312
        :param default_from_env: A list of environment variables which can
 
2313
           provide a default value. 'default' will be used only if none of the
 
2314
           variables specified here are set in the environment.
 
2315
 
 
2316
        :param help: a doc string to explain the option to the user.
 
2317
 
 
2318
        :param from_unicode: a callable to convert the unicode string
 
2319
            representing the option value in a store or its default value.
 
2320
 
 
2321
        :param invalid: the action to be taken when an invalid value is
 
2322
            encountered in a store. This is called only when from_unicode is
 
2323
            invoked to convert a string and returns None or raise ValueError or
 
2324
            TypeError. Accepted values are: None (ignore invalid values),
 
2325
            'warning' (emit a warning), 'error' (emit an error message and
 
2326
            terminates).
 
2327
 
 
2328
        :param unquote: should the unicode value be unquoted before conversion.
 
2329
           This should be used only when the store providing the values cannot
 
2330
           safely unquote them (see http://pad.lv/906897). It is provided so
 
2331
           daughter classes can handle the quoting themselves.
 
2332
        """
 
2333
        if override_from_env is None:
 
2334
            override_from_env = []
 
2335
        if default_from_env is None:
 
2336
            default_from_env = []
 
2337
        self.name = name
 
2338
        self.override_from_env = override_from_env
 
2339
        # Convert the default value to a unicode string so all values are
 
2340
        # strings internally before conversion (via from_unicode) is attempted.
 
2341
        if default is None:
 
2342
            self.default = None
 
2343
        elif isinstance(default, list):
 
2344
            # Only the empty list is supported
 
2345
            if default:
 
2346
                raise AssertionError(
 
2347
                    'Only empty lists are supported as default values')
 
2348
            self.default = u','
 
2349
        elif isinstance(default, (str, unicode, bool, int, float)):
 
2350
            # Rely on python to convert strings, booleans and integers
 
2351
            self.default = u'%s' % (default,)
 
2352
        elif callable(default):
 
2353
            self.default = default
 
2354
        else:
 
2355
            # other python objects are not expected
 
2356
            raise AssertionError('%r is not supported as a default value'
 
2357
                                 % (default,))
 
2358
        self.default_from_env = default_from_env
 
2359
        self._help = help
 
2360
        self.from_unicode = from_unicode
 
2361
        self.unquote = unquote
 
2362
        if invalid and invalid not in ('warning', 'error'):
 
2363
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
 
2364
        self.invalid = invalid
 
2365
 
 
2366
    @property
 
2367
    def help(self):
 
2368
        return self._help
 
2369
 
 
2370
    def convert_from_unicode(self, store, unicode_value):
 
2371
        if self.unquote and store is not None and unicode_value is not None:
 
2372
            unicode_value = store.unquote(unicode_value)
 
2373
        if self.from_unicode is None or unicode_value is None:
 
2374
            # Don't convert or nothing to convert
 
2375
            return unicode_value
 
2376
        try:
 
2377
            converted = self.from_unicode(unicode_value)
 
2378
        except (ValueError, TypeError):
 
2379
            # Invalid values are ignored
 
2380
            converted = None
 
2381
        if converted is None and self.invalid is not None:
 
2382
            # The conversion failed
 
2383
            if self.invalid == 'warning':
 
2384
                trace.warning('Value "%s" is not valid for "%s"',
 
2385
                              unicode_value, self.name)
 
2386
            elif self.invalid == 'error':
 
2387
                raise errors.ConfigOptionValueError(self.name, unicode_value)
 
2388
        return converted
 
2389
 
 
2390
    def get_override(self):
 
2391
        value = None
 
2392
        for var in self.override_from_env:
 
2393
            try:
 
2394
                # If the env variable is defined, its value takes precedence
 
2395
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2396
                break
 
2397
            except KeyError:
 
2398
                continue
 
2399
        return value
 
2400
 
 
2401
    def get_default(self):
 
2402
        value = None
 
2403
        for var in self.default_from_env:
 
2404
            try:
 
2405
                # If the env variable is defined, its value is the default one
 
2406
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2407
                break
 
2408
            except KeyError:
 
2409
                continue
 
2410
        if value is None:
 
2411
            # Otherwise, fallback to the value defined at registration
 
2412
            if callable(self.default):
 
2413
                value = self.default()
 
2414
                if not isinstance(value, unicode):
 
2415
                    raise AssertionError(
 
2416
                        "Callable default value for '%s' should be unicode"
 
2417
                        % (self.name))
 
2418
            else:
 
2419
                value = self.default
 
2420
        return value
 
2421
 
 
2422
    def get_help_topic(self):
 
2423
        return self.name
 
2424
 
 
2425
    def get_help_text(self, additional_see_also=None, plain=True):
 
2426
        result = self.help
 
2427
        from bzrlib import help_topics
 
2428
        result += help_topics._format_see_also(additional_see_also)
 
2429
        if plain:
 
2430
            result = help_topics.help_as_plain_text(result)
 
2431
        return result
 
2432
 
 
2433
 
 
2434
# Predefined converters to get proper values from store
 
2435
 
 
2436
def bool_from_store(unicode_str):
 
2437
    return ui.bool_from_string(unicode_str)
 
2438
 
 
2439
 
 
2440
def int_from_store(unicode_str):
 
2441
    return int(unicode_str)
 
2442
 
 
2443
 
 
2444
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
 
2445
 
 
2446
def int_SI_from_store(unicode_str):
 
2447
    """Convert a human readable size in SI units, e.g 10MB into an integer.
 
2448
 
 
2449
    Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
2450
    by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
2451
    pedantic.
 
2452
 
 
2453
    :return Integer, expanded to its base-10 value if a proper SI unit is 
 
2454
        found, None otherwise.
 
2455
    """
 
2456
    regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
 
2457
    p = re.compile(regexp, re.IGNORECASE)
 
2458
    m = p.match(unicode_str)
 
2459
    val = None
 
2460
    if m is not None:
 
2461
        val, _, unit = m.groups()
 
2462
        val = int(val)
 
2463
        if unit:
 
2464
            try:
 
2465
                coeff = _unit_suffixes[unit.upper()]
 
2466
            except KeyError:
 
2467
                raise ValueError(gettext('{0} is not an SI unit.').format(unit))
 
2468
            val *= coeff
 
2469
    return val
 
2470
 
 
2471
 
 
2472
def float_from_store(unicode_str):
 
2473
    return float(unicode_str)
 
2474
 
 
2475
 
 
2476
# Use an empty dict to initialize an empty configobj avoiding all parsing and
 
2477
# encoding checks
 
2478
_list_converter_config = configobj.ConfigObj(
 
2479
    {}, encoding='utf-8', list_values=True, interpolation=False)
 
2480
 
 
2481
 
 
2482
class ListOption(Option):
 
2483
 
 
2484
    def __init__(self, name, default=None, default_from_env=None,
 
2485
                 help=None, invalid=None):
 
2486
        """A list Option definition.
 
2487
 
 
2488
        This overrides the base class so the conversion from a unicode string
 
2489
        can take quoting into account.
 
2490
        """
 
2491
        super(ListOption, self).__init__(
 
2492
            name, default=default, default_from_env=default_from_env,
 
2493
            from_unicode=self.from_unicode, help=help,
 
2494
            invalid=invalid, unquote=False)
 
2495
 
 
2496
    def from_unicode(self, unicode_str):
 
2497
        if not isinstance(unicode_str, basestring):
 
2498
            raise TypeError
 
2499
        # Now inject our string directly as unicode. All callers got their
 
2500
        # value from configobj, so values that need to be quoted are already
 
2501
        # properly quoted.
 
2502
        _list_converter_config.reset()
 
2503
        _list_converter_config._parse([u"list=%s" % (unicode_str,)])
 
2504
        maybe_list = _list_converter_config['list']
 
2505
        if isinstance(maybe_list, basestring):
 
2506
            if maybe_list:
 
2507
                # A single value, most probably the user forgot (or didn't care
 
2508
                # to add) the final ','
 
2509
                l = [maybe_list]
 
2510
            else:
 
2511
                # The empty string, convert to empty list
 
2512
                l = []
 
2513
        else:
 
2514
            # We rely on ConfigObj providing us with a list already
 
2515
            l = maybe_list
 
2516
        return l
 
2517
 
 
2518
 
 
2519
class RegistryOption(Option):
 
2520
    """Option for a choice from a registry."""
 
2521
 
 
2522
    def __init__(self, name, registry, default_from_env=None,
 
2523
                 help=None, invalid=None):
 
2524
        """A registry based Option definition.
 
2525
 
 
2526
        This overrides the base class so the conversion from a unicode string
 
2527
        can take quoting into account.
 
2528
        """
 
2529
        super(RegistryOption, self).__init__(
 
2530
            name, default=lambda: unicode(registry.default_key),
 
2531
            default_from_env=default_from_env,
 
2532
            from_unicode=self.from_unicode, help=help,
 
2533
            invalid=invalid, unquote=False)
 
2534
        self.registry = registry
 
2535
 
 
2536
    def from_unicode(self, unicode_str):
 
2537
        if not isinstance(unicode_str, basestring):
 
2538
            raise TypeError
 
2539
        try:
 
2540
            return self.registry.get(unicode_str)
 
2541
        except KeyError:
 
2542
            raise ValueError(
 
2543
                "Invalid value %s for %s."
 
2544
                "See help for a list of possible values." % (unicode_str,
 
2545
                    self.name))
 
2546
 
 
2547
    @property
 
2548
    def help(self):
 
2549
        ret = [self._help, "\n\nThe following values are supported:\n"]
 
2550
        for key in self.registry.keys():
 
2551
            ret.append(" %s - %s\n" % (key, self.registry.get_help(key)))
 
2552
        return "".join(ret)
 
2553
 
 
2554
 
 
2555
_option_ref_re = lazy_regex.lazy_compile('({[^\d\W](?:\.\w|\w)*})')
 
2556
"""Describes an expandable option reference.
 
2557
 
 
2558
We want to match the most embedded reference first.
 
2559
 
 
2560
I.e. for '{{foo}}' we will get '{foo}',
 
2561
for '{bar{baz}}' we will get '{baz}'
 
2562
"""
 
2563
 
 
2564
def iter_option_refs(string):
 
2565
    # Split isolate refs so every other chunk is a ref
 
2566
    is_ref = False
 
2567
    for chunk  in _option_ref_re.split(string):
 
2568
        yield is_ref, chunk
 
2569
        is_ref = not is_ref
 
2570
 
 
2571
 
 
2572
class OptionRegistry(registry.Registry):
 
2573
    """Register config options by their name.
 
2574
 
 
2575
    This overrides ``registry.Registry`` to simplify registration by acquiring
 
2576
    some information from the option object itself.
 
2577
    """
 
2578
 
 
2579
    def _check_option_name(self, option_name):
 
2580
        """Ensures an option name is valid.
 
2581
 
 
2582
        :param option_name: The name to validate.
 
2583
        """
 
2584
        if _option_ref_re.match('{%s}' % option_name) is None:
 
2585
            raise errors.IllegalOptionName(option_name)
 
2586
 
 
2587
    def register(self, option):
 
2588
        """Register a new option to its name.
 
2589
 
 
2590
        :param option: The option to register. Its name is used as the key.
 
2591
        """
 
2592
        self._check_option_name(option.name)
 
2593
        super(OptionRegistry, self).register(option.name, option,
 
2594
                                             help=option.help)
 
2595
 
 
2596
    def register_lazy(self, key, module_name, member_name):
 
2597
        """Register a new option to be loaded on request.
 
2598
 
 
2599
        :param key: the key to request the option later. Since the registration
 
2600
            is lazy, it should be provided and match the option name.
 
2601
 
 
2602
        :param module_name: the python path to the module. Such as 'os.path'.
 
2603
 
 
2604
        :param member_name: the member of the module to return.  If empty or 
 
2605
                None, get() will return the module itself.
 
2606
        """
 
2607
        self._check_option_name(key)
 
2608
        super(OptionRegistry, self).register_lazy(key,
 
2609
                                                  module_name, member_name)
 
2610
 
 
2611
    def get_help(self, key=None):
 
2612
        """Get the help text associated with the given key"""
 
2613
        option = self.get(key)
 
2614
        the_help = option.help
 
2615
        if callable(the_help):
 
2616
            return the_help(self, key)
 
2617
        return the_help
 
2618
 
 
2619
 
 
2620
option_registry = OptionRegistry()
 
2621
 
 
2622
 
 
2623
# Registered options in lexicographical order
 
2624
 
 
2625
option_registry.register(
 
2626
    Option('append_revisions_only',
 
2627
           default=None, from_unicode=bool_from_store, invalid='warning',
 
2628
           help='''\
 
2629
Whether to only append revisions to the mainline.
 
2630
 
 
2631
If this is set to true, then it is not possible to change the
 
2632
existing mainline of the branch.
 
2633
'''))
 
2634
option_registry.register(
 
2635
    ListOption('acceptable_keys',
 
2636
           default=None,
 
2637
           help="""\
 
2638
List of GPG key patterns which are acceptable for verification.
 
2639
"""))
 
2640
option_registry.register(
 
2641
    Option('add.maximum_file_size',
 
2642
           default=u'20MB', from_unicode=int_SI_from_store,
 
2643
           help="""\
 
2644
Size above which files should be added manually.
 
2645
 
 
2646
Files below this size are added automatically when using ``bzr add`` without
 
2647
arguments.
 
2648
 
 
2649
A negative value means disable the size check.
 
2650
"""))
 
2651
option_registry.register(
 
2652
    Option('bound',
 
2653
           default=None, from_unicode=bool_from_store,
 
2654
           help="""\
 
2655
Is the branch bound to ``bound_location``.
 
2656
 
 
2657
If set to "True", the branch should act as a checkout, and push each commit to
 
2658
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
2659
 
 
2660
See also: bound_location.
 
2661
"""))
 
2662
option_registry.register(
 
2663
    Option('bound_location',
 
2664
           default=None,
 
2665
           help="""\
 
2666
The location that commits should go to when acting as a checkout.
 
2667
 
 
2668
This option is normally set by ``bind``.
 
2669
 
 
2670
See also: bound.
 
2671
"""))
 
2672
option_registry.register(
 
2673
    Option('branch.fetch_tags', default=False,  from_unicode=bool_from_store,
 
2674
           help="""\
 
2675
Whether revisions associated with tags should be fetched.
 
2676
"""))
 
2677
option_registry.register_lazy(
 
2678
    'bzr.transform.orphan_policy', 'bzrlib.transform', 'opt_transform_orphan')
 
2679
option_registry.register(
 
2680
    Option('bzr.workingtree.worth_saving_limit', default=10,
 
2681
           from_unicode=int_from_store,  invalid='warning',
 
2682
           help='''\
 
2683
How many changes before saving the dirstate.
 
2684
 
 
2685
-1 means that we will never rewrite the dirstate file for only
 
2686
stat-cache changes. Regardless of this setting, we will always rewrite
 
2687
the dirstate file if a file is added/removed/renamed/etc. This flag only
 
2688
affects the behavior of updating the dirstate file after we notice that
 
2689
a file has been touched.
 
2690
'''))
 
2691
option_registry.register(
 
2692
    Option('bugtracker', default=None,
 
2693
           help='''\
 
2694
Default bug tracker to use.
 
2695
 
 
2696
This bug tracker will be used for example when marking bugs
 
2697
as fixed using ``bzr commit --fixes``, if no explicit
 
2698
bug tracker was specified.
 
2699
'''))
 
2700
option_registry.register(
 
2701
    Option('check_signatures', default=CHECK_IF_POSSIBLE,
 
2702
           from_unicode=signature_policy_from_unicode,
 
2703
           help='''\
 
2704
GPG checking policy.
 
2705
 
 
2706
Possible values: require, ignore, check-available (default)
 
2707
 
 
2708
this option will control whether bzr will require good gpg
 
2709
signatures, ignore them, or check them if they are
 
2710
present.
 
2711
'''))
 
2712
option_registry.register(
 
2713
    Option('child_submit_format',
 
2714
           help='''The preferred format of submissions to this branch.'''))
 
2715
option_registry.register(
 
2716
    Option('child_submit_to',
 
2717
           help='''Where submissions to this branch are mailed to.'''))
 
2718
option_registry.register(
 
2719
    Option('create_signatures', default=SIGN_WHEN_REQUIRED,
 
2720
           from_unicode=signing_policy_from_unicode,
 
2721
           help='''\
 
2722
GPG Signing policy.
 
2723
 
 
2724
Possible values: always, never, when-required (default)
 
2725
 
 
2726
This option controls whether bzr will always create
 
2727
gpg signatures or not on commits.
 
2728
'''))
 
2729
option_registry.register(
 
2730
    Option('dirstate.fdatasync', default=True,
 
2731
           from_unicode=bool_from_store,
 
2732
           help='''\
 
2733
Flush dirstate changes onto physical disk?
 
2734
 
 
2735
If true (default), working tree metadata changes are flushed through the
 
2736
OS buffers to physical disk.  This is somewhat slower, but means data
 
2737
should not be lost if the machine crashes.  See also repository.fdatasync.
 
2738
'''))
 
2739
option_registry.register(
 
2740
    ListOption('debug_flags', default=[],
 
2741
           help='Debug flags to activate.'))
 
2742
option_registry.register(
 
2743
    Option('default_format', default='2a',
 
2744
           help='Format used when creating branches.'))
 
2745
option_registry.register(
 
2746
    Option('dpush_strict', default=None,
 
2747
           from_unicode=bool_from_store,
 
2748
           help='''\
 
2749
The default value for ``dpush --strict``.
 
2750
 
 
2751
If present, defines the ``--strict`` option default value for checking
 
2752
uncommitted changes before pushing into a different VCS without any
 
2753
custom bzr metadata.
 
2754
'''))
 
2755
option_registry.register(
 
2756
    Option('editor',
 
2757
           help='The command called to launch an editor to enter a message.'))
 
2758
option_registry.register(
 
2759
    Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
 
2760
           help='The users identity'))
 
2761
option_registry.register(
 
2762
    Option('gpg_signing_command',
 
2763
           default='gpg',
 
2764
           help="""\
 
2765
Program to use use for creating signatures.
 
2766
 
 
2767
This should support at least the -u and --clearsign options.
 
2768
"""))
 
2769
option_registry.register(
 
2770
    Option('gpg_signing_key',
 
2771
           default=None,
 
2772
           help="""\
 
2773
GPG key to use for signing.
 
2774
 
 
2775
This defaults to the first key associated with the users email.
 
2776
"""))
 
2777
option_registry.register(
 
2778
    Option('ignore_missing_extensions', default=False,
 
2779
           from_unicode=bool_from_store,
 
2780
           help='''\
 
2781
Control the missing extensions warning display.
 
2782
 
 
2783
The warning will not be emitted if set to True.
 
2784
'''))
 
2785
option_registry.register(
 
2786
    Option('language',
 
2787
           help='Language to translate messages into.'))
 
2788
option_registry.register(
 
2789
    Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
 
2790
           help='''\
 
2791
Steal locks that appears to be dead.
 
2792
 
 
2793
If set to True, bzr will check if a lock is supposed to be held by an
 
2794
active process from the same user on the same machine. If the user and
 
2795
machine match, but no process with the given PID is active, then bzr
 
2796
will automatically break the stale lock, and create a new lock for
 
2797
this process.
 
2798
Otherwise, bzr will prompt as normal to break the lock.
 
2799
'''))
 
2800
option_registry.register(
 
2801
    Option('log_format', default='long',
 
2802
           help= '''\
 
2803
Log format to use when displaying revisions.
 
2804
 
 
2805
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
 
2806
may be provided by plugins.
 
2807
'''))
 
2808
option_registry.register_lazy('mail_client', 'bzrlib.mail_client',
 
2809
    'opt_mail_client')
 
2810
option_registry.register(
 
2811
    Option('output_encoding',
 
2812
           help= 'Unicode encoding for output'
 
2813
           ' (terminal encoding if not specified).'))
 
2814
option_registry.register(
 
2815
    Option('parent_location',
 
2816
           default=None,
 
2817
           help="""\
 
2818
The location of the default branch for pull or merge.
 
2819
 
 
2820
This option is normally set when creating a branch, the first ``pull`` or by
 
2821
``pull --remember``.
 
2822
"""))
 
2823
option_registry.register(
 
2824
    Option('post_commit', default=None,
 
2825
           help='''\
 
2826
Post commit functions.
 
2827
 
 
2828
An ordered list of python functions to call, separated by spaces.
 
2829
 
 
2830
Each function takes branch, rev_id as parameters.
 
2831
'''))
 
2832
option_registry.register_lazy('progress_bar', 'bzrlib.ui.text',
 
2833
                              'opt_progress_bar')
 
2834
option_registry.register(
 
2835
    Option('public_branch',
 
2836
           default=None,
 
2837
           help="""\
 
2838
A publically-accessible version of this branch.
 
2839
 
 
2840
This implies that the branch setting this option is not publically-accessible.
 
2841
Used and set by ``bzr send``.
 
2842
"""))
 
2843
option_registry.register(
 
2844
    Option('push_location',
 
2845
           default=None,
 
2846
           help="""\
 
2847
The location of the default branch for push.
 
2848
 
 
2849
This option is normally set by the first ``push`` or ``push --remember``.
 
2850
"""))
 
2851
option_registry.register(
 
2852
    Option('push_strict', default=None,
 
2853
           from_unicode=bool_from_store,
 
2854
           help='''\
 
2855
The default value for ``push --strict``.
 
2856
 
 
2857
If present, defines the ``--strict`` option default value for checking
 
2858
uncommitted changes before sending a merge directive.
 
2859
'''))
 
2860
option_registry.register(
 
2861
    Option('repository.fdatasync', default=True,
 
2862
           from_unicode=bool_from_store,
 
2863
           help='''\
 
2864
Flush repository changes onto physical disk?
 
2865
 
 
2866
If true (default), repository changes are flushed through the OS buffers
 
2867
to physical disk.  This is somewhat slower, but means data should not be
 
2868
lost if the machine crashes.  See also dirstate.fdatasync.
 
2869
'''))
 
2870
option_registry.register_lazy('smtp_server',
 
2871
    'bzrlib.smtp_connection', 'smtp_server')
 
2872
option_registry.register_lazy('smtp_password',
 
2873
    'bzrlib.smtp_connection', 'smtp_password')
 
2874
option_registry.register_lazy('smtp_username',
 
2875
    'bzrlib.smtp_connection', 'smtp_username')
 
2876
option_registry.register(
 
2877
    Option('selftest.timeout',
 
2878
        default='600',
 
2879
        from_unicode=int_from_store,
 
2880
        help='Abort selftest if one test takes longer than this many seconds',
 
2881
        ))
 
2882
 
 
2883
option_registry.register(
 
2884
    Option('send_strict', default=None,
 
2885
           from_unicode=bool_from_store,
 
2886
           help='''\
 
2887
The default value for ``send --strict``.
 
2888
 
 
2889
If present, defines the ``--strict`` option default value for checking
 
2890
uncommitted changes before sending a bundle.
 
2891
'''))
 
2892
 
 
2893
option_registry.register(
 
2894
    Option('serve.client_timeout',
 
2895
           default=300.0, from_unicode=float_from_store,
 
2896
           help="If we wait for a new request from a client for more than"
 
2897
                " X seconds, consider the client idle, and hangup."))
 
2898
option_registry.register(
 
2899
    Option('stacked_on_location',
 
2900
           default=None,
 
2901
           help="""The location where this branch is stacked on."""))
 
2902
option_registry.register(
 
2903
    Option('submit_branch',
 
2904
           default=None,
 
2905
           help="""\
 
2906
The branch you intend to submit your current work to.
 
2907
 
 
2908
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
 
2909
by the ``submit:`` revision spec.
 
2910
"""))
 
2911
option_registry.register(
 
2912
    Option('submit_to',
 
2913
           help='''Where submissions from this branch are mailed to.'''))
 
2914
option_registry.register(
 
2915
    ListOption('suppress_warnings',
 
2916
           default=[],
 
2917
           help="List of warning classes to suppress."))
 
2918
option_registry.register(
 
2919
    Option('validate_signatures_in_log', default=False,
 
2920
           from_unicode=bool_from_store, invalid='warning',
 
2921
           help='''Whether to validate signatures in bzr log.'''))
 
2922
option_registry.register_lazy('ssl.ca_certs',
 
2923
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_ca_certs')
 
2924
 
 
2925
option_registry.register_lazy('ssl.cert_reqs',
 
2926
    'bzrlib.transport.http._urllib2_wrappers', 'opt_ssl_cert_reqs')
 
2927
 
 
2928
 
 
2929
class Section(object):
 
2930
    """A section defines a dict of option name => value.
 
2931
 
 
2932
    This is merely a read-only dict which can add some knowledge about the
 
2933
    options. It is *not* a python dict object though and doesn't try to mimic
 
2934
    its API.
 
2935
    """
 
2936
 
 
2937
    def __init__(self, section_id, options):
 
2938
        self.id = section_id
 
2939
        # We re-use the dict-like object received
 
2940
        self.options = options
 
2941
 
 
2942
    def get(self, name, default=None, expand=True):
 
2943
        return self.options.get(name, default)
 
2944
 
 
2945
    def iter_option_names(self):
 
2946
        for k in self.options.iterkeys():
 
2947
            yield k
 
2948
 
 
2949
    def __repr__(self):
 
2950
        # Mostly for debugging use
 
2951
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
 
2952
 
 
2953
 
 
2954
_NewlyCreatedOption = object()
 
2955
"""Was the option created during the MutableSection lifetime"""
 
2956
_DeletedOption = object()
 
2957
"""Was the option deleted during the MutableSection lifetime"""
 
2958
 
 
2959
 
 
2960
class MutableSection(Section):
 
2961
    """A section allowing changes and keeping track of the original values."""
 
2962
 
 
2963
    def __init__(self, section_id, options):
 
2964
        super(MutableSection, self).__init__(section_id, options)
 
2965
        self.reset_changes()
 
2966
 
 
2967
    def set(self, name, value):
 
2968
        if name not in self.options:
 
2969
            # This is a new option
 
2970
            self.orig[name] = _NewlyCreatedOption
 
2971
        elif name not in self.orig:
 
2972
            self.orig[name] = self.get(name, None)
 
2973
        self.options[name] = value
 
2974
 
 
2975
    def remove(self, name):
 
2976
        if name not in self.orig and name in self.options:
 
2977
            self.orig[name] = self.get(name, None)
 
2978
        del self.options[name]
 
2979
 
 
2980
    def reset_changes(self):
 
2981
        self.orig = {}
 
2982
 
 
2983
    def apply_changes(self, dirty, store):
 
2984
        """Apply option value changes.
 
2985
 
 
2986
        ``self`` has been reloaded from the persistent storage. ``dirty``
 
2987
        contains the changes made since the previous loading.
 
2988
 
 
2989
        :param dirty: the mutable section containing the changes.
 
2990
 
 
2991
        :param store: the store containing the section
 
2992
        """
 
2993
        for k, expected in dirty.orig.iteritems():
 
2994
            actual = dirty.get(k, _DeletedOption)
 
2995
            reloaded = self.get(k, _NewlyCreatedOption)
 
2996
            if actual is _DeletedOption:
 
2997
                if k in self.options:
 
2998
                    self.remove(k)
 
2999
            else:
 
3000
                self.set(k, actual)
 
3001
            # Report concurrent updates in an ad-hoc way. This should only
 
3002
            # occurs when different processes try to update the same option
 
3003
            # which is not supported (as in: the config framework is not meant
 
3004
            # to be used as a sharing mechanism).
 
3005
            if expected != reloaded:
 
3006
                if actual is _DeletedOption:
 
3007
                    actual = '<DELETED>'
 
3008
                if reloaded is _NewlyCreatedOption:
 
3009
                    reloaded = '<CREATED>'
 
3010
                if expected is _NewlyCreatedOption:
 
3011
                    expected = '<CREATED>'
 
3012
                # Someone changed the value since we get it from the persistent
 
3013
                # storage.
 
3014
                trace.warning(gettext(
 
3015
                        "Option {0} in section {1} of {2} was changed"
 
3016
                        " from {3} to {4}. The {5} value will be saved.".format(
 
3017
                            k, self.id, store.external_url(), expected,
 
3018
                            reloaded, actual)))
 
3019
        # No need to keep track of these changes
 
3020
        self.reset_changes()
 
3021
 
 
3022
 
 
3023
class Store(object):
 
3024
    """Abstract interface to persistent storage for configuration options."""
 
3025
 
 
3026
    readonly_section_class = Section
 
3027
    mutable_section_class = MutableSection
 
3028
 
 
3029
    def __init__(self):
 
3030
        # Which sections need to be saved (by section id). We use a dict here
 
3031
        # so the dirty sections can be shared by multiple callers.
 
3032
        self.dirty_sections = {}
 
3033
 
 
3034
    def is_loaded(self):
 
3035
        """Returns True if the Store has been loaded.
 
3036
 
 
3037
        This is used to implement lazy loading and ensure the persistent
 
3038
        storage is queried only when needed.
 
3039
        """
 
3040
        raise NotImplementedError(self.is_loaded)
 
3041
 
 
3042
    def load(self):
 
3043
        """Loads the Store from persistent storage."""
 
3044
        raise NotImplementedError(self.load)
 
3045
 
 
3046
    def _load_from_string(self, bytes):
 
3047
        """Create a store from a string in configobj syntax.
 
3048
 
 
3049
        :param bytes: A string representing the file content.
 
3050
        """
 
3051
        raise NotImplementedError(self._load_from_string)
 
3052
 
 
3053
    def unload(self):
 
3054
        """Unloads the Store.
 
3055
 
 
3056
        This should make is_loaded() return False. This is used when the caller
 
3057
        knows that the persistent storage has changed or may have change since
 
3058
        the last load.
 
3059
        """
 
3060
        raise NotImplementedError(self.unload)
 
3061
 
 
3062
    def quote(self, value):
 
3063
        """Quote a configuration option value for storing purposes.
 
3064
 
 
3065
        This allows Stacks to present values as they will be stored.
 
3066
        """
 
3067
        return value
 
3068
 
 
3069
    def unquote(self, value):
 
3070
        """Unquote a configuration option value into unicode.
 
3071
 
 
3072
        The received value is quoted as stored.
 
3073
        """
 
3074
        return value
 
3075
 
 
3076
    def save(self):
 
3077
        """Saves the Store to persistent storage."""
 
3078
        raise NotImplementedError(self.save)
 
3079
 
 
3080
    def _need_saving(self):
 
3081
        for s in self.dirty_sections.values():
 
3082
            if s.orig:
 
3083
                # At least one dirty section contains a modification
 
3084
                return True
 
3085
        return False
 
3086
 
 
3087
    def apply_changes(self, dirty_sections):
 
3088
        """Apply changes from dirty sections while checking for coherency.
 
3089
 
 
3090
        The Store content is discarded and reloaded from persistent storage to
 
3091
        acquire up-to-date values.
 
3092
 
 
3093
        Dirty sections are MutableSection which kept track of the value they
 
3094
        are expected to update.
 
3095
        """
 
3096
        # We need an up-to-date version from the persistent storage, unload the
 
3097
        # store. The reload will occur when needed (triggered by the first
 
3098
        # get_mutable_section() call below.
 
3099
        self.unload()
 
3100
        # Apply the changes from the preserved dirty sections
 
3101
        for section_id, dirty in dirty_sections.iteritems():
 
3102
            clean = self.get_mutable_section(section_id)
 
3103
            clean.apply_changes(dirty, self)
 
3104
        # Everything is clean now
 
3105
        self.dirty_sections = {}
 
3106
 
 
3107
    def save_changes(self):
 
3108
        """Saves the Store to persistent storage if changes occurred.
 
3109
 
 
3110
        Apply the changes recorded in the mutable sections to a store content
 
3111
        refreshed from persistent storage.
 
3112
        """
 
3113
        raise NotImplementedError(self.save_changes)
 
3114
 
 
3115
    def external_url(self):
 
3116
        raise NotImplementedError(self.external_url)
 
3117
 
 
3118
    def get_sections(self):
 
3119
        """Returns an ordered iterable of existing sections.
 
3120
 
 
3121
        :returns: An iterable of (store, section).
 
3122
        """
 
3123
        raise NotImplementedError(self.get_sections)
 
3124
 
 
3125
    def get_mutable_section(self, section_id=None):
 
3126
        """Returns the specified mutable section.
 
3127
 
 
3128
        :param section_id: The section identifier
 
3129
        """
 
3130
        raise NotImplementedError(self.get_mutable_section)
 
3131
 
 
3132
    def __repr__(self):
 
3133
        # Mostly for debugging use
 
3134
        return "<config.%s(%s)>" % (self.__class__.__name__,
 
3135
                                    self.external_url())
 
3136
 
 
3137
 
 
3138
class CommandLineStore(Store):
 
3139
    "A store to carry command line overrides for the config options."""
 
3140
 
 
3141
    def __init__(self, opts=None):
 
3142
        super(CommandLineStore, self).__init__()
 
3143
        if opts is None:
 
3144
            opts = {}
 
3145
        self.options = {}
 
3146
        self.id = 'cmdline'
 
3147
 
 
3148
    def _reset(self):
 
3149
        # The dict should be cleared but not replaced so it can be shared.
 
3150
        self.options.clear()
 
3151
 
 
3152
    def _from_cmdline(self, overrides):
 
3153
        # Reset before accepting new definitions
 
3154
        self._reset()
 
3155
        for over in overrides:
 
3156
            try:
 
3157
                name, value = over.split('=', 1)
 
3158
            except ValueError:
 
3159
                raise errors.BzrCommandError(
 
3160
                    gettext("Invalid '%s', should be of the form 'name=value'")
 
3161
                    % (over,))
 
3162
            self.options[name] = value
 
3163
 
 
3164
    def external_url(self):
 
3165
        # Not an url but it makes debugging easier and is never needed
 
3166
        # otherwise
 
3167
        return 'cmdline'
 
3168
 
 
3169
    def get_sections(self):
 
3170
        yield self,  self.readonly_section_class(None, self.options)
 
3171
 
 
3172
 
 
3173
class IniFileStore(Store):
 
3174
    """A config Store using ConfigObj for storage.
 
3175
 
 
3176
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
 
3177
        serialize/deserialize the config file.
 
3178
    """
 
3179
 
 
3180
    def __init__(self):
 
3181
        """A config Store using ConfigObj for storage.
 
3182
        """
 
3183
        super(IniFileStore, self).__init__()
 
3184
        self._config_obj = None
 
3185
 
 
3186
    def is_loaded(self):
 
3187
        return self._config_obj != None
 
3188
 
 
3189
    def unload(self):
 
3190
        self._config_obj = None
 
3191
        self.dirty_sections = {}
 
3192
 
 
3193
    def _load_content(self):
 
3194
        """Load the config file bytes.
 
3195
 
 
3196
        This should be provided by subclasses
 
3197
 
 
3198
        :return: Byte string
 
3199
        """
 
3200
        raise NotImplementedError(self._load_content)
 
3201
 
 
3202
    def _save_content(self, content):
 
3203
        """Save the config file bytes.
 
3204
 
 
3205
        This should be provided by subclasses
 
3206
 
 
3207
        :param content: Config file bytes to write
 
3208
        """
 
3209
        raise NotImplementedError(self._save_content)
 
3210
 
 
3211
    def load(self):
 
3212
        """Load the store from the associated file."""
 
3213
        if self.is_loaded():
 
3214
            return
 
3215
        content = self._load_content()
 
3216
        self._load_from_string(content)
 
3217
        for hook in ConfigHooks['load']:
 
3218
            hook(self)
 
3219
 
 
3220
    def _load_from_string(self, bytes):
 
3221
        """Create a config store from a string.
 
3222
 
 
3223
        :param bytes: A string representing the file content.
 
3224
        """
 
3225
        if self.is_loaded():
 
3226
            raise AssertionError('Already loaded: %r' % (self._config_obj,))
 
3227
        co_input = StringIO(bytes)
 
3228
        try:
 
3229
            # The config files are always stored utf8-encoded
 
3230
            self._config_obj = ConfigObj(co_input, encoding='utf-8',
 
3231
                                         list_values=False)
 
3232
        except configobj.ConfigObjError, e:
 
3233
            self._config_obj = None
 
3234
            raise errors.ParseConfigError(e.errors, self.external_url())
 
3235
        except UnicodeDecodeError:
 
3236
            raise errors.ConfigContentError(self.external_url())
 
3237
 
 
3238
    def save_changes(self):
 
3239
        if not self.is_loaded():
 
3240
            # Nothing to save
 
3241
            return
 
3242
        if not self._need_saving():
 
3243
            return
 
3244
        # Preserve the current version
 
3245
        dirty_sections = dict(self.dirty_sections.items())
 
3246
        self.apply_changes(dirty_sections)
 
3247
        # Save to the persistent storage
 
3248
        self.save()
 
3249
 
 
3250
    def save(self):
 
3251
        if not self.is_loaded():
 
3252
            # Nothing to save
 
3253
            return
 
3254
        out = StringIO()
 
3255
        self._config_obj.write(out)
 
3256
        self._save_content(out.getvalue())
 
3257
        for hook in ConfigHooks['save']:
 
3258
            hook(self)
 
3259
 
 
3260
    def get_sections(self):
 
3261
        """Get the configobj section in the file order.
 
3262
 
 
3263
        :returns: An iterable of (store, section).
 
3264
        """
 
3265
        # We need a loaded store
 
3266
        try:
 
3267
            self.load()
 
3268
        except (errors.NoSuchFile, errors.PermissionDenied):
 
3269
            # If the file can't be read, there is no sections
 
3270
            return
 
3271
        cobj = self._config_obj
 
3272
        if cobj.scalars:
 
3273
            yield self, self.readonly_section_class(None, cobj)
 
3274
        for section_name in cobj.sections:
 
3275
            yield (self,
 
3276
                   self.readonly_section_class(section_name,
 
3277
                                               cobj[section_name]))
 
3278
 
 
3279
    def get_mutable_section(self, section_id=None):
 
3280
        # We need a loaded store
 
3281
        try:
 
3282
            self.load()
 
3283
        except errors.NoSuchFile:
 
3284
            # The file doesn't exist, let's pretend it was empty
 
3285
            self._load_from_string('')
 
3286
        if section_id in self.dirty_sections:
 
3287
            # We already created a mutable section for this id
 
3288
            return self.dirty_sections[section_id]
 
3289
        if section_id is None:
 
3290
            section = self._config_obj
 
3291
        else:
 
3292
            section = self._config_obj.setdefault(section_id, {})
 
3293
        mutable_section = self.mutable_section_class(section_id, section)
 
3294
        # All mutable sections can become dirty
 
3295
        self.dirty_sections[section_id] = mutable_section
 
3296
        return mutable_section
 
3297
 
 
3298
    def quote(self, value):
 
3299
        try:
 
3300
            # configobj conflates automagical list values and quoting
 
3301
            self._config_obj.list_values = True
 
3302
            return self._config_obj._quote(value)
 
3303
        finally:
 
3304
            self._config_obj.list_values = False
 
3305
 
 
3306
    def unquote(self, value):
 
3307
        if value and isinstance(value, basestring):
 
3308
            # _unquote doesn't handle None nor empty strings nor anything that
 
3309
            # is not a string, really.
 
3310
            value = self._config_obj._unquote(value)
 
3311
        return value
 
3312
 
 
3313
    def external_url(self):
 
3314
        # Since an IniFileStore can be used without a file (at least in tests),
 
3315
        # it's better to provide something than raising a NotImplementedError.
 
3316
        # All daughter classes are supposed to provide an implementation
 
3317
        # anyway.
 
3318
        return 'In-Process Store, no URL'
 
3319
 
 
3320
 
 
3321
class TransportIniFileStore(IniFileStore):
 
3322
    """IniFileStore that loads files from a transport.
 
3323
 
 
3324
    :ivar transport: The transport object where the config file is located.
 
3325
 
 
3326
    :ivar file_name: The config file basename in the transport directory.
 
3327
    """
 
3328
 
 
3329
    def __init__(self, transport, file_name):
 
3330
        """A Store using a ini file on a Transport
 
3331
 
 
3332
        :param transport: The transport object where the config file is located.
 
3333
        :param file_name: The config file basename in the transport directory.
 
3334
        """
 
3335
        super(TransportIniFileStore, self).__init__()
 
3336
        self.transport = transport
 
3337
        self.file_name = file_name
 
3338
 
 
3339
    def _load_content(self):
 
3340
        try:
 
3341
            return self.transport.get_bytes(self.file_name)
 
3342
        except errors.PermissionDenied:
 
3343
            trace.warning("Permission denied while trying to load "
 
3344
                          "configuration store %s.", self.external_url())
 
3345
            raise
 
3346
 
 
3347
    def _save_content(self, content):
 
3348
        self.transport.put_bytes(self.file_name, content)
 
3349
 
 
3350
    def external_url(self):
 
3351
        # FIXME: external_url should really accepts an optional relpath
 
3352
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
3353
        # The following will do in the interim but maybe we don't want to
 
3354
        # expose a path here but rather a config ID and its associated
 
3355
        # object </hand wawe>.
 
3356
        return urlutils.join(self.transport.external_url(), self.file_name)
 
3357
 
 
3358
 
 
3359
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
 
3360
# unlockable stores for use with objects that can already ensure the locking
 
3361
# (think branches). If different stores (not based on ConfigObj) are created,
 
3362
# they may face the same issue.
 
3363
 
 
3364
 
 
3365
class LockableIniFileStore(TransportIniFileStore):
 
3366
    """A ConfigObjStore using locks on save to ensure store integrity."""
 
3367
 
 
3368
    def __init__(self, transport, file_name, lock_dir_name=None):
 
3369
        """A config Store using ConfigObj for storage.
 
3370
 
 
3371
        :param transport: The transport object where the config file is located.
 
3372
 
 
3373
        :param file_name: The config file basename in the transport directory.
 
3374
        """
 
3375
        if lock_dir_name is None:
 
3376
            lock_dir_name = 'lock'
 
3377
        self.lock_dir_name = lock_dir_name
 
3378
        super(LockableIniFileStore, self).__init__(transport, file_name)
 
3379
        self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
 
3380
 
 
3381
    def lock_write(self, token=None):
 
3382
        """Takes a write lock in the directory containing the config file.
 
3383
 
 
3384
        If the directory doesn't exist it is created.
 
3385
        """
 
3386
        # FIXME: This doesn't check the ownership of the created directories as
 
3387
        # ensure_config_dir_exists does. It should if the transport is local
 
3388
        # -- vila 2011-04-06
 
3389
        self.transport.create_prefix()
 
3390
        return self._lock.lock_write(token)
 
3391
 
 
3392
    def unlock(self):
 
3393
        self._lock.unlock()
 
3394
 
 
3395
    def break_lock(self):
 
3396
        self._lock.break_lock()
 
3397
 
 
3398
    @needs_write_lock
 
3399
    def save(self):
 
3400
        # We need to be able to override the undecorated implementation
 
3401
        self.save_without_locking()
 
3402
 
 
3403
    def save_without_locking(self):
 
3404
        super(LockableIniFileStore, self).save()
 
3405
 
 
3406
 
 
3407
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
 
3408
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
 
3409
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
 
3410
 
 
3411
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
 
3412
# functions or a registry will make it easier and clearer for tests, focusing
 
3413
# on the relevant parts of the API that needs testing -- vila 20110503 (based
 
3414
# on a poolie's remark)
 
3415
class GlobalStore(LockableIniFileStore):
 
3416
    """A config store for global options.
 
3417
 
 
3418
    There is a single GlobalStore for a given process.
 
3419
    """
 
3420
 
 
3421
    def __init__(self, possible_transports=None):
 
3422
        t = transport.get_transport_from_path(
 
3423
            config_dir(), possible_transports=possible_transports)
 
3424
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
3425
        self.id = 'bazaar'
 
3426
 
 
3427
 
 
3428
class LocationStore(LockableIniFileStore):
 
3429
    """A config store for options specific to a location.
 
3430
 
 
3431
    There is a single LocationStore for a given process.
 
3432
    """
 
3433
 
 
3434
    def __init__(self, possible_transports=None):
 
3435
        t = transport.get_transport_from_path(
 
3436
            config_dir(), possible_transports=possible_transports)
 
3437
        super(LocationStore, self).__init__(t, 'locations.conf')
 
3438
        self.id = 'locations'
 
3439
 
 
3440
 
 
3441
class BranchStore(TransportIniFileStore):
 
3442
    """A config store for branch options.
 
3443
 
 
3444
    There is a single BranchStore for a given branch.
 
3445
    """
 
3446
 
 
3447
    def __init__(self, branch):
 
3448
        super(BranchStore, self).__init__(branch.control_transport,
 
3449
                                          'branch.conf')
 
3450
        self.branch = branch
 
3451
        self.id = 'branch'
 
3452
 
 
3453
 
 
3454
class ControlStore(LockableIniFileStore):
 
3455
 
 
3456
    def __init__(self, bzrdir):
 
3457
        super(ControlStore, self).__init__(bzrdir.transport,
 
3458
                                          'control.conf',
 
3459
                                           lock_dir_name='branch_lock')
 
3460
        self.id = 'control'
 
3461
 
 
3462
 
 
3463
class SectionMatcher(object):
 
3464
    """Select sections into a given Store.
 
3465
 
 
3466
    This is intended to be used to postpone getting an iterable of sections
 
3467
    from a store.
 
3468
    """
 
3469
 
 
3470
    def __init__(self, store):
 
3471
        self.store = store
 
3472
 
 
3473
    def get_sections(self):
 
3474
        # This is where we require loading the store so we can see all defined
 
3475
        # sections.
 
3476
        sections = self.store.get_sections()
 
3477
        # Walk the revisions in the order provided
 
3478
        for store, s in sections:
 
3479
            if self.match(s):
 
3480
                yield store, s
 
3481
 
 
3482
    def match(self, section):
 
3483
        """Does the proposed section match.
 
3484
 
 
3485
        :param section: A Section object.
 
3486
 
 
3487
        :returns: True if the section matches, False otherwise.
 
3488
        """
 
3489
        raise NotImplementedError(self.match)
 
3490
 
 
3491
 
 
3492
class NameMatcher(SectionMatcher):
 
3493
 
 
3494
    def __init__(self, store, section_id):
 
3495
        super(NameMatcher, self).__init__(store)
 
3496
        self.section_id = section_id
 
3497
 
 
3498
    def match(self, section):
 
3499
        return section.id == self.section_id
 
3500
 
 
3501
 
 
3502
class LocationSection(Section):
 
3503
 
 
3504
    def __init__(self, section, extra_path, branch_name=None):
 
3505
        super(LocationSection, self).__init__(section.id, section.options)
 
3506
        self.extra_path = extra_path
 
3507
        if branch_name is None:
 
3508
            branch_name = ''
 
3509
        self.locals = {'relpath': extra_path,
 
3510
                       'basename': urlutils.basename(extra_path),
 
3511
                       'branchname': branch_name}
 
3512
 
 
3513
    def get(self, name, default=None, expand=True):
 
3514
        value = super(LocationSection, self).get(name, default)
 
3515
        if value is not None and expand:
 
3516
            policy_name = self.get(name + ':policy', None)
 
3517
            policy = _policy_value.get(policy_name, POLICY_NONE)
 
3518
            if policy == POLICY_APPENDPATH:
 
3519
                value = urlutils.join(value, self.extra_path)
 
3520
            # expand section local options right now (since POLICY_APPENDPATH
 
3521
            # will never add options references, it's ok to expand after it).
 
3522
            chunks = []
 
3523
            for is_ref, chunk in iter_option_refs(value):
 
3524
                if not is_ref:
 
3525
                    chunks.append(chunk)
 
3526
                else:
 
3527
                    ref = chunk[1:-1]
 
3528
                    if ref in self.locals:
 
3529
                        chunks.append(self.locals[ref])
 
3530
                    else:
 
3531
                        chunks.append(chunk)
 
3532
            value = ''.join(chunks)
 
3533
        return value
 
3534
 
 
3535
 
 
3536
class StartingPathMatcher(SectionMatcher):
 
3537
    """Select sections for a given location respecting the Store order."""
 
3538
 
 
3539
    # FIXME: Both local paths and urls can be used for section names as well as
 
3540
    # ``location`` to stay consistent with ``LocationMatcher`` which itself
 
3541
    # inherited the fuzziness from the previous ``LocationConfig``
 
3542
    # implementation. We probably need to revisit which encoding is allowed for
 
3543
    # both ``location`` and section names and how we normalize
 
3544
    # them. http://pad.lv/85479, http://pad.lv/437009 and http://359320 are
 
3545
    # related too. -- vila 2012-01-04
 
3546
 
 
3547
    def __init__(self, store, location):
 
3548
        super(StartingPathMatcher, self).__init__(store)
 
3549
        if location.startswith('file://'):
 
3550
            location = urlutils.local_path_from_url(location)
 
3551
        self.location = location
 
3552
 
 
3553
    def get_sections(self):
 
3554
        """Get all sections matching ``location`` in the store.
 
3555
 
 
3556
        The most generic sections are described first in the store, then more
 
3557
        specific ones can be provided for reduced scopes.
 
3558
 
 
3559
        The returned section are therefore returned in the reversed order so
 
3560
        the most specific ones can be found first.
 
3561
        """
 
3562
        location_parts = self.location.rstrip('/').split('/')
 
3563
        store = self.store
 
3564
        sections = []
 
3565
        # Later sections are more specific, they should be returned first
 
3566
        for _, section in reversed(list(store.get_sections())):
 
3567
            if section.id is None:
 
3568
                # The no-name section is always included if present
 
3569
                yield store, LocationSection(section, self.location)
 
3570
                continue
 
3571
            section_path = section.id
 
3572
            if section_path.startswith('file://'):
 
3573
                # the location is already a local path or URL, convert the
 
3574
                # section id to the same format
 
3575
                section_path = urlutils.local_path_from_url(section_path)
 
3576
            if (self.location.startswith(section_path)
 
3577
                or fnmatch.fnmatch(self.location, section_path)):
 
3578
                section_parts = section_path.rstrip('/').split('/')
 
3579
                extra_path = '/'.join(location_parts[len(section_parts):])
 
3580
                yield store, LocationSection(section, extra_path)
 
3581
 
 
3582
 
 
3583
class LocationMatcher(SectionMatcher):
 
3584
 
 
3585
    def __init__(self, store, location):
 
3586
        super(LocationMatcher, self).__init__(store)
 
3587
        url, params = urlutils.split_segment_parameters(location)
 
3588
        if location.startswith('file://'):
 
3589
            location = urlutils.local_path_from_url(location)
 
3590
        self.location = location
 
3591
        branch_name = params.get('branch')
 
3592
        if branch_name is None:
 
3593
            self.branch_name = urlutils.basename(self.location)
 
3594
        else:
 
3595
            self.branch_name = urlutils.unescape(branch_name)
 
3596
 
 
3597
    def _get_matching_sections(self):
 
3598
        """Get all sections matching ``location``."""
 
3599
        # We slightly diverge from LocalConfig here by allowing the no-name
 
3600
        # section as the most generic one and the lower priority.
 
3601
        no_name_section = None
 
3602
        all_sections = []
 
3603
        # Filter out the no_name_section so _iter_for_location_by_parts can be
 
3604
        # used (it assumes all sections have a name).
 
3605
        for _, section in self.store.get_sections():
 
3606
            if section.id is None:
 
3607
                no_name_section = section
 
3608
            else:
 
3609
                all_sections.append(section)
 
3610
        # Unfortunately _iter_for_location_by_parts deals with section names so
 
3611
        # we have to resync.
 
3612
        filtered_sections = _iter_for_location_by_parts(
 
3613
            [s.id for s in all_sections], self.location)
 
3614
        iter_all_sections = iter(all_sections)
 
3615
        matching_sections = []
 
3616
        if no_name_section is not None:
 
3617
            matching_sections.append(
 
3618
                (0, LocationSection(no_name_section, self.location)))
 
3619
        for section_id, extra_path, length in filtered_sections:
 
3620
            # a section id is unique for a given store so it's safe to take the
 
3621
            # first matching section while iterating. Also, all filtered
 
3622
            # sections are part of 'all_sections' and will always be found
 
3623
            # there.
 
3624
            while True:
 
3625
                section = iter_all_sections.next()
 
3626
                if section_id == section.id:
 
3627
                    section = LocationSection(section, extra_path,
 
3628
                                              self.branch_name)
 
3629
                    matching_sections.append((length, section))
 
3630
                    break
 
3631
        return matching_sections
 
3632
 
 
3633
    def get_sections(self):
 
3634
        # Override the default implementation as we want to change the order
 
3635
        matching_sections = self._get_matching_sections()
 
3636
        # We want the longest (aka more specific) locations first
 
3637
        sections = sorted(matching_sections,
 
3638
                          key=lambda (length, section): (length, section.id),
 
3639
                          reverse=True)
 
3640
        # Sections mentioning 'ignore_parents' restrict the selection
 
3641
        for _, section in sections:
 
3642
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
 
3643
            ignore = section.get('ignore_parents', None)
 
3644
            if ignore is not None:
 
3645
                ignore = ui.bool_from_string(ignore)
 
3646
            if ignore:
 
3647
                break
 
3648
            # Finally, we have a valid section
 
3649
            yield self.store, section
 
3650
 
 
3651
 
 
3652
# FIXME: _shared_stores should be an attribute of a library state once a
 
3653
# library_state object is always available.
 
3654
_shared_stores = {}
 
3655
_shared_stores_at_exit_installed = False
 
3656
 
 
3657
class Stack(object):
 
3658
    """A stack of configurations where an option can be defined"""
 
3659
 
 
3660
    def __init__(self, sections_def, store=None, mutable_section_id=None):
 
3661
        """Creates a stack of sections with an optional store for changes.
 
3662
 
 
3663
        :param sections_def: A list of Section or callables that returns an
 
3664
            iterable of Section. This defines the Sections for the Stack and
 
3665
            can be called repeatedly if needed.
 
3666
 
 
3667
        :param store: The optional Store where modifications will be
 
3668
            recorded. If none is specified, no modifications can be done.
 
3669
 
 
3670
        :param mutable_section_id: The id of the MutableSection where changes
 
3671
            are recorded. This requires the ``store`` parameter to be
 
3672
            specified.
 
3673
        """
 
3674
        self.sections_def = sections_def
 
3675
        self.store = store
 
3676
        self.mutable_section_id = mutable_section_id
 
3677
 
 
3678
    def iter_sections(self):
 
3679
        """Iterate all the defined sections."""
 
3680
        # Ensuring lazy loading is achieved by delaying section matching (which
 
3681
        # implies querying the persistent storage) until it can't be avoided
 
3682
        # anymore by using callables to describe (possibly empty) section
 
3683
        # lists.
 
3684
        for sections in self.sections_def:
 
3685
            for store, section in sections():
 
3686
                yield store, section
 
3687
 
 
3688
    def get(self, name, expand=True, convert=True):
 
3689
        """Return the *first* option value found in the sections.
 
3690
 
 
3691
        This is where we guarantee that sections coming from Store are loaded
 
3692
        lazily: the loading is delayed until we need to either check that an
 
3693
        option exists or get its value, which in turn may require to discover
 
3694
        in which sections it can be defined. Both of these (section and option
 
3695
        existence) require loading the store (even partially).
 
3696
 
 
3697
        :param name: The queried option.
 
3698
 
 
3699
        :param expand: Whether options references should be expanded.
 
3700
 
 
3701
        :param convert: Whether the option value should be converted from
 
3702
            unicode (do nothing for non-registered options).
 
3703
 
 
3704
        :returns: The value of the option.
 
3705
        """
 
3706
        # FIXME: No caching of options nor sections yet -- vila 20110503
 
3707
        value = None
 
3708
        found_store = None # Where the option value has been found
 
3709
        # If the option is registered, it may provide additional info about
 
3710
        # value handling
 
3711
        try:
 
3712
            opt = option_registry.get(name)
 
3713
        except KeyError:
 
3714
            # Not registered
 
3715
            opt = None
 
3716
 
 
3717
        def expand_and_convert(val):
 
3718
            # This may need to be called in different contexts if the value is
 
3719
            # None or ends up being None during expansion or conversion.
 
3720
            if val is not None:
 
3721
                if expand:
 
3722
                    if isinstance(val, basestring):
 
3723
                        val = self._expand_options_in_string(val)
 
3724
                    else:
 
3725
                        trace.warning('Cannot expand "%s":'
 
3726
                                      ' %s does not support option expansion'
 
3727
                                      % (name, type(val)))
 
3728
                if opt is None:
 
3729
                    val = found_store.unquote(val)
 
3730
                elif convert:
 
3731
                    val = opt.convert_from_unicode(found_store, val)
 
3732
            return val
 
3733
 
 
3734
        # First of all, check if the environment can override the configuration
 
3735
        # value
 
3736
        if opt is not None and opt.override_from_env:
 
3737
            value = opt.get_override()
 
3738
            value = expand_and_convert(value)
 
3739
        if value is None:
 
3740
            for store, section in self.iter_sections():
 
3741
                value = section.get(name)
 
3742
                if value is not None:
 
3743
                    found_store = store
 
3744
                    break
 
3745
            value = expand_and_convert(value)
 
3746
            if opt is not None and value is None:
 
3747
                # If the option is registered, it may provide a default value
 
3748
                value = opt.get_default()
 
3749
                value = expand_and_convert(value)
 
3750
        for hook in ConfigHooks['get']:
 
3751
            hook(self, name, value)
 
3752
        return value
 
3753
 
 
3754
    def expand_options(self, string, env=None):
 
3755
        """Expand option references in the string in the configuration context.
 
3756
 
 
3757
        :param string: The string containing option(s) to expand.
 
3758
 
 
3759
        :param env: An option dict defining additional configuration options or
 
3760
            overriding existing ones.
 
3761
 
 
3762
        :returns: The expanded string.
 
3763
        """
 
3764
        return self._expand_options_in_string(string, env)
 
3765
 
 
3766
    def _expand_options_in_string(self, string, env=None, _refs=None):
 
3767
        """Expand options in the string in the configuration context.
 
3768
 
 
3769
        :param string: The string to be expanded.
 
3770
 
 
3771
        :param env: An option dict defining additional configuration options or
 
3772
            overriding existing ones.
 
3773
 
 
3774
        :param _refs: Private list (FIFO) containing the options being expanded
 
3775
            to detect loops.
 
3776
 
 
3777
        :returns: The expanded string.
 
3778
        """
 
3779
        if string is None:
 
3780
            # Not much to expand there
 
3781
            return None
 
3782
        if _refs is None:
 
3783
            # What references are currently resolved (to detect loops)
 
3784
            _refs = []
 
3785
        result = string
 
3786
        # We need to iterate until no more refs appear ({{foo}} will need two
 
3787
        # iterations for example).
 
3788
        expanded = True
 
3789
        while expanded:
 
3790
            expanded = False
 
3791
            chunks = []
 
3792
            for is_ref, chunk in iter_option_refs(result):
 
3793
                if not is_ref:
 
3794
                    chunks.append(chunk)
 
3795
                else:
 
3796
                    expanded = True
 
3797
                    name = chunk[1:-1]
 
3798
                    if name in _refs:
 
3799
                        raise errors.OptionExpansionLoop(string, _refs)
 
3800
                    _refs.append(name)
 
3801
                    value = self._expand_option(name, env, _refs)
 
3802
                    if value is None:
 
3803
                        raise errors.ExpandingUnknownOption(name, string)
 
3804
                    chunks.append(value)
 
3805
                    _refs.pop()
 
3806
            result = ''.join(chunks)
 
3807
        return result
 
3808
 
 
3809
    def _expand_option(self, name, env, _refs):
 
3810
        if env is not None and name in env:
 
3811
            # Special case, values provided in env takes precedence over
 
3812
            # anything else
 
3813
            value = env[name]
 
3814
        else:
 
3815
            value = self.get(name, expand=False, convert=False)
 
3816
            value = self._expand_options_in_string(value, env, _refs)
 
3817
        return value
 
3818
 
 
3819
    def _get_mutable_section(self):
 
3820
        """Get the MutableSection for the Stack.
 
3821
 
 
3822
        This is where we guarantee that the mutable section is lazily loaded:
 
3823
        this means we won't load the corresponding store before setting a value
 
3824
        or deleting an option. In practice the store will often be loaded but
 
3825
        this helps catching some programming errors.
 
3826
        """
 
3827
        store = self.store
 
3828
        section = store.get_mutable_section(self.mutable_section_id)
 
3829
        return store, section
 
3830
 
 
3831
    def set(self, name, value):
 
3832
        """Set a new value for the option."""
 
3833
        store, section = self._get_mutable_section()
 
3834
        section.set(name, store.quote(value))
 
3835
        for hook in ConfigHooks['set']:
 
3836
            hook(self, name, value)
 
3837
 
 
3838
    def remove(self, name):
 
3839
        """Remove an existing option."""
 
3840
        _, section = self._get_mutable_section()
 
3841
        section.remove(name)
 
3842
        for hook in ConfigHooks['remove']:
 
3843
            hook(self, name)
 
3844
 
 
3845
    def __repr__(self):
 
3846
        # Mostly for debugging use
 
3847
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
 
3848
 
 
3849
    def _get_overrides(self):
 
3850
        # FIXME: Hack around library_state.initialize never called
 
3851
        if bzrlib.global_state is not None:
 
3852
            return bzrlib.global_state.cmdline_overrides.get_sections()
 
3853
        return []
 
3854
 
 
3855
    def get_shared_store(self, store, state=None):
 
3856
        """Get a known shared store.
 
3857
 
 
3858
        Store urls uniquely identify them and are used to ensure a single copy
 
3859
        is shared across all users.
 
3860
 
 
3861
        :param store: The store known to the caller.
 
3862
 
 
3863
        :param state: The library state where the known stores are kept.
 
3864
 
 
3865
        :returns: The store received if it's not a known one, an already known
 
3866
            otherwise.
 
3867
        """
 
3868
        if state is None:
 
3869
            state = bzrlib.global_state
 
3870
        if state is None:
 
3871
            global _shared_stores_at_exit_installed
 
3872
            stores = _shared_stores
 
3873
            def save_config_changes():
 
3874
                for k, store in stores.iteritems():
 
3875
                    store.save_changes()
 
3876
            if not _shared_stores_at_exit_installed:
 
3877
                # FIXME: Ugly hack waiting for library_state to always be
 
3878
                # available. -- vila 20120731
 
3879
                import atexit
 
3880
                atexit.register(save_config_changes)
 
3881
                _shared_stores_at_exit_installed = True
 
3882
        else:
 
3883
            stores = state.config_stores
 
3884
        url = store.external_url()
 
3885
        try:
 
3886
            return stores[url]
 
3887
        except KeyError:
 
3888
            stores[url] = store
 
3889
            return store
 
3890
 
 
3891
 
 
3892
class MemoryStack(Stack):
 
3893
    """A configuration stack defined from a string.
 
3894
 
 
3895
    This is mainly intended for tests and requires no disk resources.
 
3896
    """
 
3897
 
 
3898
    def __init__(self, content=None):
 
3899
        """Create an in-memory stack from a given content.
 
3900
 
 
3901
        It uses a single store based on configobj and support reading and
 
3902
        writing options.
 
3903
 
 
3904
        :param content: The initial content of the store. If None, the store is
 
3905
            not loaded and ``_load_from_string`` can and should be used if
 
3906
            needed.
 
3907
        """
 
3908
        store = IniFileStore()
 
3909
        if content is not None:
 
3910
            store._load_from_string(content)
 
3911
        super(MemoryStack, self).__init__(
 
3912
            [store.get_sections], store)
 
3913
 
 
3914
 
 
3915
class _CompatibleStack(Stack):
 
3916
    """Place holder for compatibility with previous design.
 
3917
 
 
3918
    This is intended to ease the transition from the Config-based design to the
 
3919
    Stack-based design and should not be used nor relied upon by plugins.
 
3920
 
 
3921
    One assumption made here is that the daughter classes will all use Stores
 
3922
    derived from LockableIniFileStore).
 
3923
 
 
3924
    It implements set() and remove () by re-loading the store before applying
 
3925
    the modification and saving it.
 
3926
 
 
3927
    The long term plan being to implement a single write by store to save
 
3928
    all modifications, this class should not be used in the interim.
 
3929
    """
 
3930
 
 
3931
    def set(self, name, value):
 
3932
        # Force a reload
 
3933
        self.store.unload()
 
3934
        super(_CompatibleStack, self).set(name, value)
 
3935
        # Force a write to persistent storage
 
3936
        self.store.save()
 
3937
 
 
3938
    def remove(self, name):
 
3939
        # Force a reload
 
3940
        self.store.unload()
 
3941
        super(_CompatibleStack, self).remove(name)
 
3942
        # Force a write to persistent storage
 
3943
        self.store.save()
 
3944
 
 
3945
 
 
3946
class GlobalStack(Stack):
 
3947
    """Global options only stack.
 
3948
 
 
3949
    The following sections are queried:
 
3950
 
 
3951
    * command-line overrides,
 
3952
 
 
3953
    * the 'DEFAULT' section in bazaar.conf
 
3954
 
 
3955
    This stack will use the ``DEFAULT`` section in bazaar.conf as its
 
3956
    MutableSection.
 
3957
    """
 
3958
 
 
3959
    def __init__(self):
 
3960
        gstore = self.get_shared_store(GlobalStore())
 
3961
        super(GlobalStack, self).__init__(
 
3962
            [self._get_overrides,
 
3963
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3964
            gstore, mutable_section_id='DEFAULT')
 
3965
 
 
3966
 
 
3967
class LocationStack(Stack):
 
3968
    """Per-location options falling back to global options stack.
 
3969
 
 
3970
 
 
3971
    The following sections are queried:
 
3972
 
 
3973
    * command-line overrides,
 
3974
 
 
3975
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3976
      defined by the number of path components in the section glob, higher
 
3977
      numbers first (from most specific section to most generic).
 
3978
 
 
3979
    * the 'DEFAULT' section in bazaar.conf
 
3980
 
 
3981
    This stack will use the ``location`` section in locations.conf as its
 
3982
    MutableSection.
 
3983
    """
 
3984
 
 
3985
    def __init__(self, location):
 
3986
        """Make a new stack for a location and global configuration.
 
3987
 
 
3988
        :param location: A URL prefix to """
 
3989
        lstore = self.get_shared_store(LocationStore())
 
3990
        if location.startswith('file://'):
 
3991
            location = urlutils.local_path_from_url(location)
 
3992
        gstore = self.get_shared_store(GlobalStore())
 
3993
        super(LocationStack, self).__init__(
 
3994
            [self._get_overrides,
 
3995
             LocationMatcher(lstore, location).get_sections,
 
3996
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3997
            lstore, mutable_section_id=location)
 
3998
 
 
3999
 
 
4000
class BranchStack(Stack):
 
4001
    """Per-location options falling back to branch then global options stack.
 
4002
 
 
4003
    The following sections are queried:
 
4004
 
 
4005
    * command-line overrides,
 
4006
 
 
4007
    * the sections matching ``location`` in ``locations.conf``, the order being
 
4008
      defined by the number of path components in the section glob, higher
 
4009
      numbers first (from most specific section to most generic),
 
4010
 
 
4011
    * the no-name section in branch.conf,
 
4012
 
 
4013
    * the ``DEFAULT`` section in ``bazaar.conf``.
 
4014
 
 
4015
    This stack will use the no-name section in ``branch.conf`` as its
 
4016
    MutableSection.
 
4017
    """
 
4018
 
 
4019
    def __init__(self, branch):
 
4020
        lstore = self.get_shared_store(LocationStore())
 
4021
        bstore = branch._get_config_store()
 
4022
        gstore = self.get_shared_store(GlobalStore())
 
4023
        super(BranchStack, self).__init__(
 
4024
            [self._get_overrides,
 
4025
             LocationMatcher(lstore, branch.base).get_sections,
 
4026
             NameMatcher(bstore, None).get_sections,
 
4027
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
4028
            bstore)
 
4029
        self.branch = branch
 
4030
 
 
4031
    def lock_write(self, token=None):
 
4032
        return self.branch.lock_write(token)
 
4033
 
 
4034
    def unlock(self):
 
4035
        return self.branch.unlock()
 
4036
 
 
4037
    @needs_write_lock
 
4038
    def set(self, name, value):
 
4039
        super(BranchStack, self).set(name, value)
 
4040
        # Unlocking the branch will trigger a store.save_changes() so the last
 
4041
        # unlock saves all the changes.
 
4042
 
 
4043
    @needs_write_lock
 
4044
    def remove(self, name):
 
4045
        super(BranchStack, self).remove(name)
 
4046
        # Unlocking the branch will trigger a store.save_changes() so the last
 
4047
        # unlock saves all the changes.
 
4048
 
 
4049
 
 
4050
class RemoteControlStack(Stack):
 
4051
    """Remote control-only options stack."""
 
4052
 
 
4053
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
4054
    # with the stack used for remote bzr dirs. RemoteControlStack only uses
 
4055
    # control.conf and is used only for stack options.
 
4056
 
 
4057
    def __init__(self, bzrdir):
 
4058
        cstore = bzrdir._get_config_store()
 
4059
        super(RemoteControlStack, self).__init__(
 
4060
            [NameMatcher(cstore, None).get_sections],
 
4061
            cstore)
 
4062
        self.bzrdir = bzrdir
 
4063
 
 
4064
 
 
4065
class BranchOnlyStack(Stack):
 
4066
    """Branch-only options stack."""
 
4067
 
 
4068
    # FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
 
4069
    # stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
 
4070
    # -- vila 2011-12-16
 
4071
 
 
4072
    def __init__(self, branch):
 
4073
        bstore = branch._get_config_store()
 
4074
        super(BranchOnlyStack, self).__init__(
 
4075
            [NameMatcher(bstore, None).get_sections],
 
4076
            bstore)
 
4077
        self.branch = branch
 
4078
 
 
4079
    def lock_write(self, token=None):
 
4080
        return self.branch.lock_write(token)
 
4081
 
 
4082
    def unlock(self):
 
4083
        return self.branch.unlock()
 
4084
 
 
4085
    @needs_write_lock
 
4086
    def set(self, name, value):
 
4087
        super(BranchOnlyStack, self).set(name, value)
 
4088
        # Force a write to persistent storage
 
4089
        self.store.save_changes()
 
4090
 
 
4091
    @needs_write_lock
 
4092
    def remove(self, name):
 
4093
        super(BranchOnlyStack, self).remove(name)
 
4094
        # Force a write to persistent storage
 
4095
        self.store.save_changes()
 
4096
 
 
4097
 
 
4098
class cmd_config(commands.Command):
 
4099
    __doc__ = """Display, set or remove a configuration option.
 
4100
 
 
4101
    Display the active value for option NAME.
 
4102
 
 
4103
    If --all is specified, NAME is interpreted as a regular expression and all
 
4104
    matching options are displayed mentioning their scope and without resolving
 
4105
    option references in the value). The active value that bzr will take into
 
4106
    account is the first one displayed for each option.
 
4107
 
 
4108
    If NAME is not given, --all .* is implied (all options are displayed for the
 
4109
    current scope).
 
4110
 
 
4111
    Setting a value is achieved by using NAME=value without spaces. The value
 
4112
    is set in the most relevant scope and can be checked by displaying the
 
4113
    option again.
 
4114
 
 
4115
    Removing a value is achieved by using --remove NAME.
 
4116
    """
 
4117
 
 
4118
    takes_args = ['name?']
 
4119
 
 
4120
    takes_options = [
 
4121
        'directory',
 
4122
        # FIXME: This should be a registry option so that plugins can register
 
4123
        # their own config files (or not) and will also address
 
4124
        # http://pad.lv/788991 -- vila 20101115
 
4125
        commands.Option('scope', help='Reduce the scope to the specified'
 
4126
                        ' configuration file.',
 
4127
                        type=unicode),
 
4128
        commands.Option('all',
 
4129
            help='Display all the defined values for the matching options.',
 
4130
            ),
 
4131
        commands.Option('remove', help='Remove the option from'
 
4132
                        ' the configuration file.'),
 
4133
        ]
 
4134
 
 
4135
    _see_also = ['configuration']
 
4136
 
 
4137
    @commands.display_command
 
4138
    def run(self, name=None, all=False, directory=None, scope=None,
 
4139
            remove=False):
 
4140
        if directory is None:
 
4141
            directory = '.'
 
4142
        directory = directory_service.directories.dereference(directory)
 
4143
        directory = urlutils.normalize_url(directory)
 
4144
        if remove and all:
 
4145
            raise errors.BzrError(
 
4146
                '--all and --remove are mutually exclusive.')
 
4147
        elif remove:
 
4148
            # Delete the option in the given scope
 
4149
            self._remove_config_option(name, directory, scope)
 
4150
        elif name is None:
 
4151
            # Defaults to all options
 
4152
            self._show_matching_options('.*', directory, scope)
 
4153
        else:
 
4154
            try:
 
4155
                name, value = name.split('=', 1)
 
4156
            except ValueError:
 
4157
                # Display the option(s) value(s)
 
4158
                if all:
 
4159
                    self._show_matching_options(name, directory, scope)
 
4160
                else:
 
4161
                    self._show_value(name, directory, scope)
 
4162
            else:
 
4163
                if all:
 
4164
                    raise errors.BzrError(
 
4165
                        'Only one option can be set.')
 
4166
                # Set the option value
 
4167
                self._set_config_option(name, value, directory, scope)
 
4168
 
 
4169
    def _get_stack(self, directory, scope=None, write_access=False):
 
4170
        """Get the configuration stack specified by ``directory`` and ``scope``.
 
4171
 
 
4172
        :param directory: Where the configurations are derived from.
 
4173
 
 
4174
        :param scope: A specific config to start from.
 
4175
 
 
4176
        :param write_access: Whether a write access to the stack will be
 
4177
            attempted.
 
4178
        """
 
4179
        # FIXME: scope should allow access to plugin-specific stacks (even
 
4180
        # reduced to the plugin-specific store), related to
 
4181
        # http://pad.lv/788991 -- vila 2011-11-15
 
4182
        if scope is not None:
 
4183
            if scope == 'bazaar':
 
4184
                return GlobalStack()
 
4185
            elif scope == 'locations':
 
4186
                return LocationStack(directory)
 
4187
            elif scope == 'branch':
 
4188
                (_, br, _) = (
 
4189
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4190
                        directory))
 
4191
                if write_access:
 
4192
                    self.add_cleanup(br.lock_write().unlock)
 
4193
                return br.get_config_stack()
 
4194
            raise errors.NoSuchConfig(scope)
 
4195
        else:
 
4196
            try:
 
4197
                (_, br, _) = (
 
4198
                    controldir.ControlDir.open_containing_tree_or_branch(
 
4199
                        directory))
 
4200
                if write_access:
 
4201
                    self.add_cleanup(br.lock_write().unlock)
 
4202
                return br.get_config_stack()
 
4203
            except errors.NotBranchError:
 
4204
                return LocationStack(directory)
 
4205
 
 
4206
    def _quote_multiline(self, value):
 
4207
        if '\n' in value:
 
4208
            value = '"""' + value + '"""'
 
4209
        return value
 
4210
 
 
4211
    def _show_value(self, name, directory, scope):
 
4212
        conf = self._get_stack(directory, scope)
 
4213
        value = conf.get(name, expand=True, convert=False)
 
4214
        if value is not None:
 
4215
            # Quote the value appropriately
 
4216
            value = self._quote_multiline(value)
 
4217
            self.outf.write('%s\n' % (value,))
 
4218
        else:
 
4219
            raise errors.NoSuchConfigOption(name)
 
4220
 
 
4221
    def _show_matching_options(self, name, directory, scope):
 
4222
        name = lazy_regex.lazy_compile(name)
 
4223
        # We want any error in the regexp to be raised *now* so we need to
 
4224
        # avoid the delay introduced by the lazy regexp.  But, we still do
 
4225
        # want the nicer errors raised by lazy_regex.
 
4226
        name._compile_and_collapse()
 
4227
        cur_store_id = None
 
4228
        cur_section = None
 
4229
        conf = self._get_stack(directory, scope)
 
4230
        for store, section in conf.iter_sections():
 
4231
            for oname in section.iter_option_names():
 
4232
                if name.search(oname):
 
4233
                    if cur_store_id != store.id:
 
4234
                        # Explain where the options are defined
 
4235
                        self.outf.write('%s:\n' % (store.id,))
 
4236
                        cur_store_id = store.id
 
4237
                        cur_section = None
 
4238
                    if (section.id is not None and cur_section != section.id):
 
4239
                        # Display the section id as it appears in the store
 
4240
                        # (None doesn't appear by definition)
 
4241
                        self.outf.write('  [%s]\n' % (section.id,))
 
4242
                        cur_section = section.id
 
4243
                    value = section.get(oname, expand=False)
 
4244
                    # Quote the value appropriately
 
4245
                    value = self._quote_multiline(value)
 
4246
                    self.outf.write('  %s = %s\n' % (oname, value))
 
4247
 
 
4248
    def _set_config_option(self, name, value, directory, scope):
 
4249
        conf = self._get_stack(directory, scope, write_access=True)
 
4250
        conf.set(name, value)
 
4251
 
 
4252
    def _remove_config_option(self, name, directory, scope):
 
4253
        if name is None:
 
4254
            raise errors.BzrCommandError(
 
4255
                '--remove expects an option to remove.')
 
4256
        conf = self._get_stack(directory, scope, write_access=True)
 
4257
        try:
 
4258
            conf.remove(name)
 
4259
        except KeyError:
 
4260
            raise errors.NoSuchConfigOption(name)
 
4261
 
 
4262
 
 
4263
# Test registries
 
4264
#
 
4265
# We need adapters that can build a Store or a Stack in a test context. Test
 
4266
# classes, based on TestCaseWithTransport, can use the registry to parametrize
 
4267
# themselves. The builder will receive a test instance and should return a
 
4268
# ready-to-use store or stack.  Plugins that define new store/stacks can also
 
4269
# register themselves here to be tested against the tests defined in
 
4270
# bzrlib.tests.test_config. Note that the builder can be called multiple times
 
4271
# for the same test.
 
4272
 
 
4273
# The registered object should be a callable receiving a test instance
 
4274
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
 
4275
# object.
 
4276
test_store_builder_registry = registry.Registry()
 
4277
 
 
4278
# The registered object should be a callable receiving a test instance
 
4279
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
 
4280
# object.
 
4281
test_stack_builder_registry = registry.Registry()