MediaWiki 1.30.2-scripts2

[autoinstalls/mediawiki.git] / includes / api / ApiFormatRaw.php

diff --git a/includes/api/ApiFormatRaw.php b/includes/api/ApiFormatRaw.php
index 8bb66aeae9b1eb6e5a1389151e47d92fd63beb49..ebaeb2ce256ef19713c231af4b5822097769bcb4 100644 (file)
--- a/includes/api/ApiFormatRaw.php
+++ b/includes/api/ApiFormatRaw.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on Feb 2, 2009
+/**
  *
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2009 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * 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
@@ -19,57 +18,103 @@
  *
  * 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.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once ( 'ApiFormatBase.php' );
-}
-
 /**
  * Formatter that spits out anything you like with any desired MIME type
  * @ingroup API
  */
 class ApiFormatRaw extends ApiFormatBase {
 
+       private $errorFallback;
+       private $mFailWithHTTPError = false;
+
        /**
-        * Constructor
-        * @param $main ApiMain object
-        * @param $errorFallback Formatter object to fall back on for errors
+        * @param ApiMain $main
+        * @param ApiFormatBase|null $errorFallback Object to fall back on for errors
         */
-       public function __construct( $main, $errorFallback ) {
-               parent :: __construct( $main, 'raw' );
-               $this->mErrorFallback = $errorFallback;
+       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->getResultData();
+               $data = $this->getResult()->getResultData();
 
-               if ( isset( $data['error'] ) )
-                       return $this->mErrorFallback->getMimeType();
+               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' );
+               }
 
-               if ( !isset( $data['mime'] ) )
-                       ApiBase::dieDebug( __METHOD__, "No MIME type set for raw formatter" );
-       
                return $data['mime'];
        }
 
+       public function getFilename() {
+               $data = $this->getResult()->getResultData();
+               if ( isset( $data['error'] ) ) {
+                       return $this->errorFallback->getFilename();
+               } elseif ( !isset( $data['filename'] ) || $this->getIsWrappedHtml() || $this->getIsHtml() ) {
+                       return parent::getFilename();
+               } else {
+                       return $data['filename'];
+               }
+       }
+
+       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->getResultData();
-               if ( isset( $data['error'] ) )
-               {
-                       $this->mErrorFallback->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" );
+
+               if ( !isset( $data['text'] ) ) {
+                       ApiBase::dieDebug( __METHOD__, 'No text given for raw formatter' );
+               }
                $this->printText( $data['text'] );
        }
 
-       public function getVersion() {
-               return __CLASS__ . ': $Id: ApiFormatRaw.php 61437 2010-01-23 22:26:40Z reedy $';
+       /**
+        * 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;
        }
 }