mediawiki-extensions-Linter/includes/LintErrorsPager.php
Arlo Breault 2fa7a30f14 Remove hardcoded list of categories with no parameters
Change-Id: Ic8b9ced613c873cada0a9909ed0d3799160504a1
2021-12-15 17:27:36 -05:00

249 lines
7.4 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 ExtensionRegistry;
use Html;
use IContextSource;
use InvalidArgumentException;
use LinkCache;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MediaWikiServices;
use TablePager;
use Title;
use TitleValue;
class LintErrorsPager extends TablePager {
/**
* @var CategoryManager
*/
private $categoryManager;
/**
* @var string
*/
private $category;
/**
* @var int|null
*/
private $categoryId;
/**
* @var LinkRenderer
*/
private $linkRenderer;
/**
* @var bool
*/
private $haveParserMigrationExt;
/**
* @var int|null
*/
private $namespace;
/**
* @var bool
*/
private $invertnamespace;
/**
* @param IContextSource $context
* @param string $category
* @param LinkRenderer $linkRenderer
* @param CategoryManager $catManager
* @param int|null $namespace
* @param bool $invertnamespace
*/
public function __construct( IContextSource $context, $category, LinkRenderer $linkRenderer,
CategoryManager $catManager, $namespace, $invertnamespace
) {
$this->category = $category;
$this->categoryManager = $catManager;
$this->categoryId = $catManager->getCategoryId( $this->category );
$this->linkRenderer = $linkRenderer;
$this->namespace = $namespace;
$this->invertnamespace = $invertnamespace;
$this->haveParserMigrationExt = ExtensionRegistry::getInstance()->isLoaded( 'ParserMigration' );
parent::__construct( $context );
}
/** @inheritDoc */
public function getQueryInfo() {
$conds = [ 'linter_cat' => $this->categoryId ];
if ( $this->namespace !== null ) {
$eq_op = $this->invertnamespace ? '!=' : '=';
$conds[] = "page_namespace $eq_op " . $this->mDb->addQuotes( $this->namespace );
}
return [
'tables' => [ 'page', 'linter' ],
'fields' => array_merge(
LinkCache::getSelectFields(),
[
'page_namespace', 'page_title',
'linter_id', 'linter_params',
'linter_start', 'linter_end',
]
),
'conds' => $conds,
'join_conds' => [ 'page' => [ 'INNER JOIN', 'page_id=linter_page' ] ]
];
}
protected function doBatchLookups() {
$linkCache = MediaWikiServices::getInstance()->getLinkCache();
foreach ( $this->mResult as $row ) {
$titleValue = new TitleValue( (int)$row->page_namespace, $row->page_title );
$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;
$row->linter_cat = $this->categoryId;
$lintError = Database::makeLintError( $row );
if ( !$lintError ) {
return '';
}
if ( $this->haveParserMigrationExt &&
$this->categoryManager->needsParserMigrationEdit( $this->category )
) {
$editAction = 'parsermigration-edit';
} else {
$editAction = 'edit';
}
switch ( $name ) {
case 'title':
$title = Title::makeTitle( $row->page_namespace, $row->page_title );
$viewLink = $this->linkRenderer->makeLink( $title );
$permManager = MediaWikiServices::getInstance()->getPermissionManager();
$editMsgKey = $permManager->quickUserCan( 'edit', $this->getUser(), $title ) ?
'linter-page-edit' : 'linter-page-viewsource';
$editLink = $this->linkRenderer->makeLink(
$title,
$this->msg( $editMsgKey )->text(),
[],
[ 'action' => $editAction, '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 ( $this->categoryManager->hasNameParam( $this->category ) &&
isset( $lintError->params['name'] ) ) {
return Html::element( 'code', [], $lintError->params['name'] );
} elseif ( $this->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 ( $this->category === 'pwrap-bug-workaround' &&
isset( $lintError->params['root'] ) &&
isset( $lintError->params['child'] ) ) {
return Html::element( 'code', [],
$lintError->params['root'] . " > " . $lintError->params['child'] );
} elseif ( $this->category === 'tidy-whitespace-bug' &&
isset( $lintError->params['node'] ) &&
isset( $lintError->params['sibling'] ) ) {
return Html::element( 'code', [],
$lintError->params['node'] . " + " . $lintError->params['sibling'] );
} elseif ( $this->category === 'multi-colon-escape' &&
isset( $lintError->params['href'] ) ) {
return Html::element( 'code', [], $lintError->params['href'] );
} elseif ( $this->category === 'multiline-html-table-in-list' ) {
/* ancestor and name will be set */
return Html::element( 'code', [],
$lintError->params['ancestorName'] . " > " . $lintError->params['name'] );
} elseif ( $this->category === 'misc-tidy-replacement-issues' ) {
/* There will be a 'subtype' param to disambiguate */
return Html::element( 'code', [], $lintError->params['subtype'] );
}
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
);
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' )->text(),
];
if ( !$this->categoryManager->hasNoParams( $this->category ) ) {
$names['details'] = $this->msg( "linter-pager-{$this->category}-details" )->text();
}
$names['template'] = $this->msg( "linter-pager-template" )->text();
return $names;
}
}