File FileResponse.php | ICanBoogie/HTTP v2.5.0

  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

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\HTTP;

use ICanBoogie\DateTime;

/**
 * Representation of an HTTP response delivering a file.
 *
 * @property-read \SplFileInfo $file
 * @property-read int $modified_time
 * @property-read RequestRange $range
 * @property-read bool $is_modified
 */
class FileResponse extends Response
{
    /**
     * Specifies the `ETag` header field of the response. If it is not defined the
     * SHA-384 of the file is used instead.
     */
    const OPTION_ETAG = 'etag';

    /**
     * Specifies the expiration date as a {@link DateTime} instance or a relative date
     * such as "+3 month", which maps to the `Expires` header field. The `max-age` directive of
     * the `Cache-Control` header field is computed from the current time. If it is not
     * defined {@link DEFAULT_EXPIRES} is used instead.
     */
    const OPTION_EXPIRES = 'expires';

    /**
     * Specifies the filename of the file and forces download. The following header are updated:
     * `Content-Transfer-Encoding`, `Content-Description`, and `Content-Dispositon`.
     */
    const OPTION_FILENAME = 'filename';

    /**
     * Specifies the MIME of the file, which maps to the `Content-Type` header field. If it is
     * not defined the MIME is guessed using `finfo::file()`.
     */
    const OPTION_MIME = 'mime';

    const DEFAULT_EXPIRES = '+1 month';
    const DEFAULT_MIME = 'application/octet-stream';

    /**
     * Hashes a file using SHA-348.
     *
     * @param string $pathname
     *
     * @return string A base64 string
     */
    static public function hash_file($pathname)
    {
        return base64_encode(hash_file('sha384', $pathname, true));
    }

    /**
     * @var \SplFileInfo
     */
    protected $file;

    /**
     * @return \SplFileInfo
     */
    protected function get_file()
    {
        return $this->file;
    }

    /**
     * @var Request
     */
    protected $request;

    /**
     * @var array
     */
    protected $options;

    /**
     * @param string|\SplFileInfo $file
     * @param Request $request
     * @param array $options
     * @param array $headers
     */
    public function __construct($file, Request $request, array $options = [], $headers = [])
    {
        $this->file = $file instanceof \SplFileInfo ? $file : new \SplFileInfo($file);
        $this->request = $request;
        $this->apply_options($options, $headers);

        parent::__construct(function() {

            if (!$this->status->is_successful)
            {
                return;
            }

            $this->send_file($this->file);

        }, Status::OK, $headers);
    }

    /**
     * Changes the status to {@link Status::NOT_MODIFIED} if the request's Cache-Control has
     * 'no-cache' and {@link is_modified} is false.
     */
    public function __invoke()
    {
        $range = $this->range;

        if ($range)
        {
            if (!$range->is_satisfiable)
            {
                $this->status = Status::REQUESTED_RANGE_NOT_SATISFIABLE;
            }
            else if (!$range->is_total)
            {
                $this->status = Status::PARTIAL_CONTENT;
            }
        }

        if ($this->request->cache_control->cacheable != 'no-cache' && !$this->is_modified)
        {
            $this->status = Status::NOT_MODIFIED;
        }

        parent::__invoke();
    }

    /**
     * The following headers are always modified:
     *
     * - `Cache-Control`: sets _cacheable_ to _public_.
     * - `Expires`: is set to "+1 month".
     *
     * If the status code is {@link Stauts::NOT_MODIFIED} the following headers are unset:
     *
     * - `Content-Type`
     * - `Content-Length`
     *
     * Otherwise, the following header is set:
     *
     * - `Content-Type`:
     *
     * @inheritdoc
     */
    protected function finalize(Headers &$headers, &$body)
    {
        parent::finalize($headers, $body);

        $status = $this->status->code;
        $expires = $this->expires;

        $headers['Expires'] = $expires;
        $headers['Cache-Control']->cacheable = 'public';
        $headers['Cache-Control']->max_age = $expires->timestamp - DateTime::now()->timestamp;
        $headers['Content-Type'] = $this->content_type;
        $headers['Etag'] = $this->etag;

        if ($status === Status::NOT_MODIFIED)
        {
            $this->finalize_for_not_modified($headers);

            return;
        }

        if ($status === Status::PARTIAL_CONTENT)
        {
            $this->finalize_for_partial_content($headers);

            return;
        }

        $this->finalize_for_other($headers);
    }

    /**
     * Finalizes the response for {@link Status::NOT_MODIFIED}.
     *
     * @param Headers $headers
     */
    protected function finalize_for_not_modified(Headers &$headers)
    {
        unset($headers['Content-Length']);
    }

    /**
     * Finalizes the response for {@link Status::PARTIAL_CONTENT}.
     *
     * @param Headers $headers
     */
    protected function finalize_for_partial_content(Headers &$headers)
    {
        $range = $this->range;

        $headers['Last-Modified'] = $this->modified_time;
        $headers['Content-Range'] = (string) $range;
        $headers['Content-Length'] = $range->length;
    }

    /**
     * Finalizes the response for status other than {@link Status::NOT_MODIFIED} or
     * {@link Status::PARTIAL_CONTENT}.
     *
     * @param Headers $headers
     */
    protected function finalize_for_other(Headers &$headers)
    {
        $headers['Last-Modified'] = $this->modified_time;

        if (!$headers['Accept-Ranges'])
        {
            $request = $this->request;

            $headers['Accept-Ranges'] = $request->is_get || $request->is_head ? 'bytes' : 'none';
        }

        $headers['Content-Length'] = $this->file->getSize();
    }

    /**
     * Sends the file.
     *
     * @param \SplFileInfo $file
     *
     * @codeCoverageIgnore
     */
    protected function send_file(\SplFileInfo $file)
    {
        list($max_length, $offset) = $this->resolve_max_length_and_offset();

        $out = fopen('php://output', 'wb');
        $fh = fopen($file->getPathname(), 'rb');

        stream_copy_to_stream($fh, $out, $max_length, $offset);

        fclose($out);
        fclose($fh);
    }

    /**
     * Resolves `max_length` and `offset` parameters for stream copy.
     *
     * @return array
     */
    private function resolve_max_length_and_offset()
    {
        $range = $this->range;

        if ($range && $range->max_length)
        {
            return [ $range->max_length, $range->offset ];
        }

        return [ -1, 0 ];
    }

    /**
     * If the content type returned by the parent is empty the method tries to obtain it from
     * the file, if it fails {@link DEFAULT_MIME} is used as fallback.
     *
     * @inheritdoc
     */
    protected function get_content_type()
    {
        $content_type = parent::get_content_type();

        if ($content_type->value)
        {
            return $content_type;
        }

        $mime = null;

        if (function_exists('finfo_file'))
        {
            $mime = finfo_file(finfo_open(FILEINFO_MIME_TYPE), $this->file);
        }

        return new Headers\ContentType($mime ?: self::DEFAULT_MIME);
    }

    /**
     * If the etag returned by the parent is empty the method returns a SHA-384 of the file.
     *
     * @return string
     */
    protected function get_etag()
    {
        return parent::get_etag() ?: self::hash_file($this->file->getPathname());
    }

    /**
     * If the date returned by the parent is empty the method returns a date created from
     * {@link DEFAULT_EXPIRES}.
     *
     * @return DateTime|Headers\Date
     */
    protected function get_expires()
    {
        $expires = parent::get_expires();

        if (!$expires->is_empty)
        {
            return $expires;
        }

        return DateTime::from(self::DEFAULT_EXPIRES);
    }

    /**
     * Returns the timestamp at which the file was last modified.
     *
     * @return int
     */
    protected function get_modified_time()
    {
        return $this->file->getMTime();
    }

    /**
     * Whether the file as been modified since the last response.
     *
     * The file is considered modified if one of the following conditions is met:
     *
     * - The `If-Modified-Since` request header is empty.
     * - The `If-Modified-Since` value is inferior to {@link $modified_time}.
     * - The `If-None-Match` value doesn't match {@link $etag}.
     *
     * @return bool
     */
    protected function get_is_modified()
    {
        /* @var $if_modified_since \ICanBoogie\DateTime */

        $headers = $this->request->headers;

        // HTTP/1.1

        if ((string) $headers['If-None-Match'] != $this->etag)
        {
            return true;
        }

        // HTTP/1.0

        $if_modified_since = $headers['If-Modified-Since'];

        return $if_modified_since->is_empty || $if_modified_since->timestamp < $this->modified_time;
    }

    private $_range;

    /**
     * @return RequestRange
     */
    protected function get_range()
    {
        return $this->_range ?: $this->_range = RequestRange::from($this->request->headers, $this->file->getSize(), $this->etag);
    }

    /**
     * @param array $options
     * @param Headers|array $headers
     */
    protected function apply_options(array $options, &$headers)
    {
        foreach (array_filter($options) as $option => $value)
        {
            switch ($option)
            {
                case self::OPTION_ETAG:
                    $headers['ETag'] = $value;
                    break;

                case self::OPTION_EXPIRES:
                    $headers['Expires'] = $value;
                    break;

                case self::OPTION_FILENAME:
                    $headers['Content-Transfer-Encoding'] = 'binary';
                    $headers['Content-Description'] = 'File Transfer';
                    $headers['Content-Disposition'] = new Headers\ContentDisposition('attachment', [

                        'filename' => $value === true ? $this->file->getFilename() : $value

                    ]);
                    break;

                case self::OPTION_MIME:
                    $headers['Content-Type'] = $value;
                    break;
            }
        }
    }
}

Namespaces

Classes

Interfaces

Exceptions

Functions