Issues in ApiTag.php - All Issues - Inspection of "Daily Inspection: Merge "Add GENDER support to pro..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (939199)

unknown

created 2016-11-04 17:19 UTC

includes/api/ApiTag.php (1 issue)

Labels

Bug 1

Severity

Minor 1

Andrew H 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/**
 * 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 API
 * @since 1.25
 */
class ApiTag extends ApiBase {

	public function execute() {
		$params = $this->extractRequestParams();
		$user = $this->getUser();

		// make sure the user is allowed
		if ( !$user->isAllowed( 'changetags' ) ) {
			$this->dieUsage( "You don't have permission to add or remove change tags from individual edits",
				'permissiondenied' );
		}

		if ( $user->isBlocked() ) {
			$this->dieBlocked( $user->getBlock() );
/** @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);
    }
}
		}

		// validate and process each revid, rcid and logid
		$this->requireAtLeastOneParameter( $params, 'revid', 'rcid', 'logid' );
		$ret = [];
		if ( $params['revid'] ) {
			foreach ( $params['revid'] as $id ) {
				$ret[] = $this->processIndividual( 'revid', $params, $id );
			}
		}
		if ( $params['rcid'] ) {
			foreach ( $params['rcid'] as $id ) {
				$ret[] = $this->processIndividual( 'rcid', $params, $id );
			}
		}
		if ( $params['logid'] ) {
			foreach ( $params['logid'] as $id ) {
				$ret[] = $this->processIndividual( 'logid', $params, $id );
			}
		}

		ApiResult::setIndexedTagName( $ret, 'result' );
		$this->getResult()->addValue( null, $this->getModuleName(), $ret );
	}

	protected static function validateLogId( $logid ) {
		$dbr = wfGetDB( DB_REPLICA );
		$result = $dbr->selectField( 'logging', 'log_id', [ 'log_id' => $logid ],
			__METHOD__ );
		return (bool)$result;
	}

	protected function processIndividual( $type, $params, $id ) {
		$idResult = [ $type => $id ];

		// validate the ID
		$valid = false;
		switch ( $type ) {
			case 'rcid':
				$valid = RecentChange::newFromId( $id );
				break;
			case 'revid':
				$valid = Revision::newFromId( $id );
				break;
			case 'logid':
				$valid = self::validateLogId( $id );
				break;
		}

		if ( !$valid ) {
			$idResult['status'] = 'error';
			$idResult += $this->parseMsg( [ "nosuch$type", $id ] );
			return $idResult;
		}

		$status = ChangeTags::updateTagsWithChecks( $params['add'],
			$params['remove'],
			( $type === 'rcid' ? $id : null ),
			( $type === 'revid' ? $id : null ),
			( $type === 'logid' ? $id : null ),
			null,
			$params['reason'],
			$this->getUser() );

		if ( !$status->isOK() ) {
			if ( $status->hasMessage( 'actionthrottledtext' ) ) {
				$idResult['status'] = 'skipped';
			} else {
				$idResult['status'] = 'failure';
				$idResult['errors'] = $this->getErrorFormatter()->arrayFromStatus( $status, 'error' );
			}
		} else {
			$idResult['status'] = 'success';
			if ( is_null( $status->value->logId ) ) {
				$idResult['noop'] = '';
			} else {
				$idResult['actionlogid'] = $status->value->logId;
				$idResult['added'] = $status->value->addedTags;
				ApiResult::setIndexedTagName( $idResult['added'], 't' );
				$idResult['removed'] = $status->value->removedTags;
				ApiResult::setIndexedTagName( $idResult['removed'], 't' );
			}
		}
		return $idResult;
	}

	public function mustBePosted() {
		return true;
	}

	public function isWriteMode() {
		return true;
	}

	public function getAllowedParams() {
		return [
			'rcid' => [
				ApiBase::PARAM_TYPE => 'integer',
				ApiBase::PARAM_ISMULTI => true,
			],
			'revid' => [
				ApiBase::PARAM_TYPE => 'integer',
				ApiBase::PARAM_ISMULTI => true,
			],
			'logid' => [
				ApiBase::PARAM_TYPE => 'integer',
				ApiBase::PARAM_ISMULTI => true,
			],
			'add' => [
				ApiBase::PARAM_TYPE => 'tags',
				ApiBase::PARAM_ISMULTI => true,
			],
			'remove' => [
				ApiBase::PARAM_TYPE => 'string',
				ApiBase::PARAM_ISMULTI => true,
			],
			'reason' => [
				ApiBase::PARAM_DFLT => '',
			],
		];
	}

	public function needsToken() {
		return 'csrf';
	}

	protected function getExamplesMessages() {
		return [
			'action=tag&revid=123&add=vandalism&token=123ABC'
				=> 'apihelp-tag-example-rev',
			'action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC'
				=> 'apihelp-tag-example-log',
		];
	}

	public function getHelpUrls() {
		return 'https://www.mediawiki.org/wiki/API:Tag';
	}
}


1		<?php
2
3		/**
4		* This program is free software; you can redistribute it and/or modify
5		* it under the terms of the GNU General Public License as published by
6		* the Free Software Foundation; either version 2 of the License, or
7		* (at your option) any later version.
8		*
9		* This program is distributed in the hope that it will be useful,
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12		* GNU General Public License for more details.
13		*
14		* You should have received a copy of the GNU General Public License along
15		* with this program; if not, write to the Free Software Foundation, Inc.,
16		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17		* http://www.gnu.org/copyleft/gpl.html
18		*
19		* @file
20		*/
21
22		/**
23		* @ingroup API
24		* @since 1.25
25		*/
26		class ApiTag extends ApiBase {
27
28		public function execute() {
29		$params = $this->extractRequestParams();
30		$user = $this->getUser();
31
32		// make sure the user is allowed
33		if ( !$user->isAllowed( 'changetags' ) ) {
34		$this->dieUsage( "You don't have permission to add or remove change tags from individual edits",
35		'permissiondenied' );
36		}
37
38		if ( $user->isBlocked() ) {
39		$this->dieBlocked( $user->getBlock() );
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$user->getBlock()` can be `null`; however, `dieBlocked()` 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...
40		}
41
42		// validate and process each revid, rcid and logid
43		$this->requireAtLeastOneParameter( $params, 'revid', 'rcid', 'logid' );
44		$ret = [];
45		if ( $params['revid'] ) {
46		foreach ( $params['revid'] as $id ) {
47		$ret[] = $this->processIndividual( 'revid', $params, $id );
48		}
49		}
50	View Code Duplication	if ( $params['rcid'] ) {
51		foreach ( $params['rcid'] as $id ) {
52		$ret[] = $this->processIndividual( 'rcid', $params, $id );
53		}
54		}
55	View Code Duplication	if ( $params['logid'] ) {
56		foreach ( $params['logid'] as $id ) {
57		$ret[] = $this->processIndividual( 'logid', $params, $id );
58		}
59		}
60
61		ApiResult::setIndexedTagName( $ret, 'result' );
62		$this->getResult()->addValue( null, $this->getModuleName(), $ret );
63		}
64
65		protected static function validateLogId( $logid ) {
66		$dbr = wfGetDB( DB_REPLICA );
67		$result = $dbr->selectField( 'logging', 'log_id', [ 'log_id' => $logid ],
68		__METHOD__ );
69		return (bool)$result;
70		}
71
72		protected function processIndividual( $type, $params, $id ) {
73		$idResult = [ $type => $id ];
74
75		// validate the ID
76		$valid = false;
77		switch ( $type ) {
78		case 'rcid':
79		$valid = RecentChange::newFromId( $id );
80		break;
81		case 'revid':
82		$valid = Revision::newFromId( $id );
83		break;
84		case 'logid':
85		$valid = self::validateLogId( $id );
86		break;
87		}
88
89		if ( !$valid ) {
90		$idResult['status'] = 'error';
91		$idResult += $this->parseMsg( [ "nosuch$type", $id ] );
92		return $idResult;
93		}
94
95		$status = ChangeTags::updateTagsWithChecks( $params['add'],
96		$params['remove'],
97		( $type === 'rcid' ? $id : null ),
98		( $type === 'revid' ? $id : null ),
99		( $type === 'logid' ? $id : null ),
100		null,
101		$params['reason'],
102		$this->getUser() );
103
104		if ( !$status->isOK() ) {
105		if ( $status->hasMessage( 'actionthrottledtext' ) ) {
106		$idResult['status'] = 'skipped';
107		} else {
108		$idResult['status'] = 'failure';
109		$idResult['errors'] = $this->getErrorFormatter()->arrayFromStatus( $status, 'error' );
110		}
111		} else {
112		$idResult['status'] = 'success';
113		if ( is_null( $status->value->logId ) ) {
114		$idResult['noop'] = '';
115		} else {
116		$idResult['actionlogid'] = $status->value->logId;
117		$idResult['added'] = $status->value->addedTags;
118		ApiResult::setIndexedTagName( $idResult['added'], 't' );
119		$idResult['removed'] = $status->value->removedTags;
120		ApiResult::setIndexedTagName( $idResult['removed'], 't' );
121		}
122		}
123		return $idResult;
124		}
125
126		public function mustBePosted() {
127		return true;
128		}
129
130		public function isWriteMode() {
131		return true;
132		}
133
134		public function getAllowedParams() {
135		return [
136		'rcid' => [
137		ApiBase::PARAM_TYPE => 'integer',
138		ApiBase::PARAM_ISMULTI => true,
139		],
140		'revid' => [
141		ApiBase::PARAM_TYPE => 'integer',
142		ApiBase::PARAM_ISMULTI => true,
143		],
144		'logid' => [
145		ApiBase::PARAM_TYPE => 'integer',
146		ApiBase::PARAM_ISMULTI => true,
147		],
148		'add' => [
149		ApiBase::PARAM_TYPE => 'tags',
150		ApiBase::PARAM_ISMULTI => true,
151		],
152		'remove' => [
153		ApiBase::PARAM_TYPE => 'string',
154		ApiBase::PARAM_ISMULTI => true,
155		],
156		'reason' => [
157		ApiBase::PARAM_DFLT => '',
158		],
159		];
160		}
161
162		public function needsToken() {
163		return 'csrf';
164		}
165
166		protected function getExamplesMessages() {
167		return [
168		'action=tag&revid=123&add=vandalism&token=123ABC'
169		=> 'apihelp-tag-example-rev',
170		'action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC'
171		=> 'apihelp-tag-example-log',
172		];
173		}
174
175		public function getHelpUrls() {
176		return 'https://www.mediawiki.org/wiki/API:Tag';
177		}
178		}
179

wikimedia / mediawiki

Branch — master (939199)

includes/api/ApiTag.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like