MIMEsearchPage::isCacheable() - Code Metrics - Inspection of "Daily Inspection: Add hooks for WatchedItemQuerySe..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (715cbe)

unknown

created 2016-11-03 17:18 UTC

MIMEsearchPage::isCacheable() A

↳ Parent: MIMEsearchPage

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php
/**
 * Implements Special:MIMESearch
 *
 * 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
 * @ingroup SpecialPage
 * @author Ævar Arnfjörð Bjarmason <[email protected]>
 */

/**
 * Searches the database for files of the requested MIME type, comparing this with the
 * 'img_major_mime' and 'img_minor_mime' fields in the image table.
 * @ingroup SpecialPage
 */
class MIMEsearchPage extends QueryPage {
	protected $major, $minor, $mime;


	function __construct( $name = 'MIMEsearch' ) {
		parent::__construct( $name );
	}

	public function isExpensive() {
		return false;
	}

	function isSyndicated() {
		return false;
	}

	function isCacheable() {
		return false;
	}

	function linkParameters() {
		return [ 'mime' => "{$this->major}/{$this->minor}" ];
	}

	public function getQueryInfo() {
		$minorType = [];
		if ( $this->minor !== '*' ) {
			// Allow wildcard searching
			$minorType['img_minor_mime'] = $this->minor;
		}
		$qi = [
			'tables' => [ 'image' ],
			'fields' => [
				'namespace' => NS_FILE,
				'title' => 'img_name',
				// Still have a value field just in case,
				// but it isn't actually used for sorting.
				'value' => 'img_name',
				'img_size',
				'img_width',
				'img_height',
				'img_user_text',
				'img_timestamp'
			],
			'conds' => [
				'img_major_mime' => $this->major,
				// This is in order to trigger using
				// the img_media_mime index in "range" mode.
				'img_media_type' => [
					MEDIATYPE_BITMAP,
					MEDIATYPE_DRAWING,
					MEDIATYPE_AUDIO,
					MEDIATYPE_VIDEO,
					MEDIATYPE_MULTIMEDIA,
					MEDIATYPE_UNKNOWN,
					MEDIATYPE_OFFICE,
					MEDIATYPE_TEXT,
					MEDIATYPE_EXECUTABLE,
					MEDIATYPE_ARCHIVE,
				],
			] + $minorType,
		];

		return $qi;
	}

	/**
	 * The index is on (img_media_type, img_major_mime, img_minor_mime)
	 * which unfortunately doesn't have img_name at the end for sorting.
	 * So tell db to sort it however it wishes (Its not super important
	 * that this report gives results in a logical order). As an aditional
	 * note, mysql seems to by default order things by img_name ASC, which
	 * is what we ideally want, so everything works out fine anyhow.
	 * @return array
	 */
	function getOrderFields() {
		return [];
	}

	/**
	 * Generate and output the form
	 */
	function getPageHeader() {
		$formDescriptor = [
			'mime' => [
				'type' => 'text',
				'name' => 'mime',
				'label-message' => 'mimetype',
				'required' => true,
				'default' => $this->mime,
			],
		];

		$form = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
			->setWrapperLegendMsg( 'mimesearch' )
			->setSubmitTextMsg( 'ilsubmit' )
			->setAction( $this->getPageTitle()->getLocalURL() )
			->setMethod( 'get' )
			->prepareForm()
			->displayForm( false );
	}

	public function execute( $par ) {
		$this->mime = $par ? $par : $this->getRequest()->getText( 'mime' );
		$this->mime = trim( $this->mime );
		list( $this->major, $this->minor ) = File::splitMime( $this->mime );

		if ( $this->major == '' || $this->minor == '' || $this->minor == 'unknown' ||
			!self::isValidType( $this->major )
		) {
			$this->setHeaders();
			$this->outputHeader();
			$this->getPageHeader();
			return;
		}

		parent::execute( $par );
	}

	/**
	 * @param Skin $skin
	 * @param object $result Result row
	 * @return string
	 */
	function formatResult( $skin, $result ) {
		global $wgContLang;

		$nt = Title::makeTitle( $result->namespace, $result->title );
		$text = $wgContLang->convert( $nt->getText() );
		$plink = Linker::link(
			Title::newFromText( $nt->getPrefixedText() ),
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
			htmlspecialchars( $text )
		);

		$download = Linker::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
		$download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
		$lang = $this->getLanguage();
		$bytes = htmlspecialchars( $lang->formatSize( $result->img_size ) );
		$dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width,
			$result->img_height )->escaped();
		$user = Linker::link(
			Title::makeTitle( NS_USER, $result->img_user_text ),
			htmlspecialchars( $result->img_user_text )
		);

		$time = $lang->userTimeAndDate( $result->img_timestamp, $this->getUser() );
		$time = htmlspecialchars( $time );

		return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
	}

	/**
	 * @param string $type
	 * @return bool
	 */
	protected static function isValidType( $type ) {
		// From maintenance/tables.sql => img_major_mime
		$types = [
			'unknown',
			'application',
			'audio',
			'image',
			'text',
			'video',
			'message',
			'model',
			'multipart',
			'chemical'
		];

		return in_array( $type, $types );
	}

	public function preprocessResults( $db, $res ) {
		$this->executeLBFromResultWrapper( $res );
	}

	protected function getGroupName() {
		return 'media';
	}
}


1			<?php
2			/**
3			* Implements Special:MIMESearch
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			* @ingroup SpecialPage
22			* @author Ævar Arnfjörð Bjarmason <[email protected]>
23			*/
24
25			/**
26			* Searches the database for files of the requested MIME type, comparing this with the
27			* 'img_major_mime' and 'img_minor_mime' fields in the image table.
28			* @ingroup SpecialPage
29			*/
30			class MIMEsearchPage extends QueryPage {
31			protected $major, $minor, $mime;
			0 ignored issues – show Coding Style introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It is generally advisable to only define one property per statement. Only declaring a single property per statement allows you to later on add doc comments more easily. It is also recommended by PSR2, so it is a common style that many people expect. Loading history...
32
33			function __construct( $name = 'MIMEsearch' ) {
34			parent::__construct( $name );
35			}
36
37			public function isExpensive() {
38			return false;
39			}
40
41			function isSyndicated() {
42			return false;
43			}
44
45			function isCacheable() {
46			return false;
47			}
48
49			function linkParameters() {
50			return [ 'mime' => "{$this->major}/{$this->minor}" ];
51			}
52
53			public function getQueryInfo() {
54			$minorType = [];
55			if ( $this->minor !== '*' ) {
56			// Allow wildcard searching
57			$minorType['img_minor_mime'] = $this->minor;
58			}
59			$qi = [
60			'tables' => [ 'image' ],
61			'fields' => [
62			'namespace' => NS_FILE,
63			'title' => 'img_name',
64			// Still have a value field just in case,
65			// but it isn't actually used for sorting.
66			'value' => 'img_name',
67			'img_size',
68			'img_width',
69			'img_height',
70			'img_user_text',
71			'img_timestamp'
72			],
73			'conds' => [
74			'img_major_mime' => $this->major,
75			// This is in order to trigger using
76			// the img_media_mime index in "range" mode.
77			'img_media_type' => [
78			MEDIATYPE_BITMAP,
79			MEDIATYPE_DRAWING,
80			MEDIATYPE_AUDIO,
81			MEDIATYPE_VIDEO,
82			MEDIATYPE_MULTIMEDIA,
83			MEDIATYPE_UNKNOWN,
84			MEDIATYPE_OFFICE,
85			MEDIATYPE_TEXT,
86			MEDIATYPE_EXECUTABLE,
87			MEDIATYPE_ARCHIVE,
88			],
89			] + $minorType,
90			];
91
92			return $qi;
93			}
94
95			/**
96			* The index is on (img_media_type, img_major_mime, img_minor_mime)
97			* which unfortunately doesn't have img_name at the end for sorting.
98			* So tell db to sort it however it wishes (Its not super important
99			* that this report gives results in a logical order). As an aditional
100			* note, mysql seems to by default order things by img_name ASC, which
101			* is what we ideally want, so everything works out fine anyhow.
102			* @return array
103			*/
104			function getOrderFields() {
105			return [];
106			}
107
108			/**
109			* Generate and output the form
110			*/
111			function getPageHeader() {
112			$formDescriptor = [
113			'mime' => [
114			'type' => 'text',
115			'name' => 'mime',
116			'label-message' => 'mimetype',
117			'required' => true,
118			'default' => $this->mime,
119			],
120			];
121
122			$form = HTMLForm::factory( 'ooui', $formDescriptor, $this->getContext() )
			0 ignored issues – show Bug introduced 2016-05-08 17:45 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$form` is correct as `\HTMLForm::factory('ooui...m()->displayForm(false)` (which targets `HTMLForm::displayForm()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history... Unused Code introduced 2016-05-08 17:45 UTC by Report Bug Copy Issue Report `$form` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
123			->setWrapperLegendMsg( 'mimesearch' )
124			->setSubmitTextMsg( 'ilsubmit' )
125			->setAction( $this->getPageTitle()->getLocalURL() )
126			->setMethod( 'get' )
127			->prepareForm()
128			->displayForm( false );
129			}
130
131			public function execute( $par ) {
132			$this->mime = $par ? $par : $this->getRequest()->getText( 'mime' );
133			$this->mime = trim( $this->mime );
134			list( $this->major, $this->minor ) = File::splitMime( $this->mime );
135
136			if ( $this->major == '' \|\| $this->minor == '' \|\| $this->minor == 'unknown' \|\|
137			!self::isValidType( $this->major )
138			) {
139			$this->setHeaders();
140			$this->outputHeader();
141			$this->getPageHeader();
142			return;
143			}
144
145			parent::execute( $par );
146			}
147
148			/**
149			* @param Skin $skin
150			* @param object $result Result row
151			* @return string
152			*/
153			function formatResult( $skin, $result ) {
154			global $wgContLang;
155
156			$nt = Title::makeTitle( $result->namespace, $result->title );
157			$text = $wgContLang->convert( $nt->getText() );
158			$plink = Linker::link(
159			Title::newFromText( $nt->getPrefixedText() ),
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like `\Title::newFromText($nt->getPrefixedText())` can be `null`; however, `link()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
160			htmlspecialchars( $text )
161			);
162
163			$download = Linker::makeMediaLinkObj( $nt, $this->msg( 'download' )->escaped() );
164			$download = $this->msg( 'parentheses' )->rawParams( $download )->escaped();
165			$lang = $this->getLanguage();
166			$bytes = htmlspecialchars( $lang->formatSize( $result->img_size ) );
167			$dimensions = $this->msg( 'widthheight' )->numParams( $result->img_width,
168			$result->img_height )->escaped();
169			$user = Linker::link(
170			Title::makeTitle( NS_USER, $result->img_user_text ),
171			htmlspecialchars( $result->img_user_text )
172			);
173
174			$time = $lang->userTimeAndDate( $result->img_timestamp, $this->getUser() );
175			$time = htmlspecialchars( $time );
176
177			return "$download $plink . . $dimensions . . $bytes . . $user . . $time";
178			}
179
180			/**
181			* @param string $type
182			* @return bool
183			*/
184			protected static function isValidType( $type ) {
185			// From maintenance/tables.sql => img_major_mime
186			$types = [
187			'unknown',
188			'application',
189			'audio',
190			'image',
191			'text',
192			'video',
193			'message',
194			'model',
195			'multipart',
196			'chemical'
197			];
198
199			return in_array( $type, $types );
200			}
201
202			public function preprocessResults( $db, $res ) {
203			$this->executeLBFromResultWrapper( $res );
204			}
205
206			protected function getGroupName() {
207			return 'media';
208			}
209			}
210

wikimedia / mediawiki

Branch — master (715cbe)

MIMEsearchPage::isCacheable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like