/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to breezy/config.py

  • Committer: Jelmer Vernooij
  • Date: 2017-05-21 18:10:28 UTC
  • mto: This revision was merged to the branch mainline in revision 6623.
  • Revision ID: jelmer@jelmer.uk-20170521181028-zn04pdfw0od9hfj3
Rename brzlib => breezy.

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