Merge pull request #53 from udzuki/feat-25-caliper-lti-alternatename

feat: LTI連携のログで機関のスコープをalternatenameから取得（Caliperステートメント変換）

Author: savvan0h

caliper/Dockerfile

@@ -1,6 +1,6 @@
 FROM composer:1.9 AS builder
 
-LABEL version="2.3.0"
+LABEL version="2.4.0"
 
 WORKDIR /stage
 COPY . .

caliper/README.md

@@ -4,6 +4,7 @@
 #### Common definitions
 - agent.id = <MOODLE_URL>/user/profile.php?id=<mdl_logstore_standard_log.userid>
 - agent.name = <mdl_user.username> (Converted to SHA256 hash)
+  ※ Set to <mdl_user.alternatename> instead if `DB_EPPN` is enabled and <mdl_user.auth> is 'lti'
 - agent.description = <mdl_user.description>
 - agent.type = Person
 - eventTime = <mdl_logstore_standard_log.timecreated>(Converted)
@@ -372,6 +373,7 @@
 #### Common definitions
 - agent.id = <MOODLE_URL>/user/profile.php?id=<mdl_mdl_scorm_scoes_track.userid>
 - agent.name = <mdl_user.username> (Converted to SHA256 hash)
+  ※ Set to <mdl_user.alternatename> instead if `DB_EPPN` is enabled and <mdl_user.auth> is 'lti'
 - agent.description = <mdl_user.description>
 - agent.type = Person
 - eventTime = <mdl_scorm_scoes_track.timemodified>(Converted)

caliper/app/Caliper/Traits/Util.php

@@ -31,18 +31,22 @@ protected function getUser(string $id): ?User
         }
     }
 
-    public function getAnonymizedUsername(string $username): string
+    public function getUsername(User $actor): ?string
     {
-        $hash = hash('sha256', $username);
-        $eppnValue = env('DB_EPPN');
-        if (is_bool($eppnValue) && $eppnValue) {
-            $enableEppn = true;
-        } elseif (is_string($eppnValue) && $eppnValue == 'true') {
-            $enableEppn = true;
+        if ($this->isEnabledEppn()) {
+            return ($actor->auth === 'lti')
+                ? $actor->alternatename
+                : $actor->username;
         } else {
-            $enableEppn = false;
+            return $actor->username;
         }
-        if ($enableEppn) {
+    }
+
+    public function getAnonymizedUsername(User $actor): string
+    {
+        if ($this->isEnabledEppn()) {
+            $username = $this->getUsername($actor);
+            $hash = $username ? hash('sha256', $username) : '';
             $eppn = Eppn::where('username', $username)->first();
             if (is_null($eppn)) {
                 if (strpos($username, '@')) {
@@ -62,7 +66,7 @@ public function getAnonymizedUsername(string $username): string
                 return $eppn->hash;
             }
         } else {
-            return $hash;
+            return hash('sha256', $actor->username);
         }
     }
 
@@ -122,4 +126,16 @@ public function getCourseId(string $id): string
     {
         return env('APP_URL') . '/course/view.php?id=' . $id;
     }
+
+    protected function isEnabledEppn(): bool
+    {
+        $eppnValue = env('DB_EPPN');
+        if (is_bool($eppnValue) && $eppnValue) {
+            return true;
+        } elseif (is_string($eppnValue) && $eppnValue == 'true') {
+            return true;
+        } else {
+            return false;
+        }
+    }
 }

caliper/app/Models/Moodle/User.php

@@ -152,8 +152,10 @@ public function scopeColumn($query)
     {
         return $query->select([
             'id',
+            'auth',
             'username',
-            'description'
+            'description',
+            'alternatename'
         ]);
     }
 }

caliper/app/Profiles/AssessableSubmitted.php

@@ -29,14 +29,14 @@ public function __construct(AppAssessableSubmitted $as)
         $objectId = $as->getObjectId();
         $partOfId = $as->getCourseId($partOf->id);
 
-        $this->originalUsername = $actor->username;
+        $this->originalUsername = $as->getUsername($actor);
 
         $this
             ->setAction(new Action(Action::SUBMITTED))
             ->setEventTime($as->getEventTime())
             ->setActor(
                 (new Person((string) $actorId))
-                    ->setName($as->getAnonymizedUsername($actor->username))
+                    ->setName($as->getAnonymizedUsername($actor))
                     ->setDescription($actor->description ?? '')
             )
             ->setObject(

caliper/app/Profiles/AttemptStarted.php

@@ -32,13 +32,13 @@ public function __construct(AppAttemptStarted $as)
         $partOfId = $as->getCourseId($partOf->id);
         $generatedId = $as->getGeneratedId();
 
-        $this->originalUsername = $actor->username;
+        $this->originalUsername = $as->getUsername($actor);
 
         $this
             ->setAction(new Action(Action::STARTED))
             ->setActor(
                 (new Person((string) $actorId))
-                    ->setName($as->getAnonymizedUsername($actor->username))
+                    ->setName($as->getAnonymizedUsername($actor))
                     ->setDescription($actor->description ?? '')
             )
             ->setObject(

caliper/app/Profiles/AttemptSubmitted.php

@@ -32,13 +32,13 @@ public function __construct(AppAttemptSubmitted $as)
         $partOfId = $as->getCourseId($partOf->id);
         $generatedId = $as->getGeneratedId();
 
-        $this->originalUsername = $actor->username;
+        $this->originalUsername = $as->getUsername($actor);
 
         $this
             ->setAction(new Action(Action::SUBMITTED))
             ->setActor(
                 (new Person((string) $actorId))
-                    ->setName($as->getAnonymizedUsername($actor->username))
+                    ->setName($as->getAnonymizedUsername($actor))
                     ->setDescription($actor->description ?? '')
             )
             ->setObject(

caliper/app/Profiles/CmiCoreTotalTime.php

@@ -29,13 +29,13 @@ public function __construct(AppCmiCoreTotalTime $cctt)
         $objectId = $cctt->getObjectId();
         $generatedId = $cctt->getGeneratedId();
 
-        $this->originalUsername = $actor->username;
+        $this->originalUsername = $cctt->getUsername($actor);
 
         $this
             ->setAction(new Action(Action::SUBMITTED))
             ->setActor(
                 (new Person((string) $actorId))
-                    ->setName($cctt->getAnonymizedUsername($actor->username))
+                    ->setName($cctt->getAnonymizedUsername($actor))
                     ->setDescription($actor->description ?? '')
             )
             ->setObject(

caliper/app/Profiles/CourseModuleViewed.php

@@ -30,13 +30,13 @@ public function __construct(AppCourseModuleViewed $cmv)
         $objectId = $cmv->getObjectId();
         $partOfId = $cmv->getCourseId($partOf->id);
 
-        $this->originalUsername = $actor->username;
+        $this->originalUsername = $cmv->getUsername($actor);
 
         $this
             ->setAction(new Action(Action::NAVIGATED_TO))
             ->setActor(
                 (new Person((string) $actorId))
-                    ->setName($cmv->getAnonymizedUsername($actor->username))
+                    ->setName($cmv->getAnonymizedUsername($actor))
                     ->setDescription($actor->description ?? '')
             )
             ->setObject(

caliper/app/Profiles/CourseViewed.php

@@ -26,13 +26,13 @@ public function __construct(AppCourseViewed $cv)
         $actorId = $cv->getUserId($actor->id);
         $objectId = $cv->getCourseId($object->id);
 
-        $this->originalUsername = $actor->username;
+        $this->originalUsername = $cv->getUsername($actor);
 
         $this
             ->setAction(new Action(Action::VIEWED))
             ->setActor(
                 (new Person((string) $actorId))
-                    ->setName($cv->getAnonymizedUsername($actor->username))
+                    ->setName($cv->getAnonymizedUsername($actor))
                     ->setDescription($actor->description ?? '')
             )
             ->setObject(