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
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 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 |
<?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\Exceptions\DownloadException; use CodeIgniter\Files\File; use Config\Mimes; /** * HTTP response when a download is requested. */ class DownloadResponse extends Message implements ResponseInterface { /** * Download file name * * @var string */ private $filename; /** * Download for file * * @var File */ private $file; /** * mime set flag * * @var boolean */ private $setMime; /** * Download for binary * * @var string */ private $binary; /** * Download reason * * @var string */ private $reason = 'OK'; /** * Download charset * * @var string */ private $charset = 'UTF-8'; /** * pretend * * @var boolean */ private $pretend = false; /** * Constructor. * * @param string $filename * @param boolean $setMime */ public function __construct(string $filename, bool $setMime) { $this->filename = $filename; $this->setMime = $setMime; } /** * set download for binary string. * * @param string $binary */ public function setBinary(string $binary) { if ($this->file !== null) { throw DownloadException::forCannotSetBinary(); } $this->binary = $binary; } /** * set download for file. * * @param string $filepath */ public function setFilePath(string $filepath) { if ($this->binary !== null) { throw DownloadException::forCannotSetFilePath($filepath); } $this->file = new File($filepath, true); } /** * set name for the download. * * @param string $filename * * @return $this */ public function setFileName(string $filename) { $this->filename = $filename; return $this; } /** * get content length. * * @return integer */ public function getContentLength() : int { if (is_string($this->binary)) { return strlen($this->binary); } elseif ($this->file instanceof File) { return $this->file->getSize(); } return 0; } /** * Set content type by guessing mime type from file extension */ private function setContentTypeByMimeType() { $mime = null; $charset = ''; if ($this->setMime === true) { if (($last_dot_position = strrpos($this->filename, '.')) !== false) { $mime = Mimes::guessTypeFromExtension(substr($this->filename, $last_dot_position + 1)); $charset = $this->charset; } } if (! is_string($mime)) { // Set the default MIME type to send $mime = 'application/octet-stream'; $charset = ''; } $this->setContentType($mime, $charset); } /** * get download filename. * * @return string */ private function getDownloadFileName(): string { $filename = $this->filename; $x = explode('.', $this->filename); $extension = end($x); /* It was reported that browsers on Android 2.1 (and possibly older as well) * need to have the filename extension upper-cased in order to be able to * download it. * * Reference: http://digiblog.de/2011/04/19/android-and-the-download-file-headers/ */ // @todo: depend super global if (count($x) !== 1 && isset($_SERVER['HTTP_USER_AGENT']) && preg_match('/Android\s(1|2\.[01])/', $_SERVER['HTTP_USER_AGENT'])) { $x[count($x) - 1] = strtoupper($extension); $filename = implode('.', $x); } return $filename; } /** * get Content-Disposition Header string. * * @return string */ private function getContentDisposition() : string { $download_filename = $this->getDownloadFileName(); $utf8_filename = $download_filename; if (strtoupper($this->charset) !== 'UTF-8') { $utf8_filename = mb_convert_encoding($download_filename, 'UTF-8', $this->charset); } $result = sprintf('attachment; filename="%s"', $download_filename); if (isset($utf8_filename)) { $result .= '; filename*=UTF-8\'\'' . rawurlencode($utf8_filename); } return $result; } /** * {@inheritDoc} */ public function getStatusCode(): int { return 200; } //-------------------------------------------------------------------- /** * Return an instance with the specified status code and, optionally, reason phrase. * * If no reason phrase is specified, will default recommended reason phrase for * the response's status code. * * @see http://tools.ietf.org/html/rfc7231#section-6 * @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml * * @param integer $code The 3-digit integer result code to set. * @param string $reason The reason phrase to use with the * provided status code; if none is provided, will * default to the IANA name. * * @throws DownloadException */ public function setStatusCode(int $code, string $reason = '') { throw DownloadException::forCannotSetStatusCode($code, $reason); } //-------------------------------------------------------------------- /** * Gets the response response phrase associated with the status code. * * @see http://tools.ietf.org/html/rfc7231#section-6 * @see http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml * * @return string */ public function getReason(): string { return $this->reason; } //-------------------------------------------------------------------- //-------------------------------------------------------------------- // Convenience Methods //-------------------------------------------------------------------- /** * Sets the date header * * @param \DateTime $date * * @return ResponseInterface */ public function setDate(\DateTime $date) { $date->setTimezone(new \DateTimeZone('UTC')); $this->setHeader('Date', $date->format('D, d M Y H:i:s') . ' GMT'); return $this; } //-------------------------------------------------------------------- /** * Sets the Content Type header for this response with the mime type * and, optionally, the charset. * * @param string $mime * @param string $charset * * @return ResponseInterface */ public function setContentType(string $mime, string $charset = 'UTF-8') { // add charset attribute if not already there and provided as parm if ((strpos($mime, 'charset=') < 1) && ! empty($charset)) { $mime .= '; charset=' . $charset; } $this->removeHeader('Content-Type'); // replace existing content type $this->setHeader('Content-Type', $mime); if (! empty($charset)) { $this->charset = $charset; } return $this; } /** * Sets the appropriate headers to ensure this response * is not cached by the browsers. */ public function noCache(): self { $this->removeHeader('Cache-control'); $this->setHeader('Cache-control', ['private', 'no-transform', 'no-store', 'must-revalidate']); return $this; } //-------------------------------------------------------------------- /** * A shortcut method that allows the developer to set all of the * cache-control headers in one method call. * * The options array is used to provide the cache-control directives * for the header. It might look something like: * * $options = [ * 'max-age' => 300, * 's-maxage' => 900 * 'etag' => 'abcde', * ]; * * Typical options are: * - etag * - last-modified * - max-age * - s-maxage * - private * - public * - must-revalidate * - proxy-revalidate * - no-transform * * @param array $options * * @throws DownloadException */ public function setCache(array $options = []) { throw DownloadException::forCannotSetCache(); } //-------------------------------------------------------------------- /** * {@inheritDoc} */ public function setLastModified($date) { if ($date instanceof \DateTime) { $date->setTimezone(new \DateTimeZone('UTC')); $this->setHeader('Last-Modified', $date->format('D, d M Y H:i:s') . ' GMT'); } elseif (is_string($date)) { $this->setHeader('Last-Modified', $date); } return $this; } //-------------------------------------------------------------------- //-------------------------------------------------------------------- // Output Methods //-------------------------------------------------------------------- /** * For unit testing, don't actually send headers. * * @param boolean $pretend * @return $this */ public function pretend(bool $pretend = true) { $this->pretend = $pretend; return $this; } /** * {@inheritDoc} */ public function send() { $this->buildHeaders(); $this->sendHeaders(); $this->sendBody(); return $this; } /** * set header for file download. */ public function buildHeaders() { if (! $this->hasHeader('Content-Type')) { $this->setContentTypeByMimeType(); } $this->setHeader('Content-Disposition', $this->getContentDisposition()); $this->setHeader('Expires-Disposition', '0'); $this->setHeader('Content-Transfer-Encoding', 'binary'); $this->setHeader('Content-Length', (string)$this->getContentLength()); $this->noCache(); } /** * Sends the headers of this HTTP request to the browser. * * @return DownloadResponse */ public function sendHeaders() { // Have the headers already been sent? if ($this->pretend || headers_sent()) { return $this; } // Per spec, MUST be sent with each request, if possible. // http://www.w3.org/Protocols/rfc2616/rfc2616-sec13.html if (! isset($this->headers['Date'])) { $this->setDate(\DateTime::createFromFormat('U', time())); } // HTTP Status header(sprintf('HTTP/%s %s %s', $this->getProtocolVersion(), $this->getStatusCode(), $this->getReason()), true, $this->getStatusCode()); // Send all of our headers foreach ($this->getHeaders() as $name => $values) { header($name . ': ' . $this->getHeaderLine($name), false, $this->getStatusCode()); } return $this; } /** * output download file text. * * @throws DownloadException * * @return DownloadResponse */ public function sendBody() { if ($this->binary !== null) { return $this->sendBodyByBinary(); } elseif ($this->file !== null) { return $this->sendBodyByFilePath(); } throw DownloadException::forNotFoundDownloadSource(); } /** * output download text by file. * * @return DownloadResponse */ private function sendBodyByFilePath() { $spl_file_object = $this->file->openFile('rb'); // Flush 1MB chunks of data while (! $spl_file_object->eof() && ($data = $spl_file_object->fread(1048576)) !== false) { echo $data; } return $this; } /** * output download text by binary * * @return DownloadResponse */ private function sendBodyByBinary() { echo $this->binary; return $this; } } |
Commits for paulgoughbooks_old/trunk/system/HTTP/DownloadResponse.php
Revision | Author | Commited | Message |
---|---|---|---|
2 | tporter | Tue 03 Nov, 2020 08:50:21 +0000 | Migration of Paul Goughs Books site to Codeignitor 4 |