5598.2.1
by John Arbash Meinel
Decode windows env vars using mbcs rather than assuming the 8-bit string is ok. |
1 |
# Copyright (C) 2005-2011 Canonical Ltd
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
2 |
# Authors: Robert Collins <robert.collins@canonical.com>
|
2323.6.2
by Martin Pool
Move responsibility for suggesting upgrades to ui object |
3 |
# and others
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
4 |
#
|
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.
|
|
9 |
#
|
|
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.
|
|
14 |
#
|
|
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
|
|
4183.7.1
by Sabin Iacob
update FSF mailing address |
17 |
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
18 |
|
1442.1.20
by Robert Collins
add some documentation on options |
19 |
"""Configuration that affects the behaviour of Bazaar.
|
20 |
||
21 |
Currently this configuration resides in ~/.bazaar/bazaar.conf
|
|
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
22 |
and ~/.bazaar/locations.conf, which is written to by bzr.
|
1442.1.20
by Robert Collins
add some documentation on options |
23 |
|
1461
by Robert Collins
Typo in config.py (Thanks Fabbione) |
24 |
In bazaar.conf the following options may be set:
|
1442.1.20
by Robert Collins
add some documentation on options |
25 |
[DEFAULT]
|
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)
|
|
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
30 |
gpg_signing_command=name-of-program
|
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
31 |
log_format=name-of-format
|
5971.1.55
by Jonathan Riddell
add a config option to validate signatures |
32 |
validate_signatures_in_log=true|false(default)
|
5971.1.56
by Jonathan Riddell
add an option for acceptable_keys in config, also make config docs match reality for signature options |
33 |
acceptable_keys=pattern1,pattern2
|
1442.1.20
by Robert Collins
add some documentation on options |
34 |
|
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
35 |
in locations.conf, you specify the url of a branch and options for it.
|
1442.1.20
by Robert Collins
add some documentation on options |
36 |
Wildcards may be used - * and ? as normal in shell completion. Options
|
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
37 |
set in both bazaar.conf and locations.conf are overridden by the locations.conf
|
1442.1.20
by Robert Collins
add some documentation on options |
38 |
setting.
|
39 |
[/home/robertc/source]
|
|
40 |
recurse=False|True(default)
|
|
41 |
email= as above
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
42 |
check_signatures= as above
|
1442.1.20
by Robert Collins
add some documentation on options |
43 |
create_signatures= as above.
|
5971.1.55
by Jonathan Riddell
add a config option to validate signatures |
44 |
validate_signatures_in_log=as above
|
5971.1.56
by Jonathan Riddell
add an option for acceptable_keys in config, also make config docs match reality for signature options |
45 |
acceptable_keys=as above
|
1442.1.20
by Robert Collins
add some documentation on options |
46 |
|
47 |
explanation of options
|
|
48 |
----------------------
|
|
49 |
editor - this option sets the pop up editor to use during commits.
|
|
50 |
email - this option sets the user id bzr will use when committing.
|
|
5971.1.56
by Jonathan Riddell
add an option for acceptable_keys in config, also make config docs match reality for signature options |
51 |
check_signatures - this option will control whether bzr will require good gpg
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
52 |
signatures, ignore them, or check them if they are
|
5971.1.56
by Jonathan Riddell
add an option for acceptable_keys in config, also make config docs match reality for signature options |
53 |
present. Currently it is unused except that check_signatures
|
54 |
turns on create_signatures.
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
55 |
create_signatures - this option controls whether bzr will always create
|
5971.1.56
by Jonathan Riddell
add an option for acceptable_keys in config, also make config docs match reality for signature options |
56 |
gpg signatures or not on commits. There is an unused
|
57 |
option which in future is expected to work if
|
|
58 |
branch settings require signatures.
|
|
1887.2.1
by Adeodato Simó
Fix some typos and grammar issues. |
59 |
log_format - this option sets the default log format. Possible values are
|
60 |
long, short, line, or a plugin can register new formats.
|
|
5971.1.55
by Jonathan Riddell
add a config option to validate signatures |
61 |
validate_signatures_in_log - show GPG signature validity in log output
|
5971.1.56
by Jonathan Riddell
add an option for acceptable_keys in config, also make config docs match reality for signature options |
62 |
acceptable_keys - comma separated list of key patterns acceptable for
|
63 |
verify-signatures command
|
|
1553.6.2
by Erik Bågfors
documentation and NEWS |
64 |
|
65 |
In bazaar.conf you can also define aliases in the ALIASES sections, example
|
|
66 |
||
67 |
[ALIASES]
|
|
68 |
lastlog=log --line -r-10..-1
|
|
69 |
ll=log --line -r-10..-1
|
|
70 |
h=help
|
|
71 |
up=pull
|
|
1442.1.20
by Robert Collins
add some documentation on options |
72 |
"""
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
73 |
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
74 |
import os |
5050.72.1
by Martin Pool
Set email address from /etc/mailname if possible |
75 |
import string |
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
76 |
import sys |
5743.8.6
by Vincent Ladeuil
Add hooks for config stacks. |
77 |
|
78 |
||
5345.5.4
by Vincent Ladeuil
Start implementing config files locking. |
79 |
from bzrlib.decorators import needs_write_lock |
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
80 |
from bzrlib.lazy_import import lazy_import |
81 |
lazy_import(globals(), """ |
|
5447.4.1
by Vincent Ladeuil
Implement config.get_options_matching_regexp. |
82 |
import fnmatch
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
83 |
import re
|
2900.2.22
by Vincent Ladeuil
Polishing. |
84 |
from cStringIO import StringIO
|
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
85 |
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
86 |
from bzrlib import (
|
4797.59.2
by Vincent Ladeuil
Use AtomicFile and avoid all unicode/encoding issues around transport (thanks jam). |
87 |
atomicfile,
|
5447.4.2
by Vincent Ladeuil
Implement the 'brz config' command. Read-only. |
88 |
bzrdir,
|
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
89 |
debug,
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
90 |
errors,
|
5967.9.3
by Martin Pool
Explicitly use lazy_regexp where we count on its error reporting behaviour |
91 |
lazy_regex,
|
5345.5.4
by Vincent Ladeuil
Start implementing config files locking. |
92 |
lockdir,
|
2681.1.8
by Aaron Bentley
Add Thunderbird support to bzr send |
93 |
mail_client,
|
5321.1.88
by Gordon Tyler
Moved mergetools config functions into bzrlib.config.Config. |
94 |
mergetools,
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
95 |
osutils,
|
2120.6.9
by James Henstridge
Fixes for issues brought up in John's review |
96 |
symbol_versioning,
|
1551.15.35
by Aaron Bentley
Warn when setting config values that will be masked (#122286) |
97 |
trace,
|
5345.5.4
by Vincent Ladeuil
Start implementing config files locking. |
98 |
transport,
|
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
99 |
ui,
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
100 |
urlutils,
|
2245.4.3
by Alexander Belchenko
config.py: changing _auto_user_id() and config_dir() to use functions from win32utils |
101 |
win32utils,
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
102 |
)
|
2991.2.4
by Vincent Ladeuil
Various fixes following local testing environment rebuild. |
103 |
from bzrlib.util.configobj import configobj
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
104 |
""") |
5904.1.2
by Martin Pool
Various pyflakes import fixes. |
105 |
from bzrlib import ( |
5743.8.6
by Vincent Ladeuil
Add hooks for config stacks. |
106 |
commands, |
107 |
hooks, |
|
5904.1.2
by Martin Pool
Various pyflakes import fixes. |
108 |
registry, |
109 |
)
|
|
5743.13.1
by Vincent Ladeuil
Deprecate _get_editor to identify its usages. |
110 |
from bzrlib.symbol_versioning import ( |
111 |
deprecated_in, |
|
112 |
deprecated_method, |
|
113 |
)
|
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
114 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
115 |
|
1442.1.14
by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE |
116 |
CHECK_IF_POSSIBLE=0 |
117 |
CHECK_ALWAYS=1 |
|
118 |
CHECK_NEVER=2 |
|
119 |
||
120 |
||
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
121 |
SIGN_WHEN_REQUIRED=0 |
122 |
SIGN_ALWAYS=1 |
|
123 |
SIGN_NEVER=2 |
|
124 |
||
125 |
||
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
126 |
POLICY_NONE = 0 |
127 |
POLICY_NORECURSE = 1 |
|
128 |
POLICY_APPENDPATH = 2 |
|
129 |
||
2120.6.8
by James Henstridge
Change syntax for setting config option policies. Rather than |
130 |
_policy_name = { |
131 |
POLICY_NONE: None, |
|
132 |
POLICY_NORECURSE: 'norecurse', |
|
133 |
POLICY_APPENDPATH: 'appendpath', |
|
134 |
}
|
|
135 |
_policy_value = { |
|
136 |
None: POLICY_NONE, |
|
137 |
'none': POLICY_NONE, |
|
138 |
'norecurse': POLICY_NORECURSE, |
|
139 |
'appendpath': POLICY_APPENDPATH, |
|
140 |
}
|
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
141 |
|
142 |
||
143 |
STORE_LOCATION = POLICY_NONE |
|
144 |
STORE_LOCATION_NORECURSE = POLICY_NORECURSE |
|
145 |
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH |
|
146 |
STORE_BRANCH = 3 |
|
147 |
STORE_GLOBAL = 4 |
|
148 |
||
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
149 |
|
150 |
class ConfigObj(configobj.ConfigObj): |
|
151 |
||
152 |
def __init__(self, infile=None, **kwargs): |
|
153 |
# We define our own interpolation mechanism calling it option expansion
|
|
154 |
super(ConfigObj, self).__init__(infile=infile, |
|
155 |
interpolation=False, |
|
156 |
**kwargs) |
|
157 |
||
158 |
def get_bool(self, section, key): |
|
159 |
return self[section].as_bool(key) |
|
160 |
||
161 |
def get_value(self, section, name): |
|
162 |
# Try [] for the old DEFAULT section.
|
|
163 |
if section == "DEFAULT": |
|
164 |
try: |
|
165 |
return self[name] |
|
166 |
except KeyError: |
|
167 |
pass
|
|
168 |
return self[section][name] |
|
169 |
||
170 |
||
5743.8.6
by Vincent Ladeuil
Add hooks for config stacks. |
171 |
# FIXME: Until we can guarantee that each config file is loaded once and
|
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
172 |
# only once for a given bzrlib session, we don't want to re-read the file every
|
173 |
# time we query for an option so we cache the value (bad ! watch out for tests
|
|
174 |
# needing to restore the proper value).This shouldn't be part of 2.4.0 final,
|
|
175 |
# yell at mgz^W vila and the RM if this is still present at that time
|
|
176 |
# -- vila 20110219
|
|
177 |
_expand_default_value = None |
|
178 |
def _get_expand_default_value(): |
|
179 |
global _expand_default_value |
|
180 |
if _expand_default_value is not None: |
|
181 |
return _expand_default_value |
|
182 |
conf = GlobalConfig() |
|
183 |
# Note that we must not use None for the expand value below or we'll run
|
|
184 |
# into infinite recursion. Using False really would be quite silly ;)
|
|
185 |
expand = conf.get_user_option_as_bool('bzr.config.expand', expand=True) |
|
186 |
if expand is None: |
|
187 |
# This is an opt-in feature, you *really* need to clearly say you want
|
|
188 |
# to activate it !
|
|
189 |
expand = False |
|
190 |
_expand_default_value = expand |
|
191 |
return expand |
|
5549.1.31
by Vincent Ladeuil
Implement a default value for config option expansion (what ? No tests ?). |
192 |
|
5549.1.19
by Vincent Ladeuil
Push down interpolation at the config level (make tests slightly less |
193 |
|
194 |
class Config(object): |
|
195 |
"""A configuration policy - what username, editor, gpg needs etc."""
|
|
196 |
||
197 |
def __init__(self): |
|
198 |
super(Config, self).__init__() |
|
199 |
||
200 |
def config_id(self): |
|
201 |
"""Returns a unique ID for the config."""
|
|
202 |
raise NotImplementedError(self.config_id) |
|
203 |
||
5743.13.1
by Vincent Ladeuil
Deprecate _get_editor to identify its usages. |
204 |
@deprecated_method(deprecated_in((2, 4, 0))) |
5549.1.19
by Vincent Ladeuil
Push down interpolation at the config level (make tests slightly less |
205 |
def get_editor(self): |
206 |
"""Get the users pop up editor."""
|
|
207 |
raise NotImplementedError |
|
208 |
||
209 |
def get_change_editor(self, old_tree, new_tree): |
|
210 |
from bzrlib import diff |
|
211 |
cmd = self._get_change_editor() |
|
212 |
if cmd is None: |
|
213 |
return None |
|
214 |
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree, |
|
215 |
sys.stdout) |
|
216 |
||
217 |
def get_mail_client(self): |
|
218 |
"""Get a mail client to use"""
|
|
219 |
selected_client = self.get_user_option('mail_client') |
|
220 |
_registry = mail_client.mail_client_registry |
|
221 |
try: |
|
222 |
mail_client_class = _registry.get(selected_client) |
|
223 |
except KeyError: |
|
224 |
raise errors.UnknownMailClient(selected_client) |
|
225 |
return mail_client_class(self) |
|
226 |
||
227 |
def _get_signature_checking(self): |
|
228 |
"""Template method to override signature checking policy."""
|
|
229 |
||
230 |
def _get_signing_policy(self): |
|
231 |
"""Template method to override signature creation policy."""
|
|
232 |
||
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
233 |
option_ref_re = None |
234 |
||
235 |
def expand_options(self, string, env=None): |
|
236 |
"""Expand option references in the string in the configuration context.
|
|
237 |
||
238 |
:param string: The string containing option to expand.
|
|
239 |
||
240 |
:param env: An option dict defining additional configuration options or
|
|
241 |
overriding existing ones.
|
|
242 |
||
243 |
:returns: The expanded string.
|
|
244 |
"""
|
|
245 |
return self._expand_options_in_string(string, env) |
|
246 |
||
247 |
def _expand_options_in_list(self, slist, env=None, _ref_stack=None): |
|
248 |
"""Expand options in a list of strings in the configuration context.
|
|
249 |
||
250 |
:param slist: A list of strings.
|
|
251 |
||
252 |
:param env: An option dict defining additional configuration options or
|
|
253 |
overriding existing ones.
|
|
254 |
||
255 |
:param _ref_stack: Private list containing the options being
|
|
256 |
expanded to detect loops.
|
|
257 |
||
258 |
:returns: The flatten list of expanded strings.
|
|
259 |
"""
|
|
260 |
# expand options in each value separately flattening lists
|
|
261 |
result = [] |
|
262 |
for s in slist: |
|
263 |
value = self._expand_options_in_string(s, env, _ref_stack) |
|
264 |
if isinstance(value, list): |
|
265 |
result.extend(value) |
|
266 |
else: |
|
267 |
result.append(value) |
|
268 |
return result |
|
269 |
||
270 |
def _expand_options_in_string(self, string, env=None, _ref_stack=None): |
|
271 |
"""Expand options in the string in the configuration context.
|
|
272 |
||
273 |
:param string: The string to be expanded.
|
|
274 |
||
275 |
:param env: An option dict defining additional configuration options or
|
|
276 |
overriding existing ones.
|
|
277 |
||
278 |
:param _ref_stack: Private list containing the options being
|
|
279 |
expanded to detect loops.
|
|
280 |
||
281 |
:returns: The expanded string.
|
|
282 |
"""
|
|
283 |
if string is None: |
|
284 |
# Not much to expand there
|
|
285 |
return None |
|
286 |
if _ref_stack is None: |
|
287 |
# What references are currently resolved (to detect loops)
|
|
288 |
_ref_stack = [] |
|
289 |
if self.option_ref_re is None: |
|
290 |
# We want to match the most embedded reference first (i.e. for
|
|
291 |
# '{{foo}}' we will get '{foo}',
|
|
292 |
# for '{bar{baz}}' we will get '{baz}'
|
|
293 |
self.option_ref_re = re.compile('({[^{}]+})') |
|
294 |
result = string |
|
295 |
# We need to iterate until no more refs appear ({{foo}} will need two
|
|
296 |
# iterations for example).
|
|
297 |
while True: |
|
5745.1.1
by Vincent Ladeuil
Remove debug code |
298 |
raw_chunks = self.option_ref_re.split(result) |
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
299 |
if len(raw_chunks) == 1: |
300 |
# Shorcut the trivial case: no refs
|
|
301 |
return result |
|
302 |
chunks = [] |
|
303 |
list_value = False |
|
304 |
# Split will isolate refs so that every other chunk is a ref
|
|
305 |
chunk_is_ref = False |
|
306 |
for chunk in raw_chunks: |
|
307 |
if not chunk_is_ref: |
|
308 |
if chunk: |
|
309 |
# Keep only non-empty strings (or we get bogus empty
|
|
310 |
# slots when a list value is involved).
|
|
311 |
chunks.append(chunk) |
|
312 |
chunk_is_ref = True |
|
313 |
else: |
|
314 |
name = chunk[1:-1] |
|
315 |
if name in _ref_stack: |
|
316 |
raise errors.OptionExpansionLoop(string, _ref_stack) |
|
317 |
_ref_stack.append(name) |
|
318 |
value = self._expand_option(name, env, _ref_stack) |
|
319 |
if value is None: |
|
320 |
raise errors.ExpandingUnknownOption(name, string) |
|
321 |
if isinstance(value, list): |
|
322 |
list_value = True |
|
323 |
chunks.extend(value) |
|
324 |
else: |
|
325 |
chunks.append(value) |
|
326 |
_ref_stack.pop() |
|
327 |
chunk_is_ref = False |
|
328 |
if list_value: |
|
329 |
# Once a list appears as the result of an expansion, all
|
|
330 |
# callers will get a list result. This allows a consistent
|
|
331 |
# behavior even when some options in the expansion chain
|
|
332 |
# defined as strings (no comma in their value) but their
|
|
333 |
# expanded value is a list.
|
|
334 |
return self._expand_options_in_list(chunks, env, _ref_stack) |
|
335 |
else: |
|
336 |
result = ''.join(chunks) |
|
337 |
return result |
|
338 |
||
339 |
def _expand_option(self, name, env, _ref_stack): |
|
340 |
if env is not None and name in env: |
|
341 |
# Special case, values provided in env takes precedence over
|
|
342 |
# anything else
|
|
343 |
value = env[name] |
|
344 |
else: |
|
345 |
# FIXME: This is a limited implementation, what we really need is a
|
|
346 |
# way to query the bzr config for the value of an option,
|
|
347 |
# respecting the scope rules (That is, once we implement fallback
|
|
348 |
# configs, getting the option value should restart from the top
|
|
349 |
# config, not the current one) -- vila 20101222
|
|
350 |
value = self.get_user_option(name, expand=False) |
|
351 |
if isinstance(value, list): |
|
352 |
value = self._expand_options_in_list(value, env, _ref_stack) |
|
353 |
else: |
|
354 |
value = self._expand_options_in_string(value, env, _ref_stack) |
|
355 |
return value |
|
356 |
||
1993.3.6
by James Henstridge
get rid of the recurse argument to get_user_option() |
357 |
def _get_user_option(self, option_name): |
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
358 |
"""Template method to provide a user option."""
|
359 |
return None |
|
360 |
||
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
361 |
def get_user_option(self, option_name, expand=None): |
362 |
"""Get a generic option - no special process, no default.
|
|
363 |
||
364 |
:param option_name: The queried option.
|
|
365 |
||
366 |
:param expand: Whether options references should be expanded.
|
|
367 |
||
368 |
:returns: The value of the option.
|
|
369 |
"""
|
|
370 |
if expand is None: |
|
371 |
expand = _get_expand_default_value() |
|
372 |
value = self._get_user_option(option_name) |
|
373 |
if expand: |
|
374 |
if isinstance(value, list): |
|
375 |
value = self._expand_options_in_list(value) |
|
376 |
elif isinstance(value, dict): |
|
377 |
trace.warning('Cannot expand "%s":' |
|
378 |
' Dicts do not support option expansion'
|
|
379 |
% (option_name,)) |
|
380 |
else: |
|
381 |
value = self._expand_options_in_string(value) |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
382 |
for hook in OldConfigHooks['get']: |
5743.8.25
by Vincent Ladeuil
Fix spurious spaces. |
383 |
hook(self, option_name, value) |
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
384 |
return value |
385 |
||
5425.4.14
by Martin Pool
Allow get_user_option_as_bool to take a default |
386 |
def get_user_option_as_bool(self, option_name, expand=None, default=None): |
387 |
"""Get a generic option as a boolean.
|
|
4503.2.2
by Vincent Ladeuil
Get a bool or none from a config file. |
388 |
|
5425.4.14
by Martin Pool
Allow get_user_option_as_bool to take a default |
389 |
:param expand: Allow expanding references to other config values.
|
390 |
:param default: Default value if nothing is configured
|
|
4503.2.2
by Vincent Ladeuil
Get a bool or none from a config file. |
391 |
:return None if the option doesn't exist or its value can't be
|
4840.2.4
by Vincent Ladeuil
Implement config.get_user_option_as_list. |
392 |
interpreted as a boolean. Returns True or False otherwise.
|
4503.2.2
by Vincent Ladeuil
Get a bool or none from a config file. |
393 |
"""
|
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
394 |
s = self.get_user_option(option_name, expand=expand) |
4989.2.12
by Vincent Ladeuil
Display a warning if an option value is not boolean. |
395 |
if s is None: |
396 |
# The option doesn't exist
|
|
5425.4.14
by Martin Pool
Allow get_user_option_as_bool to take a default |
397 |
return default |
4989.2.15
by Vincent Ladeuil
Fixed as per Andrew's review. |
398 |
val = ui.bool_from_string(s) |
4989.2.12
by Vincent Ladeuil
Display a warning if an option value is not boolean. |
399 |
if val is None: |
400 |
# The value can't be interpreted as a boolean
|
|
401 |
trace.warning('Value "%s" is not a boolean for "%s"', |
|
402 |
s, option_name) |
|
403 |
return val |
|
4503.2.2
by Vincent Ladeuil
Get a bool or none from a config file. |
404 |
|
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
405 |
def get_user_option_as_list(self, option_name, expand=None): |
4840.2.4
by Vincent Ladeuil
Implement config.get_user_option_as_list. |
406 |
"""Get a generic option as a list - no special process, no default.
|
407 |
||
408 |
:return None if the option doesn't exist. Returns the value as a list
|
|
409 |
otherwise.
|
|
410 |
"""
|
|
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
411 |
l = self.get_user_option(option_name, expand=expand) |
4840.2.4
by Vincent Ladeuil
Implement config.get_user_option_as_list. |
412 |
if isinstance(l, (str, unicode)): |
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
413 |
# A single value, most probably the user forgot (or didn't care to
|
414 |
# add) the final ','
|
|
4840.2.4
by Vincent Ladeuil
Implement config.get_user_option_as_list. |
415 |
l = [l] |
416 |
return l |
|
417 |
||
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
418 |
def gpg_signing_command(self): |
419 |
"""What program should be used to sign signatures?"""
|
|
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
420 |
result = self._gpg_signing_command() |
421 |
if result is None: |
|
422 |
result = "gpg" |
|
423 |
return result |
|
424 |
||
425 |
def _gpg_signing_command(self): |
|
426 |
"""See gpg_signing_command()."""
|
|
427 |
return None |
|
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
428 |
|
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
429 |
def log_format(self): |
430 |
"""What log format should be used"""
|
|
431 |
result = self._log_format() |
|
1553.2.4
by Erik Bågfors
Support for setting the default log format at a configuration option |
432 |
if result is None: |
433 |
result = "long" |
|
434 |
return result |
|
435 |
||
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
436 |
def _log_format(self): |
437 |
"""See log_format()."""
|
|
1553.2.4
by Erik Bågfors
Support for setting the default log format at a configuration option |
438 |
return None |
439 |
||
5971.1.55
by Jonathan Riddell
add a config option to validate signatures |
440 |
def validate_signatures_in_log(self): |
441 |
"""Show GPG signature validity in log"""
|
|
442 |
result = self._validate_signatures_in_log() |
|
443 |
if result == "true": |
|
444 |
result = True |
|
445 |
else: |
|
446 |
result = False |
|
447 |
return result |
|
448 |
||
449 |
def _validate_signatures_in_log(self): |
|
450 |
"""See validate_signatures_in_log()."""
|
|
451 |
return None |
|
452 |
||
5971.1.56
by Jonathan Riddell
add an option for acceptable_keys in config, also make config docs match reality for signature options |
453 |
def acceptable_keys(self): |
454 |
"""Comma separated list of key patterns acceptable to
|
|
455 |
verify-signatures command"""
|
|
456 |
result = self._acceptable_keys() |
|
457 |
return result |
|
458 |
||
459 |
def _acceptable_keys(self): |
|
460 |
"""See acceptable_keys()."""
|
|
461 |
return None |
|
462 |
||
1472
by Robert Collins
post commit hook, first pass implementation |
463 |
def post_commit(self): |
464 |
"""An ordered list of python functions to call.
|
|
465 |
||
466 |
Each function takes branch, rev_id as parameters.
|
|
467 |
"""
|
|
468 |
return self._post_commit() |
|
469 |
||
470 |
def _post_commit(self): |
|
471 |
"""See Config.post_commit."""
|
|
472 |
return None |
|
473 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
474 |
def user_email(self): |
475 |
"""Return just the email component of a username."""
|
|
1185.33.31
by Martin Pool
Make annotate cope better with revisions committed without a valid |
476 |
return extract_email_address(self.username()) |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
477 |
|
478 |
def username(self): |
|
479 |
"""Return email-style username.
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
480 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
481 |
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
482 |
|
5187.2.1
by Parth Malwankar
removed comment about deprecated BZREMAIL. |
483 |
$BZR_EMAIL can be set to override this, then
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
484 |
the concrete policy type is checked, and finally
|
1185.37.2
by Jamie Wilkinson
Fix a typo and grammar in Config.username() docstring. |
485 |
$EMAIL is examined.
|
5187.2.12
by Parth Malwankar
trivial clarification in docstring. |
486 |
If no username can be found, errors.NoWhoami exception is raised.
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
487 |
"""
|
1861.4.1
by Matthieu Moy
BZREMAIL renamed to BZR_EMAIL. |
488 |
v = os.environ.get('BZR_EMAIL') |
489 |
if v: |
|
3224.5.4
by Andrew Bennetts
Fix test suite, mainly weeding out uses of bzrlib.user_encoding. |
490 |
return v.decode(osutils.get_user_encoding()) |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
491 |
v = self._get_user_id() |
492 |
if v: |
|
493 |
return v |
|
494 |
v = os.environ.get('EMAIL') |
|
495 |
if v: |
|
3224.5.4
by Andrew Bennetts
Fix test suite, mainly weeding out uses of bzrlib.user_encoding. |
496 |
return v.decode(osutils.get_user_encoding()) |
5050.72.1
by Martin Pool
Set email address from /etc/mailname if possible |
497 |
name, email = _auto_user_id() |
498 |
if name and email: |
|
499 |
return '%s <%s>' % (name, email) |
|
500 |
elif email: |
|
501 |
return email |
|
5187.2.6
by Parth Malwankar
lockdir no long mandates whoami but uses unicode version of getuser |
502 |
raise errors.NoWhoami() |
5187.2.3
by Parth Malwankar
init and init-repo now fail before creating dir if username is not set. |
503 |
|
504 |
def ensure_username(self): |
|
5187.2.11
by Parth Malwankar
documentation updates |
505 |
"""Raise errors.NoWhoami if username is not set.
|
5187.2.3
by Parth Malwankar
init and init-repo now fail before creating dir if username is not set. |
506 |
|
507 |
This method relies on the username() function raising the error.
|
|
508 |
"""
|
|
509 |
self.username() |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
510 |
|
1442.1.14
by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE |
511 |
def signature_checking(self): |
512 |
"""What is the current policy for signature checking?."""
|
|
1442.1.15
by Robert Collins
make getting the signature checking policy a template method |
513 |
policy = self._get_signature_checking() |
514 |
if policy is not None: |
|
515 |
return policy |
|
1442.1.14
by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE |
516 |
return CHECK_IF_POSSIBLE |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
517 |
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
518 |
def signing_policy(self): |
519 |
"""What is the current policy for signature checking?."""
|
|
520 |
policy = self._get_signing_policy() |
|
521 |
if policy is not None: |
|
522 |
return policy |
|
523 |
return SIGN_WHEN_REQUIRED |
|
524 |
||
1442.1.21
by Robert Collins
create signature_needed() call for commit to trigger creating signatures |
525 |
def signature_needed(self): |
526 |
"""Is a signature needed when committing ?."""
|
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
527 |
policy = self._get_signing_policy() |
528 |
if policy is None: |
|
529 |
policy = self._get_signature_checking() |
|
530 |
if policy is not None: |
|
5967.3.2
by Jonathan Riddell
do not treat 'check_signatures = require' as if it were 'create_signatures = always', this is confusing and wrong |
531 |
#this warning should go away once check_signatures is
|
532 |
#implemented (if not before)
|
|
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
533 |
trace.warning("Please use create_signatures," |
534 |
" not check_signatures to set signing policy.") |
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
535 |
elif policy == SIGN_ALWAYS: |
1442.1.21
by Robert Collins
create signature_needed() call for commit to trigger creating signatures |
536 |
return True |
537 |
return False |
|
538 |
||
1553.6.12
by Erik Bågfors
remove AliasConfig, based on input from abentley |
539 |
def get_alias(self, value): |
540 |
return self._get_alias(value) |
|
541 |
||
542 |
def _get_alias(self, value): |
|
543 |
pass
|
|
544 |
||
1770.2.7
by Aaron Bentley
Set/get nickname using BranchConfig |
545 |
def get_nickname(self): |
546 |
return self._get_nickname() |
|
547 |
||
548 |
def _get_nickname(self): |
|
549 |
return None |
|
550 |
||
1551.18.17
by Aaron Bentley
Introduce bzr_remote_path configuration variable |
551 |
def get_bzr_remote_path(self): |
552 |
try: |
|
553 |
return os.environ['BZR_REMOTE_PATH'] |
|
554 |
except KeyError: |
|
555 |
path = self.get_user_option("bzr_remote_path") |
|
556 |
if path is None: |
|
557 |
path = 'bzr' |
|
558 |
return path |
|
559 |
||
4840.2.6
by Vincent Ladeuil
Implement config.suppress_warning. |
560 |
def suppress_warning(self, warning): |
561 |
"""Should the warning be suppressed or emitted.
|
|
562 |
||
563 |
:param warning: The name of the warning being tested.
|
|
564 |
||
565 |
:returns: True if the warning should be suppressed, False otherwise.
|
|
566 |
"""
|
|
567 |
warnings = self.get_user_option_as_list('suppress_warnings') |
|
568 |
if warnings is None or warning not in warnings: |
|
569 |
return False |
|
570 |
else: |
|
571 |
return True |
|
572 |
||
5321.1.88
by Gordon Tyler
Moved mergetools config functions into bzrlib.config.Config. |
573 |
def get_merge_tools(self): |
5321.1.108
by Gordon Tyler
Changed known merge tools into a default set of merge tools that are always defined but can be overridden by user-defined merge tools. |
574 |
tools = {} |
5321.1.99
by Gordon Tyler
Fixes for changes to Config._get_options(). |
575 |
for (oname, value, section, conf_id, parser) in self._get_options(): |
5321.2.3
by Vincent Ladeuil
Prefix mergetools option names with 'bzr.'. |
576 |
if oname.startswith('bzr.mergetool.'): |
5321.1.108
by Gordon Tyler
Changed known merge tools into a default set of merge tools that are always defined but can be overridden by user-defined merge tools. |
577 |
tool_name = oname[len('bzr.mergetool.'):] |
5321.1.116
by Gordon Tyler
Simplified mergetools module down to functions which deal with command lines -- no MergeTool class. |
578 |
tools[tool_name] = value |
5321.1.88
by Gordon Tyler
Moved mergetools config functions into bzrlib.config.Config. |
579 |
trace.mutter('loaded merge tools: %r' % tools) |
5321.1.116
by Gordon Tyler
Simplified mergetools module down to functions which deal with command lines -- no MergeTool class. |
580 |
return tools |
5321.1.88
by Gordon Tyler
Moved mergetools config functions into bzrlib.config.Config. |
581 |
|
5321.1.103
by Gordon Tyler
Renamed _find_merge_tool back to find_merge_tool since it must be public for UI code to lookup merge tools by name, and added tests for it. |
582 |
def find_merge_tool(self, name): |
5967.3.6
by Jonathan Riddell
use example.com for e-mails, make bzrlib/config.py pep8 happy |
583 |
# We fake a defaults mechanism here by checking if the given name can
|
5321.1.111
by Gordon Tyler
Remove predefined merge tools from list returned by get_merge_tools. |
584 |
# be found in the known_merge_tools if it's not found in the config.
|
585 |
# This should be done through the proposed config defaults mechanism
|
|
586 |
# when it becomes available in the future.
|
|
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
587 |
command_line = (self.get_user_option('bzr.mergetool.%s' % name, |
588 |
expand=False) |
|
589 |
or mergetools.known_merge_tools.get(name, None)) |
|
5321.1.116
by Gordon Tyler
Simplified mergetools module down to functions which deal with command lines -- no MergeTool class. |
590 |
return command_line |
5321.1.88
by Gordon Tyler
Moved mergetools config functions into bzrlib.config.Config. |
591 |
|
1442.1.15
by Robert Collins
make getting the signature checking policy a template method |
592 |
|
5743.8.10
by Vincent Ladeuil
We don't need (nor want) to tie the config hooks to a particular class. Especially when we want to use the same hooks on both implementations. |
593 |
class _ConfigHooks(hooks.Hooks): |
594 |
"""A dict mapping hook names and a list of callables for configs.
|
|
595 |
"""
|
|
596 |
||
597 |
def __init__(self): |
|
598 |
"""Create the default hooks.
|
|
599 |
||
600 |
These are all empty initially, because by default nothing should get
|
|
601 |
notified.
|
|
602 |
"""
|
|
603 |
super(_ConfigHooks, self).__init__('bzrlib.config', 'ConfigHooks') |
|
604 |
self.add_hook('load', |
|
605 |
'Invoked when a config store is loaded.'
|
|
606 |
' The signature is (store).', |
|
607 |
(2, 4)) |
|
608 |
self.add_hook('save', |
|
609 |
'Invoked when a config store is saved.'
|
|
610 |
' The signature is (store).', |
|
611 |
(2, 4)) |
|
612 |
# The hooks for config options
|
|
613 |
self.add_hook('get', |
|
614 |
'Invoked when a config option is read.'
|
|
615 |
' The signature is (stack, name, value).', |
|
616 |
(2, 4)) |
|
617 |
self.add_hook('set', |
|
618 |
'Invoked when a config option is set.'
|
|
619 |
' The signature is (stack, name, value).', |
|
620 |
(2, 4)) |
|
621 |
self.add_hook('remove', |
|
622 |
'Invoked when a config option is removed.'
|
|
623 |
' The signature is (stack, name).', |
|
624 |
(2, 4)) |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
625 |
ConfigHooks = _ConfigHooks() |
626 |
||
627 |
||
628 |
class _OldConfigHooks(hooks.Hooks): |
|
629 |
"""A dict mapping hook names and a list of callables for configs.
|
|
630 |
"""
|
|
631 |
||
632 |
def __init__(self): |
|
633 |
"""Create the default hooks.
|
|
634 |
||
635 |
These are all empty initially, because by default nothing should get
|
|
636 |
notified.
|
|
637 |
"""
|
|
638 |
super(_OldConfigHooks, self).__init__('bzrlib.config', 'OldConfigHooks') |
|
639 |
self.add_hook('load', |
|
5743.8.14
by Vincent Ladeuil
Separate the hooks for old and new config implementations instead of cheating like crazy. |
640 |
'Invoked when a config store is loaded.'
|
641 |
' The signature is (config).', |
|
642 |
(2, 4)) |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
643 |
self.add_hook('save', |
5743.8.14
by Vincent Ladeuil
Separate the hooks for old and new config implementations instead of cheating like crazy. |
644 |
'Invoked when a config store is saved.'
|
645 |
' The signature is (config).', |
|
646 |
(2, 4)) |
|
647 |
# The hooks for config options
|
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
648 |
self.add_hook('get', |
5743.8.14
by Vincent Ladeuil
Separate the hooks for old and new config implementations instead of cheating like crazy. |
649 |
'Invoked when a config option is read.'
|
650 |
' The signature is (config, name, value).', |
|
651 |
(2, 4)) |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
652 |
self.add_hook('set', |
5743.8.14
by Vincent Ladeuil
Separate the hooks for old and new config implementations instead of cheating like crazy. |
653 |
'Invoked when a config option is set.'
|
654 |
' The signature is (config, name, value).', |
|
655 |
(2, 4)) |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
656 |
self.add_hook('remove', |
5743.8.14
by Vincent Ladeuil
Separate the hooks for old and new config implementations instead of cheating like crazy. |
657 |
'Invoked when a config option is removed.'
|
658 |
' The signature is (config, name).', |
|
659 |
(2, 4)) |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
660 |
OldConfigHooks = _OldConfigHooks() |
5743.8.10
by Vincent Ladeuil
We don't need (nor want) to tie the config hooks to a particular class. Especially when we want to use the same hooks on both implementations. |
661 |
|
662 |
||
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
663 |
class IniBasedConfig(Config): |
664 |
"""A configuration policy that draws from ini files."""
|
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
665 |
|
5345.1.1
by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig. |
666 |
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER, |
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
667 |
file_name=None): |
5345.2.5
by Vincent Ladeuil
Add docstring. |
668 |
"""Base class for configuration files using an ini-like syntax.
|
669 |
||
670 |
:param file_name: The configuration file path.
|
|
671 |
"""
|
|
4503.2.2
by Vincent Ladeuil
Get a bool or none from a config file. |
672 |
super(IniBasedConfig, self).__init__() |
5345.1.8
by Vincent Ladeuil
Make the test_listen_to_the_last_speaker pass and fix fallouts. |
673 |
self.file_name = file_name |
5345.1.1
by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig. |
674 |
if symbol_versioning.deprecated_passed(get_filename): |
675 |
symbol_versioning.warn( |
|
676 |
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
|
|
677 |
' Use file_name instead.', |
|
678 |
DeprecationWarning, |
|
679 |
stacklevel=2) |
|
5345.1.8
by Vincent Ladeuil
Make the test_listen_to_the_last_speaker pass and fix fallouts. |
680 |
if get_filename is not None: |
5345.1.1
by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig. |
681 |
self.file_name = get_filename() |
682 |
else: |
|
683 |
self.file_name = file_name |
|
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
684 |
self._content = None |
4503.2.2
by Vincent Ladeuil
Get a bool or none from a config file. |
685 |
self._parser = None |
686 |
||
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
687 |
@classmethod
|
5345.1.26
by Vincent Ladeuil
Merge lockable-config-files into remove-gratuitous-ensure-config-dir-exist-calls resolving conflicts |
688 |
def from_string(cls, str_or_unicode, file_name=None, save=False): |
5345.5.13
by Vincent Ladeuil
Merge simplify-test-config-building into lockable-config-files resolving conflicts |
689 |
"""Create a config object from a string.
|
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
690 |
|
5345.2.9
by Vincent Ladeuil
Rename IniBaseConfig.from_bytes to from_string. |
691 |
:param str_or_unicode: A string representing the file content. This will
|
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
692 |
be utf-8 encoded.
|
5345.1.25
by Vincent Ladeuil
Move the '_save' parameter from '__init__' to 'from_bytes', fix fallouts. |
693 |
|
694 |
:param file_name: The configuration file path.
|
|
695 |
||
696 |
:param _save: Whether the file should be saved upon creation.
|
|
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
697 |
"""
|
5345.1.25
by Vincent Ladeuil
Move the '_save' parameter from '__init__' to 'from_bytes', fix fallouts. |
698 |
conf = cls(file_name=file_name) |
5345.1.26
by Vincent Ladeuil
Merge lockable-config-files into remove-gratuitous-ensure-config-dir-exist-calls resolving conflicts |
699 |
conf._create_from_string(str_or_unicode, save) |
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
700 |
return conf |
701 |
||
5345.1.26
by Vincent Ladeuil
Merge lockable-config-files into remove-gratuitous-ensure-config-dir-exist-calls resolving conflicts |
702 |
def _create_from_string(self, str_or_unicode, save): |
5345.5.13
by Vincent Ladeuil
Merge simplify-test-config-building into lockable-config-files resolving conflicts |
703 |
self._content = StringIO(str_or_unicode.encode('utf-8')) |
5345.1.16
by Vincent Ladeuil
Allows tests to save the config file at build time. |
704 |
# Some tests use in-memory configs, some other always need the config
|
705 |
# file to exist on disk.
|
|
5345.1.25
by Vincent Ladeuil
Move the '_save' parameter from '__init__' to 'from_bytes', fix fallouts. |
706 |
if save: |
5345.1.16
by Vincent Ladeuil
Allows tests to save the config file at build time. |
707 |
self._write_config_file() |
5345.5.12
by Vincent Ladeuil
Fix fallouts from replacing '_content' by 'from_bytes' for config files. |
708 |
|
5345.1.4
by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method. |
709 |
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER): |
1185.12.51
by Aaron Bentley
Allowed second call of _get_parser() to not require a file |
710 |
if self._parser is not None: |
711 |
return self._parser |
|
5345.1.4
by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method. |
712 |
if symbol_versioning.deprecated_passed(file): |
713 |
symbol_versioning.warn( |
|
714 |
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
|
|
5345.1.5
by Vincent Ladeuil
Fix fallouts by slightly editing the tests. More refactoring avoided to keep the review light. |
715 |
' Use IniBasedConfig(_content=xxx) instead.', |
5345.1.4
by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method. |
716 |
DeprecationWarning, |
717 |
stacklevel=2) |
|
718 |
if self._content is not None: |
|
719 |
co_input = self._content |
|
720 |
elif self.file_name is None: |
|
721 |
raise AssertionError('We have no content to create the config') |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
722 |
else: |
5345.1.4
by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method. |
723 |
co_input = self.file_name |
1185.12.51
by Aaron Bentley
Allowed second call of _get_parser() to not require a file |
724 |
try: |
5345.1.4
by Vincent Ladeuil
Deprecate the ``file`` parameter of the ``config._get_parser()`` method. |
725 |
self._parser = ConfigObj(co_input, encoding='utf-8') |
1474
by Robert Collins
Merge from Aaron Bentley. |
726 |
except configobj.ConfigObjError, e: |
1185.12.51
by Aaron Bentley
Allowed second call of _get_parser() to not require a file |
727 |
raise errors.ParseConfigError(e.errors, e.config.filename) |
5987.1.4
by Vincent Ladeuil
Proper error messages for config files with content in non-utf encoding or that cannot be parsed |
728 |
except UnicodeDecodeError: |
729 |
raise errors.ConfigContentError(self.file_name) |
|
5345.5.1
by Vincent Ladeuil
Implement config.reload and make sure we have a file name when using it. |
730 |
# Make sure self.reload() will use the right file name
|
5345.1.8
by Vincent Ladeuil
Make the test_listen_to_the_last_speaker pass and fix fallouts. |
731 |
self._parser.filename = self.file_name |
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
732 |
for hook in OldConfigHooks['load']: |
5743.8.12
by Vincent Ladeuil
Fire config hooks for the actual implementation even if these calls should be deleted in the end. This will help the transition by providing *some* measurements. |
733 |
hook(self) |
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
734 |
return self._parser |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
735 |
|
5345.5.1
by Vincent Ladeuil
Implement config.reload and make sure we have a file name when using it. |
736 |
def reload(self): |
737 |
"""Reload the config file from disk."""
|
|
738 |
if self.file_name is None: |
|
739 |
raise AssertionError('We need a file name to reload the config') |
|
740 |
if self._parser is not None: |
|
741 |
self._parser.reload() |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
742 |
for hook in ConfigHooks['load']: |
5743.8.12
by Vincent Ladeuil
Fire config hooks for the actual implementation even if these calls should be deleted in the end. This will help the transition by providing *some* measurements. |
743 |
hook(self) |
5345.5.1
by Vincent Ladeuil
Implement config.reload and make sure we have a file name when using it. |
744 |
|
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
745 |
def _get_matching_sections(self): |
746 |
"""Return an ordered list of (section_name, extra_path) pairs.
|
|
747 |
||
748 |
If the section contains inherited configuration, extra_path is
|
|
749 |
a string containing the additional path components.
|
|
750 |
"""
|
|
751 |
section = self._get_section() |
|
752 |
if section is not None: |
|
753 |
return [(section, '')] |
|
754 |
else: |
|
755 |
return [] |
|
756 |
||
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
757 |
def _get_section(self): |
758 |
"""Override this to define the section used by the config."""
|
|
759 |
return "DEFAULT" |
|
760 |
||
5447.4.12
by Vincent Ladeuil
Turn get_options() and get_sections() into private methods because section handling is too messy and needs to be discussed and settled. |
761 |
def _get_sections(self, name=None): |
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
762 |
"""Returns an iterator of the sections specified by ``name``.
|
763 |
||
764 |
:param name: The section name. If None is supplied, the default
|
|
765 |
configurations are yielded.
|
|
766 |
||
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
767 |
:return: A tuple (name, section, config_id) for all sections that will
|
768 |
be walked by user_get_option() in the 'right' order. The first one
|
|
769 |
is where set_user_option() will update the value.
|
|
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
770 |
"""
|
771 |
parser = self._get_parser() |
|
772 |
if name is not None: |
|
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
773 |
yield (name, parser[name], self.config_id()) |
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
774 |
else: |
775 |
# No section name has been given so we fallback to the configobj
|
|
776 |
# itself which holds the variables defined outside of any section.
|
|
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
777 |
yield (None, parser, self.config_id()) |
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
778 |
|
5447.4.12
by Vincent Ladeuil
Turn get_options() and get_sections() into private methods because section handling is too messy and needs to be discussed and settled. |
779 |
def _get_options(self, sections=None): |
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
780 |
"""Return an ordered list of (name, value, section, config_id) tuples.
|
781 |
||
782 |
All options are returned with their associated value and the section
|
|
783 |
they appeared in. ``config_id`` is a unique identifier for the
|
|
784 |
configuration file the option is defined in.
|
|
5447.4.1
by Vincent Ladeuil
Implement config.get_options_matching_regexp. |
785 |
|
786 |
:param sections: Default to ``_get_matching_sections`` if not
|
|
787 |
specified. This gives a better control to daughter classes about
|
|
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
788 |
which sections should be searched. This is a list of (name,
|
789 |
configobj) tuples.
|
|
5447.4.1
by Vincent Ladeuil
Implement config.get_options_matching_regexp. |
790 |
"""
|
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
791 |
opts = [] |
5447.4.1
by Vincent Ladeuil
Implement config.get_options_matching_regexp. |
792 |
if sections is None: |
793 |
parser = self._get_parser() |
|
794 |
sections = [] |
|
795 |
for (section_name, _) in self._get_matching_sections(): |
|
796 |
try: |
|
797 |
section = parser[section_name] |
|
798 |
except KeyError: |
|
799 |
# This could happen for an empty file for which we define a
|
|
800 |
# DEFAULT section. FIXME: Force callers to provide sections
|
|
801 |
# instead ? -- vila 20100930
|
|
802 |
continue
|
|
803 |
sections.append((section_name, section)) |
|
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
804 |
config_id = self.config_id() |
5447.4.1
by Vincent Ladeuil
Implement config.get_options_matching_regexp. |
805 |
for (section_name, section) in sections: |
806 |
for (name, value) in section.iteritems(): |
|
5533.2.1
by Vincent Ladeuil
``bzr config`` properly displays list values |
807 |
yield (name, parser._quote(value), section_name, |
808 |
config_id, parser) |
|
5447.4.1
by Vincent Ladeuil
Implement config.get_options_matching_regexp. |
809 |
|
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
810 |
def _get_option_policy(self, section, option_name): |
811 |
"""Return the policy for the given (section, option_name) pair."""
|
|
812 |
return POLICY_NONE |
|
813 |
||
4603.1.10
by Aaron Bentley
Provide change editor via config. |
814 |
def _get_change_editor(self): |
815 |
return self.get_user_option('change_editor') |
|
816 |
||
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
817 |
def _get_signature_checking(self): |
818 |
"""See Config._get_signature_checking."""
|
|
1474
by Robert Collins
Merge from Aaron Bentley. |
819 |
policy = self._get_user_option('check_signatures') |
820 |
if policy: |
|
821 |
return self._string_to_signature_policy(policy) |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
822 |
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
823 |
def _get_signing_policy(self): |
1773.4.3
by Martin Pool
[merge] bzr.dev |
824 |
"""See Config._get_signing_policy"""
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
825 |
policy = self._get_user_option('create_signatures') |
826 |
if policy: |
|
827 |
return self._string_to_signing_policy(policy) |
|
828 |
||
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
829 |
def _get_user_id(self): |
830 |
"""Get the user id from the 'email' key in the current section."""
|
|
1474
by Robert Collins
Merge from Aaron Bentley. |
831 |
return self._get_user_option('email') |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
832 |
|
1993.3.6
by James Henstridge
get rid of the recurse argument to get_user_option() |
833 |
def _get_user_option(self, option_name): |
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
834 |
"""See Config._get_user_option."""
|
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
835 |
for (section, extra_path) in self._get_matching_sections(): |
836 |
try: |
|
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
837 |
value = self._get_parser().get_value(section, option_name) |
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
838 |
except KeyError: |
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
839 |
continue
|
840 |
policy = self._get_option_policy(section, option_name) |
|
841 |
if policy == POLICY_NONE: |
|
842 |
return value |
|
843 |
elif policy == POLICY_NORECURSE: |
|
844 |
# norecurse items only apply to the exact path
|
|
845 |
if extra_path: |
|
846 |
continue
|
|
847 |
else: |
|
848 |
return value |
|
849 |
elif policy == POLICY_APPENDPATH: |
|
2120.6.3
by James Henstridge
add some more tests for getting policy options, and behaviour of get_user_option in the presence of config policies |
850 |
if extra_path: |
851 |
value = urlutils.join(value, extra_path) |
|
852 |
return value |
|
2120.6.6
by James Henstridge
fix test_set_push_location test |
853 |
else: |
854 |
raise AssertionError('Unexpected config policy %r' % policy) |
|
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
855 |
else: |
1993.3.1
by James Henstridge
first go at making location config lookup recursive |
856 |
return None |
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
857 |
|
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
858 |
def _gpg_signing_command(self): |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
859 |
"""See Config.gpg_signing_command."""
|
1472
by Robert Collins
post commit hook, first pass implementation |
860 |
return self._get_user_option('gpg_signing_command') |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
861 |
|
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
862 |
def _log_format(self): |
863 |
"""See Config.log_format."""
|
|
864 |
return self._get_user_option('log_format') |
|
1553.2.4
by Erik Bågfors
Support for setting the default log format at a configuration option |
865 |
|
5971.1.55
by Jonathan Riddell
add a config option to validate signatures |
866 |
def _validate_signatures_in_log(self): |
5971.1.56
by Jonathan Riddell
add an option for acceptable_keys in config, also make config docs match reality for signature options |
867 |
"""See Config.validate_signatures_in_log."""
|
5971.1.55
by Jonathan Riddell
add a config option to validate signatures |
868 |
return self._get_user_option('validate_signatures_in_log') |
869 |
||
5971.1.56
by Jonathan Riddell
add an option for acceptable_keys in config, also make config docs match reality for signature options |
870 |
def _acceptable_keys(self): |
871 |
"""See Config.acceptable_keys."""
|
|
872 |
return self._get_user_option('acceptable_keys') |
|
873 |
||
1472
by Robert Collins
post commit hook, first pass implementation |
874 |
def _post_commit(self): |
875 |
"""See Config.post_commit."""
|
|
876 |
return self._get_user_option('post_commit') |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
877 |
|
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
878 |
def _string_to_signature_policy(self, signature_string): |
879 |
"""Convert a string to a signing policy."""
|
|
1442.1.17
by Robert Collins
allow global overriding of signature policy to force checking, or (pointless but allowed) to set auto checking |
880 |
if signature_string.lower() == 'check-available': |
881 |
return CHECK_IF_POSSIBLE |
|
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
882 |
if signature_string.lower() == 'ignore': |
883 |
return CHECK_NEVER |
|
1442.1.17
by Robert Collins
allow global overriding of signature policy to force checking, or (pointless but allowed) to set auto checking |
884 |
if signature_string.lower() == 'require': |
885 |
return CHECK_ALWAYS |
|
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
886 |
raise errors.BzrError("Invalid signatures policy '%s'" |
887 |
% signature_string) |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
888 |
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
889 |
def _string_to_signing_policy(self, signature_string): |
890 |
"""Convert a string to a signing policy."""
|
|
891 |
if signature_string.lower() == 'when-required': |
|
892 |
return SIGN_WHEN_REQUIRED |
|
893 |
if signature_string.lower() == 'never': |
|
894 |
return SIGN_NEVER |
|
895 |
if signature_string.lower() == 'always': |
|
896 |
return SIGN_ALWAYS |
|
897 |
raise errors.BzrError("Invalid signing policy '%s'" |
|
898 |
% signature_string) |
|
899 |
||
1553.6.12
by Erik Bågfors
remove AliasConfig, based on input from abentley |
900 |
def _get_alias(self, value): |
901 |
try: |
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
902 |
return self._get_parser().get_value("ALIASES", |
1553.6.12
by Erik Bågfors
remove AliasConfig, based on input from abentley |
903 |
value) |
904 |
except KeyError: |
|
905 |
pass
|
|
906 |
||
1770.2.7
by Aaron Bentley
Set/get nickname using BranchConfig |
907 |
def _get_nickname(self): |
908 |
return self.get_user_option('nickname') |
|
909 |
||
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
910 |
def remove_user_option(self, option_name, section_name=None): |
911 |
"""Remove a user option and save the configuration file.
|
|
912 |
||
913 |
:param option_name: The option to be removed.
|
|
914 |
||
915 |
:param section_name: The section the option is defined in, default to
|
|
916 |
the default section.
|
|
917 |
"""
|
|
918 |
self.reload() |
|
919 |
parser = self._get_parser() |
|
920 |
if section_name is None: |
|
921 |
section = parser |
|
922 |
else: |
|
923 |
section = parser[section_name] |
|
924 |
try: |
|
925 |
del section[option_name] |
|
926 |
except KeyError: |
|
927 |
raise errors.NoSuchConfigOption(option_name) |
|
928 |
self._write_config_file() |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
929 |
for hook in OldConfigHooks['remove']: |
5743.8.13
by Vincent Ladeuil
Fix config calls for the actual implementation, including typos in parameters and TransportConfig support. |
930 |
hook(self, option_name) |
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
931 |
|
4708.2.1
by Martin
Ensure all files opened by bazaar proper are explicitly closed |
932 |
def _write_config_file(self): |
5345.1.1
by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig. |
933 |
if self.file_name is None: |
934 |
raise AssertionError('We cannot save, self.file_name is None') |
|
5345.1.9
by Vincent Ladeuil
Refactor config dir check. |
935 |
conf_dir = os.path.dirname(self.file_name) |
936 |
ensure_config_dir_exists(conf_dir) |
|
5345.1.1
by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig. |
937 |
atomic_file = atomicfile.AtomicFile(self.file_name) |
5050.6.1
by Vincent Ladeuil
Merge 2.1 into 2.2 including fixes for bug #525571 and bug #494221 |
938 |
self._get_parser().write(atomic_file) |
939 |
atomic_file.commit() |
|
940 |
atomic_file.close() |
|
5345.3.3
by Vincent Ladeuil
Merge bzr.dev into deprecate-get-filename resolving conflicts |
941 |
osutils.copy_ownership_from_path(self.file_name) |
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
942 |
for hook in OldConfigHooks['save']: |
5743.8.13
by Vincent Ladeuil
Fix config calls for the actual implementation, including typos in parameters and TransportConfig support. |
943 |
hook(self) |
4708.2.1
by Martin
Ensure all files opened by bazaar proper are explicitly closed |
944 |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
945 |
|
5345.5.4
by Vincent Ladeuil
Start implementing config files locking. |
946 |
class LockableConfig(IniBasedConfig): |
947 |
"""A configuration needing explicit locking for access.
|
|
948 |
||
949 |
If several processes try to write the config file, the accesses need to be
|
|
950 |
serialized.
|
|
5345.5.8
by Vincent Ladeuil
More doc and ensure that the config is locked when _write_config_file is called. |
951 |
|
952 |
Daughter classes should decorate all methods that update a config with the
|
|
953 |
``@needs_write_lock`` decorator (they call, directly or indirectly, the
|
|
954 |
``_write_config_file()`` method. These methods (typically ``set_option()``
|
|
955 |
and variants must reload the config file from disk before calling
|
|
956 |
``_write_config_file()``), this can be achieved by calling the
|
|
957 |
``self.reload()`` method. Note that the lock scope should cover both the
|
|
958 |
reading and the writing of the config file which is why the decorator can't
|
|
959 |
be applied to ``_write_config_file()`` only.
|
|
960 |
||
961 |
This should be enough to implement the following logic:
|
|
962 |
- lock for exclusive write access,
|
|
963 |
- reload the config file from disk,
|
|
964 |
- set the new value
|
|
965 |
- unlock
|
|
966 |
||
967 |
This logic guarantees that a writer can update a value without erasing an
|
|
968 |
update made by another writer.
|
|
5345.5.4
by Vincent Ladeuil
Start implementing config files locking. |
969 |
"""
|
970 |
||
5345.5.5
by Vincent Ladeuil
Make bb.test_version.TestVersionUnicodeOutput.test_unicode_bzr_home pass. |
971 |
lock_name = 'lock' |
972 |
||
5345.1.25
by Vincent Ladeuil
Move the '_save' parameter from '__init__' to 'from_bytes', fix fallouts. |
973 |
def __init__(self, file_name): |
974 |
super(LockableConfig, self).__init__(file_name=file_name) |
|
5345.5.5
by Vincent Ladeuil
Make bb.test_version.TestVersionUnicodeOutput.test_unicode_bzr_home pass. |
975 |
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name)) |
5676.1.4
by Jelmer Vernooij
merge bzr.dev. |
976 |
# FIXME: It doesn't matter that we don't provide possible_transports
|
977 |
# below since this is currently used only for local config files ;
|
|
978 |
# local transports are not shared. But if/when we start using
|
|
979 |
# LockableConfig for other kind of transports, we will need to reuse
|
|
980 |
# whatever connection is already established -- vila 20100929
|
|
5345.5.5
by Vincent Ladeuil
Make bb.test_version.TestVersionUnicodeOutput.test_unicode_bzr_home pass. |
981 |
self.transport = transport.get_transport(self.dir) |
5743.4.9
by Vincent Ladeuil
Implement a LockableConfigObjStore to be able to mimick the actual behaviour. |
982 |
self._lock = lockdir.LockDir(self.transport, self.lock_name) |
5345.5.4
by Vincent Ladeuil
Start implementing config files locking. |
983 |
|
5345.1.26
by Vincent Ladeuil
Merge lockable-config-files into remove-gratuitous-ensure-config-dir-exist-calls resolving conflicts |
984 |
def _create_from_string(self, unicode_bytes, save): |
985 |
super(LockableConfig, self)._create_from_string(unicode_bytes, False) |
|
5345.1.25
by Vincent Ladeuil
Move the '_save' parameter from '__init__' to 'from_bytes', fix fallouts. |
986 |
if save: |
5345.1.24
by Vincent Ladeuil
Implement _save for LockableConfig too. |
987 |
# We need to handle the saving here (as opposed to IniBasedConfig)
|
988 |
# to be able to lock
|
|
989 |
self.lock_write() |
|
990 |
self._write_config_file() |
|
991 |
self.unlock() |
|
5345.5.4
by Vincent Ladeuil
Start implementing config files locking. |
992 |
|
993 |
def lock_write(self, token=None): |
|
5345.5.8
by Vincent Ladeuil
More doc and ensure that the config is locked when _write_config_file is called. |
994 |
"""Takes a write lock in the directory containing the config file.
|
995 |
||
996 |
If the directory doesn't exist it is created.
|
|
997 |
"""
|
|
5345.5.5
by Vincent Ladeuil
Make bb.test_version.TestVersionUnicodeOutput.test_unicode_bzr_home pass. |
998 |
ensure_config_dir_exists(self.dir) |
5345.5.4
by Vincent Ladeuil
Start implementing config files locking. |
999 |
return self._lock.lock_write(token) |
1000 |
||
1001 |
def unlock(self): |
|
1002 |
self._lock.unlock() |
|
1003 |
||
5345.5.9
by Vincent Ladeuil
Implements 'bzr lock --config <file>'. |
1004 |
def break_lock(self): |
1005 |
self._lock.break_lock() |
|
1006 |
||
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
1007 |
@needs_write_lock
|
1008 |
def remove_user_option(self, option_name, section_name=None): |
|
1009 |
super(LockableConfig, self).remove_user_option(option_name, |
|
1010 |
section_name) |
|
1011 |
||
5345.5.8
by Vincent Ladeuil
More doc and ensure that the config is locked when _write_config_file is called. |
1012 |
def _write_config_file(self): |
1013 |
if self._lock is None or not self._lock.is_held: |
|
1014 |
# NB: if the following exception is raised it probably means a
|
|
1015 |
# missing @needs_write_lock decorator on one of the callers.
|
|
1016 |
raise errors.ObjectNotLocked(self) |
|
1017 |
super(LockableConfig, self)._write_config_file() |
|
1018 |
||
5345.5.4
by Vincent Ladeuil
Start implementing config files locking. |
1019 |
|
1020 |
class GlobalConfig(LockableConfig): |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
1021 |
"""The configuration that should be used for a specific location."""
|
1022 |
||
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
1023 |
def __init__(self): |
1024 |
super(GlobalConfig, self).__init__(file_name=config_filename()) |
|
5345.1.1
by Vincent Ladeuil
Deprecate the get_filename parameter in IniBasedConfig. |
1025 |
|
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
1026 |
def config_id(self): |
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
1027 |
return 'bazaar' |
1028 |
||
5345.1.25
by Vincent Ladeuil
Move the '_save' parameter from '__init__' to 'from_bytes', fix fallouts. |
1029 |
@classmethod
|
5345.1.26
by Vincent Ladeuil
Merge lockable-config-files into remove-gratuitous-ensure-config-dir-exist-calls resolving conflicts |
1030 |
def from_string(cls, str_or_unicode, save=False): |
5345.5.13
by Vincent Ladeuil
Merge simplify-test-config-building into lockable-config-files resolving conflicts |
1031 |
"""Create a config object from a string.
|
5345.1.25
by Vincent Ladeuil
Move the '_save' parameter from '__init__' to 'from_bytes', fix fallouts. |
1032 |
|
5345.5.13
by Vincent Ladeuil
Merge simplify-test-config-building into lockable-config-files resolving conflicts |
1033 |
:param str_or_unicode: A string representing the file content. This
|
1034 |
will be utf-8 encoded.
|
|
5345.1.25
by Vincent Ladeuil
Move the '_save' parameter from '__init__' to 'from_bytes', fix fallouts. |
1035 |
|
1036 |
:param save: Whether the file should be saved upon creation.
|
|
1037 |
"""
|
|
1038 |
conf = cls() |
|
5345.1.26
by Vincent Ladeuil
Merge lockable-config-files into remove-gratuitous-ensure-config-dir-exist-calls resolving conflicts |
1039 |
conf._create_from_string(str_or_unicode, save) |
5345.1.25
by Vincent Ladeuil
Move the '_save' parameter from '__init__' to 'from_bytes', fix fallouts. |
1040 |
return conf |
5345.5.12
by Vincent Ladeuil
Fix fallouts from replacing '_content' by 'from_bytes' for config files. |
1041 |
|
5743.13.1
by Vincent Ladeuil
Deprecate _get_editor to identify its usages. |
1042 |
@deprecated_method(deprecated_in((2, 4, 0))) |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
1043 |
def get_editor(self): |
1474
by Robert Collins
Merge from Aaron Bentley. |
1044 |
return self._get_user_option('editor') |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
1045 |
|
5345.5.4
by Vincent Ladeuil
Start implementing config files locking. |
1046 |
@needs_write_lock
|
1816.2.1
by Robey Pointer
add set_user_option to GlobalConfig, and make /etc/passwd username lookup try harder with encodings |
1047 |
def set_user_option(self, option, value): |
1048 |
"""Save option and its value in the configuration."""
|
|
2900.3.2
by Tim Penhey
A working alias command. |
1049 |
self._set_option(option, value, 'DEFAULT') |
1050 |
||
1051 |
def get_aliases(self): |
|
1052 |
"""Return the aliases section."""
|
|
1053 |
if 'ALIASES' in self._get_parser(): |
|
1054 |
return self._get_parser()['ALIASES'] |
|
1055 |
else: |
|
1056 |
return {} |
|
1057 |
||
5345.5.8
by Vincent Ladeuil
More doc and ensure that the config is locked when _write_config_file is called. |
1058 |
@needs_write_lock
|
2900.3.2
by Tim Penhey
A working alias command. |
1059 |
def set_alias(self, alias_name, alias_command): |
1060 |
"""Save the alias in the configuration."""
|
|
1061 |
self._set_option(alias_name, alias_command, 'ALIASES') |
|
1062 |
||
5345.5.8
by Vincent Ladeuil
More doc and ensure that the config is locked when _write_config_file is called. |
1063 |
@needs_write_lock
|
2900.3.2
by Tim Penhey
A working alias command. |
1064 |
def unset_alias(self, alias_name): |
1065 |
"""Unset an existing alias."""
|
|
5345.5.10
by Vincent Ladeuil
Add a missing config.reload(). |
1066 |
self.reload() |
2900.3.2
by Tim Penhey
A working alias command. |
1067 |
aliases = self._get_parser().get('ALIASES') |
2900.3.7
by Tim Penhey
Updates from Aaron's review. |
1068 |
if not aliases or alias_name not in aliases: |
1069 |
raise errors.NoSuchAlias(alias_name) |
|
2900.3.2
by Tim Penhey
A working alias command. |
1070 |
del aliases[alias_name] |
2900.3.12
by Tim Penhey
Final review comments. |
1071 |
self._write_config_file() |
2900.3.2
by Tim Penhey
A working alias command. |
1072 |
|
1073 |
def _set_option(self, option, value, section): |
|
5345.5.1
by Vincent Ladeuil
Implement config.reload and make sure we have a file name when using it. |
1074 |
self.reload() |
2900.3.7
by Tim Penhey
Updates from Aaron's review. |
1075 |
self._get_parser().setdefault(section, {})[option] = value |
2900.3.12
by Tim Penhey
Final review comments. |
1076 |
self._write_config_file() |
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
1077 |
for hook in OldConfigHooks['set']: |
5743.8.13
by Vincent Ladeuil
Fix config calls for the actual implementation, including typos in parameters and TransportConfig support. |
1078 |
hook(self, option, value) |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
1079 |
|
5447.4.12
by Vincent Ladeuil
Turn get_options() and get_sections() into private methods because section handling is too messy and needs to be discussed and settled. |
1080 |
def _get_sections(self, name=None): |
1081 |
"""See IniBasedConfig._get_sections()."""
|
|
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
1082 |
parser = self._get_parser() |
1083 |
# We don't give access to options defined outside of any section, we
|
|
1084 |
# used the DEFAULT section by... default.
|
|
1085 |
if name in (None, 'DEFAULT'): |
|
1086 |
# This could happen for an empty file where the DEFAULT section
|
|
1087 |
# doesn't exist yet. So we force DEFAULT when yielding
|
|
1088 |
name = 'DEFAULT' |
|
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
1089 |
if 'DEFAULT' not in parser: |
1090 |
parser['DEFAULT']= {} |
|
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
1091 |
yield (name, parser[name], self.config_id()) |
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
1092 |
|
1093 |
@needs_write_lock
|
|
1094 |
def remove_user_option(self, option_name, section_name=None): |
|
1095 |
if section_name is None: |
|
1096 |
# We need to force the default section.
|
|
1097 |
section_name = 'DEFAULT' |
|
1098 |
# We need to avoid the LockableConfig implementation or we'll lock
|
|
1099 |
# twice
|
|
1100 |
super(LockableConfig, self).remove_user_option(option_name, |
|
1101 |
section_name) |
|
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
1102 |
|
5764.1.4
by Vincent Ladeuil
Using iterators is even clearer. |
1103 |
def _iter_for_location_by_parts(sections, location): |
5764.1.3
by Vincent Ladeuil
Add a doctrsing and address the location being split for all iterations by making letting the function iterate over all sections. |
1104 |
"""Keep only the sessions matching the specified location.
|
1105 |
||
1106 |
:param sections: An iterable of section names.
|
|
1107 |
||
1108 |
:param location: An url or a local path to match against.
|
|
1109 |
||
5764.1.4
by Vincent Ladeuil
Using iterators is even clearer. |
1110 |
:returns: An iterator of (section, extra_path, nb_parts) where nb is the
|
1111 |
number of path components in the section name, section is the section
|
|
1112 |
name and extra_path is the difference between location and the section
|
|
1113 |
name.
|
|
5743.6.19
by Vincent Ladeuil
Clarify comments about section names for Location-related objects (also fix LocationMatcher and add tests). |
1114 |
|
1115 |
``location`` will always be a local path and never a 'file://' url but the
|
|
1116 |
section names themselves can be in either form.
|
|
5764.1.3
by Vincent Ladeuil
Add a doctrsing and address the location being split for all iterations by making letting the function iterate over all sections. |
1117 |
"""
|
5764.1.2
by Vincent Ladeuil
This put a common processing into the loop to avoid bad inputs. The |
1118 |
location_parts = location.rstrip('/').split('/') |
1119 |
||
5764.1.3
by Vincent Ladeuil
Add a doctrsing and address the location being split for all iterations by making letting the function iterate over all sections. |
1120 |
for section in sections: |
5743.6.19
by Vincent Ladeuil
Clarify comments about section names for Location-related objects (also fix LocationMatcher and add tests). |
1121 |
# location is a local path if possible, so we need to convert 'file://'
|
1122 |
# urls in section names to local paths if necessary.
|
|
5764.1.3
by Vincent Ladeuil
Add a doctrsing and address the location being split for all iterations by making letting the function iterate over all sections. |
1123 |
|
1124 |
# This also avoids having file:///path be a more exact
|
|
1125 |
# match than '/path'.
|
|
1126 |
||
5743.6.19
by Vincent Ladeuil
Clarify comments about section names for Location-related objects (also fix LocationMatcher and add tests). |
1127 |
# FIXME: This still raises an issue if a user defines both file:///path
|
1128 |
# *and* /path. Should we raise an error in this case -- vila 20110505
|
|
1129 |
||
5764.1.3
by Vincent Ladeuil
Add a doctrsing and address the location being split for all iterations by making letting the function iterate over all sections. |
1130 |
if section.startswith('file://'): |
1131 |
section_path = urlutils.local_path_from_url(section) |
|
1132 |
else: |
|
1133 |
section_path = section |
|
1134 |
section_parts = section_path.rstrip('/').split('/') |
|
1135 |
||
1136 |
matched = True |
|
1137 |
if len(section_parts) > len(location_parts): |
|
1138 |
# More path components in the section, they can't match
|
|
1139 |
matched = False |
|
1140 |
else: |
|
1141 |
# Rely on zip truncating in length to the length of the shortest
|
|
1142 |
# argument sequence.
|
|
1143 |
names = zip(location_parts, section_parts) |
|
1144 |
for name in names: |
|
1145 |
if not fnmatch.fnmatch(name[0], name[1]): |
|
1146 |
matched = False |
|
1147 |
break
|
|
1148 |
if not matched: |
|
1149 |
continue
|
|
5764.1.1
by Vincent Ladeuil
Extract _match_section_by_parts from LocationConfig._get_matching_sections and more comments to explain the behavior. |
1150 |
# build the path difference between the section and the location
|
5764.1.3
by Vincent Ladeuil
Add a doctrsing and address the location being split for all iterations by making letting the function iterate over all sections. |
1151 |
extra_path = '/'.join(location_parts[len(section_parts):]) |
5764.1.4
by Vincent Ladeuil
Using iterators is even clearer. |
1152 |
yield section, extra_path, len(section_parts) |
5764.1.1
by Vincent Ladeuil
Extract _match_section_by_parts from LocationConfig._get_matching_sections and more comments to explain the behavior. |
1153 |
|
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
1154 |
|
5345.5.7
by Vincent Ladeuil
Make LocationConfig use a lock too. |
1155 |
class LocationConfig(LockableConfig): |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
1156 |
"""A configuration object that gives the policy for a location."""
|
1157 |
||
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
1158 |
def __init__(self, location): |
5345.1.2
by Vincent Ladeuil
Get rid of 'branches.conf' references. |
1159 |
super(LocationConfig, self).__init__( |
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
1160 |
file_name=locations_config_filename()) |
1878.1.1
by John Arbash Meinel
Entries in locations.conf should prefer local paths if available (bug #53653) |
1161 |
# local file locations are looked up by local path, rather than
|
1162 |
# by file url. This is because the config file is a user
|
|
1163 |
# file, and we would rather not expose the user to file urls.
|
|
1164 |
if location.startswith('file://'): |
|
1165 |
location = urlutils.local_path_from_url(location) |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
1166 |
self.location = location |
1167 |
||
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
1168 |
def config_id(self): |
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
1169 |
return 'locations' |
1170 |
||
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
1171 |
@classmethod
|
5345.1.26
by Vincent Ladeuil
Merge lockable-config-files into remove-gratuitous-ensure-config-dir-exist-calls resolving conflicts |
1172 |
def from_string(cls, str_or_unicode, location, save=False): |
1173 |
"""Create a config object from a string.
|
|
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
1174 |
|
5345.2.9
by Vincent Ladeuil
Rename IniBaseConfig.from_bytes to from_string. |
1175 |
:param str_or_unicode: A string representing the file content. This will
|
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
1176 |
be utf-8 encoded.
|
1177 |
||
1178 |
:param location: The location url to filter the configuration.
|
|
5345.1.25
by Vincent Ladeuil
Move the '_save' parameter from '__init__' to 'from_bytes', fix fallouts. |
1179 |
|
1180 |
:param save: Whether the file should be saved upon creation.
|
|
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
1181 |
"""
|
1182 |
conf = cls(location) |
|
5345.1.26
by Vincent Ladeuil
Merge lockable-config-files into remove-gratuitous-ensure-config-dir-exist-calls resolving conflicts |
1183 |
conf._create_from_string(str_or_unicode, save) |
5345.2.8
by Vincent Ladeuil
Introduce a 'from_bytes' constructor for config objects. |
1184 |
return conf |
1185 |
||
1993.3.1
by James Henstridge
first go at making location config lookup recursive |
1186 |
def _get_matching_sections(self): |
1187 |
"""Return an ordered list of section names matching this location."""
|
|
5764.1.4
by Vincent Ladeuil
Using iterators is even clearer. |
1188 |
matches = list(_iter_for_location_by_parts(self._get_parser(), |
1189 |
self.location)) |
|
5447.4.1
by Vincent Ladeuil
Implement config.get_options_matching_regexp. |
1190 |
# put the longest (aka more specific) locations first
|
5764.1.4
by Vincent Ladeuil
Using iterators is even clearer. |
1191 |
matches.sort( |
1192 |
key=lambda (section, extra_path, length): (length, section), |
|
1193 |
reverse=True) |
|
1194 |
for (section, extra_path, length) in matches: |
|
1195 |
yield section, extra_path |
|
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
1196 |
# should we stop looking for parent configs here?
|
1993.3.1
by James Henstridge
first go at making location config lookup recursive |
1197 |
try: |
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
1198 |
if self._get_parser()[section].as_bool('ignore_parents'): |
1199 |
break
|
|
1993.3.1
by James Henstridge
first go at making location config lookup recursive |
1200 |
except KeyError: |
1201 |
pass
|
|
1442.1.9
by Robert Collins
exact section test passes |
1202 |
|
5447.4.12
by Vincent Ladeuil
Turn get_options() and get_sections() into private methods because section handling is too messy and needs to be discussed and settled. |
1203 |
def _get_sections(self, name=None): |
1204 |
"""See IniBasedConfig._get_sections()."""
|
|
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
1205 |
# We ignore the name here as the only sections handled are named with
|
1206 |
# the location path and we don't expose embedded sections either.
|
|
1207 |
parser = self._get_parser() |
|
1208 |
for name, extra_path in self._get_matching_sections(): |
|
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
1209 |
yield (name, parser[name], self.config_id()) |
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
1210 |
|
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
1211 |
def _get_option_policy(self, section, option_name): |
1212 |
"""Return the policy for the given (section, option_name) pair."""
|
|
1213 |
# check for the old 'recurse=False' flag
|
|
1214 |
try: |
|
1215 |
recurse = self._get_parser()[section].as_bool('recurse') |
|
1216 |
except KeyError: |
|
1217 |
recurse = True |
|
1218 |
if not recurse: |
|
1219 |
return POLICY_NORECURSE |
|
1220 |
||
2120.6.10
by James Henstridge
Catch another deprecation warning, and more cleanup |
1221 |
policy_key = option_name + ':policy' |
2120.6.8
by James Henstridge
Change syntax for setting config option policies. Rather than |
1222 |
try: |
1223 |
policy_name = self._get_parser()[section][policy_key] |
|
1224 |
except KeyError: |
|
1225 |
policy_name = None |
|
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
1226 |
|
2120.6.8
by James Henstridge
Change syntax for setting config option policies. Rather than |
1227 |
return _policy_value[policy_name] |
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
1228 |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
1229 |
def _set_option_policy(self, section, option_name, option_policy): |
1230 |
"""Set the policy for the given option name in the given section."""
|
|
1231 |
# The old recurse=False option affects all options in the
|
|
1232 |
# section. To handle multiple policies in the section, we
|
|
1233 |
# need to convert it to a policy_norecurse key.
|
|
1234 |
try: |
|
1235 |
recurse = self._get_parser()[section].as_bool('recurse') |
|
1236 |
except KeyError: |
|
1237 |
pass
|
|
1238 |
else: |
|
2120.6.9
by James Henstridge
Fixes for issues brought up in John's review |
1239 |
symbol_versioning.warn( |
2120.6.11
by James Henstridge
s/0.13/0.14/ in deprecation warning |
1240 |
'The recurse option is deprecated as of 0.14. '
|
2120.6.9
by James Henstridge
Fixes for issues brought up in John's review |
1241 |
'The section "%s" has been converted to use policies.' |
1242 |
% section, |
|
1243 |
DeprecationWarning) |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
1244 |
del self._get_parser()[section]['recurse'] |
2120.6.9
by James Henstridge
Fixes for issues brought up in John's review |
1245 |
if not recurse: |
1246 |
for key in self._get_parser()[section].keys(): |
|
1247 |
if not key.endswith(':policy'): |
|
1248 |
self._get_parser()[section][key + |
|
1249 |
':policy'] = 'norecurse' |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
1250 |
|
2120.6.9
by James Henstridge
Fixes for issues brought up in John's review |
1251 |
policy_key = option_name + ':policy' |
2120.6.8
by James Henstridge
Change syntax for setting config option policies. Rather than |
1252 |
policy_name = _policy_name[option_policy] |
1253 |
if policy_name is not None: |
|
1254 |
self._get_parser()[section][policy_key] = policy_name |
|
1255 |
else: |
|
1256 |
if policy_key in self._get_parser()[section]: |
|
1257 |
del self._get_parser()[section][policy_key] |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
1258 |
|
5345.5.7
by Vincent Ladeuil
Make LocationConfig use a lock too. |
1259 |
@needs_write_lock
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
1260 |
def set_user_option(self, option, value, store=STORE_LOCATION): |
1490
by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1. |
1261 |
"""Save option and its value in the configuration."""
|
3376.2.4
by Martin Pool
Remove every assert statement from bzrlib! |
1262 |
if store not in [STORE_LOCATION, |
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
1263 |
STORE_LOCATION_NORECURSE, |
3376.2.4
by Martin Pool
Remove every assert statement from bzrlib! |
1264 |
STORE_LOCATION_APPENDPATH]: |
1265 |
raise ValueError('bad storage policy %r for %r' % |
|
1266 |
(store, option)) |
|
5345.5.1
by Vincent Ladeuil
Implement config.reload and make sure we have a file name when using it. |
1267 |
self.reload() |
1490
by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1. |
1268 |
location = self.location |
1269 |
if location.endswith('/'): |
|
1270 |
location = location[:-1] |
|
5345.1.24
by Vincent Ladeuil
Implement _save for LockableConfig too. |
1271 |
parser = self._get_parser() |
5345.1.21
by Vincent Ladeuil
Slight rewrite to make the method more readable. |
1272 |
if not location in parser and not location + '/' in parser: |
1273 |
parser[location] = {} |
|
1274 |
elif location + '/' in parser: |
|
1490
by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1. |
1275 |
location = location + '/' |
5345.1.21
by Vincent Ladeuil
Slight rewrite to make the method more readable. |
1276 |
parser[location][option]=value |
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
1277 |
# the allowed values of store match the config policies
|
1278 |
self._set_option_policy(location, option, store) |
|
4708.2.1
by Martin
Ensure all files opened by bazaar proper are explicitly closed |
1279 |
self._write_config_file() |
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
1280 |
for hook in OldConfigHooks['set']: |
5743.8.13
by Vincent Ladeuil
Fix config calls for the actual implementation, including typos in parameters and TransportConfig support. |
1281 |
hook(self, option, value) |
1490
by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1. |
1282 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
1283 |
|
1284 |
class BranchConfig(Config): |
|
1285 |
"""A configuration object giving the policy for a branch."""
|
|
1286 |
||
5345.1.3
by Vincent Ladeuil
Make __init__ the first method in the BranchConfig class. |
1287 |
def __init__(self, branch): |
1288 |
super(BranchConfig, self).__init__() |
|
1289 |
self._location_config = None |
|
1290 |
self._branch_data_config = None |
|
1291 |
self._global_config = None |
|
1292 |
self.branch = branch |
|
1293 |
self.option_sources = (self._get_location_config, |
|
1294 |
self._get_branch_data_config, |
|
1295 |
self._get_global_config) |
|
1296 |
||
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
1297 |
def config_id(self): |
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
1298 |
return 'branch' |
1299 |
||
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1300 |
def _get_branch_data_config(self): |
1301 |
if self._branch_data_config is None: |
|
1302 |
self._branch_data_config = TreeConfig(self.branch) |
|
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
1303 |
self._branch_data_config.config_id = self.config_id |
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1304 |
return self._branch_data_config |
1305 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
1306 |
def _get_location_config(self): |
1307 |
if self._location_config is None: |
|
1308 |
self._location_config = LocationConfig(self.branch.base) |
|
1309 |
return self._location_config |
|
1310 |
||
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1311 |
def _get_global_config(self): |
1312 |
if self._global_config is None: |
|
1313 |
self._global_config = GlobalConfig() |
|
1314 |
return self._global_config |
|
1315 |
||
1316 |
def _get_best_value(self, option_name): |
|
1317 |
"""This returns a user option from local, tree or global config.
|
|
1318 |
||
1319 |
They are tried in that order. Use get_safe_value if trusted values
|
|
1320 |
are necessary.
|
|
1321 |
"""
|
|
1322 |
for source in self.option_sources: |
|
1323 |
value = getattr(source(), option_name)() |
|
1324 |
if value is not None: |
|
1325 |
return value |
|
1326 |
return None |
|
1327 |
||
1328 |
def _get_safe_value(self, option_name): |
|
1329 |
"""This variant of get_best_value never returns untrusted values.
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
1330 |
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1331 |
It does not return values from the branch data, because the branch may
|
1332 |
not be controlled by the user.
|
|
1333 |
||
1334 |
We may wish to allow locations.conf to control whether branches are
|
|
1335 |
trusted in the future.
|
|
1336 |
"""
|
|
1337 |
for source in (self._get_location_config, self._get_global_config): |
|
1338 |
value = getattr(source(), option_name)() |
|
1339 |
if value is not None: |
|
1340 |
return value |
|
1341 |
return None |
|
1342 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
1343 |
def _get_user_id(self): |
1344 |
"""Return the full user id for the branch.
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
1345 |
|
3407.2.14
by Martin Pool
Remove more cases of getting transport via control_files |
1346 |
e.g. "John Hacker <jhacker@example.com>"
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
1347 |
This is looked up in the email controlfile for the branch.
|
1348 |
"""
|
|
1349 |
try: |
|
3407.2.16
by Martin Pool
Remove RemoteBranch reliance on control_files._transport |
1350 |
return (self.branch._transport.get_bytes("email") |
3224.5.4
by Andrew Bennetts
Fix test suite, mainly weeding out uses of bzrlib.user_encoding. |
1351 |
.decode(osutils.get_user_encoding()) |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
1352 |
.rstrip("\r\n")) |
1353 |
except errors.NoSuchFile, e: |
|
1354 |
pass
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
1355 |
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1356 |
return self._get_best_value('_get_user_id') |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
1357 |
|
4603.1.10
by Aaron Bentley
Provide change editor via config. |
1358 |
def _get_change_editor(self): |
1359 |
return self._get_best_value('_get_change_editor') |
|
1360 |
||
1442.1.19
by Robert Collins
BranchConfigs inherit signature_checking policy from their LocationConfig. |
1361 |
def _get_signature_checking(self): |
1362 |
"""See Config._get_signature_checking."""
|
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1363 |
return self._get_best_value('_get_signature_checking') |
1442.1.19
by Robert Collins
BranchConfigs inherit signature_checking policy from their LocationConfig. |
1364 |
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
1365 |
def _get_signing_policy(self): |
1366 |
"""See Config._get_signing_policy."""
|
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1367 |
return self._get_best_value('_get_signing_policy') |
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
1368 |
|
1993.3.6
by James Henstridge
get rid of the recurse argument to get_user_option() |
1369 |
def _get_user_option(self, option_name): |
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
1370 |
"""See Config._get_user_option."""
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1371 |
for source in self.option_sources: |
1993.3.6
by James Henstridge
get rid of the recurse argument to get_user_option() |
1372 |
value = source()._get_user_option(option_name) |
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1373 |
if value is not None: |
1374 |
return value |
|
1375 |
return None |
|
1376 |
||
5447.4.12
by Vincent Ladeuil
Turn get_options() and get_sections() into private methods because section handling is too messy and needs to be discussed and settled. |
1377 |
def _get_sections(self, name=None): |
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
1378 |
"""See IniBasedConfig.get_sections()."""
|
1379 |
for source in self.option_sources: |
|
5447.4.12
by Vincent Ladeuil
Turn get_options() and get_sections() into private methods because section handling is too messy and needs to be discussed and settled. |
1380 |
for section in source()._get_sections(name): |
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
1381 |
yield section |
1382 |
||
5447.4.12
by Vincent Ladeuil
Turn get_options() and get_sections() into private methods because section handling is too messy and needs to be discussed and settled. |
1383 |
def _get_options(self, sections=None): |
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
1384 |
opts = [] |
1385 |
# First the locations options
|
|
5447.4.12
by Vincent Ladeuil
Turn get_options() and get_sections() into private methods because section handling is too messy and needs to be discussed and settled. |
1386 |
for option in self._get_location_config()._get_options(): |
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
1387 |
yield option |
1388 |
# Then the branch options
|
|
5447.4.1
by Vincent Ladeuil
Implement config.get_options_matching_regexp. |
1389 |
branch_config = self._get_branch_data_config() |
1390 |
if sections is None: |
|
1391 |
sections = [('DEFAULT', branch_config._get_parser())] |
|
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
1392 |
# FIXME: We shouldn't have to duplicate the code in IniBasedConfig but
|
1393 |
# Config itself has no notion of sections :( -- vila 20101001
|
|
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
1394 |
config_id = self.config_id() |
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
1395 |
for (section_name, section) in sections: |
1396 |
for (name, value) in section.iteritems(): |
|
5533.2.1
by Vincent Ladeuil
``bzr config`` properly displays list values |
1397 |
yield (name, value, section_name, |
1398 |
config_id, branch_config._get_parser()) |
|
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
1399 |
# Then the global options
|
5447.4.12
by Vincent Ladeuil
Turn get_options() and get_sections() into private methods because section handling is too messy and needs to be discussed and settled. |
1400 |
for option in self._get_global_config()._get_options(): |
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
1401 |
yield option |
5447.4.1
by Vincent Ladeuil
Implement config.get_options_matching_regexp. |
1402 |
|
1551.15.35
by Aaron Bentley
Warn when setting config values that will be masked (#122286) |
1403 |
def set_user_option(self, name, value, store=STORE_BRANCH, |
1404 |
warn_masked=False): |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
1405 |
if store == STORE_BRANCH: |
1770.2.6
by Aaron Bentley
Ensure branch.conf works properly |
1406 |
self._get_branch_data_config().set_option(value, name) |
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
1407 |
elif store == STORE_GLOBAL: |
2120.6.7
by James Henstridge
Fix GlobalConfig.set_user_option() call |
1408 |
self._get_global_config().set_user_option(name, value) |
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
1409 |
else: |
1410 |
self._get_location_config().set_user_option(name, value, store) |
|
1551.15.35
by Aaron Bentley
Warn when setting config values that will be masked (#122286) |
1411 |
if not warn_masked: |
1412 |
return
|
|
1413 |
if store in (STORE_GLOBAL, STORE_BRANCH): |
|
1414 |
mask_value = self._get_location_config().get_user_option(name) |
|
1415 |
if mask_value is not None: |
|
1416 |
trace.warning('Value "%s" is masked by "%s" from' |
|
1417 |
' locations.conf', value, mask_value) |
|
1418 |
else: |
|
1419 |
if store == STORE_GLOBAL: |
|
1420 |
branch_config = self._get_branch_data_config() |
|
1421 |
mask_value = branch_config.get_user_option(name) |
|
1422 |
if mask_value is not None: |
|
1423 |
trace.warning('Value "%s" is masked by "%s" from' |
|
1551.15.37
by Aaron Bentley
Don't treat a format string as a normal string |
1424 |
' branch.conf', value, mask_value) |
1551.15.35
by Aaron Bentley
Warn when setting config values that will be masked (#122286) |
1425 |
|
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
1426 |
def remove_user_option(self, option_name, section_name=None): |
1427 |
self._get_branch_data_config().remove_option(option_name, section_name) |
|
1428 |
||
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
1429 |
def _gpg_signing_command(self): |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
1430 |
"""See Config.gpg_signing_command."""
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1431 |
return self._get_safe_value('_gpg_signing_command') |
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
1432 |
|
1472
by Robert Collins
post commit hook, first pass implementation |
1433 |
def _post_commit(self): |
1434 |
"""See Config.post_commit."""
|
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1435 |
return self._get_safe_value('_post_commit') |
1472
by Robert Collins
post commit hook, first pass implementation |
1436 |
|
1770.2.7
by Aaron Bentley
Set/get nickname using BranchConfig |
1437 |
def _get_nickname(self): |
1824.1.1
by Robert Collins
Add BranchConfig.has_explicit_nickname call. |
1438 |
value = self._get_explicit_nickname() |
1770.2.7
by Aaron Bentley
Set/get nickname using BranchConfig |
1439 |
if value is not None: |
1440 |
return value |
|
2120.5.2
by Alexander Belchenko
(jam) Fix for bug #66857 |
1441 |
return urlutils.unescape(self.branch.base.split('/')[-2]) |
1770.2.7
by Aaron Bentley
Set/get nickname using BranchConfig |
1442 |
|
1824.1.1
by Robert Collins
Add BranchConfig.has_explicit_nickname call. |
1443 |
def has_explicit_nickname(self): |
1444 |
"""Return true if a nickname has been explicitly assigned."""
|
|
1445 |
return self._get_explicit_nickname() is not None |
|
1446 |
||
1447 |
def _get_explicit_nickname(self): |
|
1448 |
return self._get_best_value('_get_nickname') |
|
1449 |
||
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
1450 |
def _log_format(self): |
1451 |
"""See Config.log_format."""
|
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1452 |
return self._get_best_value('_log_format') |
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
1453 |
|
5971.1.55
by Jonathan Riddell
add a config option to validate signatures |
1454 |
def _validate_signatures_in_log(self): |
1455 |
"""See Config.validate_signatures_in_log."""
|
|
1456 |
return self._get_best_value('_validate_signatures_in_log') |
|
1457 |
||
5971.1.56
by Jonathan Riddell
add an option for acceptable_keys in config, also make config docs match reality for signature options |
1458 |
def _acceptable_keys(self): |
1459 |
"""See Config.acceptable_keys."""
|
|
1460 |
return self._get_best_value('_acceptable_keys') |
|
1461 |
||
1553.6.12
by Erik Bågfors
remove AliasConfig, based on input from abentley |
1462 |
|
1185.31.43
by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp |
1463 |
def ensure_config_dir_exists(path=None): |
5519.4.4
by Neil Martinsen-Burrell
restore ensure_config_dir since XDG_CONFIG_HOME is optional |
1464 |
"""Make sure a configuration directory exists.
|
1465 |
This makes sure that the directory exists.
|
|
1466 |
On windows, since configuration directories are 2 levels deep,
|
|
1467 |
it makes sure both the directory and the parent directory exists.
|
|
1185.31.43
by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp |
1468 |
"""
|
1469 |
if path is None: |
|
1470 |
path = config_dir() |
|
1471 |
if not os.path.isdir(path): |
|
5519.4.4
by Neil Martinsen-Burrell
restore ensure_config_dir since XDG_CONFIG_HOME is optional |
1472 |
if sys.platform == 'win32': |
1473 |
parent_dir = os.path.dirname(path) |
|
1474 |
if not os.path.isdir(parent_dir): |
|
1475 |
trace.mutter('creating config parent directory: %r', parent_dir) |
|
1476 |
os.mkdir(parent_dir) |
|
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
1477 |
trace.mutter('creating config directory: %r', path) |
5116.2.4
by Parth Malwankar
removed mkdir_with_ownership as its probably cleaner to just use copy_ownership |
1478 |
os.mkdir(path) |
5116.2.6
by Parth Malwankar
renamed copy_ownership to copy_ownership_from_path. |
1479 |
osutils.copy_ownership_from_path(path) |
1185.31.43
by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp |
1480 |
|
1532
by Robert Collins
Merge in John Meinels integration branch. |
1481 |
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
1482 |
def config_dir(): |
1483 |
"""Return per-user configuration directory.
|
|
1484 |
||
5519.4.1
by Neil Martinsen-Burrell
spec and first implementation, next tests |
1485 |
By default this is %APPDATA%/bazaar/2.0 on Windows, ~/.bazaar on Mac OS X
|
5519.4.3
by Neil Martinsen-Burrell
be permissive about using $XDG_CONFIG_HOME/bazaar, but dont complain |
1486 |
and Linux. On Linux, if there is a $XDG_CONFIG_HOME/bazaar directory,
|
1487 |
that will be used instead.
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
1488 |
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
1489 |
TODO: Global option --config-dir to override this.
|
1490 |
"""
|
|
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
1491 |
base = os.environ.get('BZR_HOME', None) |
1492 |
if sys.platform == 'win32': |
|
5598.2.2
by John Arbash Meinel
Change the comment slightly |
1493 |
# environ variables on Windows are in user encoding/mbcs. So decode
|
1494 |
# before using one
|
|
5598.2.1
by John Arbash Meinel
Decode windows env vars using mbcs rather than assuming the 8-bit string is ok. |
1495 |
if base is not None: |
1496 |
base = base.decode('mbcs') |
|
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
1497 |
if base is None: |
2245.4.3
by Alexander Belchenko
config.py: changing _auto_user_id() and config_dir() to use functions from win32utils |
1498 |
base = win32utils.get_appdata_location_unicode() |
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
1499 |
if base is None: |
1500 |
base = os.environ.get('HOME', None) |
|
5598.2.1
by John Arbash Meinel
Decode windows env vars using mbcs rather than assuming the 8-bit string is ok. |
1501 |
if base is not None: |
1502 |
base = base.decode('mbcs') |
|
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
1503 |
if base is None: |
2991.2.2
by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0. |
1504 |
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,' |
1505 |
' or HOME set') |
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
1506 |
return osutils.pathjoin(base, 'bazaar', '2.0') |
5519.4.1
by Neil Martinsen-Burrell
spec and first implementation, next tests |
1507 |
elif sys.platform == 'darwin': |
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
1508 |
if base is None: |
5519.4.1
by Neil Martinsen-Burrell
spec and first implementation, next tests |
1509 |
# this takes into account $HOME
|
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
1510 |
base = os.path.expanduser("~") |
5519.4.1
by Neil Martinsen-Burrell
spec and first implementation, next tests |
1511 |
return osutils.pathjoin(base, '.bazaar') |
1512 |
else: |
|
1513 |
if base is None: |
|
5519.4.3
by Neil Martinsen-Burrell
be permissive about using $XDG_CONFIG_HOME/bazaar, but dont complain |
1514 |
|
1515 |
xdg_dir = os.environ.get('XDG_CONFIG_HOME', None) |
|
1516 |
if xdg_dir is None: |
|
1517 |
xdg_dir = osutils.pathjoin(os.path.expanduser("~"), ".config") |
|
1518 |
xdg_dir = osutils.pathjoin(xdg_dir, 'bazaar') |
|
1519 |
if osutils.isdir(xdg_dir): |
|
1520 |
trace.mutter( |
|
1521 |
"Using configuration in XDG directory %s." % xdg_dir) |
|
1522 |
return xdg_dir |
|
1523 |
||
1524 |
base = os.path.expanduser("~") |
|
5519.4.4
by Neil Martinsen-Burrell
restore ensure_config_dir since XDG_CONFIG_HOME is optional |
1525 |
return osutils.pathjoin(base, ".bazaar") |
1185.31.32
by John Arbash Meinel
Updated the bzr sourcecode to use bzrlib.osutils.pathjoin rather than os.path.join to enforce internal use of / instead of \ |
1526 |
|
1527 |
||
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
1528 |
def config_filename(): |
1529 |
"""Return per-user configuration ini file filename."""
|
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
1530 |
return osutils.pathjoin(config_dir(), 'bazaar.conf') |
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
1531 |
|
1532 |
||
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
1533 |
def locations_config_filename(): |
1534 |
"""Return per-user configuration ini file filename."""
|
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
1535 |
return osutils.pathjoin(config_dir(), 'locations.conf') |
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
1536 |
|
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
1537 |
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1538 |
def authentication_config_filename(): |
1539 |
"""Return per-user authentication ini file filename."""
|
|
1540 |
return osutils.pathjoin(config_dir(), 'authentication.conf') |
|
1541 |
||
1542 |
||
1836.1.6
by John Arbash Meinel
Creating a helper function for getting the user ignore filename |
1543 |
def user_ignore_config_filename(): |
1544 |
"""Return the user default ignore filename"""
|
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
1545 |
return osutils.pathjoin(config_dir(), 'ignore') |
1836.1.6
by John Arbash Meinel
Creating a helper function for getting the user ignore filename |
1546 |
|
1547 |
||
4584.3.4
by Martin Pool
Add crash_dir and xdg_cache_dir functions |
1548 |
def crash_dir(): |
1549 |
"""Return the directory name to store crash files.
|
|
1550 |
||
1551 |
This doesn't implicitly create it.
|
|
1552 |
||
4634.128.2
by Martin Pool
Write crash files into /var/crash where apport can see them. |
1553 |
On Windows it's in the config directory; elsewhere it's /var/crash
|
4634.128.18
by Martin Pool
Update apport crash tests |
1554 |
which may be monitored by apport. It can be overridden by
|
1555 |
$APPORT_CRASH_DIR.
|
|
4584.3.4
by Martin Pool
Add crash_dir and xdg_cache_dir functions |
1556 |
"""
|
1557 |
if sys.platform == 'win32': |
|
1558 |
return osutils.pathjoin(config_dir(), 'Crash') |
|
1559 |
else: |
|
4634.128.2
by Martin Pool
Write crash files into /var/crash where apport can see them. |
1560 |
# XXX: hardcoded in apport_python_hook.py; therefore here too -- mbp
|
1561 |
# 2010-01-31
|
|
4634.128.18
by Martin Pool
Update apport crash tests |
1562 |
return os.environ.get('APPORT_CRASH_DIR', '/var/crash') |
4584.3.4
by Martin Pool
Add crash_dir and xdg_cache_dir functions |
1563 |
|
1564 |
||
1565 |
def xdg_cache_dir(): |
|
4584.3.23
by Martin Pool
Correction to xdg_cache_dir and add a simple test |
1566 |
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
|
1567 |
# Possibly this should be different on Windows?
|
|
1568 |
e = os.environ.get('XDG_CACHE_DIR', None) |
|
1569 |
if e: |
|
1570 |
return e |
|
1571 |
else: |
|
1572 |
return os.path.expanduser('~/.cache') |
|
4584.3.4
by Martin Pool
Add crash_dir and xdg_cache_dir functions |
1573 |
|
1574 |
||
5050.72.1
by Martin Pool
Set email address from /etc/mailname if possible |
1575 |
def _get_default_mail_domain(): |
1576 |
"""If possible, return the assumed default email domain.
|
|
1577 |
||
1578 |
:returns: string mail domain, or None.
|
|
1579 |
"""
|
|
1580 |
if sys.platform == 'win32': |
|
1581 |
# No implementation yet; patches welcome
|
|
1582 |
return None |
|
1583 |
try: |
|
1584 |
f = open('/etc/mailname') |
|
1585 |
except (IOError, OSError), e: |
|
1586 |
return None |
|
1587 |
try: |
|
1588 |
domain = f.read().strip() |
|
1589 |
return domain |
|
1590 |
finally: |
|
1591 |
f.close() |
|
1592 |
||
1593 |
||
1594 |
def _auto_user_id(): |
|
1595 |
"""Calculate automatic user identification.
|
|
1596 |
||
1597 |
:returns: (realname, email), either of which may be None if they can't be
|
|
1598 |
determined.
|
|
1599 |
||
1600 |
Only used when none is set in the environment or the id file.
|
|
1601 |
||
1602 |
This only returns an email address if we can be fairly sure the
|
|
1603 |
address is reasonable, ie if /etc/mailname is set on unix.
|
|
1604 |
||
1605 |
This doesn't use the FQDN as the default domain because that may be
|
|
1606 |
slow, and it doesn't use the hostname alone because that's not normally
|
|
1607 |
a reasonable address.
|
|
1608 |
"""
|
|
1609 |
if sys.platform == 'win32': |
|
1610 |
# No implementation to reliably determine Windows default mail
|
|
1611 |
# address; please add one.
|
|
1612 |
return None, None |
|
1613 |
||
1614 |
default_mail_domain = _get_default_mail_domain() |
|
1615 |
if not default_mail_domain: |
|
1616 |
return None, None |
|
1617 |
||
1618 |
import pwd |
|
1619 |
uid = os.getuid() |
|
1620 |
try: |
|
1621 |
w = pwd.getpwuid(uid) |
|
1622 |
except KeyError: |
|
5904.1.2
by Martin Pool
Various pyflakes import fixes. |
1623 |
trace.mutter('no passwd entry for uid %d?' % uid) |
5050.72.1
by Martin Pool
Set email address from /etc/mailname if possible |
1624 |
return None, None |
1625 |
||
1626 |
# we try utf-8 first, because on many variants (like Linux),
|
|
1627 |
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
|
|
1628 |
# false positives. (many users will have their user encoding set to
|
|
1629 |
# latin-1, which cannot raise UnicodeError.)
|
|
1630 |
try: |
|
1631 |
gecos = w.pw_gecos.decode('utf-8') |
|
1632 |
encoding = 'utf-8' |
|
1633 |
except UnicodeError: |
|
1634 |
try: |
|
1635 |
encoding = osutils.get_user_encoding() |
|
1636 |
gecos = w.pw_gecos.decode(encoding) |
|
1637 |
except UnicodeError, e: |
|
5904.1.2
by Martin Pool
Various pyflakes import fixes. |
1638 |
trace.mutter("cannot decode passwd entry %s" % w) |
5050.72.1
by Martin Pool
Set email address from /etc/mailname if possible |
1639 |
return None, None |
1640 |
try: |
|
1641 |
username = w.pw_name.decode(encoding) |
|
1642 |
except UnicodeError, e: |
|
5904.1.2
by Martin Pool
Various pyflakes import fixes. |
1643 |
trace.mutter("cannot decode passwd entry %s" % w) |
5050.72.1
by Martin Pool
Set email address from /etc/mailname if possible |
1644 |
return None, None |
1645 |
||
1646 |
comma = gecos.find(',') |
|
1647 |
if comma == -1: |
|
1648 |
realname = gecos |
|
1649 |
else: |
|
1650 |
realname = gecos[:comma] |
|
1651 |
||
1652 |
return realname, (username + '@' + default_mail_domain) |
|
1653 |
||
1654 |
||
3063.3.2
by Lukáš Lalinský
Move the name and e-mail address extraction logic to config.parse_username. |
1655 |
def parse_username(username): |
1656 |
"""Parse e-mail username and return a (name, address) tuple."""
|
|
1657 |
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username) |
|
1658 |
if match is None: |
|
1659 |
return (username, '') |
|
1660 |
else: |
|
1661 |
return (match.group(1), match.group(2)) |
|
1662 |
||
1663 |
||
1185.16.52
by Martin Pool
- add extract_email_address |
1664 |
def extract_email_address(e): |
1665 |
"""Return just the address part of an email string.
|
|
3063.3.2
by Lukáš Lalinský
Move the name and e-mail address extraction logic to config.parse_username. |
1666 |
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
1667 |
That is just the user@domain part, nothing else.
|
1185.16.52
by Martin Pool
- add extract_email_address |
1668 |
This part is required to contain only ascii characters.
|
1669 |
If it can't be extracted, raises an error.
|
|
3063.3.2
by Lukáš Lalinský
Move the name and e-mail address extraction logic to config.parse_username. |
1670 |
|
1185.16.52
by Martin Pool
- add extract_email_address |
1671 |
>>> extract_email_address('Jane Tester <jane@test.com>')
|
1672 |
"jane@test.com"
|
|
1673 |
"""
|
|
3063.3.2
by Lukáš Lalinský
Move the name and e-mail address extraction logic to config.parse_username. |
1674 |
name, email = parse_username(e) |
1675 |
if not email: |
|
2055.2.2
by John Arbash Meinel
Switch extract_email_address() to use a more specific exception |
1676 |
raise errors.NoEmailInUsername(e) |
3063.3.2
by Lukáš Lalinský
Move the name and e-mail address extraction logic to config.parse_username. |
1677 |
return email |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
1678 |
|
1185.85.30
by John Arbash Meinel
Fixing 'bzr push' exposed that IniBasedConfig didn't handle unicode. |
1679 |
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1680 |
class TreeConfig(IniBasedConfig): |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
1681 |
"""Branch configuration data associated with its contents, not location"""
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1682 |
|
3408.3.1
by Martin Pool
Remove erroneous handling of branch.conf for RemoteBranch |
1683 |
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
|
1684 |
||
1185.35.11
by Aaron Bentley
Added support for branch nicks |
1685 |
def __init__(self, branch): |
4226.1.5
by Robert Collins
Reinstate the use of the Branch.get_config_file verb. |
1686 |
self._config = branch._get_config() |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
1687 |
self.branch = branch |
1688 |
||
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
1689 |
def _get_parser(self, file=None): |
1690 |
if file is not None: |
|
1691 |
return IniBasedConfig._get_parser(file) |
|
3242.1.2
by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication |
1692 |
return self._config._get_configobj() |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
1693 |
|
1694 |
def get_option(self, name, section=None, default=None): |
|
1695 |
self.branch.lock_read() |
|
1696 |
try: |
|
3242.1.2
by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication |
1697 |
return self._config.get_option(name, section, default) |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
1698 |
finally: |
1699 |
self.branch.unlock() |
|
1700 |
||
1701 |
def set_option(self, value, name, section=None): |
|
1702 |
"""Set a per-branch configuration option"""
|
|
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
1703 |
# FIXME: We shouldn't need to lock explicitly here but rather rely on
|
1704 |
# higher levels providing the right lock -- vila 20101004
|
|
1185.35.11
by Aaron Bentley
Added support for branch nicks |
1705 |
self.branch.lock_write() |
1706 |
try: |
|
3242.1.2
by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication |
1707 |
self._config.set_option(value, name, section) |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
1708 |
finally: |
1709 |
self.branch.unlock() |
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1710 |
|
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
1711 |
def remove_option(self, option_name, section_name=None): |
1712 |
# FIXME: We shouldn't need to lock explicitly here but rather rely on
|
|
1713 |
# higher levels providing the right lock -- vila 20101004
|
|
1714 |
self.branch.lock_write() |
|
1715 |
try: |
|
1716 |
self._config.remove_option(option_name, section_name) |
|
1717 |
finally: |
|
1718 |
self.branch.unlock() |
|
1719 |
||
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1720 |
|
1721 |
class AuthenticationConfig(object): |
|
1722 |
"""The authentication configuration file based on a ini file.
|
|
1723 |
||
1724 |
Implements the authentication.conf file described in
|
|
1725 |
doc/developers/authentication-ring.txt.
|
|
1726 |
"""
|
|
1727 |
||
1728 |
def __init__(self, _file=None): |
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1729 |
self._config = None # The ConfigObj |
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1730 |
if _file is None: |
2900.2.24
by Vincent Ladeuil
Review feedback. |
1731 |
self._filename = authentication_config_filename() |
1732 |
self._input = self._filename = authentication_config_filename() |
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1733 |
else: |
2900.2.24
by Vincent Ladeuil
Review feedback. |
1734 |
# Tests can provide a string as _file
|
1735 |
self._filename = None |
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1736 |
self._input = _file |
1737 |
||
1738 |
def _get_config(self): |
|
1739 |
if self._config is not None: |
|
1740 |
return self._config |
|
1741 |
try: |
|
2900.2.22
by Vincent Ladeuil
Polishing. |
1742 |
# FIXME: Should we validate something here ? Includes: empty
|
1743 |
# sections are useless, at least one of
|
|
1744 |
# user/password/password_encoding should be defined, etc.
|
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1745 |
|
1746 |
# Note: the encoding below declares that the file itself is utf-8
|
|
1747 |
# encoded, but the values in the ConfigObj are always Unicode.
|
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1748 |
self._config = ConfigObj(self._input, encoding='utf-8') |
1749 |
except configobj.ConfigObjError, e: |
|
1750 |
raise errors.ParseConfigError(e.errors, e.config.filename) |
|
5987.1.4
by Vincent Ladeuil
Proper error messages for config files with content in non-utf encoding or that cannot be parsed |
1751 |
except UnicodeError: |
5987.1.3
by Vincent Ladeuil
Proper message when authentication.conf has non-utf8 content |
1752 |
raise errors.ConfigContentError(self._filename) |
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1753 |
return self._config |
1754 |
||
2900.2.5
by Vincent Ladeuil
ake ftp aware of authentication config. |
1755 |
def _save(self): |
1756 |
"""Save the config file, only tests should use it for now."""
|
|
2900.2.26
by Vincent Ladeuil
Fix forgotten reference to _get_filename and duplicated code. |
1757 |
conf_dir = os.path.dirname(self._filename) |
2900.2.5
by Vincent Ladeuil
ake ftp aware of authentication config. |
1758 |
ensure_config_dir_exists(conf_dir) |
4708.2.2
by Martin
Workingtree changes sitting around since November, more explict closing of files in bzrlib |
1759 |
f = file(self._filename, 'wb') |
1760 |
try: |
|
1761 |
self._get_config().write(f) |
|
1762 |
finally: |
|
1763 |
f.close() |
|
2900.2.5
by Vincent Ladeuil
ake ftp aware of authentication config. |
1764 |
|
1765 |
def _set_option(self, section_name, option_name, value): |
|
1766 |
"""Set an authentication configuration option"""
|
|
1767 |
conf = self._get_config() |
|
1768 |
section = conf.get(section_name) |
|
1769 |
if section is None: |
|
1770 |
conf[section] = {} |
|
1771 |
section = conf[section] |
|
1772 |
section[option_name] = value |
|
1773 |
self._save() |
|
1774 |
||
5743.8.25
by Vincent Ladeuil
Fix spurious spaces. |
1775 |
def get_credentials(self, scheme, host, port=None, user=None, path=None, |
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1776 |
realm=None): |
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1777 |
"""Returns the matching credentials from authentication.conf file.
|
1778 |
||
1779 |
:param scheme: protocol
|
|
1780 |
||
1781 |
:param host: the server address
|
|
1782 |
||
1783 |
:param port: the associated port (optional)
|
|
1784 |
||
1785 |
:param user: login (optional)
|
|
1786 |
||
1787 |
:param path: the absolute path on the server (optional)
|
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1788 |
|
1789 |
:param realm: the http authentication realm (optional)
|
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1790 |
|
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1791 |
:return: A dict containing the matching credentials or None.
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1792 |
This includes:
|
1793 |
- name: the section name of the credentials in the
|
|
1794 |
authentication.conf file,
|
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1795 |
- user: can't be different from the provided user if any,
|
4107.1.7
by Jean-Francois Roy
No longer deleting the extra credentials keys in get_credentials. |
1796 |
- scheme: the server protocol,
|
1797 |
- host: the server address,
|
|
1798 |
- port: the server port (can be None),
|
|
1799 |
- path: the absolute server path (can be None),
|
|
1800 |
- realm: the http specific authentication realm (can be None),
|
|
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1801 |
- password: the decoded password, could be None if the credential
|
1802 |
defines only the user
|
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1803 |
- verify_certificates: https specific, True if the server
|
1804 |
certificate should be verified, False otherwise.
|
|
1805 |
"""
|
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1806 |
credentials = None |
1807 |
for auth_def_name, auth_def in self._get_config().items(): |
|
3418.2.1
by Vincent Ladeuil
Fix #217650 by catching declarations outside sections. |
1808 |
if type(auth_def) is not configobj.Section: |
1809 |
raise ValueError("%s defined outside a section" % auth_def_name) |
|
1810 |
||
2900.2.5
by Vincent Ladeuil
ake ftp aware of authentication config. |
1811 |
a_scheme, a_host, a_user, a_path = map( |
1812 |
auth_def.get, ['scheme', 'host', 'user', 'path']) |
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1813 |
|
2900.2.5
by Vincent Ladeuil
ake ftp aware of authentication config. |
1814 |
try: |
1815 |
a_port = auth_def.as_int('port') |
|
1816 |
except KeyError: |
|
1817 |
a_port = None |
|
2900.2.22
by Vincent Ladeuil
Polishing. |
1818 |
except ValueError: |
1819 |
raise ValueError("'port' not numeric in %s" % auth_def_name) |
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1820 |
try: |
1821 |
a_verify_certificates = auth_def.as_bool('verify_certificates') |
|
1822 |
except KeyError: |
|
1823 |
a_verify_certificates = True |
|
2900.2.22
by Vincent Ladeuil
Polishing. |
1824 |
except ValueError: |
1825 |
raise ValueError( |
|
1826 |
"'verify_certificates' not boolean in %s" % auth_def_name) |
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1827 |
|
1828 |
# Attempt matching
|
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1829 |
if a_scheme is not None and scheme != a_scheme: |
1830 |
continue
|
|
1831 |
if a_host is not None: |
|
1832 |
if not (host == a_host |
|
1833 |
or (a_host.startswith('.') and host.endswith(a_host))): |
|
1834 |
continue
|
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1835 |
if a_port is not None and port != a_port: |
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1836 |
continue
|
1837 |
if (a_path is not None and path is not None |
|
1838 |
and not path.startswith(a_path)): |
|
1839 |
continue
|
|
1840 |
if (a_user is not None and user is not None |
|
1841 |
and a_user != user): |
|
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
1842 |
# Never contradict the caller about the user to be used
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1843 |
continue
|
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1844 |
if a_user is None: |
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1845 |
# Can't find a user
|
1846 |
continue
|
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1847 |
# Prepare a credentials dictionary with additional keys
|
1848 |
# for the credential providers
|
|
2900.2.24
by Vincent Ladeuil
Review feedback. |
1849 |
credentials = dict(name=auth_def_name, |
3418.4.2
by Vincent Ladeuil
Fix bug #199440 by taking into account that a section may not |
1850 |
user=a_user, |
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1851 |
scheme=a_scheme, |
1852 |
host=host, |
|
1853 |
port=port, |
|
1854 |
path=path, |
|
1855 |
realm=realm, |
|
3418.4.2
by Vincent Ladeuil
Fix bug #199440 by taking into account that a section may not |
1856 |
password=auth_def.get('password', None), |
2900.2.24
by Vincent Ladeuil
Review feedback. |
1857 |
verify_certificates=a_verify_certificates) |
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1858 |
# Decode the password in the credentials (or get one)
|
2900.2.22
by Vincent Ladeuil
Polishing. |
1859 |
self.decode_password(credentials, |
1860 |
auth_def.get('password_encoding', None)) |
|
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
1861 |
if 'auth' in debug.debug_flags: |
1862 |
trace.mutter("Using authentication section: %r", auth_def_name) |
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1863 |
break
|
1864 |
||
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1865 |
if credentials is None: |
1866 |
# No credentials were found in authentication.conf, try the fallback
|
|
1867 |
# credentials stores.
|
|
1868 |
credentials = credential_store_registry.get_fallback_credentials( |
|
1869 |
scheme, host, port, user, path, realm) |
|
1870 |
||
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1871 |
return credentials |
1872 |
||
3777.3.2
by Aaron Bentley
Reverse order of scheme and password |
1873 |
def set_credentials(self, name, host, user, scheme=None, password=None, |
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1874 |
port=None, path=None, verify_certificates=None, |
1875 |
realm=None): |
|
3777.3.1
by Aaron Bentley
Update docs |
1876 |
"""Set authentication credentials for a host.
|
1877 |
||
1878 |
Any existing credentials with matching scheme, host, port and path
|
|
1879 |
will be deleted, regardless of name.
|
|
1880 |
||
1881 |
:param name: An arbitrary name to describe this set of credentials.
|
|
1882 |
:param host: Name of the host that accepts these credentials.
|
|
1883 |
:param user: The username portion of these credentials.
|
|
1884 |
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
|
|
1885 |
to.
|
|
3777.3.2
by Aaron Bentley
Reverse order of scheme and password |
1886 |
:param password: Password portion of these credentials.
|
3777.3.1
by Aaron Bentley
Update docs |
1887 |
:param port: The IP port on the host that these credentials apply to.
|
1888 |
:param path: A filesystem path on the host that these credentials
|
|
1889 |
apply to.
|
|
1890 |
:param verify_certificates: On https, verify server certificates if
|
|
1891 |
True.
|
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1892 |
:param realm: The http authentication realm (optional).
|
3777.3.1
by Aaron Bentley
Update docs |
1893 |
"""
|
3777.1.8
by Aaron Bentley
Commit work-in-progress |
1894 |
values = {'host': host, 'user': user} |
1895 |
if password is not None: |
|
1896 |
values['password'] = password |
|
1897 |
if scheme is not None: |
|
1898 |
values['scheme'] = scheme |
|
1899 |
if port is not None: |
|
1900 |
values['port'] = '%d' % port |
|
1901 |
if path is not None: |
|
1902 |
values['path'] = path |
|
3777.1.10
by Aaron Bentley
Ensure credentials are stored |
1903 |
if verify_certificates is not None: |
1904 |
values['verify_certificates'] = str(verify_certificates) |
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1905 |
if realm is not None: |
1906 |
values['realm'] = realm |
|
3777.1.11
by Aaron Bentley
Ensure changed-name updates clear old values |
1907 |
config = self._get_config() |
1908 |
for_deletion = [] |
|
1909 |
for section, existing_values in config.items(): |
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1910 |
for key in ('scheme', 'host', 'port', 'path', 'realm'): |
3777.1.11
by Aaron Bentley
Ensure changed-name updates clear old values |
1911 |
if existing_values.get(key) != values.get(key): |
1912 |
break
|
|
1913 |
else: |
|
1914 |
del config[section] |
|
1915 |
config.update({name: values}) |
|
3777.1.10
by Aaron Bentley
Ensure credentials are stored |
1916 |
self._save() |
3777.1.8
by Aaron Bentley
Commit work-in-progress |
1917 |
|
4304.2.1
by Vincent Ladeuil
Fix bug #367726 by reverting some default user handling introduced |
1918 |
def get_user(self, scheme, host, port=None, realm=None, path=None, |
4222.3.10
by Jelmer Vernooij
Avoid using the default username in the case of SMTP. |
1919 |
prompt=None, ask=False, default=None): |
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1920 |
"""Get a user from authentication file.
|
1921 |
||
1922 |
:param scheme: protocol
|
|
1923 |
||
1924 |
:param host: the server address
|
|
1925 |
||
1926 |
:param port: the associated port (optional)
|
|
1927 |
||
1928 |
:param realm: the realm sent by the server (optional)
|
|
1929 |
||
1930 |
:param path: the absolute path on the server (optional)
|
|
1931 |
||
4222.3.4
by Jelmer Vernooij
Default to getpass.getuser() in AuthenticationConfig.get_user(), but allow |
1932 |
:param ask: Ask the user if there is no explicitly configured username
|
1933 |
(optional)
|
|
1934 |
||
4304.2.1
by Vincent Ladeuil
Fix bug #367726 by reverting some default user handling introduced |
1935 |
:param default: The username returned if none is defined (optional).
|
1936 |
||
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1937 |
:return: The found user.
|
1938 |
"""
|
|
2900.2.16
by Vincent Ladeuil
Make hhtp proxy aware of AuthenticationConfig (for password). |
1939 |
credentials = self.get_credentials(scheme, host, port, user=None, |
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1940 |
path=path, realm=realm) |
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1941 |
if credentials is not None: |
1942 |
user = credentials['user'] |
|
1943 |
else: |
|
1944 |
user = None |
|
4222.3.2
by Jelmer Vernooij
Prompt for user names if they are not in the configuration. |
1945 |
if user is None: |
4222.3.4
by Jelmer Vernooij
Default to getpass.getuser() in AuthenticationConfig.get_user(), but allow |
1946 |
if ask: |
1947 |
if prompt is None: |
|
1948 |
# Create a default prompt suitable for most cases
|
|
5923.1.3
by Vincent Ladeuil
Even more unicode prompts fixes revealed by pqm. |
1949 |
prompt = u'%s' % (scheme.upper(),) + u' %(host)s username' |
4222.3.4
by Jelmer Vernooij
Default to getpass.getuser() in AuthenticationConfig.get_user(), but allow |
1950 |
# Special handling for optional fields in the prompt
|
1951 |
if port is not None: |
|
1952 |
prompt_host = '%s:%d' % (host, port) |
|
1953 |
else: |
|
1954 |
prompt_host = host |
|
1955 |
user = ui.ui_factory.get_username(prompt, host=prompt_host) |
|
4222.3.2
by Jelmer Vernooij
Prompt for user names if they are not in the configuration. |
1956 |
else: |
4222.3.10
by Jelmer Vernooij
Avoid using the default username in the case of SMTP. |
1957 |
user = default |
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1958 |
return user |
1959 |
||
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
1960 |
def get_password(self, scheme, host, user, port=None, |
1961 |
realm=None, path=None, prompt=None): |
|
1962 |
"""Get a password from authentication file or prompt the user for one.
|
|
1963 |
||
1964 |
:param scheme: protocol
|
|
1965 |
||
1966 |
:param host: the server address
|
|
1967 |
||
1968 |
:param port: the associated port (optional)
|
|
1969 |
||
1970 |
:param user: login
|
|
1971 |
||
1972 |
:param realm: the realm sent by the server (optional)
|
|
1973 |
||
1974 |
:param path: the absolute path on the server (optional)
|
|
1975 |
||
1976 |
:return: The found password or the one entered by the user.
|
|
1977 |
"""
|
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1978 |
credentials = self.get_credentials(scheme, host, port, user, path, |
1979 |
realm) |
|
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
1980 |
if credentials is not None: |
1981 |
password = credentials['password'] |
|
3420.1.3
by Vincent Ladeuil
John's review feedback. |
1982 |
if password is not None and scheme is 'ssh': |
3420.1.2
by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user. |
1983 |
trace.warning('password ignored in section [%s],' |
1984 |
' use an ssh agent instead'
|
|
1985 |
% credentials['name']) |
|
1986 |
password = None |
|
2900.2.16
by Vincent Ladeuil
Make hhtp proxy aware of AuthenticationConfig (for password). |
1987 |
else: |
1988 |
password = None |
|
2900.2.19
by Vincent Ladeuil
Mention proxy and https in the password prompts, with tests. |
1989 |
# Prompt user only if we could't find a password
|
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1990 |
if password is None: |
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
1991 |
if prompt is None: |
3420.1.2
by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user. |
1992 |
# Create a default prompt suitable for most cases
|
5923.1.3
by Vincent Ladeuil
Even more unicode prompts fixes revealed by pqm. |
1993 |
prompt = u'%s' % scheme.upper() + u' %(user)s@%(host)s password' |
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
1994 |
# Special handling for optional fields in the prompt
|
1995 |
if port is not None: |
|
1996 |
prompt_host = '%s:%d' % (host, port) |
|
1997 |
else: |
|
1998 |
prompt_host = host |
|
2900.2.19
by Vincent Ladeuil
Mention proxy and https in the password prompts, with tests. |
1999 |
password = ui.ui_factory.get_password(prompt, |
2000 |
host=prompt_host, user=user) |
|
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
2001 |
return password |
2002 |
||
2900.2.22
by Vincent Ladeuil
Polishing. |
2003 |
def decode_password(self, credentials, encoding): |
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
2004 |
try: |
2005 |
cs = credential_store_registry.get_credential_store(encoding) |
|
2006 |
except KeyError: |
|
2007 |
raise ValueError('%r is not a known password_encoding' % encoding) |
|
2008 |
credentials['password'] = cs.decode_password(credentials) |
|
2900.2.22
by Vincent Ladeuil
Polishing. |
2009 |
return credentials |
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
2010 |
|
3242.3.17
by Aaron Bentley
Whitespace cleanup |
2011 |
|
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
2012 |
class CredentialStoreRegistry(registry.Registry): |
2013 |
"""A class that registers credential stores.
|
|
2014 |
||
2015 |
A credential store provides access to credentials via the password_encoding
|
|
2016 |
field in authentication.conf sections.
|
|
2017 |
||
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2018 |
Except for stores provided by bzr itself, most stores are expected to be
|
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
2019 |
provided by plugins that will therefore use
|
2020 |
register_lazy(password_encoding, module_name, member_name, help=help,
|
|
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2021 |
fallback=fallback) to install themselves.
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2022 |
|
2023 |
A fallback credential store is one that is queried if no credentials can be
|
|
2024 |
found via authentication.conf.
|
|
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
2025 |
"""
|
2026 |
||
2027 |
def get_credential_store(self, encoding=None): |
|
2028 |
cs = self.get(encoding) |
|
2029 |
if callable(cs): |
|
2030 |
cs = cs() |
|
2031 |
return cs |
|
2032 |
||
4283.1.2
by Jelmer Vernooij
Add tests, NEWS item. |
2033 |
def is_fallback(self, name): |
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2034 |
"""Check if the named credentials store should be used as fallback."""
|
4283.1.2
by Jelmer Vernooij
Add tests, NEWS item. |
2035 |
return self.get_info(name) |
2036 |
||
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2037 |
def get_fallback_credentials(self, scheme, host, port=None, user=None, |
4283.1.2
by Jelmer Vernooij
Add tests, NEWS item. |
2038 |
path=None, realm=None): |
2039 |
"""Request credentials from all fallback credentials stores.
|
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2040 |
|
2041 |
The first credentials store that can provide credentials wins.
|
|
4283.1.2
by Jelmer Vernooij
Add tests, NEWS item. |
2042 |
"""
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2043 |
credentials = None |
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2044 |
for name in self.keys(): |
4283.1.2
by Jelmer Vernooij
Add tests, NEWS item. |
2045 |
if not self.is_fallback(name): |
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2046 |
continue
|
2047 |
cs = self.get_credential_store(name) |
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2048 |
credentials = cs.get_credentials(scheme, host, port, user, |
2049 |
path, realm) |
|
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2050 |
if credentials is not None: |
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2051 |
# We found some credentials
|
2052 |
break
|
|
2053 |
return credentials |
|
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2054 |
|
2055 |
def register(self, key, obj, help=None, override_existing=False, |
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2056 |
fallback=False): |
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2057 |
"""Register a new object to a name.
|
2058 |
||
2059 |
:param key: This is the key to use to request the object later.
|
|
2060 |
:param obj: The object to register.
|
|
2061 |
:param help: Help text for this entry. This may be a string or
|
|
2062 |
a callable. If it is a callable, it should take two
|
|
2063 |
parameters (registry, key): this registry and the key that
|
|
2064 |
the help was registered under.
|
|
2065 |
:param override_existing: Raise KeyErorr if False and something has
|
|
2066 |
already been registered for that key. If True, ignore if there
|
|
2067 |
is an existing key (always register the new value).
|
|
2068 |
:param fallback: Whether this credential store should be
|
|
2069 |
used as fallback.
|
|
2070 |
"""
|
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2071 |
return super(CredentialStoreRegistry, |
2072 |
self).register(key, obj, help, info=fallback, |
|
2073 |
override_existing=override_existing) |
|
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2074 |
|
2075 |
def register_lazy(self, key, module_name, member_name, |
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2076 |
help=None, override_existing=False, |
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2077 |
fallback=False): |
2078 |
"""Register a new credential store to be loaded on request.
|
|
2079 |
||
2080 |
:param module_name: The python path to the module. Such as 'os.path'.
|
|
2081 |
:param member_name: The member of the module to return. If empty or
|
|
2082 |
None, get() will return the module itself.
|
|
2083 |
:param help: Help text for this entry. This may be a string or
|
|
2084 |
a callable.
|
|
2085 |
:param override_existing: If True, replace the existing object
|
|
2086 |
with the new one. If False, if there is already something
|
|
2087 |
registered with the same key, raise a KeyError
|
|
2088 |
:param fallback: Whether this credential store should be
|
|
2089 |
used as fallback.
|
|
2090 |
"""
|
|
2091 |
return super(CredentialStoreRegistry, self).register_lazy( |
|
2092 |
key, module_name, member_name, help, |
|
2093 |
info=fallback, override_existing=override_existing) |
|
2094 |
||
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
2095 |
|
2096 |
credential_store_registry = CredentialStoreRegistry() |
|
2097 |
||
2098 |
||
2099 |
class CredentialStore(object): |
|
2100 |
"""An abstract class to implement storage for credentials"""
|
|
2101 |
||
2102 |
def decode_password(self, credentials): |
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2103 |
"""Returns a clear text password for the provided credentials."""
|
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
2104 |
raise NotImplementedError(self.decode_password) |
2105 |
||
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
2106 |
def get_credentials(self, scheme, host, port=None, user=None, path=None, |
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
2107 |
realm=None): |
2108 |
"""Return the matching credentials from this credential store.
|
|
2109 |
||
2110 |
This method is only called on fallback credential stores.
|
|
2111 |
"""
|
|
2112 |
raise NotImplementedError(self.get_credentials) |
|
2113 |
||
2114 |
||
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
2115 |
|
2116 |
class PlainTextCredentialStore(CredentialStore): |
|
5131.2.1
by Martin
Permit bzrlib to run under python -OO by explictly assigning to __doc__ for user-visible docstrings |
2117 |
__doc__ = """Plain text credential store for the authentication.conf file""" |
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
2118 |
|
2119 |
def decode_password(self, credentials): |
|
2120 |
"""See CredentialStore.decode_password."""
|
|
2121 |
return credentials['password'] |
|
2122 |
||
2123 |
||
2124 |
credential_store_registry.register('plain', PlainTextCredentialStore, |
|
2125 |
help=PlainTextCredentialStore.__doc__) |
|
2126 |
credential_store_registry.default_key = 'plain' |
|
2127 |
||
2128 |
||
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
2129 |
class BzrDirConfig(object): |
2130 |
||
4288.1.1
by Robert Collins
Add support for a RemoteBzrDirConfig to support optimising push operations which need to look for default stacking locations. |
2131 |
def __init__(self, bzrdir): |
2132 |
self._bzrdir = bzrdir |
|
2133 |
self._config = bzrdir._get_config() |
|
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
2134 |
|
3242.3.11
by Aaron Bentley
Clean up BzrDirConfig usage |
2135 |
def set_default_stack_on(self, value): |
2136 |
"""Set the default stacking location.
|
|
2137 |
||
2138 |
It may be set to a location, or None.
|
|
2139 |
||
2140 |
This policy affects all branches contained by this bzrdir, except for
|
|
2141 |
those under repositories.
|
|
2142 |
"""
|
|
4288.1.1
by Robert Collins
Add support for a RemoteBzrDirConfig to support optimising push operations which need to look for default stacking locations. |
2143 |
if self._config is None: |
2144 |
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir) |
|
3242.3.11
by Aaron Bentley
Clean up BzrDirConfig usage |
2145 |
if value is None: |
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
2146 |
self._config.set_option('', 'default_stack_on') |
3242.3.11
by Aaron Bentley
Clean up BzrDirConfig usage |
2147 |
else: |
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
2148 |
self._config.set_option(value, 'default_stack_on') |
3242.3.11
by Aaron Bentley
Clean up BzrDirConfig usage |
2149 |
|
2150 |
def get_default_stack_on(self): |
|
2151 |
"""Return the default stacking location.
|
|
2152 |
||
2153 |
This will either be a location, or None.
|
|
2154 |
||
2155 |
This policy affects all branches contained by this bzrdir, except for
|
|
2156 |
those under repositories.
|
|
2157 |
"""
|
|
4288.1.1
by Robert Collins
Add support for a RemoteBzrDirConfig to support optimising push operations which need to look for default stacking locations. |
2158 |
if self._config is None: |
2159 |
return None |
|
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
2160 |
value = self._config.get_option('default_stack_on') |
3242.3.11
by Aaron Bentley
Clean up BzrDirConfig usage |
2161 |
if value == '': |
2162 |
value = None |
|
2163 |
return value |
|
2164 |
||
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
2165 |
|
2166 |
class TransportConfig(object): |
|
3242.1.5
by Aaron Bentley
Update per review comments |
2167 |
"""A Config that reads/writes a config file on a Transport.
|
3242.1.4
by Aaron Bentley
Clean-up |
2168 |
|
2169 |
It is a low-level object that considers config data to be name/value pairs
|
|
5447.4.4
by Vincent Ladeuil
Implement config.get_sections() to clarify how sections can be used. |
2170 |
that may be associated with a section. Assigning meaning to these values
|
2171 |
is done at higher levels like TreeConfig.
|
|
3242.1.4
by Aaron Bentley
Clean-up |
2172 |
"""
|
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
2173 |
|
2174 |
def __init__(self, transport, filename): |
|
2175 |
self._transport = transport |
|
2176 |
self._filename = filename |
|
2177 |
||
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
2178 |
def get_option(self, name, section=None, default=None): |
2179 |
"""Return the value associated with a named option.
|
|
2180 |
||
2181 |
:param name: The name of the value
|
|
2182 |
:param section: The section the option is in (if any)
|
|
2183 |
:param default: The value to return if the value is not set
|
|
2184 |
:return: The value or default value
|
|
2185 |
"""
|
|
2186 |
configobj = self._get_configobj() |
|
2187 |
if section is None: |
|
2188 |
section_obj = configobj |
|
2189 |
else: |
|
2190 |
try: |
|
2191 |
section_obj = configobj[section] |
|
2192 |
except KeyError: |
|
2193 |
return default |
|
5743.8.13
by Vincent Ladeuil
Fix config calls for the actual implementation, including typos in parameters and TransportConfig support. |
2194 |
value = section_obj.get(name, default) |
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
2195 |
for hook in OldConfigHooks['get']: |
5743.8.25
by Vincent Ladeuil
Fix spurious spaces. |
2196 |
hook(self, name, value) |
5743.8.13
by Vincent Ladeuil
Fix config calls for the actual implementation, including typos in parameters and TransportConfig support. |
2197 |
return value |
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
2198 |
|
2199 |
def set_option(self, value, name, section=None): |
|
2200 |
"""Set the value associated with a named option.
|
|
2201 |
||
2202 |
:param value: The value to set
|
|
2203 |
:param name: The name of the value to set
|
|
2204 |
:param section: The section the option is in (if any)
|
|
2205 |
"""
|
|
2206 |
configobj = self._get_configobj() |
|
2207 |
if section is None: |
|
2208 |
configobj[name] = value |
|
2209 |
else: |
|
2210 |
configobj.setdefault(section, {})[name] = value |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
2211 |
for hook in OldConfigHooks['set']: |
5743.8.13
by Vincent Ladeuil
Fix config calls for the actual implementation, including typos in parameters and TransportConfig support. |
2212 |
hook(self, name, value) |
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
2213 |
self._set_configobj(configobj) |
2214 |
||
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
2215 |
def remove_option(self, option_name, section_name=None): |
2216 |
configobj = self._get_configobj() |
|
2217 |
if section_name is None: |
|
2218 |
del configobj[option_name] |
|
2219 |
else: |
|
2220 |
del configobj[section_name][option_name] |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
2221 |
for hook in OldConfigHooks['remove']: |
5743.8.15
by Vincent Ladeuil
Add tests for old config hooks covering bazaar.conf, locations.conf and branch.conf. |
2222 |
hook(self, option_name) |
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
2223 |
self._set_configobj(configobj) |
2224 |
||
4288.1.2
by Robert Collins
Create a server verb for doing BzrDir.get_config() |
2225 |
def _get_config_file(self): |
2226 |
try: |
|
5743.8.13
by Vincent Ladeuil
Fix config calls for the actual implementation, including typos in parameters and TransportConfig support. |
2227 |
f = StringIO(self._transport.get_bytes(self._filename)) |
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
2228 |
for hook in OldConfigHooks['load']: |
5743.8.13
by Vincent Ladeuil
Fix config calls for the actual implementation, including typos in parameters and TransportConfig support. |
2229 |
hook(self) |
2230 |
return f |
|
4288.1.2
by Robert Collins
Create a server verb for doing BzrDir.get_config() |
2231 |
except errors.NoSuchFile: |
2232 |
return StringIO() |
|
2233 |
||
5987.1.4
by Vincent Ladeuil
Proper error messages for config files with content in non-utf encoding or that cannot be parsed |
2234 |
def _external_url(self): |
2235 |
return urlutils.join(self._transport.external_url(), self._filename) |
|
2236 |
||
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
2237 |
def _get_configobj(self): |
4708.2.1
by Martin
Ensure all files opened by bazaar proper are explicitly closed |
2238 |
f = self._get_config_file() |
2239 |
try: |
|
5987.1.4
by Vincent Ladeuil
Proper error messages for config files with content in non-utf encoding or that cannot be parsed |
2240 |
try: |
2241 |
conf = ConfigObj(f, encoding='utf-8') |
|
2242 |
except configobj.ConfigObjError, e: |
|
2243 |
raise errors.ParseConfigError(e.errors, self._external_url()) |
|
2244 |
except UnicodeDecodeError: |
|
2245 |
raise errors.ConfigContentError(self._external_url()) |
|
4708.2.1
by Martin
Ensure all files opened by bazaar proper are explicitly closed |
2246 |
finally: |
2247 |
f.close() |
|
5987.1.4
by Vincent Ladeuil
Proper error messages for config files with content in non-utf encoding or that cannot be parsed |
2248 |
return conf |
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
2249 |
|
2250 |
def _set_configobj(self, configobj): |
|
2251 |
out_file = StringIO() |
|
2252 |
configobj.write(out_file) |
|
2253 |
out_file.seek(0) |
|
2254 |
self._transport.put_file(self._filename, out_file) |
|
5743.8.24
by Vincent Ladeuil
Clearly seaparate both sets of hooks for the old and new config implementations. |
2255 |
for hook in OldConfigHooks['save']: |
5743.8.13
by Vincent Ladeuil
Fix config calls for the actual implementation, including typos in parameters and TransportConfig support. |
2256 |
hook(self) |
5447.4.2
by Vincent Ladeuil
Implement the 'brz config' command. Read-only. |
2257 |
|
2258 |
||
5743.12.2
by Vincent Ladeuil
Basic registry for options. |
2259 |
class Option(object): |
5743.12.10
by Vincent Ladeuil
Add documentation. |
2260 |
"""An option definition.
|
2261 |
||
2262 |
The option *values* are stored in config files and found in sections.
|
|
2263 |
||
2264 |
Here we define various properties about the option itself, its default
|
|
2265 |
value, in which config files it can be stored, etc (TBC).
|
|
2266 |
"""
|
|
5743.12.2
by Vincent Ladeuil
Basic registry for options. |
2267 |
|
5743.12.4
by Vincent Ladeuil
An option can provide a default value. |
2268 |
def __init__(self, name, default=None): |
5743.12.2
by Vincent Ladeuil
Basic registry for options. |
2269 |
self.name = name |
5743.12.4
by Vincent Ladeuil
An option can provide a default value. |
2270 |
self.default = default |
2271 |
||
2272 |
def get_default(self): |
|
2273 |
return self.default |
|
2274 |
||
5743.12.2
by Vincent Ladeuil
Basic registry for options. |
2275 |
|
2276 |
# Options registry
|
|
2277 |
||
2278 |
option_registry = registry.Registry() |
|
2279 |
||
5743.12.3
by Vincent Ladeuil
More basic tests for options. Start tests for all registered options. |
2280 |
|
5743.13.6
by Vincent Ladeuil
Register the 'editor' option. |
2281 |
option_registry.register( |
2282 |
'editor', Option('editor'), |
|
2283 |
help='The command called to launch an editor to enter a message.') |
|
5743.12.3
by Vincent Ladeuil
More basic tests for options. Start tests for all registered options. |
2284 |
|
2285 |
||
5743.3.11
by Vincent Ladeuil
Config sections only implement read access. |
2286 |
class Section(object): |
5743.12.2
by Vincent Ladeuil
Basic registry for options. |
2287 |
"""A section defines a dict of option name => value.
|
5743.2.1
by Vincent Ladeuil
Basic tests and implementations for read-only and mutable sections. |
2288 |
|
2289 |
This is merely a read-only dict which can add some knowledge about the
|
|
5743.3.10
by Vincent Ladeuil
Fix typos mentioned in reviews. |
2290 |
options. It is *not* a python dict object though and doesn't try to mimic
|
2291 |
its API.
|
|
5743.2.1
by Vincent Ladeuil
Basic tests and implementations for read-only and mutable sections. |
2292 |
"""
|
2293 |
||
2294 |
def __init__(self, section_id, options): |
|
2295 |
self.id = section_id |
|
2296 |
# We re-use the dict-like object received
|
|
2297 |
self.options = options |
|
2298 |
||
2299 |
def get(self, name, default=None): |
|
2300 |
return self.options.get(name, default) |
|
2301 |
||
5743.3.12
by Vincent Ladeuil
Add an ad-hoc __repr__. |
2302 |
def __repr__(self): |
2303 |
# Mostly for debugging use
|
|
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2304 |
return "<config.%s id=%s>" % (self.__class__.__name__, self.id) |
5743.3.12
by Vincent Ladeuil
Add an ad-hoc __repr__. |
2305 |
|
5743.2.3
by Vincent Ladeuil
The option is either new or has an existing value. |
2306 |
|
5743.3.6
by Vincent Ladeuil
Use a name less likely to be reused. |
2307 |
_NewlyCreatedOption = object() |
5743.2.2
by Vincent Ladeuil
Add tests for remove. |
2308 |
"""Was the option created during the MutableSection lifetime"""
|
5743.2.1
by Vincent Ladeuil
Basic tests and implementations for read-only and mutable sections. |
2309 |
|
5743.2.3
by Vincent Ladeuil
The option is either new or has an existing value. |
2310 |
|
5743.3.11
by Vincent Ladeuil
Config sections only implement read access. |
2311 |
class MutableSection(Section): |
5743.3.1
by Vincent Ladeuil
Add a docstring and dates to FIXMEs. |
2312 |
"""A section allowing changes and keeping track of the original values."""
|
5743.2.1
by Vincent Ladeuil
Basic tests and implementations for read-only and mutable sections. |
2313 |
|
2314 |
def __init__(self, section_id, options): |
|
2315 |
super(MutableSection, self).__init__(section_id, options) |
|
2316 |
self.orig = {} |
|
2317 |
||
2318 |
def set(self, name, value): |
|
5743.2.2
by Vincent Ladeuil
Add tests for remove. |
2319 |
if name not in self.options: |
5743.2.3
by Vincent Ladeuil
The option is either new or has an existing value. |
2320 |
# This is a new option
|
5743.3.6
by Vincent Ladeuil
Use a name less likely to be reused. |
2321 |
self.orig[name] = _NewlyCreatedOption |
5743.2.3
by Vincent Ladeuil
The option is either new or has an existing value. |
2322 |
elif name not in self.orig: |
5743.2.1
by Vincent Ladeuil
Basic tests and implementations for read-only and mutable sections. |
2323 |
self.orig[name] = self.get(name, None) |
2324 |
self.options[name] = value |
|
2325 |
||
2326 |
def remove(self, name): |
|
2327 |
if name not in self.orig: |
|
2328 |
self.orig[name] = self.get(name, None) |
|
2329 |
del self.options[name] |
|
2330 |
||
5743.2.13
by Vincent Ladeuil
Trivial implementations for stores with smoke tests. |
2331 |
|
5743.2.7
by Vincent Ladeuil
Implement loading a config store from a string or a file. |
2332 |
class Store(object): |
2333 |
"""Abstract interface to persistent storage for configuration options."""
|
|
2334 |
||
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2335 |
readonly_section_class = Section |
5743.4.22
by Vincent Ladeuil
Allow daughter classes to use different Section classes if/when needed. |
2336 |
mutable_section_class = MutableSection |
5743.4.21
by Vincent Ladeuil
All stores should provide _load_from_string to reuse the existing tests. |
2337 |
|
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2338 |
def is_loaded(self): |
2339 |
"""Returns True if the Store has been loaded.
|
|
2340 |
||
2341 |
This is used to implement lazy loading and ensure the persistent
|
|
2342 |
storage is queried only when needed.
|
|
2343 |
"""
|
|
2344 |
raise NotImplementedError(self.is_loaded) |
|
5743.2.7
by Vincent Ladeuil
Implement loading a config store from a string or a file. |
2345 |
|
2346 |
def load(self): |
|
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2347 |
"""Loads the Store from persistent storage."""
|
5743.2.7
by Vincent Ladeuil
Implement loading a config store from a string or a file. |
2348 |
raise NotImplementedError(self.load) |
2349 |
||
5987.1.5
by Vincent Ladeuil
Those are just bytes. |
2350 |
def _load_from_string(self, bytes): |
5743.4.21
by Vincent Ladeuil
All stores should provide _load_from_string to reuse the existing tests. |
2351 |
"""Create a store from a string in configobj syntax.
|
2352 |
||
5987.1.5
by Vincent Ladeuil
Those are just bytes. |
2353 |
:param bytes: A string representing the file content.
|
5743.4.21
by Vincent Ladeuil
All stores should provide _load_from_string to reuse the existing tests. |
2354 |
"""
|
2355 |
raise NotImplementedError(self._load_from_string) |
|
2356 |
||
5743.10.2
by Vincent Ladeuil
Make sure RemoteBranch are supported as well, relying on the vfs API. |
2357 |
def unload(self): |
2358 |
"""Unloads the Store.
|
|
2359 |
||
2360 |
This should make is_loaded() return False. This is used when the caller
|
|
2361 |
knows that the persistent storage has changed or may have change since
|
|
2362 |
the last load.
|
|
2363 |
"""
|
|
2364 |
raise NotImplementedError(self.unload) |
|
2365 |
||
5743.2.10
by Vincent Ladeuil
Implement store.get_sections() as an iterator and provides the configobj implementation. |
2366 |
def save(self): |
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2367 |
"""Saves the Store to persistent storage."""
|
5743.4.10
by Vincent Ladeuil
Fix copy/paste, bad. |
2368 |
raise NotImplementedError(self.save) |
5743.2.10
by Vincent Ladeuil
Implement store.get_sections() as an iterator and provides the configobj implementation. |
2369 |
|
5743.5.10
by Vincent Ladeuil
Parametrize the generic tests against the concrete stores. |
2370 |
def external_url(self): |
2371 |
raise NotImplementedError(self.external_url) |
|
2372 |
||
5743.2.10
by Vincent Ladeuil
Implement store.get_sections() as an iterator and provides the configobj implementation. |
2373 |
def get_sections(self): |
2374 |
"""Returns an ordered iterable of existing sections.
|
|
2375 |
||
2376 |
:returns: An iterable of (name, dict).
|
|
2377 |
"""
|
|
2378 |
raise NotImplementedError(self.get_sections) |
|
2379 |
||
5743.4.2
by Vincent Ladeuil
Stores don't implement set_option, they just provide a mutable section. |
2380 |
def get_mutable_section(self, section_name=None): |
2381 |
"""Returns the specified mutable section.
|
|
2382 |
||
2383 |
:param section_name: The section identifier
|
|
2384 |
"""
|
|
2385 |
raise NotImplementedError(self.get_mutable_section) |
|
5743.2.12
by Vincent Ladeuil
Rename store.set to store.set_option as it's clearer in this context and will act as a safe-guard against unintended uses (set() will be used for stacks). |
2386 |
|
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2387 |
def __repr__(self): |
2388 |
# Mostly for debugging use
|
|
5743.5.17
by Vincent Ladeuil
Use external_url to identify stores. |
2389 |
return "<config.%s(%s)>" % (self.__class__.__name__, |
5743.5.18
by Vincent Ladeuil
Fix typo. |
2390 |
self.external_url()) |
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2391 |
|
2392 |
||
2393 |
class IniFileStore(Store): |
|
2394 |
"""A config Store using ConfigObj for storage.
|
|
2395 |
||
2396 |
:ivar transport: The transport object where the config file is located.
|
|
2397 |
||
2398 |
:ivar file_name: The config file basename in the transport directory.
|
|
2399 |
||
2400 |
:ivar _config_obj: Private member to hold the ConfigObj instance used to
|
|
2401 |
serialize/deserialize the config file.
|
|
2402 |
"""
|
|
5743.2.7
by Vincent Ladeuil
Implement loading a config store from a string or a file. |
2403 |
|
2404 |
def __init__(self, transport, file_name): |
|
2405 |
"""A config Store using ConfigObj for storage.
|
|
2406 |
||
2407 |
:param transport: The transport object where the config file is located.
|
|
2408 |
||
2409 |
:param file_name: The config file basename in the transport directory.
|
|
2410 |
"""
|
|
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2411 |
super(IniFileStore, self).__init__() |
5743.2.7
by Vincent Ladeuil
Implement loading a config store from a string or a file. |
2412 |
self.transport = transport |
2413 |
self.file_name = file_name |
|
5743.4.18
by Vincent Ladeuil
Replace class.from_string with self._load_from_string to all stores can use it. |
2414 |
self._config_obj = None |
2415 |
||
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2416 |
def is_loaded(self): |
5743.4.18
by Vincent Ladeuil
Replace class.from_string with self._load_from_string to all stores can use it. |
2417 |
return self._config_obj != None |
5743.2.7
by Vincent Ladeuil
Implement loading a config store from a string or a file. |
2418 |
|
5743.10.2
by Vincent Ladeuil
Make sure RemoteBranch are supported as well, relying on the vfs API. |
2419 |
def unload(self): |
2420 |
self._config_obj = None |
|
2421 |
||
5743.4.19
by Vincent Ladeuil
Clarify that only Store.get_mutable_section() can accept an empty file. |
2422 |
def load(self): |
2423 |
"""Load the store from the associated file."""
|
|
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2424 |
if self.is_loaded(): |
5743.2.7
by Vincent Ladeuil
Implement loading a config store from a string or a file. |
2425 |
return
|
5743.4.19
by Vincent Ladeuil
Clarify that only Store.get_mutable_section() can accept an empty file. |
2426 |
content = self.transport.get_bytes(self.file_name) |
5743.4.18
by Vincent Ladeuil
Replace class.from_string with self._load_from_string to all stores can use it. |
2427 |
self._load_from_string(content) |
5743.8.10
by Vincent Ladeuil
We don't need (nor want) to tie the config hooks to a particular class. Especially when we want to use the same hooks on both implementations. |
2428 |
for hook in ConfigHooks['load']: |
5743.8.8
by Vincent Ladeuil
Puth the load hook in the right place. |
2429 |
hook(self) |
5743.4.18
by Vincent Ladeuil
Replace class.from_string with self._load_from_string to all stores can use it. |
2430 |
|
5987.1.5
by Vincent Ladeuil
Those are just bytes. |
2431 |
def _load_from_string(self, bytes): |
5743.4.18
by Vincent Ladeuil
Replace class.from_string with self._load_from_string to all stores can use it. |
2432 |
"""Create a config store from a string.
|
2433 |
||
5987.1.5
by Vincent Ladeuil
Those are just bytes. |
2434 |
:param bytes: A string representing the file content.
|
5743.4.18
by Vincent Ladeuil
Replace class.from_string with self._load_from_string to all stores can use it. |
2435 |
"""
|
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2436 |
if self.is_loaded(): |
5743.4.18
by Vincent Ladeuil
Replace class.from_string with self._load_from_string to all stores can use it. |
2437 |
raise AssertionError('Already loaded: %r' % (self._config_obj,)) |
5987.1.5
by Vincent Ladeuil
Those are just bytes. |
2438 |
co_input = StringIO(bytes) |
5743.4.3
by Vincent Ladeuil
Implement get_mutable_section. |
2439 |
try: |
5743.2.7
by Vincent Ladeuil
Implement loading a config store from a string or a file. |
2440 |
# The config files are always stored utf8-encoded
|
2441 |
self._config_obj = ConfigObj(co_input, encoding='utf-8') |
|
2442 |
except configobj.ConfigObjError, e: |
|
5743.4.18
by Vincent Ladeuil
Replace class.from_string with self._load_from_string to all stores can use it. |
2443 |
self._config_obj = None |
5743.5.10
by Vincent Ladeuil
Parametrize the generic tests against the concrete stores. |
2444 |
raise errors.ParseConfigError(e.errors, self.external_url()) |
5987.1.4
by Vincent Ladeuil
Proper error messages for config files with content in non-utf encoding or that cannot be parsed |
2445 |
except UnicodeDecodeError: |
2446 |
raise errors.ConfigContentError(self.external_url()) |
|
5743.2.7
by Vincent Ladeuil
Implement loading a config store from a string or a file. |
2447 |
|
5743.2.9
by Vincent Ladeuil
Implement and test store.save() and remove the 'save' parameter from store.from_string() as this won't scale well when adding class specific parameters. |
2448 |
def save(self): |
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2449 |
if not self.is_loaded(): |
5743.4.19
by Vincent Ladeuil
Clarify that only Store.get_mutable_section() can accept an empty file. |
2450 |
# Nothing to save
|
2451 |
return
|
|
5743.2.9
by Vincent Ladeuil
Implement and test store.save() and remove the 'save' parameter from store.from_string() as this won't scale well when adding class specific parameters. |
2452 |
out = StringIO() |
2453 |
self._config_obj.write(out) |
|
2454 |
self.transport.put_bytes(self.file_name, out.getvalue()) |
|
5743.8.10
by Vincent Ladeuil
We don't need (nor want) to tie the config hooks to a particular class. Especially when we want to use the same hooks on both implementations. |
2455 |
for hook in ConfigHooks['save']: |
5743.8.7
by Vincent Ladeuil
Add hooks for config stores (but the load one is not in the right place). |
2456 |
hook(self) |
5743.2.9
by Vincent Ladeuil
Implement and test store.save() and remove the 'save' parameter from store.from_string() as this won't scale well when adding class specific parameters. |
2457 |
|
5743.5.10
by Vincent Ladeuil
Parametrize the generic tests against the concrete stores. |
2458 |
def external_url(self): |
2459 |
# FIXME: external_url should really accepts an optional relpath
|
|
2460 |
# parameter (bug #750169) :-/ -- vila 2011-04-04
|
|
2461 |
# The following will do in the interim but maybe we don't want to
|
|
2462 |
# expose a path here but rather a config ID and its associated
|
|
2463 |
# object </hand wawe>.
|
|
5743.5.13
by Vincent Ladeuil
Merge config-abstract-store into config-concrete-stores resolving conflicts |
2464 |
return urlutils.join(self.transport.external_url(), self.file_name) |
5743.5.10
by Vincent Ladeuil
Parametrize the generic tests against the concrete stores. |
2465 |
|
5743.2.10
by Vincent Ladeuil
Implement store.get_sections() as an iterator and provides the configobj implementation. |
2466 |
def get_sections(self): |
2467 |
"""Get the configobj section in the file order.
|
|
2468 |
||
2469 |
:returns: An iterable of (name, dict).
|
|
2470 |
"""
|
|
2471 |
# We need a loaded store
|
|
5743.6.14
by Vincent Ladeuil
Parametrize the Stack tests. |
2472 |
try: |
2473 |
self.load() |
|
2474 |
except errors.NoSuchFile: |
|
2475 |
# If the file doesn't exist, there is no sections
|
|
2476 |
return
|
|
5743.2.10
by Vincent Ladeuil
Implement store.get_sections() as an iterator and provides the configobj implementation. |
2477 |
cobj = self._config_obj |
2478 |
if cobj.scalars: |
|
5743.4.22
by Vincent Ladeuil
Allow daughter classes to use different Section classes if/when needed. |
2479 |
yield self.readonly_section_class(None, cobj) |
5743.2.10
by Vincent Ladeuil
Implement store.get_sections() as an iterator and provides the configobj implementation. |
2480 |
for section_name in cobj.sections: |
5743.4.22
by Vincent Ladeuil
Allow daughter classes to use different Section classes if/when needed. |
2481 |
yield self.readonly_section_class(section_name, cobj[section_name]) |
5743.2.10
by Vincent Ladeuil
Implement store.get_sections() as an iterator and provides the configobj implementation. |
2482 |
|
5743.4.2
by Vincent Ladeuil
Stores don't implement set_option, they just provide a mutable section. |
2483 |
def get_mutable_section(self, section_name=None): |
5743.2.11
by Vincent Ladeuil
Basic store.set implementation. |
2484 |
# We need a loaded store
|
5743.4.19
by Vincent Ladeuil
Clarify that only Store.get_mutable_section() can accept an empty file. |
2485 |
try: |
2486 |
self.load() |
|
2487 |
except errors.NoSuchFile: |
|
2488 |
# The file doesn't exist, let's pretend it was empty
|
|
2489 |
self._load_from_string('') |
|
5743.2.11
by Vincent Ladeuil
Basic store.set implementation. |
2490 |
if section_name is None: |
2491 |
section = self._config_obj |
|
2492 |
else: |
|
2493 |
section = self._config_obj.setdefault(section_name, {}) |
|
5743.4.22
by Vincent Ladeuil
Allow daughter classes to use different Section classes if/when needed. |
2494 |
return self.mutable_section_class(section_name, section) |
5743.2.11
by Vincent Ladeuil
Basic store.set implementation. |
2495 |
|
5743.2.1
by Vincent Ladeuil
Basic tests and implementations for read-only and mutable sections. |
2496 |
|
5743.4.16
by Vincent Ladeuil
Some doc for the stores. |
2497 |
# Note that LockableConfigObjStore inherits from ConfigObjStore because we need
|
2498 |
# unlockable stores for use with objects that can already ensure the locking
|
|
2499 |
# (think branches). If different stores (not based on ConfigObj) are created,
|
|
2500 |
# they may face the same issue.
|
|
2501 |
||
2502 |
||
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2503 |
class LockableIniFileStore(IniFileStore): |
5743.4.9
by Vincent Ladeuil
Implement a LockableConfigObjStore to be able to mimick the actual behaviour. |
2504 |
"""A ConfigObjStore using locks on save to ensure store integrity."""
|
2505 |
||
2506 |
def __init__(self, transport, file_name, lock_dir_name=None): |
|
2507 |
"""A config Store using ConfigObj for storage.
|
|
2508 |
||
2509 |
:param transport: The transport object where the config file is located.
|
|
2510 |
||
2511 |
:param file_name: The config file basename in the transport directory.
|
|
2512 |
"""
|
|
2513 |
if lock_dir_name is None: |
|
2514 |
lock_dir_name = 'lock' |
|
2515 |
self.lock_dir_name = lock_dir_name |
|
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2516 |
super(LockableIniFileStore, self).__init__(transport, file_name) |
5743.4.9
by Vincent Ladeuil
Implement a LockableConfigObjStore to be able to mimick the actual behaviour. |
2517 |
self._lock = lockdir.LockDir(self.transport, self.lock_dir_name) |
2518 |
||
2519 |
def lock_write(self, token=None): |
|
2520 |
"""Takes a write lock in the directory containing the config file.
|
|
2521 |
||
2522 |
If the directory doesn't exist it is created.
|
|
2523 |
"""
|
|
2524 |
# FIXME: This doesn't check the ownership of the created directories as
|
|
2525 |
# ensure_config_dir_exists does. It should if the transport is local
|
|
2526 |
# -- vila 2011-04-06
|
|
2527 |
self.transport.create_prefix() |
|
2528 |
return self._lock.lock_write(token) |
|
2529 |
||
2530 |
def unlock(self): |
|
2531 |
self._lock.unlock() |
|
2532 |
||
2533 |
def break_lock(self): |
|
2534 |
self._lock.break_lock() |
|
2535 |
||
2536 |
@needs_write_lock
|
|
2537 |
def save(self): |
|
5743.6.25
by Vincent Ladeuil
Last test rewritten. |
2538 |
# We need to be able to override the undecorated implementation
|
5743.6.32
by Vincent Ladeuil
Address poolie's review comments. |
2539 |
self.save_without_locking() |
5743.6.24
by Vincent Ladeuil
One more test with a ugly hack to allow the test to stop in the right place. |
2540 |
|
5743.6.32
by Vincent Ladeuil
Address poolie's review comments. |
2541 |
def save_without_locking(self): |
5743.4.25
by Vincent Ladeuil
Address review comments by jelmer and poolie. |
2542 |
super(LockableIniFileStore, self).save() |
5743.4.9
by Vincent Ladeuil
Implement a LockableConfigObjStore to be able to mimick the actual behaviour. |
2543 |
|
2544 |
||
5743.2.13
by Vincent Ladeuil
Trivial implementations for stores with smoke tests. |
2545 |
# FIXME: global, bazaar, shouldn't that be 'user' instead or even
|
2546 |
# 'user_defaults' as opposed to 'user_overrides', 'system_defaults'
|
|
2547 |
# (/etc/bzr/bazaar.conf) and 'system_overrides' ? -- vila 2011-04-05
|
|
5743.5.15
by Vincent Ladeuil
Mention poolie's point about focusing tests. |
2548 |
|
2549 |
# FIXME: Moreover, we shouldn't need classes for these stores either, factory
|
|
2550 |
# functions or a registry will make it easier and clearer for tests, focusing
|
|
2551 |
# on the relevant parts of the API that needs testing -- vila 20110503 (based
|
|
2552 |
# on a poolie's remark)
|
|
5743.5.13
by Vincent Ladeuil
Merge config-abstract-store into config-concrete-stores resolving conflicts |
2553 |
class GlobalStore(LockableIniFileStore): |
5743.2.13
by Vincent Ladeuil
Trivial implementations for stores with smoke tests. |
2554 |
|
2555 |
def __init__(self, possible_transports=None): |
|
2556 |
t = transport.get_transport(config_dir(), |
|
2557 |
possible_transports=possible_transports) |
|
2558 |
super(GlobalStore, self).__init__(t, 'bazaar.conf') |
|
2559 |
||
2560 |
||
5743.5.13
by Vincent Ladeuil
Merge config-abstract-store into config-concrete-stores resolving conflicts |
2561 |
class LocationStore(LockableIniFileStore): |
5743.2.13
by Vincent Ladeuil
Trivial implementations for stores with smoke tests. |
2562 |
|
2563 |
def __init__(self, possible_transports=None): |
|
2564 |
t = transport.get_transport(config_dir(), |
|
2565 |
possible_transports=possible_transports) |
|
5743.5.10
by Vincent Ladeuil
Parametrize the generic tests against the concrete stores. |
2566 |
super(LocationStore, self).__init__(t, 'locations.conf') |
5743.2.13
by Vincent Ladeuil
Trivial implementations for stores with smoke tests. |
2567 |
|
2568 |
||
5743.9.1
by Vincent Ladeuil
Properly implement locking for BranchStore by delegating all the lock operations to the branch itself. |
2569 |
class BranchStore(IniFileStore): |
5743.2.13
by Vincent Ladeuil
Trivial implementations for stores with smoke tests. |
2570 |
|
2571 |
def __init__(self, branch): |
|
2572 |
super(BranchStore, self).__init__(branch.control_transport, |
|
2573 |
'branch.conf') |
|
5743.6.34
by Vincent Ladeuil
Forget weakref for branch <-> config. |
2574 |
self.branch = branch |
5743.10.5
by Vincent Ladeuil
Give up. |
2575 |
|
5743.9.1
by Vincent Ladeuil
Properly implement locking for BranchStore by delegating all the lock operations to the branch itself. |
2576 |
def lock_write(self, token=None): |
5743.6.34
by Vincent Ladeuil
Forget weakref for branch <-> config. |
2577 |
return self.branch.lock_write(token) |
5743.9.1
by Vincent Ladeuil
Properly implement locking for BranchStore by delegating all the lock operations to the branch itself. |
2578 |
|
2579 |
def unlock(self): |
|
5743.6.34
by Vincent Ladeuil
Forget weakref for branch <-> config. |
2580 |
return self.branch.unlock() |
5743.9.1
by Vincent Ladeuil
Properly implement locking for BranchStore by delegating all the lock operations to the branch itself. |
2581 |
|
2582 |
@needs_write_lock
|
|
2583 |
def save(self): |
|
2584 |
# We need to be able to override the undecorated implementation
|
|
5743.9.5
by Vincent Ladeuil
Fix test failure, forgot a call site when renaming _save to save_without_locking. |
2585 |
self.save_without_locking() |
5743.9.1
by Vincent Ladeuil
Properly implement locking for BranchStore by delegating all the lock operations to the branch itself. |
2586 |
|
5743.9.5
by Vincent Ladeuil
Fix test failure, forgot a call site when renaming _save to save_without_locking. |
2587 |
def save_without_locking(self): |
5743.9.1
by Vincent Ladeuil
Properly implement locking for BranchStore by delegating all the lock operations to the branch itself. |
2588 |
super(BranchStore, self).save() |
2589 |
||
5743.2.13
by Vincent Ladeuil
Trivial implementations for stores with smoke tests. |
2590 |
|
5743.2.22
by Vincent Ladeuil
Some minimal SectionMatcher implementation to setup the test infrastucture. |
2591 |
class SectionMatcher(object): |
2592 |
"""Select sections into a given Store.
|
|
2593 |
||
2594 |
This intended to be used to postpone getting an iterable of sections from a
|
|
2595 |
store.
|
|
2596 |
"""
|
|
2597 |
||
2598 |
def __init__(self, store): |
|
2599 |
self.store = store |
|
2600 |
||
2601 |
def get_sections(self): |
|
5743.2.29
by Vincent Ladeuil
Add doc for the section matchers. |
2602 |
# This is where we require loading the store so we can see all defined
|
5743.2.22
by Vincent Ladeuil
Some minimal SectionMatcher implementation to setup the test infrastucture. |
2603 |
# sections.
|
2604 |
sections = self.store.get_sections() |
|
5743.2.24
by Vincent Ladeuil
Complete location config helpers with basic tests. |
2605 |
# Walk the revisions in the order provided
|
5743.2.22
by Vincent Ladeuil
Some minimal SectionMatcher implementation to setup the test infrastucture. |
2606 |
for s in sections: |
2607 |
if self.match(s): |
|
2608 |
yield s |
|
2609 |
||
2610 |
def match(self, secion): |
|
2611 |
raise NotImplementedError(self.match) |
|
2612 |
||
2613 |
||
5743.2.37
by Vincent Ladeuil
Merge config-concrete-stores into config-section-matchers resolving conflicts |
2614 |
class LocationSection(Section): |
5743.2.24
by Vincent Ladeuil
Complete location config helpers with basic tests. |
2615 |
|
2616 |
def __init__(self, section, length, extra_path): |
|
2617 |
super(LocationSection, self).__init__(section.id, section.options) |
|
2618 |
self.length = length |
|
2619 |
self.extra_path = extra_path |
|
2620 |
||
2621 |
def get(self, name, default=None): |
|
2622 |
value = super(LocationSection, self).get(name, default) |
|
2623 |
if value is not None: |
|
2624 |
policy_name = self.get(name + ':policy', None) |
|
2625 |
policy = _policy_value.get(policy_name, POLICY_NONE) |
|
2626 |
if policy == POLICY_APPENDPATH: |
|
2627 |
value = urlutils.join(value, self.extra_path) |
|
2628 |
return value |
|
2629 |
||
2630 |
||
5743.2.22
by Vincent Ladeuil
Some minimal SectionMatcher implementation to setup the test infrastucture. |
2631 |
class LocationMatcher(SectionMatcher): |
2632 |
||
5743.2.24
by Vincent Ladeuil
Complete location config helpers with basic tests. |
2633 |
def __init__(self, store, location): |
5743.2.22
by Vincent Ladeuil
Some minimal SectionMatcher implementation to setup the test infrastucture. |
2634 |
super(LocationMatcher, self).__init__(store) |
5743.6.19
by Vincent Ladeuil
Clarify comments about section names for Location-related objects (also fix LocationMatcher and add tests). |
2635 |
if location.startswith('file://'): |
2636 |
location = urlutils.local_path_from_url(location) |
|
5743.2.22
by Vincent Ladeuil
Some minimal SectionMatcher implementation to setup the test infrastucture. |
2637 |
self.location = location |
2638 |
||
5743.6.15
by Vincent Ladeuil
Don't pollute _iter_for_location_by_parts. |
2639 |
def _get_matching_sections(self): |
2640 |
"""Get all sections matching ``location``."""
|
|
2641 |
# We slightly diverge from LocalConfig here by allowing the no-name
|
|
2642 |
# section as the most generic one and the lower priority.
|
|
2643 |
no_name_section = None |
|
2644 |
sections = [] |
|
2645 |
# Filter out the no_name_section so _iter_for_location_by_parts can be
|
|
2646 |
# used (it assumes all sections have a name).
|
|
2647 |
for section in self.store.get_sections(): |
|
2648 |
if section.id is None: |
|
2649 |
no_name_section = section |
|
2650 |
else: |
|
2651 |
sections.append(section) |
|
2652 |
# Unfortunately _iter_for_location_by_parts deals with section names so
|
|
2653 |
# we have to resync.
|
|
5743.2.31
by Vincent Ladeuil
Both the length and the section id should be used to sort. |
2654 |
filtered_sections = _iter_for_location_by_parts( |
5743.2.27
by Vincent Ladeuil
Merge the use of _filter_for_location_by_parts, uglier, but better for |
2655 |
[s.id for s in sections], self.location) |
2656 |
iter_sections = iter(sections) |
|
2657 |
matching_sections = [] |
|
5743.6.15
by Vincent Ladeuil
Don't pollute _iter_for_location_by_parts. |
2658 |
if no_name_section is not None: |
2659 |
matching_sections.append( |
|
2660 |
LocationSection(no_name_section, 0, self.location)) |
|
5743.2.31
by Vincent Ladeuil
Both the length and the section id should be used to sort. |
2661 |
for section_id, extra_path, length in filtered_sections: |
5743.2.27
by Vincent Ladeuil
Merge the use of _filter_for_location_by_parts, uglier, but better for |
2662 |
# a section id is unique for a given store so it's safe to iterate
|
2663 |
# again
|
|
2664 |
section = iter_sections.next() |
|
2665 |
if section_id == section.id: |
|
2666 |
matching_sections.append( |
|
2667 |
LocationSection(section, length, extra_path)) |
|
5743.6.15
by Vincent Ladeuil
Don't pollute _iter_for_location_by_parts. |
2668 |
return matching_sections |
2669 |
||
2670 |
def get_sections(self): |
|
2671 |
# Override the default implementation as we want to change the order
|
|
2672 |
matching_sections = self._get_matching_sections() |
|
5743.2.24
by Vincent Ladeuil
Complete location config helpers with basic tests. |
2673 |
# We want the longest (aka more specific) locations first
|
5743.2.31
by Vincent Ladeuil
Both the length and the section id should be used to sort. |
2674 |
sections = sorted(matching_sections, |
2675 |
key=lambda section: (section.length, section.id), |
|
5743.2.24
by Vincent Ladeuil
Complete location config helpers with basic tests. |
2676 |
reverse=True) |
2677 |
# Sections mentioning 'ignore_parents' restrict the selection
|
|
2678 |
for section in sections: |
|
2679 |
# FIXME: We really want to use as_bool below -- vila 2011-04-07
|
|
2680 |
ignore = section.get('ignore_parents', None) |
|
2681 |
if ignore is not None: |
|
2682 |
ignore = ui.bool_from_string(ignore) |
|
2683 |
if ignore: |
|
2684 |
break
|
|
2685 |
# Finally, we have a valid section
|
|
2686 |
yield section |
|
5743.2.22
by Vincent Ladeuil
Some minimal SectionMatcher implementation to setup the test infrastucture. |
2687 |
|
5743.2.13
by Vincent Ladeuil
Trivial implementations for stores with smoke tests. |
2688 |
|
5743.1.34
by Vincent Ladeuil
Merge config-section-matchers into config-stack resolving conflicts |
2689 |
class Stack(object): |
5743.1.1
by Vincent Ladeuil
Start implementing a config stack. |
2690 |
"""A stack of configurations where an option can be defined"""
|
2691 |
||
5743.1.37
by Vincent Ladeuil
Change the way Stacks are built: requires a Store and a mutable section name instead of a callable returning the mutable section. |
2692 |
def __init__(self, sections_def, store=None, mutable_section_name=None): |
5743.1.11
by Vincent Ladeuil
Properly use MutableSection for write operations. |
2693 |
"""Creates a stack of sections with an optional store for changes.
|
2694 |
||
5743.1.36
by Vincent Ladeuil
Clarify that constructor parameters are here to *define* the stack and as such can be re-used. Also make the sections_def parameter mandatory. |
2695 |
:param sections_def: A list of Section or callables that returns an
|
2696 |
iterable of Section. This defines the Sections for the Stack and
|
|
2697 |
can be called repeatedly if needed.
|
|
5743.1.11
by Vincent Ladeuil
Properly use MutableSection for write operations. |
2698 |
|
5743.1.37
by Vincent Ladeuil
Change the way Stacks are built: requires a Store and a mutable section name instead of a callable returning the mutable section. |
2699 |
:param store: The optional Store where modifications will be
|
2700 |
recorded. If none is specified, no modifications can be done.
|
|
2701 |
||
2702 |
:param mutable_section_name: The name of the MutableSection where
|
|
2703 |
changes are recorded. This requires the ``store`` parameter to be
|
|
2704 |
specified.
|
|
5743.1.11
by Vincent Ladeuil
Properly use MutableSection for write operations. |
2705 |
"""
|
5743.1.36
by Vincent Ladeuil
Clarify that constructor parameters are here to *define* the stack and as such can be re-used. Also make the sections_def parameter mandatory. |
2706 |
self.sections_def = sections_def |
5743.1.37
by Vincent Ladeuil
Change the way Stacks are built: requires a Store and a mutable section name instead of a callable returning the mutable section. |
2707 |
self.store = store |
2708 |
self.mutable_section_name = mutable_section_name |
|
5743.1.1
by Vincent Ladeuil
Start implementing a config stack. |
2709 |
|
2710 |
def get(self, name): |
|
5743.1.16
by Vincent Ladeuil
Allows empty sections and empty section callables. |
2711 |
"""Return the *first* option value found in the sections.
|
5743.1.13
by Vincent Ladeuil
Better explain lazy loading and make sure the mutable section respect the design. |
2712 |
|
5743.1.16
by Vincent Ladeuil
Allows empty sections and empty section callables. |
2713 |
This is where we guarantee that sections coming from Store are loaded
|
2714 |
lazily: the loading is delayed until we need to either check that an
|
|
5743.1.13
by Vincent Ladeuil
Better explain lazy loading and make sure the mutable section respect the design. |
2715 |
option exists or get its value, which in turn may require to discover
|
2716 |
in which sections it can be defined. Both of these (section and option
|
|
2717 |
existence) require loading the store (even partially).
|
|
2718 |
"""
|
|
5743.1.36
by Vincent Ladeuil
Clarify that constructor parameters are here to *define* the stack and as such can be re-used. Also make the sections_def parameter mandatory. |
2719 |
# FIXME: No caching of options nor sections yet -- vila 20110503
|
5743.12.6
by Vincent Ladeuil
Stack.get() provides the registered option default value. |
2720 |
value = None |
5743.6.17
by Vincent Ladeuil
Clarify comment. |
2721 |
# Ensuring lazy loading is achieved by delaying section matching (which
|
2722 |
# implies querying the persistent storage) until it can't be avoided
|
|
2723 |
# anymore by using callables to describe (possibly empty) section
|
|
2724 |
# lists.
|
|
5743.1.36
by Vincent Ladeuil
Clarify that constructor parameters are here to *define* the stack and as such can be re-used. Also make the sections_def parameter mandatory. |
2725 |
for section_or_callable in self.sections_def: |
5743.1.12
by Vincent Ladeuil
Clarify ConfigStack.get() about lazy evaluation of sections. |
2726 |
# Each section can expand to multiple ones when a callable is used
|
2727 |
if callable(section_or_callable): |
|
2728 |
sections = section_or_callable() |
|
5743.1.9
by Vincent Ladeuil
Fix the issue by allowing delayed section acquisition. |
2729 |
else: |
5743.1.12
by Vincent Ladeuil
Clarify ConfigStack.get() about lazy evaluation of sections. |
2730 |
sections = [section_or_callable] |
2731 |
for section in sections: |
|
2732 |
value = section.get(name) |
|
2733 |
if value is not None: |
|
5743.12.6
by Vincent Ladeuil
Stack.get() provides the registered option default value. |
2734 |
break
|
2735 |
if value is not None: |
|
2736 |
break
|
|
2737 |
if value is None: |
|
2738 |
# If the option is registered, it may provide a default value
|
|
5743.12.7
by Vincent Ladeuil
Test that providing a default value doesn't break for non-registered options. |
2739 |
try: |
2740 |
opt = option_registry.get(name) |
|
2741 |
except KeyError: |
|
2742 |
# Not registered
|
|
2743 |
opt = None |
|
2744 |
if opt is not None: |
|
2745 |
value = opt.get_default() |
|
5743.8.10
by Vincent Ladeuil
We don't need (nor want) to tie the config hooks to a particular class. Especially when we want to use the same hooks on both implementations. |
2746 |
for hook in ConfigHooks['get']: |
5743.8.6
by Vincent Ladeuil
Add hooks for config stacks. |
2747 |
hook(self, name, value) |
5743.12.6
by Vincent Ladeuil
Stack.get() provides the registered option default value. |
2748 |
return value |
5743.1.1
by Vincent Ladeuil
Start implementing a config stack. |
2749 |
|
5743.1.37
by Vincent Ladeuil
Change the way Stacks are built: requires a Store and a mutable section name instead of a callable returning the mutable section. |
2750 |
def _get_mutable_section(self): |
2751 |
"""Get the MutableSection for the Stack.
|
|
5743.1.13
by Vincent Ladeuil
Better explain lazy loading and make sure the mutable section respect the design. |
2752 |
|
5743.1.15
by Vincent Ladeuil
Test and implement ConfigStack.remove. |
2753 |
This is where we guarantee that the mutable section is lazily loaded:
|
5743.1.37
by Vincent Ladeuil
Change the way Stacks are built: requires a Store and a mutable section name instead of a callable returning the mutable section. |
2754 |
this means we won't load the corresponding store before setting a value
|
2755 |
or deleting an option. In practice the store will often be loaded but
|
|
5743.6.14
by Vincent Ladeuil
Parametrize the Stack tests. |
2756 |
this allows helps catching some programming errors.
|
5743.1.13
by Vincent Ladeuil
Better explain lazy loading and make sure the mutable section respect the design. |
2757 |
"""
|
5743.1.37
by Vincent Ladeuil
Change the way Stacks are built: requires a Store and a mutable section name instead of a callable returning the mutable section. |
2758 |
section = self.store.get_mutable_section(self.mutable_section_name) |
2759 |
return section |
|
2760 |
||
2761 |
def set(self, name, value): |
|
2762 |
"""Set a new value for the option."""
|
|
2763 |
section = self._get_mutable_section() |
|
5743.1.13
by Vincent Ladeuil
Better explain lazy loading and make sure the mutable section respect the design. |
2764 |
section.set(name, value) |
5743.8.10
by Vincent Ladeuil
We don't need (nor want) to tie the config hooks to a particular class. Especially when we want to use the same hooks on both implementations. |
2765 |
for hook in ConfigHooks['set']: |
5743.8.6
by Vincent Ladeuil
Add hooks for config stacks. |
2766 |
hook(self, name, value) |
5743.1.7
by Vincent Ladeuil
Simple set implementation. |
2767 |
|
5743.1.15
by Vincent Ladeuil
Test and implement ConfigStack.remove. |
2768 |
def remove(self, name): |
5743.1.37
by Vincent Ladeuil
Change the way Stacks are built: requires a Store and a mutable section name instead of a callable returning the mutable section. |
2769 |
"""Remove an existing option."""
|
2770 |
section = self._get_mutable_section() |
|
5743.1.15
by Vincent Ladeuil
Test and implement ConfigStack.remove. |
2771 |
section.remove(name) |
5743.8.10
by Vincent Ladeuil
We don't need (nor want) to tie the config hooks to a particular class. Especially when we want to use the same hooks on both implementations. |
2772 |
for hook in ConfigHooks['remove']: |
5743.8.6
by Vincent Ladeuil
Add hooks for config stacks. |
2773 |
hook(self, name) |
5743.1.15
by Vincent Ladeuil
Test and implement ConfigStack.remove. |
2774 |
|
5743.1.34
by Vincent Ladeuil
Merge config-section-matchers into config-stack resolving conflicts |
2775 |
def __repr__(self): |
2776 |
# Mostly for debugging use
|
|
2777 |
return "<config.%s(%s)>" % (self.__class__.__name__, id(self)) |
|
2778 |
||
5743.1.1
by Vincent Ladeuil
Start implementing a config stack. |
2779 |
|
5743.6.23
by Vincent Ladeuil
More config concurrent updates tests. |
2780 |
class _CompatibleStack(Stack): |
5743.6.26
by Vincent Ladeuil
Clarify _CompatibleStack aims. |
2781 |
"""Place holder for compatibility with previous design.
|
2782 |
||
5743.10.2
by Vincent Ladeuil
Make sure RemoteBranch are supported as well, relying on the vfs API. |
2783 |
This is intended to ease the transition from the Config-based design to the
|
5743.6.26
by Vincent Ladeuil
Clarify _CompatibleStack aims. |
2784 |
Stack-based design and should not be used nor relied upon by plugins.
|
2785 |
||
2786 |
One assumption made here is that the daughter classes will all use Stores
|
|
2787 |
derived from LockableIniFileStore).
|
|
5743.6.32
by Vincent Ladeuil
Address poolie's review comments. |
2788 |
|
2789 |
It implements set() by re-loading the store before applying the
|
|
2790 |
modification and saving it.
|
|
2791 |
||
2792 |
The long term plan being to implement a single write by store to save
|
|
2793 |
all modifications, this class should not be used in the interim.
|
|
5743.6.26
by Vincent Ladeuil
Clarify _CompatibleStack aims. |
2794 |
"""
|
5743.6.23
by Vincent Ladeuil
More config concurrent updates tests. |
2795 |
|
2796 |
def set(self, name, value): |
|
5743.10.2
by Vincent Ladeuil
Make sure RemoteBranch are supported as well, relying on the vfs API. |
2797 |
# Force a reload
|
2798 |
self.store.unload() |
|
5743.6.23
by Vincent Ladeuil
More config concurrent updates tests. |
2799 |
super(_CompatibleStack, self).set(name, value) |
2800 |
# Force a write to persistent storage
|
|
2801 |
self.store.save() |
|
2802 |
||
2803 |
||
2804 |
class GlobalStack(_CompatibleStack): |
|
5743.6.1
by Vincent Ladeuil
Outline concrete stacks and basic smoke tests. |
2805 |
|
2806 |
def __init__(self): |
|
2807 |
# Get a GlobalStore
|
|
2808 |
gstore = GlobalStore() |
|
5743.6.14
by Vincent Ladeuil
Parametrize the Stack tests. |
2809 |
super(GlobalStack, self).__init__([gstore.get_sections], gstore) |
5743.6.1
by Vincent Ladeuil
Outline concrete stacks and basic smoke tests. |
2810 |
|
2811 |
||
5743.6.23
by Vincent Ladeuil
More config concurrent updates tests. |
2812 |
class LocationStack(_CompatibleStack): |
5743.6.1
by Vincent Ladeuil
Outline concrete stacks and basic smoke tests. |
2813 |
|
2814 |
def __init__(self, location): |
|
2815 |
lstore = LocationStore() |
|
2816 |
matcher = LocationMatcher(lstore, location) |
|
2817 |
gstore = GlobalStore() |
|
2818 |
super(LocationStack, self).__init__( |
|
5743.6.14
by Vincent Ladeuil
Parametrize the Stack tests. |
2819 |
[matcher.get_sections, gstore.get_sections], lstore) |
5743.6.1
by Vincent Ladeuil
Outline concrete stacks and basic smoke tests. |
2820 |
|
5743.6.27
by Vincent Ladeuil
Move the test registries to bzrlib.config so plugins will be able to use |
2821 |
class BranchStack(_CompatibleStack): |
5743.6.1
by Vincent Ladeuil
Outline concrete stacks and basic smoke tests. |
2822 |
|
2823 |
def __init__(self, branch): |
|
2824 |
bstore = BranchStore(branch) |
|
2825 |
lstore = LocationStore() |
|
2826 |
matcher = LocationMatcher(lstore, branch.base) |
|
2827 |
gstore = GlobalStore() |
|
2828 |
super(BranchStack, self).__init__( |
|
2829 |
[matcher.get_sections, bstore.get_sections, gstore.get_sections], |
|
5743.6.14
by Vincent Ladeuil
Parametrize the Stack tests. |
2830 |
bstore) |
5743.10.2
by Vincent Ladeuil
Make sure RemoteBranch are supported as well, relying on the vfs API. |
2831 |
self.branch = branch |
5743.6.1
by Vincent Ladeuil
Outline concrete stacks and basic smoke tests. |
2832 |
|
2833 |
||
5447.4.2
by Vincent Ladeuil
Implement the 'brz config' command. Read-only. |
2834 |
class cmd_config(commands.Command): |
5447.4.19
by Vincent Ladeuil
Add some more documentation. |
2835 |
__doc__ = """Display, set or remove a configuration option. |
2836 |
||
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2837 |
Display the active value for a given option.
|
2838 |
||
2839 |
If --all is specified, NAME is interpreted as a regular expression and all
|
|
2840 |
matching options are displayed mentioning their scope. The active value
|
|
2841 |
that bzr will take into account is the first one displayed for each option.
|
|
2842 |
||
2843 |
If no NAME is given, --all .* is implied.
|
|
5506.2.1
by Vincent Ladeuil
Implements ``bzr config --active option`` displaying only the value. |
2844 |
|
5447.4.19
by Vincent Ladeuil
Add some more documentation. |
2845 |
Setting a value is achieved by using name=value without spaces. The value
|
2846 |
is set in the most relevant scope and can be checked by displaying the
|
|
2847 |
option again.
|
|
5447.4.2
by Vincent Ladeuil
Implement the 'brz config' command. Read-only. |
2848 |
"""
|
2849 |
||
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2850 |
takes_args = ['name?'] |
5447.4.2
by Vincent Ladeuil
Implement the 'brz config' command. Read-only. |
2851 |
|
2852 |
takes_options = [ |
|
2853 |
'directory', |
|
5447.4.5
by Vincent Ladeuil
Implement ``bzr config option=value``. |
2854 |
# FIXME: This should be a registry option so that plugins can register
|
2855 |
# their own config files (or not) -- vila 20101002
|
|
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2856 |
commands.Option('scope', help='Reduce the scope to the specified' |
2857 |
' configuration file', |
|
2858 |
type=unicode), |
|
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2859 |
commands.Option('all', |
2860 |
help='Display all the defined values for the matching options.', |
|
5506.2.1
by Vincent Ladeuil
Implements ``bzr config --active option`` displaying only the value. |
2861 |
),
|
5447.4.8
by Vincent Ladeuil
Make the test properly fail and provide a fake implementation for ``bzr config --remove opt_name``. |
2862 |
commands.Option('remove', help='Remove the option from' |
2863 |
' the configuration file'), |
|
5447.4.2
by Vincent Ladeuil
Implement the 'brz config' command. Read-only. |
2864 |
]
|
2865 |
||
5425.4.24
by Martin Pool
Mention 'configuration' help topic from 'bzr help config' |
2866 |
_see_also = ['configuration'] |
2867 |
||
5447.4.2
by Vincent Ladeuil
Implement the 'brz config' command. Read-only. |
2868 |
@commands.display_command |
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2869 |
def run(self, name=None, all=False, directory=None, scope=None, |
2870 |
remove=False): |
|
5447.4.5
by Vincent Ladeuil
Implement ``bzr config option=value``. |
2871 |
if directory is None: |
2872 |
directory = '.' |
|
2873 |
directory = urlutils.normalize_url(directory) |
|
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2874 |
if remove and all: |
5506.2.1
by Vincent Ladeuil
Implements ``bzr config --active option`` displaying only the value. |
2875 |
raise errors.BzrError( |
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2876 |
'--all and --remove are mutually exclusive.') |
5506.2.1
by Vincent Ladeuil
Implements ``bzr config --active option`` displaying only the value. |
2877 |
elif remove: |
2878 |
# Delete the option in the given scope
|
|
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2879 |
self._remove_config_option(name, directory, scope) |
2880 |
elif name is None: |
|
2881 |
# Defaults to all options
|
|
2882 |
self._show_matching_options('.*', directory, scope) |
|
5447.4.5
by Vincent Ladeuil
Implement ``bzr config option=value``. |
2883 |
else: |
5506.2.1
by Vincent Ladeuil
Implements ``bzr config --active option`` displaying only the value. |
2884 |
try: |
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2885 |
name, value = name.split('=', 1) |
5506.2.1
by Vincent Ladeuil
Implements ``bzr config --active option`` displaying only the value. |
2886 |
except ValueError: |
2887 |
# Display the option(s) value(s)
|
|
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2888 |
if all: |
2889 |
self._show_matching_options(name, directory, scope) |
|
2890 |
else: |
|
2891 |
self._show_value(name, directory, scope) |
|
5447.4.5
by Vincent Ladeuil
Implement ``bzr config option=value``. |
2892 |
else: |
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2893 |
if all: |
2894 |
raise errors.BzrError( |
|
2895 |
'Only one option can be set.') |
|
5506.2.1
by Vincent Ladeuil
Implements ``bzr config --active option`` displaying only the value. |
2896 |
# Set the option value
|
2897 |
self._set_config_option(name, value, directory, scope) |
|
5447.4.5
by Vincent Ladeuil
Implement ``bzr config option=value``. |
2898 |
|
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2899 |
def _get_configs(self, directory, scope=None): |
2900 |
"""Iterate the configurations specified by ``directory`` and ``scope``.
|
|
5447.4.9
by Vincent Ladeuil
Refactor under tests umbrella. |
2901 |
|
2902 |
:param directory: Where the configurations are derived from.
|
|
2903 |
||
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2904 |
:param scope: A specific config to start from.
|
5447.4.9
by Vincent Ladeuil
Refactor under tests umbrella. |
2905 |
"""
|
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2906 |
if scope is not None: |
2907 |
if scope == 'bazaar': |
|
5447.4.9
by Vincent Ladeuil
Refactor under tests umbrella. |
2908 |
yield GlobalConfig() |
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2909 |
elif scope == 'locations': |
5447.4.9
by Vincent Ladeuil
Refactor under tests umbrella. |
2910 |
yield LocationConfig(directory) |
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2911 |
elif scope == 'branch': |
5447.4.9
by Vincent Ladeuil
Refactor under tests umbrella. |
2912 |
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch( |
2913 |
directory) |
|
2914 |
yield br.get_config() |
|
2915 |
else: |
|
2916 |
try: |
|
2917 |
(_, br, _) = bzrdir.BzrDir.open_containing_tree_or_branch( |
|
2918 |
directory) |
|
2919 |
yield br.get_config() |
|
2920 |
except errors.NotBranchError: |
|
2921 |
yield LocationConfig(directory) |
|
2922 |
yield GlobalConfig() |
|
2923 |
||
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2924 |
def _show_value(self, name, directory, scope): |
5506.2.1
by Vincent Ladeuil
Implements ``bzr config --active option`` displaying only the value. |
2925 |
displayed = False |
2926 |
for c in self._get_configs(directory, scope): |
|
2927 |
if displayed: |
|
2928 |
break
|
|
5533.2.1
by Vincent Ladeuil
``bzr config`` properly displays list values |
2929 |
for (oname, value, section, conf_id, parser) in c._get_options(): |
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2930 |
if name == oname: |
5533.1.3
by Vincent Ladeuil
Tweak comment as per poolie's suggestion. |
2931 |
# Display only the first value and exit
|
5533.2.3
by Vincent Ladeuil
Merge 671050-config-policy into 672382-list-values 672382-list-values resolving conflicts |
2932 |
|
5533.1.3
by Vincent Ladeuil
Tweak comment as per poolie's suggestion. |
2933 |
# FIXME: We need to use get_user_option to take policies
|
2934 |
# into account and we need to make sure the option exists
|
|
5533.2.3
by Vincent Ladeuil
Merge 671050-config-policy into 672382-list-values 672382-list-values resolving conflicts |
2935 |
# too (hence the two for loops), this needs a better API
|
2936 |
# -- vila 20101117
|
|
5533.2.1
by Vincent Ladeuil
``bzr config`` properly displays list values |
2937 |
value = c.get_user_option(name) |
2938 |
# Quote the value appropriately
|
|
2939 |
value = parser._quote(value) |
|
2940 |
self.outf.write('%s\n' % (value,)) |
|
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2941 |
displayed = True |
2942 |
break
|
|
2943 |
if not displayed: |
|
2944 |
raise errors.NoSuchConfigOption(name) |
|
2945 |
||
2946 |
def _show_matching_options(self, name, directory, scope): |
|
5967.9.3
by Martin Pool
Explicitly use lazy_regexp where we count on its error reporting behaviour |
2947 |
name = lazy_regex.lazy_compile(name) |
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2948 |
# We want any error in the regexp to be raised *now* so we need to
|
5967.9.3
by Martin Pool
Explicitly use lazy_regexp where we count on its error reporting behaviour |
2949 |
# avoid the delay introduced by the lazy regexp. But, we still do
|
2950 |
# want the nicer errors raised by lazy_regex.
|
|
2951 |
name._compile_and_collapse() |
|
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2952 |
cur_conf_id = None |
5533.1.1
by Vincent Ladeuil
Fix ``bzr config`` to respect policies when displaying values and also display sections when appropriate. |
2953 |
cur_section = None |
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2954 |
for c in self._get_configs(directory, scope): |
5533.2.1
by Vincent Ladeuil
``bzr config`` properly displays list values |
2955 |
for (oname, value, section, conf_id, parser) in c._get_options(): |
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2956 |
if name.search(oname): |
2957 |
if cur_conf_id != conf_id: |
|
5506.2.1
by Vincent Ladeuil
Implements ``bzr config --active option`` displaying only the value. |
2958 |
# Explain where the options are defined
|
5447.4.3
by Vincent Ladeuil
Simplify code and design by only defining get_options() where relevant. |
2959 |
self.outf.write('%s:\n' % (conf_id,)) |
2960 |
cur_conf_id = conf_id |
|
5533.1.1
by Vincent Ladeuil
Fix ``bzr config`` to respect policies when displaying values and also display sections when appropriate. |
2961 |
cur_section = None |
2962 |
if (section not in (None, 'DEFAULT') |
|
2963 |
and cur_section != section): |
|
2964 |
# Display the section if it's not the default (or only)
|
|
2965 |
# one.
|
|
5533.2.1
by Vincent Ladeuil
``bzr config`` properly displays list values |
2966 |
self.outf.write(' [%s]\n' % (section,)) |
5533.1.1
by Vincent Ladeuil
Fix ``bzr config`` to respect policies when displaying values and also display sections when appropriate. |
2967 |
cur_section = section |
5506.2.3
by Vincent Ladeuil
Take review comments into account and drive-by fix bug #670251 |
2968 |
self.outf.write(' %s = %s\n' % (oname, value)) |
5447.4.2
by Vincent Ladeuil
Implement the 'brz config' command. Read-only. |
2969 |
|
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2970 |
def _set_config_option(self, name, value, directory, scope): |
2971 |
for conf in self._get_configs(directory, scope): |
|
5447.4.9
by Vincent Ladeuil
Refactor under tests umbrella. |
2972 |
conf.set_user_option(name, value) |
2973 |
break
|
|
5447.4.5
by Vincent Ladeuil
Implement ``bzr config option=value``. |
2974 |
else: |
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2975 |
raise errors.NoSuchConfig(scope) |
5447.4.5
by Vincent Ladeuil
Implement ``bzr config option=value``. |
2976 |
|
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2977 |
def _remove_config_option(self, name, directory, scope): |
5506.2.1
by Vincent Ladeuil
Implements ``bzr config --active option`` displaying only the value. |
2978 |
if name is None: |
2979 |
raise errors.BzrCommandError( |
|
2980 |
'--remove expects an option to remove.') |
|
5447.4.9
by Vincent Ladeuil
Refactor under tests umbrella. |
2981 |
removed = False |
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2982 |
for conf in self._get_configs(directory, scope): |
5447.4.12
by Vincent Ladeuil
Turn get_options() and get_sections() into private methods because section handling is too messy and needs to be discussed and settled. |
2983 |
for (section_name, section, conf_id) in conf._get_sections(): |
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2984 |
if scope is not None and conf_id != scope: |
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
2985 |
# Not the right configuration file
|
2986 |
continue
|
|
2987 |
if name in section: |
|
5447.4.16
by Vincent Ladeuil
Use config_id instead of id as suggested by poolie. |
2988 |
if conf_id != conf.config_id(): |
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
2989 |
conf = self._get_configs(directory, conf_id).next() |
2990 |
# We use the first section in the first config where the
|
|
2991 |
# option is defined to remove it
|
|
2992 |
conf.remove_user_option(name, section_name) |
|
2993 |
removed = True |
|
2994 |
break
|
|
2995 |
break
|
|
2996 |
else: |
|
5447.4.17
by Vincent Ladeuil
Rename config --force to config --scope. |
2997 |
raise errors.NoSuchConfig(scope) |
5447.4.11
by Vincent Ladeuil
Implement ``bzr config --remove <option>``. |
2998 |
if not removed: |
2999 |
raise errors.NoSuchConfigOption(name) |
|
5743.6.27
by Vincent Ladeuil
Move the test registries to bzrlib.config so plugins will be able to use |
3000 |
|
3001 |
# Test registries
|
|
5743.6.29
by Vincent Ladeuil
For jam. |
3002 |
#
|
5743.6.27
by Vincent Ladeuil
Move the test registries to bzrlib.config so plugins will be able to use |
3003 |
# We need adapters that can build a Store or a Stack in a test context. Test
|
3004 |
# classes, based on TestCaseWithTransport, can use the registry to parametrize
|
|
3005 |
# themselves. The builder will receive a test instance and should return a
|
|
5743.6.29
by Vincent Ladeuil
For jam. |
3006 |
# ready-to-use store or stack. Plugins that define new store/stacks can also
|
5743.6.27
by Vincent Ladeuil
Move the test registries to bzrlib.config so plugins will be able to use |
3007 |
# register themselves here to be tested against the tests defined in
|
5743.11.1
by Vincent Ladeuil
Add a note about config store builders being called several times by some tests. |
3008 |
# bzrlib.tests.test_config. Note that the builder can be called multiple times
|
3009 |
# for the same tests.
|
|
5743.6.27
by Vincent Ladeuil
Move the test registries to bzrlib.config so plugins will be able to use |
3010 |
|
3011 |
# The registered object should be a callable receiving a test instance
|
|
3012 |
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Store
|
|
3013 |
# object.
|
|
3014 |
test_store_builder_registry = registry.Registry() |
|
3015 |
||
5743.10.1
by Vincent Ladeuil
Derefence the ref to use it. |
3016 |
# The registered object should be a callable receiving a test instance
|
5743.6.27
by Vincent Ladeuil
Move the test registries to bzrlib.config so plugins will be able to use |
3017 |
# parameter (inheriting from tests.TestCaseWithTransport) and returning a Stack
|
3018 |
# object.
|
|
3019 |
test_stack_builder_registry = registry.Registry() |