~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/config.py

  • Committer: Jelmer Vernooij
  • Date: 2011-06-16 11:58:04 UTC
  • mto: This revision was merged to the branch mainline in revision 5987.
  • Revision ID: jelmer@samba.org-20110616115804-7tnqon61emrbdoxm
Remove unused Tree._get_ancestors.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2005-2011 Canonical Ltd
2
2
#   Authors: Robert Collins <robert.collins@canonical.com>
3
3
#            and others
4
4
#
63
63
"""
64
64
 
65
65
import os
 
66
import string
66
67
import sys
 
68
import weakref
67
69
 
 
70
from bzrlib import commands
 
71
from bzrlib.decorators import needs_write_lock
68
72
from bzrlib.lazy_import import lazy_import
69
73
lazy_import(globals(), """
70
 
import errno
71
 
from fnmatch import fnmatch
 
74
import fnmatch
72
75
import re
73
76
from cStringIO import StringIO
74
77
 
75
 
import bzrlib
76
78
from bzrlib import (
 
79
    atomicfile,
 
80
    bzrdir,
77
81
    debug,
78
82
    errors,
 
83
    lockdir,
79
84
    mail_client,
 
85
    mergetools,
80
86
    osutils,
81
 
    registry,
82
87
    symbol_versioning,
83
88
    trace,
 
89
    transport,
84
90
    ui,
85
91
    urlutils,
86
92
    win32utils,
87
93
    )
88
94
from bzrlib.util.configobj import configobj
89
95
""")
 
96
from bzrlib import (
 
97
    registry,
 
98
    )
 
99
from bzrlib.symbol_versioning import (
 
100
    deprecated_in,
 
101
    deprecated_method,
 
102
    )
90
103
 
91
104
 
92
105
CHECK_IF_POSSIBLE=0
122
135
STORE_BRANCH = 3
123
136
STORE_GLOBAL = 4
124
137
 
125
 
_ConfigObj = None
126
 
def ConfigObj(*args, **kwargs):
127
 
    global _ConfigObj
128
 
    if _ConfigObj is None:
129
 
        class ConfigObj(configobj.ConfigObj):
130
 
 
131
 
            def get_bool(self, section, key):
132
 
                return self[section].as_bool(key)
133
 
 
134
 
            def get_value(self, section, name):
135
 
                # Try [] for the old DEFAULT section.
136
 
                if section == "DEFAULT":
137
 
                    try:
138
 
                        return self[name]
139
 
                    except KeyError:
140
 
                        pass
141
 
                return self[section][name]
142
 
        _ConfigObj = ConfigObj
143
 
    return _ConfigObj(*args, **kwargs)
 
138
 
 
139
class ConfigObj(configobj.ConfigObj):
 
140
 
 
141
    def __init__(self, infile=None, **kwargs):
 
142
        # We define our own interpolation mechanism calling it option expansion
 
143
        super(ConfigObj, self).__init__(infile=infile,
 
144
                                        interpolation=False,
 
145
                                        **kwargs)
 
146
 
 
147
    def get_bool(self, section, key):
 
148
        return self[section].as_bool(key)
 
149
 
 
150
    def get_value(self, section, name):
 
151
        # Try [] for the old DEFAULT section.
 
152
        if section == "DEFAULT":
 
153
            try:
 
154
                return self[name]
 
155
            except KeyError:
 
156
                pass
 
157
        return self[section][name]
 
158
 
 
159
 
 
160
# FIXME: Until we can guarantee that each config file is loaded once and and
 
161
# only once for a given bzrlib session, we don't want to re-read the file every
 
162
# time we query for an option so we cache the value (bad ! watch out for tests
 
163
# needing to restore the proper value).This shouldn't be part of 2.4.0 final,
 
164
# yell at mgz^W vila and the RM if this is still present at that time
 
165
# -- vila 20110219
 
166
_expand_default_value = None
 
167
def _get_expand_default_value():
 
168
    global _expand_default_value
 
169
    if _expand_default_value is not None:
 
170
        return _expand_default_value
 
171
    conf = GlobalConfig()
 
172
    # Note that we must not use None for the expand value below or we'll run
 
173
    # into infinite recursion. Using False really would be quite silly ;)
 
174
    expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
 
175
    if expand is None:
 
176
        # This is an opt-in feature, you *really* need to clearly say you want
 
177
        # to activate it !
 
178
        expand = False
 
179
    _expand_default_value = expand
 
180
    return expand
144
181
 
145
182
 
146
183
class Config(object):
149
186
    def __init__(self):
150
187
        super(Config, self).__init__()
151
188
 
 
189
    def config_id(self):
 
190
        """Returns a unique ID for the config."""
 
191
        raise NotImplementedError(self.config_id)
 
192
 
 
193
    @deprecated_method(deprecated_in((2, 4, 0)))
152
194
    def get_editor(self):
153
195
        """Get the users pop up editor."""
154
196
        raise NotImplementedError
161
203
        return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
162
204
                                             sys.stdout)
163
205
 
164
 
 
165
206
    def get_mail_client(self):
166
207
        """Get a mail client to use"""
167
208
        selected_client = self.get_user_option('mail_client')
178
219
    def _get_signing_policy(self):
179
220
        """Template method to override signature creation policy."""
180
221
 
 
222
    option_ref_re = None
 
223
 
 
224
    def expand_options(self, string, env=None):
 
225
        """Expand option references in the string in the configuration context.
 
226
 
 
227
        :param string: The string containing option to expand.
 
228
 
 
229
        :param env: An option dict defining additional configuration options or
 
230
            overriding existing ones.
 
231
 
 
232
        :returns: The expanded string.
 
233
        """
 
234
        return self._expand_options_in_string(string, env)
 
235
 
 
236
    def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
 
237
        """Expand options in  a list of strings in the configuration context.
 
238
 
 
239
        :param slist: A list of strings.
 
240
 
 
241
        :param env: An option dict defining additional configuration options or
 
242
            overriding existing ones.
 
243
 
 
244
        :param _ref_stack: Private list containing the options being
 
245
            expanded to detect loops.
 
246
 
 
247
        :returns: The flatten list of expanded strings.
 
248
        """
 
249
        # expand options in each value separately flattening lists
 
250
        result = []
 
251
        for s in slist:
 
252
            value = self._expand_options_in_string(s, env, _ref_stack)
 
253
            if isinstance(value, list):
 
254
                result.extend(value)
 
255
            else:
 
256
                result.append(value)
 
257
        return result
 
258
 
 
259
    def _expand_options_in_string(self, string, env=None, _ref_stack=None):
 
260
        """Expand options in the string in the configuration context.
 
261
 
 
262
        :param string: The string to be expanded.
 
263
 
 
264
        :param env: An option dict defining additional configuration options or
 
265
            overriding existing ones.
 
266
 
 
267
        :param _ref_stack: Private list containing the options being
 
268
            expanded to detect loops.
 
269
 
 
270
        :returns: The expanded string.
 
271
        """
 
272
        if string is None:
 
273
            # Not much to expand there
 
274
            return None
 
275
        if _ref_stack is None:
 
276
            # What references are currently resolved (to detect loops)
 
277
            _ref_stack = []
 
278
        if self.option_ref_re is None:
 
279
            # We want to match the most embedded reference first (i.e. for
 
280
            # '{{foo}}' we will get '{foo}',
 
281
            # for '{bar{baz}}' we will get '{baz}'
 
282
            self.option_ref_re = re.compile('({[^{}]+})')
 
283
        result = string
 
284
        # We need to iterate until no more refs appear ({{foo}} will need two
 
285
        # iterations for example).
 
286
        while True:
 
287
            raw_chunks = self.option_ref_re.split(result)
 
288
            if len(raw_chunks) == 1:
 
289
                # Shorcut the trivial case: no refs
 
290
                return result
 
291
            chunks = []
 
292
            list_value = False
 
293
            # Split will isolate refs so that every other chunk is a ref
 
294
            chunk_is_ref = False
 
295
            for chunk in raw_chunks:
 
296
                if not chunk_is_ref:
 
297
                    if chunk:
 
298
                        # Keep only non-empty strings (or we get bogus empty
 
299
                        # slots when a list value is involved).
 
300
                        chunks.append(chunk)
 
301
                    chunk_is_ref = True
 
302
                else:
 
303
                    name = chunk[1:-1]
 
304
                    if name in _ref_stack:
 
305
                        raise errors.OptionExpansionLoop(string, _ref_stack)
 
306
                    _ref_stack.append(name)
 
307
                    value = self._expand_option(name, env, _ref_stack)
 
308
                    if value is None:
 
309
                        raise errors.ExpandingUnknownOption(name, string)
 
310
                    if isinstance(value, list):
 
311
                        list_value = True
 
312
                        chunks.extend(value)
 
313
                    else:
 
314
                        chunks.append(value)
 
315
                    _ref_stack.pop()
 
316
                    chunk_is_ref = False
 
317
            if list_value:
 
318
                # Once a list appears as the result of an expansion, all
 
319
                # callers will get a list result. This allows a consistent
 
320
                # behavior even when some options in the expansion chain
 
321
                # defined as strings (no comma in their value) but their
 
322
                # expanded value is a list.
 
323
                return self._expand_options_in_list(chunks, env, _ref_stack)
 
324
            else:
 
325
                result = ''.join(chunks)
 
326
        return result
 
327
 
 
328
    def _expand_option(self, name, env, _ref_stack):
 
329
        if env is not None and name in env:
 
330
            # Special case, values provided in env takes precedence over
 
331
            # anything else
 
332
            value = env[name]
 
333
        else:
 
334
            # FIXME: This is a limited implementation, what we really need is a
 
335
            # way to query the bzr config for the value of an option,
 
336
            # respecting the scope rules (That is, once we implement fallback
 
337
            # configs, getting the option value should restart from the top
 
338
            # config, not the current one) -- vila 20101222
 
339
            value = self.get_user_option(name, expand=False)
 
340
            if isinstance(value, list):
 
341
                value = self._expand_options_in_list(value, env, _ref_stack)
 
342
            else:
 
343
                value = self._expand_options_in_string(value, env, _ref_stack)
 
344
        return value
 
345
 
181
346
    def _get_user_option(self, option_name):
182
347
        """Template method to provide a user option."""
183
348
        return None
184
349
 
185
 
    def get_user_option(self, option_name):
186
 
        """Get a generic option - no special process, no default."""
187
 
        return self._get_user_option(option_name)
188
 
 
189
 
    def get_user_option_as_bool(self, option_name):
190
 
        """Get a generic option as a boolean - no special process, no default.
191
 
 
 
350
    def get_user_option(self, option_name, expand=None):
 
351
        """Get a generic option - no special process, no default.
 
352
 
 
353
        :param option_name: The queried option.
 
354
 
 
355
        :param expand: Whether options references should be expanded.
 
356
 
 
357
        :returns: The value of the option.
 
358
        """
 
359
        if expand is None:
 
360
            expand = _get_expand_default_value()
 
361
        value = self._get_user_option(option_name)
 
362
        if expand:
 
363
            if isinstance(value, list):
 
364
                value = self._expand_options_in_list(value)
 
365
            elif isinstance(value, dict):
 
366
                trace.warning('Cannot expand "%s":'
 
367
                              ' Dicts do not support option expansion'
 
368
                              % (option_name,))
 
369
            else:
 
370
                value = self._expand_options_in_string(value)
 
371
        return value
 
372
 
 
373
    def get_user_option_as_bool(self, option_name, expand=None, default=None):
 
374
        """Get a generic option as a boolean.
 
375
 
 
376
        :param expand: Allow expanding references to other config values.
 
377
        :param default: Default value if nothing is configured
192
378
        :return None if the option doesn't exist or its value can't be
193
379
            interpreted as a boolean. Returns True or False otherwise.
194
380
        """
195
 
        s = self._get_user_option(option_name)
 
381
        s = self.get_user_option(option_name, expand=expand)
196
382
        if s is None:
197
383
            # The option doesn't exist
198
 
            return None
 
384
            return default
199
385
        val = ui.bool_from_string(s)
200
386
        if val is None:
201
387
            # The value can't be interpreted as a boolean
203
389
                          s, option_name)
204
390
        return val
205
391
 
206
 
    def get_user_option_as_list(self, option_name):
 
392
    def get_user_option_as_list(self, option_name, expand=None):
207
393
        """Get a generic option as a list - no special process, no default.
208
394
 
209
395
        :return None if the option doesn't exist. Returns the value as a list
210
396
            otherwise.
211
397
        """
212
 
        l = self._get_user_option(option_name)
 
398
        l = self.get_user_option(option_name, expand=expand)
213
399
        if isinstance(l, (str, unicode)):
214
 
            # A single value, most probably the user forgot the final ','
 
400
            # A single value, most probably the user forgot (or didn't care to
 
401
            # add) the final ','
215
402
            l = [l]
216
403
        return l
217
404
 
257
444
 
258
445
        Something similar to 'Martin Pool <mbp@sourcefrog.net>'
259
446
 
260
 
        $BZR_EMAIL can be set to override this (as well as the
261
 
        deprecated $BZREMAIL), then
 
447
        $BZR_EMAIL can be set to override this, then
262
448
        the concrete policy type is checked, and finally
263
449
        $EMAIL is examined.
264
 
        If none is found, a reasonable default is (hopefully)
265
 
        created.
266
 
 
267
 
        TODO: Check it's reasonably well-formed.
 
450
        If no username can be found, errors.NoWhoami exception is raised.
268
451
        """
269
452
        v = os.environ.get('BZR_EMAIL')
270
453
        if v:
271
454
            return v.decode(osutils.get_user_encoding())
272
 
 
273
455
        v = self._get_user_id()
274
456
        if v:
275
457
            return v
276
 
 
277
458
        v = os.environ.get('EMAIL')
278
459
        if v:
279
460
            return v.decode(osutils.get_user_encoding())
280
 
 
281
461
        name, email = _auto_user_id()
282
 
        if name:
 
462
        if name and email:
283
463
            return '%s <%s>' % (name, email)
284
 
        else:
 
464
        elif email:
285
465
            return email
 
466
        raise errors.NoWhoami()
 
467
 
 
468
    def ensure_username(self):
 
469
        """Raise errors.NoWhoami if username is not set.
 
470
 
 
471
        This method relies on the username() function raising the error.
 
472
        """
 
473
        self.username()
286
474
 
287
475
    def signature_checking(self):
288
476
        """What is the current policy for signature checking?."""
304
492
        if policy is None:
305
493
            policy = self._get_signature_checking()
306
494
            if policy is not None:
 
495
                #this warning should go away once check_signatures is
 
496
                #implemented (if not before)
307
497
                trace.warning("Please use create_signatures,"
308
498
                              " not check_signatures to set signing policy.")
309
 
            if policy == CHECK_ALWAYS:
310
 
                return True
311
499
        elif policy == SIGN_ALWAYS:
312
500
            return True
313
501
        return False
346
534
        else:
347
535
            return True
348
536
 
 
537
    def get_merge_tools(self):
 
538
        tools = {}
 
539
        for (oname, value, section, conf_id, parser) in self._get_options():
 
540
            if oname.startswith('bzr.mergetool.'):
 
541
                tool_name = oname[len('bzr.mergetool.'):]
 
542
                tools[tool_name] = value
 
543
        trace.mutter('loaded merge tools: %r' % tools)
 
544
        return tools
 
545
 
 
546
    def find_merge_tool(self, name):
 
547
        # We fake a defaults mechanism here by checking if the given name can
 
548
        # be found in the known_merge_tools if it's not found in the config.
 
549
        # This should be done through the proposed config defaults mechanism
 
550
        # when it becomes available in the future.
 
551
        command_line = (self.get_user_option('bzr.mergetool.%s' % name,
 
552
                                             expand=False)
 
553
                        or mergetools.known_merge_tools.get(name, None))
 
554
        return command_line
 
555
 
349
556
 
350
557
class IniBasedConfig(Config):
351
558
    """A configuration policy that draws from ini files."""
352
559
 
353
 
    def __init__(self, get_filename):
 
560
    def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
 
561
                 file_name=None):
 
562
        """Base class for configuration files using an ini-like syntax.
 
563
 
 
564
        :param file_name: The configuration file path.
 
565
        """
354
566
        super(IniBasedConfig, self).__init__()
355
 
        self._get_filename = get_filename
 
567
        self.file_name = file_name
 
568
        if symbol_versioning.deprecated_passed(get_filename):
 
569
            symbol_versioning.warn(
 
570
                'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
 
571
                ' Use file_name instead.',
 
572
                DeprecationWarning,
 
573
                stacklevel=2)
 
574
            if get_filename is not None:
 
575
                self.file_name = get_filename()
 
576
        else:
 
577
            self.file_name = file_name
 
578
        self._content = None
356
579
        self._parser = None
357
580
 
358
 
    def _get_parser(self, file=None):
 
581
    @classmethod
 
582
    def from_string(cls, str_or_unicode, file_name=None, save=False):
 
583
        """Create a config object from a string.
 
584
 
 
585
        :param str_or_unicode: A string representing the file content. This will
 
586
            be utf-8 encoded.
 
587
 
 
588
        :param file_name: The configuration file path.
 
589
 
 
590
        :param _save: Whether the file should be saved upon creation.
 
591
        """
 
592
        conf = cls(file_name=file_name)
 
593
        conf._create_from_string(str_or_unicode, save)
 
594
        return conf
 
595
 
 
596
    def _create_from_string(self, str_or_unicode, save):
 
597
        self._content = StringIO(str_or_unicode.encode('utf-8'))
 
598
        # Some tests use in-memory configs, some other always need the config
 
599
        # file to exist on disk.
 
600
        if save:
 
601
            self._write_config_file()
 
602
 
 
603
    def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
359
604
        if self._parser is not None:
360
605
            return self._parser
361
 
        if file is None:
362
 
            input = self._get_filename()
 
606
        if symbol_versioning.deprecated_passed(file):
 
607
            symbol_versioning.warn(
 
608
                'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
 
609
                ' Use IniBasedConfig(_content=xxx) instead.',
 
610
                DeprecationWarning,
 
611
                stacklevel=2)
 
612
        if self._content is not None:
 
613
            co_input = self._content
 
614
        elif self.file_name is None:
 
615
            raise AssertionError('We have no content to create the config')
363
616
        else:
364
 
            input = file
 
617
            co_input = self.file_name
365
618
        try:
366
 
            self._parser = ConfigObj(input, encoding='utf-8')
 
619
            self._parser = ConfigObj(co_input, encoding='utf-8')
367
620
        except configobj.ConfigObjError, e:
368
621
            raise errors.ParseConfigError(e.errors, e.config.filename)
 
622
        # Make sure self.reload() will use the right file name
 
623
        self._parser.filename = self.file_name
369
624
        return self._parser
370
625
 
 
626
    def reload(self):
 
627
        """Reload the config file from disk."""
 
628
        if self.file_name is None:
 
629
            raise AssertionError('We need a file name to reload the config')
 
630
        if self._parser is not None:
 
631
            self._parser.reload()
 
632
 
371
633
    def _get_matching_sections(self):
372
634
        """Return an ordered list of (section_name, extra_path) pairs.
373
635
 
384
646
        """Override this to define the section used by the config."""
385
647
        return "DEFAULT"
386
648
 
 
649
    def _get_sections(self, name=None):
 
650
        """Returns an iterator of the sections specified by ``name``.
 
651
 
 
652
        :param name: The section name. If None is supplied, the default
 
653
            configurations are yielded.
 
654
 
 
655
        :return: A tuple (name, section, config_id) for all sections that will
 
656
            be walked by user_get_option() in the 'right' order. The first one
 
657
            is where set_user_option() will update the value.
 
658
        """
 
659
        parser = self._get_parser()
 
660
        if name is not None:
 
661
            yield (name, parser[name], self.config_id())
 
662
        else:
 
663
            # No section name has been given so we fallback to the configobj
 
664
            # itself which holds the variables defined outside of any section.
 
665
            yield (None, parser, self.config_id())
 
666
 
 
667
    def _get_options(self, sections=None):
 
668
        """Return an ordered list of (name, value, section, config_id) tuples.
 
669
 
 
670
        All options are returned with their associated value and the section
 
671
        they appeared in. ``config_id`` is a unique identifier for the
 
672
        configuration file the option is defined in.
 
673
 
 
674
        :param sections: Default to ``_get_matching_sections`` if not
 
675
            specified. This gives a better control to daughter classes about
 
676
            which sections should be searched. This is a list of (name,
 
677
            configobj) tuples.
 
678
        """
 
679
        opts = []
 
680
        if sections is None:
 
681
            parser = self._get_parser()
 
682
            sections = []
 
683
            for (section_name, _) in self._get_matching_sections():
 
684
                try:
 
685
                    section = parser[section_name]
 
686
                except KeyError:
 
687
                    # This could happen for an empty file for which we define a
 
688
                    # DEFAULT section. FIXME: Force callers to provide sections
 
689
                    # instead ? -- vila 20100930
 
690
                    continue
 
691
                sections.append((section_name, section))
 
692
        config_id = self.config_id()
 
693
        for (section_name, section) in sections:
 
694
            for (name, value) in section.iteritems():
 
695
                yield (name, parser._quote(value), section_name,
 
696
                       config_id, parser)
 
697
 
387
698
    def _get_option_policy(self, section, option_name):
388
699
        """Return the policy for the given (section, option_name) pair."""
389
700
        return POLICY_NONE
476
787
    def _get_nickname(self):
477
788
        return self.get_user_option('nickname')
478
789
 
479
 
 
480
 
class GlobalConfig(IniBasedConfig):
 
790
    def remove_user_option(self, option_name, section_name=None):
 
791
        """Remove a user option and save the configuration file.
 
792
 
 
793
        :param option_name: The option to be removed.
 
794
 
 
795
        :param section_name: The section the option is defined in, default to
 
796
            the default section.
 
797
        """
 
798
        self.reload()
 
799
        parser = self._get_parser()
 
800
        if section_name is None:
 
801
            section = parser
 
802
        else:
 
803
            section = parser[section_name]
 
804
        try:
 
805
            del section[option_name]
 
806
        except KeyError:
 
807
            raise errors.NoSuchConfigOption(option_name)
 
808
        self._write_config_file()
 
809
 
 
810
    def _write_config_file(self):
 
811
        if self.file_name is None:
 
812
            raise AssertionError('We cannot save, self.file_name is None')
 
813
        conf_dir = os.path.dirname(self.file_name)
 
814
        ensure_config_dir_exists(conf_dir)
 
815
        atomic_file = atomicfile.AtomicFile(self.file_name)
 
816
        self._get_parser().write(atomic_file)
 
817
        atomic_file.commit()
 
818
        atomic_file.close()
 
819
        osutils.copy_ownership_from_path(self.file_name)
 
820
 
 
821
 
 
822
class LockableConfig(IniBasedConfig):
 
823
    """A configuration needing explicit locking for access.
 
824
 
 
825
    If several processes try to write the config file, the accesses need to be
 
826
    serialized.
 
827
 
 
828
    Daughter classes should decorate all methods that update a config with the
 
829
    ``@needs_write_lock`` decorator (they call, directly or indirectly, the
 
830
    ``_write_config_file()`` method. These methods (typically ``set_option()``
 
831
    and variants must reload the config file from disk before calling
 
832
    ``_write_config_file()``), this can be achieved by calling the
 
833
    ``self.reload()`` method. Note that the lock scope should cover both the
 
834
    reading and the writing of the config file which is why the decorator can't
 
835
    be applied to ``_write_config_file()`` only.
 
836
 
 
837
    This should be enough to implement the following logic:
 
838
    - lock for exclusive write access,
 
839
    - reload the config file from disk,
 
840
    - set the new value
 
841
    - unlock
 
842
 
 
843
    This logic guarantees that a writer can update a value without erasing an
 
844
    update made by another writer.
 
845
    """
 
846
 
 
847
    lock_name = 'lock'
 
848
 
 
849
    def __init__(self, file_name):
 
850
        super(LockableConfig, self).__init__(file_name=file_name)
 
851
        self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
 
852
        # FIXME: It doesn't matter that we don't provide possible_transports
 
853
        # below since this is currently used only for local config files ;
 
854
        # local transports are not shared. But if/when we start using
 
855
        # LockableConfig for other kind of transports, we will need to reuse
 
856
        # whatever connection is already established -- vila 20100929
 
857
        self.transport = transport.get_transport(self.dir)
 
858
        self._lock = lockdir.LockDir(self.transport, self.lock_name)
 
859
 
 
860
    def _create_from_string(self, unicode_bytes, save):
 
861
        super(LockableConfig, self)._create_from_string(unicode_bytes, False)
 
862
        if save:
 
863
            # We need to handle the saving here (as opposed to IniBasedConfig)
 
864
            # to be able to lock
 
865
            self.lock_write()
 
866
            self._write_config_file()
 
867
            self.unlock()
 
868
 
 
869
    def lock_write(self, token=None):
 
870
        """Takes a write lock in the directory containing the config file.
 
871
 
 
872
        If the directory doesn't exist it is created.
 
873
        """
 
874
        ensure_config_dir_exists(self.dir)
 
875
        return self._lock.lock_write(token)
 
876
 
 
877
    def unlock(self):
 
878
        self._lock.unlock()
 
879
 
 
880
    def break_lock(self):
 
881
        self._lock.break_lock()
 
882
 
 
883
    @needs_write_lock
 
884
    def remove_user_option(self, option_name, section_name=None):
 
885
        super(LockableConfig, self).remove_user_option(option_name,
 
886
                                                       section_name)
 
887
 
 
888
    def _write_config_file(self):
 
889
        if self._lock is None or not self._lock.is_held:
 
890
            # NB: if the following exception is raised it probably means a
 
891
            # missing @needs_write_lock decorator on one of the callers.
 
892
            raise errors.ObjectNotLocked(self)
 
893
        super(LockableConfig, self)._write_config_file()
 
894
 
 
895
 
 
896
class GlobalConfig(LockableConfig):
481
897
    """The configuration that should be used for a specific location."""
482
898
 
 
899
    def __init__(self):
 
900
        super(GlobalConfig, self).__init__(file_name=config_filename())
 
901
 
 
902
    def config_id(self):
 
903
        return 'bazaar'
 
904
 
 
905
    @classmethod
 
906
    def from_string(cls, str_or_unicode, save=False):
 
907
        """Create a config object from a string.
 
908
 
 
909
        :param str_or_unicode: A string representing the file content. This
 
910
            will be utf-8 encoded.
 
911
 
 
912
        :param save: Whether the file should be saved upon creation.
 
913
        """
 
914
        conf = cls()
 
915
        conf._create_from_string(str_or_unicode, save)
 
916
        return conf
 
917
 
 
918
    @deprecated_method(deprecated_in((2, 4, 0)))
483
919
    def get_editor(self):
484
920
        return self._get_user_option('editor')
485
921
 
486
 
    def __init__(self):
487
 
        super(GlobalConfig, self).__init__(config_filename)
488
 
 
 
922
    @needs_write_lock
489
923
    def set_user_option(self, option, value):
490
924
        """Save option and its value in the configuration."""
491
925
        self._set_option(option, value, 'DEFAULT')
497
931
        else:
498
932
            return {}
499
933
 
 
934
    @needs_write_lock
500
935
    def set_alias(self, alias_name, alias_command):
501
936
        """Save the alias in the configuration."""
502
937
        self._set_option(alias_name, alias_command, 'ALIASES')
503
938
 
 
939
    @needs_write_lock
504
940
    def unset_alias(self, alias_name):
505
941
        """Unset an existing alias."""
 
942
        self.reload()
506
943
        aliases = self._get_parser().get('ALIASES')
507
944
        if not aliases or alias_name not in aliases:
508
945
            raise errors.NoSuchAlias(alias_name)
510
947
        self._write_config_file()
511
948
 
512
949
    def _set_option(self, option, value, section):
513
 
        # FIXME: RBC 20051029 This should refresh the parser and also take a
514
 
        # file lock on bazaar.conf.
515
 
        conf_dir = os.path.dirname(self._get_filename())
516
 
        ensure_config_dir_exists(conf_dir)
 
950
        self.reload()
517
951
        self._get_parser().setdefault(section, {})[option] = value
518
952
        self._write_config_file()
519
953
 
520
 
    def _write_config_file(self):
521
 
        path = self._get_filename()
522
 
        f = open(path, 'wb')
523
 
        osutils.copy_ownership_from_path(path)
524
 
        self._get_parser().write(f)
525
 
        f.close()
526
 
 
527
 
 
528
 
class LocationConfig(IniBasedConfig):
 
954
 
 
955
    def _get_sections(self, name=None):
 
956
        """See IniBasedConfig._get_sections()."""
 
957
        parser = self._get_parser()
 
958
        # We don't give access to options defined outside of any section, we
 
959
        # used the DEFAULT section by... default.
 
960
        if name in (None, 'DEFAULT'):
 
961
            # This could happen for an empty file where the DEFAULT section
 
962
            # doesn't exist yet. So we force DEFAULT when yielding
 
963
            name = 'DEFAULT'
 
964
            if 'DEFAULT' not in parser:
 
965
               parser['DEFAULT']= {}
 
966
        yield (name, parser[name], self.config_id())
 
967
 
 
968
    @needs_write_lock
 
969
    def remove_user_option(self, option_name, section_name=None):
 
970
        if section_name is None:
 
971
            # We need to force the default section.
 
972
            section_name = 'DEFAULT'
 
973
        # We need to avoid the LockableConfig implementation or we'll lock
 
974
        # twice
 
975
        super(LockableConfig, self).remove_user_option(option_name,
 
976
                                                       section_name)
 
977
 
 
978
def _iter_for_location_by_parts(sections, location):
 
979
    """Keep only the sessions matching the specified location.
 
980
 
 
981
    :param sections: An iterable of section names.
 
982
 
 
983
    :param location: An url or a local path to match against.
 
984
 
 
985
    :returns: An iterator of (section, extra_path, nb_parts) where nb is the
 
986
        number of path components in the section name, section is the section
 
987
        name and extra_path is the difference between location and the section
 
988
        name.
 
989
 
 
990
    ``location`` will always be a local path and never a 'file://' url but the
 
991
    section names themselves can be in either form.
 
992
    """
 
993
    location_parts = location.rstrip('/').split('/')
 
994
 
 
995
    for section in sections:
 
996
        # location is a local path if possible, so we need to convert 'file://'
 
997
        # urls in section names to local paths if necessary.
 
998
 
 
999
        # This also avoids having file:///path be a more exact
 
1000
        # match than '/path'.
 
1001
 
 
1002
        # FIXME: This still raises an issue if a user defines both file:///path
 
1003
        # *and* /path. Should we raise an error in this case -- vila 20110505
 
1004
 
 
1005
        if section.startswith('file://'):
 
1006
            section_path = urlutils.local_path_from_url(section)
 
1007
        else:
 
1008
            section_path = section
 
1009
        section_parts = section_path.rstrip('/').split('/')
 
1010
 
 
1011
        matched = True
 
1012
        if len(section_parts) > len(location_parts):
 
1013
            # More path components in the section, they can't match
 
1014
            matched = False
 
1015
        else:
 
1016
            # Rely on zip truncating in length to the length of the shortest
 
1017
            # argument sequence.
 
1018
            names = zip(location_parts, section_parts)
 
1019
            for name in names:
 
1020
                if not fnmatch.fnmatch(name[0], name[1]):
 
1021
                    matched = False
 
1022
                    break
 
1023
        if not matched:
 
1024
            continue
 
1025
        # build the path difference between the section and the location
 
1026
        extra_path = '/'.join(location_parts[len(section_parts):])
 
1027
        yield section, extra_path, len(section_parts)
 
1028
 
 
1029
 
 
1030
class LocationConfig(LockableConfig):
529
1031
    """A configuration object that gives the policy for a location."""
530
1032
 
531
1033
    def __init__(self, location):
532
 
        name_generator = locations_config_filename
533
 
        if (not os.path.exists(name_generator()) and
534
 
                os.path.exists(branches_config_filename())):
535
 
            if sys.platform == 'win32':
536
 
                trace.warning('Please rename %s to %s'
537
 
                              % (branches_config_filename(),
538
 
                                 locations_config_filename()))
539
 
            else:
540
 
                trace.warning('Please rename ~/.bazaar/branches.conf'
541
 
                              ' to ~/.bazaar/locations.conf')
542
 
            name_generator = branches_config_filename
543
 
        super(LocationConfig, self).__init__(name_generator)
 
1034
        super(LocationConfig, self).__init__(
 
1035
            file_name=locations_config_filename())
544
1036
        # local file locations are looked up by local path, rather than
545
1037
        # by file url. This is because the config file is a user
546
1038
        # file, and we would rather not expose the user to file urls.
548
1040
            location = urlutils.local_path_from_url(location)
549
1041
        self.location = location
550
1042
 
 
1043
    def config_id(self):
 
1044
        return 'locations'
 
1045
 
 
1046
    @classmethod
 
1047
    def from_string(cls, str_or_unicode, location, save=False):
 
1048
        """Create a config object from a string.
 
1049
 
 
1050
        :param str_or_unicode: A string representing the file content. This will
 
1051
            be utf-8 encoded.
 
1052
 
 
1053
        :param location: The location url to filter the configuration.
 
1054
 
 
1055
        :param save: Whether the file should be saved upon creation.
 
1056
        """
 
1057
        conf = cls(location)
 
1058
        conf._create_from_string(str_or_unicode, save)
 
1059
        return conf
 
1060
 
551
1061
    def _get_matching_sections(self):
552
1062
        """Return an ordered list of section names matching this location."""
553
 
        sections = self._get_parser()
554
 
        location_names = self.location.split('/')
555
 
        if self.location.endswith('/'):
556
 
            del location_names[-1]
557
 
        matches=[]
558
 
        for section in sections:
559
 
            # location is a local path if possible, so we need
560
 
            # to convert 'file://' urls to local paths if necessary.
561
 
            # This also avoids having file:///path be a more exact
562
 
            # match than '/path'.
563
 
            if section.startswith('file://'):
564
 
                section_path = urlutils.local_path_from_url(section)
565
 
            else:
566
 
                section_path = section
567
 
            section_names = section_path.split('/')
568
 
            if section.endswith('/'):
569
 
                del section_names[-1]
570
 
            names = zip(location_names, section_names)
571
 
            matched = True
572
 
            for name in names:
573
 
                if not fnmatch(name[0], name[1]):
574
 
                    matched = False
575
 
                    break
576
 
            if not matched:
577
 
                continue
578
 
            # so, for the common prefix they matched.
579
 
            # if section is longer, no match.
580
 
            if len(section_names) > len(location_names):
581
 
                continue
582
 
            matches.append((len(section_names), section,
583
 
                            '/'.join(location_names[len(section_names):])))
584
 
        matches.sort(reverse=True)
585
 
        sections = []
586
 
        for (length, section, extra_path) in matches:
587
 
            sections.append((section, extra_path))
 
1063
        matches = list(_iter_for_location_by_parts(self._get_parser(),
 
1064
                                                   self.location))
 
1065
        # put the longest (aka more specific) locations first
 
1066
        matches.sort(
 
1067
            key=lambda (section, extra_path, length): (length, section),
 
1068
            reverse=True)
 
1069
        for (section, extra_path, length) in matches:
 
1070
            yield section, extra_path
588
1071
            # should we stop looking for parent configs here?
589
1072
            try:
590
1073
                if self._get_parser()[section].as_bool('ignore_parents'):
591
1074
                    break
592
1075
            except KeyError:
593
1076
                pass
594
 
        return sections
 
1077
 
 
1078
    def _get_sections(self, name=None):
 
1079
        """See IniBasedConfig._get_sections()."""
 
1080
        # We ignore the name here as the only sections handled are named with
 
1081
        # the location path and we don't expose embedded sections either.
 
1082
        parser = self._get_parser()
 
1083
        for name, extra_path in self._get_matching_sections():
 
1084
            yield (name, parser[name], self.config_id())
595
1085
 
596
1086
    def _get_option_policy(self, section, option_name):
597
1087
        """Return the policy for the given (section, option_name) pair."""
641
1131
            if policy_key in self._get_parser()[section]:
642
1132
                del self._get_parser()[section][policy_key]
643
1133
 
 
1134
    @needs_write_lock
644
1135
    def set_user_option(self, option, value, store=STORE_LOCATION):
645
1136
        """Save option and its value in the configuration."""
646
1137
        if store not in [STORE_LOCATION,
648
1139
                         STORE_LOCATION_APPENDPATH]:
649
1140
            raise ValueError('bad storage policy %r for %r' %
650
1141
                (store, option))
651
 
        # FIXME: RBC 20051029 This should refresh the parser and also take a
652
 
        # file lock on locations.conf.
653
 
        conf_dir = os.path.dirname(self._get_filename())
654
 
        ensure_config_dir_exists(conf_dir)
 
1142
        self.reload()
655
1143
        location = self.location
656
1144
        if location.endswith('/'):
657
1145
            location = location[:-1]
658
 
        if (not location in self._get_parser() and
659
 
            not location + '/' in self._get_parser()):
660
 
            self._get_parser()[location]={}
661
 
        elif location + '/' in self._get_parser():
 
1146
        parser = self._get_parser()
 
1147
        if not location in parser and not location + '/' in parser:
 
1148
            parser[location] = {}
 
1149
        elif location + '/' in parser:
662
1150
            location = location + '/'
663
 
        self._get_parser()[location][option]=value
 
1151
        parser[location][option]=value
664
1152
        # the allowed values of store match the config policies
665
1153
        self._set_option_policy(location, option, store)
666
 
        self._get_parser().write(file(self._get_filename(), 'wb'))
 
1154
        self._write_config_file()
667
1155
 
668
1156
 
669
1157
class BranchConfig(Config):
670
1158
    """A configuration object giving the policy for a branch."""
671
1159
 
 
1160
    def __init__(self, branch):
 
1161
        super(BranchConfig, self).__init__()
 
1162
        self._location_config = None
 
1163
        self._branch_data_config = None
 
1164
        self._global_config = None
 
1165
        self.branch = branch
 
1166
        self.option_sources = (self._get_location_config,
 
1167
                               self._get_branch_data_config,
 
1168
                               self._get_global_config)
 
1169
 
 
1170
    def config_id(self):
 
1171
        return 'branch'
 
1172
 
672
1173
    def _get_branch_data_config(self):
673
1174
        if self._branch_data_config is None:
674
1175
            self._branch_data_config = TreeConfig(self.branch)
 
1176
            self._branch_data_config.config_id = self.config_id
675
1177
        return self._branch_data_config
676
1178
 
677
1179
    def _get_location_config(self):
745
1247
                return value
746
1248
        return None
747
1249
 
 
1250
    def _get_sections(self, name=None):
 
1251
        """See IniBasedConfig.get_sections()."""
 
1252
        for source in self.option_sources:
 
1253
            for section in source()._get_sections(name):
 
1254
                yield section
 
1255
 
 
1256
    def _get_options(self, sections=None):
 
1257
        opts = []
 
1258
        # First the locations options
 
1259
        for option in self._get_location_config()._get_options():
 
1260
            yield option
 
1261
        # Then the branch options
 
1262
        branch_config = self._get_branch_data_config()
 
1263
        if sections is None:
 
1264
            sections = [('DEFAULT', branch_config._get_parser())]
 
1265
        # FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
 
1266
        # Config itself has no notion of sections :( -- vila 20101001
 
1267
        config_id = self.config_id()
 
1268
        for (section_name, section) in sections:
 
1269
            for (name, value) in section.iteritems():
 
1270
                yield (name, value, section_name,
 
1271
                       config_id, branch_config._get_parser())
 
1272
        # Then the global options
 
1273
        for option in self._get_global_config()._get_options():
 
1274
            yield option
 
1275
 
748
1276
    def set_user_option(self, name, value, store=STORE_BRANCH,
749
1277
        warn_masked=False):
750
1278
        if store == STORE_BRANCH:
768
1296
                        trace.warning('Value "%s" is masked by "%s" from'
769
1297
                                      ' branch.conf', value, mask_value)
770
1298
 
 
1299
    def remove_user_option(self, option_name, section_name=None):
 
1300
        self._get_branch_data_config().remove_option(option_name, section_name)
 
1301
 
771
1302
    def _gpg_signing_command(self):
772
1303
        """See Config.gpg_signing_command."""
773
1304
        return self._get_safe_value('_gpg_signing_command')
774
1305
 
775
 
    def __init__(self, branch):
776
 
        super(BranchConfig, self).__init__()
777
 
        self._location_config = None
778
 
        self._branch_data_config = None
779
 
        self._global_config = None
780
 
        self.branch = branch
781
 
        self.option_sources = (self._get_location_config,
782
 
                               self._get_branch_data_config,
783
 
                               self._get_global_config)
784
 
 
785
1306
    def _post_commit(self):
786
1307
        """See Config.post_commit."""
787
1308
        return self._get_safe_value('_post_commit')
817
1338
            parent_dir = os.path.dirname(path)
818
1339
            if not os.path.isdir(parent_dir):
819
1340
                trace.mutter('creating config parent directory: %r', parent_dir)
820
 
            os.mkdir(parent_dir)
 
1341
                os.mkdir(parent_dir)
821
1342
        trace.mutter('creating config directory: %r', path)
822
1343
        os.mkdir(path)
823
1344
        osutils.copy_ownership_from_path(path)
826
1347
def config_dir():
827
1348
    """Return per-user configuration directory.
828
1349
 
829
 
    By default this is ~/.bazaar/
 
1350
    By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
 
1351
    and Linux.  On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
 
1352
    that will be used instead.
830
1353
 
831
1354
    TODO: Global option --config-dir to override this.
832
1355
    """
833
1356
    base = os.environ.get('BZR_HOME', None)
834
1357
    if sys.platform == 'win32':
 
1358
        # environ variables on Windows are in user encoding/mbcs. So decode
 
1359
        # before using one
 
1360
        if base is not None:
 
1361
            base = base.decode('mbcs')
835
1362
        if base is None:
836
1363
            base = win32utils.get_appdata_location_unicode()
837
1364
        if base is None:
838
1365
            base = os.environ.get('HOME', None)
 
1366
            if base is not None:
 
1367
                base = base.decode('mbcs')
839
1368
        if base is None:
840
1369
            raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
841
1370
                                  ' or HOME set')
842
1371
        return osutils.pathjoin(base, 'bazaar', '2.0')
 
1372
    elif sys.platform == 'darwin':
 
1373
        if base is None:
 
1374
            # this takes into account $HOME
 
1375
            base = os.path.expanduser("~")
 
1376
        return osutils.pathjoin(base, '.bazaar')
843
1377
    else:
844
 
        # cygwin, linux, and darwin all have a $HOME directory
845
1378
        if base is None:
 
1379
 
 
1380
            xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
 
1381
            if xdg_dir is None:
 
1382
                xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
 
1383
            xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
 
1384
            if osutils.isdir(xdg_dir):
 
1385
                trace.mutter(
 
1386
                    "Using configuration in XDG directory %s." % xdg_dir)
 
1387
                return xdg_dir
 
1388
 
846
1389
            base = os.path.expanduser("~")
847
1390
        return osutils.pathjoin(base, ".bazaar")
848
1391
 
852
1395
    return osutils.pathjoin(config_dir(), 'bazaar.conf')
853
1396
 
854
1397
 
855
 
def branches_config_filename():
856
 
    """Return per-user configuration ini file filename."""
857
 
    return osutils.pathjoin(config_dir(), 'branches.conf')
858
 
 
859
 
 
860
1398
def locations_config_filename():
861
1399
    """Return per-user configuration ini file filename."""
862
1400
    return osutils.pathjoin(config_dir(), 'locations.conf')
899
1437
        return os.path.expanduser('~/.cache')
900
1438
 
901
1439
 
 
1440
def _get_default_mail_domain():
 
1441
    """If possible, return the assumed default email domain.
 
1442
 
 
1443
    :returns: string mail domain, or None.
 
1444
    """
 
1445
    if sys.platform == 'win32':
 
1446
        # No implementation yet; patches welcome
 
1447
        return None
 
1448
    try:
 
1449
        f = open('/etc/mailname')
 
1450
    except (IOError, OSError), e:
 
1451
        return None
 
1452
    try:
 
1453
        domain = f.read().strip()
 
1454
        return domain
 
1455
    finally:
 
1456
        f.close()
 
1457
 
 
1458
 
902
1459
def _auto_user_id():
903
1460
    """Calculate automatic user identification.
904
1461
 
905
 
    Returns (realname, email).
 
1462
    :returns: (realname, email), either of which may be None if they can't be
 
1463
    determined.
906
1464
 
907
1465
    Only used when none is set in the environment or the id file.
908
1466
 
909
 
    This previously used the FQDN as the default domain, but that can
910
 
    be very slow on machines where DNS is broken.  So now we simply
911
 
    use the hostname.
 
1467
    This only returns an email address if we can be fairly sure the 
 
1468
    address is reasonable, ie if /etc/mailname is set on unix.
 
1469
 
 
1470
    This doesn't use the FQDN as the default domain because that may be 
 
1471
    slow, and it doesn't use the hostname alone because that's not normally 
 
1472
    a reasonable address.
912
1473
    """
913
 
    import socket
914
 
 
915
1474
    if sys.platform == 'win32':
916
 
        name = win32utils.get_user_name_unicode()
917
 
        if name is None:
918
 
            raise errors.BzrError("Cannot autodetect user name.\n"
919
 
                                  "Please, set your name with command like:\n"
920
 
                                  'bzr whoami "Your Name <name@domain.com>"')
921
 
        host = win32utils.get_host_name_unicode()
922
 
        if host is None:
923
 
            host = socket.gethostname()
924
 
        return name, (name + '@' + host)
925
 
 
926
 
    try:
927
 
        import pwd
928
 
        uid = os.getuid()
929
 
        try:
930
 
            w = pwd.getpwuid(uid)
931
 
        except KeyError:
932
 
            raise errors.BzrCommandError('Unable to determine your name.  '
933
 
                'Please use "bzr whoami" to set it.')
934
 
 
935
 
        # we try utf-8 first, because on many variants (like Linux),
936
 
        # /etc/passwd "should" be in utf-8, and because it's unlikely to give
937
 
        # false positives.  (many users will have their user encoding set to
938
 
        # latin-1, which cannot raise UnicodeError.)
939
 
        try:
940
 
            gecos = w.pw_gecos.decode('utf-8')
941
 
            encoding = 'utf-8'
942
 
        except UnicodeError:
943
 
            try:
944
 
                encoding = osutils.get_user_encoding()
945
 
                gecos = w.pw_gecos.decode(encoding)
946
 
            except UnicodeError:
947
 
                raise errors.BzrCommandError('Unable to determine your name.  '
948
 
                   'Use "bzr whoami" to set it.')
949
 
        try:
950
 
            username = w.pw_name.decode(encoding)
951
 
        except UnicodeError:
952
 
            raise errors.BzrCommandError('Unable to determine your name.  '
953
 
                'Use "bzr whoami" to set it.')
954
 
 
955
 
        comma = gecos.find(',')
956
 
        if comma == -1:
957
 
            realname = gecos
958
 
        else:
959
 
            realname = gecos[:comma]
960
 
        if not realname:
961
 
            realname = username
962
 
 
963
 
    except ImportError:
964
 
        import getpass
965
 
        try:
966
 
            user_encoding = osutils.get_user_encoding()
967
 
            realname = username = getpass.getuser().decode(user_encoding)
968
 
        except UnicodeDecodeError:
969
 
            raise errors.BzrError("Can't decode username as %s." % \
970
 
                    user_encoding)
971
 
 
972
 
    return realname, (username + '@' + socket.gethostname())
 
1475
        # No implementation to reliably determine Windows default mail
 
1476
        # address; please add one.
 
1477
        return None, None
 
1478
 
 
1479
    default_mail_domain = _get_default_mail_domain()
 
1480
    if not default_mail_domain:
 
1481
        return None, None
 
1482
 
 
1483
    import pwd
 
1484
    uid = os.getuid()
 
1485
    try:
 
1486
        w = pwd.getpwuid(uid)
 
1487
    except KeyError:
 
1488
        trace.mutter('no passwd entry for uid %d?' % uid)
 
1489
        return None, None
 
1490
 
 
1491
    # we try utf-8 first, because on many variants (like Linux),
 
1492
    # /etc/passwd "should" be in utf-8, and because it's unlikely to give
 
1493
    # false positives.  (many users will have their user encoding set to
 
1494
    # latin-1, which cannot raise UnicodeError.)
 
1495
    try:
 
1496
        gecos = w.pw_gecos.decode('utf-8')
 
1497
        encoding = 'utf-8'
 
1498
    except UnicodeError:
 
1499
        try:
 
1500
            encoding = osutils.get_user_encoding()
 
1501
            gecos = w.pw_gecos.decode(encoding)
 
1502
        except UnicodeError, e:
 
1503
            trace.mutter("cannot decode passwd entry %s" % w)
 
1504
            return None, None
 
1505
    try:
 
1506
        username = w.pw_name.decode(encoding)
 
1507
    except UnicodeError, e:
 
1508
        trace.mutter("cannot decode passwd entry %s" % w)
 
1509
        return None, None
 
1510
 
 
1511
    comma = gecos.find(',')
 
1512
    if comma == -1:
 
1513
        realname = gecos
 
1514
    else:
 
1515
        realname = gecos[:comma]
 
1516
 
 
1517
    return realname, (username + '@' + default_mail_domain)
973
1518
 
974
1519
 
975
1520
def parse_username(username):
1020
1565
 
1021
1566
    def set_option(self, value, name, section=None):
1022
1567
        """Set a per-branch configuration option"""
 
1568
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1569
        # higher levels providing the right lock -- vila 20101004
1023
1570
        self.branch.lock_write()
1024
1571
        try:
1025
1572
            self._config.set_option(value, name, section)
1026
1573
        finally:
1027
1574
            self.branch.unlock()
1028
1575
 
 
1576
    def remove_option(self, option_name, section_name=None):
 
1577
        # FIXME: We shouldn't need to lock explicitly here but rather rely on
 
1578
        # higher levels providing the right lock -- vila 20101004
 
1579
        self.branch.lock_write()
 
1580
        try:
 
1581
            self._config.remove_option(option_name, section_name)
 
1582
        finally:
 
1583
            self.branch.unlock()
 
1584
 
1029
1585
 
1030
1586
class AuthenticationConfig(object):
1031
1587
    """The authentication configuration file based on a ini file.
1063
1619
        """Save the config file, only tests should use it for now."""
1064
1620
        conf_dir = os.path.dirname(self._filename)
1065
1621
        ensure_config_dir_exists(conf_dir)
1066
 
        self._get_config().write(file(self._filename, 'wb'))
 
1622
        f = file(self._filename, 'wb')
 
1623
        try:
 
1624
            self._get_config().write(f)
 
1625
        finally:
 
1626
            f.close()
1067
1627
 
1068
1628
    def _set_option(self, section_name, option_name, value):
1069
1629
        """Set an authentication configuration option"""
1249
1809
            if ask:
1250
1810
                if prompt is None:
1251
1811
                    # Create a default prompt suitable for most cases
1252
 
                    prompt = scheme.upper() + ' %(host)s username'
 
1812
                    prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1253
1813
                # Special handling for optional fields in the prompt
1254
1814
                if port is not None:
1255
1815
                    prompt_host = '%s:%d' % (host, port)
1293
1853
        if password is None:
1294
1854
            if prompt is None:
1295
1855
                # Create a default prompt suitable for most cases
1296
 
                prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password'
 
1856
                prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
1297
1857
            # Special handling for optional fields in the prompt
1298
1858
            if port is not None:
1299
1859
                prompt_host = '%s:%d' % (host, port)
1470
2030
    """A Config that reads/writes a config file on a Transport.
1471
2031
 
1472
2032
    It is a low-level object that considers config data to be name/value pairs
1473
 
    that may be associated with a section.  Assigning meaning to the these
1474
 
    values is done at higher levels like TreeConfig.
 
2033
    that may be associated with a section.  Assigning meaning to these values
 
2034
    is done at higher levels like TreeConfig.
1475
2035
    """
1476
2036
 
1477
2037
    def __init__(self, transport, filename):
1510
2070
            configobj.setdefault(section, {})[name] = value
1511
2071
        self._set_configobj(configobj)
1512
2072
 
 
2073
    def remove_option(self, option_name, section_name=None):
 
2074
        configobj = self._get_configobj()
 
2075
        if section_name is None:
 
2076
            del configobj[option_name]
 
2077
        else:
 
2078
            del configobj[section_name][option_name]
 
2079
        self._set_configobj(configobj)
 
2080
 
1513
2081
    def _get_config_file(self):
1514
2082
        try:
1515
2083
            return StringIO(self._transport.get_bytes(self._filename))
1517
2085
            return StringIO()
1518
2086
 
1519
2087
    def _get_configobj(self):
1520
 
        return ConfigObj(self._get_config_file(), encoding='utf-8')
 
2088
        f = self._get_config_file()
 
2089
        try:
 
2090
            return ConfigObj(f, encoding='utf-8')
 
2091
        finally:
 
2092
            f.close()
1521
2093
 
1522
2094
    def _set_configobj(self, configobj):
1523
2095
        out_file = StringIO()
1524
2096
        configobj.write(out_file)
1525
2097
        out_file.seek(0)
1526
2098
        self._transport.put_file(self._filename, out_file)
 
2099
 
 
2100
 
 
2101
class Option(object):
 
2102
    """An option definition.
 
2103
 
 
2104
    The option *values* are stored in config files and found in sections.
 
2105
 
 
2106
    Here we define various properties about the option itself, its default
 
2107
    value, in which config files it can be stored, etc (TBC).
 
2108
    """
 
2109
 
 
2110
    def __init__(self, name, default=None):
 
2111
        self.name = name
 
2112
        self.default = default
 
2113
 
 
2114
    def get_default(self):
 
2115
        return self.default
 
2116
 
 
2117
 
 
2118
# Options registry
 
2119
 
 
2120
option_registry = registry.Registry()
 
2121
 
 
2122
 
 
2123
option_registry.register(
 
2124
    'editor', Option('editor'),
 
2125
    help='The command called to launch an editor to enter a message.')
 
2126
 
 
2127
 
 
2128
class Section(object):
 
2129
    """A section defines a dict of option name => value.
 
2130
 
 
2131
    This is merely a read-only dict which can add some knowledge about the
 
2132
    options. It is *not* a python dict object though and doesn't try to mimic
 
2133
    its API.
 
2134
    """
 
2135
 
 
2136
    def __init__(self, section_id, options):
 
2137
        self.id = section_id
 
2138
        # We re-use the dict-like object received
 
2139
        self.options = options
 
2140
 
 
2141
    def get(self, name, default=None):
 
2142
        return self.options.get(name, default)
 
2143
 
 
2144
    def __repr__(self):
 
2145
        # Mostly for debugging use
 
2146
        return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
 
2147
 
 
2148
 
 
2149
_NewlyCreatedOption = object()
 
2150
"""Was the option created during the MutableSection lifetime"""
 
2151
 
 
2152
 
 
2153
class MutableSection(Section):
 
2154
    """A section allowing changes and keeping track of the original values."""
 
2155
 
 
2156
    def __init__(self, section_id, options):
 
2157
        super(MutableSection, self).__init__(section_id, options)
 
2158
        self.orig = {}
 
2159
 
 
2160
    def set(self, name, value):
 
2161
        if name not in self.options:
 
2162
            # This is a new option
 
2163
            self.orig[name] = _NewlyCreatedOption
 
2164
        elif name not in self.orig:
 
2165
            self.orig[name] = self.get(name, None)
 
2166
        self.options[name] = value
 
2167
 
 
2168
    def remove(self, name):
 
2169
        if name not in self.orig:
 
2170
            self.orig[name] = self.get(name, None)
 
2171
        del self.options[name]
 
2172
 
 
2173
 
 
2174
class Store(object):
 
2175
    """Abstract interface to persistent storage for configuration options."""
 
2176
 
 
2177
    readonly_section_class = Section
 
2178
    mutable_section_class = MutableSection
 
2179
 
 
2180
    def is_loaded(self):
 
2181
        """Returns True if the Store has been loaded.
 
2182
 
 
2183
        This is used to implement lazy loading and ensure the persistent
 
2184
        storage is queried only when needed.
 
2185
        """
 
2186
        raise NotImplementedError(self.is_loaded)
 
2187
 
 
2188
    def load(self):
 
2189
        """Loads the Store from persistent storage."""
 
2190
        raise NotImplementedError(self.load)
 
2191
 
 
2192
    def _load_from_string(self, str_or_unicode):
 
2193
        """Create a store from a string in configobj syntax.
 
2194
 
 
2195
        :param str_or_unicode: A string representing the file content. This will
 
2196
            be encoded to suit store needs internally.
 
2197
 
 
2198
        This is for tests and should not be used in production unless a
 
2199
        convincing use case can be demonstrated :)
 
2200
        """
 
2201
        raise NotImplementedError(self._load_from_string)
 
2202
 
 
2203
    def unload(self):
 
2204
        """Unloads the Store.
 
2205
 
 
2206
        This should make is_loaded() return False. This is used when the caller
 
2207
        knows that the persistent storage has changed or may have change since
 
2208
        the last load.
 
2209
        """
 
2210
        raise NotImplementedError(self.unload)
 
2211
 
 
2212
    def save(self):
 
2213
        """Saves the Store to persistent storage."""
 
2214
        raise NotImplementedError(self.save)
 
2215
 
 
2216
    def external_url(self):
 
2217
        raise NotImplementedError(self.external_url)
 
2218
 
 
2219
    def get_sections(self):
 
2220
        """Returns an ordered iterable of existing sections.
 
2221
 
 
2222
        :returns: An iterable of (name, dict).
 
2223
        """
 
2224
        raise NotImplementedError(self.get_sections)
 
2225
 
 
2226
    def get_mutable_section(self, section_name=None):
 
2227
        """Returns the specified mutable section.
 
2228
 
 
2229
        :param section_name: The section identifier
 
2230
        """
 
2231
        raise NotImplementedError(self.get_mutable_section)
 
2232
 
 
2233
    def __repr__(self):
 
2234
        # Mostly for debugging use
 
2235
        return "<config.%s(%s)>" % (self.__class__.__name__,
 
2236
                                    self.external_url())
 
2237
 
 
2238
 
 
2239
class IniFileStore(Store):
 
2240
    """A config Store using ConfigObj for storage.
 
2241
 
 
2242
    :ivar transport: The transport object where the config file is located.
 
2243
 
 
2244
    :ivar file_name: The config file basename in the transport directory.
 
2245
 
 
2246
    :ivar _config_obj: Private member to hold the ConfigObj instance used to
 
2247
        serialize/deserialize the config file.
 
2248
    """
 
2249
 
 
2250
    def __init__(self, transport, file_name):
 
2251
        """A config Store using ConfigObj for storage.
 
2252
 
 
2253
        :param transport: The transport object where the config file is located.
 
2254
 
 
2255
        :param file_name: The config file basename in the transport directory.
 
2256
        """
 
2257
        super(IniFileStore, self).__init__()
 
2258
        self.transport = transport
 
2259
        self.file_name = file_name
 
2260
        self._config_obj = None
 
2261
 
 
2262
    def is_loaded(self):
 
2263
        return self._config_obj != None
 
2264
 
 
2265
    def unload(self):
 
2266
        self._config_obj = None
 
2267
 
 
2268
    def load(self):
 
2269
        """Load the store from the associated file."""
 
2270
        if self.is_loaded():
 
2271
            return
 
2272
        content = self.transport.get_bytes(self.file_name)
 
2273
        self._load_from_string(content)
 
2274
 
 
2275
    def _load_from_string(self, str_or_unicode):
 
2276
        """Create a config store from a string.
 
2277
 
 
2278
        :param str_or_unicode: A string representing the file content. This will
 
2279
            be utf-8 encoded internally.
 
2280
 
 
2281
        This is for tests and should not be used in production unless a
 
2282
        convincing use case can be demonstrated :)
 
2283
        """
 
2284
        if self.is_loaded():
 
2285
            raise AssertionError('Already loaded: %r' % (self._config_obj,))
 
2286
        co_input = StringIO(str_or_unicode.encode('utf-8'))
 
2287
        try:
 
2288
            # The config files are always stored utf8-encoded
 
2289
            self._config_obj = ConfigObj(co_input, encoding='utf-8')
 
2290
        except configobj.ConfigObjError, e:
 
2291
            self._config_obj = None
 
2292
            raise errors.ParseConfigError(e.errors, self.external_url())
 
2293
 
 
2294
    def save(self):
 
2295
        if not self.is_loaded():
 
2296
            # Nothing to save
 
2297
            return
 
2298
        out = StringIO()
 
2299
        self._config_obj.write(out)
 
2300
        self.transport.put_bytes(self.file_name, out.getvalue())
 
2301
 
 
2302
    def external_url(self):
 
2303
        # FIXME: external_url should really accepts an optional relpath
 
2304
        # parameter (bug #750169) :-/ -- vila 2011-04-04
 
2305
        # The following will do in the interim but maybe we don't want to
 
2306
        # expose a path here but rather a config ID and its associated
 
2307
        # object </hand wawe>.
 
2308
        return urlutils.join(self.transport.external_url(), self.file_name)
 
2309
 
 
2310
    def get_sections(self):
 
2311
        """Get the configobj section in the file order.
 
2312
 
 
2313
        :returns: An iterable of (name, dict).
 
2314
        """
 
2315
        # We need a loaded store
 
2316
        try:
 
2317
            self.load()
 
2318
        except errors.NoSuchFile:
 
2319
            # If the file doesn't exist, there is no sections
 
2320
            return
 
2321
        cobj = self._config_obj
 
2322
        if cobj.scalars:
 
2323
            yield self.readonly_section_class(None, cobj)
 
2324
        for section_name in cobj.sections:
 
2325
            yield self.readonly_section_class(section_name, cobj[section_name])
 
2326
 
 
2327
    def get_mutable_section(self, section_name=None):
 
2328
        # We need a loaded store
 
2329
        try:
 
2330
            self.load()
 
2331
        except errors.NoSuchFile:
 
2332
            # The file doesn't exist, let's pretend it was empty
 
2333
            self._load_from_string('')
 
2334
        if section_name is None:
 
2335
            section = self._config_obj
 
2336
        else:
 
2337
            section = self._config_obj.setdefault(section_name, {})
 
2338
        return self.mutable_section_class(section_name, section)
 
2339
 
 
2340
 
 
2341
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
 
2342
# unlockable stores for use with objects that can already ensure the locking
 
2343
# (think branches). If different stores (not based on ConfigObj) are created,
 
2344
# they may face the same issue.
 
2345
 
 
2346
 
 
2347
class LockableIniFileStore(IniFileStore):
 
2348
    """A ConfigObjStore using locks on save to ensure store integrity."""
 
2349
 
 
2350
    def __init__(self, transport, file_name, lock_dir_name=None):
 
2351
        """A config Store using ConfigObj for storage.
 
2352
 
 
2353
        :param transport: The transport object where the config file is located.
 
2354
 
 
2355
        :param file_name: The config file basename in the transport directory.
 
2356
        """
 
2357
        if lock_dir_name is None:
 
2358
            lock_dir_name = 'lock'
 
2359
        self.lock_dir_name = lock_dir_name
 
2360
        super(LockableIniFileStore, self).__init__(transport, file_name)
 
2361
        self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
 
2362
 
 
2363
    def lock_write(self, token=None):
 
2364
        """Takes a write lock in the directory containing the config file.
 
2365
 
 
2366
        If the directory doesn't exist it is created.
 
2367
        """
 
2368
        # FIXME: This doesn't check the ownership of the created directories as
 
2369
        # ensure_config_dir_exists does. It should if the transport is local
 
2370
        # -- vila 2011-04-06
 
2371
        self.transport.create_prefix()
 
2372
        return self._lock.lock_write(token)
 
2373
 
 
2374
    def unlock(self):
 
2375
        self._lock.unlock()
 
2376
 
 
2377
    def break_lock(self):
 
2378
        self._lock.break_lock()
 
2379
 
 
2380
    @needs_write_lock
 
2381
    def save(self):
 
2382
        # We need to be able to override the undecorated implementation
 
2383
        self.save_without_locking()
 
2384
 
 
2385
    def save_without_locking(self):
 
2386
        super(LockableIniFileStore, self).save()
 
2387
 
 
2388
 
 
2389
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
 
2390
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
 
2391
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
 
2392
 
 
2393
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
 
2394
# functions or a registry will make it easier and clearer for tests, focusing
 
2395
# on the relevant parts of the API that needs testing -- vila 20110503 (based
 
2396
# on a poolie's remark)
 
2397
class GlobalStore(LockableIniFileStore):
 
2398
 
 
2399
    def __init__(self, possible_transports=None):
 
2400
        t = transport.get_transport(config_dir(),
 
2401
                                    possible_transports=possible_transports)
 
2402
        super(GlobalStore, self).__init__(t, 'bazaar.conf')
 
2403
 
 
2404
 
 
2405
class LocationStore(LockableIniFileStore):
 
2406
 
 
2407
    def __init__(self, possible_transports=None):
 
2408
        t = transport.get_transport(config_dir(),
 
2409
                                    possible_transports=possible_transports)
 
2410
        super(LocationStore, self).__init__(t, 'locations.conf')
 
2411
 
 
2412
 
 
2413
class BranchStore(IniFileStore):
 
2414
 
 
2415
    def __init__(self, branch):
 
2416
        super(BranchStore, self).__init__(branch.control_transport,
 
2417
                                          'branch.conf')
 
2418
        self.branch = branch
 
2419
 
 
2420
    def lock_write(self, token=None):
 
2421
        return self.branch.lock_write(token)
 
2422
 
 
2423
    def unlock(self):
 
2424
        return self.branch.unlock()
 
2425
 
 
2426
    @needs_write_lock
 
2427
    def save(self):
 
2428
        # We need to be able to override the undecorated implementation
 
2429
        self.save_without_locking()
 
2430
 
 
2431
    def save_without_locking(self):
 
2432
        super(BranchStore, self).save()
 
2433
 
 
2434
 
 
2435
class SectionMatcher(object):
 
2436
    """Select sections into a given Store.
 
2437
 
 
2438
    This intended to be used to postpone getting an iterable of sections from a
 
2439
    store.
 
2440
    """
 
2441
 
 
2442
    def __init__(self, store):
 
2443
        self.store = store
 
2444
 
 
2445
    def get_sections(self):
 
2446
        # This is where we require loading the store so we can see all defined
 
2447
        # sections.
 
2448
        sections = self.store.get_sections()
 
2449
        # Walk the revisions in the order provided
 
2450
        for s in sections:
 
2451
            if self.match(s):
 
2452
                yield s
 
2453
 
 
2454
    def match(self, secion):
 
2455
        raise NotImplementedError(self.match)
 
2456
 
 
2457
 
 
2458
class LocationSection(Section):
 
2459
 
 
2460
    def __init__(self, section, length, extra_path):
 
2461
        super(LocationSection, self).__init__(section.id, section.options)
 
2462
        self.length = length
 
2463
        self.extra_path = extra_path
 
2464
 
 
2465
    def get(self, name, default=None):
 
2466
        value = super(LocationSection, self).get(name, default)
 
2467
        if value is not None:
 
2468
            policy_name = self.get(name + ':policy', None)
 
2469
            policy = _policy_value.get(policy_name, POLICY_NONE)
 
2470
            if policy == POLICY_APPENDPATH:
 
2471
                value = urlutils.join(value, self.extra_path)
 
2472
        return value
 
2473
 
 
2474
 
 
2475
class LocationMatcher(SectionMatcher):
 
2476
 
 
2477
    def __init__(self, store, location):
 
2478
        super(LocationMatcher, self).__init__(store)
 
2479
        if location.startswith('file://'):
 
2480
            location = urlutils.local_path_from_url(location)
 
2481
        self.location = location
 
2482
 
 
2483
    def _get_matching_sections(self):
 
2484
        """Get all sections matching ``location``."""
 
2485
        # We slightly diverge from LocalConfig here by allowing the no-name
 
2486
        # section as the most generic one and the lower priority.
 
2487
        no_name_section = None
 
2488
        sections = []
 
2489
        # Filter out the no_name_section so _iter_for_location_by_parts can be
 
2490
        # used (it assumes all sections have a name).
 
2491
        for section in self.store.get_sections():
 
2492
            if section.id is None:
 
2493
                no_name_section = section
 
2494
            else:
 
2495
                sections.append(section)
 
2496
        # Unfortunately _iter_for_location_by_parts deals with section names so
 
2497
        # we have to resync.
 
2498
        filtered_sections = _iter_for_location_by_parts(
 
2499
            [s.id for s in sections], self.location)
 
2500
        iter_sections = iter(sections)
 
2501
        matching_sections = []
 
2502
        if no_name_section is not None:
 
2503
            matching_sections.append(
 
2504
                LocationSection(no_name_section, 0, self.location))
 
2505
        for section_id, extra_path, length in filtered_sections:
 
2506
            # a section id is unique for a given store so it's safe to iterate
 
2507
            # again
 
2508
            section = iter_sections.next()
 
2509
            if section_id == section.id:
 
2510
                matching_sections.append(
 
2511
                    LocationSection(section, length, extra_path))
 
2512
        return matching_sections
 
2513
 
 
2514
    def get_sections(self):
 
2515
        # Override the default implementation as we want to change the order
 
2516
        matching_sections = self._get_matching_sections()
 
2517
        # We want the longest (aka more specific) locations first
 
2518
        sections = sorted(matching_sections,
 
2519
                          key=lambda section: (section.length, section.id),
 
2520
                          reverse=True)
 
2521
        # Sections mentioning 'ignore_parents' restrict the selection
 
2522
        for section in sections:
 
2523
            # FIXME: We really want to use as_bool below -- vila 2011-04-07
 
2524
            ignore = section.get('ignore_parents', None)
 
2525
            if ignore is not None:
 
2526
                ignore = ui.bool_from_string(ignore)
 
2527
            if ignore:
 
2528
                break
 
2529
            # Finally, we have a valid section
 
2530
            yield section
 
2531
 
 
2532
 
 
2533
class Stack(object):
 
2534
    """A stack of configurations where an option can be defined"""
 
2535
 
 
2536
    def __init__(self, sections_def, store=None, mutable_section_name=None):
 
2537
        """Creates a stack of sections with an optional store for changes.
 
2538
 
 
2539
        :param sections_def: A list of Section or callables that returns an
 
2540
            iterable of Section. This defines the Sections for the Stack and
 
2541
            can be called repeatedly if needed.
 
2542
 
 
2543
        :param store: The optional Store where modifications will be
 
2544
            recorded. If none is specified, no modifications can be done.
 
2545
 
 
2546
        :param mutable_section_name: The name of the MutableSection where
 
2547
            changes are recorded. This requires the ``store`` parameter to be
 
2548
            specified.
 
2549
        """
 
2550
        self.sections_def = sections_def
 
2551
        self.store = store
 
2552
        self.mutable_section_name = mutable_section_name
 
2553
 
 
2554
    def get(self, name):
 
2555
        """Return the *first* option value found in the sections.
 
2556
 
 
2557
        This is where we guarantee that sections coming from Store are loaded
 
2558
        lazily: the loading is delayed until we need to either check that an
 
2559
        option exists or get its value, which in turn may require to discover
 
2560
        in which sections it can be defined. Both of these (section and option
 
2561
        existence) require loading the store (even partially).
 
2562
        """
 
2563
        # FIXME: No caching of options nor sections yet -- vila 20110503
 
2564
        value = None
 
2565
        # Ensuring lazy loading is achieved by delaying section matching (which
 
2566
        # implies querying the persistent storage) until it can't be avoided
 
2567
        # anymore by using callables to describe (possibly empty) section
 
2568
        # lists.
 
2569
        for section_or_callable in self.sections_def:
 
2570
            # Each section can expand to multiple ones when a callable is used
 
2571
            if callable(section_or_callable):
 
2572
                sections = section_or_callable()
 
2573
            else:
 
2574
                sections = [section_or_callable]
 
2575
            for section in sections:
 
2576
                value = section.get(name)
 
2577
                if value is not None:
 
2578
                    break
 
2579
            if value is not None:
 
2580
                break
 
2581
        if value is None:
 
2582
            # If the option is registered, it may provide a default value
 
2583
            try:
 
2584
                opt = option_registry.get(name)
 
2585
            except KeyError:
 
2586
                # Not registered
 
2587
                opt = None
 
2588
            if opt is not None:
 
2589
                value = opt.get_default()
 
2590
        return value
 
2591
 
 
2592
    def _get_mutable_section(self):
 
2593
        """Get the MutableSection for the Stack.
 
2594
 
 
2595
        This is where we guarantee that the mutable section is lazily loaded:
 
2596
        this means we won't load the corresponding store before setting a value
 
2597
        or deleting an option. In practice the store will often be loaded but
 
2598
        this allows helps catching some programming errors.
 
2599
        """
 
2600
        section = self.store.get_mutable_section(self.mutable_section_name)
 
2601
        return section
 
2602
 
 
2603
    def set(self, name, value):
 
2604
        """Set a new value for the option."""
 
2605
        section = self._get_mutable_section()
 
2606
        section.set(name, value)
 
2607
 
 
2608
    def remove(self, name):
 
2609
        """Remove an existing option."""
 
2610
        section = self._get_mutable_section()
 
2611
        section.remove(name)
 
2612
 
 
2613
    def __repr__(self):
 
2614
        # Mostly for debugging use
 
2615
        return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
 
2616
 
 
2617
 
 
2618
class _CompatibleStack(Stack):
 
2619
    """Place holder for compatibility with previous design.
 
2620
 
 
2621
    This is intended to ease the transition from the Config-based design to the
 
2622
    Stack-based design and should not be used nor relied upon by plugins.
 
2623
 
 
2624
    One assumption made here is that the daughter classes will all use Stores
 
2625
    derived from LockableIniFileStore).
 
2626
 
 
2627
    It implements set() by re-loading the store before applying the
 
2628
    modification and saving it.
 
2629
 
 
2630
    The long term plan being to implement a single write by store to save
 
2631
    all modifications, this class should not be used in the interim.
 
2632
    """
 
2633
 
 
2634
    def set(self, name, value):
 
2635
        # Force a reload
 
2636
        self.store.unload()
 
2637
        super(_CompatibleStack, self).set(name, value)
 
2638
        # Force a write to persistent storage
 
2639
        self.store.save()
 
2640
 
 
2641
 
 
2642
class GlobalStack(_CompatibleStack):
 
2643
 
 
2644
    def __init__(self):
 
2645
        # Get a GlobalStore
 
2646
        gstore = GlobalStore()
 
2647
        super(GlobalStack, self).__init__([gstore.get_sections], gstore)
 
2648
 
 
2649
 
 
2650
class LocationStack(_CompatibleStack):
 
2651
 
 
2652
    def __init__(self, location):
 
2653
        lstore = LocationStore()
 
2654
        matcher = LocationMatcher(lstore, location)
 
2655
        gstore = GlobalStore()
 
2656
        super(LocationStack, self).__init__(
 
2657
            [matcher.get_sections, gstore.get_sections], lstore)
 
2658
 
 
2659
class BranchStack(_CompatibleStack):
 
2660
 
 
2661
    def __init__(self, branch):
 
2662
        bstore = BranchStore(branch)
 
2663
        lstore = LocationStore()
 
2664
        matcher = LocationMatcher(lstore, branch.base)
 
2665
        gstore = GlobalStore()
 
2666
        super(BranchStack, self).__init__(
 
2667
            [matcher.get_sections, bstore.get_sections, gstore.get_sections],
 
2668
            bstore)
 
2669
        self.branch = branch
 
2670
 
 
2671
 
 
2672
class cmd_config(commands.Command):
 
2673
    __doc__ = """Display, set or remove a configuration option.
 
2674
 
 
2675
    Display the active value for a given option.
 
2676
 
 
2677
    If --all is specified, NAME is interpreted as a regular expression and all
 
2678
    matching options are displayed mentioning their scope. The active value
 
2679
    that bzr will take into account is the first one displayed for each option.
 
2680
 
 
2681
    If no NAME is given, --all .* is implied.
 
2682
 
 
2683
    Setting a value is achieved by using name=value without spaces. The value
 
2684
    is set in the most relevant scope and can be checked by displaying the
 
2685
    option again.
 
2686
    """
 
2687
 
 
2688
    takes_args = ['name?']
 
2689
 
 
2690
    takes_options = [
 
2691
        'directory',
 
2692
        # FIXME: This should be a registry option so that plugins can register
 
2693
        # their own config files (or not) -- vila 20101002
 
2694
        commands.Option('scope', help='Reduce the scope to the specified'
 
2695
                        ' configuration file',
 
2696
                        type=unicode),
 
2697
        commands.Option('all',
 
2698
            help='Display all the defined values for the matching options.',
 
2699
            ),
 
2700
        commands.Option('remove', help='Remove the option from'
 
2701
                        ' the configuration file'),
 
2702
        ]
 
2703
 
 
2704
    _see_also = ['configuration']
 
2705
 
 
2706
    @commands.display_command
 
2707
    def run(self, name=None, all=False, directory=None, scope=None,
 
2708
            remove=False):
 
2709
        if directory is None:
 
2710
            directory = '.'
 
2711
        directory = urlutils.normalize_url(directory)
 
2712
        if remove and all:
 
2713
            raise errors.BzrError(
 
2714
                '--all and --remove are mutually exclusive.')
 
2715
        elif remove:
 
2716
            # Delete the option in the given scope
 
2717
            self._remove_config_option(name, directory, scope)
 
2718
        elif name is None:
 
2719
            # Defaults to all options
 
2720
            self._show_matching_options('.*', directory, scope)
 
2721
        else:
 
2722
            try:
 
2723
                name, value = name.split('=', 1)
 
2724
            except ValueError:
 
2725
                # Display the option(s) value(s)
 
2726
                if all:
 
2727
                    self._show_matching_options(name, directory, scope)
 
2728
                else:
 
2729
                    self._show_value(name, directory, scope)
 
2730
            else:
 
2731
                if all:
 
2732
                    raise errors.BzrError(
 
2733
                        'Only one option can be set.')
 
2734
                # Set the option value
 
2735
                self._set_config_option(name, value, directory, scope)
 
2736
 
 
2737
    def _get_configs(self, directory, scope=None):
 
2738
        """Iterate the configurations specified by ``directory`` and ``scope``.
 
2739
 
 
2740
        :param directory: Where the configurations are derived from.
 
2741
 
 
2742
        :param scope: A specific config to start from.
 
2743
        """
 
2744
        if scope is not None:
 
2745
            if scope == 'bazaar':
 
2746
                yield GlobalConfig()
 
2747
            elif scope == 'locations':
 
2748
                yield LocationConfig(directory)
 
2749
            elif scope == 'branch':
 
2750
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2751
                    directory)
 
2752
                yield br.get_config()
 
2753
        else:
 
2754
            try:
 
2755
                (_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2756
                    directory)
 
2757
                yield br.get_config()
 
2758
            except errors.NotBranchError:
 
2759
                yield LocationConfig(directory)
 
2760
                yield GlobalConfig()
 
2761
 
 
2762
    def _show_value(self, name, directory, scope):
 
2763
        displayed = False
 
2764
        for c in self._get_configs(directory, scope):
 
2765
            if displayed:
 
2766
                break
 
2767
            for (oname, value, section, conf_id, parser) in c._get_options():
 
2768
                if name == oname:
 
2769
                    # Display only the first value and exit
 
2770
 
 
2771
                    # FIXME: We need to use get_user_option to take policies
 
2772
                    # into account and we need to make sure the option exists
 
2773
                    # too (hence the two for loops), this needs a better API
 
2774
                    # -- vila 20101117
 
2775
                    value = c.get_user_option(name)
 
2776
                    # Quote the value appropriately
 
2777
                    value = parser._quote(value)
 
2778
                    self.outf.write('%s\n' % (value,))
 
2779
                    displayed = True
 
2780
                    break
 
2781
        if not displayed:
 
2782
            raise errors.NoSuchConfigOption(name)
 
2783
 
 
2784
    def _show_matching_options(self, name, directory, scope):
 
2785
        name = re.compile(name)
 
2786
        # We want any error in the regexp to be raised *now* so we need to
 
2787
        # avoid the delay introduced by the lazy regexp.
 
2788
        name._compile_and_collapse()
 
2789
        cur_conf_id = None
 
2790
        cur_section = None
 
2791
        for c in self._get_configs(directory, scope):
 
2792
            for (oname, value, section, conf_id, parser) in c._get_options():
 
2793
                if name.search(oname):
 
2794
                    if cur_conf_id != conf_id:
 
2795
                        # Explain where the options are defined
 
2796
                        self.outf.write('%s:\n' % (conf_id,))
 
2797
                        cur_conf_id = conf_id
 
2798
                        cur_section = None
 
2799
                    if (section not in (None, 'DEFAULT')
 
2800
                        and cur_section != section):
 
2801
                        # Display the section if it's not the default (or only)
 
2802
                        # one.
 
2803
                        self.outf.write('  [%s]\n' % (section,))
 
2804
                        cur_section = section
 
2805
                    self.outf.write('  %s = %s\n' % (oname, value))
 
2806
 
 
2807
    def _set_config_option(self, name, value, directory, scope):
 
2808
        for conf in self._get_configs(directory, scope):
 
2809
            conf.set_user_option(name, value)
 
2810
            break
 
2811
        else:
 
2812
            raise errors.NoSuchConfig(scope)
 
2813
 
 
2814
    def _remove_config_option(self, name, directory, scope):
 
2815
        if name is None:
 
2816
            raise errors.BzrCommandError(
 
2817
                '--remove expects an option to remove.')
 
2818
        removed = False
 
2819
        for conf in self._get_configs(directory, scope):
 
2820
            for (section_name, section, conf_id) in conf._get_sections():
 
2821
                if scope is not None and conf_id != scope:
 
2822
                    # Not the right configuration file
 
2823
                    continue
 
2824
                if name in section:
 
2825
                    if conf_id != conf.config_id():
 
2826
                        conf = self._get_configs(directory, conf_id).next()
 
2827
                    # We use the first section in the first config where the
 
2828
                    # option is defined to remove it
 
2829
                    conf.remove_user_option(name, section_name)
 
2830
                    removed = True
 
2831
                    break
 
2832
            break
 
2833
        else:
 
2834
            raise errors.NoSuchConfig(scope)
 
2835
        if not removed:
 
2836
            raise errors.NoSuchConfigOption(name)
 
2837
 
 
2838
# Test registries
 
2839
#
 
2840
# We need adapters that can build a Store or a Stack in a test context. Test
 
2841
# classes, based on TestCaseWithTransport, can use the registry to parametrize
 
2842
# themselves. The builder will receive a test instance and should return a
 
2843
# ready-to-use store or stack.  Plugins that define new store/stacks can also
 
2844
# register themselves here to be tested against the tests defined in
 
2845
# bzrlib.tests.test_config. Note that the builder can be called multiple times
 
2846
# for the same tests.
 
2847
 
 
2848
# The registered object should be a callable receiving a test instance
 
2849
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
 
2850
# object.
 
2851
test_store_builder_registry = registry.Registry()
 
2852
 
 
2853
# The registered object should be a callable receiving a test instance
 
2854
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
 
2855
# object.
 
2856
test_stack_builder_registry = registry.Registry()