setup arrayGet

Author: simonLeary42

resources/autoload.php

@@ -24,7 +24,9 @@
 require_once __DIR__ . "/lib/UnityWebhook.php";
 require_once __DIR__ . "/lib/UnityRedis.php";
 require_once __DIR__ . "/lib/UnityGithub.php";
+require_once __DIR__ . "/lib/exceptions/NoDieException.php";
 require_once __DIR__ . "/lib/exceptions/SSOException.php";
+require_once __DIR__ . "/lib/exceptions/ArrayKeyException.php";
 
 require_once __DIR__ . "/config.php";
 require __DIR__ . "/init.php";

resources/lib/UnitySite.php

@@ -4,6 +4,7 @@
 
 use phpseclib3\Crypt\PublicKeyLoader;
 use UnityWebPortal\lib\exceptions\NoDieException;
+use UnityWebPortal\lib\exceptions\ArrayKeyException;
 
 class UnitySite
 {
@@ -105,20 +106,47 @@ public static function shutdown()
         );
     }
 
-    public static function arrayGetOrBadRequest(array $array, ...$keys)
+    public static function arrayGet($array, ...$keys)
     {
         $cursor = $array;
         $keysTraversed = [];
         foreach ($keys as $key) {
             array_push($keysTraversed, $key);
             if (!isset($cursor[$key])) {
-                self::badRequest("array key not found: " . json_encode($keysTraversed));
+                throw new ArrayKeyException(
+                    "key not found: \$array" .
+                    // [1, 2, "foo"] => [1][2]["foo"]
+                    implode("", array_map(fn($x) => json_encode([$x]), $keysTraversed))
+                );
             }
             $cursor = $cursor[$key];
         }
         return $cursor;
     }
 
+    public static function getPostData(...$keys)
+    {
+        try {
+            return self::arrayGet($_POST, ...$keys);
+        } catch (ArrayKeyException $e) {
+            self::badRequest(strval($e));
+        }
+    }
+
+    public static function getUploadedFileContents($filename, $do_delete_tmpfile_after_read = true)
+    {
+        try {
+            $tmpfile_path = self::arrayGet($_FILES, $filename, "tmp_name");
+        } catch (ArrayKeyException $e) {
+            self::badRequest(strval($e));
+        }
+        $contents = file_get_contents($tmpfile_path);
+        if ($do_delete_tmpfile_after_read) {
+            unlink($tmpfile_path);
+        }
+        return $contents;
+    }
+
     // in firefox, the user can disable alert/confirm/prompt after the 2nd or 3rd popup
     // after I disable alerts, if I quit and reopen my browser, the alerts come back
     public static function alert(string $message)

resources/lib/exceptions/ArrayKeyException.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace UnityWebPortal\lib\exceptions;
+
+class ArrayKeyException extends \Exception
+{
+}

test/functional/SSHKeyAddTest.php

@@ -31,8 +31,8 @@ private function addSshKeysImport(array $keys): void {
                     __DIR__ . "/../../webroot/panel/account.php",
                     ["form_type" => "addKey", "add_type" => "import"]
                 );
+                $this->assertFalse(file_exists($tmp_path));
             } finally {
-                unlink($tmp_path);
                 unset($_FILES["keyfile"]);
             }
         }

test/phpunit-bootstrap.php

@@ -17,6 +17,7 @@
 require_once __DIR__ . "/../resources/lib/UnityGithub.php";
 require_once __DIR__ . "/../resources/lib/exceptions/NoDieException.php";
 require_once __DIR__ . "/../resources/lib/exceptions/SSOException.php";
+require_once __DIR__ . "/../resources/lib/exceptions/ArrayKeyException.php";
 
 $_SERVER["HTTP_HOST"] = "phpunit"; // used for config override
 require_once __DIR__ .  "/../resources/config.php";

test/unit/UnitySiteTest.php

@@ -4,7 +4,7 @@
 
 use PHPUnit\Framework\TestCase;
 use PHPUnit\Framework\Attributes\DataProvider;
-use UnityWebPortal\lib\exceptions\NoDieException;
+use UnityWebPortal\lib\exceptions\ArrayKeyException;
 // use PHPUnit\Framework\Attributes\BackupGlobals;
 // use PHPUnit\Framework\Attributes\RunTestsInSeparateProcess;
 
@@ -81,7 +81,7 @@ public function testTestValidSSHKey(bool $expected, string $key)
         $this->assertEquals($expected, UnitySite::testValidSSHKey($key));
     }
 
-    public function testArrayGetOrBadRequestReturnsValueWhenKeyExists()
+    public function testArrayGetReturnsValueWhenKeyExists()
     {
         $array = [
             "a" => [
@@ -90,50 +90,50 @@ public function testArrayGetOrBadRequestReturnsValueWhenKeyExists()
                 ]
             ]
         ];
-        $result = UnitySite::arrayGetOrBadRequest($array, "a", "b", "c");
+        $result = UnitySite::arrayGet($array, "a", "b", "c");
         $this->assertSame(123, $result);
     }
 
-    public function testArrayGetOrBadRequestReturnsArrayWhenTraversingPartially()
+    public function testArrayGetReturnsArrayWhenTraversingPartially()
     {
         $array = [
             "foo" => [
                 "bar" => "baz"
             ]
         ];
-        $result = UnitySite::arrayGetOrBadRequest($array, "foo");
+        $result = UnitySite::arrayGet($array, "foo");
         $this->assertSame(["bar" => "baz"], $result);
     }
 
-    public function testArrayGetOrBadRequestThrowsOnMissingKeyFirstLevel()
+    public function testArrayGetThrowsOnMissingKeyFirstLevel()
     {
         $array = ["x" => 1];
-        $this->expectException(NoDieException::class);
-        $this->expectExceptionMessage('["y"]');
-        UnitySite::arrayGetOrBadRequest($array, "y");
+        $this->expectException(ArrayKeyException::class);
+        $this->expectExceptionMessage('$array["y"]');
+        UnitySite::arrayGet($array, "y");
     }
 
-    public function testArrayGetOrBadRequestThrowsOnMissingKeyNested()
+    public function testArrayGetThrowsOnMissingKeyNested()
     {
         $array = ["a" => []];
-        $this->expectException(NoDieException::class);
+        $this->expectException(ArrayKeyException::class);
         // Should include both levels
-        $this->expectExceptionMessage('["a","b"]');
-        UnitySite::arrayGetOrBadRequest($array, "a", "b");
+        $this->expectExceptionMessage('$array["a"]["b"]');
+        UnitySite::arrayGet($array, "a", "b");
     }
 
-    public function testArrayGetOrBadRequestThrowsWhenValueIsNullButKeyNotSet()
+    public function testArrayGetThrowsWhenValueIsNullButKeyNotSet()
     {
         $array = ["a" => null];
-        $this->expectException(NoDieException::class);
-        $this->expectExceptionMessage('["a"]');
-        UnitySite::arrayGetOrBadRequest($array, "a");
+        $this->expectException(ArrayKeyException::class);
+        $this->expectExceptionMessage('$array["a"]');
+        UnitySite::arrayGet($array, "a");
     }
 
-    public function testArrayGetOrBadRequestReturnsValueWhenValueIsFalsyButSet()
+    public function testArrayGetReturnsValueWhenValueIsFalsyButSet()
     {
         $array = ["a" => 0];
-        $result = UnitySite::arrayGetOrBadRequest($array, "a");
+        $result = UnitySite::arrayGet($array, "a");
         $this->assertSame(0, $result);
     }
 

webroot/panel/account.php

@@ -7,23 +7,22 @@
 $hasGroups = count($USER->getPIGroupGIDs()) > 0;
 
 if ($_SERVER['REQUEST_METHOD'] == "POST") {
-    switch (UnitySite::arrayGetOrBadRequest($_POST, "form_type")) {
+    switch (UnitySite::getPostData("form_type")) {
         case "addKey":
             $keys = array();
-            switch (UnitySite::arrayGetOrBadRequest($_POST, "add_type")) {
+            switch (UnitySite::getPostData("add_type")) {
                 case "paste":
-                    array_push($keys, UnitySite::arrayGetOrBadRequest($_POST, "key"));
+                    array_push($keys, UnitySite::getPostData("key"));
                     break;
                 case "import":
-                    $keyPath = UnitySite::arrayGetOrBadRequest($_FILES, "keyfile", "tmp_name");
-                    $key = file_get_contents($keyPath);
+                    $key = UnitySite::getUploadedFileContents("keyfile");
                     array_push($keys, $key);
                     break;
                 case "generate":
-                    array_push($keys, UnitySite::arrayGetOrBadRequest($_POST, "gen_key"));
+                    array_push($keys, UnitySite::getPostData("gen_key"));
                     break;
                 case "github":
-                    $githubUsername = UnitySite::arrayGetOrBadRequest($_POST, "gh_user");
+                    $githubUsername = UnitySite::getPostData("gh_user");
                     $githubKeys = $GITHUB->getSshPublicKeys($githubUsername);
                     $keys = array_merge($keys, $githubKeys);
                     break;