mongrel_service 0.1 → 0.4.beta1

data/src/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/src/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/src/ServiceFB/_utils_internals.bi

@@ -0,0 +1,51 @@
+'#--
+'# 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_stop_mutex as any ptr
+    extern _svc_stopped as BOOL
+    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/src/mongrel_service/_debug.bi

@@ -0,0 +1,59 @@
+'##################################################################
+'# 
+'# mongrel_service: Win32 native implementation for mongrel
+'#                  (using ServiceFB and FreeBASIC)
+'# 
+'# Copyright (c) 2006 Multimedia systems
+'# (c) and code by Luis Lavena
+'# 
+'#  mongrel_service (native) and mongrel_service gem_pluing are licensed
+'#  in the same terms as mongrel, please review the mongrel license at
+'#  http://mongrel.rubyforge.org/license.html
+'#  
+'##################################################################
+
+'##################################################################
+'# Requirements:
+'# - FreeBASIC 0.17, Win32 CVS Build (as for November 09, 2006).
+'# 
+'##################################################################
+
+#ifndef __Debug_bi__
+#define __Debug_bi__
+
+#ifdef DEBUG_LOG
+    #include once "vbcompat.bi"
+    #ifndef DEBUG_LOG_FILE
+        #define DEBUG_LOG_FILE EXEPATH + "\debug.log"
+    #endif
+
+    '# this procedure is only used for debugging purposed, will be removed from
+    '# final compilation
+    private sub debug_to_file(byref message as string, byref file as string, byval linenumber as uinteger, byref func as string)
+        dim handle as integer
+        static first_time as integer
+        
+        handle = freefile
+        open DEBUG_LOG_FILE for append as #handle
+        
+        if (first_time = 0) then
+            print #handle, "# Logfile created on "; format(now(), "dd/mm/yyyy HH:mm:ss")
+            print #handle, ""
+            first_time = 1
+        end if
+        
+        '# src/module.bas:123, namespace.function:
+        '#   message
+        '#
+        print #handle, file; ":"; str(linenumber); ", "; lcase(func); ":"
+        print #handle, space(2); message
+        print #handle, ""
+        
+        close #handle
+    end sub
+    #define debug(message) debug_to_file(message, __FILE__, __LINE__, __FUNCTION__)
+#else
+    #define debug(message)
+#endif '# DEBUG_LOG
+
+#endif '# __Debug_bi__

data/src/mongrel_service/boolean.bi

@@ -0,0 +1,18 @@
+'#--
+'# Copyright (c) 2006-2007 Luis Lavena, Multimedia systems
+'#
+'# This source code is released under the MIT License.
+'# See MIT-LICENSE file for details
+'#++
+
+#ifndef __BOOLEAN_BI__
+#define __BOOLEAN_BI__
+
+#undef BOOLEAN
+type BOOLEAN as byte
+#undef FALSE
+const FALSE as byte = 0
+#undef TRUE
+const TRUE as byte = not FALSE
+
+#endif ' __BOOLEAN_BI__

data/src/mongrel_service/console_process.bas

@@ -0,0 +1,397 @@
+'#--
+'# Copyright (c) 2007 Luis Lavena, Multimedia systems
+'#
+'# This source code is released under the MIT License.
+'# See MIT-LICENSE file for details
+'#++
+
+#include once "console_process.bi"
+
+constructor ConsoleProcess(byref new_filename as string = "", byref new_arguments as string = "")
+    '# assign filename and arguments
+    
+    '# if filename contains spaces, automatically quote it!
+    if (instr(new_filename, " ") > 0) then
+        _filename = !"\"" + new_filename + !"\""
+    else
+        _filename = new_filename
+    endif
+    
+    _arguments = new_arguments
+end constructor
+
+destructor ConsoleProcess()
+    '# in case process still running
+    if (running = true) then
+        terminate(true)
+        
+        '# close opened handles
+        '# ...
+        CloseHandle(_process_info.hProcess)
+        CloseHandle(_process_info.hThread)
+    end if
+end destructor
+
+property ConsoleProcess.filename() as string
+    return _filename
+end property
+
+property ConsoleProcess.filename(byref rhs as string)
+    if not (running = true) then
+        _filename = rhs
+    end if
+end property
+
+property ConsoleProcess.arguments() as string
+    return _arguments
+end property
+
+property ConsoleProcess.arguments(byref rhs as string)
+    if not (running = true) then
+        _arguments = rhs
+    end if
+end property
+
+property ConsoleProcess.redirected_stdout() as string
+    return _stdout_filename
+end property
+
+property ConsoleProcess.redirected_stderr() as string
+    return _stderr_filename
+end property
+
+'# running is a helper which evaluates _pid and exit_code
+property ConsoleProcess.running() as boolean
+    dim result as boolean
+
+    '# presume not running
+    result = false
+    
+    if not (_pid = 0) then
+        '# that means the process is/was running.
+        '# now evaluate if exit_code = STILL_ACTIVE
+        result = (exit_code = STILL_ACTIVE)
+    end if
+    
+    return result
+end property
+
+property ConsoleProcess.pid() as uinteger
+    return _pid
+end property
+
+property ConsoleProcess.exit_code() as uinteger
+    static previous_code as uinteger
+    dim result as uinteger
+    
+    result = 0
+    
+    '# is _pid valid?
+    if not (_pid = 0) then
+        if not (_process_info.hProcess = NULL) then
+            '# the process reference is valid, get the exit_code
+            if not (GetExitCodeProcess(_process_info.hProcess, @result) = 0) then
+                previous_code = result
+                '# OK
+                '# no error in the query, get result
+                if not (result = STILL_ACTIVE) then
+                    CloseHandle(_process_info.hProcess)
+                    _process_info.hProcess = NULL
+                end if '# (result = STILL_ACTIVE)
+            end if '# not (GetExitCodeProcess() = 0)
+        else
+            result = previous_code
+        end if '# not (proc = NULL)
+    end if '# not (_pid = 0)
+    
+    return result
+end property
+
+function ConsoleProcess.redirect(byval target as ProcessStdEnum, byref new_std_filename as string) as boolean
+    dim result as boolean
+    
+    if not (running = true) then
+        select case target
+            case ProcessStdOut:
+                _stdout_filename = new_std_filename
+                result = true
+                
+            case ProcessStdErr:
+                _stderr_filename = new_std_filename
+                result = true
+                
+            case ProcessStdBoth:
+                _stdout_filename = new_std_filename
+                _stderr_filename = new_std_filename
+                result = true
+        
+        end select
+    end if
+    
+    return result
+end function
+
+function ConsoleProcess.start() as boolean
+    dim result as boolean
+    dim success as boolean
+    
+    '# API
+    '# New Process resources
+    dim context as STARTUPINFO
+    dim proc_sa as SECURITY_ATTRIBUTES = type(sizeof(SECURITY_ATTRIBUTES), NULL, TRUE)
+    
+    '# StdIn, StdOut, StdErr Read and Write Pipes.
+    dim as HANDLE StdInRd, StdOutRd, StdErrRd
+    dim as HANDLE StdInWr, StdOutWr, StdErrWr
+    dim merged as boolean
+    
+    '# cmdline
+    dim cmdline as string
+    
+    '# assume start will fail
+    result = false
+    
+    if (running = false) then
+        '# we should create the std* for the new proc!
+        '# (like good parents, prepare everything!)
+        
+        '# to ensure everything will work, we must allocate a console
+        '# using AllocConsole, even if it fails.
+        '# This solve the problems when running as service.
+        '# we discard result of AllocConsole since we ALWAYS will allocate it.
+        AllocConsole()
+        
+        '# assume all the following steps succeed
+        success = true
+        
+        '# StdIn is the only std that will be created using pipes always
+        '# StdIn
+        if (CreatePipe(@StdInRd, @StdInWr, @proc_sa, 0) = 0) then 
+            success = false
+        end if
+        
+        '# Ensure the handles to the pipe are not inherited.
+        if (SetHandleInformation(StdInWr, HANDLE_FLAG_INHERIT, 0) = 0) then
+            success = false
+        end if
+        
+        '# StdOut and StdErr should be redirected?
+        if (not _stdout_filename = "") or _
+            (not _stderr_filename = "") then
+            
+            '# out and err are the same? (merged)
+            if (_stdout_filename = _stderr_filename) then
+                merged = true
+            end if
+        end if
+        
+        '# StdOut if stdout_filename
+        if not (_stdout_filename = "") then
+            StdOutWr = CreateFile(strptr(_stdout_filename), _
+                                    GENERIC_WRITE, _
+                                    FILE_SHARE_READ or FILE_SHARE_WRITE, _
+                                    @proc_sa, _
+                                    OPEN_ALWAYS, _
+                                    FILE_ATTRIBUTE_NORMAL, _
+                                    NULL)
+            
+            if (StdOutWr = INVALID_HANDLE_VALUE) then
+                '# failed to open file
+                success = false
+            else
+                SetFilePointer(StdOutWr, 0, NULL, FILE_END)
+            end if
+        else
+            '# use pipes instead
+            '# StdOut
+            if (CreatePipe(@StdOutRd, @StdOutWr, @proc_sa, 0) = 0) then 
+                success = false
+            end if
+            
+            if (SetHandleInformation(StdOutRd, HANDLE_FLAG_INHERIT, 0) = 0) then
+                success = false
+            end if
+        end if 'not (_stdout_filename = "")
+        
+        '# only create stderr if no merged.
+        if (merged = true) then
+            StdErrWr = StdOutWr
+        else
+            '# do the same for StdErr...
+            if not (_stderr_filename = "") then
+                StdErrWr = CreateFile(strptr(_stderr_filename), _
+                                        GENERIC_WRITE, _
+                                        FILE_SHARE_READ or FILE_SHARE_WRITE, _
+                                        @proc_sa, _
+                                        OPEN_ALWAYS, _
+                                        FILE_ATTRIBUTE_NORMAL, _
+                                        NULL)
+                
+                if (StdErrWr = INVALID_HANDLE_VALUE) then
+                    '# failed to open file
+                    success = false
+                else
+                    SetFilePointer(StdErrWr, 0, NULL, FILE_END)
+                end if
+            else
+                '# use pipes instead
+                '# StdOut
+                if (CreatePipe(@StdErrRd, @StdErrWr, @proc_sa, 0) = 0) then
+                    success = false
+                end if
+                
+                if (SetHandleInformation(StdErrRd, HANDLE_FLAG_INHERIT, 0) = 0) then
+                    success = false
+                end if
+                
+            end if 'not (_stderr_filename = "")
+        end if '(merged = true)
+        
+        '# now we must proceed to create the process
+        '# without the pipes, we shouldn't continue!
+        if (success = true) then
+            '# Set the Std* handles ;-)
+            with context
+                .cb = sizeof( context )
+                .hStdError = StdErrWr
+                .hStdOutput = StdOutWr
+                .hStdInput = StdInRd
+                .dwFlags = STARTF_USESTDHANDLES or STARTF_USESHOWWINDOW
+                '# FIXME: .wShowWindow = iif((_show_console = true), SW_SHOW, SW_HIDE)
+                .wShowWindow = SW_HIDE
+            end with
+            
+            '# build the command line
+            cmdline = _filename + " " + _arguments
+            
+            '# now creates the process
+            if (CreateProcess(NULL, _
+                                strptr(cmdline), _
+                                NULL, _
+                                NULL, _
+                                1, _            '# win32 TRUE (1)
+                                0, _
+                                NULL, _
+                                NULL, _
+                                @context, _
+                                @_process_info) = 0) then
+                result = false
+            else
+                '# set the _pid
+                _pid = _process_info.dwProcessId
+                
+                '# OK? yeah, I think so.
+                result = true
+                
+                '# close the Std* handles
+                CloseHandle(StdInRd)
+                CloseHandle(StdInWr)
+                CloseHandle(StdOutRd)
+                CloseHandle(StdOutWr)
+                CloseHandle(StdErrRd)
+                CloseHandle(StdErrWr)
+                
+                '# close children main Thread handle and
+                '# NULLify to avoid issues
+                CloseHandle(_process_info.hThread)
+                _process_info.hThread = NULL
+            end if '# (CreateProcess() = 0)
+        else
+            result = false
+        end if '# (success = TRUE)
+    end if
+    
+    return result
+end function
+
+function ConsoleProcess.terminate(byval force as boolean = false) as boolean
+    dim result as boolean
+    dim success as boolean
+    
+    dim proc as HANDLE
+    dim code as uinteger
+    dim wait_code as uinteger
+    
+    '# is pid valid?
+    if (running = true) then
+        '# hook our custom console handler
+        if not (SetConsoleCtrlHandler(@_console_handler, 1) = 0) then
+            success = true
+        end if
+        
+        if (success = true) then
+            '# get a handle to Process
+            proc = _process_info.hProcess
+            if not (proc = NULL) then
+                '# process is valid, perform actions
+                success = false
+                
+                if not (force = true) then
+                    '# send CTRL_C_EVENT and wait for result
+                    if not (GenerateConsoleCtrlEvent(CTRL_C_EVENT, 0) = 0) then
+                        '# it worked, wait 5 seconds terminates.
+                        wait_code = WaitForSingleObject(proc, 10000)
+                        if not (wait_code = WAIT_TIMEOUT) then
+                            success = true
+                        end if
+                    else
+                        success = false
+                    end if
+                    
+                    '# Ctrl-C didn't work, try Ctrl-Break
+                    if (success = false) then
+                        '# send CTRL_BREAK_EVENT and wait for result
+                        if not (GenerateConsoleCtrlEvent(CTRL_BREAK_EVENT, 0) = 0) then
+                            '# it worked, wait 5 seconds terminates.
+                            wait_code = WaitForSingleObject(proc, 10000) 
+                            if not (wait_code = WAIT_TIMEOUT) then
+                                success = true
+                            end if
+                        else
+                            success = false
+                        end if
+                    end if
+                    
+                '# only do termination if force was set.
+                elseif (force = true) and (success = false) then
+                    '# still no luck? we should do a hard kill then
+                    if (TerminateProcess(proc, 0) = 0) then
+                        success = false
+                    else
+                        success = true
+                    end if
+                end if
+                
+                '# now get process exit code
+                if (success = true) then
+                    result = true
+                else
+                    result = false
+                end if
+            else
+                '# invalid process handler
+                result = false
+            end if
+            
+        end if '# (success = true)
+        
+        '# remove hooks
+        if not (SetConsoleCtrlHandler(@_console_handler, 0) = 0) then
+            success = true
+        end if
+    end if '# not (pid = 0)
+    
+    return result
+end function
+
+function ConsoleProcess._console_handler(byval dwCtrlType as DWORD) as BOOL
+    dim result as BOOL
+    
+    if (dwCtrlType = CTRL_C_EVENT) then
+        result = 1
+    elseif (dwCtrlType = CTRL_BREAK_EVENT) then
+        result = 1
+    end if
+    
+    return result
+end function