4e6810e4a2
API warnings and error messages are currently hard-coded English strings. This patch changes that. With a few exceptions, this patch should be compatible with non-updated extensions: * The change to ApiBase::$messageMap will blow up anything trying to mess with it. * The changes to the 'ApiCheckCanExecute' hook will cause a wrong (probably unparsed) error message to be emitted for extensions not already using an ApiMessage. Unless they're currently broken like Wikibase. Bug: T37074 Bug: T47843 Depends-On: Ia2b66b57cd4eaddc30b3ffdd7b97d6ca3e02d898 Depends-On: I2e1bb975bb0045476c03ebe6cdec00259bae22ec Depends-On: I53987bf87c48f6c00deec17a8e957d24fcc3eaa6 Depends-On: Ibf93a459eb62d30f7c70d20e91ec9faeb80d10ed Depends-On: I3cf889811f44a15935e454dd42f081164d4a098c Depends-On: Ieae527de86735ddcba34724730e8730fb277b99b Depends-On: I535344c29d51521147c2a26c341dae38cec3e931 Change-Id: Iae0e2ce3bd42dd4776a9779664086119ac188412
109 lines
3.1 KiB
PHP
109 lines
3.1 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
*
|
|
* Created on Feb 2, 2009
|
|
*
|
|
* Copyright © 2009 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
/**
|
|
* Formatter that spits out anything you like with any desired MIME type
|
|
* @ingroup API
|
|
*/
|
|
class ApiFormatRaw extends ApiFormatBase {
|
|
|
|
private $errorFallback;
|
|
private $mFailWithHTTPError = false;
|
|
|
|
/**
|
|
* @param ApiMain $main
|
|
* @param ApiFormatBase|null $errorFallback Object to fall back on for errors
|
|
*/
|
|
public function __construct( ApiMain $main, ApiFormatBase $errorFallback = null ) {
|
|
parent::__construct( $main, 'raw' );
|
|
if ( $errorFallback === null ) {
|
|
$this->errorFallback = $main->createPrinterByName( $main->getParameter( 'format' ) );
|
|
} else {
|
|
$this->errorFallback = $errorFallback;
|
|
}
|
|
}
|
|
|
|
public function getMimeType() {
|
|
$data = $this->getResult()->getResultData();
|
|
|
|
if ( isset( $data['error'] ) || isset( $data['errors'] ) ) {
|
|
return $this->errorFallback->getMimeType();
|
|
}
|
|
|
|
if ( !isset( $data['mime'] ) ) {
|
|
ApiBase::dieDebug( __METHOD__, 'No MIME type set for raw formatter' );
|
|
}
|
|
|
|
return $data['mime'];
|
|
}
|
|
|
|
public function initPrinter( $unused = false ) {
|
|
$data = $this->getResult()->getResultData();
|
|
if ( isset( $data['error'] ) || isset( $data['errors'] ) ) {
|
|
$this->errorFallback->initPrinter( $unused );
|
|
if ( $this->mFailWithHTTPError ) {
|
|
$this->getMain()->getRequest()->response()->statusHeader( 400 );
|
|
}
|
|
} else {
|
|
parent::initPrinter( $unused );
|
|
}
|
|
}
|
|
|
|
public function closePrinter() {
|
|
$data = $this->getResult()->getResultData();
|
|
if ( isset( $data['error'] ) || isset( $data['errors'] ) ) {
|
|
$this->errorFallback->closePrinter();
|
|
} else {
|
|
parent::closePrinter();
|
|
}
|
|
}
|
|
|
|
public function execute() {
|
|
$data = $this->getResult()->getResultData();
|
|
if ( isset( $data['error'] ) || isset( $data['errors'] ) ) {
|
|
$this->errorFallback->execute();
|
|
return;
|
|
}
|
|
|
|
if ( !isset( $data['text'] ) ) {
|
|
ApiBase::dieDebug( __METHOD__, 'No text given for raw formatter' );
|
|
}
|
|
$this->printText( $data['text'] );
|
|
}
|
|
|
|
/**
|
|
* Output HTTP error code 400 when if an error is encountered
|
|
*
|
|
* The purpose is for output formats where the user-agent will
|
|
* not be able to interpret the validity of the content in any
|
|
* other way. For example subtitle files read by browser video players.
|
|
*
|
|
* @param bool $fail
|
|
*/
|
|
public function setFailWithHTTPError( $fail ) {
|
|
$this->mFailWithHTTPError = $fail;
|
|
}
|
|
}
|