3777.3.2
by Aaron Bentley
Reverse order of scheme and password |
1 |
# Copyright (C) 2005, 2007, 2008 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
|
1442.1.20
by Robert Collins
add some documentation on options |
32 |
|
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
33 |
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 |
34 |
Wildcards may be used - * and ? as normal in shell completion. Options
|
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
35 |
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 |
36 |
setting.
|
37 |
[/home/robertc/source]
|
|
38 |
recurse=False|True(default)
|
|
39 |
email= as above
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
40 |
check_signatures= as above
|
1442.1.20
by Robert Collins
add some documentation on options |
41 |
create_signatures= as above.
|
42 |
||
43 |
explanation of options
|
|
44 |
----------------------
|
|
45 |
editor - this option sets the pop up editor to use during commits.
|
|
46 |
email - this option sets the user id bzr will use when committing.
|
|
47 |
check_signatures - this option controls whether bzr will require good gpg
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
48 |
signatures, ignore them, or check them if they are
|
1442.1.20
by Robert Collins
add some documentation on options |
49 |
present.
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
50 |
create_signatures - this option controls whether bzr will always create
|
1442.1.20
by Robert Collins
add some documentation on options |
51 |
gpg signatures, never create them, or create them if the
|
52 |
branch is configured to require them.
|
|
1887.2.1
by Adeodato Simó
Fix some typos and grammar issues. |
53 |
log_format - this option sets the default log format. Possible values are
|
54 |
long, short, line, or a plugin can register new formats.
|
|
1553.6.2
by Erik Bågfors
documentation and NEWS |
55 |
|
56 |
In bazaar.conf you can also define aliases in the ALIASES sections, example
|
|
57 |
||
58 |
[ALIASES]
|
|
59 |
lastlog=log --line -r-10..-1
|
|
60 |
ll=log --line -r-10..-1
|
|
61 |
h=help
|
|
62 |
up=pull
|
|
1442.1.20
by Robert Collins
add some documentation on options |
63 |
"""
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
64 |
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
65 |
import os |
66 |
import sys |
|
1474
by Robert Collins
Merge from Aaron Bentley. |
67 |
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
68 |
from bzrlib.lazy_import import lazy_import |
69 |
lazy_import(globals(), """ |
|
1474
by Robert Collins
Merge from Aaron Bentley. |
70 |
import errno
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
71 |
from fnmatch import fnmatch
|
72 |
import re
|
|
2900.2.22
by Vincent Ladeuil
Polishing. |
73 |
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. |
74 |
|
75 |
import bzrlib
|
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
76 |
from bzrlib import (
|
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
77 |
debug,
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
78 |
errors,
|
2681.1.8
by Aaron Bentley
Add Thunderbird support to bzr send |
79 |
mail_client,
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
80 |
osutils,
|
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
81 |
registry,
|
2120.6.9
by James Henstridge
Fixes for issues brought up in John's review |
82 |
symbol_versioning,
|
1551.15.35
by Aaron Bentley
Warn when setting config values that will be masked (#122286) |
83 |
trace,
|
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
84 |
ui,
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
85 |
urlutils,
|
2245.4.3
by Alexander Belchenko
config.py: changing _auto_user_id() and config_dir() to use functions from win32utils |
86 |
win32utils,
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
87 |
)
|
2991.2.4
by Vincent Ladeuil
Various fixes following local testing environment rebuild. |
88 |
from bzrlib.util.configobj import configobj
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
89 |
""") |
90 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
91 |
|
1442.1.14
by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE |
92 |
CHECK_IF_POSSIBLE=0 |
93 |
CHECK_ALWAYS=1 |
|
94 |
CHECK_NEVER=2 |
|
95 |
||
96 |
||
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
97 |
SIGN_WHEN_REQUIRED=0 |
98 |
SIGN_ALWAYS=1 |
|
99 |
SIGN_NEVER=2 |
|
100 |
||
101 |
||
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
102 |
POLICY_NONE = 0 |
103 |
POLICY_NORECURSE = 1 |
|
104 |
POLICY_APPENDPATH = 2 |
|
105 |
||
2120.6.8
by James Henstridge
Change syntax for setting config option policies. Rather than |
106 |
_policy_name = { |
107 |
POLICY_NONE: None, |
|
108 |
POLICY_NORECURSE: 'norecurse', |
|
109 |
POLICY_APPENDPATH: 'appendpath', |
|
110 |
}
|
|
111 |
_policy_value = { |
|
112 |
None: POLICY_NONE, |
|
113 |
'none': POLICY_NONE, |
|
114 |
'norecurse': POLICY_NORECURSE, |
|
115 |
'appendpath': POLICY_APPENDPATH, |
|
116 |
}
|
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
117 |
|
118 |
||
119 |
STORE_LOCATION = POLICY_NONE |
|
120 |
STORE_LOCATION_NORECURSE = POLICY_NORECURSE |
|
121 |
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH |
|
122 |
STORE_BRANCH = 3 |
|
123 |
STORE_GLOBAL = 4 |
|
124 |
||
3224.5.10
by Andrew Bennetts
Replace some duplication with a different form of hackery. |
125 |
_ConfigObj = None |
126 |
def ConfigObj(*args, **kwargs): |
|
127 |
global _ConfigObj |
|
128 |
if _ConfigObj is None: |
|
129 |
class ConfigObj(configobj.ConfigObj): |
|
130 |
||
131 |
def get_bool(self, section, key): |
|
132 |
return self[section].as_bool(key) |
|
133 |
||
134 |
def get_value(self, section, name): |
|
135 |
# Try [] for the old DEFAULT section.
|
|
136 |
if section == "DEFAULT": |
|
137 |
try: |
|
138 |
return self[name] |
|
139 |
except KeyError: |
|
140 |
pass
|
|
141 |
return self[section][name] |
|
142 |
_ConfigObj = ConfigObj |
|
143 |
return _ConfigObj(*args, **kwargs) |
|
1474
by Robert Collins
Merge from Aaron Bentley. |
144 |
|
145 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
146 |
class Config(object): |
147 |
"""A configuration policy - what username, editor, gpg needs etc."""
|
|
148 |
||
4503.2.2
by Vincent Ladeuil
Get a bool or none from a config file. |
149 |
def __init__(self): |
150 |
super(Config, self).__init__() |
|
151 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
152 |
def get_editor(self): |
153 |
"""Get the users pop up editor."""
|
|
154 |
raise NotImplementedError |
|
155 |
||
4603.1.10
by Aaron Bentley
Provide change editor via config. |
156 |
def get_change_editor(self, old_tree, new_tree): |
157 |
from bzrlib import diff |
|
158 |
cmd = self._get_change_editor() |
|
159 |
if cmd is None: |
|
160 |
return None |
|
161 |
return diff.DiffFromTool.from_string(cmd, old_tree, new_tree, |
|
162 |
sys.stdout) |
|
163 |
||
164 |
||
2681.1.8
by Aaron Bentley
Add Thunderbird support to bzr send |
165 |
def get_mail_client(self): |
166 |
"""Get a mail client to use"""
|
|
167 |
selected_client = self.get_user_option('mail_client') |
|
3638.2.4
by Neil Martinsen-Burrell
Address JAMs review. Dont use register_lazy and dont lazy_import anything other than modules |
168 |
_registry = mail_client.mail_client_registry |
2681.1.10
by Aaron Bentley
Clean up handling of unknown mail clients |
169 |
try: |
3638.2.4
by Neil Martinsen-Burrell
Address JAMs review. Dont use register_lazy and dont lazy_import anything other than modules |
170 |
mail_client_class = _registry.get(selected_client) |
2681.1.10
by Aaron Bentley
Clean up handling of unknown mail clients |
171 |
except KeyError: |
172 |
raise errors.UnknownMailClient(selected_client) |
|
173 |
return mail_client_class(self) |
|
2681.1.8
by Aaron Bentley
Add Thunderbird support to bzr send |
174 |
|
1442.1.15
by Robert Collins
make getting the signature checking policy a template method |
175 |
def _get_signature_checking(self): |
176 |
"""Template method to override signature checking policy."""
|
|
177 |
||
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
178 |
def _get_signing_policy(self): |
179 |
"""Template method to override signature creation policy."""
|
|
180 |
||
1993.3.6
by James Henstridge
get rid of the recurse argument to get_user_option() |
181 |
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. |
182 |
"""Template method to provide a user option."""
|
183 |
return None |
|
184 |
||
1993.3.6
by James Henstridge
get rid of the recurse argument to get_user_option() |
185 |
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. |
186 |
"""Get a generic option - no special process, no default."""
|
1993.3.6
by James Henstridge
get rid of the recurse argument to get_user_option() |
187 |
return self._get_user_option(option_name) |
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
188 |
|
4503.2.2
by Vincent Ladeuil
Get a bool or none from a config file. |
189 |
def get_user_option_as_bool(self, option_name): |
190 |
"""Get a generic option as a boolean - no special process, no default.
|
|
191 |
||
192 |
: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. |
193 |
interpreted as a boolean. Returns True or False otherwise.
|
4503.2.2
by Vincent Ladeuil
Get a bool or none from a config file. |
194 |
"""
|
195 |
s = self._get_user_option(option_name) |
|
196 |
return ui.bool_from_string(s) |
|
197 |
||
4840.2.4
by Vincent Ladeuil
Implement config.get_user_option_as_list. |
198 |
def get_user_option_as_list(self, option_name): |
199 |
"""Get a generic option as a list - no special process, no default.
|
|
200 |
||
201 |
:return None if the option doesn't exist. Returns the value as a list
|
|
202 |
otherwise.
|
|
203 |
"""
|
|
204 |
l = self._get_user_option(option_name) |
|
205 |
if isinstance(l, (str, unicode)): |
|
206 |
# A single value, most probably the user forgot the final ','
|
|
207 |
l = [l] |
|
208 |
return l |
|
209 |
||
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
210 |
def gpg_signing_command(self): |
211 |
"""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. |
212 |
result = self._gpg_signing_command() |
213 |
if result is None: |
|
214 |
result = "gpg" |
|
215 |
return result |
|
216 |
||
217 |
def _gpg_signing_command(self): |
|
218 |
"""See gpg_signing_command()."""
|
|
219 |
return None |
|
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
220 |
|
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
221 |
def log_format(self): |
222 |
"""What log format should be used"""
|
|
223 |
result = self._log_format() |
|
1553.2.4
by Erik Bågfors
Support for setting the default log format at a configuration option |
224 |
if result is None: |
225 |
result = "long" |
|
226 |
return result |
|
227 |
||
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
228 |
def _log_format(self): |
229 |
"""See log_format()."""
|
|
1553.2.4
by Erik Bågfors
Support for setting the default log format at a configuration option |
230 |
return None |
231 |
||
1472
by Robert Collins
post commit hook, first pass implementation |
232 |
def post_commit(self): |
233 |
"""An ordered list of python functions to call.
|
|
234 |
||
235 |
Each function takes branch, rev_id as parameters.
|
|
236 |
"""
|
|
237 |
return self._post_commit() |
|
238 |
||
239 |
def _post_commit(self): |
|
240 |
"""See Config.post_commit."""
|
|
241 |
return None |
|
242 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
243 |
def user_email(self): |
244 |
"""Return just the email component of a username."""
|
|
1185.33.31
by Martin Pool
Make annotate cope better with revisions committed without a valid |
245 |
return extract_email_address(self.username()) |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
246 |
|
247 |
def username(self): |
|
248 |
"""Return email-style username.
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
249 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
250 |
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
251 |
|
1861.4.1
by Matthieu Moy
BZREMAIL renamed to BZR_EMAIL. |
252 |
$BZR_EMAIL can be set to override this (as well as the
|
253 |
deprecated $BZREMAIL), then
|
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
254 |
the concrete policy type is checked, and finally
|
1185.37.2
by Jamie Wilkinson
Fix a typo and grammar in Config.username() docstring. |
255 |
$EMAIL is examined.
|
256 |
If none is found, a reasonable default is (hopefully)
|
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
257 |
created.
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
258 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
259 |
TODO: Check it's reasonably well-formed.
|
260 |
"""
|
|
1861.4.1
by Matthieu Moy
BZREMAIL renamed to BZR_EMAIL. |
261 |
v = os.environ.get('BZR_EMAIL') |
262 |
if v: |
|
3224.5.4
by Andrew Bennetts
Fix test suite, mainly weeding out uses of bzrlib.user_encoding. |
263 |
return v.decode(osutils.get_user_encoding()) |
2900.3.1
by Tim Penhey
Removed some annoying trailing whitespace. |
264 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
265 |
v = self._get_user_id() |
266 |
if v: |
|
267 |
return v |
|
2900.3.1
by Tim Penhey
Removed some annoying trailing whitespace. |
268 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
269 |
v = os.environ.get('EMAIL') |
270 |
if v: |
|
3224.5.4
by Andrew Bennetts
Fix test suite, mainly weeding out uses of bzrlib.user_encoding. |
271 |
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 |
272 |
|
273 |
name, email = _auto_user_id() |
|
274 |
if name: |
|
275 |
return '%s <%s>' % (name, email) |
|
276 |
else: |
|
277 |
return email |
|
278 |
||
1442.1.14
by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE |
279 |
def signature_checking(self): |
280 |
"""What is the current policy for signature checking?."""
|
|
1442.1.15
by Robert Collins
make getting the signature checking policy a template method |
281 |
policy = self._get_signature_checking() |
282 |
if policy is not None: |
|
283 |
return policy |
|
1442.1.14
by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE |
284 |
return CHECK_IF_POSSIBLE |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
285 |
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
286 |
def signing_policy(self): |
287 |
"""What is the current policy for signature checking?."""
|
|
288 |
policy = self._get_signing_policy() |
|
289 |
if policy is not None: |
|
290 |
return policy |
|
291 |
return SIGN_WHEN_REQUIRED |
|
292 |
||
1442.1.21
by Robert Collins
create signature_needed() call for commit to trigger creating signatures |
293 |
def signature_needed(self): |
294 |
"""Is a signature needed when committing ?."""
|
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
295 |
policy = self._get_signing_policy() |
296 |
if policy is None: |
|
297 |
policy = self._get_signature_checking() |
|
298 |
if policy is not None: |
|
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
299 |
trace.warning("Please use create_signatures," |
300 |
" not check_signatures to set signing policy.") |
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
301 |
if policy == CHECK_ALWAYS: |
302 |
return True |
|
303 |
elif policy == SIGN_ALWAYS: |
|
1442.1.21
by Robert Collins
create signature_needed() call for commit to trigger creating signatures |
304 |
return True |
305 |
return False |
|
306 |
||
1553.6.12
by Erik Bågfors
remove AliasConfig, based on input from abentley |
307 |
def get_alias(self, value): |
308 |
return self._get_alias(value) |
|
309 |
||
310 |
def _get_alias(self, value): |
|
311 |
pass
|
|
312 |
||
1770.2.7
by Aaron Bentley
Set/get nickname using BranchConfig |
313 |
def get_nickname(self): |
314 |
return self._get_nickname() |
|
315 |
||
316 |
def _get_nickname(self): |
|
317 |
return None |
|
318 |
||
1551.18.17
by Aaron Bentley
Introduce bzr_remote_path configuration variable |
319 |
def get_bzr_remote_path(self): |
320 |
try: |
|
321 |
return os.environ['BZR_REMOTE_PATH'] |
|
322 |
except KeyError: |
|
323 |
path = self.get_user_option("bzr_remote_path") |
|
324 |
if path is None: |
|
325 |
path = 'bzr' |
|
326 |
return path |
|
327 |
||
4840.2.6
by Vincent Ladeuil
Implement config.suppress_warning. |
328 |
def suppress_warning(self, warning): |
329 |
"""Should the warning be suppressed or emitted.
|
|
330 |
||
331 |
:param warning: The name of the warning being tested.
|
|
332 |
||
333 |
:returns: True if the warning should be suppressed, False otherwise.
|
|
334 |
"""
|
|
335 |
warnings = self.get_user_option_as_list('suppress_warnings') |
|
336 |
if warnings is None or warning not in warnings: |
|
337 |
return False |
|
338 |
else: |
|
339 |
return True |
|
340 |
||
1442.1.15
by Robert Collins
make getting the signature checking policy a template method |
341 |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
342 |
class IniBasedConfig(Config): |
343 |
"""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 |
344 |
|
4503.2.2
by Vincent Ladeuil
Get a bool or none from a config file. |
345 |
def __init__(self, get_filename): |
346 |
super(IniBasedConfig, self).__init__() |
|
347 |
self._get_filename = get_filename |
|
348 |
self._parser = None |
|
349 |
||
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
350 |
def _get_parser(self, file=None): |
1185.12.51
by Aaron Bentley
Allowed second call of _get_parser() to not require a file |
351 |
if self._parser is not None: |
352 |
return self._parser |
|
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
353 |
if file is None: |
354 |
input = self._get_filename() |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
355 |
else: |
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
356 |
input = file |
1185.12.51
by Aaron Bentley
Allowed second call of _get_parser() to not require a file |
357 |
try: |
4603.1.21
by Aaron Bentley
Restore ConfigObj interpolation. |
358 |
self._parser = ConfigObj(input, encoding='utf-8') |
1474
by Robert Collins
Merge from Aaron Bentley. |
359 |
except configobj.ConfigObjError, e: |
1185.12.51
by Aaron Bentley
Allowed second call of _get_parser() to not require a file |
360 |
raise errors.ParseConfigError(e.errors, e.config.filename) |
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
361 |
return self._parser |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
362 |
|
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
363 |
def _get_matching_sections(self): |
364 |
"""Return an ordered list of (section_name, extra_path) pairs.
|
|
365 |
||
366 |
If the section contains inherited configuration, extra_path is
|
|
367 |
a string containing the additional path components.
|
|
368 |
"""
|
|
369 |
section = self._get_section() |
|
370 |
if section is not None: |
|
371 |
return [(section, '')] |
|
372 |
else: |
|
373 |
return [] |
|
374 |
||
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
375 |
def _get_section(self): |
376 |
"""Override this to define the section used by the config."""
|
|
377 |
return "DEFAULT" |
|
378 |
||
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
379 |
def _get_option_policy(self, section, option_name): |
380 |
"""Return the policy for the given (section, option_name) pair."""
|
|
381 |
return POLICY_NONE |
|
382 |
||
4603.1.10
by Aaron Bentley
Provide change editor via config. |
383 |
def _get_change_editor(self): |
384 |
return self.get_user_option('change_editor') |
|
385 |
||
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
386 |
def _get_signature_checking(self): |
387 |
"""See Config._get_signature_checking."""
|
|
1474
by Robert Collins
Merge from Aaron Bentley. |
388 |
policy = self._get_user_option('check_signatures') |
389 |
if policy: |
|
390 |
return self._string_to_signature_policy(policy) |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
391 |
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
392 |
def _get_signing_policy(self): |
1773.4.3
by Martin Pool
[merge] bzr.dev |
393 |
"""See Config._get_signing_policy"""
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
394 |
policy = self._get_user_option('create_signatures') |
395 |
if policy: |
|
396 |
return self._string_to_signing_policy(policy) |
|
397 |
||
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
398 |
def _get_user_id(self): |
399 |
"""Get the user id from the 'email' key in the current section."""
|
|
1474
by Robert Collins
Merge from Aaron Bentley. |
400 |
return self._get_user_option('email') |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
401 |
|
1993.3.6
by James Henstridge
get rid of the recurse argument to get_user_option() |
402 |
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. |
403 |
"""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 |
404 |
for (section, extra_path) in self._get_matching_sections(): |
405 |
try: |
|
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
406 |
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 |
407 |
except KeyError: |
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
408 |
continue
|
409 |
policy = self._get_option_policy(section, option_name) |
|
410 |
if policy == POLICY_NONE: |
|
411 |
return value |
|
412 |
elif policy == POLICY_NORECURSE: |
|
413 |
# norecurse items only apply to the exact path
|
|
414 |
if extra_path: |
|
415 |
continue
|
|
416 |
else: |
|
417 |
return value |
|
418 |
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 |
419 |
if extra_path: |
420 |
value = urlutils.join(value, extra_path) |
|
421 |
return value |
|
2120.6.6
by James Henstridge
fix test_set_push_location test |
422 |
else: |
423 |
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 |
424 |
else: |
1993.3.1
by James Henstridge
first go at making location config lookup recursive |
425 |
return None |
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
426 |
|
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
427 |
def _gpg_signing_command(self): |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
428 |
"""See Config.gpg_signing_command."""
|
1472
by Robert Collins
post commit hook, first pass implementation |
429 |
return self._get_user_option('gpg_signing_command') |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
430 |
|
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
431 |
def _log_format(self): |
432 |
"""See Config.log_format."""
|
|
433 |
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 |
434 |
|
1472
by Robert Collins
post commit hook, first pass implementation |
435 |
def _post_commit(self): |
436 |
"""See Config.post_commit."""
|
|
437 |
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 |
438 |
|
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
439 |
def _string_to_signature_policy(self, signature_string): |
440 |
"""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 |
441 |
if signature_string.lower() == 'check-available': |
442 |
return CHECK_IF_POSSIBLE |
|
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
443 |
if signature_string.lower() == 'ignore': |
444 |
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 |
445 |
if signature_string.lower() == 'require': |
446 |
return CHECK_ALWAYS |
|
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
447 |
raise errors.BzrError("Invalid signatures policy '%s'" |
448 |
% signature_string) |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
449 |
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
450 |
def _string_to_signing_policy(self, signature_string): |
451 |
"""Convert a string to a signing policy."""
|
|
452 |
if signature_string.lower() == 'when-required': |
|
453 |
return SIGN_WHEN_REQUIRED |
|
454 |
if signature_string.lower() == 'never': |
|
455 |
return SIGN_NEVER |
|
456 |
if signature_string.lower() == 'always': |
|
457 |
return SIGN_ALWAYS |
|
458 |
raise errors.BzrError("Invalid signing policy '%s'" |
|
459 |
% signature_string) |
|
460 |
||
1553.6.12
by Erik Bågfors
remove AliasConfig, based on input from abentley |
461 |
def _get_alias(self, value): |
462 |
try: |
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
463 |
return self._get_parser().get_value("ALIASES", |
1553.6.12
by Erik Bågfors
remove AliasConfig, based on input from abentley |
464 |
value) |
465 |
except KeyError: |
|
466 |
pass
|
|
467 |
||
1770.2.7
by Aaron Bentley
Set/get nickname using BranchConfig |
468 |
def _get_nickname(self): |
469 |
return self.get_user_option('nickname') |
|
470 |
||
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
471 |
|
472 |
class GlobalConfig(IniBasedConfig): |
|
473 |
"""The configuration that should be used for a specific location."""
|
|
474 |
||
475 |
def get_editor(self): |
|
1474
by Robert Collins
Merge from Aaron Bentley. |
476 |
return self._get_user_option('editor') |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
477 |
|
478 |
def __init__(self): |
|
479 |
super(GlobalConfig, self).__init__(config_filename) |
|
480 |
||
1816.2.1
by Robey Pointer
add set_user_option to GlobalConfig, and make /etc/passwd username lookup try harder with encodings |
481 |
def set_user_option(self, option, value): |
482 |
"""Save option and its value in the configuration."""
|
|
2900.3.2
by Tim Penhey
A working alias command. |
483 |
self._set_option(option, value, 'DEFAULT') |
484 |
||
485 |
def get_aliases(self): |
|
486 |
"""Return the aliases section."""
|
|
487 |
if 'ALIASES' in self._get_parser(): |
|
488 |
return self._get_parser()['ALIASES'] |
|
489 |
else: |
|
490 |
return {} |
|
491 |
||
492 |
def set_alias(self, alias_name, alias_command): |
|
493 |
"""Save the alias in the configuration."""
|
|
494 |
self._set_option(alias_name, alias_command, 'ALIASES') |
|
495 |
||
496 |
def unset_alias(self, alias_name): |
|
497 |
"""Unset an existing alias."""
|
|
498 |
aliases = self._get_parser().get('ALIASES') |
|
2900.3.7
by Tim Penhey
Updates from Aaron's review. |
499 |
if not aliases or alias_name not in aliases: |
500 |
raise errors.NoSuchAlias(alias_name) |
|
2900.3.2
by Tim Penhey
A working alias command. |
501 |
del aliases[alias_name] |
2900.3.12
by Tim Penhey
Final review comments. |
502 |
self._write_config_file() |
2900.3.2
by Tim Penhey
A working alias command. |
503 |
|
504 |
def _set_option(self, option, value, section): |
|
1816.2.1
by Robey Pointer
add set_user_option to GlobalConfig, and make /etc/passwd username lookup try harder with encodings |
505 |
# FIXME: RBC 20051029 This should refresh the parser and also take a
|
506 |
# file lock on bazaar.conf.
|
|
507 |
conf_dir = os.path.dirname(self._get_filename()) |
|
508 |
ensure_config_dir_exists(conf_dir) |
|
2900.3.7
by Tim Penhey
Updates from Aaron's review. |
509 |
self._get_parser().setdefault(section, {})[option] = value |
2900.3.12
by Tim Penhey
Final review comments. |
510 |
self._write_config_file() |
2900.3.2
by Tim Penhey
A working alias command. |
511 |
|
2900.3.12
by Tim Penhey
Final review comments. |
512 |
def _write_config_file(self): |
1816.2.1
by Robey Pointer
add set_user_option to GlobalConfig, and make /etc/passwd username lookup try harder with encodings |
513 |
f = open(self._get_filename(), 'wb') |
514 |
self._get_parser().write(f) |
|
515 |
f.close() |
|
516 |
||
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
517 |
|
518 |
class LocationConfig(IniBasedConfig): |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
519 |
"""A configuration object that gives the policy for a location."""
|
520 |
||
521 |
def __init__(self, location): |
|
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
522 |
name_generator = locations_config_filename |
2900.3.1
by Tim Penhey
Removed some annoying trailing whitespace. |
523 |
if (not os.path.exists(name_generator()) and |
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
524 |
os.path.exists(branches_config_filename())): |
1830.2.1
by John Arbash Meinel
Make it clearer what config file needs to be renamed. |
525 |
if sys.platform == 'win32': |
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
526 |
trace.warning('Please rename %s to %s' |
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
527 |
% (branches_config_filename(), |
528 |
locations_config_filename())) |
|
1830.2.1
by John Arbash Meinel
Make it clearer what config file needs to be renamed. |
529 |
else: |
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
530 |
trace.warning('Please rename ~/.bazaar/branches.conf' |
531 |
' to ~/.bazaar/locations.conf') |
|
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
532 |
name_generator = branches_config_filename |
533 |
super(LocationConfig, self).__init__(name_generator) |
|
1878.1.1
by John Arbash Meinel
Entries in locations.conf should prefer local paths if available (bug #53653) |
534 |
# local file locations are looked up by local path, rather than
|
535 |
# by file url. This is because the config file is a user
|
|
536 |
# file, and we would rather not expose the user to file urls.
|
|
537 |
if location.startswith('file://'): |
|
538 |
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 |
539 |
self.location = location |
540 |
||
1993.3.1
by James Henstridge
first go at making location config lookup recursive |
541 |
def _get_matching_sections(self): |
542 |
"""Return an ordered list of section names matching this location."""
|
|
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
543 |
sections = self._get_parser() |
1442.1.12
by Robert Collins
LocationConfig section retrieval falls into my lap |
544 |
location_names = self.location.split('/') |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
545 |
if self.location.endswith('/'): |
546 |
del location_names[-1] |
|
1442.1.12
by Robert Collins
LocationConfig section retrieval falls into my lap |
547 |
matches=[] |
1442.1.10
by Robert Collins
explicit over glob test passes |
548 |
for section in sections: |
1878.1.1
by John Arbash Meinel
Entries in locations.conf should prefer local paths if available (bug #53653) |
549 |
# location is a local path if possible, so we need
|
550 |
# to convert 'file://' urls to local paths if necessary.
|
|
551 |
# This also avoids having file:///path be a more exact
|
|
552 |
# match than '/path'.
|
|
553 |
if section.startswith('file://'): |
|
554 |
section_path = urlutils.local_path_from_url(section) |
|
555 |
else: |
|
556 |
section_path = section |
|
557 |
section_names = section_path.split('/') |
|
1442.1.12
by Robert Collins
LocationConfig section retrieval falls into my lap |
558 |
if section.endswith('/'): |
559 |
del section_names[-1] |
|
560 |
names = zip(location_names, section_names) |
|
561 |
matched = True |
|
562 |
for name in names: |
|
563 |
if not fnmatch(name[0], name[1]): |
|
564 |
matched = False |
|
565 |
break
|
|
566 |
if not matched: |
|
567 |
continue
|
|
568 |
# so, for the common prefix they matched.
|
|
569 |
# if section is longer, no match.
|
|
570 |
if len(section_names) > len(location_names): |
|
571 |
continue
|
|
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
572 |
matches.append((len(section_names), section, |
573 |
'/'.join(location_names[len(section_names):]))) |
|
1442.1.12
by Robert Collins
LocationConfig section retrieval falls into my lap |
574 |
matches.sort(reverse=True) |
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
575 |
sections = [] |
576 |
for (length, section, extra_path) in matches: |
|
577 |
sections.append((section, extra_path)) |
|
578 |
# should we stop looking for parent configs here?
|
|
1993.3.1
by James Henstridge
first go at making location config lookup recursive |
579 |
try: |
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
580 |
if self._get_parser()[section].as_bool('ignore_parents'): |
581 |
break
|
|
1993.3.1
by James Henstridge
first go at making location config lookup recursive |
582 |
except KeyError: |
583 |
pass
|
|
1993.3.3
by James Henstridge
make _get_matching_sections() return (section, extra_path) tuples, and adjust other code to match |
584 |
return sections |
1442.1.9
by Robert Collins
exact section test passes |
585 |
|
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
586 |
def _get_option_policy(self, section, option_name): |
587 |
"""Return the policy for the given (section, option_name) pair."""
|
|
588 |
# check for the old 'recurse=False' flag
|
|
589 |
try: |
|
590 |
recurse = self._get_parser()[section].as_bool('recurse') |
|
591 |
except KeyError: |
|
592 |
recurse = True |
|
593 |
if not recurse: |
|
594 |
return POLICY_NORECURSE |
|
595 |
||
2120.6.10
by James Henstridge
Catch another deprecation warning, and more cleanup |
596 |
policy_key = option_name + ':policy' |
2120.6.8
by James Henstridge
Change syntax for setting config option policies. Rather than |
597 |
try: |
598 |
policy_name = self._get_parser()[section][policy_key] |
|
599 |
except KeyError: |
|
600 |
policy_name = None |
|
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
601 |
|
2120.6.8
by James Henstridge
Change syntax for setting config option policies. Rather than |
602 |
return _policy_value[policy_name] |
2120.6.1
by James Henstridge
add support for norecurse and appendpath policies when reading configuration files |
603 |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
604 |
def _set_option_policy(self, section, option_name, option_policy): |
605 |
"""Set the policy for the given option name in the given section."""
|
|
606 |
# The old recurse=False option affects all options in the
|
|
607 |
# section. To handle multiple policies in the section, we
|
|
608 |
# need to convert it to a policy_norecurse key.
|
|
609 |
try: |
|
610 |
recurse = self._get_parser()[section].as_bool('recurse') |
|
611 |
except KeyError: |
|
612 |
pass
|
|
613 |
else: |
|
2120.6.9
by James Henstridge
Fixes for issues brought up in John's review |
614 |
symbol_versioning.warn( |
2120.6.11
by James Henstridge
s/0.13/0.14/ in deprecation warning |
615 |
'The recurse option is deprecated as of 0.14. '
|
2120.6.9
by James Henstridge
Fixes for issues brought up in John's review |
616 |
'The section "%s" has been converted to use policies.' |
617 |
% section, |
|
618 |
DeprecationWarning) |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
619 |
del self._get_parser()[section]['recurse'] |
2120.6.9
by James Henstridge
Fixes for issues brought up in John's review |
620 |
if not recurse: |
621 |
for key in self._get_parser()[section].keys(): |
|
622 |
if not key.endswith(':policy'): |
|
623 |
self._get_parser()[section][key + |
|
624 |
':policy'] = 'norecurse' |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
625 |
|
2120.6.9
by James Henstridge
Fixes for issues brought up in John's review |
626 |
policy_key = option_name + ':policy' |
2120.6.8
by James Henstridge
Change syntax for setting config option policies. Rather than |
627 |
policy_name = _policy_name[option_policy] |
628 |
if policy_name is not None: |
|
629 |
self._get_parser()[section][policy_key] = policy_name |
|
630 |
else: |
|
631 |
if policy_key in self._get_parser()[section]: |
|
632 |
del self._get_parser()[section][policy_key] |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
633 |
|
634 |
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. |
635 |
"""Save option and its value in the configuration."""
|
3376.2.4
by Martin Pool
Remove every assert statement from bzrlib! |
636 |
if store not in [STORE_LOCATION, |
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
637 |
STORE_LOCATION_NORECURSE, |
3376.2.4
by Martin Pool
Remove every assert statement from bzrlib! |
638 |
STORE_LOCATION_APPENDPATH]: |
639 |
raise ValueError('bad storage policy %r for %r' % |
|
640 |
(store, option)) |
|
1490
by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1. |
641 |
# FIXME: RBC 20051029 This should refresh the parser and also take a
|
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
642 |
# file lock on locations.conf.
|
1185.31.39
by John Arbash Meinel
Replacing os.getcwdu() with osutils.getcwd(), |
643 |
conf_dir = os.path.dirname(self._get_filename()) |
1185.31.43
by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp |
644 |
ensure_config_dir_exists(conf_dir) |
1490
by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1. |
645 |
location = self.location |
646 |
if location.endswith('/'): |
|
647 |
location = location[:-1] |
|
648 |
if (not location in self._get_parser() and |
|
649 |
not location + '/' in self._get_parser()): |
|
650 |
self._get_parser()[location]={} |
|
651 |
elif location + '/' in self._get_parser(): |
|
652 |
location = location + '/' |
|
653 |
self._get_parser()[location][option]=value |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
654 |
# the allowed values of store match the config policies
|
655 |
self._set_option_policy(location, option, store) |
|
1551.2.49
by abentley
Made ConfigObj output binary-identical files on win32 and *nix |
656 |
self._get_parser().write(file(self._get_filename(), 'wb')) |
1490
by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1. |
657 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
658 |
|
659 |
class BranchConfig(Config): |
|
660 |
"""A configuration object giving the policy for a branch."""
|
|
661 |
||
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
662 |
def _get_branch_data_config(self): |
663 |
if self._branch_data_config is None: |
|
664 |
self._branch_data_config = TreeConfig(self.branch) |
|
665 |
return self._branch_data_config |
|
666 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
667 |
def _get_location_config(self): |
668 |
if self._location_config is None: |
|
669 |
self._location_config = LocationConfig(self.branch.base) |
|
670 |
return self._location_config |
|
671 |
||
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
672 |
def _get_global_config(self): |
673 |
if self._global_config is None: |
|
674 |
self._global_config = GlobalConfig() |
|
675 |
return self._global_config |
|
676 |
||
677 |
def _get_best_value(self, option_name): |
|
678 |
"""This returns a user option from local, tree or global config.
|
|
679 |
||
680 |
They are tried in that order. Use get_safe_value if trusted values
|
|
681 |
are necessary.
|
|
682 |
"""
|
|
683 |
for source in self.option_sources: |
|
684 |
value = getattr(source(), option_name)() |
|
685 |
if value is not None: |
|
686 |
return value |
|
687 |
return None |
|
688 |
||
689 |
def _get_safe_value(self, option_name): |
|
690 |
"""This variant of get_best_value never returns untrusted values.
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
691 |
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
692 |
It does not return values from the branch data, because the branch may
|
693 |
not be controlled by the user.
|
|
694 |
||
695 |
We may wish to allow locations.conf to control whether branches are
|
|
696 |
trusted in the future.
|
|
697 |
"""
|
|
698 |
for source in (self._get_location_config, self._get_global_config): |
|
699 |
value = getattr(source(), option_name)() |
|
700 |
if value is not None: |
|
701 |
return value |
|
702 |
return None |
|
703 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
704 |
def _get_user_id(self): |
705 |
"""Return the full user id for the branch.
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
706 |
|
3407.2.14
by Martin Pool
Remove more cases of getting transport via control_files |
707 |
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 |
708 |
This is looked up in the email controlfile for the branch.
|
709 |
"""
|
|
710 |
try: |
|
3407.2.16
by Martin Pool
Remove RemoteBranch reliance on control_files._transport |
711 |
return (self.branch._transport.get_bytes("email") |
3224.5.4
by Andrew Bennetts
Fix test suite, mainly weeding out uses of bzrlib.user_encoding. |
712 |
.decode(osutils.get_user_encoding()) |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
713 |
.rstrip("\r\n")) |
714 |
except errors.NoSuchFile, e: |
|
715 |
pass
|
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
716 |
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
717 |
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 |
718 |
|
4603.1.10
by Aaron Bentley
Provide change editor via config. |
719 |
def _get_change_editor(self): |
720 |
return self._get_best_value('_get_change_editor') |
|
721 |
||
1442.1.19
by Robert Collins
BranchConfigs inherit signature_checking policy from their LocationConfig. |
722 |
def _get_signature_checking(self): |
723 |
"""See Config._get_signature_checking."""
|
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
724 |
return self._get_best_value('_get_signature_checking') |
1442.1.19
by Robert Collins
BranchConfigs inherit signature_checking policy from their LocationConfig. |
725 |
|
1770.2.1
by Aaron Bentley
Use create_signature for signing policy, deprecate check_signatures for this |
726 |
def _get_signing_policy(self): |
727 |
"""See Config._get_signing_policy."""
|
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
728 |
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 |
729 |
|
1993.3.6
by James Henstridge
get rid of the recurse argument to get_user_option() |
730 |
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. |
731 |
"""See Config._get_user_option."""
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
732 |
for source in self.option_sources: |
1993.3.6
by James Henstridge
get rid of the recurse argument to get_user_option() |
733 |
value = source()._get_user_option(option_name) |
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
734 |
if value is not None: |
735 |
return value |
|
736 |
return None |
|
737 |
||
1551.15.35
by Aaron Bentley
Warn when setting config values that will be masked (#122286) |
738 |
def set_user_option(self, name, value, store=STORE_BRANCH, |
739 |
warn_masked=False): |
|
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
740 |
if store == STORE_BRANCH: |
1770.2.6
by Aaron Bentley
Ensure branch.conf works properly |
741 |
self._get_branch_data_config().set_option(value, name) |
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
742 |
elif store == STORE_GLOBAL: |
2120.6.7
by James Henstridge
Fix GlobalConfig.set_user_option() call |
743 |
self._get_global_config().set_user_option(name, value) |
2120.6.4
by James Henstridge
add support for specifying policy when storing options |
744 |
else: |
745 |
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) |
746 |
if not warn_masked: |
747 |
return
|
|
748 |
if store in (STORE_GLOBAL, STORE_BRANCH): |
|
749 |
mask_value = self._get_location_config().get_user_option(name) |
|
750 |
if mask_value is not None: |
|
751 |
trace.warning('Value "%s" is masked by "%s" from' |
|
752 |
' locations.conf', value, mask_value) |
|
753 |
else: |
|
754 |
if store == STORE_GLOBAL: |
|
755 |
branch_config = self._get_branch_data_config() |
|
756 |
mask_value = branch_config.get_user_option(name) |
|
757 |
if mask_value is not None: |
|
758 |
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 |
759 |
' branch.conf', value, mask_value) |
1551.15.35
by Aaron Bentley
Warn when setting config values that will be masked (#122286) |
760 |
|
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
761 |
def _gpg_signing_command(self): |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
762 |
"""See Config.gpg_signing_command."""
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
763 |
return self._get_safe_value('_gpg_signing_command') |
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
764 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
765 |
def __init__(self, branch): |
766 |
super(BranchConfig, self).__init__() |
|
767 |
self._location_config = None |
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
768 |
self._branch_data_config = None |
769 |
self._global_config = None |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
770 |
self.branch = branch |
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
771 |
self.option_sources = (self._get_location_config, |
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
772 |
self._get_branch_data_config, |
773 |
self._get_global_config) |
|
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
774 |
|
1472
by Robert Collins
post commit hook, first pass implementation |
775 |
def _post_commit(self): |
776 |
"""See Config.post_commit."""
|
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
777 |
return self._get_safe_value('_post_commit') |
1472
by Robert Collins
post commit hook, first pass implementation |
778 |
|
1770.2.7
by Aaron Bentley
Set/get nickname using BranchConfig |
779 |
def _get_nickname(self): |
1824.1.1
by Robert Collins
Add BranchConfig.has_explicit_nickname call. |
780 |
value = self._get_explicit_nickname() |
1770.2.7
by Aaron Bentley
Set/get nickname using BranchConfig |
781 |
if value is not None: |
782 |
return value |
|
2120.5.2
by Alexander Belchenko
(jam) Fix for bug #66857 |
783 |
return urlutils.unescape(self.branch.base.split('/')[-2]) |
1770.2.7
by Aaron Bentley
Set/get nickname using BranchConfig |
784 |
|
1824.1.1
by Robert Collins
Add BranchConfig.has_explicit_nickname call. |
785 |
def has_explicit_nickname(self): |
786 |
"""Return true if a nickname has been explicitly assigned."""
|
|
787 |
return self._get_explicit_nickname() is not None |
|
788 |
||
789 |
def _get_explicit_nickname(self): |
|
790 |
return self._get_best_value('_get_nickname') |
|
791 |
||
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
792 |
def _log_format(self): |
793 |
"""See Config.log_format."""
|
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
794 |
return self._get_best_value('_log_format') |
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
795 |
|
1553.6.12
by Erik Bågfors
remove AliasConfig, based on input from abentley |
796 |
|
1185.31.43
by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp |
797 |
def ensure_config_dir_exists(path=None): |
798 |
"""Make sure a configuration directory exists.
|
|
799 |
This makes sure that the directory exists.
|
|
800 |
On windows, since configuration directories are 2 levels deep,
|
|
801 |
it makes sure both the directory and the parent directory exists.
|
|
802 |
"""
|
|
803 |
if path is None: |
|
804 |
path = config_dir() |
|
805 |
if not os.path.isdir(path): |
|
806 |
if sys.platform == 'win32': |
|
807 |
parent_dir = os.path.dirname(path) |
|
808 |
if not os.path.isdir(parent_dir): |
|
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
809 |
trace.mutter('creating config parent directory: %r', parent_dir) |
1185.31.43
by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp |
810 |
os.mkdir(parent_dir) |
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
811 |
trace.mutter('creating config directory: %r', path) |
1185.31.43
by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp |
812 |
os.mkdir(path) |
813 |
||
1532
by Robert Collins
Merge in John Meinels integration branch. |
814 |
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
815 |
def config_dir(): |
816 |
"""Return per-user configuration directory.
|
|
817 |
||
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
818 |
By default this is ~/.bazaar/
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
819 |
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
820 |
TODO: Global option --config-dir to override this.
|
821 |
"""
|
|
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
822 |
base = os.environ.get('BZR_HOME', None) |
823 |
if sys.platform == 'win32': |
|
824 |
if base is None: |
|
2245.4.3
by Alexander Belchenko
config.py: changing _auto_user_id() and config_dir() to use functions from win32utils |
825 |
base = win32utils.get_appdata_location_unicode() |
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
826 |
if base is None: |
827 |
base = os.environ.get('HOME', None) |
|
828 |
if base is None: |
|
2991.2.2
by Vincent Ladeuil
No tests worth adding after upgrading to configobj-4.4.0. |
829 |
raise errors.BzrError('You must have one of BZR_HOME, APPDATA,' |
830 |
' or HOME set') |
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
831 |
return osutils.pathjoin(base, 'bazaar', '2.0') |
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
832 |
else: |
833 |
# cygwin, linux, and darwin all have a $HOME directory
|
|
834 |
if base is None: |
|
835 |
base = os.path.expanduser("~") |
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
836 |
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 \ |
837 |
|
838 |
||
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
839 |
def config_filename(): |
840 |
"""Return per-user configuration ini file filename."""
|
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
841 |
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. |
842 |
|
843 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
844 |
def branches_config_filename(): |
845 |
"""Return per-user configuration ini file filename."""
|
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
846 |
return osutils.pathjoin(config_dir(), 'branches.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. |
847 |
|
1830.2.1
by John Arbash Meinel
Make it clearer what config file needs to be renamed. |
848 |
|
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
849 |
def locations_config_filename(): |
850 |
"""Return per-user configuration ini file filename."""
|
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
851 |
return osutils.pathjoin(config_dir(), 'locations.conf') |
1770.2.2
by Aaron Bentley
Rename branches.conf to locations.conf |
852 |
|
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
853 |
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
854 |
def authentication_config_filename(): |
855 |
"""Return per-user authentication ini file filename."""
|
|
856 |
return osutils.pathjoin(config_dir(), 'authentication.conf') |
|
857 |
||
858 |
||
1836.1.6
by John Arbash Meinel
Creating a helper function for getting the user ignore filename |
859 |
def user_ignore_config_filename(): |
860 |
"""Return the user default ignore filename"""
|
|
1996.3.31
by John Arbash Meinel
Make bzrlib.config use lazy importing |
861 |
return osutils.pathjoin(config_dir(), 'ignore') |
1836.1.6
by John Arbash Meinel
Creating a helper function for getting the user ignore filename |
862 |
|
863 |
||
4584.3.4
by Martin Pool
Add crash_dir and xdg_cache_dir functions |
864 |
def crash_dir(): |
865 |
"""Return the directory name to store crash files.
|
|
866 |
||
867 |
This doesn't implicitly create it.
|
|
868 |
||
869 |
On Windows it's in the config directory; elsewhere in the XDG cache directory.
|
|
870 |
"""
|
|
871 |
if sys.platform == 'win32': |
|
872 |
return osutils.pathjoin(config_dir(), 'Crash') |
|
873 |
else: |
|
874 |
return osutils.pathjoin(xdg_cache_dir(), 'crash') |
|
875 |
||
876 |
||
877 |
def xdg_cache_dir(): |
|
4584.3.23
by Martin Pool
Correction to xdg_cache_dir and add a simple test |
878 |
# See http://standards.freedesktop.org/basedir-spec/latest/ar01s03.html
|
879 |
# Possibly this should be different on Windows?
|
|
880 |
e = os.environ.get('XDG_CACHE_DIR', None) |
|
881 |
if e: |
|
882 |
return e |
|
883 |
else: |
|
884 |
return os.path.expanduser('~/.cache') |
|
4584.3.4
by Martin Pool
Add crash_dir and xdg_cache_dir functions |
885 |
|
886 |
||
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
887 |
def _auto_user_id(): |
888 |
"""Calculate automatic user identification.
|
|
889 |
||
890 |
Returns (realname, email).
|
|
891 |
||
892 |
Only used when none is set in the environment or the id file.
|
|
893 |
||
894 |
This previously used the FQDN as the default domain, but that can
|
|
895 |
be very slow on machines where DNS is broken. So now we simply
|
|
896 |
use the hostname.
|
|
897 |
"""
|
|
898 |
import socket |
|
899 |
||
2245.4.3
by Alexander Belchenko
config.py: changing _auto_user_id() and config_dir() to use functions from win32utils |
900 |
if sys.platform == 'win32': |
901 |
name = win32utils.get_user_name_unicode() |
|
902 |
if name is None: |
|
903 |
raise errors.BzrError("Cannot autodetect user name.\n" |
|
904 |
"Please, set your name with command like:\n" |
|
905 |
'bzr whoami "Your Name <name@domain.com>"') |
|
906 |
host = win32utils.get_host_name_unicode() |
|
907 |
if host is None: |
|
908 |
host = socket.gethostname() |
|
909 |
return name, (name + '@' + host) |
|
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
910 |
|
911 |
try: |
|
912 |
import pwd |
|
913 |
uid = os.getuid() |
|
3849.1.1
by Andrew Bennetts
Catch exceptions from pwd and raise a better error |
914 |
try: |
915 |
w = pwd.getpwuid(uid) |
|
916 |
except KeyError: |
|
917 |
raise errors.BzrCommandError('Unable to determine your name. ' |
|
918 |
'Please use "bzr whoami" to set it.') |
|
1553.4.5
by Michael Ellerman
Produce an intelligible error if the user's /etc/passwd is not encoded in |
919 |
|
1816.2.1
by Robey Pointer
add set_user_option to GlobalConfig, and make /etc/passwd username lookup try harder with encodings |
920 |
# we try utf-8 first, because on many variants (like Linux),
|
921 |
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
|
|
922 |
# false positives. (many users will have their user encoding set to
|
|
923 |
# latin-1, which cannot raise UnicodeError.)
|
|
924 |
try: |
|
925 |
gecos = w.pw_gecos.decode('utf-8') |
|
926 |
encoding = 'utf-8' |
|
927 |
except UnicodeError: |
|
928 |
try: |
|
3224.5.4
by Andrew Bennetts
Fix test suite, mainly weeding out uses of bzrlib.user_encoding. |
929 |
encoding = osutils.get_user_encoding() |
930 |
gecos = w.pw_gecos.decode(encoding) |
|
1816.2.1
by Robey Pointer
add set_user_option to GlobalConfig, and make /etc/passwd username lookup try harder with encodings |
931 |
except UnicodeError: |
932 |
raise errors.BzrCommandError('Unable to determine your name. ' |
|
933 |
'Use "bzr whoami" to set it.') |
|
934 |
try: |
|
935 |
username = w.pw_name.decode(encoding) |
|
936 |
except UnicodeError: |
|
937 |
raise errors.BzrCommandError('Unable to determine your name. ' |
|
938 |
'Use "bzr whoami" to set it.') |
|
1553.4.5
by Michael Ellerman
Produce an intelligible error if the user's /etc/passwd is not encoded in |
939 |
|
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
940 |
comma = gecos.find(',') |
941 |
if comma == -1: |
|
942 |
realname = gecos |
|
943 |
else: |
|
944 |
realname = gecos[:comma] |
|
945 |
if not realname: |
|
946 |
realname = username |
|
947 |
||
948 |
except ImportError: |
|
949 |
import getpass |
|
1553.4.5
by Michael Ellerman
Produce an intelligible error if the user's /etc/passwd is not encoded in |
950 |
try: |
3224.5.4
by Andrew Bennetts
Fix test suite, mainly weeding out uses of bzrlib.user_encoding. |
951 |
user_encoding = osutils.get_user_encoding() |
952 |
realname = username = getpass.getuser().decode(user_encoding) |
|
1553.4.5
by Michael Ellerman
Produce an intelligible error if the user's /etc/passwd is not encoded in |
953 |
except UnicodeDecodeError: |
954 |
raise errors.BzrError("Can't decode username as %s." % \ |
|
3224.5.4
by Andrew Bennetts
Fix test suite, mainly weeding out uses of bzrlib.user_encoding. |
955 |
user_encoding) |
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
956 |
|
957 |
return realname, (username + '@' + socket.gethostname()) |
|
958 |
||
959 |
||
3063.3.2
by Lukáš Lalinský
Move the name and e-mail address extraction logic to config.parse_username. |
960 |
def parse_username(username): |
961 |
"""Parse e-mail username and return a (name, address) tuple."""
|
|
962 |
match = re.match(r'(.*?)\s*<?([\w+.-]+@[\w+.-]+)>?', username) |
|
963 |
if match is None: |
|
964 |
return (username, '') |
|
965 |
else: |
|
966 |
return (match.group(1), match.group(2)) |
|
967 |
||
968 |
||
1185.16.52
by Martin Pool
- add extract_email_address |
969 |
def extract_email_address(e): |
970 |
"""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. |
971 |
|
3943.8.1
by Marius Kruger
remove all trailing whitespace from bzr source |
972 |
That is just the user@domain part, nothing else.
|
1185.16.52
by Martin Pool
- add extract_email_address |
973 |
This part is required to contain only ascii characters.
|
974 |
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. |
975 |
|
1185.16.52
by Martin Pool
- add extract_email_address |
976 |
>>> extract_email_address('Jane Tester <jane@test.com>')
|
977 |
"jane@test.com"
|
|
978 |
"""
|
|
3063.3.2
by Lukáš Lalinský
Move the name and e-mail address extraction logic to config.parse_username. |
979 |
name, email = parse_username(e) |
980 |
if not email: |
|
2055.2.2
by John Arbash Meinel
Switch extract_email_address() to use a more specific exception |
981 |
raise errors.NoEmailInUsername(e) |
3063.3.2
by Lukáš Lalinský
Move the name and e-mail address extraction logic to config.parse_username. |
982 |
return email |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
983 |
|
1185.85.30
by John Arbash Meinel
Fixing 'bzr push' exposed that IniBasedConfig didn't handle unicode. |
984 |
|
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
985 |
class TreeConfig(IniBasedConfig): |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
986 |
"""Branch configuration data associated with its contents, not location"""
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
987 |
|
3408.3.1
by Martin Pool
Remove erroneous handling of branch.conf for RemoteBranch |
988 |
# XXX: Really needs a better name, as this is not part of the tree! -- mbp 20080507
|
989 |
||
1185.35.11
by Aaron Bentley
Added support for branch nicks |
990 |
def __init__(self, branch): |
4226.1.5
by Robert Collins
Reinstate the use of the Branch.get_config_file verb. |
991 |
self._config = branch._get_config() |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
992 |
self.branch = branch |
993 |
||
1770.2.5
by Aaron Bentley
Integrate branch.conf into BranchConfig |
994 |
def _get_parser(self, file=None): |
995 |
if file is not None: |
|
996 |
return IniBasedConfig._get_parser(file) |
|
3242.1.2
by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication |
997 |
return self._config._get_configobj() |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
998 |
|
999 |
def get_option(self, name, section=None, default=None): |
|
1000 |
self.branch.lock_read() |
|
1001 |
try: |
|
3242.1.2
by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication |
1002 |
return self._config.get_option(name, section, default) |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
1003 |
finally: |
1004 |
self.branch.unlock() |
|
1005 |
||
1006 |
def set_option(self, value, name, section=None): |
|
1007 |
"""Set a per-branch configuration option"""
|
|
1008 |
self.branch.lock_write() |
|
1009 |
try: |
|
3242.1.2
by Aaron Bentley
Turn BzrDirConfig into TransportConfig, reduce code duplication |
1010 |
self._config.set_option(value, name, section) |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
1011 |
finally: |
1012 |
self.branch.unlock() |
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1013 |
|
1014 |
||
1015 |
class AuthenticationConfig(object): |
|
1016 |
"""The authentication configuration file based on a ini file.
|
|
1017 |
||
1018 |
Implements the authentication.conf file described in
|
|
1019 |
doc/developers/authentication-ring.txt.
|
|
1020 |
"""
|
|
1021 |
||
1022 |
def __init__(self, _file=None): |
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1023 |
self._config = None # The ConfigObj |
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1024 |
if _file is None: |
2900.2.24
by Vincent Ladeuil
Review feedback. |
1025 |
self._filename = authentication_config_filename() |
1026 |
self._input = self._filename = authentication_config_filename() |
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1027 |
else: |
2900.2.24
by Vincent Ladeuil
Review feedback. |
1028 |
# Tests can provide a string as _file
|
1029 |
self._filename = None |
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1030 |
self._input = _file |
1031 |
||
1032 |
def _get_config(self): |
|
1033 |
if self._config is not None: |
|
1034 |
return self._config |
|
1035 |
try: |
|
2900.2.22
by Vincent Ladeuil
Polishing. |
1036 |
# FIXME: Should we validate something here ? Includes: empty
|
1037 |
# sections are useless, at least one of
|
|
1038 |
# user/password/password_encoding should be defined, etc.
|
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1039 |
|
1040 |
# Note: the encoding below declares that the file itself is utf-8
|
|
1041 |
# encoded, but the values in the ConfigObj are always Unicode.
|
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1042 |
self._config = ConfigObj(self._input, encoding='utf-8') |
1043 |
except configobj.ConfigObjError, e: |
|
1044 |
raise errors.ParseConfigError(e.errors, e.config.filename) |
|
1045 |
return self._config |
|
1046 |
||
2900.2.5
by Vincent Ladeuil
ake ftp aware of authentication config. |
1047 |
def _save(self): |
1048 |
"""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. |
1049 |
conf_dir = os.path.dirname(self._filename) |
2900.2.5
by Vincent Ladeuil
ake ftp aware of authentication config. |
1050 |
ensure_config_dir_exists(conf_dir) |
2900.2.26
by Vincent Ladeuil
Fix forgotten reference to _get_filename and duplicated code. |
1051 |
self._get_config().write(file(self._filename, 'wb')) |
2900.2.5
by Vincent Ladeuil
ake ftp aware of authentication config. |
1052 |
|
1053 |
def _set_option(self, section_name, option_name, value): |
|
1054 |
"""Set an authentication configuration option"""
|
|
1055 |
conf = self._get_config() |
|
1056 |
section = conf.get(section_name) |
|
1057 |
if section is None: |
|
1058 |
conf[section] = {} |
|
1059 |
section = conf[section] |
|
1060 |
section[option_name] = value |
|
1061 |
self._save() |
|
1062 |
||
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1063 |
def get_credentials(self, scheme, host, port=None, user=None, path=None, |
1064 |
realm=None): |
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1065 |
"""Returns the matching credentials from authentication.conf file.
|
1066 |
||
1067 |
:param scheme: protocol
|
|
1068 |
||
1069 |
:param host: the server address
|
|
1070 |
||
1071 |
:param port: the associated port (optional)
|
|
1072 |
||
1073 |
:param user: login (optional)
|
|
1074 |
||
1075 |
: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 |
1076 |
|
1077 |
:param realm: the http authentication realm (optional)
|
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1078 |
|
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1079 |
:return: A dict containing the matching credentials or None.
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1080 |
This includes:
|
1081 |
- name: the section name of the credentials in the
|
|
1082 |
authentication.conf file,
|
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1083 |
- 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. |
1084 |
- scheme: the server protocol,
|
1085 |
- host: the server address,
|
|
1086 |
- port: the server port (can be None),
|
|
1087 |
- path: the absolute server path (can be None),
|
|
1088 |
- realm: the http specific authentication realm (can be None),
|
|
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1089 |
- password: the decoded password, could be None if the credential
|
1090 |
defines only the user
|
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1091 |
- verify_certificates: https specific, True if the server
|
1092 |
certificate should be verified, False otherwise.
|
|
1093 |
"""
|
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1094 |
credentials = None |
1095 |
for auth_def_name, auth_def in self._get_config().items(): |
|
3418.2.1
by Vincent Ladeuil
Fix #217650 by catching declarations outside sections. |
1096 |
if type(auth_def) is not configobj.Section: |
1097 |
raise ValueError("%s defined outside a section" % auth_def_name) |
|
1098 |
||
2900.2.5
by Vincent Ladeuil
ake ftp aware of authentication config. |
1099 |
a_scheme, a_host, a_user, a_path = map( |
1100 |
auth_def.get, ['scheme', 'host', 'user', 'path']) |
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1101 |
|
2900.2.5
by Vincent Ladeuil
ake ftp aware of authentication config. |
1102 |
try: |
1103 |
a_port = auth_def.as_int('port') |
|
1104 |
except KeyError: |
|
1105 |
a_port = None |
|
2900.2.22
by Vincent Ladeuil
Polishing. |
1106 |
except ValueError: |
1107 |
raise ValueError("'port' not numeric in %s" % auth_def_name) |
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1108 |
try: |
1109 |
a_verify_certificates = auth_def.as_bool('verify_certificates') |
|
1110 |
except KeyError: |
|
1111 |
a_verify_certificates = True |
|
2900.2.22
by Vincent Ladeuil
Polishing. |
1112 |
except ValueError: |
1113 |
raise ValueError( |
|
1114 |
"'verify_certificates' not boolean in %s" % auth_def_name) |
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1115 |
|
1116 |
# Attempt matching
|
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1117 |
if a_scheme is not None and scheme != a_scheme: |
1118 |
continue
|
|
1119 |
if a_host is not None: |
|
1120 |
if not (host == a_host |
|
1121 |
or (a_host.startswith('.') and host.endswith(a_host))): |
|
1122 |
continue
|
|
2900.2.4
by Vincent Ladeuil
Cosmetic changes. |
1123 |
if a_port is not None and port != a_port: |
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1124 |
continue
|
1125 |
if (a_path is not None and path is not None |
|
1126 |
and not path.startswith(a_path)): |
|
1127 |
continue
|
|
1128 |
if (a_user is not None and user is not None |
|
1129 |
and a_user != user): |
|
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
1130 |
# Never contradict the caller about the user to be used
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1131 |
continue
|
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1132 |
if a_user is None: |
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1133 |
# Can't find a user
|
1134 |
continue
|
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1135 |
# Prepare a credentials dictionary with additional keys
|
1136 |
# for the credential providers
|
|
2900.2.24
by Vincent Ladeuil
Review feedback. |
1137 |
credentials = dict(name=auth_def_name, |
3418.4.2
by Vincent Ladeuil
Fix bug #199440 by taking into account that a section may not |
1138 |
user=a_user, |
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1139 |
scheme=a_scheme, |
1140 |
host=host, |
|
1141 |
port=port, |
|
1142 |
path=path, |
|
1143 |
realm=realm, |
|
3418.4.2
by Vincent Ladeuil
Fix bug #199440 by taking into account that a section may not |
1144 |
password=auth_def.get('password', None), |
2900.2.24
by Vincent Ladeuil
Review feedback. |
1145 |
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 |
1146 |
# Decode the password in the credentials (or get one)
|
2900.2.22
by Vincent Ladeuil
Polishing. |
1147 |
self.decode_password(credentials, |
1148 |
auth_def.get('password_encoding', None)) |
|
2900.2.10
by Vincent Ladeuil
Add -Dauth handling. |
1149 |
if 'auth' in debug.debug_flags: |
1150 |
trace.mutter("Using authentication section: %r", auth_def_name) |
|
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1151 |
break
|
1152 |
||
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1153 |
if credentials is None: |
1154 |
# No credentials were found in authentication.conf, try the fallback
|
|
1155 |
# credentials stores.
|
|
1156 |
credentials = credential_store_registry.get_fallback_credentials( |
|
1157 |
scheme, host, port, user, path, realm) |
|
1158 |
||
2900.2.3
by Vincent Ladeuil
Credentials matching implementation. |
1159 |
return credentials |
1160 |
||
3777.3.2
by Aaron Bentley
Reverse order of scheme and password |
1161 |
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 |
1162 |
port=None, path=None, verify_certificates=None, |
1163 |
realm=None): |
|
3777.3.1
by Aaron Bentley
Update docs |
1164 |
"""Set authentication credentials for a host.
|
1165 |
||
1166 |
Any existing credentials with matching scheme, host, port and path
|
|
1167 |
will be deleted, regardless of name.
|
|
1168 |
||
1169 |
:param name: An arbitrary name to describe this set of credentials.
|
|
1170 |
:param host: Name of the host that accepts these credentials.
|
|
1171 |
:param user: The username portion of these credentials.
|
|
1172 |
:param scheme: The URL scheme (e.g. ssh, http) the credentials apply
|
|
1173 |
to.
|
|
3777.3.2
by Aaron Bentley
Reverse order of scheme and password |
1174 |
:param password: Password portion of these credentials.
|
3777.3.1
by Aaron Bentley
Update docs |
1175 |
:param port: The IP port on the host that these credentials apply to.
|
1176 |
:param path: A filesystem path on the host that these credentials
|
|
1177 |
apply to.
|
|
1178 |
:param verify_certificates: On https, verify server certificates if
|
|
1179 |
True.
|
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1180 |
:param realm: The http authentication realm (optional).
|
3777.3.1
by Aaron Bentley
Update docs |
1181 |
"""
|
3777.1.8
by Aaron Bentley
Commit work-in-progress |
1182 |
values = {'host': host, 'user': user} |
1183 |
if password is not None: |
|
1184 |
values['password'] = password |
|
1185 |
if scheme is not None: |
|
1186 |
values['scheme'] = scheme |
|
1187 |
if port is not None: |
|
1188 |
values['port'] = '%d' % port |
|
1189 |
if path is not None: |
|
1190 |
values['path'] = path |
|
3777.1.10
by Aaron Bentley
Ensure credentials are stored |
1191 |
if verify_certificates is not None: |
1192 |
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 |
1193 |
if realm is not None: |
1194 |
values['realm'] = realm |
|
3777.1.11
by Aaron Bentley
Ensure changed-name updates clear old values |
1195 |
config = self._get_config() |
1196 |
for_deletion = [] |
|
1197 |
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 |
1198 |
for key in ('scheme', 'host', 'port', 'path', 'realm'): |
3777.1.11
by Aaron Bentley
Ensure changed-name updates clear old values |
1199 |
if existing_values.get(key) != values.get(key): |
1200 |
break
|
|
1201 |
else: |
|
1202 |
del config[section] |
|
1203 |
config.update({name: values}) |
|
3777.1.10
by Aaron Bentley
Ensure credentials are stored |
1204 |
self._save() |
3777.1.8
by Aaron Bentley
Commit work-in-progress |
1205 |
|
4304.2.1
by Vincent Ladeuil
Fix bug #367726 by reverting some default user handling introduced |
1206 |
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. |
1207 |
prompt=None, ask=False, default=None): |
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1208 |
"""Get a user from authentication file.
|
1209 |
||
1210 |
:param scheme: protocol
|
|
1211 |
||
1212 |
:param host: the server address
|
|
1213 |
||
1214 |
:param port: the associated port (optional)
|
|
1215 |
||
1216 |
:param realm: the realm sent by the server (optional)
|
|
1217 |
||
1218 |
:param path: the absolute path on the server (optional)
|
|
1219 |
||
4222.3.4
by Jelmer Vernooij
Default to getpass.getuser() in AuthenticationConfig.get_user(), but allow |
1220 |
:param ask: Ask the user if there is no explicitly configured username
|
1221 |
(optional)
|
|
1222 |
||
4304.2.1
by Vincent Ladeuil
Fix bug #367726 by reverting some default user handling introduced |
1223 |
:param default: The username returned if none is defined (optional).
|
1224 |
||
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1225 |
:return: The found user.
|
1226 |
"""
|
|
2900.2.16
by Vincent Ladeuil
Make hhtp proxy aware of AuthenticationConfig (for password). |
1227 |
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 |
1228 |
path=path, realm=realm) |
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1229 |
if credentials is not None: |
1230 |
user = credentials['user'] |
|
1231 |
else: |
|
1232 |
user = None |
|
4222.3.2
by Jelmer Vernooij
Prompt for user names if they are not in the configuration. |
1233 |
if user is None: |
4222.3.4
by Jelmer Vernooij
Default to getpass.getuser() in AuthenticationConfig.get_user(), but allow |
1234 |
if ask: |
1235 |
if prompt is None: |
|
1236 |
# Create a default prompt suitable for most cases
|
|
1237 |
prompt = scheme.upper() + ' %(host)s username' |
|
1238 |
# Special handling for optional fields in the prompt
|
|
1239 |
if port is not None: |
|
1240 |
prompt_host = '%s:%d' % (host, port) |
|
1241 |
else: |
|
1242 |
prompt_host = host |
|
1243 |
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. |
1244 |
else: |
4222.3.10
by Jelmer Vernooij
Avoid using the default username in the case of SMTP. |
1245 |
user = default |
2900.2.15
by Vincent Ladeuil
AuthenticationConfig can be queried for logins too (first step). |
1246 |
return user |
1247 |
||
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
1248 |
def get_password(self, scheme, host, user, port=None, |
1249 |
realm=None, path=None, prompt=None): |
|
1250 |
"""Get a password from authentication file or prompt the user for one.
|
|
1251 |
||
1252 |
:param scheme: protocol
|
|
1253 |
||
1254 |
:param host: the server address
|
|
1255 |
||
1256 |
:param port: the associated port (optional)
|
|
1257 |
||
1258 |
:param user: login
|
|
1259 |
||
1260 |
:param realm: the realm sent by the server (optional)
|
|
1261 |
||
1262 |
:param path: the absolute path on the server (optional)
|
|
1263 |
||
1264 |
:return: The found password or the one entered by the user.
|
|
1265 |
"""
|
|
4081.1.1
by Jean-Francois Roy
A 'realm' optional argument was added to the get_credentials and set_credentials |
1266 |
credentials = self.get_credentials(scheme, host, port, user, path, |
1267 |
realm) |
|
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
1268 |
if credentials is not None: |
1269 |
password = credentials['password'] |
|
3420.1.3
by Vincent Ladeuil
John's review feedback. |
1270 |
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. |
1271 |
trace.warning('password ignored in section [%s],' |
1272 |
' use an ssh agent instead'
|
|
1273 |
% credentials['name']) |
|
1274 |
password = None |
|
2900.2.16
by Vincent Ladeuil
Make hhtp proxy aware of AuthenticationConfig (for password). |
1275 |
else: |
1276 |
password = None |
|
2900.2.19
by Vincent Ladeuil
Mention proxy and https in the password prompts, with tests. |
1277 |
# 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). |
1278 |
if password is None: |
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
1279 |
if prompt is None: |
3420.1.2
by Vincent Ladeuil
Fix bug #203186 by ignoring passwords for ssh and warning user. |
1280 |
# Create a default prompt suitable for most cases
|
2900.2.19
by Vincent Ladeuil
Mention proxy and https in the password prompts, with tests. |
1281 |
prompt = '%s' % scheme.upper() + ' %(user)s@%(host)s password' |
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
1282 |
# Special handling for optional fields in the prompt
|
1283 |
if port is not None: |
|
1284 |
prompt_host = '%s:%d' % (host, port) |
|
1285 |
else: |
|
1286 |
prompt_host = host |
|
2900.2.19
by Vincent Ladeuil
Mention proxy and https in the password prompts, with tests. |
1287 |
password = ui.ui_factory.get_password(prompt, |
1288 |
host=prompt_host, user=user) |
|
2900.2.12
by Vincent Ladeuil
Since all schemes query AuthenticationConfig then prompt user, make that |
1289 |
return password |
1290 |
||
2900.2.22
by Vincent Ladeuil
Polishing. |
1291 |
def decode_password(self, credentials, encoding): |
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
1292 |
try: |
1293 |
cs = credential_store_registry.get_credential_store(encoding) |
|
1294 |
except KeyError: |
|
1295 |
raise ValueError('%r is not a known password_encoding' % encoding) |
|
1296 |
credentials['password'] = cs.decode_password(credentials) |
|
2900.2.22
by Vincent Ladeuil
Polishing. |
1297 |
return credentials |
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
1298 |
|
3242.3.17
by Aaron Bentley
Whitespace cleanup |
1299 |
|
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
1300 |
class CredentialStoreRegistry(registry.Registry): |
1301 |
"""A class that registers credential stores.
|
|
1302 |
||
1303 |
A credential store provides access to credentials via the password_encoding
|
|
1304 |
field in authentication.conf sections.
|
|
1305 |
||
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1306 |
Except for stores provided by bzr itself, most stores are expected to be
|
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
1307 |
provided by plugins that will therefore use
|
1308 |
register_lazy(password_encoding, module_name, member_name, help=help,
|
|
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1309 |
fallback=fallback) to install themselves.
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1310 |
|
1311 |
A fallback credential store is one that is queried if no credentials can be
|
|
1312 |
found via authentication.conf.
|
|
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
1313 |
"""
|
1314 |
||
1315 |
def get_credential_store(self, encoding=None): |
|
1316 |
cs = self.get(encoding) |
|
1317 |
if callable(cs): |
|
1318 |
cs = cs() |
|
1319 |
return cs |
|
1320 |
||
4283.1.2
by Jelmer Vernooij
Add tests, NEWS item. |
1321 |
def is_fallback(self, name): |
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1322 |
"""Check if the named credentials store should be used as fallback."""
|
4283.1.2
by Jelmer Vernooij
Add tests, NEWS item. |
1323 |
return self.get_info(name) |
1324 |
||
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1325 |
def get_fallback_credentials(self, scheme, host, port=None, user=None, |
4283.1.2
by Jelmer Vernooij
Add tests, NEWS item. |
1326 |
path=None, realm=None): |
1327 |
"""Request credentials from all fallback credentials stores.
|
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1328 |
|
1329 |
The first credentials store that can provide credentials wins.
|
|
4283.1.2
by Jelmer Vernooij
Add tests, NEWS item. |
1330 |
"""
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1331 |
credentials = None |
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1332 |
for name in self.keys(): |
4283.1.2
by Jelmer Vernooij
Add tests, NEWS item. |
1333 |
if not self.is_fallback(name): |
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1334 |
continue
|
1335 |
cs = self.get_credential_store(name) |
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1336 |
credentials = cs.get_credentials(scheme, host, port, user, |
1337 |
path, realm) |
|
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1338 |
if credentials is not None: |
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1339 |
# We found some credentials
|
1340 |
break
|
|
1341 |
return credentials |
|
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1342 |
|
1343 |
def register(self, key, obj, help=None, override_existing=False, |
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1344 |
fallback=False): |
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1345 |
"""Register a new object to a name.
|
1346 |
||
1347 |
:param key: This is the key to use to request the object later.
|
|
1348 |
:param obj: The object to register.
|
|
1349 |
:param help: Help text for this entry. This may be a string or
|
|
1350 |
a callable. If it is a callable, it should take two
|
|
1351 |
parameters (registry, key): this registry and the key that
|
|
1352 |
the help was registered under.
|
|
1353 |
:param override_existing: Raise KeyErorr if False and something has
|
|
1354 |
already been registered for that key. If True, ignore if there
|
|
1355 |
is an existing key (always register the new value).
|
|
1356 |
:param fallback: Whether this credential store should be
|
|
1357 |
used as fallback.
|
|
1358 |
"""
|
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1359 |
return super(CredentialStoreRegistry, |
1360 |
self).register(key, obj, help, info=fallback, |
|
1361 |
override_existing=override_existing) |
|
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1362 |
|
1363 |
def register_lazy(self, key, module_name, member_name, |
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1364 |
help=None, override_existing=False, |
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1365 |
fallback=False): |
1366 |
"""Register a new credential store to be loaded on request.
|
|
1367 |
||
1368 |
:param module_name: The python path to the module. Such as 'os.path'.
|
|
1369 |
:param member_name: The member of the module to return. If empty or
|
|
1370 |
None, get() will return the module itself.
|
|
1371 |
:param help: Help text for this entry. This may be a string or
|
|
1372 |
a callable.
|
|
1373 |
:param override_existing: If True, replace the existing object
|
|
1374 |
with the new one. If False, if there is already something
|
|
1375 |
registered with the same key, raise a KeyError
|
|
1376 |
:param fallback: Whether this credential store should be
|
|
1377 |
used as fallback.
|
|
1378 |
"""
|
|
1379 |
return super(CredentialStoreRegistry, self).register_lazy( |
|
1380 |
key, module_name, member_name, help, |
|
1381 |
info=fallback, override_existing=override_existing) |
|
1382 |
||
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
1383 |
|
1384 |
credential_store_registry = CredentialStoreRegistry() |
|
1385 |
||
1386 |
||
1387 |
class CredentialStore(object): |
|
1388 |
"""An abstract class to implement storage for credentials"""
|
|
1389 |
||
1390 |
def decode_password(self, credentials): |
|
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1391 |
"""Returns a clear text password for the provided credentials."""
|
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
1392 |
raise NotImplementedError(self.decode_password) |
1393 |
||
4283.2.1
by Vincent Ladeuil
Add a test and cleanup some PEP8 issues. |
1394 |
def get_credentials(self, scheme, host, port=None, user=None, path=None, |
4283.1.1
by Jelmer Vernooij
Support fallback credential stores. |
1395 |
realm=None): |
1396 |
"""Return the matching credentials from this credential store.
|
|
1397 |
||
1398 |
This method is only called on fallback credential stores.
|
|
1399 |
"""
|
|
1400 |
raise NotImplementedError(self.get_credentials) |
|
1401 |
||
1402 |
||
3757.3.1
by Vincent Ladeuil
Add credential stores plugging. |
1403 |
|
1404 |
class PlainTextCredentialStore(CredentialStore): |
|
1405 |
"""Plain text credential store for the authentication.conf file."""
|
|
1406 |
||
1407 |
def decode_password(self, credentials): |
|
1408 |
"""See CredentialStore.decode_password."""
|
|
1409 |
return credentials['password'] |
|
1410 |
||
1411 |
||
1412 |
credential_store_registry.register('plain', PlainTextCredentialStore, |
|
1413 |
help=PlainTextCredentialStore.__doc__) |
|
1414 |
credential_store_registry.default_key = 'plain' |
|
1415 |
||
1416 |
||
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
1417 |
class BzrDirConfig(object): |
1418 |
||
4288.1.1
by Robert Collins
Add support for a RemoteBzrDirConfig to support optimising push operations which need to look for default stacking locations. |
1419 |
def __init__(self, bzrdir): |
1420 |
self._bzrdir = bzrdir |
|
1421 |
self._config = bzrdir._get_config() |
|
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
1422 |
|
3242.3.11
by Aaron Bentley
Clean up BzrDirConfig usage |
1423 |
def set_default_stack_on(self, value): |
1424 |
"""Set the default stacking location.
|
|
1425 |
||
1426 |
It may be set to a location, or None.
|
|
1427 |
||
1428 |
This policy affects all branches contained by this bzrdir, except for
|
|
1429 |
those under repositories.
|
|
1430 |
"""
|
|
4288.1.1
by Robert Collins
Add support for a RemoteBzrDirConfig to support optimising push operations which need to look for default stacking locations. |
1431 |
if self._config is None: |
1432 |
raise errors.BzrError("Cannot set configuration in %s" % self._bzrdir) |
|
3242.3.11
by Aaron Bentley
Clean up BzrDirConfig usage |
1433 |
if value is None: |
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
1434 |
self._config.set_option('', 'default_stack_on') |
3242.3.11
by Aaron Bentley
Clean up BzrDirConfig usage |
1435 |
else: |
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
1436 |
self._config.set_option(value, 'default_stack_on') |
3242.3.11
by Aaron Bentley
Clean up BzrDirConfig usage |
1437 |
|
1438 |
def get_default_stack_on(self): |
|
1439 |
"""Return the default stacking location.
|
|
1440 |
||
1441 |
This will either be a location, or None.
|
|
1442 |
||
1443 |
This policy affects all branches contained by this bzrdir, except for
|
|
1444 |
those under repositories.
|
|
1445 |
"""
|
|
4288.1.1
by Robert Collins
Add support for a RemoteBzrDirConfig to support optimising push operations which need to look for default stacking locations. |
1446 |
if self._config is None: |
1447 |
return None |
|
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
1448 |
value = self._config.get_option('default_stack_on') |
3242.3.11
by Aaron Bentley
Clean up BzrDirConfig usage |
1449 |
if value == '': |
1450 |
value = None |
|
1451 |
return value |
|
1452 |
||
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
1453 |
|
1454 |
class TransportConfig(object): |
|
3242.1.5
by Aaron Bentley
Update per review comments |
1455 |
"""A Config that reads/writes a config file on a Transport.
|
3242.1.4
by Aaron Bentley
Clean-up |
1456 |
|
1457 |
It is a low-level object that considers config data to be name/value pairs
|
|
1458 |
that may be associated with a section. Assigning meaning to the these
|
|
1459 |
values is done at higher levels like TreeConfig.
|
|
1460 |
"""
|
|
3242.3.14
by Aaron Bentley
Make BzrDirConfig use TransportConfig |
1461 |
|
1462 |
def __init__(self, transport, filename): |
|
1463 |
self._transport = transport |
|
1464 |
self._filename = filename |
|
1465 |
||
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
1466 |
def get_option(self, name, section=None, default=None): |
1467 |
"""Return the value associated with a named option.
|
|
1468 |
||
1469 |
:param name: The name of the value
|
|
1470 |
:param section: The section the option is in (if any)
|
|
1471 |
:param default: The value to return if the value is not set
|
|
1472 |
:return: The value or default value
|
|
1473 |
"""
|
|
1474 |
configobj = self._get_configobj() |
|
1475 |
if section is None: |
|
1476 |
section_obj = configobj |
|
1477 |
else: |
|
1478 |
try: |
|
1479 |
section_obj = configobj[section] |
|
1480 |
except KeyError: |
|
1481 |
return default |
|
1482 |
return section_obj.get(name, default) |
|
1483 |
||
1484 |
def set_option(self, value, name, section=None): |
|
1485 |
"""Set the value associated with a named option.
|
|
1486 |
||
1487 |
:param value: The value to set
|
|
1488 |
:param name: The name of the value to set
|
|
1489 |
:param section: The section the option is in (if any)
|
|
1490 |
"""
|
|
1491 |
configobj = self._get_configobj() |
|
1492 |
if section is None: |
|
1493 |
configobj[name] = value |
|
1494 |
else: |
|
1495 |
configobj.setdefault(section, {})[name] = value |
|
1496 |
self._set_configobj(configobj) |
|
1497 |
||
4288.1.2
by Robert Collins
Create a server verb for doing BzrDir.get_config() |
1498 |
def _get_config_file(self): |
1499 |
try: |
|
4852.1.10
by John Arbash Meinel
Use a StringIO instead, otherwise we get failures with smart server requests. |
1500 |
return StringIO(self._transport.get_bytes(self._filename)) |
4288.1.2
by Robert Collins
Create a server verb for doing BzrDir.get_config() |
1501 |
except errors.NoSuchFile: |
1502 |
return StringIO() |
|
1503 |
||
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
1504 |
def _get_configobj(self): |
4288.1.2
by Robert Collins
Create a server verb for doing BzrDir.get_config() |
1505 |
return ConfigObj(self._get_config_file(), encoding='utf-8') |
3242.1.1
by Aaron Bentley
Implement BzrDir configuration |
1506 |
|
1507 |
def _set_configobj(self, configobj): |
|
1508 |
out_file = StringIO() |
|
1509 |
configobj.write(out_file) |
|
1510 |
out_file.seek(0) |
|
1511 |
self._transport.put_file(self._filename, out_file) |