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

/**
 * Lib for local_obf.
 *
 * @package    local_obf
 * @copyright  2013-2020, Open Badge Factory Oy
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

use classes\obf_assertion;
use classes\obf_backpack;
use classes\obf_blacklist;
use classes\obf_client;
use classes\obf_issuefailedrecord;
use classes\obf_user_preferences;
use classes\obf_assertion_collection;

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

// OBF_DEFAULT_ADDRESS - The URL of Open Badge Factory.
if (!defined('OBF_DEFAULT_ADDRESS')) {
    define('OBF_DEFAULT_ADDRESS', 'https://openbadgefactory.com/');
}

// OBF_API_CONSUMER_ID - The consumer id used in API requests.
define('OBF_API_CONSUMER_ID', 'Moodle');

// OBF API error codes.
define('OBF_API_CODE_CERT_ERROR', 495);
define('OBF_API_CODE_NO_CERT', 496);

require_once(__DIR__ . '/classes/criterion/obf_criterion.php');

/**
 * Adds the OBF-links to Moodle's navigation, Moodle 2.2 -style.
 *
 * @param global_navigation $navigation Global navigation.
 */
function obf_extends_navigation(global_navigation $navigation) {
    global $COURSE, $PAGE;

    if ($COURSE->id > 1 && $branch = $navigation->find($COURSE->id,
            navigation_node::TYPE_COURSE)) {
        local_obf_add_course_participant_badges_link($branch);
    }

    if (@$PAGE->settingsnav) {
        if (($branch = $PAGE->settingsnav->get('courseadmin'))) {
            $branch = local_obf_add_course_admin_container($branch);
            local_obf_add_course_admin_link($branch);
            local_obf_add_course_event_history_link($branch);
        }

        if (($branch = $PAGE->settingsnav->get('usercurrentsettings'))) {
            local_obf_add_obf_user_preferences_link($branch);
            local_obf_add_obf_user_badge_blacklist_link($branch);
        }
    }
}

/**
 * Adds the OBF-links to Moodle's settings navigation.
 *
 * @param settings_navigation $navigation
 */
function local_obf_extend_settings_navigation(settings_navigation $navigation) {
    global $COURSE;

    if (($branch = $navigation->get('courseadmin'))) {
        $branch = local_obf_add_course_admin_container($branch);
        local_obf_add_course_admin_link($branch);
        local_obf_add_course_event_history_link($branch);
    }

    if (($branch = $navigation->get('usercurrentsettings'))) { // This does not work on Moodle 2.9?
        local_obf_add_obf_user_preferences_link($branch);
        local_obf_add_obf_user_badge_blacklist_link($branch);
    } else if (($branch = $navigation->find('usercurrentsettings', navigation_node::TYPE_CONTAINER))) { // This works on Moodle 2.9.
        local_obf_add_obf_user_preferences_link($branch);
        local_obf_add_obf_user_badge_blacklist_link($branch);
    }
}

/**
 * Adds the OBF-links to Moodle's settings navigation on older Moodle versions.
 *
 * @param settings_navigation $navigation
 */
function local_obf_extends_settings_navigation(settings_navigation $navigation) {
    local_obf_extend_settings_navigation($navigation);
}

/**
 * Adds the OBF-links to Moodle's navigation.
 *
 * @param global_navigation $navigation
 */
function local_obf_extend_navigation(global_navigation $navigation) {
    global $PAGE, $COURSE;

    // Course id 1 is Moodle.
    if ($COURSE->id > 1 && $branch = $PAGE->navigation->find($COURSE->id,
            navigation_node::TYPE_COURSE)) {
        local_obf_add_course_participant_badges_link($branch);
    }
}

/**
 * Adds the OBF-links to Moodle's navigation in Moodle 2.8 and older.
 *
 * @param global_navigation $navigation
 */
function local_obf_extends_navigation(global_navigation $navigation) {
    local_obf_extend_navigation($navigation);
}

/**
 * Adds the OBF admin-links container.
 *
 * @param type& $branch Branch where to add the container node.
 */
function local_obf_add_course_admin_container(&$branch) {
    global $COURSE;

    if (has_capability('local/obf:viewhistory', context_course::instance($COURSE->id)) ||
        has_capability('local/obf:issuebadge', context_course::instance($COURSE->id))) {
        $node = navigation_node::create(get_string('obf', 'local_obf'),
            null, navigation_node::TYPE_CONTAINER, null, 'obf');
        $backupnode = $branch->find('backup', navigation_node::TYPE_SETTING);
        return $branch->add_node($node, $backupnode != false ? 'backup' : null);
    }
    return $branch;
}

/**
 * Adds the link to course navigation to see the badges of course participants.
 *
 * @param navigation_node& $branch Branch where to add the container node.
 */
function local_obf_add_course_participant_badges_link(&$branch) {
    global $COURSE;

    if (has_capability('local/obf:seeparticipantbadges',
        context_course::instance($COURSE->id))) {
        $node = navigation_node::create(get_string('courseuserbadges',
            'local_obf'),
            new moodle_url('/local/obf/courseuserbadges.php',
                array('courseid' => $COURSE->id, 'action' => 'badges')));
        $branch->add_node($node);
    }
}

/**
 * Adds the link to course navigation to see the event history related to course.
 *
 * @param type& $branch
 */
function local_obf_add_course_event_history_link(&$branch) {
    global $COURSE;

    if (has_capability('local/obf:viewhistory',
        context_course::instance($COURSE->id))) {
        $node = navigation_node::create(get_string('courseeventhistory',
            'local_obf'),
            new moodle_url('/local/obf/courseuserbadges.php',
                array('courseid' => $COURSE->id, 'action' => 'history')));
        $branch->add_node($node);
    }
}

/**
 * Adds the OBF-links to course management navigation.
 *
 * @param type& $branch
 */
function local_obf_add_course_admin_link(&$branch) {
    global $COURSE;

    if (has_capability('local/obf:issuebadge',
        context_course::instance($COURSE->id))) {
        $obfnode = navigation_node::create(get_string('obf', 'local_obf'),
            new moodle_url('/local/obf/badge.php',
                array('action' => 'list', 'courseid' => $COURSE->id)));
        $branch->add_node($obfnode);
    }
}

/**
 * Adds the user preferences configuration link to navigation.
 *
 * @param type& $branch
 */
function local_obf_add_obf_user_preferences_link(&$branch) {
    $node = navigation_node::create(get_string('obfuserpreferences', 'local_obf'),
        new moodle_url('/local/obf/userconfig.php'));
    $branch->add_node($node);
}

/**
 * Adds the user badge blacklist configuration link to navigation.
 *
 * @param type& $branch
 */
function local_obf_add_obf_user_badge_blacklist_link(&$branch) {
    $node = navigation_node::create(get_string('badgeblacklist', 'local_obf'),
        new moodle_url('/local/obf/blacklist.php'));
    $branch->add_node($node);
}

/**
 * Adds OBF badges to profile pages.
 *
 * @param \core_user\output\myprofile\tree $tree
 * @param stdClass $user
 * @param bool $iscurrentuser
 * @param moodle_course $course
 */
function local_obf_myprofile_navigation(\core_user\output\myprofile\tree $tree, $user, $iscurrentuser, $course) {
    global $PAGE, $DB, $CFG;
    // Load the separate JavaScript file and call the event handler.
    $PAGE->requires->js_call_amd('local_obf/obf_badgelist', 'init');

    require_once(__DIR__ . '/classes/user_preferences.php');

    $usersdisplaybadges = get_config('local_obf', 'usersdisplaybadges');
    $showbadges = obf_client::has_client_id() && (
            $usersdisplaybadges == obf_user_preferences::USERS_FORCED_TO_DISPLAY_BADGES ||
            ($usersdisplaybadges != obf_user_preferences::USERS_NOT_ALLOWED_TO_DISPLAY_BADGES &&
                obf_user_preferences::get_user_preference($user->id, 'badgesonprofile') == 1)
        );

    if ($showbadges) {
        $category = new core_user\output\myprofile\category('local_obf/badges', get_string('profilebadgelist', 'local_obf'), null);
        $tree->add_category($category);

        addobfbadges($tree, $user);
        addbackpackbadges($tree, $user);
        addmoodlebadges($tree, $user);
    }
}

/**
 * Adds OBF badges to the profile tree.
 *
 * @param \core_user\output\myprofile\tree $tree
 * @param stdClass $user
 */
function addobfbadges($tree, $user): void {
    global $PAGE, $DB;

    $assertions = local_obf_myprofile_get_assertions($user->id, $DB);

    $param['nameinstance'] = get_site()->fullname;
    $category = new core_user\output\myprofile\category('local_obf/badgesplatform',
        get_string('badgesplatform', 'local_obf', $param), null);
    $tree->add_category($category);

    if ($assertions !== false && count($assertions) > 0) {
        $renderer = $PAGE->get_renderer('local_obf');
        $content = $renderer->render_user_assertions($assertions, $user, false);
        $content .= html_writer::tag('button',
            get_string('showmore', 'local_obf'), ['class' => 'btn btn-primary show-more-button hidden']);
    } else {
        $content = get_string('nobadgesearned', 'local_obf');
    }

    $localnode = new core_user\output\myprofile\node('local_obf/badgesplatform', 'obfbadges',
        '', null, null, $content, null, 'local-obf');
    $tree->add_node($localnode);
}

/**
 * Adds backpack badges to the profile tree.
 *
 * @param \core_user\output\myprofile\tree $tree
 * @param stdClass $user
 */
function addbackpackbadges($tree, $user): void {
    global $PAGE, $DB;

    foreach (obf_backpack::get_providers() as $provider) {
        $bpassertions = local_obf_myprofile_get_backpack_badges($user->id, $provider, $DB);

        if ($bpassertions !== false && count($bpassertions) > 0) {
            $name = obf_backpack::get_providershortname_by_providerid($provider);
            $fullname = obf_backpack::get_providerfullname_by_providerid($provider);
            $title = get_string('profilebadgelistbackpackprovider', 'local_obf', $fullname);
            $renderer = $PAGE->get_renderer('local_obf');
            $content = $renderer->render_user_assertions($bpassertions, $user, false);
            $content .= html_writer::tag('button',
                get_string('showmore', 'local_obf'), ['class' => 'btn btn-primary show-more-button hidden']);
            $localnode = new core_user\output\myprofile\node('local_obf/badges', 'obfbadges' . $name,
                $title, null, null, $content, null, 'local-obf');
            $tree->add_node($localnode);
        }
    }
}

/**
 * Adds Moodle badges to the profile tree.
 *
 * @param \core_user\output\myprofile\tree $tree
 * @param stdClass $user
 */
function addmoodlebadges($tree, $user): void {
    global $PAGE, $DB, $CFG;

    $badgeslibfile = $CFG->libdir . '/badgeslib.php';

    if (file_exists($badgeslibfile) &&
        true !== get_config('enablebadges') &&
        get_config('local_obf', 'displaymoodlebadges')) {
        $moodleassertions = new obf_assertion_collection();
        require_once($badgeslibfile);
        $moodleassertions->add_collection(obf_assertion::get_user_moodle_badge_assertions($user->id));

        if (count($moodleassertions) > 0) {
            $renderer = $PAGE->get_renderer('local_obf');
            $site = get_site();
            $sitename = $site ? format_string($site->fullname) : 'Moodle';
            $title = get_string('profilebadgelistbackpackprovider', 'local_obf', $sitename);
            $content = $renderer->render_user_assertions($moodleassertions, $user, false);
            $content .= html_writer::tag('button',
                get_string('showmore', 'local_obf'), ['class' => 'btn btn-primary show-more-button hidden']);
            $localnode = new core_user\output\myprofile\node('local_obf/badges', 'obfbadgesmoodle',
                $title, null, null, $content, null, 'local-obf');
            $tree->add_node($localnode);
        }
    }
}


/**
 * Returns (cached) assertions for user
 *
 * @param int $userid
 * @param moodle_database $db
 * @return obf_assertion_collection
 */
function local_obf_myprofile_get_assertions($userid, $db) {
    $cache = cache::make('local_obf', 'obf_assertions');
    $assertions = get_config('local_obf', 'disableassertioncache') ? null : $cache->get($userid);

    if (!$assertions) {
        // Get user's badges in OBF.
        $assertions = new obf_assertion_collection();

        try {
            $client = obf_client::get_instance();
            $blacklist = new obf_blacklist($userid);

            $useremails = [];
            $useremails[] = $db->get_record('user', array('id' => $userid))->email;

            // Get badges issued with previous emails.
            $historyemails = $db->get_records('local_obf_history_emails', array('user_id' => $userid), '', 'email');
            foreach ($historyemails as $email) {
                $useremails[] = $email->email;
            }
            foreach (array_unique($useremails) as $email) {
                $assertions->add_collection(obf_assertion::get_assertions_all($client, $email));
            }

            $assertions->apply_blacklist($blacklist);

            $assertions->toarray(); // This makes sure issuer objects are populated and cached.
            $cache->set($userid, $assertions);

        } catch (Exception $e) {
            debugging('Getting OBF assertions for user id: ' . $userid . ' failed: ' . $e->getMessage());
        }
    }
    return $assertions;
}

/**
 * Returns (cached) backpack badges for user
 *
 * @param int $userid
 * @param int $provider Backpack provider. obf_backpack::BACKPACK_PROVIDER_*.
 * @param moodle_database $db
 * @return obf_assertion_collection
 */
function local_obf_myprofile_get_backpack_badges($userid, $provider, $db) {
    $backpack = obf_backpack::get_instance_by_userid($userid, $db, $provider);
    if ($backpack === false || count($backpack->get_group_ids()) == 0) {
        return new obf_assertion_collection();
    }
    $cache = cache::make('local_obf', 'obf_assertions_backpacks');
    $userassertions = get_config('local_obf', 'disableassertioncache') ? null : $cache->get($userid);
    $shortname = obf_backpack::get_providershortname_by_providerid($provider);

    if (!$userassertions || !array_key_exists($shortname, $userassertions)) {
        require_once(__DIR__ . '/classes/blacklist.php');
        if (!is_array($userassertions)) {
            $userassertions = array();
        }
        $assertions = new obf_assertion_collection();
        try {
            $client = obf_client::get_instance();
            $blacklist = new obf_blacklist($userid);
            $assertions->add_collection($backpack->get_assertions());
            $assertions->apply_blacklist($blacklist);
        } catch (Exception $e) {
            debugging('Getting OBF assertions for user id: ' . $userid . ' failed: ' . $e->getMessage());
        }

        $assertions->toarray(); // This makes sure issuer objects are populated and cached.
        $userassertions[$shortname] = $assertions;
        $cache->set($userid, $userassertions);
    }

    return $userassertions[$shortname];
}

// Moodle 2.2 -support.
if (!function_exists('users_order_by_sql')) {

    /**
     * This function generates the standard ORDER BY clause for use when generating
     * lists of users. If you don't have a reason to use a different order, then
     * you should use this method to generate the order when displaying lists of users.
     *
     * COPIED FROM THE CODE OF MOODLE 2.5
     *
     * @param string $usertablealias
     * @param string $search
     * @param context $context
     */
    function users_order_by_sql($usertablealias = '', $search = null,
        context $context = null) {
        global $DB, $PAGE;

        if ($usertablealias) {
            $tableprefix = $usertablealias . '.';
        } else {
            $tableprefix = '';
        }

        $sort = "{$tableprefix}lastname, {$tableprefix}firstname, {$tableprefix}id";
        $params = array();

        if (!$search) {
            return array($sort, $params);
        }

        if (!$context) {
            $context = $PAGE->context;
        }

        $exactconditions = array();
        $paramkey = 'usersortexact1';

        $exactconditions[] = $DB->sql_fullname($tableprefix . 'firstname',
                $tableprefix . 'lastname') .
            ' = :' . $paramkey;
        $params[$paramkey] = $search;
        $paramkey++;

        $fieldstocheck = array_merge(array('firstname', 'lastname'),
            \core_user\fields::get_identity_fields($context));

        foreach ($fieldstocheck as $field) {
            $exactconditions[] = 'LOWER(' . $tableprefix . $field . ') = LOWER(:' . $paramkey . ')';
            $params[$paramkey] = $search;
            $paramkey++;
        }

        $sort = 'CASE WHEN ' . implode(' OR ', $exactconditions) .
            ' THEN 0 ELSE 1 END, ' . $sort;

        return array($sort, $params);
    }
}

/**
 * Creates a new rule object with the provided parameters.
 *
 * @param int $ruleid The rule ID.
 * @param string $oauth2id The OAuth2 ID.
 * @param int $coursecategorieid The course category ID.
 * @param string $badgecategoriename The badge category name.
 *
 * @return stdClass The newly created rule object.
 */
function createnewrule($ruleid, $oauth2id, $coursecategorieid, $badgecategoriename): stdClass {
    $newrule = new stdClass();
    $newrule->id = null;
    $newrule->ruleid = $ruleid;
    $newrule->oauth2_id = $oauth2id;
    $newrule->coursecategorieid = $coursecategorieid;
    $newrule->badgecategoriename = $badgecategoriename;

    return $newrule;
}

/**
 * Deletes a failed record from database.
 *
 * @param int $id The ID of the failed record.
 * @return void
 */
function obf_delete_failed_record(int $id) {
    global $DB;

    $record = $DB->get_record('local_obf_issuefailedrecord', ['id' => $id]);

    if (!$record) {
        print_error('invalidrecordid', 'local_obf', '', $id);
    }

    $recordobject = new obf_issuefailedrecord($record);
    $recordobject->delete();
}