Page MenuHomeWickedGov Phorge
Files F1433044

ApiJsonSchema.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

ApiJsonSchema.php
View Options

<?php
/**
* API module for retrieving JSON Schema.
*
* @file
* @ingroup EventLogging
* @ingroup Extensions
*
* @author Ori Livneh <ori@wikimedia.org>
*/
namespace MediaWiki\Extension\EventLogging;
use MediaWiki\Api\ApiBase;
use MediaWiki\Api\ApiResult;
use MediaWiki\MediaWikiServices;
use MediaWiki\Revision\RevisionRecord;
use MediaWiki\Revision\SlotRecord;
use MediaWiki\Title\Title;
use Wikimedia\ParamValidator\ParamValidator;
/**
* API module for retrieving JSON Schema.
* This avoids API result paths and returns HTTP error codes in order to
* act like a request for the raw page content.
* @ingroup API
*/
class ApiJsonSchema extends ApiBase {
public function getAllowedParams() {
return [
'revid' => [
ParamValidator::PARAM_TYPE => 'integer',
],
'title' => [
ParamValidator::PARAM_TYPE => 'string',
],
];
}
/**
* @see ApiBase::getExamplesMessages()
* @return array
*/
protected function getExamplesMessages() {
return [
'action=jsonschema&revid=1234'
=> 'apihelp-jsonschema-example-1',
'action=jsonschema&title=Test'
=> 'apihelp-jsonschema-example-2',
];
}
/**
* Set headers on the pending HTTP response.
* @param RevisionRecord $revRecord
*/
private function markCacheable( RevisionRecord $revRecord ) {
$main = $this->getMain();
$main->setCacheMode( 'public' );
$main->setCacheMaxAge( 300 );
$lastModified = wfTimestamp( TS_RFC2822, $revRecord->getTimestamp() );
$main->getRequest()->response()->header( "Last-Modified: $lastModified" );
}
public function execute() {
$params = $this->extractRequestParams();
if ( !isset( $params['revid'] ) && !isset( $params['title'] ) ) {
$this->dieWithError(
[ 'apierror-missingparam-at-least-one-of', 'revid', 'title' ],
null, null, 400
);
}
$revLookup = MediaWikiServices::getInstance()->getRevisionLookup();
// If we are given revid, then look up Revision and
// verify that $params['title'] (if given) matches.
if ( isset( $params['revid'] ) ) {
$revRecord = $revLookup->getRevisionById( $params['revid'] );
if ( !$revRecord ) {
$this->dieWithError(
[ 'apierror-nosuchrevid', $params['revid'] ], null, null, 400
);
}
$title = Title::newFromLinkTarget( $revRecord->getPageAsLinkTarget() );
if ( !$title || !$title->inNamespace( NS_SCHEMA ) ) {
$this->dieWithError(
[ 'apierror-invalidtitle', wfEscapeWikiText( $title ?: '' ) ], null, null, 400
);
}
// If we use the revid param for lookup; the 'title' parameter is
// optional. If present, it is used to assert that the specified
// revision ID is indeed a revision of a page with the specified
// title. (Bug 46174)
if (
$params['title'] &&
!$title->equals( Title::newFromText( $params['title'], NS_SCHEMA ) )
) {
$this->dieWithError(
[ 'apierror-revwrongpage', $params['revid'], wfEscapeWikiText( $params['title'] ) ],
null, null, 400
);
}
// Else use $params['title'] and get the latest revision
} else {
$title = Title::newFromText( $params['title'], NS_SCHEMA );
if ( !$title || !$title->exists() || !$title->inNamespace( NS_SCHEMA ) ) {
$this->dieWithError(
[ 'apierror-invalidtitle', wfEscapeWikiText( $params['title'] ) ], null, null, 400
);
}
$revRecord = $revLookup->getRevisionById( $title->getLatestRevID() );
}
/** @var JsonSchemaContent $content */
$content = $revRecord->getContent( SlotRecord::MAIN );
if ( !$content ) {
$this->dieWithError(
[ 'apierror-nosuchrevid', $revRecord->getId() ],
null, null, 400
);
}
// @phan-suppress-next-line PhanTypeMismatchArgumentNullable T240141
$this->markCacheable( $revRecord );
'@phan-var JsonSchemaContent $content';
$schema = $content->getJsonData();
$result = $this->getResult();
$result->addValue( null, 'title', $title->getText() );
foreach ( $schema as $k => &$v ) {
if ( $k === 'properties' ) {
foreach ( $v as &$properties ) {
$properties[ApiResult::META_BC_BOOLS] = [ 'required' ];
}
}
$result->addValue( null, $k, $v );
}
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 22:35 (2 h, 4 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
cd/fd/6e192d5b26c69266370cd39f023b
Default Alt Text
ApiJsonSchema.php (4 KB)

Event Timeline