558471f044
* Added ConditionalHeaderUtil, a conditional request helper class meant for composition into Handler. I evaluated the composer package micheh/psr7-cache for this role but I decided that I prefer DIY code rather than some rather ugly glue. * Check conditional request headers prior to entry into Handler::execute(). Contrary to what was previously documented, use the results of getLastModified() and getETag() to set headers in the response. This is convenient and can be overridden in the Handler if desired by overriding a one-line function. * Instead of locking up header parsing inside ConditionalHeaderUtil as was done in micheh/psr7-cache, make a start on a new reusable header parsing framework, with recursive descent parsers for HTTP-date and IfNoneMatch. Change-Id: I260809081cad7701df8620ab03834158670d4230
96 lines
2.1 KiB
PHP
96 lines
2.1 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Rest\HeaderParser;
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
class HeaderParserBase {
|
|
/**
|
|
* @var string $input The input string being processed
|
|
*/
|
|
protected $input;
|
|
|
|
/**
|
|
* @var int $pos The position within $input
|
|
*/
|
|
protected $pos;
|
|
|
|
/**
|
|
* @var int $inputLength The length of $input
|
|
*/
|
|
protected $inputLength;
|
|
|
|
/**
|
|
* Set the input, and derived convenience properties
|
|
*
|
|
* @param string $input
|
|
*/
|
|
protected function setInput( $input ) {
|
|
$this->input = $input;
|
|
$this->pos = 0;
|
|
$this->inputLength = strlen( $input );
|
|
}
|
|
|
|
/**
|
|
* Consume a specified string, or throw an exception.
|
|
*
|
|
* @param string $s
|
|
* @throws HeaderParserError
|
|
*/
|
|
protected function consumeString( $s ) {
|
|
if ( $this->pos >= $this->inputLength ) {
|
|
$this->error( "Expected \"$s\" but got end of string" );
|
|
}
|
|
if ( substr_compare( $this->input, $s, $this->pos, strlen( $s ) ) === 0 ) {
|
|
$this->pos += strlen( $s );
|
|
} else {
|
|
$this->error( "Expected \"$s\"" );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Skip whitespace at the input position (OWS)
|
|
*/
|
|
protected function skipWhitespace() {
|
|
$this->pos += strspn( $this->input, " \t", $this->pos );
|
|
}
|
|
|
|
/**
|
|
* Throw an exception to indicate a parse error
|
|
*
|
|
* @param string $message
|
|
* @throws HeaderParserError
|
|
*/
|
|
protected function error( $message ) {
|
|
throw new HeaderParserError( "$message at {$this->pos}" );
|
|
}
|
|
|
|
/**
|
|
* Consume a specified number of digits, or throw an exception
|
|
*
|
|
* @param int $numDigits
|
|
* @return string
|
|
* @throws HeaderParserError
|
|
*/
|
|
protected function consumeFixedDigits( $numDigits ) {
|
|
$digits = substr( $this->input, $this->pos, $numDigits );
|
|
if ( strlen( $digits ) !== $numDigits || !preg_match( '/^[0-9]*$/', $digits ) ) {
|
|
$this->error( "expected $numDigits digits" );
|
|
}
|
|
$this->pos += $numDigits;
|
|
return $digits;
|
|
}
|
|
|
|
/**
|
|
* If the position is not at the end of the input string, raise an error,
|
|
* complaining of trailing characters.
|
|
*
|
|
* @throws HeaderParserError
|
|
*/
|
|
protected function assertEnd() {
|
|
if ( $this->pos !== $this->inputLength ) {
|
|
$this->error( "trailing characters" );
|
|
}
|
|
}
|
|
}
|