1244 lines
49 KiB
PHP
1244 lines
49 KiB
PHP
<?php
|
||
/**
|
||
* Created by PhpStorm.
|
||
* User: exodus4d
|
||
* Date: 16.02.15
|
||
* Time: 20:23
|
||
*/
|
||
|
||
namespace Controller\Api;
|
||
use Controller;
|
||
use data\file\FileHandler;
|
||
use lib\Config;
|
||
use lib\Socket;
|
||
use Model;
|
||
use Exception;
|
||
|
||
/**
|
||
* Map controller
|
||
* Class Map
|
||
* @package Controller\Api
|
||
*/
|
||
class Map extends Controller\AccessController {
|
||
|
||
// cache keys
|
||
const CACHE_KEY_INIT = 'CACHED_INIT';
|
||
const CACHE_KEY_MAP_DATA = 'CACHED.MAP_DATA.%s';
|
||
const CACHE_KEY_USER_DATA = 'CACHED.USER_DATA.%s_%s';
|
||
const CACHE_KEY_HISTORY = 'CACHED_MAP_HISTORY_%s';
|
||
|
||
|
||
/**
|
||
* get map data cache key
|
||
* @param Model\CharacterModel $character
|
||
* @return string
|
||
*/
|
||
protected function getMapDataCacheKey(Model\CharacterModel $character): string {
|
||
return sprintf(self::CACHE_KEY_MAP_DATA, 'CHAR_' . $character->_id);
|
||
}
|
||
|
||
/**
|
||
* clear map data caching
|
||
* -> cache timings are short, this will just increase update performance on map changes
|
||
* @param Model\CharacterModel $character
|
||
*/
|
||
protected function clearMapDataCache(Model\CharacterModel $character){
|
||
$cacheKey = $this->getMapDataCacheKey($character);
|
||
if($this->getF3()->exists($cacheKey)){
|
||
$this->getF3()->clear($cacheKey);
|
||
}
|
||
}
|
||
|
||
/**
|
||
* get user data cache key
|
||
* @param int $mapId
|
||
* @param int $systemId
|
||
* @return string
|
||
*/
|
||
protected function getUserDataCacheKey($mapId, $systemId = 0): string {
|
||
return sprintf(self::CACHE_KEY_USER_DATA, 'MAP_' . $mapId, 'SYS_' . $systemId);
|
||
}
|
||
|
||
/**
|
||
* get log history data cache key
|
||
* @param int $mapId
|
||
* @return string
|
||
*/
|
||
protected function getHistoryDataCacheKey(int $mapId): string {
|
||
return sprintf(self::CACHE_KEY_HISTORY, 'MAP_' . $mapId);
|
||
}
|
||
|
||
/**
|
||
* Get all required static config data for program initialization
|
||
* @param \Base $f3
|
||
* @throws Exception
|
||
* @throws Exception\PathfinderException
|
||
*/
|
||
public function init(\Base $f3){
|
||
// expire time in seconds
|
||
$expireTimeCache = 60 * 60;
|
||
$expireTimeSQL = 60 * 60 * 12;
|
||
|
||
if( !$f3->exists(self::CACHE_KEY_INIT, $return )){
|
||
$return = (object) [];
|
||
$return->error = [];
|
||
|
||
// static program data ------------------------------------------------------------------------------------
|
||
$return->timer = Config::getPathfinderData('timer');
|
||
|
||
// get all available map types ----------------------------------------------------------------------------
|
||
$mapType = Model\BasicModel::getNew('MapTypeModel');
|
||
$rows = $mapType->find('active = 1', null, $expireTimeSQL);
|
||
|
||
// default map type config
|
||
$mapsDefaultConfig = Config::getMapsDefaultConfig();
|
||
|
||
$mapTypeData = [];
|
||
foreach((array)$rows as $rowData){
|
||
$data = [
|
||
'id' => $rowData->id,
|
||
'label' => $rowData->label,
|
||
'class' => $rowData->class,
|
||
'classTab' => $rowData->classTab,
|
||
'defaultConfig' => $mapsDefaultConfig[$rowData->name]
|
||
];
|
||
$mapTypeData[$rowData->name] = $data;
|
||
|
||
}
|
||
$return->mapTypes = $mapTypeData;
|
||
|
||
// get all available map scopes ---------------------------------------------------------------------------
|
||
$mapScope = Model\BasicModel::getNew('MapScopeModel');
|
||
$rows = $mapScope->find('active = 1', null, $expireTimeSQL);
|
||
$mapScopeData = [];
|
||
foreach((array)$rows as $rowData){
|
||
$data = [
|
||
'id' => $rowData->id,
|
||
'label' => $rowData->label
|
||
];
|
||
$mapScopeData[$rowData->name] = $data;
|
||
}
|
||
$return->mapScopes = $mapScopeData;
|
||
|
||
// get all available system status ------------------------------------------------------------------------
|
||
$systemStatus = Model\BasicModel::getNew('SystemStatusModel');
|
||
$rows = $systemStatus->find('active = 1', null, $expireTimeSQL);
|
||
$systemScopeData = [];
|
||
foreach((array)$rows as $rowData){
|
||
$data = [
|
||
'id' => $rowData->id,
|
||
'label' => $rowData->label,
|
||
'class' => $rowData->class
|
||
];
|
||
$systemScopeData[$rowData->name] = $data;
|
||
}
|
||
$return->systemStatus = $systemScopeData;
|
||
|
||
// get all available system types -------------------------------------------------------------------------
|
||
$systemType = Model\BasicModel::getNew('SystemTypeModel');
|
||
$rows = $systemType->find('active = 1', null, $expireTimeSQL);
|
||
$systemTypeData = [];
|
||
foreach((array)$rows as $rowData){
|
||
$data = [
|
||
'id' => $rowData->id,
|
||
'name' => $rowData->name
|
||
];
|
||
$systemTypeData[$rowData->name] = $data;
|
||
}
|
||
$return->systemType = $systemTypeData;
|
||
|
||
// get available connection scopes ------------------------------------------------------------------------
|
||
$connectionScope = Model\BasicModel::getNew('ConnectionScopeModel');
|
||
$rows = $connectionScope->find('active = 1', null, $expireTimeSQL);
|
||
$connectionScopeData = [];
|
||
foreach((array)$rows as $rowData){
|
||
$data = [
|
||
'id' => $rowData->id,
|
||
'label' => $rowData->label,
|
||
'connectorDefinition' => $rowData->connectorDefinition
|
||
];
|
||
$connectionScopeData[$rowData->name] = $data;
|
||
}
|
||
$return->connectionScopes = $connectionScopeData;
|
||
|
||
// get available wormhole types ---------------------------------------------------------------------------
|
||
$wormholes = Model\BasicModel::getNew('WormholeModel');
|
||
$rows = $wormholes->find('id > 0', null, $expireTimeSQL);
|
||
$wormholesData = [];
|
||
foreach((array)$rows as $rowData){
|
||
$wormholesData[$rowData->name] = $rowData->getData();
|
||
}
|
||
$return->wormholes = $wormholesData;
|
||
|
||
// get available character status -------------------------------------------------------------------------
|
||
$characterStatus = Model\BasicModel::getNew('CharacterStatusModel');
|
||
$rows = $characterStatus->find('active = 1', null, $expireTimeSQL);
|
||
$characterStatusData = [];
|
||
foreach((array)$rows as $rowData){
|
||
$data = [
|
||
'id' => $rowData->id,
|
||
'name' => $rowData->name,
|
||
'class' => $rowData->class
|
||
];
|
||
$characterStatusData[$rowData->name] = $data;
|
||
}
|
||
$return->characterStatus = $characterStatusData;
|
||
|
||
// route search config ------------------------------------------------------------------------------------
|
||
$return->routeSearch = [
|
||
'defaultCount' => Config::getPathfinderData('route.search_default_count'),
|
||
'maxDefaultCount' => Config::getPathfinderData('route.max_default_count'),
|
||
'limit' => Config::getPathfinderData('route.limit')
|
||
];
|
||
|
||
// get program routes -------------------------------------------------------------------------------------
|
||
$return->routes = [
|
||
'ssoLogin' => $this->getF3()->alias( 'sso', ['action' => 'requestAuthorization'] )
|
||
];
|
||
|
||
// get third party APIs -----------------------------------------------------------------------------------
|
||
$return->url = [
|
||
'ccpImageServer' => Config::getPathfinderData('api.ccp_image_server'),
|
||
'zKillboard' => Config::getPathfinderData('api.z_killboard')
|
||
];
|
||
|
||
// Slack integration status -------------------------------------------------------------------------------
|
||
$return->slack = [
|
||
'status' => (bool)Config::getPathfinderData('slack.status')
|
||
];
|
||
|
||
// Slack integration status -------------------------------------------------------------------------------
|
||
$return->discord = [
|
||
'status' => (bool)Config::getPathfinderData('discord.status')
|
||
];
|
||
|
||
$f3->set(self::CACHE_KEY_INIT, $return, $expireTimeCache );
|
||
}
|
||
|
||
// Add data that should not be cached =========================================================================
|
||
|
||
// program mode (e.g. "maintenance") --------------------------------------------------------------------------
|
||
$return->programMode = [
|
||
'maintenance' => Config::getPathfinderData('login.mode_maintenance')
|
||
];
|
||
|
||
// get SSO error messages that should be shown immediately ----------------------------------------------------
|
||
// -> e.g. errors while character switch from previous HTTP requests
|
||
if( $f3->exists(Controller\Ccp\Sso::SESSION_KEY_SSO_ERROR) ){
|
||
$ssoError = (object) [];
|
||
$ssoError->type = 'error';
|
||
$ssoError->title = 'Login failed';
|
||
$ssoError->message = $f3->get(Controller\Ccp\Sso::SESSION_KEY_SSO_ERROR);
|
||
$return->error[] = $ssoError;
|
||
$f3->clear(Controller\Ccp\Sso::SESSION_KEY_SSO_ERROR);
|
||
}
|
||
|
||
echo json_encode($return);
|
||
}
|
||
|
||
/**
|
||
* import new map data
|
||
* @param \Base $f3
|
||
* @throws Exception
|
||
*/
|
||
public function import(\Base $f3){
|
||
$importData = (array)$f3->get('POST');
|
||
|
||
$return = (object) [];
|
||
$return->error = [];
|
||
$return->warning = [];
|
||
|
||
if(
|
||
isset($importData['typeId']) &&
|
||
count($importData['mapData']) > 0
|
||
){
|
||
$activeCharacter = $this->getCharacter();
|
||
|
||
/**
|
||
* @var $map Model\MapModel
|
||
*/
|
||
$map = Model\BasicModel::getNew('MapModel');
|
||
|
||
/**
|
||
* @var $system Model\SystemModel
|
||
*/
|
||
$system = Model\BasicModel::getNew('SystemModel');
|
||
$system->setActivityLogging(false);
|
||
|
||
/**
|
||
* @var $connection Model\ConnectionModel
|
||
*/
|
||
$connection = Model\BasicModel::getNew('ConnectionModel');
|
||
$connection->setActivityLogging(false);
|
||
|
||
// to many systems for import
|
||
$mapTypeModel = Model\BasicModel::getNew('MapTypeModel');
|
||
$mapTypeModel->getById( (int)$importData['typeId'] );
|
||
|
||
if( !$mapTypeModel->dry() ){
|
||
$defaultConfig = Config::getMapsDefaultConfig($mapTypeModel->name);
|
||
|
||
foreach($importData['mapData'] as $mapData){
|
||
if(
|
||
isset($mapData['config']) &&
|
||
isset($mapData['data'])
|
||
){
|
||
|
||
if(
|
||
isset($mapData['data']['systems']) &&
|
||
isset($mapData['data']['connections'])
|
||
){
|
||
$systemCount = count($mapData['data']['systems']);
|
||
if( $systemCount <= $defaultConfig['max_systems']){
|
||
|
||
$map->setData($mapData['config']);
|
||
$map->typeId = (int)$importData['typeId'];
|
||
$map->save($activeCharacter);
|
||
|
||
// new system IDs will be generated
|
||
// therefore we need to temp store a mapping between IDs
|
||
$tempSystemIdMapping = [];
|
||
|
||
foreach($mapData['data']['systems'] as $systemData){
|
||
if(isset($systemData['id'])){
|
||
$oldId = (int)$systemData['id'];
|
||
|
||
$system->setData($systemData);
|
||
$system->mapId = $map;
|
||
$system->save($activeCharacter);
|
||
|
||
$tempSystemIdMapping[$oldId] = $system->id;
|
||
$system->reset();
|
||
}
|
||
}
|
||
|
||
foreach($mapData['data']['connections'] as $connectionData){
|
||
// check if source and target IDs match with new system ID
|
||
if(
|
||
isset( $tempSystemIdMapping[$connectionData['source']] ) &&
|
||
isset( $tempSystemIdMapping[$connectionData['target']] )
|
||
){
|
||
$connection->setData($connectionData);
|
||
$connection->mapId = $map;
|
||
$connection->source = $tempSystemIdMapping[$connectionData['source']];
|
||
$connection->target = $tempSystemIdMapping[$connectionData['target']];
|
||
$connection->save($activeCharacter);
|
||
|
||
$connection->reset();
|
||
}
|
||
}
|
||
|
||
// map access info should not automatically imported
|
||
if($map->isPrivate()){
|
||
$map->setAccess($activeCharacter);
|
||
}elseif($map->isCorporation()){
|
||
if($corporation = $activeCharacter->getCorporation()){
|
||
$map->setAccess($corporation);
|
||
}
|
||
}elseif($map->isAlliance()){
|
||
if($alliance = $activeCharacter->getAlliance()){
|
||
$map->setAccess($alliance);
|
||
}
|
||
}
|
||
}else{
|
||
$maxSystemsError = (object) [];
|
||
$maxSystemsError->type = 'error';
|
||
$maxSystemsError->message = 'Map has to many systems (' . $systemCount . ').'
|
||
.' Max system count is ' . $defaultConfig['max_systems'] . ' for ' . $mapTypeModel->name . ' maps.';
|
||
$return->error[] = $maxSystemsError;
|
||
}
|
||
}else{
|
||
// systems || connections missing
|
||
$missingConfigError = (object) [];
|
||
$missingConfigError->type = 'error';
|
||
$missingConfigError->message = 'Map data not valid (systems || connections) missing';
|
||
$return->error[] = $missingConfigError;
|
||
}
|
||
}else{
|
||
// map config || systems/connections missing
|
||
$missingConfigError = (object) [];
|
||
$missingConfigError->type = 'error';
|
||
$missingConfigError->message = 'Map data not valid (config || data) missing';
|
||
$return->error[] = $missingConfigError;
|
||
}
|
||
|
||
$map->reset();
|
||
}
|
||
}else{
|
||
$unknownMapType = (object) [];
|
||
$unknownMapType->type = 'error';
|
||
$unknownMapType->message = 'Map type unknown!';
|
||
$return->error[] = $unknownMapType;
|
||
}
|
||
}else{
|
||
// map data missing
|
||
$missingDataError = (object) [];
|
||
$missingDataError->type = 'error';
|
||
$missingDataError->message = 'Map data missing';
|
||
$return->error[] = $missingDataError;
|
||
}
|
||
|
||
echo json_encode($return);
|
||
}
|
||
|
||
/**
|
||
* save a new map or update an existing map
|
||
* @param \Base $f3
|
||
* @throws Exception
|
||
*/
|
||
public function save(\Base $f3){
|
||
$formData = (array)$f3->get('POST.formData');
|
||
|
||
$return = (object) [];
|
||
$return->error = [];
|
||
|
||
if( isset($formData['id']) ){
|
||
$activeCharacter = $this->getCharacter(0);
|
||
|
||
/**
|
||
* @var $map Model\MapModel
|
||
*/
|
||
$map = Model\BasicModel::getNew('MapModel');
|
||
$map->getById( (int)$formData['id'] );
|
||
|
||
if(
|
||
$map->dry() ||
|
||
$map->hasAccess($activeCharacter)
|
||
){
|
||
try{
|
||
// new map
|
||
$map->setData($formData);
|
||
$map = $map->save($activeCharacter);
|
||
|
||
$mapDefaultConf = Config::getMapsDefaultConfig();
|
||
|
||
// save global map access. Depends on map "type"
|
||
if($map->isPrivate()){
|
||
|
||
// share map between characters -> set access
|
||
if(isset($formData['mapCharacters'])){
|
||
// remove character corporation (re-add later)
|
||
$accessCharacters = array_diff($formData['mapCharacters'], [$activeCharacter->_id]);
|
||
|
||
// avoid abuse -> respect share limits
|
||
$maxShared = max($mapDefaultConf['private']['max_shared'] - 1, 0);
|
||
$accessCharacters = array_slice($accessCharacters, 0, $maxShared);
|
||
|
||
// clear map access. In case something has removed from access list
|
||
$map->clearAccess();
|
||
|
||
if($accessCharacters){
|
||
/**
|
||
* @var $tempCharacter Model\CharacterModel
|
||
*/
|
||
$tempCharacter = Model\BasicModel::getNew('CharacterModel');
|
||
|
||
foreach($accessCharacters as $characterId){
|
||
$tempCharacter->getById( (int)$characterId );
|
||
|
||
if(
|
||
!$tempCharacter->dry() &&
|
||
$tempCharacter->shared == 1 // check if map shared is enabled
|
||
){
|
||
$map->setAccess($tempCharacter);
|
||
}
|
||
|
||
$tempCharacter->reset();
|
||
}
|
||
}
|
||
}
|
||
|
||
// the current character itself should always have access
|
||
// just in case he removed himself :)
|
||
$map->setAccess($activeCharacter);
|
||
}elseif($map->isCorporation()){
|
||
$corporation = $activeCharacter->getCorporation();
|
||
|
||
if($corporation){
|
||
// the current user has to have a corporation when
|
||
// working on corporation maps!
|
||
|
||
// share map between corporations -> set access
|
||
if(isset($formData['mapCorporations'])){
|
||
// remove character corporation (re-add later)
|
||
$accessCorporations = array_diff($formData['mapCorporations'], [$corporation->_id]);
|
||
|
||
// avoid abuse -> respect share limits
|
||
$maxShared = max($mapDefaultConf['corporation']['max_shared'] - 1, 0);
|
||
$accessCorporations = array_slice($accessCorporations, 0, $maxShared);
|
||
|
||
// clear map access. In case something has removed from access list
|
||
$map->clearAccess();
|
||
|
||
if($accessCorporations){
|
||
/**
|
||
* @var $tempCorporation Model\CorporationModel
|
||
*/
|
||
$tempCorporation = Model\BasicModel::getNew('CorporationModel');
|
||
|
||
foreach($accessCorporations as $corporationId){
|
||
$tempCorporation->getById( (int)$corporationId );
|
||
|
||
if(
|
||
!$tempCorporation->dry() &&
|
||
$tempCorporation->shared == 1 // check if map shared is enabled
|
||
){
|
||
$map->setAccess($tempCorporation);
|
||
}
|
||
|
||
$tempCorporation->reset();
|
||
}
|
||
}
|
||
}
|
||
|
||
// the corporation of the current user should always have access
|
||
$map->setAccess($corporation);
|
||
}
|
||
}elseif($map->isAlliance()){
|
||
$alliance = $activeCharacter->getAlliance();
|
||
|
||
if($alliance){
|
||
// the current user has to have a alliance when
|
||
// working on alliance maps!
|
||
|
||
// share map between alliances -> set access
|
||
if(isset($formData['mapAlliances'])){
|
||
// remove character alliance (re-add later)
|
||
$accessAlliances = array_diff($formData['mapAlliances'], [$alliance->_id]);
|
||
|
||
// avoid abuse -> respect share limits
|
||
$maxShared = max($mapDefaultConf['alliance']['max_shared'] - 1, 0);
|
||
$accessAlliances = array_slice($accessAlliances, 0, $maxShared);
|
||
|
||
// clear map access. In case something has removed from access list
|
||
$map->clearAccess();
|
||
|
||
if($accessAlliances){
|
||
/**
|
||
* @var $tempAlliance Model\AllianceModel
|
||
*/
|
||
$tempAlliance = Model\BasicModel::getNew('AllianceModel');
|
||
|
||
foreach($accessAlliances as $allianceId){
|
||
$tempAlliance->getById( (int)$allianceId );
|
||
|
||
if(
|
||
!$tempAlliance->dry() &&
|
||
$tempAlliance->shared == 1 // check if map shared is enabled
|
||
){
|
||
$map->setAccess($tempAlliance);
|
||
}
|
||
|
||
$tempAlliance->reset();
|
||
}
|
||
}
|
||
}
|
||
|
||
// the alliance of the current user should always have access
|
||
$map->setAccess($alliance);
|
||
}
|
||
}
|
||
// reload the same map model (refresh)
|
||
// this makes sure all data is up2date
|
||
$map->getById( $map->_id, 0 );
|
||
|
||
|
||
$charactersData = $map->getCharactersData();
|
||
$characterIds = array_map(function ($data){
|
||
return $data->id;
|
||
}, $charactersData);
|
||
|
||
// broadcast map Access -> and send map Data
|
||
$this->broadcastMapAccess($map, $characterIds);
|
||
|
||
$return->mapData = $map->getData();
|
||
}catch(Exception\ValidationException $e){
|
||
$validationError = (object) [];
|
||
$validationError->type = 'error';
|
||
$validationError->field = $e->getField();
|
||
$validationError->message = $e->getMessage();
|
||
$return->error[] = $validationError;
|
||
}
|
||
|
||
}else{
|
||
// map access denied
|
||
$captchaError = (object) [];
|
||
$captchaError->type = 'error';
|
||
$captchaError->message = 'Access denied';
|
||
$return->error[] = $captchaError;
|
||
}
|
||
}else{
|
||
// map id field missing
|
||
$idError = (object) [];
|
||
$idError->type = 'error';
|
||
$idError->message = 'Map id missing';
|
||
$return->error[] = $idError;
|
||
}
|
||
|
||
echo json_encode($return);
|
||
}
|
||
|
||
/**
|
||
* delete a map and all dependencies
|
||
* @param \Base $f3
|
||
* @throws Exception
|
||
*/
|
||
public function delete(\Base $f3){
|
||
$mapData = (array)$f3->get('POST.mapData');
|
||
$mapId = (int)$mapData['id'];
|
||
$return = (object) [];
|
||
$return->deletedMapIds = [];
|
||
|
||
if($mapId){
|
||
$activeCharacter = $this->getCharacter();
|
||
|
||
/**
|
||
* @var $map Model\MapModel
|
||
*/
|
||
$map = Model\BasicModel::getNew('MapModel');
|
||
$map->getById($mapId);
|
||
|
||
if($map->hasAccess($activeCharacter)){
|
||
$map->setActive(false);
|
||
$map->save($activeCharacter);
|
||
$return->deletedMapIds[] = $mapId;
|
||
|
||
// broadcast map delete
|
||
$this->broadcastMapDeleted($mapId);
|
||
}
|
||
}
|
||
|
||
echo json_encode($return);
|
||
}
|
||
|
||
/**
|
||
* broadcast characters with map access rights to WebSocket server
|
||
* -> if characters with map access found -> broadcast mapData to them
|
||
* @param Model\MapModel $map
|
||
* @param array $characterIds
|
||
* @throws Exception
|
||
* @throws Exception\PathfinderException
|
||
* @throws \ZMQSocketException
|
||
*/
|
||
protected function broadcastMapAccess($map, $characterIds){
|
||
$mapAccess = [
|
||
'id' => $map->_id,
|
||
'characterIds' => $characterIds
|
||
];
|
||
|
||
(new Socket( Config::getSocketUri() ))->sendData('mapAccess', $mapAccess);
|
||
|
||
// map has (probably) active connections that should receive map Data
|
||
$this->broadcastMapData($map);
|
||
}
|
||
|
||
/**
|
||
* broadcast map delete information to clients
|
||
* @param int $mapId
|
||
* @return bool|string
|
||
* @throws \ZMQSocketException
|
||
*/
|
||
protected function broadcastMapDeleted($mapId){
|
||
return (new Socket( Config::getSocketUri() ))->sendData('mapDeleted', $mapId);
|
||
}
|
||
|
||
/**
|
||
* get map access tokens for current character
|
||
* -> send access tokens via TCP Socket for WebSocket auth
|
||
* @param \Base $f3
|
||
* @throws Exception
|
||
*/
|
||
public function getAccessData(\Base $f3){
|
||
$return = (object) [];
|
||
|
||
$activeCharacter = $this->getCharacter();
|
||
$maps = $activeCharacter->getMaps();
|
||
|
||
$return->data = [
|
||
'id' => $activeCharacter->_id,
|
||
'token' => bin2hex(random_bytes(16)), // token for character access
|
||
'mapData' => []
|
||
];
|
||
|
||
if($maps){
|
||
foreach($maps as $map){
|
||
$return->data['mapData'][] = [
|
||
'id' => $map->_id,
|
||
'token' => bin2hex(random_bytes(16)) // token for map access
|
||
];
|
||
}
|
||
}
|
||
|
||
// send Access Data to WebSocket Server and get response (status)
|
||
// if 'OK' -> Socket exists
|
||
$return->status = (new Socket( Config::getSocketUri() ))->sendData('mapConnectionAccess', $return->data);
|
||
|
||
echo json_encode( $return );
|
||
}
|
||
|
||
/**
|
||
* update map data
|
||
* -> function is called continuously (trigger) by any active client
|
||
* @param \Base $f3
|
||
* @throws Exception
|
||
* @throws Exception\PathfinderException
|
||
*/
|
||
public function updateData(\Base $f3){
|
||
$mapData = (array)$f3->get('POST.mapData');
|
||
$userDataRequired = (bool)$f3->get('POST.getUserData');
|
||
|
||
$activeCharacter = $this->getCharacter();
|
||
|
||
$cacheKey = $this->getMapDataCacheKey($activeCharacter);
|
||
|
||
// if there is any system/connection change data submitted -> save new data
|
||
if(
|
||
!empty($mapData) ||
|
||
!$f3->exists($cacheKey, $return)
|
||
){
|
||
$return = (object) [];
|
||
$return->error = [];
|
||
|
||
// get current map data ===================================================================================
|
||
$maps = $activeCharacter->getMaps();
|
||
|
||
// loop all submitted map data that should be saved
|
||
// -> currently there will only be ONE map data change submitted -> single loop
|
||
foreach($mapData as $data){
|
||
|
||
$systems = [];
|
||
$connections = [];
|
||
|
||
// check whether system data and/or connection data is send
|
||
// empty arrays are not included in ajax requests
|
||
if( isset($data['data']['systems']) ){
|
||
$systems = (array)$data['data']['systems'];
|
||
}
|
||
|
||
if( isset($data['data']['connections']) ){
|
||
$connections = (array)$data['data']['connections'];
|
||
}
|
||
|
||
// check if system data or connection data is send
|
||
if(
|
||
count($systems) > 0 ||
|
||
count($connections) > 0
|
||
){
|
||
|
||
// map changes expected ===========================================================================
|
||
|
||
// loop current user maps and check for changes
|
||
foreach($maps as $map){
|
||
$mapChanged = false;
|
||
|
||
// update system data -------------------------------------------------------------------------
|
||
foreach($systems as $i => $systemData){
|
||
|
||
// check if current system belongs to the current map
|
||
$map->filter('systems', ['id = ?', $systemData['id'] ]);
|
||
$filteredMap = $map->find(
|
||
['id = ?', $map->id ],
|
||
['limit' => 1]
|
||
);
|
||
|
||
// this should never fail
|
||
if(is_object($filteredMap)){
|
||
$filteredMap = $filteredMap->current();
|
||
|
||
// system belongs to the current map
|
||
if(is_object($filteredMap->systems)){
|
||
// update
|
||
|
||
/**
|
||
* @var $system Model\SystemModel
|
||
*/
|
||
$system = $filteredMap->systems->current();
|
||
$system->setData($systemData);
|
||
|
||
if($system->save($activeCharacter)){
|
||
$mapChanged = true;
|
||
// one system belongs to ONE map -> speed up for multiple maps
|
||
unset($systemData[$i]);
|
||
}else{
|
||
$return->error = array_merge($return->error, $system->getErrors());
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
// update connection data ---------------------------------------------------------------------
|
||
foreach($connections as $i => $connectionData){
|
||
|
||
// check if the current connection belongs to the current map
|
||
$map->filter('connections', ['id = ?', $connectionData['id'] ]);
|
||
$filteredMap = $map->find(
|
||
['id = ?', $map->id ],
|
||
['limit' => 1]
|
||
);
|
||
|
||
// this should never fail
|
||
if(is_object($filteredMap)){
|
||
$filteredMap = $filteredMap->current();
|
||
|
||
// connection belongs to the current map
|
||
if(is_object($filteredMap->connections)){
|
||
// update
|
||
|
||
/**
|
||
* @var $connection Model\ConnectionModel
|
||
*/
|
||
$connection = $filteredMap->connections->current();
|
||
$connection->setData($connectionData);
|
||
|
||
if($connection->save($activeCharacter)){
|
||
$mapChanged = true;
|
||
// one connection belongs to ONE map -> speed up for multiple maps
|
||
unset($connectionData[$i]);
|
||
}else{
|
||
$return->error = array_merge($return->error, $connection->getErrors());
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
if($mapChanged){
|
||
$this->broadcastMapData($map);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
// format map Data for return
|
||
$return->mapData = $this->getFormattedMapsData($maps);
|
||
|
||
// cache time(s) per user should be equal or less than this function is called
|
||
// prevent request flooding
|
||
$responseTTL = (int)Config::getPathfinderData('timer.update_server_map.delay') / 1000;
|
||
|
||
$f3->set($cacheKey, $return, $responseTTL);
|
||
}
|
||
|
||
// if userData is requested -> add it as well
|
||
// -> Only first trigger call should request this data!
|
||
if($userDataRequired){
|
||
$return->userData = $activeCharacter->getUser()->getData();
|
||
}
|
||
|
||
echo json_encode( $return );
|
||
}
|
||
|
||
/**
|
||
* get formatted map data
|
||
* @param Model\MapModel[] $mapModels
|
||
* @return array
|
||
* @throws Exception
|
||
* @throws Exception\PathfinderException
|
||
*/
|
||
protected function getFormattedMapsData($mapModels){
|
||
$mapData = [];
|
||
foreach($mapModels as $mapModel){
|
||
$mapData[] = $this->getFormattedMapData($mapModel);
|
||
}
|
||
|
||
return $mapData;
|
||
}
|
||
|
||
/**
|
||
* update map data api
|
||
* -> function is called continuously by any active client
|
||
* @param \Base $f3
|
||
* @throws Exception
|
||
* @throws Exception\PathfinderException
|
||
*/
|
||
public function updateUserData(\Base $f3){
|
||
$return = (object) [];
|
||
|
||
$activeCharacter = $this->getCharacter(0);
|
||
|
||
$postData = $f3->get('POST');
|
||
if( !empty($mapIds = (array)$postData['mapIds']) ){
|
||
// IMPORTANT for now -> just update a single map (save performance)
|
||
$mapId = (int)reset($mapIds);
|
||
// get map and check map access
|
||
$map = $activeCharacter->getMap( (int)$mapId);
|
||
|
||
if( !is_null($map) ){
|
||
$characterMapData = (array)$postData['characterMapData'];
|
||
|
||
// check if data for specific system is requested
|
||
$systemData = (array)$postData['systemData'];
|
||
// if data is requested extend the cache key in order to get new data
|
||
$requestSystemData = (object) [];
|
||
$requestSystemData->mapId = isset($systemData['mapId']) ? (int) $systemData['mapId'] : 0;
|
||
$requestSystemData->systemId = isset($systemData['systemData']['id']) ? (int) $systemData['systemData']['id'] : 0;
|
||
|
||
// update current location
|
||
// -> suppress temporary timeout errors
|
||
$activeCharacter = $activeCharacter->updateLog(['suppressHTTPErrors' => true]);
|
||
|
||
// check character log (current system) and manipulate map (e.g. add new system)
|
||
if( (bool)$characterMapData['mapTracking'] ){
|
||
$map = $this->updateMapData($activeCharacter, $map);
|
||
}
|
||
|
||
// get from cache
|
||
// this should happen if a user has multiple program instances running
|
||
// with the same main char
|
||
$cacheKey = $this->getUserDataCacheKey($mapId, $requestSystemData->systemId);
|
||
if( !$f3->exists($cacheKey, $return) ){
|
||
$return = (object) [];
|
||
$return->mapUserData[] = $map->getUserData();
|
||
|
||
// request signature data for a system if user has map access!
|
||
if( $mapId === $requestSystemData->mapId ){
|
||
$system = $map->getSystemById( $requestSystemData->systemId );
|
||
|
||
if( !is_null($system) ){
|
||
// data for currently selected system
|
||
$return->system = $system->getData();
|
||
$return->system->signatures = $system->getSignaturesData();
|
||
}
|
||
}
|
||
|
||
// cache time (seconds) should be equal or less than request trigger time
|
||
// prevent request flooding
|
||
$responseTTL = (int)Config::getPathfinderData('timer.update_server_user_data.delay') / 1000;
|
||
|
||
// cache response
|
||
$f3->set($cacheKey, $return, $responseTTL);
|
||
}
|
||
}
|
||
}
|
||
|
||
// get current user data -> this should not be cached because each user has different personal data
|
||
// even if they have multiple characters using the same map!
|
||
$return->userData = $activeCharacter->getUser()->getData();
|
||
|
||
// add error (if exists)
|
||
$return->error = [];
|
||
|
||
echo json_encode( $return );
|
||
}
|
||
|
||
|
||
/**
|
||
*
|
||
* @param Model\CharacterModel $character
|
||
* @param Model\MapModel $map
|
||
* @return Model\MapModel
|
||
* @throws Exception
|
||
*/
|
||
protected function updateMapData(Model\CharacterModel $character, Model\MapModel $map){
|
||
|
||
// map changed. update cache (system/connection) changed
|
||
$mapDataChanged = false;
|
||
|
||
if(
|
||
( $mapScope = $map->getScope() ) &&
|
||
( $mapScope->name != 'none' ) && // tracking is disabled for map
|
||
( $log = $character->getLog() )
|
||
){
|
||
// character is currently in a system
|
||
|
||
$sameSystem = false;
|
||
$sourceExists = true;
|
||
$targetExists = true;
|
||
|
||
// system coordinates
|
||
$systemOffsetX = 130;
|
||
$systemOffsetY = 0;
|
||
$systemPosX = 0;
|
||
$systemPosY = 30;
|
||
|
||
$sessionCharacter = $this->getSessionCharacterData();
|
||
$sourceSystemId = (int)$sessionCharacter['PREV_SYSTEM_ID'];
|
||
$targetSystemId = (int)$log->systemId;
|
||
|
||
if($sourceSystemId){
|
||
$sourceSystem = null;
|
||
$targetSystem = null;
|
||
|
||
// check if source and target systems are equal
|
||
// -> NO target system available
|
||
if($sourceSystemId === $targetSystemId){
|
||
// check if previous (solo) system is already on the map
|
||
$sourceSystem = $map->getSystemByCCPId($sourceSystemId, ['active' => 1]);
|
||
$sameSystem = true;
|
||
}else{
|
||
// check if previous (source) system is already on the map
|
||
$sourceSystem = $map->getSystemByCCPId($sourceSystemId, ['active' => 1]);
|
||
|
||
// -> check if system is already on this map
|
||
$targetSystem = $map->getSystemByCCPId( $targetSystemId, ['active' => 1]);
|
||
}
|
||
|
||
// if systems don´t already exists on map -> get "blank" systems
|
||
// -> required for system type check (e.g. wormhole, k-space)
|
||
if(
|
||
!$sourceSystem &&
|
||
$sourceSystemId
|
||
){
|
||
$sourceExists = false;
|
||
$sourceSystem = $map->getNewSystem($sourceSystemId);
|
||
}else{
|
||
// system exists -> add target to the "right"
|
||
$systemPosX = $sourceSystem->posX + $systemOffsetX;
|
||
$systemPosY = $sourceSystem->posY + $systemOffsetY;
|
||
}
|
||
|
||
if(
|
||
!$sameSystem &&
|
||
!$targetSystem
|
||
){
|
||
$targetExists = false;
|
||
$targetSystem = $map->getNewSystem($targetSystemId);
|
||
}
|
||
|
||
$addSourceSystem = false;
|
||
$addTargetSystem = false;
|
||
$addConnection = false;
|
||
|
||
switch($mapScope->name){
|
||
case 'all':
|
||
if($sameSystem){
|
||
$addSourceSystem = true;
|
||
}else{
|
||
$addSourceSystem = true;
|
||
$addTargetSystem = true;
|
||
$addConnection = true;
|
||
}
|
||
break;
|
||
case 'k-space':
|
||
if($sameSystem){
|
||
if( !$sourceSystem->isWormhole() ){
|
||
$addSourceSystem = true;
|
||
}
|
||
}elseif(
|
||
!$sourceSystem->isWormhole() ||
|
||
!$targetSystem->isWormhole()
|
||
){
|
||
$addSourceSystem = true;
|
||
$addTargetSystem = true;
|
||
$addConnection = true;
|
||
}
|
||
break;
|
||
case 'wh':
|
||
default:
|
||
if($sameSystem){
|
||
if( $sourceSystem->isWormhole() ){
|
||
$addSourceSystem = true;
|
||
}
|
||
}elseif(
|
||
$sourceSystem->isWormhole() ||
|
||
$targetSystem->isWormhole()
|
||
){
|
||
$addSourceSystem = true;
|
||
$addTargetSystem = true;
|
||
$addConnection = true;
|
||
}elseif(
|
||
!$sourceSystem->isWormhole() &&
|
||
!$targetSystem->isWormhole()
|
||
){
|
||
// check distance between systems (in jumps)
|
||
// -> if > 1 it is !very likely! a wormhole
|
||
$routeController = new Route();
|
||
$route = $routeController->searchRoute($sourceSystem->systemId, $targetSystem->systemId, 1);
|
||
|
||
if( !$route['routePossible'] ){
|
||
$addSourceSystem = true;
|
||
$addTargetSystem = true;
|
||
$addConnection = true;
|
||
}
|
||
}
|
||
break;
|
||
}
|
||
|
||
// save source system ---------------------------------------------------------------------------------
|
||
if(
|
||
$addSourceSystem &&
|
||
$sourceSystem &&
|
||
!$sourceExists
|
||
){
|
||
$sourceSystem = $map->saveSystem($sourceSystem, $character, $systemPosX, $systemPosY);
|
||
// get updated maps object
|
||
if($sourceSystem){
|
||
$map = $sourceSystem->mapId;
|
||
$sourceExists = true;
|
||
$mapDataChanged = true;
|
||
// increase system position (prevent overlapping)
|
||
$systemPosX = $sourceSystem->posX + $systemOffsetX;
|
||
$systemPosY = $sourceSystem->posY + $systemOffsetY;
|
||
}
|
||
}
|
||
|
||
// save target system ---------------------------------------------------------------------------------
|
||
if(
|
||
$addTargetSystem &&
|
||
$targetSystem &&
|
||
!$targetExists
|
||
){
|
||
$targetSystem = $map->saveSystem($targetSystem, $character, $systemPosX, $systemPosY);
|
||
// get updated maps object
|
||
if($targetSystem){
|
||
$map = $targetSystem->mapId;
|
||
$mapDataChanged = true;
|
||
$targetExists = true;
|
||
}
|
||
}
|
||
|
||
if(
|
||
$sourceExists &&
|
||
$targetExists &&
|
||
$sourceSystem &&
|
||
$targetSystem
|
||
){
|
||
$connection = $map->searchConnection( $sourceSystem, $targetSystem);
|
||
|
||
// save connection --------------------------------------------------------------------------------
|
||
if(
|
||
$addConnection &&
|
||
!$connection
|
||
){
|
||
$connection = $map->getNewConnection($sourceSystem, $targetSystem);
|
||
$connection = $map->saveConnection($connection, $character);
|
||
// get updated maps object
|
||
if($connection){
|
||
$map = $connection->mapId;
|
||
$mapDataChanged = true;
|
||
}
|
||
}
|
||
|
||
// log jump mass ----------------------------------------------------------------------------------
|
||
if(
|
||
$connection &&
|
||
$connection->isWormhole()
|
||
){
|
||
$connection->logMass($log);
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
if($mapDataChanged){
|
||
$this->clearMapDataCache($character);
|
||
$this->broadcastMapData($map);
|
||
}
|
||
|
||
return $map;
|
||
}
|
||
|
||
/**
|
||
* get connectionData
|
||
* @param \Base $f3
|
||
* @throws Exception
|
||
*/
|
||
public function getConnectionData (\Base $f3){
|
||
$postData = (array)$f3->get('POST');
|
||
|
||
$addData = (array)$postData['addData'];
|
||
$filterData = (array)$postData['filterData'];
|
||
$connectionData = [];
|
||
|
||
if($mapId = (int)$postData['mapId']){
|
||
$activeCharacter = $this->getCharacter();
|
||
|
||
/**
|
||
* @var Model\MapModel $map
|
||
*/
|
||
$map = Model\BasicModel::getNew('MapModel');
|
||
$map->getById($mapId);
|
||
|
||
if($map->hasAccess($activeCharacter)){
|
||
// get specific connections by id
|
||
$connectionIds = null;
|
||
if(is_array($postData['connectionIds'])){
|
||
$connectionIds = $postData['connectionIds'];
|
||
}
|
||
|
||
$connections = $map->getConnections($connectionIds, 'wh');
|
||
foreach($connections as $connection){
|
||
$check = true;
|
||
$data = $connection->getData(in_array('signatures', $addData), in_array('logs', $addData));
|
||
// filter result
|
||
if(in_array('signatures', $filterData) && !$data->signatures){
|
||
$check = false;
|
||
}
|
||
|
||
if(in_array('logs', $filterData) && !$data->logs){
|
||
$check = false;
|
||
}
|
||
|
||
if($check){
|
||
$connectionData[] = $data;
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
echo json_encode($connectionData);
|
||
}
|
||
|
||
/**
|
||
* get map log data
|
||
* @param \Base $f3
|
||
* @throws Exception
|
||
* @throws Exception\PathfinderException
|
||
*/
|
||
public function getLogData(\Base $f3){
|
||
$postData = (array)$f3->get('POST');
|
||
$return = (object) [];
|
||
$return->data = [];
|
||
|
||
// validate query parameters
|
||
$return->query = [
|
||
'mapId' => (int) $postData['mapId'],
|
||
'offset' => FileHandler::validateOffset( (int)$postData['offset'] ),
|
||
'limit' => FileHandler::validateLimit( (int)$postData['limit'] )
|
||
];
|
||
|
||
if($mapId = (int)$postData['mapId']){
|
||
$activeCharacter = $this->getCharacter();
|
||
|
||
/**
|
||
* @var Model\MapModel $map
|
||
*/
|
||
$map = Model\BasicModel::getNew('MapModel');
|
||
$map->getById($mapId);
|
||
|
||
if($map->hasAccess($activeCharacter)){
|
||
$cacheKey = $this->getHistoryDataCacheKey($mapId);
|
||
if($return->query['offset'] === 0){
|
||
// check cache
|
||
$return->data = $f3->get($cacheKey);
|
||
}
|
||
|
||
if(empty($return->data)){
|
||
$return->data = $map->getLogData($return->query['offset'], $return->query['limit']);
|
||
if(
|
||
$return->query['offset'] === 0 &&
|
||
!empty($return->data))
|
||
{
|
||
$f3->set($cacheKey, $return->data, (int)Config::getPathfinderData('history.cache'));
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
echo json_encode($return);
|
||
}
|
||
|
||
}
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|