1
# Copyright (C) 2005 Canonical Ltd
2
# Authors: Robert Collins <robert.collins@canonical.com>
4
# This program is free software; you can redistribute it and/or modify
5
# it under the terms of the GNU General Public License as published by
6
# the Free Software Foundation; either version 2 of the License, or
7
# (at your option) any later version.
9
# This program is distributed in the hope that it will be useful,
10
# but WITHOUT ANY WARRANTY; without even the implied warranty of
11
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
# GNU General Public License for more details.
14
# You should have received a copy of the GNU General Public License
15
# along with this program; if not, write to the Free Software
16
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18
"""Configuration that affects the behaviour of Bazaar.
20
Currently this configuration resides in ~/.bazaar/bazaar.conf
21
and ~/.bazaar/locations.conf, which is written to by bzr.
23
In bazaar.conf the following options may be set:
25
editor=name-of-program
26
email=Your Name <your@email.address>
27
check_signatures=require|ignore|check-available(default)
28
create_signatures=always|never|when-required(default)
29
gpg_signing_command=name-of-program
30
log_format=name-of-format
32
in locations.conf, you specify the url of a branch and options for it.
33
Wildcards may be used - * and ? as normal in shell completion. Options
34
set in both bazaar.conf and locations.conf are overridden by the locations.conf
36
[/home/robertc/source]
37
recurse=False|True(default)
39
check_signatures= as above
40
create_signatures= as above.
42
explanation of options
43
----------------------
44
editor - this option sets the pop up editor to use during commits.
45
email - this option sets the user id bzr will use when committing.
46
check_signatures - this option controls whether bzr will require good gpg
47
signatures, ignore them, or check them if they are
49
create_signatures - this option controls whether bzr will always create
50
gpg signatures, never create them, or create them if the
51
branch is configured to require them.
52
log_format - this option sets the default log format. Possible values are
53
long, short, line, or a plugin can register new formats.
55
In bazaar.conf you can also define aliases in the ALIASES sections, example
58
lastlog=log --line -r-10..-1
59
ll=log --line -r-10..-1
67
from bzrlib.lazy_import import lazy_import
68
lazy_import(globals(), """
70
from fnmatch import fnmatch
72
from StringIO import StringIO
81
import bzrlib.util.configobj.configobj as configobj
84
from bzrlib.trace import mutter, warning
103
POLICY_NORECURSE: 'norecurse',
104
POLICY_APPENDPATH: 'appendpath',
109
'norecurse': POLICY_NORECURSE,
110
'appendpath': POLICY_APPENDPATH,
114
STORE_LOCATION = POLICY_NONE
115
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
116
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
121
class ConfigObj(configobj.ConfigObj):
123
def get_bool(self, section, key):
124
return self[section].as_bool(key)
126
def get_value(self, section, name):
127
# Try [] for the old DEFAULT section.
128
if section == "DEFAULT":
133
return self[section][name]
136
class Config(object):
137
"""A configuration policy - what username, editor, gpg needs etc."""
139
def get_editor(self):
140
"""Get the users pop up editor."""
141
raise NotImplementedError
143
def _get_signature_checking(self):
144
"""Template method to override signature checking policy."""
146
def _get_signing_policy(self):
147
"""Template method to override signature creation policy."""
149
def _get_user_option(self, option_name):
150
"""Template method to provide a user option."""
153
def get_user_option(self, option_name):
154
"""Get a generic option - no special process, no default."""
155
return self._get_user_option(option_name)
157
def gpg_signing_command(self):
158
"""What program should be used to sign signatures?"""
159
result = self._gpg_signing_command()
164
def _gpg_signing_command(self):
165
"""See gpg_signing_command()."""
168
def log_format(self):
169
"""What log format should be used"""
170
result = self._log_format()
175
def _log_format(self):
176
"""See log_format()."""
180
super(Config, self).__init__()
182
def post_commit(self):
183
"""An ordered list of python functions to call.
185
Each function takes branch, rev_id as parameters.
187
return self._post_commit()
189
def _post_commit(self):
190
"""See Config.post_commit."""
193
def user_email(self):
194
"""Return just the email component of a username."""
195
return extract_email_address(self.username())
198
"""Return email-style username.
200
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
202
$BZR_EMAIL can be set to override this (as well as the
203
deprecated $BZREMAIL), then
204
the concrete policy type is checked, and finally
206
If none is found, a reasonable default is (hopefully)
209
TODO: Check it's reasonably well-formed.
211
v = os.environ.get('BZR_EMAIL')
213
return v.decode(bzrlib.user_encoding)
214
v = os.environ.get('BZREMAIL')
216
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
217
return v.decode(bzrlib.user_encoding)
219
v = self._get_user_id()
223
v = os.environ.get('EMAIL')
225
return v.decode(bzrlib.user_encoding)
227
name, email = _auto_user_id()
229
return '%s <%s>' % (name, email)
233
def signature_checking(self):
234
"""What is the current policy for signature checking?."""
235
policy = self._get_signature_checking()
236
if policy is not None:
238
return CHECK_IF_POSSIBLE
240
def signing_policy(self):
241
"""What is the current policy for signature checking?."""
242
policy = self._get_signing_policy()
243
if policy is not None:
245
return SIGN_WHEN_REQUIRED
247
def signature_needed(self):
248
"""Is a signature needed when committing ?."""
249
policy = self._get_signing_policy()
251
policy = self._get_signature_checking()
252
if policy is not None:
253
warning("Please use create_signatures, not check_signatures "
254
"to set signing policy.")
255
if policy == CHECK_ALWAYS:
257
elif policy == SIGN_ALWAYS:
261
def get_alias(self, value):
262
return self._get_alias(value)
264
def _get_alias(self, value):
267
def get_nickname(self):
268
return self._get_nickname()
270
def _get_nickname(self):
274
class IniBasedConfig(Config):
275
"""A configuration policy that draws from ini files."""
277
def _get_parser(self, file=None):
278
if self._parser is not None:
281
input = self._get_filename()
285
self._parser = ConfigObj(input, encoding='utf-8')
286
except configobj.ConfigObjError, e:
287
raise errors.ParseConfigError(e.errors, e.config.filename)
290
def _get_matching_sections(self):
291
"""Return an ordered list of (section_name, extra_path) pairs.
293
If the section contains inherited configuration, extra_path is
294
a string containing the additional path components.
296
section = self._get_section()
297
if section is not None:
298
return [(section, '')]
302
def _get_section(self):
303
"""Override this to define the section used by the config."""
306
def _get_option_policy(self, section, option_name):
307
"""Return the policy for the given (section, option_name) pair."""
310
def _get_signature_checking(self):
311
"""See Config._get_signature_checking."""
312
policy = self._get_user_option('check_signatures')
314
return self._string_to_signature_policy(policy)
316
def _get_signing_policy(self):
317
"""See Config._get_signing_policy"""
318
policy = self._get_user_option('create_signatures')
320
return self._string_to_signing_policy(policy)
322
def _get_user_id(self):
323
"""Get the user id from the 'email' key in the current section."""
324
return self._get_user_option('email')
326
def _get_user_option(self, option_name):
327
"""See Config._get_user_option."""
328
for (section, extra_path) in self._get_matching_sections():
330
value = self._get_parser().get_value(section, option_name)
333
policy = self._get_option_policy(section, option_name)
334
if policy == POLICY_NONE:
336
elif policy == POLICY_NORECURSE:
337
# norecurse items only apply to the exact path
342
elif policy == POLICY_APPENDPATH:
344
value = urlutils.join(value, extra_path)
347
raise AssertionError('Unexpected config policy %r' % policy)
351
def _gpg_signing_command(self):
352
"""See Config.gpg_signing_command."""
353
return self._get_user_option('gpg_signing_command')
355
def _log_format(self):
356
"""See Config.log_format."""
357
return self._get_user_option('log_format')
359
def __init__(self, get_filename):
360
super(IniBasedConfig, self).__init__()
361
self._get_filename = get_filename
364
def _post_commit(self):
365
"""See Config.post_commit."""
366
return self._get_user_option('post_commit')
368
def _string_to_signature_policy(self, signature_string):
369
"""Convert a string to a signing policy."""
370
if signature_string.lower() == 'check-available':
371
return CHECK_IF_POSSIBLE
372
if signature_string.lower() == 'ignore':
374
if signature_string.lower() == 'require':
376
raise errors.BzrError("Invalid signatures policy '%s'"
379
def _string_to_signing_policy(self, signature_string):
380
"""Convert a string to a signing policy."""
381
if signature_string.lower() == 'when-required':
382
return SIGN_WHEN_REQUIRED
383
if signature_string.lower() == 'never':
385
if signature_string.lower() == 'always':
387
raise errors.BzrError("Invalid signing policy '%s'"
390
def _get_alias(self, value):
392
return self._get_parser().get_value("ALIASES",
397
def _get_nickname(self):
398
return self.get_user_option('nickname')
401
class GlobalConfig(IniBasedConfig):
402
"""The configuration that should be used for a specific location."""
404
def get_editor(self):
405
return self._get_user_option('editor')
408
super(GlobalConfig, self).__init__(config_filename)
410
def set_user_option(self, option, value):
411
"""Save option and its value in the configuration."""
412
# FIXME: RBC 20051029 This should refresh the parser and also take a
413
# file lock on bazaar.conf.
414
conf_dir = os.path.dirname(self._get_filename())
415
ensure_config_dir_exists(conf_dir)
416
if 'DEFAULT' not in self._get_parser():
417
self._get_parser()['DEFAULT'] = {}
418
self._get_parser()['DEFAULT'][option] = value
419
f = open(self._get_filename(), 'wb')
420
self._get_parser().write(f)
424
class LocationConfig(IniBasedConfig):
425
"""A configuration object that gives the policy for a location."""
427
def __init__(self, location):
428
name_generator = locations_config_filename
429
if (not os.path.exists(name_generator()) and
430
os.path.exists(branches_config_filename())):
431
if sys.platform == 'win32':
432
warning('Please rename %s to %s'
433
% (branches_config_filename(),
434
locations_config_filename()))
436
warning('Please rename ~/.bazaar/branches.conf'
437
' to ~/.bazaar/locations.conf')
438
name_generator = branches_config_filename
439
super(LocationConfig, self).__init__(name_generator)
440
# local file locations are looked up by local path, rather than
441
# by file url. This is because the config file is a user
442
# file, and we would rather not expose the user to file urls.
443
if location.startswith('file://'):
444
location = urlutils.local_path_from_url(location)
445
self.location = location
447
def _get_matching_sections(self):
448
"""Return an ordered list of section names matching this location."""
449
sections = self._get_parser()
450
location_names = self.location.split('/')
451
if self.location.endswith('/'):
452
del location_names[-1]
454
for section in sections:
455
# location is a local path if possible, so we need
456
# to convert 'file://' urls to local paths if necessary.
457
# This also avoids having file:///path be a more exact
458
# match than '/path'.
459
if section.startswith('file://'):
460
section_path = urlutils.local_path_from_url(section)
462
section_path = section
463
section_names = section_path.split('/')
464
if section.endswith('/'):
465
del section_names[-1]
466
names = zip(location_names, section_names)
469
if not fnmatch(name[0], name[1]):
474
# so, for the common prefix they matched.
475
# if section is longer, no match.
476
if len(section_names) > len(location_names):
478
matches.append((len(section_names), section,
479
'/'.join(location_names[len(section_names):])))
480
matches.sort(reverse=True)
482
for (length, section, extra_path) in matches:
483
sections.append((section, extra_path))
484
# should we stop looking for parent configs here?
486
if self._get_parser()[section].as_bool('ignore_parents'):
492
def _get_option_policy(self, section, option_name):
493
"""Return the policy for the given (section, option_name) pair."""
494
# check for the old 'recurse=False' flag
496
recurse = self._get_parser()[section].as_bool('recurse')
500
return POLICY_NORECURSE
502
policy_key = option_name + ':policy'
504
policy_name = self._get_parser()[section][policy_key]
508
return _policy_value[policy_name]
510
def _set_option_policy(self, section, option_name, option_policy):
511
"""Set the policy for the given option name in the given section."""
512
# The old recurse=False option affects all options in the
513
# section. To handle multiple policies in the section, we
514
# need to convert it to a policy_norecurse key.
516
recurse = self._get_parser()[section].as_bool('recurse')
520
symbol_versioning.warn(
521
'The recurse option is deprecated as of 0.14. '
522
'The section "%s" has been converted to use policies.'
525
del self._get_parser()[section]['recurse']
527
for key in self._get_parser()[section].keys():
528
if not key.endswith(':policy'):
529
self._get_parser()[section][key +
530
':policy'] = 'norecurse'
532
policy_key = option_name + ':policy'
533
policy_name = _policy_name[option_policy]
534
if policy_name is not None:
535
self._get_parser()[section][policy_key] = policy_name
537
if policy_key in self._get_parser()[section]:
538
del self._get_parser()[section][policy_key]
540
def set_user_option(self, option, value, store=STORE_LOCATION):
541
"""Save option and its value in the configuration."""
542
assert store in [STORE_LOCATION,
543
STORE_LOCATION_NORECURSE,
544
STORE_LOCATION_APPENDPATH], 'bad storage policy'
545
# FIXME: RBC 20051029 This should refresh the parser and also take a
546
# file lock on locations.conf.
547
conf_dir = os.path.dirname(self._get_filename())
548
ensure_config_dir_exists(conf_dir)
549
location = self.location
550
if location.endswith('/'):
551
location = location[:-1]
552
if (not location in self._get_parser() and
553
not location + '/' in self._get_parser()):
554
self._get_parser()[location]={}
555
elif location + '/' in self._get_parser():
556
location = location + '/'
557
self._get_parser()[location][option]=value
558
# the allowed values of store match the config policies
559
self._set_option_policy(location, option, store)
560
self._get_parser().write(file(self._get_filename(), 'wb'))
563
class BranchConfig(Config):
564
"""A configuration object giving the policy for a branch."""
566
def _get_branch_data_config(self):
567
if self._branch_data_config is None:
568
self._branch_data_config = TreeConfig(self.branch)
569
return self._branch_data_config
571
def _get_location_config(self):
572
if self._location_config is None:
573
self._location_config = LocationConfig(self.branch.base)
574
return self._location_config
576
def _get_global_config(self):
577
if self._global_config is None:
578
self._global_config = GlobalConfig()
579
return self._global_config
581
def _get_best_value(self, option_name):
582
"""This returns a user option from local, tree or global config.
584
They are tried in that order. Use get_safe_value if trusted values
587
for source in self.option_sources:
588
value = getattr(source(), option_name)()
589
if value is not None:
593
def _get_safe_value(self, option_name):
594
"""This variant of get_best_value never returns untrusted values.
596
It does not return values from the branch data, because the branch may
597
not be controlled by the user.
599
We may wish to allow locations.conf to control whether branches are
600
trusted in the future.
602
for source in (self._get_location_config, self._get_global_config):
603
value = getattr(source(), option_name)()
604
if value is not None:
608
def _get_user_id(self):
609
"""Return the full user id for the branch.
611
e.g. "John Hacker <jhacker@foo.org>"
612
This is looked up in the email controlfile for the branch.
615
return (self.branch.control_files.get_utf8("email")
617
.decode(bzrlib.user_encoding)
619
except errors.NoSuchFile, e:
622
return self._get_best_value('_get_user_id')
624
def _get_signature_checking(self):
625
"""See Config._get_signature_checking."""
626
return self._get_best_value('_get_signature_checking')
628
def _get_signing_policy(self):
629
"""See Config._get_signing_policy."""
630
return self._get_best_value('_get_signing_policy')
632
def _get_user_option(self, option_name):
633
"""See Config._get_user_option."""
634
for source in self.option_sources:
635
value = source()._get_user_option(option_name)
636
if value is not None:
640
def set_user_option(self, name, value, store=STORE_BRANCH):
641
if store == STORE_BRANCH:
642
self._get_branch_data_config().set_option(value, name)
643
elif store == STORE_GLOBAL:
644
self._get_global_config().set_user_option(name, value)
646
self._get_location_config().set_user_option(name, value, store)
648
def _gpg_signing_command(self):
649
"""See Config.gpg_signing_command."""
650
return self._get_safe_value('_gpg_signing_command')
652
def __init__(self, branch):
653
super(BranchConfig, self).__init__()
654
self._location_config = None
655
self._branch_data_config = None
656
self._global_config = None
658
self.option_sources = (self._get_location_config,
659
self._get_branch_data_config,
660
self._get_global_config)
662
def _post_commit(self):
663
"""See Config.post_commit."""
664
return self._get_safe_value('_post_commit')
666
def _get_nickname(self):
667
value = self._get_explicit_nickname()
668
if value is not None:
670
return urlutils.unescape(self.branch.base.split('/')[-2])
672
def has_explicit_nickname(self):
673
"""Return true if a nickname has been explicitly assigned."""
674
return self._get_explicit_nickname() is not None
676
def _get_explicit_nickname(self):
677
return self._get_best_value('_get_nickname')
679
def _log_format(self):
680
"""See Config.log_format."""
681
return self._get_best_value('_log_format')
684
def ensure_config_dir_exists(path=None):
685
"""Make sure a configuration directory exists.
686
This makes sure that the directory exists.
687
On windows, since configuration directories are 2 levels deep,
688
it makes sure both the directory and the parent directory exists.
692
if not os.path.isdir(path):
693
if sys.platform == 'win32':
694
parent_dir = os.path.dirname(path)
695
if not os.path.isdir(parent_dir):
696
mutter('creating config parent directory: %r', parent_dir)
698
mutter('creating config directory: %r', path)
703
"""Return per-user configuration directory.
705
By default this is ~/.bazaar/
707
TODO: Global option --config-dir to override this.
709
base = os.environ.get('BZR_HOME', None)
710
if sys.platform == 'win32':
712
base = os.environ.get('APPDATA', None)
714
base = os.environ.get('HOME', None)
716
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
717
return osutils.pathjoin(base, 'bazaar', '2.0')
719
# cygwin, linux, and darwin all have a $HOME directory
721
base = os.path.expanduser("~")
722
return osutils.pathjoin(base, ".bazaar")
725
def config_filename():
726
"""Return per-user configuration ini file filename."""
727
return osutils.pathjoin(config_dir(), 'bazaar.conf')
730
def branches_config_filename():
731
"""Return per-user configuration ini file filename."""
732
return osutils.pathjoin(config_dir(), 'branches.conf')
735
def locations_config_filename():
736
"""Return per-user configuration ini file filename."""
737
return osutils.pathjoin(config_dir(), 'locations.conf')
740
def user_ignore_config_filename():
741
"""Return the user default ignore filename"""
742
return osutils.pathjoin(config_dir(), 'ignore')
746
"""Calculate automatic user identification.
748
Returns (realname, email).
750
Only used when none is set in the environment or the id file.
752
This previously used the FQDN as the default domain, but that can
753
be very slow on machines where DNS is broken. So now we simply
758
# XXX: Any good way to get real user name on win32?
763
w = pwd.getpwuid(uid)
765
# we try utf-8 first, because on many variants (like Linux),
766
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
767
# false positives. (many users will have their user encoding set to
768
# latin-1, which cannot raise UnicodeError.)
770
gecos = w.pw_gecos.decode('utf-8')
774
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
775
encoding = bzrlib.user_encoding
777
raise errors.BzrCommandError('Unable to determine your name. '
778
'Use "bzr whoami" to set it.')
780
username = w.pw_name.decode(encoding)
782
raise errors.BzrCommandError('Unable to determine your name. '
783
'Use "bzr whoami" to set it.')
785
comma = gecos.find(',')
789
realname = gecos[:comma]
796
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
797
except UnicodeDecodeError:
798
raise errors.BzrError("Can't decode username as %s." % \
799
bzrlib.user_encoding)
801
return realname, (username + '@' + socket.gethostname())
804
def extract_email_address(e):
805
"""Return just the address part of an email string.
807
That is just the user@domain part, nothing else.
808
This part is required to contain only ascii characters.
809
If it can't be extracted, raises an error.
811
>>> extract_email_address('Jane Tester <jane@test.com>')
814
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
816
raise errors.NoEmailInUsername(e)
820
class TreeConfig(IniBasedConfig):
821
"""Branch configuration data associated with its contents, not location"""
822
def __init__(self, branch):
825
def _get_parser(self, file=None):
827
return IniBasedConfig._get_parser(file)
828
return self._get_config()
830
def _get_config(self):
832
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
834
except errors.NoSuchFile:
835
obj = ConfigObj(encoding='utf=8')
838
def get_option(self, name, section=None, default=None):
839
self.branch.lock_read()
841
obj = self._get_config()
843
if section is not None:
852
def set_option(self, value, name, section=None):
853
"""Set a per-branch configuration option"""
854
self.branch.lock_write()
856
cfg_obj = self._get_config()
861
obj = cfg_obj[section]
863
cfg_obj[section] = {}
864
obj = cfg_obj[section]
866
out_file = StringIO()
867
cfg_obj.write(out_file)
869
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
