| Server IP : 66.29.137.217 / Your IP : 3.144.225.144 Web Server : LiteSpeed System : Linux premium294.web-hosting.com 4.18.0-513.11.1.lve.el8.x86_64 #1 SMP Thu Jan 18 16:21:02 UTC 2024 x86_64 User : gltevjme ( 1095) PHP Version : 7.0.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/gltevjme/greatlifehub.ng/glfiles.name.ng/app/helpers/ |
Upload File : |
<?php
namespace App\Helpers;
use App\Core\Database;
use App\Models\File;
use App\Models\FileAction;
/**
* main file action class
*/
class FileActionHelper
{
public $errorMsg = null;
/**
* Queue file to be deleted.
*
* @param int $serverId
* @param string $filePath
* @param int|null $fileId
* @param string|null $actionDate
* @param bool $isUploadedFile
* @param null $artifactId
* @return \App\Core\Model
*/
static function queueDeleteFile(int $serverId, string $filePath = '', int $fileId = null, string $actionDate = null, bool $isUploadedFile = false, $artifactId = null) {
// if no action date passed, assume it needs to be done straight away
if ($actionDate == null) {
$actionDate = CoreHelper::sqlDateTime();
}
// create our FileAction object
$fileAction = FileAction::create();
$fileAction->file_id = $fileId;
$fileAction->artifact_id = $artifactId;
$fileAction->server_id = $serverId;
$fileAction->file_path = $filePath;
$fileAction->is_uploaded_file = (int) $isUploadedFile;
$fileAction->file_action = 'delete';
$fileAction->status = 'pending';
$fileAction->date_created = CoreHelper::sqlDateTime();
$fileAction->action_date = $actionDate;
$fileAction->save();
// logging
LogHelper::info('File queued for delete in file action queue. ID: '.$fileAction->id.'. Path: '.$filePath);
return $fileAction;
}
static function processQueue($limitType = null, $limitActions = 100) {
// get file servers
$db = Database::getDatabase();
LogHelper::setContext('file-action-queue');
// setup server ids, we need this to be an array to allow for multiple drives on the same server
$server = FileHelper::getCurrentServerDetails();
$serverIds = [];
if ($server['serverType'] === 'local') {
// load other non-direct servers
$servers = $db->getRows('SELECT id '
. 'FROM file_server '
. 'WHERE serverType != \'direct\'');
foreach ($servers AS $serverItem) {
$serverIds[] = (int) $serverItem['id'];
}
}
else {
$serverIds[] = (int) $server['id'];
}
// load pending queue items for the current server
$pendingItems = $db->getRows('SELECT file_action.id, file_action.action_data, '
. 'file_action.file_path, file_action.file_action, file_action.file_id, '
. 'fa.local_file_path, fa.file_hash, fas.file_server_id, file_action.is_uploaded_file, '
. 'file_action.server_id '
. 'FROM file_action '
. 'LEFT JOIN file ON file_action.file_id = file.id '
. 'LEFT JOIN file_artifact fa ON file.id = fa.file_id AND file_artifact_type = "primary" '
. 'LEFT JOIN file_artifact_storage fas ON fa.id = fas.file_artifact_id '
. 'WHERE file_action.server_id IN (' . implode(',', $serverIds) . ') '
. 'AND file_action.status = \'pending\' '
. 'AND file_action.action_date < NOW() '
. ($limitType != null ? ('AND file_action.file_action = ' . $db->quote($limitType)) : '') . ' '
. 'ORDER BY file_action.id ASC '
. 'LIMIT ' . $limitActions);
if ($pendingItems) {
// get an admin API details for remote calls
$apiCredentials = UserHelper::getAdminApiDetails();
if ($apiCredentials === false) {
// log
LogHelper::error('Failed getting any admin API credentials.');
return false;
}
foreach ($pendingItems AS $pendingItem) {
// reload item to make sure it's not been triggered by another instance of this script running, and it's
// still pending
$checkPending = $db->getValue('SELECT id '
. 'FROM file_action '
. 'WHERE id=' . (int) $pendingItem['id'] . ' '
. 'AND status=\'pending\' '
. 'LIMIT 1');
if (!$checkPending) {
continue;
}
// prepare file path
$filePath = trim($pendingItem['file_path']);
if ((int) $pendingItem['is_uploaded_file'] === 1) {
// this is the original file (i.e. not a cache file or preview image) load file object and get full
// path. This is may only be available on the file server itself hence the queue may not know about it
$file = File::loadOneById($pendingItem['file_id']);
if ($file) {
// get full path to the file
$pendingItem['file_path'] = $file->getFullFilePath();
// update the file_action item with the correct path
$db->query('UPDATE file_action '
. 'SET file_path = :file_path '
. 'WHERE id = ' . (int) $pendingItem['id'] . ' '
. 'LIMIT 1', [
'file_path' => $pendingItem['file_path'],
]);
}
}
// validation
if (strlen($filePath) <= 1) {
$db->query('UPDATE file_action '
. 'SET status = \'failed\', '
. 'status_msg=\'File has zero length or is in the root folder.\', '
. 'last_updated=NOW() '
. 'WHERE id = ' . (int) $pendingItem['id'] . ' '
. 'LIMIT 1');
continue;
}
// set processing
$db->query('UPDATE file_action '
. 'SET status = \'processing\', '
. 'last_updated=NOW() '
. 'WHERE id = ' . (int) $pendingItem['id'] . ' '
. 'LIMIT 1');
// do action
switch ($pendingItem['file_action']) {
case 'delete':
// reload the correct server, this is needed if this script is processing multiple flysystem, ftp
// or local actions.
$server = FileHelper::loadServerDetails($pendingItem['server_id']);
// handle the actual removal of the file
$rs = self::processFileRemoval($server, $pendingItem);
if ($rs === false) {
$db->query('UPDATE file_action '
. 'SET status = \'failed\', '
. 'status_msg=\'Could not delete file or folder, possible permissions issue or folder has contents.\', '
. 'last_updated=NOW() '
. 'WHERE id = ' . (int) $pendingItem['id'] . ' '
. 'LIMIT 1');
continue 2;
}
break;
case 'move':
$actionDetails = json_decode($pendingItem['action_data'], true);
$params = [];
$params['file_id'] = (int) $pendingItem['file_id'];
$params['server_id'] = (int) $actionDetails['newServerId'];
// log
LogHelper::info('Move file request. file_action id = ' . $pendingItem['id']);
$url = AdminApiHelper::createApiUrl(_CONFIG_SITE_FULL_URL, $apiCredentials['apikey'], $apiCredentials['username'], 'movefile', $params);
$rs = CoreHelper::getRemoteUrlContent($url);
// log
LogHelper::info('Move file result: ' . print_r($rs, true) . ' file_action id = ' . $pendingItem['id']);
// handle failures
if ($rs === false) {
// log
LogHelper::error('Failed move file. file_action id = ' . $pendingItem['id']);
$db->query('UPDATE file_action '
. 'SET status = \'failed\', '
. 'status_msg=\'Failed move file.\', '
. 'last_updated=NOW() '
. 'WHERE id = ' . (int) $pendingItem['id'] . ' '
. 'LIMIT 1');
continue 2;
}
break;
case 'restore':
$restorePath = str_replace('_deleted/', '', $pendingItem['localFilePath']);
$newFileHash = md5_file($pendingItem['file_path']);
$rs = rename($pendingItem['file_path'], $restorePath);
// File restored, update the database
if ($rs === true) {
$db->query("UPDATE file_action "
. "SET status_msg = 'File restoration complete.', "
. "status = 'complete', "
. "last_updated=NOW() "
. "WHERE id = " . (int) $pendingItem['id'] . " "
. "LIMIT 1");
$db->query("UPDATE file "
. "SET status = 'active' "
. "WHERE id = " . (int) $pendingItem['id'] . " "
. "LIMIT 1");
$db->query("UPDATE file_artifact "
. "SET file_hash = " . $db->quote($newFileHash) . " "
. "WHERE file_id = " . (int) $pendingItem['id'] . " "
. "AND file_artifact_type = 'primary'");
LogHelper::info('Restore file result: ' . print_r($rs, true) . ' file_action id = ' . $pendingItem['id']);
continue 2;
}
// File NOT restored, log the errors & update the db entry.
if (($rs === false) || (strlen($restorePath) == 0)) {
// log
LogHelper::error('Failed file restoration. file_action id = ' . $pendingItem['id']);
$db->query('UPDATE file_action '
. 'SET status = \'failed\', '
. 'status_msg=\'Could not restore file.\', '
. 'last_updated=NOW() '
. 'WHERE id = ' . (int) $pendingItem['id'] . ' '
. 'LIMIT 1');
continue 2;
}
break;
}
// update file record
$db->query('UPDATE file_action '
. 'SET status = \'complete\', '
. 'last_updated=NOW() '
. 'WHERE id = ' . (int) $pendingItem['id'] . ' '
. 'LIMIT 1');
continue;
}
}
}
/**
* Remove the actual file.
*
* @param array $uploadServerDetails
* @param array $queueRow
* @return bool
*/
static function processFileRemoval(array $uploadServerDetails, array $queueRow): bool {
// remove the actual file
$filePath = $queueRow['file_path'];
$storageType = $uploadServerDetails['serverType'];
// call plugin hooks to delete via S3, Wasabi etc. This will also schedule
// any cache files stored on 'direct' file servers.
$params = PluginHelper::callHook('processFileRemoval', [
'uploadServerDetails' => $uploadServerDetails,
'queueRow' => $queueRow,
'storageType' => $storageType,
'filePath' => $filePath,
'actioned' => false,
]);
// exit if we're done processing the item
if ($params['actioned'] === true) {
return true;
}
// ftp storage
if ($storageType == 'ftp') {
// connect via ftp
$conn_id = ftp_connect($uploadServerDetails['ipAddress'], $uploadServerDetails['ftpPort'], 30);
if ($conn_id === false) {
LogHelper::error('Could not connect to ' . $uploadServerDetails['ipAddress'] . ' to upload file.');
return false;
}
// authenticate
$login_result = ftp_login($conn_id, $uploadServerDetails['ftpUsername'], $uploadServerDetails['ftpPassword']);
if ($login_result === false) {
LogHelper::error('Could not login to ' . $uploadServerDetails['ipAddress'] . ' with supplied credentials.');
return false;
}
// remove file
if (!ftp_delete($conn_id, $filePath)) {
// make sure file still exists before erroring
$filePathNoName = str_replace(end(explode('/', $filePath)), '', $filePath);
$file_list = ftp_nlist($conn_id, $filePathNoName);
if ($file_list) {
if (in_array($filePath, $file_list)) {
LogHelper::error('Could not remove file on ' . $uploadServerDetails['ipAddress']);
return false;
}
}
}
return true;
}
// flysystem storage
if (substr($storageType, 0, 10) === 'flysystem_') {
$filesystem = FileServerContainerHelper::init($uploadServerDetails['id']);
if (!$filesystem) {
LogHelper::error('Could not setup adapter to delete file.');
return false;
}
// remove the file
try {
// delete
$rs = $filesystem->delete($filePath);
if (!$rs) {
LogHelper::error('Could not delete file. Please contact support or try again.');
return false;
}
}
catch (\Exception $e) {
LogHelper::error($e->getMessage());
return false;
}
return true;
}
// local & direct storage
if (file_exists($filePath)) {
// delete file or folder, this is the only option in this function for now
if (is_dir($filePath)) {
// directory
rmdir($filePath);
} else {
// file
unlink($filePath);
}
}
return true;
}
/**
* Queue file to be moved.
*
* @param type $serverId
* @param type $fromFilePath
* @param type $fileId
* @param type $newServerId
* @return boolean|\DBObject
*/
static function queueMoveFile($serverId, $fromFilePath, $fileId, $newServerId) {
// create our FileAction object
$fileAction = FileAction::create();
$fileAction->file_id = $fileId;
$fileAction->server_id = $serverId;
$fileAction->file_path = $fromFilePath;
$fileAction->file_action = 'move';
$fileAction->action_data = json_encode(array('newServerId' => $newServerId));
$fileAction->status = 'pending';
$fileAction->date_created = CoreHelper::sqlDateTime();
$fileAction->action_date = CoreHelper::sqlDateTime();
$fileAction->save();
return $fileAction;
}
}