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,
156
'xdg-email': mail_client.XDGEmail,
159
raise errors.UnknownMailClient(selected_client)
160
return mail_client_class(self)
162
def _get_signature_checking(self):
163
"""Template method to override signature checking policy."""
165
def _get_signing_policy(self):
166
"""Template method to override signature creation policy."""
168
def _get_user_option(self, option_name):
169
"""Template method to provide a user option."""
172
def get_user_option(self, option_name):
173
"""Get a generic option - no special process, no default."""
174
return self._get_user_option(option_name)
176
def gpg_signing_command(self):
177
"""What program should be used to sign signatures?"""
178
result = self._gpg_signing_command()
183
def _gpg_signing_command(self):
184
"""See gpg_signing_command()."""
187
def log_format(self):
188
"""What log format should be used"""
189
result = self._log_format()
194
def _log_format(self):
195
"""See log_format()."""
199
super(Config, self).__init__()
201
def post_commit(self):
202
"""An ordered list of python functions to call.
204
Each function takes branch, rev_id as parameters.
206
return self._post_commit()
208
def _post_commit(self):
209
"""See Config.post_commit."""
212
def user_email(self):
213
"""Return just the email component of a username."""
214
return extract_email_address(self.username())
217
"""Return email-style username.
219
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
221
$BZR_EMAIL can be set to override this (as well as the
222
deprecated $BZREMAIL), then
223
the concrete policy type is checked, and finally
225
If none is found, a reasonable default is (hopefully)
228
TODO: Check it's reasonably well-formed.
230
v = os.environ.get('BZR_EMAIL')
232
return v.decode(bzrlib.user_encoding)
233
v = os.environ.get('BZREMAIL')
235
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
236
return v.decode(bzrlib.user_encoding)
238
v = self._get_user_id()
242
v = os.environ.get('EMAIL')
244
return v.decode(bzrlib.user_encoding)
246
name, email = _auto_user_id()
248
return '%s <%s>' % (name, email)
252
def signature_checking(self):
253
"""What is the current policy for signature checking?."""
254
policy = self._get_signature_checking()
255
if policy is not None:
257
return CHECK_IF_POSSIBLE
259
def signing_policy(self):
260
"""What is the current policy for signature checking?."""
261
policy = self._get_signing_policy()
262
if policy is not None:
264
return SIGN_WHEN_REQUIRED
266
def signature_needed(self):
267
"""Is a signature needed when committing ?."""
268
policy = self._get_signing_policy()
270
policy = self._get_signature_checking()
271
if policy is not None:
272
warning("Please use create_signatures, not check_signatures "
273
"to set signing policy.")
274
if policy == CHECK_ALWAYS:
276
elif policy == SIGN_ALWAYS:
280
def get_alias(self, value):
281
return self._get_alias(value)
283
def _get_alias(self, value):
286
def get_nickname(self):
287
return self._get_nickname()
289
def _get_nickname(self):
293
class IniBasedConfig(Config):
294
"""A configuration policy that draws from ini files."""
296
def _get_parser(self, file=None):
297
if self._parser is not None:
300
input = self._get_filename()
304
self._parser = ConfigObj(input, encoding='utf-8')
305
except configobj.ConfigObjError, e:
306
raise errors.ParseConfigError(e.errors, e.config.filename)
309
def _get_matching_sections(self):
310
"""Return an ordered list of (section_name, extra_path) pairs.
312
If the section contains inherited configuration, extra_path is
313
a string containing the additional path components.
315
section = self._get_section()
316
if section is not None:
317
return [(section, '')]
321
def _get_section(self):
322
"""Override this to define the section used by the config."""
325
def _get_option_policy(self, section, option_name):
326
"""Return the policy for the given (section, option_name) pair."""
329
def _get_signature_checking(self):
330
"""See Config._get_signature_checking."""
331
policy = self._get_user_option('check_signatures')
333
return self._string_to_signature_policy(policy)
335
def _get_signing_policy(self):
336
"""See Config._get_signing_policy"""
337
policy = self._get_user_option('create_signatures')
339
return self._string_to_signing_policy(policy)
341
def _get_user_id(self):
342
"""Get the user id from the 'email' key in the current section."""
343
return self._get_user_option('email')
345
def _get_user_option(self, option_name):
346
"""See Config._get_user_option."""
347
for (section, extra_path) in self._get_matching_sections():
349
value = self._get_parser().get_value(section, option_name)
352
policy = self._get_option_policy(section, option_name)
353
if policy == POLICY_NONE:
355
elif policy == POLICY_NORECURSE:
356
# norecurse items only apply to the exact path
361
elif policy == POLICY_APPENDPATH:
363
value = urlutils.join(value, extra_path)
366
raise AssertionError('Unexpected config policy %r' % policy)
370
def _gpg_signing_command(self):
371
"""See Config.gpg_signing_command."""
372
return self._get_user_option('gpg_signing_command')
374
def _log_format(self):
375
"""See Config.log_format."""
376
return self._get_user_option('log_format')
378
def __init__(self, get_filename):
379
super(IniBasedConfig, self).__init__()
380
self._get_filename = get_filename
383
def _post_commit(self):
384
"""See Config.post_commit."""
385
return self._get_user_option('post_commit')
387
def _string_to_signature_policy(self, signature_string):
388
"""Convert a string to a signing policy."""
389
if signature_string.lower() == 'check-available':
390
return CHECK_IF_POSSIBLE
391
if signature_string.lower() == 'ignore':
393
if signature_string.lower() == 'require':
395
raise errors.BzrError("Invalid signatures policy '%s'"
398
def _string_to_signing_policy(self, signature_string):
399
"""Convert a string to a signing policy."""
400
if signature_string.lower() == 'when-required':
401
return SIGN_WHEN_REQUIRED
402
if signature_string.lower() == 'never':
404
if signature_string.lower() == 'always':
406
raise errors.BzrError("Invalid signing policy '%s'"
409
def _get_alias(self, value):
411
return self._get_parser().get_value("ALIASES",
416
def _get_nickname(self):
417
return self.get_user_option('nickname')
420
class GlobalConfig(IniBasedConfig):
421
"""The configuration that should be used for a specific location."""
423
def get_editor(self):
424
return self._get_user_option('editor')
427
super(GlobalConfig, self).__init__(config_filename)
429
def set_user_option(self, option, value):
430
"""Save option and its value in the configuration."""
431
# FIXME: RBC 20051029 This should refresh the parser and also take a
432
# file lock on bazaar.conf.
433
conf_dir = os.path.dirname(self._get_filename())
434
ensure_config_dir_exists(conf_dir)
435
if 'DEFAULT' not in self._get_parser():
436
self._get_parser()['DEFAULT'] = {}
437
self._get_parser()['DEFAULT'][option] = value
438
f = open(self._get_filename(), 'wb')
439
self._get_parser().write(f)
443
class LocationConfig(IniBasedConfig):
444
"""A configuration object that gives the policy for a location."""
446
def __init__(self, location):
447
name_generator = locations_config_filename
448
if (not os.path.exists(name_generator()) and
449
os.path.exists(branches_config_filename())):
450
if sys.platform == 'win32':
451
warning('Please rename %s to %s'
452
% (branches_config_filename(),
453
locations_config_filename()))
455
warning('Please rename ~/.bazaar/branches.conf'
456
' to ~/.bazaar/locations.conf')
457
name_generator = branches_config_filename
458
super(LocationConfig, self).__init__(name_generator)
459
# local file locations are looked up by local path, rather than
460
# by file url. This is because the config file is a user
461
# file, and we would rather not expose the user to file urls.
462
if location.startswith('file://'):
463
location = urlutils.local_path_from_url(location)
464
self.location = location
466
def _get_matching_sections(self):
467
"""Return an ordered list of section names matching this location."""
468
sections = self._get_parser()
469
location_names = self.location.split('/')
470
if self.location.endswith('/'):
471
del location_names[-1]
473
for section in sections:
474
# location is a local path if possible, so we need
475
# to convert 'file://' urls to local paths if necessary.
476
# This also avoids having file:///path be a more exact
477
# match than '/path'.
478
if section.startswith('file://'):
479
section_path = urlutils.local_path_from_url(section)
481
section_path = section
482
section_names = section_path.split('/')
483
if section.endswith('/'):
484
del section_names[-1]
485
names = zip(location_names, section_names)
488
if not fnmatch(name[0], name[1]):
493
# so, for the common prefix they matched.
494
# if section is longer, no match.
495
if len(section_names) > len(location_names):
497
matches.append((len(section_names), section,
498
'/'.join(location_names[len(section_names):])))
499
matches.sort(reverse=True)
501
for (length, section, extra_path) in matches:
502
sections.append((section, extra_path))
503
# should we stop looking for parent configs here?
505
if self._get_parser()[section].as_bool('ignore_parents'):
511
def _get_option_policy(self, section, option_name):
512
"""Return the policy for the given (section, option_name) pair."""
513
# check for the old 'recurse=False' flag
515
recurse = self._get_parser()[section].as_bool('recurse')
519
return POLICY_NORECURSE
521
policy_key = option_name + ':policy'
523
policy_name = self._get_parser()[section][policy_key]
527
return _policy_value[policy_name]
529
def _set_option_policy(self, section, option_name, option_policy):
530
"""Set the policy for the given option name in the given section."""
531
# The old recurse=False option affects all options in the
532
# section. To handle multiple policies in the section, we
533
# need to convert it to a policy_norecurse key.
535
recurse = self._get_parser()[section].as_bool('recurse')
539
symbol_versioning.warn(
540
'The recurse option is deprecated as of 0.14. '
541
'The section "%s" has been converted to use policies.'
544
del self._get_parser()[section]['recurse']
546
for key in self._get_parser()[section].keys():
547
if not key.endswith(':policy'):
548
self._get_parser()[section][key +
549
':policy'] = 'norecurse'
551
policy_key = option_name + ':policy'
552
policy_name = _policy_name[option_policy]
553
if policy_name is not None:
554
self._get_parser()[section][policy_key] = policy_name
556
if policy_key in self._get_parser()[section]:
557
del self._get_parser()[section][policy_key]
559
def set_user_option(self, option, value, store=STORE_LOCATION):
560
"""Save option and its value in the configuration."""
561
assert store in [STORE_LOCATION,
562
STORE_LOCATION_NORECURSE,
563
STORE_LOCATION_APPENDPATH], 'bad storage policy'
564
# FIXME: RBC 20051029 This should refresh the parser and also take a
565
# file lock on locations.conf.
566
conf_dir = os.path.dirname(self._get_filename())
567
ensure_config_dir_exists(conf_dir)
568
location = self.location
569
if location.endswith('/'):
570
location = location[:-1]
571
if (not location in self._get_parser() and
572
not location + '/' in self._get_parser()):
573
self._get_parser()[location]={}
574
elif location + '/' in self._get_parser():
575
location = location + '/'
576
self._get_parser()[location][option]=value
577
# the allowed values of store match the config policies
578
self._set_option_policy(location, option, store)
579
self._get_parser().write(file(self._get_filename(), 'wb'))
582
class BranchConfig(Config):
583
"""A configuration object giving the policy for a branch."""
585
def _get_branch_data_config(self):
586
if self._branch_data_config is None:
587
self._branch_data_config = TreeConfig(self.branch)
588
return self._branch_data_config
590
def _get_location_config(self):
591
if self._location_config is None:
592
self._location_config = LocationConfig(self.branch.base)
593
return self._location_config
595
def _get_global_config(self):
596
if self._global_config is None:
597
self._global_config = GlobalConfig()
598
return self._global_config
600
def _get_best_value(self, option_name):
601
"""This returns a user option from local, tree or global config.
603
They are tried in that order. Use get_safe_value if trusted values
606
for source in self.option_sources:
607
value = getattr(source(), option_name)()
608
if value is not None:
612
def _get_safe_value(self, option_name):
613
"""This variant of get_best_value never returns untrusted values.
615
It does not return values from the branch data, because the branch may
616
not be controlled by the user.
618
We may wish to allow locations.conf to control whether branches are
619
trusted in the future.
621
for source in (self._get_location_config, self._get_global_config):
622
value = getattr(source(), option_name)()
623
if value is not None:
627
def _get_user_id(self):
628
"""Return the full user id for the branch.
630
e.g. "John Hacker <jhacker@foo.org>"
631
This is looked up in the email controlfile for the branch.
634
return (self.branch.control_files.get_utf8("email")
636
.decode(bzrlib.user_encoding)
638
except errors.NoSuchFile, e:
641
return self._get_best_value('_get_user_id')
643
def _get_signature_checking(self):
644
"""See Config._get_signature_checking."""
645
return self._get_best_value('_get_signature_checking')
647
def _get_signing_policy(self):
648
"""See Config._get_signing_policy."""
649
return self._get_best_value('_get_signing_policy')
651
def _get_user_option(self, option_name):
652
"""See Config._get_user_option."""
653
for source in self.option_sources:
654
value = source()._get_user_option(option_name)
655
if value is not None:
659
def set_user_option(self, name, value, store=STORE_BRANCH,
661
if store == STORE_BRANCH:
662
self._get_branch_data_config().set_option(value, name)
663
elif store == STORE_GLOBAL:
664
self._get_global_config().set_user_option(name, value)
666
self._get_location_config().set_user_option(name, value, store)
669
if store in (STORE_GLOBAL, STORE_BRANCH):
670
mask_value = self._get_location_config().get_user_option(name)
671
if mask_value is not None:
672
trace.warning('Value "%s" is masked by "%s" from'
673
' locations.conf', value, mask_value)
675
if store == STORE_GLOBAL:
676
branch_config = self._get_branch_data_config()
677
mask_value = branch_config.get_user_option(name)
678
if mask_value is not None:
679
trace.warning('Value "%s" is masked by "%s" from'
680
' branch.conf', value, mask_value)
683
def _gpg_signing_command(self):
684
"""See Config.gpg_signing_command."""
685
return self._get_safe_value('_gpg_signing_command')
687
def __init__(self, branch):
688
super(BranchConfig, self).__init__()
689
self._location_config = None
690
self._branch_data_config = None
691
self._global_config = None
693
self.option_sources = (self._get_location_config,
694
self._get_branch_data_config,
695
self._get_global_config)
697
def _post_commit(self):
698
"""See Config.post_commit."""
699
return self._get_safe_value('_post_commit')
701
def _get_nickname(self):
702
value = self._get_explicit_nickname()
703
if value is not None:
705
return urlutils.unescape(self.branch.base.split('/')[-2])
707
def has_explicit_nickname(self):
708
"""Return true if a nickname has been explicitly assigned."""
709
return self._get_explicit_nickname() is not None
711
def _get_explicit_nickname(self):
712
return self._get_best_value('_get_nickname')
714
def _log_format(self):
715
"""See Config.log_format."""
716
return self._get_best_value('_log_format')
719
def ensure_config_dir_exists(path=None):
720
"""Make sure a configuration directory exists.
721
This makes sure that the directory exists.
722
On windows, since configuration directories are 2 levels deep,
723
it makes sure both the directory and the parent directory exists.
727
if not os.path.isdir(path):
728
if sys.platform == 'win32':
729
parent_dir = os.path.dirname(path)
730
if not os.path.isdir(parent_dir):
731
mutter('creating config parent directory: %r', parent_dir)
733
mutter('creating config directory: %r', path)
738
"""Return per-user configuration directory.
740
By default this is ~/.bazaar/
742
TODO: Global option --config-dir to override this.
744
base = os.environ.get('BZR_HOME', None)
745
if sys.platform == 'win32':
747
base = win32utils.get_appdata_location_unicode()
749
base = os.environ.get('HOME', None)
751
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
752
return osutils.pathjoin(base, 'bazaar', '2.0')
754
# cygwin, linux, and darwin all have a $HOME directory
756
base = os.path.expanduser("~")
757
return osutils.pathjoin(base, ".bazaar")
760
def config_filename():
761
"""Return per-user configuration ini file filename."""
762
return osutils.pathjoin(config_dir(), 'bazaar.conf')
765
def branches_config_filename():
766
"""Return per-user configuration ini file filename."""
767
return osutils.pathjoin(config_dir(), 'branches.conf')
770
def locations_config_filename():
771
"""Return per-user configuration ini file filename."""
772
return osutils.pathjoin(config_dir(), 'locations.conf')
775
def user_ignore_config_filename():
776
"""Return the user default ignore filename"""
777
return osutils.pathjoin(config_dir(), 'ignore')
781
"""Calculate automatic user identification.
783
Returns (realname, email).
785
Only used when none is set in the environment or the id file.
787
This previously used the FQDN as the default domain, but that can
788
be very slow on machines where DNS is broken. So now we simply
793
if sys.platform == 'win32':
794
name = win32utils.get_user_name_unicode()
796
raise errors.BzrError("Cannot autodetect user name.\n"
797
"Please, set your name with command like:\n"
798
'bzr whoami "Your Name <name@domain.com>"')
799
host = win32utils.get_host_name_unicode()
801
host = socket.gethostname()
802
return name, (name + '@' + host)
807
w = pwd.getpwuid(uid)
809
# we try utf-8 first, because on many variants (like Linux),
810
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
811
# false positives. (many users will have their user encoding set to
812
# latin-1, which cannot raise UnicodeError.)
814
gecos = w.pw_gecos.decode('utf-8')
818
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
819
encoding = bzrlib.user_encoding
821
raise errors.BzrCommandError('Unable to determine your name. '
822
'Use "bzr whoami" to set it.')
824
username = w.pw_name.decode(encoding)
826
raise errors.BzrCommandError('Unable to determine your name. '
827
'Use "bzr whoami" to set it.')
829
comma = gecos.find(',')
833
realname = gecos[:comma]
840
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
841
except UnicodeDecodeError:
842
raise errors.BzrError("Can't decode username as %s." % \
843
bzrlib.user_encoding)
845
return realname, (username + '@' + socket.gethostname())
848
def extract_email_address(e):
849
"""Return just the address part of an email string.
851
That is just the user@domain part, nothing else.
852
This part is required to contain only ascii characters.
853
If it can't be extracted, raises an error.
855
>>> extract_email_address('Jane Tester <jane@test.com>')
858
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
860
raise errors.NoEmailInUsername(e)
864
class TreeConfig(IniBasedConfig):
865
"""Branch configuration data associated with its contents, not location"""
866
def __init__(self, branch):
869
def _get_parser(self, file=None):
871
return IniBasedConfig._get_parser(file)
872
return self._get_config()
874
def _get_config(self):
876
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
878
except errors.NoSuchFile:
879
obj = ConfigObj(encoding='utf=8')
882
def get_option(self, name, section=None, default=None):
883
self.branch.lock_read()
885
obj = self._get_config()
887
if section is not None:
896
def set_option(self, value, name, section=None):
897
"""Set a per-branch configuration option"""
898
self.branch.lock_write()
900
cfg_obj = self._get_config()
905
obj = cfg_obj[section]
907
cfg_obj[section] = {}
908
obj = cfg_obj[section]
910
out_file = StringIO()
911
cfg_obj.write(out_file)
913
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
