Page MenuHomeWickedGov Phorge
Files F4162048

SitemapHandlerBase.php
No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

SitemapHandlerBase.php
View Options

<?php
namespace MediaWiki\Rest\Handler;
use MediaWiki\Config\Config;
use MediaWiki\Language\Language;
use MediaWiki\Languages\LanguageConverterFactory;
use MediaWiki\MainConfigNames;
use MediaWiki\Page\SitemapGenerator;
use MediaWiki\Permissions\PermissionManager;
use MediaWiki\Rest\Handler;
use MediaWiki\Rest\HeaderParser\HttpDate;
use MediaWiki\Rest\StringStream;
use Wikimedia\Timestamp\ConvertibleTimestamp;
abstract class SitemapHandlerBase extends Handler {
protected bool $enabled;
/** @var int */
protected $indexSize;
/** @var int */
protected $sitemapSize;
/** @var int */
protected $expiry;
protected function __construct(
Config $config,
protected LanguageConverterFactory $languageConverterFactory,
protected Language $contLang,
private PermissionManager $permissionManager,
) {
$apiConf = $config->get( MainConfigNames::SitemapApiConfig );
$this->enabled = $apiConf['enabled'] ?? false;
$this->indexSize = $apiConf['sitemapsPerIndex'] ?? 50_000;
$variants = SitemapGenerator::getVariants( $contLang, $languageConverterFactory );
$this->sitemapSize = (int)( ( $apiConf['pagesPerSitemap'] ?? 10_000 ) / ( count( $variants ) + 1 ) );
$this->expiry = $apiConf['expiry'] ?? 3600;
}
/**
* @param int $indexId
* @param int $fileId
* @return int
*/
protected function getOffset( $indexId, $fileId ) {
return $this->sitemapSize * ( $indexId * $this->indexSize + $fileId );
}
/** @inheritDoc */
public function execute() {
if ( !$this->enabled ) {
return $this->getResponseFactory()
->createHttpError( 404, [ 'message' => 'Disabled by configuration' ] );
}
if ( !$this->permissionManager->isEveryoneAllowed( 'read' ) ) {
return $this->getResponseFactory()
->createHttpError( 403, [ 'message' => 'This site has restricted access' ] );
}
$xml = $this->getXml();
$response = $this->getResponseFactory()->create();
$response->setHeader( 'Content-Type', 'application/xml; charset=utf-8' );
$response->setHeader(
'Expires',
HttpDate::format(
( $this->getLastModified() ?? ConvertibleTimestamp::time() ) + $this->expiry
)
);
$response->setHeader( 'Cache-Control', 'public' );
$response->setBody( new StringStream( $xml ) );
return $response;
}
abstract protected function getXml(): string;
}

File Metadata

Mime Type
text/x-php
Expires
Aug 20 2026, 01:18 (10 w, 6 h ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
f7/4a/2074726c0c786085554291020488
Default Alt Text
SitemapHandlerBase.php (2 KB)

Event Timeline