0
@@ -2,6 +2,13 @@ require 'fileutils'
0
+require 'action_controller/caching/pages'
0
+require 'action_controller/caching/actions'
0
+require 'action_controller/caching/sql_cache'
0
+require 'action_controller/caching/sweeping'
0
+require 'action_controller/caching/fragments'
0
module ActionController #:nodoc:
0
# Caching is a cheap way of speeding up slow applications by keeping the result of calculations, renderings, and database calls
0
# around for subsequent requests. Action Controller affords you three approaches in varying levels of granularity: Page, Action, Fragment.
0
@@ -9,701 +16,56 @@ module ActionController #:nodoc:
0
# You can read more about each approach and the sweeping assistance by clicking the modules below.
0
# Note: To turn off all caching and sweeping, set Base.perform_caching = false.
0
+ # All the caching stores from ActiveSupport::Cache is available to be used as backends for Action Controller caching.
0
+ # Configuration examples (MemoryStore is the default):
0
+ # ActionController::Base.cache_store = :memory_store
0
+ # ActionController::Base.cache_store = :file_store, "/path/to/cache/directory"
0
+ # ActionController::Base.cache_store = :drb_store, "druby://localhost:9192"
0
+ # ActionController::Base.cache_store = :mem_cache_store, "localhost"
0
+ # ActionController::Base.cache_store = MyOwnStore.new("parameter")
0
def self.included(base) #:nodoc:
0
- include Pages, Actions, Fragments
0
+ cattr_reader :cache_store
0
- if defined? ActiveRecord
0
- include Sweeping, SqlCache
0
+ # Defines the storage option for cached fragments
0
+ def self.cache_store=(store_option)
0
+ @@cache_store = ActiveSupport::Cache.lookup_store(store_option)
0
+ include Pages, Actions, Fragments
0
+ include Sweeping, SqlCache if defined?(ActiveRecord)
0
@@perform_caching = true
0
cattr_accessor :perform_caching
0
- # Page caching is an approach to caching where the entire action output of is stored as a HTML file that the web server
0
- # can serve without going through the Action Pack. This can be as much as 100 times faster than going through the process of dynamically
0
- # generating the content. Unfortunately, this incredible speed-up is only available to stateless pages where all visitors
0
- # are treated the same. Content management systems -- including weblogs and wikis -- have many pages that are a great fit
0
- # for this approach, but account-based systems where people log in and manipulate their own data are often less likely candidates.
0
- # Specifying which actions to cache is done through the <tt>caches</tt> class method:
0
- # class WeblogController < ActionController::Base
0
- # caches_page :show, :new
0
- # This will generate cache files such as weblog/show/5 and weblog/new, which match the URLs used to trigger the dynamic
0
- # generation. This is how the web server is able pick up a cache file when it exists and otherwise let the request pass on to
0
- # the Action Pack to generate it.
0
- # Expiration of the cache is handled by deleting the cached file, which results in a lazy regeneration approach where the cache
0
- # is not restored before another hit is made against it. The API for doing so mimics the options from url_for and friends:
0
- # class WeblogController < ActionController::Base
0
- # List.update(params[:list][:id], params[:list])
0
- # expire_page :action => "show", :id => params[:list][:id]
0
- # redirect_to :action => "show", :id => params[:list][:id]
0
- # Additionally, you can expire caches using Sweepers that act on changes in the model to determine when a cache is supposed to be
0
- # == Setting the cache directory
0
- # The cache directory should be the document root for the web server and is set using Base.page_cache_directory = "/document/root".
0
- # For Rails, this directory has already been set to RAILS_ROOT + "/public".
0
- # == Setting the cache extension
0
- # By default, the cache extension is .html, which makes it easy for the cached files to be picked up by the web server. If you want
0
- # something else, like .php or .shtml, just set Base.page_cache_extension.
0
- def self.included(base) #:nodoc:
0
- base.extend(ClassMethods)
0
- @@page_cache_directory = defined?(RAILS_ROOT) ? "#{RAILS_ROOT}/public" : ""
0
- cattr_accessor :page_cache_directory
0
- @@page_cache_extension = '.html'
0
- cattr_accessor :page_cache_extension
0
- # Expires the page that was cached with the +path+ as a key. Example:
0
- # expire_page "/lists/show"
0
- return unless perform_caching
0
- benchmark "Expired page: #{page_cache_file(path)}" do
0
- File.delete(page_cache_path(path)) if File.exist?(page_cache_path(path))
0
- # Manually cache the +content+ in the key determined by +path+. Example:
0
- # cache_page "I'm the cached content", "/lists/show"
0
- def cache_page(content, path)
0
- return unless perform_caching
0
- benchmark "Cached page: #{page_cache_file(path)}" do
0
- FileUtils.makedirs(File.dirname(page_cache_path(path)))
0
- File.open(page_cache_path(path), "wb+") { |f| f.write(content) }
0
- # Caches the +actions+ using the page-caching approach that'll store the cache in a path within the page_cache_directory that
0
- # matches the triggering url.
0
- def caches_page(*actions)
0
- return unless perform_caching
0
- actions = actions.map(&:to_s)
0
- after_filter { |c| c.cache_page if actions.include?(c.action_name) }
0
+ def self.cache_configured?
0
+ perform_caching && cache_store
0
- def page_cache_file(path)
0
- name = (path.empty? || path == "/") ? "/index" : URI.unescape(path.chomp('/'))
0
- name << page_cache_extension unless (name.split('/').last || name).include? '.'
0
- def page_cache_path(path)
0
- page_cache_directory + page_cache_file(path)
0
- # Expires the page that was cached with the +options+ as a key. Example:
0
- # expire_page :controller => "lists", :action => "show"
0
- def expire_page(options = {})
0
- return unless perform_caching
0
- if options.is_a?(Hash)
0
- if options[:action].is_a?(Array)
0
- options[:action].dup.each do |action|
0
- self.class.expire_page(url_for(options.merge(:only_path => true, :skip_relative_url_root => true, :action => action)))
0
- self.class.expire_page(url_for(options.merge(:only_path => true, :skip_relative_url_root => true)))
0
- self.class.expire_page(options)
0
- # Manually cache the +content+ in the key determined by +options+. If no content is provided, the contents of response.body is used
0
- # If no options are provided, the requested url is used. Example:
0
- # cache_page "I'm the cached content", :controller => "lists", :action => "show"
0
- def cache_page(content = nil, options = nil)
0
- return unless perform_caching && caching_allowed
0
- url_for(options.merge(:only_path => true, :skip_relative_url_root => true, :format => params[:format]))
0
- self.class.cache_page(content || response.body, path)
0
- request.get? && response.headers['Status'].to_i == 200
0
- # Action caching is similar to page caching by the fact that the entire output of the response is cached, but unlike page caching,
0
- # every request still goes through the Action Pack. The key benefit of this is that filters are run before the cache is served, which
0
- # allows for authentication and other restrictions on whether someone is allowed to see the cache. Example:
0
- # class ListsController < ApplicationController
0
- # before_filter :authenticate, :except => :public
0
- # caches_action :show, :feed
0
- # In this example, the public action doesn't require authentication, so it's possible to use the faster page caching method. But both the
0
- # show and feed action are to be shielded behind the authenticate filter, so we need to implement those as action caches.
0
- # Action caching internally uses the fragment caching and an around filter to do the job. The fragment cache is named according to both
0
- # the current host and the path. So a page that is accessed at http://david.somewhere.com/lists/show/1 will result in a fragment named
0
- # "david.somewhere.com/lists/show/1". This allows the cacher to differentiate between "david.somewhere.com/lists/" and
0
- # "jamis.somewhere.com/lists/" -- which is a helpful way of assisting the subdomain-as-account-key pattern.
0
- # Different representations of the same resource, e.g. <tt>http://david.somewhere.com/lists</tt> and <tt>http://david.somewhere.com/lists.xml</tt>
0
- # are treated like separate requests and so are cached separately. Keep in mind when expiring an action cache that <tt>:action => 'lists'</tt> is not the same
0
- # as <tt>:action => 'list', :format => :xml</tt>.
0
- # You can set modify the default action cache path by passing a :cache_path option. This will be passed directly to ActionCachePath.path_for. This is handy
0
- # for actions with multiple possible routes that should be cached differently. If a block is given, it is called with the current controller instance.
0
- # class ListsController < ApplicationController
0
- # before_filter :authenticate, :except => :public
0
- # caches_action :show, :cache_path => { :project => 1 }
0
- # caches_action :show, :cache_path => Proc.new { |controller|
0
- # controller.params[:user_id] ?
0
- # controller.send(:user_list_url, c.params[:user_id], c.params[:id]) :
0
- # controller.send(:list_url, c.params[:id]) }
0
- def self.included(base) #:nodoc:
0
- base.extend(ClassMethods)
0
- attr_accessor :rendered_action_cache, :action_cache_path
0
- alias_method_chain :protected_instance_variables, :action_caching
0
- # Declares that +actions+ should be cached.
0
- # See ActionController::Caching::Actions for details.
0
- def caches_action(*actions)
0
- return unless perform_caching
0
- around_filter(ActionCacheFilter.new(*actions))
0
- def protected_instance_variables_with_action_caching
0
- protected_instance_variables_without_action_caching + %w(@action_cache_path)
0
- def expire_action(options = {})
0
- return unless perform_caching
0
- if options[:action].is_a?(Array)
0
- options[:action].dup.each do |action|
0
- expire_fragment(ActionCachePath.path_for(self, options.merge({ :action => action })))
0
+ # Convenience accessor
0
+ def cache(key, options = nil, &block)
0
+ cache_store.fetch(ActiveSupport::Cache.expand_cache_key(key, :controller), options, &block)
0
-
expire_fragment(ActionCachePath.path_for(self, options))0
- class ActionCacheFilter #:nodoc:
0
- def initialize(*actions, &block)
0
- @options = actions.extract_options!
0
- @actions = Set.new actions
0
- def before(controller)
0
- return unless @actions.include?(controller.action_name.intern)
0
- cache_path = ActionCachePath.new(controller, path_options_for(controller, @options))
0
- if cache = controller.read_fragment(cache_path.path)
0
- controller.rendered_action_cache = true
0
- set_content_type!(controller, cache_path.extension)
0
- controller.send!(:render_for_text, cache)
0
- controller.action_cache_path = cache_path
0
- return if !@actions.include?(controller.action_name.intern) || controller.rendered_action_cache || !caching_allowed(controller)
0
- controller.write_fragment(controller.action_cache_path.path, controller.response.body)
0
- def set_content_type!(controller, extension)
0
- controller.response.content_type = Mime::Type.lookup_by_extension(extension).to_s if extension
0
- def path_options_for(controller, options)
0
- ((path_options = options[:cache_path]).respond_to?(:call) ? path_options.call(controller) : path_options) || {}
0
- def caching_allowed(controller)
0
- controller.request.get? && controller.response.headers['Status'].to_i == 200
0
- attr_reader :path, :extension
0
- def path_for(controller, options)
0
- new(controller, options).path
0
- def initialize(controller, options = {})
0
- @extension = extract_extension(controller.request.path)
0
- path = controller.url_for(options).split('://').last
0
- add_extension!(path, @extension)
0
- @path = URI.unescape(path)
0
- path << 'index' if path[-1] == ?/
0
- def add_extension!(path, extension)
0
- path << ".#{extension}" if extension
0
- def extract_extension(file_path)
0
- # Don't want just what comes after the last '.' to accommodate multi part extensions
0
- file_path[/^[^.]+\.(.+)$/, 1]
0
+ self.class.cache_configured?
0
- # Fragment caching is used for caching various blocks within templates without caching the entire action as a whole. This is useful when
0
- # certain elements of an action change frequently or depend on complicated state while other parts rarely change or can be shared amongst multiple
0
- # parties. The caching is doing using the cache helper available in the Action View. A template with caching might look something like:
0
- # <b>Hello <%= @name %></b>
0
- # All the topics in the system:
0
- # <%= render :partial => "topic", :collection => Topic.find(:all) %>
0
- # This cache will bind to the name of the action that called it, so if this code was part of the view for the topics/list action, you would
0
- # be able to invalidate it using <tt>expire_fragment(:controller => "topics", :action => "list")</tt>.
0
- # This default behavior is of limited use if you need to cache multiple fragments per action or if the action itself is cached using
0
- # <tt>caches_action</tt>, so we also have the option to qualify the name of the cached fragment with something like:
0
- # <% cache(:action => "list", :action_suffix => "all_topics") do %>
0
- # That would result in a name such as "/topics/list/all_topics", avoiding conflicts with the action cache and with any fragments that use a
0
- # different suffix. Note that the URL doesn't have to really exist or be callable - the url_for system is just used to generate unique
0
- # cache names that we can refer to when we need to expire the cache.
0
- # The expiration call for this example is:
0
- # expire_fragment(:controller => "topics", :action => "list", :action_suffix => "all_topics")
0
- # By default, cached fragments are stored in memory. The available store options are:
0
- # * FileStore: Keeps the fragments on disk in the +cache_path+, which works well for all types of environments and allows all
0
- # processes running from the same application directory to access the cached content.
0
- # * MemoryStore: Keeps the fragments in memory, which is fine for WEBrick and for FCGI (if you don't care that each FCGI process holds its
0
- # own fragment store). It's not suitable for CGI as the process is thrown away at the end of each request. It can potentially also take
0
- # up a lot of memory since each process keeps all the caches in memory.
0
- # * DRbStore: Keeps the fragments in the memory of a separate, shared DRb process. This works for all environments and only keeps one cache
0
- # around for all processes, but requires that you run and manage a separate DRb process.
0
- # * MemCacheStore: Works like DRbStore, but uses Danga's MemCache instead.
0
- # Requires the ruby-memcache library: gem install ruby-memcache.
0
- # Configuration examples (MemoryStore is the default):
0
- # ActionController::Base.fragment_cache_store = :memory_store
0
- # ActionController::Base.fragment_cache_store = :file_store, "/path/to/cache/directory"
0
- # ActionController::Base.fragment_cache_store = :drb_store, "druby://localhost:9192"
0
- # ActionController::Base.fragment_cache_store = :mem_cache_store, "localhost"
0
- # ActionController::Base.fragment_cache_store = MyOwnStore.new("parameter")
0
- def self.included(base) #:nodoc:
0
- @@fragment_cache_store = MemoryStore.new
0
- cattr_reader :fragment_cache_store
0
- # Defines the storage option for cached fragments
0
- def self.fragment_cache_store=(store_option)
0
- store, *parameters = *([ store_option ].flatten)
0
- @@fragment_cache_store = if store.is_a?(Symbol)
0
- store_class_name = (store == :drb_store ? "DRbStore" : store.to_s.camelize)
0
- store_class = ActionController::Caching::Fragments.const_get(store_class_name)
0
- store_class.new(*parameters)
0
- # Given a name (as described in <tt>expire_fragment</tt>), returns a key suitable for use in reading,
0
- # writing, or expiring a cached fragment. If the name is a hash, the generated name is the return
0
- # value of url_for on that hash (without the protocol).
0
- def fragment_cache_key(name)
0
- name.is_a?(Hash) ? url_for(name).split("://").last : name
0
- def fragment_for(block, name = {}, options = nil) #:nodoc:
0
- unless perform_caching then block.call; return end
0
- if cache = read_fragment(name, options)
0
- write_fragment(name, buffer[pos..-1], options)
0
- # Called by CacheHelper#cache
0
- def cache_rxml_fragment(block, name = {}, options = nil) #:nodoc:
0
- fragment_for(block, name, options) do
0
- eval('xml.target!', block.binding)
0
- # Called by CacheHelper#cache
0
- def cache_rjs_fragment(block, name = {}, options = nil) #:nodoc:
0
- fragment_for(block, name, options) do
0
- debug_mode, ActionView::Base.debug_rjs = ActionView::Base.debug_rjs, false
0
- eval('page.to_s', block.binding)
0
- ActionView::Base.debug_rjs = debug_mode
0
- # Called by CacheHelper#cache
0
- def cache_erb_fragment(block, name = {}, options = nil) #:nodoc:
0
- fragment_for(block, name, options) do
0
- eval(ActionView::Base.erb_variable, block.binding)
0
- # Writes <tt>content</tt> to the location signified by <tt>name</tt> (see <tt>expire_fragment</tt> for acceptable formats)
0
- def write_fragment(name, content, options = nil)
0
- return unless perform_caching
0
- key = fragment_cache_key(name)
0
- self.class.benchmark "Cached fragment: #{key}" do
0
- fragment_cache_store.write(key, content, options)
0
- # Reads a cached fragment from the location signified by <tt>name</tt> (see <tt>expire_fragment</tt> for acceptable formats)
0
- def read_fragment(name, options = nil)
0
- return unless perform_caching
0
- key = fragment_cache_key(name)
0
- self.class.benchmark "Fragment read: #{key}" do
0
- fragment_cache_store.read(key, options)
0
- # Name can take one of three forms:
0
- # * String: This would normally take the form of a path like "pages/45/notes"
0
- # * Hash: Is treated as an implicit call to url_for, like { :controller => "pages", :action => "notes", :id => 45 }
0
- # * Regexp: Will destroy all the matched fragments, example:
0
- # Ensure you do not specify start and finish in the regex (^$) because
0
- # the actual filename matched looks like ./cache/filename/path.cache
0
- # Regexp expiration is only supported on caches that can iterate over
0
- # all keys (unlike memcached).
0
- def expire_fragment(name, options = nil)
0
- return unless perform_caching
0
- key = fragment_cache_key(name)
0
- self.class.benchmark "Expired fragments matching: #{key.source}" do
0
- fragment_cache_store.delete_matched(key, options)
0
- self.class.benchmark "Expired fragment: #{key}" do
0
- fragment_cache_store.delete(key, options)
0
- class UnthreadedMemoryStore #:nodoc:
0
- def initialize #:nodoc:
0
- def read(name, options=nil) #:nodoc:
0
- def write(name, value, options=nil) #:nodoc:
0
- def delete(name, options=nil) #:nodoc:
0
- def delete_matched(matcher, options=nil) #:nodoc:
0
- @data.delete_if { |k,v| k =~ matcher }
0
- module ThreadSafety #:nodoc:
0
- def read(name, options=nil) #:nodoc:
0
- @mutex.synchronize { super }
0
- def write(name, value, options=nil) #:nodoc:
0
- @mutex.synchronize { super }
0
- def delete(name, options=nil) #:nodoc:
0
- @mutex.synchronize { super }
0
- def delete_matched(matcher, options=nil) #:nodoc:
0
- @mutex.synchronize { super }
0
- class MemoryStore < UnthreadedMemoryStore #:nodoc:
0
- def initialize #:nodoc:
0
- if ActionController::Base.allow_concurrency
0
- MemoryStore.module_eval { include ThreadSafety }
0
- class DRbStore < MemoryStore #:nodoc:
0
- def initialize(address = 'druby://localhost:9192')
0
- @data = DRbObject.new(nil, address)
0
- require_library_or_gem 'memcache'
0
- class MemCacheStore < MemoryStore #:nodoc:
0
- attr_reader :addresses
0
- def initialize(*addresses)
0
- addresses = addresses.flatten
0
- addresses = ["localhost"] if addresses.empty?
0
- @addresses = addresses
0
- @data = MemCache.new(*addresses)
0
- # MemCache wasn't available so neither can the store be
0
- class UnthreadedFileStore #:nodoc:
0
- attr_reader :cache_path
0
- def initialize(cache_path)
0
- @cache_path = cache_path
0
- def write(name, value, options = nil) #:nodoc:
0
- ensure_cache_path(File.dirname(real_file_path(name)))
0
- File.open(real_file_path(name), "wb+") { |f| f.write(value) }
0
- Base.logger.error "Couldn't create cache directory: #{name} (#{e.message})" if Base.logger
0
- def read(name, options = nil) #:nodoc:
0
- File.open(real_file_path(name), 'rb') { |f| f.read } rescue nil
0
- def delete(name, options) #:nodoc:
0
- File.delete(real_file_path(name))
0
- rescue SystemCallError => e
0
- # If there's no cache, then there's nothing to complain about
0
- def delete_matched(matcher, options) #:nodoc:
0
- search_dir(@cache_path) do |f|
0
- rescue SystemCallError => e
0
- # If there's no cache, then there's nothing to complain about
0
- def real_file_path(name)
0
- '%s/%s.cache' % [@cache_path, name.gsub('?', '.').gsub(':', '.')]
0
- def ensure_cache_path(path)
0
- FileUtils.makedirs(path) unless File.exist?(path)
0
- def search_dir(dir, &callback)
0
- Dir.foreach(dir) do |d|
0
- next if d == "." || d == ".."
0
- name = File.join(dir, d)
0
- if File.directory?(name)
0
- search_dir(name, &callback)
0
- class FileStore < UnthreadedFileStore #:nodoc:
0
- def initialize(cache_path)
0
- if ActionController::Base.allow_concurrency
0
- FileStore.module_eval { include ThreadSafety }
0
- # Sweepers are the terminators of the caching world and responsible for expiring caches when model objects change.
0
- # They do this by being half-observers, half-filters and implementing callbacks for both roles. A Sweeper example:
0
- # class ListSweeper < ActionController::Caching::Sweeper
0
- # def after_save(record)
0
- # list = record.is_a?(List) ? record : record.list
0
- # expire_page(:controller => "lists", :action => %w( show public feed ), :id => list.id)
0
- # expire_action(:controller => "lists", :action => "all")
0
- # list.shares.each { |share| expire_page(:controller => "lists", :action => "show", :id => share.url_key) }
0
- # The sweeper is assigned in the controllers that wish to have its job performed using the <tt>cache_sweeper</tt> class method:
0
- # class ListsController < ApplicationController
0
- # caches_action :index, :show, :public, :feed
0
- # cache_sweeper :list_sweeper, :only => [ :edit, :destroy, :share ]
0
- # In the example above, four actions are cached and three actions are responsible for expiring those caches.
0
- def self.included(base) #:nodoc:
0
- base.extend(ClassMethods)
0
- module ClassMethods #:nodoc:
0
- def cache_sweeper(*sweepers)
0
- return unless perform_caching
0
- configuration = sweepers.extract_options!
0
- sweepers.each do |sweeper|
0
- ActiveRecord::Base.observers << sweeper if defined?(ActiveRecord) and defined?(ActiveRecord::Base)
0
- sweeper_instance = Object.const_get(Inflector.classify(sweeper)).instance
0
- if sweeper_instance.is_a?(Sweeper)
0
- around_filter(sweeper_instance, :only => configuration[:only])
0
- after_filter(sweeper_instance, :only => configuration[:only])
0
- if defined?(ActiveRecord) and defined?(ActiveRecord::Observer)
0
- class Sweeper < ActiveRecord::Observer #:nodoc:
0
- attr_accessor :controller
0
- def before(controller)
0
- self.controller = controller
0
- # Clean up, so that the controller can be collected after this request
0
- # gets the action cache path for the given options.
0
- def action_path_for(options)
0
- ActionController::Caching::Actions::ActionCachePath.path_for(controller, options)
0
- # Retrieve instance variables set in the controller.
0
- controller.instance_variable_get("@#{key}")
0
- controller_callback_method_name = "#{timing}_#{controller.controller_name.underscore}"
0
- action_callback_method_name = "#{controller_callback_method_name}_#{controller.action_name}"
0
- send!(controller_callback_method_name) if respond_to?(controller_callback_method_name, true)
0
- send!(action_callback_method_name) if respond_to?(action_callback_method_name, true)
0
- def method_missing(method, *arguments)
0
- return if @controller.nil?
0
- @controller.send!(method, *arguments)
0
- def self.included(base) #:nodoc:
0
- if defined?(ActiveRecord) && ActiveRecord::Base.respond_to?(:cache)
0
- base.alias_method_chain :perform_action, :caching
0
- def perform_action_with_caching
0
- ActiveRecord::Base.cache do
0
- perform_action_without_caching
0
\ No newline at end of file
) is private.
