/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-07-24 01:09:25 UTC
  • mfrom: (6740 trunk)
  • mto: This revision was merged to the branch mainline in revision 6743.
  • Revision ID: jelmer@jelmer.uk-20170724010925-nted35vp0ufbs3p2
Merge trunk.

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