1
# Copyright (C) 2005 by 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 options set the default log format. Options are long,
53
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
66
from fnmatch import fnmatch
70
from StringIO import StringIO
73
from bzrlib import errors, urlutils
74
from bzrlib.osutils import pathjoin
75
from bzrlib.trace import mutter, warning
76
import bzrlib.util.configobj.configobj as configobj
89
class ConfigObj(configobj.ConfigObj):
91
def get_bool(self, section, key):
92
return self[section].as_bool(key)
94
def get_value(self, section, name):
95
# Try [] for the old DEFAULT section.
96
if section == "DEFAULT":
101
return self[section][name]
104
class Config(object):
105
"""A configuration policy - what username, editor, gpg needs etc."""
107
def get_editor(self):
108
"""Get the users pop up editor."""
109
raise NotImplementedError
111
def _get_signature_checking(self):
112
"""Template method to override signature checking policy."""
114
def _get_signing_policy(self):
115
"""Template method to override signature creation policy."""
117
def _get_user_option(self, option_name):
118
"""Template method to provide a user option."""
121
def get_user_option(self, option_name):
122
"""Get a generic option - no special process, no default."""
123
return self._get_user_option(option_name)
125
def gpg_signing_command(self):
126
"""What program should be used to sign signatures?"""
127
result = self._gpg_signing_command()
132
def _gpg_signing_command(self):
133
"""See gpg_signing_command()."""
136
def log_format(self):
137
"""What log format should be used"""
138
result = self._log_format()
143
def _log_format(self):
144
"""See log_format()."""
148
super(Config, self).__init__()
150
def post_commit(self):
151
"""An ordered list of python functions to call.
153
Each function takes branch, rev_id as parameters.
155
return self._post_commit()
157
def _post_commit(self):
158
"""See Config.post_commit."""
161
def user_email(self):
162
"""Return just the email component of a username."""
163
return extract_email_address(self.username())
166
"""Return email-style username.
168
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
170
$BZREMAIL can be set to override this, then
171
the concrete policy type is checked, and finally
173
If none is found, a reasonable default is (hopefully)
176
TODO: Check it's reasonably well-formed.
178
v = os.environ.get('BZREMAIL')
180
return v.decode(bzrlib.user_encoding)
182
v = self._get_user_id()
186
v = os.environ.get('EMAIL')
188
return v.decode(bzrlib.user_encoding)
190
name, email = _auto_user_id()
192
return '%s <%s>' % (name, email)
196
def signature_checking(self):
197
"""What is the current policy for signature checking?."""
198
policy = self._get_signature_checking()
199
if policy is not None:
201
return CHECK_IF_POSSIBLE
203
def signing_policy(self):
204
"""What is the current policy for signature checking?."""
205
policy = self._get_signing_policy()
206
if policy is not None:
208
return SIGN_WHEN_REQUIRED
210
def signature_needed(self):
211
"""Is a signature needed when committing ?."""
212
policy = self._get_signing_policy()
214
policy = self._get_signature_checking()
215
if policy is not None:
216
warning("Please use create_signatures, not check_signatures "
217
"to set signing policy.")
218
if policy == CHECK_ALWAYS:
220
elif policy == SIGN_ALWAYS:
224
def get_alias(self, value):
225
return self._get_alias(value)
227
def _get_alias(self, value):
230
def get_nickname(self):
231
return self._get_nickname()
233
def _get_nickname(self):
237
class IniBasedConfig(Config):
238
"""A configuration policy that draws from ini files."""
240
def _get_parser(self, file=None):
241
if self._parser is not None:
244
input = self._get_filename()
248
self._parser = ConfigObj(input, encoding='utf-8')
249
except configobj.ConfigObjError, e:
250
raise errors.ParseConfigError(e.errors, e.config.filename)
253
def _get_section(self):
254
"""Override this to define the section used by the config."""
257
def _get_signature_checking(self):
258
"""See Config._get_signature_checking."""
259
policy = self._get_user_option('check_signatures')
261
return self._string_to_signature_policy(policy)
263
def _get_signing_policy(self):
264
"""See Config._get_signing_policy"""
265
policy = self._get_user_option('create_signatures')
267
return self._string_to_signing_policy(policy)
269
def _get_user_id(self):
270
"""Get the user id from the 'email' key in the current section."""
271
return self._get_user_option('email')
273
def _get_user_option(self, option_name):
274
"""See Config._get_user_option."""
276
return self._get_parser().get_value(self._get_section(),
281
def _gpg_signing_command(self):
282
"""See Config.gpg_signing_command."""
283
return self._get_user_option('gpg_signing_command')
285
def _log_format(self):
286
"""See Config.log_format."""
287
return self._get_user_option('log_format')
289
def __init__(self, get_filename):
290
super(IniBasedConfig, self).__init__()
291
self._get_filename = get_filename
294
def _post_commit(self):
295
"""See Config.post_commit."""
296
return self._get_user_option('post_commit')
298
def _string_to_signature_policy(self, signature_string):
299
"""Convert a string to a signing policy."""
300
if signature_string.lower() == 'check-available':
301
return CHECK_IF_POSSIBLE
302
if signature_string.lower() == 'ignore':
304
if signature_string.lower() == 'require':
306
raise errors.BzrError("Invalid signatures policy '%s'"
309
def _string_to_signing_policy(self, signature_string):
310
"""Convert a string to a signing policy."""
311
if signature_string.lower() == 'when-required':
312
return SIGN_WHEN_REQUIRED
313
if signature_string.lower() == 'never':
315
if signature_string.lower() == 'always':
317
raise errors.BzrError("Invalid signing policy '%s'"
320
def _get_alias(self, value):
322
return self._get_parser().get_value("ALIASES",
327
def _get_nickname(self):
328
return self.get_user_option('nickname')
331
class GlobalConfig(IniBasedConfig):
332
"""The configuration that should be used for a specific location."""
334
def get_editor(self):
335
return self._get_user_option('editor')
338
super(GlobalConfig, self).__init__(config_filename)
340
def set_user_option(self, option, value):
341
"""Save option and its value in the configuration."""
342
# FIXME: RBC 20051029 This should refresh the parser and also take a
343
# file lock on bazaar.conf.
344
conf_dir = os.path.dirname(self._get_filename())
345
ensure_config_dir_exists(conf_dir)
346
if 'DEFAULT' not in self._get_parser():
347
self._get_parser()['DEFAULT'] = {}
348
self._get_parser()['DEFAULT'][option] = value
349
f = open(self._get_filename(), 'wb')
350
self._get_parser().write(f)
354
class LocationConfig(IniBasedConfig):
355
"""A configuration object that gives the policy for a location."""
357
def __init__(self, location):
358
name_generator = locations_config_filename
359
if (not os.path.exists(name_generator()) and
360
os.path.exists(branches_config_filename())):
361
if sys.platform == 'win32':
362
warning('Please rename %s to %s'
363
% (branches_config_filename(),
364
locations_config_filename()))
366
warning('Please rename ~/.bazaar/branches.conf'
367
' to ~/.bazaar/locations.conf')
368
name_generator = branches_config_filename
369
super(LocationConfig, self).__init__(name_generator)
370
# local file locations are looked up by local path, rather than
371
# by file url. This is because the config file is a user
372
# file, and we would rather not expose the user to file urls.
373
if location.startswith('file://'):
374
location = urlutils.local_path_from_url(location)
375
self.location = location
377
def _get_section(self):
378
"""Get the section we should look in for config items.
380
Returns None if none exists.
381
TODO: perhaps return a NullSection that thunks through to the
384
sections = self._get_parser()
385
location_names = self.location.split('/')
386
if self.location.endswith('/'):
387
del location_names[-1]
389
for section in sections:
390
# location is a local path if possible, so we need
391
# to convert 'file://' urls to local paths if necessary.
392
# This also avoids having file:///path be a more exact
393
# match than '/path'.
394
if section.startswith('file://'):
395
section_path = urlutils.local_path_from_url(section)
397
section_path = section
398
section_names = section_path.split('/')
399
if section.endswith('/'):
400
del section_names[-1]
401
names = zip(location_names, section_names)
404
if not fnmatch(name[0], name[1]):
409
# so, for the common prefix they matched.
410
# if section is longer, no match.
411
if len(section_names) > len(location_names):
413
# if path is longer, and recurse is not true, no match
414
if len(section_names) < len(location_names):
416
if not self._get_parser()[section].as_bool('recurse'):
420
matches.append((len(section_names), section))
423
matches.sort(reverse=True)
426
def set_user_option(self, option, value):
427
"""Save option and its value in the configuration."""
428
# FIXME: RBC 20051029 This should refresh the parser and also take a
429
# file lock on locations.conf.
430
conf_dir = os.path.dirname(self._get_filename())
431
ensure_config_dir_exists(conf_dir)
432
location = self.location
433
if location.endswith('/'):
434
location = location[:-1]
435
if (not location in self._get_parser() and
436
not location + '/' in self._get_parser()):
437
self._get_parser()[location]={}
438
elif location + '/' in self._get_parser():
439
location = location + '/'
440
self._get_parser()[location][option]=value
441
self._get_parser().write(file(self._get_filename(), 'wb'))
444
class BranchConfig(Config):
445
"""A configuration object giving the policy for a branch."""
447
def _get_branch_data_config(self):
448
if self._branch_data_config is None:
449
self._branch_data_config = TreeConfig(self.branch)
450
return self._branch_data_config
452
def _get_location_config(self):
453
if self._location_config is None:
454
self._location_config = LocationConfig(self.branch.base)
455
return self._location_config
457
def _get_global_config(self):
458
if self._global_config is None:
459
self._global_config = GlobalConfig()
460
return self._global_config
462
def _get_best_value(self, option_name):
463
"""This returns a user option from local, tree or global config.
465
They are tried in that order. Use get_safe_value if trusted values
468
for source in self.option_sources:
469
value = getattr(source(), option_name)()
470
if value is not None:
474
def _get_safe_value(self, option_name):
475
"""This variant of get_best_value never returns untrusted values.
477
It does not return values from the branch data, because the branch may
478
not be controlled by the user.
480
We may wish to allow locations.conf to control whether branches are
481
trusted in the future.
483
for source in (self._get_location_config, self._get_global_config):
484
value = getattr(source(), option_name)()
485
if value is not None:
489
def _get_user_id(self):
490
"""Return the full user id for the branch.
492
e.g. "John Hacker <jhacker@foo.org>"
493
This is looked up in the email controlfile for the branch.
496
return (self.branch.control_files.get_utf8("email")
498
.decode(bzrlib.user_encoding)
500
except errors.NoSuchFile, e:
503
return self._get_best_value('_get_user_id')
505
def _get_signature_checking(self):
506
"""See Config._get_signature_checking."""
507
return self._get_best_value('_get_signature_checking')
509
def _get_signing_policy(self):
510
"""See Config._get_signing_policy."""
511
return self._get_best_value('_get_signing_policy')
513
def _get_user_option(self, option_name):
514
"""See Config._get_user_option."""
515
for source in self.option_sources:
516
value = source()._get_user_option(option_name)
517
if value is not None:
521
def set_user_option(self, name, value, local=False):
523
self._get_location_config().set_user_option(name, value)
525
self._get_branch_data_config().set_option(value, name)
528
def _gpg_signing_command(self):
529
"""See Config.gpg_signing_command."""
530
return self._get_safe_value('_gpg_signing_command')
532
def __init__(self, branch):
533
super(BranchConfig, self).__init__()
534
self._location_config = None
535
self._branch_data_config = None
536
self._global_config = None
538
self.option_sources = (self._get_location_config,
539
self._get_branch_data_config,
540
self._get_global_config)
542
def _post_commit(self):
543
"""See Config.post_commit."""
544
return self._get_safe_value('_post_commit')
546
def _get_nickname(self):
547
value = self._get_explicit_nickname()
548
if value is not None:
550
return self.branch.base.split('/')[-2]
552
def has_explicit_nickname(self):
553
"""Return true if a nickname has been explicitly assigned."""
554
return self._get_explicit_nickname() is not None
556
def _get_explicit_nickname(self):
557
return self._get_best_value('_get_nickname')
559
def _log_format(self):
560
"""See Config.log_format."""
561
return self._get_best_value('_log_format')
564
def ensure_config_dir_exists(path=None):
565
"""Make sure a configuration directory exists.
566
This makes sure that the directory exists.
567
On windows, since configuration directories are 2 levels deep,
568
it makes sure both the directory and the parent directory exists.
572
if not os.path.isdir(path):
573
if sys.platform == 'win32':
574
parent_dir = os.path.dirname(path)
575
if not os.path.isdir(parent_dir):
576
mutter('creating config parent directory: %r', parent_dir)
578
mutter('creating config directory: %r', path)
583
"""Return per-user configuration directory.
585
By default this is ~/.bazaar/
587
TODO: Global option --config-dir to override this.
589
base = os.environ.get('BZR_HOME', None)
590
if sys.platform == 'win32':
592
base = os.environ.get('APPDATA', None)
594
base = os.environ.get('HOME', None)
596
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
597
return pathjoin(base, 'bazaar', '2.0')
599
# cygwin, linux, and darwin all have a $HOME directory
601
base = os.path.expanduser("~")
602
return pathjoin(base, ".bazaar")
605
def config_filename():
606
"""Return per-user configuration ini file filename."""
607
return pathjoin(config_dir(), 'bazaar.conf')
610
def branches_config_filename():
611
"""Return per-user configuration ini file filename."""
612
return pathjoin(config_dir(), 'branches.conf')
615
def locations_config_filename():
616
"""Return per-user configuration ini file filename."""
617
return pathjoin(config_dir(), 'locations.conf')
620
def user_ignore_config_filename():
621
"""Return the user default ignore filename"""
622
return pathjoin(config_dir(), 'ignore')
626
"""Calculate automatic user identification.
628
Returns (realname, email).
630
Only used when none is set in the environment or the id file.
632
This previously used the FQDN as the default domain, but that can
633
be very slow on machines where DNS is broken. So now we simply
638
# XXX: Any good way to get real user name on win32?
643
w = pwd.getpwuid(uid)
645
# we try utf-8 first, because on many variants (like Linux),
646
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
647
# false positives. (many users will have their user encoding set to
648
# latin-1, which cannot raise UnicodeError.)
650
gecos = w.pw_gecos.decode('utf-8')
654
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
655
encoding = bzrlib.user_encoding
657
raise errors.BzrCommandError('Unable to determine your name. '
658
'Use "bzr whoami" to set it.')
660
username = w.pw_name.decode(encoding)
662
raise errors.BzrCommandError('Unable to determine your name. '
663
'Use "bzr whoami" to set it.')
665
comma = gecos.find(',')
669
realname = gecos[:comma]
676
realname = username = getpass.getuser().decode(bzrlib.user_encoding)
677
except UnicodeDecodeError:
678
raise errors.BzrError("Can't decode username as %s." % \
679
bzrlib.user_encoding)
681
return realname, (username + '@' + socket.gethostname())
684
def extract_email_address(e):
685
"""Return just the address part of an email string.
687
That is just the user@domain part, nothing else.
688
This part is required to contain only ascii characters.
689
If it can't be extracted, raises an error.
691
>>> extract_email_address('Jane Tester <jane@test.com>')
694
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
696
raise errors.BzrError("%r doesn't seem to contain "
697
"a reasonable email address" % e)
701
class TreeConfig(IniBasedConfig):
702
"""Branch configuration data associated with its contents, not location"""
703
def __init__(self, branch):
706
def _get_parser(self, file=None):
708
return IniBasedConfig._get_parser(file)
709
return self._get_config()
711
def _get_config(self):
713
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
715
except errors.NoSuchFile:
716
obj = ConfigObj(encoding='utf=8')
719
def get_option(self, name, section=None, default=None):
720
self.branch.lock_read()
722
obj = self._get_config()
724
if section is not None:
733
def set_option(self, value, name, section=None):
734
"""Set a per-branch configuration option"""
735
self.branch.lock_write()
737
cfg_obj = self._get_config()
742
obj = cfg_obj[section]
744
cfg_obj[section] = {}
745
obj = cfg_obj[section]
747
out_file = StringIO()
748
cfg_obj.write(out_file)
750
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
