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

/**
 * External plugin API.
 *
 * @package   tool_managertokens
 * @copyright 2017 "Valentin Popov" <info@valentineus.link>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined("MOODLE_INTERNAL") || die();

/**
 * It checks the ability to activate the token and produces it.
 *
 * @param  string $token
 * @return object
 */
function tool_managertokens_activate_token($token = "") {
    global $DB;

    $selectlimited     = "limited = 0 OR scope < limited";
    $selecttimelimited = "timelimited = 0 OR (timecreated + timelimited) > " . time();
    $select = "enabled = 1 AND token = '$token' AND ($selectlimited) AND ($selecttimelimited)";
    if ($token = $DB->get_record_select("tool_managertokens_tokens", $select, null, "*", IGNORE_MISSING)) {
        $token = tool_managertokens_standardization_record($token);
        $token->scope = $token->scope + 1;
        $token->timelastuse = time();
        $DB->update_record("tool_managertokens_tokens", $token, false);
    }

    return $token;
}

/**
 * Creates a backup copy of the tokens.
 *
 * @return string
 */
function tool_managertokens_create_backup() {
    $list = tool_managertokens_get_list(0, 0);
    $archive = base64_encode(gzcompress(serialize($list), 9));
    return $archive;
}

/**
 * Creates an entry in the database.
 *
 * @param  object $options
 * @return number
 */
function tool_managertokens_create_record($options) {
    global $DB;

    if (!isset($options->targetid)) {
        print_error("missingparam", "error", "", "targetid");
    }

    if (!isset($options->targettype)) {
        $options->targettype = "user";
    }

    if (!isset($options->token)) {
        $options->token = generate_password(12);
    }

    if ($DB->record_exists("tool_managertokens_tokens", array("token" => $options->token))) {
        print_error("duplicatefieldname", "error", "", "token");
    }

    $token = new stdClass();
    $token->enabled      = false;
    $token->timecreated  = time();
    $token->targetid     = intval($options->targetid);
    $token->targettype   = strval($options->targettype);
    $token->timemodified = $token->timecreated;
    $token->token        = strval($options->token);

    if (!empty($options->enabled)) {
        $token->enabled = boolval($options->enabled);
    }

    if (!empty($options->extendedaction) && !empty($options->extendedoptions)) {
        $token->extendedaction  = strval($options->extendedaction);
        $token->extendedoptions = strval($options->extendedoptions);
    }

    if (!empty($options->limited)) {
        $token->limited = intval($options->limited);
    }

    if (!empty($options->timelimited)) {
        $token->timelimited = intval($options->timelimited);
    }

    $recordid = $DB->insert_record("tool_managertokens_tokens", $token, true, false);
    return $recordid;
}

/**
 * Removes all entries in the table.
 * Attention! All current records are deleted!
 *
 * @return boolean
 */
function tool_managertokens_delete_all_records() {
    global $DB;

    $result = $DB->delete_records("tool_managertokens_tokens", null);
    return boolval($result);
}

/**
 * Deletes an entry by an ID or token.
 *
 * @param  number|string $key
 * @return boolean
 */
function tool_managertokens_delete_record($key = 0) {
    global $DB;

    $result = false;
    if ($token = tool_managertokens_find_record($key)) {
        $result = $DB->delete_records("tool_managertokens_tokens", array("id" => $token->id));
    }

    return boolval($result);
}

/**
 * Searches for an id or token.
 *
 * @param  number|string  $key
 * @return object|boolean
 */
function tool_managertokens_find_record($key = 0) {
    global $DB;

    $select = "id = '$key' OR token = '$key'";
    if ($token = $DB->get_record_select("tool_managertokens_tokens", $select, null, "*", IGNORE_MISSING)) {
        $token = tool_managertokens_standardization_record($token);
    }

    return $token;
}

/**
 * Get the entire list of tokens.
 *
 * @param  number $limitfrom
 * @param  number $limitnum
 * @return array
 */
function tool_managertokens_get_list($limitfrom = 0, $limitnum = 0) {
    global $DB;

    $result = $DB->get_records("tool_managertokens_tokens", null, "id", "*", $limitfrom, $limitnum);
    return $result;
}

/**
 * Restores data from a backup.
 * Attention! All current records are deleted!
 *
 * @param string $backup
 */
function tool_managertokens_restore_backup($backup = "") {
    global $DB;

    if ($list = unserialize(gzuncompress(base64_decode($backup)))) {
        tool_managertokens_delete_all_records();
        $DB->insert_records("tool_managertokens_tokens", $list);
    }
}

/**
 * Updates the entry in the database.
 *
 * @param  object  $options
 * @return boolean
 */
function tool_managertokens_update_record($options) {
    global $DB;

    $result = false;

    if (!isset($options->id)) {
        print_error("missingparam", "error", "", "id");
    }

    if ($token = $DB->get_record("tool_managertokens_tokens", array("id" => $options->id), "*", IGNORE_MISSING)) {
        $token->timemodified = time();

        if (isset($options->enabled)) {
            $token->enabled = boolval($options->enabled);
        }

        if (isset($options->extendedaction) && isset($options->extendedoptions)) {
            $token->extendedaction  = strval($options->extendedaction);
            $token->extendedoptions = strval($options->extendedoptions);
        }

        if (isset($options->limited)) {
            $token->limited = intval($options->limited);
        }

        if (isset($options->targetid)) {
            $token->targetid = intval($options->targetid);
        }

        if (isset($options->targettype)) {
            $token->targettype = strval($options->targettype);
        }

        if (isset($options->token)) {
            $token->token = strval($options->token);
        }

        if (isset($options->timelimited)) {
            $token->timelimited = intval($options->timelimited);
        }

        $result = $DB->update_record("tool_managertokens_tokens", $token, false);
    }

    return boolval($result);
}

/**
 * Standardizes the source document.
 *
 * @param  object $record
 * @return object
 */
function tool_managertokens_standardization_record($record) {
    $record->id              = intval($record->id);
    $record->enabled         = boolval($record->enabled);
    $record->extendedaction  = strval($record->extendedaction);
    $record->extendedoptions = strval($record->extendedoptions);
    $record->limited         = intval($record->limited);
    $record->scope           = intval($record->scope);
    $record->targetid        = intval($record->targetid);
    $record->targettype      = strval($record->targettype);
    $record->timecreated     = intval($record->timecreated);
    $record->timelastuse     = intval($record->timelastuse);
    $record->timelimited     = intval($record->timelimited);
    $record->timemodified    = intval($record->timemodified);
    $record->token           = strval($record->token);
    return $record;
}