/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/config.py

  • Committer: Jelmer Vernooij
  • Date: 2018-07-17 21:20:55 UTC
  • mto: (7045.3.3 python3-r)
  • mto: This revision was merged to the branch mainline in revision 7050.
  • Revision ID: jelmer@jelmer.uk-20180717212055-apkv1s70oo6wpi6o
Fix a few more tests.

Show diffs side-by-side

added added

removed removed

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