revert back to the changes

Author: mmm545

README.md

@@ -2,25 +2,23 @@
 A query virion for Pocketmine-MP\
 This virion uses GS4 to query servers which provides more info. Servers that don't have GS4 supported/enabled can't be queried using this virion, so you need to use another virion such as [libpmquery](https://github.com/jasonwynn10/libpmquery)
 ## Usage
-First you create a new GameSpyQuery instance, first argument is the IP address to query, second argument is the port to query
+To query a server, you call the `GameSpyQuery::query()` function, first argument is the IP, second argument is the port
 ```php
-$query = new GameSpyQuery("someserver.org", 19132);
+$query = GameSpyQuery::query("someserver.org", 19132);
 ```
-Then we query the server
+There's an additional (optional) third argument which is the timeout, it's simply how long it will wait for a response before it closes the connection. The timeout is in seconds
 ```php
-$query->query();
+$query = GameSpyQuery::query("someserver.org", 19132, 5); // it will wait for 5 seconds, if there was no response it would close the connection
 ```
-You can also set a timeout in seconds (optional)
-```php
-$query->query(5);
-```
-The `query()` function will throw a GameSpyQueryException if the destination IP and port can't be queried, so you need to surround it with a try-catch block\
-If everything worked correctly, you can use the `get()` function to get some info about the server\
-List of the data you can get:
+After the query is done, it will return a `GameSpyQuery` instance
+
+The `query()` function will throw a GameSpyQueryException if the destination IP and port can't be queried, so you need to surround it with a try-catch block
+
+After that, use the `get()` function to get info about the server. List of all the data you can get:
 ```php
 $query->get("hostname"); // Server MOTD
-$query->get("gametype"); // Game type, not sure what that means
-$query->get("game_id"); // I think that's the game edition
+$query->get("gametype"); // Game type, e.g SMP or CMP
+$query->get("game_id"); // Game edition
 $query->get("version"); // Version of minecraft the server is running on
 $query->get("server_engine"); // Server software being used
 $query->get("plugins"); // Plugins list with their version
@@ -30,6 +28,10 @@ $query->get("maxplayers"); // Max number of players
 $query->get("whitelist"); // On if whitelist is turned on, otherwise off
 $query->get("hostip"); // Host ip
 $query->get("hostport"); // Host port
-$query->get("players"); // List of online players names
+$query->get("players"); // List of online players on the server
 ```
 In case you want to get the raw response, you can use `getStatusRaw()`
+
+## Notes
+- Do NOT query a server on the main thread, use an AsyncTask instead
+- The info returned by the server can be easily faked, e.g someone doesn't want people to see his highly classified core plugin name, so he removes that info from the query so no one can see it!

src/mmm545/libgamespyquery/GameSpyQuery.php

@@ -21,74 +21,78 @@ class GameSpyQuery
      * @var string $ip
      * IP to query
      */
-    private $ip;
+    private string $ip;
 
     /**
      * @var int $port
      * Port to query
      */
-    private $port;
-    
-    private $socket;
+    private int $port;
 
-    private $statusRaw;
+    /**
+     * @var string $statusRaw
+     * The raw status data
+     */
+    private string $statusRaw;
 
     /**
      * @param string $ip IP to query
      * @param int $port Port to query
      */
-    public function __construct(string $ip, int $port){
+    public function __construct(string $ip, int $port, $statusRaw){
         $this->ip = $ip;
         $this->port = $port;
+        $this->statusRaw = $statusRaw;
     }
 
     /**
      * Queries the destination IP and port.
      * @param int $timeout The connection timeout.
      * @throws GameSpyQueryException If the destination IP and port cannot be queried.
      */
-    public function query(int $timeout = 2){
-        $this->socket = @fsockopen('udp://'.$this->ip, $this->port, $errno, $errstr, $timeout);
+    public static function query(string $ip, int $port, int $timeout = 2) : GameSpyQuery{
+        $socket = @fsockopen('udp://'.$ip, $port, $errno, $errstr, $timeout);
 
-        if($errno and $this->socket !== false) {
-            fclose($this->socket);
+        if($errno and $socket !== false) {
+            fclose($socket);
             throw new GameSpyQueryException($errstr, $errno);
         }
-        elseif($this->socket === false) {
+        elseif($socket === false) {
             throw new GameSpyQueryException($errstr, $errno);
         }
-        stream_set_timeout($this->socket, $timeout);
+        stream_set_timeout($socket, $timeout);
         $sessionId = rand();
 
-        $challengeToken = $this->handshake($sessionId);
+        $challengeToken = self::handshake($socket, $sessionId);
 
         if(empty($challengeToken)){
             throw new GameSpyQueryException("Failed to retrieve challenge token"); //tbh i think i'm abusing exceptions
         }
 
-        $this->statusRaw = $this->retrieveStatus($sessionId, (int)$challengeToken);
-        if(empty($this->statusRaw)){
+        $statusRaw = self::retrieveStatus($socket, $sessionId, (int)$challengeToken);
+        if(empty($statusRaw)){
             throw new GameSpyQueryException("Failed to retrieve server info");
         }
+        return new self($ip, $port, $statusRaw);
     }
 
     /**
      * @param $sessionId
      * @return string|bool
      * @throws GameSpyQueryException
      */
-    private function handshake($sessionId){
+    private static function handshake($socket, $sessionId){
         $command = pack("n", 65277);
         $command .= pack("c", 9);
         $command .= pack("N", $sessionId);
         $command .= pack("xxxx");
 
         $length = strlen($command);
-        if ($length !== fwrite($this->socket, $command, $length)){
+        if ($length !== fwrite($socket, $command, $length)){
             throw new GameSpyQueryException("Failed to write to socket");
         }
 
-        $response = fread($this->socket, 4096);
+        $response = fread($socket, 4096);
 
         if($response === false){
             throw new GameSpyQueryException("Failed to read from socket");
@@ -103,19 +107,19 @@ private function handshake($sessionId){
      * @return string|bool
      * @throws GameSpyQueryException
      */
-    private function retrieveStatus(int $sessionId, int $challengeToken){
+    private static function retrieveStatus($socket, int $sessionId, int $challengeToken){
         $command = pack("n", 65277);
         $command .= pack("c", 0);
         $command .= pack("N", $sessionId);
         $command .= pack("N", $challengeToken);
         $command .= pack("xxxx");
 
         $length = strlen($command);
-        if ($length !== fwrite($this->socket, $command, $length)){
+        if ($length !== fwrite($socket, $command, $length)){
             throw new GameSpyQueryException("Failed to write to socket");
         }
 
-        $response = fread($this->socket, 4096);
+        $response = fread($socket, 4096);
 
         if($response === false){
             throw new GameSpyQueryException("Failed to read from socket");
@@ -125,7 +129,7 @@ private function retrieveStatus(int $sessionId, int $challengeToken){
     }
 
     /**
-     * Gets data by it's key
+     * Gets data by its key
      * @param string $key The key of the data you want to get
      * @return string|string[]|bool The return can be either a string or an array, depending on what data you want to get. Returns false if the key can't be found
      */
@@ -156,15 +160,15 @@ public function get(string $key){
                     return $data[$pos + 1];
                 }
                 return false;
-                
+
         }
     }
 
     /**
-     * @return string The raw status response from the server, or false if the status data is null
+     * @return string The raw status response from the server
      */
-    public function getStatusRaw(){
-        return isset($this->statusRaw) ? $this->statusRaw : false;
+    public function getStatusRaw(): string{
+        return $this->statusRaw;
     }
 
     /**
@@ -174,24 +178,10 @@ public function getIp(): string{
         return $this->ip;
     }
 
-    /**
-     * @param string $ip
-     */
-    public function setIp(string $ip): void{
-        $this->ip = $ip;
-    }
-
     /**
      * @return int
      */
     public function getPort(): int{
         return $this->port;
     }
-
-    /**
-     * @param int $port
-     */
-    public function setPort(int $port): void{
-        $this->port = $port;
-    }
 }

virion.yml

@@ -1,5 +1,5 @@
 name: libgamespyquery
-version: 1.0.0
+version: 2.0.0
 antigen: mmm545\libgamespyquery
-php: 7.0
+php: [8.0]
 author: mmm545