1
# Copyright (C) 2005-2011 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
"""Configuration that affects the behaviour of Bazaar.
21
Currently this configuration resides in ~/.bazaar/bazaar.conf
22
and ~/.bazaar/locations.conf, which is written to by bzr.
24
In bazaar.conf the following options may be set:
26
editor=name-of-program
27
email=Your Name <your@email.address>
28
check_signatures=require|ignore|check-available(default)
29
create_signatures=always|never|when-required(default)
30
gpg_signing_command=name-of-program
31
log_format=name-of-format
32
validate_signatures_in_log=true|false(default)
33
acceptable_keys=pattern1,pattern2
34
gpg_signing_key=amy@example.com
36
in locations.conf, you specify the url of a branch and options for it.
37
Wildcards may be used - * and ? as normal in shell completion. Options
38
set in both bazaar.conf and locations.conf are overridden by the locations.conf
40
[/home/robertc/source]
41
recurse=False|True(default)
43
check_signatures= as above
44
create_signatures= as above.
45
validate_signatures_in_log=as above
46
acceptable_keys=as above
48
explanation of options
49
----------------------
50
editor - this option sets the pop up editor to use during commits.
51
email - this option sets the user id bzr will use when committing.
52
check_signatures - this option will control whether bzr will require good gpg
53
signatures, ignore them, or check them if they are
54
present. Currently it is unused except that check_signatures
55
turns on create_signatures.
56
create_signatures - this option controls whether bzr will always create
57
gpg signatures or not on commits. There is an unused
58
option which in future is expected to work if
59
branch settings require signatures.
60
log_format - this option sets the default log format. Possible values are
61
long, short, line, or a plugin can register new formats.
62
validate_signatures_in_log - show GPG signature validity in log output
63
acceptable_keys - comma separated list of key patterns acceptable for
64
verify-signatures command
66
In bazaar.conf you can also define aliases in the ALIASES sections, example
69
lastlog=log --line -r-10..-1
70
ll=log --line -r-10..-1
75
from __future__ import absolute_import
81
from bzrlib.decorators import needs_write_lock
82
from bzrlib.lazy_import import lazy_import
83
lazy_import(globals(), """
86
from cStringIO import StringIO
106
from bzrlib.i18n import gettext
107
from bzrlib.util.configobj import configobj
115
from bzrlib.symbol_versioning import (
133
POLICY_APPENDPATH = 2
137
POLICY_NORECURSE: 'norecurse',
138
POLICY_APPENDPATH: 'appendpath',
143
'norecurse': POLICY_NORECURSE,
144
'appendpath': POLICY_APPENDPATH,
148
STORE_LOCATION = POLICY_NONE
149
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
150
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
155
def signature_policy_from_unicode(signature_string):
156
"""Convert a string to a signing policy."""
157
if signature_string.lower() == 'check-available':
158
return CHECK_IF_POSSIBLE
159
if signature_string.lower() == 'ignore':
161
if signature_string.lower() == 'require':
163
raise ValueError("Invalid signatures policy '%s'"
167
def signing_policy_from_unicode(signature_string):
168
"""Convert a string to a signing policy."""
169
if signature_string.lower() == 'when-required':
170
return SIGN_WHEN_REQUIRED
171
if signature_string.lower() == 'never':
173
if signature_string.lower() == 'always':
175
raise ValueError("Invalid signing policy '%s'"
179
class ConfigObj(configobj.ConfigObj):
181
def __init__(self, infile=None, **kwargs):
182
# We define our own interpolation mechanism calling it option expansion
183
super(ConfigObj, self).__init__(infile=infile,
187
def get_bool(self, section, key):
188
return self[section].as_bool(key)
190
def get_value(self, section, name):
191
# Try [] for the old DEFAULT section.
192
if section == "DEFAULT":
197
return self[section][name]
200
# FIXME: Until we can guarantee that each config file is loaded once and
201
# only once for a given bzrlib session, we don't want to re-read the file every
202
# time we query for an option so we cache the value (bad ! watch out for tests
203
# needing to restore the proper value). -- vila 20110219
204
_expand_default_value = None
205
def _get_expand_default_value():
206
global _expand_default_value
207
if _expand_default_value is not None:
208
return _expand_default_value
209
conf = GlobalConfig()
210
# Note that we must not use None for the expand value below or we'll run
211
# into infinite recursion. Using False really would be quite silly ;)
212
expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
214
# This is an opt-in feature, you *really* need to clearly say you want
217
_expand_default_value = expand
221
class Config(object):
222
"""A configuration policy - what username, editor, gpg needs etc."""
225
super(Config, self).__init__()
228
"""Returns a unique ID for the config."""
229
raise NotImplementedError(self.config_id)
231
@deprecated_method(deprecated_in((2, 4, 0)))
232
def get_editor(self):
233
"""Get the users pop up editor."""
234
raise NotImplementedError
236
def get_change_editor(self, old_tree, new_tree):
237
from bzrlib import diff
238
cmd = self._get_change_editor()
241
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree,
244
def get_mail_client(self):
245
"""Get a mail client to use"""
246
selected_client = self.get_user_option('mail_client')
247
_registry = mail_client.mail_client_registry
249
mail_client_class = _registry.get(selected_client)
251
raise errors.UnknownMailClient(selected_client)
252
return mail_client_class(self)
254
def _get_signature_checking(self):
255
"""Template method to override signature checking policy."""
257
def _get_signing_policy(self):
258
"""Template method to override signature creation policy."""
262
def expand_options(self, string, env=None):
263
"""Expand option references in the string in the configuration context.
265
:param string: The string containing option to expand.
267
:param env: An option dict defining additional configuration options or
268
overriding existing ones.
270
:returns: The expanded string.
272
return self._expand_options_in_string(string, env)
274
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
275
"""Expand options in a list of strings in the configuration context.
277
:param slist: A list of strings.
279
:param env: An option dict defining additional configuration options or
280
overriding existing ones.
282
:param _ref_stack: Private list containing the options being
283
expanded to detect loops.
285
:returns: The flatten list of expanded strings.
287
# expand options in each value separately flattening lists
290
value = self._expand_options_in_string(s, env, _ref_stack)
291
if isinstance(value, list):
297
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
298
"""Expand options in the string in the configuration context.
300
:param string: The string to be expanded.
302
:param env: An option dict defining additional configuration options or
303
overriding existing ones.
305
:param _ref_stack: Private list containing the options being
306
expanded to detect loops.
308
:returns: The expanded string.
311
# Not much to expand there
313
if _ref_stack is None:
314
# What references are currently resolved (to detect loops)
316
if self.option_ref_re is None:
317
# We want to match the most embedded reference first (i.e. for
318
# '{{foo}}' we will get '{foo}',
319
# for '{bar{baz}}' we will get '{baz}'
320
self.option_ref_re = re.compile('({[^{}]+})')
322
# We need to iterate until no more refs appear ({{foo}} will need two
323
# iterations for example).
325
raw_chunks = self.option_ref_re.split(result)
326
if len(raw_chunks) == 1:
327
# Shorcut the trivial case: no refs
331
# Split will isolate refs so that every other chunk is a ref
333
for chunk in raw_chunks:
336
# Keep only non-empty strings (or we get bogus empty
337
# slots when a list value is involved).
342
if name in _ref_stack:
343
raise errors.OptionExpansionLoop(string, _ref_stack)
344
_ref_stack.append(name)
345
value = self._expand_option(name, env, _ref_stack)
347
raise errors.ExpandingUnknownOption(name, string)
348
if isinstance(value, list):
356
# Once a list appears as the result of an expansion, all
357
# callers will get a list result. This allows a consistent
358
# behavior even when some options in the expansion chain
359
# defined as strings (no comma in their value) but their
360
# expanded value is a list.
361
return self._expand_options_in_list(chunks, env, _ref_stack)
363
result = ''.join(chunks)
366
def _expand_option(self, name, env, _ref_stack):
367
if env is not None and name in env:
368
# Special case, values provided in env takes precedence over
372
# FIXME: This is a limited implementation, what we really need is a
373
# way to query the bzr config for the value of an option,
374
# respecting the scope rules (That is, once we implement fallback
375
# configs, getting the option value should restart from the top
376
# config, not the current one) -- vila 20101222
377
value = self.get_user_option(name, expand=False)
378
if isinstance(value, list):
379
value = self._expand_options_in_list(value, env, _ref_stack)
381
value = self._expand_options_in_string(value, env, _ref_stack)
384
def _get_user_option(self, option_name):
385
"""Template method to provide a user option."""
388
def get_user_option(self, option_name, expand=None):
389
"""Get a generic option - no special process, no default.
391
:param option_name: The queried option.
393
:param expand: Whether options references should be expanded.
395
:returns: The value of the option.
398
expand = _get_expand_default_value()
399
value = self._get_user_option(option_name)
401
if isinstance(value, list):
402
value = self._expand_options_in_list(value)
403
elif isinstance(value, dict):
404
trace.warning('Cannot expand "%s":'
405
' Dicts do not support option expansion'
408
value = self._expand_options_in_string(value)
409
for hook in OldConfigHooks['get']:
410
hook(self, option_name, value)
413
def get_user_option_as_bool(self, option_name, expand=None, default=None):
414
"""Get a generic option as a boolean.
416
:param expand: Allow expanding references to other config values.
417
:param default: Default value if nothing is configured
418
:return None if the option doesn't exist or its value can't be
419
interpreted as a boolean. Returns True or False otherwise.
421
s = self.get_user_option(option_name, expand=expand)
423
# The option doesn't exist
425
val = ui.bool_from_string(s)
427
# The value can't be interpreted as a boolean
428
trace.warning('Value "%s" is not a boolean for "%s"',
432
def get_user_option_as_list(self, option_name, expand=None):
433
"""Get a generic option as a list - no special process, no default.
435
:return None if the option doesn't exist. Returns the value as a list
438
l = self.get_user_option(option_name, expand=expand)
439
if isinstance(l, (str, unicode)):
440
# A single value, most probably the user forgot (or didn't care to
445
@deprecated_method(deprecated_in((2, 5, 0)))
446
def get_user_option_as_int_from_SI(self, option_name, default=None):
447
"""Get a generic option from a human readable size in SI units, e.g 10MB
449
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
450
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
453
:return Integer, expanded to its base-10 value if a proper SI unit is
454
found. If the option doesn't exist, or isn't a value in
455
SI units, return default (which defaults to None)
457
val = self.get_user_option(option_name)
458
if isinstance(val, list):
463
p = re.compile("^(\d+)([kmg])*b*$", re.IGNORECASE)
467
val = int(m.group(1))
468
if m.group(2) is not None:
469
if m.group(2).lower() == 'k':
471
elif m.group(2).lower() == 'm':
473
elif m.group(2).lower() == 'g':
476
ui.ui_factory.show_warning(gettext('Invalid config value for "{0}" '
477
' value {1!r} is not an SI unit.').format(
484
@deprecated_method(deprecated_in((2, 5, 0)))
485
def gpg_signing_command(self):
486
"""What program should be used to sign signatures?"""
487
result = self._gpg_signing_command()
492
def _gpg_signing_command(self):
493
"""See gpg_signing_command()."""
496
@deprecated_method(deprecated_in((2, 5, 0)))
497
def log_format(self):
498
"""What log format should be used"""
499
result = self._log_format()
504
def _log_format(self):
505
"""See log_format()."""
508
def validate_signatures_in_log(self):
509
"""Show GPG signature validity in log"""
510
result = self._validate_signatures_in_log()
517
def _validate_signatures_in_log(self):
518
"""See validate_signatures_in_log()."""
521
@deprecated_method(deprecated_in((2, 5, 0)))
522
def acceptable_keys(self):
523
"""Comma separated list of key patterns acceptable to
524
verify-signatures command"""
525
result = self._acceptable_keys()
528
def _acceptable_keys(self):
529
"""See acceptable_keys()."""
532
@deprecated_method(deprecated_in((2, 5, 0)))
533
def post_commit(self):
534
"""An ordered list of python functions to call.
536
Each function takes branch, rev_id as parameters.
538
return self._post_commit()
540
def _post_commit(self):
541
"""See Config.post_commit."""
544
def user_email(self):
545
"""Return just the email component of a username."""
546
return extract_email_address(self.username())
549
"""Return email-style username.
551
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
553
$BZR_EMAIL can be set to override this, then
554
the concrete policy type is checked, and finally
556
If no username can be found, errors.NoWhoami exception is raised.
558
v = os.environ.get('BZR_EMAIL')
560
return v.decode(osutils.get_user_encoding())
561
v = self._get_user_id()
564
return default_email()
566
def ensure_username(self):
567
"""Raise errors.NoWhoami if username is not set.
569
This method relies on the username() function raising the error.
573
@deprecated_method(deprecated_in((2, 5, 0)))
574
def signature_checking(self):
575
"""What is the current policy for signature checking?."""
576
policy = self._get_signature_checking()
577
if policy is not None:
579
return CHECK_IF_POSSIBLE
581
@deprecated_method(deprecated_in((2, 5, 0)))
582
def signing_policy(self):
583
"""What is the current policy for signature checking?."""
584
policy = self._get_signing_policy()
585
if policy is not None:
587
return SIGN_WHEN_REQUIRED
589
@deprecated_method(deprecated_in((2, 5, 0)))
590
def signature_needed(self):
591
"""Is a signature needed when committing ?."""
592
policy = self._get_signing_policy()
594
policy = self._get_signature_checking()
595
if policy is not None:
596
#this warning should go away once check_signatures is
597
#implemented (if not before)
598
trace.warning("Please use create_signatures,"
599
" not check_signatures to set signing policy.")
600
elif policy == SIGN_ALWAYS:
604
@deprecated_method(deprecated_in((2, 5, 0)))
605
def gpg_signing_key(self):
606
"""GPG user-id to sign commits"""
607
key = self.get_user_option('gpg_signing_key')
608
if key == "default" or key == None:
609
return self.user_email()
613
def get_alias(self, value):
614
return self._get_alias(value)
616
def _get_alias(self, value):
619
def get_nickname(self):
620
return self._get_nickname()
622
def _get_nickname(self):
625
def get_bzr_remote_path(self):
627
return os.environ['BZR_REMOTE_PATH']
629
path = self.get_user_option("bzr_remote_path")
634
def suppress_warning(self, warning):
635
"""Should the warning be suppressed or emitted.
637
:param warning: The name of the warning being tested.
639
:returns: True if the warning should be suppressed, False otherwise.
641
warnings = self.get_user_option_as_list('suppress_warnings')
642
if warnings is None or warning not in warnings:
647
def get_merge_tools(self):
649
for (oname, value, section, conf_id, parser) in self._get_options():
650
if oname.startswith('bzr.mergetool.'):
651
tool_name = oname[len('bzr.mergetool.'):]
652
tools[tool_name] = self.get_user_option(oname)
653
trace.mutter('loaded merge tools: %r' % tools)
656
def find_merge_tool(self, name):
657
# We fake a defaults mechanism here by checking if the given name can
658
# be found in the known_merge_tools if it's not found in the config.
659
# This should be done through the proposed config defaults mechanism
660
# when it becomes available in the future.
661
command_line = (self.get_user_option('bzr.mergetool.%s' % name,
663
or mergetools.known_merge_tools.get(name, None))
667
class _ConfigHooks(hooks.Hooks):
668
"""A dict mapping hook names and a list of callables for configs.
672
"""Create the default hooks.
674
These are all empty initially, because by default nothing should get
677
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks')
678
self.add_hook('load',
679
'Invoked when a config store is loaded.'
680
' The signature is (store).',
682
self.add_hook('save',
683
'Invoked when a config store is saved.'
684
' The signature is (store).',
686
# The hooks for config options
688
'Invoked when a config option is read.'
689
' The signature is (stack, name, value).',
692
'Invoked when a config option is set.'
693
' The signature is (stack, name, value).',
695
self.add_hook('remove',
696
'Invoked when a config option is removed.'
697
' The signature is (stack, name).',
699
ConfigHooks = _ConfigHooks()
702
class _OldConfigHooks(hooks.Hooks):
703
"""A dict mapping hook names and a list of callables for configs.
707
"""Create the default hooks.
709
These are all empty initially, because by default nothing should get
712
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks')
713
self.add_hook('load',
714
'Invoked when a config store is loaded.'
715
' The signature is (config).',
717
self.add_hook('save',
718
'Invoked when a config store is saved.'
719
' The signature is (config).',
721
# The hooks for config options
723
'Invoked when a config option is read.'
724
' The signature is (config, name, value).',
727
'Invoked when a config option is set.'
728
' The signature is (config, name, value).',
730
self.add_hook('remove',
731
'Invoked when a config option is removed.'
732
' The signature is (config, name).',
734
OldConfigHooks = _OldConfigHooks()
737
class IniBasedConfig(Config):
738
"""A configuration policy that draws from ini files."""
740
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
742
"""Base class for configuration files using an ini-like syntax.
744
:param file_name: The configuration file path.
746
super(IniBasedConfig, self).__init__()
747
self.file_name = file_name
748
if symbol_versioning.deprecated_passed(get_filename):
749
symbol_versioning.warn(
750
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
751
' Use file_name instead.',
754
if get_filename is not None:
755
self.file_name = get_filename()
757
self.file_name = file_name
762
def from_string(cls, str_or_unicode, file_name=None, save=False):
763
"""Create a config object from a string.
765
:param str_or_unicode: A string representing the file content. This will
768
:param file_name: The configuration file path.
770
:param _save: Whether the file should be saved upon creation.
772
conf = cls(file_name=file_name)
773
conf._create_from_string(str_or_unicode, save)
776
def _create_from_string(self, str_or_unicode, save):
777
self._content = StringIO(str_or_unicode.encode('utf-8'))
778
# Some tests use in-memory configs, some other always need the config
779
# file to exist on disk.
781
self._write_config_file()
783
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
784
if self._parser is not None:
786
if symbol_versioning.deprecated_passed(file):
787
symbol_versioning.warn(
788
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
789
' Use IniBasedConfig(_content=xxx) instead.',
792
if self._content is not None:
793
co_input = self._content
794
elif self.file_name is None:
795
raise AssertionError('We have no content to create the config')
797
co_input = self.file_name
799
self._parser = ConfigObj(co_input, encoding='utf-8')
800
except configobj.ConfigObjError, e:
801
raise errors.ParseConfigError(e.errors, e.config.filename)
802
except UnicodeDecodeError:
803
raise errors.ConfigContentError(self.file_name)
804
# Make sure self.reload() will use the right file name
805
self._parser.filename = self.file_name
806
for hook in OldConfigHooks['load']:
811
"""Reload the config file from disk."""
812
if self.file_name is None:
813
raise AssertionError('We need a file name to reload the config')
814
if self._parser is not None:
815
self._parser.reload()
816
for hook in ConfigHooks['load']:
819
def _get_matching_sections(self):
820
"""Return an ordered list of (section_name, extra_path) pairs.
822
If the section contains inherited configuration, extra_path is
823
a string containing the additional path components.
825
section = self._get_section()
826
if section is not None:
827
return [(section, '')]
831
def _get_section(self):
832
"""Override this to define the section used by the config."""
835
def _get_sections(self, name=None):
836
"""Returns an iterator of the sections specified by ``name``.
838
:param name: The section name. If None is supplied, the default
839
configurations are yielded.
841
:return: A tuple (name, section, config_id) for all sections that will
842
be walked by user_get_option() in the 'right' order. The first one
843
is where set_user_option() will update the value.
845
parser = self._get_parser()
847
yield (name, parser[name], self.config_id())
849
# No section name has been given so we fallback to the configobj
850
# itself which holds the variables defined outside of any section.
851
yield (None, parser, self.config_id())
853
def _get_options(self, sections=None):
854
"""Return an ordered list of (name, value, section, config_id) tuples.
856
All options are returned with their associated value and the section
857
they appeared in. ``config_id`` is a unique identifier for the
858
configuration file the option is defined in.
860
:param sections: Default to ``_get_matching_sections`` if not
861
specified. This gives a better control to daughter classes about
862
which sections should be searched. This is a list of (name,
867
parser = self._get_parser()
869
for (section_name, _) in self._get_matching_sections():
871
section = parser[section_name]
873
# This could happen for an empty file for which we define a
874
# DEFAULT section. FIXME: Force callers to provide sections
875
# instead ? -- vila 20100930
877
sections.append((section_name, section))
878
config_id = self.config_id()
879
for (section_name, section) in sections:
880
for (name, value) in section.iteritems():
881
yield (name, parser._quote(value), section_name,
884
def _get_option_policy(self, section, option_name):
885
"""Return the policy for the given (section, option_name) pair."""
888
def _get_change_editor(self):
889
return self.get_user_option('change_editor')
891
def _get_signature_checking(self):
892
"""See Config._get_signature_checking."""
893
policy = self._get_user_option('check_signatures')
895
return signature_policy_from_unicode(policy)
897
def _get_signing_policy(self):
898
"""See Config._get_signing_policy"""
899
policy = self._get_user_option('create_signatures')
901
return signing_policy_from_unicode(policy)
903
def _get_user_id(self):
904
"""Get the user id from the 'email' key in the current section."""
905
return self._get_user_option('email')
907
def _get_user_option(self, option_name):
908
"""See Config._get_user_option."""
909
for (section, extra_path) in self._get_matching_sections():
911
value = self._get_parser().get_value(section, option_name)
914
policy = self._get_option_policy(section, option_name)
915
if policy == POLICY_NONE:
917
elif policy == POLICY_NORECURSE:
918
# norecurse items only apply to the exact path
923
elif policy == POLICY_APPENDPATH:
925
value = urlutils.join(value, extra_path)
928
raise AssertionError('Unexpected config policy %r' % policy)
932
def _gpg_signing_command(self):
933
"""See Config.gpg_signing_command."""
934
return self._get_user_option('gpg_signing_command')
936
def _log_format(self):
937
"""See Config.log_format."""
938
return self._get_user_option('log_format')
940
def _validate_signatures_in_log(self):
941
"""See Config.validate_signatures_in_log."""
942
return self._get_user_option('validate_signatures_in_log')
944
def _acceptable_keys(self):
945
"""See Config.acceptable_keys."""
946
return self._get_user_option('acceptable_keys')
948
def _post_commit(self):
949
"""See Config.post_commit."""
950
return self._get_user_option('post_commit')
952
def _get_alias(self, value):
954
return self._get_parser().get_value("ALIASES",
959
def _get_nickname(self):
960
return self.get_user_option('nickname')
962
def remove_user_option(self, option_name, section_name=None):
963
"""Remove a user option and save the configuration file.
965
:param option_name: The option to be removed.
967
:param section_name: The section the option is defined in, default to
971
parser = self._get_parser()
972
if section_name is None:
975
section = parser[section_name]
977
del section[option_name]
979
raise errors.NoSuchConfigOption(option_name)
980
self._write_config_file()
981
for hook in OldConfigHooks['remove']:
982
hook(self, option_name)
984
def _write_config_file(self):
985
if self.file_name is None:
986
raise AssertionError('We cannot save, self.file_name is None')
987
conf_dir = os.path.dirname(self.file_name)
988
ensure_config_dir_exists(conf_dir)
989
atomic_file = atomicfile.AtomicFile(self.file_name)
990
self._get_parser().write(atomic_file)
993
osutils.copy_ownership_from_path(self.file_name)
994
for hook in OldConfigHooks['save']:
998
class LockableConfig(IniBasedConfig):
999
"""A configuration needing explicit locking for access.
1001
If several processes try to write the config file, the accesses need to be
1004
Daughter classes should decorate all methods that update a config with the
1005
``@needs_write_lock`` decorator (they call, directly or indirectly, the
1006
``_write_config_file()`` method. These methods (typically ``set_option()``
1007
and variants must reload the config file from disk before calling
1008
``_write_config_file()``), this can be achieved by calling the
1009
``self.reload()`` method. Note that the lock scope should cover both the
1010
reading and the writing of the config file which is why the decorator can't
1011
be applied to ``_write_config_file()`` only.
1013
This should be enough to implement the following logic:
1014
- lock for exclusive write access,
1015
- reload the config file from disk,
1019
This logic guarantees that a writer can update a value without erasing an
1020
update made by another writer.
1025
def __init__(self, file_name):
1026
super(LockableConfig, self).__init__(file_name=file_name)
1027
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
1028
# FIXME: It doesn't matter that we don't provide possible_transports
1029
# below since this is currently used only for local config files ;
1030
# local transports are not shared. But if/when we start using
1031
# LockableConfig for other kind of transports, we will need to reuse
1032
# whatever connection is already established -- vila 20100929
1033
self.transport = transport.get_transport_from_path(self.dir)
1034
self._lock = lockdir.LockDir(self.transport, self.lock_name)
1036
def _create_from_string(self, unicode_bytes, save):
1037
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
1039
# We need to handle the saving here (as opposed to IniBasedConfig)
1040
# to be able to lock
1042
self._write_config_file()
1045
def lock_write(self, token=None):
1046
"""Takes a write lock in the directory containing the config file.
1048
If the directory doesn't exist it is created.
1050
ensure_config_dir_exists(self.dir)
1051
return self._lock.lock_write(token)
1056
def break_lock(self):
1057
self._lock.break_lock()
1060
def remove_user_option(self, option_name, section_name=None):
1061
super(LockableConfig, self).remove_user_option(option_name,
1064
def _write_config_file(self):
1065
if self._lock is None or not self._lock.is_held:
1066
# NB: if the following exception is raised it probably means a
1067
# missing @needs_write_lock decorator on one of the callers.
1068
raise errors.ObjectNotLocked(self)
1069
super(LockableConfig, self)._write_config_file()
1072
class GlobalConfig(LockableConfig):
1073
"""The configuration that should be used for a specific location."""
1076
super(GlobalConfig, self).__init__(file_name=config_filename())
1078
def config_id(self):
1082
def from_string(cls, str_or_unicode, save=False):
1083
"""Create a config object from a string.
1085
:param str_or_unicode: A string representing the file content. This
1086
will be utf-8 encoded.
1088
:param save: Whether the file should be saved upon creation.
1091
conf._create_from_string(str_or_unicode, save)
1094
@deprecated_method(deprecated_in((2, 4, 0)))
1095
def get_editor(self):
1096
return self._get_user_option('editor')
1099
def set_user_option(self, option, value):
1100
"""Save option and its value in the configuration."""
1101
self._set_option(option, value, 'DEFAULT')
1103
def get_aliases(self):
1104
"""Return the aliases section."""
1105
if 'ALIASES' in self._get_parser():
1106
return self._get_parser()['ALIASES']
1111
def set_alias(self, alias_name, alias_command):
1112
"""Save the alias in the configuration."""
1113
self._set_option(alias_name, alias_command, 'ALIASES')
1116
def unset_alias(self, alias_name):
1117
"""Unset an existing alias."""
1119
aliases = self._get_parser().get('ALIASES')
1120
if not aliases or alias_name not in aliases:
1121
raise errors.NoSuchAlias(alias_name)
1122
del aliases[alias_name]
1123
self._write_config_file()
1125
def _set_option(self, option, value, section):
1127
self._get_parser().setdefault(section, {})[option] = value
1128
self._write_config_file()
1129
for hook in OldConfigHooks['set']:
1130
hook(self, option, value)
1132
def _get_sections(self, name=None):
1133
"""See IniBasedConfig._get_sections()."""
1134
parser = self._get_parser()
1135
# We don't give access to options defined outside of any section, we
1136
# used the DEFAULT section by... default.
1137
if name in (None, 'DEFAULT'):
1138
# This could happen for an empty file where the DEFAULT section
1139
# doesn't exist yet. So we force DEFAULT when yielding
1141
if 'DEFAULT' not in parser:
1142
parser['DEFAULT']= {}
1143
yield (name, parser[name], self.config_id())
1146
def remove_user_option(self, option_name, section_name=None):
1147
if section_name is None:
1148
# We need to force the default section.
1149
section_name = 'DEFAULT'
1150
# We need to avoid the LockableConfig implementation or we'll lock
1152
super(LockableConfig, self).remove_user_option(option_name,
1155
def _iter_for_location_by_parts(sections, location):
1156
"""Keep only the sessions matching the specified location.
1158
:param sections: An iterable of section names.
1160
:param location: An url or a local path to match against.
1162
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
1163
number of path components in the section name, section is the section
1164
name and extra_path is the difference between location and the section
1167
``location`` will always be a local path and never a 'file://' url but the
1168
section names themselves can be in either form.
1170
location_parts = location.rstrip('/').split('/')
1172
for section in sections:
1173
# location is a local path if possible, so we need to convert 'file://'
1174
# urls in section names to local paths if necessary.
1176
# This also avoids having file:///path be a more exact
1177
# match than '/path'.
1179
# FIXME: This still raises an issue if a user defines both file:///path
1180
# *and* /path. Should we raise an error in this case -- vila 20110505
1182
if section.startswith('file://'):
1183
section_path = urlutils.local_path_from_url(section)
1185
section_path = section
1186
section_parts = section_path.rstrip('/').split('/')
1189
if len(section_parts) > len(location_parts):
1190
# More path components in the section, they can't match
1193
# Rely on zip truncating in length to the length of the shortest
1194
# argument sequence.
1195
names = zip(location_parts, section_parts)
1197
if not fnmatch.fnmatch(name[0], name[1]):
1202
# build the path difference between the section and the location
1203
extra_path = '/'.join(location_parts[len(section_parts):])
1204
yield section, extra_path, len(section_parts)
1207
class LocationConfig(LockableConfig):
1208
"""A configuration object that gives the policy for a location."""
1210
def __init__(self, location):
1211
super(LocationConfig, self).__init__(
1212
file_name=locations_config_filename())
1213
# local file locations are looked up by local path, rather than
1214
# by file url. This is because the config file is a user
1215
# file, and we would rather not expose the user to file urls.
1216
if location.startswith('file://'):
1217
location = urlutils.local_path_from_url(location)
1218
self.location = location
1220
def config_id(self):
1224
def from_string(cls, str_or_unicode, location, save=False):
1225
"""Create a config object from a string.
1227
:param str_or_unicode: A string representing the file content. This will
1230
:param location: The location url to filter the configuration.
1232
:param save: Whether the file should be saved upon creation.
1234
conf = cls(location)
1235
conf._create_from_string(str_or_unicode, save)
1238
def _get_matching_sections(self):
1239
"""Return an ordered list of section names matching this location."""
1240
matches = list(_iter_for_location_by_parts(self._get_parser(),
1242
# put the longest (aka more specific) locations first
1244
key=lambda (section, extra_path, length): (length, section),
1246
for (section, extra_path, length) in matches:
1247
yield section, extra_path
1248
# should we stop looking for parent configs here?
1250
if self._get_parser()[section].as_bool('ignore_parents'):
1255
def _get_sections(self, name=None):
1256
"""See IniBasedConfig._get_sections()."""
1257
# We ignore the name here as the only sections handled are named with
1258
# the location path and we don't expose embedded sections either.
1259
parser = self._get_parser()
1260
for name, extra_path in self._get_matching_sections():
1261
yield (name, parser[name], self.config_id())
1263
def _get_option_policy(self, section, option_name):
1264
"""Return the policy for the given (section, option_name) pair."""
1265
# check for the old 'recurse=False' flag
1267
recurse = self._get_parser()[section].as_bool('recurse')
1271
return POLICY_NORECURSE
1273
policy_key = option_name + ':policy'
1275
policy_name = self._get_parser()[section][policy_key]
1279
return _policy_value[policy_name]
1281
def _set_option_policy(self, section, option_name, option_policy):
1282
"""Set the policy for the given option name in the given section."""
1283
# The old recurse=False option affects all options in the
1284
# section. To handle multiple policies in the section, we
1285
# need to convert it to a policy_norecurse key.
1287
recurse = self._get_parser()[section].as_bool('recurse')
1291
symbol_versioning.warn(
1292
'The recurse option is deprecated as of 0.14. '
1293
'The section "%s" has been converted to use policies.'
1296
del self._get_parser()[section]['recurse']
1298
for key in self._get_parser()[section].keys():
1299
if not key.endswith(':policy'):
1300
self._get_parser()[section][key +
1301
':policy'] = 'norecurse'
1303
policy_key = option_name + ':policy'
1304
policy_name = _policy_name[option_policy]
1305
if policy_name is not None:
1306
self._get_parser()[section][policy_key] = policy_name
1308
if policy_key in self._get_parser()[section]:
1309
del self._get_parser()[section][policy_key]
1312
def set_user_option(self, option, value, store=STORE_LOCATION):
1313
"""Save option and its value in the configuration."""
1314
if store not in [STORE_LOCATION,
1315
STORE_LOCATION_NORECURSE,
1316
STORE_LOCATION_APPENDPATH]:
1317
raise ValueError('bad storage policy %r for %r' %
1320
location = self.location
1321
if location.endswith('/'):
1322
location = location[:-1]
1323
parser = self._get_parser()
1324
if not location in parser and not location + '/' in parser:
1325
parser[location] = {}
1326
elif location + '/' in parser:
1327
location = location + '/'
1328
parser[location][option]=value
1329
# the allowed values of store match the config policies
1330
self._set_option_policy(location, option, store)
1331
self._write_config_file()
1332
for hook in OldConfigHooks['set']:
1333
hook(self, option, value)
1336
class BranchConfig(Config):
1337
"""A configuration object giving the policy for a branch."""
1339
def __init__(self, branch):
1340
super(BranchConfig, self).__init__()
1341
self._location_config = None
1342
self._branch_data_config = None
1343
self._global_config = None
1344
self.branch = branch
1345
self.option_sources = (self._get_location_config,
1346
self._get_branch_data_config,
1347
self._get_global_config)
1349
def config_id(self):
1352
def _get_branch_data_config(self):
1353
if self._branch_data_config is None:
1354
self._branch_data_config = TreeConfig(self.branch)
1355
self._branch_data_config.config_id = self.config_id
1356
return self._branch_data_config
1358
def _get_location_config(self):
1359
if self._location_config is None:
1360
self._location_config = LocationConfig(self.branch.base)
1361
return self._location_config
1363
def _get_global_config(self):
1364
if self._global_config is None:
1365
self._global_config = GlobalConfig()
1366
return self._global_config
1368
def _get_best_value(self, option_name):
1369
"""This returns a user option from local, tree or global config.
1371
They are tried in that order. Use get_safe_value if trusted values
1374
for source in self.option_sources:
1375
value = getattr(source(), option_name)()
1376
if value is not None:
1380
def _get_safe_value(self, option_name):
1381
"""This variant of get_best_value never returns untrusted values.
1383
It does not return values from the branch data, because the branch may
1384
not be controlled by the user.
1386
We may wish to allow locations.conf to control whether branches are
1387
trusted in the future.
1389
for source in (self._get_location_config, self._get_global_config):
1390
value = getattr(source(), option_name)()
1391
if value is not None:
1395
def _get_user_id(self):
1396
"""Return the full user id for the branch.
1398
e.g. "John Hacker <jhacker@example.com>"
1399
This is looked up in the email controlfile for the branch.
1401
return self._get_best_value('_get_user_id')
1403
def _get_change_editor(self):
1404
return self._get_best_value('_get_change_editor')
1406
def _get_signature_checking(self):
1407
"""See Config._get_signature_checking."""
1408
return self._get_best_value('_get_signature_checking')
1410
def _get_signing_policy(self):
1411
"""See Config._get_signing_policy."""
1412
return self._get_best_value('_get_signing_policy')
1414
def _get_user_option(self, option_name):
1415
"""See Config._get_user_option."""
1416
for source in self.option_sources:
1417
value = source()._get_user_option(option_name)
1418
if value is not None:
1422
def _get_sections(self, name=None):
1423
"""See IniBasedConfig.get_sections()."""
1424
for source in self.option_sources:
1425
for section in source()._get_sections(name):
1428
def _get_options(self, sections=None):
1430
# First the locations options
1431
for option in self._get_location_config()._get_options():
1433
# Then the branch options
1434
branch_config = self._get_branch_data_config()
1435
if sections is None:
1436
sections = [('DEFAULT', branch_config._get_parser())]
1437
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1438
# Config itself has no notion of sections :( -- vila 20101001
1439
config_id = self.config_id()
1440
for (section_name, section) in sections:
1441
for (name, value) in section.iteritems():
1442
yield (name, value, section_name,
1443
config_id, branch_config._get_parser())
1444
# Then the global options
1445
for option in self._get_global_config()._get_options():
1448
def set_user_option(self, name, value, store=STORE_BRANCH,
1450
if store == STORE_BRANCH:
1451
self._get_branch_data_config().set_option(value, name)
1452
elif store == STORE_GLOBAL:
1453
self._get_global_config().set_user_option(name, value)
1455
self._get_location_config().set_user_option(name, value, store)
1458
if store in (STORE_GLOBAL, STORE_BRANCH):
1459
mask_value = self._get_location_config().get_user_option(name)
1460
if mask_value is not None:
1461
trace.warning('Value "%s" is masked by "%s" from'
1462
' locations.conf', value, mask_value)
1464
if store == STORE_GLOBAL:
1465
branch_config = self._get_branch_data_config()
1466
mask_value = branch_config.get_user_option(name)
1467
if mask_value is not None:
1468
trace.warning('Value "%s" is masked by "%s" from'
1469
' branch.conf', value, mask_value)
1471
def remove_user_option(self, option_name, section_name=None):
1472
self._get_branch_data_config().remove_option(option_name, section_name)
1474
def _gpg_signing_command(self):
1475
"""See Config.gpg_signing_command."""
1476
return self._get_safe_value('_gpg_signing_command')
1478
def _post_commit(self):
1479
"""See Config.post_commit."""
1480
return self._get_safe_value('_post_commit')
1482
def _get_nickname(self):
1483
value = self._get_explicit_nickname()
1484
if value is not None:
1486
return urlutils.unescape(self.branch.base.split('/')[-2])
1488
def has_explicit_nickname(self):
1489
"""Return true if a nickname has been explicitly assigned."""
1490
return self._get_explicit_nickname() is not None
1492
def _get_explicit_nickname(self):
1493
return self._get_best_value('_get_nickname')
1495
def _log_format(self):
1496
"""See Config.log_format."""
1497
return self._get_best_value('_log_format')
1499
def _validate_signatures_in_log(self):
1500
"""See Config.validate_signatures_in_log."""
1501
return self._get_best_value('_validate_signatures_in_log')
1503
def _acceptable_keys(self):
1504
"""See Config.acceptable_keys."""
1505
return self._get_best_value('_acceptable_keys')
1508
def ensure_config_dir_exists(path=None):
1509
"""Make sure a configuration directory exists.
1510
This makes sure that the directory exists.
1511
On windows, since configuration directories are 2 levels deep,
1512
it makes sure both the directory and the parent directory exists.
1516
if not os.path.isdir(path):
1517
if sys.platform == 'win32':
1518
parent_dir = os.path.dirname(path)
1519
if not os.path.isdir(parent_dir):
1520
trace.mutter('creating config parent directory: %r', parent_dir)
1521
os.mkdir(parent_dir)
1522
trace.mutter('creating config directory: %r', path)
1524
osutils.copy_ownership_from_path(path)
1528
"""Return per-user configuration directory.
1530
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1531
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1532
that will be used instead.
1534
TODO: Global option --config-dir to override this.
1536
base = os.environ.get('BZR_HOME', None)
1537
if sys.platform == 'win32':
1538
# environ variables on Windows are in user encoding/mbcs. So decode
1540
if base is not None:
1541
base = base.decode('mbcs')
1543
base = win32utils.get_appdata_location_unicode()
1545
base = os.environ.get('HOME', None)
1546
if base is not None:
1547
base = base.decode('mbcs')
1549
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1551
return osutils.pathjoin(base, 'bazaar', '2.0')
1553
if base is not None:
1554
base = base.decode(osutils._fs_enc)
1555
if sys.platform == 'darwin':
1557
# this takes into account $HOME
1558
base = os.path.expanduser("~")
1559
return osutils.pathjoin(base, '.bazaar')
1562
xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
1564
xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
1565
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1566
if osutils.isdir(xdg_dir):
1568
"Using configuration in XDG directory %s." % xdg_dir)
1570
base = os.path.expanduser("~")
1571
return osutils.pathjoin(base, ".bazaar")
1574
def config_filename():
1575
"""Return per-user configuration ini file filename."""
1576
return osutils.pathjoin(config_dir(), 'bazaar.conf')
1579
def locations_config_filename():
1580
"""Return per-user configuration ini file filename."""
1581
return osutils.pathjoin(config_dir(), 'locations.conf')
1584
def authentication_config_filename():
1585
"""Return per-user authentication ini file filename."""
1586
return osutils.pathjoin(config_dir(), 'authentication.conf')
1589
def user_ignore_config_filename():
1590
"""Return the user default ignore filename"""
1591
return osutils.pathjoin(config_dir(), 'ignore')
1595
"""Return the directory name to store crash files.
1597
This doesn't implicitly create it.
1599
On Windows it's in the config directory; elsewhere it's /var/crash
1600
which may be monitored by apport. It can be overridden by
1603
if sys.platform == 'win32':
1604
return osutils.pathjoin(config_dir(), 'Crash')
1606
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
1608
return os.environ.get('APPORT_CRASH_DIR', '/var/crash')
1611
def xdg_cache_dir():
1612
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
1613
# Possibly this should be different on Windows?
1614
e = os.environ.get('XDG_CACHE_DIR', None)
1618
return os.path.expanduser('~/.cache')
1621
def _get_default_mail_domain():
1622
"""If possible, return the assumed default email domain.
1624
:returns: string mail domain, or None.
1626
if sys.platform == 'win32':
1627
# No implementation yet; patches welcome
1630
f = open('/etc/mailname')
1631
except (IOError, OSError), e:
1634
domain = f.read().strip()
1640
def default_email():
1641
v = os.environ.get('BZR_EMAIL')
1643
return v.decode(osutils.get_user_encoding())
1644
v = os.environ.get('EMAIL')
1646
return v.decode(osutils.get_user_encoding())
1647
name, email = _auto_user_id()
1649
return u'%s <%s>' % (name, email)
1652
raise errors.NoWhoami()
1655
def email_from_store(unicode_str):
1656
"""Unlike other env vars, BZR_EMAIL takes precedence over config settings.
1658
Whatever comes from a config file is then overridden.
1660
value = os.environ.get('BZR_EMAIL')
1662
return value.decode(osutils.get_user_encoding())
1666
def _auto_user_id():
1667
"""Calculate automatic user identification.
1669
:returns: (realname, email), either of which may be None if they can't be
1672
Only used when none is set in the environment or the id file.
1674
This only returns an email address if we can be fairly sure the
1675
address is reasonable, ie if /etc/mailname is set on unix.
1677
This doesn't use the FQDN as the default domain because that may be
1678
slow, and it doesn't use the hostname alone because that's not normally
1679
a reasonable address.
1681
if sys.platform == 'win32':
1682
# No implementation to reliably determine Windows default mail
1683
# address; please add one.
1686
default_mail_domain = _get_default_mail_domain()
1687
if not default_mail_domain:
1693
w = pwd.getpwuid(uid)
1695
trace.mutter('no passwd entry for uid %d?' % uid)
1698
# we try utf-8 first, because on many variants (like Linux),
1699
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1700
# false positives. (many users will have their user encoding set to
1701
# latin-1, which cannot raise UnicodeError.)
1703
gecos = w.pw_gecos.decode('utf-8')
1705
except UnicodeError:
1707
encoding = osutils.get_user_encoding()
1708
gecos = w.pw_gecos.decode(encoding)
1709
except UnicodeError, e:
1710
trace.mutter("cannot decode passwd entry %s" % w)
1713
username = w.pw_name.decode(encoding)
1714
except UnicodeError, e:
1715
trace.mutter("cannot decode passwd entry %s" % w)
1718
comma = gecos.find(',')
1722
realname = gecos[:comma]
1724
return realname, (username + '@' + default_mail_domain)
1727
def parse_username(username):
1728
"""Parse e-mail username and return a (name, address) tuple."""
1729
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
1731
return (username, '')
1733
return (match.group(1), match.group(2))
1736
def extract_email_address(e):
1737
"""Return just the address part of an email string.
1739
That is just the user@domain part, nothing else.
1740
This part is required to contain only ascii characters.
1741
If it can't be extracted, raises an error.
1743
>>> extract_email_address('Jane Tester <jane@test.com>')
1746
name, email = parse_username(e)
1748
raise errors.NoEmailInUsername(e)
1752
class TreeConfig(IniBasedConfig):
1753
"""Branch configuration data associated with its contents, not location"""
1755
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
1757
def __init__(self, branch):
1758
self._config = branch._get_config()
1759
self.branch = branch
1761
def _get_parser(self, file=None):
1762
if file is not None:
1763
return IniBasedConfig._get_parser(file)
1764
return self._config._get_configobj()
1766
def get_option(self, name, section=None, default=None):
1767
self.branch.lock_read()
1769
return self._config.get_option(name, section, default)
1771
self.branch.unlock()
1773
def set_option(self, value, name, section=None):
1774
"""Set a per-branch configuration option"""
1775
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1776
# higher levels providing the right lock -- vila 20101004
1777
self.branch.lock_write()
1779
self._config.set_option(value, name, section)
1781
self.branch.unlock()
1783
def remove_option(self, option_name, section_name=None):
1784
# FIXME: We shouldn't need to lock explicitly here but rather rely on
1785
# higher levels providing the right lock -- vila 20101004
1786
self.branch.lock_write()
1788
self._config.remove_option(option_name, section_name)
1790
self.branch.unlock()
1793
class AuthenticationConfig(object):
1794
"""The authentication configuration file based on a ini file.
1796
Implements the authentication.conf file described in
1797
doc/developers/authentication-ring.txt.
1800
def __init__(self, _file=None):
1801
self._config = None # The ConfigObj
1803
self._filename = authentication_config_filename()
1804
self._input = self._filename = authentication_config_filename()
1806
# Tests can provide a string as _file
1807
self._filename = None
1810
def _get_config(self):
1811
if self._config is not None:
1814
# FIXME: Should we validate something here ? Includes: empty
1815
# sections are useless, at least one of
1816
# user/password/password_encoding should be defined, etc.
1818
# Note: the encoding below declares that the file itself is utf-8
1819
# encoded, but the values in the ConfigObj are always Unicode.
1820
self._config = ConfigObj(self._input, encoding='utf-8')
1821
except configobj.ConfigObjError, e:
1822
raise errors.ParseConfigError(e.errors, e.config.filename)
1823
except UnicodeError:
1824
raise errors.ConfigContentError(self._filename)
1828
"""Save the config file, only tests should use it for now."""
1829
conf_dir = os.path.dirname(self._filename)
1830
ensure_config_dir_exists(conf_dir)
1831
f = file(self._filename, 'wb')
1833
self._get_config().write(f)
1837
def _set_option(self, section_name, option_name, value):
1838
"""Set an authentication configuration option"""
1839
conf = self._get_config()
1840
section = conf.get(section_name)
1843
section = conf[section]
1844
section[option_name] = value
1847
def get_credentials(self, scheme, host, port=None, user=None, path=None,
1849
"""Returns the matching credentials from authentication.conf file.
1851
:param scheme: protocol
1853
:param host: the server address
1855
:param port: the associated port (optional)
1857
:param user: login (optional)
1859
:param path: the absolute path on the server (optional)
1861
:param realm: the http authentication realm (optional)
1863
:return: A dict containing the matching credentials or None.
1865
- name: the section name of the credentials in the
1866
authentication.conf file,
1867
- user: can't be different from the provided user if any,
1868
- scheme: the server protocol,
1869
- host: the server address,
1870
- port: the server port (can be None),
1871
- path: the absolute server path (can be None),
1872
- realm: the http specific authentication realm (can be None),
1873
- password: the decoded password, could be None if the credential
1874
defines only the user
1875
- verify_certificates: https specific, True if the server
1876
certificate should be verified, False otherwise.
1879
for auth_def_name, auth_def in self._get_config().items():
1880
if type(auth_def) is not configobj.Section:
1881
raise ValueError("%s defined outside a section" % auth_def_name)
1883
a_scheme, a_host, a_user, a_path = map(
1884
auth_def.get, ['scheme', 'host', 'user', 'path'])
1887
a_port = auth_def.as_int('port')
1891
raise ValueError("'port' not numeric in %s" % auth_def_name)
1893
a_verify_certificates = auth_def.as_bool('verify_certificates')
1895
a_verify_certificates = True
1898
"'verify_certificates' not boolean in %s" % auth_def_name)
1901
if a_scheme is not None and scheme != a_scheme:
1903
if a_host is not None:
1904
if not (host == a_host
1905
or (a_host.startswith('.') and host.endswith(a_host))):
1907
if a_port is not None and port != a_port:
1909
if (a_path is not None and path is not None
1910
and not path.startswith(a_path)):
1912
if (a_user is not None and user is not None
1913
and a_user != user):
1914
# Never contradict the caller about the user to be used
1919
# Prepare a credentials dictionary with additional keys
1920
# for the credential providers
1921
credentials = dict(name=auth_def_name,
1928
password=auth_def.get('password', None),
1929
verify_certificates=a_verify_certificates)
1930
# Decode the password in the credentials (or get one)
1931
self.decode_password(credentials,
1932
auth_def.get('password_encoding', None))
1933
if 'auth' in debug.debug_flags:
1934
trace.mutter("Using authentication section: %r", auth_def_name)
1937
if credentials is None:
1938
# No credentials were found in authentication.conf, try the fallback
1939
# credentials stores.
1940
credentials = credential_store_registry.get_fallback_credentials(
1941
scheme, host, port, user, path, realm)
1945
def set_credentials(self, name, host, user, scheme=None, password=None,
1946
port=None, path=None, verify_certificates=None,
1948
"""Set authentication credentials for a host.
1950
Any existing credentials with matching scheme, host, port and path
1951
will be deleted, regardless of name.
1953
:param name: An arbitrary name to describe this set of credentials.
1954
:param host: Name of the host that accepts these credentials.
1955
:param user: The username portion of these credentials.
1956
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
1958
:param password: Password portion of these credentials.
1959
:param port: The IP port on the host that these credentials apply to.
1960
:param path: A filesystem path on the host that these credentials
1962
:param verify_certificates: On https, verify server certificates if
1964
:param realm: The http authentication realm (optional).
1966
values = {'host': host, 'user': user}
1967
if password is not None:
1968
values['password'] = password
1969
if scheme is not None:
1970
values['scheme'] = scheme
1971
if port is not None:
1972
values['port'] = '%d' % port
1973
if path is not None:
1974
values['path'] = path
1975
if verify_certificates is not None:
1976
values['verify_certificates'] = str(verify_certificates)
1977
if realm is not None:
1978
values['realm'] = realm
1979
config = self._get_config()
1981
for section, existing_values in config.items():
1982
for key in ('scheme', 'host', 'port', 'path', 'realm'):
1983
if existing_values.get(key) != values.get(key):
1987
config.update({name: values})
1990
def get_user(self, scheme, host, port=None, realm=None, path=None,
1991
prompt=None, ask=False, default=None):
1992
"""Get a user from authentication file.
1994
:param scheme: protocol
1996
:param host: the server address
1998
:param port: the associated port (optional)
2000
:param realm: the realm sent by the server (optional)
2002
:param path: the absolute path on the server (optional)
2004
:param ask: Ask the user if there is no explicitly configured username
2007
:param default: The username returned if none is defined (optional).
2009
:return: The found user.
2011
credentials = self.get_credentials(scheme, host, port, user=None,
2012
path=path, realm=realm)
2013
if credentials is not None:
2014
user = credentials['user']
2020
# Create a default prompt suitable for most cases
2021
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username'
2022
# Special handling for optional fields in the prompt
2023
if port is not None:
2024
prompt_host = '%s:%d' % (host, port)
2027
user = ui.ui_factory.get_username(prompt, host=prompt_host)
2032
def get_password(self, scheme, host, user, port=None,
2033
realm=None, path=None, prompt=None):
2034
"""Get a password from authentication file or prompt the user for one.
2036
:param scheme: protocol
2038
:param host: the server address
2040
:param port: the associated port (optional)
2044
:param realm: the realm sent by the server (optional)
2046
:param path: the absolute path on the server (optional)
2048
:return: The found password or the one entered by the user.
2050
credentials = self.get_credentials(scheme, host, port, user, path,
2052
if credentials is not None:
2053
password = credentials['password']
2054
if password is not None and scheme is 'ssh':
2055
trace.warning('password ignored in section [%s],'
2056
' use an ssh agent instead'
2057
% credentials['name'])
2061
# Prompt user only if we could't find a password
2062
if password is None:
2064
# Create a default prompt suitable for most cases
2065
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password'
2066
# Special handling for optional fields in the prompt
2067
if port is not None:
2068
prompt_host = '%s:%d' % (host, port)
2071
password = ui.ui_factory.get_password(prompt,
2072
host=prompt_host, user=user)
2075
def decode_password(self, credentials, encoding):
2077
cs = credential_store_registry.get_credential_store(encoding)
2079
raise ValueError('%r is not a known password_encoding' % encoding)
2080
credentials['password'] = cs.decode_password(credentials)
2084
class CredentialStoreRegistry(registry.Registry):
2085
"""A class that registers credential stores.
2087
A credential store provides access to credentials via the password_encoding
2088
field in authentication.conf sections.
2090
Except for stores provided by bzr itself, most stores are expected to be
2091
provided by plugins that will therefore use
2092
register_lazy(password_encoding, module_name, member_name, help=help,
2093
fallback=fallback) to install themselves.
2095
A fallback credential store is one that is queried if no credentials can be
2096
found via authentication.conf.
2099
def get_credential_store(self, encoding=None):
2100
cs = self.get(encoding)
2105
def is_fallback(self, name):
2106
"""Check if the named credentials store should be used as fallback."""
2107
return self.get_info(name)
2109
def get_fallback_credentials(self, scheme, host, port=None, user=None,
2110
path=None, realm=None):
2111
"""Request credentials from all fallback credentials stores.
2113
The first credentials store that can provide credentials wins.
2116
for name in self.keys():
2117
if not self.is_fallback(name):
2119
cs = self.get_credential_store(name)
2120
credentials = cs.get_credentials(scheme, host, port, user,
2122
if credentials is not None:
2123
# We found some credentials
2127
def register(self, key, obj, help=None, override_existing=False,
2129
"""Register a new object to a name.
2131
:param key: This is the key to use to request the object later.
2132
:param obj: The object to register.
2133
:param help: Help text for this entry. This may be a string or
2134
a callable. If it is a callable, it should take two
2135
parameters (registry, key): this registry and the key that
2136
the help was registered under.
2137
:param override_existing: Raise KeyErorr if False and something has
2138
already been registered for that key. If True, ignore if there
2139
is an existing key (always register the new value).
2140
:param fallback: Whether this credential store should be
2143
return super(CredentialStoreRegistry,
2144
self).register(key, obj, help, info=fallback,
2145
override_existing=override_existing)
2147
def register_lazy(self, key, module_name, member_name,
2148
help=None, override_existing=False,
2150
"""Register a new credential store to be loaded on request.
2152
:param module_name: The python path to the module. Such as 'os.path'.
2153
:param member_name: The member of the module to return. If empty or
2154
None, get() will return the module itself.
2155
:param help: Help text for this entry. This may be a string or
2157
:param override_existing: If True, replace the existing object
2158
with the new one. If False, if there is already something
2159
registered with the same key, raise a KeyError
2160
:param fallback: Whether this credential store should be
2163
return super(CredentialStoreRegistry, self).register_lazy(
2164
key, module_name, member_name, help,
2165
info=fallback, override_existing=override_existing)
2168
credential_store_registry = CredentialStoreRegistry()
2171
class CredentialStore(object):
2172
"""An abstract class to implement storage for credentials"""
2174
def decode_password(self, credentials):
2175
"""Returns a clear text password for the provided credentials."""
2176
raise NotImplementedError(self.decode_password)
2178
def get_credentials(self, scheme, host, port=None, user=None, path=None,
2180
"""Return the matching credentials from this credential store.
2182
This method is only called on fallback credential stores.
2184
raise NotImplementedError(self.get_credentials)
2188
class PlainTextCredentialStore(CredentialStore):
2189
__doc__ = """Plain text credential store for the authentication.conf file"""
2191
def decode_password(self, credentials):
2192
"""See CredentialStore.decode_password."""
2193
return credentials['password']
2196
credential_store_registry.register('plain', PlainTextCredentialStore,
2197
help=PlainTextCredentialStore.__doc__)
2198
credential_store_registry.default_key = 'plain'
2201
class BzrDirConfig(object):
2203
def __init__(self, bzrdir):
2204
self._bzrdir = bzrdir
2205
self._config = bzrdir._get_config()
2207
def set_default_stack_on(self, value):
2208
"""Set the default stacking location.
2210
It may be set to a location, or None.
2212
This policy affects all branches contained by this bzrdir, except for
2213
those under repositories.
2215
if self._config is None:
2216
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir)
2218
self._config.set_option('', 'default_stack_on')
2220
self._config.set_option(value, 'default_stack_on')
2222
def get_default_stack_on(self):
2223
"""Return the default stacking location.
2225
This will either be a location, or None.
2227
This policy affects all branches contained by this bzrdir, except for
2228
those under repositories.
2230
if self._config is None:
2232
value = self._config.get_option('default_stack_on')
2238
class TransportConfig(object):
2239
"""A Config that reads/writes a config file on a Transport.
2241
It is a low-level object that considers config data to be name/value pairs
2242
that may be associated with a section. Assigning meaning to these values
2243
is done at higher levels like TreeConfig.
2246
def __init__(self, transport, filename):
2247
self._transport = transport
2248
self._filename = filename
2250
def get_option(self, name, section=None, default=None):
2251
"""Return the value associated with a named option.
2253
:param name: The name of the value
2254
:param section: The section the option is in (if any)
2255
:param default: The value to return if the value is not set
2256
:return: The value or default value
2258
configobj = self._get_configobj()
2260
section_obj = configobj
2263
section_obj = configobj[section]
2266
value = section_obj.get(name, default)
2267
for hook in OldConfigHooks['get']:
2268
hook(self, name, value)
2271
def set_option(self, value, name, section=None):
2272
"""Set the value associated with a named option.
2274
:param value: The value to set
2275
:param name: The name of the value to set
2276
:param section: The section the option is in (if any)
2278
configobj = self._get_configobj()
2280
configobj[name] = value
2282
configobj.setdefault(section, {})[name] = value
2283
for hook in OldConfigHooks['set']:
2284
hook(self, name, value)
2285
self._set_configobj(configobj)
2287
def remove_option(self, option_name, section_name=None):
2288
configobj = self._get_configobj()
2289
if section_name is None:
2290
del configobj[option_name]
2292
del configobj[section_name][option_name]
2293
for hook in OldConfigHooks['remove']:
2294
hook(self, option_name)
2295
self._set_configobj(configobj)
2297
def _get_config_file(self):
2299
f = StringIO(self._transport.get_bytes(self._filename))
2300
for hook in OldConfigHooks['load']:
2303
except errors.NoSuchFile:
2305
except errors.PermissionDenied, e:
2306
trace.warning("Permission denied while trying to open "
2307
"configuration file %s.", urlutils.unescape_for_display(
2308
urlutils.join(self._transport.base, self._filename), "utf-8"))
2311
def _external_url(self):
2312
return urlutils.join(self._transport.external_url(), self._filename)
2314
def _get_configobj(self):
2315
f = self._get_config_file()
2318
conf = ConfigObj(f, encoding='utf-8')
2319
except configobj.ConfigObjError, e:
2320
raise errors.ParseConfigError(e.errors, self._external_url())
2321
except UnicodeDecodeError:
2322
raise errors.ConfigContentError(self._external_url())
2327
def _set_configobj(self, configobj):
2328
out_file = StringIO()
2329
configobj.write(out_file)
2331
self._transport.put_file(self._filename, out_file)
2332
for hook in OldConfigHooks['save']:
2336
class Option(object):
2337
"""An option definition.
2339
The option *values* are stored in config files and found in sections.
2341
Here we define various properties about the option itself, its default
2342
value, how to convert it from stores, what to do when invalid values are
2343
encoutered, in which config files it can be stored.
2346
def __init__(self, name, default=None, default_from_env=None,
2347
help=None, from_unicode=None, invalid=None,
2349
"""Build an option definition.
2351
:param name: the name used to refer to the option.
2353
:param default: the default value to use when none exist in the config
2354
stores. This is either a string that ``from_unicode`` will convert
2355
into the proper type, a callable returning a unicode string so that
2356
``from_unicode`` can be used on the return value, or a python
2357
object that can be stringified (so only the empty list is supported
2360
:param default_from_env: A list of environment variables which can
2361
provide a default value. 'default' will be used only if none of the
2362
variables specified here are set in the environment.
2364
:param help: a doc string to explain the option to the user.
2366
:param from_unicode: a callable to convert the unicode string
2367
representing the option value in a store. This is not called for
2370
:param invalid: the action to be taken when an invalid value is
2371
encountered in a store. This is called only when from_unicode is
2372
invoked to convert a string and returns None or raise ValueError or
2373
TypeError. Accepted values are: None (ignore invalid values),
2374
'warning' (emit a warning), 'error' (emit an error message and
2377
:param unquote: should the unicode value be unquoted before conversion.
2378
This should be used only when the store providing the values cannot
2379
safely unquote them (see http://pad.lv/906897). It is provided so
2380
daughter classes can handle the quoting themselves.
2382
if default_from_env is None:
2383
default_from_env = []
2385
# Convert the default value to a unicode string so all values are
2386
# strings internally before conversion (via from_unicode) is attempted.
2389
elif isinstance(default, list):
2390
# Only the empty list is supported
2392
raise AssertionError(
2393
'Only empty lists are supported as default values')
2395
elif isinstance(default, (str, unicode, bool, int, float)):
2396
# Rely on python to convert strings, booleans and integers
2397
self.default = u'%s' % (default,)
2398
elif callable(default):
2399
self.default = default
2401
# other python objects are not expected
2402
raise AssertionError('%r is not supported as a default value'
2404
self.default_from_env = default_from_env
2406
self.from_unicode = from_unicode
2407
self.unquote = unquote
2408
if invalid and invalid not in ('warning', 'error'):
2409
raise AssertionError("%s not supported for 'invalid'" % (invalid,))
2410
self.invalid = invalid
2412
def convert_from_unicode(self, store, unicode_value):
2413
if self.unquote and store is not None and unicode_value is not None:
2414
unicode_value = store.unquote(unicode_value)
2415
if self.from_unicode is None or unicode_value is None:
2416
# Don't convert or nothing to convert
2417
return unicode_value
2419
converted = self.from_unicode(unicode_value)
2420
except (ValueError, TypeError):
2421
# Invalid values are ignored
2423
if converted is None and self.invalid is not None:
2424
# The conversion failed
2425
if self.invalid == 'warning':
2426
trace.warning('Value "%s" is not valid for "%s"',
2427
unicode_value, self.name)
2428
elif self.invalid == 'error':
2429
raise errors.ConfigOptionValueError(self.name, unicode_value)
2432
def get_default(self):
2434
for var in self.default_from_env:
2436
# If the env variable is defined, its value is the default one
2437
value = os.environ[var].decode(osutils.get_user_encoding())
2442
# Otherwise, fallback to the value defined at registration
2443
if callable(self.default):
2444
value = self.default()
2445
if not isinstance(value, unicode):
2446
raise AssertionError(
2447
'Callable default values should be unicode')
2449
value = self.default
2452
def get_help_text(self, additional_see_also=None, plain=True):
2454
from bzrlib import help_topics
2455
result += help_topics._format_see_also(additional_see_also)
2457
result = help_topics.help_as_plain_text(result)
2461
# Predefined converters to get proper values from store
2463
def bool_from_store(unicode_str):
2464
return ui.bool_from_string(unicode_str)
2467
def int_from_store(unicode_str):
2468
return int(unicode_str)
2471
_unit_suffixes = dict(K=10**3, M=10**6, G=10**9)
2473
def int_SI_from_store(unicode_str):
2474
"""Convert a human readable size in SI units, e.g 10MB into an integer.
2476
Accepted suffixes are K,M,G. It is case-insensitive and may be followed
2477
by a trailing b (i.e. Kb, MB). This is intended to be practical and not
2480
:return Integer, expanded to its base-10 value if a proper SI unit is
2481
found, None otherwise.
2483
regexp = "^(\d+)(([" + ''.join(_unit_suffixes) + "])b?)?$"
2484
p = re.compile(regexp, re.IGNORECASE)
2485
m = p.match(unicode_str)
2488
val, _, unit = m.groups()
2492
coeff = _unit_suffixes[unit.upper()]
2494
raise ValueError(gettext('{0} is not an SI unit.').format(unit))
2499
def float_from_store(unicode_str):
2500
return float(unicode_str)
2503
# Use a an empty dict to initialize an empty configobj avoiding all
2504
# parsing and encoding checks
2505
_list_converter_config = configobj.ConfigObj(
2506
{}, encoding='utf-8', list_values=True, interpolation=False)
2509
class ListOption(Option):
2511
def __init__(self, name, default=None, default_from_env=None,
2512
help=None, invalid=None):
2513
"""A list Option definition.
2515
This overrides the base class so the conversion from a unicode string
2516
can take quoting into account.
2518
super(ListOption, self).__init__(
2519
name, default=default, default_from_env=default_from_env,
2520
from_unicode=self.from_unicode, help=help,
2521
invalid=invalid, unquote=False)
2523
def from_unicode(self, unicode_str):
2524
if not isinstance(unicode_str, basestring):
2526
# Now inject our string directly as unicode. All callers got their
2527
# value from configobj, so values that need to be quoted are already
2529
_list_converter_config.reset()
2530
_list_converter_config._parse([u"list=%s" % (unicode_str,)])
2531
maybe_list = _list_converter_config['list']
2532
if isinstance(maybe_list, basestring):
2534
# A single value, most probably the user forgot (or didn't care
2535
# to add) the final ','
2538
# The empty string, convert to empty list
2541
# We rely on ConfigObj providing us with a list already
2546
class OptionRegistry(registry.Registry):
2547
"""Register config options by their name.
2549
This overrides ``registry.Registry`` to simplify registration by acquiring
2550
some information from the option object itself.
2553
def register(self, option):
2554
"""Register a new option to its name.
2556
:param option: The option to register. Its name is used as the key.
2558
super(OptionRegistry, self).register(option.name, option,
2561
def register_lazy(self, key, module_name, member_name):
2562
"""Register a new option to be loaded on request.
2564
:param key: the key to request the option later. Since the registration
2565
is lazy, it should be provided and match the option name.
2567
:param module_name: the python path to the module. Such as 'os.path'.
2569
:param member_name: the member of the module to return. If empty or
2570
None, get() will return the module itself.
2572
super(OptionRegistry, self).register_lazy(key,
2573
module_name, member_name)
2575
def get_help(self, key=None):
2576
"""Get the help text associated with the given key"""
2577
option = self.get(key)
2578
the_help = option.help
2579
if callable(the_help):
2580
return the_help(self, key)
2584
option_registry = OptionRegistry()
2587
# Registered options in lexicographical order
2589
option_registry.register(
2590
Option('append_revisions_only',
2591
default=None, from_unicode=bool_from_store, invalid='warning',
2593
Whether to only append revisions to the mainline.
2595
If this is set to true, then it is not possible to change the
2596
existing mainline of the branch.
2598
option_registry.register(
2599
ListOption('acceptable_keys',
2602
List of GPG key patterns which are acceptable for verification.
2604
option_registry.register(
2605
Option('add.maximum_file_size',
2606
default=u'20MB', from_unicode=int_SI_from_store,
2608
Size above which files should be added manually.
2610
Files below this size are added automatically when using ``bzr add`` without
2613
A negative value means disable the size check.
2615
option_registry.register(
2617
default=None, from_unicode=bool_from_store,
2619
Is the branch bound to ``bound_location``.
2621
If set to "True", the branch should act as a checkout, and push each commit to
2622
the bound_location. This option is normally set by ``bind``/``unbind``.
2624
See also: bound_location.
2626
option_registry.register(
2627
Option('bound_location',
2630
The location that commits should go to when acting as a checkout.
2632
This option is normally set by ``bind``.
2636
option_registry.register(
2637
Option('bzr.workingtree.worth_saving_limit', default=10,
2638
from_unicode=int_from_store, invalid='warning',
2640
How many changes before saving the dirstate.
2642
-1 means that we will never rewrite the dirstate file for only
2643
stat-cache changes. Regardless of this setting, we will always rewrite
2644
the dirstate file if a file is added/removed/renamed/etc. This flag only
2645
affects the behavior of updating the dirstate file after we notice that
2646
a file has been touched.
2648
option_registry.register(
2649
Option('check_signatures', default=CHECK_IF_POSSIBLE,
2650
from_unicode=signature_policy_from_unicode,
2652
GPG checking policy.
2654
Possible values: require, ignore, check-available (default)
2656
this option will control whether bzr will require good gpg
2657
signatures, ignore them, or check them if they are
2660
option_registry.register(
2661
Option('create_signatures', default=SIGN_WHEN_REQUIRED,
2662
from_unicode=signing_policy_from_unicode,
2666
Possible values: always, never, when-required (default)
2668
This option controls whether bzr will always create
2669
gpg signatures or not on commits.
2671
option_registry.register(
2672
Option('dirstate.fdatasync', default=True,
2673
from_unicode=bool_from_store,
2675
Flush dirstate changes onto physical disk?
2677
If true (default), working tree metadata changes are flushed through the
2678
OS buffers to physical disk. This is somewhat slower, but means data
2679
should not be lost if the machine crashes. See also repository.fdatasync.
2681
option_registry.register(
2682
ListOption('debug_flags', default=[],
2683
help='Debug flags to activate.'))
2684
option_registry.register(
2685
Option('default_format', default='2a',
2686
help='Format used when creating branches.'))
2687
option_registry.register(
2688
Option('dpush_strict', default=None,
2689
from_unicode=bool_from_store,
2691
The default value for ``dpush --strict``.
2693
If present, defines the ``--strict`` option default value for checking
2694
uncommitted changes before pushing into a different VCS without any
2695
custom bzr metadata.
2697
option_registry.register(
2699
help='The command called to launch an editor to enter a message.'))
2700
option_registry.register(
2701
Option('email', default=default_email,
2702
from_unicode=email_from_store,
2703
help='The users identity'))
2704
option_registry.register(
2705
Option('gpg_signing_command',
2708
Program to use use for creating signatures.
2710
This should support at least the -u and --clearsign options.
2712
option_registry.register(
2713
Option('gpg_signing_key',
2716
GPG key to use for signing.
2718
This defaults to the first key associated with the users email.
2720
option_registry.register(
2721
Option('ignore_missing_extensions', default=False,
2722
from_unicode=bool_from_store,
2724
Control the missing extensions warning display.
2726
The warning will not be emitted if set to True.
2728
option_registry.register(
2730
help='Language to translate messages into.'))
2731
option_registry.register(
2732
Option('locks.steal_dead', default=False, from_unicode=bool_from_store,
2734
Steal locks that appears to be dead.
2736
If set to True, bzr will check if a lock is supposed to be held by an
2737
active process from the same user on the same machine. If the user and
2738
machine match, but no process with the given PID is active, then bzr
2739
will automatically break the stale lock, and create a new lock for
2741
Otherwise, bzr will prompt as normal to break the lock.
2743
option_registry.register(
2744
Option('log_format', default='long',
2746
Log format to use when displaying revisions.
2748
Standard log formats are ``long``, ``short`` and ``line``. Additional formats
2749
may be provided by plugins.
2751
option_registry.register(
2752
Option('output_encoding',
2753
help= 'Unicode encoding for output'
2754
' (terminal encoding if not specified).'))
2755
option_registry.register(
2756
Option('parent_location',
2759
The location of the default branch for pull or merge.
2761
This option is normally set when creating a branch, the first ``pull`` or by
2762
``pull --remember``.
2764
option_registry.register(
2765
Option('post_commit', default=None,
2767
Post commit functions.
2769
An ordered list of python functions to call, separated by spaces.
2771
Each function takes branch, rev_id as parameters.
2773
option_registry.register(
2774
Option('public_branch',
2777
A publically-accessible version of this branch.
2779
This implies that the branch setting this option is not publically-accessible.
2780
Used and set by ``bzr send``.
2782
option_registry.register(
2783
Option('push_location',
2786
The location of the default branch for push.
2788
This option is normally set by the first ``push`` or ``push --remember``.
2790
option_registry.register(
2791
Option('push_strict', default=None,
2792
from_unicode=bool_from_store,
2794
The default value for ``push --strict``.
2796
If present, defines the ``--strict`` option default value for checking
2797
uncommitted changes before sending a merge directive.
2799
option_registry.register(
2800
Option('repository.fdatasync', default=True,
2801
from_unicode=bool_from_store,
2803
Flush repository changes onto physical disk?
2805
If true (default), repository changes are flushed through the OS buffers
2806
to physical disk. This is somewhat slower, but means data should not be
2807
lost if the machine crashes. See also dirstate.fdatasync.
2809
option_registry.register_lazy('smtp_server',
2810
'bzrlib.smtp_connection', 'smtp_server')
2811
option_registry.register_lazy('smtp_password',
2812
'bzrlib.smtp_connection', 'smtp_password')
2813
option_registry.register_lazy('smtp_username',
2814
'bzrlib.smtp_connection', 'smtp_username')
2815
option_registry.register(
2816
Option('selftest.timeout',
2818
from_unicode=int_from_store,
2819
help='Abort selftest if one test takes longer than this many seconds',
2822
option_registry.register(
2823
Option('send_strict', default=None,
2824
from_unicode=bool_from_store,
2826
The default value for ``send --strict``.
2828
If present, defines the ``--strict`` option default value for checking
2829
uncommitted changes before sending a bundle.
2832
option_registry.register(
2833
Option('serve.client_timeout',
2834
default=300.0, from_unicode=float_from_store,
2835
help="If we wait for a new request from a client for more than"
2836
" X seconds, consider the client idle, and hangup."))
2837
option_registry.register(
2838
Option('stacked_on_location',
2840
help="""The location where this branch is stacked on."""))
2841
option_registry.register(
2842
Option('submit_branch',
2845
The branch you intend to submit your current work to.
2847
This is automatically set by ``bzr send`` and ``bzr merge``, and is also used
2848
by the ``submit:`` revision spec.
2852
class Section(object):
2853
"""A section defines a dict of option name => value.
2855
This is merely a read-only dict which can add some knowledge about the
2856
options. It is *not* a python dict object though and doesn't try to mimic
2860
def __init__(self, section_id, options):
2861
self.id = section_id
2862
# We re-use the dict-like object received
2863
self.options = options
2865
def get(self, name, default=None, expand=True):
2866
return self.options.get(name, default)
2868
def iter_option_names(self):
2869
for k in self.options.iterkeys():
2873
# Mostly for debugging use
2874
return "<config.%s id=%s>" % (self.__class__.__name__, self.id)
2877
_NewlyCreatedOption = object()
2878
"""Was the option created during the MutableSection lifetime"""
2881
class MutableSection(Section):
2882
"""A section allowing changes and keeping track of the original values."""
2884
def __init__(self, section_id, options):
2885
super(MutableSection, self).__init__(section_id, options)
2888
def set(self, name, value):
2889
if name not in self.options:
2890
# This is a new option
2891
self.orig[name] = _NewlyCreatedOption
2892
elif name not in self.orig:
2893
self.orig[name] = self.get(name, None)
2894
self.options[name] = value
2896
def remove(self, name):
2897
if name not in self.orig:
2898
self.orig[name] = self.get(name, None)
2899
del self.options[name]
2902
class Store(object):
2903
"""Abstract interface to persistent storage for configuration options."""
2905
readonly_section_class = Section
2906
mutable_section_class = MutableSection
2908
def is_loaded(self):
2909
"""Returns True if the Store has been loaded.
2911
This is used to implement lazy loading and ensure the persistent
2912
storage is queried only when needed.
2914
raise NotImplementedError(self.is_loaded)
2917
"""Loads the Store from persistent storage."""
2918
raise NotImplementedError(self.load)
2920
def _load_from_string(self, bytes):
2921
"""Create a store from a string in configobj syntax.
2923
:param bytes: A string representing the file content.
2925
raise NotImplementedError(self._load_from_string)
2928
"""Unloads the Store.
2930
This should make is_loaded() return False. This is used when the caller
2931
knows that the persistent storage has changed or may have change since
2934
raise NotImplementedError(self.unload)
2936
def quote(self, value):
2937
"""Quote a configuration option value for storing purposes.
2939
This allows Stacks to present values as they will be stored.
2943
def unquote(self, value):
2944
"""Unquote a configuration option value into unicode.
2946
The received value is quoted as stored.
2951
"""Saves the Store to persistent storage."""
2952
raise NotImplementedError(self.save)
2954
def external_url(self):
2955
raise NotImplementedError(self.external_url)
2957
def get_sections(self):
2958
"""Returns an ordered iterable of existing sections.
2960
:returns: An iterable of (store, section).
2962
raise NotImplementedError(self.get_sections)
2964
def get_mutable_section(self, section_id=None):
2965
"""Returns the specified mutable section.
2967
:param section_id: The section identifier
2969
raise NotImplementedError(self.get_mutable_section)
2972
# Mostly for debugging use
2973
return "<config.%s(%s)>" % (self.__class__.__name__,
2974
self.external_url())
2977
class CommandLineStore(Store):
2978
"A store to carry command line overrides for the config options."""
2980
def __init__(self, opts=None):
2981
super(CommandLineStore, self).__init__()
2987
# The dict should be cleared but not replaced so it can be shared.
2988
self.options.clear()
2990
def _from_cmdline(self, overrides):
2991
# Reset before accepting new definitions
2993
for over in overrides:
2995
name, value = over.split('=', 1)
2997
raise errors.BzrCommandError(
2998
gettext("Invalid '%s', should be of the form 'name=value'")
3000
self.options[name] = value
3002
def external_url(self):
3003
# Not an url but it makes debugging easier and is never needed
3007
def get_sections(self):
3008
yield self, self.readonly_section_class('cmdline_overrides',
3012
class IniFileStore(Store):
3013
"""A config Store using ConfigObj for storage.
3015
:ivar transport: The transport object where the config file is located.
3017
:ivar file_name: The config file basename in the transport directory.
3019
:ivar _config_obj: Private member to hold the ConfigObj instance used to
3020
serialize/deserialize the config file.
3024
"""A config Store using ConfigObj for storage.
3026
super(IniFileStore, self).__init__()
3027
self._config_obj = None
3029
def is_loaded(self):
3030
return self._config_obj != None
3033
self._config_obj = None
3035
def _load_content(self):
3036
"""Load the config file bytes.
3038
This should be provided by subclasses
3040
:return: Byte string
3042
raise NotImplementedError(self._load_content)
3044
def _save_content(self, content):
3045
"""Save the config file bytes.
3047
This should be provided by subclasses
3049
:param content: Config file bytes to write
3051
raise NotImplementedError(self._save_content)
3054
"""Load the store from the associated file."""
3055
if self.is_loaded():
3057
content = self._load_content()
3058
self._load_from_string(content)
3059
for hook in ConfigHooks['load']:
3062
def _load_from_string(self, bytes):
3063
"""Create a config store from a string.
3065
:param bytes: A string representing the file content.
3067
if self.is_loaded():
3068
raise AssertionError('Already loaded: %r' % (self._config_obj,))
3069
co_input = StringIO(bytes)
3071
# The config files are always stored utf8-encoded
3072
self._config_obj = ConfigObj(co_input, encoding='utf-8',
3074
except configobj.ConfigObjError, e:
3075
self._config_obj = None
3076
raise errors.ParseConfigError(e.errors, self.external_url())
3077
except UnicodeDecodeError:
3078
raise errors.ConfigContentError(self.external_url())
3081
if not self.is_loaded():
3085
self._config_obj.write(out)
3086
self._save_content(out.getvalue())
3087
for hook in ConfigHooks['save']:
3090
def get_sections(self):
3091
"""Get the configobj section in the file order.
3093
:returns: An iterable of (store, section).
3095
# We need a loaded store
3098
except (errors.NoSuchFile, errors.PermissionDenied):
3099
# If the file can't be read, there is no sections
3101
cobj = self._config_obj
3103
yield self, self.readonly_section_class(None, cobj)
3104
for section_name in cobj.sections:
3106
self.readonly_section_class(section_name,
3107
cobj[section_name]))
3109
def get_mutable_section(self, section_id=None):
3110
# We need a loaded store
3113
except errors.NoSuchFile:
3114
# The file doesn't exist, let's pretend it was empty
3115
self._load_from_string('')
3116
if section_id is None:
3117
section = self._config_obj
3119
section = self._config_obj.setdefault(section_id, {})
3120
return self.mutable_section_class(section_id, section)
3122
def quote(self, value):
3124
# configobj conflates automagical list values and quoting
3125
self._config_obj.list_values = True
3126
return self._config_obj._quote(value)
3128
self._config_obj.list_values = False
3130
def unquote(self, value):
3132
# _unquote doesn't handle None nor empty strings
3133
value = self._config_obj._unquote(value)
3137
class TransportIniFileStore(IniFileStore):
3138
"""IniFileStore that loads files from a transport.
3141
def __init__(self, transport, file_name):
3142
"""A Store using a ini file on a Transport
3144
:param transport: The transport object where the config file is located.
3145
:param file_name: The config file basename in the transport directory.
3147
super(TransportIniFileStore, self).__init__()
3148
self.transport = transport
3149
self.file_name = file_name
3151
def _load_content(self):
3153
return self.transport.get_bytes(self.file_name)
3154
except errors.PermissionDenied:
3155
trace.warning("Permission denied while trying to load "
3156
"configuration store %s.", self.external_url())
3159
def _save_content(self, content):
3160
self.transport.put_bytes(self.file_name, content)
3162
def external_url(self):
3163
# FIXME: external_url should really accepts an optional relpath
3164
# parameter (bug #750169) :-/ -- vila 2011-04-04
3165
# The following will do in the interim but maybe we don't want to
3166
# expose a path here but rather a config ID and its associated
3167
# object </hand wawe>.
3168
return urlutils.join(self.transport.external_url(), self.file_name)
3171
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
3172
# unlockable stores for use with objects that can already ensure the locking
3173
# (think branches). If different stores (not based on ConfigObj) are created,
3174
# they may face the same issue.
3177
class LockableIniFileStore(TransportIniFileStore):
3178
"""A ConfigObjStore using locks on save to ensure store integrity."""
3180
def __init__(self, transport, file_name, lock_dir_name=None):
3181
"""A config Store using ConfigObj for storage.
3183
:param transport: The transport object where the config file is located.
3185
:param file_name: The config file basename in the transport directory.
3187
if lock_dir_name is None:
3188
lock_dir_name = 'lock'
3189
self.lock_dir_name = lock_dir_name
3190
super(LockableIniFileStore, self).__init__(transport, file_name)
3191
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name)
3193
def lock_write(self, token=None):
3194
"""Takes a write lock in the directory containing the config file.
3196
If the directory doesn't exist it is created.
3198
# FIXME: This doesn't check the ownership of the created directories as
3199
# ensure_config_dir_exists does. It should if the transport is local
3200
# -- vila 2011-04-06
3201
self.transport.create_prefix()
3202
return self._lock.lock_write(token)
3207
def break_lock(self):
3208
self._lock.break_lock()
3212
# We need to be able to override the undecorated implementation
3213
self.save_without_locking()
3215
def save_without_locking(self):
3216
super(LockableIniFileStore, self).save()
3219
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
3220
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
3221
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
3223
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
3224
# functions or a registry will make it easier and clearer for tests, focusing
3225
# on the relevant parts of the API that needs testing -- vila 20110503 (based
3226
# on a poolie's remark)
3227
class GlobalStore(LockableIniFileStore):
3229
def __init__(self, possible_transports=None):
3230
t = transport.get_transport_from_path(
3231
config_dir(), possible_transports=possible_transports)
3232
super(GlobalStore, self).__init__(t, 'bazaar.conf')
3236
class LocationStore(LockableIniFileStore):
3238
def __init__(self, possible_transports=None):
3239
t = transport.get_transport_from_path(
3240
config_dir(), possible_transports=possible_transports)
3241
super(LocationStore, self).__init__(t, 'locations.conf')
3242
self.id = 'locations'
3245
class BranchStore(TransportIniFileStore):
3247
def __init__(self, branch):
3248
super(BranchStore, self).__init__(branch.control_transport,
3250
self.branch = branch
3253
def lock_write(self, token=None):
3254
return self.branch.lock_write(token)
3257
return self.branch.unlock()
3261
# We need to be able to override the undecorated implementation
3262
self.save_without_locking()
3264
def save_without_locking(self):
3265
super(BranchStore, self).save()
3268
class ControlStore(LockableIniFileStore):
3270
def __init__(self, bzrdir):
3271
super(ControlStore, self).__init__(bzrdir.transport,
3273
lock_dir_name='branch_lock')
3276
class SectionMatcher(object):
3277
"""Select sections into a given Store.
3279
This is intended to be used to postpone getting an iterable of sections
3283
def __init__(self, store):
3286
def get_sections(self):
3287
# This is where we require loading the store so we can see all defined
3289
sections = self.store.get_sections()
3290
# Walk the revisions in the order provided
3291
for store, s in sections:
3295
def match(self, section):
3296
"""Does the proposed section match.
3298
:param section: A Section object.
3300
:returns: True if the section matches, False otherwise.
3302
raise NotImplementedError(self.match)
3305
class NameMatcher(SectionMatcher):
3307
def __init__(self, store, section_id):
3308
super(NameMatcher, self).__init__(store)
3309
self.section_id = section_id
3311
def match(self, section):
3312
return section.id == self.section_id
3315
class LocationSection(Section):
3317
def __init__(self, section, length, extra_path):
3318
super(LocationSection, self).__init__(section.id, section.options)
3319
self.length = length
3320
self.extra_path = extra_path
3321
self.locals = {'relpath': extra_path,
3322
'basename': urlutils.basename(extra_path)}
3324
def get(self, name, default=None, expand=True):
3325
value = super(LocationSection, self).get(name, default)
3326
if value is not None and expand:
3327
policy_name = self.get(name + ':policy', None)
3328
policy = _policy_value.get(policy_name, POLICY_NONE)
3329
if policy == POLICY_APPENDPATH:
3330
value = urlutils.join(value, self.extra_path)
3331
# expand section local options right now (since POLICY_APPENDPATH
3332
# will never add options references, it's ok to expand after it).
3334
for is_ref, chunk in iter_option_refs(value):
3336
chunks.append(chunk)
3339
if ref in self.locals:
3340
chunks.append(self.locals[ref])
3342
chunks.append(chunk)
3343
value = ''.join(chunks)
3347
class LocationMatcher(SectionMatcher):
3349
def __init__(self, store, location):
3350
super(LocationMatcher, self).__init__(store)
3351
if location.startswith('file://'):
3352
location = urlutils.local_path_from_url(location)
3353
self.location = location
3355
def _get_matching_sections(self):
3356
"""Get all sections matching ``location``."""
3357
# We slightly diverge from LocalConfig here by allowing the no-name
3358
# section as the most generic one and the lower priority.
3359
no_name_section = None
3361
# Filter out the no_name_section so _iter_for_location_by_parts can be
3362
# used (it assumes all sections have a name).
3363
for _, section in self.store.get_sections():
3364
if section.id is None:
3365
no_name_section = section
3367
all_sections.append(section)
3368
# Unfortunately _iter_for_location_by_parts deals with section names so
3369
# we have to resync.
3370
filtered_sections = _iter_for_location_by_parts(
3371
[s.id for s in all_sections], self.location)
3372
iter_all_sections = iter(all_sections)
3373
matching_sections = []
3374
if no_name_section is not None:
3375
matching_sections.append(
3376
LocationSection(no_name_section, 0, self.location))
3377
for section_id, extra_path, length in filtered_sections:
3378
# a section id is unique for a given store so it's safe to take the
3379
# first matching section while iterating. Also, all filtered
3380
# sections are part of 'all_sections' and will always be found
3383
section = iter_all_sections.next()
3384
if section_id == section.id:
3385
matching_sections.append(
3386
LocationSection(section, length, extra_path))
3388
return matching_sections
3390
def get_sections(self):
3391
# Override the default implementation as we want to change the order
3392
matching_sections = self._get_matching_sections()
3393
# We want the longest (aka more specific) locations first
3394
sections = sorted(matching_sections,
3395
key=lambda section: (section.length, section.id),
3397
# Sections mentioning 'ignore_parents' restrict the selection
3398
for section in sections:
3399
# FIXME: We really want to use as_bool below -- vila 2011-04-07
3400
ignore = section.get('ignore_parents', None)
3401
if ignore is not None:
3402
ignore = ui.bool_from_string(ignore)
3405
# Finally, we have a valid section
3406
yield self.store, section
3409
_option_ref_re = lazy_regex.lazy_compile('({[^{}\n]+})')
3410
"""Describes an expandable option reference.
3412
We want to match the most embedded reference first.
3414
I.e. for '{{foo}}' we will get '{foo}',
3415
for '{bar{baz}}' we will get '{baz}'
3418
def iter_option_refs(string):
3419
# Split isolate refs so every other chunk is a ref
3421
for chunk in _option_ref_re.split(string):
3426
class Stack(object):
3427
"""A stack of configurations where an option can be defined"""
3429
def __init__(self, sections_def, store=None, mutable_section_id=None):
3430
"""Creates a stack of sections with an optional store for changes.
3432
:param sections_def: A list of Section or callables that returns an
3433
iterable of Section. This defines the Sections for the Stack and
3434
can be called repeatedly if needed.
3436
:param store: The optional Store where modifications will be
3437
recorded. If none is specified, no modifications can be done.
3439
:param mutable_section_id: The id of the MutableSection where changes
3440
are recorded. This requires the ``store`` parameter to be
3443
self.sections_def = sections_def
3445
self.mutable_section_id = mutable_section_id
3447
def get(self, name, expand=None):
3448
"""Return the *first* option value found in the sections.
3450
This is where we guarantee that sections coming from Store are loaded
3451
lazily: the loading is delayed until we need to either check that an
3452
option exists or get its value, which in turn may require to discover
3453
in which sections it can be defined. Both of these (section and option
3454
existence) require loading the store (even partially).
3456
:param name: The queried option.
3458
:param expand: Whether options references should be expanded.
3460
:returns: The value of the option.
3462
# FIXME: No caching of options nor sections yet -- vila 20110503
3464
expand = _get_expand_default_value()
3466
# Ensuring lazy loading is achieved by delaying section matching (which
3467
# implies querying the persistent storage) until it can't be avoided
3468
# anymore by using callables to describe (possibly empty) section
3470
found_store = None # Where the option value has been found
3471
for sections in self.sections_def:
3472
for store, section in sections():
3473
value = section.get(name)
3474
if value is not None:
3477
if value is not None:
3479
# If the option is registered, it may provide additional info about
3482
opt = option_registry.get(name)
3486
def expand_and_convert(val):
3487
# This may need to be called twice if the value is None or ends up
3488
# being None during expansion or conversion.
3491
if isinstance(val, basestring):
3492
val = self._expand_options_in_string(val)
3494
trace.warning('Cannot expand "%s":'
3495
' %s does not support option expansion'
3496
% (name, type(val)))
3498
val = found_store.unquote(val)
3500
val = opt.convert_from_unicode(found_store, val)
3502
value = expand_and_convert(value)
3503
if opt is not None and value is None:
3504
# If the option is registered, it may provide a default value
3505
value = opt.get_default()
3506
value = expand_and_convert(value)
3507
for hook in ConfigHooks['get']:
3508
hook(self, name, value)
3511
def expand_options(self, string, env=None):
3512
"""Expand option references in the string in the configuration context.
3514
:param string: The string containing option(s) to expand.
3516
:param env: An option dict defining additional configuration options or
3517
overriding existing ones.
3519
:returns: The expanded string.
3521
return self._expand_options_in_string(string, env)
3523
def _expand_options_in_string(self, string, env=None, _refs=None):
3524
"""Expand options in the string in the configuration context.
3526
:param string: The string to be expanded.
3528
:param env: An option dict defining additional configuration options or
3529
overriding existing ones.
3531
:param _refs: Private list (FIFO) containing the options being expanded
3534
:returns: The expanded string.
3537
# Not much to expand there
3540
# What references are currently resolved (to detect loops)
3543
# We need to iterate until no more refs appear ({{foo}} will need two
3544
# iterations for example).
3549
for is_ref, chunk in iter_option_refs(result):
3551
chunks.append(chunk)
3556
raise errors.OptionExpansionLoop(string, _refs)
3558
value = self._expand_option(name, env, _refs)
3560
raise errors.ExpandingUnknownOption(name, string)
3561
chunks.append(value)
3563
result = ''.join(chunks)
3566
def _expand_option(self, name, env, _refs):
3567
if env is not None and name in env:
3568
# Special case, values provided in env takes precedence over
3572
value = self.get(name, expand=False)
3573
value = self._expand_options_in_string(value, env, _refs)
3576
def _get_mutable_section(self):
3577
"""Get the MutableSection for the Stack.
3579
This is where we guarantee that the mutable section is lazily loaded:
3580
this means we won't load the corresponding store before setting a value
3581
or deleting an option. In practice the store will often be loaded but
3582
this helps catching some programming errors.
3585
section = store.get_mutable_section(self.mutable_section_id)
3586
return store, section
3588
def set(self, name, value):
3589
"""Set a new value for the option."""
3590
store, section = self._get_mutable_section()
3591
section.set(name, store.quote(value))
3592
for hook in ConfigHooks['set']:
3593
hook(self, name, value)
3595
def remove(self, name):
3596
"""Remove an existing option."""
3597
_, section = self._get_mutable_section()
3598
section.remove(name)
3599
for hook in ConfigHooks['remove']:
3603
# Mostly for debugging use
3604
return "<config.%s(%s)>" % (self.__class__.__name__, id(self))
3606
def _get_overrides(self):
3607
# Hack around library_state.initialize never called
3608
if bzrlib.global_state is not None:
3609
return bzrlib.global_state.cmdline_overrides.get_sections()
3613
class MemoryStack(Stack):
3614
"""A configuration stack defined from a string.
3616
This is mainly intended for tests and requires no disk resources.
3619
def __init__(self, content=None):
3620
"""Create an in-memory stack from a given content.
3622
It uses a single store based on configobj and support reading and
3625
:param content: The initial content of the store. If None, the store is
3626
not loaded and ``_load_from_string`` can and should be used if
3629
store = IniFileStore()
3630
if content is not None:
3631
store._load_from_string(content)
3632
super(MemoryStack, self).__init__(
3633
[store.get_sections], store)
3636
class _CompatibleStack(Stack):
3637
"""Place holder for compatibility with previous design.
3639
This is intended to ease the transition from the Config-based design to the
3640
Stack-based design and should not be used nor relied upon by plugins.
3642
One assumption made here is that the daughter classes will all use Stores
3643
derived from LockableIniFileStore).
3645
It implements set() and remove () by re-loading the store before applying
3646
the modification and saving it.
3648
The long term plan being to implement a single write by store to save
3649
all modifications, this class should not be used in the interim.
3652
def set(self, name, value):
3655
super(_CompatibleStack, self).set(name, value)
3656
# Force a write to persistent storage
3659
def remove(self, name):
3662
super(_CompatibleStack, self).remove(name)
3663
# Force a write to persistent storage
3667
class GlobalStack(_CompatibleStack):
3668
"""Global options only stack.
3670
The following sections are queried:
3672
* command-line overrides,
3674
* the 'DEFAULT' section in bazaar.conf
3676
This stack will use the ``DEFAULT`` section in bazaar.conf as its
3681
gstore = GlobalStore()
3682
super(GlobalStack, self).__init__(
3683
[self._get_overrides,
3684
NameMatcher(gstore, 'DEFAULT').get_sections],
3685
gstore, mutable_section_id='DEFAULT')
3688
class LocationStack(_CompatibleStack):
3689
"""Per-location options falling back to global options stack.
3692
The following sections are queried:
3694
* command-line overrides,
3696
* the sections matching ``location`` in ``locations.conf``, the order being
3697
defined by the number of path components in the section glob, higher
3698
numbers first (from most specific section to most generic).
3700
* the 'DEFAULT' section in bazaar.conf
3702
This stack will use the ``location`` section in locations.conf as its
3706
def __init__(self, location):
3707
"""Make a new stack for a location and global configuration.
3709
:param location: A URL prefix to """
3710
lstore = LocationStore()
3711
if location.startswith('file://'):
3712
location = urlutils.local_path_from_url(location)
3713
gstore = GlobalStore()
3714
super(LocationStack, self).__init__(
3715
[self._get_overrides,
3716
LocationMatcher(lstore, location).get_sections,
3717
NameMatcher(gstore, 'DEFAULT').get_sections],
3718
lstore, mutable_section_id=location)
3721
class BranchStack(_CompatibleStack):
3722
"""Per-location options falling back to branch then global options stack.
3724
The following sections are queried:
3726
* command-line overrides,
3728
* the sections matching ``location`` in ``locations.conf``, the order being
3729
defined by the number of path components in the section glob, higher
3730
numbers first (from most specific section to most generic),
3732
* the no-name section in branch.conf,
3734
* the ``DEFAULT`` section in ``bazaar.conf``.
3736
This stack will use the no-name section in ``branch.conf`` as its
3740
def __init__(self, branch):
3741
lstore = LocationStore()
3742
bstore = branch._get_config_store()
3743
gstore = GlobalStore()
3744
super(BranchStack, self).__init__(
3745
[self._get_overrides,
3746
LocationMatcher(lstore, branch.base).get_sections,
3747
NameMatcher(bstore, None).get_sections,
3748
NameMatcher(gstore, 'DEFAULT').get_sections],
3750
self.branch = branch
3753
class RemoteControlStack(_CompatibleStack):
3754
"""Remote control-only options stack."""
3756
# FIXME 2011-11-22 JRV This should probably be renamed to avoid confusion
3757
# with the stack used for remote bzr dirs. RemoteControlStack only uses
3758
# control.conf and is used only for stack options.
3760
def __init__(self, bzrdir):
3761
cstore = bzrdir._get_config_store()
3762
super(RemoteControlStack, self).__init__(
3763
[NameMatcher(cstore, None).get_sections],
3765
self.bzrdir = bzrdir
3768
class BranchOnlyStack(_CompatibleStack):
3769
"""Branch-only options stack."""
3771
# FIXME: _BranchOnlyStack only uses branch.conf and is used only for the
3772
# stacked_on_location options waiting for http://pad.lv/832042 to be fixed.
3773
# -- vila 2011-12-16
3775
def __init__(self, branch):
3776
bstore = branch._get_config_store()
3777
super(BranchOnlyStack, self).__init__(
3778
[NameMatcher(bstore, None).get_sections],
3780
self.branch = branch
3783
# Use a an empty dict to initialize an empty configobj avoiding all
3784
# parsing and encoding checks
3785
_quoting_config = configobj.ConfigObj(
3786
{}, encoding='utf-8', interpolation=False, list_values=True)
3788
class cmd_config(commands.Command):
3789
__doc__ = """Display, set or remove a configuration option.
3791
Display the active value for a given option.
3793
If --all is specified, NAME is interpreted as a regular expression and all
3794
matching options are displayed mentioning their scope. The active value
3795
that bzr will take into account is the first one displayed for each option.
3797
If no NAME is given, --all .* is implied.
3799
Setting a value is achieved by using name=value without spaces. The value
3800
is set in the most relevant scope and can be checked by displaying the
3804
takes_args = ['name?']
3808
# FIXME: This should be a registry option so that plugins can register
3809
# their own config files (or not) and will also address
3810
# http://pad.lv/788991 -- vila 20101115
3811
commands.Option('scope', help='Reduce the scope to the specified'
3812
' configuration file.',
3814
commands.Option('all',
3815
help='Display all the defined values for the matching options.',
3817
commands.Option('remove', help='Remove the option from'
3818
' the configuration file.'),
3821
_see_also = ['configuration']
3823
@commands.display_command
3824
def run(self, name=None, all=False, directory=None, scope=None,
3826
if directory is None:
3828
directory = urlutils.normalize_url(directory)
3830
raise errors.BzrError(
3831
'--all and --remove are mutually exclusive.')
3833
# Delete the option in the given scope
3834
self._remove_config_option(name, directory, scope)
3836
# Defaults to all options
3837
self._show_matching_options('.*', directory, scope)
3840
name, value = name.split('=', 1)
3842
# Display the option(s) value(s)
3844
self._show_matching_options(name, directory, scope)
3846
self._show_value(name, directory, scope)
3849
raise errors.BzrError(
3850
'Only one option can be set.')
3851
# Set the option value
3852
self._set_config_option(name, value, directory, scope)
3854
def _get_stack(self, directory, scope=None):
3855
"""Get the configuration stack specified by ``directory`` and ``scope``.
3857
:param directory: Where the configurations are derived from.
3859
:param scope: A specific config to start from.
3861
# FIXME: scope should allow access to plugin-specific stacks (even
3862
# reduced to the plugin-specific store), related to
3863
# http://pad.lv/788991 -- vila 2011-11-15
3864
if scope is not None:
3865
if scope == 'bazaar':
3866
return GlobalStack()
3867
elif scope == 'locations':
3868
return LocationStack(directory)
3869
elif scope == 'branch':
3871
controldir.ControlDir.open_containing_tree_or_branch(
3873
return br.get_config_stack()
3874
raise errors.NoSuchConfig(scope)
3878
controldir.ControlDir.open_containing_tree_or_branch(
3880
return br.get_config_stack()
3881
except errors.NotBranchError:
3882
return LocationStack(directory)
3884
def _show_value(self, name, directory, scope):
3885
conf = self._get_stack(directory, scope)
3886
value = conf.get(name, expand=True)
3887
if value is not None:
3888
# Quote the value appropriately
3889
value = _quoting_config._quote(value)
3890
self.outf.write('%s\n' % (value,))
3892
raise errors.NoSuchConfigOption(name)
3894
def _show_matching_options(self, name, directory, scope):
3895
name = lazy_regex.lazy_compile(name)
3896
# We want any error in the regexp to be raised *now* so we need to
3897
# avoid the delay introduced by the lazy regexp. But, we still do
3898
# want the nicer errors raised by lazy_regex.
3899
name._compile_and_collapse()
3902
conf = self._get_stack(directory, scope)
3903
for sections in conf.sections_def:
3904
for store, section in sections():
3905
for oname in section.iter_option_names():
3906
if name.search(oname):
3907
if cur_store_id != store.id:
3908
# Explain where the options are defined
3909
self.outf.write('%s:\n' % (store.id,))
3910
cur_store_id = store.id
3912
if (section.id is not None
3913
and cur_section != section.id):
3914
# Display the section id as it appears in the store
3915
# (None doesn't appear by definition)
3916
self.outf.write(' [%s]\n' % (section.id,))
3917
cur_section = section.id
3918
value = section.get(oname, expand=False)
3919
# Since we don't use the stack, we need to restore a
3922
opt = option_registry.get(oname)
3923
value = opt.convert_from_unicode(store, value)
3925
value = store.unquote(value)
3926
value = _quoting_config._quote(value)
3927
self.outf.write(' %s = %s\n' % (oname, value))
3929
def _set_config_option(self, name, value, directory, scope):
3930
conf = self._get_stack(directory, scope)
3931
conf.set(name, value)
3933
def _remove_config_option(self, name, directory, scope):
3935
raise errors.BzrCommandError(
3936
'--remove expects an option to remove.')
3937
conf = self._get_stack(directory, scope)
3941
raise errors.NoSuchConfigOption(name)
3946
# We need adapters that can build a Store or a Stack in a test context. Test
3947
# classes, based on TestCaseWithTransport, can use the registry to parametrize
3948
# themselves. The builder will receive a test instance and should return a
3949
# ready-to-use store or stack. Plugins that define new store/stacks can also
3950
# register themselves here to be tested against the tests defined in
3951
# bzrlib.tests.test_config. Note that the builder can be called multiple times
3952
# for the same test.
3954
# The registered object should be a callable receiving a test instance
3955
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
3957
test_store_builder_registry = registry.Registry()
3959
# The registered object should be a callable receiving a test instance
3960
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
3962
test_stack_builder_registry = registry.Registry()
added
removed
bzrlib/config.py
