wiki.techinc.nl/includes/Revision/MainSlotRoleHandler.php
Bartosz Dziewoński 6ba47296d9 Fix Phan suppressions related to Title::castFrom*() and friends
There is no way to express that Title::castFromPageIdentity(),
Title::castFromPageReference() and Title::castFromLinkTarget()
can only return null when the parameter is null. We need to add
Phan suppressions or explicit types almost everywhere that these
methods are used with parameters that are known to not be null.

Instead, introduce new methods Title::newFromPageIdentity() and
Title::newFromPageReference() (Title::newFromLinkTarget() already
exists), without the null-coalescing behavior, and use them when
the parameter is not null. This lets static analysis tools, and
humans, easily understand where nulls can't appear.

Do the same with the corresponding TitleFactory methods.

Change the obvious uses of castFrom*() to newFrom*() (if there is
a Phan suppression, a type check, or a method call on the result).

Change-Id: Ida4da75953cf3bca372a40dc88022443109ca0cb
2023-04-22 16:45:09 +02:00

160 lines
4.8 KiB
PHP

<?php
/**
* This file is part of MediaWiki.
*
* 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\Revision;
use MediaWiki\Content\IContentHandlerFactory;
use MediaWiki\HookContainer\HookContainer;
use MediaWiki\HookContainer\HookRunner;
use MediaWiki\Linker\LinkTarget;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Title\TitleFactory;
use MWUnknownContentModelException;
/**
* A SlotRoleHandler for the main slot. While most slot roles serve a specific purpose and
* thus typically exhibit the same behaviour on all pages, the main slot is used for different
* things in different pages, typically depending on the namespace, a "file extension" in
* the page name, or the content model of the slot's content.
*
* MainSlotRoleHandler implements some of the per-namespace and per-model behavior that was
* supported prior to MediaWiki Version 1.33.
*
* @since 1.33
*/
class MainSlotRoleHandler extends SlotRoleHandler {
/**
* @var string[] A mapping of namespaces to content models.
* @see $wgNamespaceContentModels
*/
private $namespaceContentModels;
/** @var IContentHandlerFactory */
private $contentHandlerFactory;
/** @var HookRunner */
private $hookRunner;
/** @var TitleFactory */
private $titleFactory;
/**
* @param string[] $namespaceContentModels A mapping of namespaces to content models,
* typically from $wgNamespaceContentModels.
* @param IContentHandlerFactory $contentHandlerFactory
* @param HookContainer $hookContainer
* @param TitleFactory $titleFactory
*/
public function __construct(
array $namespaceContentModels,
IContentHandlerFactory $contentHandlerFactory,
HookContainer $hookContainer,
TitleFactory $titleFactory
) {
parent::__construct( SlotRecord::MAIN, CONTENT_MODEL_WIKITEXT );
$this->namespaceContentModels = $namespaceContentModels;
$this->contentHandlerFactory = $contentHandlerFactory;
$this->hookRunner = new HookRunner( $hookContainer );
$this->titleFactory = $titleFactory;
}
public function supportsArticleCount() {
return true;
}
/**
* @param string $model
* @param PageIdentity $page
*
* @return bool
* @throws MWUnknownContentModelException
*/
public function isAllowedModel( $model, PageIdentity $page ) {
$title = $this->titleFactory->newFromPageIdentity( $page );
$handler = $this->contentHandlerFactory->getContentHandler( $model );
return $handler->canBeUsedOn( $title );
}
/**
* @param LinkTarget|PageIdentity $page
*
* @return string
*/
public function getDefaultModel( $page ) {
// NOTE: this method must not rely on $title->getContentModel() directly or indirectly,
// because it is used to initialize the mContentModel member.
$ext = '';
$ns = $page->getNamespace();
$model = $this->namespaceContentModels[$ns] ?? null;
// Hook can determine default model
if ( $page instanceof PageIdentity ) {
$title = $this->titleFactory->newFromPageIdentity( $page );
} else {
$title = $this->titleFactory->newFromLinkTarget( $page );
}
// @phan-suppress-next-line PhanTypeMismatchArgument Type mismatch on pass-by-ref args
if ( !$this->hookRunner->onContentHandlerDefaultModelFor( $title, $model ) && $model !== null ) {
return $model;
}
// Could this page contain code based on the title?
$isCodePage = $ns === NS_MEDIAWIKI && preg_match( '!\.(css|js|json)$!u', $title->getText(), $m );
if ( $isCodePage ) {
$ext = $m[1];
}
// Is this a user subpage containing code?
$isCodeSubpage = $ns === NS_USER
&& !$isCodePage
&& preg_match( "/\\/.*\\.(js|css|json)$/", $title->getText(), $m );
if ( $isCodeSubpage ) {
$ext = $m[1];
}
// Is this wikitext, according to $wgNamespaceContentModels or the DefaultModelFor hook?
$isWikitext = $model === null || $model == CONTENT_MODEL_WIKITEXT;
$isWikitext = $isWikitext && !$isCodePage && !$isCodeSubpage;
if ( !$isWikitext ) {
switch ( $ext ) {
case 'js':
return CONTENT_MODEL_JAVASCRIPT;
case 'css':
return CONTENT_MODEL_CSS;
case 'json':
return CONTENT_MODEL_JSON;
default:
return $model ?? CONTENT_MODEL_TEXT;
}
}
// We established that it must be wikitext
return CONTENT_MODEL_WIKITEXT;
}
}