moodle/lib/classes/plugininfo/aiplacement.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/>.

namespace core\plugininfo;

use core_plugin_manager;
use moodle_url;

/**
 * AI placement plugin info class.
 *
 * @package    core
 * @copyright 2024 Matt Porritt <matt.porritt@moodle.com>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class aiplacement extends base {

    /**
     * Should there be a way to uninstall the plugin via the administration UI.
     *
     * By default, uninstallation is allowed.
     *
     * @return bool
     */
    public function is_uninstall_allowed(): bool {
        return true;
    }

    /**
     * This plugintype supports its plugins being disabled.
     *
     * @return bool
     */
    public static function plugintype_supports_disabling(): bool {
        return true;
    }

    /**
     * Returns the node name used in admin settings menu for this plugin settings.
     *
     * @return string node name.
     */
    public function get_settings_section_name(): string {
        return $this->type . '_' . $this->name;
    }

    /**
     * Loads plugin settings to the settings tree.
     *
     * @param \part_of_admin_tree $adminroot
     * @param string $parentnodename
     * @param bool $hassiteconfig whether the current user has moodle/site:config capability
     */
    public function load_settings(
        \part_of_admin_tree $adminroot,
        $parentnodename,
        $hassiteconfig,
    ): void {
        global $CFG, $USER, $DB, $OUTPUT, $PAGE; // In case settings.php wants to refer to them.
        /** @var \admin_root $ADMIN */
        $ADMIN = $adminroot; // May be used in settings.php.
        $plugininfo = $this; // Also can be used inside settings.php.

        if (!$this->is_installed_and_upgraded()) {
            return;
        }

        if (!$hassiteconfig) {
            return;
        }

        $section = $this->get_settings_section_name();

        // Load the specific settings.
        $settings = new \core_ai\admin\admin_settingspage_provider(
            name: $section,
            visiblename: $this->displayname,
            req_capability: 'moodle/site:config',
            hidden: true,
        );
        if (file_exists($this->full_path('settings.php'))) {
            include($this->full_path('settings.php')); // This may also set $settings to null.
            // Show the save changes button between the specific settings and the actions table.
            $settings->add(new \admin_setting_savebutton("{$section}/savebutton"));
        }

        // Load the actions table.
        if (file_exists($this->full_path('setting_actions.php'))) {
            include($this->full_path('setting_actions.php')); // This may also set $settings to null.
        } else {
            $settings->add(new \admin_setting_heading("{$section}/generals",
                new \lang_string('placementactionsettings', 'core_ai'),
                new \lang_string('placementactionsettings_desc', 'core_ai')));
            // Load the setting table of actions that this provider supports.
            $settings->add(new \core_ai\admin\admin_setting_action_manager(
                $section,
                \core_ai\table\aiplacement_action_management_table::class,
                'manageaiplacements',
                new \lang_string('manageaiproviders', 'core_ai'),
            ));
        }

        if ($settings) {
            $ADMIN->add($parentnodename, $settings);
        }
    }

    /**
     * Return URL used for management of plugins of this type.
     *
     * @return moodle_url
     */
    public static function get_manage_url(): moodle_url {
        return new moodle_url('/admin/settings.php', [
            'section' => 'aiplacement',
        ]);
    }

    /**
     * Enable or disable a plugin.
     * When possible, the change will be stored into the config_log table, to let admins check when/who has modified it.
     *
     * @param string $pluginname The plugin name to enable/disable.
     * @param int $enabled Whether the pluginname should be enabled (1) or not (0).
     * @return bool Whether $pluginname has been updated or not.
     */
    public static function enable_plugin(string $pluginname, int $enabled): bool {
        $plugin = "aiplacement_$pluginname";
        $oldvalue = self::is_plugin_enabled($pluginname);
        $newvalue = (bool)$enabled;

        if ($oldvalue !== $newvalue) {
            if ($newvalue) {
                set_config('enabled', $enabled, $plugin);
            } else {
                unset_config('enabled', $plugin);
            }

            add_to_config_log('enabled', $oldvalue, $newvalue, $plugin);
            core_plugin_manager::reset_caches();
            return true;
        }

        return false;
    }

    /**
     * Finds all enabled plugins, the result may include missing plugins.
     *
     * @return array|null of enabled plugins $pluginname=>$pluginname, null means unknown.
     */
    public static function get_enabled_plugins(): ?array {
        $pluginmanager = core_plugin_manager::instance();
        $plugins = $pluginmanager->get_installed_plugins('aiplacement');

        if (!$plugins) {
            return [];
        }

        $plugins = array_keys($plugins);

        // Filter to return only enabled plugins.
        $enabled = [];
        foreach ($plugins as $plugin) {
            if (self::is_plugin_enabled($plugin)) {
                $enabled[$plugin] = $plugin;
            }
        }
        return $enabled;
    }

    /**
     * Check if a provider plugin is enabled in config.
     *
     * @param string $plugin The plugin to check.
     * @return bool Return true if enabled.
     */
    public static function is_plugin_enabled(string $plugin): bool {
        $config = get_config("aiplacement_$plugin", 'enabled');
        return $config == 1;
    }
}