cgi_process.rb 5.7 KB
Newer Older
D
Initial  
David Heinemeier Hansson 已提交
1
require 'action_controller/cgi_ext/cgi_ext'
2
require 'action_controller/cgi_ext/cookie_performance_fix'
3
require 'action_controller/cgi_ext/raw_post_data_fix'
D
Initial  
David Heinemeier Hansson 已提交
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

module ActionController #:nodoc:
  class Base
    # Process a request extracted from an CGI object and return a response. Pass false as <tt>session_options</tt> to disable
    # sessions (large performance increase if sessions are not needed). The <tt>session_options</tt> are the same as for CGI::Session:
    #
    # * <tt>:database_manager</tt> - standard options are CGI::Session::FileStore, CGI::Session::MemoryStore, and CGI::Session::PStore
    #   (default). Additionally, there is CGI::Session::DRbStore and CGI::Session::ActiveRecordStore. Read more about these in 
    #   lib/action_controller/session.
    # * <tt>:session_key</tt> - the parameter name used for the session id. Defaults to '_session_id'.
    # * <tt>:session_id</tt> - the session id to use.  If not provided, then it is retrieved from the +session_key+ parameter
    #   of the request, or automatically generated for a new session.
    # * <tt>:new_session</tt> - if true, force creation of a new session.  If not set, a new session is only created if none currently
    #   exists.  If false, a new session is never created, and if none currently exists and the +session_id+ option is not set, 
    #   an ArgumentError is raised.
    # * <tt>:session_expires</tt> - the time the current session expires, as a +Time+ object.  If not set, the session will continue
    #   indefinitely.
    # * <tt>:session_domain</tt> -  the hostname domain for which this session is valid. If not set, defaults to the hostname of the
    #   server.
    # * <tt>:session_secure</tt> - if +true+, this session will only work over HTTPS.
    # * <tt>:session_path</tt> - the path for which this session applies.  Defaults to the directory of the CGI script.
    def self.process_cgi(cgi = CGI.new, session_options = {}) 
      new.process_cgi(cgi, session_options)
    end
  
    def process_cgi(cgi, session_options = {}) #:nodoc:
      process(CgiRequest.new(cgi, session_options), CgiResponse.new(cgi)).out
    end
  end

  class CgiRequest < AbstractRequest #:nodoc:
35
    attr_accessor :cgi, :session_options
D
Initial  
David Heinemeier Hansson 已提交
36

37 38 39 40 41
    DEFAULT_SESSION_OPTIONS = {
      :database_manager => CGI::Session::PStore,
      :prefix => "ruby_sess.",
      :session_path => "/"
    } unless const_defined?(:DEFAULT_SESSION_OPTIONS)
D
Initial  
David Heinemeier Hansson 已提交
42 43 44 45 46 47 48

    def initialize(cgi, session_options = {})
      @cgi = cgi
      @session_options = session_options
      super()
    end

49
    def query_string
50 51 52 53 54 55
      if (qs = @cgi.query_string) && !qs.empty?
        qs
      elsif uri = env['REQUEST_URI']
        parts = uri.split('?')  
        parts.shift
        parts.join('?')
56
      else
57 58
        env['QUERY_STRING'] || ''
      end
59 60
    end

D
Initial  
David Heinemeier Hansson 已提交
61
    def query_parameters
62
      (qs = self.query_string).empty? ? {} : CGIMethods.parse_query_parameters(qs)
D
Initial  
David Heinemeier Hansson 已提交
63 64 65
    end

    def request_parameters
66 67
      if formatted_post?
        CGIMethods.parse_formatted_request_parameters(post_format, env['RAW_POST_DATA'])
68 69 70
      else
        CGIMethods.parse_request_parameters(@cgi.params)
      end
D
Initial  
David Heinemeier Hansson 已提交
71 72 73 74 75 76 77 78 79 80 81
    end
    
    def env
      @cgi.send(:env_table)
    end

    def cookies
      @cgi.cookies.freeze
    end

    def host
82
      env["HTTP_X_FORWARDED_HOST"] || @cgi.host.to_s.split(":").first || ''
D
Initial  
David Heinemeier Hansson 已提交
83 84 85 86
    end
    
    def session
      return @session unless @session.nil?
87

D
Initial  
David Heinemeier Hansson 已提交
88
      begin
89
        @session = (@session_options == false ? {} : CGI::Session.new(@cgi, session_options_with_string_keys))
D
Initial  
David Heinemeier Hansson 已提交
90 91 92
        @session["__valid_session"]
        return @session
      rescue ArgumentError => e
93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108
        if e.message =~ %r{undefined class/module (\w+)}
          begin
            Module.const_missing($1)
          rescue LoadError, NameError => e
            raise(
              ActionController::SessionRestoreError, 
              "Session contained objects where the class definition wasn't available. " +
              "Remember to require classes for all objects kept in the session. " +
              "(Original exception: #{e.message} [#{e.class}])"
            )
          end
        
          retry
        else
          raise
        end
D
Initial  
David Heinemeier Hansson 已提交
109 110 111 112
      end
    end
    
    def reset_session
113
      @session.delete if CGI::Session === @session
D
Initial  
David Heinemeier Hansson 已提交
114 115 116 117 118 119 120 121 122
      @session = (@session_options == false ? {} : new_session)
    end

    def method_missing(method_id, *arguments)
      @cgi.send(method_id, *arguments) rescue super
    end

    private
      def new_session
123
        CGI::Session.new(@cgi, session_options_with_string_keys.update("new_session" => true))
D
Initial  
David Heinemeier Hansson 已提交
124
      end
125 126
      
      def session_options_with_string_keys
127
        DEFAULT_SESSION_OPTIONS.merge(@session_options).inject({}) { |options, (k,v)| options[k.to_s] = v; options }
128
      end
D
Initial  
David Heinemeier Hansson 已提交
129 130 131 132 133 134 135 136
  end

  class CgiResponse < AbstractResponse #:nodoc:
    def initialize(cgi)
      @cgi = cgi
      super()
    end

137
    def out(output = $stdout)
D
Initial  
David Heinemeier Hansson 已提交
138
      convert_content_type!(@headers)
139 140
      output.binmode      if output.respond_to?(:binmode)
      output.sync = false if output.respond_to?(:sync=)
141 142
      
      begin
143
        output.write(@cgi.header(@headers))
144

145 146 147
        if @cgi.send(:env_table)['REQUEST_METHOD'] == 'HEAD'
          return
        elsif @body.respond_to?(:call)
148
          @body.call(self, output)
149
        else
150
          output.write(@body)
151
        end
152 153

        output.flush if output.respond_to?(:flush)
154 155
      rescue Errno::EPIPE => e
        # lost connection to the FCGI process -- ignore the output, then
D
Initial  
David Heinemeier Hansson 已提交
156 157 158 159 160
      end
    end

    private
      def convert_content_type!(headers)
161 162 163 164 165
        %w( Content-Type Content-type content-type ).each do |ct|
          if headers[ct]
            headers["type"] = headers[ct]
            headers.delete(ct)
          end
D
Initial  
David Heinemeier Hansson 已提交
166 167 168 169
        end
      end
  end
end