mod_spox 0.0.4 → 0.0.5

data/CHANGELOG

@@ -1,3 +1,19 @@
+0.0.5 Release (Alpha status)
+    * Added new RAW message type for outgoing messages
+    * Ability to load/unload/reload individual plugins
+    * Plugins that fail to load are completely removed 
+    * memcache support
+    * PluginHolder introduced to reduce instances of stale plugins
+    * Faster signature matching
+    * Updated threading for better performance
+    * Removed Base64 dependency
+    * Ban exemptions available
+    * New AutoMode plugin
+    * Fixed connection monitoring
+    * Removed lazying loading of classes/modules
+    * Output bursting is now working properly
+    * Added multiline support in Privmsgs to allow ordered output
+
 0.0.4 Release (Alpha status)
     * Signatures now encoded when stored
     * SQLite lockup fixed on new version of sequel

data/INSTALL

@@ -9,4 +9,7 @@ Requirements include:
     
 Optional:
     * fastthread
-    * termios
+    * termios
+    
+More detailed information can be found at:
+http://dev.modspox.com/cgi-bin/trac.cgi/wiki/InstallHowto

data/bin/mod_spox

@@ -18,7 +18,7 @@ rescue Object => boom
     # ignore if not found #
 end
 
-$BOTVERSION='0.0.4'
+$BOTVERSION='0.0.5'
 $VERBOSITY = 0
 $MOD_SPOX_PATH = nil
 
@@ -66,5 +66,7 @@ opts.each do |opt, arg|
 end
 
 initialize_bot
+require 'mod_spox/Bot'
+
 bot = Bot.new
 bot.run

data/data/mod_spox/extras/AOLSpeak.rb

@@ -28,9 +28,9 @@ class AOLSpeak < ModSpox::Plugin
         else
             channel = message.target
         end
-        nick = Models::Nick.filter(:nick => params[:nick]).first
+        nick = Helpers.find_model(params[:nick], false)
         if(channel && nick)
-            @banner.ban(nick, channel, 60, @aolspeak[rand(@aolspeak.size) - 1], invite=false, show_time=false)
+            @banner.plugin.ban(nick, channel, 60, @aolspeak[rand(@aolspeak.size) - 1], invite=false, show_time=false)
         else
             reply message.replyto, "\2Error:\2 Failed to find channel: #{params[:channel]}" unless channel
             reply message.replyto, "\2Error:\2 Failed to find nick: #{params[:nick]}" unless nick

data/data/mod_spox/extras/AutoKick.rb

@@ -34,17 +34,12 @@ class AutoKick < ModSpox::Plugin
     
     def add(message, params)
         if(params[:channel])
-            channel = Channel.filter(:name => params[:channel])
+            channel = Channel.filter(:name => params[:channel]).first
         else
             channel = message.target
         end
         if(channel)
-            record = AutoKickRecord.new
-            record.channel_id = channel.pk
-            record.pattern = params[:regex]
-            record.message = params[:message]
-            record.bantime = params[:time]
-            record.save
+            record = AutoKickRecord.find_or_create(:pattern => params[:regex], :message => params[:message], :bantime => params[:time].to_i, :channel_id => channel.pk)
             reply message.replyto, "New autokick rule has been created"
             do_listen
         else
@@ -69,7 +64,7 @@ class AutoKick < ModSpox::Plugin
                 reg = Regexp.new(pattern)
                 unless(reg.match(message.message).nil?)
                     record = AutoKickRecord.filter(:pattern => pattern).first
-                    @banner.ban(message.source, message.target, record.bantime, record.message, invite=false, show_time=true)
+                    @banner.plugin.ban(message.source, message.target, record.bantime, record.message, invite=false, show_time=true)
                 end
             end 
         end

data/data/mod_spox/extras/AutoMode.rb

@@ -0,0 +1,135 @@
+class AutoMode < ModSpox::Plugin
+    
+    include Models
+    
+    def initialize(pipeline)
+        super
+        @admin = Group.find_or_create(:name => 'moder')
+        @user = Group.find_or_create(:name => 'modee')
+        Signature.find_or_create(:signature => 'addop (\S+)', :plugin => name, :method => 'addop', :group_id => @admin.pk,
+            :description => 'Add a nick to the auto op list', :requirement => 'public').params = [:nick]
+        Signature.find_or_create(:signature => 'addvoice (\S+)', :plugin => name, :method => 'addvoice', :group_id => @admin.pk,
+            :description => 'Add a nick to the auto voice list', :requirement => 'public').params = [:nick]
+        Signature.find_or_create(:signature => 'op', :plugin => name, :method => 'op', :group_id => @user.pk,
+            :description => 'Instruct bot to give you operator status', :requirement => 'public')
+        Signature.find_or_create(:signature => 'voice', :plugin => name, :method => 'voice', :group_id => @user.pk,
+            :description => 'Instruct bot to give you voice status', :requirement => 'public')
+        Signature.find_or_create(:signature => 'automode list (\S+)', :plugin => name, :method => 'list', :group_id => @admin.pk,
+            :description => 'Show list of current auto-modes for channel').params = [:channel]
+        Signature.find_or_create(:signature => 'delmode (\S+)', :plugin => name, :method => 'remove', :group_id => @admin.pk,
+            :description => 'Remove nick from any auto-modes in channel', :requirement => 'public').params = [:nick]
+        ModeRecord.create_table unless ModeRecord.table_exists?
+        @pipeline.hook(self, :check_join, :Incoming_Join)
+    end
+    
+    def addop(m, p)
+        nick = Helpers.find_model(p[:nick], false)
+        if(nick.is_a?(Nick))
+            ModeRecord.find_or_create(:nick_id => nick.pk, :channel_id => m.target.pk, :voice => false)
+            add_modee(nick)
+            reply m.replyto, "#{nick.nick} has been added to the auto-op list"
+        else
+            reply m.replyto, "\2Error:\2 Failed to find record of: #{p[:nick]}"
+        end
+    end
+    
+    def addvoice(m, p)
+        nick = Helpers.find_model(p[:nick], false)
+        if(nick.is_a?(Nick))
+            ModeRecord.find_or_create(:nick_id => nick.pk, :channel_id => m.target.pk, :voice => true)
+            add_modee(nick)
+            reply m.replyto, "#{nick.nick} has been added to the auto-voice list"
+        else
+            reply m.replyto, "\2Error:\2 Failed to find record of: #{p[:nick]}"
+        end
+    end
+    
+    def op(m, p)
+        record = ModeRecord.filter(:nick_id => m.source.pk, :channel_id => m.target.pk).first
+        if(record && !record.voice)
+            @pipeline << Messages::Outgoing::ChannelMode.new(m.target, '+o', m.source.nick) if me.is_op?(m.target)
+        else
+            reply m.replyto, "\2Error:\2 You are not listed on the auto-op list"
+        end
+    end
+    
+    def voice(m, p)
+        record = ModeRecord.filter(:nick_id => m.source.pk, :channel_id => m.target.pk).first
+        if(record && record.voice)
+            @pipeline << Messages::Outgoing::ChannelMode.new(m.target, '+v', m.source.nick) if me.is_op?(m.target)
+        else
+            reply m.replyto, "\2Error:\2 You are not listed on the auto-voice list"
+        end
+    end
+    
+    def list(m, p)
+        channel = Helpers.find_model(p[:channel], false)
+        if(channel.is_a?(Channel))
+            records = ModeRecord.filter(:channel_id => channel.pk)
+            if(records.size > 0)
+                reply m.replyto, "\2Auto-Mode Listing:\2"
+                sleep(0.01)
+                records.each do |record|
+                    reply m.replyto, "#{record.nick.nick} \2->\2 #{record.voice == false ? "op" : "voice"}"
+                end
+            else
+                reply m.replyto, "\2Warning:\2 No users found in auto-mode list"
+            end
+        else
+            reply m.replyto, "\2Error:\2 Failed to find channel: #{p[:channel]}"
+        end
+    end
+    
+    def remove(m, p)
+        nick = Helpers.find_model(p[:nick], false)
+        if(nick.is_a?(Nick))
+            ModeRecord.filter(:channel_id => m.target.pk, :nick_id => nick.pk).destroy
+            remove_modee(nick)
+            reply m.replyto, "All auto-modes for user: #{p[:nick]} have been removed"
+        else
+            reply m.replyto, "\2Error:\2 Failed to find nick: #{p[:nick]}"
+        end
+    end
+    
+    def check_join(m)
+        return unless me.is_op?(m.channel)
+        matches = ModeRecord.filter(:nick_id => m.nick.pk, :channel_id => m.channel.pk)
+        if(matches.size > 0)
+            matches.each do |record|
+                mode = record.voice ? '+v' : '+o'
+                @pipeline << Messages::Outgoing::ChannelMode.new(m.channel, mode, m.nick.nick)
+            end
+        end
+    end
+    
+    def add_modee(nick)
+        modee = Group.find_or_create(:name => 'modee')
+        nick.group = modee
+    end
+    
+    def remove_modee(nick)
+        modee = Group.find_or_create(:name => 'modee')
+        if(ModeRecord.filter(:nick_id => nick.pk).size < 1)
+            nick.remove_group(modee)
+        end
+    end
+    
+    class ModeRecord < Sequel::Model
+        set_schema do
+            primary_key :id
+            boolean :voice, :null => false, :default => true
+            foreign_key :nick_id, :table => :nicks, :null => false
+            foreign_key :channel_id, :table => :channels, :null => false
+            index [:nick_id, :channel_id, :voice], :unique => true
+        end
+        
+        def channel
+            ModSpox::Models::Channel[channel_id]
+        end
+        
+        def nick
+            ModSpox::Models::Nick[nick_id]
+        end
+    end
+    
+end

data/data/mod_spox/extras/EightBall.rb

@@ -25,6 +25,7 @@ class EightBall < ModSpox::Plugin
     
     def eightball(message, params)
         @pipeline << Messages::Outgoing::Privmsg.new(message.replyto, 'shakes magic 8 ball...', true)
+        sleep(1)
         reply message.replyto, "#{message.source.nick}: #{@responses[rand(@responses.size) - 1]}"
     end
 

data/data/mod_spox/extras/Headers.rb

@@ -36,11 +36,12 @@ class Headers < ModSpox::Plugin
                 con = Net::HTTP.new(location, port)
                 con.use_ssl = secure
                 response = con.get(page, nil)
-                reply message.replyto, "Response code: #{response.code}"
+                output = ["Response code: #{response.code}"]
                 response.each{|key,val|
-                    reply message.replyto, "#{key}: #{val}"
+                    output << "#{key}: #{val}"
                 }
-                reply message.replyto, "Header listing complete"
+                output << "Header listing complete"
+                reply message.replyto, output
             rescue Object => boom
                 reply message.replyto, "Error retrieving headers: #{boom}"
             end

data/data/mod_spox/extras/PhpFuncLookup.rb

@@ -190,11 +190,12 @@ class PhpFuncLookup < ModSpox::Plugin
             desc.gsub!(/[\r\n]/, ' ')
             desc.gsub!(/<.+?>/, ' ')
             desc = CGI::unescapeHTML(desc.gsub(/\s+/, ' '))
-            reply m.replyto, "\2PHP Superglobal\2"
-            reply m.replyto, "\2#{name}:\2 #{desc}"
+            output = ["\2PHP Superglobal\2"]
+            output << "\2#{name}:\2 #{desc}"
         else
-            reply m.replyto, "No superglobal found matching: #{name}"
+            output = "No superglobal found matching: #{name}"
         end
+        reply m.replyto, output
     end
     
     def parse_wildcard(m, name)
@@ -218,8 +219,9 @@ class PhpFuncLookup < ModSpox::Plugin
             end
         end
         matches.sort!
-        reply m.replyto, "Lots of matching functions. Truncating list to 20 results."
-        reply m.replyto, matches.values_at(0..19).join(', ')
+        output = ["Lots of matching functions. Truncating list to 20 results."]
+        output << matches.values_at(0..19).join(', ')
+        reply m.replyto, output
     end
     
     def parse_function(m, name, filename)
@@ -231,19 +233,20 @@ class PhpFuncLookup < ModSpox::Plugin
         versions = CGI::unescapeHTML(versions)
         proto = CGI::unescapeHTML(proto.gsub(/<.+?>/, ' ').gsub(/[\s]+/, ' '))
         desc = CGI::unescapeHTML(desc.gsub(/<.+?>/, ' ').gsub(/[\s]+/, ' '))
-        reply m.replyto, versions
-        reply m.replyto, "\2#{proto}\2"
-        reply m.replyto, desc
-        reply m.replyto, "http://www.php.net/manual/en/#{filename.gsub(/\.html$/, '.php')}"
+        output = [versions]
+        output << "\2#{proto}\2"
+        output << desc
+        output << "http://www.php.net/manual/en/#{filename.gsub(/\.html$/, '.php')}"
+        reply m.replyto, output
     end
 
     def parse_operator(m, name)
         Logger.log "parse_operator name=#{name}"
         name.downcase!
         type, title, ejemplo = @ops[name]
-        reply m.replyto, "\2#{name}\2 is the \2#{title.to_a.join("\2 or \2")}\2 operator"
+        output = ["\2#{name}\2 is the \2#{title.to_a.join("\2 or \2")}\2 operator"]
         type.to_a.each do |t|
-            reply m.replyto, "http://php.net/manual/en/language.operators.#{t}.php"
+            output << "http://php.net/manual/en/language.operators.#{t}.php"
         end
     end
     

data/data/mod_spox/extras/Roulette.rb

@@ -61,7 +61,7 @@ class Roulette < ModSpox::Plugin
     def shoot(message, params)
         return unless message.is_public?
         cur_game = game(message.target)
-        nick = Nick.filter(:nick => params[:nick])
+        nick = Helpers.find_model(params[:nick], false)
         if(cur_game.shots == 1 && nick && Info.filter(:game_id => cur_game.pk, :nick_id => nick.pk))
             do_shot(nick, message.target)
         else
@@ -96,7 +96,7 @@ class Roulette < ModSpox::Plugin
     def stats(message, params)
         return unless message.is_public?
         if(params[:nick])
-            nick = Nick.filter(:nick => params[:nick]).first
+            nick =  Helpers.find_model(params[:nick], false)
             unless(nick)
                 reply(message.replyto, "\2Error:\2 Failed to find record of #{params[:nick]}")
                 return
@@ -183,7 +183,7 @@ class Roulette < ModSpox::Plugin
     def kill_nick(nick, channel)
         unless(@banner.nil?)
             begin
-                @banner.ban(nick, channel, 30, '*BANG*', true, false)
+                @banner.plugin.ban(nick, channel, 30, '*BANG*', true, false)
             rescue Banner::NotOperator => boom
                 reply(channel, "#{nick.nick}: *BANG*")
             rescue Object => boom

data/data/mod_spox/extras/Search.rb

@@ -22,10 +22,11 @@ class Search < ModSpox::Plugin
                 title = CGI::unescapeHTML(title)
                 results.push [title, url]
             end
-            @pipeline << Privmsg.new(message.replyto, "Search results for \2#{params[:terms]}:\2")
+            output = ["Search results for \2#{params[:terms]}:\2"]
             results.slice(0, limit).each do |title, url|
-                @pipeline << Privmsg.new(message.replyto, "#{title} -> #{Helpers.tinyurl(url)} [#{url.scan(/^http:\/\/.+?\//)[0]}]")
+                output << "#{title} -> #{Helpers.tinyurl(url)} [#{url.scan(/^http:\/\/.+?\//)[0]}]"
             end
+            reply message.replyto, output
         rescue Object => boom
             @pipeline << Privmsg.new(message.replyto, "Failed to find any results for: #{params[:terms]} Reason: #{boom}")
         end

data/data/mod_spox/extras/Talk.rb

@@ -22,20 +22,12 @@ class Talk < ModSpox::Plugin
     private
     
     def send_p(message, params, action=false)
-        target = find_target(params[:target])
+        target = Helpers.find_model(params[:target], false)
         if(target.nil?)
             reply message.replyto, "\2Error:\2 Failed to locate target: #{params[:target]}"
         else
             @pipeline << Messages::Outgoing::Privmsg.new(target, params[:text], action)
         end
     end
-    
-    def find_target(string)
-        result = Channel.filter(:name => string).first
-        return result if result
-        result = Nick.filter(:nick => string).first
-        return result if result
-        return nil
-    end
 
 end

data/data/mod_spox/extras/Translate.rb

@@ -16,7 +16,7 @@ class Translate < ModSpox::Plugin
     
     def auto_add(message, params)
         return unless message.is_public?
-        nick = Nick.filter(:nick => params[:nick]).first
+        nick = Helpers.find_model(params[:nick], false)
         if(nick && nick.channels.include?(message.target))
             @watchers[message.target.pk] = {} unless @watchers.has_key?(message.target.pk)
             @watchers[message.target.pk][nick.pk] = params[:lang] unless @watchers[message.target.pk].has_key?(nick.pk)
@@ -29,7 +29,7 @@ class Translate < ModSpox::Plugin
     
     def auto_remove(message, params)
         return unless message.is_public?
-        nick = Nick.filter(:nick => params[:nick]).first
+        nick = Helpers.find_model(params[:nick], false)
         if(nick)
             if(@watchers.has_key?(message.target.pk))
                 @watchers[message.target.pk].delete(nick.pk) if @watchers[message.target.pk].has_key?(nick.pk)
@@ -54,7 +54,7 @@ class Translate < ModSpox::Plugin
                 reply message.replyto, "\2Translation (#{message.source.nick}):\2 #{do_translation("#{@watchers[message.target.pk][message.source.pk]}en", message.message)}"
             elsif(message.message =~ /^(\S+)[:,]/)
                 Logger.log("Matched a nick: #{$1}")
-                nick = Nick.filter(:nick => $1).first
+                nick = Helpers.find_model($1, false)
                 return unless nick
                 if(@watchers[message.target.pk].has_key?(nick.pk))
                     reply message.replyto, "\2(#{do_translation("en|#{@watchers[message.target.pk][nick.pk]}", 'translation')})\2 #{do_translation("en|#{@watchers[message.target.pk][nick.pk]}", message.message)}"

data/data/mod_spox/extras/UrbanDictionary.rb

@@ -22,14 +22,16 @@ class UrbanDictionary < ModSpox::Plugin
                 udict = SOAP::RPC::Driver.new(site, 'urn:UrbanSearch')
                 udict.add_method('lookup', 'key', 'term')
                 defs = udict.lookup(key, params[:term])
+                output = []
                 if defs.size < result + 1
                     @pipeline << Privmsg.new(message.replyto, "Error: Definition number #{result+1} for term: #{params[:term]} not found.")
                 else
                     defin = defs[result].definition.length > 500 ? defs[result].definition.slice(0..500) + " *[CUT]*" : defs[result].definition
                     exp = defs[result].example.length > 500 ? defs[result].example.slice(0..500) + " *[CUT]*" : defs[result].example
-                    @pipeline << Privmsg.new(message.replyto, "Definition for \2#{defs[result].word}:\2")
-                    @pipeline << Privmsg.new(message.replyto, defin)
-                    @pipeline << Privmsg.new(message.replyto, "\2Example usage:\2 #{exp}") if exp.length > 0
+                    output << ["Definition for \2#{defs[result].word}:\2"]
+                    output << defin
+                    output << "\2Example usage:\2 #{exp}" if exp.length > 0
+                    reply message.replyto, output
                 end
             rescue Timeout::Error
                 @pipeline << Privmsg.new(message.replyto, "Failed to establish connection to server.")

data/data/mod_spox/extras/Weather.rb

@@ -40,10 +40,11 @@ class Weather < ModSpox::Plugin
                     end
                     i += 1
                 end
-                reply message.replyto, "Weather for: \2#{location}\2"
-                reply message.replyto, "Current Temp: #{curtemp} - Feels like: #{feeltemp}"
-                reply message.replyto, "[UV Index: #{uv.gsub(/&.+?;/, '')}][Wind: #{wind.gsub(/&.+?;/, '')}][Humiditiy: #{humid.gsub(/&.+?;/, '')}][Pressure: #{pressure.gsub(/&.+?;/, '')}][Dew Point: #{dewpoint.gsub(/&.+?;/, '')}][Visibility: #{visibility.gsub(/&.+?;/, '')}]"
-                reply message.replyto, future.values_at(0..2).join(' ')
+                output = ["Weather for: \2#{location}\2"]
+                output << "Current Temp: #{curtemp} - Feels like: #{feeltemp}"
+                output << "[UV Index: #{uv.gsub(/&.+?;/, '')}][Wind: #{wind.gsub(/&.+?;/, '')}][Humiditiy: #{humid.gsub(/&.+?;/, '')}][Pressure: #{pressure.gsub(/&.+?;/, '')}][Dew Point: #{dewpoint.gsub(/&.+?;/, '')}][Visibility: #{visibility.gsub(/&.+?;/, '')}]"
+                output << future.values_at(0..2).join(' ')
+                reply message.replyto, output
             else
                 reply message.replyto, "Failed to retrieve weather data."
             end

data/data/mod_spox/plugins/Authenticator.rb

@@ -159,7 +159,7 @@ class Authenticator < ModSpox::Plugin
     # params:: Signature parameters
     # Display info for given nick
     def nick_info(message, params)
-        nick = Models::Nick.filter(:nick => params[:nick]).first
+        nick = Helpers.find_model(params[:nick], false)
         if(nick)
             info = []
             info << "\2INFO [#{nick.nick}]:\2"
@@ -204,7 +204,7 @@ class Authenticator < ModSpox::Plugin
     # Remove given nick from authenticationg group
     def unset_nick(message, params)
         group = Models::Group.filter(:name => params[:group]).first
-        nick = Models::Nick.filter(:nick => params[:nick]).first
+        nick = Helpers.find_model(params[:nick], false)
         if(group && nick)
             nick.remove_group(group)
             @pipeline << Messages::Outgoing::Privmsg.new(message.replyto, "Removed #{params[:nick]} from the #{params[:group]} authentication group.")