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
67
from bzrlib.lazy_import import lazy_import
68
lazy_import(globals(), """
58
70
from fnmatch import fnmatch
72
from StringIO import StringIO
62
import bzrlib.errors as errors
63
from bzrlib.osutils import pathjoin
64
from bzrlib.trace import mutter
65
82
import bzrlib.util.configobj.configobj as configobj
66
from StringIO import StringIO
85
from bzrlib.trace import mutter, warning
68
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
73
122
class ConfigObj(configobj.ConfigObj):
75
124
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)
125
return self[section].as_bool(key)
84
127
def get_value(self, section, name):
85
128
# Try [] for the old DEFAULT section.
177
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
179
248
def signature_needed(self):
180
249
"""Is a signature needed when committing ?."""
181
policy = self._get_signature_checking()
182
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:
262
def get_alias(self, value):
263
return self._get_alias(value)
265
def _get_alias(self, value):
268
def get_nickname(self):
269
return self._get_nickname()
271
def _get_nickname(self):
187
275
class IniBasedConfig(Config):
188
276
"""A configuration policy that draws from ini files."""
198
self._parser = ConfigObj(input)
286
self._parser = ConfigObj(input, encoding='utf-8')
199
287
except configobj.ConfigObjError, e:
200
288
raise errors.ParseConfigError(e.errors, e.config.filename)
201
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, '')]
203
303
def _get_section(self):
204
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."""
207
311
def _get_signature_checking(self):
208
312
"""See Config._get_signature_checking."""
209
313
policy = self._get_user_option('check_signatures')
211
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)
213
323
def _get_user_id(self):
214
324
"""Get the user id from the 'email' key in the current section."""
215
325
return self._get_user_option('email')
217
327
def _get_user_option(self, option_name):
218
328
"""See Config._get_user_option."""
220
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)
225
352
def _gpg_signing_command(self):
226
353
"""See Config.gpg_signing_command."""
227
354
return self._get_user_option('gpg_signing_command')
356
def _log_format(self):
357
"""See Config.log_format."""
358
return self._get_user_option('log_format')
229
360
def __init__(self, get_filename):
230
361
super(IniBasedConfig, self).__init__()
231
362
self._get_filename = get_filename
246
377
raise errors.BzrError("Invalid signatures policy '%s'"
247
378
% signature_string)
380
def _string_to_signing_policy(self, signature_string):
381
"""Convert a string to a signing policy."""
382
if signature_string.lower() == 'when-required':
383
return SIGN_WHEN_REQUIRED
384
if signature_string.lower() == 'never':
386
if signature_string.lower() == 'always':
388
raise errors.BzrError("Invalid signing policy '%s'"
391
def _get_alias(self, value):
393
return self._get_parser().get_value("ALIASES",
398
def _get_nickname(self):
399
return self.get_user_option('nickname')
250
402
class GlobalConfig(IniBasedConfig):
251
403
"""The configuration that should be used for a specific location."""
256
408
def __init__(self):
257
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)
260
425
class LocationConfig(IniBasedConfig):
261
426
"""A configuration object that gives the policy for a location."""
263
428
def __init__(self, location):
264
super(LocationConfig, self).__init__(branches_config_filename)
265
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)
266
446
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
def _get_section(self):
274
"""Get the section we should look in for config items.
276
Returns None if none exists.
277
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."""
280
450
sections = self._get_parser()
281
451
location_names = self.location.split('/')
282
452
if self.location.endswith('/'):
283
453
del location_names[-1]
285
455
for section in sections:
286
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('/')
287
465
if section.endswith('/'):
288
466
del section_names[-1]
289
467
names = zip(location_names, section_names)
298
476
# if section is longer, no match.
299
477
if len(section_names) > len(location_names):
301
# if path is longer, and recurse is not true, no match
302
if len(section_names) < len(location_names):
304
if not self._get_parser().get_bool(section, 'recurse'):
308
matches.append((len(section_names), section))
479
matches.append((len(section_names), section,
480
'/'.join(location_names[len(section_names):])))
311
481
matches.sort(reverse=True)
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
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):
350
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'
351
546
# FIXME: RBC 20051029 This should refresh the parser and also take a
352
# file lock on branches.conf.
547
# file lock on locations.conf.
353
548
conf_dir = os.path.dirname(self._get_filename())
354
549
ensure_config_dir_exists(conf_dir)
355
550
location = self.location
361
556
elif location + '/' in self._get_parser():
362
557
location = location + '/'
363
558
self._get_parser()[location][option]=value
364
self._get_parser().write()
559
# the allowed values of store match the config policies
560
self._set_option_policy(location, option, store)
561
self._get_parser().write(file(self._get_filename(), 'wb'))
367
564
class BranchConfig(Config):
368
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
370
572
def _get_location_config(self):
371
573
if self._location_config is None:
372
574
self._location_config = LocationConfig(self.branch.base)
373
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:
375
609
def _get_user_id(self):
376
610
"""Return the full user id for the branch.
386
620
except errors.NoSuchFile, e:
389
return self._get_location_config()._get_user_id()
623
return self._get_best_value('_get_user_id')
391
625
def _get_signature_checking(self):
392
626
"""See Config._get_signature_checking."""
393
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')
395
633
def _get_user_option(self, option_name):
396
634
"""See Config._get_user_option."""
397
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)
399
649
def _gpg_signing_command(self):
400
650
"""See Config.gpg_signing_command."""
401
return self._get_location_config()._gpg_signing_command()
651
return self._get_safe_value('_gpg_signing_command')
403
653
def __init__(self, branch):
404
654
super(BranchConfig, self).__init__()
405
655
self._location_config = None
656
self._branch_data_config = None
657
self._global_config = None
406
658
self.branch = branch
659
self.option_sources = (self._get_location_config,
660
self._get_branch_data_config,
661
self._get_global_config)
408
663
def _post_commit(self):
409
664
"""See Config.post_commit."""
410
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')
680
def _log_format(self):
681
"""See Config.log_format."""
682
return self._get_best_value('_log_format')
413
685
def ensure_config_dir_exists(path=None):
438
710
base = os.environ.get('BZR_HOME', None)
439
711
if sys.platform == 'win32':
441
base = os.environ.get('APPDATA', None)
713
base = win32utils.get_appdata_location_unicode()
443
715
base = os.environ.get('HOME', None)
445
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
446
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')
448
720
# cygwin, linux, and darwin all have a $HOME directory
450
722
base = os.path.expanduser("~")
451
return pathjoin(base, ".bazaar")
723
return osutils.pathjoin(base, ".bazaar")
454
726
def config_filename():
455
727
"""Return per-user configuration ini file filename."""
456
return pathjoin(config_dir(), 'bazaar.conf')
728
return osutils.pathjoin(config_dir(), 'bazaar.conf')
459
731
def branches_config_filename():
460
732
"""Return per-user configuration ini file filename."""
461
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')
464
746
def _auto_user_id():
477
# 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)
481
772
uid = os.getuid()
482
773
w = pwd.getpwuid(uid)
483
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
484
username = w.pw_name.decode(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.')
485
795
comma = gecos.find(',')
510
824
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
512
raise errors.BzrError("%r doesn't seem to contain "
513
"a reasonable email address" % e)
826
raise errors.NoEmailInUsername(e)
514
827
return m.group(0)
516
class TreeConfig(object):
830
class TreeConfig(IniBasedConfig):
517
831
"""Branch configuration data associated with its contents, not location"""
518
832
def __init__(self, branch):
519
833
self.branch = branch
835
def _get_parser(self, file=None):
837
return IniBasedConfig._get_parser(file)
838
return self._get_config()
521
840
def _get_config(self):
523
obj = ConfigObj(self.branch.control_files.get('branch.conf'
842
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
526
844
except errors.NoSuchFile:
845
obj = ConfigObj(encoding='utf=8')
530
848
def get_option(self, name, section=None, default=None):
added
removed
bzrlib/config.py
