From e313923ad4f374d583a18d1912793aaa7b664a00 Mon Sep 17 00:00:00 2001
From: Epagris <wabe@t-email.hu>
Date: Thu, 26 Sep 2024 11:34:02 +0200
Subject: [PATCH] - checking maintenance in each file added - a few CLI
 commands added - ticking and concluding expired tests added

---
 check_maintenance.php   |  8 +++++++
 class/GameMgr.php       |  2 ++
 class/GroupMgr.php      |  2 ++
 class/TestMgr.php       | 46 ++++++++++++++++++++++++++++++++++++++++-
 class/UserMgr.php       |  2 ++
 cli_actions.php         | 39 ++++++++++++++++++++++++++++++++++
 default_frame.php       |  2 ++
 game_manager_frame.php  |  1 +
 globals.php             |  6 ------
 group_manager_frame.php |  2 ++
 interface.php           | 10 ++-------
 login.php               |  2 ++
 main.php                |  2 ++
 result_analyzer.php     |  1 +
 testground.php          |  1 +
 user_manager_frame.php  |  1 +
 16 files changed, 112 insertions(+), 15 deletions(-)
 create mode 100644 check_maintenance.php
 create mode 100644 cli_actions.php

diff --git a/check_maintenance.php b/check_maintenance.php
new file mode 100644
index 0000000..e8a27b4
--- /dev/null
+++ b/check_maintenance.php
@@ -0,0 +1,8 @@
+<?php
+require_once "globals.php";
+
+// check MAINTENANCE file
+if (file_exists(MAINTENANCE_FLAG_FILE)) {
+    header("Location: maintenance.html");
+    exit(0);
+}
\ No newline at end of file
diff --git a/class/GameMgr.php b/class/GameMgr.php
index de48a56..ec672c8 100644
--- a/class/GameMgr.php
+++ b/class/GameMgr.php
@@ -1,5 +1,7 @@
 <?php
 
+require_once "vendor/autoload.php";
+
 require_once "AutoStoring.php";
 
 class Game extends AutoStoring
diff --git a/class/GroupMgr.php b/class/GroupMgr.php
index 2b46fa8..c3cc548 100644
--- a/class/GroupMgr.php
+++ b/class/GroupMgr.php
@@ -1,5 +1,7 @@
 <?php
 
+require_once "vendor/autoload.php";
+
 require_once "AutoStoring.php";
 
 require_once "privilege_levels.php";
diff --git a/class/TestMgr.php b/class/TestMgr.php
index e6fbbe7..04c61af 100644
--- a/class/TestMgr.php
+++ b/class/TestMgr.php
@@ -1,9 +1,13 @@
 <?php
 
+require_once "vendor/autoload.php";
+
 require_once "AutoStoring.php";
 
 require_once "ExpressionBuilder.php";
 
+require_once "globals.php";
+
 const TEST_ONGOING = "ongoing";
 const TEST_CONCLUDED = "concluded";
 
@@ -11,11 +15,22 @@ class TestSummary
 {
     public int $challengeN; // Number of challenges
     public int $correctAnswerN; // Number of correct answers
+    private float $percentage; // Ratio of correct answers
+
+    // Calculate percentage.
+    private function calculatePercentage() : void {
+        if ($this->challengeN > 0) {
+            $this->percentage = $this->correctAnswerN / (double)$this->challengeN * 100.0;
+        } else { // avoid division by zero
+            $this->percentage = 0.0;
+        }
+    }
 
     function __construct(int $challengeN, int $correctAnswerN)
     {
         $this->challengeN = $challengeN;
         $this->correctAnswerN = $correctAnswerN;
+        $this->calculatePercentage();
     }
 
     // Get challenge count.
@@ -33,6 +48,7 @@ class TestSummary
     function setCorrectAnswerN(int $correctAnswerN): void
     {
         $this->correctAnswerN = $correctAnswerN;
+        $this->calculatePercentage();
     }
 
     // Get ratio of correct results.
@@ -50,7 +66,7 @@ class TestSummary
     // Convert to array.
     function toArray(): array
     {
-        return ["challenge_n" => $this->challengeN, "correct_answer_n" => $this->correctAnswerN];
+        return ["challenge_n" => $this->challengeN, "correct_answer_n" => $this->correctAnswerN, "percentage" => $this->percentage];
     }
 }
 
@@ -158,6 +174,7 @@ class Test extends AutoStoring
         // auto-conclude time-constrained test if expired
         if ($this->timeLimited && $this->isOngoing() && ($this->endLimitTime <= time())) {
             $this->concludeTest();
+            $this->endTime = $this->endLimitTime; // date back end time to the limiting value
         }
     }
 
@@ -485,4 +502,31 @@ class TestMgr
         // match challenges
         return $aggregated;
     }
+
+    // Upgrade test. Just load tests and save them.
+    function upgradeTests(array $ids = []) : void {
+        $a = [];
+        if ($ids === []) {
+            $a = $this->db->findAll();
+        } else {
+            $a = $this->db->findBy(["_id", "IN", $ids]);
+        }
+
+        foreach ($a as $t) {
+            $test = new Test($this, $t);
+            $test->storeMods();
+        }
+    }
+
+    // Extract timed test IDs. Scan the database for tests with time limit ON.
+    function extractExpiredTimedTestIds(bool $ongoingOnly = true) : array {
+        $query = [["time_limited", "=", true], "AND", ["end_limit_time", "<", time()]];
+        if ($ongoingOnly) {
+            $query = [ ...$query, "AND", ["state", "=", TEST_ONGOING]];
+        }
+
+        $qb = $this->db->createQueryBuilder();
+        $a = $qb->where($query)->select(["_id"])->orderBy(["_id" => "ASC"])->getQuery()->fetch();
+        return array_map(fn($a) => $a["_id"], $a);
+    }
 }
\ No newline at end of file
diff --git a/class/UserMgr.php b/class/UserMgr.php
index 5decdf2..725dc42 100644
--- a/class/UserMgr.php
+++ b/class/UserMgr.php
@@ -1,5 +1,7 @@
 <?php
 
+require_once "vendor/autoload.php";
+
 require_once "common_func.php";
 
 require_once "AutoStoring.php";
diff --git a/cli_actions.php b/cli_actions.php
new file mode 100644
index 0000000..744c95e
--- /dev/null
+++ b/cli_actions.php
@@ -0,0 +1,39 @@
+<?php
+
+require_once "class/TestMgr.php";
+
+$longopts = [
+    "action:", // execute some CLI action
+    "tick" // tick timed objects (e.g. timed tests)
+];
+
+$options = getopt("", $longopts);
+
+// CLI actions
+if (isset($options["action"])) {
+    $action = $options["action"];
+
+    switch ($action) {
+        case "upgrade_tests":
+            {
+                printf("Upgrading tests...");
+                $testMgr = new TestMgr();
+                $testMgr->upgradeTests();
+                printf("OK!\n");
+            }
+            break;
+        case "get_timed_tests":
+            {
+                $testMgr = new TestMgr();
+                printf("Expired timed tests: %s\n", join(", ", $testMgr->extractExpiredTimedTestIds()));
+            }
+            break;
+    }
+}
+
+// Tick tests
+if (isset($options["tick"])) {
+    $testMgr = new TestMgr();
+    $timedTestIDs = $testMgr->extractExpiredTimedTestIds();
+    $testMgr->upgradeTests($timedTestIDs);
+}
diff --git a/default_frame.php b/default_frame.php
index 260c40a..3f9647b 100644
--- a/default_frame.php
+++ b/default_frame.php
@@ -1,5 +1,7 @@
 <?php
 
+require_once "check_maintenance.php";
+
 //require_once "frames_common.php";
 
 require_once "globals.php";
diff --git a/game_manager_frame.php b/game_manager_frame.php
index 460cffd..a74a687 100644
--- a/game_manager_frame.php
+++ b/game_manager_frame.php
@@ -1,4 +1,5 @@
 <?php
+require_once "check_maintenance.php";
 
 require_once "globals.php";
 require_once "autologin.php";
diff --git a/globals.php b/globals.php
index 9dc150e..1604d41 100644
--- a/globals.php
+++ b/globals.php
@@ -35,9 +35,3 @@ function init_datadir() {
     }
 }
 
-// check MAINTENANCE file
-if (file_exists(MAINTENANCE_FLAG_FILE)) {
-    header("Location: maintenance.html");
-    exit(0);
-}
-
diff --git a/group_manager_frame.php b/group_manager_frame.php
index b90c5f4..763fb88 100644
--- a/group_manager_frame.php
+++ b/group_manager_frame.php
@@ -1,5 +1,7 @@
 <?php
 
+require_once "check_maintenance.php";
+
 require_once "globals.php";
 require_once "autologin.php";
 
diff --git a/interface.php b/interface.php
index b5daeab..5572be7 100644
--- a/interface.php
+++ b/interface.php
@@ -1,5 +1,7 @@
 <?php
 
+require_once "check_maintenance.php";
+
 //ini_set('display_startup_errors', '1');
 
 require_once "globals.php";
@@ -16,14 +18,6 @@ if (!isset($_REQUEST["action"])) {
 
 require_once "common_func.php";
 
-// load databases only if something meaningful have arrived
-//require_once "usermgr.php";
-//require_once "groupmgr.php";
-//require_once "gamemgr.php";
-//require_once "testmgr.php";
-//
-//require_once "controller.php";
-
 require_once "class/ReqHandler.php";
 
 require_once "class/UserMgr.php";
diff --git a/login.php b/login.php
index 1a7fe1b..8a0fee5 100644
--- a/login.php
+++ b/login.php
@@ -1,4 +1,6 @@
 <?php
+require_once "check_maintenance.php";
+
 require_once "globals.php";
 require_once "autologin.php";
 
diff --git a/main.php b/main.php
index 224cc9d..c99888e 100644
--- a/main.php
+++ b/main.php
@@ -1,6 +1,8 @@
 <?php
 require_once "globals.php";
 
+require_once "check_maintenance.php";
+
 require_once "privilege_levels.php";
 
 require_once "autologin.php";
diff --git a/result_analyzer.php b/result_analyzer.php
index c1e7e3a..2e5fed2 100644
--- a/result_analyzer.php
+++ b/result_analyzer.php
@@ -1,4 +1,5 @@
 <?php
+require_once "check_maintenance.php";
 
 require_once "globals.php";
 require_once "autologin.php";
diff --git a/testground.php b/testground.php
index ba052c3..e3540d3 100644
--- a/testground.php
+++ b/testground.php
@@ -1,4 +1,5 @@
 <?php
+require_once "check_maintenance.php";
 
 require_once "globals.php";
 require_once "autologin.php";
diff --git a/user_manager_frame.php b/user_manager_frame.php
index eb3042b..eb88f8e 100644
--- a/user_manager_frame.php
+++ b/user_manager_frame.php
@@ -1,4 +1,5 @@
 <?php
+require_once "check_maintenance.php";
 
 require_once "globals.php";
 require_once "autologin.php";