WebRequestUpload::getError() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

WebRequestUpload::getError() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: WebRequestUpload

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	7
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Object to access the $_FILES array
 *
 * 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 2 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, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 */

/**
 * Object to access the $_FILES array
 *
 * @ingroup HTTP
 */
class WebRequestUpload {
	protected $request;
	protected $doesExist;
	protected $fileInfo;

	/**
	 * Constructor. Should only be called by WebRequest
	 *
	 * @param WebRequest $request The associated request
	 * @param string $key Key in $_FILES array (name of form field)
	 */
	public function __construct( $request, $key ) {
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
		$this->request = $request;
		$this->doesExist = isset( $_FILES[$key] );
		if ( $this->doesExist ) {
			$this->fileInfo = $_FILES[$key];
		}
	}

	/**
	 * Return whether a file with this name was uploaded.
	 *
	 * @return bool
	 */
	public function exists() {
		return $this->doesExist;
	}

	/**
	 * Return the original filename of the uploaded file
	 *
	 * @return string|null Filename or null if non-existent
	 */
	public function getName() {
		if ( !$this->exists() ) {
			return null;
		}

		global $wgContLang;
		$name = $this->fileInfo['name'];

		# Safari sends filenames in HTML-encoded Unicode form D...
		# Horrid and evil! Let's try to make some kind of sense of it.
		$name = Sanitizer::decodeCharReferences( $name );
		$name = $wgContLang->normalize( $name );
		wfDebug( __METHOD__ . ": {$this->fileInfo['name']} normalized to '$name'\n" );
		return $name;
	}

	/**
	 * Return the file size of the uploaded file
	 *
	 * @return int File size or zero if non-existent
	 */
	public function getSize() {
		if ( !$this->exists() ) {
			return 0;
		}

		return $this->fileInfo['size'];
	}

	/**
	 * Return the path to the temporary file
	 *
	 * @return string|null Path or null if non-existent
	 */
	public function getTempName() {
		if ( !$this->exists() ) {
			return null;
		}

		return $this->fileInfo['tmp_name'];
	}

	/**
	 * Return the upload error. See link for explanation
	 * https://secure.php.net/manual/en/features.file-upload.errors.php
	 *
	 * @return int One of the UPLOAD_ constants, 0 if non-existent
	 */
	public function getError() {
		if ( !$this->exists() ) {
			return 0; # UPLOAD_ERR_OK
		}

		return $this->fileInfo['error'];
	}

	/**
	 * Returns whether this upload failed because of overflow of a maximum set
	 * in php.ini
	 *
	 * @return bool
	 */
	public function isIniSizeOverflow() {
		if ( $this->getError() == UPLOAD_ERR_INI_SIZE ) {
			# PHP indicated that upload_max_filesize is exceeded
			return true;
		}

		$contentLength = $this->request->getHeader( 'Content-Length' );
		$maxPostSize = wfShorthandToInteger(
			ini_get( 'post_max_size' ) ?: ini_get( 'hhvm.server.max_post_size' ),
			0
		);

		if ( $maxPostSize && $contentLength > $maxPostSize ) {
			# post_max_size is exceeded
			return true;
		}

		return false;
	}
}


1			<?php
2			/**
3			* Object to access the $_FILES array
4			*
5			* This program is free software; you can redistribute it and/or modify
6			* it under the terms of the GNU General Public License as published by
7			* the Free Software Foundation; either version 2 of the License, or
8			* (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			*
15			* You should have received a copy of the GNU General Public License along
16			* with this program; if not, write to the Free Software Foundation, Inc.,
17			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18			* http://www.gnu.org/copyleft/gpl.html
19			*
20			* @file
21			*/
22
23			/**
24			* Object to access the $_FILES array
25			*
26			* @ingroup HTTP
27			*/
28			class WebRequestUpload {
29			protected $request;
30			protected $doesExist;
31			protected $fileInfo;
32
33			/**
34			* Constructor. Should only be called by WebRequest
35			*
36			* @param WebRequest $request The associated request
37			* @param string $key Key in $_FILES array (name of form field)
38			*/
39			public function __construct( $request, $key ) {
			0 ignored issues – show Coding Style introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report `__construct` uses the super-global variable `$_FILES` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
40			$this->request = $request;
41			$this->doesExist = isset( $_FILES[$key] );
42			if ( $this->doesExist ) {
43			$this->fileInfo = $_FILES[$key];
44			}
45			}
46
47			/**
48			* Return whether a file with this name was uploaded.
49			*
50			* @return bool
51			*/
52			public function exists() {
53			return $this->doesExist;
54			}
55
56			/**
57			* Return the original filename of the uploaded file
58			*
59			* @return string\|null Filename or null if non-existent
60			*/
61			public function getName() {
62			if ( !$this->exists() ) {
63			return null;
64			}
65
66			global $wgContLang;
67			$name = $this->fileInfo['name'];
68
69			# Safari sends filenames in HTML-encoded Unicode form D...
70			# Horrid and evil! Let's try to make some kind of sense of it.
71			$name = Sanitizer::decodeCharReferences( $name );
72			$name = $wgContLang->normalize( $name );
73			wfDebug( __METHOD__ . ": {$this->fileInfo['name']} normalized to '$name'\n" );
74			return $name;
75			}
76
77			/**
78			* Return the file size of the uploaded file
79			*
80			* @return int File size or zero if non-existent
81			*/
82			public function getSize() {
83			if ( !$this->exists() ) {
84			return 0;
85			}
86
87			return $this->fileInfo['size'];
88			}
89
90			/**
91			* Return the path to the temporary file
92			*
93			* @return string\|null Path or null if non-existent
94			*/
95			public function getTempName() {
96			if ( !$this->exists() ) {
97			return null;
98			}
99
100			return $this->fileInfo['tmp_name'];
101			}
102
103			/**
104			* Return the upload error. See link for explanation
105			* https://secure.php.net/manual/en/features.file-upload.errors.php
106			*
107			* @return int One of the UPLOAD_ constants, 0 if non-existent
108			*/
109			public function getError() {
110			if ( !$this->exists() ) {
111			return 0; # UPLOAD_ERR_OK
112			}
113
114			return $this->fileInfo['error'];
115			}
116
117			/**
118			* Returns whether this upload failed because of overflow of a maximum set
119			* in php.ini
120			*
121			* @return bool
122			*/
123			public function isIniSizeOverflow() {
124			if ( $this->getError() == UPLOAD_ERR_INI_SIZE ) {
125			# PHP indicated that upload_max_filesize is exceeded
126			return true;
127			}
128
129			$contentLength = $this->request->getHeader( 'Content-Length' );
130			$maxPostSize = wfShorthandToInteger(
131			ini_get( 'post_max_size' ) ?: ini_get( 'hhvm.server.max_post_size' ),
132			0
133			);
134
135			if ( $maxPostSize && $contentLength > $maxPostSize ) {
136			# post_max_size is exceeded
137			return true;
138			}
139
140			return false;
141			}
142			}
143

wikimedia / mediawiki

WebRequestUpload::getError() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WebRequestUpload::getError() A
last analyzed 2016-11-13 17:42 UTC