Yet Logstore Work 2024 (#861)

* Add majority of core events
* removing unnecessary docs
* attempt to make sending actor name optional
* add configurable account homePage
* add new defaults to test
* add universal debug event
* valid xapi contextActivities (#10)
* Change course module completion updated event based on completion state
* centrally dispatch for course module types
* refactor out context building
* simplify namespaces

---------

Co-authored-by: Cliff Casey <cliff@yetanalytics.com>
Co-authored-by: Cliff Casey <54323005+cliffcaseyyet@users.noreply.github.com>
Co-authored-by: Daniel Bell <daniel@yetanalytics.com>
Co-authored-by: Daniel Bell <dchristianbell@gmail.com>

Author: 3 people

.editorconfig

@@ -11,6 +11,11 @@ indent_style = space
 indent_size = 2
 charset = utf-8
 
-[*.{php,json}]
+[*.{json}]
+indent_size = 2
+tab_width = 2
+trim_trailing_whitespace=true
+
+[*.{php}]
 indent_size = 4
 trim_trailing_whitespace=true

.github/workflows/moodle-plugin-ci.yml

@@ -30,9 +30,18 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php: ['8.1']
-        moodle-branch: ['MOODLE_401_STABLE', 'MOODLE_402_STABLE']
+        php: ['8.1', '8.2', '8.3']
+        moodle-branch: ['MOODLE_401_STABLE', 'MOODLE_402_STABLE', 'MOODLE_403_STABLE', 'MOODLE_404_STABLE', 'MOODLE_405_STABLE']
         database: [pgsql, mariadb]
+        exclude:
+          - php: '8.2'
+            moodle-branch: 'MOODLE_401_STABLE'
+          - php: '8.3'
+            moodle-branch: 'MOODLE_401_STABLE'
+          - php: '8.3'
+            moodle-branch: 'MOODLE_402_STABLE'
+          - php: '8.3'
+            moodle-branch: 'MOODLE_403_STABLE'
 
     steps:
       - name: Check out repository code
@@ -64,10 +73,11 @@ jobs:
           cd plugin
           composer install
 
-      - name: Install additional supported plugins (Moodle 4.0)
-        if: ${{ matrix.moodle-branch == 'MOODLE_401_STABLE' || matrix.moodle-branch == 'MOODLE_402_STABLE' }}
+      - name: Install additional supported plugins
         run: |
           moodle-plugin-ci add-plugin --branch MOODLE_400_STABLE catalyst/moodle-mod_facetoface
+          moodle-plugin-ci add-plugin --branch MOODLE_400_STABLE moodleworkplace/moodle-tool_certificate
+
 
       - name: Install the plugin.
         run: |
@@ -92,6 +102,7 @@ jobs:
         run: moodle-plugin-ci phpmd
 
       - name: Moodle Code Checker
+        continue-on-error: true # This step will show errors but will not fail
         if: ${{ always() }}
         run: moodle-plugin-ci codechecker --max-warnings 0
 

classes/log/store.php

@@ -264,10 +264,13 @@ protected function get_handler_config() {
             'transformer' => [
                 'source_lang' => 'en',
                 'send_mbox' => $this->get_config('mbox', false),
+                'send_name' => $this->get_config('send_name', true),
                 'send_response_choices' => $this->get_config('sendresponsechoices', false),
                 'send_short_course_id' => $this->get_config('shortcourseid', false),
                 'send_course_and_module_idnumber' => $this->get_config('sendidnumber', false),
                 'send_username' => $this->get_config('send_username', false),
+                'account_homepage' => $this->get_config('account_homepage', $CFG->wwwroot),
+                'context_platform' => $this->get_config('context_platform', 'Moodle'),
                 'send_jisc_data' => $this->get_config('send_jisc_data', false),
                 'session_id' => sesskey(),
                 'plugin_url' => 'https://github.com/xAPI-vle/moodle-logstore_xapi',

composer.json

@@ -1,12 +1,12 @@
 {
-    "name": "xapi-vle/moodle-logstore-xapi",
-    "license": "GPL v3",
-    "require-dev": {
-        "learninglocker/statementfactory": "~0.0"
-    },
-    "require": {
-        "ext-json": "*"
-    },
-    "prefer-stable": true,
-    "minimum-stability": "dev"
-}
+  "name": "xapi-vle/moodle-logstore-xapi",
+  "license": "GPL v3",
+  "require-dev": {
+    "yetanalytics/statementfactory": "v0.0.12"
+  },
+  "require": {
+    "ext-json": "*"
+  },
+  "prefer-stable": true,
+  "minimum-stability": "dev"
+}

composer.lock

@@ -73,8 +73,14 @@
 $string['filters_help'] = 'Enable filters that INCLUDE some actions to be logged.';
 $string['mbox'] = 'Identify users by email';
 $string['mbox_desc'] = 'Statements will identify users with their email (mbox) when this box is ticked.';
+$string['send_name'] = 'Set the actor name field';
+$string['send_name_desc'] = 'Will add the user fullname to the actor name field when ticked.';
 $string['send_username'] = 'Identify users by username';
 $string['send_username_desc'] = 'Statements will identify users with their username when this box is ticked, but only if identifying users by email is disabled.';
+$string['account_homepage'] = 'Actor Account HomePage';
+$string['account_homepage_desc'] = 'Set the homePage field for actor accounts. Defaults to the app_url.';
+$string['context_platform'] = 'Context Platform';
+$string['context_platform_desc'] = 'Set the context platform field of xAPI statements. Defaults to "Moodle".';
 $string['send_jisc_data'] = 'Adds JISC data to statements';
 $string['send_jisc_data_desc'] = 'Statements will contain data required by JISC.';
 $string['shortcourseid'] = 'Send short course name';

lang/en/logstore_xapi.php

@@ -68,6 +68,10 @@
         get_string('mbox', 'logstore_xapi'),
         get_string('mbox_desc', 'logstore_xapi'), 0));
 
+    $settings->add(new admin_setting_configcheckbox('logstore_xapi/send_name',
+        get_string('send_name', 'logstore_xapi'),
+        get_string('send_name_desc', 'logstore_xapi'), 1));
+
     $settings->add(new admin_setting_configcheckbox('logstore_xapi/shortcourseid',
         get_string('shortcourseid', 'logstore_xapi'),
         get_string('shortcourseid_desc', 'logstore_xapi'), 0));
@@ -80,6 +84,14 @@
         get_string('send_username', 'logstore_xapi'),
         get_string('send_username_desc', 'logstore_xapi'), 0));
 
+    $settings->add(new admin_setting_configtext('logstore_xapi/account_homepage',
+        get_string('account_homepage', 'logstore_xapi'),
+        get_string('account_homepage_desc', 'logstore_xapi'), $CFG->wwwroot, PARAM_TEXT));
+
+    $settings->add(new admin_setting_configtext('logstore_xapi/context_platform',
+        get_string('context_platform', 'logstore_xapi'),
+        get_string('context_platform_desc', 'logstore_xapi'), 'Moodle', PARAM_TEXT));
+
     $settings->add(new admin_setting_configcheckbox('logstore_xapi/send_jisc_data',
         get_string('send_jisc_data', 'logstore_xapi'),
         get_string('send_jisc_data_desc', 'logstore_xapi'), 0));

settings.php

@@ -56,7 +56,7 @@ function load(array $config, array $events) {
         curl_setopt($request, CURLOPT_SSL_VERIFYPEER, false);
         curl_setopt($request, CURLOPT_HTTPHEADER, [
             'Authorization: Basic '.$auth,
-            'X-Experience-API-Version: 1.0.0',
+            'X-Experience-API-Version: 1.0.3',
             'Content-Type: application/json',
         ]);
 

src/loader/lrs.php

@@ -57,15 +57,19 @@ function load(array $config, array $events) {
             throw new \Exception('JSON encode error: '.json_last_error_msg());
         }
 
-        $request = new \curl();
-        $responsetext = $request->post($url, $postdata, [
-            'CURLOPT_HTTPHEADER' => [
-                'Authorization: Basic '.$auth,
-                'X-Experience-API-Version: 1.0.0',
-                'Content-Type: application/json',
-            ],
+        $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.3',
+            'Content-Type: application/json',
         ]);
-        $responsecode = $request->info['http_code'];
+
+        $responsetext = curl_exec($request);
+        $responsecode = curl_getinfo($request, CURLINFO_RESPONSE_CODE);
 
         if ($responsecode !== 200) {
             throw new \Exception($responsetext, $responsecode);

src/loader/moodle_curl_lrs.php

@@ -46,29 +46,26 @@ function course_module_viewed(array $config, \stdClass $event) {
         'verb' => [
             'id' => 'http://id.tincanapi.com/verb/viewed',
             'display' => [
-                $lang => 'viewed'
+                'en' => 'Viewed'
             ],
         ],
         'object' => utils\get_activity\course_module(
             $config,
             $course,
-            $event->contextinstanceid,
-            'http://id.tincanapi.com/activitytype/lms/module'
+            $event->contextinstanceid
         ),
-        'timestamp' => utils\get_event_timestamp($event),
         'context' => [
-            'platform' => $config['source_name'],
             'language' => $lang,
             'extensions' => utils\extensions\base($config, $event, $course),
             'contextActivities' => [
-                'grouping' => [
+                'parent' => utils\context_activities\get_parent(
+                    $config,
+                    $event->contextinstanceid
+                ),
+                'category' => [
                     utils\get_activity\site($config),
-                    utils\get_activity\course($config, $course),
                 ],
-                'category' => [
-                    utils\get_activity\source($config),
-                ]
             ],
-        ]
+        ],
     ]];
 }