Issues in ApiMove.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/ApiMove.php (2 issues)

Labels

Bug 2

Severity

Minor 2

Kunal Mehta 2

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
/**
 *
 *
 * Created on Oct 31, 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
 */

/**
 * API Module to move pages
 * @ingroup API
 */
class ApiMove extends ApiBase {

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

		$user = $this->getUser();
		$params = $this->extractRequestParams();

		$this->requireOnlyOneParameter( $params, 'from', 'fromid' );

		if ( isset( $params['from'] ) ) {
			$fromTitle = Title::newFromText( $params['from'] );
			if ( !$fromTitle || $fromTitle->isExternal() ) {
				$this->dieUsageMsg( [ 'invalidtitle', $params['from'] ] );
			}
		} elseif ( isset( $params['fromid'] ) ) {
			$fromTitle = Title::newFromID( $params['fromid'] );
			if ( !$fromTitle ) {
				$this->dieUsageMsg( [ 'nosuchpageid', $params['fromid'] ] );
			}
		}

		if ( !$fromTitle->exists() ) {
			$this->dieUsageMsg( 'notanarticle' );
		}
		$fromTalk = $fromTitle->getTalkPage();

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

		if ( $toTitle->getNamespace() == NS_FILE
			&& !RepoGroup::singleton()->getLocalRepo()->findFile( $toTitle )
			&& wfFindFile( $toTitle )
		) {
			if ( !$params['ignorewarnings'] && $user->isAllowed( 'reupload-shared' ) ) {
				$this->dieUsageMsg( 'sharedfile-exists' );
			} elseif ( !$user->isAllowed( 'reupload-shared' ) ) {
				$this->dieUsageMsg( 'cantoverwrite-sharedfile' );
			}
		}

		// Rate limit
		if ( $user->pingLimiter( 'move' ) ) {
			$this->dieUsageMsg( 'actionthrottledtext' );
		}

		// Move the page
		$toTitleExists = $toTitle->exists();
		$status = $this->movePage( $fromTitle, $toTitle, $params['reason'], !$params['noredirect'] );
/** @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);
    }
}
		if ( !$status->isOK() ) {
			$this->dieStatus( $status );
		}

		$r = [
			'from' => $fromTitle->getPrefixedText(),
			'to' => $toTitle->getPrefixedText(),
			'reason' => $params['reason']
		];

		// NOTE: we assume that if the old title exists, it's because it was re-created as
		// a redirect to the new title. This is not safe, but what we did before was
		// even worse: we just determined whether a redirect should have been created,
		// and reported that it was created if it should have, without any checks.
		// Also note that isRedirect() is unreliable because of bug 37209.
		$r['redirectcreated'] = $fromTitle->exists();

		$r['moveoverredirect'] = $toTitleExists;

		// Move the talk page
		if ( $params['movetalk'] && $fromTalk->exists() && !$fromTitle->isTalkPage() ) {
			$toTalkExists = $toTalk->exists();
			$status = $this->movePage( $fromTalk, $toTalk, $params['reason'], !$params['noredirect'] );
			if ( $status->isOK() ) {
				$r['talkfrom'] = $fromTalk->getPrefixedText();
				$r['talkto'] = $toTalk->getPrefixedText();
				$r['talkmoveoverredirect'] = $toTalkExists;
			} else {
				// We're not gonna dieUsage() on failure, since we already changed something
				$error = $this->getErrorFromStatus( $status );
				$r['talkmove-error-code'] = $error[0];
				$r['talkmove-error-info'] = $error[1];
			}
		}

		$result = $this->getResult();

		// Move subpages
		if ( $params['movesubpages'] ) {
			$r['subpages'] = $this->moveSubpages( $fromTitle, $toTitle,
				$params['reason'], $params['noredirect'] );
			ApiResult::setIndexedTagName( $r['subpages'], 'subpage' );

			if ( $params['movetalk'] ) {
				$r['subpages-talk'] = $this->moveSubpages( $fromTalk, $toTalk,
					$params['reason'], $params['noredirect'] );
				ApiResult::setIndexedTagName( $r['subpages-talk'], 'subpage' );
			}
		}

		$watch = 'preferences';
		if ( isset( $params['watchlist'] ) ) {
			$watch = $params['watchlist'];
		} elseif ( $params['watch'] ) {
			$watch = 'watch';
		} elseif ( $params['unwatch'] ) {
			$watch = 'unwatch';
		}

		// Watch pages
		$this->setWatch( $watch, $fromTitle, 'watchmoves' );
		$this->setWatch( $watch, $toTitle, 'watchmoves' );

		$result->addValue( null, $this->getModuleName(), $r );
	}

	/**
	 * @param Title $from
	 * @param Title $to
	 * @param string $reason
	 * @param bool $createRedirect
	 * @return Status
	 */
	protected function movePage( Title $from, Title $to, $reason, $createRedirect ) {
		$mp = new MovePage( $from, $to );
		$valid = $mp->isValidMove();
		if ( !$valid->isOK() ) {
			return $valid;
		}

		$permStatus = $mp->checkPermissions( $this->getUser(), $reason );
		if ( !$permStatus->isOK() ) {
			return $permStatus;
		}

		// Check suppressredirect permission
		if ( !$this->getUser()->isAllowed( 'suppressredirect' ) ) {
			$createRedirect = true;
		}

		return $mp->move( $this->getUser(), $reason, $createRedirect );
	}

	/**
	 * @param Title $fromTitle
	 * @param Title $toTitle
	 * @param string $reason
	 * @param bool $noredirect
	 * @return array
	 */
	public function moveSubpages( $fromTitle, $toTitle, $reason, $noredirect ) {
		$retval = [];
		$success = $fromTitle->moveSubpages( $toTitle, true, $reason, !$noredirect );
		if ( isset( $success[0] ) ) {
			return [ 'error' => $this->parseMsg( $success ) ];
		}

		// At least some pages could be moved
		// Report each of them separately
		foreach ( $success as $oldTitle => $newTitle ) {
			$r = [ 'from' => $oldTitle ];
			if ( is_array( $newTitle ) ) {
				$r['error'] = $this->parseMsg( reset( $newTitle ) );
			} else {
				// Success
				$r['to'] = $newTitle;
			}
			$retval[] = $r;
		}

		return $retval;
	}

	public function mustBePosted() {
		return true;
	}

	public function isWriteMode() {
		return true;
	}

	public function getAllowedParams() {
		return [
			'from' => null,
			'fromid' => [
				ApiBase::PARAM_TYPE => 'integer'
			],
			'to' => [
				ApiBase::PARAM_TYPE => 'string',
				ApiBase::PARAM_REQUIRED => true
			],
			'reason' => '',
			'movetalk' => false,
			'movesubpages' => false,
			'noredirect' => false,
			'watch' => [
				ApiBase::PARAM_DFLT => false,
				ApiBase::PARAM_DEPRECATED => true,
			],
			'unwatch' => [
				ApiBase::PARAM_DFLT => false,
				ApiBase::PARAM_DEPRECATED => true,
			],
			'watchlist' => [
				ApiBase::PARAM_DFLT => 'preferences',
				ApiBase::PARAM_TYPE => [
					'watch',
					'unwatch',
					'preferences',
					'nochange'
				],
			],
			'ignorewarnings' => false
		];
	}

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

	protected function getExamplesMessages() {
		return [
			'action=move&from=Badtitle&to=Goodtitle&token=123ABC&' .
				'reason=Misspelled%20title&movetalk=&noredirect='
				=> 'apihelp-move-example-move',
		];
	}

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


1		<?php
2		/**
3		*
4		*
5		* Created on Oct 31, 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		* API Module to move pages
29		* @ingroup API
30		*/
31		class ApiMove extends ApiBase {
32
33		public function execute() {
34		$this->useTransactionalTimeLimit();
35
36		$user = $this->getUser();
37		$params = $this->extractRequestParams();
38
39		$this->requireOnlyOneParameter( $params, 'from', 'fromid' );
40
41	View Code Duplication	if ( isset( $params['from'] ) ) {
42		$fromTitle = Title::newFromText( $params['from'] );
43		if ( !$fromTitle \|\| $fromTitle->isExternal() ) {
44		$this->dieUsageMsg( [ 'invalidtitle', $params['from'] ] );
45		}
46		} elseif ( isset( $params['fromid'] ) ) {
47		$fromTitle = Title::newFromID( $params['fromid'] );
48		if ( !$fromTitle ) {
49		$this->dieUsageMsg( [ 'nosuchpageid', $params['fromid'] ] );
50		}
51		}
52
53		if ( !$fromTitle->exists() ) {
54		$this->dieUsageMsg( 'notanarticle' );
55		}
56		$fromTalk = $fromTitle->getTalkPage();
57
58		$toTitle = Title::newFromText( $params['to'] );
59		if ( !$toTitle \|\| $toTitle->isExternal() ) {
60		$this->dieUsageMsg( [ 'invalidtitle', $params['to'] ] );
61		}
62		$toTalk = $toTitle->getTalkPage();
63
64		if ( $toTitle->getNamespace() == NS_FILE
65		&& !RepoGroup::singleton()->getLocalRepo()->findFile( $toTitle )
66		&& wfFindFile( $toTitle )
67		) {
68		if ( !$params['ignorewarnings'] && $user->isAllowed( 'reupload-shared' ) ) {
69		$this->dieUsageMsg( 'sharedfile-exists' );
70		} elseif ( !$user->isAllowed( 'reupload-shared' ) ) {
71		$this->dieUsageMsg( 'cantoverwrite-sharedfile' );
72		}
73		}
74
75		// Rate limit
76		if ( $user->pingLimiter( 'move' ) ) {
77		$this->dieUsageMsg( 'actionthrottledtext' );
78		}
79
80		// Move the page
81		$toTitleExists = $toTitle->exists();
82		$status = $this->movePage( $fromTitle, $toTitle, $params['reason'], !$params['noredirect'] );
		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 `$fromTitle` can be `null`; however, `movePage()` 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... Bug introduced 2016-02-23 18:13 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like `$toTitle` defined by `\Title::newFromText($params['to'])` on line `58` can be `null`; however, `ApiMove::movePage()` 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...
83		if ( !$status->isOK() ) {
84		$this->dieStatus( $status );
85		}
86
87		$r = [
88		'from' => $fromTitle->getPrefixedText(),
89		'to' => $toTitle->getPrefixedText(),
90		'reason' => $params['reason']
91		];
92
93		// NOTE: we assume that if the old title exists, it's because it was re-created as
94		// a redirect to the new title. This is not safe, but what we did before was
95		// even worse: we just determined whether a redirect should have been created,
96		// and reported that it was created if it should have, without any checks.
97		// Also note that isRedirect() is unreliable because of bug 37209.
98		$r['redirectcreated'] = $fromTitle->exists();
99
100		$r['moveoverredirect'] = $toTitleExists;
101
102		// Move the talk page
103		if ( $params['movetalk'] && $fromTalk->exists() && !$fromTitle->isTalkPage() ) {
104		$toTalkExists = $toTalk->exists();
105		$status = $this->movePage( $fromTalk, $toTalk, $params['reason'], !$params['noredirect'] );
106		if ( $status->isOK() ) {
107		$r['talkfrom'] = $fromTalk->getPrefixedText();
108		$r['talkto'] = $toTalk->getPrefixedText();
109		$r['talkmoveoverredirect'] = $toTalkExists;
110		} else {
111		// We're not gonna dieUsage() on failure, since we already changed something
112		$error = $this->getErrorFromStatus( $status );
113		$r['talkmove-error-code'] = $error[0];
114		$r['talkmove-error-info'] = $error[1];
115		}
116		}
117
118		$result = $this->getResult();
119
120		// Move subpages
121		if ( $params['movesubpages'] ) {
122		$r['subpages'] = $this->moveSubpages( $fromTitle, $toTitle,
123		$params['reason'], $params['noredirect'] );
124		ApiResult::setIndexedTagName( $r['subpages'], 'subpage' );
125
126		if ( $params['movetalk'] ) {
127		$r['subpages-talk'] = $this->moveSubpages( $fromTalk, $toTalk,
128		$params['reason'], $params['noredirect'] );
129		ApiResult::setIndexedTagName( $r['subpages-talk'], 'subpage' );
130		}
131		}
132
133		$watch = 'preferences';
134	View Code Duplication	if ( isset( $params['watchlist'] ) ) {
135		$watch = $params['watchlist'];
136		} elseif ( $params['watch'] ) {
137		$watch = 'watch';
138		} elseif ( $params['unwatch'] ) {
139		$watch = 'unwatch';
140		}
141
142		// Watch pages
143		$this->setWatch( $watch, $fromTitle, 'watchmoves' );
144		$this->setWatch( $watch, $toTitle, 'watchmoves' );
145
146		$result->addValue( null, $this->getModuleName(), $r );
147		}
148
149		/**
150		* @param Title $from
151		* @param Title $to
152		* @param string $reason
153		* @param bool $createRedirect
154		* @return Status
155		*/
156		protected function movePage( Title $from, Title $to, $reason, $createRedirect ) {
157		$mp = new MovePage( $from, $to );
158		$valid = $mp->isValidMove();
159		if ( !$valid->isOK() ) {
160		return $valid;
161		}
162
163		$permStatus = $mp->checkPermissions( $this->getUser(), $reason );
164		if ( !$permStatus->isOK() ) {
165		return $permStatus;
166		}
167
168		// Check suppressredirect permission
169		if ( !$this->getUser()->isAllowed( 'suppressredirect' ) ) {
170		$createRedirect = true;
171		}
172
173		return $mp->move( $this->getUser(), $reason, $createRedirect );
174		}
175
176		/**
177		* @param Title $fromTitle
178		* @param Title $toTitle
179		* @param string $reason
180		* @param bool $noredirect
181		* @return array
182		*/
183		public function moveSubpages( $fromTitle, $toTitle, $reason, $noredirect ) {
184		$retval = [];
185		$success = $fromTitle->moveSubpages( $toTitle, true, $reason, !$noredirect );
186		if ( isset( $success[0] ) ) {
187		return [ 'error' => $this->parseMsg( $success ) ];
188		}
189
190		// At least some pages could be moved
191		// Report each of them separately
192		foreach ( $success as $oldTitle => $newTitle ) {
193		$r = [ 'from' => $oldTitle ];
194		if ( is_array( $newTitle ) ) {
195		$r['error'] = $this->parseMsg( reset( $newTitle ) );
196		} else {
197		// Success
198		$r['to'] = $newTitle;
199		}
200		$retval[] = $r;
201		}
202
203		return $retval;
204		}
205
206		public function mustBePosted() {
207		return true;
208		}
209
210		public function isWriteMode() {
211		return true;
212		}
213
214		public function getAllowedParams() {
215		return [
216		'from' => null,
217		'fromid' => [
218		ApiBase::PARAM_TYPE => 'integer'
219		],
220		'to' => [
221		ApiBase::PARAM_TYPE => 'string',
222		ApiBase::PARAM_REQUIRED => true
223		],
224		'reason' => '',
225		'movetalk' => false,
226		'movesubpages' => false,
227		'noredirect' => false,
228		'watch' => [
229		ApiBase::PARAM_DFLT => false,
230		ApiBase::PARAM_DEPRECATED => true,
231		],
232		'unwatch' => [
233		ApiBase::PARAM_DFLT => false,
234		ApiBase::PARAM_DEPRECATED => true,
235		],
236		'watchlist' => [
237		ApiBase::PARAM_DFLT => 'preferences',
238		ApiBase::PARAM_TYPE => [
239		'watch',
240		'unwatch',
241		'preferences',
242		'nochange'
243		],
244		],
245		'ignorewarnings' => false
246		];
247		}
248
249		public function needsToken() {
250		return 'csrf';
251		}
252
253		protected function getExamplesMessages() {
254		return [
255		'action=move&from=Badtitle&to=Goodtitle&token=123ABC&' .
256		'reason=Misspelled%20title&movetalk=&noredirect='
257		=> 'apihelp-move-example-move',
258		];
259		}
260
261		public function getHelpUrls() {
262		return 'https://www.mediawiki.org/wiki/API:Move';
263		}
264		}
265

wikimedia / mediawiki

Branch — master (939199)

includes/api/ApiMove.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like