152 lines
5 KiB
Python
152 lines
5 KiB
Python
# Copyright (C) 2013-2018 Team tiramisu (see AUTHORS for all contributors)
|
|
#
|
|
# This program is free software: you can redistribute it and/or modify it
|
|
# under the terms of the GNU Lesser General Public License as published by the
|
|
# Free Software Foundation, either version 3 of the License, or (at your
|
|
# option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful, but WITHOUT
|
|
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
|
|
# details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
# ____________________________________________________________
|
|
|
|
"""Config's informations are, by default, volatiles. This means, all values and
|
|
settings changes will be lost.
|
|
|
|
The storage is the system Tiramisu uses to communicate with various DB.
|
|
You can specified a persistent storage.
|
|
|
|
Storage is basic components used to set Config informations in DB.
|
|
The primary "entry point" class is the StorageType and it's public
|
|
configurator ``set_storage()``.
|
|
"""
|
|
|
|
|
|
from time import time
|
|
from random import randint
|
|
import os
|
|
from ..error import ConfigError
|
|
from ..i18n import _
|
|
|
|
|
|
MODULE_PATH = os.path.split(os.path.split(os.path.split(__file__)[0])[0])[1]
|
|
|
|
|
|
MEMORY_STORAGE = 'dictionary'
|
|
DEFAULT_STORAGE = MEMORY_STORAGE
|
|
|
|
|
|
class StorageType(object):
|
|
"""Object to store storage's type. If a Config is already set,
|
|
default storage is store as selected storage. You cannot change it
|
|
after.
|
|
"""
|
|
default_storage = os.environ.get('TIRAMISU_STORAGE', DEFAULT_STORAGE)
|
|
storage_type = None
|
|
mod = None
|
|
|
|
def set(self, name): # pragma: optional cover
|
|
if self.storage_type is not None: # pragma: no cover
|
|
if self.storage_type == name:
|
|
return
|
|
raise ConfigError(_('storage_type is already set, cannot rebind it'))
|
|
self.storage_type = name
|
|
|
|
def get(self):
|
|
if self.storage_type is None:
|
|
self.storage_type = self.default_storage
|
|
set_to_default = True
|
|
else:
|
|
set_to_default = False
|
|
if self.mod is None:
|
|
modulepath = '{0}.storage.{1}'.format(MODULE_PATH, self.storage_type)
|
|
try:
|
|
mod = __import__(modulepath)
|
|
except ImportError: # pragma: no cover
|
|
import traceback
|
|
traceback.print_exc()
|
|
raise SystemError(_('cannot import the storage {0}').format(
|
|
self.default_storage))
|
|
for token in modulepath.split(".")[1:]:
|
|
mod = getattr(mod, token)
|
|
self.mod = mod
|
|
return self.mod
|
|
|
|
|
|
storage_type = StorageType()
|
|
#storage_option_type = StorageType()
|
|
#storage_option_type.set(DEFAULT_STORAGE)
|
|
memory_storage = StorageType()
|
|
memory_storage.set(MEMORY_STORAGE)
|
|
|
|
|
|
def set_storage(type_, name): # pragma: optional cover
|
|
"""Change storage's configuration
|
|
|
|
:params name: is the storage name. If storage is already set, cannot
|
|
reset storage name
|
|
|
|
Other attributes are differents according to the selected storage's name
|
|
"""
|
|
storage_type.set(name)
|
|
setting = storage_type.get().setting
|
|
|
|
|
|
def get_storages(context, session_id, persistent, storage):
|
|
def gen_id(config):
|
|
return 'c' + str(id(config)) + str(int(time())) + str(randint(0, 500))
|
|
|
|
if session_id is None:
|
|
session_id = gen_id(context)
|
|
if storage is None:
|
|
storage = storage_type
|
|
imp = storage.get()
|
|
imp_storage = imp.Storage(session_id, persistent)
|
|
properties = imp.Properties(imp_storage)
|
|
permissives = imp.Permissives(imp_storage)
|
|
values = imp.Values(imp_storage)
|
|
return properties, permissives, values, session_id
|
|
|
|
|
|
def get_default_values_storages():
|
|
imp = memory_storage.get()
|
|
storage = imp.Storage('__validator_storage', persistent=False, test=True)
|
|
return imp.Values(storage)
|
|
|
|
|
|
def get_default_settings_storages():
|
|
imp = memory_storage.get()
|
|
storage = imp.Storage('__validator_storage', persistent=False, test=True)
|
|
properties = imp.Properties(storage)
|
|
permissives = imp.Permissives(storage)
|
|
return properties, permissives
|
|
|
|
|
|
def list_sessions(type_): # pragma: optional cover
|
|
"""List all available session (persistent or not persistent)
|
|
"""
|
|
#if type_ == 'option':
|
|
# return storage_option_type.get().list_sessions()
|
|
#else:
|
|
return storage_type.get().list_sessions()
|
|
|
|
|
|
def delete_session(session_id): # pragma: optional cover
|
|
"""Delete a selected session, be careful, you can deleted a session
|
|
use by an other instance
|
|
:params session_id: id of session to delete
|
|
"""
|
|
storage_module = storage_type.get()
|
|
session = storage_module.storage.getsession()
|
|
storage_module.value.delete_session(session_id)
|
|
storage_module.storage.delete_session(session_id)
|
|
if session:
|
|
session.commit()
|
|
del(session)
|
|
|
|
|
|
__all__ = ('set_storage', 'list_sessions', 'delete_session')
|