feat: Adds moodle_curl_lrs loader to close #238

.editorconfig

@@ -13,3 +13,4 @@ charset = utf-8
 
 [*.{php,json}]
 indent_size = 4
+trim_trailing_whitespace=true

classes/log/store.php

@@ -81,18 +81,6 @@ public function get_max_batch_size() {
         return $this->get_config('maxbatchsize', 100);
     }
 
-    private function get_proxy_endpoint() {
-        global $CFG;
-        if (!empty($CFG->proxyhost)) {
-            if (!empty($CFG->proxyport)) {
-                return $CFG->proxyhost.':'.$CFG->proxyport;
-            } else {
-                return $CFG->proxyhost;
-            }
-        }
-        return null;
-    }
-
     public function process_events(array $events) {
         global $DB;
         global $CFG;
@@ -121,12 +109,11 @@ public function process_events(array $events) {
                 'app_url' => $CFG->wwwroot,
             ],
             'loader' => [
-                'loader' => 'lrs',
+                'loader' => 'moodle_curl_lrs',
                 'lrs_endpoint' => $this->get_config('endpoint', ''),
                 'lrs_username' => $this->get_config('username', ''),
                 'lrs_password' => $this->get_config('password', ''),
                 'lrs_max_batch_size' => $this->get_max_batch_size(),
-                'lrs_proxy_endpoint' => $this->get_proxy_endpoint(),
             ],
         ];
         $loadedevents = \src\handler($handlerconfig, $events);

src/loader/lrs.php

@@ -19,86 +19,35 @@
 
 use src\loader\utils as utils;
 
-function correct_endpoint($endpoint) {
-    $endswithstatements = substr($endpoint, -11) === "/statements";
-    if ($endswithstatements) {
-        return substr($endpoint, 0, -11);
-    }
-    return rtrim($endpoint, '/');
-}
-
-function send_http_statements(array $config, array $statements) {
-    $endpoint = $config['lrs_endpoint'];
-    $username = $config['lrs_username'];
-    $password = $config['lrs_password'];
-    $proxyendpoint = $config['lrs_proxy_endpoint'];
-
-    $url = correct_endpoint($endpoint).'/statements';
-    $auth = base64_encode($username.':'.$password);
-    $postdata = json_encode($statements);
-
-    $request = curl_init();
-    curl_setopt($request, CURLOPT_URL, $url);
-    curl_setopt($request, CURLOPT_POSTFIELDS, $postdata);
-    curl_setopt($request, CURLOPT_RETURNTRANSFER, true);
-    curl_setopt($request, CURLOPT_SSL_VERIFYPEER, false);
-    if (isset($proxyendpoint)) {
-        curl_setopt($request, CURLOPT_PROXY, $proxyendpoint);
-    }
-    curl_setopt($request, CURLOPT_HTTPHEADER, [
-        'Authorization: Basic '.$auth,
-        'X-Experience-API-Version: 1.0.0',
-        'Content-Type: application/json',
-    ]);
-
-    $responsetext = curl_exec($request);
-    $responsecode = curl_getinfo($request, CURLINFO_RESPONSE_CODE);
-    curl_close($request);
-
-    if ($responsecode !== 200) {
-        throw new \Exception($responsetext);
-    }
-}
-
-function load_transormed_events_to_lrs(array $config, array $transformedevents) {
-    try {
-        $statements = array_reduce($transformedevents, function ($result, $transformedevent) {
-            $eventstatements = $transformedevent['statements'];
-            return array_merge($result, $eventstatements);
-        }, []);
-        send_http_statements($config, $statements);
-        $loadedevents = utils\construct_loaded_events($transformedevents, true);
-        return $loadedevents;
-    } catch (\Exception $e) {
-        $logerror = $config['log_error'];
-        $logerror("Failed load for event id #" . $eventobj->id . ": " .  $e->getMessage());
-        $logerror($e->getTraceAsString());
-        $loadedevents = utils\construct_loaded_events($transformedevents, false);
-        return $loadedevents;
-    }
-}
-
-function get_event_batches(array $config, array $transformedevents) {
-    $maxbatchsize = $config['lrs_max_batch_size'];
-    if (!empty($maxbatchsize) && $maxbatchsize < count($transformedevents)) {
-        return array_chunk($transformedevents, $maxbatchsize);
-    }
-    return [$transformedevents];
-}
-
 function load(array $config, array $events) {
-    // Attempts to load events that were transformed successfully in batches.
-    $successfultransformevents = utils\filter_transformed_events($events, true);
-    $batches = get_event_batches($config, $successfultransformevents);
-    $loadedevents = array_reduce($batches, function ($result, $batch) use ($config) {
-        $loadedbatchevents = load_transormed_events_to_lrs($config, $batch);
-        return array_merge($result, $loadedbatchevents);
-    }, []);
-
-    // Flags events that weren't transformed successfully as events that didn't load.
-    $failedtransformevents = utils\filter_transformed_events($events, false);
-    $nonloadedevents = utils\construct_loaded_events($failedtransformevents, false);
-
-    // Returns loaded and non-loaded events to avoid re-processing.
-    return array_merge($loadedevents, $nonloadedevents);
+    $sendhttpstatements = function (array $config, array $statements) {
+        $endpoint = $config['lrs_endpoint'];
+        $username = $config['lrs_username'];
+        $password = $config['lrs_password'];
+        $proxyendpoint = $config['lrs_proxy_endpoint'];
+
+        $url = utils\correct_endpoint($endpoint).'/statements';
+        $auth = base64_encode($username.':'.$password);
+        $postdata = json_encode($statements);
+
+        $request = curl_init();
+        curl_setopt($request, CURLOPT_URL, $url);
+        curl_setopt($request, CURLOPT_POSTFIELDS, $postdata);
+        curl_setopt($request, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($request, CURLOPT_SSL_VERIFYPEER, false);
+        curl_setopt($request, CURLOPT_HTTPHEADER, [
+            'Authorization: Basic '.$auth,
+            'X-Experience-API-Version: 1.0.0',
+            'Content-Type: application/json',
+        ]);
+
+        $responsetext = curl_exec($request);
+        $responsecode = curl_getinfo($request, CURLINFO_RESPONSE_CODE);
+        curl_close($request);
+
+        if ($responsecode !== 200) {
+            throw new \Exception($responsetext);
+        }
+    };
+    return utils\load_in_batches($config, $events, $sendhttpstatements);
 }

src/loader/moodle_curl_lrs.php

@@ -0,0 +1,54 @@
+<?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 src\loader\moodle_curl_lrs;
+defined('MOODLE_INTERNAL') || die();
+
+global $CFG;
+if (!isset($CFG)) {
+    $CFG = (object) [ 'libdir' => 'utils' ];
+}
+require_once($CFG->libdir . '/filelib.php');
+
+use src\loader\utils as utils;
+
+function load(array $config, array $events) {
+    $sendhttpstatements = function (array $config, array $statements) {
+        $endpoint = $config['lrs_endpoint'];
+        $username = $config['lrs_username'];
+        $password = $config['lrs_password'];
+        $proxyendpoint = $config['lrs_proxy_endpoint'];
+
+        $url = utils\correct_endpoint($endpoint).'/statements';
+        $auth = base64_encode($username.':'.$password);
+        $postdata = json_encode($statements);
+
+        $request = new \curl();
+        $responsetext = $request->post($url, $postdata, [
+            'CURLOPT_HTTPHEADER' => [
+                'Authorization: Basic '.$auth,
+                'X-Experience-API-Version: 1.0.0',
+                'Content-Type: application/json',
+            ],
+        ]);
+        $responsecode = $request->info['http_code'];
+
+        if ($responsecode !== 200) {
+            throw new \Exception($responsetext);
+        }
+    };
+    return utils\load_in_batches($config, $events, $sendhttpstatements);
+}

src/loader/utils/correct_endpoint.php

@@ -0,0 +1,27 @@
+<?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 src\loader\utils;
+
+defined('MOODLE_INTERNAL') || die();
+
+function correct_endpoint($endpoint) {
+    $endswithstatements = substr($endpoint, -11) === "/statements";
+    if ($endswithstatements) {
+        return substr($endpoint, 0, -11);
+    }
+    return rtrim($endpoint, '/');
+}

src/loader/utils/filelib.php

@@ -0,0 +1,23 @@
+<?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 src\loader\utils;
+
+defined('MOODLE_INTERNAL') || die();
+
+class curl {
+    // This is just a dummy file to avoid failures in CI.
+}

src/loader/utils/get_event_batches.php

@@ -0,0 +1,27 @@
+<?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 src\loader\utils;
+
+defined('MOODLE_INTERNAL') || die();
+
+function get_event_batches(array $config, array $transformedevents) {
+    $maxbatchsize = $config['lrs_max_batch_size'];
+    if (!empty($maxbatchsize) && $maxbatchsize < count($transformedevents)) {
+        return array_chunk($transformedevents, $maxbatchsize);
+    }
+    return [$transformedevents];
+}

src/loader/utils/load_batch.php

@@ -0,0 +1,37 @@
+<?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 src\loader\utils;
+
+defined('MOODLE_INTERNAL') || die();
+
+function load_batch(array $config, array $transformedevents, callable $loader) {
+    try {
+        $statements = array_reduce($transformedevents, function ($result, $transformedevent) {
+            $eventstatements = $transformedevent['statements'];
+            return array_merge($result, $eventstatements);
+        }, []);
+        $loader($config, $statements);
+        $loadedevents = construct_loaded_events($transformedevents, true);
+        return $loadedevents;
+    } catch (\Exception $e) {
+        $logerror = $config['log_error'];
+        $logerror("Failed load for event id #" . $eventobj->id . ": " .  $e->getMessage());
+        $logerror($e->getTraceAsString());
+        $loadedevents = construct_loaded_events($transformedevents, false);
+        return $loadedevents;
+    }
+}

src/loader/utils/load_in_batches.php

@@ -0,0 +1,36 @@
+<?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 src\loader\utils;
+
+defined('MOODLE_INTERNAL') || die();
+
+function load_in_batches(array $config, array $events, callable $loader) {
+    // Attempts to load events that were transformed successfully in batches.
+    $successfultransformevents = filter_transformed_events($events, true);
+    $batches = get_event_batches($config, $successfultransformevents);
+    $loadedevents = array_reduce($batches, function ($result, $batch) use ($config, $loader) {
+        $loadedbatchevents = load_batch($config, $batch, $loader);
+        return array_merge($result, $loadedbatchevents);
+    }, []);
+
+    // Flags events that weren't transformed successfully as events that didn't load.
+    $failedtransformevents = filter_transformed_events($events, false);
+    $nonloadedevents = construct_loaded_events($failedtransformevents, false);
+
+    // Returns loaded and non-loaded events to avoid re-processing.
+    return array_merge($loadedevents, $nonloadedevents);
+}

tests/xapi_test_case.php

@@ -54,7 +54,6 @@ public function test_create_event() {
                 'lrs_username' => '',
                 'lrs_password' => '',
                 'lrs_max_batch_size' => 1,
-                'lrs_proxy_endpoint' => null,
             ],
         ];
         $loadedevents = \src\handler($handlerconfig, [$event]);