item_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/editing an item.
 *
 * @package    mod_mediagallery
 * @copyright  NetSpot Pty Ltd
 * @author     Adam Olley <adam.olley@netspot.com.au>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

require_once($CFG->libdir.'/formslib.php');
require_once($CFG->dirroot.'/mod/mediagallery/locallib.php');
require_once($CFG->dirroot.'/mod/mediagallery/classes/quickform/limitedurl.php');
require_once($CFG->dirroot.'/mod/mediagallery/classes/quickform/uploader.php');
require_once($CFG->dirroot.'/mod/mediagallery/classes/quickform/uploader_standard.php');

/**
 * Module instance settings form.
 *
 * @copyright Copyright (c) 2017 Blackboard Inc.
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class mod_mediagallery_item_form extends moodleform {

    /**
     * Defines forms elements
     */
    public function definition() {
        global $CFG;

        $mform = $this->_form;
        $gallery = $this->_customdata['gallery'];
        $item = $this->_customdata['item'];

        // General settings.
        $mform->addElement('header', 'general', get_string('general', 'form'));

        $mform->addElement('text', 'caption', get_string('caption', 'mediagallery'), array('size' => '64'));
        $mform->setType('caption', PARAM_TEXT);
        $mform->addRule('caption', get_string('maximumchars', '', 255), 'maxlength', 255, 'client');
        $mform->addHelpButton('caption', 'caption', 'mediagallery');

        $options = array(
            'collapsed' => true,
            'maxfiles' => 0,
            'return_types' => null,
        );
        $mform->addElement('editor', 'description', get_string('description'), null, $options);

        $mform->addElement('selectyesno', 'display', get_string('itemdisplay', 'mediagallery'));
        $mform->setDefault('display', 1);
        $mform->addHelpButton('display', 'itemdisplay', 'mediagallery');

        $mform->addElement('selectyesno', 'thumbnail', get_string('gallerythumbnail', 'mediagallery'));
        $default = $this->_customdata['firstitem'] ? 1 : 0;
        $mform->setDefault('thumbnail', $default);
        $mform->addHelpButton('thumbnail', 'gallerythumbnail', 'mediagallery');

        $mform->addElement('static', 'filecheck', '', get_string('choosecontent', 'mediagallery'));

        if ($gallery->mode == 'standard') {
            $mform->addElement('uploader_standard', 'content', get_string('content', 'mediagallery'), '0',
                mediagallery_filepicker_options($gallery));
            $mform->addHelpButton('content', 'content', 'mediagallery');

            $fpoptions = mediagallery_filepicker_options($gallery);
            $fpoptions['accepted_types'] = array('web_image');
            $fpoptions['return_types'] = FILE_INTERNAL;
            $mform->addElement('filepicker', 'customthumbnail', get_string('thumbnail', 'mediagallery'), '0', $fpoptions);
            $mform->addHelpButton('customthumbnail', 'thumbnail', 'mediagallery');
        } else if ($gallery->mode == 'youtube') {
            $mform->addElement('limitedurl', 'externalurl', get_string('youtubeurl', 'mediagallery'), array('size' => '60'),
                array('usefilepicker' => true, 'repo' => 'youtube'));
            $mform->setType('externalurl', PARAM_TEXT);
            $mform->addHelpButton('externalurl', 'externalurl', 'mediagallery');
        } else if ($gallery->mode == 'thebox') {
            if (empty($item->objectid)) {
                $mform->addElement('uploader', 'content', get_string('content', 'mediagallery'), '0',
                    array('maxfiles' => 1, 'return_types' => FILE_REFERENCE, 'repo' => 'thebox'));
                $mform->addHelpButton('content', 'content', 'mediagallery');
            } else {
                $mform->removeElement('filecheck');
                $mform->addElement('static', 'contentlinked', get_string('content', 'mediagallery'),
                    get_string('contentlinkedinfo', 'mediagallery', $item->get_file()->get_filename()));
                $mform->addHelpButton('contentlinked', 'contentlinked', 'mediagallery');
            }
        }

        $lockfields = $item && !$item->user_can_edit() ? true : false;

        $mform->addElement('tags', 'tags', get_string('tags'),
                            ['itemtype' => 'mediagallery_item', 'component' => 'mod_mediagallery']);

        if ($lockfields) {
            $mform->hardFreeze('caption');
            $mform->hardFreeze('description');
            $mform->hardFreeze('tags');
        }

        // Advanced settings.
        $mform->addElement('header', 'advanced', get_string('advanced'));
        mediagallery_add_metainfo_fields($mform);

        $mform->addElement('hidden', 'g', $gallery->id);
        $mform->setType('g', PARAM_INT);

        $mform->addElement('hidden', 'id');
        $mform->setType('id', PARAM_INT);

        $mform->addElement('hidden', 'source', 'moodle');
        $mform->setType('source', PARAM_ALPHA);
        $mform->hardFreeze('source');

        $mform->addElement('hidden', 'extpath', '');
        $mform->setType('extpath', PARAM_RAW);

        $mform->addElement('hidden', 'theme_id', '');
        $mform->setType('theme_id', PARAM_ALPHANUMEXT);

        $mform->addElement('hidden', 'copyright_id', '');
        $mform->setType('copyright_id', PARAM_ALPHANUMEXT);

        $mform->addElement('hidden', 'objectid', '');
        $mform->setType('objectid', PARAM_ALPHANUMEXT);

        $this->add_action_buttons();
    }

    /**
     * Validate user input.
     *
     * @param array $data The submitted form data.
     * @param array $files The submitted files.
     * @return array List of errors, if any.
     */
    public function validation($data, $files) {
        global $CFG;
        $errors = parent::validation($data, $files);
        $info = isset($data['content']) ? file_get_draft_area_info($data['content']) : array('filecount' => 0);
        $url = isset($data['externalurl']) ? trim($data['externalurl']) : '';

        if (empty($data['externalurl']) && $info['filecount'] == 0 && empty($data['objectid'])) {
            $errors['filecheck'] = get_string('required');
        } else if (!empty($url) && !preg_match('|^/|', $url)) {
            // Links relative to server root are ok - no validation necessary.
            if (preg_match('|^[a-z]+://|i', $url) || preg_match('|^https?:|i', $url) || preg_match('|^ftp:|i', $url)) {
                // Normal URL.
                if (!mediagallery_appears_valid_url($url)) {
                    $errors['externalurl'] = get_string('invalidurl', 'url');
                }
            } else if (!preg_match('|^[a-z]+:|i', $url)) {
                // The preg_match above has us skip general URI such as
                // teamspeak, mailto, etc. - it may or may not work in all
                // browsers. We do not validate these at all, sorry.

                // Invalid URI, we try to fix it by adding 'http://' prefix.
                // Relative links are NOT allowed because we display the link on different pages!
                require_once($CFG->dirroot."/mod/url/locallib.php");
                if (!url_appears_valid_url('http://'.$url)) {
                    $errors['externalurl'] = get_string('invalidurl', 'url');
                }
            }
        }
        return $errors;
    }

}