dedicated server api update (reverted from commit 77a53b282c)

This commit is contained in:
kremsy
2014-05-08 19:32:14 +02:00
parent 77a53b282c
commit aefa91fc15
49 changed files with 2373 additions and 2012 deletions

View File

@ -4,7 +4,7 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
abstract class AbstractStructure
@ -13,37 +13,37 @@ abstract class AbstractStructure
{
if(!is_array($array))
return $array;
$object = new static;
foreach($array as $key => $value)
$object->{lcfirst($key)} = $value;
return $object;
}
static public function fromArrayOfArray($array)
{
if(!is_array($array))
return $array;
$result = array();
foreach($array as $key => $value)
$result[$key] = static::fromArray($value);
return $result;
}
static public function getPropertyFromArray($array, $property)
{
return array_map(get_called_class().'::extractProperty', $array, array_fill(0, count($array), $property));
}
static protected function extractProperty($element, $property)
{
if(!is_a($element, get_called_class()) || !property_exists($element, $property))
throw new \InvalidArgumentException('property '.$property.' does not exists in class: '.get_called_class());
return $element->$property;
}
function toArray()
{
$out = array();
@ -52,3 +52,5 @@ abstract class AbstractStructure
return $out;
}
}
?>

View File

@ -4,7 +4,6 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class Bill extends AbstractStructure
@ -15,11 +14,9 @@ class Bill extends AbstractStructure
const STATE_PAYED = 4;
const STATE_REFUSED = 5;
const STATE_ERROR = 6;
/** @var int */
public $state;
/** @var string */
public $stateName;
/** @var int */
public $transactionId;
}
?>

View File

@ -1,20 +1,18 @@
<?php
/**
* ManiaPlanet dedicated server Xml-RPC client
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
/**
* @version $Revision: $:
* @author $Author: $:
* @date $Date: $:
*/
namespace Maniaplanet\DedicatedServer\Structures;
class Command extends AbstractStructure
{
/** @var string */
public $name;
/** @var string */
public $desc;
/** @var string */
public $type;
/** @var string */
public $default;
}
?>

View File

@ -4,7 +4,6 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class GameInfos extends AbstractStructure
@ -20,52 +19,29 @@ class GameInfos extends AbstractStructure
const GAMEMODE_CUP = 5;
const GAMEMODE_STUNTS = 6;
/** @var int */
public $gameMode;
/** @var string */
public $scriptName;
/** @var int */
public $nbMaps;
/** @var int */
public $chatTime;
/** @var int */
public $finishTimeout;
/** @var int */
public $allWarmUpDuration;
/** @var bool */
public $disableRespawn;
/** @var int */
public $forceShowAllOpponents;
/** @var int */
public $roundsPointsLimit;
/** @var int */
public $roundsForcedLaps;
/** @var bool */
public $roundsUseNewRules;
/** @var int */
public $roundsPointsLimitNewRules;
/** @var int */
public $teamPointsLimit;
/** @var int */
public $teamMaxPoints;
/** @var bool */
public $teamUseNewRules;
/** @var int */
public $teamPointsLimitNewRules;
/** @var int */
public $timeAttackLimit;
/** @var int */
public $timeAttackSynchStartPeriod;
/** @var int */
public $lapsNbLaps;
/** @var int */
public $lapsTimeLimit;
/** @var int */
public $cupPointsLimit;
/** @var int */
public $cupRoundsPerMap;
/** @var int */
public $cupNbWinners;
/** @var int */
public $cupWarmUpDuration;
}
?>

View File

@ -4,17 +4,14 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class LobbyInfo extends AbstractStructure
{
/** var bool */
public $isLobby;
/** var int */
public $lobbyPlayers;
/** var int */
public $lobbyMaxPlayers;
/** var float */
public $lobbyPlayersLevel;
}
?>

View File

@ -4,41 +4,24 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class Map extends AbstractStructure
{
/** var string */
public $uId;
/** var string */
public $name;
/** var string */
public $fileName;
/** var string */
public $author;
/** var string */
public $environnement;
/** var string */
public $mood;
/** var int */
public $bronzeTime;
/** var int */
public $silverTime;
/** var int */
public $goldTime;
/** var int */
public $authorTime;
/** var int */
public $copperPrice;
/** var bool */
public $lapRace;
/** var int */
public $nbLaps;
/** var int */
public $nbCheckpoints;
/** var string */
public $mapType;
/** var string */
public $mapStyle;
}
}

View File

@ -4,13 +4,15 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class Mod extends AbstractStructure
{
/** var string */
public $env;
/** var string */
public $url;
}
function toArray()
{
return array('Env'=>$this->env,'Url'=>$this->url);
}
}

View File

@ -4,15 +4,11 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class Music extends AbstractStructure
{
/** var bool */
public $override;
/** var string */
public $url;
/** var string */
public $url;
public $file;
}
}

View File

@ -4,34 +4,24 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class NetworkStats extends AbstractStructure
{
/** @var int */
public $uptime;
/** @var int */
public $nbrConnection;
/** @var int */
public $meanConnectionTime;
/** @var int */
public $meanNbrPlayer;
/** @var int */
public $recvNetRate;
/** @var int */
public $sendNetRate;
/** @var int */
public $totalReceivingSize;
/** @var int */
public $totalSendingSize;
/** @var PlayerNetInfo[] */
public $playerNetInfos;
static public function fromArray($array)
{
$object = parent::fromArray($array);
$object->playerNetInfos = PlayerNetInfo::fromArrayOfArray($object->playerNetInfos);
$object->playerNetInfos = Player::fromArrayOfArray($object->playerNetInfos);
return $object;
}
}
}

View File

@ -8,6 +8,90 @@ namespace Maniaplanet\DedicatedServer\Structures;
class Player extends AbstractStructure
{
/** @var string */
public $playerId;
public $login;
public $nickName;
public $teamId;
public $path;
public $language;
public $clientVersion;
public $clientName;
public $iPAddress;
public $downloadRate;
public $uploadRate;
public $isSpectator;
public $isInOfficialMode;
public $avatar;
public $skins;
public $ladderStats;
public $hoursSinceZoneInscription;
public $onlineRights;
public $rank;
public $bestTime;
public $bestCheckpoints;
public $score;
public $nbrLapsFinished;
public $ladderScore;
public $stateUpdateLatency;
public $stateUpdatePeriod;
public $latestNetworkActivity;
public $packetLossRate;
public $spectatorStatus;
public $ladderRanking;
public $flags;
public $isConnected = true;
public $allies = array();
public $clubLink;
//Flags details
public $forceSpectator;
public $isReferee;
public $isPodiumReady;
public $isUsingStereoscopy;
public $isManagedByAnOtherServer;
public $isServer;
public $hasPlayerSlot;
public $isBroadcasting;
public $hasJoinedGame;
//SpectatorStatus details
public $spectator;
public $temporarySpectator;
public $pureSpectator;
public $autoTarget;
public $currentTargetId;
function getArrayFromPath()
{
return explode('|', $this->path);
}
/**
* @return Player
*/
static public function fromArray($array)
{
$object = parent::fromArray($array);
$object->skins = Skin::fromArrayOfArray($object->skins);
//Detail flags
$object->forceSpectator = $object->flags % 10; // 0, 1 or 2
$object->isReferee = (bool) (intval($object->flags / 10) % 10);
$object->isPodiumReady = (bool) (intval($object->flags / 100) % 10);
$object->isUsingStereoscopy = (bool) (intval($object->flags / 1000) % 10);
$object->isManagedByAnOtherServer = (bool) (intval($object->flags / 10000) % 10);
$object->isServer = (bool) (intval($object->flags / 100000) % 10);
$object->hasPlayerSlot = (bool) (intval($object->flags / 1000000) % 10);
$object->isBroadcasting = (bool) (intval($object->flags / 10000000) % 10);
$object->hasJoinedGame = (bool) (intval($object->flags / 100000000) % 10);
//Details spectatorStatus
$object->spectator = (bool) ($object->spectatorStatus % 10);
$object->temporarySpectator = (bool) (intval($object->spectatorStatus / 10) % 10);
$object->pureSpectator = (bool) (intval($object->spectatorStatus / 100) % 10);
$object->autoTarget = (bool) (intval($object->spectatorStatus / 1000) % 10);
$object->currentTargetId = intval($object->spectatorStatus / 10000);
return $object;
}
}
?>

View File

@ -9,24 +9,29 @@ namespace Maniaplanet\DedicatedServer\Structures;
class ScriptInfo extends AbstractStructure
{
/** @var string */
public $name;
/** @var string */
public $compatibleMapTypes;
/** @var string */
public $description;
/** @var string */
public $version;
/** @var ScriptSettings[] */
public $paramDescs = array();
/** @var Command[] */
public $commandDescs = array();
static public function fromArray($array)
{
$object = parent::fromArray($array);
$object->paramDescs = ScriptSettings::fromArrayOfArray($object->paramDescs);
$object->commandDescs = Command::fromArrayOfArray($object->commandDescs);
if($object->paramDescs)
{
$object->paramDescs = ScriptSettings::fromArrayOfArray($object->paramDescs);
}
if($object->commandDescs)
{
$object->commandDescs = Command::fromArrayOfArray($object->commandDescs);
}
return $object;
}
}
?>

View File

@ -7,14 +7,14 @@
namespace Maniaplanet\DedicatedServer\Structures;
class ScriptSettings extends AbstractStructure
final class ScriptSettings extends AbstractStructure
{
/** @var string */
public $name;
/** @var string */
public $desc;
/** @var string */
public $type;
/** @var string */
public $default;
}
?>

View File

@ -9,66 +9,36 @@ namespace Maniaplanet\DedicatedServer\Structures;
class ServerOptions extends AbstractStructure
{
/** @var string */
public $name;
/** @var string */
public $comment;
/** @var string */
public $password;
/** @var string */
public $passwordForSpectator;
/** @var int */
public $hideServer;
/** @var int */
public $currentMaxPlayers;
/** @var int */
public $nextMaxPlayers;
/** @var int */
public $currentMaxSpectators;
/** @var int */
public $nextMaxSpectators;
/** @var bool */
public $isP2PUpload;
/** @var bool */
public $isP2PDownload;
/** @var bool */
public $currentLadderMode;
/** @var int */
public $nextLadderMode;
/** @var float */
public $ladderServerLimitMax;
/** @var float */
public $ladderServerLimitMin;
/** @var int */
public $currentVehicleNetQuality;
/** @var int */
public $nextVehicleNetQuality;
/** @var int */
public $currentCallVoteTimeOut;
/** @var int */
public $nextCallVoteTimeOut;
/** @var float */
public $callVoteRatio;
/** @var bool */
public $allowMapDownload;
/** @var bool */
public $autoSaveReplays;
/** @var bool */
public $autoSaveValidationReplays;
/** @var string */
public $refereePassword;
/** @var int */
public $refereeMode;
/** @var bool */
public $currentUseChangingValidationSeed;
/** @var bool */
public $useChangingValidationSeed;
public $nextUseChangingValidationSeed;
/** @var int */
public $clientInputsMaxLatency;
/** @var bool */
public $keepPlayerSlots;
/** @var bool */
public $disableHorns;
/** @var bool */
public $disableServiceAnnounces;
}
}

View File

@ -4,20 +4,13 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class Skin extends AbstractStructure
{
/** @var string */
public $environnement;
/** @var FileDesc */
public $packDesc;
static function fromArray($array)
{
$object = parent::fromArray($array);
$object->packDesc = FileDesc::fromArray($object->packDesc);
return $object;
}
}
public $orig;
public $name;
public $checksum;
public $url;
}

View File

@ -4,7 +4,6 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class Status extends AbstractStructure
@ -16,8 +15,6 @@ class Status extends AbstractStructure
const PLAY = 4;
const EXITING = 6;
/** @var int */
public $code;
/** @var string */
public $name;
}
}

View File

@ -4,29 +4,19 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class SystemInfos extends AbstractStructure
{
/** @var string */
public $publishedIp;
/** @var int */
public $port;
/** @var int */
public $p2PPort;
/** @var string */
public $titleId;
/** @var string */
public $serverLogin;
/** @var int */
public $serverPlayerId;
/** @var int */
public $connectionDownloadRate;
/** @var int */
public $connectionUploadRate;
/** @var bool */
public $isServer;
/** @var bool */
public $isDedicated;
}
?>

View File

@ -9,20 +9,14 @@ namespace Maniaplanet\DedicatedServer\Structures;
class Team extends AbstractStructure
{
/** @var string */
public $name;
/** @var string */
public $zonePath;
/** @var string */
public $city;
/** @var string */
public $emblemUrl;
/** @var float */
public $huePrimary;
/** @var float */
public $hueSecondary;
/** @var string */
public $rGB;
/** @var string */
public $clubLinkUrl;
}
?>

View File

@ -4,19 +4,15 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class Version extends AbstractStructure
{
/** @var string */
public $name;
/** @var string */
public $titleId;
/** @var string */
public $version;
/** @var string */
public $build;
/** @var string */
public $apiVersion;
}
?>

View File

@ -4,7 +4,7 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class Vote extends AbstractStructure
@ -13,32 +13,10 @@ class Vote extends AbstractStructure
const STATE_CANCELLED = 'VoteCancelled';
const STATE_PASSED = 'VotePassed';
const STATE_FAILED = 'VoteFailed';
/** @var string */
public $status;
/** @var string */
public $callerLogin;
/** @var string */
public $cmdName;
/** @var mixed[] */
public $cmdParam;
/**
* @param string $cmdName
* @param mixed[] $cmdParam
*/
function __construct($cmdName='', $cmdParam=array())
{
$this->cmdName = $cmdName;
$this->cmdParam = $cmdParam;
}
/**
* @return bool
*/
function isValid()
{
return is_string($this->cmdName)
&& is_array($this->cmdParam);
}
}
?>

View File

@ -4,7 +4,7 @@
*
* @license http://www.gnu.org/licenses/lgpl.html LGPL License 3
*/
namespace Maniaplanet\DedicatedServer\Structures;
class VoteRatio extends AbstractStructure
@ -17,41 +17,15 @@ class VoteRatio extends AbstractStructure
const COMMAND_TEAM_BALANCE = 'AutoTeamBalance';
const COMMAND_KICK = 'Kick';
const COMMAND_BAN = 'Ban';
/** @var string '*' for default */
public $command;
/** @var string Empty to match all votes for the command */
public $param;
/** @var float Must be in range [0,1] or -1 to disable */
public $ratio;
/**
* @param string $command
* @param float $ratio
*/
public function __construct($command = '', $ratio = 0.)
public function __construct($command = null, $ratio = null)
{
$this->command = $command;
$this->ratio = $ratio;
$this->param = '';
}
/**
* @return bool
*/
function isValid()
{
return is_string($this->command)
&& is_string($this->param)
&& self::isRatio($this->ratio);
}
/**
* @param float $ratio
* @return bool
*/
static function isRatio($ratio)
{
return is_float($ratio) && ($ratio === -1. || ($ratio >= 0. && $ratio <= 1.));
}
}
?>