133
class ConfigObj(configobj.ConfigObj):
135
def __init__(self, infile=None, **kwargs):
136
# We define our own interpolation mechanism calling it option expansion
137
super(ConfigObj, self).__init__(infile=infile,
142
def get_bool(self, section, key):
143
return self[section].as_bool(key)
145
def get_value(self, section, name):
146
# Try [] for the old DEFAULT section.
147
if section == "DEFAULT":
152
return self[section][name]
155
# FIXME: Until we can guarantee that each config file is loaded once and and
156
# only once for a given bzrlib session, we don't want to re-read the file every
157
# time we query for an option so we cache the value (bad ! watch out for tests
158
# needing to restore the proper value).This shouldn't be part of 2.4.0 final,
159
# yell at mgz^W vila and the RM if this is still present at that time
161
_expand_default_value = None
162
def _get_expand_default_value():
163
global _expand_default_value
164
if _expand_default_value is not None:
165
return _expand_default_value
166
conf = GlobalConfig()
167
# Note that we must not use None for the expand value below or we'll run
168
# into infinite recursion. Using False really would be quite silly ;)
169
expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True)
171
# This is an opt-in feature, you *really* need to clearly say you want
174
_expand_default_value = expand
130
def ConfigObj(*args, **kwargs):
132
if _ConfigObj is None:
133
class ConfigObj(configobj.ConfigObj):
135
def get_bool(self, section, key):
136
return self[section].as_bool(key)
138
def get_value(self, section, name):
139
# Try [] for the old DEFAULT section.
140
if section == "DEFAULT":
145
return self[section][name]
146
_ConfigObj = ConfigObj
147
return _ConfigObj(*args, **kwargs)
178
150
class Config(object):
214
182
def _get_signing_policy(self):
215
183
"""Template method to override signature creation policy."""
219
def expand_options(self, string, env=None):
220
"""Expand option references in the string in the configuration context.
222
:param string: The string containing option to expand.
224
:param env: An option dict defining additional configuration options or
225
overriding existing ones.
227
:returns: The expanded string.
229
return self._expand_options_in_string(string, env)
231
def _expand_options_in_list(self, slist, env=None, _ref_stack=None):
232
"""Expand options in a list of strings in the configuration context.
234
:param slist: A list of strings.
236
:param env: An option dict defining additional configuration options or
237
overriding existing ones.
239
:param _ref_stack: Private list containing the options being
240
expanded to detect loops.
242
:returns: The flatten list of expanded strings.
244
# expand options in each value separately flattening lists
247
value = self._expand_options_in_string(s, env, _ref_stack)
248
if isinstance(value, list):
254
def _expand_options_in_string(self, string, env=None, _ref_stack=None):
255
"""Expand options in the string in the configuration context.
257
:param string: The string to be expanded.
259
:param env: An option dict defining additional configuration options or
260
overriding existing ones.
262
:param _ref_stack: Private list containing the options being
263
expanded to detect loops.
265
:returns: The expanded string.
268
# Not much to expand there
270
if _ref_stack is None:
271
# What references are currently resolved (to detect loops)
273
if self.option_ref_re is None:
274
# We want to match the most embedded reference first (i.e. for
275
# '{{foo}}' we will get '{foo}',
276
# for '{bar{baz}}' we will get '{baz}'
277
self.option_ref_re = re.compile('({[^{}]+})')
279
# We need to iterate until no more refs appear ({{foo}} will need two
280
# iterations for example).
282
raw_chunks = self.option_ref_re.split(result)
283
if len(raw_chunks) == 1:
284
# Shorcut the trivial case: no refs
288
# Split will isolate refs so that every other chunk is a ref
290
for chunk in raw_chunks:
293
# Keep only non-empty strings (or we get bogus empty
294
# slots when a list value is involved).
299
if name in _ref_stack:
300
raise errors.OptionExpansionLoop(string, _ref_stack)
301
_ref_stack.append(name)
302
value = self._expand_option(name, env, _ref_stack)
304
raise errors.ExpandingUnknownOption(name, string)
305
if isinstance(value, list):
313
# Once a list appears as the result of an expansion, all
314
# callers will get a list result. This allows a consistent
315
# behavior even when some options in the expansion chain
316
# defined as strings (no comma in their value) but their
317
# expanded value is a list.
318
return self._expand_options_in_list(chunks, env, _ref_stack)
320
result = ''.join(chunks)
323
def _expand_option(self, name, env, _ref_stack):
324
if env is not None and name in env:
325
# Special case, values provided in env takes precedence over
329
# FIXME: This is a limited implementation, what we really need is a
330
# way to query the bzr config for the value of an option,
331
# respecting the scope rules (That is, once we implement fallback
332
# configs, getting the option value should restart from the top
333
# config, not the current one) -- vila 20101222
334
value = self.get_user_option(name, expand=False)
335
if isinstance(value, list):
336
value = self._expand_options_in_list(value, env, _ref_stack)
338
value = self._expand_options_in_string(value, env, _ref_stack)
341
185
def _get_user_option(self, option_name):
342
186
"""Template method to provide a user option."""
345
def get_user_option(self, option_name, expand=None):
346
"""Get a generic option - no special process, no default.
348
:param option_name: The queried option.
350
:param expand: Whether options references should be expanded.
352
:returns: The value of the option.
355
expand = _get_expand_default_value()
356
value = self._get_user_option(option_name)
358
if isinstance(value, list):
359
value = self._expand_options_in_list(value)
360
elif isinstance(value, dict):
361
trace.warning('Cannot expand "%s":'
362
' Dicts do not support option expansion'
365
value = self._expand_options_in_string(value)
368
def get_user_option_as_bool(self, option_name, expand=None):
189
def get_user_option(self, option_name):
190
"""Get a generic option - no special process, no default."""
191
return self._get_user_option(option_name)
193
def get_user_option_as_bool(self, option_name):
369
194
"""Get a generic option as a boolean - no special process, no default.
371
196
:return None if the option doesn't exist or its value can't be
372
197
interpreted as a boolean. Returns True or False otherwise.
374
s = self.get_user_option(option_name, expand=expand)
199
s = self._get_user_option(option_name)
376
201
# The option doesn't exist
639
444
"""Override this to define the section used by the config."""
642
def _get_sections(self, name=None):
643
"""Returns an iterator of the sections specified by ``name``.
645
:param name: The section name. If None is supplied, the default
646
configurations are yielded.
648
:return: A tuple (name, section, config_id) for all sections that will
649
be walked by user_get_option() in the 'right' order. The first one
650
is where set_user_option() will update the value.
652
parser = self._get_parser()
654
yield (name, parser[name], self.config_id())
656
# No section name has been given so we fallback to the configobj
657
# itself which holds the variables defined outside of any section.
658
yield (None, parser, self.config_id())
660
def _get_options(self, sections=None):
661
"""Return an ordered list of (name, value, section, config_id) tuples.
663
All options are returned with their associated value and the section
664
they appeared in. ``config_id`` is a unique identifier for the
665
configuration file the option is defined in.
667
:param sections: Default to ``_get_matching_sections`` if not
668
specified. This gives a better control to daughter classes about
669
which sections should be searched. This is a list of (name,
674
parser = self._get_parser()
676
for (section_name, _) in self._get_matching_sections():
678
section = parser[section_name]
680
# This could happen for an empty file for which we define a
681
# DEFAULT section. FIXME: Force callers to provide sections
682
# instead ? -- vila 20100930
684
sections.append((section_name, section))
685
config_id = self.config_id()
686
for (section_name, section) in sections:
687
for (name, value) in section.iteritems():
688
yield (name, parser._quote(value), section_name,
691
447
def _get_option_policy(self, section, option_name):
692
448
"""Return the policy for the given (section, option_name) pair."""
693
449
return POLICY_NONE
944
667
self._write_config_file()
947
def _get_sections(self, name=None):
948
"""See IniBasedConfig._get_sections()."""
949
parser = self._get_parser()
950
# We don't give access to options defined outside of any section, we
951
# used the DEFAULT section by... default.
952
if name in (None, 'DEFAULT'):
953
# This could happen for an empty file where the DEFAULT section
954
# doesn't exist yet. So we force DEFAULT when yielding
956
if 'DEFAULT' not in parser:
957
parser['DEFAULT']= {}
958
yield (name, parser[name], self.config_id())
961
def remove_user_option(self, option_name, section_name=None):
962
if section_name is None:
963
# We need to force the default section.
964
section_name = 'DEFAULT'
965
# We need to avoid the LockableConfig implementation or we'll lock
967
super(LockableConfig, self).remove_user_option(option_name,
971
670
class LocationConfig(LockableConfig):
972
671
"""A configuration object that gives the policy for a location."""
1220
def _get_sections(self, name=None):
1221
"""See IniBasedConfig.get_sections()."""
1222
for source in self.option_sources:
1223
for section in source()._get_sections(name):
1226
def _get_options(self, sections=None):
1228
# First the locations options
1229
for option in self._get_location_config()._get_options():
1231
# Then the branch options
1232
branch_config = self._get_branch_data_config()
1233
if sections is None:
1234
sections = [('DEFAULT', branch_config._get_parser())]
1235
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
1236
# Config itself has no notion of sections :( -- vila 20101001
1237
config_id = self.config_id()
1238
for (section_name, section) in sections:
1239
for (name, value) in section.iteritems():
1240
yield (name, value, section_name,
1241
config_id, branch_config._get_parser())
1242
# Then the global options
1243
for option in self._get_global_config()._get_options():
1246
903
def set_user_option(self, name, value, store=STORE_BRANCH,
1247
904
warn_masked=False):
1248
905
if store == STORE_BRANCH:
1317
971
def config_dir():
1318
972
"""Return per-user configuration directory.
1320
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
1321
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
1322
that will be used instead.
974
By default this is ~/.bazaar/
1324
976
TODO: Global option --config-dir to override this.
1326
978
base = os.environ.get('BZR_HOME', None)
1327
979
if sys.platform == 'win32':
1328
# environ variables on Windows are in user encoding/mbcs. So decode
1330
if base is not None:
1331
base = base.decode('mbcs')
1332
980
if base is None:
1333
981
base = win32utils.get_appdata_location_unicode()
1334
982
if base is None:
1335
983
base = os.environ.get('HOME', None)
1336
if base is not None:
1337
base = base.decode('mbcs')
1338
984
if base is None:
1339
985
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,'
1341
987
return osutils.pathjoin(base, 'bazaar', '2.0')
1342
elif sys.platform == 'darwin':
1344
# this takes into account $HOME
1345
base = os.path.expanduser("~")
1346
return osutils.pathjoin(base, '.bazaar')
1348
989
if base is None:
1350
xdg_dir = os.environ.get('XDG_CONFIG_HOME', None)
1352
xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config")
1353
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar')
1354
if osutils.isdir(xdg_dir):
1356
"Using configuration in XDG directory %s." % xdg_dir)
1359
990
base = os.path.expanduser("~")
1360
991
return osutils.pathjoin(base, ".bazaar")
1407
1038
return os.path.expanduser('~/.cache')
1410
def _get_default_mail_domain():
1411
"""If possible, return the assumed default email domain.
1413
:returns: string mail domain, or None.
1415
if sys.platform == 'win32':
1416
# No implementation yet; patches welcome
1419
f = open('/etc/mailname')
1420
except (IOError, OSError), e:
1423
domain = f.read().strip()
1429
def _auto_user_id():
1430
"""Calculate automatic user identification.
1432
:returns: (realname, email), either of which may be None if they can't be
1435
Only used when none is set in the environment or the id file.
1437
This only returns an email address if we can be fairly sure the
1438
address is reasonable, ie if /etc/mailname is set on unix.
1440
This doesn't use the FQDN as the default domain because that may be
1441
slow, and it doesn't use the hostname alone because that's not normally
1442
a reasonable address.
1444
if sys.platform == 'win32':
1445
# No implementation to reliably determine Windows default mail
1446
# address; please add one.
1449
default_mail_domain = _get_default_mail_domain()
1450
if not default_mail_domain:
1456
w = pwd.getpwuid(uid)
1458
mutter('no passwd entry for uid %d?' % uid)
1461
# we try utf-8 first, because on many variants (like Linux),
1462
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
1463
# false positives. (many users will have their user encoding set to
1464
# latin-1, which cannot raise UnicodeError.)
1466
gecos = w.pw_gecos.decode('utf-8')
1468
except UnicodeError:
1470
encoding = osutils.get_user_encoding()
1471
gecos = w.pw_gecos.decode(encoding)
1472
except UnicodeError, e:
1473
mutter("cannot decode passwd entry %s" % w)
1476
username = w.pw_name.decode(encoding)
1477
except UnicodeError, e:
1478
mutter("cannot decode passwd entry %s" % w)
1481
comma = gecos.find(',')
1485
realname = gecos[:comma]
1487
return realname, (username + '@' + default_mail_domain)
1490
1041
def parse_username(username):
1491
1042
"""Parse e-mail username and return a (name, address) tuple."""
1492
1043
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username)
2066
1598
configobj.write(out_file)
2067
1599
out_file.seek(0)
2068
1600
self._transport.put_file(self._filename, out_file)
2071
class cmd_config(commands.Command):
2072
__doc__ = """Display, set or remove a configuration option.
2074
Display the active value for a given option.
2076
If --all is specified, NAME is interpreted as a regular expression and all
2077
matching options are displayed mentioning their scope. The active value
2078
that bzr will take into account is the first one displayed for each option.
2080
If no NAME is given, --all .* is implied.
2082
Setting a value is achieved by using name=value without spaces. The value
2083
is set in the most relevant scope and can be checked by displaying the
2087
takes_args = ['name?']
2091
# FIXME: This should be a registry option so that plugins can register
2092
# their own config files (or not) -- vila 20101002
2093
commands.Option('scope', help='Reduce the scope to the specified'
2094
' configuration file',
2096
commands.Option('all',
2097
help='Display all the defined values for the matching options.',
2099
commands.Option('remove', help='Remove the option from'
2100
' the configuration file'),
2103
@commands.display_command
2104
def run(self, name=None, all=False, directory=None, scope=None,
2106
if directory is None:
2108
directory = urlutils.normalize_url(directory)
2110
raise errors.BzrError(
2111
'--all and --remove are mutually exclusive.')
2113
# Delete the option in the given scope
2114
self._remove_config_option(name, directory, scope)
2116
# Defaults to all options
2117
self._show_matching_options('.*', directory, scope)
2120
name, value = name.split('=', 1)
2122
# Display the option(s) value(s)
2124
self._show_matching_options(name, directory, scope)
2126
self._show_value(name, directory, scope)
2129
raise errors.BzrError(
2130
'Only one option can be set.')
2131
# Set the option value
2132
self._set_config_option(name, value, directory, scope)
2134
def _get_configs(self, directory, scope=None):
2135
"""Iterate the configurations specified by ``directory`` and ``scope``.
2137
:param directory: Where the configurations are derived from.
2139
:param scope: A specific config to start from.
2141
if scope is not None:
2142
if scope == 'bazaar':
2143
yield GlobalConfig()
2144
elif scope == 'locations':
2145
yield LocationConfig(directory)
2146
elif scope == 'branch':
2147
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2149
yield br.get_config()
2152
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch(
2154
yield br.get_config()
2155
except errors.NotBranchError:
2156
yield LocationConfig(directory)
2157
yield GlobalConfig()
2159
def _show_value(self, name, directory, scope):
2161
for c in self._get_configs(directory, scope):
2164
for (oname, value, section, conf_id, parser) in c._get_options():
2166
# Display only the first value and exit
2168
# FIXME: We need to use get_user_option to take policies
2169
# into account and we need to make sure the option exists
2170
# too (hence the two for loops), this needs a better API
2172
value = c.get_user_option(name)
2173
# Quote the value appropriately
2174
value = parser._quote(value)
2175
self.outf.write('%s\n' % (value,))
2179
raise errors.NoSuchConfigOption(name)
2181
def _show_matching_options(self, name, directory, scope):
2182
name = re.compile(name)
2183
# We want any error in the regexp to be raised *now* so we need to
2184
# avoid the delay introduced by the lazy regexp.
2185
name._compile_and_collapse()
2188
for c in self._get_configs(directory, scope):
2189
for (oname, value, section, conf_id, parser) in c._get_options():
2190
if name.search(oname):
2191
if cur_conf_id != conf_id:
2192
# Explain where the options are defined
2193
self.outf.write('%s:\n' % (conf_id,))
2194
cur_conf_id = conf_id
2196
if (section not in (None, 'DEFAULT')
2197
and cur_section != section):
2198
# Display the section if it's not the default (or only)
2200
self.outf.write(' [%s]\n' % (section,))
2201
cur_section = section
2202
self.outf.write(' %s = %s\n' % (oname, value))
2204
def _set_config_option(self, name, value, directory, scope):
2205
for conf in self._get_configs(directory, scope):
2206
conf.set_user_option(name, value)
2209
raise errors.NoSuchConfig(scope)
2211
def _remove_config_option(self, name, directory, scope):
2213
raise errors.BzrCommandError(
2214
'--remove expects an option to remove.')
2216
for conf in self._get_configs(directory, scope):
2217
for (section_name, section, conf_id) in conf._get_sections():
2218
if scope is not None and conf_id != scope:
2219
# Not the right configuration file
2222
if conf_id != conf.config_id():
2223
conf = self._get_configs(directory, conf_id).next()
2224
# We use the first section in the first config where the
2225
# option is defined to remove it
2226
conf.remove_user_option(name, section_name)
2231
raise errors.NoSuchConfig(scope)
2233
raise errors.NoSuchConfigOption(name)
added
removed
bzrlib/config.py
