damien
/
muk_base
mirror of https://github.com/muk-it/muk_base
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

publish muk_session_store - 12.0

pull/32/head
MuK IT GmbH 5 years ago
parent
0b276ab999
commit
73179c3b9f
3 changed files with 67 additions and 27 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 35
      muk_session_store/README.rst
  2. 35
      muk_session_store/doc/index.rst
  3. 24
      muk_session_store/store/redis.py

35
muk_session_store/README.rst
View File

@ -16,7 +16,7 @@ The requirements are only required if Redis is used as the session store.
Redis Redis
------------- -------------
A interface to the Redis key-value store for Python. To install Redis please follow the
A interface to the Redis key-value store for Python. To install Redis please follow the
`instructions <https://github.com/andymccurdy/redis-py>`_ or install the library via pip. `instructions <https://github.com/andymccurdy/redis-py>`_ or install the library via pip.
``pip install redis`` ``pip install redis``
@ -44,7 +44,7 @@ command:
The module name consists of the Odoo version and the module name, where The module name consists of the Odoo version and the module name, where
underscores are replaced by a dash. underscores are replaced by a dash.
**Module:**
**Module:**
``odoo<version>-addon-<module_name>`` ``odoo<version>-addon-<module_name>``
@ -53,7 +53,7 @@ underscores are replaced by a dash.
``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils`` ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils``
Once the installation has been successfully completed, the app is already in the Once the installation has been successfully completed, the app is already in the
correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
debug mode and update the list by clicking on the "Update Apps List" link. Now debug mode and update the list by clicking on the "Update Apps List" link. Now
install the module by clicking on the install button. install the module by clicking on the install button.
@ -62,7 +62,7 @@ using the "pip" command. To do this, enter the following command in your console
``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>`` ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
When the process is finished, restart your server and update the application in
When the process is finished, restart your server and update the application in
Odoo. The steps are the same as for the installation only the button has changed Odoo. The steps are the same as for the installation only the button has changed
from "Install" to "Upgrade". from "Install" to "Upgrade".
@ -88,7 +88,7 @@ module in the same way. Just type the following command into the console:
``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>`` ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
When the process is finished, restart your server and update the application in
When the process is finished, restart your server and update the application in
Odoo, just like you would normally. Odoo, just like you would normally.
Configuration Configuration
@ -97,34 +97,51 @@ Configuration
Since this module need to be activated even if no database is selected it should Since this module need to be activated even if no database is selected it should
be loaded right at the server start. This can be done by editing the configuration be loaded right at the server start. This can be done by editing the configuration
file or passing a load parameter to the start script. file or passing a load parameter to the start script.
Parameter: ``--load=web,muk_session_store`` Parameter: ``--load=web,muk_session_store``
The following fields can be modified in the config file: The following fields can be modified in the config file:
**Store:**
**Store:**
* session_store_database * session_store_database
* session_store_redis * session_store_redis
**Postgres:**
**Postgres:**
* session_store_dbname * session_store_dbname
* session_store_dbtable * session_store_dbtable
**Redis:**
**Redis:**
* session_store_prefix * session_store_prefix
* session_store_host * session_store_host
* session_store_port * session_store_port
* session_store_dbindex * session_store_dbindex
* session_store_pass * session_store_pass
* session_store_ssl
* session_store_ssl_cert_reqs
Usage Usage
============= =============
After setting the parameters, the session store is used automatically. After setting the parameters, the session store is used automatically.
In order to use ssl, which is a requirement of some databases, session_store_ssl
should be set to True and session_store_ssl_cert_reqs should be set to 'required'
except in the case where the server certificate does not match the host name.
e.g.
# Server has a proper certificate
session_store_ssl=True
session_store_ssl_cert_reqs=required
# Server does not have a proper certificate (AWS possibly)
session_store_ssl=True
session_store_ssl_cert_reqs=None
For more information please see the redis python module documentation.
Credits Credits
======= =======

35
muk_session_store/doc/index.rst
View File

@ -16,7 +16,7 @@ The requirements are only required if Redis is used as the session store.
Redis Redis
------------- -------------
A interface to the Redis key-value store for Python. To install Redis please follow the
A interface to the Redis key-value store for Python. To install Redis please follow the
`instructions <https://github.com/andymccurdy/redis-py>`_ or install the library via pip. `instructions <https://github.com/andymccurdy/redis-py>`_ or install the library via pip.
``pip install redis`` ``pip install redis``
@ -44,7 +44,7 @@ command:
The module name consists of the Odoo version and the module name, where The module name consists of the Odoo version and the module name, where
underscores are replaced by a dash. underscores are replaced by a dash.
**Module:**
**Module:**
``odoo<version>-addon-<module_name>`` ``odoo<version>-addon-<module_name>``
@ -53,7 +53,7 @@ underscores are replaced by a dash.
``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils`` ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils``
Once the installation has been successfully completed, the app is already in the Once the installation has been successfully completed, the app is already in the
correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
debug mode and update the list by clicking on the "Update Apps List" link. Now debug mode and update the list by clicking on the "Update Apps List" link. Now
install the module by clicking on the install button. install the module by clicking on the install button.
@ -62,7 +62,7 @@ using the "pip" command. To do this, enter the following command in your console
``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>`` ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
When the process is finished, restart your server and update the application in
When the process is finished, restart your server and update the application in
Odoo. The steps are the same as for the installation only the button has changed Odoo. The steps are the same as for the installation only the button has changed
from "Install" to "Upgrade". from "Install" to "Upgrade".
@ -88,7 +88,7 @@ module in the same way. Just type the following command into the console:
``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>`` ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
When the process is finished, restart your server and update the application in
When the process is finished, restart your server and update the application in
Odoo, just like you would normally. Odoo, just like you would normally.
Configuration Configuration
@ -97,34 +97,51 @@ Configuration
Since this module need to be activated even if no database is selected it should Since this module need to be activated even if no database is selected it should
be loaded right at the server start. This can be done by editing the configuration be loaded right at the server start. This can be done by editing the configuration
file or passing a load parameter to the start script. file or passing a load parameter to the start script.
Parameter: ``--load=web,muk_session_store`` Parameter: ``--load=web,muk_session_store``
The following fields can be modified in the config file: The following fields can be modified in the config file:
**Store:**
**Store:**
* session_store_database * session_store_database
* session_store_redis * session_store_redis
**Postgres:**
**Postgres:**
* session_store_dbname * session_store_dbname
* session_store_dbtable * session_store_dbtable
**Redis:**
**Redis:**
* session_store_prefix * session_store_prefix
* session_store_host * session_store_host
* session_store_port * session_store_port
* session_store_dbindex * session_store_dbindex
* session_store_pass * session_store_pass
* session_store_ssl
* session_store_ssl_cert_reqs
Usage Usage
============= =============
After setting the parameters, the session store is used automatically. After setting the parameters, the session store is used automatically.
In order to use ssl, which is a requirement of some databases, session_store_ssl
should be set to True and session_store_ssl_cert_reqs should be set to 'required'
except in the case where the server certificate does not match the host name.
e.g.
# Server has a proper certificate
session_store_ssl=True
session_store_ssl_cert_reqs=required
# Server does not have a proper certificate (AWS possibly)
session_store_ssl=True
session_store_ssl_cert_reqs=None
For more information please see the redis python module documentation.
Credits Credits
======= =======

24
muk_session_store/store/redis.py
View File

@ -2,7 +2,7 @@
# #
# Copyright (c) 2017-2019 MuK IT GmbH. # Copyright (c) 2017-2019 MuK IT GmbH.
# #
# This file is part of MuK Session Store
# This file is part of MuK Session Store
# (see https://mukit.at). # (see https://mukit.at).
# #
# This program is free software: you can redistribute it and/or modify # This program is free software: you can redistribute it and/or modify
@ -38,6 +38,7 @@ except ImportError:
SESSION_TIMEOUT = 60 * 60 * 24 * 7 SESSION_TIMEOUT = 60 * 60 * 24 * 7
def retry_redis(func): def retry_redis(func):
@functools.wraps(func) @functools.wraps(func)
def wrapper(self, *args, **kwargs): def wrapper(self, *args, **kwargs):
@ -48,10 +49,12 @@ def retry_redis(func):
_logger.warn("SessionStore connection failed! (%s/5)" % attempts) _logger.warn("SessionStore connection failed! (%s/5)" % attempts)
if attempts >= 5: if attempts >= 5:
raise error raise error
return wrapper return wrapper
class RedisSessionStore(SessionStore): class RedisSessionStore(SessionStore):
def __init__(self, *args, **kwargs): def __init__(self, *args, **kwargs):
super(RedisSessionStore, self).__init__(*args, **kwargs) super(RedisSessionStore, self).__init__(*args, **kwargs)
self.prefix = config.get('session_store_prefix', '') self.prefix = config.get('session_store_prefix', '')
@ -59,25 +62,27 @@ class RedisSessionStore(SessionStore):
host=config.get('session_store_host', 'localhost'), host=config.get('session_store_host', 'localhost'),
port=int(config.get('session_store_port', 6379)), port=int(config.get('session_store_port', 6379)),
db=int(config.get('session_store_dbindex', 1)), db=int(config.get('session_store_dbindex', 1)),
password=config.get('session_store_pass', None)
password=config.get('session_store_pass', None),
ssl=config.get("session_store_ssl", False),
ssl_cert_reqs=config.get("session_store_ssl_cert_reqs", None),
) )
def _encode_session_key(self, key): def _encode_session_key(self, key):
return key.encode('utf-8') if isinstance(key, str) else key return key.encode('utf-8') if isinstance(key, str) else key
def _get_session_key(self, sid): def _get_session_key(self, sid):
return self._encode_session_key(self.prefix + sid) return self._encode_session_key(self.prefix + sid)
@retry_redis @retry_redis
def save(self, session): def save(self, session):
key = self._get_session_key(session.sid) key = self._get_session_key(session.sid)
payload = pickle.dumps(dict(session), pickle.HIGHEST_PROTOCOL) payload = pickle.dumps(dict(session), pickle.HIGHEST_PROTOCOL)
self.server.setex(name=key, value=payload, time=SESSION_TIMEOUT) self.server.setex(name=key, value=payload, time=SESSION_TIMEOUT)
@retry_redis @retry_redis
def delete(self, session): def delete(self, session):
self.server.delete(self._get_session_key(session.sid)) self.server.delete(self._get_session_key(session.sid))
@retry_redis @retry_redis
def get(self, sid): def get(self, sid):
if not self.is_valid_key(sid): if not self.is_valid_key(sid):
@ -88,4 +93,5 @@ class RedisSessionStore(SessionStore):
self.server.setex(name=key, value=payload, time=SESSION_TIMEOUT) self.server.setex(name=key, value=payload, time=SESSION_TIMEOUT)
return self.session_class(pickle.loads(payload), sid, False) return self.session_class(pickle.loads(payload), sid, False)
else: else:
return self.session_class({}, sid, False)
return self.session_class({}, sid, False)
Write Preview
Loading…
Cancel
Save