1
# Copyright (C) 2005 by Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
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.
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.
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
18
"""Configuration that affects the behaviour of Bazaar.
20
Currently this configuration resides in ~/.bazaar/bazaar.conf
21
and ~/.bazaar/branches.conf, which is written to by bzr.
23
In bazaar.conf the following options may be set:
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
gpg_signing_command=name-of-program
31
in branches.conf, you specify the url of a branch and options for it.
32
Wildcards may be used - * and ? as normal in shell completion. Options
33
set in both bazaar.conf and branches.conf are overriden by the branches.conf
35
[/home/robertc/source]
36
recurse=False|True(default)
38
check_signatures= as abive
39
create_signatures= as above.
41
explanation of options
42
----------------------
43
editor - this option sets the pop up editor to use during commits.
44
email - this option sets the user id bzr will use when committing.
45
check_signatures - this option controls whether bzr will require good gpg
46
signatures, ignore them, or check them if they are
48
create_signatures - this option controls whether bzr will always create
49
gpg signatures, never create them, or create them if the
50
branch is configured to require them.
51
NB: This option is planned, but not implemented yet.
57
from fnmatch import fnmatch
61
import bzrlib.errors as errors
62
import bzrlib.util.configobj.configobj as configobj
63
from StringIO import StringIO
70
class ConfigObj(configobj.ConfigObj):
72
def get_bool(self, section, key):
73
val = self[section][key].lower()
74
if val in ('1', 'yes', 'true', 'on'):
76
elif val in ('0', 'no', 'false', 'off'):
79
raise ValueError("Value %r is not boolean" % val)
81
def get_value(self, section, name):
82
# Try [] for the old DEFAULT section.
83
if section == "DEFAULT":
88
return self[section][name]
92
"""A configuration policy - what username, editor, gpg needs etc."""
95
"""Get the users pop up editor."""
96
raise NotImplementedError
98
def _get_signature_checking(self):
99
"""Template method to override signature checking policy."""
101
def _get_user_option(self, option_name):
102
"""Template method to provide a user option."""
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)
109
def gpg_signing_command(self):
110
"""What program should be used to sign signatures?"""
111
result = self._gpg_signing_command()
116
def _gpg_signing_command(self):
117
"""See gpg_signing_command()."""
121
super(Config, self).__init__()
123
def post_commit(self):
124
"""An ordered list of python functions to call.
126
Each function takes branch, rev_id as parameters.
128
return self._post_commit()
130
def _post_commit(self):
131
"""See Config.post_commit."""
134
def user_email(self):
135
"""Return just the email component of a username."""
136
return extract_email_address(self.username())
139
"""Return email-style username.
141
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
143
$BZREMAIL can be set to override this, then
144
the concrete policy type is checked, and finally
146
If none is found, a reasonable default is (hopefully)
149
TODO: Check it's reasonably well-formed.
151
v = os.environ.get('BZREMAIL')
153
return v.decode(bzrlib.user_encoding)
155
v = self._get_user_id()
159
v = os.environ.get('EMAIL')
161
return v.decode(bzrlib.user_encoding)
163
name, email = _auto_user_id()
165
return '%s <%s>' % (name, email)
169
def signature_checking(self):
170
"""What is the current policy for signature checking?."""
171
policy = self._get_signature_checking()
172
if policy is not None:
174
return CHECK_IF_POSSIBLE
176
def signature_needed(self):
177
"""Is a signature needed when committing ?."""
178
policy = self._get_signature_checking()
179
if policy == CHECK_ALWAYS:
184
class IniBasedConfig(Config):
185
"""A configuration policy that draws from ini files."""
187
def _get_parser(self, file=None):
188
if self._parser is not None:
191
input = self._get_filename()
195
self._parser = ConfigObj(input)
196
except configobj.ConfigObjError, e:
197
raise errors.ParseConfigError(e.errors, e.config.filename)
200
def _get_section(self):
201
"""Override this to define the section used by the config."""
204
def _get_signature_checking(self):
205
"""See Config._get_signature_checking."""
206
policy = self._get_user_option('check_signatures')
208
return self._string_to_signature_policy(policy)
210
def _get_user_id(self):
211
"""Get the user id from the 'email' key in the current section."""
212
return self._get_user_option('email')
214
def _get_user_option(self, option_name):
215
"""See Config._get_user_option."""
217
return self._get_parser().get_value(self._get_section(),
222
def _gpg_signing_command(self):
223
"""See Config.gpg_signing_command."""
224
return self._get_user_option('gpg_signing_command')
226
def __init__(self, get_filename):
227
super(IniBasedConfig, self).__init__()
228
self._get_filename = get_filename
231
def _post_commit(self):
232
"""See Config.post_commit."""
233
return self._get_user_option('post_commit')
235
def _string_to_signature_policy(self, signature_string):
236
"""Convert a string to a signing policy."""
237
if signature_string.lower() == 'check-available':
238
return CHECK_IF_POSSIBLE
239
if signature_string.lower() == 'ignore':
241
if signature_string.lower() == 'require':
243
raise errors.BzrError("Invalid signatures policy '%s'"
247
class GlobalConfig(IniBasedConfig):
248
"""The configuration that should be used for a specific location."""
250
def get_editor(self):
251
return self._get_user_option('editor')
254
super(GlobalConfig, self).__init__(config_filename)
257
class LocationConfig(IniBasedConfig):
258
"""A configuration object that gives the policy for a location."""
260
def __init__(self, location):
261
super(LocationConfig, self).__init__(branches_config_filename)
262
self._global_config = None
263
self.location = location
265
def _get_global_config(self):
266
if self._global_config is None:
267
self._global_config = GlobalConfig()
268
return self._global_config
270
def _get_section(self):
271
"""Get the section we should look in for config items.
273
Returns None if none exists.
274
TODO: perhaps return a NullSection that thunks through to the
277
sections = self._get_parser()
278
location_names = self.location.split('/')
279
if self.location.endswith('/'):
280
del location_names[-1]
282
for section in sections:
283
section_names = section.split('/')
284
if section.endswith('/'):
285
del section_names[-1]
286
names = zip(location_names, section_names)
289
if not fnmatch(name[0], name[1]):
294
# so, for the common prefix they matched.
295
# if section is longer, no match.
296
if len(section_names) > len(location_names):
298
# if path is longer, and recurse is not true, no match
299
if len(section_names) < len(location_names):
301
if not self._get_parser().get_bool(section, 'recurse'):
305
matches.append((len(section_names), section))
308
matches.sort(reverse=True)
311
def _gpg_signing_command(self):
312
"""See Config.gpg_signing_command."""
313
command = super(LocationConfig, self)._gpg_signing_command()
314
if command is not None:
316
return self._get_global_config()._gpg_signing_command()
318
def _get_user_id(self):
319
user_id = super(LocationConfig, self)._get_user_id()
320
if user_id is not None:
322
return self._get_global_config()._get_user_id()
324
def _get_user_option(self, option_name):
325
"""See Config._get_user_option."""
326
option_value = super(LocationConfig,
327
self)._get_user_option(option_name)
328
if option_value is not None:
330
return self._get_global_config()._get_user_option(option_name)
332
def _get_signature_checking(self):
333
"""See Config._get_signature_checking."""
334
check = super(LocationConfig, self)._get_signature_checking()
335
if check is not None:
337
return self._get_global_config()._get_signature_checking()
339
def _post_commit(self):
340
"""See Config.post_commit."""
341
hook = self._get_user_option('post_commit')
344
return self._get_global_config()._post_commit()
346
def set_user_option(self, option, value):
347
"""Save option and its value in the configuration."""
348
# FIXME: RBC 20051029 This should refresh the parser and also take a
349
# file lock on branches.conf.
350
if not os.path.isdir(os.path.dirname(self._get_filename())):
351
os.mkdir(os.path.dirname(self._get_filename()))
352
location = self.location
353
if location.endswith('/'):
354
location = location[:-1]
355
if (not location in self._get_parser() and
356
not location + '/' in self._get_parser()):
357
self._get_parser()[location]={}
358
elif location + '/' in self._get_parser():
359
location = location + '/'
360
self._get_parser()[location][option]=value
361
self._get_parser().write()
364
class BranchConfig(Config):
365
"""A configuration object giving the policy for a branch."""
367
def _get_location_config(self):
368
if self._location_config is None:
369
self._location_config = LocationConfig(self.branch.base)
370
return self._location_config
372
def _get_user_id(self):
373
"""Return the full user id for the branch.
375
e.g. "John Hacker <jhacker@foo.org>"
376
This is looked up in the email controlfile for the branch.
379
return (self.branch.controlfile("email", "r")
381
.decode(bzrlib.user_encoding)
383
except errors.NoSuchFile, e:
386
return self._get_location_config()._get_user_id()
388
def _get_signature_checking(self):
389
"""See Config._get_signature_checking."""
390
return self._get_location_config()._get_signature_checking()
392
def _get_user_option(self, option_name):
393
"""See Config._get_user_option."""
394
return self._get_location_config()._get_user_option(option_name)
396
def _gpg_signing_command(self):
397
"""See Config.gpg_signing_command."""
398
return self._get_location_config()._gpg_signing_command()
400
def __init__(self, branch):
401
super(BranchConfig, self).__init__()
402
self._location_config = None
405
def _post_commit(self):
406
"""See Config.post_commit."""
407
return self._get_location_config()._post_commit()
411
"""Return per-user configuration directory.
413
By default this is ~/.bazaar/
415
TODO: Global option --config-dir to override this.
417
return os.path.join(os.path.expanduser("~"), ".bazaar")
420
def config_filename():
421
"""Return per-user configuration ini file filename."""
422
return os.path.join(config_dir(), 'bazaar.conf')
425
def branches_config_filename():
426
"""Return per-user configuration ini file filename."""
427
return os.path.join(config_dir(), 'branches.conf')
431
"""Calculate automatic user identification.
433
Returns (realname, email).
435
Only used when none is set in the environment or the id file.
437
This previously used the FQDN as the default domain, but that can
438
be very slow on machines where DNS is broken. So now we simply
443
# XXX: Any good way to get real user name on win32?
448
w = pwd.getpwuid(uid)
449
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
450
username = w.pw_name.decode(bzrlib.user_encoding)
451
comma = gecos.find(',')
455
realname = gecos[:comma]
461
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
463
return realname, (username + '@' + socket.gethostname())
466
def extract_email_address(e):
467
"""Return just the address part of an email string.
469
That is just the user@domain part, nothing else.
470
This part is required to contain only ascii characters.
471
If it can't be extracted, raises an error.
473
>>> extract_email_address('Jane Tester <jane@test.com>')
476
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
478
raise errors.BzrError("%r doesn't seem to contain "
479
"a reasonable email address" % e)
482
class TreeConfig(object):
483
"""Branch configuration data associated with its contents, not location"""
484
def __init__(self, branch):
487
def _get_config(self):
489
obj = ConfigObj(self.branch.controlfile('branch.conf',
492
except errors.NoSuchFile:
496
def get_option(self, name, section=None, default=None):
497
self.branch.lock_read()
499
obj = self._get_config()
501
if section is not None:
510
def set_option(self, value, name, section=None):
511
"""Set a per-branch configuration option"""
512
self.branch.lock_write()
514
cfg_obj = self._get_config()
519
obj = cfg_obj[section]
521
cfg_obj[section] = {}
522
obj = cfg_obj[section]
524
cfg_obj.encode('UTF-8')
525
out_file = StringIO(''.join([l+'\n' for l in cfg_obj.write()]))
527
self.branch.put_controlfile('branch.conf', out_file, encode=False)
added
removed
bzrlib/config.py
