From 00f5ab4e4a41dd5f07ea574f976468eb764e7d2f Mon Sep 17 00:00:00 2001
From: Michael Vasseur <michael.vasseur@vu.nl>
Date: Wed, 13 Nov 2024 21:52:44 +0100
Subject: [PATCH] Remove FIXME as PHP implemented the return type

The documentation on this is not very clear. You can encounter the `False` by using unset($argv) which would be a misconfiguration so the error message is now also improved.

A better explanation can be found here: https://bugs.php.net/bug.php?id=81352

Which has those comments;
```
 [2021-08-12 15:19 UTC] cmb@php.net
Prior to PHP 8.0.0, FALSE was returned if the function was called
with unexpected parameters or parameter types.  Most other
functions returned NULL in that case.  Anyhow, there is no need to
document that, since this is actually undefined behavior[1].

For all relevant PHP versions, FALSE will also be returned, if
neither $_SERVER nor $argv exists or are not arrays.

[1] <https://www.php.net/manual/en/functions.internal.php>

 [2022-11-26 06:42 UTC] schamberumarcelo at gmail dot com
getopt() will return an empty array if there is no error in splitting strings to args variable. GetOptions() will return a true value if the command line could be processed successfully. Otherwise, it will write error messages using die() and warn(). (https://www.imyccpay.com)github.com
```
 given that we run PHP>8.0 and the explanation that parsing will stop for the first non-option I think we'll never encounter the false in practice. To be save we now check the shortoptions string for the right format.

To be sure an internal function is now added which does some extra parsing to find unknown arguments, alternative would be to use: (https://www.php.net/manual/en/function.getopt.php#83414).
---
 judge/judgedaemon.main.php | 53 +++++++++++++++++++++++++++++++++-----
 1 file changed, 47 insertions(+), 6 deletions(-)

diff --git a/judge/judgedaemon.main.php b/judge/judgedaemon.main.php
index ae63c1dfd4..2df8675b84 100644
--- a/judge/judgedaemon.main.php
+++ b/judge/judgedaemon.main.php
@@ -16,6 +16,52 @@
 $endpoints = [];
 $domjudge_config = [];
 
+function dj_getopt(string $short_options, array $long_options = []): array
+{
+    global $argv;
+    define('GETOPT_REGEX', "/^([a-zA-Z0-9]:{0,2})*$/");
+    if (preg_match(GETOPT_REGEX, $short_options) !== 1) {
+        echo "Error: short options format specified is invalid.\n";
+        usage();
+    }
+    $options = getopt($short_options, $long_options);
+    if ($options===false || !is_array($argv)) {
+        echo "Error: parsing options failed.\nPlease check: `register_argc_arg` in php.ini.\n";
+        usage();
+    }
+    $unknown_option = false;
+    foreach (array_slice($argv, 1) as $arg) {
+        if ($arg === '--') {
+            // By convention we can stop processing arguments.
+            break;
+        }
+        if (str_starts_with($arg, '--')) {
+            foreach($long_options as $long_option) {
+                $stripped_arg = substr($arg, 2);
+                if (str_starts_with($long_option, $stripped_arg) && $stripped_arg !== $long_option) {
+                    echo "Error: Shorten long options is not supported: $arg\n";
+                    $unknown_option = true;
+                } elseif (!array_key_exists($stripped_arg, $options)) {
+                    echo "Error: Unknown option: $arg\n";
+                    $unknown_option = true;
+                }
+            }
+        } elseif (str_starts_with($arg, '-')) {
+            foreach (str_split(ltrim($arg, '-')) as $c) {
+                if (!array_key_exists($c, $options)) {
+                    echo "Error: Unknown option: $arg\n";
+                    $unknown_option = true;
+                }
+            }
+        }
+    }
+    if ($unknown_option) {
+        echo "\n";
+        usage();
+    }
+    return $options;
+}
+
 function judging_directory(string $workdirpath, array $judgeTask) : string
 {
     if (filter_var($judgeTask['submitid'], FILTER_VALIDATE_INT) === false ||
@@ -487,12 +533,7 @@ function fetch_executable_internal(
     return [$execrunpath, null, null];
 }
 
-$options = getopt("dv:n:hVe:j:t:", ["diskspace-error"]);
-// FIXME: getopt doesn't return FALSE on parse failure as documented!
-if ($options===false) {
-    echo "Error: parsing options failed.\n";
-    usage();
-}
+$options = dj_getopt("dv:n:hVe:j:t:", ["diskspace-error"]);
 if (isset($options['v'])) {
     $options['verbose'] = $options['v'];
 }