← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

(jelmer) Remove config argument from VersionedFileRepository.add_revision()
 (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/config.py
1
 
# Copyright (C) 2005, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#            and others
4
4
#
14
14
#
15
15
# You should have received a copy of the GNU General Public License
16
16
# along with this program; if not, write to the Free Software
17
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
18
 
19
19
"""Configuration that affects the behaviour of Bazaar.
20
20
 
29
29
create_signatures=always|never|when-required(default)
30
30
gpg_signing_command=name-of-program
31
31
log_format=name-of-format
 
32
validate_signatures_in_log=true|false(default)
 
33
acceptable_keys=pattern1,pattern2
 
34
gpg_signing_key=amy@example.com
32
35
 
33
36
in locations.conf, you specify the url of a branch and options for it.
34
37
Wildcards may be used - * and ? as normal in shell completion. Options
37
40
[/home/robertc/source]
38
41
recurse=False|True(default)
39
42
email= as above
40
 
check_signatures= as above 
 
43
check_signatures= as above
41
44
create_signatures= as above.
 
45
validate_signatures_in_log=as above
 
46
acceptable_keys=as above
42
47
 
43
48
explanation of options
44
49
----------------------
45
50
editor - this option sets the pop up editor to use during commits.
46
51
email - this option sets the user id bzr will use when committing.
47
 
check_signatures - this option controls whether bzr will require good gpg
48
 
                   signatures, ignore them, or check them if they are 
49
 
                   present.
50
 
create_signatures - this option controls whether bzr will always create 
51
 
                    gpg signatures, never create them, or create them if the
52
 
                    branch is configured to require them.
 
52
check_signatures - this option will control whether bzr will require good gpg
 
53
                   signatures, ignore them, or check them if they are
 
54
                   present.  Currently it is unused except that check_signatures
 
55
                   turns on create_signatures.
 
56
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.
53
60
log_format - this option sets the default log format.  Possible values are
54
61
             long, short, line, or a plugin can register new formats.
 
62
validate_signatures_in_log - show GPG signature validity in log output
 
63
acceptable_keys - comma separated list of key patterns acceptable for
 
64
                  verify-signatures command
55
65
 
56
66
In bazaar.conf you can also define aliases in the ALIASES sections, example
57
67
 
62
72
up=pull
63
73
"""
64
74
 
 
75
from __future__ import absolute_import
 
76
 
65
77
import os
66
78
import sys
67
79
 
 
80
import bzrlib
 
81
from bzrlib.decorators import needs_write_lock
68
82
from bzrlib.lazy_import import lazy_import
69
83
lazy_import(globals(), """
70
 
import errno
71
 
from fnmatch import fnmatch
 
84
import fnmatch
72
85
import re
73
 
from StringIO import StringIO
 
86
from cStringIO import StringIO
74
87
 
75
 
import bzrlib
76
88
from bzrlib import (
 
89
    atomicfile,
 
90
    controldir,
 
91
    debug,
77
92
    errors,
 
93
    lazy_regex,
 
94
    library_state,
 
95
    lockdir,
78
96
    mail_client,
 
97
    mergetools,
79
98
    osutils,
80
99
    symbol_versioning,
81
100
    trace,
 
101
    transport,
 
102
    ui,
82
103
    urlutils,
83
104
    win32utils,
84
105
    )
85
 
import bzrlib.util.configobj.configobj as configobj
 
106
from bzrlib.i18n import gettext
 
107
from bzrlib.util.configobj import configobj
86
108
""")
87
 
 
88
 
from bzrlib.trace import mutter, warning
 
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
    )
89
119
 
90
120
 
91
121
CHECK_IF_POSSIBLE=0
122
152
STORE_GLOBAL = 4
123
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
 
125
179
class ConfigObj(configobj.ConfigObj):
126
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
 
127
187
    def get_bool(self, section, key):
128
188
        return self[section].as_bool(key)
129
189
 
137
197
        return self[section][name]
138
198
 
139
199
 
 
200
# FIXME: Until we can guarantee that each config file is loaded once and
 
201
# only once for a given bzrlib session, we don't want to re-read the file every
 
202
# time we query for an option so we cache the value (bad ! watch out for tests
 
203
# needing to restore the proper value). -- vila 20110219
 
204
_expand_default_value = None
 
205
def _get_expand_default_value():
 
206
    global _expand_default_value
 
207
    if _expand_default_value is not None:
 
208
        return _expand_default_value
 
209
    conf = GlobalConfig()
 
210
    # Note that we must not use None for the expand value below or we'll run
 
211
    # into infinite recursion. Using False really would be quite silly ;)
 
212
    expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
 
213
    if expand is None:
 
214
        # This is an opt-in feature, you *really* need to clearly say you want
 
215
        # to activate it !
 
216
        expand = False
 
217
    _expand_default_value = expand
 
218
    return expand
 
219
 
 
220
 
140
221
class Config(object):
141
222
    """A configuration policy - what username, editor, gpg needs etc."""
142
223
 
 
224
    def __init__(self):
 
225
        super(Config, self).__init__()
 
226
 
 
227
    def config_id(self):
 
228
        """Returns a unique ID for the config."""
 
229
        raise NotImplementedError(self.config_id)
 
230
 
 
231
    @deprecated_method(deprecated_in((2, 4, 0)))
143
232
    def get_editor(self):
144
233
        """Get the users pop up editor."""
145
234
        raise NotImplementedError
146
235
 
 
236
    def get_change_editor(self, old_tree, new_tree):
 
237
        from bzrlib import diff
 
238
        cmd = self._get_change_editor()
 
239
        if cmd is None:
 
240
            return None
 
241
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
 
242
                                             sys.stdout)
 
243
 
147
244
    def get_mail_client(self):
148
245
        """Get a mail client to use"""
149
246
        selected_client = self.get_user_option('mail_client')
 
247
        _registry = mail_client.mail_client_registry
150
248
        try:
151
 
            mail_client_class = {
152
 
                None: mail_client.DefaultMail,
153
 
                'default': mail_client.DefaultMail,
154
 
                'editor': mail_client.Editor,
155
 
                'thunderbird': mail_client.Thunderbird,
156
 
                'evolution': mail_client.Evolution,
157
 
                'mapi': mail_client.MAPIClient,
158
 
                'xdg-email': mail_client.XDGEmail,
159
 
                'kmail': mail_client.KMail,
160
 
            }[selected_client]
 
249
            mail_client_class = _registry.get(selected_client)
161
250
        except KeyError:
162
251
            raise errors.UnknownMailClient(selected_client)
163
252
        return mail_client_class(self)
168
257
    def _get_signing_policy(self):
169
258
        """Template method to override signature creation policy."""
170
259
 
 
260
    option_ref_re = None
 
261
 
 
262
    def expand_options(self, string, env=None):
 
263
        """Expand option references in the string in the configuration context.
 
264
 
 
265
        :param string: The string containing option to expand.
 
266
 
 
267
        :param env: An option dict defining additional configuration options or
 
268
            overriding existing ones.
 
269
 
 
270
        :returns: The expanded string.
 
271
        """
 
272
        return self._expand_options_in_string(string, env)
 
273
 
 
274
    def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
 
275
        """Expand options in  a list of strings in the configuration context.
 
276
 
 
277
        :param slist: A list of strings.
 
278
 
 
279
        :param env: An option dict defining additional configuration options or
 
280
            overriding existing ones.
 
281
 
 
282
        :param _ref_stack: Private list containing the options being
 
283
            expanded to detect loops.
 
284
 
 
285
        :returns: The flatten list of expanded strings.
 
286
        """
 
287
        # expand options in each value separately flattening lists
 
288
        result = []
 
289
        for s in slist:
 
290
            value = self._expand_options_in_string(s, env, _ref_stack)
 
291
            if isinstance(value, list):
 
292
                result.extend(value)
 
293
            else:
 
294
                result.append(value)
 
295
        return result
 
296
 
 
297
    def _expand_options_in_string(self, string, env=None, _ref_stack=None):
 
298
        """Expand options in the string in the configuration context.
 
299
 
 
300
        :param string: The string to be expanded.
 
301
 
 
302
        :param env: An option dict defining additional configuration options or
 
303
            overriding existing ones.
 
304
 
 
305
        :param _ref_stack: Private list containing the options being
 
306
            expanded to detect loops.
 
307
 
 
308
        :returns: The expanded string.
 
309
        """
 
310
        if string is None:
 
311
            # Not much to expand there
 
312
            return None
 
313
        if _ref_stack is None:
 
314
            # What references are currently resolved (to detect loops)
 
315
            _ref_stack = []
 
316
        if self.option_ref_re is None:
 
317
            # We want to match the most embedded reference first (i.e. for
 
318
            # '{{foo}}' we will get '{foo}',
 
319
            # for '{bar{baz}}' we will get '{baz}'
 
320
            self.option_ref_re = re.compile('({[^{}]+})')
 
321
        result = string
 
322
        # We need to iterate until no more refs appear ({{foo}} will need two
 
323
        # iterations for example).
 
324
        while True:
 
325
            raw_chunks = self.option_ref_re.split(result)
 
326
            if len(raw_chunks) == 1:
 
327
                # Shorcut the trivial case: no refs
 
328
                return result
 
329
            chunks = []
 
330
            list_value = False
 
331
            # Split will isolate refs so that every other chunk is a ref
 
332
            chunk_is_ref = False
 
333
            for chunk in raw_chunks:
 
334
                if not chunk_is_ref:
 
335
                    if chunk:
 
336
                        # Keep only non-empty strings (or we get bogus empty
 
337
                        # slots when a list value is involved).
 
338
                        chunks.append(chunk)
 
339
                    chunk_is_ref = True
 
340
                else:
 
341
                    name = chunk[1:-1]
 
342
                    if name in _ref_stack:
 
343
                        raise errors.OptionExpansionLoop(string, _ref_stack)
 
344
                    _ref_stack.append(name)
 
345
                    value = self._expand_option(name, env, _ref_stack)
 
346
                    if value is None:
 
347
                        raise errors.ExpandingUnknownOption(name, string)
 
348
                    if isinstance(value, list):
 
349
                        list_value = True
 
350
                        chunks.extend(value)
 
351
                    else:
 
352
                        chunks.append(value)
 
353
                    _ref_stack.pop()
 
354
                    chunk_is_ref = False
 
355
            if list_value:
 
356
                # Once a list appears as the result of an expansion, all
 
357
                # callers will get a list result. This allows a consistent
 
358
                # behavior even when some options in the expansion chain
 
359
                # defined as strings (no comma in their value) but their
 
360
                # expanded value is a list.
 
361
                return self._expand_options_in_list(chunks, env, _ref_stack)
 
362
            else:
 
363
                result = ''.join(chunks)
 
364
        return result
 
365
 
 
366
    def _expand_option(self, name, env, _ref_stack):
 
367
        if env is not None and name in env:
 
368
            # Special case, values provided in env takes precedence over
 
369
            # anything else
 
370
            value = env[name]
 
371
        else:
 
372
            # FIXME: This is a limited implementation, what we really need is a
 
373
            # way to query the bzr config for the value of an option,
 
374
            # respecting the scope rules (That is, once we implement fallback
 
375
            # configs, getting the option value should restart from the top
 
376
            # config, not the current one) -- vila 20101222
 
377
            value = self.get_user_option(name, expand=False)
 
378
            if isinstance(value, list):
 
379
                value = self._expand_options_in_list(value, env, _ref_stack)
 
380
            else:
 
381
                value = self._expand_options_in_string(value, env, _ref_stack)
 
382
        return value
 
383
 
171
384
    def _get_user_option(self, option_name):
172
385
        """Template method to provide a user option."""
173
386
        return None
174
387
 
175
 
    def get_user_option(self, option_name):
176
 
        """Get a generic option - no special process, no default."""
177
 
        return self._get_user_option(option_name)
178
 
 
 
388
    def get_user_option(self, option_name, expand=None):
 
389
        """Get a generic option - no special process, no default.
 
390
 
 
391
        :param option_name: The queried option.
 
392
 
 
393
        :param expand: Whether options references should be expanded.
 
394
 
 
395
        :returns: The value of the option.
 
396
        """
 
397
        if expand is None:
 
398
            expand = _get_expand_default_value()
 
399
        value = self._get_user_option(option_name)
 
400
        if expand:
 
401
            if isinstance(value, list):
 
402
                value = self._expand_options_in_list(value)
 
403
            elif isinstance(value, dict):
 
404
                trace.warning('Cannot expand "%s":'
 
405
                              ' Dicts do not support option expansion'
 
406
                              % (option_name,))
 
407
            else:
 
408
                value = self._expand_options_in_string(value)
 
409
        for hook in OldConfigHooks['get']:
 
410
            hook(self, option_name, value)
 
411
        return value
 
412
 
 
413
    def get_user_option_as_bool(self, option_name, expand=None, default=None):
 
414
        """Get a generic option as a boolean.
 
415
 
 
416
        :param expand: Allow expanding references to other config values.
 
417
        :param default: Default value if nothing is configured
 
418
        :return None if the option doesn't exist or its value can't be
 
419
            interpreted as a boolean. Returns True or False otherwise.
 
420
        """
 
421
        s = self.get_user_option(option_name, expand=expand)
 
422
        if s is None:
 
423
            # The option doesn't exist
 
424
            return default
 
425
        val = ui.bool_from_string(s)
 
426
        if val is None:
 
427
            # The value can't be interpreted as a boolean
 
428
            trace.warning('Value "%s" is not a boolean for "%s"',
 
429
                          s, option_name)
 
430
        return val
 
431
 
 
432
    def get_user_option_as_list(self, option_name, expand=None):
 
433
        """Get a generic option as a list - no special process, no default.
 
434
 
 
435
        :return None if the option doesn't exist. Returns the value as a list
 
436
            otherwise.
 
437
        """
 
438
        l = self.get_user_option(option_name, expand=expand)
 
439
        if isinstance(l, (str, unicode)):
 
440
            # A single value, most probably the user forgot (or didn't care to
 
441
            # add) the final ','
 
442
            l = [l]
 
443
        return l
 
444
 
 
445
    @deprecated_method(deprecated_in((2, 5, 0)))
 
446
    def get_user_option_as_int_from_SI(self, option_name, default=None):
 
447
        """Get a generic option from a human readable size in SI units, e.g 10MB
 
448
 
 
449
        Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
450
        by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
451
        pedantic.
 
452
 
 
453
        :return Integer, expanded to its base-10 value if a proper SI unit is 
 
454
            found. If the option doesn't exist, or isn't a value in 
 
455
            SI units, return default (which defaults to None)
 
456
        """
 
457
        val = self.get_user_option(option_name)
 
458
        if isinstance(val, list):
 
459
            val = val[0]
 
460
        if val is None:
 
461
            val = default
 
462
        else:
 
463
            p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
 
464
            try:
 
465
                m = p.match(val)
 
466
                if m is not None:
 
467
                    val = int(m.group(1))
 
468
                    if m.group(2) is not None:
 
469
                        if m.group(2).lower() == 'k':
 
470
                            val *= 10**3
 
471
                        elif m.group(2).lower() == 'm':
 
472
                            val *= 10**6
 
473
                        elif m.group(2).lower() == 'g':
 
474
                            val *= 10**9
 
475
                else:
 
476
                    ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
 
477
                                               ' value {1!r} is not an SI unit.').format(
 
478
                                                option_name, val))
 
479
                    val = default
 
480
            except TypeError:
 
481
                val = default
 
482
        return val
 
483
 
 
484
    @deprecated_method(deprecated_in((2, 5, 0)))
179
485
    def gpg_signing_command(self):
180
486
        """What program should be used to sign signatures?"""
181
487
        result = self._gpg_signing_command()
187
493
        """See gpg_signing_command()."""
188
494
        return None
189
495
 
 
496
    @deprecated_method(deprecated_in((2, 5, 0)))
190
497
    def log_format(self):
191
498
        """What log format should be used"""
192
499
        result = self._log_format()
198
505
        """See log_format()."""
199
506
        return None
200
507
 
201
 
    def __init__(self):
202
 
        super(Config, self).__init__()
203
 
 
 
508
    def validate_signatures_in_log(self):
 
509
        """Show GPG signature validity in log"""
 
510
        result = self._validate_signatures_in_log()
 
511
        if result == "true":
 
512
            result = True
 
513
        else:
 
514
            result = False
 
515
        return result
 
516
 
 
517
    def _validate_signatures_in_log(self):
 
518
        """See validate_signatures_in_log()."""
 
519
        return None
 
520
 
 
521
    @deprecated_method(deprecated_in((2, 5, 0)))
 
522
    def acceptable_keys(self):
 
523
        """Comma separated list of key patterns acceptable to 
 
524
        verify-signatures command"""
 
525
        result = self._acceptable_keys()
 
526
        return result
 
527
 
 
528
    def _acceptable_keys(self):
 
529
        """See acceptable_keys()."""
 
530
        return None
 
531
 
 
532
    @deprecated_method(deprecated_in((2, 5, 0)))
204
533
    def post_commit(self):
205
534
        """An ordered list of python functions to call.
206
535
 
218
547
 
219
548
    def username(self):
220
549
        """Return email-style username.
221
 
    
 
550
 
222
551
        Something similar to 'Martin Pool <mbp@sourcefrog.net>'
223
 
        
224
 
        $BZR_EMAIL can be set to override this (as well as the
225
 
        deprecated $BZREMAIL), then
 
552
 
 
553
        $BZR_EMAIL can be set to override this, then
226
554
        the concrete policy type is checked, and finally
227
555
        $EMAIL is examined.
228
 
        If none is found, a reasonable default is (hopefully)
229
 
        created.
230
 
    
231
 
        TODO: Check it's reasonably well-formed.
 
556
        If no username can be found, errors.NoWhoami exception is raised.
232
557
        """
233
558
        v = os.environ.get('BZR_EMAIL')
234
559
        if v:
235
 
            return v.decode(bzrlib.user_encoding)
236
 
        v = os.environ.get('BZREMAIL')
237
 
        if v:
238
 
            warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
239
 
            return v.decode(bzrlib.user_encoding)
240
 
    
 
560
            return v.decode(osutils.get_user_encoding())
241
561
        v = self._get_user_id()
242
562
        if v:
243
563
            return v
244
 
        
245
 
        v = os.environ.get('EMAIL')
246
 
        if v:
247
 
            return v.decode(bzrlib.user_encoding)
248
 
 
249
 
        name, email = _auto_user_id()
250
 
        if name:
251
 
            return '%s <%s>' % (name, email)
252
 
        else:
253
 
            return email
254
 
 
 
564
        return default_email()
 
565
 
 
566
    def ensure_username(self):
 
567
        """Raise errors.NoWhoami if username is not set.
 
568
 
 
569
        This method relies on the username() function raising the error.
 
570
        """
 
571
        self.username()
 
572
 
 
573
    @deprecated_method(deprecated_in((2, 5, 0)))
255
574
    def signature_checking(self):
256
575
        """What is the current policy for signature checking?."""
257
576
        policy = self._get_signature_checking()
259
578
            return policy
260
579
        return CHECK_IF_POSSIBLE
261
580
 
 
581
    @deprecated_method(deprecated_in((2, 5, 0)))
262
582
    def signing_policy(self):
263
583
        """What is the current policy for signature checking?."""
264
584
        policy = self._get_signing_policy()
266
586
            return policy
267
587
        return SIGN_WHEN_REQUIRED
268
588
 
 
589
    @deprecated_method(deprecated_in((2, 5, 0)))
269
590
    def signature_needed(self):
270
591
        """Is a signature needed when committing ?."""
271
592
        policy = self._get_signing_policy()
272
593
        if policy is None:
273
594
            policy = self._get_signature_checking()
274
595
            if policy is not None:
275
 
                warning("Please use create_signatures, not check_signatures "
276
 
                        "to set signing policy.")
277
 
            if policy == CHECK_ALWAYS:
278
 
                return True
 
596
                #this warning should go away once check_signatures is
 
597
                #implemented (if not before)
 
598
                trace.warning("Please use create_signatures,"
 
599
                              " not check_signatures to set signing policy.")
279
600
        elif policy == SIGN_ALWAYS:
280
601
            return True
281
602
        return False
282
603
 
 
604
    @deprecated_method(deprecated_in((2, 5, 0)))
 
605
    def gpg_signing_key(self):
 
606
        """GPG user-id to sign commits"""
 
607
        key = self.get_user_option('gpg_signing_key')
 
608
        if key == "default" or key == None:
 
609
            return self.user_email()
 
610
        else:
 
611
            return key
 
612
 
283
613
    def get_alias(self, value):
284
614
        return self._get_alias(value)
285
615
 
292
622
    def _get_nickname(self):
293
623
        return None
294
624
 
 
625
    def get_bzr_remote_path(self):
 
626
        try:
 
627
            return os.environ['BZR_REMOTE_PATH']
 
628
        except KeyError:
 
629
            path = self.get_user_option("bzr_remote_path")
 
630
            if path is None:
 
631
                path = 'bzr'
 
632
            return path
 
633
 
 
634
    def suppress_warning(self, warning):
 
635
        """Should the warning be suppressed or emitted.
 
636
 
 
637
        :param warning: The name of the warning being tested.
 
638
 
 
639
        :returns: True if the warning should be suppressed, False otherwise.
 
640
        """
 
641
        warnings = self.get_user_option_as_list('suppress_warnings')
 
642
        if warnings is None or warning not in warnings:
 
643
            return False
 
644
        else:
 
645
            return True
 
646
 
 
647
    def get_merge_tools(self):
 
648
        tools = {}
 
649
        for (oname, value, section, conf_id, parser) in self._get_options():
 
650
            if oname.startswith('bzr.mergetool.'):
 
651
                tool_name = oname[len('bzr.mergetool.'):]
 
652
                tools[tool_name] = self.get_user_option(oname)
 
653
        trace.mutter('loaded merge tools: %r' % tools)
 
654
        return tools
 
655
 
 
656
    def find_merge_tool(self, name):
 
657
        # We fake a defaults mechanism here by checking if the given name can
 
658
        # be found in the known_merge_tools if it's not found in the config.
 
659
        # This should be done through the proposed config defaults mechanism
 
660
        # when it becomes available in the future.
 
661
        command_line = (self.get_user_option('bzr.mergetool.%s' % name,
 
662
                                             expand=False)
 
663
                        or mergetools.known_merge_tools.get(name, None))
 
664
        return command_line
 
665
 
 
666
 
 
667
class _ConfigHooks(hooks.Hooks):
 
668
    """A dict mapping hook names and a list of callables for configs.
 
669
    """
 
670
 
 
671
    def __init__(self):
 
672
        """Create the default hooks.
 
673
 
 
674
        These are all empty initially, because by default nothing should get
 
675
        notified.
 
676
        """
 
677
        super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
 
678
        self.add_hook('load',
 
679
                      'Invoked when a config store is loaded.'
 
680
                      ' The signature is (store).',
 
681
                      (2, 4))
 
682
        self.add_hook('save',
 
683
                      'Invoked when a config store is saved.'
 
684
                      ' The signature is (store).',
 
685
                      (2, 4))
 
686
        # The hooks for config options
 
687
        self.add_hook('get',
 
688
                      'Invoked when a config option is read.'
 
689
                      ' The signature is (stack, name, value).',
 
690
                      (2, 4))
 
691
        self.add_hook('set',
 
692
                      'Invoked when a config option is set.'
 
693
                      ' The signature is (stack, name, value).',
 
694
                      (2, 4))
 
695
        self.add_hook('remove',
 
696
                      'Invoked when a config option is removed.'
 
697
                      ' The signature is (stack, name).',
 
698
                      (2, 4))
 
699
ConfigHooks = _ConfigHooks()
 
700
 
 
701
 
 
702
class _OldConfigHooks(hooks.Hooks):
 
703
    """A dict mapping hook names and a list of callables for configs.
 
704
    """
 
705
 
 
706
    def __init__(self):
 
707
        """Create the default hooks.
 
708
 
 
709
        These are all empty initially, because by default nothing should get
 
710
        notified.
 
711
        """
 
712
        super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
 
713
        self.add_hook('load',
 
714
                      'Invoked when a config store is loaded.'
 
715
                      ' The signature is (config).',
 
716
                      (2, 4))
 
717
        self.add_hook('save',
 
718
                      'Invoked when a config store is saved.'
 
719
                      ' The signature is (config).',
 
720
                      (2, 4))
 
721
        # The hooks for config options
 
722
        self.add_hook('get',
 
723
                      'Invoked when a config option is read.'
 
724
                      ' The signature is (config, name, value).',
 
725
                      (2, 4))
 
726
        self.add_hook('set',
 
727
                      'Invoked when a config option is set.'
 
728
                      ' The signature is (config, name, value).',
 
729
                      (2, 4))
 
730
        self.add_hook('remove',
 
731
                      'Invoked when a config option is removed.'
 
732
                      ' The signature is (config, name).',
 
733
                      (2, 4))
 
734
OldConfigHooks = _OldConfigHooks()
 
735
 
295
736
 
296
737
class IniBasedConfig(Config):
297
738
    """A configuration policy that draws from ini files."""
298
739
 
299
 
    def _get_parser(self, file=None):
 
740
    def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
 
741
                 file_name=None):
 
742
        """Base class for configuration files using an ini-like syntax.
 
743
 
 
744
        :param file_name: The configuration file path.
 
745
        """
 
746
        super(IniBasedConfig, self).__init__()
 
747
        self.file_name = file_name
 
748
        if symbol_versioning.deprecated_passed(get_filename):
 
749
            symbol_versioning.warn(
 
750
                'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
 
751
                ' Use file_name instead.',
 
752
                DeprecationWarning,
 
753
                stacklevel=2)
 
754
            if get_filename is not None:
 
755
                self.file_name = get_filename()
 
756
        else:
 
757
            self.file_name = file_name
 
758
        self._content = None
 
759
        self._parser = None
 
760
 
 
761
    @classmethod
 
762
    def from_string(cls, str_or_unicode, file_name=None, save=False):
 
763
        """Create a config object from a string.
 
764
 
 
765
        :param str_or_unicode: A string representing the file content. This will
 
766
            be utf-8 encoded.
 
767
 
 
768
        :param file_name: The configuration file path.
 
769
 
 
770
        :param _save: Whether the file should be saved upon creation.
 
771
        """
 
772
        conf = cls(file_name=file_name)
 
773
        conf._create_from_string(str_or_unicode, save)
 
774
        return conf
 
775
 
 
776
    def _create_from_string(self, str_or_unicode, save):
 
777
        self._content = StringIO(str_or_unicode.encode('utf-8'))
 
778
        # Some tests use in-memory configs, some other always need the config
 
779
        # file to exist on disk.
 
780
        if save:
 
781
            self._write_config_file()
 
782
 
 
783
    def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
300
784
        if self._parser is not None:
301
785
            return self._parser
302
 
        if file is None:
303
 
            input = self._get_filename()
 
786
        if symbol_versioning.deprecated_passed(file):
 
787
            symbol_versioning.warn(
 
788
                'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
 
789
                ' Use IniBasedConfig(_content=xxx) instead.',
 
790
                DeprecationWarning,
 
791
                stacklevel=2)
 
792
        if self._content is not None:
 
793
            co_input = self._content
 
794
        elif self.file_name is None:
 
795
            raise AssertionError('We have no content to create the config')
304
796
        else:
305
 
            input = file
 
797
            co_input = self.file_name
306
798
        try:
307
 
            self._parser = ConfigObj(input, encoding='utf-8')
 
799
            self._parser = ConfigObj(co_input, encoding='utf-8')
308
800
        except configobj.ConfigObjError, e:
309
801
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
802
        except UnicodeDecodeError:
 
803
            raise errors.ConfigContentError(self.file_name)
 
804
        # Make sure self.reload() will use the right file name
 
805
        self._parser.filename = self.file_name
 
806
        for hook in OldConfigHooks['load']:
 
807
            hook(self)
310
808
        return self._parser
311
809
 
 
810
    def reload(self):
 
811
        """Reload the config file from disk."""
 
812
        if self.file_name is None:
 
813
            raise AssertionError('We need a file name to reload the config')
 
814
        if self._parser is not None:
 
815
            self._parser.reload()
 
816
        for hook in ConfigHooks['load']:
 
817
            hook(self)
 
818
 
312
819
    def _get_matching_sections(self):
313
820
        """Return an ordered list of (section_name, extra_path) pairs.
314
821
 
325
832
        """Override this to define the section used by the config."""
326
833
        return "DEFAULT"
327
834
 
 
835
    def _get_sections(self, name=None):
 
836
        """Returns an iterator of the sections specified by ``name``.
 
837
 
 
838
        :param name: The section name. If None is supplied, the default
 
839
            configurations are yielded.
 
840
 
 
841
        :return: A tuple (name, section, config_id) for all sections that will
 
842
            be walked by user_get_option() in the 'right' order. The first one
 
843
            is where set_user_option() will update the value.
 
844
        """
 
845
        parser = self._get_parser()
 
846
        if name is not None:
 
847
            yield (name, parser[name], self.config_id())
 
848
        else:
 
849
            # No section name has been given so we fallback to the configobj
 
850
            # itself which holds the variables defined outside of any section.
 
851
            yield (None, parser, self.config_id())
 
852
 
 
853
    def _get_options(self, sections=None):
 
854
        """Return an ordered list of (name, value, section, config_id) tuples.
 
855
 
 
856
        All options are returned with their associated value and the section
 
857
        they appeared in. ``config_id`` is a unique identifier for the
 
858
        configuration file the option is defined in.
 
859
 
 
860
        :param sections: Default to ``_get_matching_sections`` if not
 
861
            specified. This gives a better control to daughter classes about
 
862
            which sections should be searched. This is a list of (name,
 
863
            configobj) tuples.
 
864
        """
 
865
        opts = []
 
866
        if sections is None:
 
867
            parser = self._get_parser()
 
868
            sections = []
 
869
            for (section_name, _) in self._get_matching_sections():
 
870
                try:
 
871
                    section = parser[section_name]
 
872
                except KeyError:
 
873
                    # This could happen for an empty file for which we define a
 
874
                    # DEFAULT section. FIXME: Force callers to provide sections
 
875
                    # instead ? -- vila 20100930
 
876
                    continue
 
877
                sections.append((section_name, section))
 
878
        config_id = self.config_id()
 
879
        for (section_name, section) in sections:
 
880
            for (name, value) in section.iteritems():
 
881
                yield (name, parser._quote(value), section_name,
 
882
                       config_id, parser)
 
883
 
328
884
    def _get_option_policy(self, section, option_name):
329
885
        """Return the policy for the given (section, option_name) pair."""
330
886
        return POLICY_NONE
331
887
 
 
888
    def _get_change_editor(self):
 
889
        return self.get_user_option('change_editor')
 
890
 
332
891
    def _get_signature_checking(self):
333
892
        """See Config._get_signature_checking."""
334
893
        policy = self._get_user_option('check_signatures')
335
894
        if policy:
336
 
            return self._string_to_signature_policy(policy)
 
895
            return signature_policy_from_unicode(policy)
337
896
 
338
897
    def _get_signing_policy(self):
339
898
        """See Config._get_signing_policy"""
340
899
        policy = self._get_user_option('create_signatures')
341
900
        if policy:
342
 
            return self._string_to_signing_policy(policy)
 
901
            return signing_policy_from_unicode(policy)
343
902
 
344
903
    def _get_user_id(self):
345
904
        """Get the user id from the 'email' key in the current section."""
378
937
        """See Config.log_format."""
379
938
        return self._get_user_option('log_format')
380
939
 
381
 
    def __init__(self, get_filename):
382
 
        super(IniBasedConfig, self).__init__()
383
 
        self._get_filename = get_filename
384
 
        self._parser = None
385
 
        
 
940
    def _validate_signatures_in_log(self):
 
941
        """See Config.validate_signatures_in_log."""
 
942
        return self._get_user_option('validate_signatures_in_log')
 
943
 
 
944
    def _acceptable_keys(self):
 
945
        """See Config.acceptable_keys."""
 
946
        return self._get_user_option('acceptable_keys')
 
947
 
386
948
    def _post_commit(self):
387
949
        """See Config.post_commit."""
388
950
        return self._get_user_option('post_commit')
389
951
 
390
 
    def _string_to_signature_policy(self, signature_string):
391
 
        """Convert a string to a signing policy."""
392
 
        if signature_string.lower() == 'check-available':
393
 
            return CHECK_IF_POSSIBLE
394
 
        if signature_string.lower() == 'ignore':
395
 
            return CHECK_NEVER
396
 
        if signature_string.lower() == 'require':
397
 
            return CHECK_ALWAYS
398
 
        raise errors.BzrError("Invalid signatures policy '%s'"
399
 
                              % signature_string)
400
 
 
401
 
    def _string_to_signing_policy(self, signature_string):
402
 
        """Convert a string to a signing policy."""
403
 
        if signature_string.lower() == 'when-required':
404
 
            return SIGN_WHEN_REQUIRED
405
 
        if signature_string.lower() == 'never':
406
 
            return SIGN_NEVER
407
 
        if signature_string.lower() == 'always':
408
 
            return SIGN_ALWAYS
409
 
        raise errors.BzrError("Invalid signing policy '%s'"
410
 
                              % signature_string)
411
 
 
412
952
    def _get_alias(self, value):
413
953
        try:
414
 
            return self._get_parser().get_value("ALIASES", 
 
954
            return self._get_parser().get_value("ALIASES",
415
955
                                                value)
416
956
        except KeyError:
417
957
            pass
419
959
    def _get_nickname(self):
420
960
        return self.get_user_option('nickname')
421
961
 
422
 
 
423
 
class GlobalConfig(IniBasedConfig):
 
962
    def remove_user_option(self, option_name, section_name=None):
 
963
        """Remove a user option and save the configuration file.
 
964
 
 
965
        :param option_name: The option to be removed.
 
966
 
 
967
        :param section_name: The section the option is defined in, default to
 
968
            the default section.
 
969
        """
 
970
        self.reload()
 
971
        parser = self._get_parser()
 
972
        if section_name is None:
 
973
            section = parser
 
974
        else:
 
975
            section = parser[section_name]
 
976
        try:
 
977
            del section[option_name]
 
978
        except KeyError:
 
979
            raise errors.NoSuchConfigOption(option_name)
 
980
        self._write_config_file()
 
981
        for hook in OldConfigHooks['remove']:
 
982
            hook(self, option_name)
 
983
 
 
984
    def _write_config_file(self):
 
985
        if self.file_name is None:
 
986
            raise AssertionError('We cannot save, self.file_name is None')
 
987
        conf_dir = os.path.dirname(self.file_name)
 
988
        ensure_config_dir_exists(conf_dir)
 
989
        atomic_file = atomicfile.AtomicFile(self.file_name)
 
990
        self._get_parser().write(atomic_file)
 
991
        atomic_file.commit()
 
992
        atomic_file.close()
 
993
        osutils.copy_ownership_from_path(self.file_name)
 
994
        for hook in OldConfigHooks['save']:
 
995
            hook(self)
 
996
 
 
997
 
 
998
class LockableConfig(IniBasedConfig):
 
999
    """A configuration needing explicit locking for access.
 
1000
 
 
1001
    If several processes try to write the config file, the accesses need to be
 
1002
    serialized.
 
1003
 
 
1004
    Daughter classes should decorate all methods that update a config with the
 
1005
    ``@needs_write_lock`` decorator (they call, directly or indirectly, the
 
1006
    ``_write_config_file()`` method. These methods (typically ``set_option()``
 
1007
    and variants must reload the config file from disk before calling
 
1008
    ``_write_config_file()``), this can be achieved by calling the
 
1009
    ``self.reload()`` method. Note that the lock scope should cover both the
 
1010
    reading and the writing of the config file which is why the decorator can't
 
1011
    be applied to ``_write_config_file()`` only.
 
1012
 
 
1013
    This should be enough to implement the following logic:
 
1014
    - lock for exclusive write access,
 
1015
    - reload the config file from disk,
 
1016
    - set the new value
 
1017
    - unlock
 
1018
 
 
1019
    This logic guarantees that a writer can update a value without erasing an
 
1020
    update made by another writer.
 
1021
    """
 
1022
 
 
1023
    lock_name = 'lock'
 
1024
 
 
1025
    def __init__(self, file_name):
 
1026
        super(LockableConfig, self).__init__(file_name=file_name)
 
1027
        self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
 
1028
        # FIXME: It doesn't matter that we don't provide possible_transports
 
1029
        # below since this is currently used only for local config files ;
 
1030
        # local transports are not shared. But if/when we start using
 
1031
        # LockableConfig for other kind of transports, we will need to reuse
 
1032
        # whatever connection is already established -- vila 20100929
 
1033
        self.transport = transport.get_transport_from_path(self.dir)
 
1034
        self._lock = lockdir.LockDir(self.transport, self.lock_name)
 
1035
 
 
1036
    def _create_from_string(self, unicode_bytes, save):
 
1037
        super(LockableConfig, self)._create_from_string(unicode_bytes, False)
 
1038
        if save:
 
1039
            # We need to handle the saving here (as opposed to IniBasedConfig)
 
1040
            # to be able to lock
 
1041
            self.lock_write()
 
1042
            self._write_config_file()
 
1043
            self.unlock()
 
1044
 
 
1045
    def lock_write(self, token=None):
 
1046
        """Takes a write lock in the directory containing the config file.
 
1047
 
 
1048
        If the directory doesn't exist it is created.
 
1049
        """
 
1050
        ensure_config_dir_exists(self.dir)
 
1051
        return self._lock.lock_write(token)
 
1052
 
 
1053
    def unlock(self):
 
1054
        self._lock.unlock()
 
1055
 
 
1056
    def break_lock(self):
 
1057
        self._lock.break_lock()
 
1058
 
 
1059
    @needs_write_lock
 
1060
    def remove_user_option(self, option_name, section_name=None):
 
1061
        super(LockableConfig, self).remove_user_option(option_name,
 
1062
                                                       section_name)
 
1063
 
 
1064
    def _write_config_file(self):
 
1065
        if self._lock is None or not self._lock.is_held:
 
1066
            # NB: if the following exception is raised it probably means a
 
1067
            # missing @needs_write_lock decorator on one of the callers.
 
1068
            raise errors.ObjectNotLocked(self)
 
1069
        super(LockableConfig, self)._write_config_file()
 
1070
 
 
1071
 
 
1072
class GlobalConfig(LockableConfig):
424
1073
    """The configuration that should be used for a specific location."""
425
1074
 
 
1075
    def __init__(self):
 
1076
        super(GlobalConfig, self).__init__(file_name=config_filename())
 
1077
 
 
1078
    def config_id(self):
 
1079
        return 'bazaar'
 
1080
 
 
1081
    @classmethod
 
1082
    def from_string(cls, str_or_unicode, save=False):
 
1083
        """Create a config object from a string.
 
1084
 
 
1085
        :param str_or_unicode: A string representing the file content. This
 
1086
            will be utf-8 encoded.
 
1087
 
 
1088
        :param save: Whether the file should be saved upon creation.
 
1089
        """
 
1090
        conf = cls()
 
1091
        conf._create_from_string(str_or_unicode, save)
 
1092
        return conf
 
1093
 
 
1094
    @deprecated_method(deprecated_in((2, 4, 0)))
426
1095
    def get_editor(self):
427
1096
        return self._get_user_option('editor')
428
1097
 
429
 
    def __init__(self):
430
 
        super(GlobalConfig, self).__init__(config_filename)
431
 
 
 
1098
    @needs_write_lock
432
1099
    def set_user_option(self, option, value):
433
1100
        """Save option and its value in the configuration."""
434
 
        # FIXME: RBC 20051029 This should refresh the parser and also take a
435
 
        # file lock on bazaar.conf.
436
 
        conf_dir = os.path.dirname(self._get_filename())
437
 
        ensure_config_dir_exists(conf_dir)
438
 
        if 'DEFAULT' not in self._get_parser():
439
 
            self._get_parser()['DEFAULT'] = {}
440
 
        self._get_parser()['DEFAULT'][option] = value
441
 
        f = open(self._get_filename(), 'wb')
442
 
        self._get_parser().write(f)
443
 
        f.close()
444
 
 
445
 
 
446
 
class LocationConfig(IniBasedConfig):
 
1101
        self._set_option(option, value, 'DEFAULT')
 
1102
 
 
1103
    def get_aliases(self):
 
1104
        """Return the aliases section."""
 
1105
        if 'ALIASES' in self._get_parser():
 
1106
            return self._get_parser()['ALIASES']
 
1107
        else:
 
1108
            return {}
 
1109
 
 
1110
    @needs_write_lock
 
1111
    def set_alias(self, alias_name, alias_command):
 
1112
        """Save the alias in the configuration."""
 
1113
        self._set_option(alias_name, alias_command, 'ALIASES')
 
1114
 
 
1115
    @needs_write_lock
 
1116
    def unset_alias(self, alias_name):
 
1117
        """Unset an existing alias."""
 
1118
        self.reload()
 
1119
        aliases = self._get_parser().get('ALIASES')
 
1120
        if not aliases or alias_name not in aliases:
 
1121
            raise errors.NoSuchAlias(alias_name)
 
1122
        del aliases[alias_name]
 
1123
        self._write_config_file()
 
1124
 
 
1125
    def _set_option(self, option, value, section):
 
1126
        self.reload()
 
1127
        self._get_parser().setdefault(section, {})[option] = value
 
1128
        self._write_config_file()
 
1129
        for hook in OldConfigHooks['set']:
 
1130
            hook(self, option, value)
 
1131
 
 
1132
    def _get_sections(self, name=None):
 
1133
        """See IniBasedConfig._get_sections()."""
 
1134
        parser = self._get_parser()
 
1135
        # We don't give access to options defined outside of any section, we
 
1136
        # used the DEFAULT section by... default.
 
1137
        if name in (None, 'DEFAULT'):
 
1138
            # This could happen for an empty file where the DEFAULT section
 
1139
            # doesn't exist yet. So we force DEFAULT when yielding
 
1140
            name = 'DEFAULT'
 
1141
            if 'DEFAULT' not in parser:
 
1142
               parser['DEFAULT']= {}
 
1143
        yield (name, parser[name], self.config_id())
 
1144
 
 
1145
    @needs_write_lock
 
1146
    def remove_user_option(self, option_name, section_name=None):
 
1147
        if section_name is None:
 
1148
            # We need to force the default section.
 
1149
            section_name = 'DEFAULT'
 
1150
        # We need to avoid the LockableConfig implementation or we'll lock
 
1151
        # twice
 
1152
        super(LockableConfig, self).remove_user_option(option_name,
 
1153
                                                       section_name)
 
1154
 
 
1155
def _iter_for_location_by_parts(sections, location):
 
1156
    """Keep only the sessions matching the specified location.
 
1157
 
 
1158
    :param sections: An iterable of section names.
 
1159
 
 
1160
    :param location: An url or a local path to match against.
 
1161
 
 
1162
    :returns: An iterator of (section, extra_path, nb_parts) where nb is the
 
1163
        number of path components in the section name, section is the section
 
1164
        name and extra_path is the difference between location and the section
 
1165
        name.
 
1166
 
 
1167
    ``location`` will always be a local path and never a 'file://' url but the
 
1168
    section names themselves can be in either form.
 
1169
    """
 
1170
    location_parts = location.rstrip('/').split('/')
 
1171
 
 
1172
    for section in sections:
 
1173
        # location is a local path if possible, so we need to convert 'file://'
 
1174
        # urls in section names to local paths if necessary.
 
1175
 
 
1176
        # This also avoids having file:///path be a more exact
 
1177
        # match than '/path'.
 
1178
 
 
1179
        # FIXME: This still raises an issue if a user defines both file:///path
 
1180
        # *and* /path. Should we raise an error in this case -- vila 20110505
 
1181
 
 
1182
        if section.startswith('file://'):
 
1183
            section_path = urlutils.local_path_from_url(section)
 
1184
        else:
 
1185
            section_path = section
 
1186
        section_parts = section_path.rstrip('/').split('/')
 
1187
 
 
1188
        matched = True
 
1189
        if len(section_parts) > len(location_parts):
 
1190
            # More path components in the section, they can't match
 
1191
            matched = False
 
1192
        else:
 
1193
            # Rely on zip truncating in length to the length of the shortest
 
1194
            # argument sequence.
 
1195
            names = zip(location_parts, section_parts)
 
1196
            for name in names:
 
1197
                if not fnmatch.fnmatch(name[0], name[1]):
 
1198
                    matched = False
 
1199
                    break
 
1200
        if not matched:
 
1201
            continue
 
1202
        # build the path difference between the section and the location
 
1203
        extra_path = '/'.join(location_parts[len(section_parts):])
 
1204
        yield section, extra_path, len(section_parts)
 
1205
 
 
1206
 
 
1207
class LocationConfig(LockableConfig):
447
1208
    """A configuration object that gives the policy for a location."""
448
1209
 
449
1210
    def __init__(self, location):
450
 
        name_generator = locations_config_filename
451
 
        if (not os.path.exists(name_generator()) and 
452
 
                os.path.exists(branches_config_filename())):
453
 
            if sys.platform == 'win32':
454
 
                warning('Please rename %s to %s' 
455
 
                         % (branches_config_filename(),
456
 
                            locations_config_filename()))
457
 
            else:
458
 
                warning('Please rename ~/.bazaar/branches.conf'
459
 
                        ' to ~/.bazaar/locations.conf')
460
 
            name_generator = branches_config_filename
461
 
        super(LocationConfig, self).__init__(name_generator)
 
1211
        super(LocationConfig, self).__init__(
 
1212
            file_name=locations_config_filename())
462
1213
        # local file locations are looked up by local path, rather than
463
1214
        # by file url. This is because the config file is a user
464
1215
        # file, and we would rather not expose the user to file urls.
466
1217
            location = urlutils.local_path_from_url(location)
467
1218
        self.location = location
468
1219
 
 
1220
    def config_id(self):
 
1221
        return 'locations'
 
1222
 
 
1223
    @classmethod
 
1224
    def from_string(cls, str_or_unicode, location, save=False):
 
1225
        """Create a config object from a string.
 
1226
 
 
1227
        :param str_or_unicode: A string representing the file content. This will
 
1228
            be utf-8 encoded.
 
1229
 
 
1230
        :param location: The location url to filter the configuration.
 
1231
 
 
1232
        :param save: Whether the file should be saved upon creation.
 
1233
        """
 
1234
        conf = cls(location)
 
1235
        conf._create_from_string(str_or_unicode, save)
 
1236
        return conf
 
1237
 
469
1238
    def _get_matching_sections(self):
470
1239
        """Return an ordered list of section names matching this location."""
471
 
        sections = self._get_parser()
472
 
        location_names = self.location.split('/')
473
 
        if self.location.endswith('/'):
474
 
            del location_names[-1]
475
 
        matches=[]
476
 
        for section in sections:
477
 
            # location is a local path if possible, so we need
478
 
            # to convert 'file://' urls to local paths if necessary.
479
 
            # This also avoids having file:///path be a more exact
480
 
            # match than '/path'.
481
 
            if section.startswith('file://'):
482
 
                section_path = urlutils.local_path_from_url(section)
483
 
            else:
484
 
                section_path = section
485
 
            section_names = section_path.split('/')
486
 
            if section.endswith('/'):
487
 
                del section_names[-1]
488
 
            names = zip(location_names, section_names)
489
 
            matched = True
490
 
            for name in names:
491
 
                if not fnmatch(name[0], name[1]):
492
 
                    matched = False
493
 
                    break
494
 
            if not matched:
495
 
                continue
496
 
            # so, for the common prefix they matched.
497
 
            # if section is longer, no match.
498
 
            if len(section_names) > len(location_names):
499
 
                continue
500
 
            matches.append((len(section_names), section,
501
 
                            '/'.join(location_names[len(section_names):])))
502
 
        matches.sort(reverse=True)
503
 
        sections = []
504
 
        for (length, section, extra_path) in matches:
505
 
            sections.append((section, extra_path))
 
1240
        matches = list(_iter_for_location_by_parts(self._get_parser(),
 
1241
                                                   self.location))
 
1242
        # put the longest (aka more specific) locations first
 
1243
        matches.sort(
 
1244
            key=lambda (section, extra_path, length): (length, section),
 
1245
            reverse=True)
 
1246
        for (section, extra_path, length) in matches:
 
1247
            yield section, extra_path
506
1248
            # should we stop looking for parent configs here?
507
1249
            try:
508
1250
                if self._get_parser()[section].as_bool('ignore_parents'):
509
1251
                    break
510
1252
            except KeyError:
511
1253
                pass
512
 
        return sections
 
1254
 
 
1255
    def _get_sections(self, name=None):
 
1256
        """See IniBasedConfig._get_sections()."""
 
1257
        # We ignore the name here as the only sections handled are named with
 
1258
        # the location path and we don't expose embedded sections either.
 
1259
        parser = self._get_parser()
 
1260
        for name, extra_path in self._get_matching_sections():
 
1261
            yield (name, parser[name], self.config_id())
513
1262
 
514
1263
    def _get_option_policy(self, section, option_name):
515
1264
        """Return the policy for the given (section, option_name) pair."""
559
1308
            if policy_key in self._get_parser()[section]:
560
1309
                del self._get_parser()[section][policy_key]
561
1310
 
 
1311
    @needs_write_lock
562
1312
    def set_user_option(self, option, value, store=STORE_LOCATION):
563
1313
        """Save option and its value in the configuration."""
564
 
        assert store in [STORE_LOCATION,
 
1314
        if store not in [STORE_LOCATION,
565
1315
                         STORE_LOCATION_NORECURSE,
566
 
                         STORE_LOCATION_APPENDPATH], 'bad storage policy'
567
 
        # FIXME: RBC 20051029 This should refresh the parser and also take a
568
 
        # file lock on locations.conf.
569
 
        conf_dir = os.path.dirname(self._get_filename())
570
 
        ensure_config_dir_exists(conf_dir)
 
1316
                         STORE_LOCATION_APPENDPATH]:
 
1317
            raise ValueError('bad storage policy %r for %r' %
 
1318
                (store, option))
 
1319
        self.reload()
571
1320
        location = self.location
572
1321
        if location.endswith('/'):
573
1322
            location = location[:-1]
574
 
        if (not location in self._get_parser() and
575
 
            not location + '/' in self._get_parser()):
576
 
            self._get_parser()[location]={}
577
 
        elif location + '/' in self._get_parser():
 
1323
        parser = self._get_parser()
 
1324
        if not location in parser and not location + '/' in parser:
 
1325
            parser[location] = {}
 
1326
        elif location + '/' in parser:
578
1327
            location = location + '/'
579
 
        self._get_parser()[location][option]=value
 
1328
        parser[location][option]=value
580
1329
        # the allowed values of store match the config policies
581
1330
        self._set_option_policy(location, option, store)
582
 
        self._get_parser().write(file(self._get_filename(), 'wb'))
 
1331
        self._write_config_file()
 
1332
        for hook in OldConfigHooks['set']:
 
1333
            hook(self, option, value)
583
1334
 
584
1335
 
585
1336
class BranchConfig(Config):
586
1337
    """A configuration object giving the policy for a branch."""
587
1338
 
 
1339
    def __init__(self, branch):
 
1340
        super(BranchConfig, self).__init__()
 
1341
        self._location_config = None
 
1342
        self._branch_data_config = None
 
1343
        self._global_config = None
 
1344
        self.branch = branch
 
1345
        self.option_sources = (self._get_location_config,
 
1346
                               self._get_branch_data_config,
 
1347
                               self._get_global_config)
 
1348
 
 
1349
    def config_id(self):
 
1350
        return 'branch'
 
1351
 
588
1352
    def _get_branch_data_config(self):
589
1353
        if self._branch_data_config is None:
590
1354
            self._branch_data_config = TreeConfig(self.branch)
 
1355
            self._branch_data_config.config_id = self.config_id
591
1356
        return self._branch_data_config
592
1357
 
593
1358
    def _get_location_config(self):
614
1379
 
615
1380
    def _get_safe_value(self, option_name):
616
1381
        """This variant of get_best_value never returns untrusted values.
617
 
        
 
1382
 
618
1383
        It does not return values from the branch data, because the branch may
619
1384
        not be controlled by the user.
620
1385
 
629
1394
 
630
1395
    def _get_user_id(self):
631
1396
        """Return the full user id for the branch.
632
 
    
633
 
        e.g. "John Hacker <jhacker@foo.org>"
 
1397
 
 
1398
        e.g. "John Hacker <jhacker@example.com>"
634
1399
        This is looked up in the email controlfile for the branch.
635
1400
        """
636
 
        try:
637
 
            return (self.branch.control_files.get_utf8("email") 
638
 
                    .read()
639
 
                    .decode(bzrlib.user_encoding)
640
 
                    .rstrip("\r\n"))
641
 
        except errors.NoSuchFile, e:
642
 
            pass
643
 
        
644
1401
        return self._get_best_value('_get_user_id')
645
1402
 
 
1403
    def _get_change_editor(self):
 
1404
        return self._get_best_value('_get_change_editor')
 
1405
 
646
1406
    def _get_signature_checking(self):
647
1407
        """See Config._get_signature_checking."""
648
1408
        return self._get_best_value('_get_signature_checking')
659
1419
                return value
660
1420
        return None
661
1421
 
 
1422
    def _get_sections(self, name=None):
 
1423
        """See IniBasedConfig.get_sections()."""
 
1424
        for source in self.option_sources:
 
1425
            for section in source()._get_sections(name):
 
1426
                yield section
 
1427
 
 
1428
    def _get_options(self, sections=None):
 
1429
        opts = []
 
1430
        # First the locations options
 
1431
        for option in self._get_location_config()._get_options():
 
1432
            yield option
 
1433
        # Then the branch options
 
1434
        branch_config = self._get_branch_data_config()
 
1435
        if sections is None:
 
1436
            sections = [('DEFAULT', branch_config._get_parser())]
 
1437
        # FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
 
1438
        # Config itself has no notion of sections :( -- vila 20101001
 
1439
        config_id = self.config_id()
 
1440
        for (section_name, section) in sections:
 
1441
            for (name, value) in section.iteritems():
 
1442
                yield (name, value, section_name,
 
1443
                       config_id, branch_config._get_parser())
 
1444
        # Then the global options
 
1445
        for option in self._get_global_config()._get_options():
 
1446
            yield option
 
1447
 
662
1448
    def set_user_option(self, name, value, store=STORE_BRANCH,
663
1449
        warn_masked=False):
664
1450
        if store == STORE_BRANCH:
682
1468
                        trace.warning('Value "%s" is masked by "%s" from'
683
1469
                                      ' branch.conf', value, mask_value)
684
1470
 
 
1471
    def remove_user_option(self, option_name, section_name=None):
 
1472
        self._get_branch_data_config().remove_option(option_name, section_name)
685
1473
 
686
1474
    def _gpg_signing_command(self):
687
1475
        """See Config.gpg_signing_command."""
688
1476
        return self._get_safe_value('_gpg_signing_command')
689
 
        
690
 
    def __init__(self, branch):
691
 
        super(BranchConfig, self).__init__()
692
 
        self._location_config = None
693
 
        self._branch_data_config = None
694
 
        self._global_config = None
695
 
        self.branch = branch
696
 
        self.option_sources = (self._get_location_config, 
697
 
                               self._get_branch_data_config,
698
 
                               self._get_global_config)
699
1477
 
700
1478
    def _post_commit(self):
701
1479
        """See Config.post_commit."""
718
1496
        """See Config.log_format."""
719
1497
        return self._get_best_value('_log_format')
720
1498
 
 
1499
    def _validate_signatures_in_log(self):
 
1500
        """See Config.validate_signatures_in_log."""
 
1501
        return self._get_best_value('_validate_signatures_in_log')
 
1502
 
 
1503
    def _acceptable_keys(self):
 
1504
        """See Config.acceptable_keys."""
 
1505
        return self._get_best_value('_acceptable_keys')
 
1506
 
721
1507
 
722
1508
def ensure_config_dir_exists(path=None):
723
1509
    """Make sure a configuration directory exists.
731
1517
        if sys.platform == 'win32':
732
1518
            parent_dir = os.path.dirname(path)
733
1519
            if not os.path.isdir(parent_dir):
734
 
                mutter('creating config parent directory: %r', parent_dir)
735
 
            os.mkdir(parent_dir)
736
 
        mutter('creating config directory: %r', path)
 
1520
                trace.mutter('creating config parent directory: %r', parent_dir)
 
1521
                os.mkdir(parent_dir)
 
1522
        trace.mutter('creating config directory: %r', path)
737
1523
        os.mkdir(path)
 
1524
        osutils.copy_ownership_from_path(path)
738
1525
 
739
1526
 
740
1527
def config_dir():
741
1528
    """Return per-user configuration directory.
742
1529
 
743
 
    By default this is ~/.bazaar/
744
 
    
 
1530
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
 
1531
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
 
1532
    that will be used instead.
 
1533
 
745
1534
    TODO: Global option --config-dir to override this.
746
1535
    """
747
1536
    base = os.environ.get('BZR_HOME', None)
748
1537
    if sys.platform == 'win32':
 
1538
        # environ variables on Windows are in user encoding/mbcs. So decode
 
1539
        # before using one
 
1540
        if base is not None:
 
1541
            base = base.decode('mbcs')
749
1542
        if base is None:
750
1543
            base = win32utils.get_appdata_location_unicode()
751
1544
        if base is None:
752
1545
            base = os.environ.get('HOME', None)
 
1546
            if base is not None:
 
1547
                base = base.decode('mbcs')
753
1548
        if base is None:
754
 
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
 
1549
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
 
1550
                                  ' or HOME set')
755
1551
        return osutils.pathjoin(base, 'bazaar', '2.0')
756
1552
    else:
757
 
        # cygwin, linux, and darwin all have a $HOME directory
758
 
        if base is None:
 
1553
        if base is not None:
 
1554
            base = base.decode(osutils._fs_enc)
 
1555
    if sys.platform == 'darwin':
 
1556
        if base is None:
 
1557
            # this takes into account $HOME
 
1558
            base = os.path.expanduser("~")
 
1559
        return osutils.pathjoin(base, '.bazaar')
 
1560
    else:
 
1561
        if base is None:
 
1562
            xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
 
1563
            if xdg_dir is None:
 
1564
                xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
 
1565
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
 
1566
            if osutils.isdir(xdg_dir):
 
1567
                trace.mutter(
 
1568
                    "Using configuration in XDG directory %s." % xdg_dir)
 
1569
                return xdg_dir
759
1570
            base = os.path.expanduser("~")
760
1571
        return osutils.pathjoin(base, ".bazaar")
761
1572
 
765
1576
    return osutils.pathjoin(config_dir(), 'bazaar.conf')
766
1577
 
767
1578
 
768
 
def branches_config_filename():
769
 
    """Return per-user configuration ini file filename."""
770
 
    return osutils.pathjoin(config_dir(), 'branches.conf')
771
 
 
772
 
 
773
1579
def locations_config_filename():
774
1580
    """Return per-user configuration ini file filename."""
775
1581
    return osutils.pathjoin(config_dir(), 'locations.conf')
776
1582
 
777
1583
 
 
1584
def authentication_config_filename():
 
1585
    """Return per-user authentication ini file filename."""
 
1586
    return osutils.pathjoin(config_dir(), 'authentication.conf')
 
1587
 
 
1588
 
778
1589
def user_ignore_config_filename():
779
1590
    """Return the user default ignore filename"""
780
1591
    return osutils.pathjoin(config_dir(), 'ignore')
781
1592
 
782
1593
 
 
1594
def crash_dir():
 
1595
    """Return the directory name to store crash files.
 
1596
 
 
1597
    This doesn't implicitly create it.
 
1598
 
 
1599
    On Windows it's in the config directory; elsewhere it's /var/crash
 
1600
    which may be monitored by apport.  It can be overridden by
 
1601
    $APPORT_CRASH_DIR.
 
1602
    """
 
1603
    if sys.platform == 'win32':
 
1604
        return osutils.pathjoin(config_dir(), 'Crash')
 
1605
    else:
 
1606
        # XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
 
1607
        # 2010-01-31
 
1608
        return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
 
1609
 
 
1610
 
 
1611
def xdg_cache_dir():
 
1612
    # See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
 
1613
    # Possibly this should be different on Windows?
 
1614
    e = os.environ.get('XDG_CACHE_DIR', None)
 
1615
    if e:
 
1616
        return e
 
1617
    else:
 
1618
        return os.path.expanduser('~/.cache')
 
1619
 
 
1620
 
 
1621
def _get_default_mail_domain():
 
1622
    """If possible, return the assumed default email domain.
 
1623
 
 
1624
    :returns: string mail domain, or None.
 
1625
    """
 
1626
    if sys.platform == 'win32':
 
1627
        # No implementation yet; patches welcome
 
1628
        return None
 
1629
    try:
 
1630
        f = open('/etc/mailname')
 
1631
    except (IOError, OSError), e:
 
1632
        return None
 
1633
    try:
 
1634
        domain = f.read().strip()
 
1635
        return domain
 
1636
    finally:
 
1637
        f.close()
 
1638
 
 
1639
 
 
1640
def default_email():
 
1641
    v = os.environ.get('BZR_EMAIL')
 
1642
    if v:
 
1643
        return v.decode(osutils.get_user_encoding())
 
1644
    v = os.environ.get('EMAIL')
 
1645
    if v:
 
1646
        return v.decode(osutils.get_user_encoding())
 
1647
    name, email = _auto_user_id()
 
1648
    if name and email:
 
1649
        return u'%s <%s>' % (name, email)
 
1650
    elif email:
 
1651
        return email
 
1652
    raise errors.NoWhoami()
 
1653
 
 
1654
 
783
1655
def _auto_user_id():
784
1656
    """Calculate automatic user identification.
785
1657
 
786
 
    Returns (realname, email).
 
1658
    :returns: (realname, email), either of which may be None if they can't be
 
1659
    determined.
787
1660
 
788
1661
    Only used when none is set in the environment or the id file.
789
1662
 
790
 
    This previously used the FQDN as the default domain, but that can
791
 
    be very slow on machines where DNS is broken.  So now we simply
792
 
    use the hostname.
 
1663
    This only returns an email address if we can be fairly sure the 
 
1664
    address is reasonable, ie if /etc/mailname is set on unix.
 
1665
 
 
1666
    This doesn't use the FQDN as the default domain because that may be 
 
1667
    slow, and it doesn't use the hostname alone because that's not normally 
 
1668
    a reasonable address.
793
1669
    """
794
 
    import socket
795
 
 
796
1670
    if sys.platform == 'win32':
797
 
        name = win32utils.get_user_name_unicode()
798
 
        if name is None:
799
 
            raise errors.BzrError("Cannot autodetect user name.\n"
800
 
                                  "Please, set your name with command like:\n"
801
 
                                  'bzr whoami "Your Name <name@domain.com>"')
802
 
        host = win32utils.get_host_name_unicode()
803
 
        if host is None:
804
 
            host = socket.gethostname()
805
 
        return name, (name + '@' + host)
806
 
 
 
1671
        # No implementation to reliably determine Windows default mail
 
1672
        # address; please add one.
 
1673
        return None, None
 
1674
 
 
1675
    default_mail_domain = _get_default_mail_domain()
 
1676
    if not default_mail_domain:
 
1677
        return None, None
 
1678
 
 
1679
    import pwd
 
1680
    uid = os.getuid()
807
1681
    try:
808
 
        import pwd
809
 
        uid = os.getuid()
810
1682
        w = pwd.getpwuid(uid)
811
 
 
812
 
        # we try utf-8 first, because on many variants (like Linux),
813
 
        # /etc/passwd "should" be in utf-8, and because it's unlikely to give
814
 
        # false positives.  (many users will have their user encoding set to
815
 
        # latin-1, which cannot raise UnicodeError.)
816
 
        try:
817
 
            gecos = w.pw_gecos.decode('utf-8')
818
 
            encoding = 'utf-8'
819
 
        except UnicodeError:
820
 
            try:
821
 
                gecos = w.pw_gecos.decode(bzrlib.user_encoding)
822
 
                encoding = bzrlib.user_encoding
823
 
            except UnicodeError:
824
 
                raise errors.BzrCommandError('Unable to determine your name.  '
825
 
                   'Use "bzr whoami" to set it.')
826
 
        try:
827
 
            username = w.pw_name.decode(encoding)
828
 
        except UnicodeError:
829
 
            raise errors.BzrCommandError('Unable to determine your name.  '
830
 
                'Use "bzr whoami" to set it.')
831
 
 
832
 
        comma = gecos.find(',')
833
 
        if comma == -1:
834
 
            realname = gecos
835
 
        else:
836
 
            realname = gecos[:comma]
837
 
        if not realname:
838
 
            realname = username
839
 
 
840
 
    except ImportError:
841
 
        import getpass
842
 
        try:
843
 
            realname = username = getpass.getuser().decode(bzrlib.user_encoding)
844
 
        except UnicodeDecodeError:
845
 
            raise errors.BzrError("Can't decode username as %s." % \
846
 
                    bzrlib.user_encoding)
847
 
 
848
 
    return realname, (username + '@' + socket.gethostname())
 
1683
    except KeyError:
 
1684
        trace.mutter('no passwd entry for uid %d?' % uid)
 
1685
        return None, None
 
1686
 
 
1687
    # we try utf-8 first, because on many variants (like Linux),
 
1688
    # /etc/passwd "should" be in utf-8, and because it's unlikely to give
 
1689
    # false positives.  (many users will have their user encoding set to
 
1690
    # latin-1, which cannot raise UnicodeError.)
 
1691
    try:
 
1692
        gecos = w.pw_gecos.decode('utf-8')
 
1693
        encoding = 'utf-8'
 
1694
    except UnicodeError:
 
1695
        try:
 
1696
            encoding = osutils.get_user_encoding()
 
1697
            gecos = w.pw_gecos.decode(encoding)
 
1698
        except UnicodeError, e:
 
1699
            trace.mutter("cannot decode passwd entry %s" % w)
 
1700
            return None, None
 
1701
    try:
 
1702
        username = w.pw_name.decode(encoding)
 
1703
    except UnicodeError, e:
 
1704
        trace.mutter("cannot decode passwd entry %s" % w)
 
1705
        return None, None
 
1706
 
 
1707
    comma = gecos.find(',')
 
1708
    if comma == -1:
 
1709
        realname = gecos
 
1710
    else:
 
1711
        realname = gecos[:comma]
 
1712
 
 
1713
    return realname, (username + '@' + default_mail_domain)
 
1714
 
 
1715
 
 
1716
def parse_username(username):
 
1717
    """Parse e-mail username and return a (name, address) tuple."""
 
1718
    match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
 
1719
    if match is None:
 
1720
        return (username, '')
 
1721
    else:
 
1722
        return (match.group(1), match.group(2))
849
1723
 
850
1724
 
851
1725
def extract_email_address(e):
852
1726
    """Return just the address part of an email string.
853
 
    
854
 
    That is just the user@domain part, nothing else. 
 
1727
 
 
1728
    That is just the user@domain part, nothing else.
855
1729
    This part is required to contain only ascii characters.
856
1730
    If it can't be extracted, raises an error.
857
 
    
 
1731
 
858
1732
    >>> extract_email_address('Jane Tester <jane@test.com>')
859
1733
    "jane@test.com"
860
1734
    """
861
 
    m = re.search(r'[\w+.-]+@[\w+.-]+', e)
862
 
    if not m:
 
1735
    name, email = parse_username(e)
 
1736
    if not email:
863
1737
        raise errors.NoEmailInUsername(e)
864
 
    return m.group(0)
 
1738
    return email
865
1739
 
866
1740
 
867
1741
class TreeConfig(IniBasedConfig):
868
1742
    """Branch configuration data associated with its contents, not location"""
 
1743
 
 
1744
    # XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
 
1745
 
869
1746
    def __init__(self, branch):
 
1747
        self._config = branch._get_config()
870
1748
        self.branch = branch
871
1749
 
872
1750
    def _get_parser(self, file=None):
873
1751
        if file is not None:
874
1752
            return IniBasedConfig._get_parser(file)
875
 
        return self._get_config()
876
 
 
877
 
    def _get_config(self):
878
 
        try:
879
 
            obj = ConfigObj(self.branch.control_files.get('branch.conf'),
880
 
                            encoding='utf-8')
881
 
        except errors.NoSuchFile:
882
 
            obj = ConfigObj(encoding='utf=8')
883
 
        return obj
 
1753
        return self._config._get_configobj()
884
1754
 
885
1755
    def get_option(self, name, section=None, default=None):
886
1756
        self.branch.lock_read()
887
1757
        try:
888
 
            obj = self._get_config()
889
 
            try:
890
 
                if section is not None:
891
 
                    obj = obj[section]
892
 
                result = obj[name]
893
 
            except KeyError:
894
 
                result = default
 
1758
            return self._config.get_option(name, section, default)
895
1759
        finally:
896
1760
            self.branch.unlock()
897
 
        return result
898
1761
 
899
1762
    def set_option(self, value, name, section=None):
900
1763
        """Set a per-branch configuration option"""
901
 
        self.branch.lock_write()
902
 
        try:
903
 
            cfg_obj = self._get_config()
904
 
            if section is None:
905
 
                obj = cfg_obj
906
 
            else:
907
 
                try:
908
 
                    obj = cfg_obj[section]
909
 
                except KeyError:
910
 
                    cfg_obj[section] = {}
911
 
                    obj = cfg_obj[section]
912
 
            obj[name] = value
913
 
            out_file = StringIO()
914
 
            cfg_obj.write(out_file)
915
 
            out_file.seek(0)
916
 
            self.branch.control_files.put('branch.conf', out_file)
917
 
        finally:
918
 
            self.branch.unlock()
 
1764
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1765
        # higher levels providing the right lock -- vila 20101004
 
1766
        self.branch.lock_write()
 
1767
        try:
 
1768
            self._config.set_option(value, name, section)
 
1769
        finally:
 
1770
            self.branch.unlock()
 
1771
 
 
1772
    def remove_option(self, option_name, section_name=None):
 
1773
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1774
        # higher levels providing the right lock -- vila 20101004
 
1775
        self.branch.lock_write()
 
1776
        try:
 
1777
            self._config.remove_option(option_name, section_name)
 
1778
        finally:
 
1779
            self.branch.unlock()
 
1780
 
 
1781
 
 
1782
class AuthenticationConfig(object):
 
1783
    """The authentication configuration file based on a ini file.
 
1784
 
 
1785
    Implements the authentication.conf file described in
 
1786
    doc/developers/authentication-ring.txt.
 
1787
    """
 
1788
 
 
1789
    def __init__(self, _file=None):
 
1790
        self._config = None # The ConfigObj
 
1791
        if _file is None:
 
1792
            self._filename = authentication_config_filename()
 
1793
            self._input = self._filename = authentication_config_filename()
 
1794
        else:
 
1795
            # Tests can provide a string as _file
 
1796
            self._filename = None
 
1797
            self._input = _file
 
1798
 
 
1799
    def _get_config(self):
 
1800
        if self._config is not None:
 
1801
            return self._config
 
1802
        try:
 
1803
            # FIXME: Should we validate something here ? Includes: empty
 
1804
            # sections are useless, at least one of
 
1805
            # user/password/password_encoding should be defined, etc.
 
1806
 
 
1807
            # Note: the encoding below declares that the file itself is utf-8
 
1808
            # encoded, but the values in the ConfigObj are always Unicode.
 
1809
            self._config = ConfigObj(self._input, encoding='utf-8')
 
1810
        except configobj.ConfigObjError, e:
 
1811
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
1812
        except UnicodeError:
 
1813
            raise errors.ConfigContentError(self._filename)
 
1814
        return self._config
 
1815
 
 
1816
    def _save(self):
 
1817
        """Save the config file, only tests should use it for now."""
 
1818
        conf_dir = os.path.dirname(self._filename)
 
1819
        ensure_config_dir_exists(conf_dir)
 
1820
        f = file(self._filename, 'wb')
 
1821
        try:
 
1822
            self._get_config().write(f)
 
1823
        finally:
 
1824
            f.close()
 
1825
 
 
1826
    def _set_option(self, section_name, option_name, value):
 
1827
        """Set an authentication configuration option"""
 
1828
        conf = self._get_config()
 
1829
        section = conf.get(section_name)
 
1830
        if section is None:
 
1831
            conf[section] = {}
 
1832
            section = conf[section]
 
1833
        section[option_name] = value
 
1834
        self._save()
 
1835
 
 
1836
    def get_credentials(self, scheme, host, port=None, user=None, path=None,
 
1837
                        realm=None):
 
1838
        """Returns the matching credentials from authentication.conf file.
 
1839
 
 
1840
        :param scheme: protocol
 
1841
 
 
1842
        :param host: the server address
 
1843
 
 
1844
        :param port: the associated port (optional)
 
1845
 
 
1846
        :param user: login (optional)
 
1847
 
 
1848
        :param path: the absolute path on the server (optional)
 
1849
 
 
1850
        :param realm: the http authentication realm (optional)
 
1851
 
 
1852
        :return: A dict containing the matching credentials or None.
 
1853
           This includes:
 
1854
           - name: the section name of the credentials in the
 
1855
             authentication.conf file,
 
1856
           - user: can't be different from the provided user if any,
 
1857
           - scheme: the server protocol,
 
1858
           - host: the server address,
 
1859
           - port: the server port (can be None),
 
1860
           - path: the absolute server path (can be None),
 
1861
           - realm: the http specific authentication realm (can be None),
 
1862
           - password: the decoded password, could be None if the credential
 
1863
             defines only the user
 
1864
           - verify_certificates: https specific, True if the server
 
1865
             certificate should be verified, False otherwise.
 
1866
        """
 
1867
        credentials = None
 
1868
        for auth_def_name, auth_def in self._get_config().items():
 
1869
            if type(auth_def) is not configobj.Section:
 
1870
                raise ValueError("%s defined outside a section" % auth_def_name)
 
1871
 
 
1872
            a_scheme, a_host, a_user, a_path = map(
 
1873
                auth_def.get, ['scheme', 'host', 'user', 'path'])
 
1874
 
 
1875
            try:
 
1876
                a_port = auth_def.as_int('port')
 
1877
            except KeyError:
 
1878
                a_port = None
 
1879
            except ValueError:
 
1880
                raise ValueError("'port' not numeric in %s" % auth_def_name)
 
1881
            try:
 
1882
                a_verify_certificates = auth_def.as_bool('verify_certificates')
 
1883
            except KeyError:
 
1884
                a_verify_certificates = True
 
1885
            except ValueError:
 
1886
                raise ValueError(
 
1887
                    "'verify_certificates' not boolean in %s" % auth_def_name)
 
1888
 
 
1889
            # Attempt matching
 
1890
            if a_scheme is not None and scheme != a_scheme:
 
1891
                continue
 
1892
            if a_host is not None:
 
1893
                if not (host == a_host
 
1894
                        or (a_host.startswith('.') and host.endswith(a_host))):
 
1895
                    continue
 
1896
            if a_port is not None and port != a_port:
 
1897
                continue
 
1898
            if (a_path is not None and path is not None
 
1899
                and not path.startswith(a_path)):
 
1900
                continue
 
1901
            if (a_user is not None and user is not None
 
1902
                and a_user != user):
 
1903
                # Never contradict the caller about the user to be used
 
1904
                continue
 
1905
            if a_user is None:
 
1906
                # Can't find a user
 
1907
                continue
 
1908
            # Prepare a credentials dictionary with additional keys
 
1909
            # for the credential providers
 
1910
            credentials = dict(name=auth_def_name,
 
1911
                               user=a_user,
 
1912
                               scheme=a_scheme,
 
1913
                               host=host,
 
1914
                               port=port,
 
1915
                               path=path,
 
1916
                               realm=realm,
 
1917
                               password=auth_def.get('password', None),
 
1918
                               verify_certificates=a_verify_certificates)
 
1919
            # Decode the password in the credentials (or get one)
 
1920
            self.decode_password(credentials,
 
1921
                                 auth_def.get('password_encoding', None))
 
1922
            if 'auth' in debug.debug_flags:
 
1923
                trace.mutter("Using authentication section: %r", auth_def_name)
 
1924
            break
 
1925
 
 
1926
        if credentials is None:
 
1927
            # No credentials were found in authentication.conf, try the fallback
 
1928
            # credentials stores.
 
1929
            credentials = credential_store_registry.get_fallback_credentials(
 
1930
                scheme, host, port, user, path, realm)
 
1931
 
 
1932
        return credentials
 
1933
 
 
1934
    def set_credentials(self, name, host, user, scheme=None, password=None,
 
1935
                        port=None, path=None, verify_certificates=None,
 
1936
                        realm=None):
 
1937
        """Set authentication credentials for a host.
 
1938
 
 
1939
        Any existing credentials with matching scheme, host, port and path
 
1940
        will be deleted, regardless of name.
 
1941
 
 
1942
        :param name: An arbitrary name to describe this set of credentials.
 
1943
        :param host: Name of the host that accepts these credentials.
 
1944
        :param user: The username portion of these credentials.
 
1945
        :param scheme: The URL scheme (e.g. ssh, http) the credentials apply
 
1946
            to.
 
1947
        :param password: Password portion of these credentials.
 
1948
        :param port: The IP port on the host that these credentials apply to.
 
1949
        :param path: A filesystem path on the host that these credentials
 
1950
            apply to.
 
1951
        :param verify_certificates: On https, verify server certificates if
 
1952
            True.
 
1953
        :param realm: The http authentication realm (optional).
 
1954
        """
 
1955
        values = {'host': host, 'user': user}
 
1956
        if password is not None:
 
1957
            values['password'] = password
 
1958
        if scheme is not None:
 
1959
            values['scheme'] = scheme
 
1960
        if port is not None:
 
1961
            values['port'] = '%d' % port
 
1962
        if path is not None:
 
1963
            values['path'] = path
 
1964
        if verify_certificates is not None:
 
1965
            values['verify_certificates'] = str(verify_certificates)
 
1966
        if realm is not None:
 
1967
            values['realm'] = realm
 
1968
        config = self._get_config()
 
1969
        for_deletion = []
 
1970
        for section, existing_values in config.items():
 
1971
            for key in ('scheme', 'host', 'port', 'path', 'realm'):
 
1972
                if existing_values.get(key) != values.get(key):
 
1973
                    break
 
1974
            else:
 
1975
                del config[section]
 
1976
        config.update({name: values})
 
1977
        self._save()
 
1978
 
 
1979
    def get_user(self, scheme, host, port=None, realm=None, path=None,
 
1980
                 prompt=None, ask=False, default=None):
 
1981
        """Get a user from authentication file.
 
1982
 
 
1983
        :param scheme: protocol
 
1984
 
 
1985
        :param host: the server address
 
1986
 
 
1987
        :param port: the associated port (optional)
 
1988
 
 
1989
        :param realm: the realm sent by the server (optional)
 
1990
 
 
1991
        :param path: the absolute path on the server (optional)
 
1992
 
 
1993
        :param ask: Ask the user if there is no explicitly configured username 
 
1994
                    (optional)
 
1995
 
 
1996
        :param default: The username returned if none is defined (optional).
 
1997
 
 
1998
        :return: The found user.
 
1999
        """
 
2000
        credentials = self.get_credentials(scheme, host, port, user=None,
 
2001
                                           path=path, realm=realm)
 
2002
        if credentials is not None:
 
2003
            user = credentials['user']
 
2004
        else:
 
2005
            user = None
 
2006
        if user is None:
 
2007
            if ask:
 
2008
                if prompt is None:
 
2009
                    # Create a default prompt suitable for most cases
 
2010
                    prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
 
2011
                # Special handling for optional fields in the prompt
 
2012
                if port is not None:
 
2013
                    prompt_host = '%s:%d' % (host, port)
 
2014
                else:
 
2015
                    prompt_host = host
 
2016
                user = ui.ui_factory.get_username(prompt, host=prompt_host)
 
2017
            else:
 
2018
                user = default
 
2019
        return user
 
2020
 
 
2021
    def get_password(self, scheme, host, user, port=None,
 
2022
                     realm=None, path=None, prompt=None):
 
2023
        """Get a password from authentication file or prompt the user for one.
 
2024
 
 
2025
        :param scheme: protocol
 
2026
 
 
2027
        :param host: the server address
 
2028
 
 
2029
        :param port: the associated port (optional)
 
2030
 
 
2031
        :param user: login
 
2032
 
 
2033
        :param realm: the realm sent by the server (optional)
 
2034
 
 
2035
        :param path: the absolute path on the server (optional)
 
2036
 
 
2037
        :return: The found password or the one entered by the user.
 
2038
        """
 
2039
        credentials = self.get_credentials(scheme, host, port, user, path,
 
2040
                                           realm)
 
2041
        if credentials is not None:
 
2042
            password = credentials['password']
 
2043
            if password is not None and scheme is 'ssh':
 
2044
                trace.warning('password ignored in section [%s],'
 
2045
                              ' use an ssh agent instead'
 
2046
                              % credentials['name'])
 
2047
                password = None
 
2048
        else:
 
2049
            password = None
 
2050
        # Prompt user only if we could't find a password
 
2051
        if password is None:
 
2052
            if prompt is None:
 
2053
                # Create a default prompt suitable for most cases
 
2054
                prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
 
2055
            # Special handling for optional fields in the prompt
 
2056
            if port is not None:
 
2057
                prompt_host = '%s:%d' % (host, port)
 
2058
            else:
 
2059
                prompt_host = host
 
2060
            password = ui.ui_factory.get_password(prompt,
 
2061
                                                  host=prompt_host, user=user)
 
2062
        return password
 
2063
 
 
2064
    def decode_password(self, credentials, encoding):
 
2065
        try:
 
2066
            cs = credential_store_registry.get_credential_store(encoding)
 
2067
        except KeyError:
 
2068
            raise ValueError('%r is not a known password_encoding' % encoding)
 
2069
        credentials['password'] = cs.decode_password(credentials)
 
2070
        return credentials
 
2071
 
 
2072
 
 
2073
class CredentialStoreRegistry(registry.Registry):
 
2074
    """A class that registers credential stores.
 
2075
 
 
2076
    A credential store provides access to credentials via the password_encoding
 
2077
    field in authentication.conf sections.
 
2078
 
 
2079
    Except for stores provided by bzr itself, most stores are expected to be
 
2080
    provided by plugins that will therefore use
 
2081
    register_lazy(password_encoding, module_name, member_name, help=help,
 
2082
    fallback=fallback) to install themselves.
 
2083
 
 
2084
    A fallback credential store is one that is queried if no credentials can be
 
2085
    found via authentication.conf.
 
2086
    """
 
2087
 
 
2088
    def get_credential_store(self, encoding=None):
 
2089
        cs = self.get(encoding)
 
2090
        if callable(cs):
 
2091
            cs = cs()
 
2092
        return cs
 
2093
 
 
2094
    def is_fallback(self, name):
 
2095
        """Check if the named credentials store should be used as fallback."""
 
2096
        return self.get_info(name)
 
2097
 
 
2098
    def get_fallback_credentials(self, scheme, host, port=None, user=None,
 
2099
                                 path=None, realm=None):
 
2100
        """Request credentials from all fallback credentials stores.
 
2101
 
 
2102
        The first credentials store that can provide credentials wins.
 
2103
        """
 
2104
        credentials = None
 
2105
        for name in self.keys():
 
2106
            if not self.is_fallback(name):
 
2107
                continue
 
2108
            cs = self.get_credential_store(name)
 
2109
            credentials = cs.get_credentials(scheme, host, port, user,
 
2110
                                             path, realm)
 
2111
            if credentials is not None:
 
2112
                # We found some credentials
 
2113
                break
 
2114
        return credentials
 
2115
 
 
2116
    def register(self, key, obj, help=None, override_existing=False,
 
2117
                 fallback=False):
 
2118
        """Register a new object to a name.
 
2119
 
 
2120
        :param key: This is the key to use to request the object later.
 
2121
        :param obj: The object to register.
 
2122
        :param help: Help text for this entry. This may be a string or
 
2123
                a callable. If it is a callable, it should take two
 
2124
                parameters (registry, key): this registry and the key that
 
2125
                the help was registered under.
 
2126
        :param override_existing: Raise KeyErorr if False and something has
 
2127
                already been registered for that key. If True, ignore if there
 
2128
                is an existing key (always register the new value).
 
2129
        :param fallback: Whether this credential store should be 
 
2130
                used as fallback.
 
2131
        """
 
2132
        return super(CredentialStoreRegistry,
 
2133
                     self).register(key, obj, help, info=fallback,
 
2134
                                    override_existing=override_existing)
 
2135
 
 
2136
    def register_lazy(self, key, module_name, member_name,
 
2137
                      help=None, override_existing=False,
 
2138
                      fallback=False):
 
2139
        """Register a new credential store to be loaded on request.
 
2140
 
 
2141
        :param module_name: The python path to the module. Such as 'os.path'.
 
2142
        :param member_name: The member of the module to return.  If empty or
 
2143
                None, get() will return the module itself.
 
2144
        :param help: Help text for this entry. This may be a string or
 
2145
                a callable.
 
2146
        :param override_existing: If True, replace the existing object
 
2147
                with the new one. If False, if there is already something
 
2148
                registered with the same key, raise a KeyError
 
2149
        :param fallback: Whether this credential store should be 
 
2150
                used as fallback.
 
2151
        """
 
2152
        return super(CredentialStoreRegistry, self).register_lazy(
 
2153
            key, module_name, member_name, help,
 
2154
            info=fallback, override_existing=override_existing)
 
2155
 
 
2156
 
 
2157
credential_store_registry = CredentialStoreRegistry()
 
2158
 
 
2159
 
 
2160
class CredentialStore(object):
 
2161
    """An abstract class to implement storage for credentials"""
 
2162
 
 
2163
    def decode_password(self, credentials):
 
2164
        """Returns a clear text password for the provided credentials."""
 
2165
        raise NotImplementedError(self.decode_password)
 
2166
 
 
2167
    def get_credentials(self, scheme, host, port=None, user=None, path=None,
 
2168
                        realm=None):
 
2169
        """Return the matching credentials from this credential store.
 
2170
 
 
2171
        This method is only called on fallback credential stores.
 
2172
        """
 
2173
        raise NotImplementedError(self.get_credentials)
 
2174
 
 
2175
 
 
2176
 
 
2177
class PlainTextCredentialStore(CredentialStore):
 
2178
    __doc__ = """Plain text credential store for the authentication.conf file"""
 
2179
 
 
2180
    def decode_password(self, credentials):
 
2181
        """See CredentialStore.decode_password."""
 
2182
        return credentials['password']
 
2183
 
 
2184
 
 
2185
credential_store_registry.register('plain', PlainTextCredentialStore,
 
2186
                                   help=PlainTextCredentialStore.__doc__)
 
2187
credential_store_registry.default_key = 'plain'
 
2188
 
 
2189
 
 
2190
class BzrDirConfig(object):
 
2191
 
 
2192
    def __init__(self, bzrdir):
 
2193
        self._bzrdir = bzrdir
 
2194
        self._config = bzrdir._get_config()
 
2195
 
 
2196
    def set_default_stack_on(self, value):
 
2197
        """Set the default stacking location.
 
2198
 
 
2199
        It may be set to a location, or None.
 
2200
 
 
2201
        This policy affects all branches contained by this bzrdir, except for
 
2202
        those under repositories.
 
2203
        """
 
2204
        if self._config is None:
 
2205
            raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
 
2206
        if value is None:
 
2207
            self._config.set_option('', 'default_stack_on')
 
2208
        else:
 
2209
            self._config.set_option(value, 'default_stack_on')
 
2210
 
 
2211
    def get_default_stack_on(self):
 
2212
        """Return the default stacking location.
 
2213
 
 
2214
        This will either be a location, or None.
 
2215
 
 
2216
        This policy affects all branches contained by this bzrdir, except for
 
2217
        those under repositories.
 
2218
        """
 
2219
        if self._config is None:
 
2220
            return None
 
2221
        value = self._config.get_option('default_stack_on')
 
2222
        if value == '':
 
2223
            value = None
 
2224
        return value
 
2225
 
 
2226
 
 
2227
class TransportConfig(object):
 
2228
    """A Config that reads/writes a config file on a Transport.
 
2229
 
 
2230
    It is a low-level object that considers config data to be name/value pairs
 
2231
    that may be associated with a section.  Assigning meaning to these values
 
2232
    is done at higher levels like TreeConfig.
 
2233
    """
 
2234
 
 
2235
    def __init__(self, transport, filename):
 
2236
        self._transport = transport
 
2237
        self._filename = filename
 
2238
 
 
2239
    def get_option(self, name, section=None, default=None):
 
2240
        """Return the value associated with a named option.
 
2241
 
 
2242
        :param name: The name of the value
 
2243
        :param section: The section the option is in (if any)
 
2244
        :param default: The value to return if the value is not set
 
2245
        :return: The value or default value
 
2246
        """
 
2247
        configobj = self._get_configobj()
 
2248
        if section is None:
 
2249
            section_obj = configobj
 
2250
        else:
 
2251
            try:
 
2252
                section_obj = configobj[section]
 
2253
            except KeyError:
 
2254
                return default
 
2255
        value = section_obj.get(name, default)
 
2256
        for hook in OldConfigHooks['get']:
 
2257
            hook(self, name, value)
 
2258
        return value
 
2259
 
 
2260
    def set_option(self, value, name, section=None):
 
2261
        """Set the value associated with a named option.
 
2262
 
 
2263
        :param value: The value to set
 
2264
        :param name: The name of the value to set
 
2265
        :param section: The section the option is in (if any)
 
2266
        """
 
2267
        configobj = self._get_configobj()
 
2268
        if section is None:
 
2269
            configobj[name] = value
 
2270
        else:
 
2271
            configobj.setdefault(section, {})[name] = value
 
2272
        for hook in OldConfigHooks['set']:
 
2273
            hook(self, name, value)
 
2274
        self._set_configobj(configobj)
 
2275
 
 
2276
    def remove_option(self, option_name, section_name=None):
 
2277
        configobj = self._get_configobj()
 
2278
        if section_name is None:
 
2279
            del configobj[option_name]
 
2280
        else:
 
2281
            del configobj[section_name][option_name]
 
2282
        for hook in OldConfigHooks['remove']:
 
2283
            hook(self, option_name)
 
2284
        self._set_configobj(configobj)
 
2285
 
 
2286
    def _get_config_file(self):
 
2287
        try:
 
2288
            f = StringIO(self._transport.get_bytes(self._filename))
 
2289
            for hook in OldConfigHooks['load']:
 
2290
                hook(self)
 
2291
            return f
 
2292
        except errors.NoSuchFile:
 
2293
            return StringIO()
 
2294
        except errors.PermissionDenied, e:
 
2295
            trace.warning("Permission denied while trying to open "
 
2296
                "configuration file %s.", urlutils.unescape_for_display(
 
2297
                urlutils.join(self._transport.base, self._filename), "utf-8"))
 
2298
            return StringIO()
 
2299
 
 
2300
    def _external_url(self):
 
2301
        return urlutils.join(self._transport.external_url(), self._filename)
 
2302
 
 
2303
    def _get_configobj(self):
 
2304
        f = self._get_config_file()
 
2305
        try:
 
2306
            try:
 
2307
                conf = ConfigObj(f, encoding='utf-8')
 
2308
            except configobj.ConfigObjError, e:
 
2309
                raise errors.ParseConfigError(e.errors, self._external_url())
 
2310
            except UnicodeDecodeError:
 
2311
                raise errors.ConfigContentError(self._external_url())
 
2312
        finally:
 
2313
            f.close()
 
2314
        return conf
 
2315
 
 
2316
    def _set_configobj(self, configobj):
 
2317
        out_file = StringIO()
 
2318
        configobj.write(out_file)
 
2319
        out_file.seek(0)
 
2320
        self._transport.put_file(self._filename, out_file)
 
2321
        for hook in OldConfigHooks['save']:
 
2322
            hook(self)
 
2323
 
 
2324
 
 
2325
class Option(object):
 
2326
    """An option definition.
 
2327
 
 
2328
    The option *values* are stored in config files and found in sections.
 
2329
 
 
2330
    Here we define various properties about the option itself, its default
 
2331
    value, how to convert it from stores, what to do when invalid values are
 
2332
    encoutered, in which config files it can be stored.
 
2333
    """
 
2334
 
 
2335
    def __init__(self, name, override_from_env=None,
 
2336
                 default=None, default_from_env=None,
 
2337
                 help=None, from_unicode=None, invalid=None, unquote=True):
 
2338
        """Build an option definition.
 
2339
 
 
2340
        :param name: the name used to refer to the option.
 
2341
 
 
2342
        :param override_from_env: A list of environment variables which can
 
2343
           provide override any configuration setting.
 
2344
 
 
2345
        :param default: the default value to use when none exist in the config
 
2346
            stores. This is either a string that ``from_unicode`` will convert
 
2347
            into the proper type, a callable returning a unicode string so that
 
2348
            ``from_unicode`` can be used on the return value, or a python
 
2349
            object that can be stringified (so only the empty list is supported
 
2350
            for example).
 
2351
 
 
2352
        :param default_from_env: A list of environment variables which can
 
2353
           provide a default value. 'default' will be used only if none of the
 
2354
           variables specified here are set in the environment.
 
2355
 
 
2356
        :param help: a doc string to explain the option to the user.
 
2357
 
 
2358
        :param from_unicode: a callable to convert the unicode string
 
2359
            representing the option value in a store. This is not called for
 
2360
            the default value.
 
2361
 
 
2362
        :param invalid: the action to be taken when an invalid value is
 
2363
            encountered in a store. This is called only when from_unicode is
 
2364
            invoked to convert a string and returns None or raise ValueError or
 
2365
            TypeError. Accepted values are: None (ignore invalid values),
 
2366
            'warning' (emit a warning), 'error' (emit an error message and
 
2367
            terminates).
 
2368
 
 
2369
        :param unquote: should the unicode value be unquoted before conversion.
 
2370
           This should be used only when the store providing the values cannot
 
2371
           safely unquote them (see http://pad.lv/906897). It is provided so
 
2372
           daughter classes can handle the quoting themselves.
 
2373
        """
 
2374
        if override_from_env is None:
 
2375
            override_from_env = []
 
2376
        if default_from_env is None:
 
2377
            default_from_env = []
 
2378
        self.name = name
 
2379
        self.override_from_env = override_from_env
 
2380
        # Convert the default value to a unicode string so all values are
 
2381
        # strings internally before conversion (via from_unicode) is attempted.
 
2382
        if default is None:
 
2383
            self.default = None
 
2384
        elif isinstance(default, list):
 
2385
            # Only the empty list is supported
 
2386
            if default:
 
2387
                raise AssertionError(
 
2388
                    'Only empty lists are supported as default values')
 
2389
            self.default = u','
 
2390
        elif isinstance(default, (str, unicode, bool, int, float)):
 
2391
            # Rely on python to convert strings, booleans and integers
 
2392
            self.default = u'%s' % (default,)
 
2393
        elif callable(default):
 
2394
            self.default = default
 
2395
        else:
 
2396
            # other python objects are not expected
 
2397
            raise AssertionError('%r is not supported as a default value'
 
2398
                                 % (default,))
 
2399
        self.default_from_env = default_from_env
 
2400
        self.help = help
 
2401
        self.from_unicode = from_unicode
 
2402
        self.unquote = unquote
 
2403
        if invalid and invalid not in ('warning', 'error'):
 
2404
            raise AssertionError("%s not supported for 'invalid'" % (invalid,))
 
2405
        self.invalid = invalid
 
2406
 
 
2407
    def convert_from_unicode(self, store, unicode_value):
 
2408
        if self.unquote and store is not None and unicode_value is not None:
 
2409
            unicode_value = store.unquote(unicode_value)
 
2410
        if self.from_unicode is None or unicode_value is None:
 
2411
            # Don't convert or nothing to convert
 
2412
            return unicode_value
 
2413
        try:
 
2414
            converted = self.from_unicode(unicode_value)
 
2415
        except (ValueError, TypeError):
 
2416
            # Invalid values are ignored
 
2417
            converted = None
 
2418
        if converted is None and self.invalid is not None:
 
2419
            # The conversion failed
 
2420
            if self.invalid == 'warning':
 
2421
                trace.warning('Value "%s" is not valid for "%s"',
 
2422
                              unicode_value, self.name)
 
2423
            elif self.invalid == 'error':
 
2424
                raise errors.ConfigOptionValueError(self.name, unicode_value)
 
2425
        return converted
 
2426
 
 
2427
    def get_override(self):
 
2428
        value = None
 
2429
        for var in self.override_from_env:
 
2430
            try:
 
2431
                # If the env variable is defined, its value takes precedence
 
2432
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2433
                break
 
2434
            except KeyError:
 
2435
                continue
 
2436
        return value
 
2437
 
 
2438
    def get_default(self):
 
2439
        value = None
 
2440
        for var in self.default_from_env:
 
2441
            try:
 
2442
                # If the env variable is defined, its value is the default one
 
2443
                value = os.environ[var].decode(osutils.get_user_encoding())
 
2444
                break
 
2445
            except KeyError:
 
2446
                continue
 
2447
        if value is None:
 
2448
            # Otherwise, fallback to the value defined at registration
 
2449
            if callable(self.default):
 
2450
                value = self.default()
 
2451
                if not isinstance(value, unicode):
 
2452
                    raise AssertionError(
 
2453
                    'Callable default values should be unicode')
 
2454
            else:
 
2455
                value = self.default
 
2456
        return value
 
2457
 
 
2458
    def get_help_text(self, additional_see_also=None, plain=True):
 
2459
        result = self.help
 
2460
        from bzrlib import help_topics
 
2461
        result += help_topics._format_see_also(additional_see_also)
 
2462
        if plain:
 
2463
            result = help_topics.help_as_plain_text(result)
 
2464
        return result
 
2465
 
 
2466
 
 
2467
# Predefined converters to get proper values from store
 
2468
 
 
2469
def bool_from_store(unicode_str):
 
2470
    return ui.bool_from_string(unicode_str)
 
2471
 
 
2472
 
 
2473
def int_from_store(unicode_str):
 
2474
    return int(unicode_str)
 
2475
 
 
2476
 
 
2477
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
 
2478
 
 
2479
def int_SI_from_store(unicode_str):
 
2480
    """Convert a human readable size in SI units, e.g 10MB into an integer.
 
2481
 
 
2482
    Accepted suffixes are K,M,G. It is case-insensitive and may be followed
 
2483
    by a trailing b (i.e. Kb, MB). This is intended to be practical and not
 
2484
    pedantic.
 
2485
 
 
2486
    :return Integer, expanded to its base-10 value if a proper SI unit is 
 
2487
        found, None otherwise.
 
2488
    """
 
2489
    regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
 
2490
    p = re.compile(regexp, re.IGNORECASE)
 
2491
    m = p.match(unicode_str)
 
2492
    val = None
 
2493
    if m is not None:
 
2494
        val, _, unit = m.groups()
 
2495
        val = int(val)
 
2496
        if unit:
 
2497
            try:
 
2498
                coeff = _unit_suffixes[unit.upper()]
 
2499
            except KeyError:
 
2500
                raise ValueError(gettext('{0} is not an SI unit.').format(unit))
 
2501
            val *= coeff
 
2502
    return val
 
2503
 
 
2504
 
 
2505
def float_from_store(unicode_str):
 
2506
    return float(unicode_str)
 
2507
 
 
2508
 
 
2509
# Use a an empty dict to initialize an empty configobj avoiding all
 
2510
# parsing and encoding checks
 
2511
_list_converter_config = configobj.ConfigObj(
 
2512
    {}, encoding='utf-8', list_values=True, interpolation=False)
 
2513
 
 
2514
 
 
2515
class ListOption(Option):
 
2516
 
 
2517
    def __init__(self, name, default=None, default_from_env=None,
 
2518
                 help=None, invalid=None):
 
2519
        """A list Option definition.
 
2520
 
 
2521
        This overrides the base class so the conversion from a unicode string
 
2522
        can take quoting into account.
 
2523
        """
 
2524
        super(ListOption, self).__init__(
 
2525
            name, default=default, default_from_env=default_from_env,
 
2526
            from_unicode=self.from_unicode, help=help,
 
2527
            invalid=invalid, unquote=False)
 
2528
 
 
2529
    def from_unicode(self, unicode_str):
 
2530
        if not isinstance(unicode_str, basestring):
 
2531
            raise TypeError
 
2532
        # Now inject our string directly as unicode. All callers got their
 
2533
        # value from configobj, so values that need to be quoted are already
 
2534
        # properly quoted.
 
2535
        _list_converter_config.reset()
 
2536
        _list_converter_config._parse([u"list=%s" % (unicode_str,)])
 
2537
        maybe_list = _list_converter_config['list']
 
2538
        if isinstance(maybe_list, basestring):
 
2539
            if maybe_list:
 
2540
                # A single value, most probably the user forgot (or didn't care
 
2541
                # to add) the final ','
 
2542
                l = [maybe_list]
 
2543
            else:
 
2544
                # The empty string, convert to empty list
 
2545
                l = []
 
2546
        else:
 
2547
            # We rely on ConfigObj providing us with a list already
 
2548
            l = maybe_list
 
2549
        return l
 
2550
 
 
2551
 
 
2552
class OptionRegistry(registry.Registry):
 
2553
    """Register config options by their name.
 
2554
 
 
2555
    This overrides ``registry.Registry`` to simplify registration by acquiring
 
2556
    some information from the option object itself.
 
2557
    """
 
2558
 
 
2559
    def register(self, option):
 
2560
        """Register a new option to its name.
 
2561
 
 
2562
        :param option: The option to register. Its name is used as the key.
 
2563
        """
 
2564
        super(OptionRegistry, self).register(option.name, option,
 
2565
                                             help=option.help)
 
2566
 
 
2567
    def register_lazy(self, key, module_name, member_name):
 
2568
        """Register a new option to be loaded on request.
 
2569
 
 
2570
        :param key: the key to request the option later. Since the registration
 
2571
            is lazy, it should be provided and match the option name.
 
2572
 
 
2573
        :param module_name: the python path to the module. Such as 'os.path'.
 
2574
 
 
2575
        :param member_name: the member of the module to return.  If empty or 
 
2576
                None, get() will return the module itself.
 
2577
        """
 
2578
        super(OptionRegistry, self).register_lazy(key,
 
2579
                                                  module_name, member_name)
 
2580
 
 
2581
    def get_help(self, key=None):
 
2582
        """Get the help text associated with the given key"""
 
2583
        option = self.get(key)
 
2584
        the_help = option.help
 
2585
        if callable(the_help):
 
2586
            return the_help(self, key)
 
2587
        return the_help
 
2588
 
 
2589
 
 
2590
option_registry = OptionRegistry()
 
2591
 
 
2592
 
 
2593
# Registered options in lexicographical order
 
2594
 
 
2595
option_registry.register(
 
2596
    Option('append_revisions_only',
 
2597
           default=None, from_unicode=bool_from_store, invalid='warning',
 
2598
           help='''\
 
2599
Whether to only append revisions to the mainline.
 
2600
 
 
2601
If this is set to true, then it is not possible to change the
 
2602
existing mainline of the branch.
 
2603
'''))
 
2604
option_registry.register(
 
2605
    ListOption('acceptable_keys',
 
2606
           default=None,
 
2607
           help="""\
 
2608
List of GPG key patterns which are acceptable for verification.
 
2609
"""))
 
2610
option_registry.register(
 
2611
    Option('add.maximum_file_size',
 
2612
           default=u'20MB', from_unicode=int_SI_from_store,
 
2613
           help="""\
 
2614
Size above which files should be added manually.
 
2615
 
 
2616
Files below this size are added automatically when using ``bzr add`` without
 
2617
arguments.
 
2618
 
 
2619
A negative value means disable the size check.
 
2620
"""))
 
2621
option_registry.register(
 
2622
    Option('bound',
 
2623
           default=None, from_unicode=bool_from_store,
 
2624
           help="""\
 
2625
Is the branch bound to ``bound_location``.
 
2626
 
 
2627
If set to "True", the branch should act as a checkout, and push each commit to
 
2628
the bound_location.  This option is normally set by ``bind``/``unbind``.
 
2629
 
 
2630
See also: bound_location.
 
2631
"""))
 
2632
option_registry.register(
 
2633
    Option('bound_location',
 
2634
           default=None,
 
2635
           help="""\
 
2636
The location that commits should go to when acting as a checkout.
 
2637
 
 
2638
This option is normally set by ``bind``.
 
2639
 
 
2640
See also: bound.
 
2641
"""))
 
2642
option_registry.register(
 
2643
    Option('branch.fetch_tags', default=False,  from_unicode=bool_from_store,
 
2644
           help="""\
 
2645
Whether revisions associated with tags should be fetched.
 
2646
"""))
 
2647
option_registry.register(
 
2648
    Option('bzr.workingtree.worth_saving_limit', default=10,
 
2649
           from_unicode=int_from_store,  invalid='warning',
 
2650
           help='''\
 
2651
How many changes before saving the dirstate.
 
2652
 
 
2653
-1 means that we will never rewrite the dirstate file for only
 
2654
stat-cache changes. Regardless of this setting, we will always rewrite
 
2655
the dirstate file if a file is added/removed/renamed/etc. This flag only
 
2656
affects the behavior of updating the dirstate file after we notice that
 
2657
a file has been touched.
 
2658
'''))
 
2659
option_registry.register(
 
2660
    Option('check_signatures', default=CHECK_IF_POSSIBLE,
 
2661
           from_unicode=signature_policy_from_unicode,
 
2662
           help='''\
 
2663
GPG checking policy.
 
2664
 
 
2665
Possible values: require, ignore, check-available (default)
 
2666
 
 
2667
this option will control whether bzr will require good gpg
 
2668
signatures, ignore them, or check them if they are
 
2669
present.
 
2670
'''))
 
2671
option_registry.register(
 
2672
    Option('create_signatures', default=SIGN_WHEN_REQUIRED,
 
2673
           from_unicode=signing_policy_from_unicode,
 
2674
           help='''\
 
2675
GPG Signing policy.
 
2676
 
 
2677
Possible values: always, never, when-required (default)
 
2678
 
 
2679
This option controls whether bzr will always create
 
2680
gpg signatures or not on commits.
 
2681
'''))
 
2682
option_registry.register(
 
2683
    Option('dirstate.fdatasync', default=True,
 
2684
           from_unicode=bool_from_store,
 
2685
           help='''\
 
2686
Flush dirstate changes onto physical disk?
 
2687
 
 
2688
If true (default), working tree metadata changes are flushed through the
 
2689
OS buffers to physical disk.  This is somewhat slower, but means data
 
2690
should not be lost if the machine crashes.  See also repository.fdatasync.
 
2691
'''))
 
2692
option_registry.register(
 
2693
    ListOption('debug_flags', default=[],
 
2694
           help='Debug flags to activate.'))
 
2695
option_registry.register(
 
2696
    Option('default_format', default='2a',
 
2697
           help='Format used when creating branches.'))
 
2698
option_registry.register(
 
2699
    Option('dpush_strict', default=None,
 
2700
           from_unicode=bool_from_store,
 
2701
           help='''\
 
2702
The default value for ``dpush --strict``.
 
2703
 
 
2704
If present, defines the ``--strict`` option default value for checking
 
2705
uncommitted changes before pushing into a different VCS without any
 
2706
custom bzr metadata.
 
2707
'''))
 
2708
option_registry.register(
 
2709
    Option('editor',
 
2710
           help='The command called to launch an editor to enter a message.'))
 
2711
option_registry.register(
 
2712
    Option('email', override_from_env=['BZR_EMAIL'], default=default_email,
 
2713
           help='The users identity'))
 
2714
option_registry.register(
 
2715
    Option('gpg_signing_command',
 
2716
           default='gpg',
 
2717
           help="""\
 
2718
Program to use use for creating signatures.
 
2719
 
 
2720
This should support at least the -u and --clearsign options.
 
2721
"""))
 
2722
option_registry.register(
 
2723
    Option('gpg_signing_key',
 
2724
           default=None,
 
2725
           help="""\
 
2726
GPG key to use for signing.
 
2727
 
 
2728
This defaults to the first key associated with the users email.
 
2729
"""))
 
2730
option_registry.register(
 
2731
    Option('ignore_missing_extensions', default=False,
 
2732
           from_unicode=bool_from_store,
 
2733
           help='''\
 
2734
Control the missing extensions warning display.
 
2735
 
 
2736
The warning will not be emitted if set to True.
 
2737
'''))
 
2738
option_registry.register(
 
2739
    Option('language',
 
2740
           help='Language to translate messages into.'))
 
2741
option_registry.register(
 
2742
    Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
 
2743
           help='''\
 
2744
Steal locks that appears to be dead.
 
2745
 
 
2746
If set to True, bzr will check if a lock is supposed to be held by an
 
2747
active process from the same user on the same machine. If the user and
 
2748
machine match, but no process with the given PID is active, then bzr
 
2749
will automatically break the stale lock, and create a new lock for
 
2750
this process.
 
2751
Otherwise, bzr will prompt as normal to break the lock.
 
2752
'''))
 
2753
option_registry.register(
 
2754
    Option('log_format', default='long',
 
2755
           help= '''\
 
2756
Log format to use when displaying revisions.
 
2757
 
 
2758
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
 
2759
may be provided by plugins.
 
2760
'''))
 
2761
option_registry.register(
 
2762
    Option('output_encoding',
 
2763
           help= 'Unicode encoding for output'
 
2764
           ' (terminal encoding if not specified).'))
 
2765
option_registry.register(
 
2766
    Option('parent_location',
 
2767
           default=None,
 
2768
           help="""\
 
2769
The location of the default branch for pull or merge.
 
2770
 
 
2771
This option is normally set when creating a branch, the first ``pull`` or by
 
2772
``pull --remember``.
 
2773
"""))
 
2774
option_registry.register(
 
2775
    Option('post_commit', default=None,
 
2776
           help='''\
 
2777
Post commit functions.
 
2778
 
 
2779
An ordered list of python functions to call, separated by spaces.
 
2780
 
 
2781
Each function takes branch, rev_id as parameters.
 
2782
'''))
 
2783
option_registry.register(
 
2784
    Option('public_branch',
 
2785
           default=None,
 
2786
           help="""\
 
2787
A publically-accessible version of this branch.
 
2788
 
 
2789
This implies that the branch setting this option is not publically-accessible.
 
2790
Used and set by ``bzr send``.
 
2791
"""))
 
2792
option_registry.register(
 
2793
    Option('push_location',
 
2794
           default=None,
 
2795
           help="""\
 
2796
The location of the default branch for push.
 
2797
 
 
2798
This option is normally set by the first ``push`` or ``push --remember``.
 
2799
"""))
 
2800
option_registry.register(
 
2801
    Option('push_strict', default=None,
 
2802
           from_unicode=bool_from_store,
 
2803
           help='''\
 
2804
The default value for ``push --strict``.
 
2805
 
 
2806
If present, defines the ``--strict`` option default value for checking
 
2807
uncommitted changes before sending a merge directive.
 
2808
'''))
 
2809
option_registry.register(
 
2810
    Option('repository.fdatasync', default=True,
 
2811
           from_unicode=bool_from_store,
 
2812
           help='''\
 
2813
Flush repository changes onto physical disk?
 
2814
 
 
2815
If true (default), repository changes are flushed through the OS buffers
 
2816
to physical disk.  This is somewhat slower, but means data should not be
 
2817
lost if the machine crashes.  See also dirstate.fdatasync.
 
2818
'''))
 
2819
option_registry.register_lazy('smtp_server',
 
2820
    'bzrlib.smtp_connection', 'smtp_server')
 
2821
option_registry.register_lazy('smtp_password',
 
2822
    'bzrlib.smtp_connection', 'smtp_password')
 
2823
option_registry.register_lazy('smtp_username',
 
2824
    'bzrlib.smtp_connection', 'smtp_username')
 
2825
option_registry.register(
 
2826
    Option('selftest.timeout',
 
2827
        default='600',
 
2828
        from_unicode=int_from_store,
 
2829
        help='Abort selftest if one test takes longer than this many seconds',
 
2830
        ))
 
2831
 
 
2832
option_registry.register(
 
2833
    Option('send_strict', default=None,
 
2834
           from_unicode=bool_from_store,
 
2835
           help='''\
 
2836
The default value for ``send --strict``.
 
2837
 
 
2838
If present, defines the ``--strict`` option default value for checking
 
2839
uncommitted changes before sending a bundle.
 
2840
'''))
 
2841
 
 
2842
option_registry.register(
 
2843
    Option('serve.client_timeout',
 
2844
           default=300.0, from_unicode=float_from_store,
 
2845
           help="If we wait for a new request from a client for more than"
 
2846
                " X seconds, consider the client idle, and hangup."))
 
2847
option_registry.register(
 
2848
    Option('stacked_on_location',
 
2849
           default=None,
 
2850
           help="""The location where this branch is stacked on."""))
 
2851
option_registry.register(
 
2852
    Option('submit_branch',
 
2853
           default=None,
 
2854
           help="""\
 
2855
The branch you intend to submit your current work to.
 
2856
 
 
2857
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
 
2858
by the ``submit:`` revision spec.
 
2859
"""))
 
2860
 
 
2861
 
 
2862
class Section(object):
 
2863
    """A section defines a dict of option name => value.
 
2864
 
 
2865
    This is merely a read-only dict which can add some knowledge about the
 
2866
    options. It is *not* a python dict object though and doesn't try to mimic
 
2867
    its API.
 
2868
    """
 
2869
 
 
2870
    def __init__(self, section_id, options):
 
2871
        self.id = section_id
 
2872
        # We re-use the dict-like object received
 
2873
        self.options = options
 
2874
 
 
2875
    def get(self, name, default=None, expand=True):
 
2876
        return self.options.get(name, default)
 
2877
 
 
2878
    def iter_option_names(self):
 
2879
        for k in self.options.iterkeys():
 
2880
            yield k
 
2881
 
 
2882
    def __repr__(self):
 
2883
        # Mostly for debugging use
 
2884
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
 
2885
 
 
2886
 
 
2887
_NewlyCreatedOption = object()
 
2888
"""Was the option created during the MutableSection lifetime"""
 
2889
 
 
2890
 
 
2891
class MutableSection(Section):
 
2892
    """A section allowing changes and keeping track of the original values."""
 
2893
 
 
2894
    def __init__(self, section_id, options):
 
2895
        super(MutableSection, self).__init__(section_id, options)
 
2896
        self.orig = {}
 
2897
 
 
2898
    def set(self, name, value):
 
2899
        if name not in self.options:
 
2900
            # This is a new option
 
2901
            self.orig[name] = _NewlyCreatedOption
 
2902
        elif name not in self.orig:
 
2903
            self.orig[name] = self.get(name, None)
 
2904
        self.options[name] = value
 
2905
 
 
2906
    def remove(self, name):
 
2907
        if name not in self.orig:
 
2908
            self.orig[name] = self.get(name, None)
 
2909
        del self.options[name]
 
2910
 
 
2911
 
 
2912
class Store(object):
 
2913
    """Abstract interface to persistent storage for configuration options."""
 
2914
 
 
2915
    readonly_section_class = Section
 
2916
    mutable_section_class = MutableSection
 
2917
 
 
2918
    def is_loaded(self):
 
2919
        """Returns True if the Store has been loaded.
 
2920
 
 
2921
        This is used to implement lazy loading and ensure the persistent
 
2922
        storage is queried only when needed.
 
2923
        """
 
2924
        raise NotImplementedError(self.is_loaded)
 
2925
 
 
2926
    def load(self):
 
2927
        """Loads the Store from persistent storage."""
 
2928
        raise NotImplementedError(self.load)
 
2929
 
 
2930
    def _load_from_string(self, bytes):
 
2931
        """Create a store from a string in configobj syntax.
 
2932
 
 
2933
        :param bytes: A string representing the file content.
 
2934
        """
 
2935
        raise NotImplementedError(self._load_from_string)
 
2936
 
 
2937
    def unload(self):
 
2938
        """Unloads the Store.
 
2939
 
 
2940
        This should make is_loaded() return False. This is used when the caller
 
2941
        knows that the persistent storage has changed or may have change since
 
2942
        the last load.
 
2943
        """
 
2944
        raise NotImplementedError(self.unload)
 
2945
 
 
2946
    def quote(self, value):
 
2947
        """Quote a configuration option value for storing purposes.
 
2948
 
 
2949
        This allows Stacks to present values as they will be stored.
 
2950
        """
 
2951
        return value
 
2952
 
 
2953
    def unquote(self, value):
 
2954
        """Unquote a configuration option value into unicode.
 
2955
 
 
2956
        The received value is quoted as stored.
 
2957
        """
 
2958
        return value
 
2959
 
 
2960
    def save(self):
 
2961
        """Saves the Store to persistent storage."""
 
2962
        raise NotImplementedError(self.save)
 
2963
 
 
2964
    def external_url(self):
 
2965
        raise NotImplementedError(self.external_url)
 
2966
 
 
2967
    def get_sections(self):
 
2968
        """Returns an ordered iterable of existing sections.
 
2969
 
 
2970
        :returns: An iterable of (store, section).
 
2971
        """
 
2972
        raise NotImplementedError(self.get_sections)
 
2973
 
 
2974
    def get_mutable_section(self, section_id=None):
 
2975
        """Returns the specified mutable section.
 
2976
 
 
2977
        :param section_id: The section identifier
 
2978
        """
 
2979
        raise NotImplementedError(self.get_mutable_section)
 
2980
 
 
2981
    def __repr__(self):
 
2982
        # Mostly for debugging use
 
2983
        return "<config.%s(%s)>" % (self.__class__.__name__,
 
2984
                                    self.external_url())
 
2985
 
 
2986
 
 
2987
class CommandLineStore(Store):
 
2988
    "A store to carry command line overrides for the config options."""
 
2989
 
 
2990
    def __init__(self, opts=None):
 
2991
        super(CommandLineStore, self).__init__()
 
2992
        if opts is None:
 
2993
            opts = {}
 
2994
        self.options = {}
 
2995
        self.id = 'cmdline'
 
2996
 
 
2997
    def _reset(self):
 
2998
        # The dict should be cleared but not replaced so it can be shared.
 
2999
        self.options.clear()
 
3000
 
 
3001
    def _from_cmdline(self, overrides):
 
3002
        # Reset before accepting new definitions
 
3003
        self._reset()
 
3004
        for over in overrides:
 
3005
            try:
 
3006
                name, value = over.split('=', 1)
 
3007
            except ValueError:
 
3008
                raise errors.BzrCommandError(
 
3009
                    gettext("Invalid '%s', should be of the form 'name=value'")
 
3010
                    % (over,))
 
3011
            self.options[name] = value
 
3012
 
 
3013
    def external_url(self):
 
3014
        # Not an url but it makes debugging easier and is never needed
 
3015
        # otherwise
 
3016
        return 'cmdline'
 
3017
 
 
3018
    def get_sections(self):
 
3019
        yield self,  self.readonly_section_class(None, self.options)
 
3020
 
 
3021
 
 
3022
class IniFileStore(Store):
 
3023
    """A config Store using ConfigObj for storage.
 
3024
 
 
3025
    :ivar transport: The transport object where the config file is located.
 
3026
 
 
3027
    :ivar file_name: The config file basename in the transport directory.
 
3028
 
 
3029
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
 
3030
        serialize/deserialize the config file.
 
3031
    """
 
3032
 
 
3033
    def __init__(self):
 
3034
        """A config Store using ConfigObj for storage.
 
3035
        """
 
3036
        super(IniFileStore, self).__init__()
 
3037
        self._config_obj = None
 
3038
 
 
3039
    def is_loaded(self):
 
3040
        return self._config_obj != None
 
3041
 
 
3042
    def unload(self):
 
3043
        self._config_obj = None
 
3044
 
 
3045
    def _load_content(self):
 
3046
        """Load the config file bytes.
 
3047
 
 
3048
        This should be provided by subclasses
 
3049
 
 
3050
        :return: Byte string
 
3051
        """
 
3052
        raise NotImplementedError(self._load_content)
 
3053
 
 
3054
    def _save_content(self, content):
 
3055
        """Save the config file bytes.
 
3056
 
 
3057
        This should be provided by subclasses
 
3058
 
 
3059
        :param content: Config file bytes to write
 
3060
        """
 
3061
        raise NotImplementedError(self._save_content)
 
3062
 
 
3063
    def load(self):
 
3064
        """Load the store from the associated file."""
 
3065
        if self.is_loaded():
 
3066
            return
 
3067
        content = self._load_content()
 
3068
        self._load_from_string(content)
 
3069
        for hook in ConfigHooks['load']:
 
3070
            hook(self)
 
3071
 
 
3072
    def _load_from_string(self, bytes):
 
3073
        """Create a config store from a string.
 
3074
 
 
3075
        :param bytes: A string representing the file content.
 
3076
        """
 
3077
        if self.is_loaded():
 
3078
            raise AssertionError('Already loaded: %r' % (self._config_obj,))
 
3079
        co_input = StringIO(bytes)
 
3080
        try:
 
3081
            # The config files are always stored utf8-encoded
 
3082
            self._config_obj = ConfigObj(co_input, encoding='utf-8',
 
3083
                                         list_values=False)
 
3084
        except configobj.ConfigObjError, e:
 
3085
            self._config_obj = None
 
3086
            raise errors.ParseConfigError(e.errors, self.external_url())
 
3087
        except UnicodeDecodeError:
 
3088
            raise errors.ConfigContentError(self.external_url())
 
3089
 
 
3090
    def save(self):
 
3091
        if not self.is_loaded():
 
3092
            # Nothing to save
 
3093
            return
 
3094
        out = StringIO()
 
3095
        self._config_obj.write(out)
 
3096
        self._save_content(out.getvalue())
 
3097
        for hook in ConfigHooks['save']:
 
3098
            hook(self)
 
3099
 
 
3100
    def get_sections(self):
 
3101
        """Get the configobj section in the file order.
 
3102
 
 
3103
        :returns: An iterable of (store, section).
 
3104
        """
 
3105
        # We need a loaded store
 
3106
        try:
 
3107
            self.load()
 
3108
        except (errors.NoSuchFile, errors.PermissionDenied):
 
3109
            # If the file can't be read, there is no sections
 
3110
            return
 
3111
        cobj = self._config_obj
 
3112
        if cobj.scalars:
 
3113
            yield self, self.readonly_section_class(None, cobj)
 
3114
        for section_name in cobj.sections:
 
3115
            yield (self,
 
3116
                   self.readonly_section_class(section_name,
 
3117
                                               cobj[section_name]))
 
3118
 
 
3119
    def get_mutable_section(self, section_id=None):
 
3120
        # We need a loaded store
 
3121
        try:
 
3122
            self.load()
 
3123
        except errors.NoSuchFile:
 
3124
            # The file doesn't exist, let's pretend it was empty
 
3125
            self._load_from_string('')
 
3126
        if section_id is None:
 
3127
            section = self._config_obj
 
3128
        else:
 
3129
            section = self._config_obj.setdefault(section_id, {})
 
3130
        return self.mutable_section_class(section_id, section)
 
3131
 
 
3132
    def quote(self, value):
 
3133
        try:
 
3134
            # configobj conflates automagical list values and quoting
 
3135
            self._config_obj.list_values = True
 
3136
            return self._config_obj._quote(value)
 
3137
        finally:
 
3138
            self._config_obj.list_values = False
 
3139
 
 
3140
    def unquote(self, value):
 
3141
        if value and isinstance(value, basestring):
 
3142
            # _unquote doesn't handle None nor empty strings nor anything that
 
3143
            # is not a string, really.
 
3144
            value = self._config_obj._unquote(value)
 
3145
        return value
 
3146
 
 
3147
 
 
3148
class TransportIniFileStore(IniFileStore):
 
3149
    """IniFileStore that loads files from a transport.
 
3150
    """
 
3151
 
 
3152
    def __init__(self, transport, file_name):
 
3153
        """A Store using a ini file on a Transport
 
3154
 
 
3155
        :param transport: The transport object where the config file is located.
 
3156
        :param file_name: The config file basename in the transport directory.
 
3157
        """
 
3158
        super(TransportIniFileStore, self).__init__()
 
3159
        self.transport = transport
 
3160
        self.file_name = file_name
 
3161
 
 
3162
    def _load_content(self):
 
3163
        try:
 
3164
            return self.transport.get_bytes(self.file_name)
 
3165
        except errors.PermissionDenied:
 
3166
            trace.warning("Permission denied while trying to load "
 
3167
                          "configuration store %s.", self.external_url())
 
3168
            raise
 
3169
 
 
3170
    def _save_content(self, content):
 
3171
        self.transport.put_bytes(self.file_name, content)
 
3172
 
 
3173
    def external_url(self):
 
3174
        # FIXME: external_url should really accepts an optional relpath
 
3175
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
3176
        # The following will do in the interim but maybe we don't want to
 
3177
        # expose a path here but rather a config ID and its associated
 
3178
        # object </hand wawe>.
 
3179
        return urlutils.join(self.transport.external_url(), self.file_name)
 
3180
 
 
3181
 
 
3182
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
 
3183
# unlockable stores for use with objects that can already ensure the locking
 
3184
# (think branches). If different stores (not based on ConfigObj) are created,
 
3185
# they may face the same issue.
 
3186
 
 
3187
 
 
3188
class LockableIniFileStore(TransportIniFileStore):
 
3189
    """A ConfigObjStore using locks on save to ensure store integrity."""
 
3190
 
 
3191
    def __init__(self, transport, file_name, lock_dir_name=None):
 
3192
        """A config Store using ConfigObj for storage.
 
3193
 
 
3194
        :param transport: The transport object where the config file is located.
 
3195
 
 
3196
        :param file_name: The config file basename in the transport directory.
 
3197
        """
 
3198
        if lock_dir_name is None:
 
3199
            lock_dir_name = 'lock'
 
3200
        self.lock_dir_name = lock_dir_name
 
3201
        super(LockableIniFileStore, self).__init__(transport, file_name)
 
3202
        self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
 
3203
 
 
3204
    def lock_write(self, token=None):
 
3205
        """Takes a write lock in the directory containing the config file.
 
3206
 
 
3207
        If the directory doesn't exist it is created.
 
3208
        """
 
3209
        # FIXME: This doesn't check the ownership of the created directories as
 
3210
        # ensure_config_dir_exists does. It should if the transport is local
 
3211
        # -- vila 2011-04-06
 
3212
        self.transport.create_prefix()
 
3213
        return self._lock.lock_write(token)
 
3214
 
 
3215
    def unlock(self):
 
3216
        self._lock.unlock()
 
3217
 
 
3218
    def break_lock(self):
 
3219
        self._lock.break_lock()
 
3220
 
 
3221
    @needs_write_lock
 
3222
    def save(self):
 
3223
        # We need to be able to override the undecorated implementation
 
3224
        self.save_without_locking()
 
3225
 
 
3226
    def save_without_locking(self):
 
3227
        super(LockableIniFileStore, self).save()
 
3228
 
 
3229
 
 
3230
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
 
3231
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
 
3232
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
 
3233
 
 
3234
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
 
3235
# functions or a registry will make it easier and clearer for tests, focusing
 
3236
# on the relevant parts of the API that needs testing -- vila 20110503 (based
 
3237
# on a poolie's remark)
 
3238
class GlobalStore(LockableIniFileStore):
 
3239
 
 
3240
    def __init__(self, possible_transports=None):
 
3241
        t = transport.get_transport_from_path(
 
3242
            config_dir(), possible_transports=possible_transports)
 
3243
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
3244
        self.id = 'bazaar'
 
3245
 
 
3246
 
 
3247
class LocationStore(LockableIniFileStore):
 
3248
 
 
3249
    def __init__(self, possible_transports=None):
 
3250
        t = transport.get_transport_from_path(
 
3251
            config_dir(), possible_transports=possible_transports)
 
3252
        super(LocationStore, self).__init__(t, 'locations.conf')
 
3253
        self.id = 'locations'
 
3254
 
 
3255
 
 
3256
class BranchStore(TransportIniFileStore):
 
3257
 
 
3258
    def __init__(self, branch):
 
3259
        super(BranchStore, self).__init__(branch.control_transport,
 
3260
                                          'branch.conf')
 
3261
        self.branch = branch
 
3262
        self.id = 'branch'
 
3263
 
 
3264
    def lock_write(self, token=None):
 
3265
        return self.branch.lock_write(token)
 
3266
 
 
3267
    def unlock(self):
 
3268
        return self.branch.unlock()
 
3269
 
 
3270
    @needs_write_lock
 
3271
    def save(self):
 
3272
        # We need to be able to override the undecorated implementation
 
3273
        self.save_without_locking()
 
3274
 
 
3275
    def save_without_locking(self):
 
3276
        super(BranchStore, self).save()
 
3277
 
 
3278
 
 
3279
class ControlStore(LockableIniFileStore):
 
3280
 
 
3281
    def __init__(self, bzrdir):
 
3282
        super(ControlStore, self).__init__(bzrdir.transport,
 
3283
                                          'control.conf',
 
3284
                                           lock_dir_name='branch_lock')
 
3285
        self.id = 'control'
 
3286
 
 
3287
 
 
3288
class SectionMatcher(object):
 
3289
    """Select sections into a given Store.
 
3290
 
 
3291
    This is intended to be used to postpone getting an iterable of sections
 
3292
    from a store.
 
3293
    """
 
3294
 
 
3295
    def __init__(self, store):
 
3296
        self.store = store
 
3297
 
 
3298
    def get_sections(self):
 
3299
        # This is where we require loading the store so we can see all defined
 
3300
        # sections.
 
3301
        sections = self.store.get_sections()
 
3302
        # Walk the revisions in the order provided
 
3303
        for store, s in sections:
 
3304
            if self.match(s):
 
3305
                yield store, s
 
3306
 
 
3307
    def match(self, section):
 
3308
        """Does the proposed section match.
 
3309
 
 
3310
        :param section: A Section object.
 
3311
 
 
3312
        :returns: True if the section matches, False otherwise.
 
3313
        """
 
3314
        raise NotImplementedError(self.match)
 
3315
 
 
3316
 
 
3317
class NameMatcher(SectionMatcher):
 
3318
 
 
3319
    def __init__(self, store, section_id):
 
3320
        super(NameMatcher, self).__init__(store)
 
3321
        self.section_id = section_id
 
3322
 
 
3323
    def match(self, section):
 
3324
        return section.id == self.section_id
 
3325
 
 
3326
 
 
3327
class LocationSection(Section):
 
3328
 
 
3329
    def __init__(self, section, length, extra_path):
 
3330
        super(LocationSection, self).__init__(section.id, section.options)
 
3331
        self.length = length
 
3332
        self.extra_path = extra_path
 
3333
        self.locals = {'relpath': extra_path,
 
3334
                       'basename': urlutils.basename(extra_path)}
 
3335
 
 
3336
    def get(self, name, default=None, expand=True):
 
3337
        value = super(LocationSection, self).get(name, default)
 
3338
        if value is not None and expand:
 
3339
            policy_name = self.get(name + ':policy', None)
 
3340
            policy = _policy_value.get(policy_name, POLICY_NONE)
 
3341
            if policy == POLICY_APPENDPATH:
 
3342
                value = urlutils.join(value, self.extra_path)
 
3343
            # expand section local options right now (since POLICY_APPENDPATH
 
3344
            # will never add options references, it's ok to expand after it).
 
3345
            chunks = []
 
3346
            for is_ref, chunk in iter_option_refs(value):
 
3347
                if not is_ref:
 
3348
                    chunks.append(chunk)
 
3349
                else:
 
3350
                    ref = chunk[1:-1]
 
3351
                    if ref in self.locals:
 
3352
                        chunks.append(self.locals[ref])
 
3353
                    else:
 
3354
                        chunks.append(chunk)
 
3355
            value = ''.join(chunks)
 
3356
        return value
 
3357
 
 
3358
 
 
3359
class LocationMatcher(SectionMatcher):
 
3360
 
 
3361
    def __init__(self, store, location):
 
3362
        super(LocationMatcher, self).__init__(store)
 
3363
        if location.startswith('file://'):
 
3364
            location = urlutils.local_path_from_url(location)
 
3365
        self.location = location
 
3366
 
 
3367
    def _get_matching_sections(self):
 
3368
        """Get all sections matching ``location``."""
 
3369
        # We slightly diverge from LocalConfig here by allowing the no-name
 
3370
        # section as the most generic one and the lower priority.
 
3371
        no_name_section = None
 
3372
        all_sections = []
 
3373
        # Filter out the no_name_section so _iter_for_location_by_parts can be
 
3374
        # used (it assumes all sections have a name).
 
3375
        for _, section in self.store.get_sections():
 
3376
            if section.id is None:
 
3377
                no_name_section = section
 
3378
            else:
 
3379
                all_sections.append(section)
 
3380
        # Unfortunately _iter_for_location_by_parts deals with section names so
 
3381
        # we have to resync.
 
3382
        filtered_sections = _iter_for_location_by_parts(
 
3383
            [s.id for s in all_sections], self.location)
 
3384
        iter_all_sections = iter(all_sections)
 
3385
        matching_sections = []
 
3386
        if no_name_section is not None:
 
3387
            matching_sections.append(
 
3388
                LocationSection(no_name_section, 0, self.location))
 
3389
        for section_id, extra_path, length in filtered_sections:
 
3390
            # a section id is unique for a given store so it's safe to take the
 
3391
            # first matching section while iterating. Also, all filtered
 
3392
            # sections are part of 'all_sections' and will always be found
 
3393
            # there.
 
3394
            while True:
 
3395
                section = iter_all_sections.next()
 
3396
                if section_id == section.id:
 
3397
                    matching_sections.append(
 
3398
                        LocationSection(section, length, extra_path))
 
3399
                    break
 
3400
        return matching_sections
 
3401
 
 
3402
    def get_sections(self):
 
3403
        # Override the default implementation as we want to change the order
 
3404
        matching_sections = self._get_matching_sections()
 
3405
        # We want the longest (aka more specific) locations first
 
3406
        sections = sorted(matching_sections,
 
3407
                          key=lambda section: (section.length, section.id),
 
3408
                          reverse=True)
 
3409
        # Sections mentioning 'ignore_parents' restrict the selection
 
3410
        for section in sections:
 
3411
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
 
3412
            ignore = section.get('ignore_parents', None)
 
3413
            if ignore is not None:
 
3414
                ignore = ui.bool_from_string(ignore)
 
3415
            if ignore:
 
3416
                break
 
3417
            # Finally, we have a valid section
 
3418
            yield self.store, section
 
3419
 
 
3420
 
 
3421
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
 
3422
"""Describes an expandable option reference.
 
3423
 
 
3424
We want to match the most embedded reference first.
 
3425
 
 
3426
I.e. for '{{foo}}' we will get '{foo}',
 
3427
for '{bar{baz}}' we will get '{baz}'
 
3428
"""
 
3429
 
 
3430
def iter_option_refs(string):
 
3431
    # Split isolate refs so every other chunk is a ref
 
3432
    is_ref = False
 
3433
    for chunk  in _option_ref_re.split(string):
 
3434
        yield is_ref, chunk
 
3435
        is_ref = not is_ref
 
3436
 
 
3437
 
 
3438
class Stack(object):
 
3439
    """A stack of configurations where an option can be defined"""
 
3440
 
 
3441
    def __init__(self, sections_def, store=None, mutable_section_id=None):
 
3442
        """Creates a stack of sections with an optional store for changes.
 
3443
 
 
3444
        :param sections_def: A list of Section or callables that returns an
 
3445
            iterable of Section. This defines the Sections for the Stack and
 
3446
            can be called repeatedly if needed.
 
3447
 
 
3448
        :param store: The optional Store where modifications will be
 
3449
            recorded. If none is specified, no modifications can be done.
 
3450
 
 
3451
        :param mutable_section_id: The id of the MutableSection where changes
 
3452
            are recorded. This requires the ``store`` parameter to be
 
3453
            specified.
 
3454
        """
 
3455
        self.sections_def = sections_def
 
3456
        self.store = store
 
3457
        self.mutable_section_id = mutable_section_id
 
3458
 
 
3459
    def get(self, name, expand=None):
 
3460
        """Return the *first* option value found in the sections.
 
3461
 
 
3462
        This is where we guarantee that sections coming from Store are loaded
 
3463
        lazily: the loading is delayed until we need to either check that an
 
3464
        option exists or get its value, which in turn may require to discover
 
3465
        in which sections it can be defined. Both of these (section and option
 
3466
        existence) require loading the store (even partially).
 
3467
 
 
3468
        :param name: The queried option.
 
3469
 
 
3470
        :param expand: Whether options references should be expanded.
 
3471
 
 
3472
        :returns: The value of the option.
 
3473
        """
 
3474
        # FIXME: No caching of options nor sections yet -- vila 20110503
 
3475
        if expand is None:
 
3476
            expand = _get_expand_default_value()
 
3477
        value = None
 
3478
        found_store = None # Where the option value has been found
 
3479
        # If the option is registered, it may provide additional info about
 
3480
        # value handling
 
3481
        try:
 
3482
            opt = option_registry.get(name)
 
3483
        except KeyError:
 
3484
            # Not registered
 
3485
            opt = None
 
3486
 
 
3487
        def expand_and_convert(val):
 
3488
            # This may need to be called in different contexts if the value is
 
3489
            # None or ends up being None during expansion or conversion.
 
3490
            if val is not None:
 
3491
                if expand:
 
3492
                    if isinstance(val, basestring):
 
3493
                        val = self._expand_options_in_string(val)
 
3494
                    else:
 
3495
                        trace.warning('Cannot expand "%s":'
 
3496
                                      ' %s does not support option expansion'
 
3497
                                      % (name, type(val)))
 
3498
                if opt is None:
 
3499
                    val = found_store.unquote(val)
 
3500
                else:
 
3501
                    val = opt.convert_from_unicode(found_store, val)
 
3502
            return val
 
3503
 
 
3504
        # First of all, check if the environment can override the configuration
 
3505
        # value
 
3506
        if opt is not None and opt.override_from_env:
 
3507
            value = opt.get_override()
 
3508
            value = expand_and_convert(value)
 
3509
        if value is None:
 
3510
            # Ensuring lazy loading is achieved by delaying section matching
 
3511
            # (which implies querying the persistent storage) until it can't be
 
3512
            # avoided anymore by using callables to describe (possibly empty)
 
3513
            # section lists.
 
3514
            for sections in self.sections_def:
 
3515
                for store, section in sections():
 
3516
                    value = section.get(name)
 
3517
                    if value is not None:
 
3518
                        found_store = store
 
3519
                        break
 
3520
                if value is not None:
 
3521
                    break
 
3522
            value = expand_and_convert(value)
 
3523
            if opt is not None and value is None:
 
3524
                # If the option is registered, it may provide a default value
 
3525
                value = opt.get_default()
 
3526
                value = expand_and_convert(value)
 
3527
        for hook in ConfigHooks['get']:
 
3528
            hook(self, name, value)
 
3529
        return value
 
3530
 
 
3531
    def expand_options(self, string, env=None):
 
3532
        """Expand option references in the string in the configuration context.
 
3533
 
 
3534
        :param string: The string containing option(s) to expand.
 
3535
 
 
3536
        :param env: An option dict defining additional configuration options or
 
3537
            overriding existing ones.
 
3538
 
 
3539
        :returns: The expanded string.
 
3540
        """
 
3541
        return self._expand_options_in_string(string, env)
 
3542
 
 
3543
    def _expand_options_in_string(self, string, env=None, _refs=None):
 
3544
        """Expand options in the string in the configuration context.
 
3545
 
 
3546
        :param string: The string to be expanded.
 
3547
 
 
3548
        :param env: An option dict defining additional configuration options or
 
3549
            overriding existing ones.
 
3550
 
 
3551
        :param _refs: Private list (FIFO) containing the options being expanded
 
3552
            to detect loops.
 
3553
 
 
3554
        :returns: The expanded string.
 
3555
        """
 
3556
        if string is None:
 
3557
            # Not much to expand there
 
3558
            return None
 
3559
        if _refs is None:
 
3560
            # What references are currently resolved (to detect loops)
 
3561
            _refs = []
 
3562
        result = string
 
3563
        # We need to iterate until no more refs appear ({{foo}} will need two
 
3564
        # iterations for example).
 
3565
        expanded = True
 
3566
        while expanded:
 
3567
            expanded = False
 
3568
            chunks = []
 
3569
            for is_ref, chunk in iter_option_refs(result):
 
3570
                if not is_ref:
 
3571
                    chunks.append(chunk)
 
3572
                else:
 
3573
                    expanded = True
 
3574
                    name = chunk[1:-1]
 
3575
                    if name in _refs:
 
3576
                        raise errors.OptionExpansionLoop(string, _refs)
 
3577
                    _refs.append(name)
 
3578
                    value = self._expand_option(name, env, _refs)
 
3579
                    if value is None:
 
3580
                        raise errors.ExpandingUnknownOption(name, string)
 
3581
                    chunks.append(value)
 
3582
                    _refs.pop()
 
3583
            result = ''.join(chunks)
 
3584
        return result
 
3585
 
 
3586
    def _expand_option(self, name, env, _refs):
 
3587
        if env is not None and name in env:
 
3588
            # Special case, values provided in env takes precedence over
 
3589
            # anything else
 
3590
            value = env[name]
 
3591
        else:
 
3592
            value = self.get(name, expand=False)
 
3593
            value = self._expand_options_in_string(value, env, _refs)
 
3594
        return value
 
3595
 
 
3596
    def _get_mutable_section(self):
 
3597
        """Get the MutableSection for the Stack.
 
3598
 
 
3599
        This is where we guarantee that the mutable section is lazily loaded:
 
3600
        this means we won't load the corresponding store before setting a value
 
3601
        or deleting an option. In practice the store will often be loaded but
 
3602
        this helps catching some programming errors.
 
3603
        """
 
3604
        store = self.store
 
3605
        section = store.get_mutable_section(self.mutable_section_id)
 
3606
        return store, section
 
3607
 
 
3608
    def set(self, name, value):
 
3609
        """Set a new value for the option."""
 
3610
        store, section = self._get_mutable_section()
 
3611
        section.set(name, store.quote(value))
 
3612
        for hook in ConfigHooks['set']:
 
3613
            hook(self, name, value)
 
3614
 
 
3615
    def remove(self, name):
 
3616
        """Remove an existing option."""
 
3617
        _, section = self._get_mutable_section()
 
3618
        section.remove(name)
 
3619
        for hook in ConfigHooks['remove']:
 
3620
            hook(self, name)
 
3621
 
 
3622
    def __repr__(self):
 
3623
        # Mostly for debugging use
 
3624
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
 
3625
 
 
3626
    def _get_overrides(self):
 
3627
        # Hack around library_state.initialize never called
 
3628
        if bzrlib.global_state is not None:
 
3629
            return bzrlib.global_state.cmdline_overrides.get_sections()
 
3630
        return []
 
3631
 
 
3632
 
 
3633
class MemoryStack(Stack):
 
3634
    """A configuration stack defined from a string.
 
3635
 
 
3636
    This is mainly intended for tests and requires no disk resources.
 
3637
    """
 
3638
 
 
3639
    def __init__(self, content=None):
 
3640
        """Create an in-memory stack from a given content.
 
3641
 
 
3642
        It uses a single store based on configobj and support reading and
 
3643
        writing options.
 
3644
 
 
3645
        :param content: The initial content of the store. If None, the store is
 
3646
            not loaded and ``_load_from_string`` can and should be used if
 
3647
            needed.
 
3648
        """
 
3649
        store = IniFileStore()
 
3650
        if content is not None:
 
3651
            store._load_from_string(content)
 
3652
        super(MemoryStack, self).__init__(
 
3653
            [store.get_sections], store)
 
3654
 
 
3655
 
 
3656
class _CompatibleStack(Stack):
 
3657
    """Place holder for compatibility with previous design.
 
3658
 
 
3659
    This is intended to ease the transition from the Config-based design to the
 
3660
    Stack-based design and should not be used nor relied upon by plugins.
 
3661
 
 
3662
    One assumption made here is that the daughter classes will all use Stores
 
3663
    derived from LockableIniFileStore).
 
3664
 
 
3665
    It implements set() and remove () by re-loading the store before applying
 
3666
    the modification and saving it.
 
3667
 
 
3668
    The long term plan being to implement a single write by store to save
 
3669
    all modifications, this class should not be used in the interim.
 
3670
    """
 
3671
 
 
3672
    def set(self, name, value):
 
3673
        # Force a reload
 
3674
        self.store.unload()
 
3675
        super(_CompatibleStack, self).set(name, value)
 
3676
        # Force a write to persistent storage
 
3677
        self.store.save()
 
3678
 
 
3679
    def remove(self, name):
 
3680
        # Force a reload
 
3681
        self.store.unload()
 
3682
        super(_CompatibleStack, self).remove(name)
 
3683
        # Force a write to persistent storage
 
3684
        self.store.save()
 
3685
 
 
3686
 
 
3687
class GlobalStack(_CompatibleStack):
 
3688
    """Global options only stack.
 
3689
 
 
3690
    The following sections are queried:
 
3691
 
 
3692
    * command-line overrides,
 
3693
 
 
3694
    * the 'DEFAULT' section in bazaar.conf
 
3695
 
 
3696
    This stack will use the ``DEFAULT`` section in bazaar.conf as its
 
3697
    MutableSection.
 
3698
    """
 
3699
 
 
3700
    def __init__(self):
 
3701
        gstore = GlobalStore()
 
3702
        super(GlobalStack, self).__init__(
 
3703
            [self._get_overrides,
 
3704
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3705
            gstore, mutable_section_id='DEFAULT')
 
3706
 
 
3707
 
 
3708
class LocationStack(_CompatibleStack):
 
3709
    """Per-location options falling back to global options stack.
 
3710
 
 
3711
 
 
3712
    The following sections are queried:
 
3713
 
 
3714
    * command-line overrides,
 
3715
 
 
3716
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3717
      defined by the number of path components in the section glob, higher
 
3718
      numbers first (from most specific section to most generic).
 
3719
 
 
3720
    * the 'DEFAULT' section in bazaar.conf
 
3721
 
 
3722
    This stack will use the ``location`` section in locations.conf as its
 
3723
    MutableSection.
 
3724
    """
 
3725
 
 
3726
    def __init__(self, location):
 
3727
        """Make a new stack for a location and global configuration.
 
3728
 
 
3729
        :param location: A URL prefix to """
 
3730
        lstore = LocationStore()
 
3731
        if location.startswith('file://'):
 
3732
            location = urlutils.local_path_from_url(location)
 
3733
        gstore = GlobalStore()
 
3734
        super(LocationStack, self).__init__(
 
3735
            [self._get_overrides,
 
3736
             LocationMatcher(lstore, location).get_sections,
 
3737
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3738
            lstore, mutable_section_id=location)
 
3739
 
 
3740
 
 
3741
class BranchStack(_CompatibleStack):
 
3742
    """Per-location options falling back to branch then global options stack.
 
3743
 
 
3744
    The following sections are queried:
 
3745
 
 
3746
    * command-line overrides,
 
3747
 
 
3748
    * the sections matching ``location`` in ``locations.conf``, the order being
 
3749
      defined by the number of path components in the section glob, higher
 
3750
      numbers first (from most specific section to most generic),
 
3751
 
 
3752
    * the no-name section in branch.conf,
 
3753
 
 
3754
    * the ``DEFAULT`` section in ``bazaar.conf``.
 
3755
 
 
3756
    This stack will use the no-name section in ``branch.conf`` as its
 
3757
    MutableSection.
 
3758
    """
 
3759
 
 
3760
    def __init__(self, branch):
 
3761
        lstore = LocationStore()
 
3762
        bstore = branch._get_config_store()
 
3763
        gstore = GlobalStore()
 
3764
        super(BranchStack, self).__init__(
 
3765
            [self._get_overrides,
 
3766
             LocationMatcher(lstore, branch.base).get_sections,
 
3767
             NameMatcher(bstore, None).get_sections,
 
3768
             NameMatcher(gstore, 'DEFAULT').get_sections],
 
3769
            bstore)
 
3770
        self.branch = branch
 
3771
 
 
3772
 
 
3773
class RemoteControlStack(_CompatibleStack):
 
3774
    """Remote control-only options stack."""
 
3775
 
 
3776
    # FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
 
3777
    # with the stack used for remote bzr dirs. RemoteControlStack only uses
 
3778
    # control.conf and is used only for stack options.
 
3779
 
 
3780
    def __init__(self, bzrdir):
 
3781
        cstore = bzrdir._get_config_store()
 
3782
        super(RemoteControlStack, self).__init__(
 
3783
            [NameMatcher(cstore, None).get_sections],
 
3784
            cstore)
 
3785
        self.bzrdir = bzrdir
 
3786
 
 
3787
 
 
3788
class BranchOnlyStack(_CompatibleStack):
 
3789
    """Branch-only options stack."""
 
3790
 
 
3791
    # FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
 
3792
    # stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
 
3793
    # -- vila 2011-12-16
 
3794
 
 
3795
    def __init__(self, branch):
 
3796
        bstore = branch._get_config_store()
 
3797
        super(BranchOnlyStack, self).__init__(
 
3798
            [NameMatcher(bstore, None).get_sections],
 
3799
            bstore)
 
3800
        self.branch = branch
 
3801
 
 
3802
 
 
3803
# Use a an empty dict to initialize an empty configobj avoiding all
 
3804
# parsing and encoding checks
 
3805
_quoting_config = configobj.ConfigObj(
 
3806
    {}, encoding='utf-8', interpolation=False, list_values=True)
 
3807
 
 
3808
class cmd_config(commands.Command):
 
3809
    __doc__ = """Display, set or remove a configuration option.
 
3810
 
 
3811
    Display the active value for a given option.
 
3812
 
 
3813
    If --all is specified, NAME is interpreted as a regular expression and all
 
3814
    matching options are displayed mentioning their scope. The active value
 
3815
    that bzr will take into account is the first one displayed for each option.
 
3816
 
 
3817
    If no NAME is given, --all .* is implied.
 
3818
 
 
3819
    Setting a value is achieved by using name=value without spaces. The value
 
3820
    is set in the most relevant scope and can be checked by displaying the
 
3821
    option again.
 
3822
    """
 
3823
 
 
3824
    takes_args = ['name?']
 
3825
 
 
3826
    takes_options = [
 
3827
        'directory',
 
3828
        # FIXME: This should be a registry option so that plugins can register
 
3829
        # their own config files (or not) and will also address
 
3830
        # http://pad.lv/788991 -- vila 20101115
 
3831
        commands.Option('scope', help='Reduce the scope to the specified'
 
3832
                        ' configuration file.',
 
3833
                        type=unicode),
 
3834
        commands.Option('all',
 
3835
            help='Display all the defined values for the matching options.',
 
3836
            ),
 
3837
        commands.Option('remove', help='Remove the option from'
 
3838
                        ' the configuration file.'),
 
3839
        ]
 
3840
 
 
3841
    _see_also = ['configuration']
 
3842
 
 
3843
    @commands.display_command
 
3844
    def run(self, name=None, all=False, directory=None, scope=None,
 
3845
            remove=False):
 
3846
        if directory is None:
 
3847
            directory = '.'
 
3848
        directory = urlutils.normalize_url(directory)
 
3849
        if remove and all:
 
3850
            raise errors.BzrError(
 
3851
                '--all and --remove are mutually exclusive.')
 
3852
        elif remove:
 
3853
            # Delete the option in the given scope
 
3854
            self._remove_config_option(name, directory, scope)
 
3855
        elif name is None:
 
3856
            # Defaults to all options
 
3857
            self._show_matching_options('.*', directory, scope)
 
3858
        else:
 
3859
            try:
 
3860
                name, value = name.split('=', 1)
 
3861
            except ValueError:
 
3862
                # Display the option(s) value(s)
 
3863
                if all:
 
3864
                    self._show_matching_options(name, directory, scope)
 
3865
                else:
 
3866
                    self._show_value(name, directory, scope)
 
3867
            else:
 
3868
                if all:
 
3869
                    raise errors.BzrError(
 
3870
                        'Only one option can be set.')
 
3871
                # Set the option value
 
3872
                self._set_config_option(name, value, directory, scope)
 
3873
 
 
3874
    def _get_stack(self, directory, scope=None):
 
3875
        """Get the configuration stack specified by ``directory`` and ``scope``.
 
3876
 
 
3877
        :param directory: Where the configurations are derived from.
 
3878
 
 
3879
        :param scope: A specific config to start from.
 
3880
        """
 
3881
        # FIXME: scope should allow access to plugin-specific stacks (even
 
3882
        # reduced to the plugin-specific store), related to
 
3883
        # http://pad.lv/788991 -- vila 2011-11-15
 
3884
        if scope is not None:
 
3885
            if scope == 'bazaar':
 
3886
                return GlobalStack()
 
3887
            elif scope == 'locations':
 
3888
                return LocationStack(directory)
 
3889
            elif scope == 'branch':
 
3890
                (_, br, _) = (
 
3891
                    controldir.ControlDir.open_containing_tree_or_branch(
 
3892
                        directory))
 
3893
                return br.get_config_stack()
 
3894
            raise errors.NoSuchConfig(scope)
 
3895
        else:
 
3896
            try:
 
3897
                (_, br, _) = (
 
3898
                    controldir.ControlDir.open_containing_tree_or_branch(
 
3899
                        directory))
 
3900
                return br.get_config_stack()
 
3901
            except errors.NotBranchError:
 
3902
                return LocationStack(directory)
 
3903
 
 
3904
    def _show_value(self, name, directory, scope):
 
3905
        conf = self._get_stack(directory, scope)
 
3906
        value = conf.get(name, expand=True)
 
3907
        if value is not None:
 
3908
            # Quote the value appropriately
 
3909
            value = _quoting_config._quote(value)
 
3910
            self.outf.write('%s\n' % (value,))
 
3911
        else:
 
3912
            raise errors.NoSuchConfigOption(name)
 
3913
 
 
3914
    def _show_matching_options(self, name, directory, scope):
 
3915
        name = lazy_regex.lazy_compile(name)
 
3916
        # We want any error in the regexp to be raised *now* so we need to
 
3917
        # avoid the delay introduced by the lazy regexp.  But, we still do
 
3918
        # want the nicer errors raised by lazy_regex.
 
3919
        name._compile_and_collapse()
 
3920
        cur_store_id = None
 
3921
        cur_section = None
 
3922
        conf = self._get_stack(directory, scope)
 
3923
        for sections in conf.sections_def:
 
3924
            for store, section in sections():
 
3925
                for oname in section.iter_option_names():
 
3926
                    if name.search(oname):
 
3927
                        if cur_store_id != store.id:
 
3928
                            # Explain where the options are defined
 
3929
                            self.outf.write('%s:\n' % (store.id,))
 
3930
                            cur_store_id = store.id
 
3931
                            cur_section = None
 
3932
                        if (section.id is not None
 
3933
                            and cur_section != section.id):
 
3934
                            # Display the section id as it appears in the store
 
3935
                            # (None doesn't appear by definition)
 
3936
                            self.outf.write('  [%s]\n' % (section.id,))
 
3937
                            cur_section = section.id
 
3938
                        value = section.get(oname, expand=False)
 
3939
                        # Since we don't use the stack, we need to restore a
 
3940
                        # proper quoting.
 
3941
                        try:
 
3942
                            opt = option_registry.get(oname)
 
3943
                            value = opt.convert_from_unicode(store, value)
 
3944
                        except KeyError:
 
3945
                            value = store.unquote(value)
 
3946
                        value = _quoting_config._quote(value)
 
3947
                        self.outf.write('  %s = %s\n' % (oname, value))
 
3948
 
 
3949
    def _set_config_option(self, name, value, directory, scope):
 
3950
        conf = self._get_stack(directory, scope)
 
3951
        conf.set(name, value)
 
3952
 
 
3953
    def _remove_config_option(self, name, directory, scope):
 
3954
        if name is None:
 
3955
            raise errors.BzrCommandError(
 
3956
                '--remove expects an option to remove.')
 
3957
        conf = self._get_stack(directory, scope)
 
3958
        try:
 
3959
            conf.remove(name)
 
3960
        except KeyError:
 
3961
            raise errors.NoSuchConfigOption(name)
 
3962
 
 
3963
 
 
3964
# Test registries
 
3965
#
 
3966
# We need adapters that can build a Store or a Stack in a test context. Test
 
3967
# classes, based on TestCaseWithTransport, can use the registry to parametrize
 
3968
# themselves. The builder will receive a test instance and should return a
 
3969
# ready-to-use store or stack.  Plugins that define new store/stacks can also
 
3970
# register themselves here to be tested against the tests defined in
 
3971
# bzrlib.tests.test_config. Note that the builder can be called multiple times
 
3972
# for the same test.
 
3973
 
 
3974
# The registered object should be a callable receiving a test instance
 
3975
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
 
3976
# object.
 
3977
test_store_builder_registry = registry.Registry()
 
3978
 
 
3979
# The registered object should be a callable receiving a test instance
 
3980
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
 
3981
# object.
 
3982
test_stack_builder_registry = registry.Registry()