/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: Martin
  • Date: 2017-06-11 14:25:56 UTC
  • mto: This revision was merged to the branch mainline in revision 6688.
  • Revision ID: gzlist@googlemail.com-20170611142556-zbxdnifdfsk9t0c8
Update rio tests to pass on Python 3

Show diffs side-by-side

added added

removed removed

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