/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 bzrlib/config.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

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