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/locations.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 locations.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 locations.conf are overridden by the locations.conf
36
[/home/robertc/source]
37
recurse=False|True(default)
39
check_signatures= as above
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
log_format - This options set the default log format. Options are long,
53
short, line, or a plugin can register new formats
55
In bazaar.conf you can also define aliases in the ALIASES sections, example
58
lastlog=log --line -r-10..-1
59
ll=log --line -r-10..-1
66
from fnmatch import fnmatch
70
from StringIO import StringIO
73
import bzrlib.errors as errors
74
from bzrlib.osutils import pathjoin
75
from bzrlib.trace import mutter, warning
76
import bzrlib.util.configobj.configobj as configobj
89
class ConfigObj(configobj.ConfigObj):
91
def get_bool(self, section, key):
92
return self[section].as_bool(key)
94
def get_value(self, section, name):
95
# Try [] for the old DEFAULT section.
96
if section == "DEFAULT":
101
return self[section][name]
104
class Config(object):
105
"""A configuration policy - what username, editor, gpg needs etc."""
107
def get_editor(self):
108
"""Get the users pop up editor."""
109
raise NotImplementedError
111
def _get_signature_checking(self):
112
"""Template method to override signature checking policy."""
114
def _get_signing_policy(self):
115
"""Template method to override signature creation policy."""
117
def _get_user_option(self, option_name):
118
"""Template method to provide a user option."""
121
def get_user_option(self, option_name):
122
"""Get a generic option - no special process, no default."""
123
return self._get_user_option(option_name)
125
def gpg_signing_command(self):
126
"""What program should be used to sign signatures?"""
127
result = self._gpg_signing_command()
132
def _gpg_signing_command(self):
133
"""See gpg_signing_command()."""
136
def log_format(self):
137
"""What log format should be used"""
138
result = self._log_format()
143
def _log_format(self):
144
"""See log_format()."""
148
super(Config, self).__init__()
150
def post_commit(self):
151
"""An ordered list of python functions to call.
153
Each function takes branch, rev_id as parameters.
155
return self._post_commit()
157
def _post_commit(self):
158
"""See Config.post_commit."""
161
def user_email(self):
162
"""Return just the email component of a username."""
163
return extract_email_address(self.username())
166
"""Return email-style username.
168
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
170
$BZREMAIL can be set to override this, then
171
the concrete policy type is checked, and finally
173
If none is found, a reasonable default is (hopefully)
176
TODO: Check it's reasonably well-formed.
178
v = os.environ.get('BZREMAIL')
180
return v.decode(bzrlib.user_encoding)
182
v = self._get_user_id()
186
v = os.environ.get('EMAIL')
188
return v.decode(bzrlib.user_encoding)
190
name, email = _auto_user_id()
192
return '%s <%s>' % (name, email)
196
def signature_checking(self):
197
"""What is the current policy for signature checking?."""
198
policy = self._get_signature_checking()
199
if policy is not None:
201
return CHECK_IF_POSSIBLE
203
def signing_policy(self):
204
"""What is the current policy for signature checking?."""
205
policy = self._get_signing_policy()
206
if policy is not None:
208
return SIGN_WHEN_REQUIRED
210
def signature_needed(self):
211
"""Is a signature needed when committing ?."""
212
policy = self._get_signing_policy()
214
policy = self._get_signature_checking()
215
if policy is not None:
216
warning("Please use create_signatures, not check_signatures "
217
"to set signing policy.")
218
if policy == CHECK_ALWAYS:
220
elif policy == SIGN_ALWAYS:
224
def get_alias(self, value):
225
return self._get_alias(value)
227
def _get_alias(self, value):
231
class IniBasedConfig(Config):
232
"""A configuration policy that draws from ini files."""
234
def _get_parser(self, file=None):
235
if self._parser is not None:
238
input = self._get_filename()
242
self._parser = ConfigObj(input, encoding='utf-8')
243
except configobj.ConfigObjError, e:
244
raise errors.ParseConfigError(e.errors, e.config.filename)
247
def _get_section(self):
248
"""Override this to define the section used by the config."""
251
def _get_signature_checking(self):
252
"""See Config._get_signature_checking."""
253
policy = self._get_user_option('check_signatures')
255
return self._string_to_signature_policy(policy)
257
def _get_signing_policy(self):
258
"""See Config._get_signature_checking."""
259
policy = self._get_user_option('create_signatures')
261
return self._string_to_signing_policy(policy)
263
def _get_user_id(self):
264
"""Get the user id from the 'email' key in the current section."""
265
return self._get_user_option('email')
267
def _get_user_option(self, option_name):
268
"""See Config._get_user_option."""
270
return self._get_parser().get_value(self._get_section(),
275
def _gpg_signing_command(self):
276
"""See Config.gpg_signing_command."""
277
return self._get_user_option('gpg_signing_command')
279
def _log_format(self):
280
"""See Config.log_format."""
281
return self._get_user_option('log_format')
283
def __init__(self, get_filename):
284
super(IniBasedConfig, self).__init__()
285
self._get_filename = get_filename
288
def _post_commit(self):
289
"""See Config.post_commit."""
290
return self._get_user_option('post_commit')
292
def _string_to_signature_policy(self, signature_string):
293
"""Convert a string to a signing policy."""
294
if signature_string.lower() == 'check-available':
295
return CHECK_IF_POSSIBLE
296
if signature_string.lower() == 'ignore':
298
if signature_string.lower() == 'require':
300
raise errors.BzrError("Invalid signatures policy '%s'"
303
def _string_to_signing_policy(self, signature_string):
304
"""Convert a string to a signing policy."""
305
if signature_string.lower() == 'when-required':
306
return SIGN_WHEN_REQUIRED
307
if signature_string.lower() == 'never':
309
if signature_string.lower() == 'always':
311
raise errors.BzrError("Invalid signing policy '%s'"
314
def _get_alias(self, value):
316
return self._get_parser().get_value("ALIASES",
322
class GlobalConfig(IniBasedConfig):
323
"""The configuration that should be used for a specific location."""
325
def get_editor(self):
326
return self._get_user_option('editor')
329
super(GlobalConfig, self).__init__(config_filename)
332
class LocationConfig(IniBasedConfig):
333
"""A configuration object that gives the policy for a location."""
335
def __init__(self, location):
336
name_generator = locations_config_filename
337
if (not os.path.exists(name_generator()) and
338
os.path.exists(branches_config_filename())):
339
warning('Please rename branches.conf to locations.conf')
340
name_generator = branches_config_filename
341
super(LocationConfig, self).__init__(name_generator)
342
self._global_config = None
343
self.location = location
345
def _get_global_config(self):
346
if self._global_config is None:
347
self._global_config = GlobalConfig()
348
return self._global_config
350
def _get_section(self):
351
"""Get the section we should look in for config items.
353
Returns None if none exists.
354
TODO: perhaps return a NullSection that thunks through to the
357
sections = self._get_parser()
358
location_names = self.location.split('/')
359
if self.location.endswith('/'):
360
del location_names[-1]
362
for section in sections:
363
section_names = section.split('/')
364
if section.endswith('/'):
365
del section_names[-1]
366
names = zip(location_names, section_names)
369
if not fnmatch(name[0], name[1]):
374
# so, for the common prefix they matched.
375
# if section is longer, no match.
376
if len(section_names) > len(location_names):
378
# if path is longer, and recurse is not true, no match
379
if len(section_names) < len(location_names):
381
if not self._get_parser()[section].as_bool('recurse'):
385
matches.append((len(section_names), section))
388
matches.sort(reverse=True)
391
def _gpg_signing_command(self):
392
"""See Config.gpg_signing_command."""
393
command = super(LocationConfig, self)._gpg_signing_command()
394
if command is not None:
396
return self._get_global_config()._gpg_signing_command()
398
def _log_format(self):
399
"""See Config.log_format."""
400
command = super(LocationConfig, self)._log_format()
401
if command is not None:
403
return self._get_global_config()._log_format()
405
def _get_user_id(self):
406
user_id = super(LocationConfig, self)._get_user_id()
407
if user_id is not None:
409
return self._get_global_config()._get_user_id()
411
def _get_user_option(self, option_name):
412
"""See Config._get_user_option."""
413
option_value = super(LocationConfig,
414
self)._get_user_option(option_name)
415
if option_value is not None:
417
return self._get_global_config()._get_user_option(option_name)
419
def _get_signature_checking(self):
420
"""See Config._get_signature_checking."""
421
check = super(LocationConfig, self)._get_signature_checking()
422
if check is not None:
424
return self._get_global_config()._get_signature_checking()
426
def _get_signing_policy(self):
427
"""See Config._get_signing_policy."""
428
sign = super(LocationConfig, self)._get_signing_policy()
431
return self._get_global_config()._get_signing_policy()
433
def _post_commit(self):
434
"""See Config.post_commit."""
435
hook = self._get_user_option('post_commit')
438
return self._get_global_config()._post_commit()
440
def set_user_option(self, option, value):
441
"""Save option and its value in the configuration."""
442
# FIXME: RBC 20051029 This should refresh the parser and also take a
443
# file lock on locations.conf.
444
conf_dir = os.path.dirname(self._get_filename())
445
ensure_config_dir_exists(conf_dir)
446
location = self.location
447
if location.endswith('/'):
448
location = location[:-1]
449
if (not location in self._get_parser() and
450
not location + '/' in self._get_parser()):
451
self._get_parser()[location]={}
452
elif location + '/' in self._get_parser():
453
location = location + '/'
454
self._get_parser()[location][option]=value
455
self._get_parser().write(file(self._get_filename(), 'wb'))
458
class BranchConfig(Config):
459
"""A configuration object giving the policy for a branch."""
461
def _get_location_config(self):
462
if self._location_config is None:
463
self._location_config = LocationConfig(self.branch.base)
464
return self._location_config
466
def _get_user_id(self):
467
"""Return the full user id for the branch.
469
e.g. "John Hacker <jhacker@foo.org>"
470
This is looked up in the email controlfile for the branch.
473
return (self.branch.control_files.get_utf8("email")
475
.decode(bzrlib.user_encoding)
477
except errors.NoSuchFile, e:
480
return self._get_location_config()._get_user_id()
482
def _get_signature_checking(self):
483
"""See Config._get_signature_checking."""
484
return self._get_location_config()._get_signature_checking()
486
def _get_signing_policy(self):
487
"""See Config._get_signing_policy."""
488
return self._get_location_config()._get_signing_policy()
490
def _get_user_option(self, option_name):
491
"""See Config._get_user_option."""
492
return self._get_location_config()._get_user_option(option_name)
494
def _gpg_signing_command(self):
495
"""See Config.gpg_signing_command."""
496
return self._get_location_config()._gpg_signing_command()
498
def __init__(self, branch):
499
super(BranchConfig, self).__init__()
500
self._location_config = None
503
def _post_commit(self):
504
"""See Config.post_commit."""
505
return self._get_location_config()._post_commit()
507
def _log_format(self):
508
"""See Config.log_format."""
509
return self._get_location_config()._log_format()
512
def ensure_config_dir_exists(path=None):
513
"""Make sure a configuration directory exists.
514
This makes sure that the directory exists.
515
On windows, since configuration directories are 2 levels deep,
516
it makes sure both the directory and the parent directory exists.
520
if not os.path.isdir(path):
521
if sys.platform == 'win32':
522
parent_dir = os.path.dirname(path)
523
if not os.path.isdir(parent_dir):
524
mutter('creating config parent directory: %r', parent_dir)
526
mutter('creating config directory: %r', path)
531
"""Return per-user configuration directory.
533
By default this is ~/.bazaar/
535
TODO: Global option --config-dir to override this.
537
base = os.environ.get('BZR_HOME', None)
538
if sys.platform == 'win32':
540
base = os.environ.get('APPDATA', None)
542
base = os.environ.get('HOME', None)
544
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
545
return pathjoin(base, 'bazaar', '2.0')
547
# cygwin, linux, and darwin all have a $HOME directory
549
base = os.path.expanduser("~")
550
return pathjoin(base, ".bazaar")
553
def config_filename():
554
"""Return per-user configuration ini file filename."""
555
return pathjoin(config_dir(), 'bazaar.conf')
558
def branches_config_filename():
559
"""Return per-user configuration ini file filename."""
560
return pathjoin(config_dir(), 'branches.conf')
562
def locations_config_filename():
563
"""Return per-user configuration ini file filename."""
564
return pathjoin(config_dir(), 'locations.conf')
568
"""Calculate automatic user identification.
570
Returns (realname, email).
572
Only used when none is set in the environment or the id file.
574
This previously used the FQDN as the default domain, but that can
575
be very slow on machines where DNS is broken. So now we simply
580
# XXX: Any good way to get real user name on win32?
585
w = pwd.getpwuid(uid)
588
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
589
username = w.pw_name.decode(bzrlib.user_encoding)
590
except UnicodeDecodeError:
591
# We're using pwd, therefore we're on Unix, so /etc/passwd is ok.
592
raise errors.BzrError("Can't decode username in " \
593
"/etc/passwd as %s." % bzrlib.user_encoding)
595
comma = gecos.find(',')
599
realname = gecos[:comma]
606
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
607
except UnicodeDecodeError:
608
raise errors.BzrError("Can't decode username as %s." % \
609
bzrlib.user_encoding)
611
return realname, (username + '@' + socket.gethostname())
614
def extract_email_address(e):
615
"""Return just the address part of an email string.
617
That is just the user@domain part, nothing else.
618
This part is required to contain only ascii characters.
619
If it can't be extracted, raises an error.
621
>>> extract_email_address('Jane Tester <jane@test.com>')
624
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
626
raise errors.BzrError("%r doesn't seem to contain "
627
"a reasonable email address" % e)
631
class TreeConfig(object):
632
"""Branch configuration data associated with its contents, not location"""
633
def __init__(self, branch):
636
def _get_config(self):
638
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
640
except errors.NoSuchFile:
641
obj = ConfigObj(encoding='utf=8')
644
def get_option(self, name, section=None, default=None):
645
self.branch.lock_read()
647
obj = self._get_config()
649
if section is not None:
658
def set_option(self, value, name, section=None):
659
"""Set a per-branch configuration option"""
660
self.branch.lock_write()
662
cfg_obj = self._get_config()
667
obj = cfg_obj[section]
669
cfg_obj[section] = {}
670
obj = cfg_obj[section]
672
out_file = StringIO()
673
cfg_obj.write(out_file)
675
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
