UploadFileAction::main() - Code Metrics - Inspection of "Refactor SystemManagementProcessor" - mikopbx/Core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — develop ( a56058...ddfce4 )

by Nikolay

created 2024-04-10 05:50 UTC

UploadFileAction::main() B

↳ Parent: UploadFileAction

Complexity

Conditions	9
Paths	18

Size

Total Lines	55
Code Lines	37

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	37
c	0
b	0
f	0
dl	0
loc	55
rs	7.7724
cc	9
nc	18
nop	1

How to fix Long Method

<?php
/*
 * MikoPBX - free phone system for small business
 * Copyright © 2017-2024 Alexey Portnov and Nikolay Beketov
 *
 * 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 MikoPBX\PBXCoreREST\Lib\Files;

use MikoPBX\Core\System\Processes;
use MikoPBX\Core\System\Util;
use MikoPBX\PBXCoreREST\Lib\PBXApiResult;
use MikoPBX\PBXCoreREST\Workers\WorkerMergeUploadedFile;
use Phalcon\Di;
use Phalcon\Http\Message\StreamFactory;
use Phalcon\Http\Message\UploadedFile;

/**
 *  Class UploadFile
 *  Process upload files by chunks.
 *
 * @package MikoPBX\PBXCoreREST\Lib\Files
 */
class UploadFileAction extends \Phalcon\Di\Injectable
{
    /**
     * Process upload files by chunks.
     *
     * @param array $parameters The upload parameters.
     *
     * @return PBXApiResult An object containing the result of the API call.
     */
    public static function main(array $parameters): PBXApiResult
    {
        $res = new PBXApiResult();
        $res->processor = __METHOD__;
        $di = Di::getDefault();
        if ($di === null) {
            $res->success = false;
            $res->messages[] = 'Dependency injector does not initialized';

            return $res;
        }
        $parameters['uploadDir'] = $di->getShared('config')->path('www.uploadDir');
        $parameters['tempDir'] = "{$parameters['uploadDir']}/{$parameters['resumableIdentifier']}";
        if (!Util::mwMkdir($parameters['tempDir'])) {
            $res->messages[] = 'Temp dir does not exist ' . $parameters['tempDir'];

            return $res;
        }

        $fileName = (string)pathinfo($parameters['resumableFilename'], PATHINFO_FILENAME);
        $fileName = preg_replace('/[\W]/', '', $fileName);
        if (strlen($fileName) < 10) {
            $fileName = '' . md5(microtime()) . '-' . $fileName;
        }
        $extension = (string)pathinfo($parameters['resumableFilename'], PATHINFO_EXTENSION);
        $fileName .= '.' . $extension;
        $parameters['resumableFilename'] = $fileName;
        $parameters['fullUploadedFileName'] = "{$parameters['tempDir']}/{$fileName}";

        // Delete old progress and result file
        $oldMergeProgressFile = "{$parameters['tempDir']}/merging_progress";
        if (file_exists($oldMergeProgressFile)) {
            unlink($oldMergeProgressFile);
        }
        if (file_exists($parameters['fullUploadedFileName'])) {
            unlink($parameters['fullUploadedFileName']);
        }

        foreach ($parameters['files'] as $file_data) {
            if (!self::moveUploadedPartToSeparateDir($parameters, $file_data)) {
                $res->messages[] = 'Does not found any uploaded chunks on with path ' . $file_data['file_path'];
                break;
            }
            $res->success = true;
            $res->data['upload_id'] = $parameters['resumableIdentifier'];
            $res->data['filename'] = $parameters['fullUploadedFileName'];

            if (self::tryToMergeChunksIfAllPartsUploaded($parameters)) {
                $res->data[FilesConstants::D_STATUS] = FilesConstants::UPLOAD_MERGING;
            } else {
                $res->data[FilesConstants::D_STATUS] = FilesConstants::UPLOAD_WAITING_FOR_NEXT_PART;
            }
        }

        return $res;
    }

    /**
     * Moves uploaded file part to separate directory with "upload_id" name on the system uploadDir folder.
     *
     * @param array $parameters data from of resumable request
     * @param array $file_data  data from uploaded file part
     *
     * @return bool
     */
    private static function moveUploadedPartToSeparateDir(array $parameters, array $file_data): bool
    {
        if ( ! file_exists($file_data['file_path'])) {
            return false;
        }
        $factory          = new StreamFactory();
        $stream           = $factory->createStreamFromFile($file_data['file_path'], 'r');
        $file             = new UploadedFile(
            $stream,
            $file_data['file_size'],
            $file_data['file_error'],
            $file_data['file_name'],
            $file_data['file_type']
        );
        $chunks_dest_file = "{$parameters['tempDir']}/{$parameters['resumableFilename']}.part{$parameters['resumableChunkNumber']}";
        if (file_exists($chunks_dest_file)) {
            $rm = Util::which('rm');
            Processes::mwExec("{$rm} -f {$chunks_dest_file}");
        }
        $file->moveTo($chunks_dest_file);

        return true;
    }

    /**
     * If the size of all the chunks on the server is equal to the size of the file uploaded starts a merge process.
     *
     * @param array $parameters
     *
     * @return bool
     */
    private static function tryToMergeChunksIfAllPartsUploaded(array $parameters): bool
    {
        $totalFilesOnServerSize = 0;
        foreach (scandir($parameters['tempDir']) as $file) {
            $totalFilesOnServerSize += filesize($parameters['tempDir'] . '/' . $file);
        }

        if ($totalFilesOnServerSize >= $parameters['resumableTotalSize']) {
            // Parts upload complete
            $merge_settings = [
                'fullUploadedFileName' => $parameters['fullUploadedFileName'],
                'tempDir'              => $parameters['tempDir'],
                'resumableFilename'    => $parameters['resumableFilename'],
                'resumableTotalSize'   => $parameters['resumableTotalSize'],
                'resumableTotalChunks' => $parameters['resumableTotalChunks'],
            ];
            $settings_file  = "{$parameters['tempDir']}/merge_settings";
            file_put_contents(
                $settings_file,
                json_encode($merge_settings, JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT)
            );

            // We will start the background process to merge parts into one file
            $phpPath               = Util::which('php');
            $workerFilesMergerPath = Util::getFilePathByClassName(WorkerMergeUploadedFile::class);
            Processes::mwExecBg("{$phpPath} -f {$workerFilesMergerPath} start '{$settings_file}'");

            return true;
        }

        return false;
    }
}

1			<?php
2			/*
3			* MikoPBX - free phone system for small business
4			* Copyright © 2017-2024 Alexey Portnov and Nikolay Beketov
5			*
6			* This program is free software: you can redistribute it and/or modify
7			* it under the terms of the GNU General Public License as published by
8			* the Free Software Foundation; either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* This program is distributed in the hope that it will be useful,
12			* but WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU General Public License for more details.
15			*
16			* You should have received a copy of the GNU General Public License along with this program.
17			* If not, see <https://www.gnu.org/licenses/>.
18			*/
19
20			namespace MikoPBX\PBXCoreREST\Lib\Files;
21
22			use MikoPBX\Core\System\Processes;
23			use MikoPBX\Core\System\Util;
24			use MikoPBX\PBXCoreREST\Lib\PBXApiResult;
25			use MikoPBX\PBXCoreREST\Workers\WorkerMergeUploadedFile;
26			use Phalcon\Di;
27			use Phalcon\Http\Message\StreamFactory;
28			use Phalcon\Http\Message\UploadedFile;
29
30			/**
31			* Class UploadFile
32			* Process upload files by chunks.
33			*
34			* @package MikoPBX\PBXCoreREST\Lib\Files
35			*/
36			class UploadFileAction extends \Phalcon\Di\Injectable
37			{
38			/**
39			* Process upload files by chunks.
40			*
41			* @param array $parameters The upload parameters.
42			*
43			* @return PBXApiResult An object containing the result of the API call.
44			*/
45			public static function main(array $parameters): PBXApiResult
46			{
47			$res = new PBXApiResult();
48			$res->processor = __METHOD__;
49			$di = Di::getDefault();
50			if ($di === null) {
51			$res->success = false;
52			$res->messages[] = 'Dependency injector does not initialized';
53
54			return $res;
55			}
56			$parameters['uploadDir'] = $di->getShared('config')->path('www.uploadDir');
57			$parameters['tempDir'] = "{$parameters['uploadDir']}/{$parameters['resumableIdentifier']}";
58			if (!Util::mwMkdir($parameters['tempDir'])) {
59			$res->messages[] = 'Temp dir does not exist ' . $parameters['tempDir'];
60
61			return $res;
62			}
63
64			$fileName = (string)pathinfo($parameters['resumableFilename'], PATHINFO_FILENAME);
65			$fileName = preg_replace('/[\W]/', '', $fileName);
66			if (strlen($fileName) < 10) {
67			$fileName = '' . md5(microtime()) . '-' . $fileName;
68			}
69			$extension = (string)pathinfo($parameters['resumableFilename'], PATHINFO_EXTENSION);
70			$fileName .= '.' . $extension;
71			$parameters['resumableFilename'] = $fileName;
72			$parameters['fullUploadedFileName'] = "{$parameters['tempDir']}/{$fileName}";
73
74			// Delete old progress and result file
75			$oldMergeProgressFile = "{$parameters['tempDir']}/merging_progress";
76			if (file_exists($oldMergeProgressFile)) {
77			unlink($oldMergeProgressFile);
78			}
79			if (file_exists($parameters['fullUploadedFileName'])) {
80			unlink($parameters['fullUploadedFileName']);
81			}
82
83			foreach ($parameters['files'] as $file_data) {
84			if (!self::moveUploadedPartToSeparateDir($parameters, $file_data)) {
85			$res->messages[] = 'Does not found any uploaded chunks on with path ' . $file_data['file_path'];
86			break;
87			}
88			$res->success = true;
89			$res->data['upload_id'] = $parameters['resumableIdentifier'];
90			$res->data['filename'] = $parameters['fullUploadedFileName'];
91
92			if (self::tryToMergeChunksIfAllPartsUploaded($parameters)) {
93			$res->data[FilesConstants::D_STATUS] = FilesConstants::UPLOAD_MERGING;
94			} else {
95			$res->data[FilesConstants::D_STATUS] = FilesConstants::UPLOAD_WAITING_FOR_NEXT_PART;
96			}
97			}
98
99			return $res;
100			}
101
102			/**
103			* Moves uploaded file part to separate directory with "upload_id" name on the system uploadDir folder.
104			*
105			* @param array $parameters data from of resumable request
106			* @param array $file_data data from uploaded file part
107			*
108			* @return bool
109			*/
110			private static function moveUploadedPartToSeparateDir(array $parameters, array $file_data): bool
111			{
112			if ( ! file_exists($file_data['file_path'])) {
113			return false;
114			}
115			$factory = new StreamFactory();
116			$stream = $factory->createStreamFromFile($file_data['file_path'], 'r');
117			$file = new UploadedFile(
118			$stream,
119			$file_data['file_size'],
120			$file_data['file_error'],
121			$file_data['file_name'],
122			$file_data['file_type']
123			);
124			$chunks_dest_file = "{$parameters['tempDir']}/{$parameters['resumableFilename']}.part{$parameters['resumableChunkNumber']}";
125			if (file_exists($chunks_dest_file)) {
126			$rm = Util::which('rm');
127			Processes::mwExec("{$rm} -f {$chunks_dest_file}");
128			}
129			$file->moveTo($chunks_dest_file);
130
131			return true;
132			}
133
134			/**
135			* If the size of all the chunks on the server is equal to the size of the file uploaded starts a merge process.
136			*
137			* @param array $parameters
138			*
139			* @return bool
140			*/
141			private static function tryToMergeChunksIfAllPartsUploaded(array $parameters): bool
142			{
143			$totalFilesOnServerSize = 0;
144			foreach (scandir($parameters['tempDir']) as $file) {
145			$totalFilesOnServerSize += filesize($parameters['tempDir'] . '/' . $file);
146			}
147
148			if ($totalFilesOnServerSize >= $parameters['resumableTotalSize']) {
149			// Parts upload complete
150			$merge_settings = [
151			'fullUploadedFileName' => $parameters['fullUploadedFileName'],
152			'tempDir' => $parameters['tempDir'],
153			'resumableFilename' => $parameters['resumableFilename'],
154			'resumableTotalSize' => $parameters['resumableTotalSize'],
155			'resumableTotalChunks' => $parameters['resumableTotalChunks'],
156			];
157			$settings_file = "{$parameters['tempDir']}/merge_settings";
158			file_put_contents(
159			$settings_file,
160			json_encode($merge_settings, JSON_UNESCAPED_SLASHES \| JSON_PRETTY_PRINT)
161			);
162
163			// We will start the background process to merge parts into one file
164			$phpPath = Util::which('php');
165			$workerFilesMergerPath = Util::getFilePathByClassName(WorkerMergeUploadedFile::class);
166			Processes::mwExecBg("{$phpPath} -f {$workerFilesMergerPath} start '{$settings_file}'");
167
168			return true;
169			}
170
171			return false;
172			}
173			}

mikopbx / Core

Push — develop ( a56058...ddfce4 )

UploadFileAction::main() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like