123456789_123456789_123456789_123456789_123456789_

Class: XMLRPC::CGIServer

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, BasicServer
Instance Chain:
self, BasicServer, ParseContentType, ParserWriterChooseMixin
Inherits: XMLRPC::BasicServer
Defined in: lib/xmlrpc/server.rb

Overview

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!

Constant Summary

BasicServer - Inherited

ERR_MC_EXPECTED_STRUCT, ERR_MC_MISSING_METHNAME, ERR_MC_MISSING_PARAMS, ERR_MC_RECURSIVE_CALL, ERR_MC_WRONG_PARAM, ERR_MC_WRONG_PARAM_PARAMS, ERR_METHOD_MISSING, ERR_UNCAUGHT_EXCEPTION

Class Method Summary

BasicServer - Inherited

.new

Creates a new BasicServer instance, which should not be done, because BasicServer is an abstract class.

Instance Method Summary

BasicServer - Inherited

#add_handler

Adds aBlock to the list of handlers, with name as the name of the method.
#add_introspection

Adds the introspection handlers "system.listMethods", "system.methodSignature" and "system.methodHelp", where only the first one works.
#add_multicall

Adds the multi-call handler "system.multicall".
#get_default_handler

Returns the default-handler, which is called when no handler for a method-name is found.
#get_service_hook

Returns the service-hook, which is called on each service request (RPC) unless it's nil.
#process,
#set_default_handler

Sets handler as the default-handler, which is called when no handler for a method-name is found.
#set_service_hook

A service-hook is called for each service request (RPC).
#call_method,
#check_arity

Returns true, if the arity of obj matches n_args
#dispatch, #handle, #multicall_fault

ParseContentType - Included

#parse_content_type

ParserWriterChooseMixin - Included

#set_parser

Sets the XMLParser to use for parsing XML documents.
#set_writer

Sets the XMLWriter to use for generating XML output.
#create, #parser

Constructor Details

.new(*a) ⇒ CGIServer

Creates a new CGIServer instance.

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

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

[ GitHub ] 

  


# File 'lib/xmlrpc/server.rb', line 391



def CGIServer.new(*a)
  @@obj = super(*a) if @@obj.nil?
  @@obj
end


  






  

  

    #initialize(*a)  ⇒ CGIServer 
  



  

    
  





  


  [ GitHub ]


  

  


# File 'lib/xmlrpc/server.rb', line 396



def initialize(*a)
  super(*a)
end


  







Instance Method Details



  

    #http_error(status, message)   (private)
  

  [ GitHub ]


  

  


# 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)   (private)
  

  [ GitHub ]


  

  


# 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


  








  

    #serve  
  



  

    

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.


  



  [ GitHub ]


  

  


# 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