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."""
137
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
139
raise BzrError("%r doesn't seem to contain "
140
"a reasonable email address" % e)
144
"""Return email-style username.
146
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
148
$BZREMAIL can be set to override this, then
149
the concrete policy type is checked, and finally
151
but if none is found, a reasonable default is (hopefully)
154
TODO: Check it's reasonably well-formed.
156
v = os.environ.get('BZREMAIL')
158
return v.decode(bzrlib.user_encoding)
160
v = self._get_user_id()
164
v = os.environ.get('EMAIL')
166
return v.decode(bzrlib.user_encoding)
168
name, email = _auto_user_id()
170
return '%s <%s>' % (name, email)
174
def signature_checking(self):
175
"""What is the current policy for signature checking?."""
176
policy = self._get_signature_checking()
177
if policy is not None:
179
return CHECK_IF_POSSIBLE
181
def signature_needed(self):
182
"""Is a signature needed when committing ?."""
183
policy = self._get_signature_checking()
184
if policy == CHECK_ALWAYS:
189
class IniBasedConfig(Config):
190
"""A configuration policy that draws from ini files."""
192
def _get_parser(self, file=None):
193
if self._parser is not None:
196
input = self._get_filename()
200
self._parser = ConfigObj(input)
201
except configobj.ConfigObjError, e:
202
raise errors.ParseConfigError(e.errors, e.config.filename)
205
def _get_section(self):
206
"""Override this to define the section used by the config."""
209
def _get_signature_checking(self):
210
"""See Config._get_signature_checking."""
211
policy = self._get_user_option('check_signatures')
213
return self._string_to_signature_policy(policy)
215
def _get_user_id(self):
216
"""Get the user id from the 'email' key in the current section."""
217
return self._get_user_option('email')
219
def _get_user_option(self, option_name):
220
"""See Config._get_user_option."""
222
return self._get_parser().get_value(self._get_section(),
227
def _gpg_signing_command(self):
228
"""See Config.gpg_signing_command."""
229
return self._get_user_option('gpg_signing_command')
231
def __init__(self, get_filename):
232
super(IniBasedConfig, self).__init__()
233
self._get_filename = get_filename
236
def _post_commit(self):
237
"""See Config.post_commit."""
238
return self._get_user_option('post_commit')
240
def _string_to_signature_policy(self, signature_string):
241
"""Convert a string to a signing policy."""
242
if signature_string.lower() == 'check-available':
243
return CHECK_IF_POSSIBLE
244
if signature_string.lower() == 'ignore':
246
if signature_string.lower() == 'require':
248
raise errors.BzrError("Invalid signatures policy '%s'"
252
class GlobalConfig(IniBasedConfig):
253
"""The configuration that should be used for a specific location."""
255
def get_editor(self):
256
return self._get_user_option('editor')
259
super(GlobalConfig, self).__init__(config_filename)
262
class LocationConfig(IniBasedConfig):
263
"""A configuration object that gives the policy for a location."""
265
def __init__(self, location):
266
super(LocationConfig, self).__init__(branches_config_filename)
267
self._global_config = None
268
self.location = location
270
def _get_global_config(self):
271
if self._global_config is None:
272
self._global_config = GlobalConfig()
273
return self._global_config
275
def _get_section(self):
276
"""Get the section we should look in for config items.
278
Returns None if none exists.
279
TODO: perhaps return a NullSection that thunks through to the
282
sections = self._get_parser()
283
location_names = self.location.split('/')
284
if self.location.endswith('/'):
285
del location_names[-1]
287
for section in sections:
288
section_names = section.split('/')
289
if section.endswith('/'):
290
del section_names[-1]
291
names = zip(location_names, section_names)
294
if not fnmatch(name[0], name[1]):
299
# so, for the common prefix they matched.
300
# if section is longer, no match.
301
if len(section_names) > len(location_names):
303
# if path is longer, and recurse is not true, no match
304
if len(section_names) < len(location_names):
306
if not self._get_parser().get_bool(section, 'recurse'):
310
matches.append((len(section_names), section))
313
matches.sort(reverse=True)
316
def _gpg_signing_command(self):
317
"""See Config.gpg_signing_command."""
318
command = super(LocationConfig, self)._gpg_signing_command()
319
if command is not None:
321
return self._get_global_config()._gpg_signing_command()
323
def _get_user_id(self):
324
user_id = super(LocationConfig, self)._get_user_id()
325
if user_id is not None:
327
return self._get_global_config()._get_user_id()
329
def _get_user_option(self, option_name):
330
"""See Config._get_user_option."""
331
option_value = super(LocationConfig,
332
self)._get_user_option(option_name)
333
if option_value is not None:
335
return self._get_global_config()._get_user_option(option_name)
337
def _get_signature_checking(self):
338
"""See Config._get_signature_checking."""
339
check = super(LocationConfig, self)._get_signature_checking()
340
if check is not None:
342
return self._get_global_config()._get_signature_checking()
344
def _post_commit(self):
345
"""See Config.post_commit."""
346
hook = self._get_user_option('post_commit')
349
return self._get_global_config()._post_commit()
351
def set_user_option(self, option, value):
352
"""Save option and its value in the configuration."""
353
# FIXME: RBC 20051029 This should refresh the parser and also take a
354
# file lock on branches.conf.
355
if not os.path.isdir(os.path.dirname(self._get_filename())):
356
os.mkdir(os.path.dirname(self._get_filename()))
357
location = self.location
358
if location.endswith('/'):
359
location = location[:-1]
360
if (not location in self._get_parser() and
361
not location + '/' in self._get_parser()):
362
self._get_parser()[location]={}
363
elif location + '/' in self._get_parser():
364
location = location + '/'
365
self._get_parser()[location][option]=value
366
self._get_parser().write()
369
class BranchConfig(Config):
370
"""A configuration object giving the policy for a branch."""
372
def _get_location_config(self):
373
if self._location_config is None:
374
self._location_config = LocationConfig(self.branch.base)
375
return self._location_config
377
def _get_user_id(self):
378
"""Return the full user id for the branch.
380
e.g. "John Hacker <jhacker@foo.org>"
381
This is looked up in the email controlfile for the branch.
384
return (self.branch.controlfile("email", "r")
386
.decode(bzrlib.user_encoding)
388
except errors.NoSuchFile, e:
391
return self._get_location_config()._get_user_id()
393
def _get_signature_checking(self):
394
"""See Config._get_signature_checking."""
395
return self._get_location_config()._get_signature_checking()
397
def _get_user_option(self, option_name):
398
"""See Config._get_user_option."""
399
return self._get_location_config()._get_user_option(option_name)
401
def _gpg_signing_command(self):
402
"""See Config.gpg_signing_command."""
403
return self._get_location_config()._gpg_signing_command()
405
def __init__(self, branch):
406
super(BranchConfig, self).__init__()
407
self._location_config = None
410
def _post_commit(self):
411
"""See Config.post_commit."""
412
return self._get_location_config()._post_commit()
416
"""Return per-user configuration directory.
418
By default this is ~/.bazaar/
420
TODO: Global option --config-dir to override this.
422
return os.path.join(os.path.expanduser("~"), ".bazaar")
425
def config_filename():
426
"""Return per-user configuration ini file filename."""
427
return os.path.join(config_dir(), 'bazaar.conf')
430
def branches_config_filename():
431
"""Return per-user configuration ini file filename."""
432
return os.path.join(config_dir(), 'branches.conf')
436
"""Calculate automatic user identification.
438
Returns (realname, email).
440
Only used when none is set in the environment or the id file.
442
This previously used the FQDN as the default domain, but that can
443
be very slow on machines where DNS is broken. So now we simply
448
# XXX: Any good way to get real user name on win32?
453
w = pwd.getpwuid(uid)
454
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
455
username = w.pw_name.decode(bzrlib.user_encoding)
456
comma = gecos.find(',')
460
realname = gecos[:comma]
466
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
468
return realname, (username + '@' + socket.gethostname())
471
def extract_email_address(e):
472
"""Return just the address part of an email string.
474
That is just the user@domain part, nothing else.
475
This part is required to contain only ascii characters.
476
If it can't be extracted, raises an error.
478
>>> extract_email_address('Jane Tester <jane@test.com>')
481
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
483
raise BzrError("%r doesn't seem to contain "
484
"a reasonable email address" % e)
487
class TreeConfig(object):
488
"""Branch configuration data associated with its contents, not location"""
489
def __init__(self, branch):
492
def _get_config(self):
494
obj = ConfigObj(self.branch.controlfile('branch.conf',
496
except errors.NoSuchFile:
500
def get_option(self, name, section=None, default=None):
501
self.branch.lock_read()
503
obj = self._get_config()
505
if section is not None:
514
def set_option(self, value, name, section=None):
515
"""Set a per-branch configuration option"""
516
self.branch.lock_write()
518
cfg_obj = self._get_config()
523
obj = cfg_obj[section]
525
cfg_obj[section] = {}
526
obj = cfg_obj[section]
528
out_file = StringIO(''.join([l+'\n' for l in cfg_obj.write()]))
530
self.branch.put_controlfile('branch.conf', out_file, encode=True)
added
removed
bzrlib/config.py
