a154fe80e8
- added status information for "WebSocket" installations to `/setup` page (e.g. active connections, startup time) - removed "ext-zmq" as required PHP extension - removed "react/zmq" as required Composer package - removed "websoftwares/monolog-zmq-handler" as required Composer package
516 lines
17 KiB
PHP
516 lines
17 KiB
PHP
<?php
|
|
/**
|
|
* Created by PhpStorm.
|
|
* User: Exodus
|
|
* Date: 28.05.2016
|
|
* Time: 16:05
|
|
*/
|
|
|
|
namespace lib;
|
|
|
|
|
|
use lib\api\CcpClient;
|
|
use lib\api\GitHubClient;
|
|
use lib\api\SsoClient;
|
|
use lib\socket\SocketInterface;
|
|
use lib\socket\TcpSocket;
|
|
|
|
class Config extends \Prefab {
|
|
|
|
const PREFIX_KEY = 'PF';
|
|
const ARRAY_DELIMITER = '-';
|
|
const HIVE_KEY_PATHFINDER = 'PATHFINDER';
|
|
const HIVE_KEY_ENVIRONMENT = 'ENVIRONMENT';
|
|
const CACHE_KEY_SOCKET_VALID = 'CACHED_SOCKET_VALID';
|
|
const CACHE_TTL_SOCKET_VALID = 60;
|
|
|
|
// ================================================================================================================
|
|
// Redis
|
|
// ================================================================================================================
|
|
|
|
/**
|
|
* Redis connect timeout (seconds)
|
|
*/
|
|
const REDIS_OPT_TIMEOUT = 2;
|
|
|
|
/**
|
|
* Redis read timeout (seconds)
|
|
*/
|
|
const REDIS_OPT_READ_TIMEOUT = 10;
|
|
|
|
/**
|
|
* redis retry interval (milliseconds)
|
|
*/
|
|
const REDIS_OPT_RETRY_INTERVAL = 200;
|
|
|
|
// ================================================================================================================
|
|
// EVE downtime
|
|
// ================================================================================================================
|
|
|
|
/**
|
|
* SSO downtime length (estimation), minutes
|
|
*/
|
|
const DOWNTIME_LENGTH = 8;
|
|
|
|
/**
|
|
* SSO downtime buffer length extends downtime length, minutes
|
|
*/
|
|
const DOWNTIME_BUFFER = 1;
|
|
|
|
const ERROR_CLASS_NOT_EXISTS_COMPOSER = 'Class "%s" not found. → Check installed Composer packages';
|
|
const ERROR_METHOD_NOT_EXISTS_COMPOSER = 'Method "%s()" not found in class "%s". → Check installed Composer packages';
|
|
|
|
|
|
/**
|
|
* environment config keys that should be parsed as array
|
|
* -> use "," as delimiter in config files/data
|
|
*/
|
|
const ARRAY_KEYS = ['CCP_ESI_SCOPES', 'CCP_ESI_SCOPES_ADMIN'];
|
|
|
|
const
|
|
HTTP_422='Unprocessable Entity';
|
|
|
|
/**
|
|
* all environment data
|
|
* @var array
|
|
*/
|
|
private $serverConfigData = [];
|
|
|
|
public function __construct(\Base $f3){
|
|
// set server data
|
|
// -> CGI params (Nginx)
|
|
// -> .htaccess (Apache)
|
|
$this->setServerData();
|
|
// set environment data
|
|
$this->setAllEnvironmentData($f3);
|
|
// set hive configuration variables
|
|
// -> overwrites default configuration
|
|
$this->setHiveVariables($f3);
|
|
|
|
// set global getter for \DateTimeZone
|
|
$f3->set('getTimeZone', function() use ($f3) : \DateTimeZone {
|
|
return new \DateTimeZone( $f3->get('TZ') );
|
|
});
|
|
|
|
// set global getter for new \DateTime
|
|
$f3->set('getDateTime', function(string $time = 'now', ?\DateTimeZone $timeZone = null) use ($f3) : \DateTime {
|
|
$timeZone = $timeZone ? : $f3->get('getTimeZone')();
|
|
return new \DateTime($time, $timeZone);
|
|
});
|
|
|
|
// lazy init Web Api clients
|
|
$f3->set(SsoClient::CLIENT_NAME, SsoClient::instance());
|
|
$f3->set(CcpClient::CLIENT_NAME, CcpClient::instance());
|
|
$f3->set(GitHubClient::CLIENT_NAME, GitHubClient::instance());
|
|
|
|
// Socket connectors
|
|
$f3->set(TcpSocket::SOCKET_NAME, function(array $options = ['timeout' => 1]) : SocketInterface {
|
|
return new TcpSocket(self::getSocketUri(), $options);
|
|
});
|
|
}
|
|
|
|
/**
|
|
* get environment configuration data
|
|
* @param \Base $f3
|
|
* @return array|null
|
|
*/
|
|
protected function getAllEnvironmentData(\Base $f3){
|
|
if( !$f3->exists(self::HIVE_KEY_ENVIRONMENT, $environmentData) ){
|
|
$environmentData = $this->setAllEnvironmentData($f3);
|
|
}
|
|
|
|
return $environmentData;
|
|
}
|
|
|
|
/**
|
|
* set/overwrite some global framework variables original set in config.ini
|
|
* -> can be overwritten in environments.ini OR ENV-Vars
|
|
* -> see: https://github.com/exodus4d/pathfinder/issues/175
|
|
* that depend on environment settings
|
|
* @param \Base $f3
|
|
*/
|
|
protected function setHiveVariables(\Base $f3){
|
|
// hive keys that can be overwritten
|
|
$hiveKeys = ['BASE', 'URL', 'DEBUG', 'CACHE'];
|
|
|
|
foreach($hiveKeys as $key){
|
|
if( !is_null( $var = self::getEnvironmentData($key)) ){
|
|
$f3->set($key,$var);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* set all environment configuration data
|
|
* @param \Base $f3
|
|
* @return array|mixed|null
|
|
*/
|
|
protected function setAllEnvironmentData(\Base $f3){
|
|
$environmentData = null;
|
|
|
|
if( !empty($this->serverConfigData['ENV']) ){
|
|
// get environment config from $_SERVER data
|
|
$environmentData = (array)$this->serverConfigData['ENV'];
|
|
|
|
// some environment variables should be parsed as array
|
|
array_walk($environmentData, function(&$item, $key){
|
|
$item = (in_array($key, self::ARRAY_KEYS)) ? explode(',', $item) : $item;
|
|
});
|
|
|
|
$environmentData['ENVIRONMENT_CONFIG'] = 'PHP: environment variables';
|
|
}else{
|
|
// get environment data from *.ini file config
|
|
$customConfDir = $f3->get('CONF');
|
|
|
|
// check "custom" ini dir, of not found check default ini dir
|
|
foreach($customConfDir as $type => $path){
|
|
$envConfFile = $path . 'environment.ini';
|
|
$f3->config($envConfFile, true);
|
|
|
|
if(
|
|
$f3->exists(self::HIVE_KEY_ENVIRONMENT) &&
|
|
($environment = $f3->get(self::HIVE_KEY_ENVIRONMENT . '.SERVER')) &&
|
|
($environmentData = $f3->get(self::HIVE_KEY_ENVIRONMENT . '.' . $environment))
|
|
){
|
|
$environmentData['ENVIRONMENT_CONFIG'] = 'Config: ' . $envConfFile;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
if( !is_null($environmentData) ){
|
|
ksort($environmentData);
|
|
$f3->set(self::HIVE_KEY_ENVIRONMENT, $environmentData);
|
|
}
|
|
|
|
|
|
return $environmentData;
|
|
}
|
|
|
|
/**
|
|
* get/extract all server data passed to PHP
|
|
* this can be done by either:
|
|
* OS Environment variables:
|
|
* -> add to /etc/environment
|
|
* OR:
|
|
* Nginx (server config):
|
|
* -> FastCGI syntax
|
|
* fastcgi_param PF-ENV-DEBUG 3;
|
|
*/
|
|
protected function setServerData(){
|
|
$data = [];
|
|
foreach($_SERVER as $key => $value){
|
|
if( strpos($key, self::PREFIX_KEY . self::ARRAY_DELIMITER) === 0 ){
|
|
$path = explode( self::ARRAY_DELIMITER, $key);
|
|
// remove prefix
|
|
array_shift($path);
|
|
|
|
$tmp = &$data;
|
|
foreach ($path as $segment) {
|
|
$tmp[$segment] = (array)$tmp[$segment];
|
|
$tmp = &$tmp[$segment];
|
|
}
|
|
|
|
// type cast values
|
|
// (e.g. '1.2' => (float); '4' => (int),...)
|
|
$tmp = is_numeric($value) ? $value + 0 : $value;
|
|
}
|
|
}
|
|
|
|
$this->serverConfigData = $data;
|
|
}
|
|
|
|
/**
|
|
* get a environment variable by hive key
|
|
* @param $key
|
|
* @return string|null
|
|
*/
|
|
static function getEnvironmentData($key){
|
|
$hiveKey = self::HIVE_KEY_ENVIRONMENT . '.' . $key;
|
|
\Base::instance()->exists($hiveKey, $data);
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* get database config values
|
|
* @param string $dbKey
|
|
* @return array
|
|
*/
|
|
static function getDatabaseConfig(string $dbKey = 'PF'){
|
|
$dbKey = strtoupper($dbKey);
|
|
return [
|
|
'DNS' => self::getEnvironmentData('DB_' . $dbKey . '_DNS'),
|
|
'NAME' => self::getEnvironmentData('DB_' . $dbKey . '_NAME'),
|
|
'USER' => self::getEnvironmentData('DB_' . $dbKey . '_USER'),
|
|
'PASS' => self::getEnvironmentData('DB_' . $dbKey . '_PASS'),
|
|
'ALIAS' => $dbKey
|
|
];
|
|
}
|
|
|
|
/**
|
|
* get DB config value from PDO connect $dns string
|
|
* @param string $dns
|
|
* @param string $key
|
|
* @return bool
|
|
*/
|
|
static function getDatabaseDNSValue(string $dns, string $key = 'dbname'){
|
|
$value = false;
|
|
if(preg_match('/' . preg_quote($key, '/') . '=([[:alnum:]]+)/is', $dns, $parts)){
|
|
$value = $parts[1];
|
|
}
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* get SMTP config values
|
|
* @return \stdClass
|
|
*/
|
|
static function getSMTPConfig(): \stdClass{
|
|
$config = new \stdClass();
|
|
$config->host = self::getEnvironmentData('SMTP_HOST');
|
|
$config->port = self::getEnvironmentData('SMTP_PORT');
|
|
$config->scheme = self::getEnvironmentData('SMTP_SCHEME');
|
|
$config->username = self::getEnvironmentData('SMTP_USER');
|
|
$config->password = self::getEnvironmentData('SMTP_PASS');
|
|
$config->from = [
|
|
self::getEnvironmentData('SMTP_FROM') => self::getPathfinderData('name')
|
|
];
|
|
return $config;
|
|
}
|
|
|
|
/**
|
|
* validates an SMTP config
|
|
* @param \stdClass $config
|
|
* @return bool
|
|
*/
|
|
static function isValidSMTPConfig(\stdClass $config): bool {
|
|
// validate email from either an configured array or plain string
|
|
$validateMailConfig = function($mailConf = null): bool {
|
|
$email = null;
|
|
if(is_array($mailConf)){
|
|
reset($mailConf);
|
|
$email = key($mailConf);
|
|
}elseif(is_string($mailConf)){
|
|
$email = $mailConf;
|
|
}
|
|
return \Audit::instance()->email($email);
|
|
};
|
|
|
|
return (
|
|
!empty($config->host) &&
|
|
!empty($config->username) &&
|
|
$validateMailConfig($config->from) &&
|
|
$validateMailConfig($config->to)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* get email for notifications by hive key
|
|
* @param $key
|
|
* @return mixed
|
|
*/
|
|
static function getNotificationMail($key){
|
|
return self::getPathfinderData('notification' . ($key ? '.' . $key : ''));
|
|
}
|
|
|
|
/**
|
|
* get map default config values for map types (private/corp/ally)
|
|
* -> read from pathfinder.ini
|
|
* @param string $mapType
|
|
* @return mixed
|
|
*/
|
|
static function getMapsDefaultConfig($mapType = ''){
|
|
if( $mapConfig = self::getPathfinderData('map' . ($mapType ? '.' . $mapType : '')) ){
|
|
$mapConfig = Util::arrayChangeKeyCaseRecursive($mapConfig);
|
|
}
|
|
|
|
return $mapConfig;
|
|
}
|
|
|
|
/**
|
|
* get custom $message for a a HTTP $status
|
|
* -> use this in addition to the very general Base::HTTP_XXX labels
|
|
* @param int $status
|
|
* @return string
|
|
*/
|
|
static function getMessageFromHTTPStatus(int $status): string {
|
|
switch($status){
|
|
case 403:
|
|
$message = 'Access denied: User not found'; break;
|
|
default:
|
|
$message = '';
|
|
}
|
|
return $message;
|
|
}
|
|
|
|
/**
|
|
* use this function to "validate" the socket connection.
|
|
* The result will be CACHED for a few seconds!
|
|
* This function is intended to pre-check a Socket connection if it MIGHT exists.
|
|
* No data will be send to the Socket, this function just validates if a socket is available
|
|
* -> see pingDomain()
|
|
* @return bool
|
|
*/
|
|
static function validSocketConnect(): bool{
|
|
$valid = false;
|
|
$f3 = \Base::instance();
|
|
|
|
if( !$f3->exists(self::CACHE_KEY_SOCKET_VALID, $valid) ){
|
|
if( $socketUrl = self::getSocketUri() ){
|
|
// get socket URI parts -> not elegant...
|
|
$domain = parse_url( $socketUrl, PHP_URL_SCHEME) . '://' . parse_url( $socketUrl, PHP_URL_HOST);
|
|
$port = parse_url( $socketUrl, PHP_URL_PORT);
|
|
// check connection -> get ms
|
|
$status = self::pingDomain($domain, $port);
|
|
if($status >= 0){
|
|
// connection OK
|
|
$valid = true;
|
|
}else{
|
|
// connection error/timeout
|
|
$valid = false;
|
|
}
|
|
}else{
|
|
// requirements check failed or URL not valid
|
|
$valid = false;
|
|
}
|
|
|
|
$f3->set(self::CACHE_KEY_SOCKET_VALID, $valid, self::CACHE_TTL_SOCKET_VALID);
|
|
}
|
|
|
|
return $valid;
|
|
}
|
|
|
|
/**
|
|
* get response time for a host in ms or -1 on error/timeout
|
|
* @param string $domain
|
|
* @param int $port
|
|
* @param int $timeout
|
|
* @return int
|
|
*/
|
|
static function pingDomain(string $domain, int $port, $timeout = 1): int {
|
|
$starttime = microtime(true);
|
|
$file = @fsockopen ($domain, $port, $errno, $errstr, $timeout);
|
|
$stoptime = microtime(true);
|
|
|
|
if (!$file){
|
|
// Site is down
|
|
$status = -1;
|
|
}else {
|
|
fclose($file);
|
|
$status = ($stoptime - $starttime) * 1000;
|
|
$status = floor($status);
|
|
}
|
|
return $status;
|
|
}
|
|
|
|
/**
|
|
* get URI for TCP socket
|
|
* @return bool|string
|
|
*/
|
|
static function getSocketUri(){
|
|
$uri = false;
|
|
|
|
if(
|
|
( $ip = self::getEnvironmentData('SOCKET_HOST') ) &&
|
|
( $port = self::getEnvironmentData('SOCKET_PORT') )
|
|
){
|
|
$uri = 'tcp://' . $ip . ':' . $port;
|
|
}
|
|
return $uri;
|
|
}
|
|
|
|
/**
|
|
* @param string $key
|
|
* @return null|mixed
|
|
*/
|
|
static function getPathfinderData($key = ''){
|
|
$hiveKey = self::HIVE_KEY_PATHFINDER . ($key ? '.' . strtoupper($key) : '');
|
|
if( !\Base::instance()->exists($hiveKey, $data) ){
|
|
$data = null;
|
|
}
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* get HTTP status message by HTTP return code
|
|
* -> either from F3 or from self::Config constants
|
|
* @param int $code
|
|
* @return string
|
|
*/
|
|
static function getHttpStatusByCode(int $code) : string {
|
|
if(empty($status = @constant('Base::HTTP_' . $code))){
|
|
$status = @constant('self::HTTP_' . $code);
|
|
}
|
|
return $status;
|
|
}
|
|
|
|
/**
|
|
* parse [D]ata [S]ource [N]ame string from *.ini into $conf parts
|
|
* -> $dsn = redis=localhost:6379:2
|
|
* $conf = ['type' => 'redis', 'host' => 'localhost', 'port' => 6379, 'db' => 2]
|
|
* -> some $conf values might be NULL if not found in $dsn!
|
|
* -> some missing values become defaults
|
|
* @param string $dsn
|
|
* @param array|null $conf
|
|
* @return bool
|
|
*/
|
|
static function parseDSN(string $dsn, ?array &$conf = []) : bool {
|
|
// reset reference
|
|
if($matches = (bool)preg_match('/^(\w+)\h*=\h*(.+)/', strtolower(trim($dsn)), $parts)){
|
|
$conf['type'] = $parts[1];
|
|
if($conf['type'] == 'redis'){
|
|
list($conf['host'], $conf['port'], $conf['db']) = explode(':', $parts[2]) + [1 => 6379, 2 => null];
|
|
}elseif($conf['type'] == 'folder'){
|
|
$conf['folder'] = $parts[2];
|
|
}
|
|
// int cast numeric values
|
|
$conf = array_map(function($val){
|
|
return is_numeric($val) ? intval($val) : $val;
|
|
}, $conf);
|
|
}
|
|
return $matches;
|
|
}
|
|
|
|
/**
|
|
* check if a given DateTime() is within downTime range: downtime + 10m
|
|
* -> can be used for prevent logging errors during downTime
|
|
* @param \DateTime|null $dateCheck
|
|
* @return bool
|
|
*/
|
|
static function inDownTimeRange(\DateTime $dateCheck = null) : bool {
|
|
$inRange = false;
|
|
// default daily downtime 00:00am
|
|
$downTimeParts = [0, 0];
|
|
if( !empty($downTime = (string)self::getEnvironmentData('CCP_SSO_DOWNTIME')) ){
|
|
$parts = array_map('intval', explode(':', $downTime));
|
|
if(count($parts) === 2){
|
|
// well formatted DOWNTIME found in config files
|
|
$downTimeParts = $parts;
|
|
}
|
|
}
|
|
|
|
try{
|
|
// downTime Range is 10m
|
|
$downtimeLength = self::DOWNTIME_LENGTH + (2 * self::DOWNTIME_BUFFER);
|
|
$timezone = \Base::instance()->get('getTimeZone')();
|
|
|
|
// if not set -> use current time
|
|
$dateCheck = is_null($dateCheck) ? new \DateTime('now', $timezone) : $dateCheck;
|
|
$dateDowntimeStart = new \DateTime('now', $timezone);
|
|
$dateDowntimeStart->setTime($downTimeParts[0],$downTimeParts[1]);
|
|
$dateDowntimeStart->sub(new \DateInterval('PT' . self::DOWNTIME_BUFFER . 'M'));
|
|
|
|
$dateDowntimeEnd = clone $dateDowntimeStart;
|
|
$dateDowntimeEnd->add(new \DateInterval('PT' . $downtimeLength . 'M'));
|
|
|
|
$dateRange = new DateRange($dateDowntimeStart, $dateDowntimeEnd);
|
|
$inRange = $dateRange->inRange($dateCheck);
|
|
}catch(\Exception $e){
|
|
$f3 = \Base::instance();
|
|
$f3->error(500, $e->getMessage(), $e->getTrace());
|
|
}
|
|
|
|
return $inRange;
|
|
}
|
|
|
|
} |