TrackManiaControl/application/core/Files/FileUtil.php

192 lines
4.8 KiB
PHP
Raw Normal View History

<?php
2014-02-07 00:26:32 +01:00
namespace ManiaControl\Files;
2014-05-02 17:40:47 +02:00
use ManiaControl\ManiaControl;
2014-05-15 13:04:05 +02:00
use ManiaControl\Utils\Formatter;
/**
* Files Utility Class
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-27 02:42:39 +01:00
abstract class FileUtil {
/**
* Load a remote file
2014-05-02 17:40:47 +02:00
*
* @param string $url
2013-12-27 21:10:53 +01:00
* @param string $contentType
2014-05-24 21:49:38 +02:00
* @return string
*/
2013-12-27 21:10:53 +01:00
public static function loadFile($url, $contentType = 'UTF-8') {
if (!$url) {
return null;
}
2014-05-02 17:40:47 +02:00
$urlData = parse_url($url);
$port = (isset($urlData['port']) ? $urlData['port'] : 80);
2014-05-24 21:49:38 +02:00
$urlQuery = (isset($urlData['query']) ? '?' . $urlData['query'] : '');
2014-05-02 17:40:47 +02:00
$fsock = fsockopen($urlData['host'], $port);
stream_set_timeout($fsock, 3);
2014-05-02 17:40:47 +02:00
2014-02-07 12:30:53 +01:00
$query = 'GET ' . $urlData['path'] . $urlQuery . ' HTTP/1.0' . PHP_EOL;
$query .= 'Host: ' . $urlData['host'] . PHP_EOL;
2013-12-27 21:10:53 +01:00
$query .= 'Content-Type: ' . $contentType . PHP_EOL;
$query .= 'User-Agent: ManiaControl v' . ManiaControl::VERSION . PHP_EOL;
$query .= PHP_EOL;
2014-05-02 17:40:47 +02:00
fwrite($fsock, $query);
2014-05-02 17:40:47 +02:00
$buffer = '';
2014-05-02 17:40:47 +02:00
$info = array('timed_out' => false);
while (!feof($fsock) && !$info['timed_out']) {
$buffer .= fread($fsock, 1024);
$info = stream_get_meta_data($fsock);
}
fclose($fsock);
2014-05-02 17:40:47 +02:00
if ($info['timed_out'] || !$buffer) {
return null;
}
2014-05-24 21:49:38 +02:00
if (substr($buffer, 9, 3) != '200') {
return null;
}
2014-05-02 17:40:47 +02:00
$result = explode("\r\n\r\n", $buffer, 2);
if (count($result) < 2) {
return null;
}
2014-05-02 17:40:47 +02:00
return $result[1];
}
2014-01-06 14:22:48 +01:00
/**
* Load config xml-file
2014-05-02 17:40:47 +02:00
*
2014-01-06 14:22:48 +01:00
* @param string $fileName
* @return \SimpleXMLElement
*/
public static function loadConfig($fileName) {
2014-05-03 21:47:53 +02:00
$fileLocation = ManiaControlDir . 'configs' . DIRECTORY_SEPARATOR . $fileName;
if (!file_exists($fileLocation)) {
2014-05-15 13:04:05 +02:00
logMessage("Config File doesn't exist! ({$fileName})");
return null;
}
if (!is_readable($fileLocation)) {
2014-05-15 13:04:05 +02:00
logMessage("Config File isn't readable! Please check the File Permissions. ({$fileName})");
return null;
}
return simplexml_load_file($fileLocation);
}
2013-11-27 02:42:39 +01:00
/**
* Return file name cleared from special characters
2014-05-02 17:40:47 +02:00
*
2014-01-06 14:22:48 +01:00
* @param string $fileName
2013-11-27 02:42:39 +01:00
* @return string
*/
public static function getClearedFileName($fileName) {
2014-03-31 21:04:15 +02:00
$fileName = Formatter::stripCodes($fileName);
$fileName = str_replace(array('\\', '/', ':', '*', '?', '"', '<', '>', '|'), '_', $fileName);
$fileName = preg_replace('/[^[:print:]]/', '', $fileName);
2014-03-31 21:04:15 +02:00
return $fileName;
2013-11-27 02:42:39 +01:00
}
2014-05-02 17:40:47 +02:00
/**
* Delete the Temporary Folder if it's empty
*
* @return bool
*/
public static function removeTempFolder() {
$tempFolder = self::getTempFolder(false);
return @rmdir($tempFolder);
}
/**
* Get the Temporary Folder and create it if necessary
2014-05-02 17:40:47 +02:00
*
* @param bool $createIfNecessary
* @return string
*/
public static function getTempFolder($createIfNecessary = true) {
2014-05-24 21:49:38 +02:00
$tempFolder = ManiaControlDir . 'temp' . DIRECTORY_SEPARATOR;
if ($createIfNecessary && !is_dir($tempFolder)) {
mkdir($tempFolder);
}
return $tempFolder;
}
/**
* Check if ManiaControl has sufficient Access to write to Files in the given Directories
2014-05-02 17:40:47 +02:00
*
* @param mixed $directories
* @return bool
*/
public static function checkWritePermissions($directories) {
if (!is_array($directories)) {
$directories = array($directories);
}
2014-05-02 17:40:47 +02:00
foreach ($directories as $directory) {
$dir = new \RecursiveDirectoryIterator(ManiaControlDir . $directory);
foreach (new \RecursiveIteratorIterator($dir) as $fileName => $file) {
if (substr($fileName, 0, 1) === '.') {
continue;
}
if (!is_writable($fileName)) {
$message = "Write-Access missing for File '{$fileName}'!";
2014-05-02 15:12:28 +02:00
logMessage($message);
return false;
}
}
}
2014-05-02 17:40:47 +02:00
return true;
}
2014-05-03 21:47:53 +02:00
/**
* Try to delete the given Plugin Files
*
* @param mixed $pluginFileNames
*/
public static function cleanPluginFiles($pluginFileNames) {
$pluginFileNames = self::buildFileNamesArray($pluginFileNames);
$fileNames = array();
foreach ($pluginFileNames as $pluginFileName) {
$fileName = 'plugins' . DIRECTORY_SEPARATOR . $pluginFileName;
array_push($fileNames, $fileName);
}
self::cleanFiles($fileNames);
}
/**
* Make sure we're dealing with an Array of File Names
*
* @param mixed $fileNamesParam
* @return array
*/
private static function buildFileNamesArray($fileNamesParam) {
if (!is_array($fileNamesParam)) {
$fileNamesParam = array($fileNamesParam);
}
return $fileNamesParam;
}
/**
* Try to delete the given Files
*
* @param mixed $fileNames
*/
public static function cleanFiles($fileNames) {
$fileNames = self::buildFileNamesArray($fileNames);
foreach ($fileNames as $fileName) {
$filePath = ManiaControlDir . $fileName;
if (file_exists($filePath) && is_writeable($filePath)) {
unlink($filePath);
}
}
}
}