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
$BZR_EMAIL can be set to override this (as well as the
171
deprecated $BZREMAIL), then
172
the concrete policy type is checked, and finally
174
If none is found, a reasonable default is (hopefully)
177
TODO: Check it's reasonably well-formed.
179
v = os.environ.get('BZR_EMAIL')
181
return v.decode(bzrlib.user_encoding)
182
v = os.environ.get('BZREMAIL')
184
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
185
return v.decode(bzrlib.user_encoding)
187
v = self._get_user_id()
191
v = os.environ.get('EMAIL')
193
return v.decode(bzrlib.user_encoding)
195
name, email = _auto_user_id()
197
return '%s <%s>' % (name, email)
201
def signature_checking(self):
202
"""What is the current policy for signature checking?."""
203
policy = self._get_signature_checking()
204
if policy is not None:
206
return CHECK_IF_POSSIBLE
208
def signing_policy(self):
209
"""What is the current policy for signature checking?."""
210
policy = self._get_signing_policy()
211
if policy is not None:
213
return SIGN_WHEN_REQUIRED
215
def signature_needed(self):
216
"""Is a signature needed when committing ?."""
217
policy = self._get_signing_policy()
219
policy = self._get_signature_checking()
220
if policy is not None:
221
warning("Please use create_signatures, not check_signatures "
222
"to set signing policy.")
223
if policy == CHECK_ALWAYS:
225
elif policy == SIGN_ALWAYS:
229
def get_alias(self, value):
230
return self._get_alias(value)
232
def _get_alias(self, value):
235
def get_nickname(self):
236
return self._get_nickname()
238
def _get_nickname(self):
242
class IniBasedConfig(Config):
243
"""A configuration policy that draws from ini files."""
245
def _get_parser(self, file=None):
246
if self._parser is not None:
249
input = self._get_filename()
253
self._parser = ConfigObj(input, encoding='utf-8')
254
except configobj.ConfigObjError, e:
255
raise errors.ParseConfigError(e.errors, e.config.filename)
258
def _get_section(self):
259
"""Override this to define the section used by the config."""
262
def _get_signature_checking(self):
263
"""See Config._get_signature_checking."""
264
policy = self._get_user_option('check_signatures')
266
return self._string_to_signature_policy(policy)
268
def _get_signing_policy(self):
269
"""See Config._get_signing_policy"""
270
policy = self._get_user_option('create_signatures')
272
return self._string_to_signing_policy(policy)
274
def _get_user_id(self):
275
"""Get the user id from the 'email' key in the current section."""
276
return self._get_user_option('email')
278
def _get_user_option(self, option_name):
279
"""See Config._get_user_option."""
281
return self._get_parser().get_value(self._get_section(),
286
def _gpg_signing_command(self):
287
"""See Config.gpg_signing_command."""
288
return self._get_user_option('gpg_signing_command')
290
def _log_format(self):
291
"""See Config.log_format."""
292
return self._get_user_option('log_format')
294
def __init__(self, get_filename):
295
super(IniBasedConfig, self).__init__()
296
self._get_filename = get_filename
299
def _post_commit(self):
300
"""See Config.post_commit."""
301
return self._get_user_option('post_commit')
303
def _string_to_signature_policy(self, signature_string):
304
"""Convert a string to a signing policy."""
305
if signature_string.lower() == 'check-available':
306
return CHECK_IF_POSSIBLE
307
if signature_string.lower() == 'ignore':
309
if signature_string.lower() == 'require':
311
raise errors.BzrError("Invalid signatures policy '%s'"
314
def _string_to_signing_policy(self, signature_string):
315
"""Convert a string to a signing policy."""
316
if signature_string.lower() == 'when-required':
317
return SIGN_WHEN_REQUIRED
318
if signature_string.lower() == 'never':
320
if signature_string.lower() == 'always':
322
raise errors.BzrError("Invalid signing policy '%s'"
325
def _get_alias(self, value):
327
return self._get_parser().get_value("ALIASES",
332
def _get_nickname(self):
333
return self.get_user_option('nickname')
336
class GlobalConfig(IniBasedConfig):
337
"""The configuration that should be used for a specific location."""
339
def get_editor(self):
340
return self._get_user_option('editor')
343
super(GlobalConfig, self).__init__(config_filename)
345
def set_user_option(self, option, value):
346
"""Save option and its value in the configuration."""
347
# FIXME: RBC 20051029 This should refresh the parser and also take a
348
# file lock on bazaar.conf.
349
conf_dir = os.path.dirname(self._get_filename())
350
ensure_config_dir_exists(conf_dir)
351
if 'DEFAULT' not in self._get_parser():
352
self._get_parser()['DEFAULT'] = {}
353
self._get_parser()['DEFAULT'][option] = value
354
f = open(self._get_filename(), 'wb')
355
self._get_parser().write(f)
359
class LocationConfig(IniBasedConfig):
360
"""A configuration object that gives the policy for a location."""
362
def __init__(self, location):
363
name_generator = locations_config_filename
364
if (not os.path.exists(name_generator()) and
365
os.path.exists(branches_config_filename())):
366
if sys.platform == 'win32':
367
warning('Please rename %s to %s'
368
% (branches_config_filename(),
369
locations_config_filename()))
371
warning('Please rename ~/.bazaar/branches.conf'
372
' to ~/.bazaar/locations.conf')
373
name_generator = branches_config_filename
374
super(LocationConfig, self).__init__(name_generator)
375
self.location = location
377
def _get_section(self):
378
"""Get the section we should look in for config items.
380
Returns None if none exists.
381
TODO: perhaps return a NullSection that thunks through to the
384
sections = self._get_parser()
385
location_names = self.location.split('/')
386
if self.location.endswith('/'):
387
del location_names[-1]
389
for section in sections:
390
section_names = section.split('/')
391
if section.endswith('/'):
392
del section_names[-1]
393
names = zip(location_names, section_names)
396
if not fnmatch(name[0], name[1]):
401
# so, for the common prefix they matched.
402
# if section is longer, no match.
403
if len(section_names) > len(location_names):
405
# if path is longer, and recurse is not true, no match
406
if len(section_names) < len(location_names):
408
if not self._get_parser()[section].as_bool('recurse'):
412
matches.append((len(section_names), section))
415
matches.sort(reverse=True)
418
def set_user_option(self, option, value):
419
"""Save option and its value in the configuration."""
420
# FIXME: RBC 20051029 This should refresh the parser and also take a
421
# file lock on locations.conf.
422
conf_dir = os.path.dirname(self._get_filename())
423
ensure_config_dir_exists(conf_dir)
424
location = self.location
425
if location.endswith('/'):
426
location = location[:-1]
427
if (not location in self._get_parser() and
428
not location + '/' in self._get_parser()):
429
self._get_parser()[location]={}
430
elif location + '/' in self._get_parser():
431
location = location + '/'
432
self._get_parser()[location][option]=value
433
self._get_parser().write(file(self._get_filename(), 'wb'))
436
class BranchConfig(Config):
437
"""A configuration object giving the policy for a branch."""
439
def _get_branch_data_config(self):
440
if self._branch_data_config is None:
441
self._branch_data_config = TreeConfig(self.branch)
442
return self._branch_data_config
444
def _get_location_config(self):
445
if self._location_config is None:
446
self._location_config = LocationConfig(self.branch.base)
447
return self._location_config
449
def _get_global_config(self):
450
if self._global_config is None:
451
self._global_config = GlobalConfig()
452
return self._global_config
454
def _get_best_value(self, option_name):
455
"""This returns a user option from local, tree or global config.
457
They are tried in that order. Use get_safe_value if trusted values
460
for source in self.option_sources:
461
value = getattr(source(), option_name)()
462
if value is not None:
466
def _get_safe_value(self, option_name):
467
"""This variant of get_best_value never returns untrusted values.
469
It does not return values from the branch data, because the branch may
470
not be controlled by the user.
472
We may wish to allow locations.conf to control whether branches are
473
trusted in the future.
475
for source in (self._get_location_config, self._get_global_config):
476
value = getattr(source(), option_name)()
477
if value is not None:
481
def _get_user_id(self):
482
"""Return the full user id for the branch.
484
e.g. "John Hacker <jhacker@foo.org>"
485
This is looked up in the email controlfile for the branch.
488
return (self.branch.control_files.get_utf8("email")
490
.decode(bzrlib.user_encoding)
492
except errors.NoSuchFile, e:
495
return self._get_best_value('_get_user_id')
497
def _get_signature_checking(self):
498
"""See Config._get_signature_checking."""
499
return self._get_best_value('_get_signature_checking')
501
def _get_signing_policy(self):
502
"""See Config._get_signing_policy."""
503
return self._get_best_value('_get_signing_policy')
505
def _get_user_option(self, option_name):
506
"""See Config._get_user_option."""
507
for source in self.option_sources:
508
value = source()._get_user_option(option_name)
509
if value is not None:
513
def set_user_option(self, name, value, local=False):
515
self._get_location_config().set_user_option(name, value)
517
self._get_branch_data_config().set_option(value, name)
520
def _gpg_signing_command(self):
521
"""See Config.gpg_signing_command."""
522
return self._get_safe_value('_gpg_signing_command')
524
def __init__(self, branch):
525
super(BranchConfig, self).__init__()
526
self._location_config = None
527
self._branch_data_config = None
528
self._global_config = None
530
self.option_sources = (self._get_location_config,
531
self._get_branch_data_config,
532
self._get_global_config)
534
def _post_commit(self):
535
"""See Config.post_commit."""
536
return self._get_safe_value('_post_commit')
538
def _get_nickname(self):
539
value = self._get_explicit_nickname()
540
if value is not None:
542
return self.branch.base.split('/')[-2]
544
def has_explicit_nickname(self):
545
"""Return true if a nickname has been explicitly assigned."""
546
return self._get_explicit_nickname() is not None
548
def _get_explicit_nickname(self):
549
return self._get_best_value('_get_nickname')
551
def _log_format(self):
552
"""See Config.log_format."""
553
return self._get_best_value('_log_format')
556
def ensure_config_dir_exists(path=None):
557
"""Make sure a configuration directory exists.
558
This makes sure that the directory exists.
559
On windows, since configuration directories are 2 levels deep,
560
it makes sure both the directory and the parent directory exists.
564
if not os.path.isdir(path):
565
if sys.platform == 'win32':
566
parent_dir = os.path.dirname(path)
567
if not os.path.isdir(parent_dir):
568
mutter('creating config parent directory: %r', parent_dir)
570
mutter('creating config directory: %r', path)
575
"""Return per-user configuration directory.
577
By default this is ~/.bazaar/
579
TODO: Global option --config-dir to override this.
581
base = os.environ.get('BZR_HOME', None)
582
if sys.platform == 'win32':
584
base = os.environ.get('APPDATA', None)
586
base = os.environ.get('HOME', None)
588
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
589
return pathjoin(base, 'bazaar', '2.0')
591
# cygwin, linux, and darwin all have a $HOME directory
593
base = os.path.expanduser("~")
594
return pathjoin(base, ".bazaar")
597
def config_filename():
598
"""Return per-user configuration ini file filename."""
599
return pathjoin(config_dir(), 'bazaar.conf')
602
def branches_config_filename():
603
"""Return per-user configuration ini file filename."""
604
return pathjoin(config_dir(), 'branches.conf')
607
def locations_config_filename():
608
"""Return per-user configuration ini file filename."""
609
return pathjoin(config_dir(), 'locations.conf')
613
"""Calculate automatic user identification.
615
Returns (realname, email).
617
Only used when none is set in the environment or the id file.
619
This previously used the FQDN as the default domain, but that can
620
be very slow on machines where DNS is broken. So now we simply
625
# XXX: Any good way to get real user name on win32?
630
w = pwd.getpwuid(uid)
632
# we try utf-8 first, because on many variants (like Linux),
633
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
634
# false positives. (many users will have their user encoding set to
635
# latin-1, which cannot raise UnicodeError.)
637
gecos = w.pw_gecos.decode('utf-8')
641
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
642
encoding = bzrlib.user_encoding
644
raise errors.BzrCommandError('Unable to determine your name. '
645
'Use "bzr whoami" to set it.')
647
username = w.pw_name.decode(encoding)
649
raise errors.BzrCommandError('Unable to determine your name. '
650
'Use "bzr whoami" to set it.')
652
comma = gecos.find(',')
656
realname = gecos[:comma]
663
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
664
except UnicodeDecodeError:
665
raise errors.BzrError("Can't decode username as %s." % \
666
bzrlib.user_encoding)
668
return realname, (username + '@' + socket.gethostname())
671
def extract_email_address(e):
672
"""Return just the address part of an email string.
674
That is just the user@domain part, nothing else.
675
This part is required to contain only ascii characters.
676
If it can't be extracted, raises an error.
678
>>> extract_email_address('Jane Tester <jane@test.com>')
681
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
683
raise errors.BzrError("%r doesn't seem to contain "
684
"a reasonable email address" % e)
688
class TreeConfig(IniBasedConfig):
689
"""Branch configuration data associated with its contents, not location"""
690
def __init__(self, branch):
693
def _get_parser(self, file=None):
695
return IniBasedConfig._get_parser(file)
696
return self._get_config()
698
def _get_config(self):
700
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
702
except errors.NoSuchFile:
703
obj = ConfigObj(encoding='utf=8')
706
def get_option(self, name, section=None, default=None):
707
self.branch.lock_read()
709
obj = self._get_config()
711
if section is not None:
720
def set_option(self, value, name, section=None):
721
"""Set a per-branch configuration option"""
722
self.branch.lock_write()
724
cfg_obj = self._get_config()
729
obj = cfg_obj[section]
731
cfg_obj[section] = {}
732
obj = cfg_obj[section]
734
out_file = StringIO()
735
cfg_obj.write(out_file)
737
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
