1
# Copyright (C) 2005, 2007 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
5
# This program is free software; you can redistribute it and/or modify
6
# it under the terms of the GNU General Public License as published by
7
# the Free Software Foundation; either version 2 of the License, or
8
# (at your option) any later version.
10
# This program is distributed in the hope that it will be useful,
11
# but WITHOUT ANY WARRANTY; without even the implied warranty of
12
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
# GNU General Public License for more details.
15
# You should have received a copy of the GNU General Public License
16
# along with this program; if not, write to the Free Software
17
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19
"""Configuration that affects the behaviour of Bazaar.
21
Currently this configuration resides in ~/.bazaar/bazaar.conf
22
and ~/.bazaar/locations.conf, which is written to by bzr.
24
In bazaar.conf the following options may be set:
26
editor=name-of-program
27
email=Your Name <your@email.address>
28
check_signatures=require|ignore|check-available(default)
29
create_signatures=always|never|when-required(default)
30
gpg_signing_command=name-of-program
31
log_format=name-of-format
33
in locations.conf, you specify the url of a branch and options for it.
34
Wildcards may be used - * and ? as normal in shell completion. Options
35
set in both bazaar.conf and locations.conf are overridden by the locations.conf
37
[/home/robertc/source]
38
recurse=False|True(default)
40
check_signatures= as above
41
create_signatures= as above.
43
explanation of options
44
----------------------
45
editor - this option sets the pop up editor to use during commits.
46
email - this option sets the user id bzr will use when committing.
47
check_signatures - this option controls whether bzr will require good gpg
48
signatures, ignore them, or check them if they are
50
create_signatures - this option controls whether bzr will always create
51
gpg signatures, never create them, or create them if the
52
branch is configured to require them.
53
log_format - this option sets the default log format. Possible values are
54
long, short, line, or a plugin can register new formats.
56
In bazaar.conf you can also define aliases in the ALIASES sections, example
59
lastlog=log --line -r-10..-1
60
ll=log --line -r-10..-1
68
from bzrlib.lazy_import import lazy_import
69
lazy_import(globals(), """
71
from fnmatch import fnmatch
73
from StringIO import StringIO
85
import bzrlib.util.configobj.configobj as configobj
88
from bzrlib.trace import mutter, warning
103
POLICY_APPENDPATH = 2
107
POLICY_NORECURSE: 'norecurse',
108
POLICY_APPENDPATH: 'appendpath',
113
'norecurse': POLICY_NORECURSE,
114
'appendpath': POLICY_APPENDPATH,
118
STORE_LOCATION = POLICY_NONE
119
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
120
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
125
class ConfigObj(configobj.ConfigObj):
127
def get_bool(self, section, key):
128
return self[section].as_bool(key)
130
def get_value(self, section, name):
131
# Try [] for the old DEFAULT section.
132
if section == "DEFAULT":
137
return self[section][name]
140
class Config(object):
141
"""A configuration policy - what username, editor, gpg needs etc."""
143
def get_editor(self):
144
"""Get the users pop up editor."""
145
raise NotImplementedError
147
def get_mail_client(self):
148
"""Get a mail client to use"""
149
selected_client = self.get_user_option('mail_client')
151
mail_client_class = {
152
None: mail_client.DefaultMail,
153
'default': mail_client.DefaultMail,
154
'editor': mail_client.Editor,
155
'evolution': mail_client.Evolution,
156
'kmail': mail_client.KMail,
157
'mapi': mail_client.MAPIClient,
158
'mutt': mail_client.Mutt,
159
'thunderbird': mail_client.Thunderbird,
160
'xdg-email': mail_client.XDGEmail,
163
raise errors.UnknownMailClient(selected_client)
164
return mail_client_class(self)
166
def _get_signature_checking(self):
167
"""Template method to override signature checking policy."""
169
def _get_signing_policy(self):
170
"""Template method to override signature creation policy."""
172
def _get_user_option(self, option_name):
173
"""Template method to provide a user option."""
176
def get_user_option(self, option_name):
177
"""Get a generic option - no special process, no default."""
178
return self._get_user_option(option_name)
180
def gpg_signing_command(self):
181
"""What program should be used to sign signatures?"""
182
result = self._gpg_signing_command()
187
def _gpg_signing_command(self):
188
"""See gpg_signing_command()."""
191
def log_format(self):
192
"""What log format should be used"""
193
result = self._log_format()
198
def _log_format(self):
199
"""See log_format()."""
203
super(Config, self).__init__()
205
def post_commit(self):
206
"""An ordered list of python functions to call.
208
Each function takes branch, rev_id as parameters.
210
return self._post_commit()
212
def _post_commit(self):
213
"""See Config.post_commit."""
216
def user_email(self):
217
"""Return just the email component of a username."""
218
return extract_email_address(self.username())
221
"""Return email-style username.
223
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
225
$BZR_EMAIL can be set to override this (as well as the
226
deprecated $BZREMAIL), then
227
the concrete policy type is checked, and finally
229
If none is found, a reasonable default is (hopefully)
232
TODO: Check it's reasonably well-formed.
234
v = os.environ.get('BZR_EMAIL')
236
return v.decode(bzrlib.user_encoding)
237
v = os.environ.get('BZREMAIL')
239
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
240
return v.decode(bzrlib.user_encoding)
242
v = self._get_user_id()
246
v = os.environ.get('EMAIL')
248
return v.decode(bzrlib.user_encoding)
250
name, email = _auto_user_id()
252
return '%s <%s>' % (name, email)
256
def signature_checking(self):
257
"""What is the current policy for signature checking?."""
258
policy = self._get_signature_checking()
259
if policy is not None:
261
return CHECK_IF_POSSIBLE
263
def signing_policy(self):
264
"""What is the current policy for signature checking?."""
265
policy = self._get_signing_policy()
266
if policy is not None:
268
return SIGN_WHEN_REQUIRED
270
def signature_needed(self):
271
"""Is a signature needed when committing ?."""
272
policy = self._get_signing_policy()
274
policy = self._get_signature_checking()
275
if policy is not None:
276
warning("Please use create_signatures, not check_signatures "
277
"to set signing policy.")
278
if policy == CHECK_ALWAYS:
280
elif policy == SIGN_ALWAYS:
284
def get_alias(self, value):
285
return self._get_alias(value)
287
def _get_alias(self, value):
290
def get_nickname(self):
291
return self._get_nickname()
293
def _get_nickname(self):
297
class IniBasedConfig(Config):
298
"""A configuration policy that draws from ini files."""
300
def _get_parser(self, file=None):
301
if self._parser is not None:
304
input = self._get_filename()
308
self._parser = ConfigObj(input, encoding='utf-8')
309
except configobj.ConfigObjError, e:
310
raise errors.ParseConfigError(e.errors, e.config.filename)
313
def _get_matching_sections(self):
314
"""Return an ordered list of (section_name, extra_path) pairs.
316
If the section contains inherited configuration, extra_path is
317
a string containing the additional path components.
319
section = self._get_section()
320
if section is not None:
321
return [(section, '')]
325
def _get_section(self):
326
"""Override this to define the section used by the config."""
329
def _get_option_policy(self, section, option_name):
330
"""Return the policy for the given (section, option_name) pair."""
333
def _get_signature_checking(self):
334
"""See Config._get_signature_checking."""
335
policy = self._get_user_option('check_signatures')
337
return self._string_to_signature_policy(policy)
339
def _get_signing_policy(self):
340
"""See Config._get_signing_policy"""
341
policy = self._get_user_option('create_signatures')
343
return self._string_to_signing_policy(policy)
345
def _get_user_id(self):
346
"""Get the user id from the 'email' key in the current section."""
347
return self._get_user_option('email')
349
def _get_user_option(self, option_name):
350
"""See Config._get_user_option."""
351
for (section, extra_path) in self._get_matching_sections():
353
value = self._get_parser().get_value(section, option_name)
356
policy = self._get_option_policy(section, option_name)
357
if policy == POLICY_NONE:
359
elif policy == POLICY_NORECURSE:
360
# norecurse items only apply to the exact path
365
elif policy == POLICY_APPENDPATH:
367
value = urlutils.join(value, extra_path)
370
raise AssertionError('Unexpected config policy %r' % policy)
374
def _gpg_signing_command(self):
375
"""See Config.gpg_signing_command."""
376
return self._get_user_option('gpg_signing_command')
378
def _log_format(self):
379
"""See Config.log_format."""
380
return self._get_user_option('log_format')
382
def __init__(self, get_filename):
383
super(IniBasedConfig, self).__init__()
384
self._get_filename = get_filename
387
def _post_commit(self):
388
"""See Config.post_commit."""
389
return self._get_user_option('post_commit')
391
def _string_to_signature_policy(self, signature_string):
392
"""Convert a string to a signing policy."""
393
if signature_string.lower() == 'check-available':
394
return CHECK_IF_POSSIBLE
395
if signature_string.lower() == 'ignore':
397
if signature_string.lower() == 'require':
399
raise errors.BzrError("Invalid signatures policy '%s'"
402
def _string_to_signing_policy(self, signature_string):
403
"""Convert a string to a signing policy."""
404
if signature_string.lower() == 'when-required':
405
return SIGN_WHEN_REQUIRED
406
if signature_string.lower() == 'never':
408
if signature_string.lower() == 'always':
410
raise errors.BzrError("Invalid signing policy '%s'"
413
def _get_alias(self, value):
415
return self._get_parser().get_value("ALIASES",
420
def _get_nickname(self):
421
return self.get_user_option('nickname')
424
class GlobalConfig(IniBasedConfig):
425
"""The configuration that should be used for a specific location."""
427
def get_editor(self):
428
return self._get_user_option('editor')
431
super(GlobalConfig, self).__init__(config_filename)
433
def set_user_option(self, option, value):
434
"""Save option and its value in the configuration."""
435
# FIXME: RBC 20051029 This should refresh the parser and also take a
436
# file lock on bazaar.conf.
437
conf_dir = os.path.dirname(self._get_filename())
438
ensure_config_dir_exists(conf_dir)
439
if 'DEFAULT' not in self._get_parser():
440
self._get_parser()['DEFAULT'] = {}
441
self._get_parser()['DEFAULT'][option] = value
442
f = open(self._get_filename(), 'wb')
443
self._get_parser().write(f)
447
class LocationConfig(IniBasedConfig):
448
"""A configuration object that gives the policy for a location."""
450
def __init__(self, location):
451
name_generator = locations_config_filename
452
if (not os.path.exists(name_generator()) and
453
os.path.exists(branches_config_filename())):
454
if sys.platform == 'win32':
455
warning('Please rename %s to %s'
456
% (branches_config_filename(),
457
locations_config_filename()))
459
warning('Please rename ~/.bazaar/branches.conf'
460
' to ~/.bazaar/locations.conf')
461
name_generator = branches_config_filename
462
super(LocationConfig, self).__init__(name_generator)
463
# local file locations are looked up by local path, rather than
464
# by file url. This is because the config file is a user
465
# file, and we would rather not expose the user to file urls.
466
if location.startswith('file://'):
467
location = urlutils.local_path_from_url(location)
468
self.location = location
470
def _get_matching_sections(self):
471
"""Return an ordered list of section names matching this location."""
472
sections = self._get_parser()
473
location_names = self.location.split('/')
474
if self.location.endswith('/'):
475
del location_names[-1]
477
for section in sections:
478
# location is a local path if possible, so we need
479
# to convert 'file://' urls to local paths if necessary.
480
# This also avoids having file:///path be a more exact
481
# match than '/path'.
482
if section.startswith('file://'):
483
section_path = urlutils.local_path_from_url(section)
485
section_path = section
486
section_names = section_path.split('/')
487
if section.endswith('/'):
488
del section_names[-1]
489
names = zip(location_names, section_names)
492
if not fnmatch(name[0], name[1]):
497
# so, for the common prefix they matched.
498
# if section is longer, no match.
499
if len(section_names) > len(location_names):
501
matches.append((len(section_names), section,
502
'/'.join(location_names[len(section_names):])))
503
matches.sort(reverse=True)
505
for (length, section, extra_path) in matches:
506
sections.append((section, extra_path))
507
# should we stop looking for parent configs here?
509
if self._get_parser()[section].as_bool('ignore_parents'):
515
def _get_option_policy(self, section, option_name):
516
"""Return the policy for the given (section, option_name) pair."""
517
# check for the old 'recurse=False' flag
519
recurse = self._get_parser()[section].as_bool('recurse')
523
return POLICY_NORECURSE
525
policy_key = option_name + ':policy'
527
policy_name = self._get_parser()[section][policy_key]
531
return _policy_value[policy_name]
533
def _set_option_policy(self, section, option_name, option_policy):
534
"""Set the policy for the given option name in the given section."""
535
# The old recurse=False option affects all options in the
536
# section. To handle multiple policies in the section, we
537
# need to convert it to a policy_norecurse key.
539
recurse = self._get_parser()[section].as_bool('recurse')
543
symbol_versioning.warn(
544
'The recurse option is deprecated as of 0.14. '
545
'The section "%s" has been converted to use policies.'
548
del self._get_parser()[section]['recurse']
550
for key in self._get_parser()[section].keys():
551
if not key.endswith(':policy'):
552
self._get_parser()[section][key +
553
':policy'] = 'norecurse'
555
policy_key = option_name + ':policy'
556
policy_name = _policy_name[option_policy]
557
if policy_name is not None:
558
self._get_parser()[section][policy_key] = policy_name
560
if policy_key in self._get_parser()[section]:
561
del self._get_parser()[section][policy_key]
563
def set_user_option(self, option, value, store=STORE_LOCATION):
564
"""Save option and its value in the configuration."""
565
assert store in [STORE_LOCATION,
566
STORE_LOCATION_NORECURSE,
567
STORE_LOCATION_APPENDPATH], 'bad storage policy'
568
# FIXME: RBC 20051029 This should refresh the parser and also take a
569
# file lock on locations.conf.
570
conf_dir = os.path.dirname(self._get_filename())
571
ensure_config_dir_exists(conf_dir)
572
location = self.location
573
if location.endswith('/'):
574
location = location[:-1]
575
if (not location in self._get_parser() and
576
not location + '/' in self._get_parser()):
577
self._get_parser()[location]={}
578
elif location + '/' in self._get_parser():
579
location = location + '/'
580
self._get_parser()[location][option]=value
581
# the allowed values of store match the config policies
582
self._set_option_policy(location, option, store)
583
self._get_parser().write(file(self._get_filename(), 'wb'))
586
class BranchConfig(Config):
587
"""A configuration object giving the policy for a branch."""
589
def _get_branch_data_config(self):
590
if self._branch_data_config is None:
591
self._branch_data_config = TreeConfig(self.branch)
592
return self._branch_data_config
594
def _get_location_config(self):
595
if self._location_config is None:
596
self._location_config = LocationConfig(self.branch.base)
597
return self._location_config
599
def _get_global_config(self):
600
if self._global_config is None:
601
self._global_config = GlobalConfig()
602
return self._global_config
604
def _get_best_value(self, option_name):
605
"""This returns a user option from local, tree or global config.
607
They are tried in that order. Use get_safe_value if trusted values
610
for source in self.option_sources:
611
value = getattr(source(), option_name)()
612
if value is not None:
616
def _get_safe_value(self, option_name):
617
"""This variant of get_best_value never returns untrusted values.
619
It does not return values from the branch data, because the branch may
620
not be controlled by the user.
622
We may wish to allow locations.conf to control whether branches are
623
trusted in the future.
625
for source in (self._get_location_config, self._get_global_config):
626
value = getattr(source(), option_name)()
627
if value is not None:
631
def _get_user_id(self):
632
"""Return the full user id for the branch.
634
e.g. "John Hacker <jhacker@foo.org>"
635
This is looked up in the email controlfile for the branch.
638
return (self.branch.control_files.get_utf8("email")
640
.decode(bzrlib.user_encoding)
642
except errors.NoSuchFile, e:
645
return self._get_best_value('_get_user_id')
647
def _get_signature_checking(self):
648
"""See Config._get_signature_checking."""
649
return self._get_best_value('_get_signature_checking')
651
def _get_signing_policy(self):
652
"""See Config._get_signing_policy."""
653
return self._get_best_value('_get_signing_policy')
655
def _get_user_option(self, option_name):
656
"""See Config._get_user_option."""
657
for source in self.option_sources:
658
value = source()._get_user_option(option_name)
659
if value is not None:
663
def set_user_option(self, name, value, store=STORE_BRANCH,
665
if store == STORE_BRANCH:
666
self._get_branch_data_config().set_option(value, name)
667
elif store == STORE_GLOBAL:
668
self._get_global_config().set_user_option(name, value)
670
self._get_location_config().set_user_option(name, value, store)
673
if store in (STORE_GLOBAL, STORE_BRANCH):
674
mask_value = self._get_location_config().get_user_option(name)
675
if mask_value is not None:
676
trace.warning('Value "%s" is masked by "%s" from'
677
' locations.conf', value, mask_value)
679
if store == STORE_GLOBAL:
680
branch_config = self._get_branch_data_config()
681
mask_value = branch_config.get_user_option(name)
682
if mask_value is not None:
683
trace.warning('Value "%s" is masked by "%s" from'
684
' branch.conf', value, mask_value)
687
def _gpg_signing_command(self):
688
"""See Config.gpg_signing_command."""
689
return self._get_safe_value('_gpg_signing_command')
691
def __init__(self, branch):
692
super(BranchConfig, self).__init__()
693
self._location_config = None
694
self._branch_data_config = None
695
self._global_config = None
697
self.option_sources = (self._get_location_config,
698
self._get_branch_data_config,
699
self._get_global_config)
701
def _post_commit(self):
702
"""See Config.post_commit."""
703
return self._get_safe_value('_post_commit')
705
def _get_nickname(self):
706
value = self._get_explicit_nickname()
707
if value is not None:
709
return urlutils.unescape(self.branch.base.split('/')[-2])
711
def has_explicit_nickname(self):
712
"""Return true if a nickname has been explicitly assigned."""
713
return self._get_explicit_nickname() is not None
715
def _get_explicit_nickname(self):
716
return self._get_best_value('_get_nickname')
718
def _log_format(self):
719
"""See Config.log_format."""
720
return self._get_best_value('_log_format')
723
def ensure_config_dir_exists(path=None):
724
"""Make sure a configuration directory exists.
725
This makes sure that the directory exists.
726
On windows, since configuration directories are 2 levels deep,
727
it makes sure both the directory and the parent directory exists.
731
if not os.path.isdir(path):
732
if sys.platform == 'win32':
733
parent_dir = os.path.dirname(path)
734
if not os.path.isdir(parent_dir):
735
mutter('creating config parent directory: %r', parent_dir)
737
mutter('creating config directory: %r', path)
742
"""Return per-user configuration directory.
744
By default this is ~/.bazaar/
746
TODO: Global option --config-dir to override this.
748
base = os.environ.get('BZR_HOME', None)
749
if sys.platform == 'win32':
751
base = win32utils.get_appdata_location_unicode()
753
base = os.environ.get('HOME', None)
755
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
756
return osutils.pathjoin(base, 'bazaar', '2.0')
758
# cygwin, linux, and darwin all have a $HOME directory
760
base = os.path.expanduser("~")
761
return osutils.pathjoin(base, ".bazaar")
764
def config_filename():
765
"""Return per-user configuration ini file filename."""
766
return osutils.pathjoin(config_dir(), 'bazaar.conf')
769
def branches_config_filename():
770
"""Return per-user configuration ini file filename."""
771
return osutils.pathjoin(config_dir(), 'branches.conf')
774
def locations_config_filename():
775
"""Return per-user configuration ini file filename."""
776
return osutils.pathjoin(config_dir(), 'locations.conf')
779
def user_ignore_config_filename():
780
"""Return the user default ignore filename"""
781
return osutils.pathjoin(config_dir(), 'ignore')
785
"""Calculate automatic user identification.
787
Returns (realname, email).
789
Only used when none is set in the environment or the id file.
791
This previously used the FQDN as the default domain, but that can
792
be very slow on machines where DNS is broken. So now we simply
797
if sys.platform == 'win32':
798
name = win32utils.get_user_name_unicode()
800
raise errors.BzrError("Cannot autodetect user name.\n"
801
"Please, set your name with command like:\n"
802
'bzr whoami "Your Name <name@domain.com>"')
803
host = win32utils.get_host_name_unicode()
805
host = socket.gethostname()
806
return name, (name + '@' + host)
811
w = pwd.getpwuid(uid)
813
# we try utf-8 first, because on many variants (like Linux),
814
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
815
# false positives. (many users will have their user encoding set to
816
# latin-1, which cannot raise UnicodeError.)
818
gecos = w.pw_gecos.decode('utf-8')
822
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
823
encoding = bzrlib.user_encoding
825
raise errors.BzrCommandError('Unable to determine your name. '
826
'Use "bzr whoami" to set it.')
828
username = w.pw_name.decode(encoding)
830
raise errors.BzrCommandError('Unable to determine your name. '
831
'Use "bzr whoami" to set it.')
833
comma = gecos.find(',')
837
realname = gecos[:comma]
844
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
845
except UnicodeDecodeError:
846
raise errors.BzrError("Can't decode username as %s." % \
847
bzrlib.user_encoding)
849
return realname, (username + '@' + socket.gethostname())
852
def extract_email_address(e):
853
"""Return just the address part of an email string.
855
That is just the user@domain part, nothing else.
856
This part is required to contain only ascii characters.
857
If it can't be extracted, raises an error.
859
>>> extract_email_address('Jane Tester <jane@test.com>')
862
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
864
raise errors.NoEmailInUsername(e)
868
class TreeConfig(IniBasedConfig):
869
"""Branch configuration data associated with its contents, not location"""
870
def __init__(self, branch):
873
def _get_parser(self, file=None):
875
return IniBasedConfig._get_parser(file)
876
return self._get_config()
878
def _get_config(self):
880
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
882
except errors.NoSuchFile:
883
obj = ConfigObj(encoding='utf=8')
886
def get_option(self, name, section=None, default=None):
887
self.branch.lock_read()
889
obj = self._get_config()
891
if section is not None:
900
def set_option(self, value, name, section=None):
901
"""Set a per-branch configuration option"""
902
self.branch.lock_write()
904
cfg_obj = self._get_config()
909
obj = cfg_obj[section]
911
cfg_obj[section] = {}
912
obj = cfg_obj[section]
914
out_file = StringIO()
915
cfg_obj.write(out_file)
917
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
