/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-27 00:10:52 UTC
  • mto: This revision was merged to the branch mainline in revision 6721.
  • Revision ID: gzlist@googlemail.com-20170627001052-o70zln144nmwhamo
Switch c_api helpers for _static_tuple_c to capsules

Show diffs side-by-side

added added

removed removed

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