/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-02-04 01:01:24 UTC
  • mto: This revision was merged to the branch mainline in revision 7268.
  • Revision ID: jelmer@jelmer.uk-20190204010124-ni0i4qc6f5tnbvux
Fix source tests.

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