| Server IP : 167.235.224.122 / Your IP : 216.73.216.110 Web Server : Apache/2.4.58 (Ubuntu) System : Linux newplayground 6.8.0-136-generic #136-Ubuntu SMP PREEMPT_DYNAMIC Wed Jul 1 21:33:11 UTC 2026 aarch64 User : deploy ( 1000) PHP Version : 8.4.23 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : OFF | Sudo : ON | Pkexec : OFF Directory : /var/www/html/wiki/extensions/Linter/includes/ |
Upload File : |
<?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 MediaWiki\Api\ApiQuerySiteinfo;
use MediaWiki\Api\Hook\APIQuerySiteInfoGeneralInfoHook;
use MediaWiki\Config\Config;
use MediaWiki\Content\Content;
use MediaWiki\Context\IContextSource;
use MediaWiki\Deferred\DeferrableUpdate;
use MediaWiki\Deferred\MWCallableUpdate;
use MediaWiki\Hook\InfoActionHook;
use MediaWiki\Hook\ParserLogLinterDataHook;
use MediaWiki\JobQueue\JobQueueGroup;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Output\Hook\BeforePageDisplayHook;
use MediaWiki\Output\OutputPage;
use MediaWiki\Page\Hook\WikiPageDeletionUpdatesHook;
use MediaWiki\Page\ParserOutputAccess;
use MediaWiki\Page\WikiPage;
use MediaWiki\Page\WikiPageFactory;
use MediaWiki\Revision\RenderedRevision;
use MediaWiki\Skin\Skin;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Storage\Hook\RevisionDataUpdatesHook;
use MediaWiki\Title\Title;
class Hooks implements
APIQuerySiteInfoGeneralInfoHook,
BeforePageDisplayHook,
InfoActionHook,
ParserLogLinterDataHook,
WikiPageDeletionUpdatesHook,
RevisionDataUpdatesHook
{
private LinkRenderer $linkRenderer;
private JobQueueGroup $jobQueueGroup;
private WikiPageFactory $wikiPageFactory;
private ParserOutputAccess $parserOutputAccess;
private CategoryManager $categoryManager;
private TotalsLookup $totalsLookup;
private Database $database;
private bool $parseOnDerivedDataUpdates;
/**
* This should match Parsoid's PageConfig::hasLintableContentModel()
*/
public const LINTABLE_CONTENT_MODELS = [ CONTENT_MODEL_WIKITEXT, 'proofread-page' ];
/**
* @param LinkRenderer $linkRenderer
* @param JobQueueGroup $jobQueueGroup
* @param WikiPageFactory $wikiPageFactory
* @param ParserOutputAccess $parserOutputAccess
* @param CategoryManager $categoryManager
* @param TotalsLookup $totalsLookup
* @param Database $database
*/
public function __construct(
LinkRenderer $linkRenderer,
JobQueueGroup $jobQueueGroup,
WikiPageFactory $wikiPageFactory,
ParserOutputAccess $parserOutputAccess,
CategoryManager $categoryManager,
TotalsLookup $totalsLookup,
Database $database,
Config $config
) {
$this->linkRenderer = $linkRenderer;
$this->jobQueueGroup = $jobQueueGroup;
$this->wikiPageFactory = $wikiPageFactory;
$this->parserOutputAccess = $parserOutputAccess;
$this->categoryManager = $categoryManager;
$this->totalsLookup = $totalsLookup;
$this->database = $database;
$this->parseOnDerivedDataUpdates = $config->get( 'LinterParseOnDerivedDataUpdate' );
}
/**
* 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
* @param Skin $skin
*/
public function onBeforePageDisplay( $out, $skin ): void {
$request = $out->getRequest();
$lintId = $request->getInt( 'lintid' );
if ( !$lintId ) {
return;
}
$title = $out->getTitle();
if ( !$title ) {
return;
}
$lintError = $this->database->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 function onWikiPageDeletionUpdates( $wikiPage, $content, &$updates ) {
// The article id of the title is set to 0 when the page is deleted so
// capture it before creating the callback.
$id = $wikiPage->getId();
$ns = $wikiPage->getNamespace();
$updates[] = new MWCallableUpdate( function () use ( $id, $ns ) {
$this->totalsLookup->updateStats(
$this->database->setForPage( $id, $ns, [] )
);
}, __METHOD__ );
}
/**
* Hook: APIQuerySiteInfoGeneralInfo
*
* Expose categories via action=query&meta=siteinfo
*
* @param ApiQuerySiteInfo $api
* @param array &$data
*/
public function onAPIQuerySiteInfoGeneralInfo( $api, &$data ) {
$data['linter'] = [
'high' => $this->categoryManager->getHighPriority(),
'medium' => $this->categoryManager->getMediumPriority(),
'low' => $this->categoryManager->getLowPriority(),
];
}
/**
* Hook: InfoAction
*
* Display quick summary of errors for this page on ?action=info
*
* @param IContextSource $context
* @param array &$pageInfo
*/
public function onInfoAction( $context, &$pageInfo ) {
$title = $context->getTitle();
$pageId = $title->getArticleID();
if ( !$pageId ) {
return;
}
$totals = array_filter( $this->database->getTotalsForPage( $pageId ) );
if ( !$totals ) {
// No errors, yay!
return;
}
foreach ( $totals as $name => $count ) {
$pageInfo['linter'][] = [
$context->msg( "linter-category-$name" ),
htmlspecialchars( (string)$count )
];
}
$pageInfo['linter'][] = [
'below',
$this->linkRenderer->makeKnownLink(
SpecialPage::getTitleFor( 'LintErrors' ),
$context->msg( 'pageinfo-linter-moreinfo' )->text(),
[],
[ 'wpNamespaceRestrictions' => $title->getNamespace(),
'titlesearch' => $title->getText(), 'exactmatch' => 1 ]
),
];
}
/**
* Hook: ParserLogLinterData
*
* To record a lint errors.
*
* @param string $page
* @param int $revision
* @param array[] $data
* @return bool
*/
public function onParserLogLinterData(
string $page, int $revision, array $data
): bool {
$errors = [];
$title = Title::newFromText( $page );
if (
!$title || !$title->getArticleID() ||
$title->getLatestRevID() != $revision
) {
return false;
}
$catCounts = [];
foreach ( $data as $info ) {
if ( $this->categoryManager->isKnownCategory( $info['type'] ) ) {
// NOTE: Redundant with RecordLintJob, but why even create the job
if ( !$this->categoryManager->isEnabled( $info['type'] ) ) {
// Drop lints of these types for now
continue;
}
$info[ 'dbid' ] = null;
} elseif ( !isset( $info[ 'dbid' ] ) ) {
continue;
}
$count = $catCounts[$info['type']] ?? 0;
if ( $count > Database::MAX_PER_CAT ) {
// Drop
continue;
}
$catCounts[$info['type']] = $count + 1;
if ( !isset( $info['dsr'] ) ) {
LoggerFactory::getInstance( 'Linter' )->warning(
'dsr for {page} @ rev {revid}, for lint: {lint} is missing',
[
'page' => $page,
'revid' => $revision,
'lint' => $info['type'],
]
);
continue;
}
$info['location'] = array_slice( $info['dsr'], 0, 2 );
if ( !isset( $info['params'] ) ) {
$info['params'] = [];
}
if ( isset( $info['templateInfo'] ) && $info['templateInfo'] ) {
$info['params']['templateInfo'] = $info['templateInfo'];
}
$errors[] = $info;
}
LoggerFactory::getInstance( 'Linter' )->debug(
'{method}: Recording {numErrors} errors for {page}',
[
'method' => __METHOD__,
'numErrors' => count( $errors ),
'page' => $page
]
);
$job = new RecordLintJob(
$title,
[ 'errors' => $errors, 'revision' => $revision ],
$this->totalsLookup,
$this->database,
$this->categoryManager
);
$this->jobQueueGroup->lazyPush( $job );
return true;
}
/**
* @param Title $title
* @param RenderedRevision $renderedRevision
* @param DeferrableUpdate[] &$updates
*/
public function onRevisionDataUpdates( $title, $renderedRevision, &$updates ) {
if ( !$this->parseOnDerivedDataUpdates ) {
return;
}
if ( $renderedRevision->getOptions()->getUseParsoid() ) {
// Parsoid was already used for the canonical parse, nothing to do:
// onParserLogLinterData was already called.
// This will be the case when parsoid page views are enabled.
// Eventually, ParserLogLinterData will probably go away and we'll
// have the lint data in the ParserOutput. We'll then just use
// that data to create a RecordLintJob.
return;
}
if ( !in_array( $title->getContentModel(), self::LINTABLE_CONTENT_MODELS ) ) {
return;
}
$updates[] = new LintUpdate(
$this->wikiPageFactory,
$this->parserOutputAccess,
$renderedRevision,
);
}
}