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
84
import bzrlib.util.configobj.configobj as configobj
87
from bzrlib.trace import mutter, warning
102
POLICY_APPENDPATH = 2
106
POLICY_NORECURSE: 'norecurse',
107
POLICY_APPENDPATH: 'appendpath',
112
'norecurse': POLICY_NORECURSE,
113
'appendpath': POLICY_APPENDPATH,
117
STORE_LOCATION = POLICY_NONE
118
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
119
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
124
class ConfigObj(configobj.ConfigObj):
126
def get_bool(self, section, key):
127
return self[section].as_bool(key)
129
def get_value(self, section, name):
130
# Try [] for the old DEFAULT section.
131
if section == "DEFAULT":
136
return self[section][name]
139
class Config(object):
140
"""A configuration policy - what username, editor, gpg needs etc."""
142
def get_editor(self):
143
"""Get the users pop up editor."""
144
raise NotImplementedError
146
def _get_signature_checking(self):
147
"""Template method to override signature checking policy."""
149
def _get_signing_policy(self):
150
"""Template method to override signature creation policy."""
152
def _get_user_option(self, option_name):
153
"""Template method to provide a user option."""
156
def get_user_option(self, option_name):
157
"""Get a generic option - no special process, no default."""
158
return self._get_user_option(option_name)
160
def gpg_signing_command(self):
161
"""What program should be used to sign signatures?"""
162
result = self._gpg_signing_command()
167
def _gpg_signing_command(self):
168
"""See gpg_signing_command()."""
171
def log_format(self):
172
"""What log format should be used"""
173
result = self._log_format()
178
def _log_format(self):
179
"""See log_format()."""
183
super(Config, self).__init__()
185
def post_commit(self):
186
"""An ordered list of python functions to call.
188
Each function takes branch, rev_id as parameters.
190
return self._post_commit()
192
def _post_commit(self):
193
"""See Config.post_commit."""
196
def user_email(self):
197
"""Return just the email component of a username."""
198
return extract_email_address(self.username())
201
"""Return email-style username.
203
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
205
$BZR_EMAIL can be set to override this (as well as the
206
deprecated $BZREMAIL), then
207
the concrete policy type is checked, and finally
209
If none is found, a reasonable default is (hopefully)
212
TODO: Check it's reasonably well-formed.
214
v = os.environ.get('BZR_EMAIL')
216
return v.decode(bzrlib.user_encoding)
217
v = os.environ.get('BZREMAIL')
219
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
220
return v.decode(bzrlib.user_encoding)
222
v = self._get_user_id()
226
v = os.environ.get('EMAIL')
228
return v.decode(bzrlib.user_encoding)
230
name, email = _auto_user_id()
232
return '%s <%s>' % (name, email)
236
def signature_checking(self):
237
"""What is the current policy for signature checking?."""
238
policy = self._get_signature_checking()
239
if policy is not None:
241
return CHECK_IF_POSSIBLE
243
def signing_policy(self):
244
"""What is the current policy for signature checking?."""
245
policy = self._get_signing_policy()
246
if policy is not None:
248
return SIGN_WHEN_REQUIRED
250
def signature_needed(self):
251
"""Is a signature needed when committing ?."""
252
policy = self._get_signing_policy()
254
policy = self._get_signature_checking()
255
if policy is not None:
256
warning("Please use create_signatures, not check_signatures "
257
"to set signing policy.")
258
if policy == CHECK_ALWAYS:
260
elif policy == SIGN_ALWAYS:
264
def get_alias(self, value):
265
return self._get_alias(value)
267
def _get_alias(self, value):
270
def get_nickname(self):
271
return self._get_nickname()
273
def _get_nickname(self):
277
class IniBasedConfig(Config):
278
"""A configuration policy that draws from ini files."""
280
def _get_parser(self, file=None):
281
if self._parser is not None:
284
input = self._get_filename()
288
self._parser = ConfigObj(input, encoding='utf-8')
289
except configobj.ConfigObjError, e:
290
raise errors.ParseConfigError(e.errors, e.config.filename)
293
def _get_matching_sections(self):
294
"""Return an ordered list of (section_name, extra_path) pairs.
296
If the section contains inherited configuration, extra_path is
297
a string containing the additional path components.
299
section = self._get_section()
300
if section is not None:
301
return [(section, '')]
305
def _get_section(self):
306
"""Override this to define the section used by the config."""
309
def _get_option_policy(self, section, option_name):
310
"""Return the policy for the given (section, option_name) pair."""
313
def _get_signature_checking(self):
314
"""See Config._get_signature_checking."""
315
policy = self._get_user_option('check_signatures')
317
return self._string_to_signature_policy(policy)
319
def _get_signing_policy(self):
320
"""See Config._get_signing_policy"""
321
policy = self._get_user_option('create_signatures')
323
return self._string_to_signing_policy(policy)
325
def _get_user_id(self):
326
"""Get the user id from the 'email' key in the current section."""
327
return self._get_user_option('email')
329
def _get_user_option(self, option_name):
330
"""See Config._get_user_option."""
331
for (section, extra_path) in self._get_matching_sections():
333
value = self._get_parser().get_value(section, option_name)
336
policy = self._get_option_policy(section, option_name)
337
if policy == POLICY_NONE:
339
elif policy == POLICY_NORECURSE:
340
# norecurse items only apply to the exact path
345
elif policy == POLICY_APPENDPATH:
347
value = urlutils.join(value, extra_path)
350
raise AssertionError('Unexpected config policy %r' % policy)
354
def _gpg_signing_command(self):
355
"""See Config.gpg_signing_command."""
356
return self._get_user_option('gpg_signing_command')
358
def _log_format(self):
359
"""See Config.log_format."""
360
return self._get_user_option('log_format')
362
def __init__(self, get_filename):
363
super(IniBasedConfig, self).__init__()
364
self._get_filename = get_filename
367
def _post_commit(self):
368
"""See Config.post_commit."""
369
return self._get_user_option('post_commit')
371
def _string_to_signature_policy(self, signature_string):
372
"""Convert a string to a signing policy."""
373
if signature_string.lower() == 'check-available':
374
return CHECK_IF_POSSIBLE
375
if signature_string.lower() == 'ignore':
377
if signature_string.lower() == 'require':
379
raise errors.BzrError("Invalid signatures policy '%s'"
382
def _string_to_signing_policy(self, signature_string):
383
"""Convert a string to a signing policy."""
384
if signature_string.lower() == 'when-required':
385
return SIGN_WHEN_REQUIRED
386
if signature_string.lower() == 'never':
388
if signature_string.lower() == 'always':
390
raise errors.BzrError("Invalid signing policy '%s'"
393
def _get_alias(self, value):
395
return self._get_parser().get_value("ALIASES",
400
def _get_nickname(self):
401
return self.get_user_option('nickname')
404
class GlobalConfig(IniBasedConfig):
405
"""The configuration that should be used for a specific location."""
407
def get_editor(self):
408
return self._get_user_option('editor')
411
super(GlobalConfig, self).__init__(config_filename)
413
def set_user_option(self, option, value):
414
"""Save option and its value in the configuration."""
415
# FIXME: RBC 20051029 This should refresh the parser and also take a
416
# file lock on bazaar.conf.
417
conf_dir = os.path.dirname(self._get_filename())
418
ensure_config_dir_exists(conf_dir)
419
if 'DEFAULT' not in self._get_parser():
420
self._get_parser()['DEFAULT'] = {}
421
self._get_parser()['DEFAULT'][option] = value
422
f = open(self._get_filename(), 'wb')
423
self._get_parser().write(f)
427
class LocationConfig(IniBasedConfig):
428
"""A configuration object that gives the policy for a location."""
430
def __init__(self, location):
431
name_generator = locations_config_filename
432
if (not os.path.exists(name_generator()) and
433
os.path.exists(branches_config_filename())):
434
if sys.platform == 'win32':
435
warning('Please rename %s to %s'
436
% (branches_config_filename(),
437
locations_config_filename()))
439
warning('Please rename ~/.bazaar/branches.conf'
440
' to ~/.bazaar/locations.conf')
441
name_generator = branches_config_filename
442
super(LocationConfig, self).__init__(name_generator)
443
# local file locations are looked up by local path, rather than
444
# by file url. This is because the config file is a user
445
# file, and we would rather not expose the user to file urls.
446
if location.startswith('file://'):
447
location = urlutils.local_path_from_url(location)
448
self.location = location
450
def _get_matching_sections(self):
451
"""Return an ordered list of section names matching this location."""
452
sections = self._get_parser()
453
location_names = self.location.split('/')
454
if self.location.endswith('/'):
455
del location_names[-1]
457
for section in sections:
458
# location is a local path if possible, so we need
459
# to convert 'file://' urls to local paths if necessary.
460
# This also avoids having file:///path be a more exact
461
# match than '/path'.
462
if section.startswith('file://'):
463
section_path = urlutils.local_path_from_url(section)
465
section_path = section
466
section_names = section_path.split('/')
467
if section.endswith('/'):
468
del section_names[-1]
469
names = zip(location_names, section_names)
472
if not fnmatch(name[0], name[1]):
477
# so, for the common prefix they matched.
478
# if section is longer, no match.
479
if len(section_names) > len(location_names):
481
matches.append((len(section_names), section,
482
'/'.join(location_names[len(section_names):])))
483
matches.sort(reverse=True)
485
for (length, section, extra_path) in matches:
486
sections.append((section, extra_path))
487
# should we stop looking for parent configs here?
489
if self._get_parser()[section].as_bool('ignore_parents'):
495
def _get_option_policy(self, section, option_name):
496
"""Return the policy for the given (section, option_name) pair."""
497
# check for the old 'recurse=False' flag
499
recurse = self._get_parser()[section].as_bool('recurse')
503
return POLICY_NORECURSE
505
policy_key = option_name + ':policy'
507
policy_name = self._get_parser()[section][policy_key]
511
return _policy_value[policy_name]
513
def _set_option_policy(self, section, option_name, option_policy):
514
"""Set the policy for the given option name in the given section."""
515
# The old recurse=False option affects all options in the
516
# section. To handle multiple policies in the section, we
517
# need to convert it to a policy_norecurse key.
519
recurse = self._get_parser()[section].as_bool('recurse')
523
symbol_versioning.warn(
524
'The recurse option is deprecated as of 0.14. '
525
'The section "%s" has been converted to use policies.'
528
del self._get_parser()[section]['recurse']
530
for key in self._get_parser()[section].keys():
531
if not key.endswith(':policy'):
532
self._get_parser()[section][key +
533
':policy'] = 'norecurse'
535
policy_key = option_name + ':policy'
536
policy_name = _policy_name[option_policy]
537
if policy_name is not None:
538
self._get_parser()[section][policy_key] = policy_name
540
if policy_key in self._get_parser()[section]:
541
del self._get_parser()[section][policy_key]
543
def set_user_option(self, option, value, store=STORE_LOCATION):
544
"""Save option and its value in the configuration."""
545
assert store in [STORE_LOCATION,
546
STORE_LOCATION_NORECURSE,
547
STORE_LOCATION_APPENDPATH], 'bad storage policy'
548
# FIXME: RBC 20051029 This should refresh the parser and also take a
549
# file lock on locations.conf.
550
conf_dir = os.path.dirname(self._get_filename())
551
ensure_config_dir_exists(conf_dir)
552
location = self.location
553
if location.endswith('/'):
554
location = location[:-1]
555
if (not location in self._get_parser() and
556
not location + '/' in self._get_parser()):
557
self._get_parser()[location]={}
558
elif location + '/' in self._get_parser():
559
location = location + '/'
560
self._get_parser()[location][option]=value
561
# the allowed values of store match the config policies
562
self._set_option_policy(location, option, store)
563
self._get_parser().write(file(self._get_filename(), 'wb'))
566
class BranchConfig(Config):
567
"""A configuration object giving the policy for a branch."""
569
def _get_branch_data_config(self):
570
if self._branch_data_config is None:
571
self._branch_data_config = TreeConfig(self.branch)
572
return self._branch_data_config
574
def _get_location_config(self):
575
if self._location_config is None:
576
self._location_config = LocationConfig(self.branch.base)
577
return self._location_config
579
def _get_global_config(self):
580
if self._global_config is None:
581
self._global_config = GlobalConfig()
582
return self._global_config
584
def _get_best_value(self, option_name):
585
"""This returns a user option from local, tree or global config.
587
They are tried in that order. Use get_safe_value if trusted values
590
for source in self.option_sources:
591
value = getattr(source(), option_name)()
592
if value is not None:
596
def _get_safe_value(self, option_name):
597
"""This variant of get_best_value never returns untrusted values.
599
It does not return values from the branch data, because the branch may
600
not be controlled by the user.
602
We may wish to allow locations.conf to control whether branches are
603
trusted in the future.
605
for source in (self._get_location_config, self._get_global_config):
606
value = getattr(source(), option_name)()
607
if value is not None:
611
def _get_user_id(self):
612
"""Return the full user id for the branch.
614
e.g. "John Hacker <jhacker@foo.org>"
615
This is looked up in the email controlfile for the branch.
618
return (self.branch.control_files.get_utf8("email")
620
.decode(bzrlib.user_encoding)
622
except errors.NoSuchFile, e:
625
return self._get_best_value('_get_user_id')
627
def _get_signature_checking(self):
628
"""See Config._get_signature_checking."""
629
return self._get_best_value('_get_signature_checking')
631
def _get_signing_policy(self):
632
"""See Config._get_signing_policy."""
633
return self._get_best_value('_get_signing_policy')
635
def _get_user_option(self, option_name):
636
"""See Config._get_user_option."""
637
for source in self.option_sources:
638
value = source()._get_user_option(option_name)
639
if value is not None:
643
def set_user_option(self, name, value, store=STORE_BRANCH,
645
if store == STORE_BRANCH:
646
self._get_branch_data_config().set_option(value, name)
647
elif store == STORE_GLOBAL:
648
self._get_global_config().set_user_option(name, value)
650
self._get_location_config().set_user_option(name, value, store)
653
if store in (STORE_GLOBAL, STORE_BRANCH):
654
mask_value = self._get_location_config().get_user_option(name)
655
if mask_value is not None:
656
trace.warning('Value "%s" is masked by "%s" from'
657
' locations.conf', value, mask_value)
659
if store == STORE_GLOBAL:
660
branch_config = self._get_branch_data_config()
661
mask_value = branch_config.get_user_option(name)
662
if mask_value is not None:
663
trace.warning('Value "%s" is masked by "%s" from'
664
' branch.conf', value, mask_value)
667
def _gpg_signing_command(self):
668
"""See Config.gpg_signing_command."""
669
return self._get_safe_value('_gpg_signing_command')
671
def __init__(self, branch):
672
super(BranchConfig, self).__init__()
673
self._location_config = None
674
self._branch_data_config = None
675
self._global_config = None
677
self.option_sources = (self._get_location_config,
678
self._get_branch_data_config,
679
self._get_global_config)
681
def _post_commit(self):
682
"""See Config.post_commit."""
683
return self._get_safe_value('_post_commit')
685
def _get_nickname(self):
686
value = self._get_explicit_nickname()
687
if value is not None:
689
return urlutils.unescape(self.branch.base.split('/')[-2])
691
def has_explicit_nickname(self):
692
"""Return true if a nickname has been explicitly assigned."""
693
return self._get_explicit_nickname() is not None
695
def _get_explicit_nickname(self):
696
return self._get_best_value('_get_nickname')
698
def _log_format(self):
699
"""See Config.log_format."""
700
return self._get_best_value('_log_format')
703
def ensure_config_dir_exists(path=None):
704
"""Make sure a configuration directory exists.
705
This makes sure that the directory exists.
706
On windows, since configuration directories are 2 levels deep,
707
it makes sure both the directory and the parent directory exists.
711
if not os.path.isdir(path):
712
if sys.platform == 'win32':
713
parent_dir = os.path.dirname(path)
714
if not os.path.isdir(parent_dir):
715
mutter('creating config parent directory: %r', parent_dir)
717
mutter('creating config directory: %r', path)
722
"""Return per-user configuration directory.
724
By default this is ~/.bazaar/
726
TODO: Global option --config-dir to override this.
728
base = os.environ.get('BZR_HOME', None)
729
if sys.platform == 'win32':
731
base = win32utils.get_appdata_location_unicode()
733
base = os.environ.get('HOME', None)
735
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
736
return osutils.pathjoin(base, 'bazaar', '2.0')
738
# cygwin, linux, and darwin all have a $HOME directory
740
base = os.path.expanduser("~")
741
return osutils.pathjoin(base, ".bazaar")
744
def config_filename():
745
"""Return per-user configuration ini file filename."""
746
return osutils.pathjoin(config_dir(), 'bazaar.conf')
749
def branches_config_filename():
750
"""Return per-user configuration ini file filename."""
751
return osutils.pathjoin(config_dir(), 'branches.conf')
754
def locations_config_filename():
755
"""Return per-user configuration ini file filename."""
756
return osutils.pathjoin(config_dir(), 'locations.conf')
759
def user_ignore_config_filename():
760
"""Return the user default ignore filename"""
761
return osutils.pathjoin(config_dir(), 'ignore')
765
"""Calculate automatic user identification.
767
Returns (realname, email).
769
Only used when none is set in the environment or the id file.
771
This previously used the FQDN as the default domain, but that can
772
be very slow on machines where DNS is broken. So now we simply
777
if sys.platform == 'win32':
778
name = win32utils.get_user_name_unicode()
780
raise errors.BzrError("Cannot autodetect user name.\n"
781
"Please, set your name with command like:\n"
782
'bzr whoami "Your Name <name@domain.com>"')
783
host = win32utils.get_host_name_unicode()
785
host = socket.gethostname()
786
return name, (name + '@' + host)
791
w = pwd.getpwuid(uid)
793
# we try utf-8 first, because on many variants (like Linux),
794
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
795
# false positives. (many users will have their user encoding set to
796
# latin-1, which cannot raise UnicodeError.)
798
gecos = w.pw_gecos.decode('utf-8')
802
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
803
encoding = bzrlib.user_encoding
805
raise errors.BzrCommandError('Unable to determine your name. '
806
'Use "bzr whoami" to set it.')
808
username = w.pw_name.decode(encoding)
810
raise errors.BzrCommandError('Unable to determine your name. '
811
'Use "bzr whoami" to set it.')
813
comma = gecos.find(',')
817
realname = gecos[:comma]
824
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
825
except UnicodeDecodeError:
826
raise errors.BzrError("Can't decode username as %s." % \
827
bzrlib.user_encoding)
829
return realname, (username + '@' + socket.gethostname())
832
def extract_email_address(e):
833
"""Return just the address part of an email string.
835
That is just the user@domain part, nothing else.
836
This part is required to contain only ascii characters.
837
If it can't be extracted, raises an error.
839
>>> extract_email_address('Jane Tester <jane@test.com>')
842
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
844
raise errors.NoEmailInUsername(e)
848
class TreeConfig(IniBasedConfig):
849
"""Branch configuration data associated with its contents, not location"""
850
def __init__(self, branch):
853
def _get_parser(self, file=None):
855
return IniBasedConfig._get_parser(file)
856
return self._get_config()
858
def _get_config(self):
860
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
862
except errors.NoSuchFile:
863
obj = ConfigObj(encoding='utf=8')
866
def get_option(self, name, section=None, default=None):
867
self.branch.lock_read()
869
obj = self._get_config()
871
if section is not None:
880
def set_option(self, value, name, section=None):
881
"""Set a per-branch configuration option"""
882
self.branch.lock_write()
884
cfg_obj = self._get_config()
889
obj = cfg_obj[section]
891
cfg_obj[section] = {}
892
obj = cfg_obj[section]
894
out_file = StringIO()
895
cfg_obj.write(out_file)
897
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
