Merge branch 'MDL-83216-main' of https://github.com/meirzamoodle/moodle

Author: junpataleta

ai/classes/external/set_provider_order.php

@@ -0,0 +1,94 @@
+<?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_ai\external;
+
+use core_external\external_api;
+use core_external\external_function_parameters;
+use core_external\external_single_structure;
+use core_external\external_value;
+
+/**
+ * Web Service to control the order of a provider instance.
+ *
+ * @package   core_ai
+ * @category  external
+ * @copyright Meirza <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class set_provider_order extends external_api {
+    /**
+     * Returns description of method parameters
+     *
+     * @return external_function_parameters
+     */
+    public static function execute_parameters(): external_function_parameters {
+        return new external_function_parameters([
+            'plugin' => new external_value(PARAM_INT, ' The provider instance ID', VALUE_REQUIRED),
+            'direction' => new external_value(PARAM_INT, 'The direction to move', VALUE_REQUIRED),
+        ]);
+    }
+
+    /**
+     * Set the provider instance order.
+     *
+     * @param int $providerid The provider instance ID
+     * @param int $direction The direction to move the provider instance
+     * @return array
+     */
+    public static function execute(
+        int $providerid,
+        int $direction,
+    ): array {
+        [
+            'plugin' => $providerid,
+            'direction' => $direction,
+        ] = self::validate_parameters(self::execute_parameters(), [
+            'plugin' => $providerid,
+            'direction' => $direction,
+        ]);
+
+        $context = \context_system::instance();
+        self::validate_context($context);
+        require_capability('moodle/site:config', $context);
+
+        $manager = \core\di::get(\core_ai\manager::class);
+        $aiproviders = $manager->get_provider_instances(['id' => $providerid]);
+        $aiprovider = reset($aiproviders);
+        if ($aiprovider) {
+            $manager->change_provider_order($providerid, $direction);
+        }
+
+        $directionstring = $direction === \core\plugininfo\aiprovider::MOVE_UP
+                            ? \core\plugininfo\aiprovider::UP
+                            : \core\plugininfo\aiprovider::DOWN;
+        $message = get_string('providermoved' . $directionstring, 'ai', $aiprovider->name);
+        $messagetype = \core\notification::SUCCESS;
+
+        \core\notification::add($message, $messagetype);
+
+        return [];
+    }
+
+    /**
+     * Describe the return structure of the external service.
+     *
+     * @return external_single_structure
+     */
+    public static function execute_returns(): external_single_structure {
+        return new external_single_structure([]);
+    }
+}

ai/classes/manager.php

@@ -19,7 +19,7 @@
 use core\exception\coding_exception;
 use core_ai\aiactions\base;
 use core_ai\aiactions\responses;
-
+use core\plugininfo\aiprovider as aiproviderplugin;
 /**
  * AI subsystem manager.
  *
@@ -79,7 +79,7 @@ public static function get_supported_actions(string $pluginname): array {
      */
     public function get_providers_for_actions(array $actions, bool $enabledonly = false): array {
         $providers = [];
-        $instances = $this->get_provider_instances();
+        $instances = $this->get_sorted_providers();
         foreach ($actions as $action) {
             $providers[$action] = [];
             foreach ($instances as $instance) {
@@ -388,6 +388,11 @@ public function create_provider_instance(
 
         $id = $this->db->insert_record('ai_providers', $provider->to_record());
 
+        // Ensure the provider instance order config gets updated if the provider is enabled.
+        if ($enabled) {
+            $this->update_provider_order($id, \core\plugininfo\aiprovider::ENABLE);
+        }
+
         return $provider->with(id: $id);
     }
 
@@ -410,7 +415,7 @@ public function get_provider_record(array $filter = [], int $strictness = IGNORE
      * Get the provider records according to the filter.
      *
      * @param array|null $filter The filterable elements to get the records from.
-     * @return \stdClass[]
+     * @return array
      */
     public function get_provider_records(?array $filter = null): array {
         return $this->db->get_records(
@@ -428,7 +433,6 @@ public function get_provider_records(?array $filter = null): array {
      *
      * @param null|array $filter The database filter to apply when fetching provider records.
      * @return array An array of instantiated provider objects.
-     * @throws \dml_exception If there is a database error during record retrieval.
      */
     public function get_provider_instances(?array $filter = null): array {
         // Filter out any null values from the array (providers that couldn't be instantiated).
@@ -469,7 +473,6 @@ function ($record): ?provider {
      * @param array|null $config the configuration of the provider instance to be updated.
      * @param array|null $actionconfig the action configuration of the provider instance to be updated.
      * @return provider
-     * @throws \dml_exception
      */
     public function update_provider_instance(
         provider $provider,
@@ -515,6 +518,7 @@ public function enable_provider_instance(provider $provider): provider {
         if (!$provider->enabled) {
             $provider = $provider->with(enabled: true);
             $this->db->update_record('ai_providers', $provider->to_record());
+            $this->update_provider_order($provider->id, aiproviderplugin::ENABLE);
         }
 
         return $provider;
@@ -536,8 +540,146 @@ public function disable_provider_instance(provider $provider): provider {
                 $provider = $provider->with(enabled: false);
                 $this->db->update_record('ai_providers', $provider->to_record());
             }
+            $this->update_provider_order($provider->id, aiproviderplugin::DISABLE);
         }
 
         return $provider;
     }
+
+    /**
+     * Sorts provider instances by configured order.
+     *
+     * @param array $unsorted of provider instance objects
+     * @return array of provider instance objects
+     */
+    public static function sort_providers_by_order(array $unsorted): array {
+        $sorted = [];
+        $orderarray = explode(',', get_config('core_ai', 'provider_order'));
+
+        foreach ($orderarray as $notused => $providerid) {
+            foreach ($unsorted as $key => $provider) {
+                if ($provider->id == $providerid) {
+                    $sorted[] = $provider;
+                    unset($unsorted[$key]);
+                }
+            }
+        }
+
+        return array_merge($sorted, $unsorted);
+    }
+
+    /**
+     * Get the configured ai providers from the manager.
+     *
+     * @return array
+     */
+    public function get_sorted_providers(): array {
+        $unsorted = $this->get_provider_instances();
+        $orders = $this->sort_providers_by_order($unsorted);
+        $sortedplugins = [];
+
+        foreach ($orders as $order) {
+            $sortedplugins[$order->id] = $unsorted[$order->id];
+        }
+
+        return $sortedplugins;
+    }
+
+    /**
+     * Change the order of the provider instance relative to other provider instances.
+     *
+     * When possible, the change will be stored into the config_log table, to let admins check when/who has modified it.
+     *
+     * @param int $providerid The provider ID.
+     * @param int $direction The direction to move the provider instance. Negative numbers mean up, Positive mean down.
+     * @return bool Whether the provider has been updated or not.
+     */
+    public function change_provider_order(int $providerid, int $direction): bool {
+        $activefactors = array_keys($this->get_sorted_providers());
+        $key = array_search($providerid, $activefactors);
+
+        if ($key === false) {
+            return false;
+        }
+
+        $movedown = ($direction === aiproviderplugin::MOVE_DOWN && $key < count($activefactors) - 1);
+        $moveup = ($direction === aiproviderplugin::MOVE_UP && $key >= 1);
+        if ($movedown || $moveup) {
+            $this->update_provider_order($providerid, $direction);
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * Update the provider instance order configuration.
+     *
+     * @param int $providerid The provider ID.
+     * @param string|int $action
+     *
+     * @throws dml_exception
+     */
+    public function update_provider_order(int $providerid, string|int $action): void {
+        $order = explode(',', get_config('core_ai', 'provider_order'));
+        $key = array_search($providerid, $order);
+
+        switch ($action) {
+            case aiproviderplugin::MOVE_UP:
+                if ($key >= 1) {
+                    $fsave = $order[$key];
+                    $order[$key] = $order[$key - 1];
+                    $order[$key - 1] = $fsave;
+                }
+                break;
+
+            case aiproviderplugin::MOVE_DOWN:
+                if ($key < (count($order) - 1)) {
+                    $fsave = $order[$key];
+                    $order[$key] = $order[$key + 1];
+                    $order[$key + 1] = $fsave;
+                }
+                break;
+
+            case aiproviderplugin::ENABLE:
+                if (!$key) {
+                    $order[] = $providerid;
+                }
+                break;
+
+            case aiproviderplugin::DISABLE:
+                if ($key) {
+                    unset($order[$key]);
+                }
+                break;
+        }
+
+        $this->set_provider_config(['provider_order' => implode(',', $order)], 'core_ai');
+
+        \core\session\manager::gc(); // Remove stale sessions.
+        \core_plugin_manager::reset_caches();
+    }
+
+    /**
+     * Sets config variable for given provider instance.
+     *
+     * @param array $data The data to set.
+     * @param string $plugin The plugin name.
+     *
+     * @return bool true or exception.
+     * @throws dml_exception
+     */
+    public function set_provider_config(array $data, string $plugin): bool|dml_exception {
+        $providerconf = get_config($plugin);
+        foreach ($data as $key => $newvalue) {
+            if (empty($providerconf->$key)) {
+                add_to_config_log($key, null, $newvalue, $plugin);
+                set_config($key, $newvalue, $plugin);
+            } else if ($providerconf->$key != $newvalue) {
+                add_to_config_log($key, $providerconf->$key, $newvalue, $plugin);
+                set_config($key, $newvalue, $plugin);
+            }
+        }
+        return true;
+    }
 }