publish muk_session_store - 13.0

muk_session_store/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ 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.

muk_session_store/README.rst

@@ -0,0 +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 <https://github.com/andymccurdy/redis-py>`_ 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 <https://pypi.org/project/pip/>`_).
+
+To install our modules using the package manager make sure
+`odoo-autodiscover <https://pypi.org/project/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 <module>``
+
+The module name consists of the Odoo version and the module name, where
+underscores are replaced by a dash.
+
+**Module:**
+
+``odoo<version>-addon-<module_name>``
+
+**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 <module>``
+
+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 <https://nexus.mukit.at/#browse/browse:odoo>`_
+and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
+
+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 <support@mukit.at>`_
+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 <module>``
+
+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 <mathias.markl@mukit.at>
+
+Images
+------
+
+Some pictures are based on or inspired by the icon set of Font Awesome:
+
+* `Font Awesome <https://fontawesome.com>`_
+
+
+Projects
+--------
+
+Parts of the module are inspired by:
+
+* `PSQL Session Store <https://github.com/it-projects-llc/misc-addons>`_
+
+Author & Maintainer
+-------------------
+
+This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
+
+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 <sale@mukit.at>`_
+or visit our `website  <https://mukit.at>`_.

muk_session_store/__init__.py

@@ -0,0 +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 <http://www.gnu.org/licenses/>.
+#
+###################################################################################
+
+from odoo.tools import config
+
+
+def _patch_system():
+    if "muk_session_store" in config.get("server_wide_modules"):
+        from . import patch

muk_session_store/__manifest__.py

@@ -0,0 +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 <http://www.gnu.org/licenses/>.
+#
+###################################################################################
+
+{
+    "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 <mathias.markl@mukit.at>"],
+    "depends": ["muk_utils"],
+    "data": [],
+    "images": ["static/description/banner.png"],
+    "application": False,
+    "installable": True,
+    "post_load": "_patch_system",
+}

muk_session_store/doc/changelog.rst

@@ -0,0 +1,4 @@
+`1.0.0`
+-------
+
+- Init version

muk_session_store/doc/index.rst

@@ -0,0 +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 <https://github.com/andymccurdy/redis-py>`_ 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 <https://pypi.org/project/pip/>`_).
+
+To install our modules using the package manager make sure
+`odoo-autodiscover <https://pypi.org/project/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 <module>``
+
+The module name consists of the Odoo version and the module name, where
+underscores are replaced by a dash.
+
+**Module:**
+
+``odoo<version>-addon-<module_name>``
+
+**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 <module>``
+
+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 <https://nexus.mukit.at/#browse/browse:odoo>`_
+and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
+
+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 <support@mukit.at>`_
+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 <module>``
+
+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 <mathias.markl@mukit.at>
+
+Images
+------
+
+Some pictures are based on or inspired by the icon set of Font Awesome:
+
+* `Font Awesome <https://fontawesome.com>`_
+
+
+Projects
+--------
+
+Parts of the module are inspired by:
+
+* `PSQL Session Store <https://github.com/it-projects-llc/misc-addons>`_
+
+Author & Maintainer
+-------------------
+
+This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
+
+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 <sale@mukit.at>`_
+or visit our `website  <https://mukit.at>`_.

muk_session_store/i18n/ar.po

@@ -0,0 +1,15 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 12.0-20190522\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-07-12 23:53+0000\n"
+"PO-Revision-Date: 2019-07-12 23:53+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"

muk_session_store/i18n/de.po

@@ -0,0 +1,15 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 12.0-20190522\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-07-12 23:54+0000\n"
+"PO-Revision-Date: 2019-07-12 23:54+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"

muk_session_store/i18n/es.po

@@ -0,0 +1,15 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 12.0-20190522\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-07-12 23:54+0000\n"
+"PO-Revision-Date: 2019-07-12 23:54+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"

muk_session_store/i18n/fr.po

@@ -0,0 +1,15 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 12.0-20190522\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-07-12 23:54+0000\n"
+"PO-Revision-Date: 2019-07-12 23:54+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"

muk_session_store/i18n/hi.po

@@ -0,0 +1,15 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 12.0-20190522\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-07-12 23:54+0000\n"
+"PO-Revision-Date: 2019-07-12 23:54+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"

muk_session_store/i18n/muk_session_store.pot

@@ -0,0 +1,15 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 12.0-20190522\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-07-12 23:53+0000\n"
+"PO-Revision-Date: 2019-07-12 23:53+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"

muk_session_store/i18n/nl.po

@@ -0,0 +1,15 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 12.0-20190522\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-07-12 23:55+0000\n"
+"PO-Revision-Date: 2019-07-12 23:55+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"

muk_session_store/i18n/pt.po

@@ -0,0 +1,15 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 12.0-20190522\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-07-12 23:55+0000\n"
+"PO-Revision-Date: 2019-07-12 23:55+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"

muk_session_store/i18n/ru.po

@@ -0,0 +1,15 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 12.0-20190522\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2019-07-12 23:55+0000\n"
+"PO-Revision-Date: 2019-07-12 23:55+0000\n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"

muk_session_store/patch/__init__.py

@@ -0,0 +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 <http://www.gnu.org/licenses/>.
+#
+###################################################################################
+
+from . import http

muk_session_store/patch/http.py

@@ -0,0 +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 <http://www.gnu.org/licenses/>.
+#
+###################################################################################
+
+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()

muk_session_store/requirements.txt

@@ -0,0 +1 @@
+redis==3.3.11

muk_session_store/static/description/icon.svg

@@ -0,0 +1 @@
+<?xml version="1.0" standalone="no"?><!-- Generator: Gravit.io --><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="isolation:isolate" viewBox="0 0 250 250" width="250" height="250"><defs><clipPath id="_clipPath_4mlwgYrqD3IsQZsavbFn79xyDx5ADf3Z"><rect width="250" height="250"/></clipPath></defs><g clip-path="url(#_clipPath_4mlwgYrqD3IsQZsavbFn79xyDx5ADf3Z)"><rect width="250" height="250" style="fill:rgb(0,0,0)" fill-opacity="0"/><defs><filter id="QtXs0xgjRxmKzy4annsxwI2XWPBJoalb" x="-200%" y="-200%" width="400%" height="400%" filterUnits="objectBoundingBox" color-interpolation-filters="sRGB"><feOffset xmlns="http://www.w3.org/2000/svg" in="SourceGraphic" dx="0" dy="3"/><feGaussianBlur xmlns="http://www.w3.org/2000/svg" stdDeviation="2.146804531419514" result="pf_100_offsetBlur"/><feComposite xmlns="http://www.w3.org/2000/svg" in="SourceGraphic" in2="pf_100_offsetBlur" result="pf_100_inverse" operator="out"/><feFlood xmlns="http://www.w3.org/2000/svg" flood-color="#FFFFFF" flood-opacity="0.5" result="pf_100_color"/><feComposite xmlns="http://www.w3.org/2000/svg" in="pf_100_color" in2="pf_100_inverse" operator="in" result="pf_100_shadow"/><feComposite xmlns="http://www.w3.org/2000/svg" in="pf_100_shadow" in2="SourceGraphic" operator="over" result="_out_A3Ikj06RrP4GOwe07DWLZALMARwc4JdR"/><feOffset xmlns="http://www.w3.org/2000/svg" in="_out_A3Ikj06RrP4GOwe07DWLZALMARwc4JdR" dx="0" dy="-3"/><feGaussianBlur xmlns="http://www.w3.org/2000/svg" stdDeviation="2.146804531419514" result="pf_101_offsetBlur"/><feComposite xmlns="http://www.w3.org/2000/svg" in="_out_A3Ikj06RrP4GOwe07DWLZALMARwc4JdR" in2="pf_101_offsetBlur" result="pf_101_inverse" operator="out"/><feFlood xmlns="http://www.w3.org/2000/svg" flood-color="#000000" flood-opacity="0.5" result="pf_101_color"/><feComposite xmlns="http://www.w3.org/2000/svg" in="pf_101_color" in2="pf_101_inverse" operator="in" result="pf_101_shadow"/><feComposite xmlns="http://www.w3.org/2000/svg" in="pf_101_shadow" in2="_out_A3Ikj06RrP4GOwe07DWLZALMARwc4JdR" operator="over" result="_out_WxrIX6bcba89JklnU1lRNn6ZrZ2ccQRd"/><feMerge><feMergeNode in="_out_WxrIX6bcba89JklnU1lRNn6ZrZ2ccQRd"/></feMerge></filter></defs><g filter="url(#QtXs0xgjRxmKzy4annsxwI2XWPBJoalb)"><path d="M 15 0 L 235 0 C 243.279 0 250 6.721 250 15 L 250 235 C 250 243.279 243.279 250 235 250 L 15 250 C 6.721 250 0 243.279 0 235 L 0 15 C 0 6.721 6.721 0 15 0 Z" style="stroke:none;fill:#243742;stroke-miterlimit:10;"/></g><defs><filter id="nALB1fSQGZdFRRKgQEuU3hY3RCTqMdvE" x="-200%" y="-200%" width="400%" height="400%" filterUnits="objectBoundingBox" color-interpolation-filters="sRGB"><feGaussianBlur xmlns="http://www.w3.org/2000/svg" in="SourceGraphic" stdDeviation="2.146804531419514"/><feOffset xmlns="http://www.w3.org/2000/svg" dx="-5" dy="5" result="pf_100_offsetBlur"/><feFlood xmlns="http://www.w3.org/2000/svg" flood-color="#000000" flood-opacity="0.5"/><feComposite xmlns="http://www.w3.org/2000/svg" in2="pf_100_offsetBlur" operator="in" result="pf_100_dropShadow"/><feBlend xmlns="http://www.w3.org/2000/svg" in="SourceGraphic" in2="pf_100_dropShadow" mode="normal"/></filter></defs><g filter="url(#nALB1fSQGZdFRRKgQEuU3hY3RCTqMdvE)"><path d=" M 196.545 66.596 L 196.545 81.197 C 196.545 94.064 164.499 104.559 125 104.559 C 85.501 104.559 53.455 94.064 53.455 81.197 L 53.455 66.596 C 53.455 53.729 85.501 43.234 125 43.234 C 164.499 43.234 196.545 53.729 196.545 66.596 Z  M 196.545 99.448 L 196.545 132.3 C 196.545 145.168 164.499 155.662 125 155.662 C 85.501 155.662 53.455 145.168 53.455 132.3 L 53.455 99.448 C 68.826 110.034 96.959 114.962 125 114.962 C 153.041 114.962 181.174 110.034 196.545 99.448 Z  M 196.545 150.552 L 196.545 183.404 C 196.545 196.271 164.499 206.766 125 206.766 C 85.501 206.766 53.455 196.271 53.455 183.404 L 53.455 150.552 C 68.826 161.138 96.959 166.066 125 166.066 C 153.041 166.066 181.174 161.138 196.545 150.552 Z " fill="rgb(255,255,255)"/></g></g></svg>

muk_session_store/static/description/index.html

@@ -0,0 +1,181 @@
+<section class="oe_container">
+  <div class="oe_row oe_spaced">
+    <h2 class="oe_slogan">MuK Session Store</h2>
+    <h3 class="oe_slogan">Session Store Options</h3>
+    <h4 class="oe_slogan" style="font-size: 23px;">
+      MuK IT GmbH - www.mukit.at
+    </h4>
+  </div>
+</section>
+
+<section class="oe_container">
+  <div class="oe_row oe_spaced">
+    <div class="text-justify" style="max-width: 84%; margin: 16px 8%;">
+      <h3 class="oe_slogan">Overview</h3>
+      <p class="oe_mt32">
+        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.
+      </p>
+      <p>
+        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.
+      </p>
+      <p>
+        Parameter:
+        <code>--load=web,muk_session_store</code>
+      </p>
+    </div>
+  </div>
+</section>
+
+<section class="oe_container oe_dark">
+  <div class="oe_row oe_spaced">
+    <h3 class="oe_slogan">Our Services</h3>
+    <div
+      style="display: flex; padding-top: 20px; justify-content: space-between;"
+    >
+      <div style="flex-basis: 18%;">
+        <a href="https://mukit.at/r/MQ5" target="_blank">
+          <div
+            style="width: 75px; height: 75px; border-radius: 100%; margin: auto;"
+          >
+            <img
+              src="service_implementation.png"
+              style="width: 100%; border-radius: 100%;"
+            />
+          </div>
+          <h3
+            class="oe_slogan"
+            style="text-align: center; font-size: 14px; width: 100%; margin: 0; margin-top: 14px; color: #000 !important; margin-top: 5px; opacity: 1 !important; line-height: 17px;"
+          >
+            Odoo <br />Implementation
+          </h3>
+        </a>
+      </div>
+      <div style="flex-basis: 18%;">
+        <a href="https://mukit.at/r/u7c" target="_blank">
+          <div
+            style="width: 75px; height: 75px; border-radius: 100%; margin: auto;"
+          >
+            <img
+              src="service_integration.png"
+              style="width: 100%; border-radius: 100%;"
+            />
+          </div>
+          <h3
+            class="oe_slogan"
+            style="text-align: center; font-size: 14px; width: 100%; margin: 0; margin-top: 14px; color: #000 !important; margin-top: 5px; opacity: 1 !important; line-height: 17px;"
+          >
+            Odoo <br />Integration
+          </h3>
+        </a>
+      </div>
+      <div style="flex-basis: 18%;">
+        <a href="https://mukit.at/r/xDJ" target="_blank">
+          <div
+            style="width: 75px; height: 75px; border-radius: 100%; margin: auto;"
+          >
+            <img
+              src="service_customization.png"
+              style="width: 100%; border-radius: 100%;"
+            />
+          </div>
+          <h3
+            class="oe_slogan"
+            style="text-align: center; font-size: 14px; width: 100%; margin: 0; margin-top: 14px; color: #000 !important; margin-top: 5px; opacity: 1 !important; line-height: 17px;"
+          >
+            Odoo <br />Customization
+          </h3>
+        </a>
+      </div>
+      <div style="flex-basis: 18%;">
+        <a href="	https://mukit.at/r/J3A" target="_blank">
+          <div
+            style="width: 75px; height: 75px; border-radius: 100%; margin: auto;"
+          >
+            <img
+              src="service_development.png"
+              style="width: 100%; border-radius: 100%;"
+            />
+          </div>
+          <h3
+            class="oe_slogan"
+            style="text-align: center; font-size: 14px; width: 100%; margin: 0; margin-top: 14px; color: #000 !important; margin-top: 5px; opacity: 1 !important; line-height: 17px;"
+          >
+            Odoo <br />Development
+          </h3>
+        </a>
+      </div>
+      <div style="flex-basis: 18%;">
+        <a href="	https://mukit.at/r/R1v" target="_blank">
+          <div
+            style="width: 75px; height: 75px; border-radius: 100%; margin: auto;"
+          >
+            <img
+              src="service_support.png"
+              style="width: 100%; border-radius: 100%;"
+            />
+          </div>
+          <h3
+            class="oe_slogan"
+            style="text-align: center; font-size: 14px; width: 100%; margin: 0; margin-top: 14px; color: #000 !important; margin-top: 5px; opacity: 1 !important; line-height: 17px;"
+          >
+            Odoo <br />Support
+          </h3>
+        </a>
+      </div>
+    </div>
+  </div>
+</section>
+
+<section class="oe_container" style="padding: 32px 0;">
+  <div class="oe_row oe_spaced" style="margin: auto;">
+    <div class="oe_demo oe_picture oe_screenshot">
+      <a href="https://mukit.at/r/SgN" target="_blank">
+        <img src="preview.png" />
+      </a>
+    </div>
+  </div>
+</section>
+
+<section class="oe_container oe_dark">
+  <h3 class="oe_slogan">Help and Support</h3>
+  <h5 class="oe_slogan" style="font-size: 20px;">
+    Feel free to contact us, if you need any help with your Odoo integration or
+    addiontal features.
+  </h5>
+  <div class="oe_slogan">
+    <a
+      class="btn btn-primary btn-lg mt8"
+      href="https://mukit.at"
+      target="_blank"
+    >
+      <i class="fa fa-globe"></i> Website
+    </a>
+    <a
+      class="btn btn-primary btn-lg mt8"
+      href="https://mukit.at/page/contactus"
+      target="_blank"
+    >
+      <i class="fa fa-envelope"></i> Contact Us
+    </a>
+    <a
+      class="btn btn-primary btn-lg mt8"
+      href="https://github.com/muk-it"
+      target="_blank"
+    >
+      <i class="fa fa-github"></i> Issues
+    </a>
+  </div>
+  <img
+    src="logo.png"
+    style="width: 200px; margin-bottom: 20px; display: block;"
+    class="mx-auto center-block"
+  />
+</section>

muk_session_store/store/__init__.py

@@ -0,0 +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 <http://www.gnu.org/licenses/>.
+#
+###################################################################################
+
+from . import postgres, redis

muk_session_store/store/postgres.py

@@ -0,0 +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 <http://www.gnu.org/licenses/>.
+#
+###################################################################################
+
+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';
+            """
+            )

muk_session_store/store/redis.py

@@ -0,0 +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 <http://www.gnu.org/licenses/>.
+#
+###################################################################################
+
+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)