From 265f66e2e507dec2381eb9a5b6f767ee0d32193d Mon Sep 17 00:00:00 2001 From: MuK IT GmbH Date: Sun, 13 Oct 2019 16:53:14 +0000 Subject: [PATCH] publish muk_session_store - 13.0 --- muk_session_store/LICENSE | 330 ++++++++-------- muk_session_store/README.rst | 320 ++++++++-------- muk_session_store/__init__.py | 56 +-- muk_session_store/__manifest__.py | 78 ++-- muk_session_store/doc/index.rst | 320 ++++++++-------- muk_session_store/patch/__init__.py | 46 +-- muk_session_store/patch/http.py | 190 ++++----- .../static/description/index.html | 362 +++++++++--------- muk_session_store/store/__init__.py | 46 +-- muk_session_store/store/postgres.py | 314 +++++++-------- muk_session_store/store/redis.py | 182 ++++----- 11 files changed, 1122 insertions(+), 1122 deletions(-) diff --git a/muk_session_store/LICENSE b/muk_session_store/LICENSE index 11e8067..0a04128 100644 --- a/muk_session_store/LICENSE +++ b/muk_session_store/LICENSE @@ -1,165 +1,165 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - - This version of the GNU Lesser General Public License incorporates -the terms and conditions of version 3 of the GNU General Public -License, supplemented by the additional permissions listed below. - - 0. Additional Definitions. - - As used herein, "this License" refers to version 3 of the GNU Lesser -General Public License, and the "GNU GPL" refers to version 3 of the GNU -General Public License. - - "The Library" refers to a covered work governed by this License, -other than an Application or a Combined Work as defined below. - - An "Application" is any work that makes use of an interface provided -by the Library, but which is not otherwise based on the Library. -Defining a subclass of a class defined by the Library is deemed a mode -of using an interface provided by the Library. - - A "Combined Work" is a work produced by combining or linking an -Application with the Library. The particular version of the Library -with which the Combined Work was made is also called the "Linked -Version". - - The "Minimal Corresponding Source" for a Combined Work means the -Corresponding Source for the Combined Work, excluding any source code -for portions of the Combined Work that, considered in isolation, are -based on the Application, and not on the Linked Version. - - The "Corresponding Application Code" for a Combined Work means the -object code and/or source code for the Application, including any data -and utility programs needed for reproducing the Combined Work from the -Application, but excluding the System Libraries of the Combined Work. - - 1. Exception to Section 3 of the GNU GPL. - - You may convey a covered work under sections 3 and 4 of this License -without being bound by section 3 of the GNU GPL. - - 2. Conveying Modified Versions. - - If you modify a copy of the Library, and, in your modifications, a -facility refers to a function or data to be supplied by an Application -that uses the facility (other than as an argument passed when the -facility is invoked), then you may convey a copy of the modified -version: - - a) under this License, provided that you make a good faith effort to - ensure that, in the event an Application does not supply the - function or data, the facility still operates, and performs - whatever part of its purpose remains meaningful, or - - b) under the GNU GPL, with none of the additional permissions of - this License applicable to that copy. - - 3. Object Code Incorporating Material from Library Header Files. - - The object code form of an Application may incorporate material from -a header file that is part of the Library. You may convey such object -code under terms of your choice, provided that, if the incorporated -material is not limited to numerical parameters, data structure -layouts and accessors, or small macros, inline functions and templates -(ten or fewer lines in length), you do both of the following: - - a) Give prominent notice with each copy of the object code that the - Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the object code with a copy of the GNU GPL and this license - document. - - 4. Combined Works. - - You may convey a Combined Work under terms of your choice that, -taken together, effectively do not restrict modification of the -portions of the Library contained in the Combined Work and reverse -engineering for debugging such modifications, if you also do each of -the following: - - a) Give prominent notice with each copy of the Combined Work that - the Library is used in it and that the Library and its use are - covered by this License. - - b) Accompany the Combined Work with a copy of the GNU GPL and this license - document. - - c) For a Combined Work that displays copyright notices during - execution, include the copyright notice for the Library among - these notices, as well as a reference directing the user to the - copies of the GNU GPL and this license document. - - d) Do one of the following: - - 0) Convey the Minimal Corresponding Source under the terms of this - License, and the Corresponding Application Code in a form - suitable for, and under terms that permit, the user to - recombine or relink the Application with a modified version of - the Linked Version to produce a modified Combined Work, in the - manner specified by section 6 of the GNU GPL for conveying - Corresponding Source. - - 1) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (a) uses at run time - a copy of the Library already present on the user's computer - system, and (b) will operate properly with a modified version - of the Library that is interface-compatible with the Linked - Version. - - e) Provide Installation Information, but only if you would otherwise - be required to provide such information under section 6 of the - GNU GPL, and only to the extent that such information is - necessary to install and execute a modified version of the - Combined Work produced by recombining or relinking the - Application with a modified version of the Linked Version. (If - you use option 4d0, the Installation Information must accompany - the Minimal Corresponding Source and Corresponding Application - Code. If you use option 4d1, you must provide the Installation - Information in the manner specified by section 6 of the GNU GPL - for conveying Corresponding Source.) - - 5. Combined Libraries. - - You may place library facilities that are a work based on the -Library side by side in a single library together with other library -facilities that are not Applications and are not covered by this -License, and convey such a combined library under terms of your -choice, if you do both of the following: - - a) Accompany the combined library with a copy of the same work based - on the Library, uncombined with any other library facilities, - conveyed under the terms of this License. - - b) Give prominent notice with the combined library that part of it - is a work based on the Library, and explaining where to find the - accompanying uncombined form of the same work. - - 6. Revised Versions of the GNU Lesser General Public License. - - The Free Software Foundation may publish revised and/or new versions -of the GNU Lesser General Public License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. - - Each version is given a distinguishing version number. If the -Library as you received it specifies that a certain numbered version -of the GNU Lesser General Public License "or any later version" -applies to it, you have the option of following the terms and -conditions either of that published version or of any later version -published by the Free Software Foundation. If the Library as you -received it does not specify a version number of the GNU Lesser -General Public License, you may choose any version of the GNU Lesser -General Public License ever published by the Free Software Foundation. - - If the Library as you received it specifies that a proxy can decide -whether future versions of the GNU Lesser General Public License shall -apply, that proxy's public statement of acceptance of any version is -permanent authorization for you to choose that version for the -Library. + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/muk_session_store/README.rst b/muk_session_store/README.rst index 5719ead..6b917dd 100644 --- a/muk_session_store/README.rst +++ b/muk_session_store/README.rst @@ -1,160 +1,160 @@ -================= -MuK Session Store -================= - -In a distributed system the filestore based session store of Odoo has the problem that -unwanted session timeouts occur regularly. This module offers two additional options for -the Session Store. Sessions can be stored either in a Redis database or directly in -Postgres. Both options have the advantage that the session information can also be queried -in a distributed system. - -Requirements -============ - -The requirements are only required if Redis is used as the session store. - -Redis -------------- - -A interface to the Redis key-value store for Python. To install Redis please follow the -`instructions `_ or install the library via pip. - -``pip install redis`` - -Installation -============ - -To install this module, you need to: - -Download the module and add it to your Odoo addons folder. Afterward, 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 install the module by -clicking on the install button. - -Another way to install this module is via the package management for Python -(`PyPI `_). - -To install our modules using the package manager make sure -`odoo-autodiscover `_ is installed -correctly. Note that for Odoo version 11.0 and later this is not necessary anymore. -Then open a console and install the module by entering the following command: - -``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple `` - -The module name consists of the Odoo version and the module name, where -underscores are replaced by a dash. - -**Module:** - -``odoo-addon-`` - -**Example:** - -``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo13-addon-muk-utils`` - -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 -debug mode and update the list by clicking on the "Update Apps List" link. Now -install the module by clicking on the install button. - -The biggest advantage of this variant is that you can now also update the app -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 `` - -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 -from "Install" to "Upgrade". - -You can also view available Apps directly in our `repository `_ -and find a more detailed installation guide on our `website `_. - -For modules licensed under a proprietary license, you will receive the access data after you purchased -the module. If the purchase were made at the Odoo store please contact our `support `_ -with a confirmation of the purchase to receive the corresponding access data. - -Upgrade -============ - -To upgrade this module, you need to: - -Download the module and add it to your Odoo addons folder. Restart the server -and log on to your Odoo server. Select the Apps menu and upgrade the module by -clicking on the upgrade button. - -If you installed the module using the "pip" command, you can also update the -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 `` - -When the process is finished, restart your server and update the application in -Odoo, just like you would normally. - - -Configuration -============= - -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 -file or passing a load parameter to the start script. - -Parameter: ``--load=web,muk_session_store`` - -The following fields can be modified in the config file: - -**Store:** - -* session_store_database -* session_store_redis - -**Postgres:** - -* session_store_dbname - -**Redis:** - -* session_store_prefix -* session_store_host -* session_store_port -* session_store_dbindex -* session_store_pass - -Usage -===== - -After setting the parameters, the session store is used automatically. - -Credit -====== - -Contributors ------------- - -* Mathias Markl - -Images ------- - -Some pictures are based on or inspired by the icon set of Font Awesome: - -* `Font Awesome `_ - - -Projects --------- - -Parts of the module are inspired by: - -* `PSQL Session Store `_ - -Author & Maintainer -------------------- - -This module is maintained by the `MuK IT GmbH `_. - -MuK IT is an Austrian company specialized in customizing and extending Odoo. -We develop custom solutions for your individual needs to help you focus on -your strength and expertise to grow your business. - -If you want to get in touch please contact us via `mail `_ -or visit our `website `_. +================= +MuK Session Store +================= + +In a distributed system the filestore based session store of Odoo has the problem that +unwanted session timeouts occur regularly. This module offers two additional options for +the Session Store. Sessions can be stored either in a Redis database or directly in +Postgres. Both options have the advantage that the session information can also be queried +in a distributed system. + +Requirements +============ + +The requirements are only required if Redis is used as the session store. + +Redis +------------- + +A interface to the Redis key-value store for Python. To install Redis please follow the +`instructions `_ or install the library via pip. + +``pip install redis`` + +Installation +============ + +To install this module, you need to: + +Download the module and add it to your Odoo addons folder. Afterward, 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 install the module by +clicking on the install button. + +Another way to install this module is via the package management for Python +(`PyPI `_). + +To install our modules using the package manager make sure +`odoo-autodiscover `_ is installed +correctly. Note that for Odoo version 11.0 and later this is not necessary anymore. +Then open a console and install the module by entering the following command: + +``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple `` + +The module name consists of the Odoo version and the module name, where +underscores are replaced by a dash. + +**Module:** + +``odoo-addon-`` + +**Example:** + +``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo13-addon-muk-utils`` + +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 +debug mode and update the list by clicking on the "Update Apps List" link. Now +install the module by clicking on the install button. + +The biggest advantage of this variant is that you can now also update the app +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 `` + +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 +from "Install" to "Upgrade". + +You can also view available Apps directly in our `repository `_ +and find a more detailed installation guide on our `website `_. + +For modules licensed under a proprietary license, you will receive the access data after you purchased +the module. If the purchase were made at the Odoo store please contact our `support `_ +with a confirmation of the purchase to receive the corresponding access data. + +Upgrade +============ + +To upgrade this module, you need to: + +Download the module and add it to your Odoo addons folder. Restart the server +and log on to your Odoo server. Select the Apps menu and upgrade the module by +clicking on the upgrade button. + +If you installed the module using the "pip" command, you can also update the +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 `` + +When the process is finished, restart your server and update the application in +Odoo, just like you would normally. + + +Configuration +============= + +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 +file or passing a load parameter to the start script. + +Parameter: ``--load=web,muk_session_store`` + +The following fields can be modified in the config file: + +**Store:** + +* session_store_database +* session_store_redis + +**Postgres:** + +* session_store_dbname + +**Redis:** + +* session_store_prefix +* session_store_host +* session_store_port +* session_store_dbindex +* session_store_pass + +Usage +===== + +After setting the parameters, the session store is used automatically. + +Credit +====== + +Contributors +------------ + +* Mathias Markl + +Images +------ + +Some pictures are based on or inspired by the icon set of Font Awesome: + +* `Font Awesome `_ + + +Projects +-------- + +Parts of the module are inspired by: + +* `PSQL Session Store `_ + +Author & Maintainer +------------------- + +This module is maintained by the `MuK IT GmbH `_. + +MuK IT is an Austrian company specialized in customizing and extending Odoo. +We develop custom solutions for your individual needs to help you focus on +your strength and expertise to grow your business. + +If you want to get in touch please contact us via `mail `_ +or visit our `website `_. diff --git a/muk_session_store/__init__.py b/muk_session_store/__init__.py index f92fef7..333eb93 100644 --- a/muk_session_store/__init__.py +++ b/muk_session_store/__init__.py @@ -1,28 +1,28 @@ -################################################################################### -# -# Copyright (c) 2017-2019 MuK IT GmbH. -# -# This file is part of MuK Session Store -# (see https://mukit.at). -# -# 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 . -# -################################################################################### - -from odoo.tools import config - - -def _patch_system(): - if "muk_session_store" in config.get("server_wide_modules"): - from . import patch +################################################################################### +# +# Copyright (c) 2017-2019 MuK IT GmbH. +# +# This file is part of MuK Session Store +# (see https://mukit.at). +# +# 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 . +# +################################################################################### + +from odoo.tools import config + + +def _patch_system(): + if "muk_session_store" in config.get("server_wide_modules"): + from . import patch diff --git a/muk_session_store/__manifest__.py b/muk_session_store/__manifest__.py index 5135c78..94c1d6c 100644 --- a/muk_session_store/__manifest__.py +++ b/muk_session_store/__manifest__.py @@ -1,39 +1,39 @@ -################################################################################### -# -# Copyright (c) 2017-2019 MuK IT GmbH. -# -# This file is part of MuK Session Store -# (see https://mukit.at). -# -# 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 . -# -################################################################################### - -{ - "name": "MuK Session Store", - "summary": """Session Store Options""", - "version": "13.0.1.0.0", - "category": "Extra Tools", - "license": "LGPL-3", - "website": "http://www.mukit.at", - "live_test_url": "https://mukit.at/r/SgN", - "author": "MuK IT", - "contributors": ["Mathias Markl "], - "depends": ["muk_utils"], - "data": [], - "images": ["static/description/banner.png"], - "application": False, - "installable": True, - "post_load": "_patch_system", -} +################################################################################### +# +# Copyright (c) 2017-2019 MuK IT GmbH. +# +# This file is part of MuK Session Store +# (see https://mukit.at). +# +# 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 . +# +################################################################################### + +{ + "name": "MuK Session Store", + "summary": """Session Store Options""", + "version": "13.0.1.0.0", + "category": "Extra Tools", + "license": "LGPL-3", + "website": "http://www.mukit.at", + "live_test_url": "https://mukit.at/r/SgN", + "author": "MuK IT", + "contributors": ["Mathias Markl "], + "depends": ["muk_utils"], + "data": [], + "images": ["static/description/banner.png"], + "application": False, + "installable": True, + "post_load": "_patch_system", +} diff --git a/muk_session_store/doc/index.rst b/muk_session_store/doc/index.rst index 5719ead..6b917dd 100644 --- a/muk_session_store/doc/index.rst +++ b/muk_session_store/doc/index.rst @@ -1,160 +1,160 @@ -================= -MuK Session Store -================= - -In a distributed system the filestore based session store of Odoo has the problem that -unwanted session timeouts occur regularly. This module offers two additional options for -the Session Store. Sessions can be stored either in a Redis database or directly in -Postgres. Both options have the advantage that the session information can also be queried -in a distributed system. - -Requirements -============ - -The requirements are only required if Redis is used as the session store. - -Redis -------------- - -A interface to the Redis key-value store for Python. To install Redis please follow the -`instructions `_ or install the library via pip. - -``pip install redis`` - -Installation -============ - -To install this module, you need to: - -Download the module and add it to your Odoo addons folder. Afterward, 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 install the module by -clicking on the install button. - -Another way to install this module is via the package management for Python -(`PyPI `_). - -To install our modules using the package manager make sure -`odoo-autodiscover `_ is installed -correctly. Note that for Odoo version 11.0 and later this is not necessary anymore. -Then open a console and install the module by entering the following command: - -``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple `` - -The module name consists of the Odoo version and the module name, where -underscores are replaced by a dash. - -**Module:** - -``odoo-addon-`` - -**Example:** - -``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo13-addon-muk-utils`` - -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 -debug mode and update the list by clicking on the "Update Apps List" link. Now -install the module by clicking on the install button. - -The biggest advantage of this variant is that you can now also update the app -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 `` - -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 -from "Install" to "Upgrade". - -You can also view available Apps directly in our `repository `_ -and find a more detailed installation guide on our `website `_. - -For modules licensed under a proprietary license, you will receive the access data after you purchased -the module. If the purchase were made at the Odoo store please contact our `support `_ -with a confirmation of the purchase to receive the corresponding access data. - -Upgrade -============ - -To upgrade this module, you need to: - -Download the module and add it to your Odoo addons folder. Restart the server -and log on to your Odoo server. Select the Apps menu and upgrade the module by -clicking on the upgrade button. - -If you installed the module using the "pip" command, you can also update the -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 `` - -When the process is finished, restart your server and update the application in -Odoo, just like you would normally. - - -Configuration -============= - -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 -file or passing a load parameter to the start script. - -Parameter: ``--load=web,muk_session_store`` - -The following fields can be modified in the config file: - -**Store:** - -* session_store_database -* session_store_redis - -**Postgres:** - -* session_store_dbname - -**Redis:** - -* session_store_prefix -* session_store_host -* session_store_port -* session_store_dbindex -* session_store_pass - -Usage -===== - -After setting the parameters, the session store is used automatically. - -Credit -====== - -Contributors ------------- - -* Mathias Markl - -Images ------- - -Some pictures are based on or inspired by the icon set of Font Awesome: - -* `Font Awesome `_ - - -Projects --------- - -Parts of the module are inspired by: - -* `PSQL Session Store `_ - -Author & Maintainer -------------------- - -This module is maintained by the `MuK IT GmbH `_. - -MuK IT is an Austrian company specialized in customizing and extending Odoo. -We develop custom solutions for your individual needs to help you focus on -your strength and expertise to grow your business. - -If you want to get in touch please contact us via `mail `_ -or visit our `website `_. +================= +MuK Session Store +================= + +In a distributed system the filestore based session store of Odoo has the problem that +unwanted session timeouts occur regularly. This module offers two additional options for +the Session Store. Sessions can be stored either in a Redis database or directly in +Postgres. Both options have the advantage that the session information can also be queried +in a distributed system. + +Requirements +============ + +The requirements are only required if Redis is used as the session store. + +Redis +------------- + +A interface to the Redis key-value store for Python. To install Redis please follow the +`instructions `_ or install the library via pip. + +``pip install redis`` + +Installation +============ + +To install this module, you need to: + +Download the module and add it to your Odoo addons folder. Afterward, 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 install the module by +clicking on the install button. + +Another way to install this module is via the package management for Python +(`PyPI `_). + +To install our modules using the package manager make sure +`odoo-autodiscover `_ is installed +correctly. Note that for Odoo version 11.0 and later this is not necessary anymore. +Then open a console and install the module by entering the following command: + +``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple `` + +The module name consists of the Odoo version and the module name, where +underscores are replaced by a dash. + +**Module:** + +``odoo-addon-`` + +**Example:** + +``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo13-addon-muk-utils`` + +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 +debug mode and update the list by clicking on the "Update Apps List" link. Now +install the module by clicking on the install button. + +The biggest advantage of this variant is that you can now also update the app +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 `` + +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 +from "Install" to "Upgrade". + +You can also view available Apps directly in our `repository `_ +and find a more detailed installation guide on our `website `_. + +For modules licensed under a proprietary license, you will receive the access data after you purchased +the module. If the purchase were made at the Odoo store please contact our `support `_ +with a confirmation of the purchase to receive the corresponding access data. + +Upgrade +============ + +To upgrade this module, you need to: + +Download the module and add it to your Odoo addons folder. Restart the server +and log on to your Odoo server. Select the Apps menu and upgrade the module by +clicking on the upgrade button. + +If you installed the module using the "pip" command, you can also update the +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 `` + +When the process is finished, restart your server and update the application in +Odoo, just like you would normally. + + +Configuration +============= + +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 +file or passing a load parameter to the start script. + +Parameter: ``--load=web,muk_session_store`` + +The following fields can be modified in the config file: + +**Store:** + +* session_store_database +* session_store_redis + +**Postgres:** + +* session_store_dbname + +**Redis:** + +* session_store_prefix +* session_store_host +* session_store_port +* session_store_dbindex +* session_store_pass + +Usage +===== + +After setting the parameters, the session store is used automatically. + +Credit +====== + +Contributors +------------ + +* Mathias Markl + +Images +------ + +Some pictures are based on or inspired by the icon set of Font Awesome: + +* `Font Awesome `_ + + +Projects +-------- + +Parts of the module are inspired by: + +* `PSQL Session Store `_ + +Author & Maintainer +------------------- + +This module is maintained by the `MuK IT GmbH `_. + +MuK IT is an Austrian company specialized in customizing and extending Odoo. +We develop custom solutions for your individual needs to help you focus on +your strength and expertise to grow your business. + +If you want to get in touch please contact us via `mail `_ +or visit our `website `_. diff --git a/muk_session_store/patch/__init__.py b/muk_session_store/patch/__init__.py index 60c7bcd..e6a77ad 100644 --- a/muk_session_store/patch/__init__.py +++ b/muk_session_store/patch/__init__.py @@ -1,23 +1,23 @@ -################################################################################### -# -# Copyright (c) 2017-2019 MuK IT GmbH. -# -# This file is part of MuK Session Store -# (see https://mukit.at). -# -# 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 . -# -################################################################################### - -from . import http +################################################################################### +# +# Copyright (c) 2017-2019 MuK IT GmbH. +# +# This file is part of MuK Session Store +# (see https://mukit.at). +# +# 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 . +# +################################################################################### + +from . import http diff --git a/muk_session_store/patch/http.py b/muk_session_store/patch/http.py index a0ef216..bb02505 100644 --- a/muk_session_store/patch/http.py +++ b/muk_session_store/patch/http.py @@ -1,95 +1,95 @@ -################################################################################### -# -# Copyright (c) 2017-2019 MuK IT GmbH. -# -# This file is part of MuK Session Store -# (see https://mukit.at). -# -# 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 . -# -################################################################################### - -import logging -import random - -from odoo import http, tools -from odoo.addons.muk_session_store.store.postgres import PostgresSessionStore -from odoo.addons.muk_session_store.store.redis import RedisSessionStore -from odoo.addons.muk_utils.tools.patch import monkey_patch -from odoo.http import request -from odoo.tools.func import lazy_property - -_logger = logging.getLogger(__name__) - -try: - import redis -except ImportError: - if tools.config.get("session_store_redis"): - _logger.warning("The Python library redis is not installed.") - redis = False - - -def get_session_store_database(): - return tools.config.get("session_store_dbname", "session_store") - - -@monkey_patch(http) -def db_monodb(httprequest=None): - if tools.config.get("session_store_database"): - httprequest = httprequest or request.httprequest - dbs = http.db_list(True, httprequest) - store = get_session_store_database() - db_session = httprequest.session.db - if db_session in dbs: - return db_session - if store in dbs: - dbs.remove(store) - if len(dbs) == 1: - return dbs[0] - return None - else: - return db_monodb.super(httprequest) - - -@monkey_patch(http) -def db_filter(dbs, httprequest=None): - dbs = db_filter.super(dbs, httprequest=httprequest) - store = get_session_store_database() - if store in dbs: - dbs.remove(store) - return dbs - - -@monkey_patch(http) -def session_gc(session_store): - if tools.config.get("session_store_database"): - if random.random() < 0.001: - session_store.clean() - elif tools.config.get("session_store_redis"): - pass - else: - session_gc.super(session_store) - - -class Root(http.Root): - @lazy_property - def session_store(self): - if tools.config.get("session_store_database"): - return PostgresSessionStore(session_class=http.OpenERPSession) - elif tools.config.get("session_store_redis") and redis: - return RedisSessionStore(session_class=http.OpenERPSession) - return super(Root, self).session_store - - -http.root = Root() +################################################################################### +# +# Copyright (c) 2017-2019 MuK IT GmbH. +# +# This file is part of MuK Session Store +# (see https://mukit.at). +# +# 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 . +# +################################################################################### + +import logging +import random + +from odoo import http, tools +from odoo.addons.muk_session_store.store.postgres import PostgresSessionStore +from odoo.addons.muk_session_store.store.redis import RedisSessionStore +from odoo.addons.muk_utils.tools.patch import monkey_patch +from odoo.http import request +from odoo.tools.func import lazy_property + +_logger = logging.getLogger(__name__) + +try: + import redis +except ImportError: + if tools.config.get("session_store_redis"): + _logger.warning("The Python library redis is not installed.") + redis = False + + +def get_session_store_database(): + return tools.config.get("session_store_dbname", "session_store") + + +@monkey_patch(http) +def db_monodb(httprequest=None): + if tools.config.get("session_store_database"): + httprequest = httprequest or request.httprequest + dbs = http.db_list(True, httprequest) + store = get_session_store_database() + db_session = httprequest.session.db + if db_session in dbs: + return db_session + if store in dbs: + dbs.remove(store) + if len(dbs) == 1: + return dbs[0] + return None + else: + return db_monodb.super(httprequest) + + +@monkey_patch(http) +def db_filter(dbs, httprequest=None): + dbs = db_filter.super(dbs, httprequest=httprequest) + store = get_session_store_database() + if store in dbs: + dbs.remove(store) + return dbs + + +@monkey_patch(http) +def session_gc(session_store): + if tools.config.get("session_store_database"): + if random.random() < 0.001: + session_store.clean() + elif tools.config.get("session_store_redis"): + pass + else: + session_gc.super(session_store) + + +class Root(http.Root): + @lazy_property + def session_store(self): + if tools.config.get("session_store_database"): + return PostgresSessionStore(session_class=http.OpenERPSession) + elif tools.config.get("session_store_redis") and redis: + return RedisSessionStore(session_class=http.OpenERPSession) + return super(Root, self).session_store + + +http.root = Root() diff --git a/muk_session_store/static/description/index.html b/muk_session_store/static/description/index.html index 702dbdf..d103827 100644 --- a/muk_session_store/static/description/index.html +++ b/muk_session_store/static/description/index.html @@ -1,181 +1,181 @@ -
-
-

MuK Session Store

-

Session Store Options

-

- MuK IT GmbH - www.mukit.at -

-
-
- -
-
-
-

Overview

-

- In a distributed system the filestore based session store of Odoo has - the problem that unwanted session timeouts occur regularly. This module - offers two additional options for the Session Store. Sessions can be - stored either in a Redis database or directly in Postgres. Both options - have the advantage that the session information can also be queried in a - distributed system. -

-

- 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 file or passing a load parameter to the start - script. -

-

- Parameter: - --load=web,muk_session_store -

-
-
-
- -
-
-

Our Services

- -
-
- -
-
-
- - - -
-
-
- -
-

Help and Support

-
- Feel free to contact us, if you need any help with your Odoo integration or - addiontal features. -
-
- - Website - - - Contact Us - - - Issues - -
- -
+
+
+

MuK Session Store

+

Session Store Options

+

+ MuK IT GmbH - www.mukit.at +

+
+
+ +
+
+
+

Overview

+

+ In a distributed system the filestore based session store of Odoo has + the problem that unwanted session timeouts occur regularly. This module + offers two additional options for the Session Store. Sessions can be + stored either in a Redis database or directly in Postgres. Both options + have the advantage that the session information can also be queried in a + distributed system. +

+

+ 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 file or passing a load parameter to the start + script. +

+

+ Parameter: + --load=web,muk_session_store +

+
+
+
+ +
+
+

Our Services

+ +
+
+ +
+
+
+ + + +
+
+
+ +
+

Help and Support

+
+ Feel free to contact us, if you need any help with your Odoo integration or + addiontal features. +
+
+ + Website + + + Contact Us + + + Issues + +
+ +
diff --git a/muk_session_store/store/__init__.py b/muk_session_store/store/__init__.py index e991d03..2454122 100644 --- a/muk_session_store/store/__init__.py +++ b/muk_session_store/store/__init__.py @@ -1,23 +1,23 @@ -################################################################################### -# -# Copyright (c) 2017-2019 MuK IT GmbH. -# -# This file is part of MuK Session Store -# (see https://mukit.at). -# -# 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 . -# -################################################################################### - -from . import postgres, redis +################################################################################### +# +# Copyright (c) 2017-2019 MuK IT GmbH. +# +# This file is part of MuK Session Store +# (see https://mukit.at). +# +# 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 . +# +################################################################################### + +from . import postgres, redis diff --git a/muk_session_store/store/postgres.py b/muk_session_store/store/postgres.py index 92e137b..ca8dd75 100644 --- a/muk_session_store/store/postgres.py +++ b/muk_session_store/store/postgres.py @@ -1,157 +1,157 @@ -################################################################################### -# -# Copyright (c) 2017-2019 MuK IT GmbH. -# -# This file is part of MuK Session Store -# (see https://mukit.at). -# -# 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 . -# -################################################################################### - -import functools -import json -import logging -from contextlib import contextmanager -from datetime import datetime - -import psycopg2 -from odoo.sql_db import db_connect -from odoo.tools import config -from werkzeug.contrib.sessions import SessionStore - -_logger = logging.getLogger(__name__) - - -def retry_database(func): - @functools.wraps(func) - def wrapper(self, *args, **kwargs): - for attempts in range(1, 6): - try: - return func(self, *args, **kwargs) - except psycopg2.InterfaceError as error: - _logger.warn("SessionStore connection failed! (%s/5)" % attempts) - if attempts >= 5: - raise error - - return wrapper - - -class PostgresSessionStore(SessionStore): - def __init__(self, *args, **kwargs): - super(PostgresSessionStore, self).__init__(*args, **kwargs) - self.dbname = config.get("session_store_dbname", "session_store") - self._setup_database(raise_exception=False) - - def _setup_database(self, raise_exception=True): - try: - with db_connect(self.dbname, allow_uri=True).cursor() as cursor: - cursor.autocommit(True) - self._create_table(cursor) - except: - self._create_database() - self._setup_database() - - def _create_database(self): - with db_connect("postgres").cursor() as cursor: - cursor.autocommit(True) - cursor.execute( - """ - CREATE DATABASE {dbname} - ENCODING 'unicode' - TEMPLATE 'template0'; - """.format( - dbname=self.dbname - ) - ) - - def _create_table(self, cursor): - cursor.execute( - """ - CREATE TABLE IF NOT EXISTS sessions ( - sid varchar PRIMARY KEY, - write_date timestamp without time zone NOT NULL, - payload text NOT NULL - ); - """ - ) - - @contextmanager - def open_cursor(self): - connection = db_connect(self.dbname, allow_uri=True) - cursor = connection.cursor() - cursor.autocommit(True) - yield cursor - cursor.close() - - @retry_database - def save(self, session): - with self.open_cursor() as cursor: - cursor.execute( - """ - INSERT INTO sessions (sid, write_date, payload) - VALUES (%(sid)s, now() at time zone 'UTC', %(payload)s) - ON CONFLICT (sid) - DO UPDATE SET payload = %(payload)s, write_date = now() at time zone 'UTC'; - """, - dict(sid=session.sid, payload=json.dumps(dict(session))), - ) - - @retry_database - def delete(self, session): - with self.open_cursor() as cursor: - cursor.execute("DELETE FROM sessions WHERE sid=%s;", [session.sid]) - - @retry_database - def get(self, sid): - if not self.is_valid_key(sid): - return self.new() - with self.open_cursor() as cursor: - cursor.execute( - """ - SELECT payload, write_date - FROM sessions WHERE sid=%s; - """, - [sid], - ) - try: - payload, write_date = cursor.fetchone() - if write_date.date() != datetime.today().date(): - cursor.execute( - """ - UPDATE sessions - SET write_date = now() at time zone 'UTC' - WHERE sid=%s; - """, - [sid], - ) - return self.session_class(json.loads(payload), sid, False) - except Exception: - return self.session_class({}, sid, False) - - @retry_database - def list(self): - with self.open_cursor() as cursor: - cursor.execute("SELECT sid FROM sessions;") - return [record[0] for record in cursor.fetchall()] - - @retry_database - def clean(self): - with self.open_cursor() as cursor: - cursor.execute( - """ - DELETE FROM sessions - WHERE now() at time zone 'UTC' - write_date > '7 days'; - """ - ) +################################################################################### +# +# Copyright (c) 2017-2019 MuK IT GmbH. +# +# This file is part of MuK Session Store +# (see https://mukit.at). +# +# 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 . +# +################################################################################### + +import functools +import json +import logging +from contextlib import contextmanager +from datetime import datetime + +import psycopg2 +from odoo.sql_db import db_connect +from odoo.tools import config +from werkzeug.contrib.sessions import SessionStore + +_logger = logging.getLogger(__name__) + + +def retry_database(func): + @functools.wraps(func) + def wrapper(self, *args, **kwargs): + for attempts in range(1, 6): + try: + return func(self, *args, **kwargs) + except psycopg2.InterfaceError as error: + _logger.warn("SessionStore connection failed! (%s/5)" % attempts) + if attempts >= 5: + raise error + + return wrapper + + +class PostgresSessionStore(SessionStore): + def __init__(self, *args, **kwargs): + super(PostgresSessionStore, self).__init__(*args, **kwargs) + self.dbname = config.get("session_store_dbname", "session_store") + self._setup_database(raise_exception=False) + + def _setup_database(self, raise_exception=True): + try: + with db_connect(self.dbname, allow_uri=True).cursor() as cursor: + cursor.autocommit(True) + self._create_table(cursor) + except: + self._create_database() + self._setup_database() + + def _create_database(self): + with db_connect("postgres").cursor() as cursor: + cursor.autocommit(True) + cursor.execute( + """ + CREATE DATABASE {dbname} + ENCODING 'unicode' + TEMPLATE 'template0'; + """.format( + dbname=self.dbname + ) + ) + + def _create_table(self, cursor): + cursor.execute( + """ + CREATE TABLE IF NOT EXISTS sessions ( + sid varchar PRIMARY KEY, + write_date timestamp without time zone NOT NULL, + payload text NOT NULL + ); + """ + ) + + @contextmanager + def open_cursor(self): + connection = db_connect(self.dbname, allow_uri=True) + cursor = connection.cursor() + cursor.autocommit(True) + yield cursor + cursor.close() + + @retry_database + def save(self, session): + with self.open_cursor() as cursor: + cursor.execute( + """ + INSERT INTO sessions (sid, write_date, payload) + VALUES (%(sid)s, now() at time zone 'UTC', %(payload)s) + ON CONFLICT (sid) + DO UPDATE SET payload = %(payload)s, write_date = now() at time zone 'UTC'; + """, + dict(sid=session.sid, payload=json.dumps(dict(session))), + ) + + @retry_database + def delete(self, session): + with self.open_cursor() as cursor: + cursor.execute("DELETE FROM sessions WHERE sid=%s;", [session.sid]) + + @retry_database + def get(self, sid): + if not self.is_valid_key(sid): + return self.new() + with self.open_cursor() as cursor: + cursor.execute( + """ + SELECT payload, write_date + FROM sessions WHERE sid=%s; + """, + [sid], + ) + try: + payload, write_date = cursor.fetchone() + if write_date.date() != datetime.today().date(): + cursor.execute( + """ + UPDATE sessions + SET write_date = now() at time zone 'UTC' + WHERE sid=%s; + """, + [sid], + ) + return self.session_class(json.loads(payload), sid, False) + except Exception: + return self.session_class({}, sid, False) + + @retry_database + def list(self): + with self.open_cursor() as cursor: + cursor.execute("SELECT sid FROM sessions;") + return [record[0] for record in cursor.fetchall()] + + @retry_database + def clean(self): + with self.open_cursor() as cursor: + cursor.execute( + """ + DELETE FROM sessions + WHERE now() at time zone 'UTC' - write_date > '7 days'; + """ + ) diff --git a/muk_session_store/store/redis.py b/muk_session_store/store/redis.py index 72110fb..e5ea936 100644 --- a/muk_session_store/store/redis.py +++ b/muk_session_store/store/redis.py @@ -1,91 +1,91 @@ -################################################################################### -# -# Copyright (c) 2017-2019 MuK IT GmbH. -# -# This file is part of MuK Session Store -# (see https://mukit.at). -# -# 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 . -# -################################################################################### - -import functools -import logging -import pickle - -from odoo.tools import config -from werkzeug.contrib.sessions import SessionStore - -_logger = logging.getLogger(__name__) - -try: - import redis -except ImportError: - pass - -SESSION_TIMEOUT = 60 * 60 * 24 * 7 - - -def retry_redis(func): - @functools.wraps(func) - def wrapper(self, *args, **kwargs): - for attempts in range(1, 6): - try: - return func(self, *args, **kwargs) - except redis.ConnectionError as error: - _logger.warn("SessionStore connection failed! (%s/5)" % attempts) - if attempts >= 5: - raise error - - return wrapper - - -class RedisSessionStore(SessionStore): - def __init__(self, *args, **kwargs): - super(RedisSessionStore, self).__init__(*args, **kwargs) - self.prefix = config.get("session_store_prefix", "") - self.server = redis.Redis( - host=config.get("session_store_host", "localhost"), - port=int(config.get("session_store_port", 6379)), - db=int(config.get("session_store_dbindex", 1)), - password=config.get("session_store_pass", None), - ) - - def _encode_session_key(self, key): - return key.encode("utf-8") if isinstance(key, str) else key - - def _get_session_key(self, sid): - return self._encode_session_key(self.prefix + sid) - - @retry_redis - def save(self, session): - key = self._get_session_key(session.sid) - payload = pickle.dumps(dict(session), pickle.HIGHEST_PROTOCOL) - self.server.setex(name=key, value=payload, time=SESSION_TIMEOUT) - - @retry_redis - def delete(self, session): - self.server.delete(self._get_session_key(session.sid)) - - @retry_redis - def get(self, sid): - if not self.is_valid_key(sid): - return self.new() - key = self._get_session_key(sid) - payload = self.server.get(key) - if payload: - self.server.setex(name=key, value=payload, time=SESSION_TIMEOUT) - return self.session_class(pickle.loads(payload), sid, False) - else: - return self.session_class({}, sid, False) +################################################################################### +# +# Copyright (c) 2017-2019 MuK IT GmbH. +# +# This file is part of MuK Session Store +# (see https://mukit.at). +# +# 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 . +# +################################################################################### + +import functools +import logging +import pickle + +from odoo.tools import config +from werkzeug.contrib.sessions import SessionStore + +_logger = logging.getLogger(__name__) + +try: + import redis +except ImportError: + pass + +SESSION_TIMEOUT = 60 * 60 * 24 * 7 + + +def retry_redis(func): + @functools.wraps(func) + def wrapper(self, *args, **kwargs): + for attempts in range(1, 6): + try: + return func(self, *args, **kwargs) + except redis.ConnectionError as error: + _logger.warn("SessionStore connection failed! (%s/5)" % attempts) + if attempts >= 5: + raise error + + return wrapper + + +class RedisSessionStore(SessionStore): + def __init__(self, *args, **kwargs): + super(RedisSessionStore, self).__init__(*args, **kwargs) + self.prefix = config.get("session_store_prefix", "") + self.server = redis.Redis( + host=config.get("session_store_host", "localhost"), + port=int(config.get("session_store_port", 6379)), + db=int(config.get("session_store_dbindex", 1)), + password=config.get("session_store_pass", None), + ) + + def _encode_session_key(self, key): + return key.encode("utf-8") if isinstance(key, str) else key + + def _get_session_key(self, sid): + return self._encode_session_key(self.prefix + sid) + + @retry_redis + def save(self, session): + key = self._get_session_key(session.sid) + payload = pickle.dumps(dict(session), pickle.HIGHEST_PROTOCOL) + self.server.setex(name=key, value=payload, time=SESSION_TIMEOUT) + + @retry_redis + def delete(self, session): + self.server.delete(self._get_session_key(session.sid)) + + @retry_redis + def get(self, sid): + if not self.is_valid_key(sid): + return self.new() + key = self._get_session_key(sid) + payload = self.server.get(key) + if payload: + self.server.setex(name=key, value=payload, time=SESSION_TIMEOUT) + return self.session_class(pickle.loads(payload), sid, False) + else: + return self.session_class({}, sid, False)