mirror/php-phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-08-29 11:10:18 +02:00
Code Issues Releases Wiki Activity

[ticket/16955] Clean up filesystem and files classes

Browse Source 
PHPBB3-16955
This commit is contained in:
Marc Alexander
2022-12-26 16:43:50 +01:00
parent d3d53cda0f
commit 7f61f8b770
14 changed files with 58 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
phpBB/phpbb/files/factory.php
View File

@@ -46,7 +46,7 @@ class factory
try
{
$service = $this->container->get($name);
$service = $this->container->get($name) ?? false;
}
catch (\Exception $e)
{

2
phpBB/phpbb/files/filespec.php
View File

@@ -329,7 +329,7 @@ class filespec
* Get mime type
*
* @param string $filename Filename that needs to be checked
* @return string Mime type of supplied filename
* @return string|false Mime type of supplied filename or false if mimetype could not be guessed
*/
public function get_mimetype($filename)
{

8
phpBB/phpbb/files/filespec_storage.php
View File

@@ -99,7 +99,7 @@ class filespec_storage
*
* @param array $upload_ary Upload ary
*
* @return filespec This instance of the filespec class
* @return filespec_storage This instance of the filespec class
*/
public function set_upload_ary($upload_ary)
{
@@ -142,7 +142,7 @@ class filespec_storage
*
* @param upload $namespace Instance of upload class
*
* @return filespec This instance of the filespec class
* @return filespec_storage This instance of the filespec class
*/
public function set_upload_namespace($namespace)
{
@@ -166,7 +166,7 @@ class filespec_storage
*
* @param mixed $error Content for error array
*
* @return \phpbb\files\filespec This instance of the filespec class
* @return filespec_storage This instance of the filespec class
*/
public function set_error($error)
{
@@ -313,7 +313,7 @@ class filespec_storage
* Get mime type
*
* @param string $filename Filename that needs to be checked
* @return string Mime type of supplied filename
* @return string|false Mime type of supplied filename or false if mimetype could not be guessed
*/
public function get_mimetype($filename)
{

14
phpBB/phpbb/files/types/base.php
View File

@@ -27,9 +27,10 @@ abstract class base implements type_interface
/**
* Check if upload exceeds maximum file size
*
* @param \phpbb\files\filespec $file Filespec object
* @template filespec_type of \phpbb\files\filespec|\phpbb\files\filespec_storage
* @param filespec_type $file Filespec object
*
* @return \phpbb\files\filespec Returns same filespec instance
* @return filespec_type Returns same filespec instance
*/
public function check_upload_size($file)
{
@@ -47,7 +48,14 @@ abstract class base implements type_interface
$unit = ($unit == 'k') ? 'KB' : (($unit == 'g') ? 'GB' : 'MB');
}
$file->error[] = (empty($max_filesize)) ? $this->language->lang($this->upload->error_prefix . 'PHP_SIZE_NA') : $this->language->lang($this->upload->error_prefix . 'PHP_SIZE_OVERRUN', $max_filesize, $this->language->lang($unit));
if (empty($max_filesize))
{
$file->error[] = $this->language->lang($this->upload->error_prefix . 'PHP_SIZE_NA');
}
else
{
$file->error[] = $this->language->lang($this->upload->error_prefix . 'PHP_SIZE_OVERRUN', $max_filesize, $this->language->lang($unit));
}
}
return $file;

8
phpBB/phpbb/files/types/form.php
View File

@@ -18,7 +18,7 @@ use phpbb\files\factory;
use phpbb\files\filespec;
use phpbb\language\language;
use phpbb\plupload\plupload;
use phpbb\request\request_interface;
use phpbb\request\request;
class form extends base
{
@@ -28,7 +28,7 @@ class form extends base
/** @var plupload */
protected $plupload;
/** @var request_interface */
/** @var request */
protected $request;
/**
@@ -38,9 +38,9 @@ class form extends base
* @param language $language Language class
* @param IniGetWrapper $php_ini ini_get() wrapper
* @param plupload $plupload Plupload
* @param request_interface $request Request object
* @param request $request Request object
*/
public function __construct(factory $factory, language $language, IniGetWrapper $php_ini, plupload $plupload, request_interface $request)
public function __construct(factory $factory, language $language, IniGetWrapper $php_ini, plupload $plupload, request $request)
{
$this->factory = $factory;
$this->language = $language;

8
phpBB/phpbb/files/types/form_storage.php
View File

@@ -18,7 +18,7 @@ use phpbb\files\factory;
use phpbb\files\filespec;
use phpbb\language\language;
use phpbb\plupload\plupload;
use phpbb\request\request_interface;
use phpbb\request\request;
class form_storage extends base
{
@@ -28,7 +28,7 @@ class form_storage extends base
/** @var plupload */
protected $plupload;
/** @var request_interface */
/** @var request */
protected $request;
/**
@@ -38,9 +38,9 @@ class form_storage extends base
* @param language $language Language class
* @param IniGetWrapper $php_ini ini_get() wrapper
* @param plupload $plupload Plupload
* @param request_interface $request Request object
* @param request $request Request object
*/
public function __construct(factory $factory, language $language, IniGetWrapper $php_ini, plupload $plupload, request_interface $request)
public function __construct(factory $factory, language $language, IniGetWrapper $php_ini, plupload $plupload, request $request)
{
$this->factory = $factory;
$this->language = $language;

4
phpBB/phpbb/files/types/local.php
View File

@@ -65,8 +65,8 @@ class local extends base
$upload = $this->get_upload_ary($source_file, $filedata);
/** @var filespec $file */
$file = $this->factory->get('filespec')
->set_upload_ary($upload)
$file = $this->factory->get('filespec');
$file->set_upload_ary($upload)
->set_upload_namespace($this->upload);
if ($file->init_error())

11
phpBB/phpbb/files/types/local_storage.php
View File

@@ -15,7 +15,7 @@ namespace phpbb\files\types;
use bantu\IniGetWrapper\IniGetWrapper;
use phpbb\files\factory;
use phpbb\files\filespec;
use phpbb\files\filespec_storage;
use phpbb\language\language;
use phpbb\request\request_interface;
@@ -67,15 +67,15 @@ class local_storage extends base
* @param string $source_file Filename of source file
* @param array|bool $filedata Array with filedata or false
*
* @return filespec Object "filespec" is returned, all further operations can be done with this object
* @return filespec_storage Object "filespec_storage" is returned, all further operations can be done with this object
*/
protected function local_upload($source_file, $filedata = false)
{
$upload = $this->get_upload_ary($source_file, $filedata);
/** @var filespec $file */
$file = $this->factory->get('filespec_storage')
->set_upload_ary($upload)
/** @var filespec_storage $file */
$file = $this->factory->get('filespec_storage');
$file->set_upload_ary($upload)
->set_upload_namespace($this->upload);
if ($file->init_error())
@@ -85,6 +85,7 @@ class local_storage extends base
}
// PHP Upload file size check
/** @var filespec_storage $file */
$file = $this->check_upload_size($file);
if (count($file->error))
{

2
phpBB/phpbb/files/types/type_interface.php
View File

@@ -21,7 +21,7 @@ interface type_interface
* Handle upload for upload types. Arguments passed to this method will be
* handled by the upload type classes themselves.
*
* @return \phpbb\files\filespec|bool Filespec instance if upload is
* @return \phpbb\files\filespec_storage|\phpbb\files\filespec|bool Filespec instance if upload is
* successful or false if not
*/
public function upload();

14
phpBB/phpbb/files/upload.php
View File

@@ -14,7 +14,7 @@
namespace phpbb\files;
use phpbb\language\language;
use phpbb\request\request_interface;
use phpbb\request\request;
/**
* File upload class
@@ -55,7 +55,7 @@ class upload
/** @var language Language class */
protected $language;
/** @var request_interface Request class */
/** @var request Request class */
protected $request;
/**
@@ -64,9 +64,9 @@ class upload
* @param factory $factory Files factory
* @param language $language Language class
* @param \bantu\IniGetWrapper\IniGetWrapper $php_ini ini_get() wrapper
* @param request_interface $request Request class
* @param request $request Request class
*/
public function __construct(factory $factory, language $language, \bantu\IniGetWrapper\IniGetWrapper $php_ini, request_interface $request)
public function __construct(factory $factory, language $language, \bantu\IniGetWrapper\IniGetWrapper $php_ini, request $request)
{
$this->factory = $factory;
$this->language = $language;
@@ -194,7 +194,7 @@ class upload
*
* @param string $errorcode Error code to assign
*
* @return string Error string
* @return string|false Error string or false if error code is not supported
* @access public
*/
public function assign_internal_error($errorcode)
@@ -250,7 +250,7 @@ class upload
/**
* Perform common file checks
*
* @param filespec_storage $file Instance of filespec class
* @param filespec_storage|filespec $file Instance of filespec class
*/
public function common_checks($file)
{
@@ -296,7 +296,7 @@ class upload
/**
* Check for allowed dimension
*
* @param filespec_storage $file Instance of filespec class
* @param filespec_storage|filespec $file Instance of filespec class
*
* @return bool True if dimensions are valid or no constraints set, false
* if not