lib.php

<?php
// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.

/**
 * Lib file
 *
 * @package     local_lmslight
 * @copyright   2024 LMSLight
 * @author      Bryce Yoder
 * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

/**
 * Hook to remove unwanted settings for non-lmslight users
 * This runs pretty early so we do a bunch of other stuff here too
 */
function local_lmslight_extend_settings_navigation($nav, $context) {
    global $PAGE;

    // Display disabled page if need be
    check_site_disabled();

    // Platform staff see the full admin tree — no pruning.
    if (local_lmslight_is_platform_user()) {
        return;
    }

    // Hide SSO auth plugins from the manageauth table for base-tier sites.
    if (local_lmslight_get_subscription_level() < 1) {
        $PAGE->requires->js_call_amd('local_lmslight/main', 'init');
    }

    foreach (local_lmslight_get_pruned_keys() as $setting) {
        manipulate_setting($nav, $setting);
        manipulate_admin_setting($setting);
    }

}

/**
 * Remove settings from admin tree
 * @param settingname: The name of the setting to remove
 */
function manipulate_admin_setting($settingname) {
    if (!function_exists('admin_get_root')) {
        return;
    }

    $adminnav = admin_get_root();
    $adminnav->prune($settingname);
}

/**
 * Remove settings from page nav
 * @param nav: The nav object from which to remove settings
 * @param settingname: The name of the setting or category to remove
 */
function manipulate_setting($nav, $settingname) {
    // if the setting is in the nav, recursively call this function on any children
    if ($setting = $nav->find($settingname, global_navigation::TYPE_SETTING)) {
        foreach ($setting->get_children_key_list() as $child_setting) {
            manipulate_setting($nav, $child_setting);
        }

        // redirect the page if we're actually on this setting
        if ($setting->action() !== null && str_contains(
            $_SERVER['SCRIPT_NAME'] . '?' . $_SERVER['QUERY_STRING'],
            $setting->action()->out_as_local_url()
        )) {
            redirect('/');
        }

        // remove it from the tree
        $setting->remove();
    }
}

/**
 * Given a user object, login the current browser session as said user
 * @param array user: The user objet
 */
function login_as_user($user) {
    $auth = empty($user->auth) ? 'manual' : $user->auth;
    if ($auth == 'nologin' or !is_enabled_auth($auth)) {
        cli_error(sprintf("User authentication is either 'nologin' or disabled. Check Moodle authentication method for '%s'", $user->username));
    }

    $authplugin = get_auth_plugin($auth);
    $authplugin->sync_roles($user);

    login_attempt_valid($user);
    complete_user_login($user);
}

/**
 * Given an OAuth response from Google, create a new user
 * @param array oauth_response: The returned OAuth object from Google
 * @return array: The user object of the created user
 */
function create_lmslight_user($oauth_response) {
    global $CFG;

    require_once('../../user/lib.php');
    $user = new \stdClass();

    $user->email = $oauth_response['email'];
    $user->maildigest = 0;
    $user->city = 'Noblesville';
    $user->country = 'US';
    $user->firstname = $oauth_response['given_name'];
    $user->lastname = $oauth_response['family_name'];
    $user->timecreated = time();
    $user->timemodified = $user->timecreated;
    $user->username = $oauth_response['email'];

    $user->confirmed = 1;
    $user->mnethostid = $CFG->mnet_localhost_id;
    
    return user_create_user($user);
}

/**
 * Given a user ID, make the user a site administrator
 * @param int userid: The ID of the user to make an admin
 */
function make_user_admin($userid) {
    global $DB, $CFG;

    $siteadmins = explode(',', $CFG->siteadmins);
    array_push($siteadmins, $userid);
    $siteadmins = implode(',', $siteadmins);

    set_config('siteadmins', $siteadmins);
}

function check_site_disabled() {
    global $CFG;
    if (property_exists($CFG, 'sitedisabled') && $CFG->sitedisabled) {
        require_once('disabled.php');
    }
}

/**
 * Check whether the current user is an LMS Light platform staff member.
 *
 * Platform users have @lmslight.io email addresses and see the full,
 * unpruned admin tree.
 *
 * @return bool True if the current user is platform staff.
 */
function local_lmslight_is_platform_user(): bool {
    global $USER;
    if (!property_exists($USER, 'email') || empty($USER->email)) {
        return false;
    }
    $domain = explode('@', $USER->email)[1] ?? '';
    return $domain === 'lmslight.io';
}

/**
 * Return the current site subscription level.
 *
 * Levels: 0 = Core, 1 = Grow, 2 = Pro.
 *
 * @return int The subscription level (defaults to 0 if not set).
 */
function local_lmslight_get_subscription_level(): int {
    global $CFG;
    return property_exists($CFG, 'subscriptionlevel') ? (int) $CFG->subscriptionlevel : 0;
}

/**
 * Return the list of admin setting keys that are pruned for the current
 * user and subscription level.
 *
 * @return string[] Setting keys that are hidden from the current user.
 */
function local_lmslight_get_pruned_keys(): array {
    $keys = [
        'analytics',
        'license',
        'moodlenet',
        'backups',
        'development',
        'adminnotifications',
        'registrationmoodleorg',
        'moodleservices',
        'userfeedback',
        'tool_installaddon_index',
        'pluginsoverview',
        'taskconfig',
        'email',
        'systempaths',
        'supportcontact',
        'sessionhandling',
        'http',
        'maintenancemode',
        'cleanup',
        'environment',
        'phpinfo',
        'performance',
        'updatenotifications',
        'tool_filetypes',
        'reportbackups',
        'reportinfectedfiles',
        'insights',
        'reportperformance',
        'reportsecurity',
        'reportstatus',
    ];

    if (local_lmslight_get_subscription_level() < 1) {
        array_push($keys,
            'server',
            'oauth2',
            'authsettingoauth2',
            'authsettingsaml2',
            'authsettingldap',
            'authsettingcas',
            'authsettingshibboleth'
        );
    }

    return $keys;
}