Merge pull request #316 from em230418/14.0-database_limit_size

[14.0] database_limit_size port

Author: trojikman

database_limit_size/README.rst

@@ -0,0 +1,43 @@
+.. image:: https://itpp.dev/images/infinity-readme.png
+   :alt: Tested and maintained by IT Projects Labs
+   :target: https://itpp.dev
+
+.. image:: https://img.shields.io/badge/license-MIT-blue.svg
+   :target: https://opensource.org/licenses/MIT
+   :alt: License: MIT
+
+=====================
+ Database Limit Size
+=====================
+
+This module allows blocking backend access when database limit is exceeded
+
+On loading backend page, module fetches size of database (including filestore) and compares it with value, that
+is defined in "System Parameters" as ``database_limit_size``. Value is expected to be in bytes.
+
+If ``database_limit_size`` is not given or zero, there is no limit.
+
+Roadmap
+=======
+
+* Customize percentage of the limit which, if exceeded, would indicate a warning. As for now it is hardcoded to 90%
+
+Questions?
+==========
+
+To get an assistance on this module contact us by email :arrow_right: help@itpp.dev
+
+Contributors
+============
+* `Eugene Molotov <https://it-projects.info/team/em230418>`__:
+
+
+Further information
+===================
+
+Odoo Apps Store: https://apps.odoo.com/apps/modules/14.0/database_limit_size/
+
+
+Notifications on updates: `via Atom <https://github.com/itpp-labs/access-addons/commits/14.0/database_limit_size.atom>`_, `by Email <https://blogtrottr.com/?subscribe=https://github.com/itpp-labs/access-addons/commits/14.0/database_limit_size.atom>`_
+
+Tested on `Odoo 14.0 <https://github.com/odoo/odoo/commit/8ca3ea063050f2ab2d19cce8a68116489872a734>`_

database_limit_size/__init__.py

@@ -0,0 +1,3 @@
+# License MIT (https://opensource.org/licenses/MIT).
+
+from . import models

database_limit_size/__manifest__.py

@@ -0,0 +1,26 @@
+# Copyright 2020 Eugene Molotov <https://it-projects.info/team/em230418>
+# License MIT (https://opensource.org/licenses/MIT).
+
+{
+    "name": """Database Limit Size""",
+    "summary": """This module allows blocking backend access when database limit is exceeded""",
+    "category": "Extra Tools",
+    "images": [],
+    "version": "14.0.1.0.0",
+    "application": False,
+    "author": "IT-Projects LLC, Eugene Molotov",
+    "support": "help@itpp.dev",
+    "website": "https://twitter.com/OdooFree",
+    "license": "Other OSI approved licence",  # MIT
+    "depends": ["database_block"],
+    "external_dependencies": {"python": [], "bin": []},
+    "data": [],
+    "demo": [],
+    "qweb": [],
+    "post_load": None,
+    "pre_init_hook": None,
+    "post_init_hook": None,
+    "uninstall_hook": None,
+    "auto_install": False,
+    "installable": True,
+}

database_limit_size/doc/changelog.rst

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

database_limit_size/doc/index.rst

@@ -0,0 +1,19 @@
+=====================
+ Database Limit Size
+=====================
+
+Installation
+============
+
+* `Install <https://odoo-development.readthedocs.io/en/latest/odoo/usage/install-module.html>`__ this module in a usual way
+
+Configuration
+=============
+
+* `Log in as admin
+* `Activate Developer Mode <https://odoo-development.readthedocs.io/en/latest/odoo/usage/debug-mode.html>`__
+* Open menu ``[[ Settings ]] >> Technical >> System Parameter``
+* Edit existing record by key ``database_limit_size`` or create new one
+* Set integer value, click "Save" and reload web page
+* If you set small nonzero value (for example "1" without quotes), "Database size exceed" will appear and will disable navigating
+* If you set value that is less than actual database size, but greater than 90% of actual database size and ``web_responsive`` is installed, you will see warning message "Database size is about to be exceed"

database_limit_size/models/__init__.py

@@ -0,0 +1,3 @@
+# License MIT (https://opensource.org/licenses/MIT).
+
+from . import ir_http

database_limit_size/models/ir_http.py

@@ -0,0 +1,56 @@
+# Copyright 2020 Eugene Molotov <https://it-projects.info/team/em230418>
+# License MIT (https://opensource.org/licenses/MIT).
+
+import os
+
+from odoo import models
+from odoo.tools import human_size
+
+
+# https://stackoverflow.com/a/1392549
+def get_directory_size(start_path):
+    total_size = 0
+    for dirpath, _dirnames, filenames in os.walk(start_path):
+        for f in filenames:
+            fp = os.path.join(dirpath, f)
+            total_size += os.path.getsize(fp)
+    return total_size
+
+
+class IrHttp(models.AbstractModel):
+
+    _inherit = "ir.http"
+
+    def session_info(self):
+        res = super(IrHttp, self).session_info()
+
+        Config = self.env["ir.config_parameter"].sudo()
+        try:
+            database_limit_size = int(Config.get_param("database_limit_size", 0))
+        except ValueError:
+            return res
+
+        if not database_limit_size:
+            return res
+
+        self.env.cr.execute("select pg_database_size(%s)", [self.env.cr.dbname])
+        database_size = self.env.cr.fetchone()[0]
+
+        filestore_size = get_directory_size(self.env["ir.attachment"]._filestore())
+
+        total_size = database_size + filestore_size
+        if total_size > database_limit_size:
+            res["database_block_message"] = "Database size exceed ({} / {})".format(
+                human_size(total_size),
+                human_size(database_limit_size),
+            )
+        elif total_size > database_limit_size * 0.9:
+            res[
+                "database_block_message"
+            ] = "Database size is about to be exceed (%s / %s)" % (
+                human_size(total_size),
+                human_size(database_limit_size),
+            )
+            res["database_block_is_warning"] = True
+
+        return res