Pm 43593 grading

.gitignore

@@ -46,5 +46,8 @@ development/node_modules/
 # Local History for Visual Studio Code
 .history/
 
+## vim
+.phpactor.json
+
 # macOS
 .DS_Store

CHANGES.md

@@ -1,3 +1,8 @@
+### v1.3.0 (Build - 2024101601)
+
+* Added Grading
+* Improved Moodle 4.5 compatibility
+
 ### v1.2.1 (Build - 2024091201)
 
 * Namespaced styles

classes/grading/grading_service.php

@@ -0,0 +1,111 @@
+<?php
+// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
+
+// phpcs:disable moodle.NamingConventions.ValidFunctionName.LowercaseMethod
+// phpcs:disable moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+// phpcs:disable moodle.Files.RequireLogin.Missing -- doesn't require user to be logged in, as it's an LTI service
+
+namespace mod_kialo\grading;
+
+require_once(__DIR__ . '/../../../../config.php');
+require_once(__DIR__ . '/../../lib.php');
+require_once(__DIR__ . '/../../constants.php');
+require_once(__DIR__ . '/../../vendor/autoload.php');
+require_once($CFG->libdir . '/gradelib.php');
+
+use grade_item;
+use moodle_url;
+use OAT\Library\Lti1p3Core\Exception\LtiException;
+
+/**
+ * Service offering grading functionalities for LTI requests.
+ *
+ * @package     mod_kialo
+ * @copyright   2023 onwards, Kialo GmbH <[email protected]>
+ * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class grading_service {
+    /**
+     * Returns the line_item describing the grading settings for the given course module.
+     *
+     * @param int $courseid
+     * @param int $cmid
+     * @param string $resourcelinkid
+     * @return void
+     * @throws LtiException
+     * @throws \coding_exception
+     * @throws \moodle_exception
+     */
+    public static function get_line_item(int $courseid, int $cmid, string $resourcelinkid): line_item {
+        $module = get_coursemodule_from_id('kialo', $cmid, $courseid, false, MUST_EXIST);
+
+        $gradeitem = grade_item::fetch(['iteminstance' => $module->instance, 'itemtype' => 'mod']);
+        if (!$gradeitem) {
+            $maxscore = 100;
+        } else {
+            $maxscore = $gradeitem->grademax;
+        }
+
+        $lineitem = new line_item();
+
+        // Assuming this is called from /mod/kialo/lti_lineitem.php. The ID is the URL of the request.
+        $lineitem->id = (new moodle_url($_SERVER['REQUEST_URI']))->out(false);
+        $lineitem->label = $module->name;
+        $lineitem->scoreMaximum = floatval($maxscore);
+        $lineitem->resourceLinkId = $resourcelinkid;
+
+        return $lineitem;
+    }
+
+    /**
+     * Writes grade information. The expected data format is the one defined in the spec,
+     * see https://www.imsglobal.org/spec/lti-ags/v2p0#example-posting-a-final-score-update.
+     *
+     * @param int $courseid
+     * @param int $cmid
+     * @param array $data array with required field userId
+     * @return bool Returns true if the grade information could be persisted.
+     * @throws LtiException
+     * @throws \coding_exception
+     * @throws \dml_exception
+     */
+    public static function update_grade(int $courseid, int $cmid, array $data): bool {
+        global $DB;
+
+        $module = get_coursemodule_from_id('kialo', $cmid, $courseid, false, MUST_EXIST);
+        $moduleinstance = $DB->get_record('kialo', ['id' => $module->instance], '*', MUST_EXIST);
+
+        if (!isset($data['userId'])) {
+            throw new LtiException("Missing userId in the request body");
+        }
+
+        // Receive a score for the line item via JSON request body.
+        $userid = $data['userId'];
+        $scoregiven = isset($data['scoreGiven']) ? floatval($data['scoreGiven']) : null;
+        $comment = $data['comment'] ?? '';
+        $timestamp = isset($data['timestamp']) ? strtotime($data['timestamp']) : time();
+
+        $grades = [
+            'userid' => $userid,
+            'feedback' => $comment,
+            'dategraded' => $timestamp,
+        ];
+        $grades['rawgrade'] = $scoregiven;
+
+        $result = kialo_grade_item_update($moduleinstance, (object) $grades);
+        return ($result === GRADE_UPDATE_OK || $result === GRADE_UPDATE_MULTIPLE);
+    }
+}

classes/grading/line_item.php

@@ -0,0 +1,94 @@
+<?php
+// This file is part of Moodle - https://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 <https://www.gnu.org/licenses/>.
+
+// phpcs:disable moodle.NamingConventions.ValidFunctionName.LowercaseMethod
+// phpcs:disable moodle.NamingConventions.ValidVariableName.MemberNameUnderscore
+
+namespace mod_kialo\grading;
+
+/**
+ * Represents a line item in the LTI 1.3 Assignment and Grading Service.
+ *
+ * @package     mod_kialo
+ * @copyright   2023 onwards, Kialo GmbH <[email protected]>
+ * @license     https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class line_item {
+    /**
+     * @var string|null $id
+     */
+    public $id;
+
+    /**
+     * @var float|null $scoreMaximum
+     */
+    public $scoreMaximum;
+
+    /**
+     * @var string|null $label
+     */
+    public $label;
+
+    /**
+     * @var string|null $resourceId
+     */
+    public $resourceId;
+
+    /**
+     * @var string|null $tag
+     */
+    public $resourceLinkId;
+
+    /**
+     * @var string|null $tag
+     */
+    public $tag;
+
+    /**
+     * ISO 8601 timestamp, see https://www.imsglobal.org/spec/lti-ags/v2p0#startdatetime.
+     *
+     * @var string|null $startDateTime
+     */
+    public $startDateTime;
+
+    /**
+     * ISO 8601 timestamp, see https://www.imsglobal.org/spec/lti-ags/v2p0#enddatetime.
+     *
+     * @var string|null $endDateTime
+     */
+    public $endDateTime;
+
+    /**
+     * @var bool|null $gradesReleased
+     */
+    public $gradesReleased;
+
+    /**
+     * LineItem constructor.
+     * @param array|null $lineitem
+     */
+    public function __construct(?array $lineitem = null) {
+        $this->id = $lineitem['id'] ?? null;
+        $this->scoreMaximum = $lineitem['scoreMaximum'] ?? null;
+        $this->label = $lineitem['label'] ?? null;
+        $this->resourceId = $lineitem['resourceId'] ?? null;
+        $this->resourceLinkId = $lineitem['resourceLinkId'] ?? null;
+        $this->tag = $lineitem['tag'] ?? null;
+        $this->startDateTime = $lineitem['startDateTime'] ?? null;
+        $this->endDateTime = $lineitem['endDateTime'] ?? null;
+        $this->gradesReleased = $lineitem['gradesReleased'] ?? null;
+    }
+}

classes/kialo_config.php

@@ -19,6 +19,7 @@
 use moodle_url;
 use OAT\Library\Lti1p3Core\Platform\Platform;
 use OAT\Library\Lti1p3Core\Registration\Registration;
+use OAT\Library\Lti1p3Core\Registration\RegistrationRepositoryInterface;
 use OAT\Library\Lti1p3Core\Security\Key\KeyChainFactory;
 use OAT\Library\Lti1p3Core\Security\Key\KeyChainInterface;
 use OAT\Library\Lti1p3Core\Security\Key\KeyInterface;
@@ -133,10 +134,11 @@ public function get_client_id(): string {
      */
     public function get_platform(): Platform {
         return new Platform(
-            'kialo-moodle-plugin',                              // Identifier.
-            'Kialo Moodle Plugin',                              // Name.
-            (new moodle_url('/mod/kialo'))->out(),              // Audience.
-            (new moodle_url('/mod/kialo/lti_auth.php'))->out(), // OIDC authentication url.
+            'kialo-moodle-plugin',                               // Identifier.
+            'Kialo Moodle Plugin',                               // Name.
+            (new moodle_url('/mod/kialo'))->out(),               // Audience.
+            (new moodle_url('/mod/kialo/lti_auth.php'))->out(),  // OIDC authentication url.
+            (new moodle_url('/mod/kialo/lti_token.php'))->out(), // OAuth2 access token URL.
         );
     }
 
@@ -180,4 +182,16 @@ public function create_registration(?string $deploymentid = null): Registration
             $tooljwksurl,                   // JWKS URL used to download Kialo's keyset.
         );
     }
+
+    /**
+     * Returns a registration repository for the Kialo plugin.
+     *
+     * @param string|null $deploymentid The deployment id to use, or null, if it's not relevant.
+     * @return RegistrationRepositoryInterface
+     * @throws \dml_exception
+     */
+    public function get_registration_repository(?string $deploymentid = null): RegistrationRepositoryInterface {
+        $registration = $this->create_registration($deploymentid);
+        return new static_registration_repository($registration);
+    }
 }