/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-07-15 13:23:08 UTC
  • mto: This revision was merged to the branch mainline in revision 6738.
  • Revision ID: jelmer@jelmer.uk-20170715132308-1rcazg0fb2pdax0w
Move urlutils errors.

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