[18.0][MIG] dbfilter_from_header: Migration to 18.0

dbfilter_from_header/README.rst

@@ -0,0 +1,128 @@
+====================
+dbfilter_from_header
+====================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:4267001fede7fa7c4b44dee1b4642d3f1512b6b6e4d29351c08cc6d62350f3fd
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-tools/tree/18.0/dbfilter_from_header
+    :alt: OCA/server-tools
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/server-tools-18-0/server-tools-18-0-dbfilter_from_header
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=18.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This addon lets you pass a dbfilter as a HTTP header.
+
+This is interesting for setups where database names can't be mapped to
+proxied host names.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Installation
+============
+
+To install this module, you only need to add it to your addons, and load
+it as a server-wide module.
+
+This can be done with the ``server_wide_modules`` parameter in
+``/etc/odoo.conf`` or with the ``--load`` command-line parameter
+
+``server_wide_modules = base,web,dbfilter_from_header``
+
+Configuration
+=============
+
+Please keep in mind that the standard odoo dbfilter configuration is
+still applied before looking at the regular expression in the header.
+
+-  For nginx, use:
+
+   ``proxy_set_header X-Odoo-dbfilter [your filter regex];``
+
+-  For caddy, use:
+
+   ``proxy_header X-Odoo-dbfilter [your filter regex]``
+
+-  For Apache, use:
+
+   ``RequestHeader set X-Odoo-dbfilter [your filter regex]``
+
+And make sure that proxy mode is enabled in Odoo's configuration file:
+
+``proxy_mode = True``
+
+Usage
+=====
+
+To use this module, you need to complete installation and configuration
+parts.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20dbfilter_from_header%0Aversion:%2018.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+-------
+
+* Therp BV
+
+Contributors
+------------
+
+-  Stéphane Bidoul <[email protected]>
+-  Yannick Vaucher <[email protected]>
+-  Alexandre Fayolle <[email protected]>
+-  Holger Brunn <[email protected]>
+-  Laurent Mignon (aka lmi) <[email protected]>
+-  Sandy Carter <[email protected]>
+-  Fabio Vilchez <[email protected]>
+-  Jos De Graeve <[email protected]>
+-  Lai Tim Siu (Quaritle Limited) <[email protected]>
+-  Tharathip Chaweewongphan <[email protected]>
+-  Eric Antones <[email protected]>
+
+Maintainers
+-----------
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/18.0/dbfilter_from_header>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

dbfilter_from_header/__init__.py

@@ -0,0 +1 @@
+from . import override

dbfilter_from_header/__manifest__.py

@@ -0,0 +1,17 @@
+# © 2013  Therp BV
+# © 2014  ACSONE SA/NV
+# Copyright 2018 Quartile Limited
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+{
+    "name": "dbfilter_from_header",
+    "summary": "Filter databases with HTTP headers",
+    "version": "18.0.1.0.0",
+    "website": "https://github.com/OCA/server-tools",
+    "author": "Therp BV, Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "category": "Tools",
+    "depends": ["web"],
+    "auto_install": False,
+    "installable": True,
+}

dbfilter_from_header/i18n/dbfilter_from_header.pot

@@ -0,0 +1,13 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 17.0\n"
+"Report-Msgid-Bugs-To: \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"

dbfilter_from_header/i18n/it.po

@@ -0,0 +1,14 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 17.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: Automatically generated\n"
+"Language-Team: none\n"
+"Language: it\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: nplurals=2; plural=n != 1;\n"

dbfilter_from_header/override.py

@@ -0,0 +1,29 @@
+# © 2013  Therp BV
+# © 2014  ACSONE SA/NV
+# Copyright 2018 Quartile Limited
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+import logging
+import re
+
+from odoo import http
+from odoo.tools import config
+
+db_filter_org = http.db_filter
+
+
+def db_filter(dbs, host=None):
+    dbs = db_filter_org(dbs, host)
+    httprequest = http.request.httprequest
+    db_filter_hdr = httprequest.environ.get("HTTP_X_ODOO_DBFILTER")
+    if db_filter_hdr:
+        dbs = [db for db in dbs if re.match(db_filter_hdr, db)]
+    return dbs
+
+
+if config.get("proxy_mode") and "dbfilter_from_header" in config.get(
+    "server_wide_modules"
+):
+    _logger = logging.getLogger(__name__)
+    _logger.info("monkey patching http.db_filter")
+    http.db_filter = db_filter

dbfilter_from_header/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

dbfilter_from_header/readme/CONFIGURE.md

@@ -0,0 +1,18 @@
+Please keep in mind that the standard odoo dbfilter configuration is
+still applied before looking at the regular expression in the header.
+
+- For nginx, use:
+
+  `proxy_set_header X-Odoo-dbfilter [your filter regex];`
+
+- For caddy, use:
+
+  `proxy_header X-Odoo-dbfilter [your filter regex]`
+
+- For Apache, use:
+
+  `RequestHeader set X-Odoo-dbfilter [your filter regex]`
+
+And make sure that proxy mode is enabled in Odoo's configuration file:
+
+`proxy_mode = True`

dbfilter_from_header/readme/CONTRIBUTORS.md

@@ -0,0 +1,11 @@
+- Stéphane Bidoul \<<[email protected]>\>
+- Yannick Vaucher \<<[email protected]>\>
+- Alexandre Fayolle \<<[email protected]>\>
+- Holger Brunn \<<[email protected]>\>
+- Laurent Mignon (aka lmi) \<<[email protected]>\>
+- Sandy Carter \<<[email protected]>\>
+- Fabio Vilchez \<<[email protected]>\>
+- Jos De Graeve \<<[email protected]>\>
+- Lai Tim Siu (Quaritle Limited) \<<[email protected]>\>
+- Tharathip Chaweewongphan \<<[email protected]>\>
+- Eric Antones \<<[email protected]>\>

dbfilter_from_header/readme/DESCRIPTION.md

@@ -0,0 +1,4 @@
+This addon lets you pass a dbfilter as a HTTP header.
+
+This is interesting for setups where database names can't be mapped to
+proxied host names.

dbfilter_from_header/readme/INSTALL.md

@@ -0,0 +1,7 @@
+To install this module, you only need to add it to your addons, and load
+it as a server-wide module.
+
+This can be done with the `server_wide_modules` parameter in
+`/etc/odoo.conf` or with the `--load` command-line parameter
+
+`server_wide_modules = base,web,dbfilter_from_header`

dbfilter_from_header/readme/USAGE.md

@@ -0,0 +1,2 @@
+To use this module, you need to complete installation and configuration
+parts.