/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: 2017-08-26 18:51:21 UTC
  • mto: This revision was merged to the branch mainline in revision 6773.
  • Revision ID: jelmer@jelmer.uk-20170826185121-v6f5y9t77l4eghqo
Remove saved_state.

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