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

/**
 * Availability plugin for integration with Examus proctoring system.
 *
 * @package    availability_examus
 * @copyright  2019-2020 Maksim Burnin <maksim.burnin@gmail.com>
 * @copyright  based on work by 2017 Max Pomazuev
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

use availability_examus\state;

/**
 * Finish attempt on attempt finish event.
 *
 * @param stdClass $event Event
 */
function avalibility_examus_attempt_submitted_handler($event) {
    global $DB;

    $cmid = $event->get_context()->instanceid;

    $userid = $event->userid;
    $entries = $DB->get_records('availability_examus', [
        'userid' => $userid,
        'courseid' => $event->courseid,
        'cmid' => $cmid,
        'status' => "Started"
    ], '-id');

    foreach ($entries as $entry) {
        $entry->status = "Finished";
        $DB->update_record('availability_examus', $entry);
    }
}

/**
 * When attempt is started, update entry accordingly
 *
 * @param stdClass $event Event
 */
function avalibility_examus_attempt_started_handler($event) {
    global $DB, $SESSION;

    $attempt = $event->get_record_snapshot('quiz_attempts', $event->objectid);
    $cmid = $event->get_context()->instanceid;

    if (isset($SESSION->availibilityexamustoken)) {
        $accesscode = $SESSION->availibilityexamustoken;

        $condition = [
            'accesscode' => $accesscode
        ];
    } else {
        $condition = [
            'attemptid' => null,
            'status' => 'Not inited',
            'userid' => $event->userid,
            'courseid' => $event->courseid,
            'cmid' => $cmid,
        ];
    }

    $entry = $DB->get_record('availability_examus', $condition);

    if ($entry && $attempt) {
        $entry->attemptid = $attempt->id;
        $entry->status = "Started";
        $DB->update_record('availability_examus', $entry);
    }
}


/**
 * Remove entries on attempt deletion
 *
 * @param stdClass $event Event
 */
function avalibility_examus_attempt_deleted_handler($event) {
    $attempt = $event->get_record_snapshot('quiz_attempts', $event->objectid);
    $cm = get_coursemodule_from_id('quiz', $event->get_context()->instanceid, $event->courseid);

    \availability_examus\common::reset_entry([
        'cmid' => $cm->id,
        'attemptid' => $attempt->id
    ]);
}

/**
 * user enrolment deleted handles
 *
 * @param \core\event\user_enrolment_deleted $event Event
 */
function avalibility_examus_user_enrolment_deleted(\core\event\user_enrolment_deleted $event) {
    $userid = $event->relateduserid;

    \availability_examus\common::delete_empty_entries($userid, $event->courseid);
}

/**
 * course mudule deleted handler
 *
 * @param \core\event\course_module_deleted $event Event
 */
function avalibility_examus_course_module_deleted(\core\event\course_module_deleted $event) {
    global $DB;
    $cmid = $event->contextinstanceid;
    $DB->delete_records('availability_examus', ['cmid' => $cmid]);
}


/**
 * Attempt viewed
 *
 * @param \mod_quiz\event\attempt_viewed $event Event
 */
function avalibility_examus_attempt_viewed_handler($event) {
    $attempt = $event->get_record_snapshot('quiz_attempts', $event->objectid);
    $quiz = $event->get_record_snapshot('quiz', $attempt->quiz);

    // Storing attempt and CM for future use.
    state::$attempt = [
        'cm_id' => $event->get_context()->instanceid,
        'cm' => $event->get_context(),
        'course_id' => $event->courseid,
        'attempt_id' => $event->objectid,
        'quiz_id' => $quiz->id,

    ];
}