TrackManiaControl/application/core/Callbacks/CallbackManager.php

301 lines
8.9 KiB
PHP
Raw Normal View History

2013-11-09 17:24:03 +01:00
<?php
namespace ManiaControl\Callbacks;
use ManiaControl\Callbacks\Models\BaseCallback;
use ManiaControl\ManiaControl;
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>
* @copyright 2014 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 {
/*
2013-11-09 17:24:03 +01:00
* Constants
*/
// ManiaControl callbacks
// TODO: move into Callbacks interface
/** @deprecated Use Callbacks Interface */
const CB_ONINIT = 'Callbacks.OnInit';
/** @deprecated Use Callbacks Interface */
const CB_AFTERINIT = 'Callbacks.AfterInit';
/** @deprecated Use Callbacks Interface */
const CB_ONSHUTDOWN = 'Callbacks.OnShutdown';
2014-04-24 21:55:47 +02:00
2013-11-09 17:24:03 +01:00
// 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';
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
/*
* Public Properties
*/
2014-04-24 17:41:05 +02:00
public $libXmlRpcCallbacks = null;
public $shootManiaCallbacks = null;
2014-04-24 17:41:05 +02:00
/*
* Private Properties
2013-11-09 17:24:03 +01:00
*/
private $maniaControl = null;
private $callbackListenings = array();
private $scriptCallbackListenings = array();
2014-01-09 20:38:45 +01:00
2013-11-09 17:24:03 +01:00
/**
2014-01-09 20:38:45 +01:00
* Construct a new Callbacks Manager
*
* @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->shootManiaCallbacks = new ShootManiaCallbacks($maniaControl, $this);
$this->libXmlRpcCallbacks = new LibXmlRpcCallbacks($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)) {
$success = true;
foreach ($callbackName as $callback) {
if (!$this->registerCallbackListener($callback, $listener, $method)) {
$success = false;
}
}
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 (!array_key_exists($callbackName, $this->callbackListenings)) {
$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
}
/**
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)) {
$success = true;
foreach ($callbackName as $callback) {
if (!$this->registerScriptCallbackListener($callback, $listener, $method)) {
$success = false;
}
}
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);
}
/**
* Remove the Callback Listener from the given Listeners Array
*
* @param array $listeningsArray
* @param CallbackListener $listener
* @return bool
*/
private function removeCallbackListener(array &$listeningsArray, CallbackListener $listener) {
2013-12-14 23:27:15 +01:00
$removed = false;
foreach ($listeningsArray as &$listenings) {
foreach ($listenings as $key => &$listening) {
/** @var Listening $listening */
if ($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-01-30 22:35:32 +01:00
$this->maniaControl->timerManager->manageTimings();
2014-04-24 21:55:47 +02:00
2014-01-09 20:38:45 +01:00
// Server Callbacks
2014-01-30 22:35:32 +01:00
if (!$this->maniaControl->client) {
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
$callbacks = $this->maniaControl->client->executeCallbacks();
2014-05-02 17:50:30 +02:00
foreach ($callbacks as $callback) {
$this->handleCallback($callback);
}
}
/**
* 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) {
case 'ManiaPlanet.BeginMatch':
2014-05-09 12:19:06 +02:00
$this->triggerCallback($callbackName, $callback);
2014-05-02 17:50:30 +02:00
break;
case 'ManiaPlanet.BeginMap':
$this->maniaControl->mapManager->handleBeginMap($callback);
$this->triggerCallback($callbackName, $callback);
break;
2014-05-09 12:14:25 +02:00
case 'ManiaPlanet.EndMatch':
$this->triggerCallback($callbackName, $callback);
2014-05-02 17:50:30 +02:00
break;
case 'ManiaPlanet.EndMap':
$this->maniaControl->mapManager->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 $callback
2014-05-02 17:50:30 +02:00
*/
public function triggerCallback($callback) {
if ($callback instanceof BaseCallback) {
$callbackName = $callback->name;
} else {
$callbackName = $callback;
}
if (!array_key_exists($callbackName, $this->callbackListenings)) {
2014-05-02 17:50:30 +02:00
return;
}
2014-05-02 17:50:30 +02:00
$params = func_get_args();
if (!($callback instanceof BaseCallback)) {
$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) {
/** @var Listening $listening */
$listening->triggerCallbackWithParams($params);
2014-05-02 17:50:30 +02:00
}
}
2013-11-09 17:24:03 +01:00
}