49
50
create_signatures - this option controls whether bzr will always create
50
51
gpg signatures, never create them, or create them if the
51
52
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
53
log_format - this option sets the default log format. Possible values are
54
long, short, line, or a plugin can register new formats.
56
56
In bazaar.conf you can also define aliases in the ALIASES sections, example
68
from bzrlib.lazy_import import lazy_import
69
lazy_import(globals(), """
69
71
from fnmatch import fnmatch
73
from StringIO import StringIO
73
import bzrlib.errors as errors
74
from bzrlib.osutils import pathjoin
75
from bzrlib.trace import mutter
76
83
import bzrlib.util.configobj.configobj as configobj
77
from StringIO import StringIO
86
from bzrlib.trace import mutter, warning
79
89
CHECK_IF_POSSIBLE=0
101
POLICY_APPENDPATH = 2
105
POLICY_NORECURSE: 'norecurse',
106
POLICY_APPENDPATH: 'appendpath',
111
'norecurse': POLICY_NORECURSE,
112
'appendpath': POLICY_APPENDPATH,
116
STORE_LOCATION = POLICY_NONE
117
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
118
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
84
123
class ConfigObj(configobj.ConfigObj):
86
125
def get_bool(self, section, key):
193
240
return CHECK_IF_POSSIBLE
242
def signing_policy(self):
243
"""What is the current policy for signature checking?."""
244
policy = self._get_signing_policy()
245
if policy is not None:
247
return SIGN_WHEN_REQUIRED
195
249
def signature_needed(self):
196
250
"""Is a signature needed when committing ?."""
197
policy = self._get_signature_checking()
198
if policy == CHECK_ALWAYS:
251
policy = self._get_signing_policy()
253
policy = self._get_signature_checking()
254
if policy is not None:
255
warning("Please use create_signatures, not check_signatures "
256
"to set signing policy.")
257
if policy == CHECK_ALWAYS:
259
elif policy == SIGN_ALWAYS:
222
289
raise errors.ParseConfigError(e.errors, e.config.filename)
223
290
return self._parser
292
def _get_matching_sections(self):
293
"""Return an ordered list of (section_name, extra_path) pairs.
295
If the section contains inherited configuration, extra_path is
296
a string containing the additional path components.
298
section = self._get_section()
299
if section is not None:
300
return [(section, '')]
225
304
def _get_section(self):
226
305
"""Override this to define the section used by the config."""
308
def _get_option_policy(self, section, option_name):
309
"""Return the policy for the given (section, option_name) pair."""
229
312
def _get_signature_checking(self):
230
313
"""See Config._get_signature_checking."""
231
314
policy = self._get_user_option('check_signatures')
233
316
return self._string_to_signature_policy(policy)
318
def _get_signing_policy(self):
319
"""See Config._get_signing_policy"""
320
policy = self._get_user_option('create_signatures')
322
return self._string_to_signing_policy(policy)
235
324
def _get_user_id(self):
236
325
"""Get the user id from the 'email' key in the current section."""
237
326
return self._get_user_option('email')
239
328
def _get_user_option(self, option_name):
240
329
"""See Config._get_user_option."""
242
return self._get_parser().get_value(self._get_section(),
330
for (section, extra_path) in self._get_matching_sections():
332
value = self._get_parser().get_value(section, option_name)
335
policy = self._get_option_policy(section, option_name)
336
if policy == POLICY_NONE:
338
elif policy == POLICY_NORECURSE:
339
# norecurse items only apply to the exact path
344
elif policy == POLICY_APPENDPATH:
346
value = urlutils.join(value, extra_path)
349
raise AssertionError('Unexpected config policy %r' % policy)
247
353
def _gpg_signing_command(self):
248
354
"""See Config.gpg_signing_command."""
289
409
def __init__(self):
290
410
super(GlobalConfig, self).__init__(config_filename)
412
def set_user_option(self, option, value):
413
"""Save option and its value in the configuration."""
414
# FIXME: RBC 20051029 This should refresh the parser and also take a
415
# file lock on bazaar.conf.
416
conf_dir = os.path.dirname(self._get_filename())
417
ensure_config_dir_exists(conf_dir)
418
if 'DEFAULT' not in self._get_parser():
419
self._get_parser()['DEFAULT'] = {}
420
self._get_parser()['DEFAULT'][option] = value
421
f = open(self._get_filename(), 'wb')
422
self._get_parser().write(f)
293
426
class LocationConfig(IniBasedConfig):
294
427
"""A configuration object that gives the policy for a location."""
296
429
def __init__(self, location):
297
super(LocationConfig, self).__init__(branches_config_filename)
298
self._global_config = None
430
name_generator = locations_config_filename
431
if (not os.path.exists(name_generator()) and
432
os.path.exists(branches_config_filename())):
433
if sys.platform == 'win32':
434
warning('Please rename %s to %s'
435
% (branches_config_filename(),
436
locations_config_filename()))
438
warning('Please rename ~/.bazaar/branches.conf'
439
' to ~/.bazaar/locations.conf')
440
name_generator = branches_config_filename
441
super(LocationConfig, self).__init__(name_generator)
442
# local file locations are looked up by local path, rather than
443
# by file url. This is because the config file is a user
444
# file, and we would rather not expose the user to file urls.
445
if location.startswith('file://'):
446
location = urlutils.local_path_from_url(location)
299
447
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
def _get_section(self):
307
"""Get the section we should look in for config items.
309
Returns None if none exists.
310
TODO: perhaps return a NullSection that thunks through to the
449
def _get_matching_sections(self):
450
"""Return an ordered list of section names matching this location."""
313
451
sections = self._get_parser()
314
452
location_names = self.location.split('/')
315
453
if self.location.endswith('/'):
316
454
del location_names[-1]
318
456
for section in sections:
319
section_names = section.split('/')
457
# location is a local path if possible, so we need
458
# to convert 'file://' urls to local paths if necessary.
459
# This also avoids having file:///path be a more exact
460
# match than '/path'.
461
if section.startswith('file://'):
462
section_path = urlutils.local_path_from_url(section)
464
section_path = section
465
section_names = section_path.split('/')
320
466
if section.endswith('/'):
321
467
del section_names[-1]
322
468
names = zip(location_names, section_names)
331
477
# if section is longer, no match.
332
478
if len(section_names) > len(location_names):
334
# if path is longer, and recurse is not true, no match
335
if len(section_names) < len(location_names):
337
if not self._get_parser()[section].as_bool('recurse'):
341
matches.append((len(section_names), section))
480
matches.append((len(section_names), section,
481
'/'.join(location_names[len(section_names):])))
344
482
matches.sort(reverse=True)
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
def set_user_option(self, option, value):
484
for (length, section, extra_path) in matches:
485
sections.append((section, extra_path))
486
# should we stop looking for parent configs here?
488
if self._get_parser()[section].as_bool('ignore_parents'):
494
def _get_option_policy(self, section, option_name):
495
"""Return the policy for the given (section, option_name) pair."""
496
# check for the old 'recurse=False' flag
498
recurse = self._get_parser()[section].as_bool('recurse')
502
return POLICY_NORECURSE
504
policy_key = option_name + ':policy'
506
policy_name = self._get_parser()[section][policy_key]
510
return _policy_value[policy_name]
512
def _set_option_policy(self, section, option_name, option_policy):
513
"""Set the policy for the given option name in the given section."""
514
# The old recurse=False option affects all options in the
515
# section. To handle multiple policies in the section, we
516
# need to convert it to a policy_norecurse key.
518
recurse = self._get_parser()[section].as_bool('recurse')
522
symbol_versioning.warn(
523
'The recurse option is deprecated as of 0.14. '
524
'The section "%s" has been converted to use policies.'
527
del self._get_parser()[section]['recurse']
529
for key in self._get_parser()[section].keys():
530
if not key.endswith(':policy'):
531
self._get_parser()[section][key +
532
':policy'] = 'norecurse'
534
policy_key = option_name + ':policy'
535
policy_name = _policy_name[option_policy]
536
if policy_name is not None:
537
self._get_parser()[section][policy_key] = policy_name
539
if policy_key in self._get_parser()[section]:
540
del self._get_parser()[section][policy_key]
542
def set_user_option(self, option, value, store=STORE_LOCATION):
390
543
"""Save option and its value in the configuration."""
544
assert store in [STORE_LOCATION,
545
STORE_LOCATION_NORECURSE,
546
STORE_LOCATION_APPENDPATH], 'bad storage policy'
391
547
# FIXME: RBC 20051029 This should refresh the parser and also take a
392
# file lock on branches.conf.
548
# file lock on locations.conf.
393
549
conf_dir = os.path.dirname(self._get_filename())
394
550
ensure_config_dir_exists(conf_dir)
395
551
location = self.location
401
557
elif location + '/' in self._get_parser():
402
558
location = location + '/'
403
559
self._get_parser()[location][option]=value
560
# the allowed values of store match the config policies
561
self._set_option_policy(location, option, store)
404
562
self._get_parser().write(file(self._get_filename(), 'wb'))
407
565
class BranchConfig(Config):
408
566
"""A configuration object giving the policy for a branch."""
568
def _get_branch_data_config(self):
569
if self._branch_data_config is None:
570
self._branch_data_config = TreeConfig(self.branch)
571
return self._branch_data_config
410
573
def _get_location_config(self):
411
574
if self._location_config is None:
412
575
self._location_config = LocationConfig(self.branch.base)
413
576
return self._location_config
578
def _get_global_config(self):
579
if self._global_config is None:
580
self._global_config = GlobalConfig()
581
return self._global_config
583
def _get_best_value(self, option_name):
584
"""This returns a user option from local, tree or global config.
586
They are tried in that order. Use get_safe_value if trusted values
589
for source in self.option_sources:
590
value = getattr(source(), option_name)()
591
if value is not None:
595
def _get_safe_value(self, option_name):
596
"""This variant of get_best_value never returns untrusted values.
598
It does not return values from the branch data, because the branch may
599
not be controlled by the user.
601
We may wish to allow locations.conf to control whether branches are
602
trusted in the future.
604
for source in (self._get_location_config, self._get_global_config):
605
value = getattr(source(), option_name)()
606
if value is not None:
415
610
def _get_user_id(self):
416
611
"""Return the full user id for the branch.
426
621
except errors.NoSuchFile, e:
429
return self._get_location_config()._get_user_id()
624
return self._get_best_value('_get_user_id')
431
626
def _get_signature_checking(self):
432
627
"""See Config._get_signature_checking."""
433
return self._get_location_config()._get_signature_checking()
628
return self._get_best_value('_get_signature_checking')
630
def _get_signing_policy(self):
631
"""See Config._get_signing_policy."""
632
return self._get_best_value('_get_signing_policy')
435
634
def _get_user_option(self, option_name):
436
635
"""See Config._get_user_option."""
437
return self._get_location_config()._get_user_option(option_name)
636
for source in self.option_sources:
637
value = source()._get_user_option(option_name)
638
if value is not None:
642
def set_user_option(self, name, value, store=STORE_BRANCH):
643
if store == STORE_BRANCH:
644
self._get_branch_data_config().set_option(value, name)
645
elif store == STORE_GLOBAL:
646
self._get_global_config().set_user_option(name, value)
648
self._get_location_config().set_user_option(name, value, store)
439
650
def _gpg_signing_command(self):
440
651
"""See Config.gpg_signing_command."""
441
return self._get_location_config()._gpg_signing_command()
652
return self._get_safe_value('_gpg_signing_command')
443
654
def __init__(self, branch):
444
655
super(BranchConfig, self).__init__()
445
656
self._location_config = None
657
self._branch_data_config = None
658
self._global_config = None
446
659
self.branch = branch
660
self.option_sources = (self._get_location_config,
661
self._get_branch_data_config,
662
self._get_global_config)
448
664
def _post_commit(self):
449
665
"""See Config.post_commit."""
450
return self._get_location_config()._post_commit()
666
return self._get_safe_value('_post_commit')
668
def _get_nickname(self):
669
value = self._get_explicit_nickname()
670
if value is not None:
672
return urlutils.unescape(self.branch.base.split('/')[-2])
674
def has_explicit_nickname(self):
675
"""Return true if a nickname has been explicitly assigned."""
676
return self._get_explicit_nickname() is not None
678
def _get_explicit_nickname(self):
679
return self._get_best_value('_get_nickname')
452
681
def _log_format(self):
453
682
"""See Config.log_format."""
454
return self._get_location_config()._log_format()
683
return self._get_best_value('_log_format')
457
686
def ensure_config_dir_exists(path=None):
482
711
base = os.environ.get('BZR_HOME', None)
483
712
if sys.platform == 'win32':
485
base = os.environ.get('APPDATA', None)
714
base = win32utils.get_appdata_location_unicode()
487
716
base = os.environ.get('HOME', None)
489
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
490
return pathjoin(base, 'bazaar', '2.0')
718
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
719
return osutils.pathjoin(base, 'bazaar', '2.0')
492
721
# cygwin, linux, and darwin all have a $HOME directory
494
723
base = os.path.expanduser("~")
495
return pathjoin(base, ".bazaar")
724
return osutils.pathjoin(base, ".bazaar")
498
727
def config_filename():
499
728
"""Return per-user configuration ini file filename."""
500
return pathjoin(config_dir(), 'bazaar.conf')
729
return osutils.pathjoin(config_dir(), 'bazaar.conf')
503
732
def branches_config_filename():
504
733
"""Return per-user configuration ini file filename."""
505
return pathjoin(config_dir(), 'branches.conf')
734
return osutils.pathjoin(config_dir(), 'branches.conf')
737
def locations_config_filename():
738
"""Return per-user configuration ini file filename."""
739
return osutils.pathjoin(config_dir(), 'locations.conf')
742
def user_ignore_config_filename():
743
"""Return the user default ignore filename"""
744
return osutils.pathjoin(config_dir(), 'ignore')
508
747
def _auto_user_id():
521
# XXX: Any good way to get real user name on win32?
760
if sys.platform == 'win32':
761
name = win32utils.get_user_name_unicode()
763
raise errors.BzrError("Cannot autodetect user name.\n"
764
"Please, set your name with command like:\n"
765
'bzr whoami "Your Name <name@domain.com>"')
766
host = win32utils.get_host_name_unicode()
768
host = socket.gethostname()
769
return name, (name + '@' + host)
525
773
uid = os.getuid()
526
774
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)
776
# we try utf-8 first, because on many variants (like Linux),
777
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
778
# false positives. (many users will have their user encoding set to
779
# latin-1, which cannot raise UnicodeError.)
781
gecos = w.pw_gecos.decode('utf-8')
785
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
786
encoding = bzrlib.user_encoding
788
raise errors.BzrCommandError('Unable to determine your name. '
789
'Use "bzr whoami" to set it.')
791
username = w.pw_name.decode(encoding)
793
raise errors.BzrCommandError('Unable to determine your name. '
794
'Use "bzr whoami" to set it.')
536
796
comma = gecos.find(',')
565
825
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
567
raise errors.BzrError("%r doesn't seem to contain "
568
"a reasonable email address" % e)
827
raise errors.NoEmailInUsername(e)
569
828
return m.group(0)
571
class TreeConfig(object):
831
class TreeConfig(IniBasedConfig):
572
832
"""Branch configuration data associated with its contents, not location"""
573
833
def __init__(self, branch):
574
834
self.branch = branch
836
def _get_parser(self, file=None):
838
return IniBasedConfig._get_parser(file)
839
return self._get_config()
576
841
def _get_config(self):
578
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
843
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
579
844
encoding='utf-8')
580
845
except errors.NoSuchFile:
581
846
obj = ConfigObj(encoding='utf=8')
added
removed
bzrlib/config.py
