paulgoughbooks_old
This repository has no backups
This repository's network speed is throttled to 100KB/sec
Upgrade your account to fix these warnings, or use backups.vc for automated backups
@ 2
paulgoughbooks_old / trunk / system / HTTP / Message.php
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 |
<?php /** * CodeIgniter * * An open source application development framework for PHP * * This content is released under the MIT License (MIT) * * Copyright (c) 2014-2019 British Columbia Institute of Technology * Copyright (c) 2019-2020 CodeIgniter Foundation * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal * in the Software without restriction, including without limitation the rights * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the Software is * furnished to do so, subject to the following conditions: * * The above copyright notice and this permission notice shall be included in * all copies or substantial portions of the Software. * * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN * THE SOFTWARE. * * @package CodeIgniter * @author CodeIgniter Dev Team * @copyright 2019-2020 CodeIgniter Foundation * @license https://opensource.org/licenses/MIT MIT License * @link https://codeigniter.com * @since Version 4.0.0 * @filesource */ namespace CodeIgniter\HTTP; use CodeIgniter\HTTP\Exceptions\HTTPException; /** * An HTTP message */ class Message { /** * List of all HTTP request headers. * * @var array */ protected $headers = []; /** * Holds a map of lower-case header names * and their normal-case key as it is in $headers. * Used for case-insensitive header access. * * @var array */ protected $headerMap = []; /** * Protocol version * * @var string */ protected $protocolVersion; /** * List of valid protocol versions * * @var array */ protected $validProtocolVersions = [ '1.0', '1.1', '2', ]; /** * Message body * * @var mixed */ protected $body; //-------------------------------------------------------------------- //-------------------------------------------------------------------- // Body //-------------------------------------------------------------------- /** * Returns the Message's body. * * @return mixed */ public function getBody() { return $this->body; } //-------------------------------------------------------------------- /** * Sets the body of the current message. * * @param mixed $data * * @return Message|Response */ public function setBody($data) { $this->body = $data; return $this; } //-------------------------------------------------------------------- /** * Appends data to the body of the current message. * * @param $data * * @return Message|Response */ public function appendBody($data) { $this->body .= (string) $data; return $this; } //-------------------------------------------------------------------- //-------------------------------------------------------------------- // Headers //-------------------------------------------------------------------- /** * Populates the $headers array with any headers the getServer knows about. */ public function populateHeaders() { $contentType = $_SERVER['CONTENT_TYPE'] ?? getenv('CONTENT_TYPE'); if (! empty($contentType)) { $this->setHeader('Content-Type', $contentType); } unset($contentType); foreach ($_SERVER as $key => $val) { if (sscanf($key, 'HTTP_%s', $header) === 1) { // take SOME_HEADER and turn it into Some-Header $header = str_replace('_', ' ', strtolower($header)); $header = str_replace(' ', '-', ucwords($header)); $this->setHeader($header, $_SERVER[$key]); // Add us to the header map so we can find them case-insensitively $this->headerMap[strtolower($header)] = $header; } } } //-------------------------------------------------------------------- /** * Returns an array containing all headers. * * @return array An array of the request headers */ public function getHeaders(): array { // If no headers are defined, but the user is // requesting it, then it's likely they want // it to be populated so do that... if (empty($this->headers)) { $this->populateHeaders(); } return $this->headers; } //-------------------------------------------------------------------- /** * Returns a single header object. If multiple headers with the same * name exist, then will return an array of header objects. * * @param string $name * * @return array|\CodeIgniter\HTTP\Header */ public function getHeader(string $name) { $orig_name = $this->getHeaderName($name); if (! isset($this->headers[$orig_name])) { return null; } return $this->headers[$orig_name]; } //-------------------------------------------------------------------- /** * Determines whether a header exists. * * @param string $name * * @return boolean */ public function hasHeader(string $name): bool { $orig_name = $this->getHeaderName($name); return isset($this->headers[$orig_name]); } //-------------------------------------------------------------------- /** * Retrieves a comma-separated string of the values for a single header. * * This method returns all of the header values of the given * case-insensitive header name as a string concatenated together using * a comma. * * NOTE: Not all header values may be appropriately represented using * comma concatenation. For such headers, use getHeader() instead * and supply your own delimiter when concatenating. * * @param string $name * * @return string */ public function getHeaderLine(string $name): string { $orig_name = $this->getHeaderName($name); if (! array_key_exists($orig_name, $this->headers)) { return ''; } return $this->headers[$orig_name]->getValueLine(); } //-------------------------------------------------------------------- /** * Sets a header and it's value. * * @param string $name * @param array|null|string $value * * @return Message|Response */ public function setHeader(string $name, $value) { $origName = $this->getHeaderName($name); if (isset($this->headers[$origName]) && is_array($this->headers[$origName])) { $this->appendHeader($origName, $value); } else { $this->headers[$origName] = new Header($origName, $value); $this->headerMap[strtolower($origName)] = $origName; } return $this; } //-------------------------------------------------------------------- /** * Removes a header from the list of headers we track. * * @param string $name * * @return Message */ public function removeHeader(string $name) { $orig_name = $this->getHeaderName($name); unset($this->headers[$orig_name]); unset($this->headerMap[strtolower($name)]); return $this; } //-------------------------------------------------------------------- /** * Adds an additional header value to any headers that accept * multiple values (i.e. are an array or implement ArrayAccess) * * @param string $name * @param string $value * * @return Message */ public function appendHeader(string $name, string $value) { $orig_name = $this->getHeaderName($name); array_key_exists($orig_name, $this->headers) ? $this->headers[$orig_name]->appendValue($value) : $this->setHeader($name, $value); return $this; } //-------------------------------------------------------------------- /** * Adds an additional header value to any headers that accept * multiple values (i.e. are an array or implement ArrayAccess) * * @param string $name * @param string $value * * @return Message */ public function prependHeader(string $name, string $value) { $orig_name = $this->getHeaderName($name); $this->headers[$orig_name]->prependValue($value); return $this; } //-------------------------------------------------------------------- /** * Returns the HTTP Protocol Version. * * @return string */ public function getProtocolVersion(): string { return $this->protocolVersion ?? '1.1'; } //-------------------------------------------------------------------- /** * Sets the HTTP protocol version. * * @param string $version * * @return Message */ public function setProtocolVersion(string $version) { if (! is_numeric($version)) { $version = substr($version, strpos($version, '/') + 1); } if (! in_array($version, $this->validProtocolVersions)) { throw HTTPException::forInvalidHTTPProtocol(implode(', ', $this->validProtocolVersions)); } $this->protocolVersion = $version; return $this; } //-------------------------------------------------------------------- /** * Takes a header name in any case, and returns the * normal-case version of the header. * * @param string $name * * @return string */ protected function getHeaderName(string $name): string { $lower_name = strtolower($name); return $this->headerMap[$lower_name] ?? $name; } //-------------------------------------------------------------------- } |
Commits for paulgoughbooks_old/trunk/system/HTTP/Message.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |