ap4r 0.3.0 → 0.3.1

data/CHANGELOG

@@ -1,9 +1,15 @@
 == 0.3.x
 
+=== 0.3.1 (April 24th, 2007)
+
+* Changed: @delete_mode of AsyncController to @@saf_delete_mode with accessor
+* Changed: default value of dispatch_mode, from :XMLRPC to :HTTP
+* Added: Bootstrap script to let ap4r run on mongrel, experimental yet
+
 === 0.3.0 (April 6th, 2007)
 
-* Changed: Name space from "AP4R" to "Ap4r"
-* Added: Support the latest version for Rails(1.8.6) and RubyGems(0.9.2) and Rails(1.2.3) 
+* Changed: name space from "AP4R" to "Ap4r"
+* Added: support the latest version for Rails(1.8.6) and RubyGems(0.9.2) and Rails(1.2.3) 
 
 == 0.2.x
 

data/lib/ap4r/mongrel.rb

@@ -0,0 +1,99 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2007 Future Architect Corp.
+# Licence:: MIT Licence
+
+require 'mongrel'
+require 'cgi'
+
+require 'ap4r'
+
+module Ap4r
+  module Mongrel
+
+    class Ap4rConfigurator < ::Mongrel::Configurator
+
+      def stop(needs_restart=false)
+        ::ReliableMsg::Client.new.instance_eval do
+          qm.stop
+        end
+        super
+        join
+      end
+
+      def mswin?
+        RUBY_PLATFORM =~ /mswin/
+      end
+
+      def remove_pid_file
+        return unless @pid_file && File.exists?(@pid_file)
+        # TODO: slit exists between pid check and delete 2007/04/16 by shino
+        File.delete(@pid_file) if pid_from_file == Process.pid
+      end
+
+      def pid_from_file
+        File.open(@pid_file) do |file|
+          file.read.to_i
+        end
+      end
+    end
+
+    # Implements a handler that can run AP4R.
+    # * If the requested exact PATH_INFO exists as a file then serve it.
+    # * Finally, raise an exception.
+    #
+    # memo: want to use this handler to take information from AP4R server
+    # like mod_status. Message counts and status of threads are useful.
+    #
+    # TODO not yet implemented 2007/04/09 by shino
+    #
+    class Ap4rHandler < ::Mongrel::HttpHandler
+      STDERR.puts "CAUTION! This script is rather experimental."
+      attr_reader :files
+      @@file_only_methods = ["GET","HEAD"]
+
+      def initialize(options)
+        # TODO what is "false" here? 2007/04/13 by shinohara
+        @files = ::Mongrel::DirHandler.new(options[:docroot], false)
+        @tick = Time.now
+
+        # TODO: QueueManager life cycle should be controlled in Configurator? 2007/04/16 by shino
+        qm = ::ReliableMsg::QueueManager.new({:config => options[:ap4r_config_file]})
+        qm.start
+      end
+
+      # * If the requested exact PATH_INFO exists as a file then serve it.
+      # * Finally, raise an exception.
+      def process(request, response)
+        if response.socket.closed?
+          return
+        end
+
+        path_info = request.params[Mongrel::Const::PATH_INFO]
+        get_or_head = @@file_only_methods.include? request.params[Mongrel::Const::REQUEST_METHOD]
+        if get_or_head and @files.can_serve(path_info)
+          # File exists as-is so serve it up
+          @files.process(request,response)
+        else
+          raise "No file... Sorry" #TODO set 404 status 2007/04/09 by shino
+        end
+      end
+
+      def log_threads_waiting_for(event)
+        if Time.now - @tick > 10
+          @tick = Time.now
+        end
+      end
+
+      # Does the internal reload for Rails.  It might work for most cases, but
+      # sometimes you get exceptions.  In that case just do a real restart.
+      def reload!
+        begin
+          #TODO not implemented 2007/04/09 by shino
+          raise "not yet implemented!."
+        end
+      end
+
+    end
+
+  end
+end

data/lib/ap4r/util/irm.rb

@@ -1,4 +1,4 @@
-# Author:: Shunichi Shinohara
+ # Author:: Shunichi Shinohara
 # Copyright:: Copyright (c) 2006 Future System Consulting Corp.
 # Licence:: MIT Licence
 

data/lib/ap4r/version.rb

@@ -8,7 +8,7 @@ module Ap4r
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/ap4r/xxx_create_table_for_saf.rb

@@ -0,0 +1,21 @@
+# Author:: Kiwamu Kato
+# Copyright:: Copyright (c) 2006 Future System Consulting Corp.
+# Licence:: MIT Licence
+
+class CreateTableForSaf < ActiveRecord::Migration
+  def self.up
+    create_table :stored_messages do |t|
+      t.column :duplication_check_id, :string, :null => false
+      t.column :queue, :string, :null => false
+      t.column :headers, :binary, :null => false
+      t.column :object, :binary, :null => false
+      t.column :status, :integer, :null => false
+      t.column :created_at, :datetime, :null => false
+      t.column :updated_at, :datetime, :null => false
+    end
+  end
+
+  def self.down
+    drop_table :stored_messages
+  end
+end

data/rails_plugin/ap4r/lib/async_controller.rb

@@ -6,51 +6,52 @@ require 'reliable-msg'
 #require 'ap4r/stored_message'
 
 module Ap4r
-  # This +asyncController+ is the Rails plugin for asynchronous processing.
+
+  # This +AsyncController+ is the Rails plugin for asynchronous processing.
   # Asynchronous logics are called via various protocols, such as XML-RPC,
-  # SOAP, HTTP PUT, and more. Now implemented jsut as XML-RPC.
+  # SOAP, HTTP POST, and more. Now default protocol is HTTP POST.
   #
   # Examples: The part of calling next asynchronous logics in a controller in the HelloWorld Sample.
   #
   #     req = WorldRequest.new([:world_id => 1, :message => "World"})
   #     async_dispatch(req,
-  #                     {:controller => 'async_world', :action => 'execute',
-  #                     :mode => :XMLRPC })
+  #                     {:controller => 'async_world', :action => 'execute'},
+  #                     :dispatch_mode => :XMLRPC }) # skippable
   #
   #     render :action => 'response'
   #
   module AsyncController
-      
+
     module Base
       Converters = {}
       DRUBY_URI = "druby://#{ENV['AP4R_DRUBY_HOST']||'localhost'}:#{ENV['AP4R_DRUBY_PORT'] || '6438'}"
 
-      @@default_dispatch_mode = :XMLRPC
+      @@default_dispatch_mode = :HTTP
       @@default_rm_options = { :delivery => :once }
       @@default_queue_prefix = "queue."
 
-      mattr_accessor :default_dispatch_mode, :default_rm_options, :default_queue_prefix
+      mattr_accessor :default_dispatch_mode, :default_rm_options, :default_queue_prefix, :saf_delete_mode
 
       # Provide at-least-once QoS level.
       # Execute application logic and store the message for next logic to the application
-      # database. This is a store processing. After commit to the database, 
+      # database. This is a store processing. After commit to the database,
       # put the message into queue and update or delte a management table.
       # This is a forward processing.
-      # SAF(store and forward) processing like this guarantees that any message 
-      # is never lost and keeps reasonable performance.   
-      # 
+      # SAF(store and forward) processing like this guarantees that any message
+      # is never lost and keeps reasonable performance.
+      #
       # Examples: Just call async_dispath method in this block.
       #
       #     transaction_with saf do
       #       req = WorldRequest.new([:world_id => 1, :message => "World"})
       #       async_dispatch(req,
-      #                       {:controller => 'async_world', :action => 'execute',
-      #                       :mode => :XMLRPC })
+      #                       {:controller => 'async_world', :action => 'execute'},
+      #                       :dispatch_mode => :XMLRPC }) # skippable
       #
       #       render :action => 'response'
       #     end
       #
-      def transaction_with_saf(active_record_class = StoredMessage, *objects, &block)
+      def transaction_with_saf(active_record_class = ::Ap4r::StoredMessage, *objects, &block)
 
         Thread.current[:use_saf] = true
         Thread.current[:stored_messages] = {}
@@ -72,25 +73,25 @@ module Ap4r
             forwarded_messages[k] = v
           }
         rescue Exception => err
-          # Don't raise any Exception. Response to user already completed. 
+          # Don't raise any Exception. Response to user already completed.
           # nop
           logger.warn("Failed to put a message into queue: #{err}")
         end
-      
+
         begin
           StoredMessage.transaction do
-            options = {:delete_mode => @delete_mode || :physical}
+            options = {:delete_mode => @@saf_delete_mode || :physical}
             forwarded_messages.keys.each {|id|
               ::Ap4r::StoredMessage.destroy_if_exists(id, options)
             }
           end
         rescue Exception => err
-          # Don't raise any Exception. Response to user already completed. 
+          # Don't raise any Exception. Response to user already completed.
           # nop
           logger.warn("Failed to put a message into queue: #{err}")
         end
-        
-      ensure     
+
+      ensure
         Thread.current[:use_saf] = false
         Thread.current[:stored_messages] = nil
       end
@@ -126,6 +127,7 @@ module Ap4r
 
         # TODO: clone it, 2006/10/16 shino
         options ||= {}
+        options[:controller] ||= controller_path.gsub("/", ".")
         rm_options = @@default_rm_options.merge(rm_options || {})
         # TODO: put into :dispatch_mode to @@default_rm_options
         rm_options[:dispatch_mode] ||= @@default_dispatch_mode
@@ -143,14 +145,14 @@ module Ap4r
           stored_message = ::Ap4r::StoredMessage.store(queue_name, queue_message, queue_headers)
 
           Thread.current[:stored_messages].store(
-                                                 stored_message.id, 
+                                                 stored_message.id,
                                                  {
-                                                   :queue_message => queue_message, 
+                                                   :queue_message => queue_message,
                                                    :queue_name => queue_name,
-                                                   :queue_headers => queue_headers 
+                                                   :queue_headers => queue_headers
                                                  } )
           return stored_message.id
-        end 
+        end
 
         __queue_put(queue_name, queue_message, queue_headers)
       end
@@ -162,8 +164,9 @@ module Ap4r
       end
 
       def __get_queue_name(options, rm_options)
-        rm_options[:queue_name] ||
-          @@default_queue_prefix.concat(options[:controller].to_s).concat('.').concat(options[:action].to_s)
+        rm_options[:queue_name] ||=
+          @@default_queue_prefix.clone.concat(options[:controller].to_s).concat('.').concat(options[:action].to_s)
+        rm_options[:queue_name]
       end
 
     end
@@ -238,7 +241,7 @@ module Ap4r
           @rm_options[:target_action] ||= action_api_name
           @rm_options
         end
-        
+
         def action_api_name
           action_method_name = @options[:action]
           action_method_name.camelcase
@@ -249,7 +252,7 @@ module Ap4r
           new_opts[:action] = nil
           new_opts
         end
-          
+
       end
 
       class XmlRpc < WebService
@@ -258,7 +261,7 @@ module Ap4r
         def target_url_name
           url_for(options_without_action) + rails_api_url_suffix
         end
-        
+
         private
         def rails_api_url_suffix
           '/api'

data/script/mongrel_ap4r.rb

@@ -0,0 +1,255 @@
+# Author:: Shunichi Shinohara
+# Copyright:: Copyright (c) 2007 Future Architect Corp.
+# Licence:: MIT Licence
+
+require 'rubygems'
+require 'mongrel'
+require 'ap4r/mongrel'
+
+module Ap4r::Mongrel
+
+  module Command
+    PREFIX = "ap4r::mongrel::"
+
+    module Base
+      def self.included(klass)
+        return unless klass.kind_of?(Class)
+        klass.class_eval do |k|
+          include(::Mongrel::Command::Base)
+        end
+        # TODO: Can subclass the return of RubyGems::GemPlugin ? 2007/04/16 by shino
+      end
+
+      # send a signal to the process specified by pid_file.
+      def send_signal(signal, pid_file)
+        pid = open(pid_file).read.to_i
+        print "Send signal #{signal} to AP4R at PID #{pid} ..."
+        begin
+          Process.kill(signal, pid)
+        rescue Errno::ESRCH
+          puts "Process not found."
+        end
+        puts "Done."
+      end
+    end
+
+  end
+
+  class Help < GemPlugin::Plugin "/commands"
+    include ::Ap4r::Mongrel::Command::Base
+
+    def run
+      puts "Available AP4R commands are:\n\n"
+      Mongrel::Command::Registry.instance.commands.each do |name|
+        if name =~ /#{Command::PREFIX}/
+          name = name[Command::PREFIX.length .. -1]
+        end
+        puts " - #{name[1 .. -1]}\n"
+      end
+      puts "\nfor further help, run each command with -h option to get help."
+    end
+
+  end
+
+  class Version < GemPlugin::Plugin "/commands"
+    include ::Ap4r::Mongrel::Command::Base
+
+    def run
+      puts "AP4R Version is:"
+      puts
+      puts " - AP4R #{::Ap4r::VERSION::STRING}"
+      puts
+    end
+
+  end
+
+  class Start < GemPlugin::Plugin "/commands"
+    include ::Ap4r::Mongrel::Command::Base
+
+    def configure
+      options [
+        ["-d", "--daemonize", "Run in daemon mode", :@daemon, false],
+        ['-p', '--port PORT', "Port number used by mongrel", :@port, 7438],
+        ['-a', '--address HOST', "IP address used by mongrel", :@host, "0.0.0.0"],
+        ['-A', '--ap4r-config FILE', "Config file for reliable-msg/AP4R", :@ap4r_config_file, "config/queues.cfg"],
+        ['-l', '--log FILE', "Log file", :@log_file, "log/mongrel_ap4r.log"],
+        ['-P', '--pid FILE', "PID file", :@pid_file, "log/mongrel_ap4r.pid"],
+        ['-r', '--root PATH', "Document root (no meanings yet.)", :@docroot, "public"],
+        ['-c', '--chdir PATH', "Change to dir", :@cwd, Dir.pwd],
+      ]
+    end
+
+    def validate
+      @cwd = File.expand_path(@cwd)
+      valid_dir? @cwd, "Path of chdir not valid: #@cwd "
+      Dir.chdir(@cwd)
+
+      valid_dir? File.dirname(@log_file), "Path to log file not valid: #@log_file"
+      valid_dir? File.dirname(@pid_file), "Path to pid file not valid: #@pid_file"
+      # TODO: now not utilized, skip checking 2007/04/23 by shino
+      #valid_dir? @docroot, "Path to docroot not valid: #@docroot"
+
+      return @valid
+    end
+
+    def run
+      settings = {
+        :host => @host,  :port => @port,
+        :log_file => @log_file, :pid_file => @pid_file,
+        :docroot => @docroot,
+        :daemon => @daemon,
+        :ap4r_config_file => @ap4r_config_file,
+      }
+
+      config = ::Ap4r::Mongrel::Ap4rConfigurator.new(settings) do
+        if defaults[:daemon]
+          if File.exist? defaults[:pid_file]
+            log "PID file #{defaults[:pid_file]} exists!!! Exiting with error."
+            exit 1
+          end
+          daemonize({:log_file => @log_file, :cwd => File.expand_path(".") })
+        end
+
+        listener do
+          log "Starting AP4R Handler with #{defaults[:ap4r_config_file]}"
+          uri "/", :handler => ::Ap4r::Mongrel::Ap4rHandler.new(defaults)
+        end
+        setup_signals(settings)
+      end
+
+      config.run
+      config.log "Mongrel available at #{settings[:host]}:#{settings[:port]}"
+
+      if config.defaults[:daemon]
+        config.write_pid_file
+      else
+        config.log "Use CTRL-C to stop."
+      end
+
+      config.log "Mongrel start up process completed."
+      config.join
+
+      if config.needs_restart
+        if RUBY_PLATFORM !~ /mswin/
+          cmd = "ruby #{__FILE__} start #{original_args.join(' ')}"
+          config.log "Restarting with arguments:  #{cmd}"
+          config.stop
+          config.remove_pid_file
+
+          if config.defaults[:daemon]
+            system cmd
+          else
+            STDERR.puts "Can't restart unless in daemon mode."
+            exit 1
+          end
+        else
+          config.log "Win32 does not support restarts. Exiting."
+        end
+      end
+    end
+
+  end
+
+  class Stop < GemPlugin::Plugin "/commands"
+    include ::Ap4r::Mongrel::Command::Base
+
+    def configure
+      options [
+        ['-c', '--chdir PATH', "Change to dir", :@cwd, Dir.pwd],
+        ['-P', '--pid FILE', "PID file", :@pid_file, "log/mongrel_ap4r.pid"],
+        ['-f', '--force', "Force the shutdown (kill -9).", :@force, false],
+        ['-w', '--wait SECONDS', "Wait SECONDS before forcing shutdown", :@wait, "0"],
+      ]
+    end
+
+    def validate
+      @cwd = File.expand_path(@cwd)
+      valid_dir? @cwd, "Path of chdir not valid: #@cwd "
+      Dir.chdir(@cwd)
+
+      valid_dir? File.dirname(@pid_file), "Path to pid file not valid: #@pid_file"
+
+      return @valid
+    end
+
+    def run
+      if @force
+        @wait.to_i.times do |waiting|
+          exit(0) if not File.exist? @pid_file
+          sleep 1
+        end
+        send_signal("KILL", @pid_file) if File.exist? @pid_file
+      else
+        send_signal("TERM", @pid_file)
+      end
+    end
+  end
+
+  class Restart < GemPlugin::Plugin "/commands"
+    include ::Ap4r::Mongrel::Command::Base
+
+    def configure
+      options [
+        ['-c', '--chdir PATH', "Change to dir", :@cwd, Dir.pwd],
+        ['-P', '--pid FILE', "PID file", :@pid_file, "log/mongrel_ap4r.pid"],
+      ]
+    end
+
+    def validate
+      @cwd = File.expand_path(@cwd)
+      valid_dir? @cwd, "Path of chdir not valid: #@cwd "
+      Dir.chdir(@cwd)
+
+      valid_dir? File.dirname(@pid_file), "Path to pid file not valid: #@pid_file"
+
+      return @valid
+    end
+
+    def run
+      send_signal("USR2", @pid_file)
+    end
+  end
+
+  # TODO: add Reload(reliable-msg) command class 2007/04/16 by shino
+
+end
+
+
+def main(args)
+  cmd_name = args.shift
+
+  begin
+    # TODO not all commands are implemented 2007/04/16 by shinohara
+    if %w(help version start stop restart reload).include? cmd_name
+      cmd_name = ::Ap4r::Mongrel::Command::PREFIX + cmd_name
+    end
+
+    command = GemPlugin::Manager.instance.create("/commands/#{cmd_name}", :argv => args)
+  rescue OptionParser::InvalidOption
+    STDERR.puts "#$! for command '#{cmd_name}'"
+    STDERR.puts "Try #{cmd_name} -h to get help."
+    return false
+  rescue
+    STDERR.puts "ERROR RUNNING '#{cmd_name}': #$!"
+    STDERR.puts "Use help command to get help"
+    return false
+  end
+
+  if not command.done_validating
+    if not command.validate
+      STDERR.puts "#{cmd_name} reported an error. Use mongrel_rails #{cmd_name} -h to get help."
+      return false
+    else
+      command.run
+    end
+  end
+
+  return true
+end
+
+# TODO: This script is not yet proper form of GemPlugin 2007/04/16 by shinohara
+#GemPlugin::Manager.instance.load "ap4r" => GemPlugin::INCLUDE, "rails" => GemPlugin::EXCLUDE
+
+unless main(ARGV)
+  exit(1)
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: ap4r
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2007-04-06 00:00:00 +09:00
+  version: 0.3.1
+date: 2007-04-24 00:00:00 +09:00
 summary: Asynchronous Processing for Ruby.
 require_paths: 
 - lib
@@ -36,10 +36,12 @@ files:
 - doc
 - lib
 - MIT-LICENSE
+- pkg
 - rails_plugin
 - Rakefile
 - README
 - script
+- temp
 - bin/ap4r_setup
 - config/ap4r_settings.rb
 - config/log4r.yaml
@@ -53,10 +55,12 @@ files:
 - script/irm
 - script/loop.cmd
 - script/loop.rb
+- script/mongrel_ap4r.rb
 - script/start
 - script/stop
 - lib/ap4r
 - lib/ap4r/message_store_ext.rb
+- lib/ap4r/mongrel.rb
 - lib/ap4r/multi_queue.rb
 - lib/ap4r/queue_manager_ext.rb
 - lib/ap4r/queue_manager_ext_debug.rb
@@ -74,6 +78,7 @@ files:
 - lib/ap4r/util/loc.rb
 - lib/ap4r/util/queue_client.rb
 - lib/ap4r/version.rb
+- lib/ap4r/xxx_create_table_for_saf.rb
 - lib/ap4r.rb
 test_files: []