Issues in SpecialPageAction.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/actions/SpecialPageAction.php (1 issue)

Labels

Bug 1

Severity

Minor 1

This, that and the other 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
 *
 * @file
 * @ingroup Actions
 */

/**
 * An action that just passes the request to the relevant special page
 *
 * @ingroup Actions
 * @since 1.25
 */
class SpecialPageAction extends FormlessAction {
	/**
	 * @var array A mapping of action names to special page names.
	 */
	public static $actionToSpecialPageMapping = [
		'revisiondelete' => 'Revisiondelete',
		'editchangetags' => 'EditTags',
	];

	public function getName() {
		$request = $this->getRequest();
		$actionName = $request->getVal( 'action', 'view' );
		// TODO: Shouldn't need to copy-paste this code from Action::getActionName!
		if ( $actionName === 'historysubmit' ) {
			if ( $request->getBool( 'revisiondelete' ) ) {
				$actionName = 'revisiondelete';
			} elseif ( $request->getBool( 'editchangetags' ) ) {
				$actionName = 'editchangetags';
			}
		}

		if ( isset( self::$actionToSpecialPageMapping[$actionName] ) ) {
			return $actionName;
		}

		return 'nosuchaction';
	}

	public function requiresUnblock() {
		return false;
	}

	public function getDescription() {
		return '';
	}

	public function onView() {
		return '';
	}

	public function show() {
		$special = $this->getSpecialPage();
		if ( !$special ) {
			throw new ErrorPageError(
				$this->msg( 'nosuchaction' ), $this->msg( 'nosuchactiontext' ) );
		}

		$special->setContext( $this->getContext() );
		$special->getContext()->setTitle( $special->getPageTitle() );
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.
    }
}
		$special->run( '' );
	}

	public function doesWrites() {
		$special = $this->getSpecialPage();

		return $special ? $special->doesWrites() : false;
	}

	/**
	 * @return SpecialPage|null
	 */
	protected function getSpecialPage() {
		$action = $this->getName();
		if ( $action === 'nosuchaction' ) {
			return null;
		}

		// map actions to (whitelisted) special pages
		return SpecialPageFactory::getPage( self::$actionToSpecialPageMapping[$action] );
	}
}


Branch — master (939199)

includes/actions/SpecialPageAction.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

1		<?php
2		/**
3		* This program is free software; you can redistribute it and/or modify
4		* it under the terms of the GNU General Public License as published by
5		* the Free Software Foundation; either version 2 of the License, or
6		* (at your option) any later version.
7		*
8		* This program is distributed in the hope that it will be useful,
9		* but WITHOUT ANY WARRANTY; without even the implied warranty of
10		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11		* GNU General Public License for more details.
12		*
13		* You should have received a copy of the GNU General Public License
14		* along with this program; if not, write to the Free Software
15		* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
16		*
17		* @file
18		* @ingroup Actions
19		*/
20
21		/**
22		* An action that just passes the request to the relevant special page
23		*
24		* @ingroup Actions
25		* @since 1.25
26		*/
27		class SpecialPageAction extends FormlessAction {
28		/**
29		* @var array A mapping of action names to special page names.
30		*/
31		public static $actionToSpecialPageMapping = [
32		'revisiondelete' => 'Revisiondelete',
33		'editchangetags' => 'EditTags',
34		];
35
36		public function getName() {
37		$request = $this->getRequest();
38		$actionName = $request->getVal( 'action', 'view' );
39		// TODO: Shouldn't need to copy-paste this code from Action::getActionName!
40	View Code Duplication	if ( $actionName === 'historysubmit' ) {
41		if ( $request->getBool( 'revisiondelete' ) ) {
42		$actionName = 'revisiondelete';
43		} elseif ( $request->getBool( 'editchangetags' ) ) {
44		$actionName = 'editchangetags';
45		}
46		}
47
48		if ( isset( self::$actionToSpecialPageMapping[$actionName] ) ) {
49		return $actionName;
50		}
51
52		return 'nosuchaction';
53		}
54
55		public function requiresUnblock() {
56		return false;
57		}
58
59		public function getDescription() {
60		return '';
61		}
62
63		public function onView() {
64		return '';
65		}
66
67		public function show() {
68		$special = $this->getSpecialPage();
69		if ( !$special ) {
70		throw new ErrorPageError(
71		$this->msg( 'nosuchaction' ), $this->msg( 'nosuchactiontext' ) );
72		}
73
74		$special->setContext( $this->getContext() );
75		$special->getContext()->setTitle( $special->getPageTitle() );
		0 ignored issues – show Bug introduced 2016-01-25 18:14 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `IContextSource` as the method `setTitle()` does only exist in the following implementations of said interface: `DerivativeContext`, `EditWatchlistNormalHTMLForm`, `HTMLForm`, `OOUIHTMLForm`, `OutputPage`, `PreferencesForm`, `RequestContext`, `UploadForm`, `VFormHTMLForm`. 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...
76		$special->run( '' );
77		}
78
79		public function doesWrites() {
80		$special = $this->getSpecialPage();
81
82		return $special ? $special->doesWrites() : false;
83		}
84
85		/**
86		* @return SpecialPage\|null
87		*/
88		protected function getSpecialPage() {
89		$action = $this->getName();
90		if ( $action === 'nosuchaction' ) {
91		return null;
92		}
93
94		// map actions to (whitelisted) special pages
95		return SpecialPageFactory::getPage( self::$actionToSpecialPageMapping[$action] );
96		}
97		}
98

wikimedia / mediawiki

Branch — master (939199)

includes/actions/SpecialPageAction.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like