first commit

2023-10-22 08:41:16 +02:00
commit 0d2de82fdc
12 changed files with 2284 additions and 0 deletions
--- a/cli/sync.php
+++ b/cli/sync.php
@@ -0,0 +1,105 @@
+<?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/>.
+
+/**
+ * CLI sync for full OSS synchronisation.
+ *
+ * This script is meant to be called from a cronjob to sync moodle with the OSS
+ * server to pickup groups as moodle global groups (cohorts).
+ *
+ * Sample cron entry:
+ * # 5 minutes past every full hour
+ * 5 * * * * $sudo -u www-data /usr/bin/php /var/www/moodle/enrol/oss/cli/sync.php
+ *
+ * Notes:
+ *   - it is required to use the web server account when executing PHP CLI scripts
+ *   - you need to change the "www-data" to match the apache user account
+ *   - use "su" if "sudo" not available
+ *   - If you have a large number of users, you may want to raise the memory limits
+ *     by passing -d momory_limit=256M
+ *   - For debugging & better logging, you are encouraged to use in the command line:
+ *     -d log_errors=1 -d error_reporting=E_ALL -d display_errors=0 -d html_errors=0
+ *
+ * @package    enrol
+ * @subpackage oss
+ * @author     Frank Schütte - test script
+ * @copyright  2012 Frank Schütte <fschuett@gymnasium-himmelsthuer.de>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+define("CLI_SCRIPT", true);
+
+require (dirname(dirname(dirname(dirname(__FILE__)))) . "/config.php");
+require_once ("{$CFG -> libdir}/clilib.php");
+
+// Parse CLI arguments
+list ($options, $unrecognized) = cli_get_params (
+    [
+        "help" => false,
+        "user" => false
+    ],
+    [
+        "h" => "help",
+        "u" => "user"
+    ],
+);
+
+if ($unrecognized) {
+    $unrecognized = implode ("\n  ", $unrecognized);
+    cli_error (get_string ("cliunknownoption", "enrol_iserv", $unrecognized));
+} else if ($options["help"]) {
+    $help = <<< EOH
+    Manually do a sync of IServ groups as courses.
+    Please ensure to enable and configure the enrol_iserv Plugin beforehand.
+
+    Options:
+    -h, --help    Print out this help
+
+    Example:
+    \$sudo -u www-data /usr/bin/php enrol/iserv/cli/sync.php
+
+    Notice:
+      Do not call this file through the system cron scheduler, rather
+      use the scheduled task within Moodle this plugin provides.
+
+    
+    EOH;
+
+    echo $help;
+    die;
+}
+
+// Enable debug messages
+$CFG -> debug = DEBUG_NORMAL;
+
+// Ensure required plugins are enabled
+if (! is_enabled_auth ("ldap")) {
+    print ("[AUTH LDAP] " . get_string ("pluginnotenabled", "auth_ldap"));
+    die;
+}
+
+if (! enrol_is_enabled ("iserv")) {
+    print ("[ENROL IServ] " . get_string ("pluginnotenabled", "enrol_iserv"));
+    die;
+}
+
+// Sync courses
+$enrol = enrol_get_plugin ("iserv");
+if (! $enrol -> sync_courses ($options["user"] ?? "*")) {
+    cli_error (get_string ("sync_failed", "enrol_iserv"), 1);
+};
+
+exit(0);