API
2 weeks ago
Access
2 weeks ago
Application
2 weeks ago
Archive
2 weeks ago
ArchiveProcessor
2 weeks ago
Archiver
2 years ago
AssetManager
2 weeks ago
Auth
2 weeks ago
Category
2 weeks ago
Changes
2 months ago
CliMulti
2 weeks ago
Columns
2 weeks ago
Concurrency
2 weeks ago
Config
2 weeks ago
Container
2 months ago
CronArchive
2 weeks ago
DataAccess
2 weeks ago
DataFiles
2 years ago
DataTable
2 weeks ago
Db
2 weeks ago
DeviceDetector
1 year ago
Email
2 years ago
Exception
5 months ago
Http
2 weeks ago
Intl
4 months ago
Log
2 years ago
Mail
1 year ago
Measurable
8 months ago
Menu
2 weeks ago
Metrics
2 weeks ago
Notification
8 months ago
Period
2 weeks ago
Plugin
2 weeks ago
Policy
2 months ago
ProfessionalServices
1 year ago
Report
1 year ago
ReportRenderer
2 weeks ago
Request
2 weeks ago
Scheduler
2 weeks ago
Segment
2 weeks ago
Session
1 month ago
Settings
2 weeks ago
Tracker
2 weeks ago
Translation
2 months ago
Twig
1 year ago
UpdateCheck
4 months ago
Updater
2 weeks ago
Updates
1 month ago
Validators
1 year ago
View
2 months ago
ViewDataTable
2 weeks ago
Visualization
2 weeks ago
Widget
2 weeks ago
.htaccess
2 years ago
Access.php
2 weeks ago
Archive.php
2 months ago
ArchiveProcessor.php
2 weeks ago
AssetManager.php
2 weeks ago
Auth.php
8 months ago
AuthResult.php
8 months ago
BaseFactory.php
2 years ago
Cache.php
2 weeks ago
CacheId.php
5 months ago
CliMulti.php
2 weeks ago
Common.php
2 weeks ago
Config.php
2 weeks ago
Console.php
4 months ago
Context.php
2 years ago
Cookie.php
2 weeks ago
CronArchive.php
2 weeks ago
DI.php
4 months ago
DataArray.php
2 weeks ago
DataTable.php
2 weeks ago
Date.php
2 months ago
Db.php
2 months ago
DbHelper.php
2 weeks ago
Development.php
2 weeks ago
ErrorHandler.php
8 months ago
EventDispatcher.php
2 months ago
ExceptionHandler.php
5 months ago
FileIntegrity.php
2 weeks ago
Filechecks.php
1 year ago
Filesystem.php
2 weeks ago
FrontController.php
2 weeks ago
Http.php
2 weeks ago
IP.php
1 year ago
Log.php
4 months ago
LogDeleter.php
2 weeks ago
Mail.php
1 year ago
Metrics.php
2 months ago
NoAccessException.php
2 years ago
Nonce.php
8 months ago
Notification.php
2 months ago
NumberFormatter.php
2 weeks ago
Option.php
2 weeks ago
Period.php
2 weeks ago
Piwik.php
2 weeks ago
Plugin.php
2 months ago
Process.php
2 months ago
Profiler.php
2 weeks ago
ProxyHeaders.php
5 months ago
ProxyHttp.php
2 weeks ago
QuickForm2.php
4 months ago
RankingQuery.php
2 months ago
ReportRenderer.php
2 weeks ago
Request.php
2 months ago
Segment.php
2 weeks ago
Sequence.php
2 weeks ago
Session.php
1 month ago
SettingsPiwik.php
2 weeks ago
SettingsServer.php
2 weeks ago
Singleton.php
2 years ago
Site.php
2 months ago
SiteContentDetector.php
2 months ago
SupportedBrowser.php
2 years ago
TCPDF.php
1 year ago
Theme.php
2 weeks ago
Timer.php
2 weeks ago
Tracker.php
2 weeks ago
Twig.php
2 months ago
Unzip.php
1 year ago
UpdateCheck.php
2 months ago
Updater.php
2 weeks ago
UpdaterErrorException.php
2 years ago
Updates.php
2 weeks ago
Url.php
2 weeks ago
UrlHelper.php
2 months ago
Version.php
2 weeks ago
View.php
2 weeks ago
bootstrap.php
1 year ago
dispatch.php
2 years ago
testMinimumPhpVersion.php
8 months ago
Request.php
266 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * Matomo - free/libre analytics platform |
| 5 | * |
| 6 | * @link https://matomo.org |
| 7 | * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later |
| 8 | */ |
| 9 | namespace Piwik; |
| 10 | |
| 11 | use InvalidArgumentException; |
| 12 | /** |
| 13 | * Provides (type safe) access methods for request parameters. |
| 14 | * |
| 15 | * Ensure to handle parameters received with this class with care. |
| 16 | * Especially parameters received as string, array or json might contain malicious content. Those should never be used |
| 17 | * raw in templates or other output. |
| 18 | * |
| 19 | * Note: For security reasons this class will automatically remove null byte sequences from string values. |
| 20 | * |
| 21 | * @api |
| 22 | */ |
| 23 | class Request |
| 24 | { |
| 25 | /** |
| 26 | * @var array |
| 27 | */ |
| 28 | protected $requestParameters; |
| 29 | private static $exceptionMsg = "The parameter '%s' isn't set in the Request and a default value wasn't provided."; |
| 30 | public function __construct(array $requestParameters) |
| 31 | { |
| 32 | $this->requestParameters = $requestParameters; |
| 33 | } |
| 34 | /** |
| 35 | * Creates a request object using GET and POST parameters of the current request |
| 36 | * |
| 37 | * @return static |
| 38 | */ |
| 39 | public static function fromRequest() : self |
| 40 | { |
| 41 | return new self($_GET + $_POST); |
| 42 | } |
| 43 | /** |
| 44 | * Creates a request object using only GET parameters of the current request |
| 45 | * |
| 46 | * @return static |
| 47 | */ |
| 48 | public static function fromGet() : self |
| 49 | { |
| 50 | return new self($_GET); |
| 51 | } |
| 52 | /** |
| 53 | * Creates a request object using only POST parameters of the current request |
| 54 | * |
| 55 | * @return static |
| 56 | */ |
| 57 | public static function fromPost() : self |
| 58 | { |
| 59 | return new self($_POST); |
| 60 | } |
| 61 | /** |
| 62 | * Creates a request object using the parameters that can be extracted from the provided query string |
| 63 | * |
| 64 | * @return static |
| 65 | */ |
| 66 | public static function fromQueryString(string $queryString) : self |
| 67 | { |
| 68 | $requestParameters = []; |
| 69 | parse_str($queryString, $requestParameters); |
| 70 | // If a querystring is provided urlencode'd parse_str will not be able to parse it correctly. |
| 71 | // A querystring like `method%3dVisitsSummary.get%26idSite%3d1` would result in |
| 72 | // an array like `['method=VisitsSummary.get&idSite=1' => '']` |
| 73 | // In this case we try to parse the urldecode'd string to get proper results |
| 74 | // Note: We can't always perform a urldecode, as this might otherwise destroy urlencoded values containing a & |
| 75 | if (1 === count($requestParameters) && '' === end($requestParameters)) { |
| 76 | $requestParameters = []; |
| 77 | parse_str(urldecode($queryString), $requestParameters); |
| 78 | } |
| 79 | return new self($requestParameters); |
| 80 | } |
| 81 | /** |
| 82 | * Returns the requested parameter from the request object. |
| 83 | * If the requested parameter can't be found and no default is provided an exception will be thrown |
| 84 | * |
| 85 | * Note: It's recommend to use one of type-safe methods instead, if a certain type is expected: |
| 86 | * @see getIntegerParameter |
| 87 | * @see getFloatParameter |
| 88 | * @see getStringParameter |
| 89 | * @see getArrayParameter |
| 90 | * @see getJSONParameter |
| 91 | * |
| 92 | * @param mixed $default |
| 93 | * @return mixed |
| 94 | * @throws InvalidArgumentException |
| 95 | */ |
| 96 | public function getParameter(string $name, $default = null) |
| 97 | { |
| 98 | if (!strlen($name)) { |
| 99 | throw new InvalidArgumentException('Invalid request parameter. Parameter name required.'); |
| 100 | } |
| 101 | if (array_key_exists($name, $this->requestParameters) && $this->requestParameters[$name] !== null) { |
| 102 | return $this->filterNullBytes($this->requestParameters[$name]); |
| 103 | } |
| 104 | if (null !== $default) { |
| 105 | return $default; |
| 106 | } |
| 107 | throw new InvalidArgumentException(sprintf(self::$exceptionMsg, $name)); |
| 108 | } |
| 109 | /** |
| 110 | * Returns the requested parameter from the request object. |
| 111 | * If no default is provided and the requested parameter either can't be found or is not of type integer an |
| 112 | * exception will be thrown |
| 113 | * |
| 114 | * @throws InvalidArgumentException |
| 115 | */ |
| 116 | public function getIntegerParameter(string $name, ?int $default = null) : int |
| 117 | { |
| 118 | $parameter = $this->getParameter($name, $default); |
| 119 | if ((is_string($parameter) || is_numeric($parameter)) && (string) $parameter === (string) (int) $parameter) { |
| 120 | return (int) $parameter; |
| 121 | } |
| 122 | if (null !== $default) { |
| 123 | return $default; |
| 124 | } |
| 125 | throw new InvalidArgumentException(sprintf(self::$exceptionMsg, $name)); |
| 126 | } |
| 127 | /** |
| 128 | * Returns the requested parameter from the request object. |
| 129 | * If no default is provided and the requested parameter either can't be found or is not of type float an |
| 130 | * exception will be thrown |
| 131 | * |
| 132 | * @throws InvalidArgumentException |
| 133 | */ |
| 134 | public function getFloatParameter(string $name, ?float $default = null) : float |
| 135 | { |
| 136 | $parameter = $this->getParameter($name, $default); |
| 137 | $parsedFloat = \Piwik\Common::parseFloat($parameter); |
| 138 | if ($parsedFloat !== null) { |
| 139 | return $parsedFloat; |
| 140 | } |
| 141 | if (null !== $default) { |
| 142 | return $default; |
| 143 | } |
| 144 | throw new InvalidArgumentException(sprintf(self::$exceptionMsg, $name)); |
| 145 | } |
| 146 | /** |
| 147 | * Returns the requested parameter from the request object. |
| 148 | * If no default is provided and the requested parameter either can't be found or is not of type string an |
| 149 | * exception will be thrown |
| 150 | * |
| 151 | * @throws InvalidArgumentException |
| 152 | */ |
| 153 | public function getStringParameter(string $name, ?string $default = null) : string |
| 154 | { |
| 155 | $parameter = $this->getParameter($name, $default); |
| 156 | if (is_string($parameter) || is_numeric($parameter)) { |
| 157 | return $this->filterNullBytes((string) $parameter); |
| 158 | } |
| 159 | if (null !== $default) { |
| 160 | return $default; |
| 161 | } |
| 162 | throw new InvalidArgumentException(sprintf(self::$exceptionMsg, $name)); |
| 163 | } |
| 164 | /** |
| 165 | * Returns the requested parameter from the request object. |
| 166 | * If no default is provided and the requested parameter either can't be found or can't be converted to boolean |
| 167 | * exception will be thrown |
| 168 | * |
| 169 | * Values accepted as bool-ish: |
| 170 | * true: true, 'true', '1', 1 |
| 171 | * false: false, 'false', '0', 0 |
| 172 | * |
| 173 | * @throws InvalidArgumentException |
| 174 | */ |
| 175 | public function getBoolParameter(string $name, ?bool $default = null) : bool |
| 176 | { |
| 177 | $parameter = $this->getParameter($name, $default); |
| 178 | if ($parameter === \false || $parameter === \true) { |
| 179 | return $parameter; |
| 180 | } |
| 181 | if (\is_string($parameter) && \strtolower($parameter) === 'false' || $parameter === '0' || $parameter === 0) { |
| 182 | return \false; |
| 183 | } |
| 184 | if (\is_string($parameter) && \strtolower($parameter) === 'true' || $parameter === '1' || $parameter === 1) { |
| 185 | return \true; |
| 186 | } |
| 187 | if (null !== $default) { |
| 188 | return $default; |
| 189 | } |
| 190 | throw new InvalidArgumentException(sprintf(self::$exceptionMsg, $name)); |
| 191 | } |
| 192 | /** |
| 193 | * Returns the requested parameter from the request object. |
| 194 | * If no default is provided and the requested parameter either can't be found or is not of type array an |
| 195 | * exception will be thrown |
| 196 | * |
| 197 | * @param array|null $default |
| 198 | * @return array |
| 199 | * @throws InvalidArgumentException |
| 200 | */ |
| 201 | public function getArrayParameter(string $name, ?array $default = null) : array |
| 202 | { |
| 203 | $parameter = $this->getParameter($name, $default); |
| 204 | if (is_array($parameter)) { |
| 205 | return $this->filterNullBytes($parameter); |
| 206 | } |
| 207 | if (null !== $default) { |
| 208 | return $default; |
| 209 | } |
| 210 | throw new InvalidArgumentException(sprintf(self::$exceptionMsg, $name)); |
| 211 | } |
| 212 | /** |
| 213 | * Returns the requested parameter from the request object. |
| 214 | * If no default is provided and the requested parameter either can't be found or can't be json_decode'd an |
| 215 | * exception will be thrown |
| 216 | * |
| 217 | * @param mixed $default |
| 218 | * @return mixed |
| 219 | * @throws InvalidArgumentException |
| 220 | */ |
| 221 | public function getJsonParameter(string $name, $default = null) |
| 222 | { |
| 223 | try { |
| 224 | // Note we can't simply pass the default to getParameter here, in case the default would be string |
| 225 | // we would otherwise try to parse it as json below, which might result in unexpected behavior |
| 226 | $parameter = $this->getParameter($name); |
| 227 | } catch (InvalidArgumentException $e) { |
| 228 | $parameter = null; |
| 229 | if ($default !== null) { |
| 230 | return $default; |
| 231 | } |
| 232 | } |
| 233 | if (is_string($parameter)) { |
| 234 | $decodedValue = \json_decode($parameter, \true); |
| 235 | if ($decodedValue !== null && $decodedValue !== '') { |
| 236 | return $this->filterNullBytes($decodedValue); |
| 237 | } |
| 238 | } |
| 239 | if (null !== $default) { |
| 240 | return $default; |
| 241 | } |
| 242 | throw new InvalidArgumentException(sprintf(self::$exceptionMsg, $name)); |
| 243 | } |
| 244 | private function filterNullBytes($value) |
| 245 | { |
| 246 | if (is_array($value)) { |
| 247 | $result = []; |
| 248 | foreach ($value as $key => $arrayValue) { |
| 249 | $result[$key] = $this->filterNullBytes($arrayValue); |
| 250 | } |
| 251 | return $result; |
| 252 | } else { |
| 253 | return is_string($value) ? \Piwik\Common::sanitizeNullBytes($value) : $value; |
| 254 | } |
| 255 | } |
| 256 | /** |
| 257 | * Returns an array containing all parameters of the request object |
| 258 | * |
| 259 | * @return array |
| 260 | */ |
| 261 | public function getParameters() : array |
| 262 | { |
| 263 | return $this->requestParameters; |
| 264 | } |
| 265 | } |
| 266 |