wiki.techinc.nl/includes/exception/ThrottledError.php

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

46 lines
1.2 KiB
PHP
Raw Normal View History

<?php
/**
* 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
*/
/**
* Show an error when the user hits a rate limit.
*
* @newable
* @since 1.18
* @ingroup Exception
*/
class ThrottledError extends ErrorPageError {
/**
* @stable to call
*/
public function __construct() {
parent::__construct(
'actionthrottled',
'actionthrottledtext'
);
}
public function report( $action = ErrorPageError::SEND_OUTPUT ) {
global $wgOut;
Set ThrottledError's response code to 429 ThrottledError currently returns a 503, which in turn results into badly-written spambots occasionally flooding our 5xx logs and graphs. There is no reason, however, for ThrottledError to return a 5xx in the first place: it's a user-generated error (user hitting a rate limit and being throttled), not a server error. 5xx error codes in general have many other implications, such as frontend caches treating this as a backend failure and potentially retrying the same request, so they are unsuitable and undesirable for the ThrottledError exception. RFC 6585 (April 2012, updates: 2616) has added a special 4xx code specifically for rate-limiting, 429 Too Many Requests. As the description of that code matches exactly what ThrottledError was meant for, switch it to using 429 instead. Note that there is a chance 429 might be mistreated and not showed by older or badly-written user agents as it's fairly new and not part of RFC 2616, the original HTTP/1.1 spec. However, the last paragraph of section 6.1.1 of RFC 2616, specifically covers the issue of UAs & unknown status codes: it dictates that applications MUST understand the class of any status code and treat them as the "x00 status code of that class" (here: 400), MUST NOT be cached, and "SHOULD present to the user the entity returned with the response, since that entity is likely to include human-readable information which will explain the unusual status". Change-Id: I46335a76096ec800ee8ce5471bacffd41d2dc4f6
2014-03-25 10:35:49 +00:00
$wgOut->setStatusCode( 429 );
parent::report( $action );
}
}