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

/**
 * Local functions and constants for recompletion plugin.
 *
 * @package    local_recompletion
 * @copyright  2018 Catalyst IT
 * @author     Dan Marsden
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

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

// Used by settings to decide if attempts should be deleted or an extra attempt allowed.
define('LOCAL_RECOMPLETION_NOTHING', 0);
define('LOCAL_RECOMPLETION_DELETE', 1);
define('LOCAL_RECOMPLETION_EXTRAATTEMPT', 2);

require_once($CFG->dirroot.'/user/lib.php');
require_once($CFG->libdir.'/formslib.php');
require_once($CFG->dirroot.'/course/lib.php');
require_once($CFG->libdir.'/completionlib.php');
require_once($CFG->libdir.'/gradelib.php');
require_once($CFG->dirroot . '/mod/assign/locallib.php');
require_once($CFG->dirroot . '/mod/quiz/lib.php');

/**
 * Get list of supported plugin classes.
 * @return array
 * @throws coding_exception
 */
function local_recompletion_get_supported_plugins() {
    global $CFG;
    $plugins = [];
    $files = scandir($CFG->dirroot. '/local/recompletion/classes/plugins');
    foreach ($files as $file) {
        $component = clean_param(str_replace('.php', '', $file), PARAM_ALPHANUMEXT);
        list($plugin, $type) = core_component::normalize_component($component);

        if (!core_component::is_valid_plugin_name($type, $plugin)) {
            continue;
        }

        if ($plugin != 'core' && core_component::get_component_directory($component)) {
            $plugins[] = core_component::normalize_componentname($component);
        }

    }
    return $plugins;
}

/**
 * Get list of supported restriction classes.
 * @return array
 */
function local_recompletion_get_supported_restrictions(): array {
    global $CFG;

    $restrictions = [];
    $files = scandir($CFG->dirroot. '/local/recompletion/classes/local/restrictions');
    foreach ($files as $file) {
        $class = clean_param(str_replace('.php', '', $file), PARAM_ALPHANUMEXT);
        if (!empty($class) && $class !== 'base') {
            $restrictions[] = $class;
        }
    }

    return $restrictions;
}

/**
 * Loads form data.
 *
 * @param string[] $mformdata
 * @return object
 */
function local_recompletion_set_form_data($mformdata) {
    $restrictions = local_recompletion_get_supported_restrictions();
    foreach ($restrictions as $plugin) {
        $fqn = 'local_recompletion\\local\\restrictions\\' . $plugin;
        $fqn::set_form_data($mformdata);
    }

    $data = (array) $mformdata;
    if (key_exists('recompletionemailbody', $data)) {
        $recompletionemailbody = $data['recompletionemailbody'];
        $data['recompletionemailbody_format'] = $recompletionemailbody['format'];
        $data['recompletionemailbody'] = $recompletionemailbody['text'];
    }

    return (object) $data;
}

/**
 * Return the data that will be used upon saving.
 * @param string[] $data
 * @return array|false
 */
function local_recompletion_get_data(array $data) {
    $keys = array_column($data, 'name');
    $values = array_column($data, 'value');
    $result = array_combine($keys, $values);
    // Set default format for email body editor.
    if (isset($result['recompletionemailbody']) && !isset($result['recompletionemailbody_format'])) {
        $result['recompletionemailbody_format'] = FORMAT_HTML;
    }
    // Prepare email body for editor.
    $emailbody = array('text' => $result['recompletionemailbody'], 'format' => $result['recompletionemailbody_format']);
    $result['recompletionemailbody'] = $emailbody;

    return $result;
}

/**
 * Update course completions
 * @param int $courseid
 * @param array[] $users
 * @param int $timecompleted
 */
function local_recompletion_update_course_completion(int $courseid, array $users, int $timecompleted) {
    foreach ($users as $user) {
        $params = ['userid' => $user, 'course' => $courseid];
        $ccompletion = new \completion_completion($params);
        if ($ccompletion->is_complete()) {
            // If we already have a completion date, clear it first so that mark_complete works.
            $ccompletion->timecompleted = null;
        }
        $ccompletion->mark_complete($timecompleted);
    }
}


/**
 * Get local config
 * @param stdClass $course - course record.
 */
function local_recompletion_get_config($course) {
    global $DB;
    // Ideally this would be picked up directly from settings or the override form.
    // Values if not set in the form are set to 0.
    $defaultconfig = [
        'recompletiontype' => '',
        'recompletionduration' => 0,
        'recompletionschedule' => '',
        'assignevent' => null,
        'archivecompletiondata' => 0,
        'recompletionnotify' => '',
        'recompletionunenrolenable' => 0,
        'recompletionemailbody' => '',
        'recompletionemailbody_format' => FORMAT_HTML,
        'recompletionemailsubject' => '',
        'deletegradedata' => 0,
        'nextresettime' => 0,
        'course' => null    // This isn't in the form.
    ];

    $config = $defaultconfig;
    $dbconfig = $DB->get_records_menu('local_recompletion_config', array('course' => $course->id), '', 'name, value');
    // If we get no values back, then we use the default above, otherwise update the config with the DB values a precedent.
    // We could also combine the settings values so that the code calling it doesn't need to do this.
    if (!empty($dbconfig)) {
        foreach ($dbconfig as $key => $value) {
            if (!isset($config[$key]) || $config[$key] !== $value) {
                $config[$key] = $value;
            }
        }
    }
    $config['course'] = $course->id;

    $config = (object)$config;
    return $config;
}

/**
 * Get a future timestamp for recompletion calculation based on strtotime.
 * Will not return a value in the past, 0 is returned instead.
 *
 * @param string $input The natural language string to evaluate.
 * @return int a future timestamp, or 0.
 */
function local_recompletion_calculate_schedule_time(string $input): int {
    // Special handling for next reset time.
    // Assumptions. If this is in the past, try and append a year stamp for
    // next year. If that doesnt evaluate, we cannot deal with this.
    $time = strtotime($input);
    if ($time === false) {
        // We cannot handle this value.
        return 0;
    }
    if ($time < time()) {
        // Try with a year appended to force a future calculation.
        $schedulestring = $input . ' ' . date('Y', strtotime('+1 year'));
        $time = strtotime($schedulestring);

        // If this isn't valid or still in the past (somehow), we can't trust it.
        if ($time === false || $time < time()) {
            return 0;
        }

        return $time;
    }

    return $time;
}