Added QR code element (#146)

classes/element.php

@@ -245,6 +245,7 @@ abstract class element {
             element_helper::render_form_element_position($mform);
         }
         element_helper::render_form_element_width($mform);
+        element_helper::render_form_element_refpoint($mform);
     }
 
     /**

classes/element_helper.php

@@ -186,10 +186,19 @@ class element_helper {
         $mform->setType('width', PARAM_INT);
         $mform->setDefault('width', 0);
         $mform->addHelpButton('width', 'elementwidth', 'customcert');
+    }
+
+    /**
+     * Helper function to render the refpoint element.
+     *
+     * @param \mod_customcert\edit_element_form $mform the edit_form instance.
+     */
+    public static function render_form_element_refpoint($mform) {
         $refpointoptions = array();
         $refpointoptions[self::CUSTOMCERT_REF_POINT_TOPLEFT] = get_string('topleft', 'customcert');
         $refpointoptions[self::CUSTOMCERT_REF_POINT_TOPCENTER] = get_string('topcenter', 'customcert');
         $refpointoptions[self::CUSTOMCERT_REF_POINT_TOPRIGHT] = get_string('topright', 'customcert');
+
         $mform->addElement('select', 'refpoint', get_string('refpoint', 'customcert'), $refpointoptions);
         $mform->setType('refpoint', PARAM_INT);
         $mform->setDefault('refpoint', self::CUSTOMCERT_REF_POINT_TOPCENTER);

element/qrcode/classes/element.php

@@ -0,0 +1,202 @@
+<?php
+// This file is part of the customcert module for Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * This file contains the customcert element QR code's core interaction API.
+ *
+ * @package    customcertelement_qrcode
+ * @copyright  2019 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace customcertelement_qrcode;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->libdir . '/tcpdf/tcpdf_barcodes_2d.php');
+
+/**
+ * The customcert element QR code's core interaction API.
+ *
+ * @package    customcertelement_qrcode
+ * @copyright  2019 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class element extends \mod_customcert\element {
+
+
+    const BARCODETYPE = 'QRCODE';
+
+    /**
+     * This function renders the form elements when adding a customcert element.
+     *
+     * @param \mod_customcert\edit_element_form $mform the edit_form instance
+     */
+    public function render_form_elements($mform) {
+        \mod_customcert\element_helper::render_form_element_width($mform);
+
+        $mform->addElement('text', 'height', get_string('height', 'customcertelement_qrcode'), array('size' => 10));
+        $mform->setType('height', PARAM_INT);
+        $mform->setDefault('height', 0);
+        $mform->addHelpButton('height', 'height', 'customcertelement_qrcode');
+
+        if ($this->showposxy) {
+            \mod_customcert\element_helper::render_form_element_position($mform);
+        }
+    }
+
+    /**
+     * Performs validation on the element values.
+     *
+     * @param array $data the submitted data
+     * @param array $files the submitted files
+     * @return array the validation errors
+     */
+    public function validate_form_elements($data, $files) {
+        // Array to return the errors.
+        $errors = [];
+
+        // Check if height is not set, or not numeric or less than 0.
+        if ((!isset($data['height'])) || (!is_numeric($data['height'])) || ($data['height'] < 0)) {
+            $errors['height'] = get_string('invalidheight', 'customcertelement_qrcode');
+        }
+
+        if ($this->showposxy) {
+            $errors += \mod_customcert\element_helper::validate_form_element_position($data);
+        }
+
+        $errors += \mod_customcert\element_helper::validate_form_element_width($data);
+
+        return $errors;
+    }
+
+    /**
+     * This will handle how form data will be saved into the data column in the
+     * customcert_elements table.
+     *
+     * @param \stdClass $data the form data
+     * @return string the json encoded array
+     */
+    public function save_unique_data($data) {
+        $arrtostore = [
+            'width' => !empty($data->width) ? (int)$data->width : 0,
+            'height' => !empty($data->height) ? (int)$data->height : 0
+        ];
+
+        return json_encode($arrtostore);
+    }
+
+    /**
+     * Sets the data on the form when editing an element.
+     *
+     * @param \mod_customcert\edit_element_form $mform the edit_form instance
+     */
+    public function definition_after_data($mform) {
+        parent::definition_after_data($mform);
+
+        // Set the image, width, height and alpha channel for this element.
+        if (!empty($this->get_data())) {
+            $imageinfo = json_decode($this->get_data());
+
+            if (!empty($imageinfo->height)) {
+                $element = $mform->getElement('height');
+                $element->setValue($imageinfo->height);
+            }
+        }
+    }
+
+    /**
+     * Handles rendering the element on the pdf.
+     *
+     * @param \pdf $pdf the pdf object
+     * @param bool $preview true if it is a preview, false otherwise
+     * @param \stdClass $user the user we are rendering this for
+     */
+    public function render($pdf, $preview, $user) {
+        global $DB;
+
+        // If there is no element data, we have nothing to display.
+        if (empty($this->get_data())) {
+            return;
+        }
+
+        $imageinfo = json_decode($this->get_data());
+
+        if ($preview) {
+            // Generate the URL to verify this.
+            $qrcodeurl = new \moodle_url('/');
+            $qrcodeurl = $qrcodeurl->out(false);
+        } else {
+            // Get the information we need.
+            $sql = "SELECT c.id, ct.contextid, ci.code
+                      FROM {customcert_issues} ci
+                      JOIN {customcert} c
+                        ON ci.customcertid = c.id
+                      JOIN {customcert_templates} ct
+                        ON c.templateid = ct.id
+                      JOIN {customcert_pages} cp
+                        ON cp.templateid = ct.id
+                     WHERE ci.userid = :userid
+                       AND cp.id = :pageid";
+
+            // Now we can get the issue for this user.
+            $issue = $DB->get_record_sql($sql, array('userid' => $user->id, 'pageid' => $this->get_pageid()),
+                '*', MUST_EXIST);
+            $code = $issue->code;
+
+            // Generate the URL to verify this.
+            $qrcodeurl = new \moodle_url('/mod/customcert/verify_certificate.php',
+                [
+                    'contextid' => $issue->contextid,
+                    'code' => $code,
+                    'qrcode' => 1
+                ]
+            );
+            $qrcodeurl = $qrcodeurl->out(false);
+        }
+
+        $barcode = new \TCPDF2DBarcode($qrcodeurl, self::BARCODETYPE);
+        $image = $barcode->getBarcodePngData($imageinfo->width, $imageinfo->height);
+
+        $location = make_request_directory() . '/target';
+        file_put_contents($location, $image);
+
+        $pdf->Image($location, $this->get_posx(), $this->get_posy(), $imageinfo->width, $imageinfo->height);
+    }
+
+    /**
+     * Render the element in html.
+     *
+     * This function is used to render the element when we are using the
+     * drag and drop interface to position it.
+     *
+     * @return string the html
+     */
+    public function render_html() {
+        // If there is no element data, we have nothing to display.
+        if (empty($this->get_data())) {
+            return;
+        }
+
+        $imageinfo = json_decode($this->get_data());
+
+        $qrcodeurl = new \moodle_url('/');
+        $qrcodeurl = $qrcodeurl->out(false);
+
+        $barcode = new \TCPDF2DBarcode($qrcodeurl, self::BARCODETYPE);
+        return $barcode->getBarcodeHTML($imageinfo->width / 10, $imageinfo->height / 10);
+    }
+}

element/qrcode/classes/privacy/provider.php

@@ -0,0 +1,46 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Privacy Subsystem implementation for customcertelement_qrcode.
+ *
+ * @package    customcertelement_qrcode
+ * @copyright  2019 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace customcertelement_qrcode\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Privacy Subsystem for customcertelement_qrcode implementing null_provider.
+ *
+ * @copyright  2019 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider {
+
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return  string
+     */
+    public static function get_reason() : string {
+        return 'privacy:metadata';
+    }
+}

element/qrcode/lang/en/customcertelement_qrcode.php

@@ -0,0 +1,30 @@
+<?php
+// This file is part of the customcert module for Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Strings for component 'customcertelement_qrcode', language 'en'.
+ *
+ * @package    customcertelement_qrcode
+ * @copyright  2019 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['height'] = 'Height';
+$string['height_help'] = 'Height help';
+$string['pluginname'] = 'QR code';
+$string['privacy:metadata'] = 'The QR code plugin does not store any personal data.';
+$string['width'] = 'Width';
+$string['width_help'] = 'width help';

element/qrcode/version.php

@@ -0,0 +1,29 @@
+<?php
+// This file is part of the customcert module for Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * This file contains the version information for the QR code plugin.
+ *
+ * @package    customcertelement_qrcode
+ * @copyright  2019 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die('Direct access to this script is forbidden.');
+
+$plugin->version   = 2018120300; // The current module version (Date: YYYYMMDDXX).
+$plugin->requires  = 2018120300; // Requires this Moodle version (3.6).
+$plugin->component = 'customcertelement_qrcode';

verify_certificate.php

@@ -28,6 +28,7 @@ require_once('../../config.php');
 
 $contextid = optional_param('contextid', context_system::instance()->id, PARAM_INT);
 $code = optional_param('code', '', PARAM_ALPHANUM); // The code for the certificate we are verifying.
+$qrcode = optional_param('qrcode', false, PARAM_BOOL);
 
 $context = context::instance_by_id($contextid);
 
@@ -87,7 +88,7 @@ if ($checkallofsite) {
 // The form we are using to verify these codes.
 $form = new \mod_customcert\verify_certificate_form($pageurl);
 
-if ($form->get_data()) {
+if ($code) {
     $result = new stdClass();
     $result->issues = array();
 
@@ -128,7 +129,10 @@ if ($form->get_data()) {
 
 echo $OUTPUT->header();
 echo $OUTPUT->heading($heading);
-echo $form->display();
+// Don't show the form if we are coming from a QR code.
+if (!$qrcode) {
+    echo $form->display();
+}
 if (isset($result)) {
     $renderer = $PAGE->get_renderer('mod_customcert');
     $result = new \mod_customcert\output\verify_certificate_results($result);