Added custom options module for printers by report

corrections for travis tests

fix for flake8 errors and travis tests

added new sections and rapleced maintainers

added USAGE section in readme + bug corection for update of printers

changed copyrights

updated manifest and fix for case of false ppd

printer_custom_options/README.rst

@@ -0,0 +1,67 @@
+==========================================
+Report to printer - Custom Printer Options
+==========================================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! 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-compassionCH%2Fcompassion--modules-lightgray.png?logo=github
+    :target: https://github.com/compassionCH/compassion-modules/tree/11.0/printer_custom_options
+    :alt: compassionCH/compassion-modules
+
+|badge1| |badge2| |badge3|
+
+Allow to retrieve a subset of printer options using CUPS,
+define which should be used depending on the report and finally set the correct options on the print jobs.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/compassionCH/compassion-modules/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/compassionCH/compassion-modules/issues/new?body=module:%20printer_custom_options%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
+~~~~~~~
+
+* Compassion CH
+
+Contributors
+~~~~~~~~~~~~
+
+Nicolas Bornand
+Quentin Gigon <gigon.quentin@gmail.com>
+
+Maintainers
+~~~~~~~~~~~
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+This module is maintained by the OCA.
+
+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.
+
+To contribute to this module, please visit https://odoo-community.org.

printer_custom_options/__init__.py

@@ -0,0 +1,4 @@
+# Copyright 2019 Compassion
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from . import models

printer_custom_options/__manifest__.py

@@ -0,0 +1,27 @@
+# Copyright 2019 Compassion
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+# pylint: disable=C8101
+{
+    'name': 'Report to printer - Custom Printer Options',
+    'version': '11.0.0.0.0',
+    'category': 'Printer',
+    'author': 'Compassion CH, OCA',
+    'website': 'https://github.com/OCA/report-print-send',
+    'license': 'AGPL-3',
+    'depends': [
+        'base_report_to_printer'        # oca_addons/report-print-send
+    ],
+    'data': [
+        'views/printing_printer.xml',
+        'views/ir_actions_reports_xml_view.xml',
+        'security/ir.model.access.csv'
+    ],
+    'external_dependencies': {
+        'python': ['cups'],
+    },
+    'installable': True,
+    'application': False,
+    'summary': "Adds the ability to check all printing options available "
+               "from a CUPS printer set them in the reports",
+}

printer_custom_options/models/__init__.py

@@ -0,0 +1,7 @@
+# Copyright 2019 Compassion
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from . import printing_printer
+from . import printer_option
+from . import printer_option_choice
+from . import report_xml

printer_custom_options/models/printer_option.py

@@ -0,0 +1,18 @@
+# Copyright 2019 Compassion
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+from odoo import fields, models
+
+
+class PrinterOption(models.Model):
+    _name = 'printer.option'
+    _description = 'Printer Option'
+    _rec_name = 'option_key'
+
+    option_key = fields.Char(required=True, readonly=True)
+    printer_id = fields.Many2one(
+        comodel_name='printing.printer',
+        string='Printer',
+        required=True,
+        readonly=True,
+        ondelete='cascade',
+    )

printer_custom_options/models/printer_option_choice.py

@@ -0,0 +1,33 @@
+# Copyright 2019 Compassion
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+from odoo import api, fields, models
+
+
+class PrinterOptionChoice(models.Model):
+    _name = 'printer.option.choice'
+    _description = 'Printer Option Choice'
+    _rec_name = 'composite_key'
+
+    option_key = fields.Char(required=True, readonly=True)
+    option_value = fields.Char(required=True, readonly=True)
+    composite_key = fields.Char(compute='_compute_composite_key', store=True)
+    printer_id = fields.Many2one(
+        comodel_name='printing.printer',
+        string='Printer',
+        required=True,
+        readonly=True,
+        ondelete='cascade',
+    )
+
+    @api.multi
+    @api.depends("option_key", "option_value")
+    def _compute_composite_key(self):
+        """ Composite key for a printing option key-value pair."""
+        for option in self:
+            option.composite_key = self.build_composite_key(option.option_key,
+                                                            option.option_value
+                                                            )
+
+    @api.model
+    def build_composite_key(self, option_key, option_value):
+        return option_key + ':' + option_value

printer_custom_options/models/printing_printer.py

@@ -0,0 +1,116 @@
+# Copyright 2019 Compassion
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+import errno
+import logging
+import os
+
+from odoo import api, fields, models
+
+_logger = logging.getLogger(__name__)
+
+try:
+    import cups
+except ImportError:
+    _logger.debug('Cannot `import cups`.')
+
+
+class PrintingPrinter(models.Model):
+    _inherit = 'printing.printer'
+
+    printer_options = fields.One2many(
+        comodel_name='printer.option',
+        inverse_name='printer_id',
+        readonly=True)
+    printer_option_choices = fields.One2many(
+        comodel_name='printer.option.choice',
+        inverse_name='printer_id',
+        string='Option Choices',
+        readonly=True)
+
+    def _get_cups_ppd(self, cups_connection, cups_printer):
+        """ Returns a PostScript Printer Description (PPD) file for the
+        printer. """
+        printer_uri = cups_printer['printer-uri-supported']
+        printer_system_name = printer_uri[printer_uri.rfind('/') + 1:]
+        ppd_info = cups_connection.getPPD3(printer_system_name)
+        ppd_path = ppd_info[2]
+        if not ppd_path:
+            return False, False
+        return ppd_path, cups.PPD(ppd_path)
+
+    def _cleanup_ppd(self, ppd_path):
+        try:
+            os.unlink(ppd_path)
+        except OSError as err:
+            # ENOENT means No such file or directory
+            # The file has already been deleted, we can continue the update
+            if err.errno != errno.ENOENT:
+                raise
+
+    @api.multi
+    def _prepare_update_from_cups(self, cups_connection, cups_printer):
+        vals = super()._prepare_update_from_cups(
+            cups_connection, cups_printer)
+
+        current_option_keys = self.printer_option_choices.mapped(
+            'composite_key')
+        ppd_path, ppd = self._get_cups_ppd(cups_connection, cups_printer)
+        if ppd_path and ppd:
+            self._load_printer_option_list(ppd)
+
+            new_option_values = []
+            for printer_option in self.printer_options:
+                option_key = printer_option.option_key
+                new_options = self.discover_values_of_option(ppd,
+                                                             current_option_keys,
+                                                             option_key)
+                new_option_values.extend(new_options)
+            vals['printer_option_choices'] = new_option_values
+
+            self._cleanup_ppd(ppd_path)
+        return vals
+
+    def _load_printer_option_list(self, ppd):
+        if len(self.printer_options) > 0 or not self:
+            # Only fetch options the first time or
+            # if the printer is already in the system.
+            return
+        option_inserts = []
+        for option_group in ppd.optionGroups:
+            for option in option_group.options:
+                option_inserts.append((0, 0, {'option_key': option.keyword}))
+        self.printer_options = option_inserts
+
+    def discover_values_of_option(self, ppd, current_option_keys, option_key):
+        """ Returns all new values for one printer option category. Most
+        probably it will insert all option values the first time we sync with
+        CUPS and then return an empty list."""
+        option = ppd.findOption(option_key)
+        if not option:
+            return []
+
+        printer_option_values = {entry['choice'] for entry in option.choices}
+        option_model = self.env['printer.option.choice']
+
+        # Insertion tuples
+        return [
+            (0, 0,
+             {'option_value': option_value, 'option_key': option_key})
+            for option_value in printer_option_values
+            if option_model.build_composite_key(option_key, option_value)
+            not in current_option_keys
+        ]
+
+    @api.multi
+    def print_options(self, report=None, **print_opts):
+        # Use lpoptions to have an exhaustive list of the supported options
+        options = super().print_options(report=report, **print_opts)
+
+        if report is not None:
+            # Some modules pass report_name instead of the report.
+            full_report = self.env['report']._get_report_from_name(report) \
+                if isinstance(report, str) else report
+            for printer_option in full_report.printer_options:
+                options[
+                    printer_option.option_key] = printer_option.option_value
+        return options

printer_custom_options/models/report_xml.py

@@ -0,0 +1,16 @@
+# Copyright 2019 Compassion
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+from odoo import api, fields, models
+
+
+class IrActionsReportXml(models.Model):
+    _inherit = 'ir.actions.report'
+
+    printer_options = fields.Many2many('printer.option.choice',
+                                       string='Printer Options')
+
+    @api.multi
+    @api.onchange('printing_printer_id')
+    def on_change_printer(self):
+        for report in self:
+            report.printer_options = False

printer_custom_options/readme/CONTRIBUTORS.rst

@@ -0,0 +1,2 @@
+Nicolas Bornand
+Quentin Gigon <gigon.quentin@gmail.com>

printer_custom_options/readme/DESCRIPTION.rst

@@ -0,0 +1,2 @@
+Allow to retrieve a subset of printer options using CUPS,
+define which should be used depending on the report and finally set the correct options on the print jobs.

printer_custom_options/readme/USAGE.rst

@@ -0,0 +1,5 @@
+After installing update the CUPS printers in Settings > Printing > Update Printers from CUPS
+Usage
+In the printer you can see all se options Settings > Printing > Printers
+If you want print a report with specific options, you can change these in Settings > Printing > Reports.
+When no option is configured for a report, the default option setup on the CUPS server is used.

printer_custom_options/security/ir.model.access.csv

@@ -0,0 +1,4 @@
+"id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink"
+access_printer_option_choice_all,printer_option_choice all,model_printer_option_choice,base_report_to_printer.printing_group_user,1,0,0,0
+access_printer_option_choice_operator,printer_option_choice operator,model_printer_option_choice,base_report_to_printer.printing_group_manager,1,1,1,1
+access_printer_option,access_printer_option,model_printer_option,base.group_user,1,0,0,0

printer_custom_options/static/description/index.html

@@ -0,0 +1,418 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.15.1: http://docutils.sourceforge.net/" />
+<title>Report to printer - Custom Printer Options</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="report-to-printer-custom-printer-options">
+<h1 class="title">Report to printer - Custom Printer Options</h1>
+
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/compassionCH/compassion-modules/tree/11.0/printer_custom_options"><img alt="compassionCH/compassion-modules" src="https://img.shields.io/badge/github-compassionCH%2Fcompassion--modules-lightgray.png?logo=github" /></a></p>
+<p>Allow to retrieve a subset of printer options using CUPS,
+define which should be used depending on the report and finally set the correct options on the print jobs.</p>
+<p><strong>Table of contents</strong></p>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference internal" href="#bug-tracker" id="id1">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="id2">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="id3">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="id4">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="id5">Maintainers</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="bug-tracker">
+<h1><a class="toc-backref" href="#id1">Bug Tracker</a></h1>
+<p>Bugs are tracked on <a class="reference external" href="https://github.com/compassionCH/compassion-modules/issues">GitHub Issues</a>.
+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
+<a class="reference external" href="https://github.com/compassionCH/compassion-modules/issues/new?body=module:%20printer_custom_options%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<p>Do not contact contributors directly about support or help with technical issues.</p>
+</div>
+<div class="section" id="credits">
+<h1><a class="toc-backref" href="#id2">Credits</a></h1>
+<div class="section" id="authors">
+<h2><a class="toc-backref" href="#id3">Authors</a></h2>
+<ul class="simple">
+<li>Compassion CH</li>
+</ul>
+</div>
+<div class="section" id="contributors">
+<h2><a class="toc-backref" href="#id4">Contributors</a></h2>
+<p>Nicolas Bornand
+Quentin Gigon &lt;<a class="reference external" href="mailto:gigon.quentin&#64;gmail.com">gigon.quentin&#64;gmail.com</a>&gt;</p>
+</div>
+<div class="section" id="maintainers">
+<h2><a class="toc-backref" href="#id5">Maintainers</a></h2>
+<p>This module is maintained by Compassion Switzerland.</p>
+<a class="reference external image-reference" href="https://www.compassion.ch"><img alt="Compassion Switzerland" src="https://upload.wikimedia.org/wikipedia/en/8/83/CompassionInternationalLogo.png" /></a>
+<p>Compassion Switzerland is a nonprofit organization whose
+mission is to release children from extreme poverty in Jesus name.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/compassionCH/compassion-modules/tree/11.0/printer_custom_options">compassionCH/compassion-modules</a> project on GitHub.</p>
+<p>You are welcome to contribute.</p>
+</div>
+</div>
+</div>
+</body>
+</html>

printer_custom_options/tests/__init__.py

@@ -0,0 +1,4 @@
+# Copyright 2019 Compassion
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from . import test_printing_printer

printer_custom_options/tests/test_printing_printer.py

@@ -0,0 +1,105 @@
+# Copyright 2019 Compassion
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+import mock
+import types
+from odoo.tests.common import TransactionCase
+
+server_model = 'odoo.addons.base_report_to_printer.models.printing_server'
+
+
+class TestPrintingPrinter(TransactionCase):
+
+    def setUp(self):
+        super().setUp()
+        self.server = self.env['printing.server'].create({})
+        self.ServerModel = self.env['printing.server']
+        self.printer = self.env['printing.printer'].create({
+            'name': 'Printer',
+            'server_id': self.server.id,
+            'system_name': 'Sys Name',
+            'default': True,
+            'status': 'unknown',
+            'status_message': 'Msg',
+            'model': 'res.users',
+            'location': 'Location',
+            'uri': 'URI',
+        })
+        self.bin_option = self.env['printer.option.choice'].create({
+            'option_key': 'OutputBin',
+            'option_value': 'bin1',
+            'printer_id': self.printer.id,
+        })
+        self.printer_vals = {
+            'printer-info': 'Info',
+            'printer-make-and-model': 'Make and Model',
+            'printer-location': "location",
+            'device-uri': 'URI',
+            'printer-uri-supported': '/' + self.printer.system_name
+        }
+
+    def test_print_options__copies_options_from_report(self):
+        mock_report = mock.Mock()
+        mock_report.printer_options = [self.bin_option]
+
+        options = self.printer \
+            .print_options(report=mock_report)
+
+        self.assertEqual(options['OutputBin'], 'bin1')
+
+    def test_print_options__without_option(self):
+        mock_report = mock.Mock()
+        mock_report.printer_options = []
+
+        options = self.printer \
+            .print_options(report=mock_report)
+
+        self.assertEqual(options, {})
+
+    @mock.patch('%s.cups' % server_model)
+    def test_prepare_update_from_cups__load_options(self, patched_cups):
+        patched_cups.Connection.return_value.getPPD3.return_value = (200, 1, None)
+        self._mock_cups_options(self.printer, [])
+
+        self.printer._prepare_update_from_cups(
+            patched_cups.Connection(), self.printer_vals)
+
+        self.assertEqual(len(self.printer.printer_options), 1)
+        self.assertEqual(self.printer.printer_options[0].option_key,
+                         'OutputBin')
+
+    @mock.patch('%s.cups' % server_model)
+    def test_prepare_update_from_cups(self, patched_cups):
+        patched_cups.Connection.return_value.getPPD3.return_value = (200, 1, None)
+        self._mock_cups_options(self.printer,
+                                [{'choice': 'bin1'},
+                                 {'choice': 'bin2'}])
+
+        vals = self.printer._prepare_update_from_cups(
+            patched_cups.Connection(), self.printer_vals)
+
+        # OutputBin:bin1 was already inserted
+        self.assertEqual(len(vals['printer_option_choices']), 1)
+        self.assertIn((0, 0,
+                       {'option_key': 'OutputBin', 'option_value': 'bin2'}),
+                      vals['printer_option_choices'])
+        self.assertNotIn((0, 0,
+                          {'option_key': 'OutputBin', 'option_value': 'bin1'}),
+                         vals['printer_option_choices'])
+
+    def _mock_cups_options(self, printer,
+                           choices):
+        def mock__get_cups_ppd(*args):
+            mock_ppd = mock.Mock()
+            # Mock optionGroups
+            mock_option_group = mock.Mock()
+            mock_option = mock.Mock()
+            mock_option.keyword = 'OutputBin'
+            mock_option.choices = choices
+            mock_option_group.options = [mock_option]
+            mock_ppd.optionGroups = [mock_option_group]
+            # Mock findOption
+            mock_ppd.findOption = lambda x: mock_option
+            return 'pdd_path', mock_ppd
+
+        printer._get_cups_ppd = \
+            types.MethodType(mock__get_cups_ppd, self.printer)

printer_custom_options/views/ir_actions_reports_xml_view.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0"?>
+<odoo>
+  <record model="ir.ui.view" id="act_report_xml_view">
+    <field name="name">ir.actions.report.printing_options</field>
+    <field name="model">ir.actions.report</field>
+    <field name="inherit_id" ref="base.act_report_xml_view" />
+    <field name="arch" type="xml">
+      <xpath expr="//field[@name='printing_printer_id']" position="after" >
+          <field name="printer_options" widget="many2many_tags"
+                 domain="[('printer_id', '=', printing_printer_id)]"
+                 options="{'no_create': True}"/>
+      </xpath>
+    </field>
+  </record>
+</odoo>

printer_custom_options/views/printing_printer.xml

@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+  <data>
+    <record model="ir.ui.view" id="printing_printer_view_form">
+      <field name="name">printing.printer.form</field>
+      <field name="model">printing.printer</field>
+      <field name="inherit_id" ref="base_report_to_printer.printing_printer_view_form"/>
+      <field name="arch" type="xml">
+        <xpath expr="//sheet/group[3]" position="after">
+          <group string="Printer Options Selected">
+            <field name="printer_options" widget="many2many_tags"
+                   domain="[('printer_id', '=', active_id)]"/>
+            <field name="printer_option_choices"/>
+          </group>
+        </xpath>
+      </field>
+    </record>
+  </data>
+</odoo>