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
83
import bzrlib.util.configobj.configobj as configobj
86
from bzrlib.trace import mutter, warning
101
POLICY_APPENDPATH = 2
105
POLICY_NORECURSE: 'norecurse',
106
POLICY_APPENDPATH: 'appendpath',
111
'norecurse': POLICY_NORECURSE,
112
'appendpath': POLICY_APPENDPATH,
116
STORE_LOCATION = POLICY_NONE
117
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
118
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
123
class ConfigObj(configobj.ConfigObj):
125
def get_bool(self, section, key):
126
return self[section].as_bool(key)
128
def get_value(self, section, name):
129
# Try [] for the old DEFAULT section.
130
if section == "DEFAULT":
135
return self[section][name]
138
class Config(object):
139
"""A configuration policy - what username, editor, gpg needs etc."""
141
def get_editor(self):
142
"""Get the users pop up editor."""
143
raise NotImplementedError
145
def _get_signature_checking(self):
146
"""Template method to override signature checking policy."""
148
def _get_signing_policy(self):
149
"""Template method to override signature creation policy."""
151
def _get_user_option(self, option_name):
152
"""Template method to provide a user option."""
155
def get_user_option(self, option_name):
156
"""Get a generic option - no special process, no default."""
157
return self._get_user_option(option_name)
159
def gpg_signing_command(self):
160
"""What program should be used to sign signatures?"""
161
result = self._gpg_signing_command()
166
def _gpg_signing_command(self):
167
"""See gpg_signing_command()."""
170
def log_format(self):
171
"""What log format should be used"""
172
result = self._log_format()
177
def _log_format(self):
178
"""See log_format()."""
182
super(Config, self).__init__()
184
def post_commit(self):
185
"""An ordered list of python functions to call.
187
Each function takes branch, rev_id as parameters.
189
return self._post_commit()
191
def _post_commit(self):
192
"""See Config.post_commit."""
195
def user_email(self):
196
"""Return just the email component of a username."""
197
return extract_email_address(self.username())
200
"""Return email-style username.
202
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
204
$BZR_EMAIL can be set to override this (as well as the
205
deprecated $BZREMAIL), then
206
the concrete policy type is checked, and finally
208
If none is found, a reasonable default is (hopefully)
211
TODO: Check it's reasonably well-formed.
213
v = os.environ.get('BZR_EMAIL')
215
return v.decode(bzrlib.user_encoding)
216
v = os.environ.get('BZREMAIL')
218
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
219
return v.decode(bzrlib.user_encoding)
221
v = self._get_user_id()
225
v = os.environ.get('EMAIL')
227
return v.decode(bzrlib.user_encoding)
229
name, email = _auto_user_id()
231
return '%s <%s>' % (name, email)
235
def signature_checking(self):
236
"""What is the current policy for signature checking?."""
237
policy = self._get_signature_checking()
238
if policy is not None:
240
return CHECK_IF_POSSIBLE
242
def signing_policy(self):
243
"""What is the current policy for signature checking?."""
244
policy = self._get_signing_policy()
245
if policy is not None:
247
return SIGN_WHEN_REQUIRED
249
def signature_needed(self):
250
"""Is a signature needed when committing ?."""
251
policy = self._get_signing_policy()
253
policy = self._get_signature_checking()
254
if policy is not None:
255
warning("Please use create_signatures, not check_signatures "
256
"to set signing policy.")
257
if policy == CHECK_ALWAYS:
259
elif policy == SIGN_ALWAYS:
263
def get_alias(self, value):
264
return self._get_alias(value)
266
def _get_alias(self, value):
269
def get_nickname(self):
270
return self._get_nickname()
272
def _get_nickname(self):
276
class IniBasedConfig(Config):
277
"""A configuration policy that draws from ini files."""
279
def _get_parser(self, file=None):
280
if self._parser is not None:
283
input = self._get_filename()
287
self._parser = ConfigObj(input, encoding='utf-8')
288
except configobj.ConfigObjError, e:
289
raise errors.ParseConfigError(e.errors, e.config.filename)
292
def _get_matching_sections(self):
293
"""Return an ordered list of (section_name, extra_path) pairs.
295
If the section contains inherited configuration, extra_path is
296
a string containing the additional path components.
298
section = self._get_section()
299
if section is not None:
300
return [(section, '')]
304
def _get_section(self):
305
"""Override this to define the section used by the config."""
308
def _get_option_policy(self, section, option_name):
309
"""Return the policy for the given (section, option_name) pair."""
312
def _get_signature_checking(self):
313
"""See Config._get_signature_checking."""
314
policy = self._get_user_option('check_signatures')
316
return self._string_to_signature_policy(policy)
318
def _get_signing_policy(self):
319
"""See Config._get_signing_policy"""
320
policy = self._get_user_option('create_signatures')
322
return self._string_to_signing_policy(policy)
324
def _get_user_id(self):
325
"""Get the user id from the 'email' key in the current section."""
326
return self._get_user_option('email')
328
def _get_user_option(self, option_name):
329
"""See Config._get_user_option."""
330
for (section, extra_path) in self._get_matching_sections():
332
value = self._get_parser().get_value(section, option_name)
335
policy = self._get_option_policy(section, option_name)
336
if policy == POLICY_NONE:
338
elif policy == POLICY_NORECURSE:
339
# norecurse items only apply to the exact path
344
elif policy == POLICY_APPENDPATH:
346
value = urlutils.join(value, extra_path)
349
raise AssertionError('Unexpected config policy %r' % policy)
353
def _gpg_signing_command(self):
354
"""See Config.gpg_signing_command."""
355
return self._get_user_option('gpg_signing_command')
357
def _log_format(self):
358
"""See Config.log_format."""
359
return self._get_user_option('log_format')
361
def __init__(self, get_filename):
362
super(IniBasedConfig, self).__init__()
363
self._get_filename = get_filename
366
def _post_commit(self):
367
"""See Config.post_commit."""
368
return self._get_user_option('post_commit')
370
def _string_to_signature_policy(self, signature_string):
371
"""Convert a string to a signing policy."""
372
if signature_string.lower() == 'check-available':
373
return CHECK_IF_POSSIBLE
374
if signature_string.lower() == 'ignore':
376
if signature_string.lower() == 'require':
378
raise errors.BzrError("Invalid signatures policy '%s'"
381
def _string_to_signing_policy(self, signature_string):
382
"""Convert a string to a signing policy."""
383
if signature_string.lower() == 'when-required':
384
return SIGN_WHEN_REQUIRED
385
if signature_string.lower() == 'never':
387
if signature_string.lower() == 'always':
389
raise errors.BzrError("Invalid signing policy '%s'"
392
def _get_alias(self, value):
394
return self._get_parser().get_value("ALIASES",
399
def _get_nickname(self):
400
return self.get_user_option('nickname')
403
class GlobalConfig(IniBasedConfig):
404
"""The configuration that should be used for a specific location."""
406
def get_editor(self):
407
return self._get_user_option('editor')
410
super(GlobalConfig, self).__init__(config_filename)
412
def set_user_option(self, option, value):
413
"""Save option and its value in the configuration."""
414
# FIXME: RBC 20051029 This should refresh the parser and also take a
415
# file lock on bazaar.conf.
416
conf_dir = os.path.dirname(self._get_filename())
417
ensure_config_dir_exists(conf_dir)
418
if 'DEFAULT' not in self._get_parser():
419
self._get_parser()['DEFAULT'] = {}
420
self._get_parser()['DEFAULT'][option] = value
421
f = open(self._get_filename(), 'wb')
422
self._get_parser().write(f)
426
class LocationConfig(IniBasedConfig):
427
"""A configuration object that gives the policy for a location."""
429
def __init__(self, location):
430
name_generator = locations_config_filename
431
if (not os.path.exists(name_generator()) and
432
os.path.exists(branches_config_filename())):
433
if sys.platform == 'win32':
434
warning('Please rename %s to %s'
435
% (branches_config_filename(),
436
locations_config_filename()))
438
warning('Please rename ~/.bazaar/branches.conf'
439
' to ~/.bazaar/locations.conf')
440
name_generator = branches_config_filename
441
super(LocationConfig, self).__init__(name_generator)
442
# local file locations are looked up by local path, rather than
443
# by file url. This is because the config file is a user
444
# file, and we would rather not expose the user to file urls.
445
if location.startswith('file://'):
446
location = urlutils.local_path_from_url(location)
447
self.location = location
449
def _get_matching_sections(self):
450
"""Return an ordered list of section names matching this location."""
451
sections = self._get_parser()
452
location_names = self.location.split('/')
453
if self.location.endswith('/'):
454
del location_names[-1]
456
for section in sections:
457
# location is a local path if possible, so we need
458
# to convert 'file://' urls to local paths if necessary.
459
# This also avoids having file:///path be a more exact
460
# match than '/path'.
461
if section.startswith('file://'):
462
section_path = urlutils.local_path_from_url(section)
464
section_path = section
465
section_names = section_path.split('/')
466
if section.endswith('/'):
467
del section_names[-1]
468
names = zip(location_names, section_names)
471
if not fnmatch(name[0], name[1]):
476
# so, for the common prefix they matched.
477
# if section is longer, no match.
478
if len(section_names) > len(location_names):
480
matches.append((len(section_names), section,
481
'/'.join(location_names[len(section_names):])))
482
matches.sort(reverse=True)
484
for (length, section, extra_path) in matches:
485
sections.append((section, extra_path))
486
# should we stop looking for parent configs here?
488
if self._get_parser()[section].as_bool('ignore_parents'):
494
def _get_option_policy(self, section, option_name):
495
"""Return the policy for the given (section, option_name) pair."""
496
# check for the old 'recurse=False' flag
498
recurse = self._get_parser()[section].as_bool('recurse')
502
return POLICY_NORECURSE
504
policy_key = option_name + ':policy'
506
policy_name = self._get_parser()[section][policy_key]
510
return _policy_value[policy_name]
512
def _set_option_policy(self, section, option_name, option_policy):
513
"""Set the policy for the given option name in the given section."""
514
# The old recurse=False option affects all options in the
515
# section. To handle multiple policies in the section, we
516
# need to convert it to a policy_norecurse key.
518
recurse = self._get_parser()[section].as_bool('recurse')
522
symbol_versioning.warn(
523
'The recurse option is deprecated as of 0.14. '
524
'The section "%s" has been converted to use policies.'
527
del self._get_parser()[section]['recurse']
529
for key in self._get_parser()[section].keys():
530
if not key.endswith(':policy'):
531
self._get_parser()[section][key +
532
':policy'] = 'norecurse'
534
policy_key = option_name + ':policy'
535
policy_name = _policy_name[option_policy]
536
if policy_name is not None:
537
self._get_parser()[section][policy_key] = policy_name
539
if policy_key in self._get_parser()[section]:
540
del self._get_parser()[section][policy_key]
542
def set_user_option(self, option, value, store=STORE_LOCATION):
543
"""Save option and its value in the configuration."""
544
assert store in [STORE_LOCATION,
545
STORE_LOCATION_NORECURSE,
546
STORE_LOCATION_APPENDPATH], 'bad storage policy'
547
# FIXME: RBC 20051029 This should refresh the parser and also take a
548
# file lock on locations.conf.
549
conf_dir = os.path.dirname(self._get_filename())
550
ensure_config_dir_exists(conf_dir)
551
location = self.location
552
if location.endswith('/'):
553
location = location[:-1]
554
if (not location in self._get_parser() and
555
not location + '/' in self._get_parser()):
556
self._get_parser()[location]={}
557
elif location + '/' in self._get_parser():
558
location = location + '/'
559
self._get_parser()[location][option]=value
560
# the allowed values of store match the config policies
561
self._set_option_policy(location, option, store)
562
self._get_parser().write(file(self._get_filename(), 'wb'))
565
class BranchConfig(Config):
566
"""A configuration object giving the policy for a branch."""
568
def _get_branch_data_config(self):
569
if self._branch_data_config is None:
570
self._branch_data_config = TreeConfig(self.branch)
571
return self._branch_data_config
573
def _get_location_config(self):
574
if self._location_config is None:
575
self._location_config = LocationConfig(self.branch.base)
576
return self._location_config
578
def _get_global_config(self):
579
if self._global_config is None:
580
self._global_config = GlobalConfig()
581
return self._global_config
583
def _get_best_value(self, option_name):
584
"""This returns a user option from local, tree or global config.
586
They are tried in that order. Use get_safe_value if trusted values
589
for source in self.option_sources:
590
value = getattr(source(), option_name)()
591
if value is not None:
595
def _get_safe_value(self, option_name):
596
"""This variant of get_best_value never returns untrusted values.
598
It does not return values from the branch data, because the branch may
599
not be controlled by the user.
601
We may wish to allow locations.conf to control whether branches are
602
trusted in the future.
604
for source in (self._get_location_config, self._get_global_config):
605
value = getattr(source(), option_name)()
606
if value is not None:
610
def _get_user_id(self):
611
"""Return the full user id for the branch.
613
e.g. "John Hacker <jhacker@foo.org>"
614
This is looked up in the email controlfile for the branch.
617
return (self.branch.control_files.get_utf8("email")
619
.decode(bzrlib.user_encoding)
621
except errors.NoSuchFile, e:
624
return self._get_best_value('_get_user_id')
626
def _get_signature_checking(self):
627
"""See Config._get_signature_checking."""
628
return self._get_best_value('_get_signature_checking')
630
def _get_signing_policy(self):
631
"""See Config._get_signing_policy."""
632
return self._get_best_value('_get_signing_policy')
634
def _get_user_option(self, option_name):
635
"""See Config._get_user_option."""
636
for source in self.option_sources:
637
value = source()._get_user_option(option_name)
638
if value is not None:
642
def set_user_option(self, name, value, store=STORE_BRANCH):
643
if store == STORE_BRANCH:
644
self._get_branch_data_config().set_option(value, name)
645
elif store == STORE_GLOBAL:
646
self._get_global_config().set_user_option(name, value)
648
self._get_location_config().set_user_option(name, value, store)
650
def _gpg_signing_command(self):
651
"""See Config.gpg_signing_command."""
652
return self._get_safe_value('_gpg_signing_command')
654
def __init__(self, branch):
655
super(BranchConfig, self).__init__()
656
self._location_config = None
657
self._branch_data_config = None
658
self._global_config = None
660
self.option_sources = (self._get_location_config,
661
self._get_branch_data_config,
662
self._get_global_config)
664
def _post_commit(self):
665
"""See Config.post_commit."""
666
return self._get_safe_value('_post_commit')
668
def _get_nickname(self):
669
value = self._get_explicit_nickname()
670
if value is not None:
672
return urlutils.unescape(self.branch.base.split('/')[-2])
674
def has_explicit_nickname(self):
675
"""Return true if a nickname has been explicitly assigned."""
676
return self._get_explicit_nickname() is not None
678
def _get_explicit_nickname(self):
679
return self._get_best_value('_get_nickname')
681
def _log_format(self):
682
"""See Config.log_format."""
683
return self._get_best_value('_log_format')
686
def ensure_config_dir_exists(path=None):
687
"""Make sure a configuration directory exists.
688
This makes sure that the directory exists.
689
On windows, since configuration directories are 2 levels deep,
690
it makes sure both the directory and the parent directory exists.
694
if not os.path.isdir(path):
695
if sys.platform == 'win32':
696
parent_dir = os.path.dirname(path)
697
if not os.path.isdir(parent_dir):
698
mutter('creating config parent directory: %r', parent_dir)
700
mutter('creating config directory: %r', path)
705
"""Return per-user configuration directory.
707
By default this is ~/.bazaar/
709
TODO: Global option --config-dir to override this.
711
base = os.environ.get('BZR_HOME', None)
712
if sys.platform == 'win32':
714
base = win32utils.get_appdata_location_unicode()
716
base = os.environ.get('HOME', None)
718
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
719
return osutils.pathjoin(base, 'bazaar', '2.0')
721
# cygwin, linux, and darwin all have a $HOME directory
723
base = os.path.expanduser("~")
724
return osutils.pathjoin(base, ".bazaar")
727
def config_filename():
728
"""Return per-user configuration ini file filename."""
729
return osutils.pathjoin(config_dir(), 'bazaar.conf')
732
def branches_config_filename():
733
"""Return per-user configuration ini file filename."""
734
return osutils.pathjoin(config_dir(), 'branches.conf')
737
def locations_config_filename():
738
"""Return per-user configuration ini file filename."""
739
return osutils.pathjoin(config_dir(), 'locations.conf')
742
def user_ignore_config_filename():
743
"""Return the user default ignore filename"""
744
return osutils.pathjoin(config_dir(), 'ignore')
748
"""Calculate automatic user identification.
750
Returns (realname, email).
752
Only used when none is set in the environment or the id file.
754
This previously used the FQDN as the default domain, but that can
755
be very slow on machines where DNS is broken. So now we simply
760
if sys.platform == 'win32':
761
name = win32utils.get_user_name_unicode()
763
raise errors.BzrError("Cannot autodetect user name.\n"
764
"Please, set your name with command like:\n"
765
'bzr whoami "Your Name <name@domain.com>"')
766
host = win32utils.get_host_name_unicode()
768
host = socket.gethostname()
769
return name, (name + '@' + host)
774
w = pwd.getpwuid(uid)
776
# we try utf-8 first, because on many variants (like Linux),
777
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
778
# false positives. (many users will have their user encoding set to
779
# latin-1, which cannot raise UnicodeError.)
781
gecos = w.pw_gecos.decode('utf-8')
785
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
786
encoding = bzrlib.user_encoding
788
raise errors.BzrCommandError('Unable to determine your name. '
789
'Use "bzr whoami" to set it.')
791
username = w.pw_name.decode(encoding)
793
raise errors.BzrCommandError('Unable to determine your name. '
794
'Use "bzr whoami" to set it.')
796
comma = gecos.find(',')
800
realname = gecos[:comma]
807
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
808
except UnicodeDecodeError:
809
raise errors.BzrError("Can't decode username as %s." % \
810
bzrlib.user_encoding)
812
return realname, (username + '@' + socket.gethostname())
815
def extract_email_address(e):
816
"""Return just the address part of an email string.
818
That is just the user@domain part, nothing else.
819
This part is required to contain only ascii characters.
820
If it can't be extracted, raises an error.
822
>>> extract_email_address('Jane Tester <jane@test.com>')
825
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
827
raise errors.NoEmailInUsername(e)
831
class TreeConfig(IniBasedConfig):
832
"""Branch configuration data associated with its contents, not location"""
833
def __init__(self, branch):
836
def _get_parser(self, file=None):
838
return IniBasedConfig._get_parser(file)
839
return self._get_config()
841
def _get_config(self):
843
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
845
except errors.NoSuchFile:
846
obj = ConfigObj(encoding='utf=8')
849
def get_option(self, name, section=None, default=None):
850
self.branch.lock_read()
852
obj = self._get_config()
854
if section is not None:
863
def set_option(self, value, name, section=None):
864
"""Set a per-branch configuration option"""
865
self.branch.lock_write()
867
cfg_obj = self._get_config()
872
obj = cfg_obj[section]
874
cfg_obj[section] = {}
875
obj = cfg_obj[section]
877
out_file = StringIO()
878
cfg_obj.write(out_file)
880
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
