includes/api/ApiFormatRaw.php

   1 <?php
   2 /**
   3  *
   4  *
   5  * Created on Feb 2, 2009
   6  *
   7  * Copyright © 2009 Roan Kattouw "<Firstname>.<Lastname>@gmail.com"
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  */
  26
  27 /**
  28  * Formatter that spits out anything you like with any desired MIME type
  29  * @ingroup API
  30  */
  31 class ApiFormatRaw extends ApiFormatBase {
  32
  33         private $errorFallback;
  34         private $mFailWithHTTPError = false;
  35
  36
  37         /**
  38          * @param ApiMain $main
  39          * @param ApiFormatBase |null $errorFallback Object to fall back on for errors
  40          */
  41         public function __construct( ApiMain $main, ApiFormatBase $errorFallback = null ) {
  42                 parent::__construct( $main, 'raw' );
  43                 if ( $errorFallback === null ) {
  44                         $this->errorFallback = $main->createPrinterByName( $main->getParameter( 'format' ) );
  45                 } else {
  46                         $this->errorFallback = $errorFallback;
  47                 }
  48         }
  49
  50         public function getMimeType() {
  51                 $data = $this->getResult()->getResultData();
  52
  53                 if ( isset( $data['error'] ) ) {
  54                         return $this->errorFallback->getMimeType();
  55                 }
  56
  57                 if ( !isset( $data['mime'] ) ) {
  58                         ApiBase::dieDebug( __METHOD__, 'No MIME type set for raw formatter' );
  59                 }
  60
  61                 return $data['mime'];
  62         }
  63
  64         public function initPrinter( $unused = false ) {
  65                 $data = $this->getResult()->getResultData();
  66                 if ( isset( $data['error'] ) ) {
  67                         $this->errorFallback->initPrinter( $unused );
  68                         if ( $this->mFailWithHTTPError ) {
  69                                 $this->getMain()->getRequest()->response()->statusHeader( 400 );
  70                         }
  71                 } else {
  72                         parent::initPrinter( $unused );
  73                 }
  74         }
  75
  76         public function closePrinter() {
  77                 $data = $this->getResult()->getResultData();
  78                 if ( isset( $data['error'] ) ) {
  79                         $this->errorFallback->closePrinter();
  80                 } else {
  81                         parent::closePrinter();
  82                 }
  83         }
  84
  85         public function execute() {
  86                 $data = $this->getResult()->getResultData();
  87                 if ( isset( $data['error'] ) ) {
  88                         $this->errorFallback->execute();
  89                         return;
  90                 }
  91
  92                 if ( !isset( $data['text'] ) ) {
  93                         ApiBase::dieDebug( __METHOD__, 'No text given for raw formatter' );
  94                 }
  95                 $this->printText( $data['text'] );
  96         }
  97
  98         /**
  99          * Output HTTP error code 400 when if an error is encountered
 100          *
 101          * The purpose is for output formats where the user-agent will
 102          * not be able to interpret the validity of the content in any
 103          * other way. For example subtitle files read by browser video players.
 104          *
 105          * @param bool $fail
 106          */
 107         public function setFailWithHTTPError( $fail ) {
 108                 $this->mFailWithHTTPError = $fail;
 109         }
 110 }