stompserver_ng 1.0.6

data/etc/arutils/cre_postgres.rb

@@ -0,0 +1,33 @@
+require 'rubygems' if RUBY_VERSION =~ /1.8/
+require 'active_record'
+#
+# = cre_postgres - create a postgres data base for use by stompserver_ng
+#
+# For now, the db parameters are hard coded.  Change as required.
+#
+db_params = {
+  'adapter' =>  'postgresql',
+  'encoding' =>  'utf8',
+  'database' =>  'ssng_dev',
+  'pool' => 5,
+  'username' => 'ssng',
+  'password' => 'xxxxxxxx',
+  'host' => 'localhost',
+  'port' => 5432
+}
+#
+# Connect.
+#
+ActiveRecord::Base.establish_connection(db_params)
+puts "postgres Connection complete."
+#
+# Define the ar_messages table.
+#
+ActiveRecord::Schema.define do
+  create_table 'ar_messages' do |t|
+    t.column 'stomp_id', :string, :null => false
+    t.column 'frame', :text, :null => false
+  end
+end
+puts "postgres table create complete."
+

data/etc/arutils/cre_sqlite3.rb

@@ -0,0 +1,28 @@
+require 'rubygems' if RUBY_VERSION =~ /1.8/
+require 'active_record'
+#
+# = cre_sqlite3 - create an sqlite3 data base for use by stompserver_ng
+#
+# For now, the db parameters are hard coded.  Change as required.
+# Note: directory structure should already exist.
+#
+db_params = {
+  'adapter' => 'sqlite3',
+  'database' => "/tmp/stompserver/etc/stompserver_development"
+}
+#
+# Connect.
+#
+ActiveRecord::Base.establish_connection(db_params)
+puts "sqlite3 Connection complete."
+#
+# Define the ar_messages table.
+#
+ActiveRecord::Schema.define do
+  create_table 'ar_messages' do |t|
+    t.column 'stomp_id', :string, :null => false
+    t.column 'frame', :text, :null => false
+  end
+end
+puts "sqlite3 table create complete."
+

data/etc/arutils/mysql_boot.sql

@@ -0,0 +1,12 @@
+--
+--
+-- This might depend on your mysql set up:
+--
+-- * mysql -u root -p mysql < mysql_boot.sql
+--
+CREATE USER 'ssng'@'localhost' IDENTIFIED BY 'xxxxxxxx';
+GRANT ALL PRIVILEGES ON ssng_dev.* TO 'ssng'@'localhost' WITH GRANT OPTION;
+GRANT ALL PRIVILEGES ON ssng_dev.* TO 'ssng'@'%' WITH GRANT OPTION;
+--
+CREATE DATABASE ssng_dev;
+

data/etc/arutils/postgres_boot.sql

@@ -0,0 +1,14 @@
+--
+-- This probably depends on your postgres setup:
+-- * su - postgres
+-- * (enter password if necessary)
+-- * psql < postgres_boot.sql
+--
+-- Create the user/role.
+--
+CREATE ROLE ssng LOGIN PASSWORD 'xxxxxxxx';
+--
+-- And the data base.
+--
+CREATE DATABASE ssng_dev OWNER ssng;
+

data/etc/database.mysql.yml

@@ -0,0 +1,9 @@
+adapter: mysql
+encoding: utf8
+database: ssng_dev
+pool: 5
+username: ssng
+password: xxxxxxxx
+host: localhost
+port: 3306
+

data/etc/database.postgres.yml

@@ -0,0 +1,9 @@
+adapter: postgresql
+encoding: utf8
+database: ssng_dev
+pool: 5
+username: ssng
+password: xxxxxxxx
+host: localhost
+port: 5432
+

data/etc/passwd.example

@@ -0,0 +1,3 @@
+# Stompserver will look for a .passwd file in the directory you are running it from.  One login/passcode per line, separated by a colon.
+# Comment lines are ignored
+testuser:testpass

data/etc/ppqinfo.rb

@@ -0,0 +1,15 @@
+require 'pp'
+#
+# Pretty print the queue information file.
+#
+# Sample Use:
+#
+# ruby etc/ppqinfo.rb /ad3/tmp/stompserver/.queue/qinfo 
+#
+qfile = ARGV[0]
+qinfo = nil
+File.open(qfile) do |f|
+  qinfo = Marshal.load(f)
+end
+pp qinfo
+

data/etc/runserver.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+cd /home/stompserver_ng
+>stompserver.log
+echo Start >>stompserver.log
+x=$(ruby -v)
+echo $x >>stompserver.log
+# 
+# Set command line options.
+#
+sopts="$*"
+#
+# Start the server.
+#
+echo Start server >>stompserver.log
+stompserver_ng $sopts
+set +x
+exit 0

data/etc/stompserver_ng

@@ -0,0 +1,50 @@
+#!/bin/sh
+### BEGIN INIT INFO
+# Provides:          stompserver_ng
+# Required-Start:    $syslog
+# Required-Stop:     $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Start/stop the stompserver_ng gem
+### END INIT INFO
+#
+NAME=stompserver_ng
+DESC="stompserver_ng ruby gem"
+#
+NAMEHOME=/home/$NAME
+#
+CONFIGFILE="$NAMEHOME/$NAME.conf"
+STOMPCMD="$NAMEHOME/bin/runserver.sh"
+#
+WORKDIR=$(grep "working_dir" $CONFIGFILE | cut -d" " -f2)
+PIDFILE="$WORKDIR/$NAME.pid"
+#
+EXTRA_OPTS="--daemon --session_cache=25 -C $CONFIGFILE"
+EXTRA_OPTS="${EXTRA_OPTS} ${STOMP_OPTS}"
+#
+set -e
+# set -x
+#
+case "$1" in
+    start)
+        echo -n "Starting $DESC: "
+        test -f /var/tmp/ruby-uuid && rm /var/tmp/ruby-uuid
+        test -d $WORKDIR && rm -rf $WORKDIR
+        su -l $NAME -c "$STOMPCMD $EXTRA_OPTS"
+        echo "$NAME."
+        ;;
+    stop)
+        echo -n "Stopping $DESC: "
+        pid=$(ps -ef | grep -i stompserver | grep -i ruby |awk '{print $2}')
+        kill $pid
+        echo "$NAME."
+        ;;
+    *)
+        echo "Usage: $0 { start | stop }" >&2
+        exit 1
+        ;;
+esac
+#
+# set +x
+exit 0
+

data/etc/stompserver_ng.conf

@@ -0,0 +1,13 @@
+---
+:daemon: true
+:working_dir: /tmp/stompserver
+:storage: .queue
+:queue: file
+:auth: false
+:debug: false
+:group:
+:user:
+:host: localhost
+:port: 61613
+:log_level: debug
+

data/lib/stomp_server_ng.rb

@@ -0,0 +1,471 @@
+require 'rubygems'
+require 'eventmachine'
+require 'uuid'
+require 'stomp_server_ng/stomp_frame'
+require 'stomp_server_ng/stomp_frame_recognizer'
+require 'stomp_server_ng/stomp_id'
+require 'stomp_server_ng/stomp_auth'
+require 'stomp_server_ng/topic_manager'
+require 'stomp_server_ng/queue_manager'
+require 'stomp_server_ng/qmonitor'
+require 'stomp_server_ng/queue'
+require 'stomp_server_ng/queue/memory_queue'
+require 'stomp_server_ng/queue/file_queue'
+require 'stomp_server_ng/queue/dbm_queue'
+require 'stomp_server_ng/protocols/stomp'
+require 'logger'
+
+module StompServer
+  VERSION = '1.0.6'
+  #
+  # session ID cache manager
+  #
+  class SessionIDManager
+    #
+    @@session_cache = nil
+    #
+    @@generator = nil
+    #
+    def self.initialize_cache(requested_size)
+      #
+      return [] if requested_size <= 0
+      #
+      @@session_cache = @@session_cache || []
+      #
+      if not @@generator
+        UUID::state_file = "./.temp_uuid_state"
+        @@generator = UUID::new()
+      end
+      #
+      return @@session_cache if @@session_cache.size > requested_size
+      #
+      (requested_size - @@session_cache.size).times do
+        @@session_cache << @@generator.generate
+      end
+    end
+    #
+    def self.get_cache_id(requested_size)
+      session_id = @@session_cache.pop
+      initialize_cache(requested_size) if @@session_cache.size == 0
+      session_id
+    end
+    #
+    def self.dump_cache(logger)
+      logger.debug("Session ID Dump:")
+      @@session_cache.each do |sessid|
+        logger.debug("#{sessid}")
+      end
+    end
+  end
+  #
+  # Ruby Logger Level Handler.
+  #
+  class LogHelper
+    #
+    # Set the desired logger level.
+    #
+    def self.set_loglevel(opts)
+      @@loglevel = nil
+      case opts[:log_level].downcase
+        when 'debug' then @@loglevel = Logger::DEBUG
+        when 'info'  then @@loglevel = Logger::INFO
+        when 'warn'  then @@loglevel = Logger::WARN
+        when 'error' then @@loglevel = Logger::ERROR
+        else  
+          @@loglevel = Logger::ERROR
+      end
+    end
+    #
+    # Return the desired logging level.
+    #
+    def self.get_loglevel
+      @@loglevel
+    end
+    #
+    # Display ruby version information on a defined logger output
+    # destination.
+    #
+    def self.showversion(logger)
+      # stompserver version
+      logger.debug "stomp_server version: #{StompServer::VERSION}"
+      # ruby version for all versions
+      logger.debug "ruby: ver=#{RUBY_VERSION}p#{RUBY_PATCHLEVEL} (reldate=#{RUBY_RELEASE_DATE})"
+      # more ruby version information for 1.9+
+      if RUBY_VERSION =~ /1.9/
+        logger.debug "ruby: rev=#{RUBY_REVISION} engine=#{RUBY_ENGINE}"
+      end
+    end
+    #
+    # Clean logging of all options values.
+    #
+    def self.showoptions(logger, opts)
+      logger.debug("Options Display Starts")
+      # This is ugly, but it should only happen once at startup ......
+      if RUBY_VERSION =~ /1.8/
+        opts.keys.map {|key| key.to_s}.sort.each do |str_opt|
+          optname = str_opt.to_sym
+          logger.debug("Option: #{optname}=#{opts[optname]}")
+        end
+      else  # 1.9 version
+        opts.keys.sort.each do |optname|
+          logger.debug("Option: #{optname}=#{opts[optname]}")
+        end
+      end
+      logger.debug("Options Display Ends")
+    end
+    #
+    # Show load path
+    #
+    def self.showloadpath(logger)
+      return unless @@loglevel == Logger::DEBUG
+      pos = 1
+      $:.each do |lp|
+        logger.debug("#{pos} #{lp}")
+        pos += 1
+      end
+    end
+  end # of class LogHelper
+  #
+  # Module level configuration
+  #
+  class Configurator
+
+    # The final options, merged from the defaults, the config file, and the 
+    # command line.
+    #--
+    # Should this be 'read' only after construction ????
+    attr_accessor :opts
+
+    def initialize
+
+      @opts = nil
+      @defaults = {
+        #
+        # For clarity maintain the same order here as below in the 'getopts' 
+        # method!!!!
+        #
+        :auth => false,                 # -a
+        :host => "127.0.0.1",           # -b
+        :checkpoint => 0,               # -c
+        :config => 'stompserver.conf',  # -C
+        :debug => false,                # -d
+        :logdir => 'log',               # -D
+        :log_level => 'error',          # -l
+        :logfile => 'stompserver.log',  # -L
+        :port => 61613,                 # -p
+        :pidfile => 'stompserver.pid',  # -P
+        :queue => 'memory',             # -q
+        :storage => ".stompserver",     # -s
+        :session_cache => 0,            # -S
+        :working_dir => Dir.getwd,      # -w
+        :dbyml => 'database.yml',       # -y
+        :daemon => false                # -z
+      }
+      # Get a crude logger
+      @@log = Logger.new(STDOUT)
+
+      # Show version numbers regardless
+      StompServer::LogHelper.showversion(@@log)
+
+      # Options handling
+      @opts = getopts()   # get and merge the options
+
+      # Finalize logger level handling
+      @@log.debug "Logger Level Requested: #{@opts[:log_level].upcase}"
+      StompServer::LogHelper.set_loglevel(@opts)
+
+      # Show Load Path
+      StompServer::LogHelper.showloadpath(@@log)
+
+      @@log.level = StompServer::LogHelper.get_loglevel()
+
+      # Turn on $DEBUG for extra debugging info if requested
+      if opts[:debug]
+        $DEBUG=true
+        @@log.debug "-d / --debug set, $DEBUG is true"
+      end
+
+      # Configuration is complete!
+      @@log.debug("#{self.class} Configuration complete")
+    end
+
+    def getopts()
+
+      # New Options Parser
+      opts_parser = OptionParser.new
+
+      # Empty Hash for parser values
+      hopts = {}
+
+      # :auth
+      opts_parser.on("-a", "--auth", String, 
+        "Require client authorization") {|a| 
+        hopts[:auth] = true}
+
+      # :host
+      opts_parser.on("-b", "--host=ADDR", String, 
+        "Change the host (default: localhost)") {|a| 
+        hopts[:host] = a}
+
+      # :checkpoint
+      opts_parser.on("-c", "--checkpoint=SECONDS", Integer, 
+        "Time between checkpointing the queues in seconds (default: 0)") {|c| 
+        hopts[:checkpoint] = c}
+
+      # :config
+      opts_parser.on("-C", "--config=CONFIGFILE", String, 
+        "Configuration File (default: stompserver.conf)") {|c| 
+        hopts[:config] = c}
+
+      # :debug
+      opts_parser.on("-d", "--debug", String, 
+        "Turn on debug messages") {|d| 
+        hopts[:debug] = true}
+
+      # :logdir
+      opts_parser.on("-D", "--logdir=LOGDIR", String, 
+        "Log file directory  (default: log)") {|d| 
+        hopts[:logdir] = d} # new
+
+      # :log_level
+      opts_parser.on("-l", "--log_level=LEVEL", String, 
+        "Logger Level (default: ERROR)") {|l| 
+        hopts[:log_level] = l}
+
+      # :logfile
+      opts_parser.on("-L", "--logfile=LOGFILE", String, 
+        "Log file name (default: stompserver.log") {|l| 
+        hopts[:logfile] = l} # new
+
+      # :port
+      opts_parser.on("-p", "--port=PORT", Integer, 
+        "Change the port (default: 61613)") {|p| 
+        hopts[:port] = p}
+
+      # :pidfile
+      opts_parser.on("-P", "--pidfile=PIDFILE", Integer, 
+        "PID file name (default: stompserver.pid)") {|p| 
+        hopts[:pidfile] = p} # new
+
+      # :queue
+      opts_parser.on("-q", "--queuetype=QUEUETYPE", String, 
+        "Queue type (memory|dbm|activerecord|file) (default: memory)") {|q| 
+        hopts[:queue] = q}
+
+      # :storage
+      opts_parser.on("-s", "--storage=DIR", String, 
+        "Change the storage directory (default: .stompserver, relative to working_dir)") {|s| 
+        hopts[:storage] = s}
+
+      # :session_cache
+      opts_parser.on("-S", "--session_cache=SIZE", Integer, 
+        "session ID cache size (default: 0, disable session ID cache)") {|s| 
+        hopts[:session_cache] = s}
+
+      # :working_dir
+      opts_parser.on("-w", "--working_dir=DIR", String, 
+        "Change the working directory (default: current directory)") {|s| 
+        hopts[:working_dir] = s}
+
+      # :dbyml
+      opts_parser.on("-y", "--dbyml=YMLFILE", String, 
+        "Database .yml file name (default: database.yml)") {|y| 
+        hopts[:dbyml] = y}
+
+      # :daemon
+      opts_parser.on("-z", "--daemon", String, 
+        "Daemonize server process") {|d| 
+        hopts[:daemon] = true}
+
+      # Handle help if required
+      opts_parser.on("-h", "--help", "Show this message") do
+        puts opts_parser
+        exit
+      end
+
+      opts_parser.parse(ARGV)
+
+      # Handle the config file
+      config_found = false
+      # Load a default config file first if it exists.
+      loaded_opts = {}
+      full_path_default = File.expand_path(@defaults[:config])
+      if File.exists?(full_path_default)
+        @@log.debug("Loading config file defaults from: #{full_path_default}")
+        loaded_opts.merge!(YAML.load_file(full_path_default))
+        @defaults[:config] = full_path_default
+        config_found = true
+      end
+      # If a command line specified config file exists, overlay any new
+      # parameters in that file.
+      if hopts[:config]
+        full_path_cl = File.expand_path(hopts[:config])
+        if File.exists?(full_path_cl)
+          @@log.debug("Loading config file overrides from: #{full_path_cl}")
+          loaded_opts.merge!(YAML.load_file(full_path_cl))
+          hopts[:config] = full_path_cl
+          config_found = true
+        end
+      end
+      @@log.warn("No configuration file found.") unless config_found
+
+      # Run basic required merges on all the options
+      opts = {}                         # set to empty
+      opts = opts.merge(@defaults)      # 01 = merge in defaults
+      opts = opts.merge(loaded_opts)    # 02 = merge in loaded from config file
+      opts = opts.merge(hopts)          # 03 = merge in command line options
+
+      # Last but not least: Miscellaneous file definitions
+      opts[:etcdir] = File.join(opts[:working_dir],'etc')           # Define ':etcdir'
+      opts[:storage] = File.join(opts[:working_dir],opts[:storage]) # Override! ':storage'
+      opts[:logdir] = File.join(opts[:working_dir],opts[:logdir])   # Override! ':logdir'
+      opts[:logfile] = File.join(opts[:logdir],opts[:logfile])      # Override! ':logfile'
+      opts[:pidfile] = File.join(opts[:logdir],opts[:pidfile])      # Override! ':pidfile'
+      # :dbyml will be a full path and file name
+      unless File.exists?(File.expand_path(opts[:dbyml]))
+        opts[:dbyml] = File.join(opts[:etcdir],opts[:dbyml])        # Override! ':dbyml'
+      else
+        opts[:dbyml] = File.expand_path(opts[:dbyml])
+      end
+
+      # Authorization - working file
+      if opts[:auth]
+        opts[:passwd] = File.join(opts[:etcdir],'.passwd')
+      end
+      
+      # Return merged values (in Hash)
+      return opts
+    end
+  end
+
+  #
+  # Run server start up.
+  #
+  class Run
+    #
+    attr_accessor :queue_manager, :auth_required, :stompauth, :topic_manager
+
+    #
+    attr_accessor :session_cache
+
+    # Intiialize
+    def initialize(opts)
+      @@log = Logger.new(STDOUT)
+      @@log.level = StompServer::LogHelper.get_loglevel()
+
+      @opts = opts
+      @queue_manager = nil
+      @auth_required = nil
+      @stompauth = nil
+      @topic_manager = nil
+      @session_cache = nil
+      @@log.debug("#{self.class} Run class initialize method complete")
+    end
+
+    # Server stop on SIGINT or SIGTERM
+    def stop(pidfile)
+      @queue_manager.stop("KILL_ISSUED")
+      @@log.debug "Stompserver #{StompServer::VERSION} shutting down"
+      STDOUT.flush
+      EventMachine::stop_event_loop
+      File.delete(pidfile)
+    end
+
+    # Startup
+    def start
+      @@log.debug("#{self.class}.start begins")
+
+      # Handle group priviliges!
+      # N.B.: Handle these options from the command line ?????????
+      begin
+        if @opts[:group]
+          @@log.debug "Changing group to #{@opts[:group]}."
+          Process::GID.change_privilege(Etc.getgrnam(@opts[:group]).gid)
+        end
+
+        if @opts[:user]
+          @@log.debug "Changing user to #{@opts[:user]}."
+          Process::UID.change_privilege(Etc.getpwnam(@opts[:user]).uid)
+        end
+      rescue Errno::EPERM
+        @@log.error "FAILED to change user:group #{@opts[:user]}:#{@opts[:group]}: #$!"
+        exit 1
+      end
+
+      # Make required directories unless they already exist
+      Dir.mkdir(@opts[:working_dir]) unless File.directory?(@opts[:working_dir])
+      Dir.mkdir(@opts[:logdir]) unless File.directory?(@opts[:logdir])
+      Dir.mkdir(@opts[:etcdir]) unless File.directory?(@opts[:etcdir])
+
+      # Determine qstore type
+      if @opts[:queue] == 'dbm'
+        qstore=StompServer::DBMQueue.new(@opts[:storage])
+        @@log.debug "Queue storage is DBM"
+      elsif @opts[:queue] == 'file'
+        qstore=StompServer::FileQueue.new(@opts[:storage])
+        @@log.debug "Queue storage is FILE"
+      elsif @opts[:queue] == 'activerecord'
+        require 'stomp_server_ng/queue/activerecord_queue'
+        qstore=StompServer::ActiveRecordQueue.new(@opts[:etcdir], @opts[:storage], @opts[:dbyml])
+        @@log.debug "Queue storage is ActiveRecord"
+      else
+        qstore=StompServer::MemoryQueue.new
+        @@log.debug "Queue storage is MEMORY"
+      end
+
+      # Set checkpoint interval
+      qstore.checkpoint_interval = @opts[:checkpoint]
+      @@log.debug "Checkpoint interval is #{qstore.checkpoint_interval}" if $DEBUG
+
+      #
+      @topic_manager = StompServer::TopicManager.new
+      @queue_manager = StompServer::QueueManager.new(qstore)
+      @@log.debug("Managers are initialized.")
+      @@log.debug("Topic Manager: #{@topic_manager}")
+      @@log.debug("Queue Manager: #{@queue_manager}")
+
+      # Authorization: requirement
+      @auth_required = @opts[:auth]
+      if @auth_required
+        @stompauth = StompServer::StompAuth.new(@opts[:passwd])
+      end
+
+      # Initialize session ID cache
+      if @opts[:session_cache] > 0
+        StompServer::SessionIDManager.initialize_cache(@opts[:session_cache])
+        StompServer::SessionIDManager.dump_cache(@@log);
+      end
+
+      # If we are going to daemonize, it should be almost the last
+      # thing we do here.
+      @@log.debug("#{self.class}.start Daemonize: #{@opts[:daemon]}")
+      if @opts[:daemon]
+        @@log.debug("#{self.class}.start going to background")
+        @@log.debug("#{self.class}.start check #{@opts[:logfile]}")
+
+        StompServer::LogHelper.showversion(@@log)
+
+        STDOUT.flush    # clear the decks
+        Daemonize.daemonize(log_file=@opts[:logfile])
+        # change back to the original starting directory
+        Dir.chdir(@opts[:working_dir])
+      end
+
+      # But write pidfile only after possible daemonization
+      curr_pid = Process.pid
+      open(@opts[:pidfile],"w") {|f| f.write(curr_pid) }
+      @@log.debug("Pid File Contents: #{curr_pid}")
+
+      # OK, log and set the SIGINT signal handler.
+      @@log.debug("#{self.class}.start setting trap at completion")
+      StompServer::LogHelper.showversion(@@log) # one more time at startup
+      # Show Load Path
+      StompServer::LogHelper.showloadpath(@@log)
+      StompServer::LogHelper.showoptions(@@log, @opts) # Dump runtime options
+      trap("INT") { @@log.debug "INT signal received.";stop(@opts[:pidfile]) }
+      trap("TERM") { @@log.debug "TERM signal received.";stop(@opts[:pidfile]) }
+    end
+  end # of class Run
+#
+end # of module StompServer
+