TrackManiaControl/core/ManiaExchange/ManiaExchangeManager.php

372 lines
10 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
2017-03-30 20:27:57 +02:00
use ManiaControl\Files\AsyncHttpRequest;
use ManiaControl\General\UsageInformationAble;
use ManiaControl\General\UsageInformationTrait;
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-01-08 21:03:59 +01:00
2014-01-08 22:49:09 +01:00
/**
2015-01-21 20:37:25 +01:00
* Mania Exchange Manager Class
2014-01-08 22:49:09 +01:00
*
2014-05-02 17:50:30 +02:00
* @author ManiaControl Team <mail@maniacontrol.com>
2020-01-22 10:39:35 +01:00
* @copyright 2014-2020 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
*/
class ManiaExchangeManager implements UsageInformationAble {
use UsageInformationTrait;
2017-03-30 20:27:57 +02:00
/*
2014-01-08 21:03:59 +01:00
* Constants
2015-01-21 20:37:25 +01:00
* @deprecated SEARCH Constants
2014-01-08 21:03:59 +01:00
*/
2015-11-16 22:07:06 +01:00
//Search orders (prior parameter) https://api.mania-exchange.com/documents/enums#orderings
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-05-18 16:26:52 +02:00
const SEARCH_ORDER_LENGTH_SHORTEST = 14;
const SEARCH_ORDER_LENGTH_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
2017-03-06 19:03:09 +01:00
const SETTING_MX_KEY = "Mania exchange Key";
/*
* Private properties
2014-01-08 21:03:59 +01:00
*/
/** @var ManiaControl $maniaControl */
2015-01-21 17:06:18 +01:00
private $maniaControl = null;
2023-08-14 17:11:09 +02:00
private $enabled = true;
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;
2017-03-06 19:03:09 +01:00
2017-05-12 21:16:54 +02:00
//$this->maniaControl->getSettingManager()->initSetting($this, self::SETTING_MX_KEY, "");
2014-01-08 21:03:59 +01:00
}
2023-08-14 17:11:09 +02:00
/**
* Set the status of the plugin
*
* @param bool $status
*/
public function setStatus(bool $status) {
$this->enabled = $status;
}
/**
* Get the status of the plugin
*/
public function getStatus() {
return $this->enabled;
}
2014-01-15 20:40:14 +01:00
/**
* Unset Map by Mx Id
*
* @param int $mxId
2014-01-15 20:40:14 +01:00
*/
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-05-27 22:32:54 +02:00
* @param mixed $maps
2014-01-09 23:21:44 +01:00
*/
2014-05-27 22:32:54 +02:00
public function fetchManiaExchangeMapInformation($maps = null) {
2023-08-14 17:11:09 +02:00
if (!$this->enabled) return;
2014-06-14 19:45:32 +02:00
if ($maps) {
// Fetch Information for a single map
$maps = array($maps);
2014-01-15 20:40:14 +01:00
} else {
2014-06-14 19:45:32 +02:00
// Fetch Information for whole MapList
2014-08-13 11:05:52 +02:00
$maps = $this->maniaControl->getMapManager()->getMaps();
2014-01-15 18:31:06 +01:00
}
2014-08-13 11:05:52 +02:00
$mysqli = $this->maniaControl->getDatabase()->getMysqli();
2014-01-09 23:21:44 +01:00
$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
$index = 0;
foreach ($maps as &$map) {
2014-06-14 15:58:24 +02:00
if (!$map) {
// TODO: remove after resolving of error report about "non-object"
$this->maniaControl->getErrorHandler()->triggerDebugNotice('Non-Object-Map ' . $map->name);
2014-06-14 15:58:24 +02:00
continue;
}
2014-01-09 23:21:44 +01:00
/** @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);
if ($mxId) {
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
$index++;
2014-01-09 23:21:44 +01:00
2014-01-12 19:08:56 +01:00
//If Max Maplimit is reached, or string gets too long send the request
if ($index % self::MAPS_PER_MX_FETCH === 0) {
2014-01-12 22:31:50 +01:00
$mapIdString = substr($mapIdString, 0, -1);
$this->fetchMaplistByMixedUidIdString($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
if ($mapIdString) {
2014-01-12 22:31:50 +01:00
$mapIdString = substr($mapIdString, 0, -1);
$this->fetchMaplistByMixedUidIdString($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-01-14 15:15:13 +01:00
/**
* Fetch the whole Map List from MX via mixed Uid and Id Strings
2014-01-14 15:15:13 +01:00
*
* @param string $string
2014-01-14 15:15:13 +01:00
*/
public function fetchMaplistByMixedUidIdString($string) {
2023-08-14 17:11:09 +02:00
if (!$this->enabled) return;
// For TM2020
if ($this->maniaControl->getServer()->titleId == "Trackmania") {
// Get Title Prefix
$titlePrefix = "trackmania.exchange";
} else {
// Get Title Prefix
$titlePrefix = $this->maniaControl->getMapManager()->getCurrentMap()->getGame() . ".mania-exchange.com";
}
2014-01-09 23:21:44 +01:00
// compile search URL
$url = "https://{$titlePrefix}/api/maps/get_map_info/multi/{$string}";
2014-01-09 23:21:44 +01:00
2017-05-12 21:16:54 +02:00
/*if ($key = $this->maniaControl->getSettingManager()->getSettingValue($this, self::SETTING_MX_KEY)) {
2017-03-06 19:03:09 +01:00
$url .= "&key=" . $key;
2017-05-12 21:16:54 +02:00
}*/
2017-03-06 19:03:09 +01:00
2017-03-30 20:27:57 +02:00
$asyncHttpRequest = new AsyncHttpRequest($this->maniaControl, $url);
$asyncHttpRequest->setContentType(AsyncHttpRequest::CONTENT_TYPE_JSON);
$asyncHttpRequest->setCallable(function ($mapInfo, $error) use ($titlePrefix, $url) {
2014-08-25 15:33:22 +02:00
if ($error) {
trigger_error("Error: '{$error}' for Url '{$url}'");
return;
}
if (!$mapInfo) {
return;
}
$mxMapList = json_decode($mapInfo);
if ($mxMapList === null) {
trigger_error("Can't decode searched JSON Data from Url '{$url}'");
return;
}
$maps = array();
foreach ($mxMapList as $map) {
if ($map) {
$mxMapObject = new MXMapInfo($titlePrefix, $map);
if ($mxMapObject) {
array_push($maps, $mxMapObject);
}
}
}
$this->updateMapObjectsWithManiaExchangeIds($maps);
2017-03-30 20:27:57 +02:00
});
$asyncHttpRequest->getData();
2014-02-07 14:05:10 +01:00
}
2014-02-07 13:12:53 +01:00
2014-05-02 17:50:30 +02:00
/**
* Store MX Map Info in the Database and the MX Info in the Map Object
2014-05-02 17:50:30 +02:00
*
* @param array $mxMapInfos
2014-05-02 17:50:30 +02:00
*/
public function updateMapObjectsWithManiaExchangeIds(array $mxMapInfos) {
2023-08-14 17:11:09 +02:00
if (!$this->enabled) return;
2014-08-13 11:05:52 +02:00
$mysqli = $this->maniaControl->getDatabase()->getMysqli();
2014-05-02 17:50:30 +02:00
// Save map data
$saveMapQuery = "UPDATE `" . MapManager::TABLE_MAPS . "`
SET `mxid` = ?
WHERE `uid` = ?;";
$saveMapStatement = $mysqli->prepare($saveMapQuery);
if ($mysqli->error) {
trigger_error($mysqli->error);
return;
}
$saveMapStatement->bind_param('is', $mapMxId, $mapUId);
foreach ($mxMapInfos as $mxMapInfo) {
/** @var MXMapInfo $mxMapInfo */
$mapMxId = $mxMapInfo->id;
$mapUId = $mxMapInfo->uid;
$saveMapStatement->execute();
if ($saveMapStatement->error) {
trigger_error($saveMapStatement->error);
}
//Take the uid out of the vector
if (isset($this->mxIdUidVector[$mxMapInfo->id])) {
$uid = $this->mxIdUidVector[$mxMapInfo->id];
} else {
$uid = $mxMapInfo->uid;
}
2014-08-13 11:05:52 +02:00
$map = $this->maniaControl->getMapManager()->getMapByUid($uid);
2014-05-02 17:50:30 +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;
}
}
$saveMapStatement->close();
}
/**
* @deprecated
* @see \ManiaControl\ManiaExchange\ManiaExchangeManager::fetchMaplistByMixedUidIdString()
*/
public function getMaplistByMixedUidIdString($string) {
$this->fetchMaplistByMixedUidIdString($string);
return true;
}
2014-05-02 17:50:30 +02:00
/**
2014-06-14 19:08:07 +02:00
* Fetch Map Info asynchronously
2014-05-02 17:50:30 +02:00
*
* @param int $mapId
* @param callable $function
2014-05-02 17:50:30 +02:00
*/
2014-06-14 19:08:07 +02:00
public function fetchMapInfo($mapId, callable $function) {
2023-08-14 17:11:09 +02:00
if (!$this->enabled) return;
// For TM2020
if ($this->maniaControl->getServer()->titleId == "Trackmania") {
// Get Title Prefix
$titlePrefix = "trackmania.exchange";
2014-05-02 17:50:30 +02:00
} else {
// Get Title Prefix
$titlePrefix = $this->maniaControl->getMapManager()->getCurrentMap()->getGame() . ".mania-exchange.com";
}
2014-05-02 17:50:30 +02:00
// compile search URL
$url = "https://{$titlePrefix}/api/maps/get_map_info/multi/{$mapId}";
2014-05-02 17:50:30 +02:00
2017-05-12 21:16:54 +02:00
/*if ($key = $this->maniaControl->getSettingManager()->getSettingValue($this, self::SETTING_MX_KEY)) {
2017-03-06 19:03:09 +01:00
$url .= "&key=" . $key;
2017-05-12 21:16:54 +02:00
}*/
2017-03-06 19:03:09 +01:00
2017-03-30 20:27:57 +02:00
$asyncHttpRequest = new AsyncHttpRequest($this->maniaControl, $url);
$asyncHttpRequest->setContentType(AsyncHttpRequest::CONTENT_TYPE_JSON);
$asyncHttpRequest->setCallable(function ($mapInfo, $error) use (&$function, $titlePrefix, $url) {
2014-08-25 15:33:22 +02:00
$mxMapInfo = null;
if ($error) {
trigger_error($error);
} else {
$mxMapList = json_decode($mapInfo);
if (!is_array($mxMapList)) {
trigger_error('Cannot decode searched JSON data from ' . $url);
} else if (!empty($mxMapList)) {
$mxMapInfo = new MXMapInfo($titlePrefix, $mxMapList[0]);
}
}
call_user_func($function, $mxMapInfo);
2017-03-30 20:27:57 +02:00
});
$asyncHttpRequest->getData();
2014-05-02 17:50:30 +02:00
}
/**
* @param callable $function
* @param string $name
* @param string $author
* @param string $env
* @param int $maxMapsReturned
* @param int $searchOrder
* @return bool
2015-02-01 11:34:51 +01:00
* @see \ManiaControl\ManiaExchange\ManiaExchangeMapSearch
* @deprecated
*/
public function getMapsAsync(callable $function, $name = '', $author = '', $env = '', $maxMapsReturned = 100, $searchOrder = ManiaExchangeMapSearch::SEARCH_ORDER_UPDATED_NEWEST) {
$this->fetchMapsAsync($function, $name, $author, $env, $maxMapsReturned, $searchOrder);
return true;
}
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
*
* @param callable $function
* @param string $name
* @param string $author
* @param string $env
* @param int $maxMapsReturned
* @param int $sortOrder
* @deprecated
* @see \ManiaControl\ManiaExchange\ManiaExchangeMapSearch
2014-01-08 22:49:09 +01:00
*/
public function fetchMapsAsync(callable $function, $name = '', $author = '', $env = '', $maxMapsReturned = 100, $sortOrder = ManiaExchangeMapSearch::SEARCH_ORDER_UPDATED_NEWEST) {
2023-08-14 17:11:09 +02:00
if (!$this->enabled) return;
$mapSearch = new ManiaExchangeMapSearch($this->maniaControl);
$mapSearch->setMapName($name);
$mapSearch->setAuthorName($author);
$mapSearch->setMapLimit($maxMapsReturned);
$mapSearch->setPrioritySortOrder($sortOrder);
2017-03-06 19:03:09 +01:00
if ($env) {
$mapSearch->setEnvironments($env);
2014-01-08 22:49:09 +01:00
}
2014-01-09 23:21:44 +01:00
$mapSearch->fetchMapsAsync($function);
2014-01-08 21:03:59 +01:00
}
2014-06-14 15:58:24 +02:00
}