WIP

classes/external/condition_form.php

@@ -18,17 +18,13 @@
 
 use context_system;
 use moodle_exception;
-use external_api;
-use external_function_parameters;
-use external_single_structure;
-use external_value;
+use core_external\external_api;
+use core_external\external_function_parameters;
+use core_external\external_single_structure;
+use core_external\external_value;
 use tool_dynamic_cohorts\condition_base;
 use tool_dynamic_cohorts\condition_form as form;
 
-defined('MOODLE_INTERNAL') || die();
-
-require_once($CFG->dirroot . '/lib/externallib.php');
-
 /**
  * Condition form AJAX submission.
  *

classes/external/matching_users.php

@@ -17,17 +17,13 @@
 namespace tool_dynamic_cohorts\external;
 
 use context_system;
-use external_api;
-use external_function_parameters;
-use external_value;
+use core_external\external_api;
+use core_external\external_function_parameters;
+use core_external\external_value;
 use tool_dynamic_cohorts\rule;
 use invalid_parameter_exception;
 use tool_dynamic_cohorts\rule_manager;
 
-defined('MOODLE_INTERNAL') || die();
-
-require_once($CFG->dirroot . '/lib/externallib.php');
-
 /**
  * Matching users external APIs.
  *

classes/external/rule_conditions.php

@@ -17,19 +17,15 @@
 namespace tool_dynamic_cohorts\external;
 
 use context_system;
-use external_api;
-use external_function_parameters;
-use external_value;
-use external_multiple_structure;
-use external_single_structure;
+use core_external\external_api;
+use core_external\external_function_parameters;
+use core_external\external_value;
+use core_external\external_multiple_structure;
+use core_external\external_single_structure;
 use tool_dynamic_cohorts\condition_base;
 use tool_dynamic_cohorts\rule;
 use invalid_parameter_exception;
 
-defined('MOODLE_INTERNAL') || die();
-
-require_once($CFG->dirroot . '/lib/externallib.php');
-
 /**
  * Rule conditions external APIs.
  *

classes/external/rules.php

@@ -0,0 +1,157 @@
+<?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/>.
+
+namespace tool_dynamic_cohorts\external;
+
+use context_system;
+use core_external\external_api;
+use core_external\external_function_parameters;
+use core_external\external_multiple_structure;
+use core_external\external_value;
+use core_external\external_single_structure;
+use Throwable;
+use tool_dynamic_cohorts\condition_base;
+use tool_dynamic_cohorts\event\rule_updated;
+use tool_dynamic_cohorts\rule;
+use invalid_parameter_exception;
+use tool_dynamic_cohorts\rule_manager;
+
+/**
+ * Rules external APIs.
+ *
+ * @package     tool_dynamic_cohorts
+ * @copyright   2024 Catalyst IT
+ * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class rules extends external_api {
+
+    /**
+     * Describes the parameters for delete_rule webservice.
+     *
+     * @return external_function_parameters
+     */
+    public static function delete_rules_parameters(): external_function_parameters {
+        return new external_function_parameters(
+            [
+                'ruleids' => new external_multiple_structure(new external_value(PARAM_INT, 'Rule IDs')
+                    , 'List of rule id to delete.'),
+            ]
+        );
+    }
+
+    /**
+     * Deletes provided rules.
+     *
+     * @param array $ruleids Rule IDs.
+     * @return array
+     */
+    public static function delete_rules(array $ruleids): array {
+        global $DB;
+
+        self::validate_parameters(self::delete_rules_parameters(), ['ruleids' => $ruleids]);
+
+        self::validate_context(context_system::instance());
+        require_capability('tool/dynamic_cohorts:manage', context_system::instance());
+
+        // We would like to treat deletion for multiple rules as one operation.
+        // If one failed we would like to fail whole call and roll back.
+        $transaction = $DB->start_delegated_transaction();
+        try {
+            foreach ($ruleids as $ruleid) {
+                $rule = rule::get_record(['id' => (int) $ruleid], MUST_EXIST);
+                if (empty($rule)) {
+                    throw new invalid_parameter_exception('Rule does not exist. ID: ' . $ruleid);
+                }
+                rule_manager::delete_rule($rule);
+            }
+        } catch (throwable $ex) {
+            $transaction->rollback($ex);
+        }
+
+        $transaction->allow_commit();
+
+        return [];
+    }
+
+    /**
+     * Returns description of method result value.
+     *
+     * @return external_single_structure
+     */
+    public static function delete_rules_returns(): external_single_structure {
+        return new external_single_structure([]);
+    }
+
+    /**
+     * Enable or disable rule.
+     *
+     * @return external_function_parameters
+     */
+    public static function toggle_status_parameters(): external_function_parameters {
+        return new external_function_parameters([
+            'ruleid' => new external_value(PARAM_INT, 'The rule ID to toggle'),
+        ]);
+    }
+
+    /**
+     * Toggle rule.
+     *
+     * @param int $ruleid Rule ID.
+     * @return array
+     */
+    public static function toggle_status(int $ruleid): array {
+        self::validate_parameters(self::delete_rules_parameters(), ['ruleid' => $ruleid]);
+
+        self::validate_context(context_system::instance());
+        require_capability('tool/dynamic_cohorts:manage', context_system::instance());
+
+        $rule = rule::get_record(['id' => $ruleid], MUST_EXIST);
+        if (empty($rule)) {
+            throw new invalid_parameter_exception('Rule does not exist.');
+        }
+
+        if ($rule->is_broken()) {
+            // Disable broken rule
+            $rule->set('enabled', 0);
+            $rule->save();
+            rule_updated::create(['other' => ['ruleid' => $rule->get('id')]])->trigger();
+
+            throw new invalid_parameter_exception('A broken rule can\'t be enabled');
+        }
+
+        $newvalue = (int) !$rule->is_enabled();
+        $rule->set('enabled', $newvalue);
+        $rule->save();
+        rule_updated::create(['other' => ['ruleid' => $rule->get('id')]])->trigger();
+
+        return [
+            'ruleid' => $rule->get('id'),
+            'enabled' => $newvalue,
+        ];
+    }
+
+    /**
+     * Returns description of method result value.
+     *
+     * @return external_single_structure
+     */
+    public static function toggle_status_returns(): external_single_structure {
+        return new external_single_structure([
+            'ruleid' => new external_value(PARAM_INT, 'The rule ID'),
+            'enabled' => new external_value(PARAM_INT, 'New status for the rule'),
+        ]);
+    }
+}

db/services.php

@@ -49,4 +49,20 @@
         'capabilities'    => 'tool/dynamic_cohorts:manage',
         'ajax'            => true,
     ],
+    'tool_dynamic_cohorts_delete_rules' => [
+        'classname'       => 'tool_dynamic_cohorts\external\rules',
+        'methodname'      => 'delete_rules',
+        'description'     => 'Delete provided rules',
+        'type'            => 'write',
+        'capabilities'    => 'tool/dynamic_cohorts:manage',
+        'ajax'            => true,
+    ],
+    'tool_dynamic_cohorts_toggle_rule_status' => [
+        'classname'       => 'tool_dynamic_cohorts\external\rules',
+        'methodname'      => 'toggle_status',
+        'description'     => 'Toggles status for given rule (disable or enable)',
+        'type'            => 'write',
+        'capabilities'    => 'tool/dynamic_cohorts:manage',
+        'ajax'            => true,
+    ],
 ];