/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: 2018-11-11 04:08:32 UTC
  • mto: (7143.16.20 even-more-cleanups)
  • mto: This revision was merged to the branch mainline in revision 7175.
  • Revision ID: jelmer@jelmer.uk-20181111040832-nsljjynzzwmznf3h
Run autopep8.

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