Patch ContributionScores for newer tables

Change-Id: Ia8f9b33e935bf4f6f2ede29eeabf9acb10c15cb9

ContributionScores.php

@@ -1,16 +0,0 @@
-<?php
-
-if ( function_exists( 'wfLoadExtension' ) ) {
-	wfLoadExtension( 'ContributionScores' );
-	// Keep i18n globals so mergeMessageFileList.php doesn't break
-	$wgMessageDirs['ContributionScores'] = __DIR__ . '/i18n';
-	$wgExtensionMessagesFiles['ContributionScoresAlias'] = __DIR__ . '/ContributionScores.alias.php';
-	$wgExtensionMessagesFiles['ContributionScoresMagic'] = __DIR__ . '/ContributionScores.i18n.magic.php';
-	wfWarn(
-		'Deprecated PHP entry point used for ContributionScores extension. ' .
-		'Please use wfLoadExtension instead, ' .
-		'see https://www.mediawiki.org/wiki/Extension_registration for more details.'
-	);
-} else {
-	die( 'This version of the ContributionScores extension requires MediaWiki 1.29+' );
-}

composer.json

@@ -1,9 +1,9 @@
 {
 	"require-dev": {
-		"mediawiki/mediawiki-codesniffer": "37.0.0",
-		"mediawiki/minus-x": "1.1.1",
-		"php-parallel-lint/php-console-highlighter": "0.5.0",
-		"php-parallel-lint/php-parallel-lint": "1.3.0"
+		"mediawiki/mediawiki-codesniffer": "45.0.0",
+		"mediawiki/minus-x": "1.1.3",
+		"php-parallel-lint/php-console-highlighter": "1.0.0",
+		"php-parallel-lint/php-parallel-lint": "1.4.0"
 	},
 	"scripts": {
 		"fix": [
@@ -12,8 +12,14 @@
 		],
 		"test": [
 			"parallel-lint . --exclude vendor --exclude node_modules",
-			"phpcs -p -s",
+			"@phpcs",
 			"minus-x check ."
-		]
+		],
+		"phpcs": "phpcs -sp --cache"
+	},
+	"config": {
+		"allow-plugins": {
+			"dealerdirect/phpcodesniffer-composer-installer": true
+		}
 	}
 }

extension.json

@@ -3,7 +3,7 @@
 	"author": "Tim Laqua",
 	"url": "https://www.mediawiki.org/wiki/Extension:Contribution_Scores",
 	"descriptionmsg": "contributionscores-desc",
-	"version": "1.26.0",
+	"version": "1.26.1",
 	"type": "specialpage",
 	"requires": {
 		"MediaWiki": ">= 1.34.0"
@@ -39,6 +39,10 @@
 			"value": false,
 			"description": "Set to true to exclude bots users from the reporting."
 		},
+		"ContribScoreIgnoreUsernames": {
+			"value": [],
+			"description": "Array of usernames to exclude from the reporting."
+		},
 		"ContribScoresUseRealName": {
 			"value": false,
 			"description": "Set to true to use real user names when available."
@@ -46,6 +50,14 @@
 		"ContribScoreDisableCache": {
 			"value": false,
 			"description": "Set to true to disable cache for parser function and inclusion of table."
+		},
+		"ContribScoreUseRoughEditCount": {
+			"value": false,
+			"description": "Set to true to use the rough number of edits in user table, for performance issue."
+		},
+		"ContribScoreCacheTTL": {
+			"value": 30,
+			"description": "Cache the contribution scores data, in minutes."
 		}
 	},
 	"manifest_version": 2

i18n/io.json

@@ -5,6 +5,8 @@
 		]
 	},
 	"contributionscores-days": "Lasta {{PLURAL:$1|dio|$1 dii}}",
+	"contributionscores-score": "Nombro di punti",
 	"contributionscores-pages": "Pagini",
+	"contributionscores-changes": "Modifikuri",
 	"contributionscores-username": "Uzeronomo"
 }

package.json

@@ -1,12 +1,13 @@
 {
+	"name": "ContributionScores",
 	"private": true,
 	"scripts": {
 		"test": "grunt test"
 	},
 	"devDependencies": {
-		"eslint-config-wikimedia": "0.20.0",
-		"grunt": "1.4.0",
-		"grunt-banana-checker": "0.9.0",
-		"grunt-eslint": "23.0.0"
+		"eslint-config-wikimedia": "0.28.2",
+		"grunt": "1.6.1",
+		"grunt-banana-checker": "0.13.0",
+		"grunt-eslint": "24.3.0"
 	}
 }

src/ContributionScores.php

@@ -3,6 +3,8 @@
  * \brief Contains code for the ContributionScores Class (extends SpecialPage).
  */
 
+use MediaWiki\MediaWikiServices;
+
 /// Special page class for the Contribution Scores extension
 /**
  * Special page that generates a list of wiki contributors based
@@ -24,51 +26,50 @@ class ContributionScores extends IncludableSpecialPage {
 	}
 
 	public static function efContributionScoresRender( $parser, $usertext, $metric = 'score' ) {
-		global $wgContribScoreDisableCache;
+		global $wgContribScoreDisableCache, $wgContribScoreUseRoughEditCount;
 
 		if ( $wgContribScoreDisableCache ) {
 			$parser->getOutput()->updateCacheExpiry( 0 );
 		}
 
 		$user = User::newFromName( $usertext );
-		$dbr = wfGetDB( DB_REPLICA );
+		$loadBalancer = MediaWikiServices::getInstance()->getDBLoadBalancer();
+		$dbr = $loadBalancer->getConnection( DB_REPLICA );
 
 		if ( $user instanceof User && $user->isRegistered() ) {
 			global $wgLang;
+			$revVar = $wgContribScoreUseRoughEditCount ? 'user_editcount' : 'COUNT(rev_id)';
 
 			$revWhere = ActorMigration::newMigration()->getWhere( $dbr, 'rev_user', $user );
 			if ( $metric == 'score' ) {
-				$res = $dbr->select(
+				$row = $dbr->selectRow(
 					[ 'revision' ] + $revWhere['tables'],
-					'COUNT(DISTINCT rev_page)+SQRT(COUNT(rev_id)-COUNT(DISTINCT rev_page))*2 AS wiki_rank',
+					[ 'wiki_rank' => "COUNT(DISTINCT rev_page)+SQRT($revVar-COUNT(DISTINCT rev_page))*2" ],
 					$revWhere['conds'],
 					__METHOD__,
 					[],
 					$revWhere['joins']
 				);
-				$row = $dbr->fetchObject( $res );
 				$output = $wgLang->formatNum( round( $row->wiki_rank, 0 ) );
 			} elseif ( $metric == 'changes' ) {
-				$res = $dbr->select(
+				$row = $dbr->selectRow(
 					[ 'revision' ] + $revWhere['tables'],
-					'COUNT(rev_id) AS rev_count',
+					[ 'rev_count' => $revVar ],
 					$revWhere['conds'],
 					__METHOD__,
 					[],
 					$revWhere['joins']
 				);
-				$row = $dbr->fetchObject( $res );
 				$output = $wgLang->formatNum( $row->rev_count );
 			} elseif ( $metric == 'pages' ) {
-				$res = $dbr->select(
+				$row = $dbr->selectRow(
 					[ 'revision' ] + $revWhere['tables'],
-					'COUNT(DISTINCT rev_page) AS page_count',
+					[ 'page_count' => 'COUNT(DISTINCT rev_page)' ],
 					$revWhere['conds'],
 					__METHOD__,
 					[],
 					$revWhere['joins']
 				);
-				$row = $dbr->fetchObject( $res );
 				$output = $wgLang->formatNum( $row->page_count );
 			} else {
 				$output = wfMessage( 'contributionscores-invalidmetric' )->text();
@@ -76,31 +77,28 @@ class ContributionScores extends IncludableSpecialPage {
 		} else {
 			$output = wfMessage( 'contributionscores-invalidusername' )->text();
 		}
-		return $parser->insertStripItem( $output, $parser->mStripState );
+		return $parser->insertStripItem( $output, $parser->getStripState() );
 	}
 
-	/// Generates a "Contribution Scores" table for a given LIMIT and date range
-
 	/**
-	 * Function generates Contribution Scores tables in HTML format (not wikiText)
+	 * Function fetch Contribution Scores data from database
 	 *
 	 * @param int $days Days in the past to run report for
 	 * @param int $limit Maximum number of users to return (default 50)
-	 * @param string|null $title The title of the table
-	 * @param array $options array of options (default none; nosort/notools)
-	 * @return string Html Table representing the requested Contribution Scores.
+	 * @return array Data including the requested Contribution Scores.
 	 */
-	function genContributionScoreTable( $days, $limit, $title = null, $options = 'none' ) {
-		global $wgContribScoreIgnoreBots, $wgContribScoreIgnoreBlockedUsers, $wgContribScoresUseRealName;
+	public static function getContributionScoreData( $days, $limit ) {
+		global $wgContribScoreIgnoreBots, $wgContribScoreIgnoreBlockedUsers, $wgContribScoreIgnoreUsernames,
+			$wgContribScoreUseRoughEditCount;
 
-		$opts = explode( ',', strtolower( $options ) );
-
-		$dbr = wfGetDB( DB_REPLICA );
+		$loadBalancer = MediaWikiServices::getInstance()->getDBLoadBalancer();
+		$dbr = $loadBalancer->getConnection( DB_REPLICA );
 
 		$revQuery = ActorMigration::newMigration()->getJoin( 'rev_user' );
 		$revQuery['tables'] = array_merge( [ 'revision' ], $revQuery['tables'] );
 
 		$revUser = $revQuery['fields']['rev_user'];
+		$revUsername = $revQuery['fields']['rev_user_text'];
 
 		$sqlWhere = [];
 
@@ -109,9 +107,35 @@ class ContributionScores extends IncludableSpecialPage {
 			$sqlWhere[] = 'rev_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( $date ) );
 		}
 
+		$sqlVars = [
+			'rev_user'   => $revUser,
+			'page_count' => 'COUNT(DISTINCT rev_page)'
+		];
+		if ( $wgContribScoreUseRoughEditCount ) {
+			$revQuery['tables'][] = 'user';
+			$revQuery['joins']['user'] = [ 'LEFT JOIN', [ "$revUser != 0", "user_id = $revUser" ] ];
+			$sqlVars['rev_count'] = 'user_editcount';
+		} else {
+			$sqlVars['rev_count'] = 'COUNT(rev_id)';
+		}
+
 		if ( $wgContribScoreIgnoreBlockedUsers ) {
 			$sqlWhere[] = "{$revUser} NOT IN " .
-				$dbr->buildSelectSubquery( 'ipblocks', 'ipb_user', 'ipb_user <> 0', __METHOD__ );
+				$dbr->buildSelectSubquery( 				[
+						'block',
+						'block_target'
+					],
+					'bt_user',
+					'bt_user <> 0',
+					__METHOD__,
+					[],
+					[
+						'block_target' => [ 'JOIN', [
+							'bl_target=bt_id'
+						] ]
+					]
+				);
+
 		}
 
 		if ( $wgContribScoreIgnoreBots ) {
@@ -122,6 +146,11 @@ class ContributionScores extends IncludableSpecialPage {
 				], __METHOD__ );
 		}
 
+		if ( count( $wgContribScoreIgnoreUsernames ) ) {
+			$listIgnoredUsernames = $dbr->makeList( $wgContribScoreIgnoreUsernames );
+			$sqlWhere[] = "{$revUsername} NOT IN ($listIgnoredUsernames)";
+		}
+
 		if ( $dbr->unionSupportsOrderAndLimit() ) {
 			$order = [
 				'GROUP BY' => 'rev_user',
@@ -134,11 +163,7 @@ class ContributionScores extends IncludableSpecialPage {
 
 		$sqlMostPages = $dbr->selectSQLText(
 			$revQuery['tables'],
-			[
-				'rev_user'   => $revUser,
-				'page_count' => 'COUNT(DISTINCT rev_page)',
-				'rev_count'  => 'COUNT(rev_id)',
-			],
+			$sqlVars,
 			$sqlWhere,
 			__METHOD__,
 			$order,
@@ -151,11 +176,7 @@ class ContributionScores extends IncludableSpecialPage {
 
 		$sqlMostRevs = $dbr->selectSQLText(
 			$revQuery['tables'],
-			[
-				'rev_user' => $revUser,
-				'page_count' => 'COUNT(DISTINCT rev_page)',
-				'rev_count' => 'COUNT(rev_id)',
-			],
+			$sqlVars,
 			$sqlWhere,
 			__METHOD__,
 			$order,
@@ -180,7 +201,6 @@ class ContributionScores extends IncludableSpecialPage {
 			__METHOD__,
 			[
 				'ORDER BY' => 'wiki_rank DESC',
-				'GROUP BY' => 'user_name',
 				'LIMIT' => $limit,
 			],
 			[
@@ -190,6 +210,25 @@ class ContributionScores extends IncludableSpecialPage {
 				]
 			]
 		);
+		$ret = iterator_to_array( $res );
+		return $ret;
+	}
+
+	/// Generates a "Contribution Scores" table for a given LIMIT and date range
+
+	/**
+	 * Function generates Contribution Scores tables in HTML format (not wikiText)
+	 *
+	 * @param int $days Days in the past to run report for
+	 * @param int $limit Maximum number of users to return (default 50)
+	 * @param string|null $title The title of the table
+	 * @param array $options array of options (default none; nosort/notools)
+	 * @return string Html Table representing the requested Contribution Scores.
+	 */
+	function genContributionScoreTable( $days, $limit, $title = null, $options = 'none' ) {
+		global $wgContribScoresUseRealName, $wgContribScoreCacheTTL;
+
+		$opts = explode( ',', strtolower( $options ) );
 
 		$sortable = in_array( 'nosort', $opts ) ? '' : ' sortable';
 
@@ -201,11 +240,26 @@ class ContributionScores extends IncludableSpecialPage {
 			Html::element( 'th', [], $this->msg( 'contributionscores-changes' )->text() ) .
 			Html::element( 'th', [], $this->msg( 'contributionscores-username' )->text() );
 
+		$cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
+		$data = $cache->getWithSetCallback(
+			$cache->makeKey( 'contributionscores', 'data-' . (string)$days ),
+			$wgContribScoreCacheTTL * 60,
+			function () use ( $days ) {
+				// Use max limit, as limit doesn't matter with performance.
+				// Avoid purge multiple times since limit on transclusion can be vary.
+				return self::getContributionScoreData( $days, self::CONTRIBUTIONSCORES_MAXINCLUDELIMIT );
+			} );
+
+		$lang = $this->getLanguage();
+
 		$altrow = '';
 		$user_rank = 1;
 
-		$lang = $this->getLanguage();
-		foreach ( $res as $row ) {
+		foreach ( $data as $row ) {
+			if ( $user_rank > $limit ) {
+				break;
+			}
+
 			// Use real name if option used and real name present.
 			if ( $wgContribScoresUseRealName && $row->user_real_name !== '' ) {
 				$userLink = Linker::userLink(
@@ -251,8 +305,7 @@ class ContributionScores extends IncludableSpecialPage {
 		$output .= Html::closeElement( 'tr' );
 		$output .= Html::closeElement( 'table' );
 
-		$dbr->freeResult( $res );
-
+		// Transcluded on a normal wiki page.
 		if ( !empty( $title ) ) {
 			$output = Html::rawElement( 'table',
 				[
@@ -353,7 +406,7 @@ class ContributionScores extends IncludableSpecialPage {
 		$out->addWikiMsg( 'contributionscores-info' );
 
 		foreach ( $wgContribScoreReports as $scoreReport ) {
-			list( $days, $revs ) = $scoreReport;
+			[ $days, $revs ] = $scoreReport;
 			if ( $days > 0 ) {
 				$reportTitle = $this->msg( 'contributionscores-days' )->numParams( $days )->text();
 			} else {
@@ -369,6 +422,11 @@ class ContributionScores extends IncludableSpecialPage {
 		}
 	}
 
+	public function maxIncludeCacheTime() {
+		global $wgContribScoreDisableCache, $wgContribScoreCacheTTL;
+		return $wgContribScoreDisableCache ? 0 : $wgContribScoreCacheTTL;
+	}
+
 	/**
 	 * @inheritDoc
 	 */