mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Linter
synced 2024-11-11 16:59:40 +00:00
dd0836d232
* Using namespacesmultiselect type in HTMLForm element to provide multiple namespace selection criteria in reports. * New namespace URL encoding implemented which matches namespace parameters against active namespaces to ensure parameter security and validation. * Test system updated to use new URL namespace encoding Bug: T231161 Change-Id: Ic3190cffe259aecdea429c10e35122eabdbe10d4
324 lines
9.6 KiB
PHP
324 lines
9.6 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 Html;
|
|
use IContextSource;
|
|
use InvalidArgumentException;
|
|
use LinkCache;
|
|
use MediaWiki\Linker\LinkRenderer;
|
|
use MediaWiki\MediaWikiServices;
|
|
use MediaWiki\Title\Title;
|
|
use TablePager;
|
|
use TitleValue;
|
|
|
|
class LintErrorsPager extends TablePager {
|
|
|
|
/**
|
|
* @var CategoryManager
|
|
*/
|
|
private $categoryManager;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $category;
|
|
|
|
/**
|
|
* @var int|null
|
|
*/
|
|
private $categoryId;
|
|
|
|
/**
|
|
* @var LinkRenderer
|
|
*/
|
|
private $linkRenderer;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
private $namespaces;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $exactMatch;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $title;
|
|
|
|
/**
|
|
* Allowed values are keys 'all', 'with' or 'without'
|
|
* @var string
|
|
*/
|
|
private $throughTemplate;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $tag;
|
|
|
|
/**
|
|
* @param IContextSource $context
|
|
* @param string|null $category
|
|
* @param LinkRenderer $linkRenderer
|
|
* @param CategoryManager $catManager
|
|
* @param array $namespaces
|
|
* @param bool $exactMatch
|
|
* @param string $title
|
|
* @param string $throughTemplate
|
|
* @param string $tag
|
|
*/
|
|
public function __construct( IContextSource $context, $category, LinkRenderer $linkRenderer,
|
|
CategoryManager $catManager, $namespaces, $exactMatch, $title, $throughTemplate, $tag
|
|
) {
|
|
$this->category = $category;
|
|
$this->categoryManager = $catManager;
|
|
if ( $category !== null ) {
|
|
$this->categoryId = $catManager->getCategoryId( $this->category );
|
|
} else {
|
|
$this->categoryId = null;
|
|
}
|
|
$this->linkRenderer = $linkRenderer;
|
|
$this->namespaces = $namespaces;
|
|
$this->exactMatch = $exactMatch;
|
|
$this->title = $title;
|
|
$this->throughTemplate = $throughTemplate;
|
|
$this->tag = $tag;
|
|
parent::__construct( $context );
|
|
}
|
|
|
|
/** @inheritDoc */
|
|
public function getQueryInfo() {
|
|
$conds = [];
|
|
if ( $this->categoryId !== null ) {
|
|
$conds[ 'linter_cat' ] = $this->categoryId;
|
|
}
|
|
|
|
$mwServices = MediaWikiServices::getInstance();
|
|
$config = $mwServices->getMainConfig();
|
|
$dbMaintenance = $mwServices->getDBLoadBalancer()->getMaintenanceConnectionRef( DB_REPLICA );
|
|
if ( !empty( $this->namespaces ) ) {
|
|
$enableUseNamespaceColumnStage = $config->get( 'LinterUseNamespaceColumnStage' );
|
|
$fieldExists = $dbMaintenance->fieldExists( 'linter', 'linter_namespace', __METHOD__ );
|
|
if ( !$enableUseNamespaceColumnStage || !$fieldExists ) {
|
|
$conds[ "page_namespace" ] = $this->namespaces;
|
|
} else {
|
|
$conds[ "linter_namespace" ] = $this->namespaces;
|
|
}
|
|
}
|
|
|
|
if ( $this->exactMatch ) {
|
|
if ( $this->title !== '' ) {
|
|
$conds[] = "page_title = " . $this->mDb->addQuotes( $this->title );
|
|
}
|
|
} else {
|
|
$conds[] = 'page_title' . $this->mDb->buildLike( $this->title, $this->mDb->anyString() );
|
|
}
|
|
|
|
$enableUserInterfaceTagAndTemplateStage = $config->get( 'LinterUserInterfaceTagAndTemplateStage' );
|
|
$fieldTagExists = $dbMaintenance->fieldExists( 'linter', 'linter_tag', __METHOD__ );
|
|
if ( $enableUserInterfaceTagAndTemplateStage && $fieldTagExists ) {
|
|
switch ( $this->throughTemplate ) {
|
|
case 'with':
|
|
$conds[] = "linter_template != ''";
|
|
break;
|
|
case 'without':
|
|
$conds[] = "linter_template = ''";
|
|
break;
|
|
case 'all':
|
|
default:
|
|
break;
|
|
}
|
|
switch ( $this->tag ) {
|
|
case 'all':
|
|
break;
|
|
default:
|
|
$htmlTags = new HtmlTags( $this );
|
|
if ( $htmlTags->checkAllowedHTMLTags( $this->tag ) ) {
|
|
$conds[] = 'linter_tag = ' . $this->mDb->addQuotes( $this->tag );
|
|
}
|
|
}
|
|
}
|
|
|
|
return [
|
|
'tables' => [ 'page', 'linter' ],
|
|
'fields' => array_merge(
|
|
LinkCache::getSelectFields(),
|
|
[
|
|
'page_namespace', 'page_title',
|
|
'linter_id', 'linter_params',
|
|
'linter_start', 'linter_end',
|
|
'linter_cat'
|
|
]
|
|
),
|
|
'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;
|
|
|
|
// 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
|
|
if ( $this->category === null && $row->linter_cat !== null ) {
|
|
$category = $this->categoryManager->getCategoryName( $row->linter_cat );
|
|
} else {
|
|
$category = $this->category;
|
|
$row->linter_cat = $this->categoryId;
|
|
}
|
|
$lintError = Database::makeLintError( $row );
|
|
|
|
if ( !$lintError ) {
|
|
return '';
|
|
}
|
|
|
|
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' => '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 ( $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'] );
|
|
}
|
|
return '';
|
|
case 'template':
|
|
if ( !$lintError->templateInfo ) {
|
|
return '—';
|
|
}
|
|
|
|
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 '—';
|
|
}
|
|
}
|
|
|
|
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;
|
|
}
|
|
}
|