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

ApiDelete::getHelpUrls() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: ApiDelete

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 Jun 30, 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 that facilitates deleting pages. The API equivalent of action=delete.
 * Requires API write mode to be enabled.
 *
 * @ingroup API
 */
class ApiDelete extends ApiBase {
	/**
	 * Extracts the title and reason from the request parameters and invokes
	 * the local delete() function with these as arguments. It does not make use of
	 * the delete function specified by Article.php. If the deletion succeeds, the
	 * details of the article deleted and the reason for deletion are added to the
	 * result object.
	 */
	public function execute() {
		$this->useTransactionalTimeLimit();

		$params = $this->extractRequestParams();

		$pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
		if ( !$pageObj->exists() ) {
			$this->dieUsageMsg( 'notanarticle' );
		}

		$titleObj = $pageObj->getTitle();
		$reason = $params['reason'];
		$user = $this->getUser();

		// Check that the user is allowed to carry out the deletion
		$errors = $titleObj->getUserPermissionsErrors( 'delete', $user );
		if ( count( $errors ) ) {
			$this->dieUsageMsg( $errors[0] );
		}

		// If change tagging was requested, check that the user is allowed to tag,
		// and the tags are valid
		if ( count( $params['tags'] ) ) {
			$tagStatus = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
			if ( !$tagStatus->isOK() ) {
				$this->dieStatus( $tagStatus );
			}
		}

		if ( $titleObj->getNamespace() == NS_FILE ) {
			$status = self::deleteFile(
				$pageObj,
/** @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);
    }
}
				$user,
				$params['oldimage'],
				$reason,
				false,
				$params['tags']
			);
		} else {
			$status = self::delete( $pageObj, $user, $reason, $params['tags'] );
/** @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 ( is_array( $status ) ) {
			$this->dieUsageMsg( $status[0] );
		}
		if ( !$status->isGood() ) {
			$this->dieStatus( $status );
		}

		// Deprecated parameters
		if ( $params['watch'] ) {
			$watch = 'watch';
		} elseif ( $params['unwatch'] ) {
			$watch = 'unwatch';
		} else {
			$watch = $params['watchlist'];
		}
		$this->setWatch( $watch, $titleObj, 'watchdeletion' );

		$r = [
			'title' => $titleObj->getPrefixedText(),
			'reason' => $reason,
			'logid' => $status->value
		];
		$this->getResult()->addValue( null, $this->getModuleName(), $r );
	}

	/**
	 * We have our own delete() function, since Article.php's implementation is split in two phases
	 *
	 * @param Page|WikiPage $page Page or WikiPage object to work on
	 * @param User $user User doing the action
	 * @param string|null $reason Reason for the deletion. Autogenerated if null
	 * @param array $tags Tags to tag the deletion with
	 * @return Status|array
	 */
	protected static function delete( Page $page, User $user, &$reason = null, $tags = [] ) {
		$title = $page->getTitle();

		// Auto-generate a summary, if necessary
		if ( is_null( $reason ) ) {
			// Need to pass a throwaway variable because generateReason expects
			// a reference
			$hasHistory = false;
			$reason = $page->getAutoDeleteReason( $hasHistory );
			if ( $reason === false ) {
				return [ [ 'cannotdelete', $title->getPrefixedText() ] ];
			}
		}

		$error = '';

		// Luckily, Article.php provides a reusable delete function that does the hard work for us
		return $page->doDeleteArticleReal( $reason, false, 0, true, $error, $user, $tags );
	}

	/**
	 * @param Page $page Object to work on
	 * @param User $user User doing the action
	 * @param string $oldimage Archive name
	 * @param string $reason Reason for the deletion. Autogenerated if null.
	 * @param bool $suppress Whether to mark all deleted versions as restricted
	 * @param array $tags Tags to tag the deletion with
	 * @return Status|array
	 */
	protected static function deleteFile( Page $page, User $user, $oldimage,
		&$reason = null, $suppress = false, $tags = []
	) {
		$title = $page->getTitle();

		$file = $page->getFile();
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
		if ( !$file->exists() || !$file->isLocal() || $file->getRedirected() ) {
			return self::delete( $page, $user, $reason, $tags );
		}

		if ( $oldimage ) {
			if ( !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
				return [ [ 'invalidoldimage' ] ];
			}
			$oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
			if ( !$oldfile->exists() || !$oldfile->isLocal() || $oldfile->getRedirected() ) {
				return [ [ 'nodeleteablefile' ] ];
			}
		}

		if ( is_null( $reason ) ) { // Log and RC don't like null reasons
			$reason = '';
		}

		return FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress, $user, $tags );
	}

	public function mustBePosted() {
		return true;
	}

	public function isWriteMode() {
		return true;
	}

	public function getAllowedParams() {
		return [
			'title' => null,
			'pageid' => [
				ApiBase::PARAM_TYPE => 'integer'
			],
			'reason' => null,
			'tags' => [
				ApiBase::PARAM_TYPE => 'tags',
				ApiBase::PARAM_ISMULTI => true,
			],
			'watch' => [
				ApiBase::PARAM_DFLT => false,
				ApiBase::PARAM_DEPRECATED => true,
			],
			'watchlist' => [
				ApiBase::PARAM_DFLT => 'preferences',
				ApiBase::PARAM_TYPE => [
					'watch',
					'unwatch',
					'preferences',
					'nochange'
				],
			],
			'unwatch' => [
				ApiBase::PARAM_DFLT => false,
				ApiBase::PARAM_DEPRECATED => true,
			],
			'oldimage' => null,
		];
	}

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

	protected function getExamplesMessages() {
		return [
			'action=delete&title=Main%20Page&token=123ABC'
				=> 'apihelp-delete-example-simple',
			'action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
				=> 'apihelp-delete-example-reason',
		];
	}

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


1		<?php
2		/**
3		*
4		*
5		* Created on Jun 30, 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 that facilitates deleting pages. The API equivalent of action=delete.
29		* Requires API write mode to be enabled.
30		*
31		* @ingroup API
32		*/
33		class ApiDelete extends ApiBase {
34		/**
35		* Extracts the title and reason from the request parameters and invokes
36		* the local delete() function with these as arguments. It does not make use of
37		* the delete function specified by Article.php. If the deletion succeeds, the
38		* details of the article deleted and the reason for deletion are added to the
39		* result object.
40		*/
41		public function execute() {
42		$this->useTransactionalTimeLimit();
43
44		$params = $this->extractRequestParams();
45
46		$pageObj = $this->getTitleOrPageId( $params, 'fromdbmaster' );
47		if ( !$pageObj->exists() ) {
48		$this->dieUsageMsg( 'notanarticle' );
49		}
50
51		$titleObj = $pageObj->getTitle();
52		$reason = $params['reason'];
53		$user = $this->getUser();
54
55		// Check that the user is allowed to carry out the deletion
56		$errors = $titleObj->getUserPermissionsErrors( 'delete', $user );
57		if ( count( $errors ) ) {
58		$this->dieUsageMsg( $errors[0] );
59		}
60
61		// If change tagging was requested, check that the user is allowed to tag,
62		// and the tags are valid
63	View Code Duplication	if ( count( $params['tags'] ) ) {
64		$tagStatus = ChangeTags::canAddTagsAccompanyingChange( $params['tags'], $user );
65		if ( !$tagStatus->isOK() ) {
66		$this->dieStatus( $tagStatus );
67		}
68		}
69
70		if ( $titleObj->getNamespace() == NS_FILE ) {
71		$status = self::deleteFile(
72		$pageObj,
		0 ignored issues – show Bug introduced 2016-02-23 18:13 UTC by Report Bug Copy Issue Report It seems like `$pageObj` defined by `$this->getTitleOrPageId($params, 'fromdbmaster')` on line `46` can be `null`; however, `ApiDelete::deleteFile()` 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...
73		$user,
74		$params['oldimage'],
75		$reason,
76		false,
77		$params['tags']
78		);
79		} else {
80		$status = self::delete( $pageObj, $user, $reason, $params['tags'] );
		0 ignored issues – show Bug introduced 2016-09-23 18:28 UTC by Report Bug Copy Issue Report It seems like `$pageObj` defined by `$this->getTitleOrPageId($params, 'fromdbmaster')` on line `46` can be `null`; however, `ApiDelete::delete()` 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...
81		}
82
83		if ( is_array( $status ) ) {
84		$this->dieUsageMsg( $status[0] );
85		}
86		if ( !$status->isGood() ) {
87		$this->dieStatus( $status );
88		}
89
90		// Deprecated parameters
91	View Code Duplication	if ( $params['watch'] ) {
92		$watch = 'watch';
93		} elseif ( $params['unwatch'] ) {
94		$watch = 'unwatch';
95		} else {
96		$watch = $params['watchlist'];
97		}
98		$this->setWatch( $watch, $titleObj, 'watchdeletion' );
99
100		$r = [
101		'title' => $titleObj->getPrefixedText(),
102		'reason' => $reason,
103		'logid' => $status->value
104		];
105		$this->getResult()->addValue( null, $this->getModuleName(), $r );
106		}
107
108		/**
109		* We have our own delete() function, since Article.php's implementation is split in two phases
110		*
111		* @param Page\|WikiPage $page Page or WikiPage object to work on
112		* @param User $user User doing the action
113		* @param string\|null $reason Reason for the deletion. Autogenerated if null
114		* @param array $tags Tags to tag the deletion with
115		* @return Status\|array
116		*/
117		protected static function delete( Page $page, User $user, &$reason = null, $tags = [] ) {
118		$title = $page->getTitle();
119
120		// Auto-generate a summary, if necessary
121		if ( is_null( $reason ) ) {
122		// Need to pass a throwaway variable because generateReason expects
123		// a reference
124		$hasHistory = false;
125		$reason = $page->getAutoDeleteReason( $hasHistory );
126		if ( $reason === false ) {
127		return [ [ 'cannotdelete', $title->getPrefixedText() ] ];
128		}
129		}
130
131		$error = '';
132
133		// Luckily, Article.php provides a reusable delete function that does the hard work for us
134		return $page->doDeleteArticleReal( $reason, false, 0, true, $error, $user, $tags );
135		}
136
137		/**
138		* @param Page $page Object to work on
139		* @param User $user User doing the action
140		* @param string $oldimage Archive name
141		* @param string $reason Reason for the deletion. Autogenerated if null.
142		* @param bool $suppress Whether to mark all deleted versions as restricted
143		* @param array $tags Tags to tag the deletion with
144		* @return Status\|array
145		*/
146		protected static function deleteFile( Page $page, User $user, $oldimage,
147		&$reason = null, $suppress = false, $tags = []
148		) {
149		$title = $page->getTitle();
150
151		$file = $page->getFile();
		0 ignored issues – show Bug introduced 2016-02-23 18:13 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Page` as the method `getFile()` does only exist in the following implementations of said interface: `ImagePage`, `WikiFilePage`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
152		if ( !$file->exists() \|\| !$file->isLocal() \|\| $file->getRedirected() ) {
153		return self::delete( $page, $user, $reason, $tags );
154		}
155
156		if ( $oldimage ) {
157		if ( !FileDeleteForm::isValidOldSpec( $oldimage ) ) {
158		return [ [ 'invalidoldimage' ] ];
159		}
160		$oldfile = RepoGroup::singleton()->getLocalRepo()->newFromArchiveName( $title, $oldimage );
161		if ( !$oldfile->exists() \|\| !$oldfile->isLocal() \|\| $oldfile->getRedirected() ) {
162		return [ [ 'nodeleteablefile' ] ];
163		}
164		}
165
166		if ( is_null( $reason ) ) { // Log and RC don't like null reasons
167		$reason = '';
168		}
169
170		return FileDeleteForm::doDelete( $title, $file, $oldimage, $reason, $suppress, $user, $tags );
171		}
172
173		public function mustBePosted() {
174		return true;
175		}
176
177		public function isWriteMode() {
178		return true;
179		}
180
181		public function getAllowedParams() {
182		return [
183		'title' => null,
184		'pageid' => [
185		ApiBase::PARAM_TYPE => 'integer'
186		],
187		'reason' => null,
188		'tags' => [
189		ApiBase::PARAM_TYPE => 'tags',
190		ApiBase::PARAM_ISMULTI => true,
191		],
192		'watch' => [
193		ApiBase::PARAM_DFLT => false,
194		ApiBase::PARAM_DEPRECATED => true,
195		],
196		'watchlist' => [
197		ApiBase::PARAM_DFLT => 'preferences',
198		ApiBase::PARAM_TYPE => [
199		'watch',
200		'unwatch',
201		'preferences',
202		'nochange'
203		],
204		],
205		'unwatch' => [
206		ApiBase::PARAM_DFLT => false,
207		ApiBase::PARAM_DEPRECATED => true,
208		],
209		'oldimage' => null,
210		];
211		}
212
213		public function needsToken() {
214		return 'csrf';
215		}
216
217		protected function getExamplesMessages() {
218		return [
219		'action=delete&title=Main%20Page&token=123ABC'
220		=> 'apihelp-delete-example-simple',
221		'action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move'
222		=> 'apihelp-delete-example-reason',
223		];
224		}
225
226		public function getHelpUrls() {
227		return 'https://www.mediawiki.org/wiki/API:Delete';
228		}
229		}
230

wikimedia / mediawiki

ApiDelete::getHelpUrls() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

ApiDelete::getHelpUrls() A
last analyzed 2016-11-13 17:42 UTC