[flag] Add flag editors table (#9478)

- Introduce a flag_editors table that tracks who has edited an
instrument
- Removes UserID from flag as it is replaced with the first entry of
flag_editors
- Removes User1 and User2 from conflicts_resolved as they are misleading
columns, and also not useful now that UserID is gone from flag

Author: skarya22

SQL/0000-00-00-schema.sql

@@ -299,7 +299,6 @@ CREATE TABLE `flag` (
   `Administration` enum('None','Partial','All') default NULL,
   `Validity` enum('Questionable','Invalid','Valid') default NULL,
   `Exclusion` enum('Fail','Pass') default NULL,
-  `UserID` varchar(255) default NULL,
   `Testdate` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
   `DataID` int(10) unsigned default NULL,
   PRIMARY KEY  (`CommentID`),
@@ -309,12 +308,29 @@ CREATE TABLE `flag` (
   KEY `flag_Data_entry` (`Data_entry`),
   KEY `flag_Validity` (`Validity`),
   KEY `flag_Administration` (`Administration`),
-  KEY `flag_UserID` (`UserID`),
   CONSTRAINT `FK_flag_1` FOREIGN KEY (`SessionID`) REFERENCES `session` (`ID`) ON DELETE CASCADE ON UPDATE CASCADE,
   CONSTRAINT `FK_flag_3` FOREIGN KEY (`DataID`) REFERENCES `instrument_data` (`ID`),
   CONSTRAINT `FK_ibfk_1` FOREIGN KEY (`TestID`) REFERENCES `test_names` (`ID`)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
 
+CREATE TABLE `flag_editors` (
+  `userID` int(10) unsigned NOT NULL default '0',
+  `CommentID` VARCHAR(255) NOT NULL default '',
+  `editDate` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
+  PRIMARY KEY  (`userID`,`CommentID`),
+  KEY `FK_flag_editors_2` (`CommentID`),
+  CONSTRAINT `FK_flag_editors_2`
+  FOREIGN KEY (`CommentID`)
+    REFERENCES `flag` (`CommentID`)
+    ON DELETE CASCADE
+    ON UPDATE CASCADE,
+  CONSTRAINT `FK_flag_editors_1`
+  FOREIGN KEY (`userID`)
+    REFERENCES `users` (`ID`)
+    ON DELETE CASCADE
+    ON UPDATE CASCADE
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
 CREATE TABLE `history` (
   `id` int(11) NOT NULL auto_increment,
   `tbl` varchar(255) NOT NULL default '',

SQL/New_patches/2024_11_18_Save_Flag_Editors.sql

@@ -0,0 +1,22 @@
+CREATE TABLE `flag_editors` (
+  `userID` int(10) unsigned NOT NULL default '0',
+  `CommentID` VARCHAR(255) NOT NULL default '',
+  `editDate` timestamp NOT NULL default CURRENT_TIMESTAMP on update CURRENT_TIMESTAMP,
+  PRIMARY KEY  (`userID`,`CommentID`),
+  KEY `FK_flag_editors_2` (`CommentID`),
+  CONSTRAINT `FK_flag_editors_2`
+  FOREIGN KEY (`CommentID`)
+    REFERENCES `flag` (`CommentID`)
+    ON DELETE CASCADE
+    ON UPDATE CASCADE,
+  CONSTRAINT `FK_flag_editors_1`
+  FOREIGN KEY (`userID`)
+    REFERENCES `users` (`ID`)
+    ON DELETE CASCADE
+    ON UPDATE CASCADE
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+INSERT INTO flag_editors (userID, CommentID)
+SELECT users.ID, CommentID from flag JOIN users ON flag.UserID = users.UserID;
+
+ALTER TABLE flag DROP COLUMN UserID;

modules/conflict_resolver/jsx/resolved_filterabledatatable.js

@@ -178,14 +178,6 @@ class ResolvedFilterableDataTable extends Component {
         name: 'CorrectAnswer',
         type: 'text',
       }},
-      {label: 'User 1', show: true, filter: {
-        name: 'User1',
-        type: 'text',
-      }},
-      {label: 'User 2', show: true, filter: {
-        name: 'User2',
-        type: 'text',
-      }},
       {label: 'Resolver', show: true, filter: {
         name: 'Resolver',
         type: 'text',

modules/conflict_resolver/php/endpoints/unresolved.class.inc

@@ -293,8 +293,6 @@ class Unresolved extends Endpoint implements ETagCalculator
             '
              REPLACE INTO conflicts_resolved (
                UserID,
-               User1,
-               User2,
                TestName,
                ExtraKeyColumn,
                ExtraKey1,
@@ -309,8 +307,6 @@ class Unresolved extends Endpoint implements ETagCalculator
              )
              SELECT
                :v_username,
-               f1.UserID,
-               f2.UserID,
                cu.TestName,
                cu.ExtraKeyColumn,
                cu.ExtraKey1,
@@ -331,8 +327,6 @@ class Unresolved extends Endpoint implements ETagCalculator
              UNION DISTINCT
              SELECT
                :v_username,
-               cr.User1,
-               cr.User2,
                cr.TestName,
                cr.ExtraKeyColumn,
                cr.ExtraKey1,

modules/conflict_resolver/php/models/resolveddto.class.inc

@@ -48,8 +48,6 @@ class ResolvedDTO implements DataInstance, SiteHaver
     protected $description;
     protected $oldValue;
     protected $correctanswer;
-    protected $user1;
-    protected $user2;
     protected $resolver;
     protected $resolutiontimestamp;
 
@@ -73,8 +71,6 @@ class ResolvedDTO implements DataInstance, SiteHaver
             'Description'         => "",
             'Incorrect Answer'    => $this->oldValue,
             'Correct Answer'      => $this->correctanswer,
-            'User 1'              => $this->user1,
-            'User 2'              => $this->user2,
             'Resolver'            => $this->resolver,
             'ResolutionTimestamp' => $this->resolutiontimestamp,
         ];

modules/conflict_resolver/php/provisioners/resolvedprovisioner.class.inc

@@ -69,8 +69,6 @@ class ResolvedProvisioner extends \LORIS\Data\Provisioners\DBObjectProvisioner
                     ELSE conflicts_resolved.OldValue2
                 END AS correctanswer,
               conflicts_resolved.ResolutionTimestamp as resolutiontimestamp,
-              conflicts_resolved.User1 as user1,
-              conflicts_resolved.User2 as user2,
               conflicts_resolved.UserID as resolver,
               psc.name as site,
               session.CenterID as centerid,

php/libraries/NDB_BVL_Battery.class.inc

@@ -249,10 +249,23 @@ class NDB_BVL_Battery
                 'SessionID' => $sessionData['SessionID'],
                 'TestID'    => $testId,
                 'CommentID' => $commentID,
-                'UserID'    => $sessionData['UserID'],
             ]
         );
 
+        $userID = $DB->pselectOne(
+            "SELECT ID FROM users WHERE UserID=:uid",
+            ['uid' => $sessionData['UserID'] ?? ""]
+        );
+        if (($userID ?? "") != "") {
+            $DB->insertOnDuplicateUpdate(
+                "flag_editors",
+                [
+                    'userID'    => $userID,
+                    'CommentID' => $commentID,
+                ],
+            );
+        }
+
         // insert the dde into the flag table
         if ($DDEEnabled) {
             $DB->insert(
@@ -261,9 +274,17 @@ class NDB_BVL_Battery
                     'SessionID' => $sessionData['SessionID'],
                     'TestID'    => $testId,
                     'CommentID' => $ddeCommentID,
-                    'UserID'    => $sessionData['UserID'],
                 ]
             );
+            if (($userID ?? "") != "") {
+                $DB->insertOnDuplicateUpdate(
+                    "flag_editors",
+                    [
+                        'userID'    => $userID,
+                        'CommentID' => $ddeCommentID,
+                    ],
+                );
+            }
         }
 
         return $commentID ?? '';

php/libraries/NDB_BVL_Instrument.class.inc

@@ -829,6 +829,19 @@ abstract class NDB_BVL_Instrument extends NDB_Page
         // don't overwrite data from other pages.
         $newData = array_merge($this->getInstanceData() ?? [], $values);
 
+        $userID = $db->pselectOne(
+            "SELECT ID FROM users WHERE UserID=:uid",
+            ['uid' => $newData['UserID'] ?? ""]
+        );
+        if (($userID ?? "") != "") {
+            $db->insertOnDuplicateUpdate(
+                "flag_editors",
+                [
+                    'userID'    => $userID,
+                    'CommentID' => $this->getCommentID(),
+                ],
+            );
+        }
         // If there's already a row with the same data, re-use the DataID.
         // Otherwise, insert it, then update the DataID on flag.
         $jsonencoded = json_encode($newData);