mongrel_service 0.3.4-i386-mswin32

data/lib/ServiceFB/ServiceFB_Utils.bi

@@ -0,0 +1,70 @@
+'#--
+'# Copyright (c) 2006-2007 Luis Lavena, Multimedia systems
+'#
+'# This source code is released under the MIT License.
+'# See MIT-LICENSE file for details
+'#++
+
+#if __FB_VERSION__ < "0.17"
+#error ServiceFB is designed to compile with FreeBASIC version "0.17"
+#else
+
+#ifndef __FB_WIN32__
+#error Platform unsupported. Compiling ServiceFB requires Windows platform.
+#else
+
+#ifndef __ServiceFB_Utils_bi__
+#define __ServiceFB_Utils_bi__
+
+#include once "win/psapi.bi"
+#include once "win/tlhelp32.bi"
+
+namespace fb
+namespace svc
+namespace utils   '# fb.svc.utils
+    '# use this to determine (using select case maybe?) the
+    '# mode which the service was invoked.
+    enum ServiceRunMode
+        RunAsUnknown = 0
+        RunAsService
+        RunAsManager
+        RunAsConsole
+    end enum
+    
+    
+    '# ServiceController type (object)
+    '# this is a helper object in case you want to implement
+    '# console mode (command line testing/debugging) and management (install/remove/control)
+    '# to your services, all from the same executable
+    type ServiceController
+        '# ctor/dtor()
+        declare constructor()
+        declare constructor(byref as string)
+        declare constructor(byref as string, byref as string)
+        declare constructor(byref as string, byref as string, byref as string)
+        declare destructor()
+        
+        '# methods (public)
+        declare sub Banner()
+        declare function RunMode() as ServiceRunMode
+        declare sub Manage()
+        declare sub Manage(byref as ServiceProcess)
+        declare sub Console()
+        declare sub Console(byref as ServiceProcess)
+        
+        '# properties (public)
+        '# use these properties for shwoing information on console/manager mode
+        '# as banner.
+        '# Product, version
+        '# copyright
+        product     as string
+        version     as string
+        copyright   as string
+    end type
+end namespace     '# fb.svc.utils
+end namespace     '# fb.svc
+end namespace     '# fb
+
+#endif '# __ServiceFB_bi__
+#endif '# __FB_WIN32__
+#endif '# __FB_VERSION__

data/lib/ServiceFB/_internals.bi

@@ -0,0 +1,50 @@
+'#--
+'# Copyright (c) 2006-2007 Luis Lavena, Multimedia systems
+'#
+'# This source code is released under the MIT License.
+'# See MIT-LICENSE file for details
+'#++
+
+'##################################################################
+'#
+'# DO NOT INCLUDE THIS FILE DIRECTLY!
+'# it is used internaly by ServiceFB
+'# use ServiceFB.bi instead
+'#
+'##################################################################
+
+namespace fb
+namespace svc
+    '# now due references locking, I needed a constructor and destructor for 
+    '# the namespace to garantee everything is cleaned up on termination of the process
+    declare sub _initialize() constructor
+    declare sub _terminate() destructor
+    
+    '# global service procedures (private)
+    declare sub _main(byval as DWORD, byval as LPSTR ptr)
+    declare function _control_ex(byval as DWORD, byval as DWORD, byval as LPVOID, byval as LPVOID) as DWORD
+    declare sub _run()
+    
+    '# global references helper
+    declare function _add_to_references(byref as ServiceProcess) as integer
+    declare function _find_in_references(byref as string) as ServiceProcess ptr
+    
+    '# command line builder (helper)
+    '# this is used to gather information about:
+    '# mode (if present)
+    '# valid service name (after lookup in the table)
+    '# command line to be passed to service
+    declare sub _build_commandline(byref as string, byref as string, byref as string)
+    
+    '# I started this as simple, unique service served from one process
+    '# but the idea of share the same process space (and reduce resources use) was good.
+    '# to do that, I needed a references table (similar to service_table, but we will
+    '# hold the ServiceProcess registered by ServiceHost (the multi services host).
+    '# also, I needed a locking mechanism to avoid problems of two calls changing the table
+    '# at the same time.
+    extern _svc_references as ServiceProcess ptr ptr
+    extern _svc_references_count as integer
+    extern _svc_references_lock as any ptr
+end namespace   '# fb.svc
+end namespace   '# fb
+

data/lib/ServiceFB/_utils_internals.bi

@@ -0,0 +1,49 @@
+'#--
+'# Copyright (c) 2006-2007 Luis Lavena, Multimedia systems
+'#
+'# This source code is released under the MIT License.
+'# See MIT-LICENSE file for details
+'#++
+
+'##################################################################
+'#
+'# DO NOT INCLUDE THIS FILE DIRECTLY!
+'# it is used internaly by ServiceFB
+'# use ServiceFB_Utils.bi instead
+'#
+'##################################################################
+
+namespace fb
+namespace svc
+namespace utils   '# fb.svc.utils
+    '# console_handler is used to get feedback form keyboard and allow
+    '# shutdown of service using Ctrl+C / Ctrl+Break from keyboard
+    declare function _console_handler(byval as DWORD) as BOOL
+    
+    '# helper private subs used to list the services and their descriptions 
+    '# in _svc_references
+    declare sub _list_references()
+    
+    '# internals functions used to get Parent PID and Process Name
+    '# using this we automatically determine if the service was started by SCM
+    '# or by the user, from commandline or from explorer
+    declare function _parent_pid(byval as uinteger) as uinteger
+    declare function _process_name(byval as uinteger) as string
+    declare function _process_name_dyn_psapi(byval as uinteger) as string
+    declare function _show_error() as string
+    
+    '# InStrRev (authored by ikkejw @ freebasic forums)
+    '# http://www.freebasic.net/forum/viewtopic.php?p=49315#49315
+    declare function InStrRev(byval as uinteger = 0, byref as string, byref as string) as uinteger
+    
+    '# use a signal (condition) in the console mode to know
+    '# when the service should be stopped.
+    '# the Console() main loop will wait for it, and the console_handler
+    '# will raise in case Ctrl+C / Ctrl+Break or other events are
+    '# received.
+    extern _svc_stop_signal as any ptr
+    extern _svc_in_console as ServiceProcess ptr
+    extern _svc_in_console_stop_flag as BOOL
+end namespace     '# fb.svc.utils
+end namespace     '# fb.svc
+end namespace     '# fb

data/lib/mongrel_service/init.rb

@@ -0,0 +1,211 @@
+require 'gem_plugin'
+require 'mongrel'
+require 'mongrel/rails'
+require 'rbconfig'
+require 'fileutils'
+
+module Service
+  class Install < GemPlugin::Plugin "/commands"
+    include Mongrel::Command::Base
+  
+    def configure
+        options [
+          ['-N', '--name SVC_NAME', "Required name for the service to be registered/installed.", :@svc_name, nil],
+          ['-D', '--display SVC_DISPLAY', "Adjust the display name of the service.", :@svc_display, nil],
+          ["-e", "--environment ENV", "Rails environment to run as", :@environment, ENV['RAILS_ENV'] || "development"],
+          ['-p', '--port PORT', "Which port to bind to", :@port, 3000],
+          ['-a', '--address ADDR', "Address to bind to", :@address, "0.0.0.0"],
+          ['-l', '--log FILE', "Where to write log messages", :@log_file, "log/mongrel.log"],
+          ['-P', '--pid FILE', "Where to write the PID", :@pid_file, "log/mongrel.pid"],
+          ['-n', '--num-procs INT', "Number of processors active before clients denied", :@num_procs, 1024],
+          ['-t', '--timeout TIME', "Timeout all requests after 100th seconds time", :@timeout, 0],
+          ['-m', '--mime PATH', "A YAML file that lists additional MIME types", :@mime_map, nil],
+          ['-c', '--chdir PATH', "Change to dir before starting (will be expanded)", :@cwd, Dir.pwd],
+          ['-r', '--root PATH', "Set the document root (default 'public')", :@docroot, "public"],
+          ['-B', '--debug', "Enable debugging mode", :@debug, false],
+          ['-C', '--config PATH', "Use a config file", :@config_file, nil],
+          ['-S', '--script PATH', "Load the given file as an extra config script.", :@config_script, nil],
+          ['', '--prefix PATH', "URL prefix for Rails app", :@prefix, nil]
+        ]
+    end
+    
+    # When we validate the options, we need to make sure the --root is actually RAILS_ROOT
+    # of the rails application we wanted to serve, because later "as service" no error 
+    # show to trace this.
+    def validate
+      # TODO: investigate why Win32::Service interfere with gem_plugin
+      gem 'win32-service', '>= 0.5.2', '< 0.6.0'
+      require 'win32/service'
+
+      @cwd = File.expand_path(@cwd)
+      valid_dir? @cwd, "Invalid path to change to: #@cwd"
+  
+      # change there to start, then we'll have to come back after daemonize
+      Dir.chdir(@cwd)
+  
+      # start with the premise of app really exist.
+      app_exist = true
+      %w{app config log}.each do |path|
+        if !File.directory?(File.join(@cwd, path))
+          app_exist = false
+          break
+        end
+      end
+
+      valid?(@prefix[0].chr == "/" && @prefix[-1].chr != "/", "Prefix must begin with / and not end in /") if @prefix
+
+      valid? app_exist == true, "The path you specified isn't a valid Rails application."
+
+      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"
+      valid_dir? @docroot, "Path to docroot not valid: #@docroot"
+      valid_exists? @mime_map, "MIME mapping file does not exist: #@mime_map" if @mime_map
+      valid_exists? @config_file, "Config file not there: #@config_file" if @config_file
+
+      # We should validate service existance here, right Zed?
+      begin
+        valid? !Win32::Service.exists?(@svc_name), "The service already exist, please remove it first."
+      rescue
+      end
+
+      valid? @svc_name != nil, "A service name is mandatory."
+      
+      # default service display to service name
+      @svc_display = @svc_name if !@svc_display
+
+      return @valid
+    end
+    
+    def run
+      gem 'win32-service', '>= 0.5.2', '< 0.6.0'
+      require 'win32/service'
+
+      # check if mongrel_service.exe is in ruby bindir.
+      gem_root = File.join(File.dirname(__FILE__), "..", "..")
+      gem_executable = File.join(gem_root, "bin/mongrel_service.exe")
+      bindir_executable = File.join(Config::CONFIG['bindir'], '/mongrel_service.exe')
+      
+      unless File.exist?(bindir_executable)
+        STDERR.puts "** Copying native mongrel_service executable..."
+        FileUtils.cp gem_executable, bindir_executable rescue nil
+      end
+      
+      unless FileUtils.compare_file(bindir_executable, gem_executable)
+        STDERR.puts "** Updating native mongrel_service executable..."
+        FileUtils.rm_f bindir_executable rescue nil
+        FileUtils.cp gem_executable, bindir_executable rescue nil
+      end
+      
+      # build the command line
+      argv = []
+      
+      # start using the native executable
+      argv << '"' + bindir_executable + '"'
+      
+      # use the 'single' service for now
+      argv << "single"
+      
+      # command line setting override config file settings
+      @options = { :host => @address,  :port => @port, :cwd => @cwd,
+        :log_file => @log_file, :pid_file => @pid_file, :environment => @environment,
+        :docroot => @docroot, :mime_map => @mime_map,
+        :debug => @debug, :includes => ["mongrel"], :config_script => @config_script,
+        :num_procs => @num_procs, :timeout => @timeout, :cpu => @cpu, :prefix => @prefix
+      }
+      
+      # if we are using a config file, pass -c and -C to the service instead of each start parameter.
+      if @config_file
+        STDERR.puts "** Using #{@config_file} instead of command line parameters."
+        conf = YAML.load_file(@config_file)
+        
+        # add the root folder (-c)
+        argv << "-c \"#{conf[:cwd]}\""
+        
+        # use the config file
+        argv << "-C \"#{@config_file}\""
+
+      else
+        # use the command line instead
+        # now the options
+        argv << "-e #{@options[:environment]}" if @options[:environment]
+        argv << "-p #{@options[:port]}"
+        argv << "-a #{@options[:host]}"  if @options[:host]
+        argv << "-l \"#{@options[:log_file]}\"" if @options[:log_file]
+        argv << "-P \"#{@options[:pid_file]}\""
+        argv << "-c \"#{@options[:cwd]}\"" if @options[:cwd]
+        argv << "-t #{@options[:timeout]}" if @options[:timeout]
+        argv << "-m \"#{@options[:mime_map]}\"" if @options[:mime_map]
+        argv << "-r \"#{@options[:docroot]}\"" if @options[:docroot]
+        argv << "-n #{@options[:num_procs]}" if @options[:num_procs]
+        argv << "-B" if @options[:debug]
+        argv << "-S \"#{@options[:config_script]}\"" if @options[:config_script]
+        argv << "-u #{@options[:cpu.to_i]}" if @options[:cpu]
+        argv << "--prefix \"#{@options[:prefix]}\"" if @options[:prefix]
+      end
+
+      svc = Win32::Service.new
+      begin
+        svc.create_service{ |s|
+          s.service_name     = @svc_name
+          s.display_name     = @svc_display
+          s.binary_path_name = argv.join ' '
+          s.dependencies     = []
+          s.service_type     = Win32::Service::WIN32_OWN_PROCESS
+        }
+        puts "Mongrel service '#{@svc_display}' installed as '#{@svc_name}'."
+      rescue Win32::ServiceError => err
+        puts "There was a problem installing the service:"
+        puts err
+      end
+      svc.close
+    end
+  end
+
+  module ServiceValidation
+    def configure
+      options [
+        ['-N', '--name SVC_NAME', "Required name for the service to be registered/installed.", :@svc_name, nil],
+      ]
+    end
+    
+    def validate
+      valid? @svc_name != nil, "A service name is mandatory."
+
+      gem 'win32-service', '>= 0.5.2', '< 0.6.0'
+      require 'win32/service'
+      
+      # Validate that the service exists
+      begin
+        valid? Win32::Service.exists?(@svc_name), "There is no service with that name, cannot proceed."
+        Win32::Service.open(@svc_name) do |svc|
+          valid? svc.binary_path_name.include?("mongrel_service"), "The service specified isn't a Mongrel service."
+        end
+      rescue
+      end
+      
+      return @valid
+    end
+  end
+  
+  class Remove < GemPlugin::Plugin "/commands"
+    include Mongrel::Command::Base
+    include ServiceValidation
+    
+    def run
+      gem 'win32-service', '>= 0.5.2', '< 0.6.0'
+      require 'win32/service'
+
+      display_name = Win32::Service.getdisplayname(@svc_name)
+      
+      begin
+        Win32::Service.stop(@svc_name)
+      rescue
+      end
+      begin
+        Win32::Service.delete(@svc_name)
+      rescue
+      end
+      puts "#{display_name} service removed."
+    end
+  end
+end

data/mongrel_service.gemspec

@@ -0,0 +1,117 @@
+
+# Gem::Specification for Mongrel_service-0.3.4
+# Originally generated by Echoe
+
+Gem::Specification.new do |s|
+  s.name = %q{mongrel_service}
+  s.version = "0.3.4"
+  s.date = %q{2008-01-02}
+  s.summary = %q{Mongrel Native Win32 Service Plugin for Rails}
+  s.email = %q{}
+  s.homepage = %q{http://rubyforge.org/projects/mongrel}
+  s.rubyforge_project = %q{mongrel}
+  s.description = %q{This plugin offer native win32 services for rails, powered by Mongrel.}
+  s.has_rdoc = true
+  s.platform = %q{i386-mswin32}
+  s.authors = ["Luis Lavena"]
+  s.files = ["bin/mongrel_service.exe", "tools/freebasic.rb", "TODO", "resources/defaults.yaml", "README", "native/mongrel_service.bi", "native/mongrel_service.bas", "native/console_process.bi", "native/console_process.bas", "native/_debug.bi", "LICENSE", "lib/ServiceFB/ServiceFB_Utils.bi", "lib/ServiceFB/ServiceFB_Utils.bas", "lib/ServiceFB/ServiceFB.bi", "lib/ServiceFB/ServiceFB.bas", "lib/ServiceFB/_utils_internals.bi", "lib/ServiceFB/_internals.bi", "lib/mongrel_service/init.rb", "COPYING", "CHANGELOG", "Manifest", "mongrel_service.gemspec"]
+  s.add_dependency(%q<gem_plugin>, [">= 0.2.3", "< 0.3.0"])
+  s.add_dependency(%q<mongrel>, [">= 1.0.2", "< 1.2.0"])
+  s.add_dependency(%q<win32-service>, [">= 0.5.2", "< 0.6.0"])
+end
+
+
+# # Original Rakefile source (requires the Echoe gem):
+# 
+# require 'echoe'
+# require 'tools/freebasic'
+# 
+# # Task :package needs compile before doing the gem stuff.
+# # (weird behavior of Rake?)
+# task :package => [:compile]
+# 
+# echoe_spec = Echoe.new("mongrel_service") do |p|
+#   p.summary = "Mongrel Native Win32 Service Plugin for Rails"
+#   p.summary += " (debug build)" unless ENV['RELEASE'] 
+#   p.description = "This plugin offer native win32 services for rails, powered by Mongrel."
+#   p.author = "Luis Lavena"
+#   p.platform = Gem::Platform::CURRENT
+#   p.dependencies = [['gem_plugin', '>=0.2.3', '<0.3.0'],
+#                     ['mongrel', '>=1.0.2', '<1.2.0'],
+#                     ['win32-service', '>=0.5.2', '<0.6.0']]
+# 
+#   p.executable_pattern = ""
+#   
+#   p.need_tar_gz = false
+#   p.need_zip = true
+#   ]
+#   p.require_signed = true
+# end
+# 
+# desc "Compile native code"
+# task :compile => [:native_lib, :native_service]
+# 
+# # global options shared by all the project in this Rakefile
+# OPTIONS = {
+#   :debug => false,
+#   :profile => false,
+#   :errorchecking => :ex,
+#   :mt => true,
+#   :pedantic => true }
+# 
+# OPTIONS[:debug] = true if ENV['DEBUG']
+# OPTIONS[:profile] = true if ENV['PROFILE']
+# OPTIONS[:errorchecking] = :exx if ENV['EXX']
+# OPTIONS[:pedantic] = false if ENV['NOPEDANTIC']
+# 
+# # ServiceFB namespace (lib)
+# namespace :lib do
+#   project_task 'servicefb' do
+#     lib       'ServiceFB'
+#     build_to  'lib'
+# 
+#     define    'SERVICEFB_DEBUG_LOG' unless ENV['RELEASE'] 
+#     source    'lib/ServiceFB/ServiceFB.bas'
+#     
+#     option    OPTIONS
+#   end
+#   
+#   project_task 'servicefb_utils' do
+#     lib       'ServiceFB_Utils'
+#     build_to  'lib'
+# 
+#     define    'SERVICEFB_DEBUG_LOG' unless ENV['RELEASE']
+#     source    'lib/ServiceFB/ServiceFB_Utils.bas'
+#     
+#     option    OPTIONS
+#   end
+# end
+# 
+# # add lib namespace to global tasks
+# #include_projects_of :lib
+# task :native_lib => "lib:build"
+# task :clean => "lib:clobber"
+# 
+# # mongrel_service (native)
+# namespace :native do
+#   project_task  'mongrel_service' do
+#     executable  'mongrel_service'
+#     build_to    'bin'
+#     
+#     define      'DEBUG_LOG' unless ENV['RELEASE']
+#     define      "GEM_VERSION=#{echoe_spec.version}"
+#     
+#     main        'native/mongrel_service.bas'
+#     source      'native/console_process.bas'
+#     
+#     lib_path    'lib'
+#     library     'ServiceFB', 'ServiceFB_Utils'
+#     library     'user32', 'advapi32', 'psapi'
+#     
+#     option      OPTIONS
+#   end
+# end
+# 
+# #include_projects_of :native
+# task :native_service => "native:build"
+# task :clean => "native:clobber"