"""Plugin storage class.""" import json import logging from acme.magic_typing import Any, Dict # pylint: disable=unused-import, no-name-in-module from certbot import errors from certbot.compat import os from certbot.compat import filesystem logger = logging.getLogger(__name__) class PluginStorage(object): """Class implementing storage functionality for plugins""" def __init__(self, config, classkey): """Initializes PluginStorage object storing required configuration options. :param .configuration.NamespaceConfig config: Configuration object :param str classkey: class name to use as root key in storage file """ self._config = config self._classkey = classkey self._initialized = False self._data = None self._storagepath = None def _initialize_storage(self): """Initializes PluginStorage data and reads current state from the disk if the storage json exists.""" self._storagepath = os.path.join(self._config.config_dir, ".pluginstorage.json") self._load() self._initialized = True def _load(self): """Reads PluginStorage content from the disk to a dict structure :raises .errors.PluginStorageError: when unable to open or read the file """ data = dict() # type: Dict[str, Any] filedata = "" try: with open(self._storagepath, 'r') as fh: filedata = fh.read() except IOError as e: errmsg = "Could not read PluginStorage data file: {0} : {1}".format( self._storagepath, str(e)) if os.path.isfile(self._storagepath): # Only error out if file exists, but cannot be read logger.error(errmsg) raise errors.PluginStorageError(errmsg) try: data = json.loads(filedata) except ValueError: if not filedata: logger.debug("Plugin storage file %s was empty, no values loaded", self._storagepath) else: errmsg = "PluginStorage file {0} is corrupted.".format( self._storagepath) logger.error(errmsg) raise errors.PluginStorageError(errmsg) self._data = data def save(self): """Saves PluginStorage content to disk :raises .errors.PluginStorageError: when unable to serialize the data or write it to the filesystem """ if not self._initialized: errmsg = "Unable to save, no values have been added to PluginStorage." logger.error(errmsg) raise errors.PluginStorageError(errmsg) try: serialized = json.dumps(self._data) except TypeError as e: errmsg = "Could not serialize PluginStorage data: {0}".format( str(e)) logger.error(errmsg) raise errors.PluginStorageError(errmsg) try: with os.fdopen(filesystem.open( self._storagepath, os.O_WRONLY | os.O_CREAT | os.O_TRUNC, 0o600), 'w') as fh: fh.write(serialized) except IOError as e: errmsg = "Could not write PluginStorage data to file {0} : {1}".format( self._storagepath, str(e)) logger.error(errmsg) raise errors.PluginStorageError(errmsg) def put(self, key, value): """Put configuration value to PluginStorage :param str key: Key to store the value to :param value: Data to store """ if not self._initialized: self._initialize_storage() if not self._classkey in self._data.keys(): self._data[self._classkey] = dict() self._data[self._classkey][key] = value def fetch(self, key): """Get configuration value from PluginStorage :param str key: Key to get value from the storage :raises KeyError: If the key doesn't exist in the storage """ if not self._initialized: self._initialize_storage() return self._data[self._classkey][key]
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 0755 |
|
|
__init__.py | File | 30 B | 0644 |
|
common.py | File | 18.68 KB | 0644 |
|
common_test.py | File | 14.89 KB | 0644 |
|
disco.py | File | 9.96 KB | 0644 |
|
disco_test.py | File | 11.34 KB | 0644 |
|
dns_common.py | File | 11.69 KB | 0644 |
|
dns_common_lexicon.py | File | 5.41 KB | 0644 |
|
dns_common_lexicon_test.py | File | 651 B | 0644 |
|
dns_common_test.py | File | 8.18 KB | 0644 |
|
dns_test_common.py | File | 1.65 KB | 0644 |
|
dns_test_common_lexicon.py | File | 5.48 KB | 0644 |
|
enhancements.py | File | 5.58 KB | 0644 |
|
enhancements_test.py | File | 2.36 KB | 0644 |
|
manual.py | File | 7.88 KB | 0644 |
|
manual_test.py | File | 5.6 KB | 0644 |
|
null.py | File | 1.27 KB | 0644 |
|
null_test.py | File | 624 B | 0644 |
|
selection.py | File | 13.55 KB | 0644 |
|
selection_test.py | File | 7.78 KB | 0644 |
|
standalone.py | File | 7.72 KB | 0644 |
|
standalone_test.py | File | 6.64 KB | 0644 |
|
storage.py | File | 4.14 KB | 0644 |
|
storage_test.py | File | 5.47 KB | 0644 |
|
util.py | File | 1.69 KB | 0644 |
|
util_test.py | File | 1.81 KB | 0644 |
|
webroot.py | File | 12.08 KB | 0644 |
|
webroot_test.py | File | 13.11 KB | 0644 |
|