|
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
|
|
|
* @param ApiMain $main |
|
38
|
|
|
* @param ApiFormatBase|null $errorFallback Object to fall back on for errors |
|
39
|
|
|
*/ |
|
40
|
|
|
public function __construct( ApiMain $main, ApiFormatBase $errorFallback = null ) { |
|
41
|
|
|
parent::__construct( $main, 'raw' ); |
|
42
|
|
|
if ( $errorFallback === null ) { |
|
43
|
|
|
$this->errorFallback = $main->createPrinterByName( $main->getParameter( 'format' ) ); |
|
|
|
|
|
|
44
|
|
|
} else { |
|
45
|
|
|
$this->errorFallback = $errorFallback; |
|
46
|
|
|
} |
|
47
|
|
|
} |
|
48
|
|
|
|
|
49
|
|
View Code Duplication |
public function getMimeType() { |
|
50
|
|
|
$data = $this->getResult()->getResultData(); |
|
51
|
|
|
|
|
52
|
|
|
if ( isset( $data['error'] ) ) { |
|
53
|
|
|
return $this->errorFallback->getMimeType(); |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
|
|
if ( !isset( $data['mime'] ) ) { |
|
57
|
|
|
ApiBase::dieDebug( __METHOD__, 'No MIME type set for raw formatter' ); |
|
58
|
|
|
} |
|
59
|
|
|
|
|
60
|
|
|
return $data['mime']; |
|
61
|
|
|
} |
|
62
|
|
|
|
|
63
|
|
|
public function initPrinter( $unused = false ) { |
|
64
|
|
|
$data = $this->getResult()->getResultData(); |
|
65
|
|
|
if ( isset( $data['error'] ) ) { |
|
66
|
|
|
$this->errorFallback->initPrinter( $unused ); |
|
67
|
|
|
if ( $this->mFailWithHTTPError ) { |
|
68
|
|
|
$this->getMain()->getRequest()->response()->statusHeader( 400 ); |
|
69
|
|
|
} |
|
70
|
|
|
} else { |
|
71
|
|
|
parent::initPrinter( $unused ); |
|
72
|
|
|
} |
|
73
|
|
|
} |
|
74
|
|
|
|
|
75
|
|
|
public function closePrinter() { |
|
76
|
|
|
$data = $this->getResult()->getResultData(); |
|
77
|
|
|
if ( isset( $data['error'] ) ) { |
|
78
|
|
|
$this->errorFallback->closePrinter(); |
|
79
|
|
|
} else { |
|
80
|
|
|
parent::closePrinter(); |
|
81
|
|
|
} |
|
82
|
|
|
} |
|
83
|
|
|
|
|
84
|
|
View Code Duplication |
public function execute() { |
|
85
|
|
|
$data = $this->getResult()->getResultData(); |
|
86
|
|
|
if ( isset( $data['error'] ) ) { |
|
87
|
|
|
$this->errorFallback->execute(); |
|
88
|
|
|
return; |
|
89
|
|
|
} |
|
90
|
|
|
|
|
91
|
|
|
if ( !isset( $data['text'] ) ) { |
|
92
|
|
|
ApiBase::dieDebug( __METHOD__, 'No text given for raw formatter' ); |
|
93
|
|
|
} |
|
94
|
|
|
$this->printText( $data['text'] ); |
|
95
|
|
|
} |
|
96
|
|
|
|
|
97
|
|
|
/** |
|
98
|
|
|
* Output HTTP error code 400 when if an error is encountered |
|
99
|
|
|
* |
|
100
|
|
|
* The purpose is for output formats where the user-agent will |
|
101
|
|
|
* not be able to interpret the validity of the content in any |
|
102
|
|
|
* other way. For example subtitle files read by browser video players. |
|
103
|
|
|
* |
|
104
|
|
|
* @param bool $fail |
|
105
|
|
|
*/ |
|
106
|
|
|
public function setFailWithHTTPError( $fail ) { |
|
107
|
|
|
$this->mFailWithHTTPError = $fail; |
|
108
|
|
|
} |
|
109
|
|
|
} |
|
110
|
|
|
|
wikimedia /
mediawiki
This check looks for access to methods that are not accessible from the current context.
If you need to make a method accessible to another context you can raise its visibility level in the defining class.