<?php
-/**
- * Uguu
- *
- * @copyright Copyright (c) 2022 Go Johansson (nokonoko) <neku@pomf.se>
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <https://www.gnu.org/licenses/>.
- */
-
-namespace Pomf\Uguu\Classes;
-
-use Exception;
+ /**
+ * Uguu
+ *
+ * @copyright Copyright (c) 2022 Go Johansson (nokonoko) <neku@pomf.se>
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+ namespace Pomf\Uguu\Classes;
+
+ use Exception;
class Upload extends Response
{
public array $fingerPrintInfo;
private mixed $Connector;
-
/**
- * @throws Exception
+ * Takes an array of files, and returns an array of arrays containing the file's temporary name,
+ * name, size, SHA1 hash, extension, and MIME type
+ *
+ * @param $files array The files array from the $_FILES superglobal.
+ *
+ * @return array An array of arrays.
+ * @throws \Exception
*/
- public function reFiles($files): array
+ public function reFiles(array $files): array
{
$this->Connector = new Connector();
$this->Connector->setDB($this->Connector->DB);
foreach ($files as $file) {
$hash = sha1_file($file['tmp_name']);
$this->FILE_INFO = [
- 'TEMP_NAME' => $file['tmp_name'],
- 'NAME' => strip_tags($file['name']),
- 'SIZE' => $file['size'],
- 'SHA1' => $hash,
- 'EXTENSION' => $this->fileExtension($file),
- 'MIME' => $this->fileMIME($file),
- 'NEW_NAME' => $this->generateName($this->fileExtension($file), $hash)
+ 'TEMP_NAME' => $file['tmp_name'],
+ 'NAME' => strip_tags($file['name']),
+ 'SIZE' => $file['size'],
+ 'SHA1' => $hash,
+ 'EXTENSION' => $this->fileExtension($file),
+ 'MIME' => $this->fileMIME($file),
];
+
+ if ($this->Connector->CONFIG['ANTI_DUPE']) {
+ $dupeResult = $this->Connector->antiDupe($hash);
+ if ($dupeResult['result']) {
+ $this->FILE_INFO['NEW_NAME'] = $dupeResult['name'];
+ }
+ }
+
+ if (!isset($this->FILE_INFO['NEW_NAME'])) {
+ $this->FILE_INFO['NEW_NAME'] = $this->generateName($this->FILE_INFO['EXTENSION']);
+ }
+
$result[] = [
- $this->FILE_INFO['TEMP_NAME'],
- $this->FILE_INFO['NAME'],
- $this->FILE_INFO['SIZE'],
- $this->FILE_INFO['SHA1'],
- $this->FILE_INFO['EXTENSION'],
- $this->FILE_INFO['MIME']
+ $this->FILE_INFO['TEMP_NAME'],
+ $this->FILE_INFO['NAME'],
+ $this->FILE_INFO['SIZE'],
+ $this->FILE_INFO['SHA1'],
+ $this->FILE_INFO['EXTENSION'],
+ $this->FILE_INFO['MIME'],
];
}
return $result;
}
- public function diverseArray($files): array
+
+ /**
+ * Takes an array of arrays and returns an array of arrays with the keys and values swapped
+ *
+ * @param $files array an array of arrays
+ *
+ * @return array ```
+ * array:2 [▼
+ * 0 => array:2 [▼
+ * 'TEMP_NAME' => 'example'
+ * 'NAME' => 'example'
+ * 'SIZE' => 'example'
+ * 'SHA1' => 'example'
+ * 'EXTENSION' => 'example'
+ * 'MIME' => 'example'
+ *
+ * ]
+ * 1 => array:2 [▼
+ * 'TEMP_NAME' => 'example'
+ * 'NAME' => 'example'
+ * 'SIZE' => 'example'
+ * 'SHA1' => 'example'
+ * 'EXTENSION' => 'example'
+ * 'MIME' => 'example'
+ * ]
+ * ]
+ * ```
+ */
+ public function diverseArray(array $files): array
{
$result = [];
foreach ($files as $key1 => $value1) {
}
/**
- * @throws Exception
+ * Takes a file, checks if it's blacklisted, moves it to the file storage, and then logs it to the database
+ *
+ * @return array An array containing the hash, name, url, and size of the file.
+ * @throws \Exception
*/
public function uploadFile(): array
{
-
- if ($this->Connector->CONFIG['RATE_LIMIT']) {
- $this->Connector->checkRateLimit($this->fingerPrintInfo);
- }
-
- if ($this->Connector->CONFIG['BLACKLIST_DB']) {
- $this->Connector->checkFileBlacklist($this->FILE_INFO);
- }
-
- if ($this->Connector->CONFIG['FILTER_MODE'] && empty($this->FILE_INFO['EXTENSION'])) {
- $this->checkMimeBlacklist();
+ switch (true) {
+ case $this->Connector->CONFIG['RATE_LIMIT']:
+ $this->Connector->checkRateLimit($this->fingerPrintInfo);
+ // Continue
+ case $this->Connector->CONFIG['BLACKLIST_DB']:
+ $this->Connector->checkFileBlacklist($this->FILE_INFO);
+ // Continue
+ case $this->Connector->CONFIG['FILTER_MODE'] && empty($this->FILE_INFO['EXTENSION']):
+ $this->checkMimeBlacklist();
+ // Continue
+ case $this->Connector->CONFIG['FILTER_MODE'] && !empty($this->FILE_INFO['EXTENSION']):
+ $this->checkMimeBlacklist();
+ $this->checkExtensionBlacklist();
+ // Continue
+ case !$this->Connector->CONFIG['LOG_IP']:
+ $this->fingerPrintInfo['ip'] = null;
+ // Continue
}
-
- if ($this->Connector->CONFIG['FILTER_MODE'] && !empty($this->FILE_INFO['EXTENSION'])) {
- $this->checkMimeBlacklist();
- $this->checkExtensionBlacklist();
- }
-
if (!is_dir($this->Connector->CONFIG['FILES_ROOT'])) {
throw new Exception('File storage path not accessible.', 500);
}
-
if (
- !move_uploaded_file($this->FILE_INFO['TEMP_NAME'], $this->Connector->CONFIG['FILES_ROOT'] .
- $this->FILE_INFO['NEW_NAME'])
+ !move_uploaded_file(
+ $this->FILE_INFO['TEMP_NAME'],
+ $this->Connector->CONFIG['FILES_ROOT'] .
+ $this->FILE_INFO['NEW_NAME'],
+ )
) {
throw new Exception('Failed to move file to destination', 500);
}
-
if (!chmod($this->Connector->CONFIG['FILES_ROOT'] . $this->FILE_INFO['NEW_NAME'], 0644)) {
throw new Exception('Failed to change file permissions', 500);
}
- if (!$this->Connector->CONFIG['LOG_IP']) {
- $this->fingerPrintInfo['ip'] = null;
- }
- $this->Connector->newIntoDB($this->FILE_INFO, $this->fingerPrintInfo);
+ $this->Connector->newIntoDB($this->FILE_INFO, $this->fingerPrintInfo);
return [
- 'hash' => $this->FILE_INFO['SHA1'],
- 'name' => $this->FILE_INFO['NAME'],
- 'url' => $this->Connector->CONFIG['FILES_URL'] . '/' . $this->FILE_INFO['NEW_NAME'],
- 'size' => $this->FILE_INFO['SIZE']
+ 'hash' => $this->FILE_INFO['SHA1'],
+ 'name' => $this->FILE_INFO['NAME'],
+ 'url' => $this->Connector->CONFIG['FILES_URL'] . '/' . $this->FILE_INFO['NEW_NAME'],
+ 'size' => $this->FILE_INFO['SIZE'],
];
}
- public function fingerPrint($files_amount): void
+ /**
+ * Takes the amount of files that are being uploaded, and creates a fingerprint of the user's IP address,
+ * user agent, and the amount of files being
+ * uploaded
+ *
+ * @param $files_amount int The amount of files that are being uploaded.
+ *
+ * @throws \Exception
+ */
+ public function fingerPrint(int $files_amount): void
{
- $this->fingerPrintInfo = [
- 'timestamp' => time(),
- 'useragent' => $_SERVER['HTTP_USER_AGENT'],
- 'ip' => $_SERVER['REMOTE_ADDR'],
- 'ip_hash' => hash('sha1', $_SERVER['REMOTE_ADDR'] . $_SERVER['HTTP_USER_AGENT']),
- 'files_amount' => $files_amount
- ];
+ if (!empty($_SERVER['HTTP_USER_AGENT'])) {
+ $USER_AGENT = filter_var($_SERVER['HTTP_USER_AGENT'], FILTER_SANITIZE_ENCODED);
+ $this->fingerPrintInfo = [
+ 'timestamp' => time(),
+ 'useragent' => $USER_AGENT,
+ 'ip' => $_SERVER['REMOTE_ADDR'],
+ 'ip_hash' => hash('sha1', $_SERVER['REMOTE_ADDR'] . $USER_AGENT),
+ 'files_amount' => $files_amount,
+ ];
+ } else {
+ throw new Exception('Invalid user agent.', 500);
+ }
}
-
- public function fileMIME($file): string
+ /**
+ * Returns the MIME type of a file
+ *
+ * @param $file array The file to be checked.
+ *
+ * @return string The MIME type of the file.
+ */
+ public function fileMIME(array $file): string
{
- $finfo = finfo_open(FILEINFO_MIME_TYPE);
- return finfo_file($finfo, $file['tmp_name']);
+ $FILE_INFO = finfo_open(FILEINFO_MIME_TYPE);
+ return finfo_file($FILE_INFO, $file['tmp_name']);
}
- public function fileExtension($file): ?string
+ /**
+ * It takes an array of strings, and returns the last two strings joined by a dot,
+ * unless the last two strings are in the array of strings in the
+ * `DOUBLE_DOTS_EXTENSIONS` config variable, in which case it returns the last string
+ *
+ * @param $extension array The extension of the file.
+ *
+ * @return string The last two elements of the array are joined together and returned.
+ */
+ public function doubleDotExtension(array $extension): string
{
- $extension = explode('.', $file['name']);
- if (substr_count($file['name'], '.') > 0) {
- return end($extension);
+ $doubleDotArray = array_slice($extension, -2, 2);
+ $doubleDot = strtolower(preg_replace('/[^a-zA-Z.]/', '', join('.', $doubleDotArray)));
+ if (in_array($doubleDot, $this->Connector->CONFIG['DOUBLE_DOTS_EXTENSIONS'])) {
+ return $doubleDot;
} else {
- return null;
+ return end($extension);
}
}
+ /**
+ * Takes a file and returns the file extension
+ *
+ * @param $file array The file you want to get the extension from.
+ *
+ * @return string The file extension of the file.
+ */
+ public function fileExtension(array $file): string
+ {
+ $extension = explode('.', $file['name']);
+ $dotCount = substr_count($file['name'], '.');
+ return match ($dotCount) {
+ 0 => null,
+ 1 => end($extension),
+ 2 => $this->doubleDotExtension($extension)
+ };
+ }
/**
- * @throws Exception
+ * > Check if the file's MIME type is in the blacklist
+ *
+ * @throws \Exception
*/
public function checkMimeBlacklist(): void
{
}
/**
- * Check if file extension is blacklisted
- * if it does throw an exception.
+ * > Check if the file extension is in the blacklist
*
- * @throws Exception
+ * @throws \Exception
*/
public function checkExtensionBlacklist(): void
{
}
/**
- * @throws Exception
+ * Generates a random string of characters, checks if it exists in the database,
+ * and if it does, it generates another one
+ *
+ * @param $extension string The file extension.
+ * @param $hash string The hash of the file.
+ *
+ * @return string A string
+ * @throws \Exception
*/
- public function generateName($extension, $hash): string
+ public function generateName(string $extension): string
{
- $a = $this->Connector->antiDupe($hash);
- if ($a === true) {
- do {
- if ($this->Connector->CONFIG['FILES_RETRIES'] === 0) {
- throw new Exception('Gave up trying to find an unused name!', 500);
- }
-
- $NEW_NAME = '';
- for ($i = 0; $i < $this->Connector->CONFIG['NAME_LENGTH']; ++$i) {
- $NEW_NAME .= $this->Connector->CONFIG['ID_CHARSET']
- [mt_rand(0, strlen($this->Connector->CONFIG['ID_CHARSET']))];
- }
-
- if (!is_null($extension)) {
- $NEW_NAME .= '.' . $extension;
- }
- } while ($this->Connector->dbCheckNameExists($NEW_NAME) > 0);
+ do {
+ if ($this->Connector->CONFIG['FILES_RETRIES'] === 0) {
+ throw new Exception('Gave up trying to find an unused name!', 500);
+ }
+ $NEW_NAME = '';
+ $count = strlen($this->Connector->CONFIG['ID_CHARSET']);
+ while ($this->Connector->CONFIG['NAME_LENGTH']--) {
+ $NEW_NAME .= $this->Connector->CONFIG['ID_CHARSET'][mt_rand(0, $count - 1)];
+ }
+ if (!empty($extension)) {
+ $NEW_NAME .= '.' . $extension;
+ }
+ } while ($this->Connector->dbCheckNameExists($NEW_NAME) > 0);
return $NEW_NAME;
- } else {
- return $a;
- }
}
}
projects / uguu.git / blobdiff