diff --git a/muk_dbfilter/__init__.py b/muk_dbfilter/__init__.py new file mode 100644 index 0000000..7981660 --- /dev/null +++ b/muk_dbfilter/__init__.py @@ -0,0 +1,25 @@ +################################################################################### +# +# Copyright (C) 2018 MuK IT GmbH +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +################################################################################### + +from odoo.tools import config + +def _patch_system(): + server_modules = config.get('server_wide_modules') or [] + if 'muk_dbfilter' in server_modules and config.get('proxy_mode'): + from . import patch diff --git a/muk_dbfilter/__manifest__.py b/muk_dbfilter/__manifest__.py new file mode 100644 index 0000000..d3013ec --- /dev/null +++ b/muk_dbfilter/__manifest__.py @@ -0,0 +1,51 @@ +################################################################################### +# +# Copyright (C) 2018 MuK IT GmbH +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +################################################################################### + +{ + "name": "MuK DB Filter", + "summary": """Headers based Database Selection""", + "version": "11.0.1.0.1", + 'category': 'Extra Tools', + 'license': 'AGPL-3', + 'author': 'MuK IT', + 'website': 'https://www.mukit.at', + 'live_test_url': 'https://demo.mukit.at/web/login', + "depends": [ + ], + "contributors": [ + "Kerrim Abdelhamed ", + "Mathias Markl " + ], + "data": [ + ], + "demo": [ + ], + "qweb": [ + ], + "images": [ + ], + "external_dependencies": { + "python": [], + "bin": [], + }, + "installable": True, + "auto_install": False, + "application": False, + "post_load": "_patch_system", +} diff --git a/muk_dbfilter/doc/changelog.rst b/muk_dbfilter/doc/changelog.rst new file mode 100644 index 0000000..33170e8 --- /dev/null +++ b/muk_dbfilter/doc/changelog.rst @@ -0,0 +1,4 @@ +`1.0.0` +------- + +- Init version \ No newline at end of file diff --git a/muk_dbfilter/doc/index.rst b/muk_dbfilter/doc/index.rst new file mode 100644 index 0000000..c7fb350 --- /dev/null +++ b/muk_dbfilter/doc/index.rst @@ -0,0 +1,126 @@ +============ +MuK DBFilter +============ + +This module allows to add additional filter criteria to the ``dbfilter`` +function using a request header. To pass a regular expression to the +filter set the ``X-Odoo-dbfilter`` header field on the request and make +sure that Odoo runs with an enabled proxy mode. + +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. 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 odoo11-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 OPL-1, you will receive access data when you purchase +the module. If the modules were not purchased directly from +`MuK IT `_ please contact our support (support@mukit.at) +with a confirmation of 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`` + +Usage +============= + +After loading the module, the ``dbfilter`` function reacts to request headers. + +Credits +======= + +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 based on or inspired by: + +* `DBFilter from Header `_ + +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 +(sale@mukit.at) or visit our website (https://mukit.at). diff --git a/muk_dbfilter/patch/__init__.py b/muk_dbfilter/patch/__init__.py new file mode 100644 index 0000000..ad1151a --- /dev/null +++ b/muk_dbfilter/patch/__init__.py @@ -0,0 +1,20 @@ +################################################################################### +# +# Copyright (C) 2018 MuK IT GmbH +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +################################################################################### + +from . import http \ No newline at end of file diff --git a/muk_dbfilter/patch/http.py b/muk_dbfilter/patch/http.py new file mode 100644 index 0000000..243f68a --- /dev/null +++ b/muk_dbfilter/patch/http.py @@ -0,0 +1,35 @@ +################################################################################### +# +# Copyright (C) 2018 MuK IT GmbH +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero 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 Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +# +################################################################################### + +import random +import logging + +from odoo import http, tools +from odoo.http import request + +from odoo.addons.muk_utils.tools.patch import monkey_patch + +_logger = logging.getLogger(__name__) + +@monkey_patch(http) +def db_filter(dbs, httprequest=None): + httprequest = httprequest or request.httprequest + dbs = db_filter.super(dbs, httprequest=httprequest) + filter = httprequest.environ.get('HTTP_X_ODOO_DBFILTER') + return [db for db in dbs if re.match(filter, db)] if filter else dbs \ No newline at end of file diff --git a/muk_dbfilter/static/description/banner.png b/muk_dbfilter/static/description/banner.png new file mode 100644 index 0000000..534951c Binary files /dev/null and b/muk_dbfilter/static/description/banner.png differ diff --git a/muk_dbfilter/static/description/icon.png b/muk_dbfilter/static/description/icon.png new file mode 100644 index 0000000..3162407 Binary files /dev/null and b/muk_dbfilter/static/description/icon.png differ diff --git a/muk_dbfilter/static/description/icon.svg b/muk_dbfilter/static/description/icon.svg new file mode 100644 index 0000000..49f373d --- /dev/null +++ b/muk_dbfilter/static/description/icon.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/muk_dbfilter/static/description/index.html b/muk_dbfilter/static/description/index.html new file mode 100644 index 0000000..689124d --- /dev/null +++ b/muk_dbfilter/static/description/index.html @@ -0,0 +1,129 @@ +
+
+

MuK DB Filter

+

Headers based Database Selection

+

MuK IT GmbH - + www.mukit.at

+
+
+ +
+
+
+

Overview

+

+ This module allows to add additional filter criteria to the + dbfilter + function using a request header. To pass a regular expression to the + filter set the + X-Odoo-dbfilter + header field on the request and make sure that Odoo runs with an + enabled proxy mode. +

+
+
+
+ +
+
+

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 + +
+ +
\ No newline at end of file diff --git a/muk_dbfilter/static/description/logo.png b/muk_dbfilter/static/description/logo.png new file mode 100644 index 0000000..9427ce3 Binary files /dev/null and b/muk_dbfilter/static/description/logo.png differ diff --git a/muk_dbfilter/static/description/preview.png b/muk_dbfilter/static/description/preview.png new file mode 100644 index 0000000..1deb1cc Binary files /dev/null and b/muk_dbfilter/static/description/preview.png differ diff --git a/muk_dbfilter/static/description/service_customization.png b/muk_dbfilter/static/description/service_customization.png new file mode 100644 index 0000000..3eac664 Binary files /dev/null and b/muk_dbfilter/static/description/service_customization.png differ diff --git a/muk_dbfilter/static/description/service_development.png b/muk_dbfilter/static/description/service_development.png new file mode 100644 index 0000000..580d460 Binary files /dev/null and b/muk_dbfilter/static/description/service_development.png differ diff --git a/muk_dbfilter/static/description/service_implementation.png b/muk_dbfilter/static/description/service_implementation.png new file mode 100644 index 0000000..d64b66b Binary files /dev/null and b/muk_dbfilter/static/description/service_implementation.png differ diff --git a/muk_dbfilter/static/description/service_integration.png b/muk_dbfilter/static/description/service_integration.png new file mode 100644 index 0000000..76c5e80 Binary files /dev/null and b/muk_dbfilter/static/description/service_integration.png differ diff --git a/muk_dbfilter/static/description/service_support.png b/muk_dbfilter/static/description/service_support.png new file mode 100644 index 0000000..4c530fa Binary files /dev/null and b/muk_dbfilter/static/description/service_support.png differ