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
30
log_format=name-of-format
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
36
[/home/robertc/source]
37
recurse=False|True(default)
39
check_signatures= as abive
40
create_signatures= as above.
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
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.
52
NB: This option is planned, but not implemented yet.
53
log_format - This options set the default log format. Options are long,
54
short, line, or a plugin can register new formats
61
from fnmatch import fnmatch
65
import bzrlib.errors as errors
66
from bzrlib.osutils import pathjoin
67
from bzrlib.trace import mutter
68
import bzrlib.util.configobj.configobj as configobj
69
from StringIO import StringIO
76
class ConfigObj(configobj.ConfigObj):
78
def get_bool(self, section, key):
79
val = self[section][key].lower()
80
if val in ('1', 'yes', 'true', 'on'):
82
elif val in ('0', 'no', 'false', 'off'):
85
raise ValueError("Value %r is not boolean" % val)
87
def get_value(self, section, name):
88
# Try [] for the old DEFAULT section.
89
if section == "DEFAULT":
94
return self[section][name]
98
"""A configuration policy - what username, editor, gpg needs etc."""
100
def get_editor(self):
101
"""Get the users pop up editor."""
102
raise NotImplementedError
104
def _get_signature_checking(self):
105
"""Template method to override signature checking policy."""
107
def _get_user_option(self, option_name):
108
"""Template method to provide a user option."""
111
def get_user_option(self, option_name):
112
"""Get a generic option - no special process, no default."""
113
return self._get_user_option(option_name)
115
def gpg_signing_command(self):
116
"""What program should be used to sign signatures?"""
117
result = self._gpg_signing_command()
122
def _gpg_signing_command(self):
123
"""See gpg_signing_command()."""
126
def log_formatter(self):
127
"""What log formatter should be used"""
128
result = self._log_formatter()
131
mutter('debug ' + result)
135
def _log_formatter(self):
136
"""See log_formatter()."""
141
super(Config, self).__init__()
143
def post_commit(self):
144
"""An ordered list of python functions to call.
146
Each function takes branch, rev_id as parameters.
148
return self._post_commit()
150
def _post_commit(self):
151
"""See Config.post_commit."""
154
def user_email(self):
155
"""Return just the email component of a username."""
156
return extract_email_address(self.username())
159
"""Return email-style username.
161
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
163
$BZREMAIL can be set to override this, then
164
the concrete policy type is checked, and finally
166
If none is found, a reasonable default is (hopefully)
169
TODO: Check it's reasonably well-formed.
171
v = os.environ.get('BZREMAIL')
173
return v.decode(bzrlib.user_encoding)
175
v = self._get_user_id()
179
v = os.environ.get('EMAIL')
181
return v.decode(bzrlib.user_encoding)
183
name, email = _auto_user_id()
185
return '%s <%s>' % (name, email)
189
def signature_checking(self):
190
"""What is the current policy for signature checking?."""
191
policy = self._get_signature_checking()
192
if policy is not None:
194
return CHECK_IF_POSSIBLE
196
def signature_needed(self):
197
"""Is a signature needed when committing ?."""
198
policy = self._get_signature_checking()
199
if policy == CHECK_ALWAYS:
204
class IniBasedConfig(Config):
205
"""A configuration policy that draws from ini files."""
207
def _get_parser(self, file=None):
208
if self._parser is not None:
211
input = self._get_filename()
215
self._parser = ConfigObj(input)
216
except configobj.ConfigObjError, e:
217
raise errors.ParseConfigError(e.errors, e.config.filename)
220
def _get_section(self):
221
"""Override this to define the section used by the config."""
224
def _get_signature_checking(self):
225
"""See Config._get_signature_checking."""
226
policy = self._get_user_option('check_signatures')
228
return self._string_to_signature_policy(policy)
230
def _get_user_id(self):
231
"""Get the user id from the 'email' key in the current section."""
232
return self._get_user_option('email')
234
def _get_user_option(self, option_name):
235
"""See Config._get_user_option."""
237
return self._get_parser().get_value(self._get_section(),
242
def _gpg_signing_command(self):
243
"""See Config.gpg_signing_command."""
244
return self._get_user_option('gpg_signing_command')
246
def _log_formatter(self):
247
"""See Config.log_formatter."""
249
return self._get_user_option('log_formatter')
251
def __init__(self, get_filename):
252
super(IniBasedConfig, self).__init__()
253
self._get_filename = get_filename
256
def _post_commit(self):
257
"""See Config.post_commit."""
258
return self._get_user_option('post_commit')
260
def _string_to_signature_policy(self, signature_string):
261
"""Convert a string to a signing policy."""
262
if signature_string.lower() == 'check-available':
263
return CHECK_IF_POSSIBLE
264
if signature_string.lower() == 'ignore':
266
if signature_string.lower() == 'require':
268
raise errors.BzrError("Invalid signatures policy '%s'"
272
class GlobalConfig(IniBasedConfig):
273
"""The configuration that should be used for a specific location."""
275
def get_editor(self):
276
return self._get_user_option('editor')
279
super(GlobalConfig, self).__init__(config_filename)
282
class LocationConfig(IniBasedConfig):
283
"""A configuration object that gives the policy for a location."""
285
def __init__(self, location):
286
super(LocationConfig, self).__init__(branches_config_filename)
287
self._global_config = None
288
self.location = location
290
def _get_global_config(self):
291
if self._global_config is None:
292
self._global_config = GlobalConfig()
293
return self._global_config
295
def _get_section(self):
296
"""Get the section we should look in for config items.
298
Returns None if none exists.
299
TODO: perhaps return a NullSection that thunks through to the
302
sections = self._get_parser()
303
location_names = self.location.split('/')
304
if self.location.endswith('/'):
305
del location_names[-1]
307
for section in sections:
308
section_names = section.split('/')
309
if section.endswith('/'):
310
del section_names[-1]
311
names = zip(location_names, section_names)
314
if not fnmatch(name[0], name[1]):
319
# so, for the common prefix they matched.
320
# if section is longer, no match.
321
if len(section_names) > len(location_names):
323
# if path is longer, and recurse is not true, no match
324
if len(section_names) < len(location_names):
326
if not self._get_parser().get_bool(section, 'recurse'):
330
matches.append((len(section_names), section))
333
matches.sort(reverse=True)
336
def _gpg_signing_command(self):
337
"""See Config.gpg_signing_command."""
338
command = super(LocationConfig, self)._gpg_signing_command()
339
if command is not None:
341
return self._get_global_config()._gpg_signing_command()
343
def _log_formatter(self):
344
"""See Config.log_formatter."""
345
command = super(LocationConfig, self)._log_formatter()
346
if command is not None:
348
return self._get_global_config()._log_formatter()
350
def _get_user_id(self):
351
user_id = super(LocationConfig, self)._get_user_id()
352
if user_id is not None:
354
return self._get_global_config()._get_user_id()
356
def _get_user_option(self, option_name):
357
"""See Config._get_user_option."""
358
option_value = super(LocationConfig,
359
self)._get_user_option(option_name)
360
if option_value is not None:
362
return self._get_global_config()._get_user_option(option_name)
364
def _get_signature_checking(self):
365
"""See Config._get_signature_checking."""
366
check = super(LocationConfig, self)._get_signature_checking()
367
if check is not None:
369
return self._get_global_config()._get_signature_checking()
371
def _post_commit(self):
372
"""See Config.post_commit."""
373
hook = self._get_user_option('post_commit')
376
return self._get_global_config()._post_commit()
378
def set_user_option(self, option, value):
379
"""Save option and its value in the configuration."""
380
# FIXME: RBC 20051029 This should refresh the parser and also take a
381
# file lock on branches.conf.
382
conf_dir = os.path.dirname(self._get_filename())
383
ensure_config_dir_exists(conf_dir)
384
location = self.location
385
if location.endswith('/'):
386
location = location[:-1]
387
if (not location in self._get_parser() and
388
not location + '/' in self._get_parser()):
389
self._get_parser()[location]={}
390
elif location + '/' in self._get_parser():
391
location = location + '/'
392
self._get_parser()[location][option]=value
393
self._get_parser().write()
396
class BranchConfig(Config):
397
"""A configuration object giving the policy for a branch."""
399
def _get_location_config(self):
400
if self._location_config is None:
401
self._location_config = LocationConfig(self.branch.base)
402
return self._location_config
404
def _get_user_id(self):
405
"""Return the full user id for the branch.
407
e.g. "John Hacker <jhacker@foo.org>"
408
This is looked up in the email controlfile for the branch.
411
return (self.branch.control_files.get_utf8("email")
413
.decode(bzrlib.user_encoding)
415
except errors.NoSuchFile, e:
418
return self._get_location_config()._get_user_id()
420
def _get_signature_checking(self):
421
"""See Config._get_signature_checking."""
422
return self._get_location_config()._get_signature_checking()
424
def _get_user_option(self, option_name):
425
"""See Config._get_user_option."""
426
return self._get_location_config()._get_user_option(option_name)
428
def _gpg_signing_command(self):
429
"""See Config.gpg_signing_command."""
430
return self._get_location_config()._gpg_signing_command()
432
def __init__(self, branch):
433
super(BranchConfig, self).__init__()
434
self._location_config = None
437
def _post_commit(self):
438
"""See Config.post_commit."""
439
return self._get_location_config()._post_commit()
441
def _log_formatter(self):
442
"""See Config.log_formatter."""
443
return self._get_location_config()._log_formatter()
445
def ensure_config_dir_exists(path=None):
446
"""Make sure a configuration directory exists.
447
This makes sure that the directory exists.
448
On windows, since configuration directories are 2 levels deep,
449
it makes sure both the directory and the parent directory exists.
453
if not os.path.isdir(path):
454
if sys.platform == 'win32':
455
parent_dir = os.path.dirname(path)
456
if not os.path.isdir(parent_dir):
457
mutter('creating config parent directory: %r', parent_dir)
459
mutter('creating config directory: %r', path)
464
"""Return per-user configuration directory.
466
By default this is ~/.bazaar/
468
TODO: Global option --config-dir to override this.
470
base = os.environ.get('BZR_HOME', None)
471
if sys.platform == 'win32':
473
base = os.environ.get('APPDATA', None)
475
base = os.environ.get('HOME', None)
477
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
478
return pathjoin(base, 'bazaar', '2.0')
480
# cygwin, linux, and darwin all have a $HOME directory
482
base = os.path.expanduser("~")
483
return pathjoin(base, ".bazaar")
486
def config_filename():
487
"""Return per-user configuration ini file filename."""
488
return pathjoin(config_dir(), 'bazaar.conf')
491
def branches_config_filename():
492
"""Return per-user configuration ini file filename."""
493
return pathjoin(config_dir(), 'branches.conf')
497
"""Calculate automatic user identification.
499
Returns (realname, email).
501
Only used when none is set in the environment or the id file.
503
This previously used the FQDN as the default domain, but that can
504
be very slow on machines where DNS is broken. So now we simply
509
# XXX: Any good way to get real user name on win32?
514
w = pwd.getpwuid(uid)
515
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
516
username = w.pw_name.decode(bzrlib.user_encoding)
517
comma = gecos.find(',')
521
realname = gecos[:comma]
527
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
529
return realname, (username + '@' + socket.gethostname())
532
def extract_email_address(e):
533
"""Return just the address part of an email string.
535
That is just the user@domain part, nothing else.
536
This part is required to contain only ascii characters.
537
If it can't be extracted, raises an error.
539
>>> extract_email_address('Jane Tester <jane@test.com>')
542
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
544
raise errors.BzrError("%r doesn't seem to contain "
545
"a reasonable email address" % e)
548
class TreeConfig(object):
549
"""Branch configuration data associated with its contents, not location"""
550
def __init__(self, branch):
553
def _get_config(self):
555
obj = ConfigObj(self.branch.control_files.get('branch.conf'
558
except errors.NoSuchFile:
562
def get_option(self, name, section=None, default=None):
563
self.branch.lock_read()
565
obj = self._get_config()
567
if section is not None:
576
def set_option(self, value, name, section=None):
577
"""Set a per-branch configuration option"""
578
self.branch.lock_write()
580
cfg_obj = self._get_config()
585
obj = cfg_obj[section]
587
cfg_obj[section] = {}
588
obj = cfg_obj[section]
590
cfg_obj.encode('UTF-8')
591
out_file = StringIO(''.join([l+'\n' for l in cfg_obj.write()]))
593
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
