28
27
check_signatures=require|ignore|check-available(default)
29
28
create_signatures=always|never|when-required(default)
30
29
gpg_signing_command=name-of-program
31
log_format=name-of-format
33
in locations.conf, you specify the url of a branch and options for it.
31
in branches.conf, you specify the url of a branch and options for it.
34
32
Wildcards may be used - * and ? as normal in shell completion. Options
35
set in both bazaar.conf and locations.conf are overridden by the locations.conf
33
set in both bazaar.conf and branches.conf are overriden by the branches.conf
37
35
[/home/robertc/source]
38
36
recurse=False|True(default)
40
check_signatures= as above
38
check_signatures= as abive
41
39
create_signatures= as above.
43
41
explanation of options
50
48
create_signatures - this option controls whether bzr will always create
51
49
gpg signatures, never create them, or create them if the
52
50
branch is configured to require them.
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
In bazaar.conf you can also define aliases in the ALIASES sections, example
59
lastlog=log --line -r-10..-1
60
ll=log --line -r-10..-1
51
NB: This option is planned, but not implemented yet.
68
from bzrlib.lazy_import import lazy_import
69
lazy_import(globals(), """
71
57
from fnmatch import fnmatch
73
from StringIO import StringIO
61
import bzrlib.errors as errors
84
62
import bzrlib.util.configobj.configobj as configobj
87
from bzrlib.trace import mutter, warning
63
from StringIO import StringIO
90
65
CHECK_IF_POSSIBLE=0
102
POLICY_APPENDPATH = 2
106
POLICY_NORECURSE: 'norecurse',
107
POLICY_APPENDPATH: 'appendpath',
112
'norecurse': POLICY_NORECURSE,
113
'appendpath': POLICY_APPENDPATH,
117
STORE_LOCATION = POLICY_NONE
118
STORE_LOCATION_NORECURSE = POLICY_NORECURSE
119
STORE_LOCATION_APPENDPATH = POLICY_APPENDPATH
124
70
class ConfigObj(configobj.ConfigObj):
126
72
def get_bool(self, section, key):
127
return self[section].as_bool(key)
73
val = self[section][key].lower()
74
if val in ('1', 'yes', 'true', 'on'):
76
elif val in ('0', 'no', 'false', 'off'):
79
raise ValueError("Value %r is not boolean" % val)
129
81
def get_value(self, section, name):
130
82
# Try [] for the old DEFAULT section.
241
174
return CHECK_IF_POSSIBLE
243
def signing_policy(self):
244
"""What is the current policy for signature checking?."""
245
policy = self._get_signing_policy()
246
if policy is not None:
248
return SIGN_WHEN_REQUIRED
250
176
def signature_needed(self):
251
177
"""Is a signature needed when committing ?."""
252
policy = self._get_signing_policy()
254
policy = self._get_signature_checking()
255
if policy is not None:
256
warning("Please use create_signatures, not check_signatures "
257
"to set signing policy.")
258
if policy == CHECK_ALWAYS:
260
elif policy == SIGN_ALWAYS:
178
policy = self._get_signature_checking()
179
if policy == CHECK_ALWAYS:
264
def get_alias(self, value):
265
return self._get_alias(value)
267
def _get_alias(self, value):
270
def get_nickname(self):
271
return self._get_nickname()
273
def _get_nickname(self):
277
184
class IniBasedConfig(Config):
278
185
"""A configuration policy that draws from ini files."""
288
self._parser = ConfigObj(input, encoding='utf-8')
195
self._parser = ConfigObj(input)
289
196
except configobj.ConfigObjError, e:
290
197
raise errors.ParseConfigError(e.errors, e.config.filename)
291
198
return self._parser
293
def _get_matching_sections(self):
294
"""Return an ordered list of (section_name, extra_path) pairs.
296
If the section contains inherited configuration, extra_path is
297
a string containing the additional path components.
299
section = self._get_section()
300
if section is not None:
301
return [(section, '')]
305
200
def _get_section(self):
306
201
"""Override this to define the section used by the config."""
309
def _get_option_policy(self, section, option_name):
310
"""Return the policy for the given (section, option_name) pair."""
313
204
def _get_signature_checking(self):
314
205
"""See Config._get_signature_checking."""
315
206
policy = self._get_user_option('check_signatures')
317
208
return self._string_to_signature_policy(policy)
319
def _get_signing_policy(self):
320
"""See Config._get_signing_policy"""
321
policy = self._get_user_option('create_signatures')
323
return self._string_to_signing_policy(policy)
325
210
def _get_user_id(self):
326
211
"""Get the user id from the 'email' key in the current section."""
327
212
return self._get_user_option('email')
329
214
def _get_user_option(self, option_name):
330
215
"""See Config._get_user_option."""
331
for (section, extra_path) in self._get_matching_sections():
333
value = self._get_parser().get_value(section, option_name)
336
policy = self._get_option_policy(section, option_name)
337
if policy == POLICY_NONE:
339
elif policy == POLICY_NORECURSE:
340
# norecurse items only apply to the exact path
345
elif policy == POLICY_APPENDPATH:
347
value = urlutils.join(value, extra_path)
350
raise AssertionError('Unexpected config policy %r' % policy)
217
return self._get_parser().get_value(self._get_section(),
354
222
def _gpg_signing_command(self):
355
223
"""See Config.gpg_signing_command."""
356
224
return self._get_user_option('gpg_signing_command')
358
def _log_format(self):
359
"""See Config.log_format."""
360
return self._get_user_option('log_format')
362
226
def __init__(self, get_filename):
363
227
super(IniBasedConfig, self).__init__()
364
228
self._get_filename = get_filename
379
243
raise errors.BzrError("Invalid signatures policy '%s'"
380
244
% signature_string)
382
def _string_to_signing_policy(self, signature_string):
383
"""Convert a string to a signing policy."""
384
if signature_string.lower() == 'when-required':
385
return SIGN_WHEN_REQUIRED
386
if signature_string.lower() == 'never':
388
if signature_string.lower() == 'always':
390
raise errors.BzrError("Invalid signing policy '%s'"
393
def _get_alias(self, value):
395
return self._get_parser().get_value("ALIASES",
400
def _get_nickname(self):
401
return self.get_user_option('nickname')
404
247
class GlobalConfig(IniBasedConfig):
405
248
"""The configuration that should be used for a specific location."""
410
253
def __init__(self):
411
254
super(GlobalConfig, self).__init__(config_filename)
413
def set_user_option(self, option, value):
414
"""Save option and its value in the configuration."""
415
# FIXME: RBC 20051029 This should refresh the parser and also take a
416
# file lock on bazaar.conf.
417
conf_dir = os.path.dirname(self._get_filename())
418
ensure_config_dir_exists(conf_dir)
419
if 'DEFAULT' not in self._get_parser():
420
self._get_parser()['DEFAULT'] = {}
421
self._get_parser()['DEFAULT'][option] = value
422
f = open(self._get_filename(), 'wb')
423
self._get_parser().write(f)
427
257
class LocationConfig(IniBasedConfig):
428
258
"""A configuration object that gives the policy for a location."""
430
260
def __init__(self, location):
431
name_generator = locations_config_filename
432
if (not os.path.exists(name_generator()) and
433
os.path.exists(branches_config_filename())):
434
if sys.platform == 'win32':
435
warning('Please rename %s to %s'
436
% (branches_config_filename(),
437
locations_config_filename()))
439
warning('Please rename ~/.bazaar/branches.conf'
440
' to ~/.bazaar/locations.conf')
441
name_generator = branches_config_filename
442
super(LocationConfig, self).__init__(name_generator)
443
# local file locations are looked up by local path, rather than
444
# by file url. This is because the config file is a user
445
# file, and we would rather not expose the user to file urls.
446
if location.startswith('file://'):
447
location = urlutils.local_path_from_url(location)
261
super(LocationConfig, self).__init__(branches_config_filename)
262
self._global_config = None
448
263
self.location = location
450
def _get_matching_sections(self):
451
"""Return an ordered list of section names matching this location."""
265
def _get_global_config(self):
266
if self._global_config is None:
267
self._global_config = GlobalConfig()
268
return self._global_config
270
def _get_section(self):
271
"""Get the section we should look in for config items.
273
Returns None if none exists.
274
TODO: perhaps return a NullSection that thunks through to the
452
277
sections = self._get_parser()
453
278
location_names = self.location.split('/')
454
279
if self.location.endswith('/'):
455
280
del location_names[-1]
457
282
for section in sections:
458
# location is a local path if possible, so we need
459
# to convert 'file://' urls to local paths if necessary.
460
# This also avoids having file:///path be a more exact
461
# match than '/path'.
462
if section.startswith('file://'):
463
section_path = urlutils.local_path_from_url(section)
465
section_path = section
466
section_names = section_path.split('/')
283
section_names = section.split('/')
467
284
if section.endswith('/'):
468
285
del section_names[-1]
469
286
names = zip(location_names, section_names)
478
295
# if section is longer, no match.
479
296
if len(section_names) > len(location_names):
481
matches.append((len(section_names), section,
482
'/'.join(location_names[len(section_names):])))
298
# if path is longer, and recurse is not true, no match
299
if len(section_names) < len(location_names):
301
if not self._get_parser().get_bool(section, 'recurse'):
305
matches.append((len(section_names), section))
483
308
matches.sort(reverse=True)
485
for (length, section, extra_path) in matches:
486
sections.append((section, extra_path))
487
# should we stop looking for parent configs here?
489
if self._get_parser()[section].as_bool('ignore_parents'):
495
def _get_option_policy(self, section, option_name):
496
"""Return the policy for the given (section, option_name) pair."""
497
# check for the old 'recurse=False' flag
499
recurse = self._get_parser()[section].as_bool('recurse')
503
return POLICY_NORECURSE
505
policy_key = option_name + ':policy'
507
policy_name = self._get_parser()[section][policy_key]
511
return _policy_value[policy_name]
513
def _set_option_policy(self, section, option_name, option_policy):
514
"""Set the policy for the given option name in the given section."""
515
# The old recurse=False option affects all options in the
516
# section. To handle multiple policies in the section, we
517
# need to convert it to a policy_norecurse key.
519
recurse = self._get_parser()[section].as_bool('recurse')
523
symbol_versioning.warn(
524
'The recurse option is deprecated as of 0.14. '
525
'The section "%s" has been converted to use policies.'
528
del self._get_parser()[section]['recurse']
530
for key in self._get_parser()[section].keys():
531
if not key.endswith(':policy'):
532
self._get_parser()[section][key +
533
':policy'] = 'norecurse'
535
policy_key = option_name + ':policy'
536
policy_name = _policy_name[option_policy]
537
if policy_name is not None:
538
self._get_parser()[section][policy_key] = policy_name
540
if policy_key in self._get_parser()[section]:
541
del self._get_parser()[section][policy_key]
543
def set_user_option(self, option, value, store=STORE_LOCATION):
311
def _gpg_signing_command(self):
312
"""See Config.gpg_signing_command."""
313
command = super(LocationConfig, self)._gpg_signing_command()
314
if command is not None:
316
return self._get_global_config()._gpg_signing_command()
318
def _get_user_id(self):
319
user_id = super(LocationConfig, self)._get_user_id()
320
if user_id is not None:
322
return self._get_global_config()._get_user_id()
324
def _get_user_option(self, option_name):
325
"""See Config._get_user_option."""
326
option_value = super(LocationConfig,
327
self)._get_user_option(option_name)
328
if option_value is not None:
330
return self._get_global_config()._get_user_option(option_name)
332
def _get_signature_checking(self):
333
"""See Config._get_signature_checking."""
334
check = super(LocationConfig, self)._get_signature_checking()
335
if check is not None:
337
return self._get_global_config()._get_signature_checking()
339
def _post_commit(self):
340
"""See Config.post_commit."""
341
hook = self._get_user_option('post_commit')
344
return self._get_global_config()._post_commit()
346
def set_user_option(self, option, value):
544
347
"""Save option and its value in the configuration."""
545
assert store in [STORE_LOCATION,
546
STORE_LOCATION_NORECURSE,
547
STORE_LOCATION_APPENDPATH], 'bad storage policy'
548
348
# FIXME: RBC 20051029 This should refresh the parser and also take a
549
# file lock on locations.conf.
550
conf_dir = os.path.dirname(self._get_filename())
551
ensure_config_dir_exists(conf_dir)
349
# file lock on branches.conf.
350
if not os.path.isdir(os.path.dirname(self._get_filename())):
351
os.mkdir(os.path.dirname(self._get_filename()))
552
352
location = self.location
553
353
if location.endswith('/'):
554
354
location = location[:-1]
558
358
elif location + '/' in self._get_parser():
559
359
location = location + '/'
560
360
self._get_parser()[location][option]=value
561
# the allowed values of store match the config policies
562
self._set_option_policy(location, option, store)
563
self._get_parser().write(file(self._get_filename(), 'wb'))
361
self._get_parser().write()
566
364
class BranchConfig(Config):
567
365
"""A configuration object giving the policy for a branch."""
569
def _get_branch_data_config(self):
570
if self._branch_data_config is None:
571
self._branch_data_config = TreeConfig(self.branch)
572
return self._branch_data_config
574
367
def _get_location_config(self):
575
368
if self._location_config is None:
576
369
self._location_config = LocationConfig(self.branch.base)
577
370
return self._location_config
579
def _get_global_config(self):
580
if self._global_config is None:
581
self._global_config = GlobalConfig()
582
return self._global_config
584
def _get_best_value(self, option_name):
585
"""This returns a user option from local, tree or global config.
587
They are tried in that order. Use get_safe_value if trusted values
590
for source in self.option_sources:
591
value = getattr(source(), option_name)()
592
if value is not None:
596
def _get_safe_value(self, option_name):
597
"""This variant of get_best_value never returns untrusted values.
599
It does not return values from the branch data, because the branch may
600
not be controlled by the user.
602
We may wish to allow locations.conf to control whether branches are
603
trusted in the future.
605
for source in (self._get_location_config, self._get_global_config):
606
value = getattr(source(), option_name)()
607
if value is not None:
611
372
def _get_user_id(self):
612
373
"""Return the full user id for the branch.
615
376
This is looked up in the email controlfile for the branch.
618
return (self.branch.control_files.get_utf8("email")
379
return (self.branch.controlfile("email", "r")
620
381
.decode(bzrlib.user_encoding)
622
383
except errors.NoSuchFile, e:
625
return self._get_best_value('_get_user_id')
386
return self._get_location_config()._get_user_id()
627
388
def _get_signature_checking(self):
628
389
"""See Config._get_signature_checking."""
629
return self._get_best_value('_get_signature_checking')
631
def _get_signing_policy(self):
632
"""See Config._get_signing_policy."""
633
return self._get_best_value('_get_signing_policy')
390
return self._get_location_config()._get_signature_checking()
635
392
def _get_user_option(self, option_name):
636
393
"""See Config._get_user_option."""
637
for source in self.option_sources:
638
value = source()._get_user_option(option_name)
639
if value is not None:
643
def set_user_option(self, name, value, store=STORE_BRANCH,
645
if store == STORE_BRANCH:
646
self._get_branch_data_config().set_option(value, name)
647
elif store == STORE_GLOBAL:
648
self._get_global_config().set_user_option(name, value)
650
self._get_location_config().set_user_option(name, value, store)
653
if store in (STORE_GLOBAL, STORE_BRANCH):
654
mask_value = self._get_location_config().get_user_option(name)
655
if mask_value is not None:
656
trace.warning('Value "%s" is masked by "%s" from'
657
' locations.conf', value, mask_value)
659
if store == STORE_GLOBAL:
660
branch_config = self._get_branch_data_config()
661
mask_value = branch_config.get_user_option(name)
662
if mask_value is not None:
663
trace.warning('Value "%s" is masked by "%s" from'
664
' branch.conf', value, mask_value)
394
return self._get_location_config()._get_user_option(option_name)
667
396
def _gpg_signing_command(self):
668
397
"""See Config.gpg_signing_command."""
669
return self._get_safe_value('_gpg_signing_command')
398
return self._get_location_config()._gpg_signing_command()
671
400
def __init__(self, branch):
672
401
super(BranchConfig, self).__init__()
673
402
self._location_config = None
674
self._branch_data_config = None
675
self._global_config = None
676
403
self.branch = branch
677
self.option_sources = (self._get_location_config,
678
self._get_branch_data_config,
679
self._get_global_config)
681
405
def _post_commit(self):
682
406
"""See Config.post_commit."""
683
return self._get_safe_value('_post_commit')
685
def _get_nickname(self):
686
value = self._get_explicit_nickname()
687
if value is not None:
689
return urlutils.unescape(self.branch.base.split('/')[-2])
691
def has_explicit_nickname(self):
692
"""Return true if a nickname has been explicitly assigned."""
693
return self._get_explicit_nickname() is not None
695
def _get_explicit_nickname(self):
696
return self._get_best_value('_get_nickname')
698
def _log_format(self):
699
"""See Config.log_format."""
700
return self._get_best_value('_log_format')
703
def ensure_config_dir_exists(path=None):
704
"""Make sure a configuration directory exists.
705
This makes sure that the directory exists.
706
On windows, since configuration directories are 2 levels deep,
707
it makes sure both the directory and the parent directory exists.
711
if not os.path.isdir(path):
712
if sys.platform == 'win32':
713
parent_dir = os.path.dirname(path)
714
if not os.path.isdir(parent_dir):
715
mutter('creating config parent directory: %r', parent_dir)
717
mutter('creating config directory: %r', path)
407
return self._get_location_config()._post_commit()
721
410
def config_dir():
726
415
TODO: Global option --config-dir to override this.
728
base = os.environ.get('BZR_HOME', None)
729
if sys.platform == 'win32':
731
base = win32utils.get_appdata_location_unicode()
733
base = os.environ.get('HOME', None)
735
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
736
return osutils.pathjoin(base, 'bazaar', '2.0')
738
# cygwin, linux, and darwin all have a $HOME directory
740
base = os.path.expanduser("~")
741
return osutils.pathjoin(base, ".bazaar")
417
return os.path.join(os.path.expanduser("~"), ".bazaar")
744
420
def config_filename():
745
421
"""Return per-user configuration ini file filename."""
746
return osutils.pathjoin(config_dir(), 'bazaar.conf')
422
return os.path.join(config_dir(), 'bazaar.conf')
749
425
def branches_config_filename():
750
426
"""Return per-user configuration ini file filename."""
751
return osutils.pathjoin(config_dir(), 'branches.conf')
754
def locations_config_filename():
755
"""Return per-user configuration ini file filename."""
756
return osutils.pathjoin(config_dir(), 'locations.conf')
759
def user_ignore_config_filename():
760
"""Return the user default ignore filename"""
761
return osutils.pathjoin(config_dir(), 'ignore')
427
return os.path.join(config_dir(), 'branches.conf')
764
430
def _auto_user_id():
777
if sys.platform == 'win32':
778
name = win32utils.get_user_name_unicode()
780
raise errors.BzrError("Cannot autodetect user name.\n"
781
"Please, set your name with command like:\n"
782
'bzr whoami "Your Name <name@domain.com>"')
783
host = win32utils.get_host_name_unicode()
785
host = socket.gethostname()
786
return name, (name + '@' + host)
443
# XXX: Any good way to get real user name on win32?
790
447
uid = os.getuid()
791
448
w = pwd.getpwuid(uid)
793
# we try utf-8 first, because on many variants (like Linux),
794
# /etc/passwd "should" be in utf-8, and because it's unlikely to give
795
# false positives. (many users will have their user encoding set to
796
# latin-1, which cannot raise UnicodeError.)
798
gecos = w.pw_gecos.decode('utf-8')
802
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
803
encoding = bzrlib.user_encoding
805
raise errors.BzrCommandError('Unable to determine your name. '
806
'Use "bzr whoami" to set it.')
808
username = w.pw_name.decode(encoding)
810
raise errors.BzrCommandError('Unable to determine your name. '
811
'Use "bzr whoami" to set it.')
449
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
450
username = w.pw_name.decode(bzrlib.user_encoding)
813
451
comma = gecos.find(',')
842
476
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
844
raise errors.NoEmailInUsername(e)
478
raise errors.BzrError("%r doesn't seem to contain "
479
"a reasonable email address" % e)
845
480
return m.group(0)
848
class TreeConfig(IniBasedConfig):
482
class TreeConfig(object):
849
483
"""Branch configuration data associated with its contents, not location"""
850
484
def __init__(self, branch):
851
485
self.branch = branch
853
def _get_parser(self, file=None):
855
return IniBasedConfig._get_parser(file)
856
return self._get_config()
858
487
def _get_config(self):
860
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
489
obj = ConfigObj(self.branch.controlfile('branch.conf',
862
492
except errors.NoSuchFile:
863
obj = ConfigObj(encoding='utf=8')
866
496
def get_option(self, name, section=None, default=None):
added
removed
bzrlib/config.py
