cache.rb 4.6 KB
Newer Older
1 2
require 'active_support/core_ext/object/blank'

3 4 5 6
module ActionDispatch
  module Http
    module Cache
      module Request
7 8 9 10

        HTTP_IF_MODIFIED_SINCE = 'HTTP_IF_MODIFIED_SINCE'.freeze
        HTTP_IF_NONE_MATCH     = 'HTTP_IF_NONE_MATCH'.freeze

11
        def if_modified_since
12
          if since = env[HTTP_IF_MODIFIED_SINCE]
13 14 15 16 17
            Time.rfc2822(since) rescue nil
          end
        end

        def if_none_match
18
          env[HTTP_IF_NONE_MATCH]
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
        end

        def not_modified?(modified_at)
          if_modified_since && modified_at && if_modified_since >= modified_at
        end

        def etag_matches?(etag)
          if_none_match && if_none_match == etag
        end

        # Check response freshness (Last-Modified and ETag) against request
        # If-Modified-Since and If-None-Match conditions. If both headers are
        # supplied, both must match, or the request is not considered fresh.
        def fresh?(response)
          last_modified = if_modified_since
          etag          = if_none_match

          return false unless last_modified || etag

          success = true
          success &&= not_modified?(response.last_modified) if last_modified
          success &&= etag_matches?(response.etag) if etag
          success
        end
      end

      module Response
46 47
        attr_reader :cache_control, :etag
        alias :etag? :etag
48

49
        def last_modified
50
          if last = headers[LAST_MODIFIED]
51 52 53 54 55
            Time.httpdate(last)
          end
        end

        def last_modified?
56
          headers.include?(LAST_MODIFIED)
57 58 59
        end

        def last_modified=(utc_time)
60
          headers[LAST_MODIFIED] = utc_time.httpdate
61 62
        end

A
arvida 已提交
63 64 65 66 67 68 69 70 71 72 73 74 75 76
        def date
          if date_header = headers['Date']
            Time.httpdate(date_header)
          end
        end

        def date?
          headers.include?('Date')
        end

        def date=(utc_time)
          headers['Date'] = utc_time.httpdate
        end

77 78
        def etag=(etag)
          key = ActiveSupport::Cache.expand_cache_key(etag)
79
          @etag = self[ETAG] = %("#{Digest::MD5.hexdigest(key)}")
80 81 82 83
        end

      private

84 85 86
        LAST_MODIFIED = "Last-Modified".freeze
        ETAG          = "ETag".freeze
        CACHE_CONTROL = "Cache-Control".freeze
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
        SPESHUL_KEYS  = %w[extras no-cache max-age public must-revalidate]

        def cache_control_headers
          cache_control = {}
          if cc = self[CACHE_CONTROL]
            cc.delete(' ').split(',').each do |segment|
              directive, argument = segment.split('=', 2)
              case directive
              when *SPESHUL_KEYS
                key = directive.tr('-', '_')
                cache_control[key.to_sym] = argument || true
              else
                cache_control[:extras] ||= []
                cache_control[:extras] << segment
              end
            end
          end
          cache_control
        end
106

107
        def prepare_cache_control!
108
          @cache_control = cache_control_headers
109
          @etag = self[ETAG]
110 111
        end

112 113 114 115 116 117
        def handle_conditional_get!
          if etag? || last_modified? || !@cache_control.empty?
            set_conditional_cache_control!
          end
        end

118 119 120 121 122
        DEFAULT_CACHE_CONTROL = "max-age=0, private, must-revalidate".freeze
        NO_CACHE              = "no-cache".freeze
        PUBLIC                = "public".freeze
        PRIVATE               = "private".freeze
        MUST_REVALIDATE       = "must-revalidate".freeze
123 124

        def set_conditional_cache_control!
125 126 127 128 129 130 131
          control = {}
          cc_headers = cache_control_headers
          if extras = cc_headers.delete(:extras)
            @cache_control[:extras] ||= []
            @cache_control[:extras] += extras
            @cache_control[:extras].uniq!
          end
132

133 134
          control.merge! cc_headers
          control.merge! @cache_control
135

136
          if control.empty?
137
            headers[CACHE_CONTROL] = DEFAULT_CACHE_CONTROL
138
          elsif control[:no_cache]
139
            headers[CACHE_CONTROL] = NO_CACHE
140 141 142
            if control[:extras]
              headers[CACHE_CONTROL] += ", #{control[:extras].join(', ')}"
            end
143 144 145 146 147 148
          else
            extras  = control[:extras]
            max_age = control[:max_age]

            options = []
            options << "max-age=#{max_age.to_i}" if max_age
149 150
            options << (control[:public] ? PUBLIC : PRIVATE)
            options << MUST_REVALIDATE if control[:must_revalidate]
151 152
            options.concat(extras) if extras

153
            headers[CACHE_CONTROL] = options.join(", ")
154 155 156 157 158
          end
        end
      end
    end
  end
159
end