aboutsummaryrefslogtreecommitdiffstats
path: root/actionpack/lib/action_controller/new_base/conditional_get.rb
blob: 16104c51fc0403e57b207342a624dfb9a642dbb5 (plain) (blame)
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
module ActionController
  module ConditionalGet
    
    # Sets the etag, last_modified, or both on the response and renders a
    # "304 Not Modified" response if the request is already fresh.
    #
    # Parameters:
    # * <tt>:etag</tt>
    # * <tt>:last_modified</tt> 
    # * <tt>:public</tt> By default the Cache-Control header is private, set this to true if you want your application to be cachable by other devices (proxy caches).
    #
    # Example:
    #
    #   def show
    #     @article = Article.find(params[:id])
    #     fresh_when(:etag => @article, :last_modified => @article.created_at.utc, :public => true)
    #   end
    #
    # This will render the show template if the request isn't sending a matching etag or
    # If-Modified-Since header and just a "304 Not Modified" response if there's a match.
    #    
    def fresh_when(options)
      options.assert_valid_keys(:etag, :last_modified, :public)

      response.etag          = options[:etag]          if options[:etag]
      response.last_modified = options[:last_modified] if options[:last_modified]
      
      if options[:public] 
        cache_control = response.headers["Cache-Control"].split(",").map {|k| k.strip }
        cache_control.delete("private")
        cache_control.delete("no-cache")
        cache_control << "public"
        response.headers["Cache-Control"] = cache_control.join(', ')
      end

      if request.fresh?(response)
        head :not_modified
      end
    end    
    
  end
end