/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-10 01:57:00 UTC
  • mto: This revision was merged to the branch mainline in revision 6679.
  • Revision ID: gzlist@googlemail.com-20170610015700-o3xeuyaqry2obiay
Go back to native str for urls and many other py3 changes

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