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
80
from bzrlib.decorators import needs_write_lock
81
from bzrlib.lazy_import import lazy_import
82
lazy_import(globals(), """
85
from cStringIO import StringIO
104
from bzrlib.util.configobj import configobj
112
from bzrlib.symbol_versioning import (
130
POLICY_APPENDPATH = 2
134
POLICY_NORECURSE: 'norecurse',
135
POLICY_APPENDPATH: 'appendpath',
140
'norecurse': POLICY_NORECURSE,
141
'appendpath': POLICY_APPENDPATH,
145
STORE_LOCATION = POLICY_NONE
146
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
147
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
152
class ConfigObj(configobj.ConfigObj):
154
def __init__(self, infile=None, **kwargs):
155
# We define our own interpolation mechanism calling it option expansion
156
super(ConfigObj, self).__init__(infile=infile,
160
def get_bool(self, section, key):
161
return self[section].as_bool(key)
163
def get_value(self, section, name):
164
# Try [] for the old DEFAULT section.
165
if section == "DEFAULT":
170
return self[section][name]
173
# FIXME: Until we can guarantee that each config file is loaded once and
174
# only once for a given bzrlib session, we don't want to re-read the file every
175
# time we query for an option so we cache the value (bad ! watch out for tests
176
# needing to restore the proper value). -- vila 20110219
177
_expand_default_value = None
178
def _get_expand_default_value():
179
global _expand_default_value
180
if _expand_default_value is not None:
181
return _expand_default_value
182
conf = GlobalConfig()
183
# Note that we must not use None for the expand value below or we'll run
184
# into infinite recursion. Using False really would be quite silly ;)
185
expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
187
# This is an opt-in feature, you *really* need to clearly say you want
190
_expand_default_value = expand
194
class Config(object):
195
"""A configuration policy - what username, editor, gpg needs etc."""
198
super(Config, self).__init__()
201
"""Returns a unique ID for the config."""
202
raise NotImplementedError(self.config_id)
204
@deprecated_method(deprecated_in((2, 4, 0)))
205
def get_editor(self):
206
"""Get the users pop up editor."""
207
raise NotImplementedError
209
def get_change_editor(self, old_tree, new_tree):
210
from bzrlib import diff
211
cmd = self._get_change_editor()
214
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
217
def get_mail_client(self):
218
"""Get a mail client to use"""
219
selected_client = self.get_user_option('mail_client')
220
_registry = mail_client.mail_client_registry
222
mail_client_class = _registry.get(selected_client)
224
raise errors.UnknownMailClient(selected_client)
225
return mail_client_class(self)
227
def _get_signature_checking(self):
228
"""Template method to override signature checking policy."""
230
def _get_signing_policy(self):
231
"""Template method to override signature creation policy."""
235
def expand_options(self, string, env=None):
236
"""Expand option references in the string in the configuration context.
238
:param string: The string containing option to expand.
240
:param env: An option dict defining additional configuration options or
241
overriding existing ones.
243
:returns: The expanded string.
245
return self._expand_options_in_string(string, env)
247
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
248
"""Expand options in a list of strings in the configuration context.
250
:param slist: A list of strings.
252
:param env: An option dict defining additional configuration options or
253
overriding existing ones.
255
:param _ref_stack: Private list containing the options being
256
expanded to detect loops.
258
:returns: The flatten list of expanded strings.
260
# expand options in each value separately flattening lists
263
value = self._expand_options_in_string(s, env, _ref_stack)
264
if isinstance(value, list):
270
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
271
"""Expand options in the string in the configuration context.
273
:param string: The string to be expanded.
275
:param env: An option dict defining additional configuration options or
276
overriding existing ones.
278
:param _ref_stack: Private list containing the options being
279
expanded to detect loops.
281
:returns: The expanded string.
284
# Not much to expand there
286
if _ref_stack is None:
287
# What references are currently resolved (to detect loops)
289
if self.option_ref_re is None:
290
# We want to match the most embedded reference first (i.e. for
291
# '{{foo}}' we will get '{foo}',
292
# for '{bar{baz}}' we will get '{baz}'
293
self.option_ref_re = re.compile('({[^{}]+})')
295
# We need to iterate until no more refs appear ({{foo}} will need two
296
# iterations for example).
298
raw_chunks = self.option_ref_re.split(result)
299
if len(raw_chunks) == 1:
300
# Shorcut the trivial case: no refs
304
# Split will isolate refs so that every other chunk is a ref
306
for chunk in raw_chunks:
309
# Keep only non-empty strings (or we get bogus empty
310
# slots when a list value is involved).
315
if name in _ref_stack:
316
raise errors.OptionExpansionLoop(string, _ref_stack)
317
_ref_stack.append(name)
318
value = self._expand_option(name, env, _ref_stack)
320
raise errors.ExpandingUnknownOption(name, string)
321
if isinstance(value, list):
329
# Once a list appears as the result of an expansion, all
330
# callers will get a list result. This allows a consistent
331
# behavior even when some options in the expansion chain
332
# defined as strings (no comma in their value) but their
333
# expanded value is a list.
334
return self._expand_options_in_list(chunks, env, _ref_stack)
336
result = ''.join(chunks)
339
def _expand_option(self, name, env, _ref_stack):
340
if env is not None and name in env:
341
# Special case, values provided in env takes precedence over
345
# FIXME: This is a limited implementation, what we really need is a
346
# way to query the bzr config for the value of an option,
347
# respecting the scope rules (That is, once we implement fallback
348
# configs, getting the option value should restart from the top
349
# config, not the current one) -- vila 20101222
350
value = self.get_user_option(name, expand=False)
351
if isinstance(value, list):
352
value = self._expand_options_in_list(value, env, _ref_stack)
354
value = self._expand_options_in_string(value, env, _ref_stack)
357
def _get_user_option(self, option_name):
358
"""Template method to provide a user option."""
361
def get_user_option(self, option_name, expand=None):
362
"""Get a generic option - no special process, no default.
364
:param option_name: The queried option.
366
:param expand: Whether options references should be expanded.
368
:returns: The value of the option.
371
expand = _get_expand_default_value()
372
value = self._get_user_option(option_name)
374
if isinstance(value, list):
375
value = self._expand_options_in_list(value)
376
elif isinstance(value, dict):
377
trace.warning('Cannot expand "%s":'
378
' Dicts do not support option expansion'
381
value = self._expand_options_in_string(value)
382
for hook in OldConfigHooks['get']:
383
hook(self, option_name, value)
386
def get_user_option_as_bool(self, option_name, expand=None, default=None):
387
"""Get a generic option as a boolean.
389
:param expand: Allow expanding references to other config values.
390
:param default: Default value if nothing is configured
391
:return None if the option doesn't exist or its value can't be
392
interpreted as a boolean. Returns True or False otherwise.
394
s = self.get_user_option(option_name, expand=expand)
396
# The option doesn't exist
398
val = ui.bool_from_string(s)
400
# The value can't be interpreted as a boolean
401
trace.warning('Value "%s" is not a boolean for "%s"',
405
def get_user_option_as_list(self, option_name, expand=None):
406
"""Get a generic option as a list - no special process, no default.
408
:return None if the option doesn't exist. Returns the value as a list
411
l = self.get_user_option(option_name, expand=expand)
412
if isinstance(l, (str, unicode)):
413
# A single value, most probably the user forgot (or didn't care to
418
def get_user_option_as_int_from_SI(self, option_name, default=None):
419
"""Get a generic option from a human readable size in SI units, e.g 10MB
421
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
422
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
425
:return Integer, expanded to its base-10 value if a proper SI unit is
426
found. If the option doesn't exist, or isn't a value in
427
SI units, return default (which defaults to None)
429
val = self.get_user_option(option_name)
430
if isinstance(val, list):
435
p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
439
val = int(m.group(1))
440
if m.group(2) is not None:
441
if m.group(2).lower() == 'k':
443
elif m.group(2).lower() == 'm':
445
elif m.group(2).lower() == 'g':
448
ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
449
' value {1!r} is not an SI unit.').format(
457
def gpg_signing_command(self):
458
"""What program should be used to sign signatures?"""
459
result = self._gpg_signing_command()
464
def _gpg_signing_command(self):
465
"""See gpg_signing_command()."""
468
def log_format(self):
469
"""What log format should be used"""
470
result = self._log_format()
475
def _log_format(self):
476
"""See log_format()."""
479
def validate_signatures_in_log(self):
480
"""Show GPG signature validity in log"""
481
result = self._validate_signatures_in_log()
488
def _validate_signatures_in_log(self):
489
"""See validate_signatures_in_log()."""
492
def acceptable_keys(self):
493
"""Comma separated list of key patterns acceptable to
494
verify-signatures command"""
495
result = self._acceptable_keys()
498
def _acceptable_keys(self):
499
"""See acceptable_keys()."""
502
def post_commit(self):
503
"""An ordered list of python functions to call.
505
Each function takes branch, rev_id as parameters.
507
return self._post_commit()
509
def _post_commit(self):
510
"""See Config.post_commit."""
513
def user_email(self):
514
"""Return just the email component of a username."""
515
return extract_email_address(self.username())
518
"""Return email-style username.
520
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
522
$BZR_EMAIL can be set to override this, then
523
the concrete policy type is checked, and finally
525
If no username can be found, errors.NoWhoami exception is raised.
527
v = os.environ.get('BZR_EMAIL')
529
return v.decode(osutils.get_user_encoding())
530
v = self._get_user_id()
533
v = os.environ.get('EMAIL')
535
return v.decode(osutils.get_user_encoding())
536
name, email = _auto_user_id()
538
return '%s <%s>' % (name, email)
541
raise errors.NoWhoami()
543
def ensure_username(self):
544
"""Raise errors.NoWhoami if username is not set.
546
This method relies on the username() function raising the error.
550
def signature_checking(self):
551
"""What is the current policy for signature checking?."""
552
policy = self._get_signature_checking()
553
if policy is not None:
555
return CHECK_IF_POSSIBLE
557
def signing_policy(self):
558
"""What is the current policy for signature checking?."""
559
policy = self._get_signing_policy()
560
if policy is not None:
562
return SIGN_WHEN_REQUIRED
564
def signature_needed(self):
565
"""Is a signature needed when committing ?."""
566
policy = self._get_signing_policy()
568
policy = self._get_signature_checking()
569
if policy is not None:
570
#this warning should go away once check_signatures is
571
#implemented (if not before)
572
trace.warning("Please use create_signatures,"
573
" not check_signatures to set signing policy.")
574
elif policy == SIGN_ALWAYS:
578
def gpg_signing_key(self):
579
"""GPG user-id to sign commits"""
580
key = self.get_user_option('gpg_signing_key')
581
if key == "default" or key == None:
582
return self.user_email()
586
def get_alias(self, value):
587
return self._get_alias(value)
589
def _get_alias(self, value):
592
def get_nickname(self):
593
return self._get_nickname()
595
def _get_nickname(self):
598
def get_bzr_remote_path(self):
600
return os.environ['BZR_REMOTE_PATH']
602
path = self.get_user_option("bzr_remote_path")
607
def suppress_warning(self, warning):
608
"""Should the warning be suppressed or emitted.
610
:param warning: The name of the warning being tested.
612
:returns: True if the warning should be suppressed, False otherwise.
614
warnings = self.get_user_option_as_list('suppress_warnings')
615
if warnings is None or warning not in warnings:
620
def get_merge_tools(self):
622
for (oname, value, section, conf_id, parser) in self._get_options():
623
if oname.startswith('bzr.mergetool.'):
624
tool_name = oname[len('bzr.mergetool.'):]
625
tools[tool_name] = self.get_user_option(oname)
626
trace.mutter('loaded merge tools: %r' % tools)
629
def find_merge_tool(self, name):
630
# We fake a defaults mechanism here by checking if the given name can
631
# be found in the known_merge_tools if it's not found in the config.
632
# This should be done through the proposed config defaults mechanism
633
# when it becomes available in the future.
634
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
636
or mergetools.known_merge_tools.get(name, None))
640
class _ConfigHooks(hooks.Hooks):
641
"""A dict mapping hook names and a list of callables for configs.
645
"""Create the default hooks.
647
These are all empty initially, because by default nothing should get
650
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
651
self.add_hook('load',
652
'Invoked when a config store is loaded.'
653
' The signature is (store).',
655
self.add_hook('save',
656
'Invoked when a config store is saved.'
657
' The signature is (store).',
659
# The hooks for config options
661
'Invoked when a config option is read.'
662
' The signature is (stack, name, value).',
665
'Invoked when a config option is set.'
666
' The signature is (stack, name, value).',
668
self.add_hook('remove',
669
'Invoked when a config option is removed.'
670
' The signature is (stack, name).',
672
ConfigHooks = _ConfigHooks()
675
class _OldConfigHooks(hooks.Hooks):
676
"""A dict mapping hook names and a list of callables for configs.
680
"""Create the default hooks.
682
These are all empty initially, because by default nothing should get
685
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
686
self.add_hook('load',
687
'Invoked when a config store is loaded.'
688
' The signature is (config).',
690
self.add_hook('save',
691
'Invoked when a config store is saved.'
692
' The signature is (config).',
694
# The hooks for config options
696
'Invoked when a config option is read.'
697
' The signature is (config, name, value).',
700
'Invoked when a config option is set.'
701
' The signature is (config, name, value).',
703
self.add_hook('remove',
704
'Invoked when a config option is removed.'
705
' The signature is (config, name).',
707
OldConfigHooks = _OldConfigHooks()
710
class IniBasedConfig(Config):
711
"""A configuration policy that draws from ini files."""
713
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
715
"""Base class for configuration files using an ini-like syntax.
717
:param file_name: The configuration file path.
719
super(IniBasedConfig, self).__init__()
720
self.file_name = file_name
721
if symbol_versioning.deprecated_passed(get_filename):
722
symbol_versioning.warn(
723
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
724
' Use file_name instead.',
727
if get_filename is not None:
728
self.file_name = get_filename()
730
self.file_name = file_name
735
def from_string(cls, str_or_unicode, file_name=None, save=False):
736
"""Create a config object from a string.
738
:param str_or_unicode: A string representing the file content. This will
741
:param file_name: The configuration file path.
743
:param _save: Whether the file should be saved upon creation.
745
conf = cls(file_name=file_name)
746
conf._create_from_string(str_or_unicode, save)
749
def _create_from_string(self, str_or_unicode, save):
750
self._content = StringIO(str_or_unicode.encode('utf-8'))
751
# Some tests use in-memory configs, some other always need the config
752
# file to exist on disk.
754
self._write_config_file()
756
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
757
if self._parser is not None:
759
if symbol_versioning.deprecated_passed(file):
760
symbol_versioning.warn(
761
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
762
' Use IniBasedConfig(_content=xxx) instead.',
765
if self._content is not None:
766
co_input = self._content
767
elif self.file_name is None:
768
raise AssertionError('We have no content to create the config')
770
co_input = self.file_name
772
self._parser = ConfigObj(co_input, encoding='utf-8')
773
except configobj.ConfigObjError, e:
774
raise errors.ParseConfigError(e.errors, e.config.filename)
775
except UnicodeDecodeError:
776
raise errors.ConfigContentError(self.file_name)
777
# Make sure self.reload() will use the right file name
778
self._parser.filename = self.file_name
779
for hook in OldConfigHooks['load']:
784
"""Reload the config file from disk."""
785
if self.file_name is None:
786
raise AssertionError('We need a file name to reload the config')
787
if self._parser is not None:
788
self._parser.reload()
789
for hook in ConfigHooks['load']:
792
def _get_matching_sections(self):
793
"""Return an ordered list of (section_name, extra_path) pairs.
795
If the section contains inherited configuration, extra_path is
796
a string containing the additional path components.
798
section = self._get_section()
799
if section is not None:
800
return [(section, '')]
804
def _get_section(self):
805
"""Override this to define the section used by the config."""
808
def _get_sections(self, name=None):
809
"""Returns an iterator of the sections specified by ``name``.
811
:param name: The section name. If None is supplied, the default
812
configurations are yielded.
814
:return: A tuple (name, section, config_id) for all sections that will
815
be walked by user_get_option() in the 'right' order. The first one
816
is where set_user_option() will update the value.
818
parser = self._get_parser()
820
yield (name, parser[name], self.config_id())
822
# No section name has been given so we fallback to the configobj
823
# itself which holds the variables defined outside of any section.
824
yield (None, parser, self.config_id())
826
def _get_options(self, sections=None):
827
"""Return an ordered list of (name, value, section, config_id) tuples.
829
All options are returned with their associated value and the section
830
they appeared in. ``config_id`` is a unique identifier for the
831
configuration file the option is defined in.
833
:param sections: Default to ``_get_matching_sections`` if not
834
specified. This gives a better control to daughter classes about
835
which sections should be searched. This is a list of (name,
840
parser = self._get_parser()
842
for (section_name, _) in self._get_matching_sections():
844
section = parser[section_name]
846
# This could happen for an empty file for which we define a
847
# DEFAULT section. FIXME: Force callers to provide sections
848
# instead ? -- vila 20100930
850
sections.append((section_name, section))
851
config_id = self.config_id()
852
for (section_name, section) in sections:
853
for (name, value) in section.iteritems():
854
yield (name, parser._quote(value), section_name,
857
def _get_option_policy(self, section, option_name):
858
"""Return the policy for the given (section, option_name) pair."""
861
def _get_change_editor(self):
862
return self.get_user_option('change_editor')
864
def _get_signature_checking(self):
865
"""See Config._get_signature_checking."""
866
policy = self._get_user_option('check_signatures')
868
return self._string_to_signature_policy(policy)
870
def _get_signing_policy(self):
871
"""See Config._get_signing_policy"""
872
policy = self._get_user_option('create_signatures')
874
return self._string_to_signing_policy(policy)
876
def _get_user_id(self):
877
"""Get the user id from the 'email' key in the current section."""
878
return self._get_user_option('email')
880
def _get_user_option(self, option_name):
881
"""See Config._get_user_option."""
882
for (section, extra_path) in self._get_matching_sections():
884
value = self._get_parser().get_value(section, option_name)
887
policy = self._get_option_policy(section, option_name)
888
if policy == POLICY_NONE:
890
elif policy == POLICY_NORECURSE:
891
# norecurse items only apply to the exact path
896
elif policy == POLICY_APPENDPATH:
898
value = urlutils.join(value, extra_path)
901
raise AssertionError('Unexpected config policy %r' % policy)
905
def _gpg_signing_command(self):
906
"""See Config.gpg_signing_command."""
907
return self._get_user_option('gpg_signing_command')
909
def _log_format(self):
910
"""See Config.log_format."""
911
return self._get_user_option('log_format')
913
def _validate_signatures_in_log(self):
914
"""See Config.validate_signatures_in_log."""
915
return self._get_user_option('validate_signatures_in_log')
917
def _acceptable_keys(self):
918
"""See Config.acceptable_keys."""
919
return self._get_user_option('acceptable_keys')
921
def _post_commit(self):
922
"""See Config.post_commit."""
923
return self._get_user_option('post_commit')
925
def _string_to_signature_policy(self, signature_string):
926
"""Convert a string to a signing policy."""
927
if signature_string.lower() == 'check-available':
928
return CHECK_IF_POSSIBLE
929
if signature_string.lower() == 'ignore':
931
if signature_string.lower() == 'require':
933
raise errors.BzrError("Invalid signatures policy '%s'"
936
def _string_to_signing_policy(self, signature_string):
937
"""Convert a string to a signing policy."""
938
if signature_string.lower() == 'when-required':
939
return SIGN_WHEN_REQUIRED
940
if signature_string.lower() == 'never':
942
if signature_string.lower() == 'always':
944
raise errors.BzrError("Invalid signing policy '%s'"
947
def _get_alias(self, value):
949
return self._get_parser().get_value("ALIASES",
954
def _get_nickname(self):
955
return self.get_user_option('nickname')
957
def remove_user_option(self, option_name, section_name=None):
958
"""Remove a user option and save the configuration file.
960
:param option_name: The option to be removed.
962
:param section_name: The section the option is defined in, default to
966
parser = self._get_parser()
967
if section_name is None:
970
section = parser[section_name]
972
del section[option_name]
974
raise errors.NoSuchConfigOption(option_name)
975
self._write_config_file()
976
for hook in OldConfigHooks['remove']:
977
hook(self, option_name)
979
def _write_config_file(self):
980
if self.file_name is None:
981
raise AssertionError('We cannot save, self.file_name is None')
982
conf_dir = os.path.dirname(self.file_name)
983
ensure_config_dir_exists(conf_dir)
984
atomic_file = atomicfile.AtomicFile(self.file_name)
985
self._get_parser().write(atomic_file)
988
osutils.copy_ownership_from_path(self.file_name)
989
for hook in OldConfigHooks['save']:
993
class LockableConfig(IniBasedConfig):
994
"""A configuration needing explicit locking for access.
996
If several processes try to write the config file, the accesses need to be
999
Daughter classes should decorate all methods that update a config with the
1000
``@needs_write_lock`` decorator (they call, directly or indirectly, the
1001
``_write_config_file()`` method. These methods (typically ``set_option()``
1002
and variants must reload the config file from disk before calling
1003
``_write_config_file()``), this can be achieved by calling the
1004
``self.reload()`` method. Note that the lock scope should cover both the
1005
reading and the writing of the config file which is why the decorator can't
1006
be applied to ``_write_config_file()`` only.
1008
This should be enough to implement the following logic:
1009
- lock for exclusive write access,
1010
- reload the config file from disk,
1014
This logic guarantees that a writer can update a value without erasing an
1015
update made by another writer.
1020
def __init__(self, file_name):
1021
super(LockableConfig, self).__init__(file_name=file_name)
1022
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
1023
# FIXME: It doesn't matter that we don't provide possible_transports
1024
# below since this is currently used only for local config files ;
1025
# local transports are not shared. But if/when we start using
1026
# LockableConfig for other kind of transports, we will need to reuse
1027
# whatever connection is already established -- vila 20100929
1028
self.transport = transport.get_transport_from_path(self.dir)
1029
self._lock = lockdir.LockDir(self.transport, self.lock_name)
1031
def _create_from_string(self, unicode_bytes, save):
1032
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
1034
# We need to handle the saving here (as opposed to IniBasedConfig)
1035
# to be able to lock
1037
self._write_config_file()
1040
def lock_write(self, token=None):
1041
"""Takes a write lock in the directory containing the config file.
1043
If the directory doesn't exist it is created.
1045
ensure_config_dir_exists(self.dir)
1046
return self._lock.lock_write(token)
1051
def break_lock(self):
1052
self._lock.break_lock()
1055
def remove_user_option(self, option_name, section_name=None):
1056
super(LockableConfig, self).remove_user_option(option_name,
1059
def _write_config_file(self):
1060
if self._lock is None or not self._lock.is_held:
1061
# NB: if the following exception is raised it probably means a
1062
# missing @needs_write_lock decorator on one of the callers.
1063
raise errors.ObjectNotLocked(self)
1064
super(LockableConfig, self)._write_config_file()
1067
class GlobalConfig(LockableConfig):
1068
"""The configuration that should be used for a specific location."""
1071
super(GlobalConfig, self).__init__(file_name=config_filename())
1073
def config_id(self):
1077
def from_string(cls, str_or_unicode, save=False):
1078
"""Create a config object from a string.
1080
:param str_or_unicode: A string representing the file content. This
1081
will be utf-8 encoded.
1083
:param save: Whether the file should be saved upon creation.
1086
conf._create_from_string(str_or_unicode, save)
1089
@deprecated_method(deprecated_in((2, 4, 0)))
1090
def get_editor(self):
1091
return self._get_user_option('editor')
1094
def set_user_option(self, option, value):
1095
"""Save option and its value in the configuration."""
1096
self._set_option(option, value, 'DEFAULT')
1098
def get_aliases(self):
1099
"""Return the aliases section."""
1100
if 'ALIASES' in self._get_parser():
1101
return self._get_parser()['ALIASES']
1106
def set_alias(self, alias_name, alias_command):
1107
"""Save the alias in the configuration."""
1108
self._set_option(alias_name, alias_command, 'ALIASES')
1111
def unset_alias(self, alias_name):
1112
"""Unset an existing alias."""
1114
aliases = self._get_parser().get('ALIASES')
1115
if not aliases or alias_name not in aliases:
1116
raise errors.NoSuchAlias(alias_name)
1117
del aliases[alias_name]
1118
self._write_config_file()
1120
def _set_option(self, option, value, section):
1122
self._get_parser().setdefault(section, {})[option] = value
1123
self._write_config_file()
1124
for hook in OldConfigHooks['set']:
1125
hook(self, option, value)
1127
def _get_sections(self, name=None):
1128
"""See IniBasedConfig._get_sections()."""
1129
parser = self._get_parser()
1130
# We don't give access to options defined outside of any section, we
1131
# used the DEFAULT section by... default.
1132
if name in (None, 'DEFAULT'):
1133
# This could happen for an empty file where the DEFAULT section
1134
# doesn't exist yet. So we force DEFAULT when yielding
1136
if 'DEFAULT' not in parser:
1137
parser['DEFAULT']= {}
1138
yield (name, parser[name], self.config_id())
1141
def remove_user_option(self, option_name, section_name=None):
1142
if section_name is None:
1143
# We need to force the default section.
1144
section_name = 'DEFAULT'
1145
# We need to avoid the LockableConfig implementation or we'll lock
1147
super(LockableConfig, self).remove_user_option(option_name,
1150
def _iter_for_location_by_parts(sections, location):
1151
"""Keep only the sessions matching the specified location.
1153
:param sections: An iterable of section names.
1155
:param location: An url or a local path to match against.
1157
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1158
number of path components in the section name, section is the section
1159
name and extra_path is the difference between location and the section
1162
``location`` will always be a local path and never a 'file://' url but the
1163
section names themselves can be in either form.
1165
location_parts = location.rstrip('/').split('/')
1167
for section in sections:
1168
# location is a local path if possible, so we need to convert 'file://'
1169
# urls in section names to local paths if necessary.
1171
# This also avoids having file:///path be a more exact
1172
# match than '/path'.
1174
# FIXME: This still raises an issue if a user defines both file:///path
1175
# *and* /path. Should we raise an error in this case -- vila 20110505
1177
if section.startswith('file://'):
1178
section_path = urlutils.local_path_from_url(section)
1180
section_path = section
1181
section_parts = section_path.rstrip('/').split('/')
1184
if len(section_parts) > len(location_parts):
1185
# More path components in the section, they can't match
1188
# Rely on zip truncating in length to the length of the shortest
1189
# argument sequence.
1190
names = zip(location_parts, section_parts)
1192
if not fnmatch.fnmatch(name[0], name[1]):
1197
# build the path difference between the section and the location
1198
extra_path = '/'.join(location_parts[len(section_parts):])
1199
yield section, extra_path, len(section_parts)
1202
class LocationConfig(LockableConfig):
1203
"""A configuration object that gives the policy for a location."""
1205
def __init__(self, location):
1206
super(LocationConfig, self).__init__(
1207
file_name=locations_config_filename())
1208
# local file locations are looked up by local path, rather than
1209
# by file url. This is because the config file is a user
1210
# file, and we would rather not expose the user to file urls.
1211
if location.startswith('file://'):
1212
location = urlutils.local_path_from_url(location)
1213
self.location = location
1215
def config_id(self):
1219
def from_string(cls, str_or_unicode, location, save=False):
1220
"""Create a config object from a string.
1222
:param str_or_unicode: A string representing the file content. This will
1225
:param location: The location url to filter the configuration.
1227
:param save: Whether the file should be saved upon creation.
1229
conf = cls(location)
1230
conf._create_from_string(str_or_unicode, save)
1233
def _get_matching_sections(self):
1234
"""Return an ordered list of section names matching this location."""
1235
matches = list(_iter_for_location_by_parts(self._get_parser(),
1237
# put the longest (aka more specific) locations first
1239
key=lambda (section, extra_path, length): (length, section),
1241
for (section, extra_path, length) in matches:
1242
yield section, extra_path
1243
# should we stop looking for parent configs here?
1245
if self._get_parser()[section].as_bool('ignore_parents'):
1250
def _get_sections(self, name=None):
1251
"""See IniBasedConfig._get_sections()."""
1252
# We ignore the name here as the only sections handled are named with
1253
# the location path and we don't expose embedded sections either.
1254
parser = self._get_parser()
1255
for name, extra_path in self._get_matching_sections():
1256
yield (name, parser[name], self.config_id())
1258
def _get_option_policy(self, section, option_name):
1259
"""Return the policy for the given (section, option_name) pair."""
1260
# check for the old 'recurse=False' flag
1262
recurse = self._get_parser()[section].as_bool('recurse')
1266
return POLICY_NORECURSE
1268
policy_key = option_name + ':policy'
1270
policy_name = self._get_parser()[section][policy_key]
1274
return _policy_value[policy_name]
1276
def _set_option_policy(self, section, option_name, option_policy):
1277
"""Set the policy for the given option name in the given section."""
1278
# The old recurse=False option affects all options in the
1279
# section. To handle multiple policies in the section, we
1280
# need to convert it to a policy_norecurse key.
1282
recurse = self._get_parser()[section].as_bool('recurse')
1286
symbol_versioning.warn(
1287
'The recurse option is deprecated as of 0.14. '
1288
'The section "%s" has been converted to use policies.'
1291
del self._get_parser()[section]['recurse']
1293
for key in self._get_parser()[section].keys():
1294
if not key.endswith(':policy'):
1295
self._get_parser()[section][key +
1296
':policy'] = 'norecurse'
1298
policy_key = option_name + ':policy'
1299
policy_name = _policy_name[option_policy]
1300
if policy_name is not None:
1301
self._get_parser()[section][policy_key] = policy_name
1303
if policy_key in self._get_parser()[section]:
1304
del self._get_parser()[section][policy_key]
1307
def set_user_option(self, option, value, store=STORE_LOCATION):
1308
"""Save option and its value in the configuration."""
1309
if store not in [STORE_LOCATION,
1310
STORE_LOCATION_NORECURSE,
1311
STORE_LOCATION_APPENDPATH]:
1312
raise ValueError('bad storage policy %r for %r' %
1315
location = self.location
1316
if location.endswith('/'):
1317
location = location[:-1]
1318
parser = self._get_parser()
1319
if not location in parser and not location + '/' in parser:
1320
parser[location] = {}
1321
elif location + '/' in parser:
1322
location = location + '/'
1323
parser[location][option]=value
1324
# the allowed values of store match the config policies
1325
self._set_option_policy(location, option, store)
1326
self._write_config_file()
1327
for hook in OldConfigHooks['set']:
1328
hook(self, option, value)
1331
class BranchConfig(Config):
1332
"""A configuration object giving the policy for a branch."""
1334
def __init__(self, branch):
1335
super(BranchConfig, self).__init__()
1336
self._location_config = None
1337
self._branch_data_config = None
1338
self._global_config = None
1339
self.branch = branch
1340
self.option_sources = (self._get_location_config,
1341
self._get_branch_data_config,
1342
self._get_global_config)
1344
def config_id(self):
1347
def _get_branch_data_config(self):
1348
if self._branch_data_config is None:
1349
self._branch_data_config = TreeConfig(self.branch)
1350
self._branch_data_config.config_id = self.config_id
1351
return self._branch_data_config
1353
def _get_location_config(self):
1354
if self._location_config is None:
1355
self._location_config = LocationConfig(self.branch.base)
1356
return self._location_config
1358
def _get_global_config(self):
1359
if self._global_config is None:
1360
self._global_config = GlobalConfig()
1361
return self._global_config
1363
def _get_best_value(self, option_name):
1364
"""This returns a user option from local, tree or global config.
1366
They are tried in that order. Use get_safe_value if trusted values
1369
for source in self.option_sources:
1370
value = getattr(source(), option_name)()
1371
if value is not None:
1375
def _get_safe_value(self, option_name):
1376
"""This variant of get_best_value never returns untrusted values.
1378
It does not return values from the branch data, because the branch may
1379
not be controlled by the user.
1381
We may wish to allow locations.conf to control whether branches are
1382
trusted in the future.
1384
for source in (self._get_location_config, self._get_global_config):
1385
value = getattr(source(), option_name)()
1386
if value is not None:
1390
def _get_user_id(self):
1391
"""Return the full user id for the branch.
1393
e.g. "John Hacker <jhacker@example.com>"
1394
This is looked up in the email controlfile for the branch.
1397
return (self.branch._transport.get_bytes("email")
1398
.decode(osutils.get_user_encoding())
1400
except (errors.NoSuchFile, errors.PermissionDenied), e:
1403
return self._get_best_value('_get_user_id')
1405
def _get_change_editor(self):
1406
return self._get_best_value('_get_change_editor')
1408
def _get_signature_checking(self):
1409
"""See Config._get_signature_checking."""
1410
return self._get_best_value('_get_signature_checking')
1412
def _get_signing_policy(self):
1413
"""See Config._get_signing_policy."""
1414
return self._get_best_value('_get_signing_policy')
1416
def _get_user_option(self, option_name):
1417
"""See Config._get_user_option."""
1418
for source in self.option_sources:
1419
value = source()._get_user_option(option_name)
1420
if value is not None:
1424
def _get_sections(self, name=None):
1425
"""See IniBasedConfig.get_sections()."""
1426
for source in self.option_sources:
1427
for section in source()._get_sections(name):
1430
def _get_options(self, sections=None):
1432
# First the locations options
1433
for option in self._get_location_config()._get_options():
1435
# Then the branch options
1436
branch_config = self._get_branch_data_config()
1437
if sections is None:
1438
sections = [('DEFAULT', branch_config._get_parser())]
1439
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1440
# Config itself has no notion of sections :( -- vila 20101001
1441
config_id = self.config_id()
1442
for (section_name, section) in sections:
1443
for (name, value) in section.iteritems():
1444
yield (name, value, section_name,
1445
config_id, branch_config._get_parser())
1446
# Then the global options
1447
for option in self._get_global_config()._get_options():
1450
def set_user_option(self, name, value, store=STORE_BRANCH,
1452
if store == STORE_BRANCH:
1453
self._get_branch_data_config().set_option(value, name)
1454
elif store == STORE_GLOBAL:
1455
self._get_global_config().set_user_option(name, value)
1457
self._get_location_config().set_user_option(name, value, store)
1460
if store in (STORE_GLOBAL, STORE_BRANCH):
1461
mask_value = self._get_location_config().get_user_option(name)
1462
if mask_value is not None:
1463
trace.warning('Value "%s" is masked by "%s" from'
1464
' locations.conf', value, mask_value)
1466
if store == STORE_GLOBAL:
1467
branch_config = self._get_branch_data_config()
1468
mask_value = branch_config.get_user_option(name)
1469
if mask_value is not None:
1470
trace.warning('Value "%s" is masked by "%s" from'
1471
' branch.conf', value, mask_value)
1473
def remove_user_option(self, option_name, section_name=None):
1474
self._get_branch_data_config().remove_option(option_name, section_name)
1476
def _gpg_signing_command(self):
1477
"""See Config.gpg_signing_command."""
1478
return self._get_safe_value('_gpg_signing_command')
1480
def _post_commit(self):
1481
"""See Config.post_commit."""
1482
return self._get_safe_value('_post_commit')
1484
def _get_nickname(self):
1485
value = self._get_explicit_nickname()
1486
if value is not None:
1488
return urlutils.unescape(self.branch.base.split('/')[-2])
1490
def has_explicit_nickname(self):
1491
"""Return true if a nickname has been explicitly assigned."""
1492
return self._get_explicit_nickname() is not None
1494
def _get_explicit_nickname(self):
1495
return self._get_best_value('_get_nickname')
1497
def _log_format(self):
1498
"""See Config.log_format."""
1499
return self._get_best_value('_log_format')
1501
def _validate_signatures_in_log(self):
1502
"""See Config.validate_signatures_in_log."""
1503
return self._get_best_value('_validate_signatures_in_log')
1505
def _acceptable_keys(self):
1506
"""See Config.acceptable_keys."""
1507
return self._get_best_value('_acceptable_keys')
1510
def ensure_config_dir_exists(path=None):
1511
"""Make sure a configuration directory exists.
1512
This makes sure that the directory exists.
1513
On windows, since configuration directories are 2 levels deep,
1514
it makes sure both the directory and the parent directory exists.
1518
if not os.path.isdir(path):
1519
if sys.platform == 'win32':
1520
parent_dir = os.path.dirname(path)
1521
if not os.path.isdir(parent_dir):
1522
trace.mutter('creating config parent directory: %r', parent_dir)
1523
os.mkdir(parent_dir)
1524
trace.mutter('creating config directory: %r', path)
1526
osutils.copy_ownership_from_path(path)
1530
"""Return per-user configuration directory.
1532
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1533
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1534
that will be used instead.
1536
TODO: Global option --config-dir to override this.
1538
base = os.environ.get('BZR_HOME', None)
1539
if sys.platform == 'win32':
1540
# environ variables on Windows are in user encoding/mbcs. So decode
1542
if base is not None:
1543
base = base.decode('mbcs')
1545
base = win32utils.get_appdata_location_unicode()
1547
base = os.environ.get('HOME', None)
1548
if base is not None:
1549
base = base.decode('mbcs')
1551
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1553
return osutils.pathjoin(base, 'bazaar', '2.0')
1555
if base is not None:
1556
base = base.decode(osutils._fs_enc)
1557
if sys.platform == 'darwin':
1559
# this takes into account $HOME
1560
base = os.path.expanduser("~")
1561
return osutils.pathjoin(base, '.bazaar')
1564
xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
1566
xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
1567
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1568
if osutils.isdir(xdg_dir):
1570
"Using configuration in XDG directory %s." % xdg_dir)
1572
base = os.path.expanduser("~")
1573
return osutils.pathjoin(base, ".bazaar")
1576
def config_filename():
1577
"""Return per-user configuration ini file filename."""
1578
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1581
def locations_config_filename():
1582
"""Return per-user configuration ini file filename."""
1583
return osutils.pathjoin(config_dir(), 'locations.conf')
1586
def authentication_config_filename():
1587
"""Return per-user authentication ini file filename."""
1588
return osutils.pathjoin(config_dir(), 'authentication.conf')
1591
def user_ignore_config_filename():
1592
"""Return the user default ignore filename"""
1593
return osutils.pathjoin(config_dir(), 'ignore')
1597
"""Return the directory name to store crash files.
1599
This doesn't implicitly create it.
1601
On Windows it's in the config directory; elsewhere it's /var/crash
1602
which may be monitored by apport. It can be overridden by
1605
if sys.platform == 'win32':
1606
return osutils.pathjoin(config_dir(), 'Crash')
1608
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1610
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1613
def xdg_cache_dir():
1614
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1615
# Possibly this should be different on Windows?
1616
e = os.environ.get('XDG_CACHE_DIR', None)
1620
return os.path.expanduser('~/.cache')
1623
def _get_default_mail_domain():
1624
"""If possible, return the assumed default email domain.
1626
:returns: string mail domain, or None.
1628
if sys.platform == 'win32':
1629
# No implementation yet; patches welcome
1632
f = open('/etc/mailname')
1633
except (IOError, OSError), e:
1636
domain = f.read().strip()
1642
def _auto_user_id():
1643
"""Calculate automatic user identification.
1645
:returns: (realname, email), either of which may be None if they can't be
1648
Only used when none is set in the environment or the id file.
1650
This only returns an email address if we can be fairly sure the
1651
address is reasonable, ie if /etc/mailname is set on unix.
1653
This doesn't use the FQDN as the default domain because that may be
1654
slow, and it doesn't use the hostname alone because that's not normally
1655
a reasonable address.
1657
if sys.platform == 'win32':
1658
# No implementation to reliably determine Windows default mail
1659
# address; please add one.
1662
default_mail_domain = _get_default_mail_domain()
1663
if not default_mail_domain:
1669
w = pwd.getpwuid(uid)
1671
trace.mutter('no passwd entry for uid %d?' % uid)
1674
# we try utf-8 first, because on many variants (like Linux),
1675
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1676
# false positives. (many users will have their user encoding set to
1677
# latin-1, which cannot raise UnicodeError.)
1679
gecos = w.pw_gecos.decode('utf-8')
1681
except UnicodeError:
1683
encoding = osutils.get_user_encoding()
1684
gecos = w.pw_gecos.decode(encoding)
1685
except UnicodeError, e:
1686
trace.mutter("cannot decode passwd entry %s" % w)
1689
username = w.pw_name.decode(encoding)
1690
except UnicodeError, e:
1691
trace.mutter("cannot decode passwd entry %s" % w)
1694
comma = gecos.find(',')
1698
realname = gecos[:comma]
1700
return realname, (username + '@' + default_mail_domain)
1703
def parse_username(username):
1704
"""Parse e-mail username and return a (name, address) tuple."""
1705
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1707
return (username, '')
1709
return (match.group(1), match.group(2))
1712
def extract_email_address(e):
1713
"""Return just the address part of an email string.
1715
That is just the user@domain part, nothing else.
1716
This part is required to contain only ascii characters.
1717
If it can't be extracted, raises an error.
1719
>>> extract_email_address('Jane Tester <jane@test.com>')
1722
name, email = parse_username(e)
1724
raise errors.NoEmailInUsername(e)
1728
class TreeConfig(IniBasedConfig):
1729
"""Branch configuration data associated with its contents, not location"""
1731
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1733
def __init__(self, branch):
1734
self._config = branch._get_config()
1735
self.branch = branch
1737
def _get_parser(self, file=None):
1738
if file is not None:
1739
return IniBasedConfig._get_parser(file)
1740
return self._config._get_configobj()
1742
def get_option(self, name, section=None, default=None):
1743
self.branch.lock_read()
1745
return self._config.get_option(name, section, default)
1747
self.branch.unlock()
1749
def set_option(self, value, name, section=None):
1750
"""Set a per-branch configuration option"""
1751
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1752
# higher levels providing the right lock -- vila 20101004
1753
self.branch.lock_write()
1755
self._config.set_option(value, name, section)
1757
self.branch.unlock()
1759
def remove_option(self, option_name, section_name=None):
1760
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1761
# higher levels providing the right lock -- vila 20101004
1762
self.branch.lock_write()
1764
self._config.remove_option(option_name, section_name)
1766
self.branch.unlock()
1769
class AuthenticationConfig(object):
1770
"""The authentication configuration file based on a ini file.
1772
Implements the authentication.conf file described in
1773
doc/developers/authentication-ring.txt.
1776
def __init__(self, _file=None):
1777
self._config = None # The ConfigObj
1779
self._filename = authentication_config_filename()
1780
self._input = self._filename = authentication_config_filename()
1782
# Tests can provide a string as _file
1783
self._filename = None
1786
def _get_config(self):
1787
if self._config is not None:
1790
# FIXME: Should we validate something here ? Includes: empty
1791
# sections are useless, at least one of
1792
# user/password/password_encoding should be defined, etc.
1794
# Note: the encoding below declares that the file itself is utf-8
1795
# encoded, but the values in the ConfigObj are always Unicode.
1796
self._config = ConfigObj(self._input, encoding='utf-8')
1797
except configobj.ConfigObjError, e:
1798
raise errors.ParseConfigError(e.errors, e.config.filename)
1799
except UnicodeError:
1800
raise errors.ConfigContentError(self._filename)
1804
"""Save the config file, only tests should use it for now."""
1805
conf_dir = os.path.dirname(self._filename)
1806
ensure_config_dir_exists(conf_dir)
1807
f = file(self._filename, 'wb')
1809
self._get_config().write(f)
1813
def _set_option(self, section_name, option_name, value):
1814
"""Set an authentication configuration option"""
1815
conf = self._get_config()
1816
section = conf.get(section_name)
1819
section = conf[section]
1820
section[option_name] = value
1823
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1825
"""Returns the matching credentials from authentication.conf file.
1827
:param scheme: protocol
1829
:param host: the server address
1831
:param port: the associated port (optional)
1833
:param user: login (optional)
1835
:param path: the absolute path on the server (optional)
1837
:param realm: the http authentication realm (optional)
1839
:return: A dict containing the matching credentials or None.
1841
- name: the section name of the credentials in the
1842
authentication.conf file,
1843
- user: can't be different from the provided user if any,
1844
- scheme: the server protocol,
1845
- host: the server address,
1846
- port: the server port (can be None),
1847
- path: the absolute server path (can be None),
1848
- realm: the http specific authentication realm (can be None),
1849
- password: the decoded password, could be None if the credential
1850
defines only the user
1851
- verify_certificates: https specific, True if the server
1852
certificate should be verified, False otherwise.
1855
for auth_def_name, auth_def in self._get_config().items():
1856
if type(auth_def) is not configobj.Section:
1857
raise ValueError("%s defined outside a section" % auth_def_name)
1859
a_scheme, a_host, a_user, a_path = map(
1860
auth_def.get, ['scheme', 'host', 'user', 'path'])
1863
a_port = auth_def.as_int('port')
1867
raise ValueError("'port' not numeric in %s" % auth_def_name)
1869
a_verify_certificates = auth_def.as_bool('verify_certificates')
1871
a_verify_certificates = True
1874
"'verify_certificates' not boolean in %s" % auth_def_name)
1877
if a_scheme is not None and scheme != a_scheme:
1879
if a_host is not None:
1880
if not (host == a_host
1881
or (a_host.startswith('.') and host.endswith(a_host))):
1883
if a_port is not None and port != a_port:
1885
if (a_path is not None and path is not None
1886
and not path.startswith(a_path)):
1888
if (a_user is not None and user is not None
1889
and a_user != user):
1890
# Never contradict the caller about the user to be used
1895
# Prepare a credentials dictionary with additional keys
1896
# for the credential providers
1897
credentials = dict(name=auth_def_name,
1904
password=auth_def.get('password', None),
1905
verify_certificates=a_verify_certificates)
1906
# Decode the password in the credentials (or get one)
1907
self.decode_password(credentials,
1908
auth_def.get('password_encoding', None))
1909
if 'auth' in debug.debug_flags:
1910
trace.mutter("Using authentication section: %r", auth_def_name)
1913
if credentials is None:
1914
# No credentials were found in authentication.conf, try the fallback
1915
# credentials stores.
1916
credentials = credential_store_registry.get_fallback_credentials(
1917
scheme, host, port, user, path, realm)
1921
def set_credentials(self, name, host, user, scheme=None, password=None,
1922
port=None, path=None, verify_certificates=None,
1924
"""Set authentication credentials for a host.
1926
Any existing credentials with matching scheme, host, port and path
1927
will be deleted, regardless of name.
1929
:param name: An arbitrary name to describe this set of credentials.
1930
:param host: Name of the host that accepts these credentials.
1931
:param user: The username portion of these credentials.
1932
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1934
:param password: Password portion of these credentials.
1935
:param port: The IP port on the host that these credentials apply to.
1936
:param path: A filesystem path on the host that these credentials
1938
:param verify_certificates: On https, verify server certificates if
1940
:param realm: The http authentication realm (optional).
1942
values = {'host': host, 'user': user}
1943
if password is not None:
1944
values['password'] = password
1945
if scheme is not None:
1946
values['scheme'] = scheme
1947
if port is not None:
1948
values['port'] = '%d' % port
1949
if path is not None:
1950
values['path'] = path
1951
if verify_certificates is not None:
1952
values['verify_certificates'] = str(verify_certificates)
1953
if realm is not None:
1954
values['realm'] = realm
1955
config = self._get_config()
1957
for section, existing_values in config.items():
1958
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1959
if existing_values.get(key) != values.get(key):
1963
config.update({name: values})
1966
def get_user(self, scheme, host, port=None, realm=None, path=None,
1967
prompt=None, ask=False, default=None):
1968
"""Get a user from authentication file.
1970
:param scheme: protocol
1972
:param host: the server address
1974
:param port: the associated port (optional)
1976
:param realm: the realm sent by the server (optional)
1978
:param path: the absolute path on the server (optional)
1980
:param ask: Ask the user if there is no explicitly configured username
1983
:param default: The username returned if none is defined (optional).
1985
:return: The found user.
1987
credentials = self.get_credentials(scheme, host, port, user=None,
1988
path=path, realm=realm)
1989
if credentials is not None:
1990
user = credentials['user']
1996
# Create a default prompt suitable for most cases
1997
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
1998
# Special handling for optional fields in the prompt
1999
if port is not None:
2000
prompt_host = '%s:%d' % (host, port)
2003
user = ui.ui_factory.get_username(prompt, host=prompt_host)
2008
def get_password(self, scheme, host, user, port=None,
2009
realm=None, path=None, prompt=None):
2010
"""Get a password from authentication file or prompt the user for one.
2012
:param scheme: protocol
2014
:param host: the server address
2016
:param port: the associated port (optional)
2020
:param realm: the realm sent by the server (optional)
2022
:param path: the absolute path on the server (optional)
2024
:return: The found password or the one entered by the user.
2026
credentials = self.get_credentials(scheme, host, port, user, path,
2028
if credentials is not None:
2029
password = credentials['password']
2030
if password is not None and scheme is 'ssh':
2031
trace.warning('password ignored in section [%s],'
2032
' use an ssh agent instead'
2033
% credentials['name'])
2037
# Prompt user only if we could't find a password
2038
if password is None:
2040
# Create a default prompt suitable for most cases
2041
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
2042
# Special handling for optional fields in the prompt
2043
if port is not None:
2044
prompt_host = '%s:%d' % (host, port)
2047
password = ui.ui_factory.get_password(prompt,
2048
host=prompt_host, user=user)
2051
def decode_password(self, credentials, encoding):
2053
cs = credential_store_registry.get_credential_store(encoding)
2055
raise ValueError('%r is not a known password_encoding' % encoding)
2056
credentials['password'] = cs.decode_password(credentials)
2060
class CredentialStoreRegistry(registry.Registry):
2061
"""A class that registers credential stores.
2063
A credential store provides access to credentials via the password_encoding
2064
field in authentication.conf sections.
2066
Except for stores provided by bzr itself, most stores are expected to be
2067
provided by plugins that will therefore use
2068
register_lazy(password_encoding, module_name, member_name, help=help,
2069
fallback=fallback) to install themselves.
2071
A fallback credential store is one that is queried if no credentials can be
2072
found via authentication.conf.
2075
def get_credential_store(self, encoding=None):
2076
cs = self.get(encoding)
2081
def is_fallback(self, name):
2082
"""Check if the named credentials store should be used as fallback."""
2083
return self.get_info(name)
2085
def get_fallback_credentials(self, scheme, host, port=None, user=None,
2086
path=None, realm=None):
2087
"""Request credentials from all fallback credentials stores.
2089
The first credentials store that can provide credentials wins.
2092
for name in self.keys():
2093
if not self.is_fallback(name):
2095
cs = self.get_credential_store(name)
2096
credentials = cs.get_credentials(scheme, host, port, user,
2098
if credentials is not None:
2099
# We found some credentials
2103
def register(self, key, obj, help=None, override_existing=False,
2105
"""Register a new object to a name.
2107
:param key: This is the key to use to request the object later.
2108
:param obj: The object to register.
2109
:param help: Help text for this entry. This may be a string or
2110
a callable. If it is a callable, it should take two
2111
parameters (registry, key): this registry and the key that
2112
the help was registered under.
2113
:param override_existing: Raise KeyErorr if False and something has
2114
already been registered for that key. If True, ignore if there
2115
is an existing key (always register the new value).
2116
:param fallback: Whether this credential store should be
2119
return super(CredentialStoreRegistry,
2120
self).register(key, obj, help, info=fallback,
2121
override_existing=override_existing)
2123
def register_lazy(self, key, module_name, member_name,
2124
help=None, override_existing=False,
2126
"""Register a new credential store to be loaded on request.
2128
:param module_name: The python path to the module. Such as 'os.path'.
2129
:param member_name: The member of the module to return. If empty or
2130
None, get() will return the module itself.
2131
:param help: Help text for this entry. This may be a string or
2133
:param override_existing: If True, replace the existing object
2134
with the new one. If False, if there is already something
2135
registered with the same key, raise a KeyError
2136
:param fallback: Whether this credential store should be
2139
return super(CredentialStoreRegistry, self).register_lazy(
2140
key, module_name, member_name, help,
2141
info=fallback, override_existing=override_existing)
2144
credential_store_registry = CredentialStoreRegistry()
2147
class CredentialStore(object):
2148
"""An abstract class to implement storage for credentials"""
2150
def decode_password(self, credentials):
2151
"""Returns a clear text password for the provided credentials."""
2152
raise NotImplementedError(self.decode_password)
2154
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2156
"""Return the matching credentials from this credential store.
2158
This method is only called on fallback credential stores.
2160
raise NotImplementedError(self.get_credentials)
2164
class PlainTextCredentialStore(CredentialStore):
2165
__doc__ = """Plain text credential store for the authentication.conf file"""
2167
def decode_password(self, credentials):
2168
"""See CredentialStore.decode_password."""
2169
return credentials['password']
2172
credential_store_registry.register('plain', PlainTextCredentialStore,
2173
help=PlainTextCredentialStore.__doc__)
2174
credential_store_registry.default_key = 'plain'
2177
class BzrDirConfig(object):
2179
def __init__(self, bzrdir):
2180
self._bzrdir = bzrdir
2181
self._config = bzrdir._get_config()
2183
def set_default_stack_on(self, value):
2184
"""Set the default stacking location.
2186
It may be set to a location, or None.
2188
This policy affects all branches contained by this bzrdir, except for
2189
those under repositories.
2191
if self._config is None:
2192
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2194
self._config.set_option('', 'default_stack_on')
2196
self._config.set_option(value, 'default_stack_on')
2198
def get_default_stack_on(self):
2199
"""Return the default stacking location.
2201
This will either be a location, or None.
2203
This policy affects all branches contained by this bzrdir, except for
2204
those under repositories.
2206
if self._config is None:
2208
value = self._config.get_option('default_stack_on')
2214
class TransportConfig(object):
2215
"""A Config that reads/writes a config file on a Transport.
2217
It is a low-level object that considers config data to be name/value pairs
2218
that may be associated with a section. Assigning meaning to these values
2219
is done at higher levels like TreeConfig.
2222
def __init__(self, transport, filename):
2223
self._transport = transport
2224
self._filename = filename
2226
def get_option(self, name, section=None, default=None):
2227
"""Return the value associated with a named option.
2229
:param name: The name of the value
2230
:param section: The section the option is in (if any)
2231
:param default: The value to return if the value is not set
2232
:return: The value or default value
2234
configobj = self._get_configobj()
2236
section_obj = configobj
2239
section_obj = configobj[section]
2242
value = section_obj.get(name, default)
2243
for hook in OldConfigHooks['get']:
2244
hook(self, name, value)
2247
def set_option(self, value, name, section=None):
2248
"""Set the value associated with a named option.
2250
:param value: The value to set
2251
:param name: The name of the value to set
2252
:param section: The section the option is in (if any)
2254
configobj = self._get_configobj()
2256
configobj[name] = value
2258
configobj.setdefault(section, {})[name] = value
2259
for hook in OldConfigHooks['set']:
2260
hook(self, name, value)
2261
self._set_configobj(configobj)
2263
def remove_option(self, option_name, section_name=None):
2264
configobj = self._get_configobj()
2265
if section_name is None:
2266
del configobj[option_name]
2268
del configobj[section_name][option_name]
2269
for hook in OldConfigHooks['remove']:
2270
hook(self, option_name)
2271
self._set_configobj(configobj)
2273
def _get_config_file(self):
2275
f = StringIO(self._transport.get_bytes(self._filename))
2276
for hook in OldConfigHooks['load']:
2279
except errors.NoSuchFile:
2281
except errors.PermissionDenied, e:
2282
trace.warning("Permission denied while trying to open "
2283
"configuration file %s.", urlutils.unescape_for_display(
2284
urlutils.join(self._transport.base, self._filename), "utf-8"))
2287
def _external_url(self):
2288
return urlutils.join(self._transport.external_url(), self._filename)
2290
def _get_configobj(self):
2291
f = self._get_config_file()
2294
conf = ConfigObj(f, encoding='utf-8')
2295
except configobj.ConfigObjError, e:
2296
raise errors.ParseConfigError(e.errors, self._external_url())
2297
except UnicodeDecodeError:
2298
raise errors.ConfigContentError(self._external_url())
2303
def _set_configobj(self, configobj):
2304
out_file = StringIO()
2305
configobj.write(out_file)
2307
self._transport.put_file(self._filename, out_file)
2308
for hook in OldConfigHooks['save']:
2312
class Option(object):
2313
"""An option definition.
2315
The option *values* are stored in config files and found in sections.
2317
Here we define various properties about the option itself, its default
2318
value, how to convert it from stores, what to do when invalid values are
2319
encoutered, in which config files it can be stored.
2322
def __init__(self, name, default=None, default_from_env=None,
2324
from_unicode=None, invalid=None):
2325
"""Build an option definition.
2327
:param name: the name used to refer to the option.
2329
:param default: the default value to use when none exist in the config
2330
stores. This is either a string that ``from_unicode`` will convert
2331
into the proper type or a python object that can be stringified (so
2332
only the empty list is supported for example).
2334
:param default_from_env: A list of environment variables which can
2335
provide a default value. 'default' will be used only if none of the
2336
variables specified here are set in the environment.
2338
:param help: a doc string to explain the option to the user.
2340
:param from_unicode: a callable to convert the unicode string
2341
representing the option value in a store. This is not called for
2344
:param invalid: the action to be taken when an invalid value is
2345
encountered in a store. This is called only when from_unicode is
2346
invoked to convert a string and returns None or raise ValueError or
2347
TypeError. Accepted values are: None (ignore invalid values),
2348
'warning' (emit a warning), 'error' (emit an error message and
2351
if default_from_env is None:
2352
default_from_env = []
2354
# Convert the default value to a unicode string so all values are
2355
# strings internally before conversion (via from_unicode) is attempted.
2358
elif isinstance(default, list):
2359
# Only the empty list is supported
2361
raise AssertionError(
2362
'Only empty lists are supported as default values')
2364
elif isinstance(default, (str, unicode, bool, int)):
2365
# Rely on python to convert strings, booleans and integers
2366
self.default = u'%s' % (default,)
2368
# other python objects are not expected
2369
raise AssertionError('%r is not supported as a default value'
2371
self.default_from_env = default_from_env
2373
self.from_unicode = from_unicode
2374
if invalid and invalid not in ('warning', 'error'):
2375
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2376
self.invalid = invalid
2378
def convert_from_unicode(self, unicode_value):
2379
if self.from_unicode is None or unicode_value is None:
2380
# Don't convert or nothing to convert
2381
return unicode_value
2383
converted = self.from_unicode(unicode_value)
2384
except (ValueError, TypeError):
2385
# Invalid values are ignored
2387
if converted is None and self.invalid is not None:
2388
# The conversion failed
2389
if self.invalid == 'warning':
2390
trace.warning('Value "%s" is not valid for "%s"',
2391
unicode_value, self.name)
2392
elif self.invalid == 'error':
2393
raise errors.ConfigOptionValueError(self.name, unicode_value)
2396
def get_default(self):
2398
for var in self.default_from_env:
2400
# If the env variable is defined, its value is the default one
2401
value = os.environ[var]
2406
# Otherwise, fallback to the value defined at registration
2407
value = self.default
2410
def get_help_text(self, additional_see_also=None, plain=True):
2412
from bzrlib import help_topics
2413
result += help_topics._format_see_also(additional_see_also)
2415
result = help_topics.help_as_plain_text(result)
2419
# Predefined converters to get proper values from store
2421
def bool_from_store(unicode_str):
2422
return ui.bool_from_string(unicode_str)
2425
def int_from_store(unicode_str):
2426
return int(unicode_str)
2429
# Use a an empty dict to initialize an empty configobj avoiding all
2430
# parsing and encoding checks
2431
_list_converter_config = configobj.ConfigObj(
2432
{}, encoding='utf-8', list_values=True, interpolation=False)
2435
def list_from_store(unicode_str):
2436
if not isinstance(unicode_str, basestring):
2438
# Now inject our string directly as unicode. All callers got their value
2439
# from configobj, so values that need to be quoted are already properly
2441
_list_converter_config.reset()
2442
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2443
maybe_list = _list_converter_config['list']
2444
# ConfigObj return '' instead of u''. Use 'str' below to catch all cases.
2445
if isinstance(maybe_list, basestring):
2447
# A single value, most probably the user forgot (or didn't care to
2448
# add) the final ','
2451
# The empty string, convert to empty list
2454
# We rely on ConfigObj providing us with a list already
2459
class OptionRegistry(registry.Registry):
2460
"""Register config options by their name.
2462
This overrides ``registry.Registry`` to simplify registration by acquiring
2463
some information from the option object itself.
2466
def register(self, option):
2467
"""Register a new option to its name.
2469
:param option: The option to register. Its name is used as the key.
2471
super(OptionRegistry, self).register(option.name, option,
2474
def register_lazy(self, key, module_name, member_name):
2475
"""Register a new option to be loaded on request.
2477
:param key: the key to request the option later. Since the registration
2478
is lazy, it should be provided and match the option name.
2480
:param module_name: the python path to the module. Such as 'os.path'.
2482
:param member_name: the member of the module to return. If empty or
2483
None, get() will return the module itself.
2485
super(OptionRegistry, self).register_lazy(key,
2486
module_name, member_name)
2488
def get_help(self, key=None):
2489
"""Get the help text associated with the given key"""
2490
option = self.get(key)
2491
the_help = option.help
2492
if callable(the_help):
2493
return the_help(self, key)
2497
option_registry = OptionRegistry()
2500
# Registered options in lexicographical order
2502
option_registry.register(
2503
Option('bzr.workingtree.worth_saving_limit', default=10,
2504
from_unicode=int_from_store, invalid='warning',
2506
How many changes before saving the dirstate.
2508
-1 means that we will never rewrite the dirstate file for only
2509
stat-cache changes. Regardless of this setting, we will always rewrite
2510
the dirstate file if a file is added/removed/renamed/etc. This flag only
2511
affects the behavior of updating the dirstate file after we notice that
2512
a file has been touched.
2514
option_registry.register(
2515
Option('dirstate.fdatasync', default=True,
2516
from_unicode=bool_from_store,
2518
Flush dirstate changes onto physical disk?
2520
If true (default), working tree metadata changes are flushed through the
2521
OS buffers to physical disk. This is somewhat slower, but means data
2522
should not be lost if the machine crashes. See also repository.fdatasync.
2524
option_registry.register(
2525
Option('debug_flags', default=[], from_unicode=list_from_store,
2526
help='Debug flags to activate.'))
2527
option_registry.register(
2528
Option('default_format', default='2a',
2529
help='Format used when creating branches.'))
2530
option_registry.register(
2531
Option('dpush_strict', default=None,
2532
from_unicode=bool_from_store,
2534
The default value for ``dpush --strict``.
2536
If present, defines the ``--strict`` option default value for checking
2537
uncommitted changes before pushing into a different VCS without any
2538
custom bzr metadata.
2540
option_registry.register(
2542
help='The command called to launch an editor to enter a message.'))
2543
option_registry.register(
2544
Option('ignore_missing_extensions', default=False,
2545
from_unicode=bool_from_store,
2547
Control the missing extensions warning display.
2549
The warning will not be emitted if set to True.
2551
option_registry.register(
2553
help='Language to translate messages into.'))
2554
option_registry.register(
2555
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2557
Steal locks that appears to be dead.
2559
If set to True, bzr will check if a lock is supposed to be held by an
2560
active process from the same user on the same machine. If the user and
2561
machine match, but no process with the given PID is active, then bzr
2562
will automatically break the stale lock, and create a new lock for
2564
Otherwise, bzr will prompt as normal to break the lock.
2566
option_registry.register(
2567
Option('output_encoding',
2568
help= 'Unicode encoding for output'
2569
' (terminal encoding if not specified).'))
2570
option_registry.register(
2571
Option('push_strict', default=None,
2572
from_unicode=bool_from_store,
2574
The default value for ``push --strict``.
2576
If present, defines the ``--strict`` option default value for checking
2577
uncommitted changes before sending a merge directive.
2579
option_registry.register(
2580
Option('repository.fdatasync', default=True,
2581
from_unicode=bool_from_store,
2583
Flush repository changes onto physical disk?
2585
If true (default), repository changes are flushed through the OS buffers
2586
to physical disk. This is somewhat slower, but means data should not be
2587
lost if the machine crashes. See also dirstate.fdatasync.
2589
option_registry.register(
2590
Option('send_strict', default=None,
2591
from_unicode=bool_from_store,
2593
The default value for ``send --strict``.
2595
If present, defines the ``--strict`` option default value for checking
2596
uncommitted changes before pushing.
2600
class Section(object):
2601
"""A section defines a dict of option name => value.
2603
This is merely a read-only dict which can add some knowledge about the
2604
options. It is *not* a python dict object though and doesn't try to mimic
2608
def __init__(self, section_id, options):
2609
self.id = section_id
2610
# We re-use the dict-like object received
2611
self.options = options
2613
def get(self, name, default=None):
2614
return self.options.get(name, default)
2617
# Mostly for debugging use
2618
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2621
_NewlyCreatedOption = object()
2622
"""Was the option created during the MutableSection lifetime"""
2625
class MutableSection(Section):
2626
"""A section allowing changes and keeping track of the original values."""
2628
def __init__(self, section_id, options):
2629
super(MutableSection, self).__init__(section_id, options)
2632
def set(self, name, value):
2633
if name not in self.options:
2634
# This is a new option
2635
self.orig[name] = _NewlyCreatedOption
2636
elif name not in self.orig:
2637
self.orig[name] = self.get(name, None)
2638
self.options[name] = value
2640
def remove(self, name):
2641
if name not in self.orig:
2642
self.orig[name] = self.get(name, None)
2643
del self.options[name]
2646
class Store(object):
2647
"""Abstract interface to persistent storage for configuration options."""
2649
readonly_section_class = Section
2650
mutable_section_class = MutableSection
2652
def is_loaded(self):
2653
"""Returns True if the Store has been loaded.
2655
This is used to implement lazy loading and ensure the persistent
2656
storage is queried only when needed.
2658
raise NotImplementedError(self.is_loaded)
2661
"""Loads the Store from persistent storage."""
2662
raise NotImplementedError(self.load)
2664
def _load_from_string(self, bytes):
2665
"""Create a store from a string in configobj syntax.
2667
:param bytes: A string representing the file content.
2669
raise NotImplementedError(self._load_from_string)
2672
"""Unloads the Store.
2674
This should make is_loaded() return False. This is used when the caller
2675
knows that the persistent storage has changed or may have change since
2678
raise NotImplementedError(self.unload)
2681
"""Saves the Store to persistent storage."""
2682
raise NotImplementedError(self.save)
2684
def external_url(self):
2685
raise NotImplementedError(self.external_url)
2687
def get_sections(self):
2688
"""Returns an ordered iterable of existing sections.
2690
:returns: An iterable of (name, dict).
2692
raise NotImplementedError(self.get_sections)
2694
def get_mutable_section(self, section_name=None):
2695
"""Returns the specified mutable section.
2697
:param section_name: The section identifier
2699
raise NotImplementedError(self.get_mutable_section)
2702
# Mostly for debugging use
2703
return "<config.%s(%s)>" % (self.__class__.__name__,
2704
self.external_url())
2707
class IniFileStore(Store):
2708
"""A config Store using ConfigObj for storage.
2710
:ivar transport: The transport object where the config file is located.
2712
:ivar file_name: The config file basename in the transport directory.
2714
:ivar _config_obj: Private member to hold the ConfigObj instance used to
2715
serialize/deserialize the config file.
2718
def __init__(self, transport, file_name):
2719
"""A config Store using ConfigObj for storage.
2721
:param transport: The transport object where the config file is located.
2723
:param file_name: The config file basename in the transport directory.
2725
super(IniFileStore, self).__init__()
2726
self.transport = transport
2727
self.file_name = file_name
2728
self._config_obj = None
2730
def is_loaded(self):
2731
return self._config_obj != None
2734
self._config_obj = None
2737
"""Load the store from the associated file."""
2738
if self.is_loaded():
2741
content = self.transport.get_bytes(self.file_name)
2742
except errors.PermissionDenied:
2743
trace.warning("Permission denied while trying to load "
2744
"configuration store %s.", self.external_url())
2746
self._load_from_string(content)
2747
for hook in ConfigHooks['load']:
2750
def _load_from_string(self, bytes):
2751
"""Create a config store from a string.
2753
:param bytes: A string representing the file content.
2755
if self.is_loaded():
2756
raise AssertionError('Already loaded: %r' % (self._config_obj,))
2757
co_input = StringIO(bytes)
2759
# The config files are always stored utf8-encoded
2760
self._config_obj = ConfigObj(co_input, encoding='utf-8',
2762
except configobj.ConfigObjError, e:
2763
self._config_obj = None
2764
raise errors.ParseConfigError(e.errors, self.external_url())
2765
except UnicodeDecodeError:
2766
raise errors.ConfigContentError(self.external_url())
2769
if not self.is_loaded():
2773
self._config_obj.write(out)
2774
self.transport.put_bytes(self.file_name, out.getvalue())
2775
for hook in ConfigHooks['save']:
2778
def external_url(self):
2779
# FIXME: external_url should really accepts an optional relpath
2780
# parameter (bug #750169) :-/ -- vila 2011-04-04
2781
# The following will do in the interim but maybe we don't want to
2782
# expose a path here but rather a config ID and its associated
2783
# object </hand wawe>.
2784
return urlutils.join(self.transport.external_url(), self.file_name)
2786
def get_sections(self):
2787
"""Get the configobj section in the file order.
2789
:returns: An iterable of (name, dict).
2791
# We need a loaded store
2794
except (errors.NoSuchFile, errors.PermissionDenied):
2795
# If the file can't be read, there is no sections
2797
cobj = self._config_obj
2799
yield self.readonly_section_class(None, cobj)
2800
for section_name in cobj.sections:
2801
yield self.readonly_section_class(section_name, cobj[section_name])
2803
def get_mutable_section(self, section_name=None):
2804
# We need a loaded store
2807
except errors.NoSuchFile:
2808
# The file doesn't exist, let's pretend it was empty
2809
self._load_from_string('')
2810
if section_name is None:
2811
section = self._config_obj
2813
section = self._config_obj.setdefault(section_name, {})
2814
return self.mutable_section_class(section_name, section)
2817
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
2818
# unlockable stores for use with objects that can already ensure the locking
2819
# (think branches). If different stores (not based on ConfigObj) are created,
2820
# they may face the same issue.
2823
class LockableIniFileStore(IniFileStore):
2824
"""A ConfigObjStore using locks on save to ensure store integrity."""
2826
def __init__(self, transport, file_name, lock_dir_name=None):
2827
"""A config Store using ConfigObj for storage.
2829
:param transport: The transport object where the config file is located.
2831
:param file_name: The config file basename in the transport directory.
2833
if lock_dir_name is None:
2834
lock_dir_name = 'lock'
2835
self.lock_dir_name = lock_dir_name
2836
super(LockableIniFileStore, self).__init__(transport, file_name)
2837
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
2839
def lock_write(self, token=None):
2840
"""Takes a write lock in the directory containing the config file.
2842
If the directory doesn't exist it is created.
2844
# FIXME: This doesn't check the ownership of the created directories as
2845
# ensure_config_dir_exists does. It should if the transport is local
2846
# -- vila 2011-04-06
2847
self.transport.create_prefix()
2848
return self._lock.lock_write(token)
2853
def break_lock(self):
2854
self._lock.break_lock()
2858
# We need to be able to override the undecorated implementation
2859
self.save_without_locking()
2861
def save_without_locking(self):
2862
super(LockableIniFileStore, self).save()
2865
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
2866
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
2867
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
2869
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
2870
# functions or a registry will make it easier and clearer for tests, focusing
2871
# on the relevant parts of the API that needs testing -- vila 20110503 (based
2872
# on a poolie's remark)
2873
class GlobalStore(LockableIniFileStore):
2875
def __init__(self, possible_transports=None):
2876
t = transport.get_transport_from_path(
2877
config_dir(), possible_transports=possible_transports)
2878
super(GlobalStore, self).__init__(t, 'bazaar.conf')
2881
class LocationStore(LockableIniFileStore):
2883
def __init__(self, possible_transports=None):
2884
t = transport.get_transport_from_path(
2885
config_dir(), possible_transports=possible_transports)
2886
super(LocationStore, self).__init__(t, 'locations.conf')
2889
class BranchStore(IniFileStore):
2891
def __init__(self, branch):
2892
super(BranchStore, self).__init__(branch.control_transport,
2894
self.branch = branch
2896
def lock_write(self, token=None):
2897
return self.branch.lock_write(token)
2900
return self.branch.unlock()
2904
# We need to be able to override the undecorated implementation
2905
self.save_without_locking()
2907
def save_without_locking(self):
2908
super(BranchStore, self).save()
2911
class ControlStore(LockableIniFileStore):
2913
def __init__(self, bzrdir):
2914
super(ControlStore, self).__init__(bzrdir.transport,
2916
lock_dir_name='branch_lock')
2919
class SectionMatcher(object):
2920
"""Select sections into a given Store.
2922
This is intended to be used to postpone getting an iterable of sections
2926
def __init__(self, store):
2929
def get_sections(self):
2930
# This is where we require loading the store so we can see all defined
2932
sections = self.store.get_sections()
2933
# Walk the revisions in the order provided
2938
def match(self, section):
2939
"""Does the proposed section match.
2941
:param section: A Section object.
2943
:returns: True if the section matches, False otherwise.
2945
raise NotImplementedError(self.match)
2948
class NameMatcher(SectionMatcher):
2950
def __init__(self, store, section_id):
2951
super(NameMatcher, self).__init__(store)
2952
self.section_id = section_id
2954
def match(self, section):
2955
return section.id == self.section_id
2958
class LocationSection(Section):
2960
def __init__(self, section, length, extra_path):
2961
super(LocationSection, self).__init__(section.id, section.options)
2962
self.length = length
2963
self.extra_path = extra_path
2965
def get(self, name, default=None):
2966
value = super(LocationSection, self).get(name, default)
2967
if value is not None:
2968
policy_name = self.get(name + ':policy', None)
2969
policy = _policy_value.get(policy_name, POLICY_NONE)
2970
if policy == POLICY_APPENDPATH:
2971
value = urlutils.join(value, self.extra_path)
2975
class LocationMatcher(SectionMatcher):
2977
def __init__(self, store, location):
2978
super(LocationMatcher, self).__init__(store)
2979
if location.startswith('file://'):
2980
location = urlutils.local_path_from_url(location)
2981
self.location = location
2983
def _get_matching_sections(self):
2984
"""Get all sections matching ``location``."""
2985
# We slightly diverge from LocalConfig here by allowing the no-name
2986
# section as the most generic one and the lower priority.
2987
no_name_section = None
2989
# Filter out the no_name_section so _iter_for_location_by_parts can be
2990
# used (it assumes all sections have a name).
2991
for section in self.store.get_sections():
2992
if section.id is None:
2993
no_name_section = section
2995
all_sections.append(section)
2996
# Unfortunately _iter_for_location_by_parts deals with section names so
2997
# we have to resync.
2998
filtered_sections = _iter_for_location_by_parts(
2999
[s.id for s in all_sections], self.location)
3000
iter_all_sections = iter(all_sections)
3001
matching_sections = []
3002
if no_name_section is not None:
3003
matching_sections.append(
3004
LocationSection(no_name_section, 0, self.location))
3005
for section_id, extra_path, length in filtered_sections:
3006
# a section id is unique for a given store so it's safe to take the
3007
# first matching section while iterating. Also, all filtered
3008
# sections are part of 'all_sections' and will always be found
3011
section = iter_all_sections.next()
3012
if section_id == section.id:
3013
matching_sections.append(
3014
LocationSection(section, length, extra_path))
3016
return matching_sections
3018
def get_sections(self):
3019
# Override the default implementation as we want to change the order
3020
matching_sections = self._get_matching_sections()
3021
# We want the longest (aka more specific) locations first
3022
sections = sorted(matching_sections,
3023
key=lambda section: (section.length, section.id),
3025
# Sections mentioning 'ignore_parents' restrict the selection
3026
for section in sections:
3027
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3028
ignore = section.get('ignore_parents', None)
3029
if ignore is not None:
3030
ignore = ui.bool_from_string(ignore)
3033
# Finally, we have a valid section
3037
class Stack(object):
3038
"""A stack of configurations where an option can be defined"""
3040
_option_ref_re = lazy_regex.lazy_compile('({[^{}]+})')
3041
"""Describes an exandable option reference.
3043
We want to match the most embedded reference first.
3045
I.e. for '{{foo}}' we will get '{foo}',
3046
for '{bar{baz}}' we will get '{baz}'
3049
def __init__(self, sections_def, store=None, mutable_section_name=None):
3050
"""Creates a stack of sections with an optional store for changes.
3052
:param sections_def: A list of Section or callables that returns an
3053
iterable of Section. This defines the Sections for the Stack and
3054
can be called repeatedly if needed.
3056
:param store: The optional Store where modifications will be
3057
recorded. If none is specified, no modifications can be done.
3059
:param mutable_section_name: The name of the MutableSection where
3060
changes are recorded. This requires the ``store`` parameter to be
3063
self.sections_def = sections_def
3065
self.mutable_section_name = mutable_section_name
3067
def get(self, name, expand=None):
3068
"""Return the *first* option value found in the sections.
3070
This is where we guarantee that sections coming from Store are loaded
3071
lazily: the loading is delayed until we need to either check that an
3072
option exists or get its value, which in turn may require to discover
3073
in which sections it can be defined. Both of these (section and option
3074
existence) require loading the store (even partially).
3076
:param name: The queried option.
3078
:param expand: Whether options references should be expanded.
3080
:returns: The value of the option.
3082
# FIXME: No caching of options nor sections yet -- vila 20110503
3084
expand = _get_expand_default_value()
3086
# Ensuring lazy loading is achieved by delaying section matching (which
3087
# implies querying the persistent storage) until it can't be avoided
3088
# anymore by using callables to describe (possibly empty) section
3090
for section_or_callable in self.sections_def:
3091
# Each section can expand to multiple ones when a callable is used
3092
if callable(section_or_callable):
3093
sections = section_or_callable()
3095
sections = [section_or_callable]
3096
for section in sections:
3097
value = section.get(name)
3098
if value is not None:
3100
if value is not None:
3102
# If the option is registered, it may provide additional info about
3105
opt = option_registry.get(name)
3109
def expand_and_convert(val):
3110
# This may need to be called twice if the value is None or ends up
3111
# being None during expansion or conversion.
3114
if isinstance(val, basestring):
3115
val = self._expand_options_in_string(val)
3117
trace.warning('Cannot expand "%s":'
3118
' %s does not support option expansion'
3119
% (name, type(val)))
3121
val = opt.convert_from_unicode(val)
3123
value = expand_and_convert(value)
3124
if opt is not None and value is None:
3125
# If the option is registered, it may provide a default value
3126
value = opt.get_default()
3127
value = expand_and_convert(value)
3128
for hook in ConfigHooks['get']:
3129
hook(self, name, value)
3132
def expand_options(self, string, env=None):
3133
"""Expand option references in the string in the configuration context.
3135
:param string: The string containing option(s) to expand.
3137
:param env: An option dict defining additional configuration options or
3138
overriding existing ones.
3140
:returns: The expanded string.
3142
return self._expand_options_in_string(string, env)
3144
def _expand_options_in_string(self, string, env=None, _refs=None):
3145
"""Expand options in the string in the configuration context.
3147
:param string: The string to be expanded.
3149
:param env: An option dict defining additional configuration options or
3150
overriding existing ones.
3152
:param _refs: Private list (FIFO) containing the options being expanded
3155
:returns: The expanded string.
3158
# Not much to expand there
3161
# What references are currently resolved (to detect loops)
3164
# We need to iterate until no more refs appear ({{foo}} will need two
3165
# iterations for example).
3167
raw_chunks = Stack._option_ref_re.split(result)
3168
if len(raw_chunks) == 1:
3169
# Shorcut the trivial case: no refs
3172
# Split will isolate refs so that every other chunk is a ref
3173
chunk_is_ref = False
3174
for chunk in raw_chunks:
3175
if not chunk_is_ref:
3176
chunks.append(chunk)
3181
raise errors.OptionExpansionLoop(string, _refs)
3183
value = self._expand_option(name, env, _refs)
3185
raise errors.ExpandingUnknownOption(name, string)
3186
chunks.append(value)
3188
chunk_is_ref = False
3189
result = ''.join(chunks)
3192
def _expand_option(self, name, env, _refs):
3193
if env is not None and name in env:
3194
# Special case, values provided in env takes precedence over
3198
# FIXME: This is a limited implementation, what we really need is a
3199
# way to query the bzr config for the value of an option,
3200
# respecting the scope rules (That is, once we implement fallback
3201
# configs, getting the option value should restart from the top
3202
# config, not the current one) -- vila 20101222
3203
value = self.get(name, expand=False)
3204
value = self._expand_options_in_string(value, env, _refs)
3207
def _get_mutable_section(self):
3208
"""Get the MutableSection for the Stack.
3210
This is where we guarantee that the mutable section is lazily loaded:
3211
this means we won't load the corresponding store before setting a value
3212
or deleting an option. In practice the store will often be loaded but
3213
this allows helps catching some programming errors.
3215
section = self.store.get_mutable_section(self.mutable_section_name)
3218
def set(self, name, value):
3219
"""Set a new value for the option."""
3220
section = self._get_mutable_section()
3221
section.set(name, value)
3222
for hook in ConfigHooks['set']:
3223
hook(self, name, value)
3225
def remove(self, name):
3226
"""Remove an existing option."""
3227
section = self._get_mutable_section()
3228
section.remove(name)
3229
for hook in ConfigHooks['remove']:
3233
# Mostly for debugging use
3234
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3237
class _CompatibleStack(Stack):
3238
"""Place holder for compatibility with previous design.
3240
This is intended to ease the transition from the Config-based design to the
3241
Stack-based design and should not be used nor relied upon by plugins.
3243
One assumption made here is that the daughter classes will all use Stores
3244
derived from LockableIniFileStore).
3246
It implements set() by re-loading the store before applying the
3247
modification and saving it.
3249
The long term plan being to implement a single write by store to save
3250
all modifications, this class should not be used in the interim.
3253
def set(self, name, value):
3256
super(_CompatibleStack, self).set(name, value)
3257
# Force a write to persistent storage
3261
class GlobalStack(_CompatibleStack):
3262
"""Global options only stack."""
3266
gstore = GlobalStore()
3267
super(GlobalStack, self).__init__([gstore.get_sections], gstore)
3270
class LocationStack(_CompatibleStack):
3271
"""Per-location options falling back to global options stack."""
3273
def __init__(self, location):
3274
"""Make a new stack for a location and global configuration.
3276
:param location: A URL prefix to """
3277
lstore = LocationStore()
3278
matcher = LocationMatcher(lstore, location)
3279
gstore = GlobalStore()
3280
super(LocationStack, self).__init__(
3281
[matcher.get_sections, gstore.get_sections], lstore)
3284
class BranchStack(_CompatibleStack):
3285
"""Per-location options falling back to branch then global options stack."""
3287
def __init__(self, branch):
3288
bstore = BranchStore(branch)
3289
lstore = LocationStore()
3290
matcher = LocationMatcher(lstore, branch.base)
3291
gstore = GlobalStore()
3292
super(BranchStack, self).__init__(
3293
[matcher.get_sections, bstore.get_sections, gstore.get_sections],
3295
self.branch = branch
3298
class RemoteControlStack(_CompatibleStack):
3299
"""Remote control-only options stack."""
3301
def __init__(self, bzrdir):
3302
cstore = ControlStore(bzrdir)
3303
super(RemoteControlStack, self).__init__(
3304
[cstore.get_sections],
3306
self.bzrdir = bzrdir
3309
class RemoteBranchStack(_CompatibleStack):
3310
"""Remote branch-only options stack."""
3312
def __init__(self, branch):
3313
bstore = BranchStore(branch)
3314
super(RemoteBranchStack, self).__init__(
3315
[bstore.get_sections],
3317
self.branch = branch
3320
class cmd_config(commands.Command):
3321
__doc__ = """Display, set or remove a configuration option.
3323
Display the active value for a given option.
3325
If --all is specified, NAME is interpreted as a regular expression and all
3326
matching options are displayed mentioning their scope. The active value
3327
that bzr will take into account is the first one displayed for each option.
3329
If no NAME is given, --all .* is implied.
3331
Setting a value is achieved by using name=value without spaces. The value
3332
is set in the most relevant scope and can be checked by displaying the
3336
takes_args = ['name?']
3340
# FIXME: This should be a registry option so that plugins can register
3341
# their own config files (or not) -- vila 20101002
3342
commands.Option('scope', help='Reduce the scope to the specified'
3343
' configuration file',
3345
commands.Option('all',
3346
help='Display all the defined values for the matching options.',
3348
commands.Option('remove', help='Remove the option from'
3349
' the configuration file'),
3352
_see_also = ['configuration']
3354
@commands.display_command
3355
def run(self, name=None, all=False, directory=None, scope=None,
3357
if directory is None:
3359
directory = urlutils.normalize_url(directory)
3361
raise errors.BzrError(
3362
'--all and --remove are mutually exclusive.')
3364
# Delete the option in the given scope
3365
self._remove_config_option(name, directory, scope)
3367
# Defaults to all options
3368
self._show_matching_options('.*', directory, scope)
3371
name, value = name.split('=', 1)
3373
# Display the option(s) value(s)
3375
self._show_matching_options(name, directory, scope)
3377
self._show_value(name, directory, scope)
3380
raise errors.BzrError(
3381
'Only one option can be set.')
3382
# Set the option value
3383
self._set_config_option(name, value, directory, scope)
3385
def _get_configs(self, directory, scope=None):
3386
"""Iterate the configurations specified by ``directory`` and ``scope``.
3388
:param directory: Where the configurations are derived from.
3390
:param scope: A specific config to start from.
3392
if scope is not None:
3393
if scope == 'bazaar':
3394
yield GlobalConfig()
3395
elif scope == 'locations':
3396
yield LocationConfig(directory)
3397
elif scope == 'branch':
3398
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
3400
yield br.get_config()
3403
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
3405
yield br.get_config()
3406
except errors.NotBranchError:
3407
yield LocationConfig(directory)
3408
yield GlobalConfig()
3410
def _show_value(self, name, directory, scope):
3412
for c in self._get_configs(directory, scope):
3415
for (oname, value, section, conf_id, parser) in c._get_options():
3417
# Display only the first value and exit
3419
# FIXME: We need to use get_user_option to take policies
3420
# into account and we need to make sure the option exists
3421
# too (hence the two for loops), this needs a better API
3423
value = c.get_user_option(name)
3424
# Quote the value appropriately
3425
value = parser._quote(value)
3426
self.outf.write('%s\n' % (value,))
3430
raise errors.NoSuchConfigOption(name)
3432
def _show_matching_options(self, name, directory, scope):
3433
name = lazy_regex.lazy_compile(name)
3434
# We want any error in the regexp to be raised *now* so we need to
3435
# avoid the delay introduced by the lazy regexp. But, we still do
3436
# want the nicer errors raised by lazy_regex.
3437
name._compile_and_collapse()
3440
for c in self._get_configs(directory, scope):
3441
for (oname, value, section, conf_id, parser) in c._get_options():
3442
if name.search(oname):
3443
if cur_conf_id != conf_id:
3444
# Explain where the options are defined
3445
self.outf.write('%s:\n' % (conf_id,))
3446
cur_conf_id = conf_id
3448
if (section not in (None, 'DEFAULT')
3449
and cur_section != section):
3450
# Display the section if it's not the default (or only)
3452
self.outf.write(' [%s]\n' % (section,))
3453
cur_section = section
3454
self.outf.write(' %s = %s\n' % (oname, value))
3456
def _set_config_option(self, name, value, directory, scope):
3457
for conf in self._get_configs(directory, scope):
3458
conf.set_user_option(name, value)
3461
raise errors.NoSuchConfig(scope)
3463
def _remove_config_option(self, name, directory, scope):
3465
raise errors.BzrCommandError(
3466
'--remove expects an option to remove.')
3468
for conf in self._get_configs(directory, scope):
3469
for (section_name, section, conf_id) in conf._get_sections():
3470
if scope is not None and conf_id != scope:
3471
# Not the right configuration file
3474
if conf_id != conf.config_id():
3475
conf = self._get_configs(directory, conf_id).next()
3476
# We use the first section in the first config where the
3477
# option is defined to remove it
3478
conf.remove_user_option(name, section_name)
3483
raise errors.NoSuchConfig(scope)
3485
raise errors.NoSuchConfigOption(name)
3489
# We need adapters that can build a Store or a Stack in a test context. Test
3490
# classes, based on TestCaseWithTransport, can use the registry to parametrize
3491
# themselves. The builder will receive a test instance and should return a
3492
# ready-to-use store or stack. Plugins that define new store/stacks can also
3493
# register themselves here to be tested against the tests defined in
3494
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3495
# for the same tests.
3497
# The registered object should be a callable receiving a test instance
3498
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
3500
test_store_builder_registry = registry.Registry()
3502
# The registered object should be a callable receiving a test instance
3503
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
3505
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
