[17.0] mig-excel_import_export

excel_import_export/README.rst

@@ -0,0 +1,243 @@
+==========================
+Excel Import/Export/Report
+==========================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:71e187de9ab7723f404469d47ee695cf540260f860ccdd3ec12963a1a4b52ea7
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/17.0/excel_import_export
+    :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-17-0/server-tools-17-0-excel_import_export
+    :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=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+The module provide pre-built functions and wizards for developer to
+build excel import / export / report with ease.
+
+Without having to code to create excel file, developer do,
+
+-  Create menu, action, wizard, model, view a normal Odoo development.
+-  Design excel template using standard Excel application, e.g., colors,
+   fonts, formulas, etc.
+-  Instruct how the data will be located in Excel with simple dictionary
+   instruction or from Odoo UI.
+-  Odoo will combine instruction with excel template, and result in
+   final excel file.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Installation
+============
+
+To install this module, you need to install following python library,
+**xlrd, xlwt, openpyxl**.
+
+Then, simply install **excel_import_export**.
+
+For demo, install **excel_import_export_demo**
+
+Usage
+=====
+
+Concepts
+--------
+
+This module contain pre-defined function and wizards to make exporting,
+importing and reporting easy.
+
+At the heart of this module, there are 2 main methods
+
+-  ``self.env['xlsx.export'].export_xlsx(...)``
+-  ``self.env['xlsx.import'].import_xlsx(...)``
+
+For reporting, also call export_xlsx(...) but through following method
+
+-  ``self.env['xslx.report'].report_xlsx(...)``
+
+After install this module, go to Settings > Excel Import/Export > XLSX
+Templates, this is where the key component located.
+
+As this module provide tools, it is best to explain as use cases. For
+example use cases, please install **excel_import_export_demo**
+
+Use Cases
+---------
+
+**Use Case 1:** Export/Import Excel on existing document
+
+This add export/import action menus in existing document (example -
+excel_import_export_demo/import_export_sale_order)
+
+1. Create export action menu on document, <act_window> with
+   res_model="export.xlsx.wizard" and src_model="<document_model>", and
+   context['template_domain'] to locate the right template --
+   actions.xml
+2. Create import action menu on document, <act_window> with
+   res_model="import.xlsx.wizard" and src_model="<document_model>", and
+   context['template_domain'] to locate the right template -- action.xml
+3. Create/Design Excel Template File (.xlsx), in the template, name the
+   underlining tab used for export/import -- <file>.xlsx
+4. Create instruction dictionary for export/import in xlsx.template
+   model -- templates.xml
+
+**Use Case 2:** Import Excel Files
+
+With menu wizard to create new documents (example -
+excel_import_export_demo/import_sale_orders)
+
+1. Create report menu with search wizard, res_model="import.xlsx.wizard"
+   and context['template_domain'] to locate the right template --
+   menu_action.xml
+2. Create Excel Template File (.xlsx), in the template, name the
+   underlining tab used for import -- <import file>.xlsx
+3. Create instruction dictionary for import in xlsx.template model --
+   templates.xml
+
+**Use Case 3:** Create Excel Report
+
+This create report menu with criteria wizard. (example -
+excel_import_export_demo/report_sale_order)
+
+1. Create report's menu, action, and add context['template_domain'] to
+   locate the right template for this report -- <report>.xml
+2. Create report's wizard for search criteria. The view inherits
+   ``excel_import_export.xlsx_report_view`` and mode="primary". In this
+   view, you only need to add criteria fields, the rest will reuse from
+   interited view -- <report.xml>
+3. Create report model as models.Transient, then define search criteria
+   fields, and get reporing data into ``results`` field -- <report>.py
+4. Create/Design Excel Template File (.xlsx), in the template, name the
+   underlining tab used for report results -- <report_file>.xlsx
+5. Create instruction dictionary for report in xlsx.template model --
+   templates.xml
+
+**Note:**
+
+Another option for reporting is to use report action
+(report_type='excel'), I.e.,
+
+.. code:: xml
+
+   <report id='action_report_saleorder_excel'
+           string='Quotation / Order (.xlsx)'
+           model='sale.order'
+           name='sale_order.xlsx'
+           file='sale_order'
+           report_type='excel'
+   />
+
+By using report action, Odoo will find template using combination of
+model and name, then do the export for the underlining record. Please
+see example in excel_import_export_demo/report_action, which shows,
+
+1. Print excel from an active sale.order
+2. Run partner list report based on search criteria.
+
+Easy Reporting Option
+---------------------
+
+Technically, this option is the same as "Create Excel Report" use case.
+But instead of having to write XML / Python code like normally do, this
+option allow user to create a report based on a model or view, all by
+configuration only.
+
+1. Goto > Technical> Excel Import/Export > XLSX Templates, and create a
+   new template for a report.
+2. On the new template, select "Easy Reporting" option, then select
+   followings
+
+   -  Report Model, this can be data model or data view we want to get
+      the results from.
+   -  Click upload your file and add the excel template (.xlsx)
+   -  Click Save, system will create sample export line, user can add
+      more fields according to results model.
+
+3. Click Add Report Menu, the report menu will be created, user can
+   change its location. Now the report is ready to use.
+
+..
+
+   |image1|
+
+Note: Using easy reporting mode, system will used a common criteria
+wizard.
+
+   |image2|
+
+.. |image1| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/excel_import_export/static/description/xlsx_template.png
+.. |image2| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/excel_import_export/static/description/common_wizard.png
+
+Known issues / Roadmap
+======================
+
+-  Module extension e.g., excel_import_export_async, that add ability to
+   execute as async process.
+
+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:%20excel_import_export%0Aversion:%2017.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
+-------
+
+* Ecosoft
+
+Contributors
+------------
+
+-  Kitti Upariphutthiphong. <[email protected]> (http://ecosoft.co.th)
+-  Saran Lim. <[email protected]> (http://ecosoft.co.th)
+
+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.
+
+.. |maintainer-kittiu| image:: https://github.com/kittiu.png?size=40px
+    :target: https://github.com/kittiu
+    :alt: kittiu
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-kittiu| 
+
+This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/17.0/excel_import_export>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

excel_import_export/__init__.py

@@ -0,0 +1,6 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+from . import wizard
+from . import models
+from . import controllers

excel_import_export/__manifest__.py

@@ -0,0 +1,30 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+{
+    "name": "Excel Import/Export/Report",
+    "summary": "Base module for developing Excel import/export/report",
+    "version": "17.0.1.0.0",
+    "author": "Ecosoft,Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "website": "https://github.com/OCA/server-tools",
+    "category": "Tools",
+    "depends": ["mail"],
+    "external_dependencies": {"python": ["openpyxl"]},
+    "data": [
+        "security/ir.model.access.csv",
+        "wizard/export_xlsx_wizard.xml",
+        "wizard/import_xlsx_wizard.xml",
+        "wizard/report_xlsx_wizard.xml",
+        "views/xlsx_template_view.xml",
+        "views/xlsx_report.xml",
+    ],
+    "installable": True,
+    "development_status": "Beta",
+    "maintainers": ["kittiu"],
+    "assets": {
+        "web.assets_backend": [
+            "/excel_import_export/static/src/js/report/action_manager_report.esm.js"
+        ]
+    },
+}

excel_import_export/controllers/__init__.py

@@ -0,0 +1,4 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+from . import report

excel_import_export/controllers/report.py

@@ -0,0 +1,95 @@
+# Copyright 2019 Ecosoft Co., Ltd (http://ecosoft.co.th/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html)
+
+import base64
+import json
+import logging
+
+from werkzeug.urls import url_decode
+
+from odoo import http
+from odoo.http import content_disposition, request, route, serialize_exception
+from odoo.tools import html_escape
+from odoo.tools.safe_eval import safe_eval, time
+
+from odoo.addons.web.controllers import report
+
+_logger = logging.getLogger(__name__)
+
+
+class ReportController(report.ReportController):
+    @route()
+    def report_routes(self, reportname, docids=None, converter=None, **data):
+        if converter == "excel":
+            report = request.env["ir.actions.report"]._get_report_from_name(reportname)
+            context = dict(request.env.context)
+            if docids:
+                docids = [int(i) for i in docids.split(",")]
+            if data.get("options"):
+                data.update(json.loads(data.pop("options")))
+            if data.get("context"):
+                # Ignore 'lang' here, because the context in data is the one
+                # from the webclient *but* if the user explicitely wants to
+                # change the lang, this mechanism overwrites it.
+                data["context"] = json.loads(data["context"])
+                if data["context"].get("lang"):
+                    del data["context"]["lang"]
+                context.update(data["context"])
+
+            excel, report_name = report.with_context(**context)._render_excel(
+                docids, data=data
+            )
+            excel = base64.decodebytes(excel)
+            if docids:
+                records = request.env[report.model].browse(docids)
+                if report.print_report_name and not len(records) > 1:
+                    # this is a bad idea, this should only be .xlsx
+                    extension = report_name.split(".")[-1:].pop()
+                    report_name = safe_eval(
+                        report.print_report_name, {"object": records, "time": time}
+                    )
+                    report_name = f"{report_name}.{extension}"
+            excelhttpheaders = [
+                (
+                    "Content-Type",
+                    "application/vnd.openxmlformats-"
+                    "officedocument.spreadsheetml.sheet",
+                ),
+                ("Content-Length", len(excel)),
+                ("Content-Disposition", content_disposition(report_name)),
+            ]
+            return request.make_response(excel, headers=excelhttpheaders)
+        return super().report_routes(reportname, docids, converter, **data)
+
+    @http.route()
+    def report_download(self, data, context=None):
+        requestcontent = json.loads(data)
+        url, report_type = requestcontent[0], requestcontent[1]
+        if report_type != "excel":
+            return super().report_download(data, context)
+        reportname = "???"
+        try:
+            pattern = "/report/excel/"
+            reportname = url.split(pattern)[1].split("?")[0]
+            docids = None
+            if "/" in reportname:
+                reportname, docids = reportname.split("/")
+            if docids:
+                return self.report_routes(
+                    reportname, docids=docids, converter="excel", context=context
+                )
+            data = dict(url_decode(url.split("?")[1]).items())
+            if "context" in data:
+                context, data_context = (
+                    json.loads(context or "{}"),
+                    json.loads(data.pop("context")),
+                )
+                context = json.dumps({**context, **data_context})
+            return self.report_routes(
+                reportname, converter="excel", context=context, **data
+            )
+        except Exception as e:
+            _logger.exception("Error while generating report %s", reportname)
+            se = serialize_exception(e)
+            error = {"code": 200, "message": "Odoo Server Error", "data": se}
+            return request.make_response(html_escape(json.dumps(error)))