29
29
gpg_signing_command=name-of-program
30
30
log_format=name-of-format
32
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.
33
33
Wildcards may be used - * and ? as normal in shell completion. Options
34
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
36
36
[/home/robertc/source]
37
37
recurse=False|True(default)
39
check_signatures= as abive
39
check_signatures= as above
40
40
create_signatures= as above.
42
42
explanation of options
49
49
create_signatures - this option controls whether bzr will always create
50
50
gpg signatures, never create them, or create them if the
51
51
branch is configured to require them.
52
NB: This option is planned, but not implemented yet.
53
log_format - This options set the default log format. Options are long,
54
short, line, or a plugin can register new formats
52
log_format - this option sets the default log format. Possible values are
53
long, short, line, or a plugin can register new formats.
56
55
In bazaar.conf you can also define aliases in the ALIASES sections, example
66
from fnmatch import fnmatch
69
from fnmatch import fnmatch
70
from StringIO import StringIO
73
import bzrlib.errors as errors
73
from bzrlib import errors, urlutils
74
74
from bzrlib.osutils import pathjoin
75
from bzrlib.trace import mutter
75
from bzrlib.trace import mutter, warning
76
76
import bzrlib.util.configobj.configobj as configobj
77
from StringIO import StringIO
79
79
CHECK_IF_POSSIBLE=0
84
89
class ConfigObj(configobj.ConfigObj):
86
91
def get_bool(self, section, key):
106
111
def _get_signature_checking(self):
107
112
"""Template method to override signature checking policy."""
114
def _get_signing_policy(self):
115
"""Template method to override signature creation policy."""
109
117
def _get_user_option(self, option_name):
110
118
"""Template method to provide a user option."""
160
168
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
162
$BZREMAIL can be set to override this, then
170
$BZR_EMAIL can be set to override this (as well as the
171
deprecated $BZREMAIL), then
163
172
the concrete policy type is checked, and finally
164
173
$EMAIL is examined.
165
174
If none is found, a reasonable default is (hopefully)
193
206
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
195
215
def signature_needed(self):
196
216
"""Is a signature needed when committing ?."""
197
policy = self._get_signature_checking()
198
if policy == CHECK_ALWAYS:
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:
233
266
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)
235
274
def _get_user_id(self):
236
275
"""Get the user id from the 'email' key in the current section."""
237
276
return self._get_user_option('email')
272
311
raise errors.BzrError("Invalid signatures policy '%s'"
273
312
% 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'"
275
325
def _get_alias(self, value):
277
327
return self._get_parser().get_value("ALIASES",
289
342
def __init__(self):
290
343
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)
293
359
class LocationConfig(IniBasedConfig):
294
360
"""A configuration object that gives the policy for a location."""
296
362
def __init__(self, location):
297
super(LocationConfig, self).__init__(branches_config_filename)
298
self._global_config = None
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)
299
380
self.location = location
301
def _get_global_config(self):
302
if self._global_config is None:
303
self._global_config = GlobalConfig()
304
return self._global_config
306
382
def _get_section(self):
307
383
"""Get the section we should look in for config items.
316
392
del location_names[-1]
318
394
for section in sections:
319
section_names = section.split('/')
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('/')
320
404
if section.endswith('/'):
321
405
del section_names[-1]
322
406
names = zip(location_names, section_names)
344
428
matches.sort(reverse=True)
345
429
return matches[0][1]
347
def _gpg_signing_command(self):
348
"""See Config.gpg_signing_command."""
349
command = super(LocationConfig, self)._gpg_signing_command()
350
if command is not None:
352
return self._get_global_config()._gpg_signing_command()
354
def _log_format(self):
355
"""See Config.log_format."""
356
command = super(LocationConfig, self)._log_format()
357
if command is not None:
359
return self._get_global_config()._log_format()
361
def _get_user_id(self):
362
user_id = super(LocationConfig, self)._get_user_id()
363
if user_id is not None:
365
return self._get_global_config()._get_user_id()
367
def _get_user_option(self, option_name):
368
"""See Config._get_user_option."""
369
option_value = super(LocationConfig,
370
self)._get_user_option(option_name)
371
if option_value is not None:
373
return self._get_global_config()._get_user_option(option_name)
375
def _get_signature_checking(self):
376
"""See Config._get_signature_checking."""
377
check = super(LocationConfig, self)._get_signature_checking()
378
if check is not None:
380
return self._get_global_config()._get_signature_checking()
382
def _post_commit(self):
383
"""See Config.post_commit."""
384
hook = self._get_user_option('post_commit')
387
return self._get_global_config()._post_commit()
389
431
def set_user_option(self, option, value):
390
432
"""Save option and its value in the configuration."""
391
433
# FIXME: RBC 20051029 This should refresh the parser and also take a
392
# file lock on branches.conf.
434
# file lock on locations.conf.
393
435
conf_dir = os.path.dirname(self._get_filename())
394
436
ensure_config_dir_exists(conf_dir)
395
437
location = self.location
407
449
class BranchConfig(Config):
408
450
"""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
410
457
def _get_location_config(self):
411
458
if self._location_config is None:
412
459
self._location_config = LocationConfig(self.branch.base)
413
460
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:
415
494
def _get_user_id(self):
416
495
"""Return the full user id for the branch.
426
505
except errors.NoSuchFile, e:
429
return self._get_location_config()._get_user_id()
508
return self._get_best_value('_get_user_id')
431
510
def _get_signature_checking(self):
432
511
"""See Config._get_signature_checking."""
433
return self._get_location_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')
435
518
def _get_user_option(self, option_name):
436
519
"""See Config._get_user_option."""
437
return self._get_location_config()._get_user_option(option_name)
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)
439
533
def _gpg_signing_command(self):
440
534
"""See Config.gpg_signing_command."""
441
return self._get_location_config()._gpg_signing_command()
535
return self._get_safe_value('_gpg_signing_command')
443
537
def __init__(self, branch):
444
538
super(BranchConfig, self).__init__()
445
539
self._location_config = None
540
self._branch_data_config = None
541
self._global_config = None
446
542
self.branch = branch
543
self.option_sources = (self._get_location_config,
544
self._get_branch_data_config,
545
self._get_global_config)
448
547
def _post_commit(self):
449
548
"""See Config.post_commit."""
450
return self._get_location_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')
452
564
def _log_format(self):
453
565
"""See Config.log_format."""
454
return self._get_location_config()._log_format()
566
return self._get_best_value('_log_format')
457
569
def ensure_config_dir_exists(path=None):
487
599
base = os.environ.get('HOME', None)
489
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
601
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
490
602
return pathjoin(base, 'bazaar', '2.0')
492
604
# cygwin, linux, and darwin all have a $HOME directory
505
617
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')
508
630
def _auto_user_id():
509
631
"""Calculate automatic user identification.
525
647
uid = os.getuid()
526
648
w = pwd.getpwuid(uid)
529
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
530
username = w.pw_name.decode(bzrlib.user_encoding)
531
except UnicodeDecodeError:
532
# We're using pwd, therefore we're on Unix, so /etc/passwd is ok.
533
raise errors.BzrError("Can't decode username in " \
534
"/etc/passwd as %s." % bzrlib.user_encoding)
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.')
536
670
comma = gecos.find(',')
568
702
"a reasonable email address" % e)
569
703
return m.group(0)
571
class TreeConfig(object):
706
class TreeConfig(IniBasedConfig):
572
707
"""Branch configuration data associated with its contents, not location"""
573
708
def __init__(self, branch):
574
709
self.branch = branch
711
def _get_parser(self, file=None):
713
return IniBasedConfig._get_parser(file)
714
return self._get_config()
576
716
def _get_config(self):
578
718
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
added
removed
bzrlib/config.py
