mod_spox 0.1.0.1 → 0.2.0

data/data/mod_spox/plugins/PluginLoader.rb

@@ -16,7 +16,7 @@ class PluginLoader < ModSpox::Plugin
         @pipeline.hook(self, :get_module, :Internal_PluginModuleResponse)
         @plugins_mod = nil
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: matching signature params
     # Output currently available plugins for loading
@@ -27,7 +27,7 @@ class PluginLoader < ModSpox::Plugin
         end
         reply message.replyto, output
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: matching signature params
     # Output currently loaded plugins
@@ -39,32 +39,32 @@ class PluginLoader < ModSpox::Plugin
     # Load the given plugin
     def load_plugin(message, params)
         plugins = find_plugins
-        if(plugins.has_key?(params[:plugin]))
-            name = plugin_discovery(BotConfig[:pluginextraspath]).keys.include?(params[:plugin]) ? nil : "#{params[:plugin]}.rb"
-            @pipeline << Messages::Internal::PluginLoadRequest.new(self, plugins[params[:plugin]], name)
+        if(plugins.has_key?(params[:plugin].to_sym))
+            name = plugin_discovery(BotConfig[:pluginextraspath]).keys.include?(params[:plugin].to_sym) ? nil : "#{params[:plugin]}.rb"
+            @pipeline << Messages::Internal::PluginLoadRequest.new(self, plugins[params[:plugin].to_sym], name)
             @pipeline << Messages::Outgoing::Privmsg.new(message.replyto, "Okay")
         else
             @pipeline << Messages::Outgoing::Privmsg.new(message.replyto, "Failed to find plugin: #{params[:plugin]}")
         end
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: matching signature params
     # Unload the given plugin
     def unload_plugin(message, params)
-        path = loaded_path(params[:plugin])
+        path = loaded_path(params[:plugin].to_sym)
         unless(path.nil?)
-            name = plugin_discovery(BotConfig[:pluginextraspath]).keys.include?(params[:plugin]) ? nil : ".#{params[:plugin]}.rb"
+            name = plugin_discovery(BotConfig[:pluginextraspath]).keys.include?(params[:plugin].to_sym) ? nil : ".#{params[:plugin]}.rb"
             @pipeline << Messages::Internal::PluginUnloadRequest.new(self, path, name)
             @pipeline << Messages::Outgoing::Privmsg.new(message.replyto, "Okay")
         else
             @pipeline << Messages::Outgoing::Privmsg.new(message.replyto, "Failed to find loaded plugin named: #{params[:plugin]}")
         end
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: matching signature params
-    # Reloads plugins    
+    # Reloads plugins
     def reload_plugin(message, params)
         if(params[:plugin])
             users = plugin_discovery(BotConfig[:userpluginpath])
@@ -84,15 +84,34 @@ class PluginLoader < ModSpox::Plugin
             @pipeline << Messages::Outgoing::Privmsg.new(message.replyto, 'Full plugin reload requested')
         end
     end
-    
+
     # message:: ModSpox::Messages::Internal::PluginModuleResponse
     # Receives the plugins module
     def get_module(message)
         @plugins_mod = message.module
     end
 
+    # Upgrades extra plugins to latest version
+    def extras_upgrade
+        Logger.info("Starting plugin upgrade to current version: #{$BOTVERSION}")
+        extras = plugin_discovery(BotConfig[:pluginextraspath])
+        pl = plugin_list
+        extras.keys.each{|d| extras.delete(d) unless pl.include?(d)}
+        extras.keys.each do |plugin|
+            path = loaded_path(plugin)
+            @pipeline << Messages::Internal::PluginUnloadRequest.new(self, path, plugin)
+        end
+        Logger.info('Waiting for plugins to complete unloading...')
+        sleep(3)
+        Logger.info('Loading active plugins back into the bot')
+        extras.each do |name, path|
+            @pipeline << Messages::Internal::PluginLoadRequest.new(self, path)
+        end
+        Logger.info("Plugin upgrade is now complete. Upgraded to version: #{$BOTVERSION}")
+    end
+
     private
-    
+
     # Returns the list of currently loaded plugins
     def plugin_list
         plug = []
@@ -107,7 +126,7 @@ class PluginLoader < ModSpox::Plugin
         @plugins_mod = nil
         return plug
     end
-    
+
     # Finds available plugins for loading
     def find_plugins
         users = plugin_discovery(BotConfig[:userpluginpath])
@@ -118,7 +137,7 @@ class PluginLoader < ModSpox::Plugin
         end
         return plugins
     end
-    
+
     # path:: path to directory
     # Discovers any plugins within the files in the given path
     def plugin_discovery(path)
@@ -130,24 +149,29 @@ class PluginLoader < ModSpox::Plugin
                 sandbox.module_eval(IO.readlines("#{path}/#{file}").join("\n"))
                 sandbox.constants.each do |const|
                     klass = sandbox.const_get(const)
-                    plugins[const] = "#{path}/#{file}" if klass < Plugin
+                    plugins[const.to_sym] = "#{path}/#{file}" if klass < Plugin
                 end
             rescue Object => boom
-                Logger.log("Failed to parse file: #{path}/#{file}. Reason: #{boom}")
+                Logger.warn("Failed to parse file: #{path}/#{file}. Reason: #{boom}\n#{boom.backtrace.join("\n")}")
+                next
             end
         end
         return plugins
     end
-    
+
     # name:: plugin name
     # Returns the file path the given plugin originated from
     def loaded_path(name)
         Dir.new(BotConfig[:userpluginpath]).each do |file|
-            next unless file =~ /\.rb$/
-            sandbox = Module.new
-            sandbox.module_eval(IO.readlines("#{BotConfig[:userpluginpath]}/#{file}").join("\n"))
-            sandbox.constants.each do |const|
-                return "#{BotConfig[:userpluginpath]}/#{file}" if const == name
+            begin
+                next unless file =~ /\.rb$/
+                sandbox = Module.new
+                sandbox.module_eval(IO.readlines("#{BotConfig[:userpluginpath]}/#{file}").join("\n"))
+                sandbox.constants.each do |const|
+                    return "#{BotConfig[:userpluginpath]}/#{file}" if const == name
+                end
+            rescue Object => boom
+                Logger.warn("Failed to load file: #{file}. Reason: #{boom}")
             end
         end
         return nil

data/data/mod_spox/plugins/PoolConfig.rb

@@ -0,0 +1,52 @@
+class PoolConfig < ModSpox::Plugin
+
+    def initialize(args)
+        super
+        group = Group.find_or_create(:name => 'admin')
+        add_sig(:sig => 'pool max workers(\s(\d+))?', :method => :max_workers, :group => group,
+                :desc => 'Show/set max number of worker threads', :params => [:max])
+        add_sig(:sig => 'pool worker timeout(\s(\d+))?', :method => :max_timeout, :group => group,
+                :desc => 'Show/set max worker timeout', :params => [:max])
+        add_sig(:sig => 'pool workers total', :method => :workers_total, :group => group,
+                :desc => 'Show current number of workers in pool')
+    end
+
+    def max_workers(message, params)
+        if(params[:max].nil?)
+            reply message.replyto, "Maximum number of worker threads allowed in pool: #{Pool.workers_max}"
+        else
+            params[:max] = params[:max].strip.to_i
+            if(params[:max] > 0)
+                config = Config.find_or_create(:name => 'pool_workers_min')
+                config.value = params[:max]
+                config.save
+                Pool.workers_max = params[:max]
+                reply message.replyto, "\2Thread Pool Update:\2 Number of worker threads updated to: #{params[:max]}"
+            else
+                reply message.replyto, "\2Error:\2 You must have at least one worker thread"
+            end
+        end
+    end
+
+    def max_timeout(message, params)
+        if(params[:max].nil?)
+            reply message.replyto, "Maximum number of seconds threads allowed per task: #{Pool.worker_timeout == 0 ? 'no limit' : Pool.worker_timeout}"
+        else
+            params[:max] = params[:max].strip.to_i
+            if(params[:max] >= 0)
+                config = Config.find_or_create(:name => 'pool_timeout')
+                config.value = params[:max]
+                config.save
+                Pool.worker_timeout = params[:max]
+                reply message.replyto, "\2Thread Pool Update:\2 Worker processing timeout updated to: #{params[:max]} seconds"
+            else
+                reply message.replyto, "\2Error:\2 Threads are not able to finish executing before they start"
+            end
+        end
+    end
+
+    def workers_total(message, params)
+        reply message.replyto, "Current number of worker threads in pool: #{Pool.workers}"
+    end
+
+end

data/data/mod_spox/plugins/Quitter.rb

@@ -2,7 +2,7 @@ class Quitter < ModSpox::Plugin
 
     def initialize(pipeline)
         super(pipeline)
-        Models::Signature.find_or_create(:signature => 'quit\s(.*)', :plugin => name, :method => 'quit',
+        Models::Signature.find_or_create(:signature => 'quit(\s.+)?', :plugin => name, :method => 'quit',
             :group_id => Models::Group.filter(:name => 'admin').first.pk).params = [:channel, :message]
     end
 

data/data/mod_spox/plugins/Status.rb

@@ -0,0 +1,28 @@
+class Status < ModSpox::Plugin
+
+    def initialize(pipeline)
+        super
+        add_sig(:sig => 'status', :method => :status, :desc => 'Show current status')
+        add_sig(:sig => 'version', :method => :version, :desc => 'Show version information')
+        @pipeline.hook(self, :get_status, :Internal_StatusResponse)
+        @resp = []
+    end
+    
+    def status(m, pa)
+        @resp << m.replyto
+        @pipeline << Messages::Internal::StatusRequest.new(self)
+    end
+    
+    def version(message, params)
+        reply message.replyto, "mod_spox IRC bot - Version: \2#{$BOTVERSION}\2 (#{$BOTCODENAME}) [http://modspox.rubyforge.org]"
+    end
+    
+    def get_status(m)
+        @resp.uniq!
+        @resp.each do |c|
+            reply c, "\2Status:\2 \2Uptime:\2 #{m.status[:uptime]} \2Plugins:\2 #{m.status[:plugins]} loaded \2Lines sent:\2 #{m.status[:sent]} \2Lines Received:\2 #{m.status[:received]}"            
+            @resp.delete(c)
+        end
+    end
+
+end

data/lib/mod_spox/Action.rb

@@ -19,12 +19,30 @@ module ModSpox
             @timer = timer
             @completed = false
             @wait_remaining = @period
+            @owner = nil
+        end
+        
+        def owner=(o)
+            unless(o.is_a?(Symbol))
+                if(o.is_a?(ModSpox::Plugin))
+                    o = o.name.to_sym
+                else
+                    raise Exceptions::BotException.new('Unsupported type given for owner')
+                end
+            end
+            @owner = o
+        end
+        
+        def owner
+            @owner
         end
         
         # amount:: number of seconds passed
         # Decrement wait time by given number of seconds
         def tick(amount)
-            @wait_remaining = @wait_remaining - amount
+            @wait_remaining = @wait_remaining - amount if @wait_remaining > 0
+            @wait_remaining = 0 if @wait_remaining < 0
+            @completed = true if @once && @wait_remaining <= 0
         end
         
         # Returns true if action is due to run
@@ -66,9 +84,8 @@ module ModSpox
                     @func.call
                 end
             rescue Object => boom
-                Logger.log("Action generated an exception during run: #{boom}\n#{boom.backtrace.join("\n")}", 10)
+                Logger.warn("Action generated an exception during run: #{boom}\n#{boom.backtrace.join("\n")}")
             end
-            @completed = true if @once
         end
     end
 

data/lib/mod_spox/BaseConfig.rb

@@ -23,6 +23,7 @@ module ModSpox
         def []=(key, value)
             key = key.to_sym unless key.is_a?(Symbol)
             @config[key] = value
+            write_configuration
         end
         
         # Parses the configuration file into a usable Hash