mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Linter
synced 2024-11-24 16:04:00 +00:00
135 lines
3.5 KiB
PHP
135 lines
3.5 KiB
PHP
<?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.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\Linter;
|
|
|
|
use ApiQuerySiteInfo;
|
|
use Content;
|
|
use DatabaseUpdater;
|
|
use IContextSource;
|
|
use MWCallableUpdate;
|
|
use OutputPage;
|
|
use WikiPage;
|
|
|
|
class Hooks {
|
|
/**
|
|
* @param DatabaseUpdater $updater
|
|
*/
|
|
public static function onLoadExtensionSchemaUpdates( DatabaseUpdater $updater ) {
|
|
$dir = dirname( __DIR__ ) . '/sql';
|
|
$updater->addExtensionTable( 'linter', "$dir/linter.sql" );
|
|
}
|
|
|
|
/**
|
|
* Hook: BeforePageDisplay
|
|
*
|
|
* If there is a lintid parameter, look up that error in the database
|
|
* and setup and output our client-side helpers
|
|
*
|
|
* @param OutputPage &$out
|
|
*/
|
|
public static function onBeforePageDisplay( OutputPage &$out ) {
|
|
$request = $out->getRequest();
|
|
$lintId = $request->getInt( 'lintid' );
|
|
if ( !$lintId ) {
|
|
return;
|
|
}
|
|
$title = $out->getTitle();
|
|
if ( !$title ) {
|
|
return;
|
|
}
|
|
|
|
$lintError = ( new Database( $title->getArticleID() ) )->getFromId( $lintId );
|
|
if ( !$lintError ) {
|
|
// Already fixed or bogus URL parameter?
|
|
return;
|
|
}
|
|
|
|
$out->addJsConfigVars( [
|
|
'wgLinterErrorCategory' => $lintError->category,
|
|
'wgLinterErrorLocation' => $lintError->location,
|
|
] );
|
|
$out->addModules( 'ext.linter.edit' );
|
|
}
|
|
|
|
/**
|
|
* Hook: WikiPageDeletionUpdates
|
|
*
|
|
* Remove entries from the linter table upon page deletion
|
|
*
|
|
* @param WikiPage $wikiPage
|
|
* @param Content $content
|
|
* @param array &$updates
|
|
*/
|
|
public static function onWikiPageDeletionUpdates( WikiPage $wikiPage,
|
|
Content $content, array &$updates
|
|
) {
|
|
$title = $wikiPage->getTitle();
|
|
$updates[] = new MWCallableUpdate( function () use ( $title ) {
|
|
$job = new RecordLintJob(
|
|
$title, [ 'errors' => [] ]
|
|
);
|
|
$job->run();
|
|
}, __METHOD__ );
|
|
}
|
|
|
|
/**
|
|
* Hook: APIQuerySiteInfoGeneralInfo
|
|
*
|
|
* Expose categories via action=query&meta=siteinfo
|
|
*
|
|
* @param ApiQuerySiteInfo $api
|
|
* @param array &$data
|
|
*/
|
|
public static function onAPIQuerySiteInfoGeneralInfo( ApiQuerySiteInfo $api, array &$data ) {
|
|
$catManager = new CategoryManager();
|
|
$data['linter'] = [
|
|
'high' => $catManager->getHighPriority(),
|
|
'medium' => $catManager->getMediumPriority(),
|
|
'low' => $catManager->getLowPriority(),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Hook: InfoAction
|
|
*
|
|
* Display quick summary of errors for this page on ?action=info
|
|
*
|
|
* @param IContextSource $context
|
|
* @param array &$pageInfo
|
|
*/
|
|
public static function onInfoAction( IContextSource $context, array &$pageInfo ) {
|
|
$pageId = $context->getTitle()->getArticleID();
|
|
if ( !$pageId ) {
|
|
return;
|
|
}
|
|
$database = new Database( $pageId );
|
|
$totals = array_filter( $database->getTotalsForPage() );
|
|
if ( !$totals ) {
|
|
// No errors, yay!
|
|
return;
|
|
}
|
|
|
|
foreach ( $totals as $name => $count ) {
|
|
$pageInfo['linter'][] = [ $context->msg( "linter-category-$name" ), htmlspecialchars( $count ) ];
|
|
}
|
|
}
|
|
}
|