first commit

communication/classes/task/add_members_to_room_task.php

@@ -0,0 +1,63 @@
+<?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_communication\task;
+
+use core\task\adhoc_task;
+use core_communication\processor;
+
+/**
+ * Class add_members_to_room_task to add the task to add members to the room and execute the task to action the addition.
+ *
+ * @package    core_communication
+ * @copyright  2023 David Woloszyn <david.woloszyn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class add_members_to_room_task extends adhoc_task {
+    public function execute() {
+        // Initialize the custom data operation to be used for the action.
+        $data = $this->get_custom_data();
+
+        // Call the communication api to action the operation.
+        $communication = processor::load_by_id($data->id);
+
+        if ($communication === null) {
+            mtrace("Skipping room creation because the instance does not exist");
+            return;
+        }
+
+        $communication->get_room_user_provider()->add_members_to_room($communication->get_instance_userids());
+    }
+
+    /**
+     * Queue the task for the next run.
+     *
+     * @param processor $communication The communication processor to perform the action on
+     */
+    public static function queue(
+        processor $communication
+    ): void {
+
+        // Add ad-hoc task to update the provider room.
+        $task = new self();
+        $task->set_custom_data([
+            'id' => $communication->get_id(),
+        ]);
+
+        // Queue the task for the next run.
+        \core\task\manager::queue_adhoc_task($task);
+    }
+}

communication/classes/task/create_and_configure_room_task.php

@@ -0,0 +1,74 @@
+<?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_communication\task;
+
+use core\task\adhoc_task;
+use core_communication\processor;
+
+/**
+ * Class create_and_configure_room_task to add a task to create a room and execute the task to action the creation.
+ *
+ * this task will be queued by the communication api and will use the communication handler api to action the creation.
+ *
+ * @package    core_communication
+ * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class create_and_configure_room_task extends adhoc_task {
+    public function execute() {
+        $data = $this->get_custom_data();
+
+        // Call the communication api to action the operation.
+        $communication = processor::load_by_id($data->id);
+
+        if ($communication === null) {
+            mtrace("Skipping room creation because the instance does not exist");
+            return;
+        }
+
+        if (!$communication->is_instance_active()) {
+            mtrace("Skipping room creation because the instance is not active");
+            return;
+        }
+
+        // If the room is created successfully, add members to the room if supported by the provider.
+        if ($communication->get_room_provider()->create_chat_room() && $communication->supports_user_features()) {
+            add_members_to_room_task::queue(
+                $communication
+            );
+        }
+    }
+
+    /**
+     * Queue the task for the next run.
+     *
+     * @param processor $communication The communication processor to perform the action on
+     */
+    public static function queue(
+        processor $communication,
+    ): void {
+
+        // Add ad-hoc task to update the provider room.
+        $task = new self();
+        $task->set_custom_data([
+            'id' => $communication->get_id(),
+        ]);
+
+        // Queue the task for the next run.
+        \core\task\manager::queue_adhoc_task($task);
+    }
+}

communication/classes/task/delete_room_task.php

@@ -0,0 +1,71 @@
+<?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_communication\task;
+
+use core\task\adhoc_task;
+use core_communication\processor;
+
+/**
+ * Class delete_room_task to add a task to delete a room and execute the task to action the deletion.
+ *
+ * this task will be queued by the communication api and will use the communication handler api to action the deletion.
+ *
+ * @package    core_communication
+ * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class delete_room_task extends adhoc_task {
+    public function execute() {
+        $data = $this->get_custom_data();
+
+        $communication = processor::load_by_id($data->id);
+
+        if ($communication === null) {
+            mtrace("Skipping room creation because the instance does not exist");
+            return;
+        }
+
+        // First remove the members from the room.
+        $communication->get_room_user_provider()->remove_members_from_room($communication->get_instance_userids(true, true));
+        // Now remove any mapping for users who are not in the room.
+        $communication->delete_instance_non_synced_user_mapping($communication->get_instance_userids(false, true));
+
+        // Now delete the room.
+        if ($communication->get_room_provider()->delete_chat_room()) {
+            $communication->delete_instance();
+        }
+    }
+
+    /**
+     * Queue the task for the next run.
+     *
+     * @param processor $communication The communication processor to perform the action on
+     */
+    public static function queue(
+        processor $communication,
+    ): void {
+
+        // Add ad-hoc task to update the provider room.
+        $task = new self();
+        $task->set_custom_data([
+            'id' => $communication->get_id(),
+        ]);
+
+        // Queue the task for the next run.
+        \core\task\manager::queue_adhoc_task($task);
+    }
+}

communication/classes/task/remove_members_from_room.php

@@ -0,0 +1,66 @@
+<?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_communication\task;
+
+use core\task\adhoc_task;
+use core_communication\processor;
+
+/**
+ * Class remove_members_from_room to add the task to remove members to the room and execute the task to action the removal.
+ *
+ * @package    core_communication
+ * @copyright  2023 David Woloszyn <david.woloszyn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class remove_members_from_room extends adhoc_task {
+    public function execute() {
+        // Initialize the custom data operation to be used for the action.
+        $data = $this->get_custom_data();
+
+        // Call the communication api to action the operation.
+        $communication = processor::load_by_id($data->id);
+
+        if ($communication === null) {
+            mtrace("Skipping room creation because the instance does not exist");
+            return;
+        }
+
+        $communication->get_room_user_provider()->remove_members_from_room($communication->get_all_delete_flagged_userids());
+
+        // Now remove any mapping for users who are not in the room.
+        $communication->delete_instance_non_synced_user_mapping($communication->get_instance_userids(false, true));
+    }
+
+    /**
+     * Queue the task for the next run.
+     *
+     * @param processor $communication The communication processor to perform the action on
+     */
+    public static function queue(
+        processor $communication
+    ): void {
+
+        // Add ad-hoc task to update the provider room.
+        $task = new self();
+        $task->set_custom_data([
+            'id' => $communication->get_id(),
+        ]);
+
+        // Queue the task for the next run.
+        \core\task\manager::queue_adhoc_task($task);
+    }
+}

communication/classes/task/synchronise_provider_task.php

@@ -0,0 +1,63 @@
+<?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_communication\task;
+
+use core\task\adhoc_task;
+use core_communication\processor;
+
+/**
+ * Class synchronise_provider_task to add a task to synchronise the provider and execute the task to action the synchronisation.
+ *
+ * @package    core_communication
+ * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class synchronise_provider_task extends adhoc_task {
+
+    public function execute() {
+        $data = $this->get_custom_data();
+
+        $communication = processor::load_by_id($data->id);
+
+        if ($communication === null) {
+            mtrace("Skipping provider sync because the instance does not exist");
+            return;
+        }
+
+        // Sync room members for the instance.
+        $communication->get_sync_provider()->synchronise_room_members();
+    }
+
+    /**
+     * Queue the task for the next run.
+     *
+     * @param processor $communication The communication processor to perform the action on
+     */
+    public static function queue(
+        processor $communication
+    ): void {
+
+        // Add ad-hoc task to update the provider room.
+        $task = new self();
+        $task->set_custom_data([
+            'id' => $communication->get_id(),
+        ]);
+
+        // Queue the task for the next run.
+        \core\task\manager::queue_adhoc_task($task);
+    }
+}

communication/classes/task/synchronise_providers_task.php

@@ -0,0 +1,61 @@
+<?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_communication\task;
+
+use core\task\scheduled_task;
+use core_communication\api;
+use core_communication\processor;
+
+/**
+ * Class synchronise_providers to add a task to synchronise the providers and execute the task to action the synchronisation.
+ *
+ * @package    core_communication
+ * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class synchronise_providers_task extends scheduled_task {
+
+    public function get_name() {
+        return get_string('synchroniseproviders', 'core_communication');
+    }
+
+    public function execute() {
+        // Communication is not enabled? nothing to do.
+        if (!api::is_available()) {
+            return;
+        }
+
+        global $DB;
+        $communicationinstances = $DB->get_records(
+            table: 'communication',
+            conditions: ['active' => processor::PROVIDER_ACTIVE],
+        );
+
+        foreach ($communicationinstances as $communicationinstance) {
+            $communication = \core_communication\api::load_by_instance(
+                context: \context::instance_by_id($communicationinstance->contextid),
+                component: $communicationinstance->component,
+                instancetype: $communicationinstance->instancetype,
+                instanceid: $communicationinstance->instanceid,
+            );
+            $processor = $communication->get_processor();
+            if ($processor->supports_sync_provider_features()) {
+                $communication->sync_provider();
+            }
+        }
+    }
+}

communication/classes/task/update_room_membership_task.php

@@ -0,0 +1,63 @@
+<?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_communication\task;
+
+use core\task\adhoc_task;
+use core_communication\processor;
+
+/**
+ * Class update_room_membership_task to add the task to update members for the room and execute the task to action the addition.
+ *
+ * @package    core_communication
+ * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class update_room_membership_task extends adhoc_task {
+    public function execute() {
+        // Initialize the custom data operation to be used for the action.
+        $data = $this->get_custom_data();
+
+        // Call the communication api to action the operation.
+        $communication = processor::load_by_id($data->id);
+
+        if ($communication === null) {
+            mtrace("Skipping room creation because the instance does not exist");
+            return;
+        }
+
+        $communication->get_room_user_provider()->update_room_membership($communication->get_instance_userids());
+    }
+
+    /**
+     * Queue the task for the next run.
+     *
+     * @param processor $communication The communication processor to perform the action on
+     */
+    public static function queue(
+        processor $communication
+    ): void {
+
+        // Add ad-hoc task to update the provider room.
+        $task = new self();
+        $task->set_custom_data([
+            'id' => $communication->get_id(),
+        ]);
+
+        // Queue the task for the next run.
+        \core\task\manager::queue_adhoc_task($task);
+    }
+}

communication/classes/task/update_room_task.php

@@ -0,0 +1,64 @@
+<?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_communication\task;
+
+use core\task\adhoc_task;
+use core_communication\processor;
+
+/**
+ * Class update_room_task to add a task to update a room and execute the task to action the update.
+ *
+ * this task will be queued by the communication api and will use the communication handler api to action the updates.
+ *
+ * @package    core_communication
+ * @copyright  2023 Safat Shahin <safat.shahin@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class update_room_task extends adhoc_task {
+    public function execute() {
+        $data = $this->get_custom_data();
+
+        // Call the communication api to action the operation.
+        $communication = processor::load_by_id($data->id);
+
+        if ($communication === null) {
+            mtrace("Skipping room creation because the instance does not exist");
+            return;
+        }
+
+        $communication->get_room_provider()->update_chat_room();
+    }
+
+    /**
+     * Queue the task for the next run.
+     *
+     * @param processor $communication The communication processor to perform the action on
+     */
+    public static function queue(
+        processor $communication,
+    ): void {
+
+        // Add ad-hoc task to update the provider room.
+        $task = new self();
+        $task->set_custom_data([
+            'id' => $communication->get_id(),
+        ]);
+
+        // Queue the task for the next run.
+        \core\task\manager::queue_adhoc_task($task);
+    }
+}