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

ApiUndelete::mustBePosted() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: ApiUndelete

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
/**
 *
 *
 * Created on Jul 3, 2007
 *
 * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
 *
 * 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
 */
class ApiUndelete extends ApiBase {

	public function execute() {
		$this->useTransactionalTimeLimit();

		$params = $this->extractRequestParams();
		$user = $this->getUser();
		if ( !$user->isAllowed( 'undelete' ) ) {
			$this->dieUsageMsg( 'permdenied-undelete' );
		}

		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);
    }
}
		}

		$titleObj = Title::newFromText( $params['title'] );
		if ( !$titleObj || $titleObj->isExternal() ) {
			$this->dieUsageMsg( [ 'invalidtitle', $params['title'] ] );
		}

		// Check if user can add tags
		if ( !is_null( $params['tags'] ) ) {
			$ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
			if ( !$ableToTag->isOK() ) {
				$this->dieStatus( $ableToTag );
			}
		}

		// Convert timestamps
		if ( !isset( $params['timestamps'] ) ) {
			$params['timestamps'] = [];
		}
		if ( !is_array( $params['timestamps'] ) ) {
			$params['timestamps'] = [ $params['timestamps'] ];
		}
		foreach ( $params['timestamps'] as $i => $ts ) {
			$params['timestamps'][$i] = wfTimestamp( TS_MW, $ts );
		}

		$pa = new PageArchive( $titleObj, $this->getConfig() );
		$retval = $pa->undelete(
			( isset( $params['timestamps'] ) ? $params['timestamps'] : [] ),
			$params['reason'],
			$params['fileids'],
			false,
			$user,
			$params['tags']
		);
		if ( !is_array( $retval ) ) {
			$this->dieUsageMsg( 'cannotundelete' );
		}

		if ( $retval[1] ) {
			Hooks::run( 'FileUndeleteComplete',
				[ $titleObj, $params['fileids'], $this->getUser(), $params['reason'] ] );
		}

		$this->setWatch( $params['watchlist'], $titleObj );
/** @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);
    }
}

		$info['title'] = $titleObj->getPrefixedText();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
		$info['revisions'] = intval( $retval[0] );
		$info['fileversions'] = intval( $retval[1] );
		$info['reason'] = $retval[2];
		$this->getResult()->addValue( null, $this->getModuleName(), $info );
	}

	public function mustBePosted() {
		return true;
	}

	public function isWriteMode() {
		return true;
	}

	public function getAllowedParams() {
		return [
			'title' => [
				ApiBase::PARAM_TYPE => 'string',
				ApiBase::PARAM_REQUIRED => true
			],
			'reason' => '',
			'tags' => [
				ApiBase::PARAM_TYPE => 'tags',
				ApiBase::PARAM_ISMULTI => true,
			],
			'timestamps' => [
				ApiBase::PARAM_TYPE => 'timestamp',
				ApiBase::PARAM_ISMULTI => true,
			],
			'fileids' => [
				ApiBase::PARAM_TYPE => 'integer',
				ApiBase::PARAM_ISMULTI => true,
			],
			'watchlist' => [
				ApiBase::PARAM_DFLT => 'preferences',
				ApiBase::PARAM_TYPE => [
					'watch',
					'unwatch',
					'preferences',
					'nochange'
				],
			],
		];
	}

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

	protected function getExamplesMessages() {
		return [
			'action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page'
				=> 'apihelp-undelete-example-page',
			'action=undelete&title=Main%20Page&token=123ABC' .
				'&timestamps=2007-07-03T22:00:45Z|2007-07-02T19:48:56Z'
				=> 'apihelp-undelete-example-revisions',
		];
	}

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


1		<?php
2		/**
3		*
4		*
5		* Created on Jul 3, 2007
6		*
7		* Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
8		*
9		* This program is free software; you can redistribute it and/or modify
10		* it under the terms of the GNU General Public License as published by
11		* the Free Software Foundation; either version 2 of the License, or
12		* (at your option) any later version.
13		*
14		* This program is distributed in the hope that it will be useful,
15		* but WITHOUT ANY WARRANTY; without even the implied warranty of
16		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17		* GNU General Public License for more details.
18		*
19		* You should have received a copy of the GNU General Public License along
20		* with this program; if not, write to the Free Software Foundation, Inc.,
21		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22		* http://www.gnu.org/copyleft/gpl.html
23		*
24		* @file
25		*/
26
27		/**
28		* @ingroup API
29		*/
30		class ApiUndelete extends ApiBase {
31
32		public function execute() {
33		$this->useTransactionalTimeLimit();
34
35		$params = $this->extractRequestParams();
36		$user = $this->getUser();
37		if ( !$user->isAllowed( 'undelete' ) ) {
38		$this->dieUsageMsg( 'permdenied-undelete' );
39		}
40
41		if ( $user->isBlocked() ) {
42		$this->dieBlocked( $user->getBlock() );
		0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report 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...
43		}
44
45		$titleObj = Title::newFromText( $params['title'] );
46		if ( !$titleObj \|\| $titleObj->isExternal() ) {
47		$this->dieUsageMsg( [ 'invalidtitle', $params['title'] ] );
48		}
49
50		// Check if user can add tags
51	View Code Duplication	if ( !is_null( $params['tags'] ) ) {
52		$ableToTag = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
53		if ( !$ableToTag->isOK() ) {
54		$this->dieStatus( $ableToTag );
55		}
56		}
57
58		// Convert timestamps
59		if ( !isset( $params['timestamps'] ) ) {
60		$params['timestamps'] = [];
61		}
62		if ( !is_array( $params['timestamps'] ) ) {
63		$params['timestamps'] = [ $params['timestamps'] ];
64		}
65		foreach ( $params['timestamps'] as $i => $ts ) {
66		$params['timestamps'][$i] = wfTimestamp( TS_MW, $ts );
67		}
68
69		$pa = new PageArchive( $titleObj, $this->getConfig() );
70		$retval = $pa->undelete(
71		( isset( $params['timestamps'] ) ? $params['timestamps'] : [] ),
72		$params['reason'],
73		$params['fileids'],
74		false,
75		$user,
76		$params['tags']
77		);
78		if ( !is_array( $retval ) ) {
79		$this->dieUsageMsg( 'cannotundelete' );
80		}
81
82		if ( $retval[1] ) {
83		Hooks::run( 'FileUndeleteComplete',
84		[ $titleObj, $params['fileids'], $this->getUser(), $params['reason'] ] );
85		}
86
87		$this->setWatch( $params['watchlist'], $titleObj );
		0 ignored issues – show Bug introduced 2016-02-23 18:13 UTC by Report Bug Copy Issue Report It seems like `$titleObj` defined by `\Title::newFromText($params['title'])` on line `45` can be `null`; however, `ApiBase::setWatch()` 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...
88
89		$info['title'] = $titleObj->getPrefixedText();
		0 ignored issues – show Coding Style Comprehensibility introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report `$info` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$info = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
90		$info['revisions'] = intval( $retval[0] );
91		$info['fileversions'] = intval( $retval[1] );
92		$info['reason'] = $retval[2];
93		$this->getResult()->addValue( null, $this->getModuleName(), $info );
94		}
95
96		public function mustBePosted() {
97		return true;
98		}
99
100		public function isWriteMode() {
101		return true;
102		}
103
104		public function getAllowedParams() {
105		return [
106		'title' => [
107		ApiBase::PARAM_TYPE => 'string',
108		ApiBase::PARAM_REQUIRED => true
109		],
110		'reason' => '',
111		'tags' => [
112		ApiBase::PARAM_TYPE => 'tags',
113		ApiBase::PARAM_ISMULTI => true,
114		],
115		'timestamps' => [
116		ApiBase::PARAM_TYPE => 'timestamp',
117		ApiBase::PARAM_ISMULTI => true,
118		],
119		'fileids' => [
120		ApiBase::PARAM_TYPE => 'integer',
121		ApiBase::PARAM_ISMULTI => true,
122		],
123		'watchlist' => [
124		ApiBase::PARAM_DFLT => 'preferences',
125		ApiBase::PARAM_TYPE => [
126		'watch',
127		'unwatch',
128		'preferences',
129		'nochange'
130		],
131		],
132		];
133		}
134
135		public function needsToken() {
136		return 'csrf';
137		}
138
139		protected function getExamplesMessages() {
140		return [
141		'action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page'
142		=> 'apihelp-undelete-example-page',
143		'action=undelete&title=Main%20Page&token=123ABC' .
144		'&timestamps=2007-07-03T22:00:45Z\|2007-07-02T19:48:56Z'
145		=> 'apihelp-undelete-example-revisions',
146		];
147		}
148
149		public function getHelpUrls() {
150		return 'https://www.mediawiki.org/wiki/API:Undelete';
151		}
152		}
153

wikimedia / mediawiki

ApiUndelete::mustBePosted() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ApiUndelete::mustBePosted() A
last analyzed 2016-11-13 17:42 UTC