makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-08 12:28:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/16955] Clean up request classes

Browse source 
PHPBB3-16955
This commit is contained in:
Marc Alexander 2022-12-26 14:52:27 +01:00
parent 5b23dcd606
commit 056f786769
No known key found for this signature in database
GPG key ID: 50E0D2423696F995
6 changed files with 53 additions and 49 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
phpBB/phpbb/request/deactivated_super_global.php
View file

@ -100,6 +100,8 @@ class deactivated_super_global implements \ArrayAccess, \Countable, \IteratorAgg
/** /**
* Part of the \Countable implementation, will always result in a FATAL error * Part of the \Countable implementation, will always result in a FATAL error
* @return void
* @psalm-suppress InvalidReturnType
*/ */
public function count() public function count()
{ {
@ -108,6 +110,8 @@ class deactivated_super_global implements \ArrayAccess, \Countable, \IteratorAgg
/** /**
* Part of the Traversable/IteratorAggregate implementation, will always result in a FATAL error * Part of the Traversable/IteratorAggregate implementation, will always result in a FATAL error
* @return void
* @psalm-suppress InvalidReturnType
*/ */
public function getIterator() public function getIterator()
{ {

68
phpBB/phpbb/request/request.php
View file

@ -19,18 +19,18 @@ namespace phpbb\request;
* It provides a method to disable access to input data through super globals. * It provides a method to disable access to input data through super globals.
* This should force MOD authors to read about data validation. * This should force MOD authors to read about data validation.
*/ */
class request implements \phpbb\request\request_interface class request implements request_interface
{ {
/** /**
* @var array The names of super global variables that this class should protect if super globals are disabled. * @var array The names of super global variables that this class should protect if super globals are disabled.
*/ */
protected $super_globals = array( protected $super_globals = array(
\phpbb\request\request_interface::POST => '_POST', request_interface::POST => '_POST',
\phpbb\request\request_interface::GET => '_GET', request_interface::GET => '_GET',
\phpbb\request\request_interface::REQUEST => '_REQUEST', request_interface::REQUEST => '_REQUEST',
\phpbb\request\request_interface::COOKIE => '_COOKIE', request_interface::COOKIE => '_COOKIE',
\phpbb\request\request_interface::SERVER => '_SERVER', request_interface::SERVER => '_SERVER',
\phpbb\request\request_interface::FILES => '_FILES', request_interface::FILES => '_FILES',
); );
/** /**
@ -74,8 +74,8 @@ class request implements \phpbb\request\request_interface
} }
// simulate request_order = GP // simulate request_order = GP
$this->original_request = $this->input[\phpbb\request\request_interface::REQUEST]; $this->original_request = $this->input[request_interface::REQUEST];
$this->input[\phpbb\request\request_interface::REQUEST] = $this->input[\phpbb\request\request_interface::POST] + $this->input[\phpbb\request\request_interface::GET]; $this->input[request_interface::REQUEST] = $this->input[request_interface::POST] + $this->input[request_interface::GET];
if ($disable_super_globals) if ($disable_super_globals)
{ {
@ -140,10 +140,10 @@ class request implements \phpbb\request\request_interface
* @param string $var_name The name of the variable that shall be overwritten * @param string $var_name The name of the variable that shall be overwritten
* @param mixed $value The value which the variable shall contain. * @param mixed $value The value which the variable shall contain.
* If this is null the variable will be unset. * If this is null the variable will be unset.
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* Specifies which super global shall be changed * Specifies which super global shall be changed
*/ */
public function overwrite($var_name, $value, $super_global = \phpbb\request\request_interface::REQUEST) public function overwrite($var_name, $value, $super_global = request_interface::REQUEST)
{ {
if (!isset($this->super_globals[$super_global])) if (!isset($this->super_globals[$super_global]))
{ {
@ -181,13 +181,13 @@ class request implements \phpbb\request\request_interface
* This function will always return a value of the same type as the default. * This function will always return a value of the same type as the default.
* @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters * @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
* Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks * Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* Specifies which super global should be used * Specifies which super global should be used
* *
* @return mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the * @return mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the
* the same as that of $default. If the variable is not set $default is returned. * the same as that of $default. If the variable is not set $default is returned.
*/ */
public function variable($var_name, $default, $multibyte = false, $super_global = \phpbb\request\request_interface::REQUEST) public function variable($var_name, $default, $multibyte = false, $super_global = request_interface::REQUEST)
{ {
return $this->_variable($var_name, $default, $multibyte, $super_global, true); return $this->_variable($var_name, $default, $multibyte, $super_global, true);
} }
@ -205,13 +205,13 @@ class request implements \phpbb\request\request_interface
* This function will always return a value of the same type as the default. * This function will always return a value of the same type as the default.
* @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters * @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
* Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks * Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* Specifies which super global should be used * Specifies which super global should be used
* *
* @return mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the * @return mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the
* the same as that of $default. If the variable is not set $default is returned. * the same as that of $default. If the variable is not set $default is returned.
*/ */
public function untrimmed_variable($var_name, $default, $multibyte = false, $super_global = \phpbb\request\request_interface::REQUEST) public function untrimmed_variable($var_name, $default, $multibyte = false, $super_global = request_interface::REQUEST)
{ {
return $this->_variable($var_name, $default, $multibyte, $super_global, false); return $this->_variable($var_name, $default, $multibyte, $super_global, false);
} }
@ -219,7 +219,7 @@ class request implements \phpbb\request\request_interface
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function raw_variable($var_name, $default, $super_global = \phpbb\request\request_interface::REQUEST) public function raw_variable($var_name, $default, $super_global = request_interface::REQUEST)
{ {
$path = false; $path = false;
@ -276,9 +276,9 @@ class request implements \phpbb\request\request_interface
{ {
$multibyte = true; $multibyte = true;
if ($this->is_set($var_name, \phpbb\request\request_interface::SERVER)) if ($this->is_set($var_name, request_interface::SERVER))
{ {
return $this->variable($var_name, $default, $multibyte, \phpbb\request\request_interface::SERVER); return $this->variable($var_name, $default, $multibyte, request_interface::SERVER);
} }
else else
{ {
@ -312,7 +312,7 @@ class request implements \phpbb\request\request_interface
*/ */
public function file($form_name) public function file($form_name)
{ {
return $this->variable($form_name, array('name' => 'none'), true, \phpbb\request\request_interface::FILES); return $this->variable($form_name, array('name' => 'none'), true, request_interface::FILES);
} }
/** /**
@ -327,7 +327,7 @@ class request implements \phpbb\request\request_interface
*/ */
public function is_set_post($name) public function is_set_post($name)
{ {
return $this->is_set($name, \phpbb\request\request_interface::POST); return $this->is_set($name, request_interface::POST);
} }
/** /**
@ -335,12 +335,12 @@ class request implements \phpbb\request\request_interface
* arrays. * arrays.
* *
* @param string $var Name of the variable * @param string $var Name of the variable
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* Specifies the super global which shall be checked * Specifies the super global which shall be checked
* *
* @return bool True if the variable was sent as input * @return bool True if the variable was sent as input
*/ */
public function is_set($var, $super_global = \phpbb\request\request_interface::REQUEST) public function is_set($var, $super_global = request_interface::REQUEST)
{ {
return isset($this->input[$super_global][$var]); return isset($this->input[$super_global][$var]);
} }
@ -370,13 +370,13 @@ class request implements \phpbb\request\request_interface
/** /**
* Returns all variable names for a given super global * Returns all variable names for a given super global
* *
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* The super global from which names shall be taken * The super global from which names shall be taken
* *
* @return array All variable names that are set for the super global. * @return array All variable names that are set for the super global.
* Pay attention when using these, they are unsanitised! * Pay attention when using these, they are unsanitised!
*/ */
public function variable_names($super_global = \phpbb\request\request_interface::REQUEST) public function variable_names($super_global = request_interface::REQUEST)
{ {
if (!isset($this->input[$super_global])) if (!isset($this->input[$super_global]))
{ {
@ -397,14 +397,14 @@ class request implements \phpbb\request\request_interface
* This function will always return a value of the same type as the default. * This function will always return a value of the same type as the default.
* @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters * @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
* Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks * Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* Specifies which super global should be used * Specifies which super global should be used
* @param bool $trim Indicates whether trim() should be applied to string values. * @param bool $trim Indicates whether trim() should be applied to string values.
* *
* @return mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the * @return mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the
* the same as that of $default. If the variable is not set $default is returned. * the same as that of $default. If the variable is not set $default is returned.
*/ */
protected function _variable($var_name, $default, $multibyte = false, $super_global = \phpbb\request\request_interface::REQUEST, $trim = true) protected function _variable($var_name, $default, $multibyte = false, $super_global = request_interface::REQUEST, $trim = true)
{ {
$var = $this->raw_variable($var_name, $default, $super_global); $var = $this->raw_variable($var_name, $default, $super_global);
@ -424,7 +424,7 @@ class request implements \phpbb\request\request_interface
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function get_super_global($super_global = \phpbb\request\request_interface::REQUEST) public function get_super_global($super_global = request_interface::REQUEST)
{ {
return $this->input[$super_global]; return $this->input[$super_global];
} }
@ -432,23 +432,23 @@ class request implements \phpbb\request\request_interface
/** /**
* {@inheritdoc} * {@inheritdoc}
*/ */
public function escape($var, $multibyte) public function escape($value, $multibyte)
{ {
if (is_array($var)) if (is_array($value))
{ {
$result = array(); $result = array();
foreach ($var as $key => $value) foreach ($value as $key => $array_value)
{ {
$this->type_cast_helper->set_var($key, $key, gettype($key), $multibyte); $this->type_cast_helper->set_var($key, $key, gettype($key), $multibyte);
$result[$key] = $this->escape($value, $multibyte); $result[$key] = $this->escape($array_value, $multibyte);
} }
$var = $result; $value = $result;
} }
else else
{ {
$this->type_cast_helper->set_var($var, $var, 'string', $multibyte); $this->type_cast_helper->set_var($value, $value, 'string', $multibyte);
} }
return $var; return $value;
} }
} }

24
phpBB/phpbb/request/request_interface.php
View file

@ -39,10 +39,10 @@ interface request_interface
* @param string $var_name The name of the variable that shall be overwritten * @param string $var_name The name of the variable that shall be overwritten
* @param mixed $value The value which the variable shall contain. * @param mixed $value The value which the variable shall contain.
* If this is null the variable will be unset. * If this is null the variable will be unset.
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* Specifies which super global shall be changed * Specifies which super global shall be changed
*/ */
public function overwrite($var_name, $value, $super_global = \phpbb\request\request_interface::REQUEST); public function overwrite($var_name, $value, $super_global = request_interface::REQUEST);
/** /**
* Central type safe input handling function. * Central type safe input handling function.
@ -56,13 +56,13 @@ interface request_interface
* This function will always return a value of the same type as the default. * This function will always return a value of the same type as the default.
* @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters * @param bool $multibyte If $default is a string this parameter has to be true if the variable may contain any UTF-8 characters
* Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks * Default is false, causing all bytes outside the ASCII range (0-127) to be replaced with question marks
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* Specifies which super global shall be changed * Specifies which super global shall be changed
* *
* @return mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the * @return mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the
* the same as that of $default. If the variable is not set $default is returned. * the same as that of $default. If the variable is not set $default is returned.
*/ */
public function variable($var_name, $default, $multibyte = false, $super_global = \phpbb\request\request_interface::REQUEST); public function variable($var_name, $default, $multibyte = false, $super_global = request_interface::REQUEST);
/** /**
* Get a variable without trimming strings and without escaping. * Get a variable without trimming strings and without escaping.
@ -78,13 +78,13 @@ interface request_interface
* then specifying array("var", 1) as the name will return "a". * then specifying array("var", 1) as the name will return "a".
* @param mixed $default A default value that is returned if the variable was not set. * @param mixed $default A default value that is returned if the variable was not set.
* This function will always return a value of the same type as the default. * This function will always return a value of the same type as the default.
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* Specifies which super global shall be changed * Specifies which super global shall be changed
* *
* @return mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the * @return mixed The value of $_REQUEST[$var_name] run through {@link set_var set_var} to ensure that the type is the
* the same as that of $default. If the variable is not set $default is returned. * the same as that of $default. If the variable is not set $default is returned.
*/ */
public function raw_variable($var_name, $default, $super_global = \phpbb\request\request_interface::REQUEST); public function raw_variable($var_name, $default, $super_global = request_interface::REQUEST);
/** /**
* Shortcut method to retrieve SERVER variables. * Shortcut method to retrieve SERVER variables.
@ -123,12 +123,12 @@ interface request_interface
* arrays. * arrays.
* *
* @param string $var Name of the variable * @param string $var Name of the variable
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* Specifies which super global shall be changed * Specifies which super global shall be changed
* *
* @return bool True if the variable was sent as input * @return bool True if the variable was sent as input
*/ */
public function is_set($var, $super_global = \phpbb\request\request_interface::REQUEST); public function is_set($var, $super_global = request_interface::REQUEST);
/** /**
* Checks whether the current request is an AJAX request (XMLHttpRequest) * Checks whether the current request is an AJAX request (XMLHttpRequest)
@ -147,23 +147,23 @@ interface request_interface
/** /**
* Returns all variable names for a given super global * Returns all variable names for a given super global
* *
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* The super global from which names shall be taken * The super global from which names shall be taken
* *
* @return array All variable names that are set for the super global. * @return array All variable names that are set for the super global.
* Pay attention when using these, they are unsanitised! * Pay attention when using these, they are unsanitised!
*/ */
public function variable_names($super_global = \phpbb\request\request_interface::REQUEST); public function variable_names($super_global = request_interface::REQUEST);
/** /**
* Returns the original array of the requested super global * Returns the original array of the requested super global
* *
* @param string $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE) * @param int $super_global (\phpbb\request\request_interface::POST|GET|REQUEST|COOKIE)
* The super global which will be returned * The super global which will be returned
* *
* @return array The original array of the requested super global. * @return array The original array of the requested super global.
*/ */
public function get_super_global($super_global = \phpbb\request\request_interface::REQUEST); public function get_super_global($super_global = request_interface::REQUEST);
/** /**
* Escape a string variable. * Escape a string variable.

2
phpBB/phpbb/request/type_cast_helper.php
View file

@ -72,7 +72,7 @@ class type_cast_helper implements \phpbb\request\type_cast_helper_interface
/** /**
* Recursively sets a variable to a given type using {@link set_var set_var} * Recursively sets a variable to a given type using {@link set_var set_var}
* *
* @param string $var The value which shall be sanitised (passed by reference). * @param mixed $var The value which shall be sanitised (passed by reference).
* @param mixed $default Specifies the type $var shall have. * @param mixed $default Specifies the type $var shall have.
* If it is an array and $var is not one, then an empty array is returned. * If it is an array and $var is not one, then an empty array is returned.
* Otherwise var is cast to the same type, and if $default is an array all * Otherwise var is cast to the same type, and if $default is an array all

2
phpBB/phpbb/routing/helper.php
View file

@ -83,7 +83,7 @@ class helper
* @param array $params String or array of additional url parameters * @param array $params String or array of additional url parameters
* @param bool $is_amp Is url using & (true) or & (false) * @param bool $is_amp Is url using & (true) or & (false)
* @param string|bool $session_id Possibility to use a custom session id instead of the global one * @param string|bool $session_id Possibility to use a custom session id instead of the global one
* @param bool|string $reference_type The type of reference to be generated (one of the constants) * @param int $reference_type The type of reference to be generated (one of the constants)
* @return string The URL already passed through append_sid() * @return string The URL already passed through append_sid()
*/ */
public function route($route, array $params = array(), $is_amp = true, $session_id = false, $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH) public function route($route, array $params = array(), $is_amp = true, $session_id = false, $reference_type = UrlGeneratorInterface::ABSOLUTE_PATH)

2
tests/mock/request.php
View file

@ -11,7 +11,7 @@
* *
*/ */
class phpbb_mock_request implements \phpbb\request\request_interface class phpbb_mock_request extends \phpbb\request\request
{ {
protected $data; protected $data;