mod_form.php

<?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/>.
/**
 * Form for creating new H5P Content
 *
 * @package    mod_hvp
 * @copyright  2016 Joubel AS <contact@joubel.com>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

require_once($CFG->dirroot . '/course/moodleform_mod.php');

class mod_hvp_mod_form extends moodleform_mod {

    public function definition() {
        global $CFG, $DB, $OUTPUT, $COURSE, $PAGE;

        $mform =& $this->_form;

        // Name.
        $mform->addElement('text', 'name', get_string('name'));
        $mform->setType('name', PARAM_TEXT);
        $mform->addRule('name', null, 'required', null, 'client');
        $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');

        // Intro.
        if (method_exists($this, 'standard_intro_elements')) {
            $this->standard_intro_elements();
        }
        else {
            $this->add_intro_editor(false, get_string('intro', 'hvp'));
        }

        // Max grade
        $mform->addElement('text', 'maximumgrade', get_string('maximumgrade', 'hvp'));
        $mform->setType('maximumgrade', PARAM_INT);
        $mform->setDefault('maximumgrade', 10);

        // Action.
        $h5paction = array();
        $h5paction[] = $mform->createElement('radio', 'h5paction', '', get_string('upload', 'hvp'), 'upload');
        $h5paction[] = $mform->createElement('radio', 'h5paction', '', get_string('create', 'hvp'), 'create');
        $mform->addGroup($h5paction, 'h5pactiongroup', get_string('action', 'hvp'), array('<br/>'), false);
        $mform->setDefault('h5paction', 'create');

        // Upload.
        $mform->addElement('filepicker', 'h5pfile', get_string('h5pfile', 'hvp'), null,
            array('maxbytes' => $COURSE->maxbytes, 'accepted_types' => '*'));

        // Editor placeholder.
        if ($CFG->theme == 'boost' || in_array('boost', $PAGE->theme->parents)) {
          $h5peditor = array();
          $h5peditor[] = $mform->createElement('html', '<div class="h5p-editor">' . get_string('javascriptloading', 'hvp') .  '</div>');
          $mform->addGroup($h5peditor, 'h5peditorgroup', get_string('editor', 'hvp'));
        }
        else {
          $mform->addElement('static', 'h5peditor', get_string('editor', 'hvp'), '<div class="h5p-editor">' . get_string('javascriptloading', 'hvp') .  '</div>');
        }

        // Hidden fields.
        $mform->addElement('hidden', 'h5plibrary', '');
        $mform->setType('h5plibrary', PARAM_RAW);
        $mform->addElement('hidden', 'h5pparams', '');
        $mform->setType('h5pparams', PARAM_RAW);

        $core = \mod_hvp\framework::instance();
        $displayOptions = $core->getDisplayOptionsForEdit();
        if (isset($displayOptions[\H5PCore::DISPLAY_OPTION_FRAME])) {
          // Display options group.
          $mform->addElement('header', 'displayoptions', get_string('displayoptions', 'hvp'));

          $mform->addElement('checkbox', \H5PCore::DISPLAY_OPTION_FRAME, get_string('enableframe', 'hvp'));
          $mform->setType(\H5PCore::DISPLAY_OPTION_FRAME, PARAM_BOOL);
          $mform->setDefault(\H5PCore::DISPLAY_OPTION_FRAME, true);

          if (isset($displayOptions[\H5PCore::DISPLAY_OPTION_DOWNLOAD])) {
            $mform->addElement('checkbox', \H5PCore::DISPLAY_OPTION_DOWNLOAD, get_string('enabledownload', 'hvp'));
            $mform->setType(\H5PCore::DISPLAY_OPTION_DOWNLOAD, PARAM_BOOL);
            $mform->setDefault(\H5PCore::DISPLAY_OPTION_DOWNLOAD, $displayOptions[\H5PCore::DISPLAY_OPTION_DOWNLOAD]);
            $mform->disabledIf(\H5PCore::DISPLAY_OPTION_DOWNLOAD, 'frame');
          }

          if (isset($displayOptions[\H5PCore::DISPLAY_OPTION_COPYRIGHT])) {
            $mform->addElement('checkbox', \H5PCore::DISPLAY_OPTION_COPYRIGHT, get_string('enablecopyright', 'hvp'));
            $mform->setType(\H5PCore::DISPLAY_OPTION_COPYRIGHT, PARAM_BOOL);
            $mform->setDefault(\H5PCore::DISPLAY_OPTION_COPYRIGHT, $displayOptions[\H5PCore::DISPLAY_OPTION_COPYRIGHT]);
            $mform->disabledIf(\H5PCore::DISPLAY_OPTION_COPYRIGHT, 'frame');
          }
        }

        $this->standard_coursemodule_elements();

        $this->add_action_buttons();
    }

    public function data_preprocessing(&$defaultvalues) {
        global $DB;
        $core = \mod_hvp\framework::instance();

        $content = null;
        if (!empty($defaultvalues['id'])) {
            // Load Content
            $content = $core->loadContent($defaultvalues['id']);
            if ($content === null) {
                print_error('invalidhvp');
            }
        }

        // Set default maxgrade
        if (isset($content) && isset($content['id'])
            && isset($defaultvalues) && isset($defaultvalues['course'])) {

            // Get the gradeitem and set maxgrade
            $gradeitem = grade_item::fetch(array(
                'itemtype' => 'mod',
                'itemmodule' => 'hvp',
                'iteminstance' => $content['id'],
                'courseid' => $defaultvalues['course']
            ));

            if (isset($gradeitem) && isset($gradeitem->grademax)) {
                $defaultvalues['maximumgrade'] = $gradeitem->grademax;
            }
        }

        // Aaah.. we meet again h5pfile!
        $draftitemid = file_get_submitted_draft_itemid('h5pfile');
        file_prepare_draft_area($draftitemid, $this->context->id, 'mod_hvp', 'package', 0);
        $defaultvalues['h5pfile'] = $draftitemid;

        // Individual display options are not stored, must be extracted from disable.
        if (isset($defaultvalues['disable'])) {
            $h5pcore = \mod_hvp\framework::instance('core');
            $displayoptions = $h5pcore->getDisplayOptionsForEdit($defaultvalues['disable']);
            if (isset ($displayoptions[\H5PCore::DISPLAY_OPTION_FRAME])) {
              $defaultvalues[\H5PCore::DISPLAY_OPTION_FRAME] = $displayoptions[\H5PCore::DISPLAY_OPTION_FRAME];
            }
            if (isset($displayoptions[\H5PCore::DISPLAY_OPTION_DOWNLOAD])) {
              $defaultvalues[\H5PCore::DISPLAY_OPTION_DOWNLOAD] = $displayoptions[\H5PCore::DISPLAY_OPTION_DOWNLOAD];
            }
            if (isset($displayoptions[\H5PCore::DISPLAY_OPTION_COPYRIGHT])) {
              $defaultvalues[\H5PCore::DISPLAY_OPTION_COPYRIGHT] = $displayoptions[\H5PCore::DISPLAY_OPTION_COPYRIGHT];
            }
        }

        // Determine default action
        if (!get_config('mod_hvp', 'hub_is_enabled') && $content === null && $DB->get_field_sql("SELECT id FROM {hvp_libraries} WHERE runnable = 1", null, IGNORE_MULTIPLE) === false) {
          $defaultvalues['h5paction'] = 'upload';
        }

        // Set editor defaults
        $defaultvalues['h5plibrary'] = ($content === null ? 0 : H5PCore::libraryToString($content['library']));
        $defaultvalues['h5pparams'] = ($content === null ? '{}' : $core->filterParameters($content));

        // Add required editor assets.
        require_once 'locallib.php';
        \hvp_add_editor_assets($content === null ? null : $defaultvalues['id']);

        // Log editor opened
        if ($content === null) {
            new \mod_hvp\event('content', 'new');
        }
        else {
            new \mod_hvp\event(
                    'content', 'edit',
                    $content['id'],
                    $content['title'],
                    $content['library']['name'],
                    $content['library']['majorVersion'] . '.' . $content['library']['minorVersion']
            );
        }
    }

    public function validation($data, $files) {
        global $CFG;

        $errors = parent::validation($data, $files);

        // Validate max grade as a non-negative numeric value
        if (!is_numeric($data['maximumgrade']) || $data['maximumgrade'] < 0) {
            $errors['maximumgrade'] = get_string('maximumgradeerror', 'hvp');
        }

        if ($data['h5paction'] === 'upload') {
            // Validate uploaded H5P file
            if (empty($data['h5pfile'])) {
                // Field missing
                $errors['h5pfile'] = get_string('required');
            }
            else {
                $files = $this->get_draft_files('h5pfile');
                if (count($files) < 1) {
                    // No file uploaded
                    $errors['h5pfile'] = get_string('required');
                }
                else {
                    // Prepare to validate package
                    $file = reset($files);
                    $interface = \mod_hvp\framework::instance('interface');

                    $path = $CFG->tempdir . uniqid('/hvp-');
                    $interface->getUploadedH5pFolderPath($path);
                    $path .= '.h5p';
                    $interface->getUploadedH5pPath($path);
                    $file->copy_content_to($path);

                    $h5pvalidator = \mod_hvp\framework::instance('validator');
                    if (! $h5pvalidator->isValidPackage()) {
                        // Errors while validating the package
                        $infomessages =  implode('<br/>', \mod_hvp\framework::messages('info'));
                        $errormessages = implode('<br/>', \mod_hvp\framework::messages('error'));
                        $errors['h5pfile'] = ($errormessages ? $errormessages . '<br/>' : '') . $infomessages;
                    }
                }
            }
        }
        else {
            // Validate library and params used in editor
            $core = \mod_hvp\framework::instance();

            // Get library array from string
            $library = H5PCore::libraryFromString($data['h5plibrary']);
            if (!$library) {
                $errors['h5peditor'] = get_string('invalidlibrary', 'hvp');
            }
            else {
                // Check that library exists
                $library['libraryId'] = $core->h5pF->getLibraryId($library['machineName'], $library['majorVersion'], $library['minorVersion']);
                if (!$library['libraryId']) {
                    $errors['h5peditor'] = get_string('nosuchlibrary', 'hvp');
                }
                else {
                    $data['h5plibrary'] = $library;

                    // Verify that parameters are valid
                    if (empty($data['h5pparams'])) {
                        $errors['h5peditor'] = get_string('noparameters', 'hvp');
                    }
                    else {
                        $params = json_decode($data['h5pparams']);
                        if ($params === NULL) {
                            $errors['h5peditor'] = get_string('invalidparameters', 'hvp');
                        }
                        else {
                            $data['h5pparams'] = $params;
                        }
                    }
                }
            }
        }
        return $errors;
    }

    public function get_data() {
        $data = parent::get_data();
        if (!$data) {
            return false;
        }
        return $data;
    }
}