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
None : mail_client.Editor,
152
'editor': mail_client.Editor,
153
'thunderbird': mail_client.Thunderbird,
156
def _get_signature_checking(self):
157
"""Template method to override signature checking policy."""
159
def _get_signing_policy(self):
160
"""Template method to override signature creation policy."""
162
def _get_user_option(self, option_name):
163
"""Template method to provide a user option."""
166
def get_user_option(self, option_name):
167
"""Get a generic option - no special process, no default."""
168
return self._get_user_option(option_name)
170
def gpg_signing_command(self):
171
"""What program should be used to sign signatures?"""
172
result = self._gpg_signing_command()
177
def _gpg_signing_command(self):
178
"""See gpg_signing_command()."""
181
def log_format(self):
182
"""What log format should be used"""
183
result = self._log_format()
188
def _log_format(self):
189
"""See log_format()."""
193
super(Config, self).__init__()
195
def post_commit(self):
196
"""An ordered list of python functions to call.
198
Each function takes branch, rev_id as parameters.
200
return self._post_commit()
202
def _post_commit(self):
203
"""See Config.post_commit."""
206
def user_email(self):
207
"""Return just the email component of a username."""
208
return extract_email_address(self.username())
211
"""Return email-style username.
213
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
215
$BZR_EMAIL can be set to override this (as well as the
216
deprecated $BZREMAIL), then
217
the concrete policy type is checked, and finally
219
If none is found, a reasonable default is (hopefully)
222
TODO: Check it's reasonably well-formed.
224
v = os.environ.get('BZR_EMAIL')
226
return v.decode(bzrlib.user_encoding)
227
v = os.environ.get('BZREMAIL')
229
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
230
return v.decode(bzrlib.user_encoding)
232
v = self._get_user_id()
236
v = os.environ.get('EMAIL')
238
return v.decode(bzrlib.user_encoding)
240
name, email = _auto_user_id()
242
return '%s <%s>' % (name, email)
246
def signature_checking(self):
247
"""What is the current policy for signature checking?."""
248
policy = self._get_signature_checking()
249
if policy is not None:
251
return CHECK_IF_POSSIBLE
253
def signing_policy(self):
254
"""What is the current policy for signature checking?."""
255
policy = self._get_signing_policy()
256
if policy is not None:
258
return SIGN_WHEN_REQUIRED
260
def signature_needed(self):
261
"""Is a signature needed when committing ?."""
262
policy = self._get_signing_policy()
264
policy = self._get_signature_checking()
265
if policy is not None:
266
warning("Please use create_signatures, not check_signatures "
267
"to set signing policy.")
268
if policy == CHECK_ALWAYS:
270
elif policy == SIGN_ALWAYS:
274
def get_alias(self, value):
275
return self._get_alias(value)
277
def _get_alias(self, value):
280
def get_nickname(self):
281
return self._get_nickname()
283
def _get_nickname(self):
287
class IniBasedConfig(Config):
288
"""A configuration policy that draws from ini files."""
290
def _get_parser(self, file=None):
291
if self._parser is not None:
294
input = self._get_filename()
298
self._parser = ConfigObj(input, encoding='utf-8')
299
except configobj.ConfigObjError, e:
300
raise errors.ParseConfigError(e.errors, e.config.filename)
303
def _get_matching_sections(self):
304
"""Return an ordered list of (section_name, extra_path) pairs.
306
If the section contains inherited configuration, extra_path is
307
a string containing the additional path components.
309
section = self._get_section()
310
if section is not None:
311
return [(section, '')]
315
def _get_section(self):
316
"""Override this to define the section used by the config."""
319
def _get_option_policy(self, section, option_name):
320
"""Return the policy for the given (section, option_name) pair."""
323
def _get_signature_checking(self):
324
"""See Config._get_signature_checking."""
325
policy = self._get_user_option('check_signatures')
327
return self._string_to_signature_policy(policy)
329
def _get_signing_policy(self):
330
"""See Config._get_signing_policy"""
331
policy = self._get_user_option('create_signatures')
333
return self._string_to_signing_policy(policy)
335
def _get_user_id(self):
336
"""Get the user id from the 'email' key in the current section."""
337
return self._get_user_option('email')
339
def _get_user_option(self, option_name):
340
"""See Config._get_user_option."""
341
for (section, extra_path) in self._get_matching_sections():
343
value = self._get_parser().get_value(section, option_name)
346
policy = self._get_option_policy(section, option_name)
347
if policy == POLICY_NONE:
349
elif policy == POLICY_NORECURSE:
350
# norecurse items only apply to the exact path
355
elif policy == POLICY_APPENDPATH:
357
value = urlutils.join(value, extra_path)
360
raise AssertionError('Unexpected config policy %r' % policy)
364
def _gpg_signing_command(self):
365
"""See Config.gpg_signing_command."""
366
return self._get_user_option('gpg_signing_command')
368
def _log_format(self):
369
"""See Config.log_format."""
370
return self._get_user_option('log_format')
372
def __init__(self, get_filename):
373
super(IniBasedConfig, self).__init__()
374
self._get_filename = get_filename
377
def _post_commit(self):
378
"""See Config.post_commit."""
379
return self._get_user_option('post_commit')
381
def _string_to_signature_policy(self, signature_string):
382
"""Convert a string to a signing policy."""
383
if signature_string.lower() == 'check-available':
384
return CHECK_IF_POSSIBLE
385
if signature_string.lower() == 'ignore':
387
if signature_string.lower() == 'require':
389
raise errors.BzrError("Invalid signatures policy '%s'"
392
def _string_to_signing_policy(self, signature_string):
393
"""Convert a string to a signing policy."""
394
if signature_string.lower() == 'when-required':
395
return SIGN_WHEN_REQUIRED
396
if signature_string.lower() == 'never':
398
if signature_string.lower() == 'always':
400
raise errors.BzrError("Invalid signing policy '%s'"
403
def _get_alias(self, value):
405
return self._get_parser().get_value("ALIASES",
410
def _get_nickname(self):
411
return self.get_user_option('nickname')
414
class GlobalConfig(IniBasedConfig):
415
"""The configuration that should be used for a specific location."""
417
def get_editor(self):
418
return self._get_user_option('editor')
421
super(GlobalConfig, self).__init__(config_filename)
423
def set_user_option(self, option, value):
424
"""Save option and its value in the configuration."""
425
# FIXME: RBC 20051029 This should refresh the parser and also take a
426
# file lock on bazaar.conf.
427
conf_dir = os.path.dirname(self._get_filename())
428
ensure_config_dir_exists(conf_dir)
429
if 'DEFAULT' not in self._get_parser():
430
self._get_parser()['DEFAULT'] = {}
431
self._get_parser()['DEFAULT'][option] = value
432
f = open(self._get_filename(), 'wb')
433
self._get_parser().write(f)
437
class LocationConfig(IniBasedConfig):
438
"""A configuration object that gives the policy for a location."""
440
def __init__(self, location):
441
name_generator = locations_config_filename
442
if (not os.path.exists(name_generator()) and
443
os.path.exists(branches_config_filename())):
444
if sys.platform == 'win32':
445
warning('Please rename %s to %s'
446
% (branches_config_filename(),
447
locations_config_filename()))
449
warning('Please rename ~/.bazaar/branches.conf'
450
' to ~/.bazaar/locations.conf')
451
name_generator = branches_config_filename
452
super(LocationConfig, self).__init__(name_generator)
453
# local file locations are looked up by local path, rather than
454
# by file url. This is because the config file is a user
455
# file, and we would rather not expose the user to file urls.
456
if location.startswith('file://'):
457
location = urlutils.local_path_from_url(location)
458
self.location = location
460
def _get_matching_sections(self):
461
"""Return an ordered list of section names matching this location."""
462
sections = self._get_parser()
463
location_names = self.location.split('/')
464
if self.location.endswith('/'):
465
del location_names[-1]
467
for section in sections:
468
# location is a local path if possible, so we need
469
# to convert 'file://' urls to local paths if necessary.
470
# This also avoids having file:///path be a more exact
471
# match than '/path'.
472
if section.startswith('file://'):
473
section_path = urlutils.local_path_from_url(section)
475
section_path = section
476
section_names = section_path.split('/')
477
if section.endswith('/'):
478
del section_names[-1]
479
names = zip(location_names, section_names)
482
if not fnmatch(name[0], name[1]):
487
# so, for the common prefix they matched.
488
# if section is longer, no match.
489
if len(section_names) > len(location_names):
491
matches.append((len(section_names), section,
492
'/'.join(location_names[len(section_names):])))
493
matches.sort(reverse=True)
495
for (length, section, extra_path) in matches:
496
sections.append((section, extra_path))
497
# should we stop looking for parent configs here?
499
if self._get_parser()[section].as_bool('ignore_parents'):
505
def _get_option_policy(self, section, option_name):
506
"""Return the policy for the given (section, option_name) pair."""
507
# check for the old 'recurse=False' flag
509
recurse = self._get_parser()[section].as_bool('recurse')
513
return POLICY_NORECURSE
515
policy_key = option_name + ':policy'
517
policy_name = self._get_parser()[section][policy_key]
521
return _policy_value[policy_name]
523
def _set_option_policy(self, section, option_name, option_policy):
524
"""Set the policy for the given option name in the given section."""
525
# The old recurse=False option affects all options in the
526
# section. To handle multiple policies in the section, we
527
# need to convert it to a policy_norecurse key.
529
recurse = self._get_parser()[section].as_bool('recurse')
533
symbol_versioning.warn(
534
'The recurse option is deprecated as of 0.14. '
535
'The section "%s" has been converted to use policies.'
538
del self._get_parser()[section]['recurse']
540
for key in self._get_parser()[section].keys():
541
if not key.endswith(':policy'):
542
self._get_parser()[section][key +
543
':policy'] = 'norecurse'
545
policy_key = option_name + ':policy'
546
policy_name = _policy_name[option_policy]
547
if policy_name is not None:
548
self._get_parser()[section][policy_key] = policy_name
550
if policy_key in self._get_parser()[section]:
551
del self._get_parser()[section][policy_key]
553
def set_user_option(self, option, value, store=STORE_LOCATION):
554
"""Save option and its value in the configuration."""
555
assert store in [STORE_LOCATION,
556
STORE_LOCATION_NORECURSE,
557
STORE_LOCATION_APPENDPATH], 'bad storage policy'
558
# FIXME: RBC 20051029 This should refresh the parser and also take a
559
# file lock on locations.conf.
560
conf_dir = os.path.dirname(self._get_filename())
561
ensure_config_dir_exists(conf_dir)
562
location = self.location
563
if location.endswith('/'):
564
location = location[:-1]
565
if (not location in self._get_parser() and
566
not location + '/' in self._get_parser()):
567
self._get_parser()[location]={}
568
elif location + '/' in self._get_parser():
569
location = location + '/'
570
self._get_parser()[location][option]=value
571
# the allowed values of store match the config policies
572
self._set_option_policy(location, option, store)
573
self._get_parser().write(file(self._get_filename(), 'wb'))
576
class BranchConfig(Config):
577
"""A configuration object giving the policy for a branch."""
579
def _get_branch_data_config(self):
580
if self._branch_data_config is None:
581
self._branch_data_config = TreeConfig(self.branch)
582
return self._branch_data_config
584
def _get_location_config(self):
585
if self._location_config is None:
586
self._location_config = LocationConfig(self.branch.base)
587
return self._location_config
589
def _get_global_config(self):
590
if self._global_config is None:
591
self._global_config = GlobalConfig()
592
return self._global_config
594
def _get_best_value(self, option_name):
595
"""This returns a user option from local, tree or global config.
597
They are tried in that order. Use get_safe_value if trusted values
600
for source in self.option_sources:
601
value = getattr(source(), option_name)()
602
if value is not None:
606
def _get_safe_value(self, option_name):
607
"""This variant of get_best_value never returns untrusted values.
609
It does not return values from the branch data, because the branch may
610
not be controlled by the user.
612
We may wish to allow locations.conf to control whether branches are
613
trusted in the future.
615
for source in (self._get_location_config, self._get_global_config):
616
value = getattr(source(), option_name)()
617
if value is not None:
621
def _get_user_id(self):
622
"""Return the full user id for the branch.
624
e.g. "John Hacker <jhacker@foo.org>"
625
This is looked up in the email controlfile for the branch.
628
return (self.branch.control_files.get_utf8("email")
630
.decode(bzrlib.user_encoding)
632
except errors.NoSuchFile, e:
635
return self._get_best_value('_get_user_id')
637
def _get_signature_checking(self):
638
"""See Config._get_signature_checking."""
639
return self._get_best_value('_get_signature_checking')
641
def _get_signing_policy(self):
642
"""See Config._get_signing_policy."""
643
return self._get_best_value('_get_signing_policy')
645
def _get_user_option(self, option_name):
646
"""See Config._get_user_option."""
647
for source in self.option_sources:
648
value = source()._get_user_option(option_name)
649
if value is not None:
653
def set_user_option(self, name, value, store=STORE_BRANCH,
655
if store == STORE_BRANCH:
656
self._get_branch_data_config().set_option(value, name)
657
elif store == STORE_GLOBAL:
658
self._get_global_config().set_user_option(name, value)
660
self._get_location_config().set_user_option(name, value, store)
663
if store in (STORE_GLOBAL, STORE_BRANCH):
664
mask_value = self._get_location_config().get_user_option(name)
665
if mask_value is not None:
666
trace.warning('Value "%s" is masked by "%s" from'
667
' locations.conf', value, mask_value)
669
if store == STORE_GLOBAL:
670
branch_config = self._get_branch_data_config()
671
mask_value = branch_config.get_user_option(name)
672
if mask_value is not None:
673
trace.warning('Value "%s" is masked by "%s" from'
674
' branch.conf', value, mask_value)
677
def _gpg_signing_command(self):
678
"""See Config.gpg_signing_command."""
679
return self._get_safe_value('_gpg_signing_command')
681
def __init__(self, branch):
682
super(BranchConfig, self).__init__()
683
self._location_config = None
684
self._branch_data_config = None
685
self._global_config = None
687
self.option_sources = (self._get_location_config,
688
self._get_branch_data_config,
689
self._get_global_config)
691
def _post_commit(self):
692
"""See Config.post_commit."""
693
return self._get_safe_value('_post_commit')
695
def _get_nickname(self):
696
value = self._get_explicit_nickname()
697
if value is not None:
699
return urlutils.unescape(self.branch.base.split('/')[-2])
701
def has_explicit_nickname(self):
702
"""Return true if a nickname has been explicitly assigned."""
703
return self._get_explicit_nickname() is not None
705
def _get_explicit_nickname(self):
706
return self._get_best_value('_get_nickname')
708
def _log_format(self):
709
"""See Config.log_format."""
710
return self._get_best_value('_log_format')
713
def ensure_config_dir_exists(path=None):
714
"""Make sure a configuration directory exists.
715
This makes sure that the directory exists.
716
On windows, since configuration directories are 2 levels deep,
717
it makes sure both the directory and the parent directory exists.
721
if not os.path.isdir(path):
722
if sys.platform == 'win32':
723
parent_dir = os.path.dirname(path)
724
if not os.path.isdir(parent_dir):
725
mutter('creating config parent directory: %r', parent_dir)
727
mutter('creating config directory: %r', path)
732
"""Return per-user configuration directory.
734
By default this is ~/.bazaar/
736
TODO: Global option --config-dir to override this.
738
base = os.environ.get('BZR_HOME', None)
739
if sys.platform == 'win32':
741
base = win32utils.get_appdata_location_unicode()
743
base = os.environ.get('HOME', None)
745
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
746
return osutils.pathjoin(base, 'bazaar', '2.0')
748
# cygwin, linux, and darwin all have a $HOME directory
750
base = os.path.expanduser("~")
751
return osutils.pathjoin(base, ".bazaar")
754
def config_filename():
755
"""Return per-user configuration ini file filename."""
756
return osutils.pathjoin(config_dir(), 'bazaar.conf')
759
def branches_config_filename():
760
"""Return per-user configuration ini file filename."""
761
return osutils.pathjoin(config_dir(), 'branches.conf')
764
def locations_config_filename():
765
"""Return per-user configuration ini file filename."""
766
return osutils.pathjoin(config_dir(), 'locations.conf')
769
def user_ignore_config_filename():
770
"""Return the user default ignore filename"""
771
return osutils.pathjoin(config_dir(), 'ignore')
775
"""Calculate automatic user identification.
777
Returns (realname, email).
779
Only used when none is set in the environment or the id file.
781
This previously used the FQDN as the default domain, but that can
782
be very slow on machines where DNS is broken. So now we simply
787
if sys.platform == 'win32':
788
name = win32utils.get_user_name_unicode()
790
raise errors.BzrError("Cannot autodetect user name.\n"
791
"Please, set your name with command like:\n"
792
'bzr whoami "Your Name <name@domain.com>"')
793
host = win32utils.get_host_name_unicode()
795
host = socket.gethostname()
796
return name, (name + '@' + host)
801
w = pwd.getpwuid(uid)
803
# we try utf-8 first, because on many variants (like Linux),
804
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
805
# false positives. (many users will have their user encoding set to
806
# latin-1, which cannot raise UnicodeError.)
808
gecos = w.pw_gecos.decode('utf-8')
812
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
813
encoding = bzrlib.user_encoding
815
raise errors.BzrCommandError('Unable to determine your name. '
816
'Use "bzr whoami" to set it.')
818
username = w.pw_name.decode(encoding)
820
raise errors.BzrCommandError('Unable to determine your name. '
821
'Use "bzr whoami" to set it.')
823
comma = gecos.find(',')
827
realname = gecos[:comma]
834
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
835
except UnicodeDecodeError:
836
raise errors.BzrError("Can't decode username as %s." % \
837
bzrlib.user_encoding)
839
return realname, (username + '@' + socket.gethostname())
842
def extract_email_address(e):
843
"""Return just the address part of an email string.
845
That is just the user@domain part, nothing else.
846
This part is required to contain only ascii characters.
847
If it can't be extracted, raises an error.
849
>>> extract_email_address('Jane Tester <jane@test.com>')
852
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
854
raise errors.NoEmailInUsername(e)
858
class TreeConfig(IniBasedConfig):
859
"""Branch configuration data associated with its contents, not location"""
860
def __init__(self, branch):
863
def _get_parser(self, file=None):
865
return IniBasedConfig._get_parser(file)
866
return self._get_config()
868
def _get_config(self):
870
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
872
except errors.NoSuchFile:
873
obj = ConfigObj(encoding='utf=8')
876
def get_option(self, name, section=None, default=None):
877
self.branch.lock_read()
879
obj = self._get_config()
881
if section is not None:
890
def set_option(self, value, name, section=None):
891
"""Set a per-branch configuration option"""
892
self.branch.lock_write()
894
cfg_obj = self._get_config()
899
obj = cfg_obj[section]
901
cfg_obj[section] = {}
902
obj = cfg_obj[section]
904
out_file = StringIO()
905
cfg_obj.write(out_file)
907
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
