18
18
"""Configuration that affects the behaviour of Bazaar.
20
20
Currently this configuration resides in ~/.bazaar/bazaar.conf
21
and ~/.bazaar/locations.conf, which is written to by bzr.
21
and ~/.bazaar/branches.conf, which is written to by bzr.
23
23
In bazaar.conf the following options may be set:
27
27
check_signatures=require|ignore|check-available(default)
28
28
create_signatures=always|never|when-required(default)
29
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.
31
in branches.conf, you specify the url of a branch and options for it.
33
32
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
33
set in both bazaar.conf and branches.conf are overriden by the branches.conf
36
35
[/home/robertc/source]
37
36
recurse=False|True(default)
39
check_signatures= as above
38
check_signatures= as abive
40
39
create_signatures= as above.
42
41
explanation of options
49
48
create_signatures - this option controls whether bzr will always create
50
49
gpg signatures, never create them, or create them if the
51
50
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
51
NB: This option is planned, but not implemented yet.
66
58
from fnmatch import fnmatch
70
from StringIO import StringIO
73
from bzrlib import errors, urlutils
62
import bzrlib.errors as errors
74
63
from bzrlib.osutils import pathjoin
75
from bzrlib.trace import mutter, warning
64
from bzrlib.trace import mutter
76
65
import bzrlib.util.configobj.configobj as configobj
66
from StringIO import StringIO
79
68
CHECK_IF_POSSIBLE=0
89
73
class ConfigObj(configobj.ConfigObj):
91
75
def get_bool(self, section, key):
92
return self[section].as_bool(key)
76
val = self[section][key].lower()
77
if val in ('1', 'yes', 'true', 'on'):
79
elif val in ('0', 'no', 'false', 'off'):
82
raise ValueError("Value %r is not boolean" % val)
94
84
def get_value(self, section, name):
95
85
# Try [] for the old DEFAULT section.
111
101
def _get_signature_checking(self):
112
102
"""Template method to override signature checking policy."""
114
def _get_signing_policy(self):
115
"""Template method to override signature creation policy."""
117
104
def _get_user_option(self, option_name):
118
105
"""Template method to provide a user option."""
168
144
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
170
$BZR_EMAIL can be set to override this (as well as the
171
deprecated $BZREMAIL), then
146
$BZREMAIL can be set to override this, then
172
147
the concrete policy type is checked, and finally
173
148
$EMAIL is examined.
174
149
If none is found, a reasonable default is (hopefully)
177
152
TODO: Check it's reasonably well-formed.
179
v = os.environ.get('BZR_EMAIL')
181
return v.decode(bzrlib.user_encoding)
182
154
v = os.environ.get('BZREMAIL')
184
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
185
156
return v.decode(bzrlib.user_encoding)
187
158
v = self._get_user_id()
206
177
return CHECK_IF_POSSIBLE
208
def signing_policy(self):
209
"""What is the current policy for signature checking?."""
210
policy = self._get_signing_policy()
211
if policy is not None:
213
return SIGN_WHEN_REQUIRED
215
179
def signature_needed(self):
216
180
"""Is a signature needed when committing ?."""
217
policy = self._get_signing_policy()
219
policy = self._get_signature_checking()
220
if policy is not None:
221
warning("Please use create_signatures, not check_signatures "
222
"to set signing policy.")
223
if policy == CHECK_ALWAYS:
225
elif policy == SIGN_ALWAYS:
181
policy = self._get_signature_checking()
182
if policy == CHECK_ALWAYS:
229
def get_alias(self, value):
230
return self._get_alias(value)
232
def _get_alias(self, value):
235
def get_nickname(self):
236
return self._get_nickname()
238
def _get_nickname(self):
242
187
class IniBasedConfig(Config):
243
188
"""A configuration policy that draws from ini files."""
266
211
return self._string_to_signature_policy(policy)
268
def _get_signing_policy(self):
269
"""See Config._get_signing_policy"""
270
policy = self._get_user_option('create_signatures')
272
return self._string_to_signing_policy(policy)
274
213
def _get_user_id(self):
275
214
"""Get the user id from the 'email' key in the current section."""
276
215
return self._get_user_option('email')
287
226
"""See Config.gpg_signing_command."""
288
227
return self._get_user_option('gpg_signing_command')
290
def _log_format(self):
291
"""See Config.log_format."""
292
return self._get_user_option('log_format')
294
229
def __init__(self, get_filename):
295
230
super(IniBasedConfig, self).__init__()
296
231
self._get_filename = get_filename
311
246
raise errors.BzrError("Invalid signatures policy '%s'"
312
247
% signature_string)
314
def _string_to_signing_policy(self, signature_string):
315
"""Convert a string to a signing policy."""
316
if signature_string.lower() == 'when-required':
317
return SIGN_WHEN_REQUIRED
318
if signature_string.lower() == 'never':
320
if signature_string.lower() == 'always':
322
raise errors.BzrError("Invalid signing policy '%s'"
325
def _get_alias(self, value):
327
return self._get_parser().get_value("ALIASES",
332
def _get_nickname(self):
333
return self.get_user_option('nickname')
336
250
class GlobalConfig(IniBasedConfig):
337
251
"""The configuration that should be used for a specific location."""
342
256
def __init__(self):
343
257
super(GlobalConfig, self).__init__(config_filename)
345
def set_user_option(self, option, value):
346
"""Save option and its value in the configuration."""
347
# FIXME: RBC 20051029 This should refresh the parser and also take a
348
# file lock on bazaar.conf.
349
conf_dir = os.path.dirname(self._get_filename())
350
ensure_config_dir_exists(conf_dir)
351
if 'DEFAULT' not in self._get_parser():
352
self._get_parser()['DEFAULT'] = {}
353
self._get_parser()['DEFAULT'][option] = value
354
f = open(self._get_filename(), 'wb')
355
self._get_parser().write(f)
359
260
class LocationConfig(IniBasedConfig):
360
261
"""A configuration object that gives the policy for a location."""
362
263
def __init__(self, location):
363
name_generator = locations_config_filename
364
if (not os.path.exists(name_generator()) and
365
os.path.exists(branches_config_filename())):
366
if sys.platform == 'win32':
367
warning('Please rename %s to %s'
368
% (branches_config_filename(),
369
locations_config_filename()))
371
warning('Please rename ~/.bazaar/branches.conf'
372
' to ~/.bazaar/locations.conf')
373
name_generator = branches_config_filename
374
super(LocationConfig, self).__init__(name_generator)
375
# local file locations are looked up by local path, rather than
376
# by file url. This is because the config file is a user
377
# file, and we would rather not expose the user to file urls.
378
if location.startswith('file://'):
379
location = urlutils.local_path_from_url(location)
264
super(LocationConfig, self).__init__(branches_config_filename)
265
self._global_config = None
380
266
self.location = location
268
def _get_global_config(self):
269
if self._global_config is None:
270
self._global_config = GlobalConfig()
271
return self._global_config
382
273
def _get_section(self):
383
274
"""Get the section we should look in for config items.
392
283
del location_names[-1]
394
285
for section in sections:
395
# location is a local path if possible, so we need
396
# to convert 'file://' urls to local paths if necessary.
397
# This also avoids having file:///path be a more exact
398
# match than '/path'.
399
if section.startswith('file://'):
400
section_path = urlutils.local_path_from_url(section)
402
section_path = section
403
section_names = section_path.split('/')
286
section_names = section.split('/')
404
287
if section.endswith('/'):
405
288
del section_names[-1]
406
289
names = zip(location_names, section_names)
428
311
matches.sort(reverse=True)
429
312
return matches[0][1]
314
def _gpg_signing_command(self):
315
"""See Config.gpg_signing_command."""
316
command = super(LocationConfig, self)._gpg_signing_command()
317
if command is not None:
319
return self._get_global_config()._gpg_signing_command()
321
def _get_user_id(self):
322
user_id = super(LocationConfig, self)._get_user_id()
323
if user_id is not None:
325
return self._get_global_config()._get_user_id()
327
def _get_user_option(self, option_name):
328
"""See Config._get_user_option."""
329
option_value = super(LocationConfig,
330
self)._get_user_option(option_name)
331
if option_value is not None:
333
return self._get_global_config()._get_user_option(option_name)
335
def _get_signature_checking(self):
336
"""See Config._get_signature_checking."""
337
check = super(LocationConfig, self)._get_signature_checking()
338
if check is not None:
340
return self._get_global_config()._get_signature_checking()
342
def _post_commit(self):
343
"""See Config.post_commit."""
344
hook = self._get_user_option('post_commit')
347
return self._get_global_config()._post_commit()
431
349
def set_user_option(self, option, value):
432
350
"""Save option and its value in the configuration."""
433
351
# FIXME: RBC 20051029 This should refresh the parser and also take a
434
# file lock on locations.conf.
352
# file lock on branches.conf.
435
353
conf_dir = os.path.dirname(self._get_filename())
436
354
ensure_config_dir_exists(conf_dir)
437
355
location = self.location
443
361
elif location + '/' in self._get_parser():
444
362
location = location + '/'
445
363
self._get_parser()[location][option]=value
446
self._get_parser().write(file(self._get_filename(), 'wb'))
364
self._get_parser().write()
449
367
class BranchConfig(Config):
450
368
"""A configuration object giving the policy for a branch."""
452
def _get_branch_data_config(self):
453
if self._branch_data_config is None:
454
self._branch_data_config = TreeConfig(self.branch)
455
return self._branch_data_config
457
370
def _get_location_config(self):
458
371
if self._location_config is None:
459
372
self._location_config = LocationConfig(self.branch.base)
460
373
return self._location_config
462
def _get_global_config(self):
463
if self._global_config is None:
464
self._global_config = GlobalConfig()
465
return self._global_config
467
def _get_best_value(self, option_name):
468
"""This returns a user option from local, tree or global config.
470
They are tried in that order. Use get_safe_value if trusted values
473
for source in self.option_sources:
474
value = getattr(source(), option_name)()
475
if value is not None:
479
def _get_safe_value(self, option_name):
480
"""This variant of get_best_value never returns untrusted values.
482
It does not return values from the branch data, because the branch may
483
not be controlled by the user.
485
We may wish to allow locations.conf to control whether branches are
486
trusted in the future.
488
for source in (self._get_location_config, self._get_global_config):
489
value = getattr(source(), option_name)()
490
if value is not None:
494
375
def _get_user_id(self):
495
376
"""Return the full user id for the branch.
505
386
except errors.NoSuchFile, e:
508
return self._get_best_value('_get_user_id')
389
return self._get_location_config()._get_user_id()
510
391
def _get_signature_checking(self):
511
392
"""See Config._get_signature_checking."""
512
return self._get_best_value('_get_signature_checking')
514
def _get_signing_policy(self):
515
"""See Config._get_signing_policy."""
516
return self._get_best_value('_get_signing_policy')
393
return self._get_location_config()._get_signature_checking()
518
395
def _get_user_option(self, option_name):
519
396
"""See Config._get_user_option."""
520
for source in self.option_sources:
521
value = source()._get_user_option(option_name)
522
if value is not None:
526
def set_user_option(self, name, value, local=False):
528
self._get_location_config().set_user_option(name, value)
530
self._get_branch_data_config().set_option(value, name)
397
return self._get_location_config()._get_user_option(option_name)
533
399
def _gpg_signing_command(self):
534
400
"""See Config.gpg_signing_command."""
535
return self._get_safe_value('_gpg_signing_command')
401
return self._get_location_config()._gpg_signing_command()
537
403
def __init__(self, branch):
538
404
super(BranchConfig, self).__init__()
539
405
self._location_config = None
540
self._branch_data_config = None
541
self._global_config = None
542
406
self.branch = branch
543
self.option_sources = (self._get_location_config,
544
self._get_branch_data_config,
545
self._get_global_config)
547
408
def _post_commit(self):
548
409
"""See Config.post_commit."""
549
return self._get_safe_value('_post_commit')
551
def _get_nickname(self):
552
value = self._get_explicit_nickname()
553
if value is not None:
555
return self.branch.base.split('/')[-2]
557
def has_explicit_nickname(self):
558
"""Return true if a nickname has been explicitly assigned."""
559
return self._get_explicit_nickname() is not None
561
def _get_explicit_nickname(self):
562
return self._get_best_value('_get_nickname')
564
def _log_format(self):
565
"""See Config.log_format."""
566
return self._get_best_value('_log_format')
410
return self._get_location_config()._post_commit()
569
413
def ensure_config_dir_exists(path=None):
599
443
base = os.environ.get('HOME', None)
601
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
445
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
602
446
return pathjoin(base, 'bazaar', '2.0')
604
448
# cygwin, linux, and darwin all have a $HOME directory
617
461
return pathjoin(config_dir(), 'branches.conf')
620
def locations_config_filename():
621
"""Return per-user configuration ini file filename."""
622
return pathjoin(config_dir(), 'locations.conf')
625
def user_ignore_config_filename():
626
"""Return the user default ignore filename"""
627
return pathjoin(config_dir(), 'ignore')
630
464
def _auto_user_id():
631
465
"""Calculate automatic user identification.
647
481
uid = os.getuid()
648
482
w = pwd.getpwuid(uid)
650
# we try utf-8 first, because on many variants (like Linux),
651
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
652
# false positives. (many users will have their user encoding set to
653
# latin-1, which cannot raise UnicodeError.)
655
gecos = w.pw_gecos.decode('utf-8')
659
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
660
encoding = bzrlib.user_encoding
662
raise errors.BzrCommandError('Unable to determine your name. '
663
'Use "bzr whoami" to set it.')
665
username = w.pw_name.decode(encoding)
667
raise errors.BzrCommandError('Unable to determine your name. '
668
'Use "bzr whoami" to set it.')
483
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
484
username = w.pw_name.decode(bzrlib.user_encoding)
670
485
comma = gecos.find(',')
702
513
"a reasonable email address" % e)
703
514
return m.group(0)
706
class TreeConfig(IniBasedConfig):
516
class TreeConfig(object):
707
517
"""Branch configuration data associated with its contents, not location"""
708
518
def __init__(self, branch):
709
519
self.branch = branch
711
def _get_parser(self, file=None):
713
return IniBasedConfig._get_parser(file)
714
return self._get_config()
716
521
def _get_config(self):
718
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
523
obj = ConfigObj(self.branch.control_files.get('branch.conf'
720
526
except errors.NoSuchFile:
721
obj = ConfigObj(encoding='utf=8')
724
530
def get_option(self, name, section=None, default=None):
added
removed
bzrlib/config.py
