diff --git a/report_qr/README.rst b/report_qr/README.rst new file mode 100644 index 00000000..f644a132 --- /dev/null +++ b/report_qr/README.rst @@ -0,0 +1,107 @@ +============== +Web QR Manager +============== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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%2Freporting--engine-lightgray.png?logo=github + :target: https://github.com/OCA/reporting-engine/tree/11.0/report_qr + :alt: OCA/reporting-engine +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/reporting-engine-11-0/reporting-engine-11-0-report_qr + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/143/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows to print QR in better structure than the standard odoo. + +The original image looks like the following + +.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/11.0/report_qr/static/description/old_qr.png + :alt: Original QR + :width: 100 px + +With the new generator, it looks like: + +.. figure:: https://raw.githubusercontent.com/OCA/reporting-engine/11.0/report_qr/static/description/new_qr.png + :alt: New QR + :width: 100 px + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +When creating new reports, you should use a path like the following:: + + + + +The **error_correction** parameter controls the error correction used for the QR Code. The following four constants are made available: + +* **error_correction** = 1: About 7% or less errors can be corrected. +* **error_correction** = 0: About 15% or less errors can be corrected. +* **error_correction** = 3: About 25% or less errors can be corrected. +* **error_correction** = 2: About 30% or less errors can be corrected. + +The **box_size** parameter controls how many pixels each "box" of the QR code is. The default is 3. +The **border** parameter controls how many boxes thick the border should be (the default is 4, which is the minimum according to the specs). + +The **version** parameter is an integer from 1 to 40 that controls the size of the QR Code (the smallest, version 1, is a 21x21 matrix). Set to None and use the fit parameter when making the code to determine this automatically. + +**fill_color** and **back_color** can change the background and the painting color of the QR, when using the default image factory. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Creu Blanca + +Contributors +~~~~~~~~~~~~ + +* Enric Tobella + +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/reporting-engine `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_qr/__init__.py b/report_qr/__init__.py new file mode 100644 index 00000000..91c5580f --- /dev/null +++ b/report_qr/__init__.py @@ -0,0 +1,2 @@ +from . import controllers +from . import models diff --git a/report_qr/__manifest__.py b/report_qr/__manifest__.py new file mode 100644 index 00000000..1c44aa6c --- /dev/null +++ b/report_qr/__manifest__.py @@ -0,0 +1,21 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Creu Blanca +# Copyright 2019 Tecnativa +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + 'name': 'Web QR Manager', + 'version': '10.0.1.0.0', + 'author': 'Creu Blanca, ' + 'Tecnativa, ' + 'Odoo Community Association (OCA)', + 'category': 'Sales', + 'website': 'https://github.com/OCA/reporting-engine', + 'license': 'AGPL-3', + 'depends': [ + 'report', + ], + 'data': [ + ], + 'installable': True, +} diff --git a/report_qr/controllers/__init__.py b/report_qr/controllers/__init__.py new file mode 100644 index 00000000..c52ced06 --- /dev/null +++ b/report_qr/controllers/__init__.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +from . import qr diff --git a/report_qr/controllers/qr.py b/report_qr/controllers/qr.py new file mode 100644 index 00000000..e032e15b --- /dev/null +++ b/report_qr/controllers/qr.py @@ -0,0 +1,24 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). +import werkzeug +from odoo import http +from odoo.http import request + + +class Home(http.Controller): + + @http.route('/report/qr', type='http', auth="public") + def report_qr(self, value, box_size=3, border=3, factory='png', **kwargs): + try: + barcode = request.env['report'].qr_generate( + value, box_size=box_size, border=border, + factory=factory, **kwargs) + except (ValueError, AttributeError): + raise werkzeug.exceptions.HTTPException( + description='Cannot convert into barcode.') + if factory != 'png': + return request.make_response( + barcode, headers=[('Content-Type', 'image/svg+xml')]) + return request.make_response( + barcode, headers=[('Content-Type', 'image/png')]) diff --git a/report_qr/models/__init__.py b/report_qr/models/__init__.py new file mode 100644 index 00000000..8323e741 --- /dev/null +++ b/report_qr/models/__init__.py @@ -0,0 +1,2 @@ +# -*- coding: utf-8 -*- +from . import report diff --git a/report_qr/models/report.py b/report_qr/models/report.py new file mode 100644 index 00000000..43d60900 --- /dev/null +++ b/report_qr/models/report.py @@ -0,0 +1,39 @@ +# -*- coding: utf-8 -*- +# Copyright 2019 Creu Blanca +# Copyright 2019 Tecnativa - David Vidal +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html). +from odoo import api, models +import qrcode +from qrcode.image import svg, pil +import io + + +class Report(models.Model): + _inherit = 'report' + + @api.model + def qr_generate(self, value, box_size=3, border=5, + factory='png', **kwargs): + factories = { + 'png': pil.PilImage, + 'svg': svg.SvgImage, + 'svg-fragment': svg.SvgFragmentImage, + 'svg-path': svg.SvgPathImage, + } + # Color parameters seem to be inverted in the library + back_color = kwargs.pop("back_color", "black") + fill_color = kwargs.pop("fill_color", "white") + try: + # Defaults to png if the argument is unknown + image_factory = factories.get(factory, pil.PilImage) + qr = qrcode.QRCode( + box_size=box_size, border=border, + image_factory=image_factory, **kwargs) + qr.add_data(value) + qr.make() + img = qr.make_image(fill_color=fill_color, back_color=back_color) + arr = io.BytesIO() + img.save(arr) + return arr.getvalue() + except Exception: + raise ValueError("Cannot convert into barcode.") diff --git a/report_qr/readme/CONTRIBUTORS.rst b/report_qr/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..ba55fe73 --- /dev/null +++ b/report_qr/readme/CONTRIBUTORS.rst @@ -0,0 +1,5 @@ +* Enric Tobella + +* `Tecnativa `_: + + * David Vidal diff --git a/report_qr/readme/DESCRIPTION.rst b/report_qr/readme/DESCRIPTION.rst new file mode 100644 index 00000000..e4e45291 --- /dev/null +++ b/report_qr/readme/DESCRIPTION.rst @@ -0,0 +1,13 @@ +This module allows to print QR in better structure than the standard odoo. + +The original image looks like the following + +.. figure:: static/description/old_qr.png + :alt: Original QR + :width: 100 px + +With the new generator, it looks like: + +.. figure:: static/description/new_qr.png + :alt: New QR + :width: 100 px diff --git a/report_qr/readme/USAGE.rst b/report_qr/readme/USAGE.rst new file mode 100644 index 00000000..365558ad --- /dev/null +++ b/report_qr/readme/USAGE.rst @@ -0,0 +1,18 @@ +When creating new reports, you should use a path like the following:: + + + + +The **error_correction** parameter controls the error correction used for the QR Code. The following four constants are made available: + +* **error_correction** = 1: About 7% or less errors can be corrected. +* **error_correction** = 0: About 15% or less errors can be corrected. +* **error_correction** = 3: About 25% or less errors can be corrected. +* **error_correction** = 2: About 30% or less errors can be corrected. + +The **box_size** parameter controls how many pixels each "box" of the QR code is. The default is 3. +The **border** parameter controls how many boxes thick the border should be (the default is 4, which is the minimum according to the specs). + +The **version** parameter is an integer from 1 to 40 that controls the size of the QR Code (the smallest, version 1, is a 21x21 matrix). Set to None and use the fit parameter when making the code to determine this automatically. + +**fill_color** and **back_color** can change the background and the painting color of the QR, when using the default image factory. diff --git a/report_qr/static/description/icon.png b/report_qr/static/description/icon.png new file mode 100644 index 00000000..3a0328b5 Binary files /dev/null and b/report_qr/static/description/icon.png differ diff --git a/report_qr/static/description/index.html b/report_qr/static/description/index.html new file mode 100644 index 00000000..99f52e2c --- /dev/null +++ b/report_qr/static/description/index.html @@ -0,0 +1,446 @@ + + + + + + +Web QR Manager + + + +
+

Web QR Manager

+ + +

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

+

This module allows to print QR in better structure than the standard odoo.

+

The original image looks like the following

+
+Original QR +
+

With the new generator, it looks like:

+
+New QR +
+

Table of contents

+ +
+

Usage

+

When creating new reports, you should use a path like the following:

+
+<img t-att-src="'/report/qr/?value=%s&amp;error_correction=%s' % ('HELLO WORLD!', 3)" style="width:100;height:100"/>
+
+

The error_correction parameter controls the error correction used for the QR Code. The following four constants are made available:

+
    +
  • error_correction = 1: About 7% or less errors can be corrected.
    • +
  • error_correction = 0: About 15% or less errors can be corrected.
    • +
  • error_correction = 3: About 25% or less errors can be corrected.
    • +
  • error_correction = 2: About 30% or less errors can be corrected.
    • +
+

The box_size parameter controls how many pixels each “box” of the QR code is. The default is 3. +The border parameter controls how many boxes thick the border should be (the default is 4, which is the minimum according to the specs).

+

The version parameter is an integer from 1 to 40 that controls the size of the QR Code (the smallest, version 1, is a 21x21 matrix). Set to None and use the fit parameter when making the code to determine this automatically.

+

fill_color and back_color can change the background and the painting color of the QR, when using the default image factory.

+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us smashing it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Creu Blanca
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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/reporting-engine project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/report_qr/static/description/new_qr.png b/report_qr/static/description/new_qr.png new file mode 100644 index 00000000..6b4848f1 Binary files /dev/null and b/report_qr/static/description/new_qr.png differ diff --git a/report_qr/static/description/old_qr.png b/report_qr/static/description/old_qr.png new file mode 100644 index 00000000..73958fa9 Binary files /dev/null and b/report_qr/static/description/old_qr.png differ diff --git a/report_qr/tests/__init__.py b/report_qr/tests/__init__.py new file mode 100644 index 00000000..c7c57bc2 --- /dev/null +++ b/report_qr/tests/__init__.py @@ -0,0 +1 @@ +from . import test_report_qr diff --git a/report_qr/tests/test_report_qr.py b/report_qr/tests/test_report_qr.py new file mode 100644 index 00000000..a231c547 --- /dev/null +++ b/report_qr/tests/test_report_qr.py @@ -0,0 +1,21 @@ +# Copyright 2019 Creu Blanca +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo.tests.common import HttpCase + + +class TestReportQr(HttpCase): + + def test_qr_generation(self): + data = 'TEST' + image = self.url_open('/report/qr?value=%s' % data) + self.assertEqual(image.headers['Content-type'], 'image/png') + + def test_qr_overflow(self): + """There is a QR limitation for 4296 characters, we will test that an + Exception is raised""" + new_data = '' + for i in range(0, 1500): + new_data += 'TEST' + with self.assertRaises(Exception): + self.env['report'].qr_generate(new_data)