MediaWiki  1.28.0
AjaxResponse.php
Go to the documentation of this file.
1 <?php
30 class AjaxResponse {
35  private $mCacheDuration;
36 
41  private $mContentType;
42 
47  private $mDisabled;
48 
53  private $mLastModified;
54 
59  private $mResponseCode;
60 
65  private $mVary;
66 
71  private $mText;
72 
76  private $mConfig;
77 
82  function __construct( $text = null, Config $config = null ) {
83  $this->mCacheDuration = null;
84  $this->mVary = null;
85  $this->mConfig = $config ?: ConfigFactory::getDefaultInstance()->makeConfig( 'main' );
86 
87  $this->mDisabled = false;
88  $this->mText = '';
89  $this->mResponseCode = 200;
90  $this->mLastModified = false;
91  $this->mContentType = 'application/x-wiki';
92 
93  if ( $text ) {
94  $this->addText( $text );
95  }
96  }
97 
102  function setCacheDuration( $duration ) {
103  $this->mCacheDuration = $duration;
104  }
105 
110  function setVary( $vary ) {
111  $this->mVary = $vary;
112  }
113 
118  function setResponseCode( $code ) {
119  $this->mResponseCode = $code;
120  }
121 
126  function setContentType( $type ) {
127  $this->mContentType = $type;
128  }
129 
133  function disable() {
134  $this->mDisabled = true;
135  }
136 
141  function addText( $text ) {
142  if ( !$this->mDisabled && $text ) {
143  $this->mText .= $text;
144  }
145  }
146 
150  function printText() {
151  if ( !$this->mDisabled ) {
153  }
154  }
155 
159  function sendHeaders() {
160  if ( $this->mResponseCode ) {
161  // For back-compat, it is supported that mResponseCode be a string like " 200 OK"
162  // (with leading space and the status message after). Cast response code to an integer
163  // to take advantage of PHP's conversion rules which will turn " 200 OK" into 200.
164  // http://php.net/string#language.types.string.conversion
165  $n = intval( trim( $this->mResponseCode ) );
166  HttpStatus::header( $n );
167  }
168 
169  header( "Content-Type: " . $this->mContentType );
170 
171  if ( $this->mLastModified ) {
172  header( "Last-Modified: " . $this->mLastModified );
173  } else {
174  header( "Last-Modified: " . gmdate( "D, d M Y H:i:s" ) . " GMT" );
175  }
176 
177  if ( $this->mCacheDuration ) {
178  # If CDN caches are configured, tell them to cache the response,
179  # and tell the client to always check with the CDN. Otherwise,
180  # tell the client to use a cached copy, without a way to purge it.
181 
182  if ( $this->mConfig->get( 'UseSquid' ) ) {
183  # Expect explicit purge of the proxy cache, but require end user agents
184  # to revalidate against the proxy on each visit.
185  # Surrogate-Control controls our CDN, Cache-Control downstream caches
186 
187  if ( $this->mConfig->get( 'UseESI' ) ) {
188  header( 'Surrogate-Control: max-age=' . $this->mCacheDuration . ', content="ESI/1.0"' );
189  header( 'Cache-Control: s-maxage=0, must-revalidate, max-age=0' );
190  } else {
191  header( 'Cache-Control: s-maxage=' . $this->mCacheDuration . ', must-revalidate, max-age=0' );
192  }
193 
194  } else {
195  # Let the client do the caching. Cache is not purged.
196  header( "Expires: " . gmdate( "D, d M Y H:i:s", time() + $this->mCacheDuration ) . " GMT" );
197  header( "Cache-Control: s-maxage={$this->mCacheDuration}," .
198  "public,max-age={$this->mCacheDuration}" );
199  }
200 
201  } else {
202  # always expired, always modified
203  header( "Expires: Mon, 26 Jul 1997 05:00:00 GMT" ); // Date in the past
204  header( "Cache-Control: no-cache, must-revalidate" ); // HTTP/1.1
205  header( "Pragma: no-cache" ); // HTTP/1.0
206  }
207 
208  if ( $this->mVary ) {
209  header( "Vary: " . $this->mVary );
210  }
211  }
212 
223  $fname = 'AjaxResponse::checkLastModified';
224 
225  if ( !$timestamp || $timestamp == '19700101000000' ) {
226  wfDebug( "$fname: CACHE DISABLED, NO TIMESTAMP", 'private' );
227  return false;
228  }
229 
230  if ( !$wgCachePages ) {
231  wfDebug( "$fname: CACHE DISABLED", 'private' );
232  return false;
233  }
234 
236  $lastmod = wfTimestamp( TS_RFC2822, max( $timestamp, $wgUser->getTouched(), $wgCacheEpoch ) );
237 
238  if ( !empty( $_SERVER['HTTP_IF_MODIFIED_SINCE'] ) ) {
239  # IE sends sizes after the date like this:
240  # Wed, 20 Aug 2003 06:51:19 GMT; length=5202
241  # this breaks strtotime().
242  $modsince = preg_replace( '/;.*$/', '', $_SERVER["HTTP_IF_MODIFIED_SINCE"] );
243  $modsinceTime = strtotime( $modsince );
244  $ismodsince = wfTimestamp( TS_MW, $modsinceTime ? $modsinceTime : 1 );
245  wfDebug( "$fname: -- client send If-Modified-Since: $modsince", 'private' );
246  wfDebug( "$fname: -- we might send Last-Modified : $lastmod", 'private' );
247 
248  if ( ( $ismodsince >= $timestamp )
249  && $wgUser->validateCache( $ismodsince ) &&
250  $ismodsince >= $wgCacheEpoch
251  ) {
252  ini_set( 'zlib.output_compression', 0 );
253  $this->setResponseCode( 304 );
254  $this->disable();
255  $this->mLastModified = $lastmod;
256 
257  wfDebug( "$fname: CACHED client: $ismodsince ; user: {$wgUser->getTouched()} ; " .
258  "page: $timestamp ; site $wgCacheEpoch", 'private' );
259 
260  return true;
261  } else {
262  wfDebug( "$fname: READY client: $ismodsince ; user: {$wgUser->getTouched()} ; " .
263  "page: $timestamp ; site $wgCacheEpoch", 'private' );
264  $this->mLastModified = $lastmod;
265  }
266  } else {
267  wfDebug( "$fname: client did not send If-Modified-Since header", 'private' );
268  $this->mLastModified = $lastmod;
269  }
270  return false;
271  }
272 
278  function loadFromMemcached( $mckey, $touched ) {
279  if ( !$touched ) {
280  return false;
281  }
282 
283  $mcvalue = ObjectCache::getMainWANInstance()->get( $mckey );
284  if ( $mcvalue ) {
285  # Check to see if the value has been invalidated
286  if ( $touched <= $mcvalue['timestamp'] ) {
287  wfDebug( "Got $mckey from cache" );
288  $this->mText = $mcvalue['value'];
289 
290  return true;
291  } else {
292  wfDebug( "$mckey has expired" );
293  }
294  }
295 
296  return false;
297  }
298 
304  function storeInMemcached( $mckey, $expiry = 86400 ) {
305  ObjectCache::getMainWANInstance()->set( $mckey,
306  [
307  'timestamp' => wfTimestampNow(),
308  'value' => $this->mText
309  ], $expiry
310  );
311 
312  return true;
313  }
314 }
sendHeaders()
Construct the header and output it.
printText()
Output text.
static getMainWANInstance()
Get the main WAN cache object.
disable()
Disable output.
static header($code)
Output an HTTP status code header.
Definition: HttpStatus.php:96
const TS_RFC2822
RFC 2822 format, for E-mail and HTTP headers.
Definition: defines.php:21
$mLastModified
Date for the HTTP header Last-modified.
Config $mConfig
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
$mResponseCode
HTTP response code.
wfDebug($text, $dest= 'all', array $context=[])
Sends a line to the debug log if enabled or, optionally, to a comment in output.
setContentType($type)
Set the HTTP header Content-Type.
loadFromMemcached($mckey, $touched)
wfTimestamp($outputtype=TS_UNIX, $ts=0)
Get a timestamp string in one of various formats.
$wgCachePages
Allow client-side caching of pages.
Handle responses for Ajax requests (send headers, print content, that sort of thing) ...
checkLastModified($timestamp)
checkLastModified tells the client to use the client-cached response if possible. ...
if($limit) $timestamp
$mText
Content of our HTTP response.
$mDisabled
Disables output.
wfTimestampNow()
Convenience function; returns MediaWiki timestamp for the present time.
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
Definition: defines.php:11
$mVary
HTTP Vary header.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable & $code
Definition: hooks.txt:802
static getDefaultInstance()
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
if(!defined( 'MEDIAWIKI')) $fname
This file is not a valid entry point, perform no further processing unless MEDIAWIKI is defined...
Definition: Setup.php:36
$mContentType
HTTP header Content-Type.
__construct($text=null, Config $config=null)
setResponseCode($code)
Set the HTTP response code.
addText($text)
Add content to the response.
storeInMemcached($mckey, $expiry=86400)
$wgCacheEpoch
Set this to current time to invalidate all prior cached pages.
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
$mCacheDuration
Number of seconds to get the response cached by a proxy.
setVary($vary)
Set the HTTP Vary header.
$wgUser
Definition: Setup.php:806
setCacheDuration($duration)
Set the number of seconds to get the response cached by a proxy.