TrackManiaControl/application/core/Chat.php

226 lines
7.0 KiB
PHP
Raw Normal View History

2013-11-09 17:24:03 +01:00
<?php
namespace ManiaControl;
use ManiaControl\Admin\AuthenticationManager;
use ManiaControl\Players\Player;
use Maniaplanet\DedicatedServer\Xmlrpc\UnknownPlayerException;
2013-11-09 17:24:03 +01:00
/**
* Chat Utility Class
2013-11-09 17:24:03 +01:00
*
2014-05-02 17:40:47 +02:00
* @author ManiaControl Team <mail@maniacontrol.com>
* @copyright 2014 ManiaControl Team
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
2013-11-09 17:24:03 +01:00
*/
class Chat {
/*
* Constants
*/
2014-01-16 18:08:32 +01:00
const SETTING_PREFIX = 'Messages Prefix';
const SETTING_FORMAT_INFORMATION = 'Information Format';
2014-01-16 18:08:32 +01:00
const SETTING_FORMAT_SUCCESS = 'Success Format';
const SETTING_FORMAT_ERROR = 'Error Format';
const SETTING_FORMAT_USAGEINFO = 'UsageInfo Format';
/*
* Private properties
2013-11-09 17:24:03 +01:00
*/
/** @var ManiaControl $maniaControl */
private $maniaControl = null;
2013-11-09 17:24:03 +01:00
/**
* Construct chat utility
*
2014-01-16 18:08:32 +01:00
* @param ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
2014-01-16 18:08:32 +01:00
// Settings
2014-08-05 02:17:41 +02:00
$this->maniaControl->getSettingManager()
->initSetting($this, self::SETTING_PREFIX, '» ');
$this->maniaControl->getSettingManager()
->initSetting($this, self::SETTING_FORMAT_INFORMATION, '$fff');
$this->maniaControl->getSettingManager()
->initSetting($this, self::SETTING_FORMAT_SUCCESS, '$0f0');
$this->maniaControl->getSettingManager()
->initSetting($this, self::SETTING_FORMAT_ERROR, '$f30');
$this->maniaControl->getSettingManager()
->initSetting($this, self::SETTING_FORMAT_USAGEINFO, '$f80');
}
2013-11-09 17:24:03 +01:00
/**
2014-05-02 17:40:47 +02:00
* Send an information message to the given login
*
2014-05-02 17:40:47 +02:00
* @param string $message
* @param string $login
2014-01-16 18:08:32 +01:00
* @param string|bool $prefix
2014-05-02 17:40:47 +02:00
* @return bool
2013-11-09 17:24:03 +01:00
*/
2014-05-02 17:40:47 +02:00
public function sendInformation($message, $login = null, $prefix = true) {
2014-08-05 02:17:41 +02:00
$format = $this->maniaControl->getSettingManager()
->getSettingValue($this, self::SETTING_FORMAT_INFORMATION);
2014-05-02 18:21:38 +02:00
return $this->sendChat($format . $message, $login, $prefix);
2013-11-09 17:24:03 +01:00
}
2014-05-02 17:40:47 +02:00
2013-11-09 17:24:03 +01:00
/**
* Send a chat message to the given login
*
2014-01-16 18:08:32 +01:00
* @param string $message
* @param string $login
* @param string|bool $prefix
* @return bool
2013-11-09 17:24:03 +01:00
*/
public function sendChat($message, $login = null, $prefix = true) {
if (!$this->maniaControl->getClient()) {
return false;
2013-11-09 17:24:03 +01:00
}
2014-04-14 13:17:00 +02:00
if (!$login) {
2014-05-02 17:40:47 +02:00
$prefix = $this->getPrefix($prefix);
2014-04-30 16:57:49 +02:00
$chatMessage = '$<$z$ff0' . str_replace(' ', '', $prefix) . $prefix . $message . '$>';
2014-08-05 02:17:41 +02:00
$this->maniaControl->getClient()
->chatSendServerMessage($chatMessage);
2014-03-01 11:11:50 +01:00
} else {
2014-04-30 16:57:49 +02:00
$chatMessage = '$<$z$ff0' . $this->getPrefix($prefix) . $message . '$>';
if (!is_array($login)) {
$login = Player::parseLogin($login);
}
2014-05-02 17:40:47 +02:00
try {
2014-08-05 02:17:41 +02:00
$this->maniaControl->getClient()
->chatSendServerMessage($chatMessage, $login);
} catch (UnknownPlayerException $e) {
2014-03-02 11:25:47 +01:00
}
2013-11-09 17:24:03 +01:00
}
2014-01-31 17:08:20 +01:00
return true;
2013-11-09 17:24:03 +01:00
}
/**
2014-05-02 17:40:47 +02:00
* Get prefix
2013-11-09 17:24:03 +01:00
*
2014-01-16 18:08:32 +01:00
* @param string|bool $prefix
2014-05-02 17:40:47 +02:00
* @return string
2013-11-09 17:24:03 +01:00
*/
2014-05-02 17:40:47 +02:00
private function getPrefix($prefix) {
if (is_string($prefix)) {
return $prefix;
}
if ($prefix === true) {
2014-08-05 02:17:41 +02:00
return $this->maniaControl->getSettingManager()
->getSettingValue($this, self::SETTING_PREFIX);
2014-05-02 17:40:47 +02:00
}
return '';
2013-11-09 17:24:03 +01:00
}
/**
* Send an Error Message to all Connected Admins
*
* @param string $message
* @param int $minLevel
* @param bool $prefix
*/
public function sendErrorToAdmins($message, $minLevel = AuthenticationManager::AUTH_LEVEL_MODERATOR, $prefix = true) {
2014-08-05 02:17:41 +02:00
$format = $this->maniaControl->getSettingManager()
->getSettingValue($this, self::SETTING_FORMAT_ERROR);
$this->sendMessageToAdmins($format . $message, $minLevel, $prefix);
}
/**
2014-07-25 15:16:41 +02:00
* Send a Message to all connected Admins
*
* @param string $message
* @param int $minLevel
* @param bool|string $prefix
2014-07-25 15:16:41 +02:00
* @return bool
*/
public function sendMessageToAdmins($message, $minLevel = AuthenticationManager::AUTH_LEVEL_MODERATOR, $prefix = true) {
2014-08-05 02:17:41 +02:00
$admins = $this->maniaControl->getAuthenticationManager()
->getConnectedAdmins($minLevel);
2014-07-25 15:16:41 +02:00
return $this->sendChat($message, $admins, $prefix);
}
2013-11-09 17:24:03 +01:00
/**
* Send a success message to the given login
*
2014-01-16 18:08:32 +01:00
* @param string $message
* @param string $login
* @param bool|string $prefix
* @return bool
2013-11-09 17:24:03 +01:00
*/
public function sendSuccess($message, $login = null, $prefix = true) {
2014-08-05 02:17:41 +02:00
$format = $this->maniaControl->getSettingManager()
->getSettingValue($this, self::SETTING_FORMAT_SUCCESS);
2014-05-02 18:21:38 +02:00
return $this->sendChat($format . $message, $login, $prefix);
2013-11-09 17:24:03 +01:00
}
2014-07-25 15:16:41 +02:00
/**
* Sends a Success Message to all connected Admins
*
* @param string $message
* @param int $minLevel
* @param bool|string $prefix
* @return bool
*/
public function sendSuccessToAdmins($message, $minLevel = AuthenticationManager::AUTH_LEVEL_MODERATOR, $prefix = true) {
2014-08-05 02:17:41 +02:00
$format = $this->maniaControl->getSettingManager()
->getSettingValue($this, self::SETTING_FORMAT_SUCCESS);
2014-07-25 15:16:41 +02:00
return $this->sendMessageToAdmins($format . $message, $minLevel, $prefix);
}
2014-05-02 17:40:47 +02:00
/**
* Send the Exception Information to the Chat
*
* @param \Exception $exception
* @param string $login
* @return bool
*/
public function sendException(\Exception $exception, $login = null) {
$message = "Exception occurred: '{$exception->getMessage()}' ({$exception->getCode()})";
return $this->sendError($message, $login);
}
2013-11-09 17:24:03 +01:00
/**
2014-04-14 13:17:00 +02:00
* Send an Error Message to the Chat
2013-11-09 17:24:03 +01:00
*
2014-01-16 18:08:32 +01:00
* @param string $message
* @param string $login
* @param string|bool $prefix
* @return bool
2013-11-09 17:24:03 +01:00
*/
public function sendError($message, $login = null, $prefix = true) {
2014-08-05 02:17:41 +02:00
$format = $this->maniaControl->getSettingManager()
->getSettingValue($this, self::SETTING_FORMAT_ERROR);
2014-05-02 18:21:38 +02:00
return $this->sendChat($format . $message, $login, $prefix);
2013-11-09 17:24:03 +01:00
}
/**
* Send a Exception Message to all Connected Admins
*
* @param \Exception $exception
* @param int $minLevel
* @param bool|string $prefix
*/
2014-07-25 15:16:41 +02:00
public function sendExceptionToAdmins(\Exception $exception, $minLevel = AuthenticationManager::AUTH_LEVEL_MODERATOR,
$prefix = true) {
2014-08-05 02:17:41 +02:00
$format = $this->maniaControl->getSettingManager()
->getSettingValue($this, self::SETTING_FORMAT_ERROR);
$message = $format . "Exception: '{$exception->getMessage()}' ({$exception->getCode()})";
$this->sendMessageToAdmins($message, $minLevel, $prefix);
}
/**
* Send an usage info message to the given login
*
2014-01-16 18:08:32 +01:00
* @param string $message
* @param string $login
* @param string|bool $prefix
* @return bool
*/
public function sendUsageInfo($message, $login = null, $prefix = false) {
2014-08-05 02:17:41 +02:00
$format = $this->maniaControl->getSettingManager()
->getSettingValue($this, self::SETTING_FORMAT_USAGEINFO);
2014-05-02 18:21:38 +02:00
return $this->sendChat($format . $message, $login, $prefix);
}
2013-11-09 17:24:03 +01:00
}