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
58
from fnmatch import fnmatch
73
from StringIO import StringIO
62
import bzrlib.errors as errors
83
63
import bzrlib.util.configobj.configobj as configobj
86
from bzrlib.trace import mutter, warning
64
from StringIO import StringIO
89
66
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
123
71
class ConfigObj(configobj.ConfigObj):
125
73
def get_bool(self, section, key):
126
return self[section].as_bool(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)
128
82
def get_value(self, section, name):
129
83
# Try [] for the old DEFAULT section.
240
175
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
249
177
def signature_needed(self):
250
178
"""Is a signature needed when committing ?."""
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:
179
policy = self._get_signature_checking()
180
if policy == CHECK_ALWAYS:
263
def get_alias(self, value):
264
return self._get_alias(value)
266
def _get_alias(self, value):
269
def get_nickname(self):
270
return self._get_nickname()
272
def _get_nickname(self):
276
185
class IniBasedConfig(Config):
277
186
"""A configuration policy that draws from ini files."""
287
self._parser = ConfigObj(input, encoding='utf-8')
196
self._parser = ConfigObj(input)
288
197
except configobj.ConfigObjError, e:
289
198
raise errors.ParseConfigError(e.errors, e.config.filename)
290
199
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, '')]
304
201
def _get_section(self):
305
202
"""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."""
312
205
def _get_signature_checking(self):
313
206
"""See Config._get_signature_checking."""
314
207
policy = self._get_user_option('check_signatures')
316
209
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)
324
211
def _get_user_id(self):
325
212
"""Get the user id from the 'email' key in the current section."""
326
213
return self._get_user_option('email')
328
215
def _get_user_option(self, option_name):
329
216
"""See Config._get_user_option."""
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)
218
return self._get_parser().get_value(self._get_section(),
353
223
def _gpg_signing_command(self):
354
224
"""See Config.gpg_signing_command."""
355
225
return self._get_user_option('gpg_signing_command')
357
def _log_format(self):
358
"""See Config.log_format."""
359
return self._get_user_option('log_format')
361
227
def __init__(self, get_filename):
362
228
super(IniBasedConfig, self).__init__()
363
229
self._get_filename = get_filename
378
244
raise errors.BzrError("Invalid signatures policy '%s'"
379
245
% signature_string)
381
def _string_to_signing_policy(self, signature_string):
382
"""Convert a string to a signing policy."""
383
if signature_string.lower() == 'when-required':
384
return SIGN_WHEN_REQUIRED
385
if signature_string.lower() == 'never':
387
if signature_string.lower() == 'always':
389
raise errors.BzrError("Invalid signing policy '%s'"
392
def _get_alias(self, value):
394
return self._get_parser().get_value("ALIASES",
399
def _get_nickname(self):
400
return self.get_user_option('nickname')
403
248
class GlobalConfig(IniBasedConfig):
404
249
"""The configuration that should be used for a specific location."""
409
254
def __init__(self):
410
255
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)
426
258
class LocationConfig(IniBasedConfig):
427
259
"""A configuration object that gives the policy for a location."""
429
261
def __init__(self, location):
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)
262
super(LocationConfig, self).__init__(branches_config_filename)
263
self._global_config = None
447
264
self.location = location
449
def _get_matching_sections(self):
450
"""Return an ordered list of section names matching this 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
def _get_section(self):
272
"""Get the section we should look in for config items.
274
Returns None if none exists.
275
TODO: perhaps return a NullSection that thunks through to the
451
278
sections = self._get_parser()
452
279
location_names = self.location.split('/')
453
280
if self.location.endswith('/'):
454
281
del location_names[-1]
456
283
for section in sections:
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('/')
284
section_names = section.split('/')
466
285
if section.endswith('/'):
467
286
del section_names[-1]
468
287
names = zip(location_names, section_names)
477
296
# if section is longer, no match.
478
297
if len(section_names) > len(location_names):
480
matches.append((len(section_names), section,
481
'/'.join(location_names[len(section_names):])))
299
# if path is longer, and recurse is not true, no match
300
if len(section_names) < len(location_names):
302
if not self._get_parser().get_bool(section, 'recurse'):
306
matches.append((len(section_names), section))
482
309
matches.sort(reverse=True)
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):
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
def set_user_option(self, option, value):
543
348
"""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'
547
349
# FIXME: RBC 20051029 This should refresh the parser and also take a
548
# file lock on locations.conf.
549
conf_dir = os.path.dirname(self._get_filename())
550
ensure_config_dir_exists(conf_dir)
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()))
551
353
location = self.location
552
354
if location.endswith('/'):
553
355
location = location[:-1]
557
359
elif location + '/' in self._get_parser():
558
360
location = location + '/'
559
361
self._get_parser()[location][option]=value
560
# the allowed values of store match the config policies
561
self._set_option_policy(location, option, store)
562
self._get_parser().write(file(self._get_filename(), 'wb'))
362
self._get_parser().write()
565
365
class BranchConfig(Config):
566
366
"""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
573
368
def _get_location_config(self):
574
369
if self._location_config is None:
575
370
self._location_config = LocationConfig(self.branch.base)
576
371
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:
610
373
def _get_user_id(self):
611
374
"""Return the full user id for the branch.
614
377
This is looked up in the email controlfile for the branch.
617
return (self.branch.control_files.get_utf8("email")
380
return (self.branch.controlfile("email", "r")
619
382
.decode(bzrlib.user_encoding)
621
384
except errors.NoSuchFile, e:
624
return self._get_best_value('_get_user_id')
387
return self._get_location_config()._get_user_id()
626
389
def _get_signature_checking(self):
627
390
"""See 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')
391
return self._get_location_config()._get_signature_checking()
634
393
def _get_user_option(self, option_name):
635
394
"""See Config._get_user_option."""
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)
395
return self._get_location_config()._get_user_option(option_name)
650
397
def _gpg_signing_command(self):
651
398
"""See Config.gpg_signing_command."""
652
return self._get_safe_value('_gpg_signing_command')
399
return self._get_location_config()._gpg_signing_command()
654
401
def __init__(self, branch):
655
402
super(BranchConfig, self).__init__()
656
403
self._location_config = None
657
self._branch_data_config = None
658
self._global_config = None
659
404
self.branch = branch
660
self.option_sources = (self._get_location_config,
661
self._get_branch_data_config,
662
self._get_global_config)
664
406
def _post_commit(self):
665
407
"""See 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')
681
def _log_format(self):
682
"""See Config.log_format."""
683
return self._get_best_value('_log_format')
686
def ensure_config_dir_exists(path=None):
687
"""Make sure a configuration directory exists.
688
This makes sure that the directory exists.
689
On windows, since configuration directories are 2 levels deep,
690
it makes sure both the directory and the parent directory exists.
694
if not os.path.isdir(path):
695
if sys.platform == 'win32':
696
parent_dir = os.path.dirname(path)
697
if not os.path.isdir(parent_dir):
698
mutter('creating config parent directory: %r', parent_dir)
700
mutter('creating config directory: %r', path)
408
return self._get_location_config()._post_commit()
704
411
def config_dir():
711
418
base = os.environ.get('BZR_HOME', None)
712
419
if sys.platform == 'win32':
714
base = win32utils.get_appdata_location_unicode()
421
base = os.environ.get('APPDATA', None)
716
423
base = os.environ.get('HOME', None)
718
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
719
return osutils.pathjoin(base, 'bazaar', '2.0')
425
raise BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
426
return os.path.join(base, 'bazaar', '2.0')
721
428
# cygwin, linux, and darwin all have a $HOME directory
723
430
base = os.path.expanduser("~")
724
return osutils.pathjoin(base, ".bazaar")
431
return os.path.join(base, ".bazaar")
727
434
def config_filename():
728
435
"""Return per-user configuration ini file filename."""
729
return osutils.pathjoin(config_dir(), 'bazaar.conf')
436
return os.path.join(config_dir(), 'bazaar.conf')
732
439
def branches_config_filename():
733
440
"""Return per-user configuration ini file filename."""
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')
441
return os.path.join(config_dir(), 'branches.conf')
747
444
def _auto_user_id():
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)
457
# XXX: Any good way to get real user name on win32?
773
461
uid = os.getuid()
774
462
w = pwd.getpwuid(uid)
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.')
463
gecos = w.pw_gecos.decode(bzrlib.user_encoding)
464
username = w.pw_name.decode(bzrlib.user_encoding)
796
465
comma = gecos.find(',')
825
490
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
827
raise errors.NoEmailInUsername(e)
492
raise errors.BzrError("%r doesn't seem to contain "
493
"a reasonable email address" % e)
828
494
return m.group(0)
831
class TreeConfig(IniBasedConfig):
496
class TreeConfig(object):
832
497
"""Branch configuration data associated with its contents, not location"""
833
498
def __init__(self, branch):
834
499
self.branch = branch
836
def _get_parser(self, file=None):
838
return IniBasedConfig._get_parser(file)
839
return self._get_config()
841
501
def _get_config(self):
843
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
503
obj = ConfigObj(self.branch.controlfile('branch.conf',
845
506
except errors.NoSuchFile:
846
obj = ConfigObj(encoding='utf=8')
849
510
def get_option(self, name, section=None, default=None):
added
removed
bzrlib/config.py
