/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: John Ferlito
  • Date: 2009-09-02 04:31:45 UTC
  • mto: (4665.7.1 serve-init)
  • mto: This revision was merged to the branch mainline in revision 4913.
  • Revision ID: johnf@inodes.org-20090902043145-gxdsfw03ilcwbyn5
Add a debian init script for bzr --serve

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