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
67
from bzrlib.lazy_import import lazy_import
68
lazy_import(globals(), """
69
70
from fnmatch import fnmatch
72
from StringIO import StringIO
73
import bzrlib.errors as errors
74
from bzrlib.osutils import pathjoin
75
from bzrlib.trace import mutter
76
82
import bzrlib.util.configobj.configobj as configobj
77
from StringIO import StringIO
85
from bzrlib.trace import mutter, warning
79
88
CHECK_IF_POSSIBLE=0
100
POLICY_APPENDPATH = 2
104
POLICY_NORECURSE: 'norecurse',
105
POLICY_APPENDPATH: 'appendpath',
110
'norecurse': POLICY_NORECURSE,
111
'appendpath': POLICY_APPENDPATH,
115
STORE_LOCATION = POLICY_NONE
116
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
117
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
84
122
class ConfigObj(configobj.ConfigObj):
86
124
def get_bool(self, section, key):
193
239
return CHECK_IF_POSSIBLE
241
def signing_policy(self):
242
"""What is the current policy for signature checking?."""
243
policy = self._get_signing_policy()
244
if policy is not None:
246
return SIGN_WHEN_REQUIRED
195
248
def signature_needed(self):
196
249
"""Is a signature needed when committing ?."""
197
policy = self._get_signature_checking()
198
if policy == CHECK_ALWAYS:
250
policy = self._get_signing_policy()
252
policy = self._get_signature_checking()
253
if policy is not None:
254
warning("Please use create_signatures, not check_signatures "
255
"to set signing policy.")
256
if policy == CHECK_ALWAYS:
258
elif policy == SIGN_ALWAYS:
222
288
raise errors.ParseConfigError(e.errors, e.config.filename)
223
289
return self._parser
291
def _get_matching_sections(self):
292
"""Return an ordered list of (section_name, extra_path) pairs.
294
If the section contains inherited configuration, extra_path is
295
a string containing the additional path components.
297
section = self._get_section()
298
if section is not None:
299
return [(section, '')]
225
303
def _get_section(self):
226
304
"""Override this to define the section used by the config."""
307
def _get_option_policy(self, section, option_name):
308
"""Return the policy for the given (section, option_name) pair."""
229
311
def _get_signature_checking(self):
230
312
"""See Config._get_signature_checking."""
231
313
policy = self._get_user_option('check_signatures')
233
315
return self._string_to_signature_policy(policy)
317
def _get_signing_policy(self):
318
"""See Config._get_signing_policy"""
319
policy = self._get_user_option('create_signatures')
321
return self._string_to_signing_policy(policy)
235
323
def _get_user_id(self):
236
324
"""Get the user id from the 'email' key in the current section."""
237
325
return self._get_user_option('email')
239
327
def _get_user_option(self, option_name):
240
328
"""See Config._get_user_option."""
242
return self._get_parser().get_value(self._get_section(),
329
for (section, extra_path) in self._get_matching_sections():
331
value = self._get_parser().get_value(section, option_name)
334
policy = self._get_option_policy(section, option_name)
335
if policy == POLICY_NONE:
337
elif policy == POLICY_NORECURSE:
338
# norecurse items only apply to the exact path
343
elif policy == POLICY_APPENDPATH:
345
value = urlutils.join(value, extra_path)
348
raise AssertionError('Unexpected config policy %r' % policy)
247
352
def _gpg_signing_command(self):
248
353
"""See Config.gpg_signing_command."""
289
408
def __init__(self):
290
409
super(GlobalConfig, self).__init__(config_filename)
411
def set_user_option(self, option, value):
412
"""Save option and its value in the configuration."""
413
# FIXME: RBC 20051029 This should refresh the parser and also take a
414
# file lock on bazaar.conf.
415
conf_dir = os.path.dirname(self._get_filename())
416
ensure_config_dir_exists(conf_dir)
417
if 'DEFAULT' not in self._get_parser():
418
self._get_parser()['DEFAULT'] = {}
419
self._get_parser()['DEFAULT'][option] = value
420
f = open(self._get_filename(), 'wb')
421
self._get_parser().write(f)
293
425
class LocationConfig(IniBasedConfig):
294
426
"""A configuration object that gives the policy for a location."""
296
428
def __init__(self, location):
297
super(LocationConfig, self).__init__(branches_config_filename)
298
self._global_config = None
429
name_generator = locations_config_filename
430
if (not os.path.exists(name_generator()) and
431
os.path.exists(branches_config_filename())):
432
if sys.platform == 'win32':
433
warning('Please rename %s to %s'
434
% (branches_config_filename(),
435
locations_config_filename()))
437
warning('Please rename ~/.bazaar/branches.conf'
438
' to ~/.bazaar/locations.conf')
439
name_generator = branches_config_filename
440
super(LocationConfig, self).__init__(name_generator)
441
# local file locations are looked up by local path, rather than
442
# by file url. This is because the config file is a user
443
# file, and we would rather not expose the user to file urls.
444
if location.startswith('file://'):
445
location = urlutils.local_path_from_url(location)
299
446
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
448
def _get_matching_sections(self):
449
"""Return an ordered list of section names matching this location."""
313
450
sections = self._get_parser()
314
451
location_names = self.location.split('/')
315
452
if self.location.endswith('/'):
316
453
del location_names[-1]
318
455
for section in sections:
319
section_names = section.split('/')
456
# location is a local path if possible, so we need
457
# to convert 'file://' urls to local paths if necessary.
458
# This also avoids having file:///path be a more exact
459
# match than '/path'.
460
if section.startswith('file://'):
461
section_path = urlutils.local_path_from_url(section)
463
section_path = section
464
section_names = section_path.split('/')
320
465
if section.endswith('/'):
321
466
del section_names[-1]
322
467
names = zip(location_names, section_names)
331
476
# if section is longer, no match.
332
477
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))
479
matches.append((len(section_names), section,
480
'/'.join(location_names[len(section_names):])))
344
481
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):
483
for (length, section, extra_path) in matches:
484
sections.append((section, extra_path))
485
# should we stop looking for parent configs here?
487
if self._get_parser()[section].as_bool('ignore_parents'):
493
def _get_option_policy(self, section, option_name):
494
"""Return the policy for the given (section, option_name) pair."""
495
# check for the old 'recurse=False' flag
497
recurse = self._get_parser()[section].as_bool('recurse')
501
return POLICY_NORECURSE
503
policy_key = option_name + ':policy'
505
policy_name = self._get_parser()[section][policy_key]
509
return _policy_value[policy_name]
511
def _set_option_policy(self, section, option_name, option_policy):
512
"""Set the policy for the given option name in the given section."""
513
# The old recurse=False option affects all options in the
514
# section. To handle multiple policies in the section, we
515
# need to convert it to a policy_norecurse key.
517
recurse = self._get_parser()[section].as_bool('recurse')
521
symbol_versioning.warn(
522
'The recurse option is deprecated as of 0.14. '
523
'The section "%s" has been converted to use policies.'
526
del self._get_parser()[section]['recurse']
528
for key in self._get_parser()[section].keys():
529
if not key.endswith(':policy'):
530
self._get_parser()[section][key +
531
':policy'] = 'norecurse'
533
policy_key = option_name + ':policy'
534
policy_name = _policy_name[option_policy]
535
if policy_name is not None:
536
self._get_parser()[section][policy_key] = policy_name
538
if policy_key in self._get_parser()[section]:
539
del self._get_parser()[section][policy_key]
541
def set_user_option(self, option, value, store=STORE_LOCATION):
390
542
"""Save option and its value in the configuration."""
543
assert store in [STORE_LOCATION,
544
STORE_LOCATION_NORECURSE,
545
STORE_LOCATION_APPENDPATH], 'bad storage policy'
391
546
# FIXME: RBC 20051029 This should refresh the parser and also take a
392
# file lock on branches.conf.
547
# file lock on locations.conf.
393
548
conf_dir = os.path.dirname(self._get_filename())
394
549
ensure_config_dir_exists(conf_dir)
395
550
location = self.location
401
556
elif location + '/' in self._get_parser():
402
557
location = location + '/'
403
558
self._get_parser()[location][option]=value
559
# the allowed values of store match the config policies
560
self._set_option_policy(location, option, store)
404
561
self._get_parser().write(file(self._get_filename(), 'wb'))
407
564
class BranchConfig(Config):
408
565
"""A configuration object giving the policy for a branch."""
567
def _get_branch_data_config(self):
568
if self._branch_data_config is None:
569
self._branch_data_config = TreeConfig(self.branch)
570
return self._branch_data_config
410
572
def _get_location_config(self):
411
573
if self._location_config is None:
412
574
self._location_config = LocationConfig(self.branch.base)
413
575
return self._location_config
577
def _get_global_config(self):
578
if self._global_config is None:
579
self._global_config = GlobalConfig()
580
return self._global_config
582
def _get_best_value(self, option_name):
583
"""This returns a user option from local, tree or global config.
585
They are tried in that order. Use get_safe_value if trusted values
588
for source in self.option_sources:
589
value = getattr(source(), option_name)()
590
if value is not None:
594
def _get_safe_value(self, option_name):
595
"""This variant of get_best_value never returns untrusted values.
597
It does not return values from the branch data, because the branch may
598
not be controlled by the user.
600
We may wish to allow locations.conf to control whether branches are
601
trusted in the future.
603
for source in (self._get_location_config, self._get_global_config):
604
value = getattr(source(), option_name)()
605
if value is not None:
415
609
def _get_user_id(self):
416
610
"""Return the full user id for the branch.
426
620
except errors.NoSuchFile, e:
429
return self._get_location_config()._get_user_id()
623
return self._get_best_value('_get_user_id')
431
625
def _get_signature_checking(self):
432
626
"""See Config._get_signature_checking."""
433
return self._get_location_config()._get_signature_checking()
627
return self._get_best_value('_get_signature_checking')
629
def _get_signing_policy(self):
630
"""See Config._get_signing_policy."""
631
return self._get_best_value('_get_signing_policy')
435
633
def _get_user_option(self, option_name):
436
634
"""See Config._get_user_option."""
437
return self._get_location_config()._get_user_option(option_name)
635
for source in self.option_sources:
636
value = source()._get_user_option(option_name)
637
if value is not None:
641
def set_user_option(self, name, value, store=STORE_BRANCH):
642
if store == STORE_BRANCH:
643
self._get_branch_data_config().set_option(value, name)
644
elif store == STORE_GLOBAL:
645
self._get_global_config().set_user_option(name, value)
647
self._get_location_config().set_user_option(name, value, store)
439
649
def _gpg_signing_command(self):
440
650
"""See Config.gpg_signing_command."""
441
return self._get_location_config()._gpg_signing_command()
651
return self._get_safe_value('_gpg_signing_command')
443
653
def __init__(self, branch):
444
654
super(BranchConfig, self).__init__()
445
655
self._location_config = None
656
self._branch_data_config = None
657
self._global_config = None
446
658
self.branch = branch
659
self.option_sources = (self._get_location_config,
660
self._get_branch_data_config,
661
self._get_global_config)
448
663
def _post_commit(self):
449
664
"""See Config.post_commit."""
450
return self._get_location_config()._post_commit()
665
return self._get_safe_value('_post_commit')
667
def _get_nickname(self):
668
value = self._get_explicit_nickname()
669
if value is not None:
671
return urlutils.unescape(self.branch.base.split('/')[-2])
673
def has_explicit_nickname(self):
674
"""Return true if a nickname has been explicitly assigned."""
675
return self._get_explicit_nickname() is not None
677
def _get_explicit_nickname(self):
678
return self._get_best_value('_get_nickname')
452
680
def _log_format(self):
453
681
"""See Config.log_format."""
454
return self._get_location_config()._log_format()
682
return self._get_best_value('_log_format')
457
685
def ensure_config_dir_exists(path=None):
482
710
base = os.environ.get('BZR_HOME', None)
483
711
if sys.platform == 'win32':
485
base = os.environ.get('APPDATA', None)
713
base = win32utils.get_appdata_location_unicode()
487
715
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')
717
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
718
return osutils.pathjoin(base, 'bazaar', '2.0')
492
720
# cygwin, linux, and darwin all have a $HOME directory
494
722
base = os.path.expanduser("~")
495
return pathjoin(base, ".bazaar")
723
return osutils.pathjoin(base, ".bazaar")
498
726
def config_filename():
499
727
"""Return per-user configuration ini file filename."""
500
return pathjoin(config_dir(), 'bazaar.conf')
728
return osutils.pathjoin(config_dir(), 'bazaar.conf')
503
731
def branches_config_filename():
504
732
"""Return per-user configuration ini file filename."""
505
return pathjoin(config_dir(), 'branches.conf')
733
return osutils.pathjoin(config_dir(), 'branches.conf')
736
def locations_config_filename():
737
"""Return per-user configuration ini file filename."""
738
return osutils.pathjoin(config_dir(), 'locations.conf')
741
def user_ignore_config_filename():
742
"""Return the user default ignore filename"""
743
return osutils.pathjoin(config_dir(), 'ignore')
508
746
def _auto_user_id():
521
# XXX: Any good way to get real user name on win32?
759
if sys.platform == 'win32':
760
name = win32utils.get_user_name_unicode()
762
raise errors.BzrError("Cannot autodetect user name.\n"
763
"Please, set your name with command like:\n"
764
'bzr whoami "Your Name <name@domain.com>"')
765
host = win32utils.get_host_name_unicode()
767
host = socket.gethostname()
768
return name, (name + '@' + host)
525
772
uid = os.getuid()
526
773
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)
775
# we try utf-8 first, because on many variants (like Linux),
776
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
777
# false positives. (many users will have their user encoding set to
778
# latin-1, which cannot raise UnicodeError.)
780
gecos = w.pw_gecos.decode('utf-8')
784
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
785
encoding = bzrlib.user_encoding
787
raise errors.BzrCommandError('Unable to determine your name. '
788
'Use "bzr whoami" to set it.')
790
username = w.pw_name.decode(encoding)
792
raise errors.BzrCommandError('Unable to determine your name. '
793
'Use "bzr whoami" to set it.')
536
795
comma = gecos.find(',')
565
824
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
567
raise errors.BzrError("%r doesn't seem to contain "
568
"a reasonable email address" % e)
826
raise errors.NoEmailInUsername(e)
569
827
return m.group(0)
571
class TreeConfig(object):
830
class TreeConfig(IniBasedConfig):
572
831
"""Branch configuration data associated with its contents, not location"""
573
832
def __init__(self, branch):
574
833
self.branch = branch
835
def _get_parser(self, file=None):
837
return IniBasedConfig._get_parser(file)
838
return self._get_config()
576
840
def _get_config(self):
578
842
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
added
removed
bzrlib/config.py
