/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/config.py

  • Committer: Jelmer Vernooij
  • Date: 2019-06-21 11:21:12 UTC
  • mto: This revision was merged to the branch mainline in revision 7352.
  • Revision ID: jelmer@jelmer.uk-20190621112112-v0uorrdgqib5z1ur
For python 2.x, install sphinx 1.8.5. Newer versions don't support python 2.

Show diffs side-by-side

added added

removed removed

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