352
355
class IniBasedConfig(Config):
353
356
"""A configuration policy that draws from ini files."""
355
def __init__(self, get_filename):
358
def __init__(self, get_filename=symbol_versioning.DEPRECATED_PARAMETER,
360
"""Base class for configuration files using an ini-like syntax.
362
:param file_name: The configuration file path.
356
364
super(IniBasedConfig, self).__init__()
357
self._get_filename = get_filename
365
self.file_name = file_name
366
if symbol_versioning.deprecated_passed(get_filename):
367
symbol_versioning.warn(
368
'IniBasedConfig.__init__(get_filename) was deprecated in 2.3.'
369
' Use file_name instead.',
372
if get_filename is not None:
373
self.file_name = get_filename()
375
self.file_name = file_name
358
377
self._parser = None
360
def _get_parser(self, file=None):
380
def from_string(cls, str_or_unicode, file_name=None, save=False):
381
"""Create a config object from a string.
383
:param str_or_unicode: A string representing the file content. This will
386
:param file_name: The configuration file path.
388
:param _save: Whether the file should be saved upon creation.
390
conf = cls(file_name=file_name)
391
conf._create_from_string(str_or_unicode, save)
394
def _create_from_string(self, str_or_unicode, save):
395
self._content = StringIO(str_or_unicode.encode('utf-8'))
396
# Some tests use in-memory configs, some other always need the config
397
# file to exist on disk.
399
self._write_config_file()
401
def _get_parser(self, file=symbol_versioning.DEPRECATED_PARAMETER):
361
402
if self._parser is not None:
362
403
return self._parser
364
input = self._get_filename()
404
if symbol_versioning.deprecated_passed(file):
405
symbol_versioning.warn(
406
'IniBasedConfig._get_parser(file=xxx) was deprecated in 2.3.'
407
' Use IniBasedConfig(_content=xxx) instead.',
410
if self._content is not None:
411
co_input = self._content
412
elif self.file_name is None:
413
raise AssertionError('We have no content to create the config')
415
co_input = self.file_name
368
self._parser = ConfigObj(input, encoding='utf-8')
417
self._parser = ConfigObj(co_input, encoding='utf-8')
369
418
except configobj.ConfigObjError, e:
370
419
raise errors.ParseConfigError(e.errors, e.config.filename)
420
# Make sure self.reload() will use the right file name
421
self._parser.filename = self.file_name
371
422
return self._parser
425
"""Reload the config file from disk."""
426
if self.file_name is None:
427
raise AssertionError('We need a file name to reload the config')
428
if self._parser is not None:
429
self._parser.reload()
373
431
def _get_matching_sections(self):
374
432
"""Return an ordered list of (section_name, extra_path) pairs.
479
537
return self.get_user_option('nickname')
481
539
def _write_config_file(self):
482
atomic_file = atomicfile.AtomicFile(self._get_filename())
540
if self.file_name is None:
541
raise AssertionError('We cannot save, self.file_name is None')
542
conf_dir = os.path.dirname(self.file_name)
543
ensure_config_dir_exists(conf_dir)
544
atomic_file = atomicfile.AtomicFile(self.file_name)
483
545
self._get_parser().write(atomic_file)
484
546
atomic_file.commit()
485
547
atomic_file.close()
488
class GlobalConfig(IniBasedConfig):
548
osutils.copy_ownership_from_path(self.file_name)
551
class LockableConfig(IniBasedConfig):
552
"""A configuration needing explicit locking for access.
554
If several processes try to write the config file, the accesses need to be
557
Daughter classes should decorate all methods that update a config with the
558
``@needs_write_lock`` decorator (they call, directly or indirectly, the
559
``_write_config_file()`` method. These methods (typically ``set_option()``
560
and variants must reload the config file from disk before calling
561
``_write_config_file()``), this can be achieved by calling the
562
``self.reload()`` method. Note that the lock scope should cover both the
563
reading and the writing of the config file which is why the decorator can't
564
be applied to ``_write_config_file()`` only.
566
This should be enough to implement the following logic:
567
- lock for exclusive write access,
568
- reload the config file from disk,
572
This logic guarantees that a writer can update a value without erasing an
573
update made by another writer.
578
def __init__(self, file_name):
579
super(LockableConfig, self).__init__(file_name=file_name)
580
self.dir = osutils.dirname(osutils.safe_unicode(self.file_name))
581
self.transport = transport.get_transport(self.dir)
582
self._lock = lockdir.LockDir(self.transport, 'lock')
584
def _create_from_string(self, unicode_bytes, save):
585
super(LockableConfig, self)._create_from_string(unicode_bytes, False)
587
# We need to handle the saving here (as opposed to IniBasedConfig)
590
self._write_config_file()
593
def lock_write(self, token=None):
594
"""Takes a write lock in the directory containing the config file.
596
If the directory doesn't exist it is created.
598
ensure_config_dir_exists(self.dir)
599
return self._lock.lock_write(token)
604
def break_lock(self):
605
self._lock.break_lock()
607
def _write_config_file(self):
608
if self._lock is None or not self._lock.is_held:
609
# NB: if the following exception is raised it probably means a
610
# missing @needs_write_lock decorator on one of the callers.
611
raise errors.ObjectNotLocked(self)
612
super(LockableConfig, self)._write_config_file()
615
class GlobalConfig(LockableConfig):
489
616
"""The configuration that should be used for a specific location."""
619
super(GlobalConfig, self).__init__(file_name=config_filename())
622
def from_string(cls, str_or_unicode, save=False):
623
"""Create a config object from a string.
625
:param str_or_unicode: A string representing the file content. This
626
will be utf-8 encoded.
628
:param save: Whether the file should be saved upon creation.
631
conf._create_from_string(str_or_unicode, save)
491
634
def get_editor(self):
492
635
return self._get_user_option('editor')
495
super(GlobalConfig, self).__init__(config_filename)
497
638
def set_user_option(self, option, value):
498
639
"""Save option and its value in the configuration."""
499
640
self._set_option(option, value, 'DEFAULT')
518
662
self._write_config_file()
520
664
def _set_option(self, option, value, section):
521
# FIXME: RBC 20051029 This should refresh the parser and also take a
522
# file lock on bazaar.conf.
523
conf_dir = os.path.dirname(self._get_filename())
524
ensure_config_dir_exists(conf_dir)
525
666
self._get_parser().setdefault(section, {})[option] = value
526
667
self._write_config_file()
529
class LocationConfig(IniBasedConfig):
670
class LocationConfig(LockableConfig):
530
671
"""A configuration object that gives the policy for a location."""
532
673
def __init__(self, location):
533
name_generator = locations_config_filename
534
if (not os.path.exists(name_generator()) and
535
os.path.exists(branches_config_filename())):
536
if sys.platform == 'win32':
537
trace.warning('Please rename %s to %s'
538
% (branches_config_filename(),
539
locations_config_filename()))
541
trace.warning('Please rename ~/.bazaar/branches.conf'
542
' to ~/.bazaar/locations.conf')
543
name_generator = branches_config_filename
544
super(LocationConfig, self).__init__(name_generator)
674
super(LocationConfig, self).__init__(
675
file_name=locations_config_filename())
545
676
# local file locations are looked up by local path, rather than
546
677
# by file url. This is because the config file is a user
547
678
# file, and we would rather not expose the user to file urls.
549
680
location = urlutils.local_path_from_url(location)
550
681
self.location = location
684
def from_string(cls, str_or_unicode, location, save=False):
685
"""Create a config object from a string.
687
:param str_or_unicode: A string representing the file content. This will
690
:param location: The location url to filter the configuration.
692
:param save: Whether the file should be saved upon creation.
695
conf._create_from_string(str_or_unicode, save)
552
698
def _get_matching_sections(self):
553
699
"""Return an ordered list of section names matching this location."""
554
700
sections = self._get_parser()
649
796
STORE_LOCATION_APPENDPATH]:
650
797
raise ValueError('bad storage policy %r for %r' %
652
# FIXME: RBC 20051029 This should refresh the parser and also take a
653
# file lock on locations.conf.
654
conf_dir = os.path.dirname(self._get_filename())
655
ensure_config_dir_exists(conf_dir)
656
800
location = self.location
657
801
if location.endswith('/'):
658
802
location = location[:-1]
659
if (not location in self._get_parser() and
660
not location + '/' in self._get_parser()):
661
self._get_parser()[location]={}
662
elif location + '/' in self._get_parser():
803
parser = self._get_parser()
804
if not location in parser and not location + '/' in parser:
805
parser[location] = {}
806
elif location + '/' in parser:
663
807
location = location + '/'
664
self._get_parser()[location][option]=value
808
parser[location][option]=value
665
809
# the allowed values of store match the config policies
666
810
self._set_option_policy(location, option, store)
667
811
self._write_config_file()
670
814
class BranchConfig(Config):
671
815
"""A configuration object giving the policy for a branch."""
817
def __init__(self, branch):
818
super(BranchConfig, self).__init__()
819
self._location_config = None
820
self._branch_data_config = None
821
self._global_config = None
823
self.option_sources = (self._get_location_config,
824
self._get_branch_data_config,
825
self._get_global_config)
673
827
def _get_branch_data_config(self):
674
828
if self._branch_data_config is None:
675
829
self._branch_data_config = TreeConfig(self.branch)
773
927
"""See Config.gpg_signing_command."""
774
928
return self._get_safe_value('_gpg_signing_command')
776
def __init__(self, branch):
777
super(BranchConfig, self).__init__()
778
self._location_config = None
779
self._branch_data_config = None
780
self._global_config = None
782
self.option_sources = (self._get_location_config,
783
self._get_branch_data_config,
784
self._get_global_config)
786
930
def _post_commit(self):
787
931
"""See Config.post_commit."""
788
932
return self._get_safe_value('_post_commit')
added
removed
bzrlib/config.py
