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
'thunderbird': mail_client.Thunderbird,
156
'evolution': mail_client.Evolution,
157
'mapi': mail_client.MAPIClient,
158
'xdg-email': mail_client.XDGEmail,
159
'kmail': mail_client.KMail,
162
raise errors.UnknownMailClient(selected_client)
163
return mail_client_class(self)
165
def _get_signature_checking(self):
166
"""Template method to override signature checking policy."""
168
def _get_signing_policy(self):
169
"""Template method to override signature creation policy."""
171
def _get_user_option(self, option_name):
172
"""Template method to provide a user option."""
175
def get_user_option(self, option_name):
176
"""Get a generic option - no special process, no default."""
177
return self._get_user_option(option_name)
179
def gpg_signing_command(self):
180
"""What program should be used to sign signatures?"""
181
result = self._gpg_signing_command()
186
def _gpg_signing_command(self):
187
"""See gpg_signing_command()."""
190
def log_format(self):
191
"""What log format should be used"""
192
result = self._log_format()
197
def _log_format(self):
198
"""See log_format()."""
202
super(Config, self).__init__()
204
def post_commit(self):
205
"""An ordered list of python functions to call.
207
Each function takes branch, rev_id as parameters.
209
return self._post_commit()
211
def _post_commit(self):
212
"""See Config.post_commit."""
215
def user_email(self):
216
"""Return just the email component of a username."""
217
return extract_email_address(self.username())
220
"""Return email-style username.
222
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
224
$BZR_EMAIL can be set to override this (as well as the
225
deprecated $BZREMAIL), then
226
the concrete policy type is checked, and finally
228
If none is found, a reasonable default is (hopefully)
231
TODO: Check it's reasonably well-formed.
233
v = os.environ.get('BZR_EMAIL')
235
return v.decode(bzrlib.user_encoding)
236
v = os.environ.get('BZREMAIL')
238
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
239
return v.decode(bzrlib.user_encoding)
241
v = self._get_user_id()
245
v = os.environ.get('EMAIL')
247
return v.decode(bzrlib.user_encoding)
249
name, email = _auto_user_id()
251
return '%s <%s>' % (name, email)
255
def signature_checking(self):
256
"""What is the current policy for signature checking?."""
257
policy = self._get_signature_checking()
258
if policy is not None:
260
return CHECK_IF_POSSIBLE
262
def signing_policy(self):
263
"""What is the current policy for signature checking?."""
264
policy = self._get_signing_policy()
265
if policy is not None:
267
return SIGN_WHEN_REQUIRED
269
def signature_needed(self):
270
"""Is a signature needed when committing ?."""
271
policy = self._get_signing_policy()
273
policy = self._get_signature_checking()
274
if policy is not None:
275
warning("Please use create_signatures, not check_signatures "
276
"to set signing policy.")
277
if policy == CHECK_ALWAYS:
279
elif policy == SIGN_ALWAYS:
283
def get_alias(self, value):
284
return self._get_alias(value)
286
def _get_alias(self, value):
289
def get_nickname(self):
290
return self._get_nickname()
292
def _get_nickname(self):
296
class IniBasedConfig(Config):
297
"""A configuration policy that draws from ini files."""
299
def _get_parser(self, file=None):
300
if self._parser is not None:
303
input = self._get_filename()
307
self._parser = ConfigObj(input, encoding='utf-8')
308
except configobj.ConfigObjError, e:
309
raise errors.ParseConfigError(e.errors, e.config.filename)
312
def _get_matching_sections(self):
313
"""Return an ordered list of (section_name, extra_path) pairs.
315
If the section contains inherited configuration, extra_path is
316
a string containing the additional path components.
318
section = self._get_section()
319
if section is not None:
320
return [(section, '')]
324
def _get_section(self):
325
"""Override this to define the section used by the config."""
328
def _get_option_policy(self, section, option_name):
329
"""Return the policy for the given (section, option_name) pair."""
332
def _get_signature_checking(self):
333
"""See Config._get_signature_checking."""
334
policy = self._get_user_option('check_signatures')
336
return self._string_to_signature_policy(policy)
338
def _get_signing_policy(self):
339
"""See Config._get_signing_policy"""
340
policy = self._get_user_option('create_signatures')
342
return self._string_to_signing_policy(policy)
344
def _get_user_id(self):
345
"""Get the user id from the 'email' key in the current section."""
346
return self._get_user_option('email')
348
def _get_user_option(self, option_name):
349
"""See Config._get_user_option."""
350
for (section, extra_path) in self._get_matching_sections():
352
value = self._get_parser().get_value(section, option_name)
355
policy = self._get_option_policy(section, option_name)
356
if policy == POLICY_NONE:
358
elif policy == POLICY_NORECURSE:
359
# norecurse items only apply to the exact path
364
elif policy == POLICY_APPENDPATH:
366
value = urlutils.join(value, extra_path)
369
raise AssertionError('Unexpected config policy %r' % policy)
373
def _gpg_signing_command(self):
374
"""See Config.gpg_signing_command."""
375
return self._get_user_option('gpg_signing_command')
377
def _log_format(self):
378
"""See Config.log_format."""
379
return self._get_user_option('log_format')
381
def __init__(self, get_filename):
382
super(IniBasedConfig, self).__init__()
383
self._get_filename = get_filename
386
def _post_commit(self):
387
"""See Config.post_commit."""
388
return self._get_user_option('post_commit')
390
def _string_to_signature_policy(self, signature_string):
391
"""Convert a string to a signing policy."""
392
if signature_string.lower() == 'check-available':
393
return CHECK_IF_POSSIBLE
394
if signature_string.lower() == 'ignore':
396
if signature_string.lower() == 'require':
398
raise errors.BzrError("Invalid signatures policy '%s'"
401
def _string_to_signing_policy(self, signature_string):
402
"""Convert a string to a signing policy."""
403
if signature_string.lower() == 'when-required':
404
return SIGN_WHEN_REQUIRED
405
if signature_string.lower() == 'never':
407
if signature_string.lower() == 'always':
409
raise errors.BzrError("Invalid signing policy '%s'"
412
def _get_alias(self, value):
414
return self._get_parser().get_value("ALIASES",
419
def _get_nickname(self):
420
return self.get_user_option('nickname')
423
class GlobalConfig(IniBasedConfig):
424
"""The configuration that should be used for a specific location."""
426
def get_editor(self):
427
return self._get_user_option('editor')
430
super(GlobalConfig, self).__init__(config_filename)
432
def set_user_option(self, option, value):
433
"""Save option and its value in the configuration."""
434
# FIXME: RBC 20051029 This should refresh the parser and also take a
435
# file lock on bazaar.conf.
436
conf_dir = os.path.dirname(self._get_filename())
437
ensure_config_dir_exists(conf_dir)
438
if 'DEFAULT' not in self._get_parser():
439
self._get_parser()['DEFAULT'] = {}
440
self._get_parser()['DEFAULT'][option] = value
441
f = open(self._get_filename(), 'wb')
442
self._get_parser().write(f)
446
class LocationConfig(IniBasedConfig):
447
"""A configuration object that gives the policy for a location."""
449
def __init__(self, location):
450
name_generator = locations_config_filename
451
if (not os.path.exists(name_generator()) and
452
os.path.exists(branches_config_filename())):
453
if sys.platform == 'win32':
454
warning('Please rename %s to %s'
455
% (branches_config_filename(),
456
locations_config_filename()))
458
warning('Please rename ~/.bazaar/branches.conf'
459
' to ~/.bazaar/locations.conf')
460
name_generator = branches_config_filename
461
super(LocationConfig, self).__init__(name_generator)
462
# local file locations are looked up by local path, rather than
463
# by file url. This is because the config file is a user
464
# file, and we would rather not expose the user to file urls.
465
if location.startswith('file://'):
466
location = urlutils.local_path_from_url(location)
467
self.location = location
469
def _get_matching_sections(self):
470
"""Return an ordered list of section names matching this location."""
471
sections = self._get_parser()
472
location_names = self.location.split('/')
473
if self.location.endswith('/'):
474
del location_names[-1]
476
for section in sections:
477
# location is a local path if possible, so we need
478
# to convert 'file://' urls to local paths if necessary.
479
# This also avoids having file:///path be a more exact
480
# match than '/path'.
481
if section.startswith('file://'):
482
section_path = urlutils.local_path_from_url(section)
484
section_path = section
485
section_names = section_path.split('/')
486
if section.endswith('/'):
487
del section_names[-1]
488
names = zip(location_names, section_names)
491
if not fnmatch(name[0], name[1]):
496
# so, for the common prefix they matched.
497
# if section is longer, no match.
498
if len(section_names) > len(location_names):
500
matches.append((len(section_names), section,
501
'/'.join(location_names[len(section_names):])))
502
matches.sort(reverse=True)
504
for (length, section, extra_path) in matches:
505
sections.append((section, extra_path))
506
# should we stop looking for parent configs here?
508
if self._get_parser()[section].as_bool('ignore_parents'):
514
def _get_option_policy(self, section, option_name):
515
"""Return the policy for the given (section, option_name) pair."""
516
# check for the old 'recurse=False' flag
518
recurse = self._get_parser()[section].as_bool('recurse')
522
return POLICY_NORECURSE
524
policy_key = option_name + ':policy'
526
policy_name = self._get_parser()[section][policy_key]
530
return _policy_value[policy_name]
532
def _set_option_policy(self, section, option_name, option_policy):
533
"""Set the policy for the given option name in the given section."""
534
# The old recurse=False option affects all options in the
535
# section. To handle multiple policies in the section, we
536
# need to convert it to a policy_norecurse key.
538
recurse = self._get_parser()[section].as_bool('recurse')
542
symbol_versioning.warn(
543
'The recurse option is deprecated as of 0.14. '
544
'The section "%s" has been converted to use policies.'
547
del self._get_parser()[section]['recurse']
549
for key in self._get_parser()[section].keys():
550
if not key.endswith(':policy'):
551
self._get_parser()[section][key +
552
':policy'] = 'norecurse'
554
policy_key = option_name + ':policy'
555
policy_name = _policy_name[option_policy]
556
if policy_name is not None:
557
self._get_parser()[section][policy_key] = policy_name
559
if policy_key in self._get_parser()[section]:
560
del self._get_parser()[section][policy_key]
562
def set_user_option(self, option, value, store=STORE_LOCATION):
563
"""Save option and its value in the configuration."""
564
assert store in [STORE_LOCATION,
565
STORE_LOCATION_NORECURSE,
566
STORE_LOCATION_APPENDPATH], 'bad storage policy'
567
# FIXME: RBC 20051029 This should refresh the parser and also take a
568
# file lock on locations.conf.
569
conf_dir = os.path.dirname(self._get_filename())
570
ensure_config_dir_exists(conf_dir)
571
location = self.location
572
if location.endswith('/'):
573
location = location[:-1]
574
if (not location in self._get_parser() and
575
not location + '/' in self._get_parser()):
576
self._get_parser()[location]={}
577
elif location + '/' in self._get_parser():
578
location = location + '/'
579
self._get_parser()[location][option]=value
580
# the allowed values of store match the config policies
581
self._set_option_policy(location, option, store)
582
self._get_parser().write(file(self._get_filename(), 'wb'))
585
class BranchConfig(Config):
586
"""A configuration object giving the policy for a branch."""
588
def _get_branch_data_config(self):
589
if self._branch_data_config is None:
590
self._branch_data_config = TreeConfig(self.branch)
591
return self._branch_data_config
593
def _get_location_config(self):
594
if self._location_config is None:
595
self._location_config = LocationConfig(self.branch.base)
596
return self._location_config
598
def _get_global_config(self):
599
if self._global_config is None:
600
self._global_config = GlobalConfig()
601
return self._global_config
603
def _get_best_value(self, option_name):
604
"""This returns a user option from local, tree or global config.
606
They are tried in that order. Use get_safe_value if trusted values
609
for source in self.option_sources:
610
value = getattr(source(), option_name)()
611
if value is not None:
615
def _get_safe_value(self, option_name):
616
"""This variant of get_best_value never returns untrusted values.
618
It does not return values from the branch data, because the branch may
619
not be controlled by the user.
621
We may wish to allow locations.conf to control whether branches are
622
trusted in the future.
624
for source in (self._get_location_config, self._get_global_config):
625
value = getattr(source(), option_name)()
626
if value is not None:
630
def _get_user_id(self):
631
"""Return the full user id for the branch.
633
e.g. "John Hacker <jhacker@foo.org>"
634
This is looked up in the email controlfile for the branch.
637
return (self.branch.control_files.get_utf8("email")
639
.decode(bzrlib.user_encoding)
641
except errors.NoSuchFile, e:
644
return self._get_best_value('_get_user_id')
646
def _get_signature_checking(self):
647
"""See Config._get_signature_checking."""
648
return self._get_best_value('_get_signature_checking')
650
def _get_signing_policy(self):
651
"""See Config._get_signing_policy."""
652
return self._get_best_value('_get_signing_policy')
654
def _get_user_option(self, option_name):
655
"""See Config._get_user_option."""
656
for source in self.option_sources:
657
value = source()._get_user_option(option_name)
658
if value is not None:
662
def set_user_option(self, name, value, store=STORE_BRANCH,
664
if store == STORE_BRANCH:
665
self._get_branch_data_config().set_option(value, name)
666
elif store == STORE_GLOBAL:
667
self._get_global_config().set_user_option(name, value)
669
self._get_location_config().set_user_option(name, value, store)
672
if store in (STORE_GLOBAL, STORE_BRANCH):
673
mask_value = self._get_location_config().get_user_option(name)
674
if mask_value is not None:
675
trace.warning('Value "%s" is masked by "%s" from'
676
' locations.conf', value, mask_value)
678
if store == STORE_GLOBAL:
679
branch_config = self._get_branch_data_config()
680
mask_value = branch_config.get_user_option(name)
681
if mask_value is not None:
682
trace.warning('Value "%s" is masked by "%s" from'
683
' branch.conf', value, mask_value)
686
def _gpg_signing_command(self):
687
"""See Config.gpg_signing_command."""
688
return self._get_safe_value('_gpg_signing_command')
690
def __init__(self, branch):
691
super(BranchConfig, self).__init__()
692
self._location_config = None
693
self._branch_data_config = None
694
self._global_config = None
696
self.option_sources = (self._get_location_config,
697
self._get_branch_data_config,
698
self._get_global_config)
700
def _post_commit(self):
701
"""See Config.post_commit."""
702
return self._get_safe_value('_post_commit')
704
def _get_nickname(self):
705
value = self._get_explicit_nickname()
706
if value is not None:
708
return urlutils.unescape(self.branch.base.split('/')[-2])
710
def has_explicit_nickname(self):
711
"""Return true if a nickname has been explicitly assigned."""
712
return self._get_explicit_nickname() is not None
714
def _get_explicit_nickname(self):
715
return self._get_best_value('_get_nickname')
717
def _log_format(self):
718
"""See Config.log_format."""
719
return self._get_best_value('_log_format')
722
def ensure_config_dir_exists(path=None):
723
"""Make sure a configuration directory exists.
724
This makes sure that the directory exists.
725
On windows, since configuration directories are 2 levels deep,
726
it makes sure both the directory and the parent directory exists.
730
if not os.path.isdir(path):
731
if sys.platform == 'win32':
732
parent_dir = os.path.dirname(path)
733
if not os.path.isdir(parent_dir):
734
mutter('creating config parent directory: %r', parent_dir)
736
mutter('creating config directory: %r', path)
741
"""Return per-user configuration directory.
743
By default this is ~/.bazaar/
745
TODO: Global option --config-dir to override this.
747
base = os.environ.get('BZR_HOME', None)
748
if sys.platform == 'win32':
750
base = win32utils.get_appdata_location_unicode()
752
base = os.environ.get('HOME', None)
754
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
755
return osutils.pathjoin(base, 'bazaar', '2.0')
757
# cygwin, linux, and darwin all have a $HOME directory
759
base = os.path.expanduser("~")
760
return osutils.pathjoin(base, ".bazaar")
763
def config_filename():
764
"""Return per-user configuration ini file filename."""
765
return osutils.pathjoin(config_dir(), 'bazaar.conf')
768
def branches_config_filename():
769
"""Return per-user configuration ini file filename."""
770
return osutils.pathjoin(config_dir(), 'branches.conf')
773
def locations_config_filename():
774
"""Return per-user configuration ini file filename."""
775
return osutils.pathjoin(config_dir(), 'locations.conf')
778
def user_ignore_config_filename():
779
"""Return the user default ignore filename"""
780
return osutils.pathjoin(config_dir(), 'ignore')
784
"""Calculate automatic user identification.
786
Returns (realname, email).
788
Only used when none is set in the environment or the id file.
790
This previously used the FQDN as the default domain, but that can
791
be very slow on machines where DNS is broken. So now we simply
796
if sys.platform == 'win32':
797
name = win32utils.get_user_name_unicode()
799
raise errors.BzrError("Cannot autodetect user name.\n"
800
"Please, set your name with command like:\n"
801
'bzr whoami "Your Name <name@domain.com>"')
802
host = win32utils.get_host_name_unicode()
804
host = socket.gethostname()
805
return name, (name + '@' + host)
810
w = pwd.getpwuid(uid)
812
# we try utf-8 first, because on many variants (like Linux),
813
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
814
# false positives. (many users will have their user encoding set to
815
# latin-1, which cannot raise UnicodeError.)
817
gecos = w.pw_gecos.decode('utf-8')
821
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
822
encoding = bzrlib.user_encoding
824
raise errors.BzrCommandError('Unable to determine your name. '
825
'Use "bzr whoami" to set it.')
827
username = w.pw_name.decode(encoding)
829
raise errors.BzrCommandError('Unable to determine your name. '
830
'Use "bzr whoami" to set it.')
832
comma = gecos.find(',')
836
realname = gecos[:comma]
843
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
844
except UnicodeDecodeError:
845
raise errors.BzrError("Can't decode username as %s." % \
846
bzrlib.user_encoding)
848
return realname, (username + '@' + socket.gethostname())
851
def extract_email_address(e):
852
"""Return just the address part of an email string.
854
That is just the user@domain part, nothing else.
855
This part is required to contain only ascii characters.
856
If it can't be extracted, raises an error.
858
>>> extract_email_address('Jane Tester <jane@test.com>')
861
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
863
raise errors.NoEmailInUsername(e)
867
class TreeConfig(IniBasedConfig):
868
"""Branch configuration data associated with its contents, not location"""
869
def __init__(self, branch):
872
def _get_parser(self, file=None):
874
return IniBasedConfig._get_parser(file)
875
return self._get_config()
877
def _get_config(self):
879
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
881
except errors.NoSuchFile:
882
obj = ConfigObj(encoding='utf=8')
885
def get_option(self, name, section=None, default=None):
886
self.branch.lock_read()
888
obj = self._get_config()
890
if section is not None:
899
def set_option(self, value, name, section=None):
900
"""Set a per-branch configuration option"""
901
self.branch.lock_write()
903
cfg_obj = self._get_config()
908
obj = cfg_obj[section]
910
cfg_obj[section] = {}
911
obj = cfg_obj[section]
913
out_file = StringIO()
914
cfg_obj.write(out_file)
916
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
