HttpCache.php 5.42 KB
Newer Older
1 2 3 4 5 6 7
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

8
namespace yii\filters;
9 10 11 12 13 14

use Yii;
use yii\base\ActionFilter;
use yii\base\Action;

/**
15 16 17 18 19 20 21 22 23 24 25 26 27
 * The HttpCache provides functionality for caching via HTTP Last-Modified and Etag headers.
 *
 * It is an action filter that can be added to a controller and handles the `beforeAction` event.
 *
 * To use AccessControl, declare it in the `behaviors()` method of your controller class.
 * In the following example the filter will be applied to the `list`-action and
 * the Last-Modified header will contain the date of the last update to the user table in the database.
 *
 * ~~~
 * public function behaviors()
 * {
 *     return [
 *         'httpCache' => [
28
 *             'class' => \yii\filters\HttpCache::className(),
29
 *             'only' => ['index'],
30
 *             'lastModified' => function ($action, $params) {
31 32
 *                 $q = new \yii\db\Query();
 *                 return $q->from('user')->max('updated_at');
33 34 35 36 37 38 39 40
 *             },
 * //            'etagSeed' => function ($action, $params) {
 * //                return // generate etag seed here
 * //            }
 *         ],
 *     ];
 * }
 * ~~~
41
 *
42 43 44 45 46 47
 * @author Da:Sourcerer <webmaster@dasourcerer.net>
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class HttpCache extends ActionFilter
{
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
    /**
     * @var callable a PHP callback that returns the UNIX timestamp of the last modification time.
     * The callback's signature should be:
     *
     * ~~~
     * function ($action, $params)
     * ~~~
     *
     * where `$action` is the [[Action]] object that this filter is currently handling;
     * `$params` takes the value of [[params]]. The callback should return a UNIX timestamp.
     */
    public $lastModified;
    /**
     * @var callable a PHP callback that generates the Etag seed string.
     * The callback's signature should be:
     *
     * ~~~
     * function ($action, $params)
     * ~~~
     *
     * where `$action` is the [[Action]] object that this filter is currently handling;
     * `$params` takes the value of [[params]]. The callback should return a string serving
     * as the seed for generating an Etag.
     */
    public $etagSeed;
    /**
     * @var mixed additional parameters that should be passed to the [[lastModified]] and [[etagSeed]] callbacks.
     */
    public $params;
    /**
     * @var string HTTP cache control header. If null, the header will not be sent.
     */
    public $cacheControlHeader = 'max-age=3600, public';
81

82 83 84
    /**
     * This method is invoked right before an action is to be executed (after all possible filters.)
     * You may override this method to do last-minute preparation for the action.
85
     * @param Action $action the action to be executed.
86 87 88 89 90 91 92 93
     * @return boolean whether the action should continue to be executed.
     */
    public function beforeAction($action)
    {
        $verb = Yii::$app->getRequest()->getMethod();
        if ($verb !== 'GET' && $verb !== 'HEAD' || $this->lastModified === null && $this->etagSeed === null) {
            return true;
        }
94

95 96 97 98 99 100 101 102
        $lastModified = $etag = null;
        if ($this->lastModified !== null) {
            $lastModified = call_user_func($this->lastModified, $action, $this->params);
        }
        if ($this->etagSeed !== null) {
            $seed = call_user_func($this->etagSeed, $action, $this->params);
            $etag = $this->generateEtag($seed);
        }
103

104 105 106 107 108
        $this->sendCacheControlHeader();
        $response = Yii::$app->getResponse();
        if ($etag !== null) {
            $response->getHeaders()->set('Etag', $etag);
        }
109

110 111
        if ($this->validateCache($lastModified, $etag)) {
            $response->setStatusCode(304);
Qiang Xue committed
112

113 114
            return false;
        }
115

116 117 118
        if ($lastModified !== null) {
            $response->getHeaders()->set('Last-Modified', gmdate('D, d M Y H:i:s', $lastModified) . ' GMT');
        }
119

120 121
        return true;
    }
122

123 124
    /**
     * Validates if the HTTP cache contains valid content.
125 126 127
     * @param integer $lastModified the calculated Last-Modified value in terms of a UNIX timestamp.
     * If null, the Last-Modified header will not be validated.
     * @param string $etag the calculated ETag value. If null, the ETag header will not be validated.
128 129 130 131 132 133 134 135 136 137 138 139 140
     * @return boolean whether the HTTP cache is still valid.
     */
    protected function validateCache($lastModified, $etag)
    {
        if ($lastModified !== null && (!isset($_SERVER['HTTP_IF_MODIFIED_SINCE']) || @strtotime($_SERVER['HTTP_IF_MODIFIED_SINCE']) < $lastModified)) {
            return false;
        } else {
            return $etag === null || isset($_SERVER['HTTP_IF_NONE_MATCH']) && $_SERVER['HTTP_IF_NONE_MATCH'] === $etag;
        }
    }

    /**
     * Sends the cache control header to the client
141
     * @see cacheControlHeader
142 143 144 145 146 147 148 149 150 151 152 153 154
     */
    protected function sendCacheControlHeader()
    {
        session_cache_limiter('public');
        $headers = Yii::$app->getResponse()->getHeaders();
        $headers->set('Pragma');
        if ($this->cacheControlHeader !== null) {
            $headers->set('Cache-Control', $this->cacheControlHeader);
        }
    }

    /**
     * Generates an Etag from the given seed string.
155
     * @param string $seed Seed for the ETag
156 157 158 159 160 161
     * @return string the generated Etag
     */
    protected function generateEtag($seed)
    {
        return '"' . base64_encode(sha1($seed, true)) . '"';
    }
Zander Baldwin committed
162
}