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.Editor,
153
'editor': mail_client.Editor,
154
'thunderbird': mail_client.Thunderbird,
155
'evolution': mail_client.Evolution,
158
raise errors.UnknownMailClient(selected_client)
159
return mail_client_class(self)
161
def _get_signature_checking(self):
162
"""Template method to override signature checking policy."""
164
def _get_signing_policy(self):
165
"""Template method to override signature creation policy."""
167
def _get_user_option(self, option_name):
168
"""Template method to provide a user option."""
171
def get_user_option(self, option_name):
172
"""Get a generic option - no special process, no default."""
173
return self._get_user_option(option_name)
175
def gpg_signing_command(self):
176
"""What program should be used to sign signatures?"""
177
result = self._gpg_signing_command()
182
def _gpg_signing_command(self):
183
"""See gpg_signing_command()."""
186
def log_format(self):
187
"""What log format should be used"""
188
result = self._log_format()
193
def _log_format(self):
194
"""See log_format()."""
198
super(Config, self).__init__()
200
def post_commit(self):
201
"""An ordered list of python functions to call.
203
Each function takes branch, rev_id as parameters.
205
return self._post_commit()
207
def _post_commit(self):
208
"""See Config.post_commit."""
211
def user_email(self):
212
"""Return just the email component of a username."""
213
return extract_email_address(self.username())
216
"""Return email-style username.
218
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
220
$BZR_EMAIL can be set to override this (as well as the
221
deprecated $BZREMAIL), then
222
the concrete policy type is checked, and finally
224
If none is found, a reasonable default is (hopefully)
227
TODO: Check it's reasonably well-formed.
229
v = os.environ.get('BZR_EMAIL')
231
return v.decode(bzrlib.user_encoding)
232
v = os.environ.get('BZREMAIL')
234
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
235
return v.decode(bzrlib.user_encoding)
237
v = self._get_user_id()
241
v = os.environ.get('EMAIL')
243
return v.decode(bzrlib.user_encoding)
245
name, email = _auto_user_id()
247
return '%s <%s>' % (name, email)
251
def signature_checking(self):
252
"""What is the current policy for signature checking?."""
253
policy = self._get_signature_checking()
254
if policy is not None:
256
return CHECK_IF_POSSIBLE
258
def signing_policy(self):
259
"""What is the current policy for signature checking?."""
260
policy = self._get_signing_policy()
261
if policy is not None:
263
return SIGN_WHEN_REQUIRED
265
def signature_needed(self):
266
"""Is a signature needed when committing ?."""
267
policy = self._get_signing_policy()
269
policy = self._get_signature_checking()
270
if policy is not None:
271
warning("Please use create_signatures, not check_signatures "
272
"to set signing policy.")
273
if policy == CHECK_ALWAYS:
275
elif policy == SIGN_ALWAYS:
279
def get_alias(self, value):
280
return self._get_alias(value)
282
def _get_alias(self, value):
285
def get_nickname(self):
286
return self._get_nickname()
288
def _get_nickname(self):
292
class IniBasedConfig(Config):
293
"""A configuration policy that draws from ini files."""
295
def _get_parser(self, file=None):
296
if self._parser is not None:
299
input = self._get_filename()
303
self._parser = ConfigObj(input, encoding='utf-8')
304
except configobj.ConfigObjError, e:
305
raise errors.ParseConfigError(e.errors, e.config.filename)
308
def _get_matching_sections(self):
309
"""Return an ordered list of (section_name, extra_path) pairs.
311
If the section contains inherited configuration, extra_path is
312
a string containing the additional path components.
314
section = self._get_section()
315
if section is not None:
316
return [(section, '')]
320
def _get_section(self):
321
"""Override this to define the section used by the config."""
324
def _get_option_policy(self, section, option_name):
325
"""Return the policy for the given (section, option_name) pair."""
328
def _get_signature_checking(self):
329
"""See Config._get_signature_checking."""
330
policy = self._get_user_option('check_signatures')
332
return self._string_to_signature_policy(policy)
334
def _get_signing_policy(self):
335
"""See Config._get_signing_policy"""
336
policy = self._get_user_option('create_signatures')
338
return self._string_to_signing_policy(policy)
340
def _get_user_id(self):
341
"""Get the user id from the 'email' key in the current section."""
342
return self._get_user_option('email')
344
def _get_user_option(self, option_name):
345
"""See Config._get_user_option."""
346
for (section, extra_path) in self._get_matching_sections():
348
value = self._get_parser().get_value(section, option_name)
351
policy = self._get_option_policy(section, option_name)
352
if policy == POLICY_NONE:
354
elif policy == POLICY_NORECURSE:
355
# norecurse items only apply to the exact path
360
elif policy == POLICY_APPENDPATH:
362
value = urlutils.join(value, extra_path)
365
raise AssertionError('Unexpected config policy %r' % policy)
369
def _gpg_signing_command(self):
370
"""See Config.gpg_signing_command."""
371
return self._get_user_option('gpg_signing_command')
373
def _log_format(self):
374
"""See Config.log_format."""
375
return self._get_user_option('log_format')
377
def __init__(self, get_filename):
378
super(IniBasedConfig, self).__init__()
379
self._get_filename = get_filename
382
def _post_commit(self):
383
"""See Config.post_commit."""
384
return self._get_user_option('post_commit')
386
def _string_to_signature_policy(self, signature_string):
387
"""Convert a string to a signing policy."""
388
if signature_string.lower() == 'check-available':
389
return CHECK_IF_POSSIBLE
390
if signature_string.lower() == 'ignore':
392
if signature_string.lower() == 'require':
394
raise errors.BzrError("Invalid signatures policy '%s'"
397
def _string_to_signing_policy(self, signature_string):
398
"""Convert a string to a signing policy."""
399
if signature_string.lower() == 'when-required':
400
return SIGN_WHEN_REQUIRED
401
if signature_string.lower() == 'never':
403
if signature_string.lower() == 'always':
405
raise errors.BzrError("Invalid signing policy '%s'"
408
def _get_alias(self, value):
410
return self._get_parser().get_value("ALIASES",
415
def _get_nickname(self):
416
return self.get_user_option('nickname')
419
class GlobalConfig(IniBasedConfig):
420
"""The configuration that should be used for a specific location."""
422
def get_editor(self):
423
return self._get_user_option('editor')
426
super(GlobalConfig, self).__init__(config_filename)
428
def set_user_option(self, option, value):
429
"""Save option and its value in the configuration."""
430
# FIXME: RBC 20051029 This should refresh the parser and also take a
431
# file lock on bazaar.conf.
432
conf_dir = os.path.dirname(self._get_filename())
433
ensure_config_dir_exists(conf_dir)
434
if 'DEFAULT' not in self._get_parser():
435
self._get_parser()['DEFAULT'] = {}
436
self._get_parser()['DEFAULT'][option] = value
437
f = open(self._get_filename(), 'wb')
438
self._get_parser().write(f)
442
class LocationConfig(IniBasedConfig):
443
"""A configuration object that gives the policy for a location."""
445
def __init__(self, location):
446
name_generator = locations_config_filename
447
if (not os.path.exists(name_generator()) and
448
os.path.exists(branches_config_filename())):
449
if sys.platform == 'win32':
450
warning('Please rename %s to %s'
451
% (branches_config_filename(),
452
locations_config_filename()))
454
warning('Please rename ~/.bazaar/branches.conf'
455
' to ~/.bazaar/locations.conf')
456
name_generator = branches_config_filename
457
super(LocationConfig, self).__init__(name_generator)
458
# local file locations are looked up by local path, rather than
459
# by file url. This is because the config file is a user
460
# file, and we would rather not expose the user to file urls.
461
if location.startswith('file://'):
462
location = urlutils.local_path_from_url(location)
463
self.location = location
465
def _get_matching_sections(self):
466
"""Return an ordered list of section names matching this location."""
467
sections = self._get_parser()
468
location_names = self.location.split('/')
469
if self.location.endswith('/'):
470
del location_names[-1]
472
for section in sections:
473
# location is a local path if possible, so we need
474
# to convert 'file://' urls to local paths if necessary.
475
# This also avoids having file:///path be a more exact
476
# match than '/path'.
477
if section.startswith('file://'):
478
section_path = urlutils.local_path_from_url(section)
480
section_path = section
481
section_names = section_path.split('/')
482
if section.endswith('/'):
483
del section_names[-1]
484
names = zip(location_names, section_names)
487
if not fnmatch(name[0], name[1]):
492
# so, for the common prefix they matched.
493
# if section is longer, no match.
494
if len(section_names) > len(location_names):
496
matches.append((len(section_names), section,
497
'/'.join(location_names[len(section_names):])))
498
matches.sort(reverse=True)
500
for (length, section, extra_path) in matches:
501
sections.append((section, extra_path))
502
# should we stop looking for parent configs here?
504
if self._get_parser()[section].as_bool('ignore_parents'):
510
def _get_option_policy(self, section, option_name):
511
"""Return the policy for the given (section, option_name) pair."""
512
# check for the old 'recurse=False' flag
514
recurse = self._get_parser()[section].as_bool('recurse')
518
return POLICY_NORECURSE
520
policy_key = option_name + ':policy'
522
policy_name = self._get_parser()[section][policy_key]
526
return _policy_value[policy_name]
528
def _set_option_policy(self, section, option_name, option_policy):
529
"""Set the policy for the given option name in the given section."""
530
# The old recurse=False option affects all options in the
531
# section. To handle multiple policies in the section, we
532
# need to convert it to a policy_norecurse key.
534
recurse = self._get_parser()[section].as_bool('recurse')
538
symbol_versioning.warn(
539
'The recurse option is deprecated as of 0.14. '
540
'The section "%s" has been converted to use policies.'
543
del self._get_parser()[section]['recurse']
545
for key in self._get_parser()[section].keys():
546
if not key.endswith(':policy'):
547
self._get_parser()[section][key +
548
':policy'] = 'norecurse'
550
policy_key = option_name + ':policy'
551
policy_name = _policy_name[option_policy]
552
if policy_name is not None:
553
self._get_parser()[section][policy_key] = policy_name
555
if policy_key in self._get_parser()[section]:
556
del self._get_parser()[section][policy_key]
558
def set_user_option(self, option, value, store=STORE_LOCATION):
559
"""Save option and its value in the configuration."""
560
assert store in [STORE_LOCATION,
561
STORE_LOCATION_NORECURSE,
562
STORE_LOCATION_APPENDPATH], 'bad storage policy'
563
# FIXME: RBC 20051029 This should refresh the parser and also take a
564
# file lock on locations.conf.
565
conf_dir = os.path.dirname(self._get_filename())
566
ensure_config_dir_exists(conf_dir)
567
location = self.location
568
if location.endswith('/'):
569
location = location[:-1]
570
if (not location in self._get_parser() and
571
not location + '/' in self._get_parser()):
572
self._get_parser()[location]={}
573
elif location + '/' in self._get_parser():
574
location = location + '/'
575
self._get_parser()[location][option]=value
576
# the allowed values of store match the config policies
577
self._set_option_policy(location, option, store)
578
self._get_parser().write(file(self._get_filename(), 'wb'))
581
class BranchConfig(Config):
582
"""A configuration object giving the policy for a branch."""
584
def _get_branch_data_config(self):
585
if self._branch_data_config is None:
586
self._branch_data_config = TreeConfig(self.branch)
587
return self._branch_data_config
589
def _get_location_config(self):
590
if self._location_config is None:
591
self._location_config = LocationConfig(self.branch.base)
592
return self._location_config
594
def _get_global_config(self):
595
if self._global_config is None:
596
self._global_config = GlobalConfig()
597
return self._global_config
599
def _get_best_value(self, option_name):
600
"""This returns a user option from local, tree or global config.
602
They are tried in that order. Use get_safe_value if trusted values
605
for source in self.option_sources:
606
value = getattr(source(), option_name)()
607
if value is not None:
611
def _get_safe_value(self, option_name):
612
"""This variant of get_best_value never returns untrusted values.
614
It does not return values from the branch data, because the branch may
615
not be controlled by the user.
617
We may wish to allow locations.conf to control whether branches are
618
trusted in the future.
620
for source in (self._get_location_config, self._get_global_config):
621
value = getattr(source(), option_name)()
622
if value is not None:
626
def _get_user_id(self):
627
"""Return the full user id for the branch.
629
e.g. "John Hacker <jhacker@foo.org>"
630
This is looked up in the email controlfile for the branch.
633
return (self.branch.control_files.get_utf8("email")
635
.decode(bzrlib.user_encoding)
637
except errors.NoSuchFile, e:
640
return self._get_best_value('_get_user_id')
642
def _get_signature_checking(self):
643
"""See Config._get_signature_checking."""
644
return self._get_best_value('_get_signature_checking')
646
def _get_signing_policy(self):
647
"""See Config._get_signing_policy."""
648
return self._get_best_value('_get_signing_policy')
650
def _get_user_option(self, option_name):
651
"""See Config._get_user_option."""
652
for source in self.option_sources:
653
value = source()._get_user_option(option_name)
654
if value is not None:
658
def set_user_option(self, name, value, store=STORE_BRANCH,
660
if store == STORE_BRANCH:
661
self._get_branch_data_config().set_option(value, name)
662
elif store == STORE_GLOBAL:
663
self._get_global_config().set_user_option(name, value)
665
self._get_location_config().set_user_option(name, value, store)
668
if store in (STORE_GLOBAL, STORE_BRANCH):
669
mask_value = self._get_location_config().get_user_option(name)
670
if mask_value is not None:
671
trace.warning('Value "%s" is masked by "%s" from'
672
' locations.conf', value, mask_value)
674
if store == STORE_GLOBAL:
675
branch_config = self._get_branch_data_config()
676
mask_value = branch_config.get_user_option(name)
677
if mask_value is not None:
678
trace.warning('Value "%s" is masked by "%s" from'
679
' branch.conf', value, mask_value)
682
def _gpg_signing_command(self):
683
"""See Config.gpg_signing_command."""
684
return self._get_safe_value('_gpg_signing_command')
686
def __init__(self, branch):
687
super(BranchConfig, self).__init__()
688
self._location_config = None
689
self._branch_data_config = None
690
self._global_config = None
692
self.option_sources = (self._get_location_config,
693
self._get_branch_data_config,
694
self._get_global_config)
696
def _post_commit(self):
697
"""See Config.post_commit."""
698
return self._get_safe_value('_post_commit')
700
def _get_nickname(self):
701
value = self._get_explicit_nickname()
702
if value is not None:
704
return urlutils.unescape(self.branch.base.split('/')[-2])
706
def has_explicit_nickname(self):
707
"""Return true if a nickname has been explicitly assigned."""
708
return self._get_explicit_nickname() is not None
710
def _get_explicit_nickname(self):
711
return self._get_best_value('_get_nickname')
713
def _log_format(self):
714
"""See Config.log_format."""
715
return self._get_best_value('_log_format')
718
def ensure_config_dir_exists(path=None):
719
"""Make sure a configuration directory exists.
720
This makes sure that the directory exists.
721
On windows, since configuration directories are 2 levels deep,
722
it makes sure both the directory and the parent directory exists.
726
if not os.path.isdir(path):
727
if sys.platform == 'win32':
728
parent_dir = os.path.dirname(path)
729
if not os.path.isdir(parent_dir):
730
mutter('creating config parent directory: %r', parent_dir)
732
mutter('creating config directory: %r', path)
737
"""Return per-user configuration directory.
739
By default this is ~/.bazaar/
741
TODO: Global option --config-dir to override this.
743
base = os.environ.get('BZR_HOME', None)
744
if sys.platform == 'win32':
746
base = win32utils.get_appdata_location_unicode()
748
base = os.environ.get('HOME', None)
750
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
751
return osutils.pathjoin(base, 'bazaar', '2.0')
753
# cygwin, linux, and darwin all have a $HOME directory
755
base = os.path.expanduser("~")
756
return osutils.pathjoin(base, ".bazaar")
759
def config_filename():
760
"""Return per-user configuration ini file filename."""
761
return osutils.pathjoin(config_dir(), 'bazaar.conf')
764
def branches_config_filename():
765
"""Return per-user configuration ini file filename."""
766
return osutils.pathjoin(config_dir(), 'branches.conf')
769
def locations_config_filename():
770
"""Return per-user configuration ini file filename."""
771
return osutils.pathjoin(config_dir(), 'locations.conf')
774
def user_ignore_config_filename():
775
"""Return the user default ignore filename"""
776
return osutils.pathjoin(config_dir(), 'ignore')
780
"""Calculate automatic user identification.
782
Returns (realname, email).
784
Only used when none is set in the environment or the id file.
786
This previously used the FQDN as the default domain, but that can
787
be very slow on machines where DNS is broken. So now we simply
792
if sys.platform == 'win32':
793
name = win32utils.get_user_name_unicode()
795
raise errors.BzrError("Cannot autodetect user name.\n"
796
"Please, set your name with command like:\n"
797
'bzr whoami "Your Name <name@domain.com>"')
798
host = win32utils.get_host_name_unicode()
800
host = socket.gethostname()
801
return name, (name + '@' + host)
806
w = pwd.getpwuid(uid)
808
# we try utf-8 first, because on many variants (like Linux),
809
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
810
# false positives. (many users will have their user encoding set to
811
# latin-1, which cannot raise UnicodeError.)
813
gecos = w.pw_gecos.decode('utf-8')
817
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
818
encoding = bzrlib.user_encoding
820
raise errors.BzrCommandError('Unable to determine your name. '
821
'Use "bzr whoami" to set it.')
823
username = w.pw_name.decode(encoding)
825
raise errors.BzrCommandError('Unable to determine your name. '
826
'Use "bzr whoami" to set it.')
828
comma = gecos.find(',')
832
realname = gecos[:comma]
839
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
840
except UnicodeDecodeError:
841
raise errors.BzrError("Can't decode username as %s." % \
842
bzrlib.user_encoding)
844
return realname, (username + '@' + socket.gethostname())
847
def extract_email_address(e):
848
"""Return just the address part of an email string.
850
That is just the user@domain part, nothing else.
851
This part is required to contain only ascii characters.
852
If it can't be extracted, raises an error.
854
>>> extract_email_address('Jane Tester <jane@test.com>')
857
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
859
raise errors.NoEmailInUsername(e)
863
class TreeConfig(IniBasedConfig):
864
"""Branch configuration data associated with its contents, not location"""
865
def __init__(self, branch):
868
def _get_parser(self, file=None):
870
return IniBasedConfig._get_parser(file)
871
return self._get_config()
873
def _get_config(self):
875
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
877
except errors.NoSuchFile:
878
obj = ConfigObj(encoding='utf=8')
881
def get_option(self, name, section=None, default=None):
882
self.branch.lock_read()
884
obj = self._get_config()
886
if section is not None:
895
def set_option(self, value, name, section=None):
896
"""Set a per-branch configuration option"""
897
self.branch.lock_write()
899
cfg_obj = self._get_config()
904
obj = cfg_obj[section]
906
cfg_obj[section] = {}
907
obj = cfg_obj[section]
909
out_file = StringIO()
910
cfg_obj.write(out_file)
912
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
