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,
161
raise errors.UnknownMailClient(selected_client)
162
return mail_client_class(self)
164
def _get_signature_checking(self):
165
"""Template method to override signature checking policy."""
167
def _get_signing_policy(self):
168
"""Template method to override signature creation policy."""
170
def _get_user_option(self, option_name):
171
"""Template method to provide a user option."""
174
def get_user_option(self, option_name):
175
"""Get a generic option - no special process, no default."""
176
return self._get_user_option(option_name)
178
def gpg_signing_command(self):
179
"""What program should be used to sign signatures?"""
180
result = self._gpg_signing_command()
185
def _gpg_signing_command(self):
186
"""See gpg_signing_command()."""
189
def log_format(self):
190
"""What log format should be used"""
191
result = self._log_format()
196
def _log_format(self):
197
"""See log_format()."""
201
super(Config, self).__init__()
203
def post_commit(self):
204
"""An ordered list of python functions to call.
206
Each function takes branch, rev_id as parameters.
208
return self._post_commit()
210
def _post_commit(self):
211
"""See Config.post_commit."""
214
def user_email(self):
215
"""Return just the email component of a username."""
216
return extract_email_address(self.username())
219
"""Return email-style username.
221
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
223
$BZR_EMAIL can be set to override this (as well as the
224
deprecated $BZREMAIL), then
225
the concrete policy type is checked, and finally
227
If none is found, a reasonable default is (hopefully)
230
TODO: Check it's reasonably well-formed.
232
v = os.environ.get('BZR_EMAIL')
234
return v.decode(bzrlib.user_encoding)
235
v = os.environ.get('BZREMAIL')
237
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
238
return v.decode(bzrlib.user_encoding)
240
v = self._get_user_id()
244
v = os.environ.get('EMAIL')
246
return v.decode(bzrlib.user_encoding)
248
name, email = _auto_user_id()
250
return '%s <%s>' % (name, email)
254
def signature_checking(self):
255
"""What is the current policy for signature checking?."""
256
policy = self._get_signature_checking()
257
if policy is not None:
259
return CHECK_IF_POSSIBLE
261
def signing_policy(self):
262
"""What is the current policy for signature checking?."""
263
policy = self._get_signing_policy()
264
if policy is not None:
266
return SIGN_WHEN_REQUIRED
268
def signature_needed(self):
269
"""Is a signature needed when committing ?."""
270
policy = self._get_signing_policy()
272
policy = self._get_signature_checking()
273
if policy is not None:
274
warning("Please use create_signatures, not check_signatures "
275
"to set signing policy.")
276
if policy == CHECK_ALWAYS:
278
elif policy == SIGN_ALWAYS:
282
def get_alias(self, value):
283
return self._get_alias(value)
285
def _get_alias(self, value):
288
def get_nickname(self):
289
return self._get_nickname()
291
def _get_nickname(self):
295
class IniBasedConfig(Config):
296
"""A configuration policy that draws from ini files."""
298
def _get_parser(self, file=None):
299
if self._parser is not None:
302
input = self._get_filename()
306
self._parser = ConfigObj(input, encoding='utf-8')
307
except configobj.ConfigObjError, e:
308
raise errors.ParseConfigError(e.errors, e.config.filename)
311
def _get_matching_sections(self):
312
"""Return an ordered list of (section_name, extra_path) pairs.
314
If the section contains inherited configuration, extra_path is
315
a string containing the additional path components.
317
section = self._get_section()
318
if section is not None:
319
return [(section, '')]
323
def _get_section(self):
324
"""Override this to define the section used by the config."""
327
def _get_option_policy(self, section, option_name):
328
"""Return the policy for the given (section, option_name) pair."""
331
def _get_signature_checking(self):
332
"""See Config._get_signature_checking."""
333
policy = self._get_user_option('check_signatures')
335
return self._string_to_signature_policy(policy)
337
def _get_signing_policy(self):
338
"""See Config._get_signing_policy"""
339
policy = self._get_user_option('create_signatures')
341
return self._string_to_signing_policy(policy)
343
def _get_user_id(self):
344
"""Get the user id from the 'email' key in the current section."""
345
return self._get_user_option('email')
347
def _get_user_option(self, option_name):
348
"""See Config._get_user_option."""
349
for (section, extra_path) in self._get_matching_sections():
351
value = self._get_parser().get_value(section, option_name)
354
policy = self._get_option_policy(section, option_name)
355
if policy == POLICY_NONE:
357
elif policy == POLICY_NORECURSE:
358
# norecurse items only apply to the exact path
363
elif policy == POLICY_APPENDPATH:
365
value = urlutils.join(value, extra_path)
368
raise AssertionError('Unexpected config policy %r' % policy)
372
def _gpg_signing_command(self):
373
"""See Config.gpg_signing_command."""
374
return self._get_user_option('gpg_signing_command')
376
def _log_format(self):
377
"""See Config.log_format."""
378
return self._get_user_option('log_format')
380
def __init__(self, get_filename):
381
super(IniBasedConfig, self).__init__()
382
self._get_filename = get_filename
385
def _post_commit(self):
386
"""See Config.post_commit."""
387
return self._get_user_option('post_commit')
389
def _string_to_signature_policy(self, signature_string):
390
"""Convert a string to a signing policy."""
391
if signature_string.lower() == 'check-available':
392
return CHECK_IF_POSSIBLE
393
if signature_string.lower() == 'ignore':
395
if signature_string.lower() == 'require':
397
raise errors.BzrError("Invalid signatures policy '%s'"
400
def _string_to_signing_policy(self, signature_string):
401
"""Convert a string to a signing policy."""
402
if signature_string.lower() == 'when-required':
403
return SIGN_WHEN_REQUIRED
404
if signature_string.lower() == 'never':
406
if signature_string.lower() == 'always':
408
raise errors.BzrError("Invalid signing policy '%s'"
411
def _get_alias(self, value):
413
return self._get_parser().get_value("ALIASES",
418
def _get_nickname(self):
419
return self.get_user_option('nickname')
422
class GlobalConfig(IniBasedConfig):
423
"""The configuration that should be used for a specific location."""
425
def get_editor(self):
426
return self._get_user_option('editor')
429
super(GlobalConfig, self).__init__(config_filename)
431
def set_user_option(self, option, value):
432
"""Save option and its value in the configuration."""
433
# FIXME: RBC 20051029 This should refresh the parser and also take a
434
# file lock on bazaar.conf.
435
conf_dir = os.path.dirname(self._get_filename())
436
ensure_config_dir_exists(conf_dir)
437
if 'DEFAULT' not in self._get_parser():
438
self._get_parser()['DEFAULT'] = {}
439
self._get_parser()['DEFAULT'][option] = value
440
f = open(self._get_filename(), 'wb')
441
self._get_parser().write(f)
445
class LocationConfig(IniBasedConfig):
446
"""A configuration object that gives the policy for a location."""
448
def __init__(self, location):
449
name_generator = locations_config_filename
450
if (not os.path.exists(name_generator()) and
451
os.path.exists(branches_config_filename())):
452
if sys.platform == 'win32':
453
warning('Please rename %s to %s'
454
% (branches_config_filename(),
455
locations_config_filename()))
457
warning('Please rename ~/.bazaar/branches.conf'
458
' to ~/.bazaar/locations.conf')
459
name_generator = branches_config_filename
460
super(LocationConfig, self).__init__(name_generator)
461
# local file locations are looked up by local path, rather than
462
# by file url. This is because the config file is a user
463
# file, and we would rather not expose the user to file urls.
464
if location.startswith('file://'):
465
location = urlutils.local_path_from_url(location)
466
self.location = location
468
def _get_matching_sections(self):
469
"""Return an ordered list of section names matching this location."""
470
sections = self._get_parser()
471
location_names = self.location.split('/')
472
if self.location.endswith('/'):
473
del location_names[-1]
475
for section in sections:
476
# location is a local path if possible, so we need
477
# to convert 'file://' urls to local paths if necessary.
478
# This also avoids having file:///path be a more exact
479
# match than '/path'.
480
if section.startswith('file://'):
481
section_path = urlutils.local_path_from_url(section)
483
section_path = section
484
section_names = section_path.split('/')
485
if section.endswith('/'):
486
del section_names[-1]
487
names = zip(location_names, section_names)
490
if not fnmatch(name[0], name[1]):
495
# so, for the common prefix they matched.
496
# if section is longer, no match.
497
if len(section_names) > len(location_names):
499
matches.append((len(section_names), section,
500
'/'.join(location_names[len(section_names):])))
501
matches.sort(reverse=True)
503
for (length, section, extra_path) in matches:
504
sections.append((section, extra_path))
505
# should we stop looking for parent configs here?
507
if self._get_parser()[section].as_bool('ignore_parents'):
513
def _get_option_policy(self, section, option_name):
514
"""Return the policy for the given (section, option_name) pair."""
515
# check for the old 'recurse=False' flag
517
recurse = self._get_parser()[section].as_bool('recurse')
521
return POLICY_NORECURSE
523
policy_key = option_name + ':policy'
525
policy_name = self._get_parser()[section][policy_key]
529
return _policy_value[policy_name]
531
def _set_option_policy(self, section, option_name, option_policy):
532
"""Set the policy for the given option name in the given section."""
533
# The old recurse=False option affects all options in the
534
# section. To handle multiple policies in the section, we
535
# need to convert it to a policy_norecurse key.
537
recurse = self._get_parser()[section].as_bool('recurse')
541
symbol_versioning.warn(
542
'The recurse option is deprecated as of 0.14. '
543
'The section "%s" has been converted to use policies.'
546
del self._get_parser()[section]['recurse']
548
for key in self._get_parser()[section].keys():
549
if not key.endswith(':policy'):
550
self._get_parser()[section][key +
551
':policy'] = 'norecurse'
553
policy_key = option_name + ':policy'
554
policy_name = _policy_name[option_policy]
555
if policy_name is not None:
556
self._get_parser()[section][policy_key] = policy_name
558
if policy_key in self._get_parser()[section]:
559
del self._get_parser()[section][policy_key]
561
def set_user_option(self, option, value, store=STORE_LOCATION):
562
"""Save option and its value in the configuration."""
563
assert store in [STORE_LOCATION,
564
STORE_LOCATION_NORECURSE,
565
STORE_LOCATION_APPENDPATH], 'bad storage policy'
566
# FIXME: RBC 20051029 This should refresh the parser and also take a
567
# file lock on locations.conf.
568
conf_dir = os.path.dirname(self._get_filename())
569
ensure_config_dir_exists(conf_dir)
570
location = self.location
571
if location.endswith('/'):
572
location = location[:-1]
573
if (not location in self._get_parser() and
574
not location + '/' in self._get_parser()):
575
self._get_parser()[location]={}
576
elif location + '/' in self._get_parser():
577
location = location + '/'
578
self._get_parser()[location][option]=value
579
# the allowed values of store match the config policies
580
self._set_option_policy(location, option, store)
581
self._get_parser().write(file(self._get_filename(), 'wb'))
584
class BranchConfig(Config):
585
"""A configuration object giving the policy for a branch."""
587
def _get_branch_data_config(self):
588
if self._branch_data_config is None:
589
self._branch_data_config = TreeConfig(self.branch)
590
return self._branch_data_config
592
def _get_location_config(self):
593
if self._location_config is None:
594
self._location_config = LocationConfig(self.branch.base)
595
return self._location_config
597
def _get_global_config(self):
598
if self._global_config is None:
599
self._global_config = GlobalConfig()
600
return self._global_config
602
def _get_best_value(self, option_name):
603
"""This returns a user option from local, tree or global config.
605
They are tried in that order. Use get_safe_value if trusted values
608
for source in self.option_sources:
609
value = getattr(source(), option_name)()
610
if value is not None:
614
def _get_safe_value(self, option_name):
615
"""This variant of get_best_value never returns untrusted values.
617
It does not return values from the branch data, because the branch may
618
not be controlled by the user.
620
We may wish to allow locations.conf to control whether branches are
621
trusted in the future.
623
for source in (self._get_location_config, self._get_global_config):
624
value = getattr(source(), option_name)()
625
if value is not None:
629
def _get_user_id(self):
630
"""Return the full user id for the branch.
632
e.g. "John Hacker <jhacker@foo.org>"
633
This is looked up in the email controlfile for the branch.
636
return (self.branch.control_files.get_utf8("email")
638
.decode(bzrlib.user_encoding)
640
except errors.NoSuchFile, e:
643
return self._get_best_value('_get_user_id')
645
def _get_signature_checking(self):
646
"""See Config._get_signature_checking."""
647
return self._get_best_value('_get_signature_checking')
649
def _get_signing_policy(self):
650
"""See Config._get_signing_policy."""
651
return self._get_best_value('_get_signing_policy')
653
def _get_user_option(self, option_name):
654
"""See Config._get_user_option."""
655
for source in self.option_sources:
656
value = source()._get_user_option(option_name)
657
if value is not None:
661
def set_user_option(self, name, value, store=STORE_BRANCH,
663
if store == STORE_BRANCH:
664
self._get_branch_data_config().set_option(value, name)
665
elif store == STORE_GLOBAL:
666
self._get_global_config().set_user_option(name, value)
668
self._get_location_config().set_user_option(name, value, store)
671
if store in (STORE_GLOBAL, STORE_BRANCH):
672
mask_value = self._get_location_config().get_user_option(name)
673
if mask_value is not None:
674
trace.warning('Value "%s" is masked by "%s" from'
675
' locations.conf', value, mask_value)
677
if store == STORE_GLOBAL:
678
branch_config = self._get_branch_data_config()
679
mask_value = branch_config.get_user_option(name)
680
if mask_value is not None:
681
trace.warning('Value "%s" is masked by "%s" from'
682
' branch.conf', value, mask_value)
685
def _gpg_signing_command(self):
686
"""See Config.gpg_signing_command."""
687
return self._get_safe_value('_gpg_signing_command')
689
def __init__(self, branch):
690
super(BranchConfig, self).__init__()
691
self._location_config = None
692
self._branch_data_config = None
693
self._global_config = None
695
self.option_sources = (self._get_location_config,
696
self._get_branch_data_config,
697
self._get_global_config)
699
def _post_commit(self):
700
"""See Config.post_commit."""
701
return self._get_safe_value('_post_commit')
703
def _get_nickname(self):
704
value = self._get_explicit_nickname()
705
if value is not None:
707
return urlutils.unescape(self.branch.base.split('/')[-2])
709
def has_explicit_nickname(self):
710
"""Return true if a nickname has been explicitly assigned."""
711
return self._get_explicit_nickname() is not None
713
def _get_explicit_nickname(self):
714
return self._get_best_value('_get_nickname')
716
def _log_format(self):
717
"""See Config.log_format."""
718
return self._get_best_value('_log_format')
721
def ensure_config_dir_exists(path=None):
722
"""Make sure a configuration directory exists.
723
This makes sure that the directory exists.
724
On windows, since configuration directories are 2 levels deep,
725
it makes sure both the directory and the parent directory exists.
729
if not os.path.isdir(path):
730
if sys.platform == 'win32':
731
parent_dir = os.path.dirname(path)
732
if not os.path.isdir(parent_dir):
733
mutter('creating config parent directory: %r', parent_dir)
735
mutter('creating config directory: %r', path)
740
"""Return per-user configuration directory.
742
By default this is ~/.bazaar/
744
TODO: Global option --config-dir to override this.
746
base = os.environ.get('BZR_HOME', None)
747
if sys.platform == 'win32':
749
base = win32utils.get_appdata_location_unicode()
751
base = os.environ.get('HOME', None)
753
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
754
return osutils.pathjoin(base, 'bazaar', '2.0')
756
# cygwin, linux, and darwin all have a $HOME directory
758
base = os.path.expanduser("~")
759
return osutils.pathjoin(base, ".bazaar")
762
def config_filename():
763
"""Return per-user configuration ini file filename."""
764
return osutils.pathjoin(config_dir(), 'bazaar.conf')
767
def branches_config_filename():
768
"""Return per-user configuration ini file filename."""
769
return osutils.pathjoin(config_dir(), 'branches.conf')
772
def locations_config_filename():
773
"""Return per-user configuration ini file filename."""
774
return osutils.pathjoin(config_dir(), 'locations.conf')
777
def user_ignore_config_filename():
778
"""Return the user default ignore filename"""
779
return osutils.pathjoin(config_dir(), 'ignore')
783
"""Calculate automatic user identification.
785
Returns (realname, email).
787
Only used when none is set in the environment or the id file.
789
This previously used the FQDN as the default domain, but that can
790
be very slow on machines where DNS is broken. So now we simply
795
if sys.platform == 'win32':
796
name = win32utils.get_user_name_unicode()
798
raise errors.BzrError("Cannot autodetect user name.\n"
799
"Please, set your name with command like:\n"
800
'bzr whoami "Your Name <name@domain.com>"')
801
host = win32utils.get_host_name_unicode()
803
host = socket.gethostname()
804
return name, (name + '@' + host)
809
w = pwd.getpwuid(uid)
811
# we try utf-8 first, because on many variants (like Linux),
812
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
813
# false positives. (many users will have their user encoding set to
814
# latin-1, which cannot raise UnicodeError.)
816
gecos = w.pw_gecos.decode('utf-8')
820
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
821
encoding = bzrlib.user_encoding
823
raise errors.BzrCommandError('Unable to determine your name. '
824
'Use "bzr whoami" to set it.')
826
username = w.pw_name.decode(encoding)
828
raise errors.BzrCommandError('Unable to determine your name. '
829
'Use "bzr whoami" to set it.')
831
comma = gecos.find(',')
835
realname = gecos[:comma]
842
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
843
except UnicodeDecodeError:
844
raise errors.BzrError("Can't decode username as %s." % \
845
bzrlib.user_encoding)
847
return realname, (username + '@' + socket.gethostname())
850
def extract_email_address(e):
851
"""Return just the address part of an email string.
853
That is just the user@domain part, nothing else.
854
This part is required to contain only ascii characters.
855
If it can't be extracted, raises an error.
857
>>> extract_email_address('Jane Tester <jane@test.com>')
860
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
862
raise errors.NoEmailInUsername(e)
866
class TreeConfig(IniBasedConfig):
867
"""Branch configuration data associated with its contents, not location"""
868
def __init__(self, branch):
871
def _get_parser(self, file=None):
873
return IniBasedConfig._get_parser(file)
874
return self._get_config()
876
def _get_config(self):
878
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
880
except errors.NoSuchFile:
881
obj = ConfigObj(encoding='utf=8')
884
def get_option(self, name, section=None, default=None):
885
self.branch.lock_read()
887
obj = self._get_config()
889
if section is not None:
898
def set_option(self, value, name, section=None):
899
"""Set a per-branch configuration option"""
900
self.branch.lock_write()
902
cfg_obj = self._get_config()
907
obj = cfg_obj[section]
909
cfg_obj[section] = {}
910
obj = cfg_obj[section]
912
out_file = StringIO()
913
cfg_obj.write(out_file)
915
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
