1
# Copyright (C) 2005-2011 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
"""Configuration that affects the behaviour of Bazaar.
21
Currently this configuration resides in ~/.bazaar/bazaar.conf
22
and ~/.bazaar/locations.conf, which is written to by bzr.
24
In bazaar.conf the following options may be set:
26
editor=name-of-program
27
email=Your Name <your@email.address>
28
check_signatures=require|ignore|check-available(default)
29
create_signatures=always|never|when-required(default)
30
gpg_signing_command=name-of-program
31
log_format=name-of-format
32
validate_signatures_in_log=true|false(default)
33
acceptable_keys=pattern1,pattern2
34
gpg_signing_key=amy@example.com
36
in locations.conf, you specify the url of a branch and options for it.
37
Wildcards may be used - * and ? as normal in shell completion. Options
38
set in both bazaar.conf and locations.conf are overridden by the locations.conf
40
[/home/robertc/source]
41
recurse=False|True(default)
43
check_signatures= as above
44
create_signatures= as above.
45
validate_signatures_in_log=as above
46
acceptable_keys=as above
48
explanation of options
49
----------------------
50
editor - this option sets the pop up editor to use during commits.
51
email - this option sets the user id bzr will use when committing.
52
check_signatures - this option will control whether bzr will require good gpg
53
signatures, ignore them, or check them if they are
54
present. Currently it is unused except that check_signatures
55
turns on create_signatures.
56
create_signatures - this option controls whether bzr will always create
57
gpg signatures or not on commits. There is an unused
58
option which in future is expected to work if
59
branch settings require signatures.
60
log_format - this option sets the default log format. Possible values are
61
long, short, line, or a plugin can register new formats.
62
validate_signatures_in_log - show GPG signature validity in log output
63
acceptable_keys - comma separated list of key patterns acceptable for
64
verify-signatures command
66
In bazaar.conf you can also define aliases in the ALIASES sections, example
69
lastlog=log --line -r-10..-1
70
ll=log --line -r-10..-1
75
from __future__ import absolute_import
81
from bzrlib.decorators import needs_write_lock
82
from bzrlib.lazy_import import lazy_import
83
lazy_import(globals(), """
86
from cStringIO import StringIO
106
from bzrlib.i18n import gettext
107
from bzrlib.util.configobj import configobj
115
from bzrlib.symbol_versioning import (
133
POLICY_APPENDPATH = 2
137
POLICY_NORECURSE: 'norecurse',
138
POLICY_APPENDPATH: 'appendpath',
143
'norecurse': POLICY_NORECURSE,
144
'appendpath': POLICY_APPENDPATH,
148
STORE_LOCATION = POLICY_NONE
149
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
150
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
155
def signature_policy_from_unicode(signature_string):
156
"""Convert a string to a signing policy."""
157
if signature_string.lower() == 'check-available':
158
return CHECK_IF_POSSIBLE
159
if signature_string.lower() == 'ignore':
161
if signature_string.lower() == 'require':
163
raise ValueError("Invalid signatures policy '%s'"
167
def signing_policy_from_unicode(signature_string):
168
"""Convert a string to a signing policy."""
169
if signature_string.lower() == 'when-required':
170
return SIGN_WHEN_REQUIRED
171
if signature_string.lower() == 'never':
173
if signature_string.lower() == 'always':
175
raise ValueError("Invalid signing policy '%s'"
179
class ConfigObj(configobj.ConfigObj):
181
def __init__(self, infile=None, **kwargs):
182
# We define our own interpolation mechanism calling it option expansion
183
super(ConfigObj, self).__init__(infile=infile,
187
def get_bool(self, section, key):
188
return self[section].as_bool(key)
190
def get_value(self, section, name):
191
# Try [] for the old DEFAULT section.
192
if section == "DEFAULT":
197
return self[section][name]
200
# FIXME: Until we can guarantee that each config file is loaded once and
201
# only once for a given bzrlib session, we don't want to re-read the file every
202
# time we query for an option so we cache the value (bad ! watch out for tests
203
# needing to restore the proper value). -- vila 20110219
204
_expand_default_value = None
205
def _get_expand_default_value():
206
global _expand_default_value
207
if _expand_default_value is not None:
208
return _expand_default_value
209
conf = GlobalConfig()
210
# Note that we must not use None for the expand value below or we'll run
211
# into infinite recursion. Using False really would be quite silly ;)
212
expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
214
# This is an opt-in feature, you *really* need to clearly say you want
217
_expand_default_value = expand
221
class Config(object):
222
"""A configuration policy - what username, editor, gpg needs etc."""
225
super(Config, self).__init__()
228
"""Returns a unique ID for the config."""
229
raise NotImplementedError(self.config_id)
231
@deprecated_method(deprecated_in((2, 4, 0)))
232
def get_editor(self):
233
"""Get the users pop up editor."""
234
raise NotImplementedError
236
def get_change_editor(self, old_tree, new_tree):
237
from bzrlib import diff
238
cmd = self._get_change_editor()
241
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
244
def get_mail_client(self):
245
"""Get a mail client to use"""
246
selected_client = self.get_user_option('mail_client')
247
_registry = mail_client.mail_client_registry
249
mail_client_class = _registry.get(selected_client)
251
raise errors.UnknownMailClient(selected_client)
252
return mail_client_class(self)
254
def _get_signature_checking(self):
255
"""Template method to override signature checking policy."""
257
def _get_signing_policy(self):
258
"""Template method to override signature creation policy."""
262
def expand_options(self, string, env=None):
263
"""Expand option references in the string in the configuration context.
265
:param string: The string containing option to expand.
267
:param env: An option dict defining additional configuration options or
268
overriding existing ones.
270
:returns: The expanded string.
272
return self._expand_options_in_string(string, env)
274
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
275
"""Expand options in a list of strings in the configuration context.
277
:param slist: A list of strings.
279
:param env: An option dict defining additional configuration options or
280
overriding existing ones.
282
:param _ref_stack: Private list containing the options being
283
expanded to detect loops.
285
:returns: The flatten list of expanded strings.
287
# expand options in each value separately flattening lists
290
value = self._expand_options_in_string(s, env, _ref_stack)
291
if isinstance(value, list):
297
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
298
"""Expand options in the string in the configuration context.
300
:param string: The string to be expanded.
302
:param env: An option dict defining additional configuration options or
303
overriding existing ones.
305
:param _ref_stack: Private list containing the options being
306
expanded to detect loops.
308
:returns: The expanded string.
311
# Not much to expand there
313
if _ref_stack is None:
314
# What references are currently resolved (to detect loops)
316
if self.option_ref_re is None:
317
# We want to match the most embedded reference first (i.e. for
318
# '{{foo}}' we will get '{foo}',
319
# for '{bar{baz}}' we will get '{baz}'
320
self.option_ref_re = re.compile('({[^{}]+})')
322
# We need to iterate until no more refs appear ({{foo}} will need two
323
# iterations for example).
325
raw_chunks = self.option_ref_re.split(result)
326
if len(raw_chunks) == 1:
327
# Shorcut the trivial case: no refs
331
# Split will isolate refs so that every other chunk is a ref
333
for chunk in raw_chunks:
336
# Keep only non-empty strings (or we get bogus empty
337
# slots when a list value is involved).
342
if name in _ref_stack:
343
raise errors.OptionExpansionLoop(string, _ref_stack)
344
_ref_stack.append(name)
345
value = self._expand_option(name, env, _ref_stack)
347
raise errors.ExpandingUnknownOption(name, string)
348
if isinstance(value, list):
356
# Once a list appears as the result of an expansion, all
357
# callers will get a list result. This allows a consistent
358
# behavior even when some options in the expansion chain
359
# defined as strings (no comma in their value) but their
360
# expanded value is a list.
361
return self._expand_options_in_list(chunks, env, _ref_stack)
363
result = ''.join(chunks)
366
def _expand_option(self, name, env, _ref_stack):
367
if env is not None and name in env:
368
# Special case, values provided in env takes precedence over
372
# FIXME: This is a limited implementation, what we really need is a
373
# way to query the bzr config for the value of an option,
374
# respecting the scope rules (That is, once we implement fallback
375
# configs, getting the option value should restart from the top
376
# config, not the current one) -- vila 20101222
377
value = self.get_user_option(name, expand=False)
378
if isinstance(value, list):
379
value = self._expand_options_in_list(value, env, _ref_stack)
381
value = self._expand_options_in_string(value, env, _ref_stack)
384
def _get_user_option(self, option_name):
385
"""Template method to provide a user option."""
388
def get_user_option(self, option_name, expand=None):
389
"""Get a generic option - no special process, no default.
391
:param option_name: The queried option.
393
:param expand: Whether options references should be expanded.
395
:returns: The value of the option.
398
expand = _get_expand_default_value()
399
value = self._get_user_option(option_name)
401
if isinstance(value, list):
402
value = self._expand_options_in_list(value)
403
elif isinstance(value, dict):
404
trace.warning('Cannot expand "%s":'
405
' Dicts do not support option expansion'
408
value = self._expand_options_in_string(value)
409
for hook in OldConfigHooks['get']:
410
hook(self, option_name, value)
413
def get_user_option_as_bool(self, option_name, expand=None, default=None):
414
"""Get a generic option as a boolean.
416
:param expand: Allow expanding references to other config values.
417
:param default: Default value if nothing is configured
418
:return None if the option doesn't exist or its value can't be
419
interpreted as a boolean. Returns True or False otherwise.
421
s = self.get_user_option(option_name, expand=expand)
423
# The option doesn't exist
425
val = ui.bool_from_string(s)
427
# The value can't be interpreted as a boolean
428
trace.warning('Value "%s" is not a boolean for "%s"',
432
def get_user_option_as_list(self, option_name, expand=None):
433
"""Get a generic option as a list - no special process, no default.
435
:return None if the option doesn't exist. Returns the value as a list
438
l = self.get_user_option(option_name, expand=expand)
439
if isinstance(l, (str, unicode)):
440
# A single value, most probably the user forgot (or didn't care to
445
def get_user_option_as_int_from_SI(self, option_name, default=None):
446
"""Get a generic option from a human readable size in SI units, e.g 10MB
448
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
449
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
452
:return Integer, expanded to its base-10 value if a proper SI unit is
453
found. If the option doesn't exist, or isn't a value in
454
SI units, return default (which defaults to None)
456
val = self.get_user_option(option_name)
457
if isinstance(val, list):
462
p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
466
val = int(m.group(1))
467
if m.group(2) is not None:
468
if m.group(2).lower() == 'k':
470
elif m.group(2).lower() == 'm':
472
elif m.group(2).lower() == 'g':
475
ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
476
' value {1!r} is not an SI unit.').format(
483
@deprecated_method(deprecated_in((2, 5, 0)))
484
def gpg_signing_command(self):
485
"""What program should be used to sign signatures?"""
486
result = self._gpg_signing_command()
491
def _gpg_signing_command(self):
492
"""See gpg_signing_command()."""
495
def log_format(self):
496
"""What log format should be used"""
497
result = self._log_format()
502
def _log_format(self):
503
"""See log_format()."""
506
def validate_signatures_in_log(self):
507
"""Show GPG signature validity in log"""
508
result = self._validate_signatures_in_log()
515
def _validate_signatures_in_log(self):
516
"""See validate_signatures_in_log()."""
519
@deprecated_method(deprecated_in((2, 5, 0)))
520
def acceptable_keys(self):
521
"""Comma separated list of key patterns acceptable to
522
verify-signatures command"""
523
result = self._acceptable_keys()
526
def _acceptable_keys(self):
527
"""See acceptable_keys()."""
530
@deprecated_method(deprecated_in((2, 5, 0)))
531
def post_commit(self):
532
"""An ordered list of python functions to call.
534
Each function takes branch, rev_id as parameters.
536
return self._post_commit()
538
def _post_commit(self):
539
"""See Config.post_commit."""
542
def user_email(self):
543
"""Return just the email component of a username."""
544
return extract_email_address(self.username())
547
"""Return email-style username.
549
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
551
$BZR_EMAIL can be set to override this, then
552
the concrete policy type is checked, and finally
554
If no username can be found, errors.NoWhoami exception is raised.
556
v = os.environ.get('BZR_EMAIL')
558
return v.decode(osutils.get_user_encoding())
559
v = self._get_user_id()
562
return default_email()
564
def ensure_username(self):
565
"""Raise errors.NoWhoami if username is not set.
567
This method relies on the username() function raising the error.
571
@deprecated_method(deprecated_in((2, 5, 0)))
572
def signature_checking(self):
573
"""What is the current policy for signature checking?."""
574
policy = self._get_signature_checking()
575
if policy is not None:
577
return CHECK_IF_POSSIBLE
579
@deprecated_method(deprecated_in((2, 5, 0)))
580
def signing_policy(self):
581
"""What is the current policy for signature checking?."""
582
policy = self._get_signing_policy()
583
if policy is not None:
585
return SIGN_WHEN_REQUIRED
587
@deprecated_method(deprecated_in((2, 5, 0)))
588
def signature_needed(self):
589
"""Is a signature needed when committing ?."""
590
policy = self._get_signing_policy()
592
policy = self._get_signature_checking()
593
if policy is not None:
594
#this warning should go away once check_signatures is
595
#implemented (if not before)
596
trace.warning("Please use create_signatures,"
597
" not check_signatures to set signing policy.")
598
elif policy == SIGN_ALWAYS:
602
@deprecated_method(deprecated_in((2, 5, 0)))
603
def gpg_signing_key(self):
604
"""GPG user-id to sign commits"""
605
key = self.get_user_option('gpg_signing_key')
606
if key == "default" or key == None:
607
return self.user_email()
611
def get_alias(self, value):
612
return self._get_alias(value)
614
def _get_alias(self, value):
617
def get_nickname(self):
618
return self._get_nickname()
620
def _get_nickname(self):
623
def get_bzr_remote_path(self):
625
return os.environ['BZR_REMOTE_PATH']
627
path = self.get_user_option("bzr_remote_path")
632
def suppress_warning(self, warning):
633
"""Should the warning be suppressed or emitted.
635
:param warning: The name of the warning being tested.
637
:returns: True if the warning should be suppressed, False otherwise.
639
warnings = self.get_user_option_as_list('suppress_warnings')
640
if warnings is None or warning not in warnings:
645
def get_merge_tools(self):
647
for (oname, value, section, conf_id, parser) in self._get_options():
648
if oname.startswith('bzr.mergetool.'):
649
tool_name = oname[len('bzr.mergetool.'):]
650
tools[tool_name] = self.get_user_option(oname)
651
trace.mutter('loaded merge tools: %r' % tools)
654
def find_merge_tool(self, name):
655
# We fake a defaults mechanism here by checking if the given name can
656
# be found in the known_merge_tools if it's not found in the config.
657
# This should be done through the proposed config defaults mechanism
658
# when it becomes available in the future.
659
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
661
or mergetools.known_merge_tools.get(name, None))
665
class _ConfigHooks(hooks.Hooks):
666
"""A dict mapping hook names and a list of callables for configs.
670
"""Create the default hooks.
672
These are all empty initially, because by default nothing should get
675
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
676
self.add_hook('load',
677
'Invoked when a config store is loaded.'
678
' The signature is (store).',
680
self.add_hook('save',
681
'Invoked when a config store is saved.'
682
' The signature is (store).',
684
# The hooks for config options
686
'Invoked when a config option is read.'
687
' The signature is (stack, name, value).',
690
'Invoked when a config option is set.'
691
' The signature is (stack, name, value).',
693
self.add_hook('remove',
694
'Invoked when a config option is removed.'
695
' The signature is (stack, name).',
697
ConfigHooks = _ConfigHooks()
700
class _OldConfigHooks(hooks.Hooks):
701
"""A dict mapping hook names and a list of callables for configs.
705
"""Create the default hooks.
707
These are all empty initially, because by default nothing should get
710
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
711
self.add_hook('load',
712
'Invoked when a config store is loaded.'
713
' The signature is (config).',
715
self.add_hook('save',
716
'Invoked when a config store is saved.'
717
' The signature is (config).',
719
# The hooks for config options
721
'Invoked when a config option is read.'
722
' The signature is (config, name, value).',
725
'Invoked when a config option is set.'
726
' The signature is (config, name, value).',
728
self.add_hook('remove',
729
'Invoked when a config option is removed.'
730
' The signature is (config, name).',
732
OldConfigHooks = _OldConfigHooks()
735
class IniBasedConfig(Config):
736
"""A configuration policy that draws from ini files."""
738
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
740
"""Base class for configuration files using an ini-like syntax.
742
:param file_name: The configuration file path.
744
super(IniBasedConfig, self).__init__()
745
self.file_name = file_name
746
if symbol_versioning.deprecated_passed(get_filename):
747
symbol_versioning.warn(
748
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
749
' Use file_name instead.',
752
if get_filename is not None:
753
self.file_name = get_filename()
755
self.file_name = file_name
760
def from_string(cls, str_or_unicode, file_name=None, save=False):
761
"""Create a config object from a string.
763
:param str_or_unicode: A string representing the file content. This will
766
:param file_name: The configuration file path.
768
:param _save: Whether the file should be saved upon creation.
770
conf = cls(file_name=file_name)
771
conf._create_from_string(str_or_unicode, save)
774
def _create_from_string(self, str_or_unicode, save):
775
self._content = StringIO(str_or_unicode.encode('utf-8'))
776
# Some tests use in-memory configs, some other always need the config
777
# file to exist on disk.
779
self._write_config_file()
781
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
782
if self._parser is not None:
784
if symbol_versioning.deprecated_passed(file):
785
symbol_versioning.warn(
786
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
787
' Use IniBasedConfig(_content=xxx) instead.',
790
if self._content is not None:
791
co_input = self._content
792
elif self.file_name is None:
793
raise AssertionError('We have no content to create the config')
795
co_input = self.file_name
797
self._parser = ConfigObj(co_input, encoding='utf-8')
798
except configobj.ConfigObjError, e:
799
raise errors.ParseConfigError(e.errors, e.config.filename)
800
except UnicodeDecodeError:
801
raise errors.ConfigContentError(self.file_name)
802
# Make sure self.reload() will use the right file name
803
self._parser.filename = self.file_name
804
for hook in OldConfigHooks['load']:
809
"""Reload the config file from disk."""
810
if self.file_name is None:
811
raise AssertionError('We need a file name to reload the config')
812
if self._parser is not None:
813
self._parser.reload()
814
for hook in ConfigHooks['load']:
817
def _get_matching_sections(self):
818
"""Return an ordered list of (section_name, extra_path) pairs.
820
If the section contains inherited configuration, extra_path is
821
a string containing the additional path components.
823
section = self._get_section()
824
if section is not None:
825
return [(section, '')]
829
def _get_section(self):
830
"""Override this to define the section used by the config."""
833
def _get_sections(self, name=None):
834
"""Returns an iterator of the sections specified by ``name``.
836
:param name: The section name. If None is supplied, the default
837
configurations are yielded.
839
:return: A tuple (name, section, config_id) for all sections that will
840
be walked by user_get_option() in the 'right' order. The first one
841
is where set_user_option() will update the value.
843
parser = self._get_parser()
845
yield (name, parser[name], self.config_id())
847
# No section name has been given so we fallback to the configobj
848
# itself which holds the variables defined outside of any section.
849
yield (None, parser, self.config_id())
851
def _get_options(self, sections=None):
852
"""Return an ordered list of (name, value, section, config_id) tuples.
854
All options are returned with their associated value and the section
855
they appeared in. ``config_id`` is a unique identifier for the
856
configuration file the option is defined in.
858
:param sections: Default to ``_get_matching_sections`` if not
859
specified. This gives a better control to daughter classes about
860
which sections should be searched. This is a list of (name,
865
parser = self._get_parser()
867
for (section_name, _) in self._get_matching_sections():
869
section = parser[section_name]
871
# This could happen for an empty file for which we define a
872
# DEFAULT section. FIXME: Force callers to provide sections
873
# instead ? -- vila 20100930
875
sections.append((section_name, section))
876
config_id = self.config_id()
877
for (section_name, section) in sections:
878
for (name, value) in section.iteritems():
879
yield (name, parser._quote(value), section_name,
882
def _get_option_policy(self, section, option_name):
883
"""Return the policy for the given (section, option_name) pair."""
886
def _get_change_editor(self):
887
return self.get_user_option('change_editor')
889
def _get_signature_checking(self):
890
"""See Config._get_signature_checking."""
891
policy = self._get_user_option('check_signatures')
893
return signature_policy_from_unicode(policy)
895
def _get_signing_policy(self):
896
"""See Config._get_signing_policy"""
897
policy = self._get_user_option('create_signatures')
899
return signing_policy_from_unicode(policy)
901
def _get_user_id(self):
902
"""Get the user id from the 'email' key in the current section."""
903
return self._get_user_option('email')
905
def _get_user_option(self, option_name):
906
"""See Config._get_user_option."""
907
for (section, extra_path) in self._get_matching_sections():
909
value = self._get_parser().get_value(section, option_name)
912
policy = self._get_option_policy(section, option_name)
913
if policy == POLICY_NONE:
915
elif policy == POLICY_NORECURSE:
916
# norecurse items only apply to the exact path
921
elif policy == POLICY_APPENDPATH:
923
value = urlutils.join(value, extra_path)
926
raise AssertionError('Unexpected config policy %r' % policy)
930
def _gpg_signing_command(self):
931
"""See Config.gpg_signing_command."""
932
return self._get_user_option('gpg_signing_command')
934
def _log_format(self):
935
"""See Config.log_format."""
936
return self._get_user_option('log_format')
938
def _validate_signatures_in_log(self):
939
"""See Config.validate_signatures_in_log."""
940
return self._get_user_option('validate_signatures_in_log')
942
def _acceptable_keys(self):
943
"""See Config.acceptable_keys."""
944
return self._get_user_option('acceptable_keys')
946
def _post_commit(self):
947
"""See Config.post_commit."""
948
return self._get_user_option('post_commit')
950
def _get_alias(self, value):
952
return self._get_parser().get_value("ALIASES",
957
def _get_nickname(self):
958
return self.get_user_option('nickname')
960
def remove_user_option(self, option_name, section_name=None):
961
"""Remove a user option and save the configuration file.
963
:param option_name: The option to be removed.
965
:param section_name: The section the option is defined in, default to
969
parser = self._get_parser()
970
if section_name is None:
973
section = parser[section_name]
975
del section[option_name]
977
raise errors.NoSuchConfigOption(option_name)
978
self._write_config_file()
979
for hook in OldConfigHooks['remove']:
980
hook(self, option_name)
982
def _write_config_file(self):
983
if self.file_name is None:
984
raise AssertionError('We cannot save, self.file_name is None')
985
conf_dir = os.path.dirname(self.file_name)
986
ensure_config_dir_exists(conf_dir)
987
atomic_file = atomicfile.AtomicFile(self.file_name)
988
self._get_parser().write(atomic_file)
991
osutils.copy_ownership_from_path(self.file_name)
992
for hook in OldConfigHooks['save']:
996
class LockableConfig(IniBasedConfig):
997
"""A configuration needing explicit locking for access.
999
If several processes try to write the config file, the accesses need to be
1002
Daughter classes should decorate all methods that update a config with the
1003
``@needs_write_lock`` decorator (they call, directly or indirectly, the
1004
``_write_config_file()`` method. These methods (typically ``set_option()``
1005
and variants must reload the config file from disk before calling
1006
``_write_config_file()``), this can be achieved by calling the
1007
``self.reload()`` method. Note that the lock scope should cover both the
1008
reading and the writing of the config file which is why the decorator can't
1009
be applied to ``_write_config_file()`` only.
1011
This should be enough to implement the following logic:
1012
- lock for exclusive write access,
1013
- reload the config file from disk,
1017
This logic guarantees that a writer can update a value without erasing an
1018
update made by another writer.
1023
def __init__(self, file_name):
1024
super(LockableConfig, self).__init__(file_name=file_name)
1025
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
1026
# FIXME: It doesn't matter that we don't provide possible_transports
1027
# below since this is currently used only for local config files ;
1028
# local transports are not shared. But if/when we start using
1029
# LockableConfig for other kind of transports, we will need to reuse
1030
# whatever connection is already established -- vila 20100929
1031
self.transport = transport.get_transport_from_path(self.dir)
1032
self._lock = lockdir.LockDir(self.transport, self.lock_name)
1034
def _create_from_string(self, unicode_bytes, save):
1035
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
1037
# We need to handle the saving here (as opposed to IniBasedConfig)
1038
# to be able to lock
1040
self._write_config_file()
1043
def lock_write(self, token=None):
1044
"""Takes a write lock in the directory containing the config file.
1046
If the directory doesn't exist it is created.
1048
ensure_config_dir_exists(self.dir)
1049
return self._lock.lock_write(token)
1054
def break_lock(self):
1055
self._lock.break_lock()
1058
def remove_user_option(self, option_name, section_name=None):
1059
super(LockableConfig, self).remove_user_option(option_name,
1062
def _write_config_file(self):
1063
if self._lock is None or not self._lock.is_held:
1064
# NB: if the following exception is raised it probably means a
1065
# missing @needs_write_lock decorator on one of the callers.
1066
raise errors.ObjectNotLocked(self)
1067
super(LockableConfig, self)._write_config_file()
1070
class GlobalConfig(LockableConfig):
1071
"""The configuration that should be used for a specific location."""
1074
super(GlobalConfig, self).__init__(file_name=config_filename())
1076
def config_id(self):
1080
def from_string(cls, str_or_unicode, save=False):
1081
"""Create a config object from a string.
1083
:param str_or_unicode: A string representing the file content. This
1084
will be utf-8 encoded.
1086
:param save: Whether the file should be saved upon creation.
1089
conf._create_from_string(str_or_unicode, save)
1092
@deprecated_method(deprecated_in((2, 4, 0)))
1093
def get_editor(self):
1094
return self._get_user_option('editor')
1097
def set_user_option(self, option, value):
1098
"""Save option and its value in the configuration."""
1099
self._set_option(option, value, 'DEFAULT')
1101
def get_aliases(self):
1102
"""Return the aliases section."""
1103
if 'ALIASES' in self._get_parser():
1104
return self._get_parser()['ALIASES']
1109
def set_alias(self, alias_name, alias_command):
1110
"""Save the alias in the configuration."""
1111
self._set_option(alias_name, alias_command, 'ALIASES')
1114
def unset_alias(self, alias_name):
1115
"""Unset an existing alias."""
1117
aliases = self._get_parser().get('ALIASES')
1118
if not aliases or alias_name not in aliases:
1119
raise errors.NoSuchAlias(alias_name)
1120
del aliases[alias_name]
1121
self._write_config_file()
1123
def _set_option(self, option, value, section):
1125
self._get_parser().setdefault(section, {})[option] = value
1126
self._write_config_file()
1127
for hook in OldConfigHooks['set']:
1128
hook(self, option, value)
1130
def _get_sections(self, name=None):
1131
"""See IniBasedConfig._get_sections()."""
1132
parser = self._get_parser()
1133
# We don't give access to options defined outside of any section, we
1134
# used the DEFAULT section by... default.
1135
if name in (None, 'DEFAULT'):
1136
# This could happen for an empty file where the DEFAULT section
1137
# doesn't exist yet. So we force DEFAULT when yielding
1139
if 'DEFAULT' not in parser:
1140
parser['DEFAULT']= {}
1141
yield (name, parser[name], self.config_id())
1144
def remove_user_option(self, option_name, section_name=None):
1145
if section_name is None:
1146
# We need to force the default section.
1147
section_name = 'DEFAULT'
1148
# We need to avoid the LockableConfig implementation or we'll lock
1150
super(LockableConfig, self).remove_user_option(option_name,
1153
def _iter_for_location_by_parts(sections, location):
1154
"""Keep only the sessions matching the specified location.
1156
:param sections: An iterable of section names.
1158
:param location: An url or a local path to match against.
1160
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1161
number of path components in the section name, section is the section
1162
name and extra_path is the difference between location and the section
1165
``location`` will always be a local path and never a 'file://' url but the
1166
section names themselves can be in either form.
1168
location_parts = location.rstrip('/').split('/')
1170
for section in sections:
1171
# location is a local path if possible, so we need to convert 'file://'
1172
# urls in section names to local paths if necessary.
1174
# This also avoids having file:///path be a more exact
1175
# match than '/path'.
1177
# FIXME: This still raises an issue if a user defines both file:///path
1178
# *and* /path. Should we raise an error in this case -- vila 20110505
1180
if section.startswith('file://'):
1181
section_path = urlutils.local_path_from_url(section)
1183
section_path = section
1184
section_parts = section_path.rstrip('/').split('/')
1187
if len(section_parts) > len(location_parts):
1188
# More path components in the section, they can't match
1191
# Rely on zip truncating in length to the length of the shortest
1192
# argument sequence.
1193
names = zip(location_parts, section_parts)
1195
if not fnmatch.fnmatch(name[0], name[1]):
1200
# build the path difference between the section and the location
1201
extra_path = '/'.join(location_parts[len(section_parts):])
1202
yield section, extra_path, len(section_parts)
1205
class LocationConfig(LockableConfig):
1206
"""A configuration object that gives the policy for a location."""
1208
def __init__(self, location):
1209
super(LocationConfig, self).__init__(
1210
file_name=locations_config_filename())
1211
# local file locations are looked up by local path, rather than
1212
# by file url. This is because the config file is a user
1213
# file, and we would rather not expose the user to file urls.
1214
if location.startswith('file://'):
1215
location = urlutils.local_path_from_url(location)
1216
self.location = location
1218
def config_id(self):
1222
def from_string(cls, str_or_unicode, location, save=False):
1223
"""Create a config object from a string.
1225
:param str_or_unicode: A string representing the file content. This will
1228
:param location: The location url to filter the configuration.
1230
:param save: Whether the file should be saved upon creation.
1232
conf = cls(location)
1233
conf._create_from_string(str_or_unicode, save)
1236
def _get_matching_sections(self):
1237
"""Return an ordered list of section names matching this location."""
1238
matches = list(_iter_for_location_by_parts(self._get_parser(),
1240
# put the longest (aka more specific) locations first
1242
key=lambda (section, extra_path, length): (length, section),
1244
for (section, extra_path, length) in matches:
1245
yield section, extra_path
1246
# should we stop looking for parent configs here?
1248
if self._get_parser()[section].as_bool('ignore_parents'):
1253
def _get_sections(self, name=None):
1254
"""See IniBasedConfig._get_sections()."""
1255
# We ignore the name here as the only sections handled are named with
1256
# the location path and we don't expose embedded sections either.
1257
parser = self._get_parser()
1258
for name, extra_path in self._get_matching_sections():
1259
yield (name, parser[name], self.config_id())
1261
def _get_option_policy(self, section, option_name):
1262
"""Return the policy for the given (section, option_name) pair."""
1263
# check for the old 'recurse=False' flag
1265
recurse = self._get_parser()[section].as_bool('recurse')
1269
return POLICY_NORECURSE
1271
policy_key = option_name + ':policy'
1273
policy_name = self._get_parser()[section][policy_key]
1277
return _policy_value[policy_name]
1279
def _set_option_policy(self, section, option_name, option_policy):
1280
"""Set the policy for the given option name in the given section."""
1281
# The old recurse=False option affects all options in the
1282
# section. To handle multiple policies in the section, we
1283
# need to convert it to a policy_norecurse key.
1285
recurse = self._get_parser()[section].as_bool('recurse')
1289
symbol_versioning.warn(
1290
'The recurse option is deprecated as of 0.14. '
1291
'The section "%s" has been converted to use policies.'
1294
del self._get_parser()[section]['recurse']
1296
for key in self._get_parser()[section].keys():
1297
if not key.endswith(':policy'):
1298
self._get_parser()[section][key +
1299
':policy'] = 'norecurse'
1301
policy_key = option_name + ':policy'
1302
policy_name = _policy_name[option_policy]
1303
if policy_name is not None:
1304
self._get_parser()[section][policy_key] = policy_name
1306
if policy_key in self._get_parser()[section]:
1307
del self._get_parser()[section][policy_key]
1310
def set_user_option(self, option, value, store=STORE_LOCATION):
1311
"""Save option and its value in the configuration."""
1312
if store not in [STORE_LOCATION,
1313
STORE_LOCATION_NORECURSE,
1314
STORE_LOCATION_APPENDPATH]:
1315
raise ValueError('bad storage policy %r for %r' %
1318
location = self.location
1319
if location.endswith('/'):
1320
location = location[:-1]
1321
parser = self._get_parser()
1322
if not location in parser and not location + '/' in parser:
1323
parser[location] = {}
1324
elif location + '/' in parser:
1325
location = location + '/'
1326
parser[location][option]=value
1327
# the allowed values of store match the config policies
1328
self._set_option_policy(location, option, store)
1329
self._write_config_file()
1330
for hook in OldConfigHooks['set']:
1331
hook(self, option, value)
1334
class BranchConfig(Config):
1335
"""A configuration object giving the policy for a branch."""
1337
def __init__(self, branch):
1338
super(BranchConfig, self).__init__()
1339
self._location_config = None
1340
self._branch_data_config = None
1341
self._global_config = None
1342
self.branch = branch
1343
self.option_sources = (self._get_location_config,
1344
self._get_branch_data_config,
1345
self._get_global_config)
1347
def config_id(self):
1350
def _get_branch_data_config(self):
1351
if self._branch_data_config is None:
1352
self._branch_data_config = TreeConfig(self.branch)
1353
self._branch_data_config.config_id = self.config_id
1354
return self._branch_data_config
1356
def _get_location_config(self):
1357
if self._location_config is None:
1358
self._location_config = LocationConfig(self.branch.base)
1359
return self._location_config
1361
def _get_global_config(self):
1362
if self._global_config is None:
1363
self._global_config = GlobalConfig()
1364
return self._global_config
1366
def _get_best_value(self, option_name):
1367
"""This returns a user option from local, tree or global config.
1369
They are tried in that order. Use get_safe_value if trusted values
1372
for source in self.option_sources:
1373
value = getattr(source(), option_name)()
1374
if value is not None:
1378
def _get_safe_value(self, option_name):
1379
"""This variant of get_best_value never returns untrusted values.
1381
It does not return values from the branch data, because the branch may
1382
not be controlled by the user.
1384
We may wish to allow locations.conf to control whether branches are
1385
trusted in the future.
1387
for source in (self._get_location_config, self._get_global_config):
1388
value = getattr(source(), option_name)()
1389
if value is not None:
1393
def _get_user_id(self):
1394
"""Return the full user id for the branch.
1396
e.g. "John Hacker <jhacker@example.com>"
1397
This is looked up in the email controlfile for the branch.
1399
return self._get_best_value('_get_user_id')
1401
def _get_change_editor(self):
1402
return self._get_best_value('_get_change_editor')
1404
def _get_signature_checking(self):
1405
"""See Config._get_signature_checking."""
1406
return self._get_best_value('_get_signature_checking')
1408
def _get_signing_policy(self):
1409
"""See Config._get_signing_policy."""
1410
return self._get_best_value('_get_signing_policy')
1412
def _get_user_option(self, option_name):
1413
"""See Config._get_user_option."""
1414
for source in self.option_sources:
1415
value = source()._get_user_option(option_name)
1416
if value is not None:
1420
def _get_sections(self, name=None):
1421
"""See IniBasedConfig.get_sections()."""
1422
for source in self.option_sources:
1423
for section in source()._get_sections(name):
1426
def _get_options(self, sections=None):
1428
# First the locations options
1429
for option in self._get_location_config()._get_options():
1431
# Then the branch options
1432
branch_config = self._get_branch_data_config()
1433
if sections is None:
1434
sections = [('DEFAULT', branch_config._get_parser())]
1435
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1436
# Config itself has no notion of sections :( -- vila 20101001
1437
config_id = self.config_id()
1438
for (section_name, section) in sections:
1439
for (name, value) in section.iteritems():
1440
yield (name, value, section_name,
1441
config_id, branch_config._get_parser())
1442
# Then the global options
1443
for option in self._get_global_config()._get_options():
1446
def set_user_option(self, name, value, store=STORE_BRANCH,
1448
if store == STORE_BRANCH:
1449
self._get_branch_data_config().set_option(value, name)
1450
elif store == STORE_GLOBAL:
1451
self._get_global_config().set_user_option(name, value)
1453
self._get_location_config().set_user_option(name, value, store)
1456
if store in (STORE_GLOBAL, STORE_BRANCH):
1457
mask_value = self._get_location_config().get_user_option(name)
1458
if mask_value is not None:
1459
trace.warning('Value "%s" is masked by "%s" from'
1460
' locations.conf', value, mask_value)
1462
if store == STORE_GLOBAL:
1463
branch_config = self._get_branch_data_config()
1464
mask_value = branch_config.get_user_option(name)
1465
if mask_value is not None:
1466
trace.warning('Value "%s" is masked by "%s" from'
1467
' branch.conf', value, mask_value)
1469
def remove_user_option(self, option_name, section_name=None):
1470
self._get_branch_data_config().remove_option(option_name, section_name)
1472
def _gpg_signing_command(self):
1473
"""See Config.gpg_signing_command."""
1474
return self._get_safe_value('_gpg_signing_command')
1476
def _post_commit(self):
1477
"""See Config.post_commit."""
1478
return self._get_safe_value('_post_commit')
1480
def _get_nickname(self):
1481
value = self._get_explicit_nickname()
1482
if value is not None:
1484
return urlutils.unescape(self.branch.base.split('/')[-2])
1486
def has_explicit_nickname(self):
1487
"""Return true if a nickname has been explicitly assigned."""
1488
return self._get_explicit_nickname() is not None
1490
def _get_explicit_nickname(self):
1491
return self._get_best_value('_get_nickname')
1493
def _log_format(self):
1494
"""See Config.log_format."""
1495
return self._get_best_value('_log_format')
1497
def _validate_signatures_in_log(self):
1498
"""See Config.validate_signatures_in_log."""
1499
return self._get_best_value('_validate_signatures_in_log')
1501
def _acceptable_keys(self):
1502
"""See Config.acceptable_keys."""
1503
return self._get_best_value('_acceptable_keys')
1506
def ensure_config_dir_exists(path=None):
1507
"""Make sure a configuration directory exists.
1508
This makes sure that the directory exists.
1509
On windows, since configuration directories are 2 levels deep,
1510
it makes sure both the directory and the parent directory exists.
1514
if not os.path.isdir(path):
1515
if sys.platform == 'win32':
1516
parent_dir = os.path.dirname(path)
1517
if not os.path.isdir(parent_dir):
1518
trace.mutter('creating config parent directory: %r', parent_dir)
1519
os.mkdir(parent_dir)
1520
trace.mutter('creating config directory: %r', path)
1522
osutils.copy_ownership_from_path(path)
1526
"""Return per-user configuration directory.
1528
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1529
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1530
that will be used instead.
1532
TODO: Global option --config-dir to override this.
1534
base = os.environ.get('BZR_HOME', None)
1535
if sys.platform == 'win32':
1536
# environ variables on Windows are in user encoding/mbcs. So decode
1538
if base is not None:
1539
base = base.decode('mbcs')
1541
base = win32utils.get_appdata_location_unicode()
1543
base = os.environ.get('HOME', None)
1544
if base is not None:
1545
base = base.decode('mbcs')
1547
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1549
return osutils.pathjoin(base, 'bazaar', '2.0')
1551
if base is not None:
1552
base = base.decode(osutils._fs_enc)
1553
if sys.platform == 'darwin':
1555
# this takes into account $HOME
1556
base = os.path.expanduser("~")
1557
return osutils.pathjoin(base, '.bazaar')
1560
xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
1562
xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
1563
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1564
if osutils.isdir(xdg_dir):
1566
"Using configuration in XDG directory %s." % xdg_dir)
1568
base = os.path.expanduser("~")
1569
return osutils.pathjoin(base, ".bazaar")
1572
def config_filename():
1573
"""Return per-user configuration ini file filename."""
1574
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1577
def locations_config_filename():
1578
"""Return per-user configuration ini file filename."""
1579
return osutils.pathjoin(config_dir(), 'locations.conf')
1582
def authentication_config_filename():
1583
"""Return per-user authentication ini file filename."""
1584
return osutils.pathjoin(config_dir(), 'authentication.conf')
1587
def user_ignore_config_filename():
1588
"""Return the user default ignore filename"""
1589
return osutils.pathjoin(config_dir(), 'ignore')
1593
"""Return the directory name to store crash files.
1595
This doesn't implicitly create it.
1597
On Windows it's in the config directory; elsewhere it's /var/crash
1598
which may be monitored by apport. It can be overridden by
1601
if sys.platform == 'win32':
1602
return osutils.pathjoin(config_dir(), 'Crash')
1604
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1606
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1609
def xdg_cache_dir():
1610
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1611
# Possibly this should be different on Windows?
1612
e = os.environ.get('XDG_CACHE_DIR', None)
1616
return os.path.expanduser('~/.cache')
1619
def _get_default_mail_domain():
1620
"""If possible, return the assumed default email domain.
1622
:returns: string mail domain, or None.
1624
if sys.platform == 'win32':
1625
# No implementation yet; patches welcome
1628
f = open('/etc/mailname')
1629
except (IOError, OSError), e:
1632
domain = f.read().strip()
1638
def default_email():
1639
v = os.environ.get('BZR_EMAIL')
1641
return v.decode(osutils.get_user_encoding())
1642
v = os.environ.get('EMAIL')
1644
return v.decode(osutils.get_user_encoding())
1645
name, email = _auto_user_id()
1647
return u'%s <%s>' % (name, email)
1650
raise errors.NoWhoami()
1653
def email_from_store(unicode_str):
1654
"""Unlike other env vars, BZR_EMAIL takes precedence over config settings.
1656
Whatever comes from a config file is then overridden.
1658
value = os.environ.get('BZR_EMAIL')
1660
return value.decode(osutils.get_user_encoding())
1664
def _auto_user_id():
1665
"""Calculate automatic user identification.
1667
:returns: (realname, email), either of which may be None if they can't be
1670
Only used when none is set in the environment or the id file.
1672
This only returns an email address if we can be fairly sure the
1673
address is reasonable, ie if /etc/mailname is set on unix.
1675
This doesn't use the FQDN as the default domain because that may be
1676
slow, and it doesn't use the hostname alone because that's not normally
1677
a reasonable address.
1679
if sys.platform == 'win32':
1680
# No implementation to reliably determine Windows default mail
1681
# address; please add one.
1684
default_mail_domain = _get_default_mail_domain()
1685
if not default_mail_domain:
1691
w = pwd.getpwuid(uid)
1693
trace.mutter('no passwd entry for uid %d?' % uid)
1696
# we try utf-8 first, because on many variants (like Linux),
1697
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1698
# false positives. (many users will have their user encoding set to
1699
# latin-1, which cannot raise UnicodeError.)
1701
gecos = w.pw_gecos.decode('utf-8')
1703
except UnicodeError:
1705
encoding = osutils.get_user_encoding()
1706
gecos = w.pw_gecos.decode(encoding)
1707
except UnicodeError, e:
1708
trace.mutter("cannot decode passwd entry %s" % w)
1711
username = w.pw_name.decode(encoding)
1712
except UnicodeError, e:
1713
trace.mutter("cannot decode passwd entry %s" % w)
1716
comma = gecos.find(',')
1720
realname = gecos[:comma]
1722
return realname, (username + '@' + default_mail_domain)
1725
def parse_username(username):
1726
"""Parse e-mail username and return a (name, address) tuple."""
1727
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1729
return (username, '')
1731
return (match.group(1), match.group(2))
1734
def extract_email_address(e):
1735
"""Return just the address part of an email string.
1737
That is just the user@domain part, nothing else.
1738
This part is required to contain only ascii characters.
1739
If it can't be extracted, raises an error.
1741
>>> extract_email_address('Jane Tester <jane@test.com>')
1744
name, email = parse_username(e)
1746
raise errors.NoEmailInUsername(e)
1750
class TreeConfig(IniBasedConfig):
1751
"""Branch configuration data associated with its contents, not location"""
1753
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1755
def __init__(self, branch):
1756
self._config = branch._get_config()
1757
self.branch = branch
1759
def _get_parser(self, file=None):
1760
if file is not None:
1761
return IniBasedConfig._get_parser(file)
1762
return self._config._get_configobj()
1764
def get_option(self, name, section=None, default=None):
1765
self.branch.lock_read()
1767
return self._config.get_option(name, section, default)
1769
self.branch.unlock()
1771
def set_option(self, value, name, section=None):
1772
"""Set a per-branch configuration option"""
1773
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1774
# higher levels providing the right lock -- vila 20101004
1775
self.branch.lock_write()
1777
self._config.set_option(value, name, section)
1779
self.branch.unlock()
1781
def remove_option(self, option_name, section_name=None):
1782
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1783
# higher levels providing the right lock -- vila 20101004
1784
self.branch.lock_write()
1786
self._config.remove_option(option_name, section_name)
1788
self.branch.unlock()
1791
class AuthenticationConfig(object):
1792
"""The authentication configuration file based on a ini file.
1794
Implements the authentication.conf file described in
1795
doc/developers/authentication-ring.txt.
1798
def __init__(self, _file=None):
1799
self._config = None # The ConfigObj
1801
self._filename = authentication_config_filename()
1802
self._input = self._filename = authentication_config_filename()
1804
# Tests can provide a string as _file
1805
self._filename = None
1808
def _get_config(self):
1809
if self._config is not None:
1812
# FIXME: Should we validate something here ? Includes: empty
1813
# sections are useless, at least one of
1814
# user/password/password_encoding should be defined, etc.
1816
# Note: the encoding below declares that the file itself is utf-8
1817
# encoded, but the values in the ConfigObj are always Unicode.
1818
self._config = ConfigObj(self._input, encoding='utf-8')
1819
except configobj.ConfigObjError, e:
1820
raise errors.ParseConfigError(e.errors, e.config.filename)
1821
except UnicodeError:
1822
raise errors.ConfigContentError(self._filename)
1826
"""Save the config file, only tests should use it for now."""
1827
conf_dir = os.path.dirname(self._filename)
1828
ensure_config_dir_exists(conf_dir)
1829
f = file(self._filename, 'wb')
1831
self._get_config().write(f)
1835
def _set_option(self, section_name, option_name, value):
1836
"""Set an authentication configuration option"""
1837
conf = self._get_config()
1838
section = conf.get(section_name)
1841
section = conf[section]
1842
section[option_name] = value
1845
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1847
"""Returns the matching credentials from authentication.conf file.
1849
:param scheme: protocol
1851
:param host: the server address
1853
:param port: the associated port (optional)
1855
:param user: login (optional)
1857
:param path: the absolute path on the server (optional)
1859
:param realm: the http authentication realm (optional)
1861
:return: A dict containing the matching credentials or None.
1863
- name: the section name of the credentials in the
1864
authentication.conf file,
1865
- user: can't be different from the provided user if any,
1866
- scheme: the server protocol,
1867
- host: the server address,
1868
- port: the server port (can be None),
1869
- path: the absolute server path (can be None),
1870
- realm: the http specific authentication realm (can be None),
1871
- password: the decoded password, could be None if the credential
1872
defines only the user
1873
- verify_certificates: https specific, True if the server
1874
certificate should be verified, False otherwise.
1877
for auth_def_name, auth_def in self._get_config().items():
1878
if type(auth_def) is not configobj.Section:
1879
raise ValueError("%s defined outside a section" % auth_def_name)
1881
a_scheme, a_host, a_user, a_path = map(
1882
auth_def.get, ['scheme', 'host', 'user', 'path'])
1885
a_port = auth_def.as_int('port')
1889
raise ValueError("'port' not numeric in %s" % auth_def_name)
1891
a_verify_certificates = auth_def.as_bool('verify_certificates')
1893
a_verify_certificates = True
1896
"'verify_certificates' not boolean in %s" % auth_def_name)
1899
if a_scheme is not None and scheme != a_scheme:
1901
if a_host is not None:
1902
if not (host == a_host
1903
or (a_host.startswith('.') and host.endswith(a_host))):
1905
if a_port is not None and port != a_port:
1907
if (a_path is not None and path is not None
1908
and not path.startswith(a_path)):
1910
if (a_user is not None and user is not None
1911
and a_user != user):
1912
# Never contradict the caller about the user to be used
1917
# Prepare a credentials dictionary with additional keys
1918
# for the credential providers
1919
credentials = dict(name=auth_def_name,
1926
password=auth_def.get('password', None),
1927
verify_certificates=a_verify_certificates)
1928
# Decode the password in the credentials (or get one)
1929
self.decode_password(credentials,
1930
auth_def.get('password_encoding', None))
1931
if 'auth' in debug.debug_flags:
1932
trace.mutter("Using authentication section: %r", auth_def_name)
1935
if credentials is None:
1936
# No credentials were found in authentication.conf, try the fallback
1937
# credentials stores.
1938
credentials = credential_store_registry.get_fallback_credentials(
1939
scheme, host, port, user, path, realm)
1943
def set_credentials(self, name, host, user, scheme=None, password=None,
1944
port=None, path=None, verify_certificates=None,
1946
"""Set authentication credentials for a host.
1948
Any existing credentials with matching scheme, host, port and path
1949
will be deleted, regardless of name.
1951
:param name: An arbitrary name to describe this set of credentials.
1952
:param host: Name of the host that accepts these credentials.
1953
:param user: The username portion of these credentials.
1954
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1956
:param password: Password portion of these credentials.
1957
:param port: The IP port on the host that these credentials apply to.
1958
:param path: A filesystem path on the host that these credentials
1960
:param verify_certificates: On https, verify server certificates if
1962
:param realm: The http authentication realm (optional).
1964
values = {'host': host, 'user': user}
1965
if password is not None:
1966
values['password'] = password
1967
if scheme is not None:
1968
values['scheme'] = scheme
1969
if port is not None:
1970
values['port'] = '%d' % port
1971
if path is not None:
1972
values['path'] = path
1973
if verify_certificates is not None:
1974
values['verify_certificates'] = str(verify_certificates)
1975
if realm is not None:
1976
values['realm'] = realm
1977
config = self._get_config()
1979
for section, existing_values in config.items():
1980
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1981
if existing_values.get(key) != values.get(key):
1985
config.update({name: values})
1988
def get_user(self, scheme, host, port=None, realm=None, path=None,
1989
prompt=None, ask=False, default=None):
1990
"""Get a user from authentication file.
1992
:param scheme: protocol
1994
:param host: the server address
1996
:param port: the associated port (optional)
1998
:param realm: the realm sent by the server (optional)
2000
:param path: the absolute path on the server (optional)
2002
:param ask: Ask the user if there is no explicitly configured username
2005
:param default: The username returned if none is defined (optional).
2007
:return: The found user.
2009
credentials = self.get_credentials(scheme, host, port, user=None,
2010
path=path, realm=realm)
2011
if credentials is not None:
2012
user = credentials['user']
2018
# Create a default prompt suitable for most cases
2019
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
2020
# Special handling for optional fields in the prompt
2021
if port is not None:
2022
prompt_host = '%s:%d' % (host, port)
2025
user = ui.ui_factory.get_username(prompt, host=prompt_host)
2030
def get_password(self, scheme, host, user, port=None,
2031
realm=None, path=None, prompt=None):
2032
"""Get a password from authentication file or prompt the user for one.
2034
:param scheme: protocol
2036
:param host: the server address
2038
:param port: the associated port (optional)
2042
:param realm: the realm sent by the server (optional)
2044
:param path: the absolute path on the server (optional)
2046
:return: The found password or the one entered by the user.
2048
credentials = self.get_credentials(scheme, host, port, user, path,
2050
if credentials is not None:
2051
password = credentials['password']
2052
if password is not None and scheme is 'ssh':
2053
trace.warning('password ignored in section [%s],'
2054
' use an ssh agent instead'
2055
% credentials['name'])
2059
# Prompt user only if we could't find a password
2060
if password is None:
2062
# Create a default prompt suitable for most cases
2063
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
2064
# Special handling for optional fields in the prompt
2065
if port is not None:
2066
prompt_host = '%s:%d' % (host, port)
2069
password = ui.ui_factory.get_password(prompt,
2070
host=prompt_host, user=user)
2073
def decode_password(self, credentials, encoding):
2075
cs = credential_store_registry.get_credential_store(encoding)
2077
raise ValueError('%r is not a known password_encoding' % encoding)
2078
credentials['password'] = cs.decode_password(credentials)
2082
class CredentialStoreRegistry(registry.Registry):
2083
"""A class that registers credential stores.
2085
A credential store provides access to credentials via the password_encoding
2086
field in authentication.conf sections.
2088
Except for stores provided by bzr itself, most stores are expected to be
2089
provided by plugins that will therefore use
2090
register_lazy(password_encoding, module_name, member_name, help=help,
2091
fallback=fallback) to install themselves.
2093
A fallback credential store is one that is queried if no credentials can be
2094
found via authentication.conf.
2097
def get_credential_store(self, encoding=None):
2098
cs = self.get(encoding)
2103
def is_fallback(self, name):
2104
"""Check if the named credentials store should be used as fallback."""
2105
return self.get_info(name)
2107
def get_fallback_credentials(self, scheme, host, port=None, user=None,
2108
path=None, realm=None):
2109
"""Request credentials from all fallback credentials stores.
2111
The first credentials store that can provide credentials wins.
2114
for name in self.keys():
2115
if not self.is_fallback(name):
2117
cs = self.get_credential_store(name)
2118
credentials = cs.get_credentials(scheme, host, port, user,
2120
if credentials is not None:
2121
# We found some credentials
2125
def register(self, key, obj, help=None, override_existing=False,
2127
"""Register a new object to a name.
2129
:param key: This is the key to use to request the object later.
2130
:param obj: The object to register.
2131
:param help: Help text for this entry. This may be a string or
2132
a callable. If it is a callable, it should take two
2133
parameters (registry, key): this registry and the key that
2134
the help was registered under.
2135
:param override_existing: Raise KeyErorr if False and something has
2136
already been registered for that key. If True, ignore if there
2137
is an existing key (always register the new value).
2138
:param fallback: Whether this credential store should be
2141
return super(CredentialStoreRegistry,
2142
self).register(key, obj, help, info=fallback,
2143
override_existing=override_existing)
2145
def register_lazy(self, key, module_name, member_name,
2146
help=None, override_existing=False,
2148
"""Register a new credential store to be loaded on request.
2150
:param module_name: The python path to the module. Such as 'os.path'.
2151
:param member_name: The member of the module to return. If empty or
2152
None, get() will return the module itself.
2153
:param help: Help text for this entry. This may be a string or
2155
:param override_existing: If True, replace the existing object
2156
with the new one. If False, if there is already something
2157
registered with the same key, raise a KeyError
2158
:param fallback: Whether this credential store should be
2161
return super(CredentialStoreRegistry, self).register_lazy(
2162
key, module_name, member_name, help,
2163
info=fallback, override_existing=override_existing)
2166
credential_store_registry = CredentialStoreRegistry()
2169
class CredentialStore(object):
2170
"""An abstract class to implement storage for credentials"""
2172
def decode_password(self, credentials):
2173
"""Returns a clear text password for the provided credentials."""
2174
raise NotImplementedError(self.decode_password)
2176
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2178
"""Return the matching credentials from this credential store.
2180
This method is only called on fallback credential stores.
2182
raise NotImplementedError(self.get_credentials)
2186
class PlainTextCredentialStore(CredentialStore):
2187
__doc__ = """Plain text credential store for the authentication.conf file"""
2189
def decode_password(self, credentials):
2190
"""See CredentialStore.decode_password."""
2191
return credentials['password']
2194
credential_store_registry.register('plain', PlainTextCredentialStore,
2195
help=PlainTextCredentialStore.__doc__)
2196
credential_store_registry.default_key = 'plain'
2199
class BzrDirConfig(object):
2201
def __init__(self, bzrdir):
2202
self._bzrdir = bzrdir
2203
self._config = bzrdir._get_config()
2205
def set_default_stack_on(self, value):
2206
"""Set the default stacking location.
2208
It may be set to a location, or None.
2210
This policy affects all branches contained by this bzrdir, except for
2211
those under repositories.
2213
if self._config is None:
2214
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2216
self._config.set_option('', 'default_stack_on')
2218
self._config.set_option(value, 'default_stack_on')
2220
def get_default_stack_on(self):
2221
"""Return the default stacking location.
2223
This will either be a location, or None.
2225
This policy affects all branches contained by this bzrdir, except for
2226
those under repositories.
2228
if self._config is None:
2230
value = self._config.get_option('default_stack_on')
2236
class TransportConfig(object):
2237
"""A Config that reads/writes a config file on a Transport.
2239
It is a low-level object that considers config data to be name/value pairs
2240
that may be associated with a section. Assigning meaning to these values
2241
is done at higher levels like TreeConfig.
2244
def __init__(self, transport, filename):
2245
self._transport = transport
2246
self._filename = filename
2248
def get_option(self, name, section=None, default=None):
2249
"""Return the value associated with a named option.
2251
:param name: The name of the value
2252
:param section: The section the option is in (if any)
2253
:param default: The value to return if the value is not set
2254
:return: The value or default value
2256
configobj = self._get_configobj()
2258
section_obj = configobj
2261
section_obj = configobj[section]
2264
value = section_obj.get(name, default)
2265
for hook in OldConfigHooks['get']:
2266
hook(self, name, value)
2269
def set_option(self, value, name, section=None):
2270
"""Set the value associated with a named option.
2272
:param value: The value to set
2273
:param name: The name of the value to set
2274
:param section: The section the option is in (if any)
2276
configobj = self._get_configobj()
2278
configobj[name] = value
2280
configobj.setdefault(section, {})[name] = value
2281
for hook in OldConfigHooks['set']:
2282
hook(self, name, value)
2283
self._set_configobj(configobj)
2285
def remove_option(self, option_name, section_name=None):
2286
configobj = self._get_configobj()
2287
if section_name is None:
2288
del configobj[option_name]
2290
del configobj[section_name][option_name]
2291
for hook in OldConfigHooks['remove']:
2292
hook(self, option_name)
2293
self._set_configobj(configobj)
2295
def _get_config_file(self):
2297
f = StringIO(self._transport.get_bytes(self._filename))
2298
for hook in OldConfigHooks['load']:
2301
except errors.NoSuchFile:
2303
except errors.PermissionDenied, e:
2304
trace.warning("Permission denied while trying to open "
2305
"configuration file %s.", urlutils.unescape_for_display(
2306
urlutils.join(self._transport.base, self._filename), "utf-8"))
2309
def _external_url(self):
2310
return urlutils.join(self._transport.external_url(), self._filename)
2312
def _get_configobj(self):
2313
f = self._get_config_file()
2316
conf = ConfigObj(f, encoding='utf-8')
2317
except configobj.ConfigObjError, e:
2318
raise errors.ParseConfigError(e.errors, self._external_url())
2319
except UnicodeDecodeError:
2320
raise errors.ConfigContentError(self._external_url())
2325
def _set_configobj(self, configobj):
2326
out_file = StringIO()
2327
configobj.write(out_file)
2329
self._transport.put_file(self._filename, out_file)
2330
for hook in OldConfigHooks['save']:
2334
class Option(object):
2335
"""An option definition.
2337
The option *values* are stored in config files and found in sections.
2339
Here we define various properties about the option itself, its default
2340
value, how to convert it from stores, what to do when invalid values are
2341
encoutered, in which config files it can be stored.
2344
def __init__(self, name, default=None, default_from_env=None,
2345
help=None, from_unicode=None, invalid=None):
2346
"""Build an option definition.
2348
:param name: the name used to refer to the option.
2350
:param default: the default value to use when none exist in the config
2351
stores. This is either a string that ``from_unicode`` will convert
2352
into the proper type, a callable returning a unicode string so that
2353
``from_unicode`` can be used on the return value, or a python
2354
object that can be stringified (so only the empty list is supported
2357
:param default_from_env: A list of environment variables which can
2358
provide a default value. 'default' will be used only if none of the
2359
variables specified here are set in the environment.
2361
:param help: a doc string to explain the option to the user.
2363
:param from_unicode: a callable to convert the unicode string
2364
representing the option value in a store. This is not called for
2367
:param invalid: the action to be taken when an invalid value is
2368
encountered in a store. This is called only when from_unicode is
2369
invoked to convert a string and returns None or raise ValueError or
2370
TypeError. Accepted values are: None (ignore invalid values),
2371
'warning' (emit a warning), 'error' (emit an error message and
2374
if default_from_env is None:
2375
default_from_env = []
2377
# Convert the default value to a unicode string so all values are
2378
# strings internally before conversion (via from_unicode) is attempted.
2381
elif isinstance(default, list):
2382
# Only the empty list is supported
2384
raise AssertionError(
2385
'Only empty lists are supported as default values')
2387
elif isinstance(default, (str, unicode, bool, int, float)):
2388
# Rely on python to convert strings, booleans and integers
2389
self.default = u'%s' % (default,)
2390
elif callable(default):
2391
self.default = default
2393
# other python objects are not expected
2394
raise AssertionError('%r is not supported as a default value'
2396
self.default_from_env = default_from_env
2398
self.from_unicode = from_unicode
2399
if invalid and invalid not in ('warning', 'error'):
2400
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2401
self.invalid = invalid
2403
def convert_from_unicode(self, unicode_value):
2404
if self.from_unicode is None or unicode_value is None:
2405
# Don't convert or nothing to convert
2406
return unicode_value
2408
converted = self.from_unicode(unicode_value)
2409
except (ValueError, TypeError):
2410
# Invalid values are ignored
2412
if converted is None and self.invalid is not None:
2413
# The conversion failed
2414
if self.invalid == 'warning':
2415
trace.warning('Value "%s" is not valid for "%s"',
2416
unicode_value, self.name)
2417
elif self.invalid == 'error':
2418
raise errors.ConfigOptionValueError(self.name, unicode_value)
2421
def get_default(self):
2423
for var in self.default_from_env:
2425
# If the env variable is defined, its value is the default one
2426
value = os.environ[var].decode(osutils.get_user_encoding())
2431
# Otherwise, fallback to the value defined at registration
2432
if callable(self.default):
2433
value = self.default()
2434
if not isinstance(value, unicode):
2435
raise AssertionError(
2436
'Callable default values should be unicode')
2438
value = self.default
2441
def get_help_text(self, additional_see_also=None, plain=True):
2443
from bzrlib import help_topics
2444
result += help_topics._format_see_also(additional_see_also)
2446
result = help_topics.help_as_plain_text(result)
2450
# Predefined converters to get proper values from store
2452
def bool_from_store(unicode_str):
2453
return ui.bool_from_string(unicode_str)
2456
def int_from_store(unicode_str):
2457
return int(unicode_str)
2460
def float_from_store(unicode_str):
2461
return float(unicode_str)
2464
# Use a an empty dict to initialize an empty configobj avoiding all
2465
# parsing and encoding checks
2466
_list_converter_config = configobj.ConfigObj(
2467
{}, encoding='utf-8', list_values=True, interpolation=False)
2470
def list_from_store(unicode_str):
2471
if not isinstance(unicode_str, basestring):
2473
# Now inject our string directly as unicode. All callers got their value
2474
# from configobj, so values that need to be quoted are already properly
2476
_list_converter_config.reset()
2477
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2478
maybe_list = _list_converter_config['list']
2479
# ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
2480
if isinstance(maybe_list, basestring):
2482
# A single value, most probably the user forgot (or didn't care to
2483
# add) the final ','
2486
# The empty string, convert to empty list
2489
# We rely on ConfigObj providing us with a list already
2494
class OptionRegistry(registry.Registry):
2495
"""Register config options by their name.
2497
This overrides ``registry.Registry`` to simplify registration by acquiring
2498
some information from the option object itself.
2501
def register(self, option):
2502
"""Register a new option to its name.
2504
:param option: The option to register. Its name is used as the key.
2506
super(OptionRegistry, self).register(option.name, option,
2509
def register_lazy(self, key, module_name, member_name):
2510
"""Register a new option to be loaded on request.
2512
:param key: the key to request the option later. Since the registration
2513
is lazy, it should be provided and match the option name.
2515
:param module_name: the python path to the module. Such as 'os.path'.
2517
:param member_name: the member of the module to return. If empty or
2518
None, get() will return the module itself.
2520
super(OptionRegistry, self).register_lazy(key,
2521
module_name, member_name)
2523
def get_help(self, key=None):
2524
"""Get the help text associated with the given key"""
2525
option = self.get(key)
2526
the_help = option.help
2527
if callable(the_help):
2528
return the_help(self, key)
2532
option_registry = OptionRegistry()
2535
# Registered options in lexicographical order
2537
option_registry.register(
2538
Option('append_revisions_only',
2539
default=None, from_unicode=bool_from_store, invalid='warning',
2541
Whether to only append revisions to the mainline.
2543
If this is set to true, then it is not possible to change the
2544
existing mainline of the branch.
2546
option_registry.register(
2547
Option('acceptable_keys',
2548
default=None, from_unicode=list_from_store,
2550
List of GPG key patterns which are acceptable for verification.
2552
option_registry.register(
2553
Option('bzr.workingtree.worth_saving_limit', default=10,
2554
from_unicode=int_from_store, invalid='warning',
2556
How many changes before saving the dirstate.
2558
-1 means that we will never rewrite the dirstate file for only
2559
stat-cache changes. Regardless of this setting, we will always rewrite
2560
the dirstate file if a file is added/removed/renamed/etc. This flag only
2561
affects the behavior of updating the dirstate file after we notice that
2562
a file has been touched.
2564
option_registry.register(
2565
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2566
from_unicode=signature_policy_from_unicode,
2568
GPG checking policy.
2570
Possible values: require, ignore, check-available (default)
2572
this option will control whether bzr will require good gpg
2573
signatures, ignore them, or check them if they are
2576
option_registry.register(
2577
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2578
from_unicode=signing_policy_from_unicode,
2582
Possible values: always, never, when-required (default)
2584
This option controls whether bzr will always create
2585
gpg signatures or not on commits.
2587
option_registry.register(
2588
Option('dirstate.fdatasync', default=True,
2589
from_unicode=bool_from_store,
2591
Flush dirstate changes onto physical disk?
2593
If true (default), working tree metadata changes are flushed through the
2594
OS buffers to physical disk. This is somewhat slower, but means data
2595
should not be lost if the machine crashes. See also repository.fdatasync.
2597
option_registry.register(
2598
Option('debug_flags', default=[], from_unicode=list_from_store,
2599
help='Debug flags to activate.'))
2600
option_registry.register(
2601
Option('default_format', default='2a',
2602
help='Format used when creating branches.'))
2603
option_registry.register(
2604
Option('dpush_strict', default=None,
2605
from_unicode=bool_from_store,
2607
The default value for ``dpush --strict``.
2609
If present, defines the ``--strict`` option default value for checking
2610
uncommitted changes before pushing into a different VCS without any
2611
custom bzr metadata.
2613
option_registry.register(
2615
help='The command called to launch an editor to enter a message.'))
2616
option_registry.register(
2617
Option('email', default=default_email,
2618
from_unicode=email_from_store,
2619
help='The users identity'))
2620
option_registry.register(
2621
Option('gpg_signing_command',
2624
Program to use use for creating signatures.
2626
This should support at least the -u and --clearsign options.
2628
option_registry.register(
2629
Option('gpg_signing_key',
2632
GPG key to use for signing.
2634
This defaults to the first key associated with the users email.
2636
option_registry.register(
2637
Option('ignore_missing_extensions', default=False,
2638
from_unicode=bool_from_store,
2640
Control the missing extensions warning display.
2642
The warning will not be emitted if set to True.
2644
option_registry.register(
2646
help='Language to translate messages into.'))
2647
option_registry.register(
2648
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2650
Steal locks that appears to be dead.
2652
If set to True, bzr will check if a lock is supposed to be held by an
2653
active process from the same user on the same machine. If the user and
2654
machine match, but no process with the given PID is active, then bzr
2655
will automatically break the stale lock, and create a new lock for
2657
Otherwise, bzr will prompt as normal to break the lock.
2659
option_registry.register(
2660
Option('log_format', default='long',
2662
Log format to use when displaying revisions.
2664
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2665
may be provided by plugins.
2667
option_registry.register(
2668
Option('output_encoding',
2669
help= 'Unicode encoding for output'
2670
' (terminal encoding if not specified).'))
2671
option_registry.register(
2672
Option('post_commit', default=None,
2674
Post commit functions.
2676
An ordered list of python functions to call, separated by spaces.
2678
Each function takes branch, rev_id as parameters.
2680
option_registry.register(
2681
Option('push_strict', default=None,
2682
from_unicode=bool_from_store,
2684
The default value for ``push --strict``.
2686
If present, defines the ``--strict`` option default value for checking
2687
uncommitted changes before sending a merge directive.
2689
option_registry.register(
2690
Option('repository.fdatasync', default=True,
2691
from_unicode=bool_from_store,
2693
Flush repository changes onto physical disk?
2695
If true (default), repository changes are flushed through the OS buffers
2696
to physical disk. This is somewhat slower, but means data should not be
2697
lost if the machine crashes. See also dirstate.fdatasync.
2700
option_registry.register(
2701
Option('selftest.timeout',
2703
from_unicode=int_from_store,
2704
help='Abort selftest if one test takes longer than this many seconds',
2707
option_registry.register(
2708
Option('send_strict', default=None,
2709
from_unicode=bool_from_store,
2711
The default value for ``send --strict``.
2713
If present, defines the ``--strict`` option default value for checking
2714
uncommitted changes before pushing.
2717
option_registry.register(
2718
Option('serve.client_timeout',
2719
default=300.0, from_unicode=float_from_store,
2720
help="If we wait for a new request from a client for more than"
2721
" X seconds, consider the client idle, and hangup."))
2724
class Section(object):
2725
"""A section defines a dict of option name => value.
2727
This is merely a read-only dict which can add some knowledge about the
2728
options. It is *not* a python dict object though and doesn't try to mimic
2732
def __init__(self, section_id, options):
2733
self.id = section_id
2734
# We re-use the dict-like object received
2735
self.options = options
2737
def get(self, name, default=None, expand=True):
2738
return self.options.get(name, default)
2740
def iter_option_names(self):
2741
for k in self.options.iterkeys():
2745
# Mostly for debugging use
2746
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2749
_NewlyCreatedOption = object()
2750
"""Was the option created during the MutableSection lifetime"""
2753
class MutableSection(Section):
2754
"""A section allowing changes and keeping track of the original values."""
2756
def __init__(self, section_id, options):
2757
super(MutableSection, self).__init__(section_id, options)
2760
def set(self, name, value):
2761
if name not in self.options:
2762
# This is a new option
2763
self.orig[name] = _NewlyCreatedOption
2764
elif name not in self.orig:
2765
self.orig[name] = self.get(name, None)
2766
self.options[name] = value
2768
def remove(self, name):
2769
if name not in self.orig:
2770
self.orig[name] = self.get(name, None)
2771
del self.options[name]
2774
class Store(object):
2775
"""Abstract interface to persistent storage for configuration options."""
2777
readonly_section_class = Section
2778
mutable_section_class = MutableSection
2780
def is_loaded(self):
2781
"""Returns True if the Store has been loaded.
2783
This is used to implement lazy loading and ensure the persistent
2784
storage is queried only when needed.
2786
raise NotImplementedError(self.is_loaded)
2789
"""Loads the Store from persistent storage."""
2790
raise NotImplementedError(self.load)
2792
def _load_from_string(self, bytes):
2793
"""Create a store from a string in configobj syntax.
2795
:param bytes: A string representing the file content.
2797
raise NotImplementedError(self._load_from_string)
2800
"""Unloads the Store.
2802
This should make is_loaded() return False. This is used when the caller
2803
knows that the persistent storage has changed or may have change since
2806
raise NotImplementedError(self.unload)
2809
"""Saves the Store to persistent storage."""
2810
raise NotImplementedError(self.save)
2812
def external_url(self):
2813
raise NotImplementedError(self.external_url)
2815
def get_sections(self):
2816
"""Returns an ordered iterable of existing sections.
2818
:returns: An iterable of (store, section).
2820
raise NotImplementedError(self.get_sections)
2822
def get_mutable_section(self, section_id=None):
2823
"""Returns the specified mutable section.
2825
:param section_id: The section identifier
2827
raise NotImplementedError(self.get_mutable_section)
2830
# Mostly for debugging use
2831
return "<config.%s(%s)>" % (self.__class__.__name__,
2832
self.external_url())
2835
class CommandLineStore(Store):
2836
"A store to carry command line overrides for the config options."""
2838
def __init__(self, opts=None):
2839
super(CommandLineStore, self).__init__()
2845
# The dict should be cleared but not replaced so it can be shared.
2846
self.options.clear()
2848
def _from_cmdline(self, overrides):
2849
# Reset before accepting new definitions
2851
for over in overrides:
2853
name, value = over.split('=', 1)
2855
raise errors.BzrCommandError(
2856
gettext("Invalid '%s', should be of the form 'name=value'")
2858
self.options[name] = value
2860
def external_url(self):
2861
# Not an url but it makes debugging easier and is never needed
2865
def get_sections(self):
2866
yield self, self.readonly_section_class('cmdline_overrides',
2870
class IniFileStore(Store):
2871
"""A config Store using ConfigObj for storage.
2873
:ivar transport: The transport object where the config file is located.
2875
:ivar file_name: The config file basename in the transport directory.
2877
:ivar _config_obj: Private member to hold the ConfigObj instance used to
2878
serialize/deserialize the config file.
2882
"""A config Store using ConfigObj for storage.
2884
super(IniFileStore, self).__init__()
2885
self._config_obj = None
2887
def is_loaded(self):
2888
return self._config_obj != None
2891
self._config_obj = None
2893
def _load_content(self):
2894
"""Load the config file bytes.
2896
This should be provided by subclasses
2898
:return: Byte string
2900
raise NotImplementedError(self._load_content)
2902
def _save_content(self, content):
2903
"""Save the config file bytes.
2905
This should be provided by subclasses
2907
:param content: Config file bytes to write
2909
raise NotImplementedError(self._save_content)
2912
"""Load the store from the associated file."""
2913
if self.is_loaded():
2915
content = self._load_content()
2916
self._load_from_string(content)
2917
for hook in ConfigHooks['load']:
2920
def _load_from_string(self, bytes):
2921
"""Create a config store from a string.
2923
:param bytes: A string representing the file content.
2925
if self.is_loaded():
2926
raise AssertionError('Already loaded: %r' % (self._config_obj,))
2927
co_input = StringIO(bytes)
2929
# The config files are always stored utf8-encoded
2930
self._config_obj = ConfigObj(co_input, encoding='utf-8',
2932
except configobj.ConfigObjError, e:
2933
self._config_obj = None
2934
raise errors.ParseConfigError(e.errors, self.external_url())
2935
except UnicodeDecodeError:
2936
raise errors.ConfigContentError(self.external_url())
2939
if not self.is_loaded():
2943
self._config_obj.write(out)
2944
self._save_content(out.getvalue())
2945
for hook in ConfigHooks['save']:
2948
def get_sections(self):
2949
"""Get the configobj section in the file order.
2951
:returns: An iterable of (store, section).
2953
# We need a loaded store
2956
except (errors.NoSuchFile, errors.PermissionDenied):
2957
# If the file can't be read, there is no sections
2959
cobj = self._config_obj
2961
yield self, self.readonly_section_class(None, cobj)
2962
for section_name in cobj.sections:
2964
self.readonly_section_class(section_name,
2965
cobj[section_name]))
2967
def get_mutable_section(self, section_id=None):
2968
# We need a loaded store
2971
except errors.NoSuchFile:
2972
# The file doesn't exist, let's pretend it was empty
2973
self._load_from_string('')
2974
if section_id is None:
2975
section = self._config_obj
2977
section = self._config_obj.setdefault(section_id, {})
2978
return self.mutable_section_class(section_id, section)
2981
class TransportIniFileStore(IniFileStore):
2982
"""IniFileStore that loads files from a transport.
2985
def __init__(self, transport, file_name):
2986
"""A Store using a ini file on a Transport
2988
:param transport: The transport object where the config file is located.
2989
:param file_name: The config file basename in the transport directory.
2991
super(TransportIniFileStore, self).__init__()
2992
self.transport = transport
2993
self.file_name = file_name
2995
def _load_content(self):
2997
return self.transport.get_bytes(self.file_name)
2998
except errors.PermissionDenied:
2999
trace.warning("Permission denied while trying to load "
3000
"configuration store %s.", self.external_url())
3003
def _save_content(self, content):
3004
self.transport.put_bytes(self.file_name, content)
3006
def external_url(self):
3007
# FIXME: external_url should really accepts an optional relpath
3008
# parameter (bug #750169) :-/ -- vila 2011-04-04
3009
# The following will do in the interim but maybe we don't want to
3010
# expose a path here but rather a config ID and its associated
3011
# object </hand wawe>.
3012
return urlutils.join(self.transport.external_url(), self.file_name)
3015
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3016
# unlockable stores for use with objects that can already ensure the locking
3017
# (think branches). If different stores (not based on ConfigObj) are created,
3018
# they may face the same issue.
3021
class LockableIniFileStore(TransportIniFileStore):
3022
"""A ConfigObjStore using locks on save to ensure store integrity."""
3024
def __init__(self, transport, file_name, lock_dir_name=None):
3025
"""A config Store using ConfigObj for storage.
3027
:param transport: The transport object where the config file is located.
3029
:param file_name: The config file basename in the transport directory.
3031
if lock_dir_name is None:
3032
lock_dir_name = 'lock'
3033
self.lock_dir_name = lock_dir_name
3034
super(LockableIniFileStore, self).__init__(transport, file_name)
3035
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3037
def lock_write(self, token=None):
3038
"""Takes a write lock in the directory containing the config file.
3040
If the directory doesn't exist it is created.
3042
# FIXME: This doesn't check the ownership of the created directories as
3043
# ensure_config_dir_exists does. It should if the transport is local
3044
# -- vila 2011-04-06
3045
self.transport.create_prefix()
3046
return self._lock.lock_write(token)
3051
def break_lock(self):
3052
self._lock.break_lock()
3056
# We need to be able to override the undecorated implementation
3057
self.save_without_locking()
3059
def save_without_locking(self):
3060
super(LockableIniFileStore, self).save()
3063
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3064
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3065
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3067
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3068
# functions or a registry will make it easier and clearer for tests, focusing
3069
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3070
# on a poolie's remark)
3071
class GlobalStore(LockableIniFileStore):
3073
def __init__(self, possible_transports=None):
3074
t = transport.get_transport_from_path(
3075
config_dir(), possible_transports=possible_transports)
3076
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3080
class LocationStore(LockableIniFileStore):
3082
def __init__(self, possible_transports=None):
3083
t = transport.get_transport_from_path(
3084
config_dir(), possible_transports=possible_transports)
3085
super(LocationStore, self).__init__(t, 'locations.conf')
3086
self.id = 'locations'
3089
class BranchStore(TransportIniFileStore):
3091
def __init__(self, branch):
3092
super(BranchStore, self).__init__(branch.control_transport,
3094
self.branch = branch
3097
def lock_write(self, token=None):
3098
return self.branch.lock_write(token)
3101
return self.branch.unlock()
3105
# We need to be able to override the undecorated implementation
3106
self.save_without_locking()
3108
def save_without_locking(self):
3109
super(BranchStore, self).save()
3112
class ControlStore(LockableIniFileStore):
3114
def __init__(self, bzrdir):
3115
super(ControlStore, self).__init__(bzrdir.transport,
3117
lock_dir_name='branch_lock')
3120
class SectionMatcher(object):
3121
"""Select sections into a given Store.
3123
This is intended to be used to postpone getting an iterable of sections
3127
def __init__(self, store):
3130
def get_sections(self):
3131
# This is where we require loading the store so we can see all defined
3133
sections = self.store.get_sections()
3134
# Walk the revisions in the order provided
3135
for store, s in sections:
3139
def match(self, section):
3140
"""Does the proposed section match.
3142
:param section: A Section object.
3144
:returns: True if the section matches, False otherwise.
3146
raise NotImplementedError(self.match)
3149
class NameMatcher(SectionMatcher):
3151
def __init__(self, store, section_id):
3152
super(NameMatcher, self).__init__(store)
3153
self.section_id = section_id
3155
def match(self, section):
3156
return section.id == self.section_id
3159
class LocationSection(Section):
3161
def __init__(self, section, length, extra_path):
3162
super(LocationSection, self).__init__(section.id, section.options)
3163
self.length = length
3164
self.extra_path = extra_path
3165
self.locals = {'relpath': extra_path,
3166
'basename': urlutils.basename(extra_path)}
3168
def get(self, name, default=None, expand=True):
3169
value = super(LocationSection, self).get(name, default)
3170
if value is not None and expand:
3171
policy_name = self.get(name + ':policy', None)
3172
policy = _policy_value.get(policy_name, POLICY_NONE)
3173
if policy == POLICY_APPENDPATH:
3174
value = urlutils.join(value, self.extra_path)
3175
# expand section local options right now (since POLICY_APPENDPATH
3176
# will never add options references, it's ok to expand after it).
3178
for is_ref, chunk in iter_option_refs(value):
3180
chunks.append(chunk)
3183
if ref in self.locals:
3184
chunks.append(self.locals[ref])
3186
chunks.append(chunk)
3187
value = ''.join(chunks)
3191
class LocationMatcher(SectionMatcher):
3193
def __init__(self, store, location):
3194
super(LocationMatcher, self).__init__(store)
3195
if location.startswith('file://'):
3196
location = urlutils.local_path_from_url(location)
3197
self.location = location
3199
def _get_matching_sections(self):
3200
"""Get all sections matching ``location``."""
3201
# We slightly diverge from LocalConfig here by allowing the no-name
3202
# section as the most generic one and the lower priority.
3203
no_name_section = None
3205
# Filter out the no_name_section so _iter_for_location_by_parts can be
3206
# used (it assumes all sections have a name).
3207
for _, section in self.store.get_sections():
3208
if section.id is None:
3209
no_name_section = section
3211
all_sections.append(section)
3212
# Unfortunately _iter_for_location_by_parts deals with section names so
3213
# we have to resync.
3214
filtered_sections = _iter_for_location_by_parts(
3215
[s.id for s in all_sections], self.location)
3216
iter_all_sections = iter(all_sections)
3217
matching_sections = []
3218
if no_name_section is not None:
3219
matching_sections.append(
3220
LocationSection(no_name_section, 0, self.location))
3221
for section_id, extra_path, length in filtered_sections:
3222
# a section id is unique for a given store so it's safe to take the
3223
# first matching section while iterating. Also, all filtered
3224
# sections are part of 'all_sections' and will always be found
3227
section = iter_all_sections.next()
3228
if section_id == section.id:
3229
matching_sections.append(
3230
LocationSection(section, length, extra_path))
3232
return matching_sections
3234
def get_sections(self):
3235
# Override the default implementation as we want to change the order
3236
matching_sections = self._get_matching_sections()
3237
# We want the longest (aka more specific) locations first
3238
sections = sorted(matching_sections,
3239
key=lambda section: (section.length, section.id),
3241
# Sections mentioning 'ignore_parents' restrict the selection
3242
for section in sections:
3243
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3244
ignore = section.get('ignore_parents', None)
3245
if ignore is not None:
3246
ignore = ui.bool_from_string(ignore)
3249
# Finally, we have a valid section
3250
yield self.store, section
3253
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3254
"""Describes an expandable option reference.
3256
We want to match the most embedded reference first.
3258
I.e. for '{{foo}}' we will get '{foo}',
3259
for '{bar{baz}}' we will get '{baz}'
3262
def iter_option_refs(string):
3263
# Split isolate refs so every other chunk is a ref
3265
for chunk in _option_ref_re.split(string):
3270
class Stack(object):
3271
"""A stack of configurations where an option can be defined"""
3273
def __init__(self, sections_def, store=None, mutable_section_id=None):
3274
"""Creates a stack of sections with an optional store for changes.
3276
:param sections_def: A list of Section or callables that returns an
3277
iterable of Section. This defines the Sections for the Stack and
3278
can be called repeatedly if needed.
3280
:param store: The optional Store where modifications will be
3281
recorded. If none is specified, no modifications can be done.
3283
:param mutable_section_id: The id of the MutableSection where changes
3284
are recorded. This requires the ``store`` parameter to be
3287
self.sections_def = sections_def
3289
self.mutable_section_id = mutable_section_id
3291
def get(self, name, expand=None):
3292
"""Return the *first* option value found in the sections.
3294
This is where we guarantee that sections coming from Store are loaded
3295
lazily: the loading is delayed until we need to either check that an
3296
option exists or get its value, which in turn may require to discover
3297
in which sections it can be defined. Both of these (section and option
3298
existence) require loading the store (even partially).
3300
:param name: The queried option.
3302
:param expand: Whether options references should be expanded.
3304
:returns: The value of the option.
3306
# FIXME: No caching of options nor sections yet -- vila 20110503
3308
expand = _get_expand_default_value()
3310
# Ensuring lazy loading is achieved by delaying section matching (which
3311
# implies querying the persistent storage) until it can't be avoided
3312
# anymore by using callables to describe (possibly empty) section
3314
for sections in self.sections_def:
3315
for store, section in sections():
3316
value = section.get(name)
3317
if value is not None:
3319
if value is not None:
3321
# If the option is registered, it may provide additional info about
3324
opt = option_registry.get(name)
3328
def expand_and_convert(val):
3329
# This may need to be called twice if the value is None or ends up
3330
# being None during expansion or conversion.
3333
if isinstance(val, basestring):
3334
val = self._expand_options_in_string(val)
3336
trace.warning('Cannot expand "%s":'
3337
' %s does not support option expansion'
3338
% (name, type(val)))
3340
val = opt.convert_from_unicode(val)
3342
value = expand_and_convert(value)
3343
if opt is not None and value is None:
3344
# If the option is registered, it may provide a default value
3345
value = opt.get_default()
3346
value = expand_and_convert(value)
3347
for hook in ConfigHooks['get']:
3348
hook(self, name, value)
3351
def expand_options(self, string, env=None):
3352
"""Expand option references in the string in the configuration context.
3354
:param string: The string containing option(s) to expand.
3356
:param env: An option dict defining additional configuration options or
3357
overriding existing ones.
3359
:returns: The expanded string.
3361
return self._expand_options_in_string(string, env)
3363
def _expand_options_in_string(self, string, env=None, _refs=None):
3364
"""Expand options in the string in the configuration context.
3366
:param string: The string to be expanded.
3368
:param env: An option dict defining additional configuration options or
3369
overriding existing ones.
3371
:param _refs: Private list (FIFO) containing the options being expanded
3374
:returns: The expanded string.
3377
# Not much to expand there
3380
# What references are currently resolved (to detect loops)
3383
# We need to iterate until no more refs appear ({{foo}} will need two
3384
# iterations for example).
3389
for is_ref, chunk in iter_option_refs(result):
3391
chunks.append(chunk)
3396
raise errors.OptionExpansionLoop(string, _refs)
3398
value = self._expand_option(name, env, _refs)
3400
raise errors.ExpandingUnknownOption(name, string)
3401
chunks.append(value)
3403
result = ''.join(chunks)
3406
def _expand_option(self, name, env, _refs):
3407
if env is not None and name in env:
3408
# Special case, values provided in env takes precedence over
3412
value = self.get(name, expand=False)
3413
value = self._expand_options_in_string(value, env, _refs)
3416
def _get_mutable_section(self):
3417
"""Get the MutableSection for the Stack.
3419
This is where we guarantee that the mutable section is lazily loaded:
3420
this means we won't load the corresponding store before setting a value
3421
or deleting an option. In practice the store will often be loaded but
3422
this helps catching some programming errors.
3424
section = self.store.get_mutable_section(self.mutable_section_id)
3427
def set(self, name, value):
3428
"""Set a new value for the option."""
3429
section = self._get_mutable_section()
3430
section.set(name, value)
3431
for hook in ConfigHooks['set']:
3432
hook(self, name, value)
3434
def remove(self, name):
3435
"""Remove an existing option."""
3436
section = self._get_mutable_section()
3437
section.remove(name)
3438
for hook in ConfigHooks['remove']:
3442
# Mostly for debugging use
3443
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3445
def _get_overrides(self):
3446
# Hack around library_state.initialize never called
3447
if bzrlib.global_state is not None:
3448
return bzrlib.global_state.cmdline_overrides.get_sections()
3452
class _CompatibleStack(Stack):
3453
"""Place holder for compatibility with previous design.
3455
This is intended to ease the transition from the Config-based design to the
3456
Stack-based design and should not be used nor relied upon by plugins.
3458
One assumption made here is that the daughter classes will all use Stores
3459
derived from LockableIniFileStore).
3461
It implements set() and remove () by re-loading the store before applying
3462
the modification and saving it.
3464
The long term plan being to implement a single write by store to save
3465
all modifications, this class should not be used in the interim.
3468
def set(self, name, value):
3471
super(_CompatibleStack, self).set(name, value)
3472
# Force a write to persistent storage
3475
def remove(self, name):
3478
super(_CompatibleStack, self).remove(name)
3479
# Force a write to persistent storage
3483
class GlobalStack(_CompatibleStack):
3484
"""Global options only stack.
3486
The following sections are queried:
3488
* command-line overrides,
3490
* the 'DEFAULT' section in bazaar.conf
3492
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3497
gstore = GlobalStore()
3498
super(GlobalStack, self).__init__(
3499
[self._get_overrides,
3500
NameMatcher(gstore, 'DEFAULT').get_sections],
3501
gstore, mutable_section_id='DEFAULT')
3504
class LocationStack(_CompatibleStack):
3505
"""Per-location options falling back to global options stack.
3508
The following sections are queried:
3510
* command-line overrides,
3512
* the sections matching ``location`` in ``locations.conf``, the order being
3513
defined by the number of path components in the section glob, higher
3514
numbers first (from most specific section to most generic).
3516
* the 'DEFAULT' section in bazaar.conf
3518
This stack will use the ``location`` section in locations.conf as its
3522
def __init__(self, location):
3523
"""Make a new stack for a location and global configuration.
3525
:param location: A URL prefix to """
3526
lstore = LocationStore()
3527
if location.startswith('file://'):
3528
location = urlutils.local_path_from_url(location)
3529
gstore = GlobalStore()
3530
super(LocationStack, self).__init__(
3531
[self._get_overrides,
3532
LocationMatcher(lstore, location).get_sections,
3533
NameMatcher(gstore, 'DEFAULT').get_sections],
3534
lstore, mutable_section_id=location)
3537
class BranchStack(_CompatibleStack):
3538
"""Per-location options falling back to branch then global options stack.
3540
The following sections are queried:
3542
* command-line overrides,
3544
* the sections matching ``location`` in ``locations.conf``, the order being
3545
defined by the number of path components in the section glob, higher
3546
numbers first (from most specific section to most generic),
3548
* the no-name section in branch.conf,
3550
* the ``DEFAULT`` section in ``bazaar.conf``.
3552
This stack will use the no-name section in ``branch.conf`` as its
3556
def __init__(self, branch):
3557
lstore = LocationStore()
3558
bstore = branch._get_config_store()
3559
gstore = GlobalStore()
3560
super(BranchStack, self).__init__(
3561
[self._get_overrides,
3562
LocationMatcher(lstore, branch.base).get_sections,
3563
NameMatcher(bstore, None).get_sections,
3564
NameMatcher(gstore, 'DEFAULT').get_sections],
3566
self.branch = branch
3569
class RemoteControlStack(_CompatibleStack):
3570
"""Remote control-only options stack."""
3572
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3573
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3574
# control.conf and is used only for stack options.
3576
def __init__(self, bzrdir):
3577
cstore = bzrdir._get_config_store()
3578
super(RemoteControlStack, self).__init__(
3579
[NameMatcher(cstore, None).get_sections],
3581
self.bzrdir = bzrdir
3584
class RemoteBranchStack(_CompatibleStack):
3585
"""Remote branch-only options stack."""
3587
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3588
# with the stack used for remote branches. RemoteBranchStack only uses
3589
# branch.conf and is used only for the stack options.
3591
def __init__(self, branch):
3592
bstore = branch._get_config_store()
3593
super(RemoteBranchStack, self).__init__(
3594
[NameMatcher(bstore, None).get_sections],
3596
self.branch = branch
3598
# Use a an empty dict to initialize an empty configobj avoiding all
3599
# parsing and encoding checks
3600
_quoting_config = configobj.ConfigObj(
3601
{}, encoding='utf-8', interpolation=False)
3603
class cmd_config(commands.Command):
3604
__doc__ = """Display, set or remove a configuration option.
3606
Display the active value for a given option.
3608
If --all is specified, NAME is interpreted as a regular expression and all
3609
matching options are displayed mentioning their scope. The active value
3610
that bzr will take into account is the first one displayed for each option.
3612
If no NAME is given, --all .* is implied.
3614
Setting a value is achieved by using name=value without spaces. The value
3615
is set in the most relevant scope and can be checked by displaying the
3619
takes_args = ['name?']
3623
# FIXME: This should be a registry option so that plugins can register
3624
# their own config files (or not) and will also address
3625
# http://pad.lv/788991 -- vila 20101115
3626
commands.Option('scope', help='Reduce the scope to the specified'
3627
' configuration file.',
3629
commands.Option('all',
3630
help='Display all the defined values for the matching options.',
3632
commands.Option('remove', help='Remove the option from'
3633
' the configuration file.'),
3636
_see_also = ['configuration']
3638
@commands.display_command
3639
def run(self, name=None, all=False, directory=None, scope=None,
3641
if directory is None:
3643
directory = urlutils.normalize_url(directory)
3645
raise errors.BzrError(
3646
'--all and --remove are mutually exclusive.')
3648
# Delete the option in the given scope
3649
self._remove_config_option(name, directory, scope)
3651
# Defaults to all options
3652
self._show_matching_options('.*', directory, scope)
3655
name, value = name.split('=', 1)
3657
# Display the option(s) value(s)
3659
self._show_matching_options(name, directory, scope)
3661
self._show_value(name, directory, scope)
3664
raise errors.BzrError(
3665
'Only one option can be set.')
3666
# Set the option value
3667
self._set_config_option(name, value, directory, scope)
3669
def _get_stack(self, directory, scope=None):
3670
"""Get the configuration stack specified by ``directory`` and ``scope``.
3672
:param directory: Where the configurations are derived from.
3674
:param scope: A specific config to start from.
3676
# FIXME: scope should allow access to plugin-specific stacks (even
3677
# reduced to the plugin-specific store), related to
3678
# http://pad.lv/788991 -- vila 2011-11-15
3679
if scope is not None:
3680
if scope == 'bazaar':
3681
return GlobalStack()
3682
elif scope == 'locations':
3683
return LocationStack(directory)
3684
elif scope == 'branch':
3686
controldir.ControlDir.open_containing_tree_or_branch(
3688
return br.get_config_stack()
3689
raise errors.NoSuchConfig(scope)
3693
controldir.ControlDir.open_containing_tree_or_branch(
3695
return br.get_config_stack()
3696
except errors.NotBranchError:
3697
return LocationStack(directory)
3699
def _show_value(self, name, directory, scope):
3700
conf = self._get_stack(directory, scope)
3701
value = conf.get(name, expand=True)
3702
if value is not None:
3703
# Quote the value appropriately
3704
value = _quoting_config._quote(value)
3705
self.outf.write('%s\n' % (value,))
3707
raise errors.NoSuchConfigOption(name)
3709
def _show_matching_options(self, name, directory, scope):
3710
name = lazy_regex.lazy_compile(name)
3711
# We want any error in the regexp to be raised *now* so we need to
3712
# avoid the delay introduced by the lazy regexp. But, we still do
3713
# want the nicer errors raised by lazy_regex.
3714
name._compile_and_collapse()
3717
conf = self._get_stack(directory, scope)
3718
for sections in conf.sections_def:
3719
for store, section in sections():
3720
for oname in section.iter_option_names():
3721
if name.search(oname):
3722
if cur_store_id != store.id:
3723
# Explain where the options are defined
3724
self.outf.write('%s:\n' % (store.id,))
3725
cur_store_id = store.id
3727
if (section.id not in (None, 'DEFAULT')
3728
and cur_section != section.id):
3729
# Display the section if it's not the default (or
3731
self.outf.write(' [%s]\n' % (section.id,))
3732
cur_section = section.id
3733
value = section.get(oname, expand=False)
3734
value = _quoting_config._quote(value)
3735
self.outf.write(' %s = %s\n' % (oname, value))
3737
def _set_config_option(self, name, value, directory, scope):
3738
conf = self._get_stack(directory, scope)
3739
conf.set(name, value)
3741
def _remove_config_option(self, name, directory, scope):
3743
raise errors.BzrCommandError(
3744
'--remove expects an option to remove.')
3745
conf = self._get_stack(directory, scope)
3749
raise errors.NoSuchConfigOption(name)
3754
# We need adapters that can build a Store or a Stack in a test context. Test
3755
# classes, based on TestCaseWithTransport, can use the registry to parametrize
3756
# themselves. The builder will receive a test instance and should return a
3757
# ready-to-use store or stack. Plugins that define new store/stacks can also
3758
# register themselves here to be tested against the tests defined in
3759
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3760
# for the same test.
3762
# The registered object should be a callable receiving a test instance
3763
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
3765
test_store_builder_registry = registry.Registry()
3767
# The registered object should be a callable receiving a test instance
3768
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
3770
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
