MDL-73703 auth_ldap: Break apart sync_task

Extracted code from sync_users() into separate functions in order to enable ad-hoc sheduling, and chunking. Co-authored-by: David Woloszyn <[email protected]>
2024-01-24 12:17:53 +11:00
parent 810554ee83
commit 3079896480
7 changed files with 201 additions and 43 deletions
@@ -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/>.
+
+/**
+ * Adhoc task for LDAP user sync.
+ *
+ * @package    auth_ldap
+ * @copyright  Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace auth_ldap\task;
+
+use core\task\adhoc_task;
+
+/**
+ * Adhoc task class for LDAP user sync.
+ *
+ * @package    auth_ldap
+ * @copyright  Catalyst IT
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class asynchronous_sync_task extends adhoc_task {
+
+    /** @var string Message prefix for mtrace */
+    protected const MTRACE_MSG = 'Synced ldap users';
+
+    /**
+     * Constructor
+     */
+    public function __construct() {
+        $this->set_blocking(false);
+        $this->set_component('auth_ldap');
+    }
+
+    /**
+     * Run users sync.
+     */
+    public function execute() {
+        $data = $this->get_custom_data();
+
+        /** @var auth_plugin_ldap $auth */
+        $auth = get_auth_plugin('ldap');
+        $auth->update_users($data->users, $data->updatekeys);
+
+        mtrace(sprintf(" %s (%d)", self::MTRACE_MSG, count($data->users)));
+    }
+}