TrackManiaControl/application/core/ManiaExchange/ManiaExchangeManager.php

366 lines
9.2 KiB
PHP
Raw Normal View History

2014-01-08 21:03:59 +01:00
<?php
2014-01-09 22:08:34 +01:00
2014-01-28 15:56:50 +01:00
namespace ManiaControl\ManiaExchange;
2014-01-08 21:03:59 +01:00
use ManiaControl\ManiaControl;
2014-01-28 15:56:50 +01:00
use ManiaControl\Maps\Map;
use ManiaControl\Maps\MapManager;
2014-04-29 21:06:38 +02:00
use Maniaplanet\DedicatedServer\Xmlrpc\NotInScriptModeException;
2014-01-08 21:03:59 +01:00
2014-01-08 22:49:09 +01:00
/**
* Mania Exchange Info Searcher Class
*
2014-04-29 21:06:38 +02:00
* @author steeffeen & kremsy
* @copyright ManiaControl Copyright © 2014 ManiaControl Team
2014-04-29 21:06:38 +02:00
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
2014-01-08 22:49:09 +01:00
*/
2014-04-29 21:06:38 +02:00
class ManiaExchangeManager {
/*
2014-01-08 21:03:59 +01:00
* Constants
*/
2014-01-14 15:15:13 +01:00
//Search others
2014-01-09 23:21:44 +01:00
const SEARCH_ORDER_NONE = -1;
const SEARCH_ORDER_TRACK_NAME = 0;
const SEARCH_ORDER_AUTHOR = 1;
const SEARCH_ORDER_UPLOADED_NEWEST = 2;
const SEARCH_ORDER_UPLOADED_OLDEST = 3;
const SEARCH_ORDER_UPDATED_NEWEST = 4;
const SEARCH_ORDER_UPDATED_OLDEST = 5;
const SEARCH_ORDER_ACTIVITY_LATEST = 6;
const SEARCH_ORDER_ACTIVITY_OLDEST = 7;
const SEARCH_ORDER_AWARDS_MOST = 8;
const SEARCH_ORDER_AWARDS_LEAST = 9;
const SEARCH_ORDER_COMMENTS_MOST = 10;
const SEARCH_ORDER_COMMENTS_LEAST = 11;
2014-01-08 22:49:09 +01:00
const SEARCH_ORDER_DIFFICULTY_EASIEST = 12;
const SEARCH_ORDER_DIFFICULTY_HARDEST = 13;
2014-01-09 23:21:44 +01:00
const SEARCH_ORDER_LENGHT_SHORTEST = 14;
const SEARCH_ORDER_LENGHT_LONGEST = 15;
2014-01-14 15:15:13 +01:00
//Maximum Maps per request
const MAPS_PER_MX_FETCH = 50;
2014-01-12 19:08:56 +01:00
2014-04-29 21:06:38 +02:00
const MIN_EXE_BUILD = "2014-04-01_00_00";
2014-03-27 18:40:13 +01:00
/*
* Private Properties
2014-01-08 21:03:59 +01:00
*/
private $maniaControl = null;
2014-01-11 22:06:52 +01:00
private $mxIdUidVector = array();
2014-01-08 21:03:59 +01:00
/**
* Construct map manager
*
* @param \ManiaControl\ManiaControl $maniaControl
*/
public function __construct(ManiaControl $maniaControl) {
$this->maniaControl = $maniaControl;
}
2014-01-09 23:21:44 +01:00
/**
* Store Map Info from MX and store the mxid in the database and the mx info in the map object
*
* @param $mxMapInfos
*/
2014-01-12 17:15:59 +01:00
public function updateMapObjectsWithManiaExchangeIds($mxMapInfos) {
2014-01-09 22:08:34 +01:00
$mysqli = $this->maniaControl->database->mysqli;
2014-01-09 23:21:44 +01:00
// Save map data
$saveMapQuery = "UPDATE `" . MapManager::TABLE_MAPS . "`
SET `mxid` = ?
2014-01-12 21:39:27 +01:00
WHERE `uid` = ?;";
2014-01-09 23:21:44 +01:00
$saveMapStatement = $mysqli->prepare($saveMapQuery);
2014-01-28 15:56:50 +01:00
if ($mysqli->error) {
2014-01-09 23:21:44 +01:00
trigger_error($mysqli->error);
return;
}
2014-04-30 05:42:27 +02:00
$saveMapStatement->bind_param('is', $mapMxId, $mapUId);
2014-01-09 23:21:44 +01:00
foreach($mxMapInfos as $mxMapInfo) {
/** @var MXMapInfo $mxMapInfo */
2014-04-30 05:42:27 +02:00
$mapMxId = $mxMapInfo->id;
2014-04-30 15:22:30 +02:00
$mapUId = $mxMapInfo->uid;
2014-01-09 23:21:44 +01:00
$saveMapStatement->execute();
2014-01-28 15:56:50 +01:00
if ($saveMapStatement->error) {
2014-01-09 23:21:44 +01:00
trigger_error($saveMapStatement->error);
}
2014-01-11 22:06:52 +01:00
//Take the uid out of the vector
2014-01-28 15:56:50 +01:00
if (isset($this->mxIdUidVector[$mxMapInfo->id])) {
2014-01-11 22:06:52 +01:00
$uid = $this->mxIdUidVector[$mxMapInfo->id];
} else {
$uid = $mxMapInfo->uid;
}
$map = $this->maniaControl->mapManager->getMapByUid($uid);
2014-04-30 05:42:27 +02:00
if ($map) {
// TODO: how does it come that $map can be empty here? we got an error report for that
/** @var Map $map */
$map->mx = $mxMapInfo;
}
2014-01-09 23:21:44 +01:00
}
$saveMapStatement->close();
}
2014-01-15 20:40:14 +01:00
/**
* Unset Map by Mx Id
*
* @param $mxId
*/
public function unsetMap($mxId) {
2014-03-13 18:25:29 +01:00
if (isset($this->mxIdUidVector[$mxId])) {
unset($this->mxIdUidVector[$mxId]);
}
2014-01-15 20:40:14 +01:00
}
2014-01-15 18:31:06 +01:00
2014-01-09 23:21:44 +01:00
/**
* Fetch Map Information from Mania Exchange
2014-01-15 20:40:14 +01:00
*
2014-01-15 18:31:06 +01:00
* @param null $map
2014-01-09 23:21:44 +01:00
*/
2014-01-15 18:31:06 +01:00
public function fetchManiaExchangeMapInformations($map = null) {
2014-01-28 15:56:50 +01:00
if (!$map) {
2014-01-15 18:31:06 +01:00
//Fetch Informations for whole Maplist
2014-01-15 20:40:14 +01:00
$maps = $this->maniaControl->mapManager->getMaps();
} else {
2014-01-15 18:31:06 +01:00
//Fetch Information for a single map
$maps[] = $map;
}
2014-01-09 23:21:44 +01:00
$mysqli = $this->maniaControl->database->mysqli;
$mapIdString = '';
2014-01-09 22:08:34 +01:00
// Fetch mx ids
2014-01-09 23:21:44 +01:00
$fetchMapQuery = "SELECT `mxid`, `changed` FROM `" . MapManager::TABLE_MAPS . "`
2014-01-09 22:08:34 +01:00
WHERE `index` = ?;";
$fetchMapStatement = $mysqli->prepare($fetchMapQuery);
2014-01-28 15:56:50 +01:00
if ($mysqli->error) {
2014-01-09 22:08:34 +01:00
trigger_error($mysqli->error);
return;
2014-01-09 21:37:01 +01:00
}
2014-01-09 23:21:44 +01:00
$id = 0;
foreach($maps as $map) {
/** @var Map $map */
$fetchMapStatement->bind_param('i', $map->index);
2014-01-09 22:08:34 +01:00
$fetchMapStatement->execute();
2014-01-28 15:56:50 +01:00
if ($fetchMapStatement->error) {
2014-01-09 22:08:34 +01:00
trigger_error($fetchMapStatement->error);
continue;
}
$fetchMapStatement->store_result();
2014-01-09 23:21:44 +01:00
$fetchMapStatement->bind_result($mxId, $changed);
2014-01-09 22:08:34 +01:00
$fetchMapStatement->fetch();
$fetchMapStatement->free_result();
2014-01-09 23:21:44 +01:00
//Set changed time into the map object
$map->lastUpdate = strtotime($changed);
2014-01-28 15:56:50 +01:00
if ($mxId != 0) {
2014-01-12 19:08:56 +01:00
$appendString = $mxId . ',';
2014-01-11 22:06:52 +01:00
//Set the mx id to the mxidmapvektor
$this->mxIdUidVector[$mxId] = $map->uid;
} else {
2014-01-12 19:08:56 +01:00
$appendString = $map->uid . ',';
2014-01-11 22:06:52 +01:00
}
2014-01-09 23:21:44 +01:00
$id++;
2014-01-12 19:08:56 +01:00
//If Max Maplimit is reached, or string gets too long send the request
2014-01-28 15:56:50 +01:00
if ($id % self::MAPS_PER_MX_FETCH == 0) {
2014-01-12 22:31:50 +01:00
$mapIdString = substr($mapIdString, 0, -1);
2014-02-07 12:30:53 +01:00
$this->getMaplistByMixedUidIdString($mapIdString);
2014-01-09 23:21:44 +01:00
$mapIdString = '';
}
2014-01-12 19:08:56 +01:00
$mapIdString .= $appendString;
2014-01-09 21:32:17 +01:00
}
2014-01-09 23:21:44 +01:00
2014-01-28 15:56:50 +01:00
if ($mapIdString != '') {
2014-01-12 22:31:50 +01:00
$mapIdString = substr($mapIdString, 0, -1);
2014-02-07 12:30:53 +01:00
$this->getMaplistByMixedUidIdString($mapIdString);
2014-01-09 23:21:44 +01:00
}
2014-01-09 22:08:34 +01:00
$fetchMapStatement->close();
2014-01-09 23:21:44 +01:00
}
2014-02-07 17:53:09 +01:00
/**
* Get Map Info Asynchronously
*
* @param $id
* @param $function
* @return bool
*/
public function getMapInfo($id, $function) {
2014-03-12 13:07:02 +01:00
// Get Title Prefix
$titlePrefix = $this->maniaControl->mapManager->getCurrentMap()->getGame();
2014-02-07 17:53:09 +01:00
// compile search URL
$url = 'http://api.mania-exchange.com/' . $titlePrefix . '/maps/?ids=' . $id;
return $this->maniaControl->fileReader->loadFile($url, function ($mapInfo, $error) use (&$function, $titlePrefix, $url) {
$mxMapInfo = null;
if ($error) {
trigger_error($error);
} else {
$mxMapList = json_decode($mapInfo);
if ($mxMapList === null) {
trigger_error('Cannot decode searched JSON data from ' . $url);
} else {
$mxMapInfo = new MXMapInfo($titlePrefix, $mxMapList[0]);
}
}
call_user_func($function, $mxMapInfo);
}, "application/json");
}
2014-01-09 23:21:44 +01:00
2014-02-07 13:12:53 +01:00
2014-01-14 15:15:13 +01:00
/**
2014-02-07 17:27:09 +01:00
* Get the Whole MapList from MX by Mixed Uid and Id String fetch
2014-01-14 15:15:13 +01:00
*
* @param $string
* @return array|null
*/
2014-01-09 23:21:44 +01:00
public function getMaplistByMixedUidIdString($string) {
2014-03-12 13:07:02 +01:00
// Get Title Prefix
$titlePrefix = $this->maniaControl->mapManager->getCurrentMap()->getGame();
2014-01-09 23:21:44 +01:00
// compile search URL
2014-01-12 22:24:30 +01:00
$url = 'http://api.mania-exchange.com/' . $titlePrefix . '/maps/?ids=' . $string;
2014-01-09 23:21:44 +01:00
2014-03-19 10:54:21 +01:00
$thisRef = $this;
$success = $this->maniaControl->fileReader->loadFile($url, function ($mapInfo, $error) use ($thisRef, $titlePrefix, $url) {
2014-02-07 17:27:09 +01:00
if ($error) {
2014-02-08 16:58:12 +01:00
trigger_error($error . " " . $url);
2014-02-07 17:27:09 +01:00
return null;
}
2014-01-09 23:21:44 +01:00
2014-03-19 10:54:21 +01:00
if (!$mapInfo) {
2014-02-15 16:33:48 +01:00
return null;
}
2014-04-29 21:06:38 +02:00
2014-02-07 17:27:09 +01:00
$mxMapList = json_decode($mapInfo);
if ($mxMapList === null) {
trigger_error('Cannot decode searched JSON data from ' . $url);
return null;
}
2014-01-09 23:21:44 +01:00
2014-02-07 17:27:09 +01:00
$maps = array();
foreach($mxMapList as $map) {
if ($map) {
2014-02-13 21:14:56 +01:00
$mxMapObject = new MXMapInfo($titlePrefix, $map);
if ($mxMapObject) {
2014-02-13 21:14:56 +01:00
array_push($maps, $mxMapObject);
}
2014-02-07 12:30:53 +01:00
}
2014-02-07 17:27:09 +01:00
}
2014-02-07 12:30:53 +01:00
2014-03-19 10:54:21 +01:00
$thisRef->updateMapObjectsWithManiaExchangeIds($maps);
2014-02-07 17:27:09 +01:00
return true;
}, "application/json");
2014-02-07 12:30:53 +01:00
return $success;
2014-02-07 14:05:10 +01:00
}
2014-02-07 13:12:53 +01:00
2014-01-08 22:49:09 +01:00
/**
2014-02-07 17:27:09 +01:00
* Fetch a MapList Asynchronously
2014-01-08 22:49:09 +01:00
*
2014-02-07 17:27:09 +01:00
* @param $function
2014-01-08 22:49:09 +01:00
* @param string $name
* @param string $author
* @param string $env
2014-01-09 23:21:44 +01:00
* @param int $maxMapsReturned
* @param int $searchOrder
2014-02-07 17:27:09 +01:00
* @return bool
2014-01-08 22:49:09 +01:00
*/
2014-02-07 17:27:09 +01:00
public function getMapsAsync($function, $name = '', $author = '', $env = '', $maxMapsReturned = 100, $searchOrder = self::SEARCH_ORDER_UPDATED_NEWEST) {
if (!is_callable($function)) {
$this->maniaControl->log("Function is not callable");
return false;
}
2014-01-09 22:08:34 +01:00
// Get Title Id
2014-01-09 23:21:44 +01:00
$titleId = $this->maniaControl->server->titleId;
2014-03-12 13:07:02 +01:00
$titlePrefix = $this->maniaControl->mapManager->getCurrentMap()->getGame();
2014-01-09 23:21:44 +01:00
2014-01-08 21:03:59 +01:00
// compile search URL
2014-03-27 18:40:13 +01:00
$url = 'http://' . $titlePrefix . '.mania-exchange.com/tracksearch2/search?api=on';
2014-01-09 23:21:44 +01:00
2014-03-13 18:25:29 +01:00
$game = explode('@', $titleId);
2014-03-01 12:58:08 +01:00
$envNumber = $this->getEnvironment($game[0]);
2014-03-13 18:25:29 +01:00
if ($env != '' || $envNumber != -1) {
2014-03-01 12:58:08 +01:00
$url .= '&environments=' . $envNumber;
2014-01-08 21:03:59 +01:00
}
2014-01-28 15:56:50 +01:00
if ($name != '') {
2014-01-09 23:58:47 +01:00
$url .= '&trackname=' . str_replace(" ", "%20", $name);
2014-01-08 22:49:09 +01:00
}
2014-01-28 15:56:50 +01:00
if ($author != '') {
2014-01-08 22:49:09 +01:00
$url .= '&author=' . $author;
}
2014-01-09 23:21:44 +01:00
2014-01-08 21:03:59 +01:00
$url .= '&priord=' . $searchOrder;
2014-01-08 22:49:09 +01:00
$url .= '&limit=' . $maxMapsReturned;
2014-01-09 23:21:44 +01:00
2014-04-30 15:29:12 +02:00
if ($titlePrefix != "tm") {
$url .= '&minexebuild=' . self::MIN_EXE_BUILD;
}
2014-02-13 00:26:18 +01:00
// Get MapTypes
try {
$scriptInfos = $this->maniaControl->client->getModeScriptInfo();
$mapTypes = $scriptInfos->compatibleMapTypes;
$url .= '&mtype=' . $mapTypes;
2014-04-29 21:06:38 +02:00
} catch(NotInScriptModeException $e) {
2014-02-13 00:26:18 +01:00
}
2014-01-09 23:21:44 +01:00
2014-02-27 23:09:19 +01:00
$success = $this->maniaControl->fileReader->loadFile($url, function ($mapInfo, $error) use (&$function, $titlePrefix) {
2014-02-07 17:27:09 +01:00
if ($error) {
trigger_error($error);
return null;
2014-01-14 13:57:10 +01:00
}
2014-01-09 23:21:44 +01:00
2014-02-07 17:27:09 +01:00
$mxMapList = json_decode($mapInfo);
2014-03-27 18:40:13 +01:00
if (!isset($mxMapList->results)) {
trigger_error('Cannot decode searched JSON data');
return null;
}
$mxMapList = $mxMapList->results;
2014-02-07 17:27:09 +01:00
if ($mxMapList === null) {
trigger_error('Cannot decode searched JSON data');
return null;
}
2014-01-09 23:21:44 +01:00
2014-02-07 17:27:09 +01:00
$maps = array();
foreach($mxMapList as $map) {
if (!empty($map)) {
array_push($maps, new MXMapInfo($titlePrefix, $map));
}
2014-01-08 21:52:42 +01:00
}
2014-02-07 17:27:09 +01:00
call_user_func($function, $maps);
return true;
2014-02-27 23:09:19 +01:00
}, "application/json");
2014-02-07 17:27:09 +01:00
return $success;
2014-01-08 21:03:59 +01:00
}
2014-01-14 15:15:13 +01:00
/**
* Gets the Current Environment by String
2014-01-14 15:15:13 +01:00
*
* @param $env
* @return int
*/
2014-01-08 21:03:59 +01:00
private function getEnvironment($env) {
2014-01-09 23:21:44 +01:00
switch($env) {
2014-01-08 21:03:59 +01:00
case 'TMCanyon':
return 1;
case 'TMStadium':
return 2;
case 'TMValley':
return 3;
default:
return -1;
}
}
2014-01-28 15:56:50 +01:00
}