1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
|
<?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 JobQueueGroup;
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\Linker\LinkRenderer;
use MediaWiki\Logger\LoggerFactory;
use MediaWiki\Output\Hook\BeforePageDisplayHook;
use MediaWiki\Output\OutputPage;
use MediaWiki\Page\Hook\RevisionFromEditCompleteHook;
use MediaWiki\Page\Hook\WikiPageDeletionUpdatesHook;
use MediaWiki\Page\ParserOutputAccess;
use MediaWiki\Page\WikiPageFactory;
use MediaWiki\Revision\RenderedRevision;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\SpecialPage\SpecialPage;
use MediaWiki\Storage\Hook\RevisionDataUpdatesHook;
use MediaWiki\Title\Title;
use MediaWiki\User\UserIdentity;
use Skin;
use WikiPage;
class Hooks implements
APIQuerySiteInfoGeneralInfoHook,
BeforePageDisplayHook,
InfoActionHook,
ParserLogLinterDataHook,
RevisionFromEditCompleteHook,
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;
/**
* @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__ );
}
/**
* This should match Parsoid's PageConfig::hasLintableContentModel()
*/
public const LINTABLE_CONTENT_MODELS = [ CONTENT_MODEL_WIKITEXT, 'proofread-page' ];
/**
* Hook: RevisionFromEditComplete
*
* Remove entries from the linter table upon page content model change away from wikitext
*
* @param WikiPage $wikiPage
* @param RevisionRecord $newRevisionRecord
* @param bool|int $originalRevId
* @param UserIdentity $user
* @param string[] &$tags
*/
public function onRevisionFromEditComplete(
$wikiPage, $newRevisionRecord, $originalRevId, $user, &$tags
) {
// This is just a stop-gap to deal with callers that aren't complying
// with the advertised hook signature.
if ( !is_array( $tags ) ) {
return;
}
if (
in_array( "mw-blank", $tags ) ||
( in_array( "mw-contentmodelchange", $tags ) &&
!in_array( $wikiPage->getContentModel(), self::LINTABLE_CONTENT_MODELS ) )
) {
$this->totalsLookup->updateStats(
$this->database->setForPage(
$wikiPage->getId(), $wikiPage->getNamespace(), []
)
);
}
}
/**
* 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,
);
}
}
|