question.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/>.

/**
 * PoodLL Recording question definition class.
 *
 * @package    qtype
 * @subpackage cloudpoodll
 * @copyright  2019 Justin Hunt (poodllsupport@gmail.com)
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

use qtype_cloudpoodll\constants;

/**
 * Represents a cloudpoodll question.
 *
 * @copyright  2019 Justin Hunt (poodllsupport@gmail.com)
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class qtype_cloudpoodll_question extends question_with_responses {
    public $responseformat;
    public $graderinfo;
    public $graderinfoformat;
    public $qresource;
    public $language;
    public $expiredays;
    public $transcriber;
    public $studentplayer;
    public $teacherplayer;
    public $transcode;
    public $audioskin;
    public $videoskin;
    public $timelimit;
    public $safesave;
    public $noaudiofilters;
    public $whiteboardwidth;
    public $whiteboardheight;

    public function make_behaviour(question_attempt $qa, $preferredbehaviour) {
        question_engine::load_behaviour_class('manualgraded');
        return new qbehaviour_manualgraded($qa, $preferredbehaviour);
    }

    /**
     * @param moodle_page the page we are outputting to.
     * @return qtype_cloudpoodll_format_base_renderer the response-format-specific renderer.
     */
    public function get_format_renderer(moodle_page $page) {
        return $page->get_renderer(constants::M_COMP, $this->responseformat);
    }

    /**
     *    This tells Moodle what fields to expect, in particular it tells it
     *   to look for uploaded file URLs in the answer field
     */
    public function get_expected_data() {
        if ($this->responseformat === 'whiteboard') {
            $expecteddata = ['answer' => question_attempt::PARAM_RAW_FILES];
        } else {
            $expecteddata = ['answer' => PARAM_RAW];
        }
        $expecteddata['answermediaurl'] = PARAM_URL;
        $expecteddata['answertranscript'] = PARAM_TEXT;
        $expecteddata['answerdetails'] = PARAM_RAW;
        $expecteddata['answervector'] = PARAM_RAW;
        $expecteddata['answer_draftid'] = PARAM_INT;
        return $expecteddata;
    }


    public function summarise_response(array $response) {
        if ($this->responseformat === 'whiteboard') {
            return (string) ($response['answer'] ?? '');
        }
        if (isset($response['answer']) && !empty($response['answer']) && $response['answer'] !== constants::BLANK) {
            return pathinfo($response['answermediaurl'] ?? $response['answer'], PATHINFO_BASENAME);
        } else if (isset($response['answertranscript']) &&
                !empty($response['answertranscript'] && $response['answertranscript'] !== constants::BLANK) &&
                strpos($response['answertranscript'], 'http') !== 0
        ) {
            return $response['answertranscript'];
        } else if ((isset($response['answermediaurl']) && !empty($response['answermediaurl']) && $response['answermediaurl'] !== constants::BLANK)) {
            return $response['answermediaurl'];
        } else {
            return null;
        }
    }

    public function get_correct_response() {
        return null;
    }

    /**
     * Is the response complete?
     *
     * @param array $response the response to check.
     * @return bool true if the response is complete.
     */
    public function is_complete_response(array $response) {
        return $this->is_answered($response);
    }

    /**
     * Is the response gradable?
     *
     * @param array $response the response to check.
     * @return bool true if the response is gradable.
     */
    public function is_gradable_response(array $response) {
        return $this->is_answered($response);
    }

    /**
     * Check if the question has been answered.
     * We check the answer field, but also the mediaurl and the details field.
     * The details field is checked for successful upload events to ensure we match the status message
     * shown above the recorder in the question display.
     * We don't check for transcript because it may not be configured or arrive in time.
     */
    protected function is_answered(array $response) {
        $answer = (string) ($response['answer'] ?? '');
        if (!empty($answer) && $answer !== constants::BLANK) {
            return true;
        }
        if (!empty($response['answervector']) && $response['answervector'] !== constants::BLANK) {
            return true;
        }
        if (!empty($response['answermediaurl']) && $response['answermediaurl'] !== constants::BLANK) {
            return true;
        }
        if (!empty($response['answerdetails'])) {
            $reclog = json_decode($response['answerdetails']);
            if (json_last_error() === JSON_ERROR_NONE && isset($reclog->recevents)) {
                foreach ($reclog->recevents as $recevent) {
                    if ($recevent->type === 'awaitingconversion' ||
                        $recevent->type === 'awaitingprocessing' ||
                        $recevent->type === 'filesubmitted') {
                        return true;
                    }
                }
            }
        }
        return false;
    }

    public function is_same_response(array $prevresponse, array $newresponse) {
        $anssame = question_utils::arrays_same_at_key_missing_is_blank(
                $prevresponse, $newresponse, 'answer');

        $vec1 = $prevresponse['answervector'] ?? '';
        $vec2 = $newresponse['answervector'] ?? '';

        // Handle question_file_loader objects by casting to string.
        $vec1 = (string) $vec1;
        $vec2 = (string) $vec2;

        // Treat empty string and empty JSON array as the same.
        if ($vec1 === '[]') {
            $vec1 = '';
        }
        if ($vec2 === '[]') {
            $vec2 = '';
        }

        return $anssame && ($vec1 === $vec2);
    }

    public function check_file_access($qa, $options, $component, $filearea, $args, $forcedownload) {
        // print_object($qa);
        if ($component == 'question' && $filearea == 'response_answer') {
            // since we will put files in respnse_answer, this is likely to be always true.
            return true;

            // if we are using a qresource, there is no need to restrict here
        } else if ($component == constants::M_COMP && $filearea == \qtype_cloudpoodll\constants::FILEAREA_QRESOURCE) {
            return true;

        } else if ($component == constants::M_COMP && $filearea == \qtype_cloudpoodll\constants::FILEAREA_GRADERINFO) {
            return $options->manualcomment;

        } else {
            return parent::check_file_access($qa, $options, $component,
                    $filearea, $args, $forcedownload);

        }
    }
}