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
80
import bzrlib.util.configobj.configobj as configobj
83
from bzrlib.trace import mutter, warning
96
class ConfigObj(configobj.ConfigObj):
98
def get_bool(self, section, key):
99
return self[section].as_bool(key)
101
def get_value(self, section, name):
102
# Try [] for the old DEFAULT section.
103
if section == "DEFAULT":
108
return self[section][name]
111
class Config(object):
112
"""A configuration policy - what username, editor, gpg needs etc."""
114
def get_editor(self):
115
"""Get the users pop up editor."""
116
raise NotImplementedError
118
def _get_signature_checking(self):
119
"""Template method to override signature checking policy."""
121
def _get_signing_policy(self):
122
"""Template method to override signature creation policy."""
124
def _get_user_option(self, option_name):
125
"""Template method to provide a user option."""
128
def get_user_option(self, option_name):
129
"""Get a generic option - no special process, no default."""
130
return self._get_user_option(option_name)
132
def gpg_signing_command(self):
133
"""What program should be used to sign signatures?"""
134
result = self._gpg_signing_command()
139
def _gpg_signing_command(self):
140
"""See gpg_signing_command()."""
143
def log_format(self):
144
"""What log format should be used"""
145
result = self._log_format()
150
def _log_format(self):
151
"""See log_format()."""
155
super(Config, self).__init__()
157
def post_commit(self):
158
"""An ordered list of python functions to call.
160
Each function takes branch, rev_id as parameters.
162
return self._post_commit()
164
def _post_commit(self):
165
"""See Config.post_commit."""
168
def user_email(self):
169
"""Return just the email component of a username."""
170
return extract_email_address(self.username())
173
"""Return email-style username.
175
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
177
$BZR_EMAIL can be set to override this (as well as the
178
deprecated $BZREMAIL), then
179
the concrete policy type is checked, and finally
181
If none is found, a reasonable default is (hopefully)
184
TODO: Check it's reasonably well-formed.
186
v = os.environ.get('BZR_EMAIL')
188
return v.decode(bzrlib.user_encoding)
189
v = os.environ.get('BZREMAIL')
191
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
192
return v.decode(bzrlib.user_encoding)
194
v = self._get_user_id()
198
v = os.environ.get('EMAIL')
200
return v.decode(bzrlib.user_encoding)
202
name, email = _auto_user_id()
204
return '%s <%s>' % (name, email)
208
def signature_checking(self):
209
"""What is the current policy for signature checking?."""
210
policy = self._get_signature_checking()
211
if policy is not None:
213
return CHECK_IF_POSSIBLE
215
def signing_policy(self):
216
"""What is the current policy for signature checking?."""
217
policy = self._get_signing_policy()
218
if policy is not None:
220
return SIGN_WHEN_REQUIRED
222
def signature_needed(self):
223
"""Is a signature needed when committing ?."""
224
policy = self._get_signing_policy()
226
policy = self._get_signature_checking()
227
if policy is not None:
228
warning("Please use create_signatures, not check_signatures "
229
"to set signing policy.")
230
if policy == CHECK_ALWAYS:
232
elif policy == SIGN_ALWAYS:
236
def get_alias(self, value):
237
return self._get_alias(value)
239
def _get_alias(self, value):
242
def get_nickname(self):
243
return self._get_nickname()
245
def _get_nickname(self):
249
class IniBasedConfig(Config):
250
"""A configuration policy that draws from ini files."""
252
def _get_parser(self, file=None):
253
if self._parser is not None:
256
input = self._get_filename()
260
self._parser = ConfigObj(input, encoding='utf-8')
261
except configobj.ConfigObjError, e:
262
raise errors.ParseConfigError(e.errors, e.config.filename)
265
def _get_section(self):
266
"""Override this to define the section used by the config."""
269
def _get_signature_checking(self):
270
"""See Config._get_signature_checking."""
271
policy = self._get_user_option('check_signatures')
273
return self._string_to_signature_policy(policy)
275
def _get_signing_policy(self):
276
"""See Config._get_signing_policy"""
277
policy = self._get_user_option('create_signatures')
279
return self._string_to_signing_policy(policy)
281
def _get_user_id(self):
282
"""Get the user id from the 'email' key in the current section."""
283
return self._get_user_option('email')
285
def _get_user_option(self, option_name):
286
"""See Config._get_user_option."""
288
return self._get_parser().get_value(self._get_section(),
293
def _gpg_signing_command(self):
294
"""See Config.gpg_signing_command."""
295
return self._get_user_option('gpg_signing_command')
297
def _log_format(self):
298
"""See Config.log_format."""
299
return self._get_user_option('log_format')
301
def __init__(self, get_filename):
302
super(IniBasedConfig, self).__init__()
303
self._get_filename = get_filename
306
def _post_commit(self):
307
"""See Config.post_commit."""
308
return self._get_user_option('post_commit')
310
def _string_to_signature_policy(self, signature_string):
311
"""Convert a string to a signing policy."""
312
if signature_string.lower() == 'check-available':
313
return CHECK_IF_POSSIBLE
314
if signature_string.lower() == 'ignore':
316
if signature_string.lower() == 'require':
318
raise errors.BzrError("Invalid signatures policy '%s'"
321
def _string_to_signing_policy(self, signature_string):
322
"""Convert a string to a signing policy."""
323
if signature_string.lower() == 'when-required':
324
return SIGN_WHEN_REQUIRED
325
if signature_string.lower() == 'never':
327
if signature_string.lower() == 'always':
329
raise errors.BzrError("Invalid signing policy '%s'"
332
def _get_alias(self, value):
334
return self._get_parser().get_value("ALIASES",
339
def _get_nickname(self):
340
return self.get_user_option('nickname')
343
class GlobalConfig(IniBasedConfig):
344
"""The configuration that should be used for a specific location."""
346
def get_editor(self):
347
return self._get_user_option('editor')
350
super(GlobalConfig, self).__init__(config_filename)
352
def set_user_option(self, option, value):
353
"""Save option and its value in the configuration."""
354
# FIXME: RBC 20051029 This should refresh the parser and also take a
355
# file lock on bazaar.conf.
356
conf_dir = os.path.dirname(self._get_filename())
357
ensure_config_dir_exists(conf_dir)
358
if 'DEFAULT' not in self._get_parser():
359
self._get_parser()['DEFAULT'] = {}
360
self._get_parser()['DEFAULT'][option] = value
361
f = open(self._get_filename(), 'wb')
362
self._get_parser().write(f)
366
class LocationConfig(IniBasedConfig):
367
"""A configuration object that gives the policy for a location."""
369
def __init__(self, location):
370
name_generator = locations_config_filename
371
if (not os.path.exists(name_generator()) and
372
os.path.exists(branches_config_filename())):
373
if sys.platform == 'win32':
374
warning('Please rename %s to %s'
375
% (branches_config_filename(),
376
locations_config_filename()))
378
warning('Please rename ~/.bazaar/branches.conf'
379
' to ~/.bazaar/locations.conf')
380
name_generator = branches_config_filename
381
super(LocationConfig, self).__init__(name_generator)
382
# local file locations are looked up by local path, rather than
383
# by file url. This is because the config file is a user
384
# file, and we would rather not expose the user to file urls.
385
if location.startswith('file://'):
386
location = urlutils.local_path_from_url(location)
387
self.location = location
389
def _get_section(self):
390
"""Get the section we should look in for config items.
392
Returns None if none exists.
393
TODO: perhaps return a NullSection that thunks through to the
396
sections = self._get_parser()
397
location_names = self.location.split('/')
398
if self.location.endswith('/'):
399
del location_names[-1]
401
for section in sections:
402
# location is a local path if possible, so we need
403
# to convert 'file://' urls to local paths if necessary.
404
# This also avoids having file:///path be a more exact
405
# match than '/path'.
406
if section.startswith('file://'):
407
section_path = urlutils.local_path_from_url(section)
409
section_path = section
410
section_names = section_path.split('/')
411
if section.endswith('/'):
412
del section_names[-1]
413
names = zip(location_names, section_names)
416
if not fnmatch(name[0], name[1]):
421
# so, for the common prefix they matched.
422
# if section is longer, no match.
423
if len(section_names) > len(location_names):
425
# if path is longer, and recurse is not true, no match
426
if len(section_names) < len(location_names):
428
if not self._get_parser()[section].as_bool('recurse'):
432
matches.append((len(section_names), section))
435
matches.sort(reverse=True)
438
def set_user_option(self, option, value):
439
"""Save option and its value in the configuration."""
440
# FIXME: RBC 20051029 This should refresh the parser and also take a
441
# file lock on locations.conf.
442
conf_dir = os.path.dirname(self._get_filename())
443
ensure_config_dir_exists(conf_dir)
444
location = self.location
445
if location.endswith('/'):
446
location = location[:-1]
447
if (not location in self._get_parser() and
448
not location + '/' in self._get_parser()):
449
self._get_parser()[location]={}
450
elif location + '/' in self._get_parser():
451
location = location + '/'
452
self._get_parser()[location][option]=value
453
self._get_parser().write(file(self._get_filename(), 'wb'))
456
class BranchConfig(Config):
457
"""A configuration object giving the policy for a branch."""
459
def _get_branch_data_config(self):
460
if self._branch_data_config is None:
461
self._branch_data_config = TreeConfig(self.branch)
462
return self._branch_data_config
464
def _get_location_config(self):
465
if self._location_config is None:
466
self._location_config = LocationConfig(self.branch.base)
467
return self._location_config
469
def _get_global_config(self):
470
if self._global_config is None:
471
self._global_config = GlobalConfig()
472
return self._global_config
474
def _get_best_value(self, option_name):
475
"""This returns a user option from local, tree or global config.
477
They are tried in that order. Use get_safe_value if trusted values
480
for source in self.option_sources:
481
value = getattr(source(), option_name)()
482
if value is not None:
486
def _get_safe_value(self, option_name):
487
"""This variant of get_best_value never returns untrusted values.
489
It does not return values from the branch data, because the branch may
490
not be controlled by the user.
492
We may wish to allow locations.conf to control whether branches are
493
trusted in the future.
495
for source in (self._get_location_config, self._get_global_config):
496
value = getattr(source(), option_name)()
497
if value is not None:
501
def _get_user_id(self):
502
"""Return the full user id for the branch.
504
e.g. "John Hacker <jhacker@foo.org>"
505
This is looked up in the email controlfile for the branch.
508
return (self.branch.control_files.get_utf8("email")
510
.decode(bzrlib.user_encoding)
512
except errors.NoSuchFile, e:
515
return self._get_best_value('_get_user_id')
517
def _get_signature_checking(self):
518
"""See Config._get_signature_checking."""
519
return self._get_best_value('_get_signature_checking')
521
def _get_signing_policy(self):
522
"""See Config._get_signing_policy."""
523
return self._get_best_value('_get_signing_policy')
525
def _get_user_option(self, option_name):
526
"""See Config._get_user_option."""
527
for source in self.option_sources:
528
value = source()._get_user_option(option_name)
529
if value is not None:
533
def set_user_option(self, name, value, local=False):
535
self._get_location_config().set_user_option(name, value)
537
self._get_branch_data_config().set_option(value, name)
540
def _gpg_signing_command(self):
541
"""See Config.gpg_signing_command."""
542
return self._get_safe_value('_gpg_signing_command')
544
def __init__(self, branch):
545
super(BranchConfig, self).__init__()
546
self._location_config = None
547
self._branch_data_config = None
548
self._global_config = None
550
self.option_sources = (self._get_location_config,
551
self._get_branch_data_config,
552
self._get_global_config)
554
def _post_commit(self):
555
"""See Config.post_commit."""
556
return self._get_safe_value('_post_commit')
558
def _get_nickname(self):
559
value = self._get_explicit_nickname()
560
if value is not None:
562
return self.branch.base.split('/')[-2]
564
def has_explicit_nickname(self):
565
"""Return true if a nickname has been explicitly assigned."""
566
return self._get_explicit_nickname() is not None
568
def _get_explicit_nickname(self):
569
return self._get_best_value('_get_nickname')
571
def _log_format(self):
572
"""See Config.log_format."""
573
return self._get_best_value('_log_format')
576
def ensure_config_dir_exists(path=None):
577
"""Make sure a configuration directory exists.
578
This makes sure that the directory exists.
579
On windows, since configuration directories are 2 levels deep,
580
it makes sure both the directory and the parent directory exists.
584
if not os.path.isdir(path):
585
if sys.platform == 'win32':
586
parent_dir = os.path.dirname(path)
587
if not os.path.isdir(parent_dir):
588
mutter('creating config parent directory: %r', parent_dir)
590
mutter('creating config directory: %r', path)
595
"""Return per-user configuration directory.
597
By default this is ~/.bazaar/
599
TODO: Global option --config-dir to override this.
601
base = os.environ.get('BZR_HOME', None)
602
if sys.platform == 'win32':
604
base = os.environ.get('APPDATA', None)
606
base = os.environ.get('HOME', None)
608
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
609
return osutils.pathjoin(base, 'bazaar', '2.0')
611
# cygwin, linux, and darwin all have a $HOME directory
613
base = os.path.expanduser("~")
614
return osutils.pathjoin(base, ".bazaar")
617
def config_filename():
618
"""Return per-user configuration ini file filename."""
619
return osutils.pathjoin(config_dir(), 'bazaar.conf')
622
def branches_config_filename():
623
"""Return per-user configuration ini file filename."""
624
return osutils.pathjoin(config_dir(), 'branches.conf')
627
def locations_config_filename():
628
"""Return per-user configuration ini file filename."""
629
return osutils.pathjoin(config_dir(), 'locations.conf')
632
def user_ignore_config_filename():
633
"""Return the user default ignore filename"""
634
return osutils.pathjoin(config_dir(), 'ignore')
638
"""Calculate automatic user identification.
640
Returns (realname, email).
642
Only used when none is set in the environment or the id file.
644
This previously used the FQDN as the default domain, but that can
645
be very slow on machines where DNS is broken. So now we simply
650
# XXX: Any good way to get real user name on win32?
655
w = pwd.getpwuid(uid)
657
# we try utf-8 first, because on many variants (like Linux),
658
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
659
# false positives. (many users will have their user encoding set to
660
# latin-1, which cannot raise UnicodeError.)
662
gecos = w.pw_gecos.decode('utf-8')
666
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
667
encoding = bzrlib.user_encoding
669
raise errors.BzrCommandError('Unable to determine your name. '
670
'Use "bzr whoami" to set it.')
672
username = w.pw_name.decode(encoding)
674
raise errors.BzrCommandError('Unable to determine your name. '
675
'Use "bzr whoami" to set it.')
677
comma = gecos.find(',')
681
realname = gecos[:comma]
688
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
689
except UnicodeDecodeError:
690
raise errors.BzrError("Can't decode username as %s." % \
691
bzrlib.user_encoding)
693
return realname, (username + '@' + socket.gethostname())
696
def extract_email_address(e):
697
"""Return just the address part of an email string.
699
That is just the user@domain part, nothing else.
700
This part is required to contain only ascii characters.
701
If it can't be extracted, raises an error.
703
>>> extract_email_address('Jane Tester <jane@test.com>')
706
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
708
raise errors.NoEmailInUsername(e)
712
class TreeConfig(IniBasedConfig):
713
"""Branch configuration data associated with its contents, not location"""
714
def __init__(self, branch):
717
def _get_parser(self, file=None):
719
return IniBasedConfig._get_parser(file)
720
return self._get_config()
722
def _get_config(self):
724
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
726
except errors.NoSuchFile:
727
obj = ConfigObj(encoding='utf=8')
730
def get_option(self, name, section=None, default=None):
731
self.branch.lock_read()
733
obj = self._get_config()
735
if section is not None:
744
def set_option(self, value, name, section=None):
745
"""Set a per-branch configuration option"""
746
self.branch.lock_write()
748
cfg_obj = self._get_config()
753
obj = cfg_obj[section]
755
cfg_obj[section] = {}
756
obj = cfg_obj[section]
758
out_file = StringIO()
759
cfg_obj.write(out_file)
761
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
