18
18
"""Configuration that affects the behaviour of Bazaar.
20
20
Currently this configuration resides in ~/.bazaar/bazaar.conf
21
and ~/.bazaar/branches.conf, which is written to by bzr.
21
and ~/.bazaar/locations.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
31
in branches.conf, you specify the url of a branch and options for it.
32
in locations.conf, you specify the url of a branch and options for it.
32
33
Wildcards may be used - * and ? as normal in shell completion. Options
33
set in both bazaar.conf and branches.conf are overriden by the branches.conf
34
set in both bazaar.conf and locations.conf are overridden by the locations.conf
35
36
[/home/robertc/source]
36
37
recurse=False|True(default)
38
check_signatures= as abive
39
check_signatures= as above
39
40
create_signatures= as above.
41
42
explanation of options
48
49
create_signatures - this option controls whether bzr will always create
49
50
gpg signatures, never create them, or create them if the
50
51
branch is configured to require them.
51
NB: This option is planned, but not implemented yet.
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
58
from fnmatch import fnmatch
70
from StringIO import StringIO
62
import bzrlib.errors as errors
73
from bzrlib import errors, urlutils
63
74
from bzrlib.osutils import pathjoin
64
from bzrlib.trace import mutter
75
from bzrlib.trace import mutter, warning
65
76
import bzrlib.util.configobj.configobj as configobj
66
from StringIO import StringIO
68
79
CHECK_IF_POSSIBLE=0
73
89
class ConfigObj(configobj.ConfigObj):
75
91
def get_bool(self, section, 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)
92
return self[section].as_bool(key)
84
94
def get_value(self, section, name):
85
95
# Try [] for the old DEFAULT section.
101
111
def _get_signature_checking(self):
102
112
"""Template method to override signature checking policy."""
114
def _get_signing_policy(self):
115
"""Template method to override signature creation policy."""
104
117
def _get_user_option(self, option_name):
105
118
"""Template method to provide a user option."""
177
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
179
210
def signature_needed(self):
180
211
"""Is a signature needed when committing ?."""
181
policy = self._get_signature_checking()
182
if policy == CHECK_ALWAYS:
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):
187
237
class IniBasedConfig(Config):
188
238
"""A configuration policy that draws from ini files."""
211
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)
213
269
def _get_user_id(self):
214
270
"""Get the user id from the 'email' key in the current section."""
215
271
return self._get_user_option('email')
226
282
"""See Config.gpg_signing_command."""
227
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')
229
289
def __init__(self, get_filename):
230
290
super(IniBasedConfig, self).__init__()
231
291
self._get_filename = get_filename
246
306
raise errors.BzrError("Invalid signatures policy '%s'"
247
307
% signature_string)
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')
250
331
class GlobalConfig(IniBasedConfig):
251
332
"""The configuration that should be used for a specific location."""
256
337
def __init__(self):
257
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)
260
354
class LocationConfig(IniBasedConfig):
261
355
"""A configuration object that gives the policy for a location."""
263
357
def __init__(self, location):
264
super(LocationConfig, self).__init__(branches_config_filename)
265
self._global_config = None
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)
266
375
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
273
377
def _get_section(self):
274
378
"""Get the section we should look in for config items.
283
387
del location_names[-1]
285
389
for section in sections:
286
section_names = section.split('/')
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('/')
287
399
if section.endswith('/'):
288
400
del section_names[-1]
289
401
names = zip(location_names, section_names)
311
423
matches.sort(reverse=True)
312
424
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()
349
426
def set_user_option(self, option, value):
350
427
"""Save option and its value in the configuration."""
351
428
# FIXME: RBC 20051029 This should refresh the parser and also take a
352
# file lock on branches.conf.
429
# file lock on locations.conf.
353
430
conf_dir = os.path.dirname(self._get_filename())
354
431
ensure_config_dir_exists(conf_dir)
355
432
location = self.location
361
438
elif location + '/' in self._get_parser():
362
439
location = location + '/'
363
440
self._get_parser()[location][option]=value
364
self._get_parser().write()
441
self._get_parser().write(file(self._get_filename(), 'wb'))
367
444
class BranchConfig(Config):
368
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
370
452
def _get_location_config(self):
371
453
if self._location_config is None:
372
454
self._location_config = LocationConfig(self.branch.base)
373
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:
375
489
def _get_user_id(self):
376
490
"""Return the full user id for the branch.
386
500
except errors.NoSuchFile, e:
389
return self._get_location_config()._get_user_id()
503
return self._get_best_value('_get_user_id')
391
505
def _get_signature_checking(self):
392
506
"""See Config._get_signature_checking."""
393
return self._get_location_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')
395
513
def _get_user_option(self, option_name):
396
514
"""See Config._get_user_option."""
397
return self._get_location_config()._get_user_option(option_name)
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)
399
528
def _gpg_signing_command(self):
400
529
"""See Config.gpg_signing_command."""
401
return self._get_location_config()._gpg_signing_command()
530
return self._get_safe_value('_gpg_signing_command')
403
532
def __init__(self, branch):
404
533
super(BranchConfig, self).__init__()
405
534
self._location_config = None
535
self._branch_data_config = None
536
self._global_config = None
406
537
self.branch = branch
538
self.option_sources = (self._get_location_config,
539
self._get_branch_data_config,
540
self._get_global_config)
408
542
def _post_commit(self):
409
543
"""See Config.post_commit."""
410
return self._get_location_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')
413
564
def ensure_config_dir_exists(path=None):
443
594
base = os.environ.get('HOME', None)
445
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
596
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
446
597
return pathjoin(base, 'bazaar', '2.0')
448
599
# cygwin, linux, and darwin all have a $HOME directory
461
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')
464
625
def _auto_user_id():
465
626
"""Calculate automatic user identification.
481
642
uid = os.getuid()
482
643
w = pwd.getpwuid(uid)
483
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
484
username = w.pw_name.decode(bzrlib.user_encoding)
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.')
485
665
comma = gecos.find(',')
513
697
"a reasonable email address" % e)
514
698
return m.group(0)
516
class TreeConfig(object):
701
class TreeConfig(IniBasedConfig):
517
702
"""Branch configuration data associated with its contents, not location"""
518
703
def __init__(self, branch):
519
704
self.branch = branch
706
def _get_parser(self, file=None):
708
return IniBasedConfig._get_parser(file)
709
return self._get_config()
521
711
def _get_config(self):
523
obj = ConfigObj(self.branch.control_files.get('branch.conf'
713
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
526
715
except errors.NoSuchFile:
716
obj = ConfigObj(encoding='utf=8')
530
719
def get_option(self, name, section=None, default=None):
added
removed
bzrlib/config.py
