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 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
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
74
from bzrlib.osutils import pathjoin
75
from bzrlib.trace import mutter, warning
63
76
import bzrlib.util.configobj.configobj as configobj
64
from StringIO import StringIO
66
79
CHECK_IF_POSSIBLE=0
71
89
class ConfigObj(configobj.ConfigObj):
73
91
def get_bool(self, section, key):
74
val = self[section][key].lower()
75
if val in ('1', 'yes', 'true', 'on'):
77
elif val in ('0', 'no', 'false', 'off'):
80
raise ValueError("Value %r is not boolean" % val)
92
return self[section].as_bool(key)
82
94
def get_value(self, section, name):
83
95
# Try [] for the old DEFAULT section.
175
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
177
215
def signature_needed(self):
178
216
"""Is a signature needed when committing ?."""
179
policy = self._get_signature_checking()
180
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:
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):
185
242
class IniBasedConfig(Config):
186
243
"""A configuration policy that draws from ini files."""
244
311
raise errors.BzrError("Invalid signatures policy '%s'"
245
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'"
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')
248
336
class GlobalConfig(IniBasedConfig):
249
337
"""The configuration that should be used for a specific location."""
254
342
def __init__(self):
255
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)
258
359
class LocationConfig(IniBasedConfig):
259
360
"""A configuration object that gives the policy for a location."""
261
362
def __init__(self, location):
262
super(LocationConfig, self).__init__(branches_config_filename)
263
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)
264
380
self.location = location
266
def _get_global_config(self):
267
if self._global_config is None:
268
self._global_config = GlobalConfig()
269
return self._global_config
271
382
def _get_section(self):
272
383
"""Get the section we should look in for config items.
281
392
del location_names[-1]
283
394
for section in sections:
284
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('/')
285
404
if section.endswith('/'):
286
405
del section_names[-1]
287
406
names = zip(location_names, section_names)
309
428
matches.sort(reverse=True)
310
429
return matches[0][1]
312
def _gpg_signing_command(self):
313
"""See Config.gpg_signing_command."""
314
command = super(LocationConfig, self)._gpg_signing_command()
315
if command is not None:
317
return self._get_global_config()._gpg_signing_command()
319
def _get_user_id(self):
320
user_id = super(LocationConfig, self)._get_user_id()
321
if user_id is not None:
323
return self._get_global_config()._get_user_id()
325
def _get_user_option(self, option_name):
326
"""See Config._get_user_option."""
327
option_value = super(LocationConfig,
328
self)._get_user_option(option_name)
329
if option_value is not None:
331
return self._get_global_config()._get_user_option(option_name)
333
def _get_signature_checking(self):
334
"""See Config._get_signature_checking."""
335
check = super(LocationConfig, self)._get_signature_checking()
336
if check is not None:
338
return self._get_global_config()._get_signature_checking()
340
def _post_commit(self):
341
"""See Config.post_commit."""
342
hook = self._get_user_option('post_commit')
345
return self._get_global_config()._post_commit()
347
431
def set_user_option(self, option, value):
348
432
"""Save option and its value in the configuration."""
349
433
# FIXME: RBC 20051029 This should refresh the parser and also take a
350
# file lock on branches.conf.
351
if not os.path.isdir(os.path.dirname(self._get_filename())):
352
os.mkdir(os.path.dirname(self._get_filename()))
434
# file lock on locations.conf.
435
conf_dir = os.path.dirname(self._get_filename())
436
ensure_config_dir_exists(conf_dir)
353
437
location = self.location
354
438
if location.endswith('/'):
355
439
location = location[:-1]
359
443
elif location + '/' in self._get_parser():
360
444
location = location + '/'
361
445
self._get_parser()[location][option]=value
362
self._get_parser().write()
446
self._get_parser().write(file(self._get_filename(), 'wb'))
365
449
class BranchConfig(Config):
366
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
368
457
def _get_location_config(self):
369
458
if self._location_config is None:
370
459
self._location_config = LocationConfig(self.branch.base)
371
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:
373
494
def _get_user_id(self):
374
495
"""Return the full user id for the branch.
377
498
This is looked up in the email controlfile for the branch.
380
return (self.branch.controlfile("email", "r")
501
return (self.branch.control_files.get_utf8("email")
382
503
.decode(bzrlib.user_encoding)
384
505
except errors.NoSuchFile, e:
387
return self._get_location_config()._get_user_id()
508
return self._get_best_value('_get_user_id')
389
510
def _get_signature_checking(self):
390
511
"""See Config._get_signature_checking."""
391
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')
393
518
def _get_user_option(self, option_name):
394
519
"""See Config._get_user_option."""
395
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)
397
533
def _gpg_signing_command(self):
398
534
"""See Config.gpg_signing_command."""
399
return self._get_location_config()._gpg_signing_command()
535
return self._get_safe_value('_gpg_signing_command')
401
537
def __init__(self, branch):
402
538
super(BranchConfig, self).__init__()
403
539
self._location_config = None
540
self._branch_data_config = None
541
self._global_config = None
404
542
self.branch = branch
543
self.option_sources = (self._get_location_config,
544
self._get_branch_data_config,
545
self._get_global_config)
406
547
def _post_commit(self):
407
548
"""See Config.post_commit."""
408
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')
564
def _log_format(self):
565
"""See Config.log_format."""
566
return self._get_best_value('_log_format')
569
def ensure_config_dir_exists(path=None):
570
"""Make sure a configuration directory exists.
571
This makes sure that the directory exists.
572
On windows, since configuration directories are 2 levels deep,
573
it makes sure both the directory and the parent directory exists.
577
if not os.path.isdir(path):
578
if sys.platform == 'win32':
579
parent_dir = os.path.dirname(path)
580
if not os.path.isdir(parent_dir):
581
mutter('creating config parent directory: %r', parent_dir)
583
mutter('creating config directory: %r', path)
411
587
def config_dir():
423
599
base = os.environ.get('HOME', None)
425
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
426
return os.path.join(base, 'bazaar', '2.0')
601
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
602
return pathjoin(base, 'bazaar', '2.0')
428
604
# cygwin, linux, and darwin all have a $HOME directory
430
606
base = os.path.expanduser("~")
431
return os.path.join(base, ".bazaar")
607
return pathjoin(base, ".bazaar")
434
610
def config_filename():
435
611
"""Return per-user configuration ini file filename."""
436
return os.path.join(config_dir(), 'bazaar.conf')
612
return pathjoin(config_dir(), 'bazaar.conf')
439
615
def branches_config_filename():
440
616
"""Return per-user configuration ini file filename."""
441
return os.path.join(config_dir(), 'branches.conf')
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')
444
630
def _auto_user_id():
461
647
uid = os.getuid()
462
648
w = pwd.getpwuid(uid)
463
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
464
username = w.pw_name.decode(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.')
465
670
comma = gecos.find(',')
493
702
"a reasonable email address" % e)
494
703
return m.group(0)
496
class TreeConfig(object):
706
class TreeConfig(IniBasedConfig):
497
707
"""Branch configuration data associated with its contents, not location"""
498
708
def __init__(self, branch):
499
709
self.branch = branch
711
def _get_parser(self, file=None):
713
return IniBasedConfig._get_parser(file)
714
return self._get_config()
501
716
def _get_config(self):
503
obj = ConfigObj(self.branch.controlfile('branch.conf',
718
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
506
720
except errors.NoSuchFile:
721
obj = ConfigObj(encoding='utf=8')
510
724
def get_option(self, name, section=None, default=None):