TrackManiaControl/core/Callbacks/CallbackManager.php

357 lines
10 KiB
PHP
Raw Normal View History

2013-11-09 17:24:03 +01:00
<?php
namespace ManiaControl\Callbacks;
2017-05-10 12:40:00 +02:00
use ManiaControl\ErrorHandler;
use ManiaControl\General\UsageInformationAble;
use ManiaControl\General\UsageInformationTrait;
2017-05-13 15:13:33 +02:00
use ManiaControl\Logger;
use ManiaControl\ManiaControl;
use Maniaplanet\DedicatedServer\Xmlrpc\ParseException;
2013-11-09 17:24:03 +01:00
/**
2014-01-09 20:38:45 +01:00
* Class for managing Server and ManiaControl Callbacks
2013-11-09 17:24:03 +01:00
*
2014-05-02 17:50:30 +02:00
* @author ManiaControl Team <mail@maniacontrol.com>
2017-02-04 11:49:23 +01:00
* @copyright 2014-2017 ManiaControl Team
2014-04-24 21:55:47 +02:00
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
2013-11-09 17:24:03 +01:00
*/
class CallbackManager implements UsageInformationAble {
use UsageInformationTrait;
/*
2013-11-09 17:24:03 +01:00
* Constants
*/
// ManiaPlanet callbacks
2014-04-24 21:55:47 +02:00
const CB_MP_SERVERSTART = 'ManiaPlanet.ServerStart';
const CB_MP_SERVERSTOP = 'ManiaPlanet.ServerStop';
const CB_MP_BEGINMATCH = 'ManiaPlanet.BeginMatch';
const CB_MP_ENDMATCH = 'ManiaPlanet.EndMatch';
2014-06-14 17:10:19 +02:00
const CB_MP_BEGINMAP = 'ManiaPlanet.BeginMap';
const CB_MP_ENDMAP = 'ManiaPlanet.EndMap';
2014-04-24 21:55:47 +02:00
const CB_MP_MAPLISTMODIFIED = 'ManiaPlanet.MapListModified';
const CB_MP_ECHO = 'ManiaPlanet.Echo';
const CB_MP_BILLUPDATED = 'ManiaPlanet.BillUpdated';
const CB_MP_PLAYERCHAT = 'ManiaPlanet.PlayerChat';
const CB_MP_PLAYERCONNECT = 'ManiaPlanet.PlayerConnect';
const CB_MP_PLAYERDISCONNECT = 'ManiaPlanet.PlayerDisconnect';
2013-11-09 17:24:03 +01:00
const CB_MP_PLAYERMANIALINKPAGEANSWER = 'ManiaPlanet.PlayerManialinkPageAnswer';
2014-04-24 21:55:47 +02:00
const CB_MP_PLAYERINFOCHANGED = 'ManiaPlanet.PlayerInfoChanged';
const CB_MP_PLAYERALLIESCHANGED = 'ManiaPlanet.PlayerAlliesChanged';
const CB_MP_VOTEUPDATED = 'ManiaPlanet.VoteUpdated';
const CB_MP_STATUSCHANGED = 'ManiaPlanet.StatusChanged';
const CB_MP_MODESCRIPTCALLBACK = 'ManiaPlanet.ModeScriptCallback';
const CB_MP_MODESCRIPTCALLBACKARRAY = 'ManiaPlanet.ModeScriptCallbackArray';
const CB_MP_TUNNELDATARECEIVED = 'ManiaPlanet.TunnelDataReceived';
2013-11-09 17:24:03 +01:00
// TrackMania callbacks
2014-04-24 21:55:47 +02:00
const CB_TM_PLAYERCHECKPOINT = 'TrackMania.PlayerCheckpoint';
const CB_TM_PLAYERFINISH = 'TrackMania.PlayerFinish';
2013-11-09 17:24:03 +01:00
const CB_TM_PLAYERINCOHERENCE = 'TrackMania.PlayerIncoherence';
2014-04-24 21:55:47 +02:00
/*
2014-07-25 16:39:07 +02:00
* Private properties
2013-11-09 17:24:03 +01:00
*/
private $libXmlRpcCallbacks = null;
private $shootManiaCallbacks = null;
private $trackManiaCallbacks = null;
2014-07-25 16:39:07 +02:00
/** @var ManiaControl $maniaControl */
private $maniaControl = null;
2014-07-11 16:54:43 +02:00
/** @var Listening[][] $callbackListenings */
private $callbackListenings = array();
2014-07-11 16:54:43 +02:00
/** @var Listening[][] $scriptCallbackListenings */
private $scriptCallbackListenings = array();
2014-01-09 20:38:45 +01:00
2013-11-09 17:24:03 +01:00
/**
2014-07-25 16:39:07 +02:00
* Construct a new callbacks manager instance
*
* @param ManiaControl $maniaControl
2013-11-09 17:24:03 +01:00
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
2014-04-24 21:55:47 +02:00
$this->libXmlRpcCallbacks = new LibXmlRpcCallbacks($maniaControl, $this);
2014-05-24 17:45:35 +02:00
$this->shootManiaCallbacks = new ShootManiaCallbacks($maniaControl, $this);
$this->trackManiaCallbacks = new TrackManiaCallbacks($maniaControl, $this);
2013-11-09 17:24:03 +01:00
}
/**
2014-01-09 20:38:45 +01:00
* Register a new Callback Listener
*
* @param string $callbackName
* @param CallbackListener $listener
* @param string $method
* @return bool
2013-11-09 17:24:03 +01:00
*/
public function registerCallbackListener($callbackName, CallbackListener $listener, $method) {
if (is_array($callbackName)) {
2014-07-11 16:54:43 +02:00
$success = false;
foreach ($callbackName as $callback) {
2014-07-11 16:54:43 +02:00
if ($this->registerCallbackListener($callback, $listener, $method)) {
$success = true;
}
}
return $success;
}
if (!Listening::checkValidCallback($listener, $method)) {
$listenerClass = get_class($listener);
trigger_error("Given Listener '{$listenerClass}' can't handle Callback '{$callbackName}': No callable Method '{$method}'!");
return false;
2013-11-09 17:24:03 +01:00
}
if (!$this->callbackListeningExists($callbackName)) {
$this->callbackListenings[$callbackName] = array();
}
$listening = new Listening($listener, $method);
array_push($this->callbackListenings[$callbackName], $listening);
return true;
2013-11-09 17:24:03 +01:00
}
/**
* Checks if a Callback Listening exists
*
* @param $callbackName
* @return bool
*/
public function callbackListeningExists($callbackName) {
return array_key_exists($callbackName, $this->callbackListenings);
}
/**
2014-01-09 20:38:45 +01:00
* Register a new Script Callback Listener
*
2014-04-24 21:55:47 +02:00
* @param string $callbackName
2014-01-09 20:38:45 +01:00
* @param CallbackListener $listener
2014-04-24 21:55:47 +02:00
* @param string $method
* @return bool
*/
public function registerScriptCallbackListener($callbackName, CallbackListener $listener, $method) {
if (is_array($callbackName)) {
2014-07-11 16:54:43 +02:00
$success = false;
foreach ($callbackName as $callback) {
2014-07-11 16:54:43 +02:00
if ($this->registerScriptCallbackListener($callback, $listener, $method)) {
$success = true;
}
}
return $success;
}
if (!Listening::checkValidCallback($listener, $method)) {
$listenerClass = get_class($listener);
trigger_error("Given Listener '{$listenerClass}' can't handle Script Callback '{$callbackName}': No callable Method '{$method}'!");
return false;
}
if (!array_key_exists($callbackName, $this->scriptCallbackListenings)) {
$this->scriptCallbackListenings[$callbackName] = array();
}
$listening = new Listening($listener, $method);
array_push($this->scriptCallbackListenings[$callbackName], $listening);
return true;
}
2013-12-14 23:27:15 +01:00
/**
* Unregister a Callback Listener
2013-12-14 23:27:15 +01:00
*
2014-01-09 20:38:45 +01:00
* @param CallbackListener $listener
2013-12-14 23:27:15 +01:00
* @return bool
*/
public function unregisterCallbackListener(CallbackListener $listener) {
return $this->removeCallbackListener($this->callbackListenings, $listener);
}
/**
2014-07-11 16:54:43 +02:00
* Remove the Callback Listener from the given Listeners Array
*
2014-07-11 16:54:43 +02:00
* @param Listening[] $listeningsArray
* @param CallbackListener $listener
* @return bool
*/
2014-07-11 16:54:43 +02:00
private function removeCallbackListener(array &$listeningsArray, CallbackListener $listener) {
$removed = false;
foreach ($listeningsArray as &$listenings) {
foreach ($listenings as $key => &$listening) {
2014-07-11 16:54:43 +02:00
if ($listening->listener === $listener) {
unset($listenings[$key]);
2014-07-11 16:54:43 +02:00
$removed = true;
}
}
}
2014-07-11 16:54:43 +02:00
return $removed;
}
/**
2014-07-11 16:54:43 +02:00
* Unregister a single Callback Listening from an Callback Listener
*
2014-07-11 16:54:43 +02:00
* @param String $callbackName
* @param CallbackListener $listener
* @return bool
*/
2014-07-11 16:54:43 +02:00
public function unregisterCallbackListening($callbackName, CallbackListener $listener) {
2013-12-14 23:27:15 +01:00
$removed = false;
2014-07-11 16:54:43 +02:00
foreach ($this->callbackListenings as &$listenings) {
foreach ($listenings as $key => &$listening) {
2014-07-11 16:54:43 +02:00
if ($key === $callbackName && $listening->listener === $listener) {
unset($listenings[$key]);
2014-05-07 23:00:21 +02:00
$removed = true;
2014-01-19 23:18:48 +01:00
}
2013-12-14 23:27:15 +01:00
}
}
return $removed;
}
/**
* Unregister a Script Callback Listener
2013-12-14 23:27:15 +01:00
*
2014-01-09 20:38:45 +01:00
* @param CallbackListener $listener
2013-12-14 23:27:15 +01:00
* @return bool
*/
public function unregisterScriptCallbackListener(CallbackListener $listener) {
return $this->removeCallbackListener($this->scriptCallbackListenings, $listener);
2013-12-14 23:27:15 +01:00
}
/**
2014-01-09 20:38:45 +01:00
* Trigger internal Callbacks and manage Server Callbacks
*/
public function manageCallbacks() {
2014-01-31 00:04:40 +01:00
// Manage Timings
2014-08-13 11:05:52 +02:00
$this->maniaControl->getTimerManager()->manageTimings();
2014-04-24 21:55:47 +02:00
// Manage Socket Tickets
$this->maniaControl->getCommunicationManager()->tick();
2014-01-09 20:38:45 +01:00
// Server Callbacks
if (!$this->maniaControl->getClient()) {
2014-01-19 23:18:48 +01:00
return;
}
2014-04-24 21:55:47 +02:00
2013-11-09 17:24:03 +01:00
// Handle callbacks
$timings = array();
$startTime = microtime(true);
try {
$callbacks = $this->maniaControl->getClient()->executeCallbacks();
} catch (ParseException $e) {
//TODO remove later, its for the wrong XML encoding of nadeo
2017-05-13 15:13:33 +02:00
Logger::logError("Parse Exception");
return;
}
$timings["executeCallbacks"] = microtime(true) - $startTime;
2017-05-10 12:40:00 +02:00
foreach ($callbacks as $key => $callback) {
$time1 = microtime(true);
$this->handleCallback($callback);
2017-05-10 12:40:00 +02:00
$timings[$key] = array($callback[0], microtime(true) - $time1);
}
2017-05-14 09:25:52 +02:00
//Execute Multicalls
$this->maniaControl->getClient()->executeMulticall();
2017-05-10 11:09:59 +02:00
$fullTime = microtime(true) - $startTime;
2017-05-14 09:25:52 +02:00
2017-05-10 12:40:00 +02:00
if ($fullTime > ErrorHandler::LONG_LOOP_REPORT_TIME) {
$this->maniaControl->getErrorHandler()->triggerDebugNotice(json_encode(array("Long Loop Detected: " . $fullTime, $timings)));
}
2017-05-14 09:25:52 +02:00
}
/**
* Handle the given Callback
*
* @param array $callback
*/
private function handleCallback(array $callback) {
$callbackName = $callback[0];
2014-05-02 17:50:30 +02:00
switch ($callbackName) {
2014-06-14 17:10:19 +02:00
case self::CB_MP_BEGINMATCH:
2014-05-09 12:19:06 +02:00
$this->triggerCallback($callbackName, $callback);
2014-05-02 17:50:30 +02:00
break;
2014-06-14 17:10:19 +02:00
case self::CB_MP_BEGINMAP:
2014-08-13 11:05:52 +02:00
$this->maniaControl->getMapManager()->handleBeginMap($callback);
$this->triggerCallback($callbackName, $callback);
break;
2014-06-14 17:10:19 +02:00
case self::CB_MP_ENDMATCH:
2014-05-09 12:14:25 +02:00
$this->triggerCallback($callbackName, $callback);
2014-05-02 17:50:30 +02:00
break;
2014-06-14 17:10:19 +02:00
case self::CB_MP_ENDMAP:
2014-08-13 11:05:52 +02:00
$this->maniaControl->getMapManager()->handleEndMap($callback);
$this->triggerCallback($callbackName, $callback);
break;
case self::CB_MP_MODESCRIPTCALLBACK:
$this->handleScriptCallback($callback);
$this->triggerCallback($callbackName, $callback);
break;
case self::CB_MP_MODESCRIPTCALLBACKARRAY:
$this->handleScriptCallback($callback);
$this->triggerCallback($callbackName, $callback);
break;
default:
$this->triggerCallback($callbackName, $callback);
break;
2013-11-09 17:24:03 +01:00
}
}
2014-05-02 17:50:30 +02:00
/**
* Trigger a specific Callback
*
* @param mixed $callbackName
2014-05-02 17:50:30 +02:00
*/
public function triggerCallback($callbackName) {
if (!$this->callbackListeningExists($callbackName)) {
2014-05-02 17:50:30 +02:00
return;
}
2014-05-02 17:50:30 +02:00
$params = func_get_args();
$params = array_slice($params, 1, null, true);
foreach ($this->callbackListenings[$callbackName] as $listening) {
/** @var Listening $listening */
$listening->triggerCallbackWithParams($params);
2014-05-02 17:50:30 +02:00
}
}
2013-11-09 17:24:03 +01:00
/**
2014-01-09 20:38:45 +01:00
* Handle the given Script Callback
2013-11-09 17:24:03 +01:00
*
2014-01-09 20:38:45 +01:00
* @param array $callback
2013-11-09 17:24:03 +01:00
*/
private function handleScriptCallback(array $callback) {
$scriptCallbackData = $callback[1];
$scriptCallbackName = $scriptCallbackData[0];
$this->triggerScriptCallback($scriptCallbackName, $scriptCallbackData);
2014-04-24 21:55:47 +02:00
$this->triggerCallback(Callbacks::SCRIPTCALLBACK, $scriptCallbackName, $scriptCallbackData[1]);
2013-11-09 17:24:03 +01:00
}
2014-05-02 17:50:30 +02:00
/**
* Trigger a specific Script Callback
*
* @param string $callbackName
*/
public function triggerScriptCallback($callbackName) {
if (!array_key_exists($callbackName, $this->scriptCallbackListenings)) {
2014-05-02 17:50:30 +02:00
return;
}
2014-05-02 17:50:30 +02:00
$params = func_get_args();
$params = array_slice($params, 1, null, true);
foreach ($this->scriptCallbackListenings[$callbackName] as $listening) {
2014-07-17 20:02:36 +02:00
/** @var Listening $listening */
$listening->triggerCallbackWithParams($params);
2014-05-02 17:50:30 +02:00
}
}
2013-11-09 17:24:03 +01:00
}