1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
1 |
# Copyright (C) 2005 by Canonical Ltd
|
2 |
# Authors: Robert Collins <robert.collins@canonical.com>
|
|
3 |
#
|
|
4 |
# This program is free software; you can redistribute it and/or modify
|
|
5 |
# it under the terms of the GNU General Public License as published by
|
|
6 |
# the Free Software Foundation; either version 2 of the License, or
|
|
7 |
# (at your option) any later version.
|
|
8 |
#
|
|
9 |
# This program is distributed in the hope that it will be useful,
|
|
10 |
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
11 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
12 |
# GNU General Public License for more details.
|
|
13 |
#
|
|
14 |
# You should have received a copy of the GNU General Public License
|
|
15 |
# along with this program; if not, write to the Free Software
|
|
16 |
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
17 |
||
1442.1.20
by Robert Collins
add some documentation on options |
18 |
"""Configuration that affects the behaviour of Bazaar.
|
19 |
||
20 |
Currently this configuration resides in ~/.bazaar/bazaar.conf
|
|
21 |
and ~/.bazaar/branches.conf, which is written to by bzr.
|
|
22 |
||
1461
by Robert Collins
Typo in config.py (Thanks Fabbione) |
23 |
In bazaar.conf the following options may be set:
|
1442.1.20
by Robert Collins
add some documentation on options |
24 |
[DEFAULT]
|
25 |
editor=name-of-program
|
|
26 |
email=Your Name <your@email.address>
|
|
27 |
check_signatures=require|ignore|check-available(default)
|
|
28 |
create_signatures=always|never|when-required(default)
|
|
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
29 |
gpg_signing_command=name-of-program
|
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
30 |
log_format=name-of-format
|
1442.1.20
by Robert Collins
add some documentation on options |
31 |
|
32 |
in branches.conf, you specify the url of a branch and options for it.
|
|
33 |
Wildcards may be used - * and ? as normal in shell completion. Options
|
|
34 |
set in both bazaar.conf and branches.conf are overriden by the branches.conf
|
|
35 |
setting.
|
|
36 |
[/home/robertc/source]
|
|
37 |
recurse=False|True(default)
|
|
38 |
email= as above
|
|
39 |
check_signatures= as abive
|
|
40 |
create_signatures= as above.
|
|
41 |
||
42 |
explanation of options
|
|
43 |
----------------------
|
|
44 |
editor - this option sets the pop up editor to use during commits.
|
|
45 |
email - this option sets the user id bzr will use when committing.
|
|
46 |
check_signatures - this option controls whether bzr will require good gpg
|
|
47 |
signatures, ignore them, or check them if they are
|
|
48 |
present.
|
|
49 |
create_signatures - this option controls whether bzr will always create
|
|
50 |
gpg signatures, never create them, or create them if the
|
|
51 |
branch is configured to require them.
|
|
1442.1.21
by Robert Collins
create signature_needed() call for commit to trigger creating signatures |
52 |
NB: This option is planned, but not implemented yet.
|
1553.2.4
by Erik Bågfors
Support for setting the default log format at a configuration option |
53 |
log_format - This options set the default log format. Options are long,
|
54 |
short, line, or a plugin can register new formats
|
|
1442.1.20
by Robert Collins
add some documentation on options |
55 |
"""
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
56 |
|
1474
by Robert Collins
Merge from Aaron Bentley. |
57 |
|
58 |
import errno |
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
59 |
import os |
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
60 |
import sys |
1442.1.12
by Robert Collins
LocationConfig section retrieval falls into my lap |
61 |
from fnmatch import fnmatch |
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
62 |
import re |
63 |
||
64 |
import bzrlib |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
65 |
import bzrlib.errors as errors |
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 \ |
66 |
from bzrlib.osutils import pathjoin |
1185.31.39
by John Arbash Meinel
Replacing os.getcwdu() with osutils.getcwd(), |
67 |
from bzrlib.trace import mutter |
1474
by Robert Collins
Merge from Aaron Bentley. |
68 |
import bzrlib.util.configobj.configobj as configobj |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
69 |
from StringIO import StringIO |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
70 |
|
1442.1.14
by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE |
71 |
CHECK_IF_POSSIBLE=0 |
72 |
CHECK_ALWAYS=1 |
|
73 |
CHECK_NEVER=2 |
|
74 |
||
75 |
||
1474
by Robert Collins
Merge from Aaron Bentley. |
76 |
class ConfigObj(configobj.ConfigObj): |
77 |
||
78 |
def get_bool(self, section, key): |
|
1556.2.2
by Aaron Bentley
Fixed get_bool |
79 |
return self[section].as_bool(key) |
1474
by Robert Collins
Merge from Aaron Bentley. |
80 |
|
81 |
def get_value(self, section, name): |
|
82 |
# Try [] for the old DEFAULT section.
|
|
83 |
if section == "DEFAULT": |
|
84 |
try: |
|
85 |
return self[name] |
|
86 |
except KeyError: |
|
87 |
pass
|
|
88 |
return self[section][name] |
|
89 |
||
90 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
91 |
class Config(object): |
92 |
"""A configuration policy - what username, editor, gpg needs etc."""
|
|
93 |
||
94 |
def get_editor(self): |
|
95 |
"""Get the users pop up editor."""
|
|
96 |
raise NotImplementedError |
|
97 |
||
1442.1.15
by Robert Collins
make getting the signature checking policy a template method |
98 |
def _get_signature_checking(self): |
99 |
"""Template method to override signature checking policy."""
|
|
100 |
||
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
101 |
def _get_user_option(self, option_name): |
102 |
"""Template method to provide a user option."""
|
|
103 |
return None |
|
104 |
||
105 |
def get_user_option(self, option_name): |
|
106 |
"""Get a generic option - no special process, no default."""
|
|
107 |
return self._get_user_option(option_name) |
|
108 |
||
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
109 |
def gpg_signing_command(self): |
110 |
"""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. |
111 |
result = self._gpg_signing_command() |
112 |
if result is None: |
|
113 |
result = "gpg" |
|
114 |
return result |
|
115 |
||
116 |
def _gpg_signing_command(self): |
|
117 |
"""See gpg_signing_command()."""
|
|
118 |
return None |
|
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
119 |
|
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
120 |
def log_format(self): |
121 |
"""What log format should be used"""
|
|
122 |
result = self._log_format() |
|
1553.2.4
by Erik Bågfors
Support for setting the default log format at a configuration option |
123 |
if result is None: |
124 |
result = "long" |
|
125 |
return result |
|
126 |
||
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
127 |
def _log_format(self): |
128 |
"""See log_format()."""
|
|
1553.2.4
by Erik Bågfors
Support for setting the default log format at a configuration option |
129 |
return None |
130 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
131 |
def __init__(self): |
132 |
super(Config, self).__init__() |
|
133 |
||
1472
by Robert Collins
post commit hook, first pass implementation |
134 |
def post_commit(self): |
135 |
"""An ordered list of python functions to call.
|
|
136 |
||
137 |
Each function takes branch, rev_id as parameters.
|
|
138 |
"""
|
|
139 |
return self._post_commit() |
|
140 |
||
141 |
def _post_commit(self): |
|
142 |
"""See Config.post_commit."""
|
|
143 |
return None |
|
144 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
145 |
def user_email(self): |
146 |
"""Return just the email component of a username."""
|
|
1185.33.31
by Martin Pool
Make annotate cope better with revisions committed without a valid |
147 |
return extract_email_address(self.username()) |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
148 |
|
149 |
def username(self): |
|
150 |
"""Return email-style username.
|
|
151 |
|
|
152 |
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
|
|
153 |
|
|
154 |
$BZREMAIL can be set to override this, then
|
|
155 |
the concrete policy type is checked, and finally
|
|
1185.37.2
by Jamie Wilkinson
Fix a typo and grammar in Config.username() docstring. |
156 |
$EMAIL is examined.
|
157 |
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 |
158 |
created.
|
159 |
|
|
160 |
TODO: Check it's reasonably well-formed.
|
|
161 |
"""
|
|
162 |
v = os.environ.get('BZREMAIL') |
|
163 |
if v: |
|
164 |
return v.decode(bzrlib.user_encoding) |
|
165 |
||
166 |
v = self._get_user_id() |
|
167 |
if v: |
|
168 |
return v |
|
169 |
||
170 |
v = os.environ.get('EMAIL') |
|
171 |
if v: |
|
172 |
return v.decode(bzrlib.user_encoding) |
|
173 |
||
174 |
name, email = _auto_user_id() |
|
175 |
if name: |
|
176 |
return '%s <%s>' % (name, email) |
|
177 |
else: |
|
178 |
return email |
|
179 |
||
1442.1.14
by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE |
180 |
def signature_checking(self): |
181 |
"""What is the current policy for signature checking?."""
|
|
1442.1.15
by Robert Collins
make getting the signature checking policy a template method |
182 |
policy = self._get_signature_checking() |
183 |
if policy is not None: |
|
184 |
return policy |
|
1442.1.14
by Robert Collins
Create a default signature checking policy of CHECK_IF_POSSIBLE |
185 |
return CHECK_IF_POSSIBLE |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
186 |
|
1442.1.21
by Robert Collins
create signature_needed() call for commit to trigger creating signatures |
187 |
def signature_needed(self): |
188 |
"""Is a signature needed when committing ?."""
|
|
189 |
policy = self._get_signature_checking() |
|
190 |
if policy == CHECK_ALWAYS: |
|
191 |
return True |
|
192 |
return False |
|
193 |
||
1442.1.15
by Robert Collins
make getting the signature checking policy a template method |
194 |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
195 |
class IniBasedConfig(Config): |
196 |
"""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 |
197 |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
198 |
def _get_parser(self, file=None): |
1185.12.51
by Aaron Bentley
Allowed second call of _get_parser() to not require a file |
199 |
if self._parser is not None: |
200 |
return self._parser |
|
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
201 |
if file is None: |
202 |
input = self._get_filename() |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
203 |
else: |
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
204 |
input = file |
1185.12.51
by Aaron Bentley
Allowed second call of _get_parser() to not require a file |
205 |
try: |
206 |
self._parser = ConfigObj(input) |
|
1474
by Robert Collins
Merge from Aaron Bentley. |
207 |
except configobj.ConfigObjError, e: |
1185.12.51
by Aaron Bentley
Allowed second call of _get_parser() to not require a file |
208 |
raise errors.ParseConfigError(e.errors, e.config.filename) |
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
209 |
return self._parser |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
210 |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
211 |
def _get_section(self): |
212 |
"""Override this to define the section used by the config."""
|
|
213 |
return "DEFAULT" |
|
214 |
||
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
215 |
def _get_signature_checking(self): |
216 |
"""See Config._get_signature_checking."""
|
|
1474
by Robert Collins
Merge from Aaron Bentley. |
217 |
policy = self._get_user_option('check_signatures') |
218 |
if policy: |
|
219 |
return self._string_to_signature_policy(policy) |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
220 |
|
221 |
def _get_user_id(self): |
|
222 |
"""Get the user id from the 'email' key in the current section."""
|
|
1474
by Robert Collins
Merge from Aaron Bentley. |
223 |
return self._get_user_option('email') |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
224 |
|
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
225 |
def _get_user_option(self, option_name): |
226 |
"""See Config._get_user_option."""
|
|
1185.12.53
by Aaron Bentley
Merged more from Robert |
227 |
try: |
1474
by Robert Collins
Merge from Aaron Bentley. |
228 |
return self._get_parser().get_value(self._get_section(), |
229 |
option_name) |
|
1185.12.53
by Aaron Bentley
Merged more from Robert |
230 |
except KeyError: |
231 |
pass
|
|
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
232 |
|
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
233 |
def _gpg_signing_command(self): |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
234 |
"""See Config.gpg_signing_command."""
|
1472
by Robert Collins
post commit hook, first pass implementation |
235 |
return self._get_user_option('gpg_signing_command') |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
236 |
|
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
237 |
def _log_format(self): |
238 |
"""See Config.log_format."""
|
|
239 |
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 |
240 |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
241 |
def __init__(self, get_filename): |
242 |
super(IniBasedConfig, self).__init__() |
|
243 |
self._get_filename = get_filename |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
244 |
self._parser = None |
1472
by Robert Collins
post commit hook, first pass implementation |
245 |
|
246 |
def _post_commit(self): |
|
247 |
"""See Config.post_commit."""
|
|
248 |
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 |
249 |
|
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
250 |
def _string_to_signature_policy(self, signature_string): |
251 |
"""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 |
252 |
if signature_string.lower() == 'check-available': |
253 |
return CHECK_IF_POSSIBLE |
|
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
254 |
if signature_string.lower() == 'ignore': |
255 |
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 |
256 |
if signature_string.lower() == 'require': |
257 |
return CHECK_ALWAYS |
|
1442.1.16
by Robert Collins
allow global overriding of signature policy to never check |
258 |
raise errors.BzrError("Invalid signatures policy '%s'" |
259 |
% signature_string) |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
260 |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
261 |
|
262 |
class GlobalConfig(IniBasedConfig): |
|
263 |
"""The configuration that should be used for a specific location."""
|
|
264 |
||
265 |
def get_editor(self): |
|
1474
by Robert Collins
Merge from Aaron Bentley. |
266 |
return self._get_user_option('editor') |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
267 |
|
268 |
def __init__(self): |
|
269 |
super(GlobalConfig, self).__init__(config_filename) |
|
270 |
||
271 |
||
272 |
class LocationConfig(IniBasedConfig): |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
273 |
"""A configuration object that gives the policy for a location."""
|
274 |
||
275 |
def __init__(self, location): |
|
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
276 |
super(LocationConfig, self).__init__(branches_config_filename) |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
277 |
self._global_config = None |
278 |
self.location = location |
|
279 |
||
280 |
def _get_global_config(self): |
|
281 |
if self._global_config is None: |
|
282 |
self._global_config = GlobalConfig() |
|
283 |
return self._global_config |
|
284 |
||
1442.1.9
by Robert Collins
exact section test passes |
285 |
def _get_section(self): |
286 |
"""Get the section we should look in for config items.
|
|
287 |
||
288 |
Returns None if none exists.
|
|
289 |
TODO: perhaps return a NullSection that thunks through to the
|
|
290 |
global config.
|
|
291 |
"""
|
|
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
292 |
sections = self._get_parser() |
1442.1.12
by Robert Collins
LocationConfig section retrieval falls into my lap |
293 |
location_names = self.location.split('/') |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
294 |
if self.location.endswith('/'): |
295 |
del location_names[-1] |
|
1442.1.12
by Robert Collins
LocationConfig section retrieval falls into my lap |
296 |
matches=[] |
1442.1.10
by Robert Collins
explicit over glob test passes |
297 |
for section in sections: |
1442.1.12
by Robert Collins
LocationConfig section retrieval falls into my lap |
298 |
section_names = section.split('/') |
299 |
if section.endswith('/'): |
|
300 |
del section_names[-1] |
|
301 |
names = zip(location_names, section_names) |
|
302 |
matched = True |
|
303 |
for name in names: |
|
304 |
if not fnmatch(name[0], name[1]): |
|
305 |
matched = False |
|
306 |
break
|
|
307 |
if not matched: |
|
308 |
continue
|
|
309 |
# so, for the common prefix they matched.
|
|
310 |
# if section is longer, no match.
|
|
311 |
if len(section_names) > len(location_names): |
|
312 |
continue
|
|
313 |
# if path is longer, and recurse is not true, no match
|
|
314 |
if len(section_names) < len(location_names): |
|
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
315 |
try: |
1474
by Robert Collins
Merge from Aaron Bentley. |
316 |
if not self._get_parser().get_bool(section, 'recurse'): |
1185.12.49
by Aaron Bentley
Switched to ConfigObj |
317 |
continue
|
318 |
except KeyError: |
|
319 |
pass
|
|
1442.1.12
by Robert Collins
LocationConfig section retrieval falls into my lap |
320 |
matches.append((len(section_names), section)) |
321 |
if not len(matches): |
|
322 |
return None |
|
323 |
matches.sort(reverse=True) |
|
324 |
return matches[0][1] |
|
1442.1.9
by Robert Collins
exact section test passes |
325 |
|
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
326 |
def _gpg_signing_command(self): |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
327 |
"""See Config.gpg_signing_command."""
|
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
328 |
command = super(LocationConfig, self)._gpg_signing_command() |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
329 |
if command is not None: |
330 |
return command |
|
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
331 |
return self._get_global_config()._gpg_signing_command() |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
332 |
|
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
333 |
def _log_format(self): |
334 |
"""See Config.log_format."""
|
|
335 |
command = super(LocationConfig, self)._log_format() |
|
1553.2.4
by Erik Bågfors
Support for setting the default log format at a configuration option |
336 |
if command is not None: |
337 |
return command |
|
1553.2.9
by Erik Bågfors
log_formatter => log_format for "named" formatters |
338 |
return self._get_global_config()._log_format() |
1553.2.4
by Erik Bågfors
Support for setting the default log format at a configuration option |
339 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
340 |
def _get_user_id(self): |
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
341 |
user_id = super(LocationConfig, self)._get_user_id() |
342 |
if user_id is not None: |
|
343 |
return user_id |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
344 |
return self._get_global_config()._get_user_id() |
345 |
||
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
346 |
def _get_user_option(self, option_name): |
347 |
"""See Config._get_user_option."""
|
|
348 |
option_value = super(LocationConfig, |
|
349 |
self)._get_user_option(option_name) |
|
350 |
if option_value is not None: |
|
351 |
return option_value |
|
352 |
return self._get_global_config()._get_user_option(option_name) |
|
353 |
||
1442.1.18
by Robert Collins
permit per branch location overriding of signature checking policy |
354 |
def _get_signature_checking(self): |
355 |
"""See Config._get_signature_checking."""
|
|
356 |
check = super(LocationConfig, self)._get_signature_checking() |
|
357 |
if check is not None: |
|
358 |
return check |
|
359 |
return self._get_global_config()._get_signature_checking() |
|
360 |
||
1472
by Robert Collins
post commit hook, first pass implementation |
361 |
def _post_commit(self): |
362 |
"""See Config.post_commit."""
|
|
363 |
hook = self._get_user_option('post_commit') |
|
364 |
if hook is not None: |
|
365 |
return hook |
|
366 |
return self._get_global_config()._post_commit() |
|
367 |
||
1490
by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1. |
368 |
def set_user_option(self, option, value): |
369 |
"""Save option and its value in the configuration."""
|
|
370 |
# FIXME: RBC 20051029 This should refresh the parser and also take a
|
|
371 |
# file lock on branches.conf.
|
|
1185.31.39
by John Arbash Meinel
Replacing os.getcwdu() with osutils.getcwd(), |
372 |
conf_dir = os.path.dirname(self._get_filename()) |
1185.31.43
by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp |
373 |
ensure_config_dir_exists(conf_dir) |
1490
by Robert Collins
Implement a 'bzr push' command, with saved locations; update diff to return 1. |
374 |
location = self.location |
375 |
if location.endswith('/'): |
|
376 |
location = location[:-1] |
|
377 |
if (not location in self._get_parser() and |
|
378 |
not location + '/' in self._get_parser()): |
|
379 |
self._get_parser()[location]={} |
|
380 |
elif location + '/' in self._get_parser(): |
|
381 |
location = location + '/' |
|
382 |
self._get_parser()[location][option]=value |
|
383 |
self._get_parser().write() |
|
384 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
385 |
|
386 |
class BranchConfig(Config): |
|
387 |
"""A configuration object giving the policy for a branch."""
|
|
388 |
||
389 |
def _get_location_config(self): |
|
390 |
if self._location_config is None: |
|
391 |
self._location_config = LocationConfig(self.branch.base) |
|
392 |
return self._location_config |
|
393 |
||
394 |
def _get_user_id(self): |
|
395 |
"""Return the full user id for the branch.
|
|
396 |
|
|
397 |
e.g. "John Hacker <jhacker@foo.org>"
|
|
398 |
This is looked up in the email controlfile for the branch.
|
|
399 |
"""
|
|
400 |
try: |
|
1185.65.29
by Robert Collins
Implement final review suggestions. |
401 |
return (self.branch.control_files.get_utf8("email") |
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
402 |
.read() |
403 |
.decode(bzrlib.user_encoding) |
|
404 |
.rstrip("\r\n")) |
|
405 |
except errors.NoSuchFile, e: |
|
406 |
pass
|
|
407 |
||
408 |
return self._get_location_config()._get_user_id() |
|
409 |
||
1442.1.19
by Robert Collins
BranchConfigs inherit signature_checking policy from their LocationConfig. |
410 |
def _get_signature_checking(self): |
411 |
"""See Config._get_signature_checking."""
|
|
412 |
return self._get_location_config()._get_signature_checking() |
|
413 |
||
1442.1.69
by Robert Collins
config.Config has a 'get_user_option' call that accepts an option name. |
414 |
def _get_user_option(self, option_name): |
415 |
"""See Config._get_user_option."""
|
|
416 |
return self._get_location_config()._get_user_option(option_name) |
|
417 |
||
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
418 |
def _gpg_signing_command(self): |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
419 |
"""See Config.gpg_signing_command."""
|
1442.1.59
by Robert Collins
Add re-sign command to generate a digital signature on a single revision. |
420 |
return self._get_location_config()._gpg_signing_command() |
1442.1.56
by Robert Collins
gpg_signing_command configuration item |
421 |
|
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
422 |
def __init__(self, branch): |
423 |
super(BranchConfig, self).__init__() |
|
424 |
self._location_config = None |
|
425 |
self.branch = branch |
|
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
426 |
|
1472
by Robert Collins
post commit hook, first pass implementation |
427 |
def _post_commit(self): |
428 |
"""See Config.post_commit."""
|
|
429 |
return self._get_location_config()._post_commit() |
|
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_location_config()._log_format() |
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
434 |
|
1185.31.43
by John Arbash Meinel
Reintroduced ensure_config_dir_exists() for sftp |
435 |
def ensure_config_dir_exists(path=None): |
436 |
"""Make sure a configuration directory exists.
|
|
437 |
This makes sure that the directory exists.
|
|
438 |
On windows, since configuration directories are 2 levels deep,
|
|
439 |
it makes sure both the directory and the parent directory exists.
|
|
440 |
"""
|
|
441 |
if path is None: |
|
442 |
path = config_dir() |
|
443 |
if not os.path.isdir(path): |
|
444 |
if sys.platform == 'win32': |
|
445 |
parent_dir = os.path.dirname(path) |
|
446 |
if not os.path.isdir(parent_dir): |
|
447 |
mutter('creating config parent directory: %r', parent_dir) |
|
448 |
os.mkdir(parent_dir) |
|
449 |
mutter('creating config directory: %r', path) |
|
450 |
os.mkdir(path) |
|
451 |
||
1532
by Robert Collins
Merge in John Meinels integration branch. |
452 |
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
453 |
def config_dir(): |
454 |
"""Return per-user configuration directory.
|
|
455 |
||
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
456 |
By default this is ~/.bazaar/
|
1442.1.1
by Robert Collins
move config_dir into bzrlib.config |
457 |
|
458 |
TODO: Global option --config-dir to override this.
|
|
459 |
"""
|
|
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
460 |
base = os.environ.get('BZR_HOME', None) |
461 |
if sys.platform == 'win32': |
|
462 |
if base is None: |
|
463 |
base = os.environ.get('APPDATA', None) |
|
464 |
if base is None: |
|
465 |
base = os.environ.get('HOME', None) |
|
466 |
if base is None: |
|
467 |
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set') |
|
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 \ |
468 |
return pathjoin(base, 'bazaar', '2.0') |
1185.38.1
by John Arbash Meinel
Adding my win32 patch for moving the home directory. |
469 |
else: |
470 |
# cygwin, linux, and darwin all have a $HOME directory
|
|
471 |
if base is None: |
|
472 |
base = os.path.expanduser("~") |
|
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 \ |
473 |
return pathjoin(base, ".bazaar") |
474 |
||
475 |
||
1442.1.2
by Robert Collins
create a config module - there is enough config logic to make this worthwhile, and start testing config processing. |
476 |
def config_filename(): |
477 |
"""Return per-user configuration ini file filename."""
|
|
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 \ |
478 |
return 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. |
479 |
|
480 |
||
1442.1.6
by Robert Collins
first stage major overhaul of configs, giving use BranchConfigs, LocationConfigs and GlobalConfigs |
481 |
def branches_config_filename(): |
482 |
"""Return per-user configuration ini file filename."""
|
|
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 \ |
483 |
return 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. |
484 |
|
485 |
||
486 |
def _auto_user_id(): |
|
487 |
"""Calculate automatic user identification.
|
|
488 |
||
489 |
Returns (realname, email).
|
|
490 |
||
491 |
Only used when none is set in the environment or the id file.
|
|
492 |
||
493 |
This previously used the FQDN as the default domain, but that can
|
|
494 |
be very slow on machines where DNS is broken. So now we simply
|
|
495 |
use the hostname.
|
|
496 |
"""
|
|
497 |
import socket |
|
498 |
||
499 |
# XXX: Any good way to get real user name on win32?
|
|
500 |
||
501 |
try: |
|
502 |
import pwd |
|
503 |
uid = os.getuid() |
|
504 |
w = pwd.getpwuid(uid) |
|
505 |
gecos = w.pw_gecos.decode(bzrlib.user_encoding) |
|
506 |
username = w.pw_name.decode(bzrlib.user_encoding) |
|
507 |
comma = gecos.find(',') |
|
508 |
if comma == -1: |
|
509 |
realname = gecos |
|
510 |
else: |
|
511 |
realname = gecos[:comma] |
|
512 |
if not realname: |
|
513 |
realname = username |
|
514 |
||
515 |
except ImportError: |
|
516 |
import getpass |
|
517 |
realname = username = getpass.getuser().decode(bzrlib.user_encoding) |
|
518 |
||
519 |
return realname, (username + '@' + socket.gethostname()) |
|
520 |
||
521 |
||
1185.16.52
by Martin Pool
- add extract_email_address |
522 |
def extract_email_address(e): |
523 |
"""Return just the address part of an email string.
|
|
524 |
|
|
525 |
That is just the user@domain part, nothing else.
|
|
526 |
This part is required to contain only ascii characters.
|
|
527 |
If it can't be extracted, raises an error.
|
|
528 |
|
|
529 |
>>> extract_email_address('Jane Tester <jane@test.com>')
|
|
530 |
"jane@test.com"
|
|
531 |
"""
|
|
532 |
m = re.search(r'[\w+.-]+@[\w+.-]+', e) |
|
533 |
if not m: |
|
1185.33.31
by Martin Pool
Make annotate cope better with revisions committed without a valid |
534 |
raise errors.BzrError("%r doesn't seem to contain " |
535 |
"a reasonable email address" % e) |
|
1185.16.52
by Martin Pool
- add extract_email_address |
536 |
return m.group(0) |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
537 |
|
538 |
class TreeConfig(object): |
|
539 |
"""Branch configuration data associated with its contents, not location"""
|
|
540 |
def __init__(self, branch): |
|
541 |
self.branch = branch |
|
542 |
||
543 |
def _get_config(self): |
|
544 |
try: |
|
1556.2.1
by Aaron Bentley
Switched to ConfigObj 4.2.0 |
545 |
obj = ConfigObj(self.branch.control_files.get('branch.conf'), |
546 |
encoding='utf-8') |
|
1185.35.11
by Aaron Bentley
Added support for branch nicks |
547 |
except errors.NoSuchFile: |
1556.2.1
by Aaron Bentley
Switched to ConfigObj 4.2.0 |
548 |
obj = ConfigObj(encoding='utf=8') |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
549 |
return obj |
550 |
||
551 |
def get_option(self, name, section=None, default=None): |
|
552 |
self.branch.lock_read() |
|
553 |
try: |
|
554 |
obj = self._get_config() |
|
555 |
try: |
|
556 |
if section is not None: |
|
557 |
obj[section] |
|
558 |
result = obj[name] |
|
559 |
except KeyError: |
|
560 |
result = default |
|
561 |
finally: |
|
562 |
self.branch.unlock() |
|
563 |
return result |
|
564 |
||
565 |
def set_option(self, value, name, section=None): |
|
566 |
"""Set a per-branch configuration option"""
|
|
567 |
self.branch.lock_write() |
|
568 |
try: |
|
569 |
cfg_obj = self._get_config() |
|
570 |
if section is None: |
|
571 |
obj = cfg_obj |
|
572 |
else: |
|
573 |
try: |
|
574 |
obj = cfg_obj[section] |
|
575 |
except KeyError: |
|
576 |
cfg_obj[section] = {} |
|
577 |
obj = cfg_obj[section] |
|
578 |
obj[name] = value |
|
1556.2.1
by Aaron Bentley
Switched to ConfigObj 4.2.0 |
579 |
out_file = StringIO() |
580 |
cfg_obj.write(out_file) |
|
1185.35.11
by Aaron Bentley
Added support for branch nicks |
581 |
out_file.seek(0) |
1185.65.12
by Robert Collins
Remove the only-used-once put_controlfiles, and change put_controlfile to put and put_utf8. |
582 |
self.branch.control_files.put('branch.conf', out_file) |
1185.35.11
by Aaron Bentley
Added support for branch nicks |
583 |
finally: |
584 |
self.branch.unlock() |