Skip to content
Snippets Groups Projects
Select Git revision
  • 91cc3b285d49276d7316144cec364929b7115beb
  • master default protected
  • hsh_v4.5
  • hsh_v4-4
  • hsh_v4.4
  • hsh_v4.3
  • hsh_v4.1.x
  • hsh_v4.2
  • hsh_v4.1
  • hsh_v3.11
  • hsh_3.10
  • v3.11-r2-hsh
  • v3.11-r2
  • v3.11-r1
  • v3.10-r1
  • v3.9-r1
  • v3.8-r2
  • v3.8-r1
  • v3.7-r1
19 results

lib.php

Blame
  • ajax.php 9.91 KiB
    <?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/>.
    /**
     * Responsible for handling AJAX requests related to H5P.
     *
     * @package    mod_hvp
     * @copyright  2016 Joubel AS <contact@joubel.com>
     * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
     */
    
    define('AJAX_SCRIPT', true);
    require(__DIR__ . '/../../config.php');
    require_once($CFG->libdir . '/filelib.php');
    require_once("locallib.php");
    
    require_login();
    
    $action = required_param('action', PARAM_ALPHA);
    switch($action) {
    
        /*
         * Handle user data reporting
         *
         * Type: HTTP POST
         *
         * Parameters:
         *  - content_id
         *  - data_type
         *  - sub_content_id
         */
        case 'contentsuserdata':
            \mod_hvp\content_user_data::handle_ajax();
            break;
    
        /*
         * Handle restricting H5P libraries
         *
         * Type: HTTP GET
         *
         * Parameters:
         *  - library_id
         *  - restrict (0 or 1)
         *  - token
         */
        case 'restrictlibrary':
    
            // Check permissions.
            $context = \context_system::instance();
            if (!has_capability('mod/hvp:restrictlibraries', $context)) {
                \H5PCore::ajaxError(get_string('nopermissiontorestrict', 'hvp'));
                http_response_code(403);
                break;
            }
    
            $libraryid = required_param('library_id', PARAM_INT);
            $restrict = required_param('restrict', PARAM_INT);
    
            if (!\H5PCore::validToken('library_' . $libraryid, required_param('token', PARAM_RAW))) {
                \H5PCore::ajaxError(get_string('invalidtoken', 'hvp'));
                exit;
            }
    
            hvp_restrict_library($libraryid, $restrict);
            header('Cache-Control: no-cache');
            header('Content-Type: application/json');
            echo json_encode(array(
                'url' => (new moodle_url('/mod/hvp/ajax.php', array(
                    'action' => 'restrict_library',
                    'token' => \H5PCore::createToken('library_' . $libraryid),
                    'restrict' => ($restrict === '1' ? 0 : 1),
                    'library_id' => $libraryid
                )))->out(false)));
            break;
    
        /*
         * Collecting data needed by H5P content upgrade
         *
         * Type: HTTP GET
         *
         * Parameters:
         *  - library (Format: /<machine-name>/<major-version>/<minor-version>)
         */
        case 'getlibrarydataforupgrade':
    
            // Check permissions.
            $context = \context_system::instance();
            if (!has_capability('mod/hvp:updatelibraries', $context)) {
                \H5PCore::ajaxError(get_string('nopermissiontoupgrade', 'hvp'));
                http_response_code(403);
                break;
            }
    
            $library = required_param('library', PARAM_TEXT);
            $library = explode('/', substr($library, 1));
    
            if (count($library) !== 3) {
                http_response_code(422);
                return;
            }
    
            $library = hvp_get_library_upgrade_info($library[0], $library[1], $library[2]);
    
            header('Cache-Control: no-cache');
            header('Content-Type: application/json');
            print json_encode($library);
    
            break;
    
        /*
         * Saving upgraded content, and returning next batch to process
         *
         * Type: HTTP POST
         *
         * Parameters:
         *  - library_id
         */
        case 'libraryupgradeprogress':
            // Check upgrade permissions.
            $context = \context_system::instance();
            if (!has_capability('mod/hvp:updatelibraries', $context)) {
                \H5PCore::ajaxError(get_string('nopermissiontoupgrade', 'hvp'));
                http_response_code(403);
                break;
            }
    
            // Because of a confirmed bug in PHP, filter_input(INPUT_SERVER, ...)
            // will return null on some versions of FCGI/PHP (5.4 and probably
            // older versions as well), ref. https://bugs.php.net/bug.php?id=49184.
            if ($_SERVER['REQUEST_METHOD'] === 'POST') {
                $libraryid = required_param('library_id', PARAM_INT);
                $out = hvp_content_upgrade_progress($libraryid);
                header('Cache-Control: no-cache');
                header('Content-Type: application/json');
                print json_encode($out);
            } else {
                // Only allow POST.
                http_response_code(405);
            }
            break;
    
        /*
         * Handle set finished / storing grades
         *
         * Type: HTTP GET
         *
         * Parameters:
         *  - contentId
         *  - score
         *  - maxScore
         */
        case 'setfinished':
            \mod_hvp\user_grades::handle_ajax();
            break;
    
        /*
         * Saves a dynamically graded grade to the gradebook
         *
         * Type: HTTP POST
         *
         * Parameters:
         *  - subcontent_id
         *  - score
         */
        case 'updatesubcontentscore':
            \mod_hvp\user_grades::handle_dynamic_grading();
            break;
    
        /*
         * Returns a grade
         *
         * Type: HTTP GET
         *
         * Parameters:
         *  - subcontent_id
         */
        case 'getsubcontentscore':
            \mod_hvp\user_grades::return_subcontent_grade();
            break;
    
        /*
         * Provide data for results view
         *
         * Type: HTTP GET
         *
         * Parameters:
         *  int content_id
         *  int offset
         *  int limit
         *  int sortBy
         *  int sortDir
         *  string[] filters
         */
        case 'results':
            $results = new \mod_hvp\results();
            $results->print_results();
            break;
    
        /*
         * Load list of libraries or details for library.
         *
         * Parameters:
         *  string machineName
         *  int majorVersion
         *  int minorVersion
         */
        case 'libraries':
            if (!\mod_hvp\framework::has_editor_access('nopermissiontoviewcontenttypes')) {
                break;
            }
    
            // Get parameters.
            $name = optional_param('machineName', '', PARAM_TEXT);
            $major = optional_param('majorVersion', 0, PARAM_INT);
            $minor = optional_param('minorVersion', 0, PARAM_INT);
            $editor = \mod_hvp\framework::instance('editor');
            $language = optional_param('default-language', null, PARAM_RAW);
    
            if (!empty($name)) {
                $editor->ajax->action(H5PEditorEndpoints::SINGLE_LIBRARY, $name,
                    $major, $minor, \mod_hvp\framework::get_language(), '', '', $language);
    
                new \mod_hvp\event(
                        'library', null,
                        null, null,
                        $name, $major . '.' . $minor
                );
            } else {
                $editor->ajax->action(H5PEditorEndpoints::LIBRARIES);
            }
    
            break;
    
        /*
         * Load content type cache list to display available libraries in hub
         */
        case 'contenttypecache':
            if (!\mod_hvp\framework::has_editor_access('nopermissiontoviewcontenttypes')) {
                break;
            }
    
            $editor = \mod_hvp\framework::instance('editor');
            $editor->ajax->action(H5PEditorEndpoints::CONTENT_TYPE_CACHE);
            break;
    
        /*
         * Handle file upload through the editor.
         *
         * Parameters:
         *  int contentId
         *  int contextId
         */
        case 'files':
            $token = required_param('token', PARAM_RAW);
            $contentid = required_param('contentId', PARAM_INT);
            if (!\mod_hvp\framework::has_editor_access('nopermissiontouploadfiles')) {
                break;
            }
    
            $editor = \mod_hvp\framework::instance('editor');
            $editor->ajax->action(H5PEditorEndpoints::FILES, $token, $contentid);
            break;
    
        /*
         * Handle file upload through the editor.
         *
         * Parameters:
         *  raw token
         *  raw contentTypeUrl
         */
        case 'libraryinstall':
            $token = required_param('token', PARAM_RAW);
            $machinename = required_param('id', PARAM_TEXT);
            $editor = \mod_hvp\framework::instance('editor');
            $editor->ajax->action(H5PEditorEndpoints::LIBRARY_INSTALL, $token, $machinename);
            break;
    
        /*
         * Install libraries from h5p and retrieve content json
         *
         * Parameters:
         *  file h5p
         */
        case 'libraryupload':
            $token = required_param('token', PARAM_RAW);
            if (!\mod_hvp\framework::has_editor_access('nopermissiontouploadcontent')) {
                break;
            }
    
            $editor = \mod_hvp\framework::instance('editor');
            $uploadpath = $_FILES['h5p']['tmp_name'];
            $contentid = optional_param('contentId', 0, PARAM_INT);
            $editor->ajax->action(H5PEditorEndpoints::LIBRARY_UPLOAD, $token, $uploadpath, $contentid);
            break;
    
        /*
         * Record xAPI result from view
         */
        case 'xapiresult':
            \mod_hvp\xapi_result::handle_ajax();
            break;
    
        case 'translations':
            if (!\mod_hvp\framework::has_editor_access('nopermissiontogettranslations')) {
                break;
            }
            $language = required_param('language', PARAM_RAW);
            $editor = \mod_hvp\framework::instance('editor');
            $editor->ajax->action(H5PEditorEndpoints::TRANSLATIONS, $language);
            break;
    
        /*
         * Handle filtering of parameters through AJAX.
         */
        case 'filter':
            $token = required_param('token', PARAM_RAW);
            $libraryparameters = required_param('libraryParameters', PARAM_RAW);
    
            if (!\mod_hvp\framework::has_editor_access('nopermissiontouploadfiles')) {
                break;
            }
    
            $editor = \mod_hvp\framework::instance('editor');
            $editor->ajax->action(H5PEditorEndpoints::FILTER, $token, $libraryparameters);
            break;
    
        /*
         * Throw error if AJAX isnt handeled
         */
        default:
            throw new coding_exception('Unhandled AJAX');
            break;
    }