/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/config.py

  • Committer: Jelmer Vernooij
  • Date: 2017-06-13 02:58:21 UTC
  • mto: This revision was merged to the branch mainline in revision 6694.
  • Revision ID: jelmer@jelmer.uk-20170613025821-8a45viqutx5obr18
Drop Python < 2.5 support.

Show diffs side-by-side

added added

removed removed

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