← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

https://launchpad.net/bugs/524184
NEWS section template into a separate file

Show diffs side-by-side

added added

removed removed

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