Page MenuHomeWickedGov Phorge
Files F1432828

LintErrorsPager.php
No OneTemporary
Actions

Size
10 KB
Referenced Files
None
Subscribers
None

LintErrorsPager.php
View Options

<?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 InvalidArgumentException;
use MediaWiki\Cache\LinkCache;
use MediaWiki\Context\IContextSource;
use MediaWiki\Html\Html;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MediaWikiServices;
use MediaWiki\Pager\TablePager;
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Title\Title;
use MediaWiki\Title\TitleValue;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\LikeValue;
use Wikimedia\Rdbms\SelectQueryBuilder;
class LintErrorsPager extends TablePager {
private CategoryManager $categoryManager;
private LinkCache $linkCache;
private LinkRenderer $linkRenderer;
private PermissionManager $permissionManager;
private ?string $category;
/** @var mixed */
private $categoryId;
private array $namespaces;
private bool $exactMatch;
private string $title;
private string $tag;
/**
* Allowed values are keys 'all', 'with' or 'without'
*/
private string $throughTemplate;
/**
* @param IContextSource $context
* @param CategoryManager $categoryManager
* @param LinkCache $linkCache
* @param LinkRenderer $linkRenderer
* @param PermissionManager $permissionManager
* @param ?string $category
* @param array $namespaces
* @param bool $exactMatch
* @param string $title
* @param string $throughTemplate
* @param string $tag
*/
public function __construct(
IContextSource $context,
CategoryManager $categoryManager,
LinkCache $linkCache,
LinkRenderer $linkRenderer,
PermissionManager $permissionManager,
?string $category,
array $namespaces,
bool $exactMatch,
string $title,
string $throughTemplate,
string $tag
) {
$this->categoryManager = $categoryManager;
$this->linkCache = $linkCache;
$this->linkRenderer = $linkRenderer;
$this->permissionManager = $permissionManager;
$this->category = $category;
if ( $category !== null ) {
$this->categoryId = $categoryManager->getCategoryId( $category );
} else {
$this->categoryId = array_values( $this->categoryManager->getCategoryIds(
$this->categoryManager->getVisibleCategories()
) );
}
$this->namespaces = $namespaces;
$this->exactMatch = $exactMatch;
$this->title = $title;
$this->throughTemplate = $throughTemplate ?: 'all';
$this->tag = $tag ?: 'all';
parent::__construct( $context );
}
private function fillQueryBuilder( SelectQueryBuilder $queryBuilder ): void {
$mainConfig = MediaWikiServices::getInstance()->getMainConfig();
$queryBuilder
->table( 'page' )
->join( 'linter', null, 'page_id=linter_page' )
->fields( LinkCache::getSelectFields() )
->fields( [
'page_namespace', 'page_title',
'linter_id', 'linter_params',
'linter_start', 'linter_end',
'linter_cat'
] )
->where( [ 'linter_cat' => $this->categoryId ] );
$useIndex = false;
if ( $this->title !== '' ) {
$namespaces = $this->namespaces ?: [ NS_MAIN ];
// Specify page_namespace so that the index can be used (T360865)
// Also put a condition on linter_namespace, in case the DB
// decides to put the linter table first
$queryBuilder->where( [ 'page_namespace' => $namespaces, 'linter_namespace' => $namespaces ] );
if ( $this->exactMatch ) {
$queryBuilder->where( [
'page_title' => $this->title
] );
} else {
$queryBuilder->where( $this->mDb->expr(
'page_title', IExpression::LIKE, new LikeValue( $this->title, $this->mDb->anyString() )
) );
}
} elseif ( $this->namespaces ) {
$queryBuilder->where( [ 'linter_namespace' => $this->namespaces ] );
} else {
$useIndex = true;
}
if ( $this->throughTemplate !== 'all' ) {
$useIndex = false;
$op = ( $this->throughTemplate === 'with' ) ? '!=' : '=';
$queryBuilder->where( $this->mDb->expr( 'linter_template', $op, '' ) );
}
if ( $this->tag !== 'all' && ( new HtmlTags( $this ) )->checkAllowedHTMLTags( $this->tag ) ) {
$useIndex = false;
$queryBuilder->where( [ 'linter_tag' => $this->tag ] );
}
if ( $useIndex ) {
// T200517#10236299: Force the use of the category index
$queryBuilder->option( 'USE INDEX', [ 'linter' => 'linter_cat_page_position' ] );
}
}
/**
* @inheritDoc
*/
public function getQueryInfo() {
$queryBuilder = $this->mDb->newSelectQueryBuilder();
$this->fillQueryBuilder( $queryBuilder );
return $queryBuilder->getQueryInfo();
}
protected function doBatchLookups() {
foreach ( $this->mResult as $row ) {
$titleValue = new TitleValue( (int)$row->page_namespace, $row->page_title );
$this->linkCache->addGoodLinkObjFromRow( $titleValue, $row );
}
}
/** @inheritDoc */
public function isFieldSortable( $field ) {
return false;
}
/**
* @param string $name
* @param string $value
* @return string
* @throws InvalidArgumentException
*/
public function formatValue( $name, $value ) {
$row = $this->mCurrentRow;
// To support multiple lint errors of varying types for a single page, the
// category is set each time based on the category set in the lint error $row
// not by the class when lints are being reported by type for many pages
$category = $this->category;
if ( $category === null ) {
// Assert $row->linter_cat !== null ?
$category = $this->categoryManager->getCategoryName( $row->linter_cat );
} else {
$row->linter_cat = $this->categoryId;
}
$lintError = Database::makeLintError( $this->categoryManager, $row );
if ( !$lintError ) {
return '';
}
switch ( $name ) {
case 'title':
$title = Title::makeTitle( $row->page_namespace, $row->page_title );
$viewLink = $this->linkRenderer->makeLink( $title );
$editMsgKey = $this->permissionManager->quickUserCan( 'edit', $this->getUser(), $title ) ?
'linter-page-edit' : 'linter-page-viewsource';
$editLink = $this->linkRenderer->makeLink(
$title,
$this->msg( $editMsgKey )->text(),
[],
[ 'action' => 'edit', 'lintid' => $lintError->lintId, ]
);
$historyLink = $this->linkRenderer->makeLink(
$title,
$this->msg( 'linter-page-history' )->text(),
[],
[ 'action' => 'history' ]
);
$editHistLinks = $this->getLanguage()->pipeList( [ $editLink, $historyLink ] );
return $this->msg( 'linter-page-title-edit' )
->rawParams( $viewLink, $editHistLinks )
->escaped();
case 'details':
if ( $category !== null && $this->categoryManager->hasNameParam( $category ) &&
isset( $lintError->params['name'] ) ) {
return Html::element( 'code', [], $lintError->params['name'] );
} elseif ( $category === 'bogus-image-options' && isset( $lintError->params['items'] ) ) {
$list = array_map( static function ( $in ) {
return Html::element( 'code', [], $in );
}, $lintError->params['items'] );
return $this->getLanguage()->commaList( $list );
} elseif ( $category === 'pwrap-bug-workaround' &&
isset( $lintError->params['root'] ) &&
isset( $lintError->params['child'] ) ) {
return Html::element( 'code', [],
$lintError->params['root'] . " > " . $lintError->params['child'] );
} elseif ( $category === 'tidy-whitespace-bug' &&
isset( $lintError->params['node'] ) &&
isset( $lintError->params['sibling'] ) ) {
return Html::element( 'code', [],
$lintError->params['node'] . " + " . $lintError->params['sibling'] );
} elseif ( $category === 'multi-colon-escape' &&
isset( $lintError->params['href'] ) ) {
return Html::element( 'code', [], $lintError->params['href'] );
} elseif ( $category === 'multiline-html-table-in-list' ) {
/* ancestor and name will be set */
return Html::element( 'code', [],
$lintError->params['ancestorName'] . " > " . $lintError->params['name'] );
} elseif ( $category === 'misc-tidy-replacement-issues' ) {
/* There will be a 'subtype' param to disambiguate */
return Html::element( 'code', [], $lintError->params['subtype'] );
} elseif ( $category === 'missing-image-alt-text' ) {
$title = Title::newFromText( $lintError->params['file'], NS_FILE );
return Html::element( 'a', [
'href' => $title->getLocalUrl(),
], $title );
} elseif ( $category === 'duplicate-ids' ) {
return Html::element( 'code', [], $lintError->params['id'] );
}
return '';
case 'template':
if ( !$lintError->templateInfo ) {
return '&mdash;';
}
if ( isset( $lintError->templateInfo['multiPartTemplateBlock'] ) ) {
return $this->msg( 'multi-part-template-block' )->escaped();
} else {
// @phan-suppress-next-line PhanTypeArraySuspiciousNullable Null checked above
$templateName = $lintError->templateInfo['name'];
// Parsoid provides us with fully qualified template title
// So, fallback to the default main namespace
$templateTitle = Title::newFromText( $templateName );
if ( !$templateTitle ) {
// Shouldn't be possible...???
return '&mdash;';
}
}
return $this->linkRenderer->makeLink(
$templateTitle
);
case 'category':
return Html::element( 'code', [], $category ?? '' );
default:
throw new InvalidArgumentException( "Unexpected name: $name" );
}
}
/** @inheritDoc */
public function getDefaultSort() {
return 'linter_id';
}
/**
* @return string[]
*/
public function getFieldNames() {
$names = [
'title' => $this->msg( 'linter-pager-title-header' )->text(),
];
if ( !$this->category ) {
$names['category'] = $this->msg( 'linter-pager-category-header' )->text();
$names['details'] = $this->msg( "linter-pager-details-header" )->text();
} elseif ( !$this->categoryManager->hasNoParams( $this->category ) ) {
$names['details'] = $this->msg( "linter-pager-{$this->category}-details" )->text();
}
$names['template'] = $this->msg( "linter-pager-template-header" )->text();
return $names;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 22:22 (1 h, 37 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
e6/0a/926d0658729f56fbc4a4adb2e2d5
Default Alt Text
LintErrorsPager.php (10 KB)

Event Timeline