49
48
create_signatures - this option controls whether bzr will always create
50
49
gpg signatures, never create them, or create them if the
51
50
branch is configured to require them.
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
51
NB: This option is planned, but not implemented yet.
54
from ConfigParser import ConfigParser
67
from bzrlib.lazy_import import lazy_import
68
lazy_import(globals(), """
56
from fnmatch import fnmatch
70
from fnmatch import fnmatch
72
from StringIO import StringIO
81
import bzrlib.util.configobj.configobj as configobj
84
from bzrlib.trace import mutter, warning
61
import bzrlib.errors as errors
87
64
CHECK_IF_POSSIBLE=0
165
95
"""See gpg_signing_command()."""
168
def log_format(self):
169
"""What log format should be used"""
170
result = self._log_format()
175
def _log_format(self):
176
"""See log_format()."""
179
98
def __init__(self):
180
99
super(Config, self).__init__()
182
def post_commit(self):
183
"""An ordered list of python functions to call.
185
Each function takes branch, rev_id as parameters.
187
return self._post_commit()
189
def _post_commit(self):
190
"""See Config.post_commit."""
193
101
def user_email(self):
194
102
"""Return just the email component of a username."""
195
return extract_email_address(self.username())
104
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
106
raise BzrError("%r doesn't seem to contain "
107
"a reasonable email address" % e)
197
110
def username(self):
198
111
"""Return email-style username.
200
113
Something similar to 'Martin Pool <mbp@sourcefrog.net>'
202
$BZR_EMAIL can be set to override this (as well as the
203
deprecated $BZREMAIL), then
115
$BZREMAIL can be set to override this, then
204
116
the concrete policy type is checked, and finally
206
If none is found, a reasonable default is (hopefully)
118
but if none is found, a reasonable default is (hopefully)
209
121
TODO: Check it's reasonably well-formed.
211
v = os.environ.get('BZR_EMAIL')
213
return v.decode(bzrlib.user_encoding)
214
123
v = os.environ.get('BZREMAIL')
216
warning('BZREMAIL is deprecated in favor of BZR_EMAIL. Please update your configuration.')
217
125
return v.decode(bzrlib.user_encoding)
219
127
v = self._get_user_id()
238
146
return CHECK_IF_POSSIBLE
240
def signing_policy(self):
241
"""What is the current policy for signature checking?."""
242
policy = self._get_signing_policy()
243
if policy is not None:
245
return SIGN_WHEN_REQUIRED
247
148
def signature_needed(self):
248
149
"""Is a signature needed when committing ?."""
249
policy = self._get_signing_policy()
251
policy = self._get_signature_checking()
252
if policy is not None:
253
warning("Please use create_signatures, not check_signatures "
254
"to set signing policy.")
255
if policy == CHECK_ALWAYS:
257
elif policy == SIGN_ALWAYS:
150
policy = self._get_signature_checking()
151
if policy == CHECK_ALWAYS:
261
def get_alias(self, value):
262
return self._get_alias(value)
264
def _get_alias(self, value):
267
def get_nickname(self):
268
return self._get_nickname()
270
def _get_nickname(self):
274
156
class IniBasedConfig(Config):
275
157
"""A configuration policy that draws from ini files."""
277
159
def _get_parser(self, file=None):
278
160
if self._parser is not None:
279
161
return self._parser
281
input = self._get_filename()
285
self._parser = ConfigObj(input, encoding='utf-8')
286
except configobj.ConfigObjError, e:
287
raise errors.ParseConfigError(e.errors, e.config.filename)
290
def _get_matching_sections(self):
291
"""Return an ordered list of (section_name, extra_path) pairs.
293
If the section contains inherited configuration, extra_path is
294
a string containing the additional path components.
296
section = self._get_section()
297
if section is not None:
298
return [(section, '')]
162
parser = ConfigParser()
166
parser.read([self._get_filename()])
167
self._parser = parser
302
170
def _get_section(self):
303
171
"""Override this to define the section used by the config."""
306
def _get_option_policy(self, section, option_name):
307
"""Return the policy for the given (section, option_name) pair."""
310
174
def _get_signature_checking(self):
311
175
"""See Config._get_signature_checking."""
312
policy = self._get_user_option('check_signatures')
314
return self._string_to_signature_policy(policy)
316
def _get_signing_policy(self):
317
"""See Config._get_signing_policy"""
318
policy = self._get_user_option('create_signatures')
320
return self._string_to_signing_policy(policy)
176
section = self._get_section()
179
if self._get_parser().has_option(section, 'check_signatures'):
180
return self._string_to_signature_policy(
181
self._get_parser().get(section, 'check_signatures'))
322
183
def _get_user_id(self):
323
184
"""Get the user id from the 'email' key in the current section."""
324
return self._get_user_option('email')
185
section = self._get_section()
186
if section is not None:
187
if self._get_parser().has_option(section, 'email'):
188
return self._get_parser().get(section, 'email')
326
190
def _get_user_option(self, option_name):
327
191
"""See Config._get_user_option."""
328
for (section, extra_path) in self._get_matching_sections():
330
value = self._get_parser().get_value(section, option_name)
333
policy = self._get_option_policy(section, option_name)
334
if policy == POLICY_NONE:
336
elif policy == POLICY_NORECURSE:
337
# norecurse items only apply to the exact path
342
elif policy == POLICY_APPENDPATH:
344
value = urlutils.join(value, extra_path)
347
raise AssertionError('Unexpected config policy %r' % policy)
192
section = self._get_section()
193
if section is not None:
194
if self._get_parser().has_option(section, option_name):
195
return self._get_parser().get(section, option_name)
351
197
def _gpg_signing_command(self):
352
198
"""See Config.gpg_signing_command."""
353
return self._get_user_option('gpg_signing_command')
355
def _log_format(self):
356
"""See Config.log_format."""
357
return self._get_user_option('log_format')
199
section = self._get_section()
200
if section is not None:
201
if self._get_parser().has_option(section, 'gpg_signing_command'):
202
return self._get_parser().get(section, 'gpg_signing_command')
359
204
def __init__(self, get_filename):
360
205
super(IniBasedConfig, self).__init__()
361
206
self._get_filename = get_filename
362
207
self._parser = None
364
def _post_commit(self):
365
"""See Config.post_commit."""
366
return self._get_user_option('post_commit')
368
209
def _string_to_signature_policy(self, signature_string):
369
210
"""Convert a string to a signing policy."""
376
217
raise errors.BzrError("Invalid signatures policy '%s'"
377
218
% signature_string)
379
def _string_to_signing_policy(self, signature_string):
380
"""Convert a string to a signing policy."""
381
if signature_string.lower() == 'when-required':
382
return SIGN_WHEN_REQUIRED
383
if signature_string.lower() == 'never':
385
if signature_string.lower() == 'always':
387
raise errors.BzrError("Invalid signing policy '%s'"
390
def _get_alias(self, value):
392
return self._get_parser().get_value("ALIASES",
397
def _get_nickname(self):
398
return self.get_user_option('nickname')
401
221
class GlobalConfig(IniBasedConfig):
402
222
"""The configuration that should be used for a specific location."""
404
224
def get_editor(self):
405
return self._get_user_option('editor')
225
if self._get_parser().has_option(self._get_section(), 'editor'):
226
return self._get_parser().get(self._get_section(), 'editor')
407
228
def __init__(self):
408
229
super(GlobalConfig, self).__init__(config_filename)
410
def set_user_option(self, option, value):
411
"""Save option and its value in the configuration."""
412
# FIXME: RBC 20051029 This should refresh the parser and also take a
413
# file lock on bazaar.conf.
414
conf_dir = os.path.dirname(self._get_filename())
415
ensure_config_dir_exists(conf_dir)
416
if 'DEFAULT' not in self._get_parser():
417
self._get_parser()['DEFAULT'] = {}
418
self._get_parser()['DEFAULT'][option] = value
419
f = open(self._get_filename(), 'wb')
420
self._get_parser().write(f)
424
232
class LocationConfig(IniBasedConfig):
425
233
"""A configuration object that gives the policy for a location."""
427
235
def __init__(self, location):
428
name_generator = locations_config_filename
429
if (not os.path.exists(name_generator()) and
430
os.path.exists(branches_config_filename())):
431
if sys.platform == 'win32':
432
warning('Please rename %s to %s'
433
% (branches_config_filename(),
434
locations_config_filename()))
436
warning('Please rename ~/.bazaar/branches.conf'
437
' to ~/.bazaar/locations.conf')
438
name_generator = branches_config_filename
439
super(LocationConfig, self).__init__(name_generator)
440
# local file locations are looked up by local path, rather than
441
# by file url. This is because the config file is a user
442
# file, and we would rather not expose the user to file urls.
443
if location.startswith('file://'):
444
location = urlutils.local_path_from_url(location)
236
super(LocationConfig, self).__init__(branches_config_filename)
237
self._global_config = None
445
238
self.location = location
447
def _get_matching_sections(self):
448
"""Return an ordered list of section names matching this location."""
449
sections = self._get_parser()
240
def _get_global_config(self):
241
if self._global_config is None:
242
self._global_config = GlobalConfig()
243
return self._global_config
245
def _get_section(self):
246
"""Get the section we should look in for config items.
248
Returns None if none exists.
249
TODO: perhaps return a NullSection that thunks through to the
252
sections = self._get_parser().sections()
450
253
location_names = self.location.split('/')
451
254
if self.location.endswith('/'):
452
255
del location_names[-1]
454
257
for section in sections:
455
# location is a local path if possible, so we need
456
# to convert 'file://' urls to local paths if necessary.
457
# This also avoids having file:///path be a more exact
458
# match than '/path'.
459
if section.startswith('file://'):
460
section_path = urlutils.local_path_from_url(section)
462
section_path = section
463
section_names = section_path.split('/')
258
section_names = section.split('/')
464
259
if section.endswith('/'):
465
260
del section_names[-1]
466
261
names = zip(location_names, section_names)
475
270
# if section is longer, no match.
476
271
if len(section_names) > len(location_names):
478
matches.append((len(section_names), section,
479
'/'.join(location_names[len(section_names):])))
273
# if path is longer, and recurse is not true, no match
274
if len(section_names) < len(location_names):
275
if (self._get_parser().has_option(section, 'recurse')
276
and not self._get_parser().getboolean(section, 'recurse')):
278
matches.append((len(section_names), section))
480
281
matches.sort(reverse=True)
482
for (length, section, extra_path) in matches:
483
sections.append((section, extra_path))
484
# should we stop looking for parent configs here?
486
if self._get_parser()[section].as_bool('ignore_parents'):
492
def _get_option_policy(self, section, option_name):
493
"""Return the policy for the given (section, option_name) pair."""
494
# check for the old 'recurse=False' flag
496
recurse = self._get_parser()[section].as_bool('recurse')
500
return POLICY_NORECURSE
502
policy_key = option_name + ':policy'
504
policy_name = self._get_parser()[section][policy_key]
508
return _policy_value[policy_name]
510
def _set_option_policy(self, section, option_name, option_policy):
511
"""Set the policy for the given option name in the given section."""
512
# The old recurse=False option affects all options in the
513
# section. To handle multiple policies in the section, we
514
# need to convert it to a policy_norecurse key.
516
recurse = self._get_parser()[section].as_bool('recurse')
520
symbol_versioning.warn(
521
'The recurse option is deprecated as of 0.14. '
522
'The section "%s" has been converted to use policies.'
525
del self._get_parser()[section]['recurse']
527
for key in self._get_parser()[section].keys():
528
if not key.endswith(':policy'):
529
self._get_parser()[section][key +
530
':policy'] = 'norecurse'
532
policy_key = option_name + ':policy'
533
policy_name = _policy_name[option_policy]
534
if policy_name is not None:
535
self._get_parser()[section][policy_key] = policy_name
537
if policy_key in self._get_parser()[section]:
538
del self._get_parser()[section][policy_key]
540
def set_user_option(self, option, value, store=STORE_LOCATION):
541
"""Save option and its value in the configuration."""
542
assert store in [STORE_LOCATION,
543
STORE_LOCATION_NORECURSE,
544
STORE_LOCATION_APPENDPATH], 'bad storage policy'
545
# FIXME: RBC 20051029 This should refresh the parser and also take a
546
# file lock on locations.conf.
547
conf_dir = os.path.dirname(self._get_filename())
548
ensure_config_dir_exists(conf_dir)
549
location = self.location
550
if location.endswith('/'):
551
location = location[:-1]
552
if (not location in self._get_parser() and
553
not location + '/' in self._get_parser()):
554
self._get_parser()[location]={}
555
elif location + '/' in self._get_parser():
556
location = location + '/'
557
self._get_parser()[location][option]=value
558
# the allowed values of store match the config policies
559
self._set_option_policy(location, option, store)
560
self._get_parser().write(file(self._get_filename(), 'wb'))
284
def _gpg_signing_command(self):
285
"""See Config.gpg_signing_command."""
286
command = super(LocationConfig, self)._gpg_signing_command()
287
if command is not None:
289
return self._get_global_config()._gpg_signing_command()
291
def _get_user_id(self):
292
user_id = super(LocationConfig, self)._get_user_id()
293
if user_id is not None:
295
return self._get_global_config()._get_user_id()
297
def _get_user_option(self, option_name):
298
"""See Config._get_user_option."""
299
option_value = super(LocationConfig,
300
self)._get_user_option(option_name)
301
if option_value is not None:
303
return self._get_global_config()._get_user_option(option_name)
305
def _get_signature_checking(self):
306
"""See Config._get_signature_checking."""
307
check = super(LocationConfig, self)._get_signature_checking()
308
if check is not None:
310
return self._get_global_config()._get_signature_checking()
563
313
class BranchConfig(Config):
564
314
"""A configuration object giving the policy for a branch."""
566
def _get_branch_data_config(self):
567
if self._branch_data_config is None:
568
self._branch_data_config = TreeConfig(self.branch)
569
return self._branch_data_config
571
316
def _get_location_config(self):
572
317
if self._location_config is None:
573
318
self._location_config = LocationConfig(self.branch.base)
574
319
return self._location_config
576
def _get_global_config(self):
577
if self._global_config is None:
578
self._global_config = GlobalConfig()
579
return self._global_config
581
def _get_best_value(self, option_name):
582
"""This returns a user option from local, tree or global config.
584
They are tried in that order. Use get_safe_value if trusted values
587
for source in self.option_sources:
588
value = getattr(source(), option_name)()
589
if value is not None:
593
def _get_safe_value(self, option_name):
594
"""This variant of get_best_value never returns untrusted values.
596
It does not return values from the branch data, because the branch may
597
not be controlled by the user.
599
We may wish to allow locations.conf to control whether branches are
600
trusted in the future.
602
for source in (self._get_location_config, self._get_global_config):
603
value = getattr(source(), option_name)()
604
if value is not None:
608
321
def _get_user_id(self):
609
322
"""Return the full user id for the branch.
612
325
This is looked up in the email controlfile for the branch.
615
return (self.branch.control_files.get_utf8("email")
328
return (self.branch.controlfile("email", "r")
617
330
.decode(bzrlib.user_encoding)
619
332
except errors.NoSuchFile, e:
622
return self._get_best_value('_get_user_id')
335
return self._get_location_config()._get_user_id()
624
337
def _get_signature_checking(self):
625
338
"""See Config._get_signature_checking."""
626
return self._get_best_value('_get_signature_checking')
628
def _get_signing_policy(self):
629
"""See Config._get_signing_policy."""
630
return self._get_best_value('_get_signing_policy')
339
return self._get_location_config()._get_signature_checking()
632
341
def _get_user_option(self, option_name):
633
342
"""See Config._get_user_option."""
634
for source in self.option_sources:
635
value = source()._get_user_option(option_name)
636
if value is not None:
640
def set_user_option(self, name, value, store=STORE_BRANCH):
641
if store == STORE_BRANCH:
642
self._get_branch_data_config().set_option(value, name)
643
elif store == STORE_GLOBAL:
644
self._get_global_config().set_user_option(name, value)
646
self._get_location_config().set_user_option(name, value, store)
343
return self._get_location_config()._get_user_option(option_name)
648
345
def _gpg_signing_command(self):
649
346
"""See Config.gpg_signing_command."""
650
return self._get_safe_value('_gpg_signing_command')
347
return self._get_location_config()._gpg_signing_command()
652
349
def __init__(self, branch):
653
350
super(BranchConfig, self).__init__()
654
351
self._location_config = None
655
self._branch_data_config = None
656
self._global_config = None
657
352
self.branch = branch
658
self.option_sources = (self._get_location_config,
659
self._get_branch_data_config,
660
self._get_global_config)
662
def _post_commit(self):
663
"""See Config.post_commit."""
664
return self._get_safe_value('_post_commit')
666
def _get_nickname(self):
667
value = self._get_explicit_nickname()
668
if value is not None:
670
return urlutils.unescape(self.branch.base.split('/')[-2])
672
def has_explicit_nickname(self):
673
"""Return true if a nickname has been explicitly assigned."""
674
return self._get_explicit_nickname() is not None
676
def _get_explicit_nickname(self):
677
return self._get_best_value('_get_nickname')
679
def _log_format(self):
680
"""See Config.log_format."""
681
return self._get_best_value('_log_format')
684
def ensure_config_dir_exists(path=None):
685
"""Make sure a configuration directory exists.
686
This makes sure that the directory exists.
687
On windows, since configuration directories are 2 levels deep,
688
it makes sure both the directory and the parent directory exists.
692
if not os.path.isdir(path):
693
if sys.platform == 'win32':
694
parent_dir = os.path.dirname(path)
695
if not os.path.isdir(parent_dir):
696
mutter('creating config parent directory: %r', parent_dir)
698
mutter('creating config directory: %r', path)
702
355
def config_dir():
707
360
TODO: Global option --config-dir to override this.
709
base = os.environ.get('BZR_HOME', None)
710
if sys.platform == 'win32':
712
base = os.environ.get('APPDATA', None)
714
base = os.environ.get('HOME', None)
716
raise errors.BzrError('You must have one of BZR_HOME, APPDATA, or HOME set')
717
return osutils.pathjoin(base, 'bazaar', '2.0')
719
# cygwin, linux, and darwin all have a $HOME directory
721
base = os.path.expanduser("~")
722
return osutils.pathjoin(base, ".bazaar")
362
return os.path.join(os.path.expanduser("~"), ".bazaar")
725
365
def config_filename():
726
366
"""Return per-user configuration ini file filename."""
727
return osutils.pathjoin(config_dir(), 'bazaar.conf')
367
return os.path.join(config_dir(), 'bazaar.conf')
730
370
def branches_config_filename():
731
371
"""Return per-user configuration ini file filename."""
732
return osutils.pathjoin(config_dir(), 'branches.conf')
735
def locations_config_filename():
736
"""Return per-user configuration ini file filename."""
737
return osutils.pathjoin(config_dir(), 'locations.conf')
740
def user_ignore_config_filename():
741
"""Return the user default ignore filename"""
742
return osutils.pathjoin(config_dir(), 'ignore')
372
return os.path.join(config_dir(), 'branches.conf')
745
375
def _auto_user_id():
814
421
m = re.search(r'[\w+.-]+@[\w+.-]+', e)
816
raise errors.NoEmailInUsername(e)
423
raise BzrError("%r doesn't seem to contain "
424
"a reasonable email address" % e)
817
425
return m.group(0)
820
class TreeConfig(IniBasedConfig):
821
"""Branch configuration data associated with its contents, not location"""
822
def __init__(self, branch):
825
def _get_parser(self, file=None):
827
return IniBasedConfig._get_parser(file)
828
return self._get_config()
830
def _get_config(self):
832
obj = ConfigObj(self.branch.control_files.get('branch.conf'),
834
except errors.NoSuchFile:
835
obj = ConfigObj(encoding='utf=8')
838
def get_option(self, name, section=None, default=None):
839
self.branch.lock_read()
841
obj = self._get_config()
843
if section is not None:
852
def set_option(self, value, name, section=None):
853
"""Set a per-branch configuration option"""
854
self.branch.lock_write()
856
cfg_obj = self._get_config()
861
obj = cfg_obj[section]
863
cfg_obj[section] = {}
864
obj = cfg_obj[section]
866
out_file = StringIO()
867
cfg_obj.write(out_file)
869
self.branch.control_files.put('branch.conf', out_file)
added
removed
bzrlib/config.py
