InvalidateUserSesssions::__construct() - Code Metrics - Inspection of "Daily Inspection: Merge "Fix LegacyHookPreAuthenti..." - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — master (9a4483)

unknown

created 2016-06-20 17:45 UTC

InvalidateUserSesssions::__construct() A

↳ Parent: InvalidateUserSesssions

Complexity

Conditions	1
Paths	1

Size

Total Lines	9
Code Lines	7

Duplication

Lines	9
Ratio	100 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	1
eloc	7
nc	1
nop	0
dl	9
loc	9
rs	9.6666
c	1
b	0
f	1

<?php

/**
 * Invalidate the sessions of certain users on the wiki.
 * If you want to invalidate all sessions, use $wgAuthenticationTokenVersion instead.
 *
 * 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 Maintenance
 */

use MediaWiki\MediaWikiServices;
use MediaWiki\Session\SessionManager;

require_once __DIR__ . '/Maintenance.php';

/**
 * Invalidate the sessions of certain users on the wiki.
 * If you want to invalidate all sessions, use $wgAuthenticationTokenVersion instead.
 *
 * @ingroup Maintenance
 */
class InvalidateUserSesssions extends Maintenance {
	public function __construct() {
		parent::__construct();
		$this->addDescription(
			'Invalidate the sessions of certain users on the wiki.'
		);
		$this->addOption( 'user', 'Username', false, true, 'u' );
		$this->addOption( 'file', 'File with one username per line', false, true, 'f' );
		$this->setBatchSize( 1000 );
	}

	public function execute() {
		$username = $this->getOption( 'user' );
		$file = $this->getOption( 'file' );

		if ( $username === null && $file === null ) {
			$this->error( 'Either --user or --file is required', 1 );
		} elseif ( $username !== null && $file !== null ) {
			$this->error( 'Cannot use both --user and --file', 1 );
		}

		if ( $username !== null ) {
			$usernames = [ $username ];
		} else {
			$usernames = is_readable( $file ) ?
				file( $file, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES ) : false;
			if ( $usernames === false ) {
				$this->error( "Could not open $file", 2 );
			}
		}

		$i = 0;
		$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
		$sessionManager = SessionManager::singleton();
		foreach ( $usernames as $username ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			$i++;
			$user = User::newFromName( $username );
			try {
				$sessionManager->invalidateSessionsForUser( $user );
<?php

function getDate($date)
{
    if ($date !== null) {
        return new DateTime($date);
    }

    return false;
}
				if ( $user->getId() ) {
					$this->output( "Invalidated sessions for user $username\n" );
				} else {
					# session invalidation might still work if there is a central identity provider
					$this->output( "Could not find user $username, tried to invalidate anyway\n" );
				}
			} catch ( Exception $e ) {
				$this->output( "Failed to invalidate sessions for user $username | "
					. str_replace( [ "\r", "\n" ], ' ', $e->getMessage() ) . "\n" );
			}

			if ( $i % $this->mBatchSize ) {
				$lbFactory->waitForReplication();
			}
		}
	}
}

$maintClass = "InvalidateUserSesssions";
require_once RUN_MAINTENANCE_IF_MAIN;


1		<?php
		0 ignored issues – show Coding Style Compatibility introduced 2016-06-16 18:04 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 36 and the first side effect is on line 28. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2		/**
3		* Invalidate the sessions of certain users on the wiki.
4		* If you want to invalidate all sessions, use $wgAuthenticationTokenVersion instead.
5		*
6		* This program is free software; you can redistribute it and/or modify
7		* it under the terms of the GNU General Public License as published by
8		* the Free Software Foundation; either version 2 of the License, or
9		* (at your option) any later version.
10		*
11		* This program is distributed in the hope that it will be useful,
12		* but WITHOUT ANY WARRANTY; without even the implied warranty of
13		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14		* GNU General Public License for more details.
15		*
16		* You should have received a copy of the GNU General Public License along
17		* with this program; if not, write to the Free Software Foundation, Inc.,
18		* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19		* http://www.gnu.org/copyleft/gpl.html
20		*
21		* @file
22		* @ingroup Maintenance
23		*/
24
25		use MediaWiki\MediaWikiServices;
26		use MediaWiki\Session\SessionManager;
27
28		require_once __DIR__ . '/Maintenance.php';
29
30		/**
31		* Invalidate the sessions of certain users on the wiki.
32		* If you want to invalidate all sessions, use $wgAuthenticationTokenVersion instead.
33		*
34		* @ingroup Maintenance
35		*/
36		class InvalidateUserSesssions extends Maintenance {
37	View Code Duplication	public function __construct() {
38		parent::__construct();
39		$this->addDescription(
40		'Invalidate the sessions of certain users on the wiki.'
41		);
42		$this->addOption( 'user', 'Username', false, true, 'u' );
43		$this->addOption( 'file', 'File with one username per line', false, true, 'f' );
44		$this->setBatchSize( 1000 );
45		}
46
47		public function execute() {
48		$username = $this->getOption( 'user' );
49		$file = $this->getOption( 'file' );
50
51		if ( $username === null && $file === null ) {
52		$this->error( 'Either --user or --file is required', 1 );
53		} elseif ( $username !== null && $file !== null ) {
54		$this->error( 'Cannot use both --user and --file', 1 );
55		}
56
57		if ( $username !== null ) {
58		$usernames = [ $username ];
59		} else {
60		$usernames = is_readable( $file ) ?
61		file( $file, FILE_IGNORE_NEW_LINES \| FILE_SKIP_EMPTY_LINES ) : false;
62		if ( $usernames === false ) {
63		$this->error( "Could not open $file", 2 );
64		}
65		}
66
67		$i = 0;
68		$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
69		$sessionManager = SessionManager::singleton();
70		foreach ( $usernames as $username ) {
		0 ignored issues – show Bug introduced 2016-06-16 18:04 UTC by Report Bug Copy Issue Report The expression `$usernames` of type `false\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
71		$i++;
72		$user = User::newFromName( $username );
73		try {
74		$sessionManager->invalidateSessionsForUser( $user );
		0 ignored issues – show Security Bug introduced 2016-06-16 18:04 UTC by Report Bug Copy Issue Report It seems like `$user` defined by `\User::newFromName($username)` on line `72` can also be of type `false`; however, `MediaWiki\Session\Sessio...lidateSessionsForUser()` does only seem to accept `object<User>`, did you maybe forget to handle an error condition? This check looks for type mismatches where the missing type is `false`. This is usually indicative of an error condtion. Consider the follow example <?php function getDate($date) { if ($date !== null) { return new DateTime($date); } return false; } This function either returns a new `DateTime` object or false, if there was an error. This is a typical pattern in PHP programming to show that an error has occurred without raising an exception. The calling code should check for this returned `false` before passing on the value to another function or method that may not be able to handle a `false`. Loading history...
75		if ( $user->getId() ) {
76		$this->output( "Invalidated sessions for user $username\n" );
77		} else {
78		# session invalidation might still work if there is a central identity provider
79		$this->output( "Could not find user $username, tried to invalidate anyway\n" );
80		}
81		} catch ( Exception $e ) {
82		$this->output( "Failed to invalidate sessions for user $username \| "
83		. str_replace( [ "\r", "\n" ], ' ', $e->getMessage() ) . "\n" );
84		}
85
86		if ( $i % $this->mBatchSize ) {
87		$lbFactory->waitForReplication();
88		}
89		}
90		}
91		}
92
93		$maintClass = "InvalidateUserSesssions";
94		require_once RUN_MAINTENANCE_IF_MAIN;
95

wikimedia / mediawiki

Branch — master (9a4483)

InvalidateUserSesssions::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like