PCNTL support, type safety, error catching

Author: valzargaming

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [v2.0.0]
+
+### Added
+- Graceful shutdown support on non-Windows systems with `pcntl` extension.
+
+### Changed
+- Refactored `Server` class to improve error handling.
+- Updated `README.md` to include information about new features and usage of bash scripts.
+
+### Fixed
+- Fixed issues with handling client requests and responses in `Server` class.

README.md

@@ -11,6 +11,8 @@ Verifier-Server is a web server designed to handle BYOND user verification. It s
 - Handles GET and POST requests for user verification.
 - Supports both filesystem and SQL (SQLite/MySQL) storage.
 - Configurable via `.env` file.
+- Verbose mode for detailed request and response logging.
+- Graceful shutdown support on non-Windows systems with `pcntl` extension.
 
 ## Installation
 
@@ -44,7 +46,7 @@ Verifier-Server is a web server designed to handle BYOND user verification. It s
     #DB_OPTIONS=
 
     # MySQL configuration
-    DB_DSN=mysql:host=127.0.0.1;port=3307;dbname=verify_list
+    DB_DSN=mysql:host=127.0.0.1;port=3306;dbname=verify_list
     DB_PORT=3306
     DB_USERNAME=your_username
     DB_PASSWORD=your_password

composer.json

@@ -14,6 +14,9 @@
     "require-dev": {
         "phpunit/phpunit": "^9.5"
     },
+    "suggest": {
+        "ext-pcntl": "Enables process control support for better server management on non-Windows systems"
+    },
     "autoload": {
         "psr-4": {
             "VerifierServer\\": "src/"

example.env

@@ -10,7 +10,7 @@ STORAGE_TYPE=filesystem
 #DB_OPTIONS=
 
 # MySQL configuration
-DB_DSN=mysql:host=127.0.0.1;port=3307;dbname=verify_list
+DB_DSN=mysql:host=127.0.0.1;port=3306;dbname=verify_list
 DB_PORT=3306
 DB_USERNAME=your_username
 DB_PASSWORD=your_password

run.php

@@ -4,12 +4,17 @@
 use VerifierServer\PersistentState;
 use VerifierServer\Server;
 
-$verifyFile = PersistentState::loadVerifyFile();
 $envConfig = PersistentState::loadEnvConfig();
-$hostAddr = $envConfig['HOST_ADDR'] . ':' . $envConfig['HOST_PORT'];
-$civToken = $envConfig['TOKEN'];
-$storageType = $envConfig['STORAGE_TYPE'] ?? 'sql';
-$state = new PersistentState($verifyFile, $civToken, $storageType);
 
-$server = new Server($state, $hostAddr);
+$server = new Server(
+    new PersistentState(
+        $envConfig['TOKEN'],
+        PersistentState::loadVerifyFile(),
+        $envConfig['STORAGE_TYPE'] ?? 'filesystem'
+    ),
+    $envConfig['HOST_ADDR'] . ':' . $envConfig['HOST_PORT']
+);
+
+$server->init();
+$server->setVerbose(true);
 $server->start();

src/Endpoints/VerifiedEndpoint.php

@@ -4,13 +4,18 @@
 use VerifierServer\PersistentState;
 
 class VerifiedEndpoint {
-    private PersistentState $state;
+    public function __construct(private PersistentState $state)
+    {}
 
-    public function __construct(PersistentState $state) {
-        $this->state = $state;
-    }
-
-    public function handleRequest($method, $request, &$response) {
+    /**
+     * Handles the incoming HTTP request and generates the appropriate response.
+     *
+     * @param string $method The HTTP method of the request (e.g., 'GET', 'POST').
+     * @param string $request The request payload, typically used for 'POST' requests.
+     * @param string &$response The variable to store the generated response.
+     */
+    public function handleRequest(string $method, string $request, string &$response): void
+    {
         switch ($method) {
             case 'GET':
                 $this->handleGet($response);
@@ -24,12 +29,36 @@ public function handleRequest($method, $request, &$response) {
         }
     }
 
-    private function handleGet(&$response) {
+    /**
+     * Handles the GET request and prepares the response.
+     *
+     * @param string &$response The response string to be sent back to the client.
+     *
+     * This method sets the HTTP status code to 200 OK and the Content-Type to application/json.
+     * It then appends the JSON-encoded verification list to the response.
+     */
+    private function handleGet(string &$response): void
+    {
         $response = "HTTP/1.1 200 OK" . PHP_EOL . "Content-Type: application/json" . PHP_EOL . PHP_EOL;
         $response .= json_encode($this->state->getVerifyList());
     }
 
-    private function handlePost($request, &$response) {
+    /**
+     * Handles POST requests by parsing the request data and performing actions based on the method type.
+     *
+     * @param string $request The raw HTTP request string.
+     * @param string &$response The response string to be modified based on the request handling.
+     *
+     * The function performs the following steps:
+     * 1. Extracts the raw data from the request.
+     * 2. Parses the raw data into an associative array.
+     * 3. Retrieves the method type, ckey, discord, and token from the parsed data.
+     * 4. Checks if the provided token matches the expected token. If not, sets the response to 401 Unauthorized.
+     * 5. Retrieves the verification list from the state.
+     * 6. Based on the method type, either deletes an entry from the list or handles the default case.
+     */
+    private function handlePost(string $request, string &$response): void
+    {
         $rawData = explode(PHP_EOL . PHP_EOL, $request, 2)[1];
         parse_str($rawData, $formData);
 
@@ -44,19 +73,26 @@ private function handlePost($request, &$response) {
         }
 
         $list = $this->state->getVerifyList();
-        $existingIndex = array_search($discord, array_column($list, 'discord'));
 
         switch ($methodType) {
             case 'delete':
-                $this->handleDelete($existingIndex, $list, $response);
+                $this->handleDelete(array_search($discord, array_column($list, 'discord')), $list, $response);
                 break;
             default:
-                $this->handleDefault($existingIndex, $list, $ckey, $discord, $response);
+                $this->handleDefault($list, $ckey, $discord, $response);
                 break;
         }
     }
 
-    private function handleDelete($existingIndex, &$list, &$response) {
+    /**
+     * Handles the deletion of an item from the list.
+     *
+     * @param int|string|false $existingIndex The index of the item to delete, or false if the item does not exist.
+     * @param array &$list The list from which the item will be deleted.
+     * @param string &$response The HTTP response message to be returned.
+     */
+    private function handleDelete(int|string|false $existingIndex, array &$list, string &$response): void
+    {
         if ($existingIndex !== false) {
             array_splice($list, $existingIndex, 1);
             PersistentState::writeJson("verify.json", $list);
@@ -67,7 +103,21 @@ private function handleDelete($existingIndex, &$list, &$response) {
         }
     }
 
-    public function handleDefault($existingIndex, &$list, $ckey, $discord, &$response) {
+    /**
+     * Handles the default verification process.
+     *
+     * This method checks if the provided `ckey` or `discord` already exists in the list.
+     * If either exists, it sets the response to a 403 Forbidden status.
+     * If neither exists, it adds the new entry to the list, writes the updated list to a JSON file,
+     * updates the state, and sets the response to a 200 OK status.
+     *
+     * @param array $list The list of existing entries.
+     * @param string $ckey The ckey to be verified.
+     * @param string $discord The discord identifier to be verified.
+     * @param string &$response The response message to be set based on the verification result.
+     */
+    public function handleDefault(array &$list, string $ckey, string $discord, string &$response): void
+    {
         $existingCkeyIndex = array_search($ckey, array_column($list, 'ss13'));
         $existingDiscordIndex = array_search($discord, array_column($list, 'discord'));