Skip to content

Commit

Permalink
Merge 3c9b5d5 into 9a8b38d
Browse files Browse the repository at this point in the history
  • Loading branch information
chienandalu authored Sep 19, 2019
2 parents 9a8b38d + 3c9b5d5 commit 362a002
Show file tree
Hide file tree
Showing 16 changed files with 697 additions and 0 deletions.
107 changes: 107 additions & 0 deletions report_qr/README.rst
Original file line number Diff line number Diff line change
@@ -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::

<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 <https://github.com/OCA/reporting-engine/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 <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qr%0Aversion:%2011.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
~~~~~~~

* Creu Blanca

Contributors
~~~~~~~~~~~~

* Enric Tobella <etobella@creublanca.es>

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 <https://github.com/OCA/reporting-engine/tree/11.0/report_qr>`_ project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
2 changes: 2 additions & 0 deletions report_qr/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
from . import controllers
from . import models
21 changes: 21 additions & 0 deletions report_qr/__manifest__.py
Original file line number Diff line number Diff line change
@@ -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,
}
2 changes: 2 additions & 0 deletions report_qr/controllers/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# -*- coding: utf-8 -*-
from . import qr
20 changes: 20 additions & 0 deletions report_qr/controllers/qr.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# -*- 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, **kwargs):
try:
barcode = request.env['report'].qr_generate(
value, box_size=box_size, border=border, **kwargs)
except (ValueError, AttributeError):
raise werkzeug.exceptions.HTTPException(
description='Cannot convert into barcode.')
return request.make_response(
barcode, headers=[('Content-Type', 'image/png')])
2 changes: 2 additions & 0 deletions report_qr/models/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# -*- coding: utf-8 -*-
from . import report
39 changes: 39 additions & 0 deletions report_qr/models/report.py
Original file line number Diff line number Diff line change
@@ -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.")
5 changes: 5 additions & 0 deletions report_qr/readme/CONTRIBUTORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
* Enric Tobella <etobella@creublanca.es>

* `Tecnativa <https://www.tecnativa.com>`_:

* David Vidal
13 changes: 13 additions & 0 deletions report_qr/readme/DESCRIPTION.rst
Original file line number Diff line number Diff line change
@@ -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
18 changes: 18 additions & 0 deletions report_qr/readme/USAGE.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
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.
Binary file added report_qr/static/description/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 362a002

Please sign in to comment.