Page MenuHomeWickedGov Phorge
Files F4152965

ApiCategoryTree.php
No OneTemporary
Actions

Size
5 KB
Referenced Files
None
Subscribers
None

ApiCategoryTree.php
View Options

<?php
namespace MediaWiki\Extension\CategoryTree;
use MediaWiki\Api\ApiBase;
use MediaWiki\Api\ApiMain;
use MediaWiki\Json\FormatJson;
use MediaWiki\Languages\LanguageConverterFactory;
use MediaWiki\Linker\LinkRenderer;
use MediaWiki\MainConfigNames;
use MediaWiki\Title\Title;
use Wikimedia\ObjectCache\WANObjectCache;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Rdbms\IConnectionProvider;
/**
* 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
*/
class ApiCategoryTree extends ApiBase {
private LanguageConverterFactory $languageConverterFactory;
private LinkRenderer $linkRenderer;
private IConnectionProvider $dbProvider;
private WANObjectCache $wanCache;
public function __construct(
ApiMain $main,
string $action,
IConnectionProvider $dbProvider,
LanguageConverterFactory $languageConverterFactory,
LinkRenderer $linkRenderer,
WANObjectCache $wanCache
) {
parent::__construct( $main, $action );
$this->languageConverterFactory = $languageConverterFactory;
$this->linkRenderer = $linkRenderer;
$this->dbProvider = $dbProvider;
$this->wanCache = $wanCache;
}
/**
* @inheritDoc
*/
public function execute() {
$params = $this->extractRequestParams();
$options = $this->extractOptions( $params );
$title = CategoryTree::makeTitle( $params['category'] );
if ( !$title || $title->isExternal() ) {
$this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['category'] ) ] );
}
$depth = isset( $options['depth'] ) ? (int)$options['depth'] : 1;
$ct = new CategoryTree( $options, $this->getConfig(), $this->dbProvider, $this->linkRenderer );
$depth = $ct->optionManager->capDepth( $depth );
$html = $this->getHTML( $ct, $title, $depth );
$this->getMain()->setCacheMode( 'public' );
$this->getResult()->addContentValue( $this->getModuleName(), 'html', $html );
}
/**
* @param array $params
* @return string[]
*/
private function extractOptions( array $params ): array {
if ( !isset( $params['options'] ) ) {
return [];
}
$options = FormatJson::decode( $params['options'] );
if ( !is_object( $options ) ) {
$this->dieWithError( 'apierror-categorytree-invalidjson', 'invalidjson' );
}
foreach ( $options as $option => $value ) {
if ( is_scalar( $value ) || $value === null ) {
continue;
}
if ( $option === 'namespaces' && is_array( $value ) ) {
continue;
}
$this->dieWithError(
[ 'apierror-categorytree-invalidjson-option', $option ], 'invalidjson-option'
);
}
return get_object_vars( $options );
}
/**
* @param string $condition
*
* @return bool|null|string
*/
public function getConditionalRequestData( $condition ) {
if ( $condition === 'last-modified' ) {
$params = $this->extractRequestParams();
$title = CategoryTree::makeTitle( $params['category'] );
return $this->dbProvider->getReplicaDatabase()->newSelectQueryBuilder()
->select( 'page_touched' )
->from( 'page' )
->where( [
'page_namespace' => NS_CATEGORY,
'page_title' => $title->getDBkey(),
] )
->caller( __METHOD__ )
->fetchField();
}
}
/**
* Get category tree HTML for the given tree, title and depth
*
* @param CategoryTree $ct
* @param Title $title
* @param int $depth
* @return string HTML
*/
private function getHTML( CategoryTree $ct, Title $title, int $depth ): string {
$langConv = $this->languageConverterFactory->getLanguageConverter();
return $this->wanCache->getWithSetCallback(
$this->wanCache->makeKey(
'categorytree-html-ajax',
md5( $title->getDBkey() ),
md5( $ct->optionManager->getOptionsAsCacheKey( $depth ) ),
$this->getLanguage()->getCode(),
$langConv->getExtraHashOptions(),
$this->getConfig()->get( MainConfigNames::RenderHashAppend )
),
$this->wanCache::TTL_DAY,
static function () use ( $ct, $title, $depth ) {
return $ct->renderChildren( $title, $depth );
},
[
'touchedCallback' => function () {
$timestamp = $this->getConditionalRequestData( 'last-modified' );
return $timestamp ? wfTimestamp( TS_UNIX, $timestamp ) : null;
}
]
);
}
/**
* @inheritDoc
*/
public function getAllowedParams() {
return [
'category' => [
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true,
],
'options' => [
ParamValidator::PARAM_TYPE => 'string',
],
];
}
/**
* @inheritDoc
*/
public function isInternal() {
return true;
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 19 2026, 20:34 (7 w, 4 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
b3/ab/a2f54be9562dcf8855f2b4f1a938
Default Alt Text
ApiCategoryTree.php (5 KB)

Event Timeline