GameQ\Protocols\M2mp

Complexity

Total Complexity

7

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Test Coverage

Coverage

96.77%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	processStatus()	0	14	1
A	processServerInfo()	0	19	1
A	processResponse()	0	15	2
A	processPlayers()	0	22	3

<?php
/**
 * This file is part of GameQ.
 *
 * GameQ is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * GameQ is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

namespace GameQ\Protocols;

use GameQ\Protocol;
use GameQ\Buffer;
use GameQ\Result;
use GameQ\Exception\Protocol as Exception;

/**
 * Mafia 2 Multiplayer Protocol Class
 *
 * Loosely based on SAMP protocol
 *
 * Query port = server port + 1
 *
 * Handles processing Mafia 2 Multiplayer servers
 *
 * @package GameQ\Protocols
 * @author Wilson Jesus <>
 */
class M2mp extends Protocol
{
    /**
     * Array of packets we want to look up.
     * Each key should correspond to a defined method in this or a parent class
     *
     * @type array
     */
    protected $packets = [
        self::PACKET_ALL => "M2MP",
    ];

    /**
     * Use the response flag to figure out what method to run
     *
     * @type array
     */
    protected $responses = [
        "M2MP" => 'processStatus',
    ];

    /**
     * The query protocol used to make the call
     *
     * @type string
     */
    protected $protocol = 'm2mp';

    /**
     * String name of this protocol class
     *
     * @type string
     */
    protected $name = 'm2mp';

    /**
     * Longer string name of this protocol class
     *
     * @type string
     */
    protected $name_long = "Mafia 2 Multiplayer";

    /**
     * The client join link
     *
     * @type string
     */
    protected $join_link = null;

    /**
     * The difference between the client port and query port
     *
     * @type int
     */
    protected $port_diff = 1;

    /**
     * Normalize settings for this protocol
     *
     * @type array
     */
    protected $normalize = [
        // General
        'general' => [
            // target       => source
            'hostname'   => 'servername',
            'gametype'   => 'gamemode',
            'maxplayers' => 'max_players',
            'numplayers' => 'num_players',
            'password'   => 'password',
        ],
        // Individual
        'player'  => [
            'name'  => 'name',
        ],
    ];

    /**
     * Handle response from the server
     *
     * @return mixed
     * @throws Exception
     */
    public function processResponse()
    {
        // Make a buffer
        $buffer = new Buffer(implode('', $this->packets_response));

        // Grab the header
        $header = $buffer->read(4);

        // Header
        // Figure out which packet response this is
        if ($header != "M2MP") {
            throw new Exception(__METHOD__ . " response type '" . bin2hex($header) . "' is not valid");
        }

        return call_user_func_array([$this, $this->responses[$header]], [$buffer]);
    }

    /**
     * Process the status response
     *
     * @param Buffer $buffer
     *
     * @return array
     */
    protected function processStatus(Buffer $buffer)
    {
        // We need to split the data and offload
        $results = $this->processServerInfo($buffer);

        $results = array_merge_recursive(
            $results,
            $this->processPlayers($buffer)
        );

        unset($buffer);

        // Return results
        return $results;
    }

    /**
     * Handle processing the server information
     *
     * @param Buffer $buffer
     *
     * @return array
     */
    protected function processServerInfo(Buffer $buffer)
    {
        // Set the result to a new result instance
        $result = new Result();

        // Always dedicated
        $result->add('dedicated', 1);

        // Pull out the server information
        // Note the length information is incorrect, we correct using offset options in pascal method
        $result->add('servername', $buffer->readPascalString(1, true));
        $result->add('num_players', $buffer->readPascalString(1, true));
        $result->add('max_players', $buffer->readPascalString(1, true));
        $result->add('gamemode', $buffer->readPascalString(1, true));
        $result->add('password', (bool) $buffer->readInt8());

        unset($buffer);

        return $result->fetch();
    }

    /**
     * Handle processing of player data
     *
     * @param Buffer $buffer
     *
     * @return array
     */
    protected function processPlayers(Buffer $buffer)
    {
        // Set the result to a new result instance
        $result = new Result();

        // Parse players
        // Read the player info, it's in the same query response for some odd reason.
        while ($buffer->getLength()) {
            // Check to see if we ran out of info, length bug from response
            if ($buffer->getLength() <= 1) {
                break;
            }

            // Only player name information is available
            // Add player name, encoded
            $result->addPlayer('name', utf8_encode(trim($buffer->readPascalString(1, true))));
        }

        // Clear
        unset($buffer);

        return $result->fetch();
    }
}