1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
<?php
/**
* Response handler for Ajax requests.
*
* 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
* @ingroup Ajax
*/
use MediaWiki\MediaWikiServices;
/**
* Handle responses for Ajax requests (send headers, print
* content, that sort of thing)
*
* @ingroup Ajax
*/
class AjaxResponse {
/**
* Number of seconds to get the response cached by a proxy
* @var int
*/
private $mCacheDuration;
/**
* HTTP header Content-Type
* @var string
*/
private $mContentType;
/**
* Disables output. Can be set by calling $AjaxResponse->disable()
* @var bool
*/
private $mDisabled;
/**
* Date for the HTTP header Last-modified
* @var string|bool
*/
private $mLastModified;
/**
* HTTP response code
* @var int|string
*/
private $mResponseCode;
/**
* HTTP Vary header
* @var string
*/
private $mVary;
/**
* Content of our HTTP response
* @var string
*/
private $mText;
/**
* @var Config
*/
private $mConfig;
/**
* @param string|null $text
* @param Config|null $config
*/
public function __construct( $text = null, Config $config = null ) {
$this->mCacheDuration = null;
$this->mVary = null;
$this->mConfig = $config ?: MediaWikiServices::getInstance()->getMainConfig();
$this->mDisabled = false;
$this->mText = '';
$this->mResponseCode = 200;
$this->mLastModified = false;
$this->mContentType = 'application/x-wiki';
if ( $text ) {
$this->addText( $text );
}
}
/**
* Set the HTTP response code
* @param int|string $code
*/
public function setResponseCode( $code ) {
$this->mResponseCode = $code;
}
/**
* Set the HTTP header Content-Type
* @param string $type
*/
public function setContentType( $type ) {
$this->mContentType = $type;
}
/**
* Disable output.
*/
public function disable() {
$this->mDisabled = true;
}
/**
* Add content to the response
* @param string $text
*/
public function addText( $text ) {
if ( !$this->mDisabled && $text ) {
$this->mText .= $text;
}
}
/**
* Output text
*/
public function printText() {
if ( !$this->mDisabled ) {
print $this->mText;
}
}
/**
* Construct the header and output it
*/
public function sendHeaders() {
if ( $this->mResponseCode ) {
// For back-compat, it is supported that mResponseCode be a string like " 200 OK"
// (with leading space and the status message after). Cast response code to an integer
// to take advantage of PHP's conversion rules which will turn " 200 OK" into 200.
// https://www.php.net/manual/en/language.types.string.php#language.types.string.conversion
$n = intval( trim( $this->mResponseCode ) );
HttpStatus::header( $n );
}
header( "Content-Type: " . $this->mContentType );
if ( $this->mLastModified ) {
header( "Last-Modified: " . $this->mLastModified );
} else {
header( "Last-Modified: " . gmdate( "D, d M Y H:i:s" ) . " GMT" );
}
if ( $this->mCacheDuration ) {
# If CDN caches are configured, tell them to cache the response,
# and tell the client to always check with the CDN. Otherwise,
# tell the client to use a cached copy, without a way to purge it.
if ( $this->mConfig->get( 'UseCdn' ) ) {
# Expect explicit purge of the proxy cache, but require end user agents
# to revalidate against the proxy on each visit.
header( 'Cache-Control: s-maxage=' . $this->mCacheDuration . ', must-revalidate, max-age=0' );
} else {
# Let the client do the caching. Cache is not purged.
header( "Expires: " . gmdate( "D, d M Y H:i:s", time() + $this->mCacheDuration ) . " GMT" );
header( "Cache-Control: s-maxage={$this->mCacheDuration}," .
"public,max-age={$this->mCacheDuration}" );
}
} else {
# always expired, always modified
header( "Expires: Mon, 26 Jul 1997 05:00:00 GMT" ); // Date in the past
header( "Cache-Control: no-cache, must-revalidate" ); // HTTP/1.1
header( "Pragma: no-cache" ); // HTTP/1.0
}
if ( $this->mVary ) {
header( "Vary: " . $this->mVary );
}
}
}
|
