# class XMLRPC::CGIServer

Implements a CGI-based XML-RPC server.

    require "xmlrpc/server"

    s = XMLRPC::CGIServer.new

    s.add_handler("michael.add") do |a,b|
      a + b
    end

    s.add_handler("michael.div") do |a,b|
      if b == 0
        raise XMLRPC::FaultException.new(1, "division by zero")
      else
        a / b
      end
    end

    s.set_default_handler do |name, *args|
      raise XMLRPC::FaultException.new(-99, "Method #{name} missing" +
                                       " or wrong number of parameters!")
    end

    s.serve

Note: Make sure that you don't write to standard-output in a handler, or in any other part of your program, this would cause a CGI-based server to fail!

### Public Class Methods

new(*a) click to toggle source

Creates a new XMLRPC::CGIServer instance.

All parameters given are by-passed to XMLRPC::BasicServer.new.

You can only create one XMLRPC::CGIServer instance, because more than one makes no sense.

Calls superclass method XMLRPC::BasicServer.new

    # File lib/xmlrpc/server.rb, line 391
    def CGIServer.new(*a)
      @@obj = super(*a) if @@obj.nil?
      @@obj
    end

new(*a) click to toggle source
Calls superclass method XMLRPC::BasicServer.new

    # File lib/xmlrpc/server.rb, line 396
    def initialize(*a)
      super(*a)
    end

### Public Instance Methods

serve() click to toggle source

Call this after you have added all you handlers to the server.

This method processes a XML-RPC method call and sends the answer back to the client.

    # File lib/xmlrpc/server.rb, line 404
    def serve
      catch(:exit_serve) {
        length = ENV['CONTENT_LENGTH'].to_i

        http_error(405, "Method Not Allowed") unless ENV['REQUEST_METHOD'] == "POST"
        http_error(400, "Bad Request")        unless parse_content_type(ENV['CONTENT_TYPE']).first == "text/xml"
        http_error(411, "Length Required")    unless length > 0

        # TODO: do we need a call to binmode?
        $stdin.binmode if $stdin.respond_to? :binmode
        data = $stdin.read(length)

        http_error(400, "Bad Request")        if data.nil? or data.bytesize != length

        http_write(process(data), "Content-type" => "text/xml; charset=utf-8")
      }
    end

### Private Instance Methods

http_error(status, message) click to toggle source

    # File lib/xmlrpc/server.rb, line 425
    def http_error(status, message)
      err = "#{status} #{message}"
      msg = <<-"MSGEND"
        <html>
          <head>
            <title>#{err}</title>
          </head>
          <body>
            <h1>#{err}</h1>
            <p>Unexpected error occurred while processing XML-RPC request!</p>
          </body>
        </html>
      MSGEND

      http_write(msg, "Status" => err, "Content-type" => "text/html")
      throw :exit_serve # exit from the #serve method
    end

http_write(body, header) click to toggle source

    # File lib/xmlrpc/server.rb, line 443
    def http_write(body, header)
      h = {}
      header.each {|key, value| h[key.to_s.capitalize] = value}
      h['Status']         ||= "200 OK"
      h['Content-length'] ||= body.bytesize.to_s

      str = ""
      h.each {|key, value| str << "#{key}: #{value}\r\n"}
      str << "\r\n#{body}"

      print str
    end