Page MenuHomeWickedGov Phorge
Files F4076519

TranslationStashActionApi.php
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

TranslationStashActionApi.php
View Options

<?php
declare( strict_types = 1 );
namespace MediaWiki\Extension\Translate\TranslatorSandbox;
use MediaWiki\Api\ApiBase;
use MediaWiki\Api\ApiMain;
use MediaWiki\Extension\Translate\MessageGroupProcessing\MessageGroups;
use MediaWiki\Extension\Translate\MessageLoading\MessageHandle;
use MediaWiki\Extension\Translate\MessageLoading\MessageIndex;
use MediaWiki\Json\FormatJson;
use MediaWiki\Title\Title;
use MediaWiki\User\UserFactory;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\Rdbms\IConnectionProvider;
/**
* WebAPI module for storing translations for users who are in a sandbox.
* Access is controlled by hooks in TranslateSandbox class.
* @author Niklas Laxström
* @license GPL-2.0-or-later
* @since 2013.06
*/
class TranslationStashActionApi extends ApiBase {
private IConnectionProvider $dbProvider;
private UserFactory $userFactory;
private MessageIndex $messageIndex;
public function __construct(
ApiMain $mainModule,
string $moduleName,
IConnectionProvider $dbProvider,
UserFactory $userFactory,
MessageIndex $messageIndex
) {
parent::__construct( $mainModule, $moduleName );
$this->dbProvider = $dbProvider;
$this->userFactory = $userFactory;
$this->messageIndex = $messageIndex;
}
public function execute(): void {
$params = $this->extractRequestParams();
// The user we are operating on, not necessarily the user making the request
$user = $this->getUser();
if ( isset( $params['username'] ) ) {
if ( $user->isAllowed( 'translate-sandboxmanage' ) ) {
$user = $this->userFactory->newFromName( $params['username'] );
if ( !$user ) {
$this->dieWithError( [ 'apierror-badparameter', 'username' ], 'invalidparam' );
}
} else {
$this->dieWithError( [ 'apierror-badparameter', 'username' ], 'invalidparam' );
}
}
$stash = new TranslationStashStorage( $this->dbProvider->getPrimaryDatabase() );
$action = $params['subaction'];
if ( $action === 'add' ) {
if ( !isset( $params['title'] ) ) {
$this->dieWithError( [ 'apierror-missingparam', 'title' ] );
}
if ( !isset( $params['translation'] ) ) {
$this->dieWithError( [ 'apierror-missingparam', 'translation' ] );
}
$metadata = $params['metadata'] ? FormatJson::decode( $params['metadata'], true ) : null;
// @todo: Return value of Title::newFromText not checked
$translation = new StashedTranslation(
$user,
Title::newFromText( $params['title'] ),
$params['translation'],
$metadata
);
$stash->addTranslation( $translation );
}
$output = [];
if ( $action === 'query' ) {
$output['translations'] = [];
$translations = $stash->getTranslations( $user );
foreach ( $translations as $translation ) {
$output['translations'][] = $this->formatTranslation( $translation );
}
}
// If we got this far, nothing has failed
$output['result'] = 'ok';
$this->getResult()->addValue( null, $this->getModuleName(), $output );
}
private function formatTranslation( StashedTranslation $translation ): array {
$title = $translation->getTitle();
$handle = new MessageHandle( $title );
// Prepare for the worst
$definition = '';
$comparison = '';
if ( $handle->isValid() ) {
$groupId = $this->messageIndex->getPrimaryGroupId( $handle );
$group = MessageGroups::getGroup( $groupId );
$key = $handle->getKey();
$definition = $group->getMessage( $key, $group->getSourceLanguage() );
$comparison = $group->getMessage( $key, $handle->getCode() );
}
return [
'title' => $title->getPrefixedText(),
'definition' => $definition,
'translation' => $translation->getValue(),
'comparison' => $comparison,
'metadata' => $translation->getMetadata(),
];
}
public function isWriteMode(): bool {
return true;
}
public function needsToken(): string {
return 'csrf';
}
protected function getAllowedParams(): array {
return [
'subaction' => [
ParamValidator::PARAM_TYPE => [ 'add', 'query' ],
ParamValidator::PARAM_REQUIRED => true,
],
'title' => [
ParamValidator::PARAM_TYPE => 'string',
],
'translation' => [
ParamValidator::PARAM_TYPE => 'string',
],
'metadata' => [
ParamValidator::PARAM_TYPE => 'string',
],
'username' => [
ParamValidator::PARAM_TYPE => 'string',
],
];
}
protected function getExamplesMessages(): array {
return [
'action=translationstash&subaction=add&title=MediaWiki:Jan/fi&translation=tammikuu&metadata={}'
=> 'apihelp-translationstash-example-1',
'action=translationstash&subaction=query'
=> 'apihelp-translationstash-example-2',
];
}
}

File Metadata

Mime Type
text/x-php
Expires
Aug 17 2026, 20:57 (9 w, 3 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
63/4d/1bc78d43f1a82a62b08f0347147e
Default Alt Text
TranslationStashActionApi.php (4 KB)

Event Timeline