« back to all changes in this revision
Viewing changes to bzrlib/config.py
- browse files at revision 1185.12.43
- compare with another revision
- compare with revision 1185.33.74
- download diff
- download tarball
- view history from revision 1185.12.43
- Committer: abentley
- Date: 2005-10-16 05:15:58 UTC
- mfrom: (1457)
- mto: (1185.25.1)
- mto: This revision was merged to the branch mainline in revision 1460.
- Revision ID: abentley@lappy-20051016051558-502eb6c3601ceb90
Merged Robert's latest
added
removed
bzrlib/config.py
15
15
# along with this program; if not, write to the Free Software
16
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17
17
18
"""Configuration that affects the behaviour of Bazaar."""
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
23
In bazaar.config the following options may be set:
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)
29
30
in branches.conf, you specify the url of a branch and options for it.
31
Wildcards may be used - * and ? as normal in shell completion. Options
32
set in both bazaar.conf and branches.conf are overriden by the branches.conf
33
setting.
34
[/home/robertc/source]
35
recurse=False|True(default)
36
email= as above
37
check_signatures= as abive
38
create_signatures= as above.
39
40
explanation of options
41
----------------------
42
editor - this option sets the pop up editor to use during commits.
43
email - this option sets the user id bzr will use when committing.
44
check_signatures - this option controls whether bzr will require good gpg
45
signatures, ignore them, or check them if they are
46
present.
47
create_signatures - this option controls whether bzr will always create
48
gpg signatures, never create them, or create them if the
49
branch is configured to require them.
50
NB: This option is planned, but not implemented yet.
51
"""
19
52
20
53
from ConfigParser import ConfigParser
21
54
import os
55
from fnmatch import fnmatch
22
56
import errno
23
57
import re
24
58
25
59
import bzrlib
60
import bzrlib.errors as errors
61
62
63
CHECK_IF_POSSIBLE=0
64
CHECK_ALWAYS=1
65
CHECK_NEVER=2
66
67
68
class Config(object):
69
"""A configuration policy - what username, editor, gpg needs etc."""
70
71
def get_editor(self):
72
"""Get the users pop up editor."""
73
raise NotImplementedError
74
75
def _get_signature_checking(self):
76
"""Template method to override signature checking policy."""
77
78
def __init__(self):
79
super(Config, self).__init__()
80
81
def user_email(self):
82
"""Return just the email component of a username."""
83
e = self.username()
84
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
85
if not m:
86
raise BzrError("%r doesn't seem to contain "
87
"a reasonable email address" % e)
88
return m.group(0)
89
90
def username(self):
91
"""Return email-style username.
92
93
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
94
95
$BZREMAIL can be set to override this, then
96
the concrete policy type is checked, and finally
97
$EMAIL is examinged.
98
but if none is found, a reasonable default is (hopefully)
99
created.
100
101
TODO: Check it's reasonably well-formed.
102
"""
103
v = os.environ.get('BZREMAIL')
104
if v:
105
return v.decode(bzrlib.user_encoding)
106
107
v = self._get_user_id()
108
if v:
109
return v
110
111
v = os.environ.get('EMAIL')
112
if v:
113
return v.decode(bzrlib.user_encoding)
114
115
name, email = _auto_user_id()
116
if name:
117
return '%s <%s>' % (name, email)
118
else:
119
return email
120
121
def signature_checking(self):
122
"""What is the current policy for signature checking?."""
123
policy = self._get_signature_checking()
124
if policy is not None:
125
return policy
126
return CHECK_IF_POSSIBLE
127
128
def signature_needed(self):
129
"""Is a signature needed when committing ?."""
130
policy = self._get_signature_checking()
131
if policy == CHECK_ALWAYS:
132
return True
133
return False
134
135
136
class IniBasedConfig(Config):
137
"""A configuration policy that draws from ini files."""
138
139
def _get_parser(self, file=None):
140
if self._parser is not None:
141
return self._parser
142
parser = ConfigParser()
143
if file is not None:
144
parser.readfp(file)
145
else:
146
parser.read([self._get_filename()])
147
self._parser = parser
148
return parser
149
150
def _get_section(self):
151
"""Override this to define the section used by the config."""
152
return "DEFAULT"
153
154
def _get_signature_checking(self):
155
"""See Config._get_signature_checking."""
156
section = self._get_section()
157
if section is None:
158
return None
159
if self._get_parser().has_option(section, 'check_signatures'):
160
return self._string_to_signature_policy(
161
self._get_parser().get(section, 'check_signatures'))
162
163
def _get_user_id(self):
164
"""Get the user id from the 'email' key in the current section."""
165
section = self._get_section()
166
if section is not None:
167
if self._get_parser().has_option(section, 'email'):
168
return self._get_parser().get(section, 'email')
169
170
def __init__(self, get_filename):
171
super(IniBasedConfig, self).__init__()
172
self._get_filename = get_filename
173
self._parser = None
174
175
def _string_to_signature_policy(self, signature_string):
176
"""Convert a string to a signing policy."""
177
if signature_string.lower() == 'check-available':
178
return CHECK_IF_POSSIBLE
179
if signature_string.lower() == 'ignore':
180
return CHECK_NEVER
181
if signature_string.lower() == 'require':
182
return CHECK_ALWAYS
183
raise errors.BzrError("Invalid signatures policy '%s'"
184
% signature_string)
185
186
187
class GlobalConfig(IniBasedConfig):
188
"""The configuration that should be used for a specific location."""
189
190
def get_editor(self):
191
if self._get_parser().has_option(self._get_section(), 'editor'):
192
return self._get_parser().get(self._get_section(), 'editor')
193
194
def __init__(self):
195
super(GlobalConfig, self).__init__(config_filename)
196
197
198
class LocationConfig(IniBasedConfig):
199
"""A configuration object that gives the policy for a location."""
200
201
def __init__(self, location):
202
super(LocationConfig, self).__init__(branches_config_filename)
203
self._global_config = None
204
self.location = location
205
206
def _get_global_config(self):
207
if self._global_config is None:
208
self._global_config = GlobalConfig()
209
return self._global_config
210
211
def _get_section(self):
212
"""Get the section we should look in for config items.
213
214
Returns None if none exists.
215
TODO: perhaps return a NullSection that thunks through to the
216
global config.
217
"""
218
sections = self._get_parser().sections()
219
location_names = self.location.split('/')
220
if self.location.endswith('/'):
221
del location_names[-1]
222
matches=[]
223
for section in sections:
224
section_names = section.split('/')
225
if section.endswith('/'):
226
del section_names[-1]
227
names = zip(location_names, section_names)
228
matched = True
229
for name in names:
230
if not fnmatch(name[0], name[1]):
231
matched = False
232
break
233
if not matched:
234
continue
235
# so, for the common prefix they matched.
236
# if section is longer, no match.
237
if len(section_names) > len(location_names):
238
continue
239
# if path is longer, and recurse is not true, no match
240
if len(section_names) < len(location_names):
241
if (self._get_parser().has_option(section, 'recurse')
242
and not self._get_parser().getboolean(section, 'recurse')):
243
continue
244
matches.append((len(section_names), section))
245
if not len(matches):
246
return None
247
matches.sort(reverse=True)
248
return matches[0][1]
249
250
def _get_user_id(self):
251
user_id = super(LocationConfig, self)._get_user_id()
252
if user_id is not None:
253
return user_id
254
return self._get_global_config()._get_user_id()
255
256
def _get_signature_checking(self):
257
"""See Config._get_signature_checking."""
258
check = super(LocationConfig, self)._get_signature_checking()
259
if check is not None:
260
return check
261
return self._get_global_config()._get_signature_checking()
262
263
264
class BranchConfig(Config):
265
"""A configuration object giving the policy for a branch."""
266
267
def _get_location_config(self):
268
if self._location_config is None:
269
self._location_config = LocationConfig(self.branch.base)
270
return self._location_config
271
272
def _get_user_id(self):
273
"""Return the full user id for the branch.
274
275
e.g. "John Hacker <jhacker@foo.org>"
276
This is looked up in the email controlfile for the branch.
277
"""
278
try:
279
return (self.branch.controlfile("email", "r")
280
.read()
281
.decode(bzrlib.user_encoding)
282
.rstrip("\r\n"))
283
except errors.NoSuchFile, e:
284
pass
285
286
return self._get_location_config()._get_user_id()
287
288
def _get_signature_checking(self):
289
"""See Config._get_signature_checking."""
290
return self._get_location_config()._get_signature_checking()
291
292
def __init__(self, branch):
293
super(BranchConfig, self).__init__()
294
self._location_config = None
295
self.branch = branch
26
296
27
297
28
298
def config_dir():
40
310
return os.path.join(config_dir(), 'bazaar.conf')
41
311
42
312
43
def _get_config_parser(file=None):
44
parser = ConfigParser()
45
if file is not None:
46
parser.readfp(file)
47
else:
48
parser.read([config_filename()])
49
return parser
50
51
52
def get_editor(parser=None):
53
if parser is None:
54
parser = _get_config_parser()
55
if parser.has_option('DEFAULT', 'editor'):
56
return parser.get('DEFAULT', 'editor')
57
58
59
def _get_user_id(branch=None, parser = None):
60
"""Return the full user id from a file or environment variable.
61
62
e.g. "John Hacker <jhacker@foo.org>"
63
64
branch
65
A branch to use for a per-branch configuration, or None.
66
67
The following are searched in order:
68
69
1. $BZREMAIL
70
2. .bzr/email for this branch.
71
3. ~/.bzr.conf/email
72
4. $EMAIL
73
"""
74
v = os.environ.get('BZREMAIL')
75
if v:
76
return v.decode(bzrlib.user_encoding)
77
78
if branch:
79
try:
80
return (branch.controlfile("email", "r")
81
.read()
82
.decode(bzrlib.user_encoding)
83
.rstrip("\r\n"))
84
except IOError, e:
85
if e.errno != errno.ENOENT:
86
raise
87
except BzrError, e:
88
pass
89
90
if parser is None:
91
parser = _get_config_parser()
92
if parser.has_option('DEFAULT', 'email'):
93
email = parser.get('DEFAULT', 'email')
94
if email is not None:
95
return email
96
97
v = os.environ.get('EMAIL')
98
if v:
99
return v.decode(bzrlib.user_encoding)
100
else:
101
return None
313
def branches_config_filename():
314
"""Return per-user configuration ini file filename."""
315
return os.path.join(config_dir(), 'branches.conf')
102
316
103
317
104
318
def _auto_user_id():
137
351
return realname, (username + '@' + socket.gethostname())
138
352
139
353
140
def username(branch):
141
"""Return email-style username.
142
143
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
144
145
TODO: Check it's reasonably well-formed.
146
"""
147
v = _get_user_id(branch)
148
if v:
149
return v
150
151
name, email = _auto_user_id()
152
if name:
153
return '%s <%s>' % (name, email)
154
else:
155
return email
156
157
158
def user_email(branch):
159
"""Return just the email component of a username."""
160
e = _get_user_id(branch)
161
if e:
162
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
163
if not m:
164
raise BzrError("%r doesn't seem to contain "
165
"a reasonable email address" % e)
166
return m.group(0)
167
168
return _auto_user_id()[1]
169
170
Loggerhead is a web-based interface for Breezy
Version: 2.0.1