/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: Breezy landing bot
  • Author(s): Jelmer Vernooij
  • Date: 2018-11-16 11:31:40 UTC
  • mfrom: (7143.12.3 annotated-tags)
  • Revision ID: breezy.the.bot@gmail.com-20181116113140-618u04763u0dyxnh
Fix fetching of revisions that are referenced by annotated tags.

Merged from https://code.launchpad.net/~jelmer/brz/annotated-tags/+merge/358536

Show diffs side-by-side

added added

removed removed

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