mod_spox 0.1.0.1 → 0.2.0

data/data/mod_spox/plugins/Banner.rb

@@ -2,9 +2,9 @@ class Banner < ModSpox::Plugin
 
     include Models
     include Messages::Outgoing
-    
+
     def initialize(pipeline)
-        super(pipeline)
+        super
         admin = Group.find_or_create(:name => 'banner')
         Signature.find_or_create(:signature => 'ban (\S+)', :plugin => name, :method => 'default_ban', :group_id => admin.pk,
             :description => 'Kickban given nick from current channel').params = [:nick]
@@ -36,22 +36,31 @@ class Banner < ModSpox::Plugin
         @pipeline.hook(self, :mode_check, :Incoming_Mode)
         @pipeline.hook(self, :join_check, :Incoming_Join)
         @pipeline.hook(self, :who_check, :Incoming_Who)
-        @pipeline.hook(self, :get_action, :Internal_TimerResponse)
+        @pipeline.hook(self, :process_ban, :Banner_Ban)
         BanRecord.create_table unless BanRecord.table_exists?
         BanMask.create_table unless BanMask.table_exists?
         BanNickExempt.create_table unless BanNickExempt.table_exists?
         BanModeExempt.create_table unless BanModeExempt.table_exists?
         BanSourceExempt.create_table unless BanSourceExempt.table_exists?
-        @actions = []
-        @up_sync = Mutex.new
-        @timer_sync = Mutex.new
-        updater
+        load_timer
+        @time = Object::Time.now
     end
-    
+
     def destroy
-        do_update
+        reset_time
+    end
+
+    def process_ban(message)
+        ban(message.nick, message.channel, message.time, message.message, message.invite?, message.display_time?)
+    end
+
+    def reset_time
+        elapsed = Object::Time.now.to_i - @time.to_i
+        BanRecord.filter('remaining > 0').update("remaining = remaining - #{elapsed}")
+        BanMask.filter('bantime > 0').update("bantime = bantime - #{elapsed}")
+        @time = Object::Time.now
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: parameters
     # Perform a simple ban with default values
@@ -60,7 +69,7 @@ class Banner < ModSpox::Plugin
         params[:channel] = message.target.name
         full_ban(message, params)
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: parameters
     # Ban given nick in given channel
@@ -68,14 +77,14 @@ class Banner < ModSpox::Plugin
         params[:time] = 86400
         full_ban(message, params)
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: parameters
     # Ban nick in given channel for given time providing given message
     def full_ban(message, params)
         nick = Helpers.find_model(params[:nick], false)
-        channel = Channel.filter(:name => params[:channel]).first
-        if(!me.is_op?(message.target))
+        channel = Channel.locate(params[:channel])
+        if(!me.is_op?(channel))
             reply(message.replyto, "Error: I'm not a channel operator")
         elsif(!nick)
             reply(message.replyto, "#{message.source.nick}: Failed to find nick #{params[:nick]}")
@@ -85,7 +94,7 @@ class Banner < ModSpox::Plugin
             ban(nick, channel, params[:time], params[:message])
         end
     end
-    
+
     # nick:: ModSpox::Models::Nick to ban
     # channel:: ModSpox::Models::Channel to ban nick from
     # time:: number of seconds ban should last
@@ -102,17 +111,27 @@ class Banner < ModSpox::Plugin
         elsif(check_exempt(nick, channel))
             raise BanExemption.new("This nick is exempt from bans: #{nick.nick}")
         else
-            mask = nick.source.nil? || nick.source.empty? ? "#{nick.nick}!*@*" : "*!*@#{nick.address}"
-            BanRecord.new(:nick_id => nick.pk, :bantime => time.to_i, :remaining => time.to_i,
-                :invite => invite, :channel_id => channel.pk, :mask => mask).save
+            reset_time
+            mask = nick.address.nil? || nick.address.empty? ? "#{nick.nick}!*@*" : "*!*@#{nick.address}"
+            record = BanRecord.filter(:nick_id => nick.pk, :channel_id => channel.pk, :mask => mask, :removed => false).first
+            if(record)
+                record.bantime = record.bantime + time.to_i
+                record.remaining = record.remaining + time.to_i
+                record.save
+            else
+                record = BanRecord.new(:nick_id => nick.pk, :bantime => time.to_i, :remaining => time.to_i,
+                    :invite => invite, :channel_id => channel.pk, :mask => mask)
+                record.save
+            end
+            @pipeline << Messages::Internal::TimerAdd.new(self, record.remaining, nil, true){ clear_record(record.pk, record.remaining) }
+            reset_time
             message = reason ? reason : 'no soup for you!'
             message = "#{message} (Duration: #{Helpers.format_seconds(time.to_i)})" if show_time
             @pipeline << ChannelMode.new(channel, '+b', mask)
             @pipeline << Kick.new(nick, channel, message)
-            updater
         end
     end
-    
+
     # mask:: mask to match against source (Regexp)
     # channel:: ModSpox::Models::Channel to ban from
     # message:: kick message
@@ -120,11 +139,14 @@ class Banner < ModSpox::Plugin
     # Bans all users who's source matches the given mask
     def mask_ban(mask, channel, message, time)
         raise NotInChannel.new("I am not in channel: #{channel.name}") unless me.channels.include?(channel)
-        BanMask.new(:mask => mask, :channel_id => channel.pk, :message => message, :bantime => time.to_i, :stamp => Object::Time.now).save
+        reset_time
+        record = BanMask.new(:mask => mask, :channel_id => channel.pk, :message => message, :bantime => time.to_i, :stamp => Object::Time.now)
+        record.save
         check_masks
-        updater
+        @pipeline << Messages::Internal::TimerAdd.new(self, record.bantime, nil, true){ record.destroy }
+        reset_time
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: parameters
     # Set a ban on any nick with a source match given regex
@@ -136,22 +158,21 @@ class Banner < ModSpox::Plugin
                 reply(message.replyto, "Okay")
             rescue Object => boom
                 reply(message.replyto, "Error: Failed to ban mask. Reason: #{boom}")
-                Logger.log("ERROR: #{boom} #{boom.backtrace.join("\n")}")
+                Logger.warn("ERROR: #{boom} #{boom.backtrace.join("\n")}")
             end
         else
             reply(message.replyto, "Error: No record of channel: #{params[:channel]}")
-        end 
+        end
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: parameters
     # List all ban masks
     def mask_list(message, params)
-        updater
         if(BanMask.all.size > 0)
             reply(message.replyto, "Masks currently banned:")
             BanMask.all.each do |mask|
-                reply(message.replyto, "\2ID:\2 #{mask.pk} \2Mask:\2 #{mask.mask} \2Time:\2 #{Helpers.format_seconds(mask.bantime.to_i)} \2Channel:\2 #{mask.channel.name}")
+                reply(message.replyto, "\2ID:\2 #{mask.pk} \2Mask:\2 #{mask.mask} \2Time:\2 #{Helpers.format_seconds(mask.bantime.to_i - (Object::Time.now.to_i - @time.to_i))} \2Channel:\2 #{mask.channel.name}")
             end
         else
             reply(message.replyto, "No ban masks currently enabled")
@@ -165,43 +186,41 @@ class Banner < ModSpox::Plugin
         mask = BanMask[params[:id].to_i]
         if(mask)
             mask.destroy
-            updater
             reply(message.replyto, 'Okay')
         else
             reply(message.replyto, "\2Error:\2 Failed to find ban mask with ID: #{params[:id]}")
         end
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: parameters
-    # List all currently active bans originating from the bot    
+    # List all currently active bans originating from the bot
     def ban_list(message, params)
-        updater
         set = BanRecord.filter(:removed => false)
         if(set.size > 0)
             reply(message.replyto, "Currently active bans:")
             set.each do |record|
-                reply(message.replyto, "\2ID:\2 #{record.pk} \2Nick:\2 #{record.nick.nick} \2Channel:\2 #{record.channel.name} \2Initial time:\2 #{Helpers.format_seconds(record.bantime.to_i)} \2Time remaining:\2 #{Helpers.format_seconds(record.remaining.to_i)}")
+                remains = record.remaining.to_i - (Object::Time.now.to_i - @time.to_i)
+                remains = 0 unless remains > 0
+                reply(message.replyto, "\2ID:\2 #{record.pk} \2Nick:\2 #{record.nick.nick} \2Channel:\2 #{record.channel.name} \2Initial time:\2 #{Helpers.format_seconds(record.bantime.to_i)} \2Time remaining:\2 #{Helpers.format_seconds(remains)}")
             end
         else
             reply(message.replyto, "No bans currently active")
         end
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: parameters
     # Remove given ban
     def ban_remove(message, params)
         record = BanRecord[params[:id].to_i]
         if(record)
-            record.update_with_params(:remaining => 0)
-            updater
-            reply(message.replyto, 'Okay')
+            clear_record(record.pk, nil)
         else
             reply(message.replyto, "\2Error:\2 Failed to find ban record with ID: #{params[:id]}")
-        end 
+        end
     end
-    
+
     # Check all enabled ban masks and ban any matches found
     def check_masks
         masks = BanMask.map_masks
@@ -217,24 +236,23 @@ class Banner < ModSpox::Plugin
                     end
                     unless match.nil?
                         begin
-                            ban(nick, channel, match[:bantime], match[:message]) 
+                            ban(nick, channel, match[:bantime], match[:message])
                         rescue Object => boom
-                            Logger.log("Mask based ban failed. Reason: #{boom}")
+                            Logger.warn("Mask based ban failed. Reason: #{boom}")
                         end
                     end
                 end
             else
-                Logger.log("Ban masks will not be processed due to lack of operator status")
+                Logger.info("Ban masks will not be processed due to lack of operator status")
             end
         end
     end
-    
+
     # nick:: ModSpox::Models::Nick
     # channel:: ModSpox::Models::Channel
     # Check if the nick in the channel matches any ban masks
     def mask_check(nick, channel)
         return unless me.is_op?(channel)
-        updater
         match = nil
         BanMask.filter(:channel_id => channel.pk).each do |bm|
             if(nick.source =~ /#{bm.mask}/)
@@ -245,108 +263,69 @@ class Banner < ModSpox::Plugin
             begin
                 ban(nick, channel, match.bantime, match.message)
             rescue Object => boom
-                Logger.log("Mask based ban failed. Reason: #{boom}")
+                Logger.warn("Mask based ban failed. Reason: #{boom}")
             end
         end
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Mode
     # Check for mode changes. Remove pending ban removals if
     # done manually
     def mode_check(message)
         if(message.target.is_a?(String) && message.source != me)
             if(message.mode == '-b')
-                update = false
                 BanRecord.filter(:mask => message.target, :channel_id => message.channel.pk).each do |match|
-                    match.update_vaules(:remaining => 0)
-                    match.update_with_params(:removed => true)
-                    update = true
+                    match.remaining = 0
+                    match.removed = true
+                    match.save
                 end
-                updater if update
             end
         end
         if(message.target == me && message.mode == '+o')
             check_masks
-            updater
+            BanRecord.filter('remaining < 1 AND removed = ?', false).each do |record|
+                clear_record(record.pk, nil)
+            end
         end
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Join
     # Check is nick is banned
     def join_check(message)
         mask_check(message.nick, message.channel)
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Who
     # Check if we updated any addresses
     def who_check(message)
         check_masks
     end
-    
-    # message:: ModSpox::Messages::Internal::TimerResponse
-    # Store any timer actions we have registered
-    def get_action(message)
-        if(message.action_added? && message.origin == self)
-            @actions << message.action
-        elsif(message.action_removed? && @actions.include?(message.action))
-            @actions.delete(message.action)
-        end
-    end
-    
-    # Update all BanMask and BanRecords
-    def updater
-        @up_sync.synchronize do
-            unless(@actions.empty?)
-                @actions.each{|a|@pipeline << Messages::Internal::TimerRemove.new(a)}
-                Logger.log("Waiting for actions to become empty")
-                sleep(0.01) until @actions.empty?
-                Logger.log("Actions has now become empty")
-            end
-            do_update
+
+    def load_timer
+        BanRecord.filter('removed = ? AND remaining > 0', false).each do |record|
+            @pipeline << Messages::Internal::TimerAdd.new(self, record.remaining, nil, true){ clear_record(record.pk, record.remaining) }
+        end
+        BanMask.filter('bantime > 0').each do |record|
+            @pipeline << Messages::Internal::TimerAdd.new(self, record.bantime, nil, true){ record.destroy }
         end
     end
-    
-    # Completes update
-    def do_update
-        @timer_sync.synchronize do
-            begin
-                time = @sleep.nil? ? 0 : (Object::Time.now - @sleep).to_i
-                if(time > 0)
-                    BanRecord.filter('remaining > ?', 0).update("remaining = remaining - #{time}")
-                    BanMask.filter('bantime > ?', 0).update("bantime = bantime - #{time}")
-                end
-                BanRecord.filter('remaining <= ?', 0).filter('removed = ?', false).each do |record|
-                    if(me.is_op?(record.channel))
-                        @pipeline << ChannelMode.new(record.channel, '-b', record.mask)
-                        record.update_with_params(:removed => true)
-                        @pipeline << Invite.new(record.nick, record.channel) if record.invite
-                    end
-                end
-                BanMask.filter('bantime < ?', 1).destroy
-                next_ban_record = BanRecord.filter('remaining > ?', 0).order(:remaining).first
-                next_mask_record = BanMask.filter('bantime > ?', 0).order(:bantime).first
-                if(next_ban_record && next_mask_record)
-                    time = next_ban_record.bantime < next_mask_record.bantime ? next_ban_record.bantime : next_mask_record.bantime
-                elsif(next_ban_record)
-                    time = next_ban_record.bantime
-                elsif(next_mask_record)
-                    time = next_mask_record.bantime
-                else
-                    time = nil
-                end
-                Logger.log("Time left to sleep is now: #{time}")
-                unless(time.nil?)
-                    @sleep = Object::Time.now
-                    @pipeline << Messages::Internal::TimerAdd.new(self, time, nil, true){ do_update }
-                else
-                    @sleep = nil
-                end
-            rescue Object => boom
-                Logger.log("Updating encountered an unexpected error: #{boom}")
+
+    def clear_record(id, slept=nil)
+        record = BanRecord[id]
+        return if !record || record.removed
+        if(!slept.nil? && (record.remaining - slept).to_i > 0)
+            record.remaining = record.remaining - slept
+        else
+            record.remaining = 0
+            if(me.is_op?(record.channel))
+                @pipeline << ChannelMode.new(record.channel, '-b', record.mask)
+                record.removed = true
+                @pipeline << Invite.new(record.nick, record.channel) if record.invite
             end
         end
+        record.save
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: parameters
     # Add ban exemption for a given mode
@@ -366,7 +345,7 @@ class Banner < ModSpox::Plugin
         end
         reply message.replyto, response
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: parameters
     # Add ban exemption for a given nick
@@ -375,7 +354,7 @@ class Banner < ModSpox::Plugin
         nick = Helpers.find_model(params[:nick])
         unless(nick.is_a?(Models::Nick))
             reply message.replyto, "\2Error:\2 Failed to find record of: #{params[:nick]}"
-            return 
+            return
         end
         channel = params[:channel] ? Helpers.find_model(params[:channel]) : nil
         if(channel)
@@ -411,10 +390,10 @@ class Banner < ModSpox::Plugin
         end
         reply message.replyto, response
     end
-    
+
     # message:: ModSpox::Messages::Incoming::Privmsg
     # params:: parameters
-    # List given type of current ban exemptions    
+    # List given type of current ban exemptions
     def exempt_list(message, params)
         output = []
         if(params[:type] == 'nick')
@@ -470,7 +449,7 @@ class Banner < ModSpox::Plugin
         end
         reply message.replyto, response
     end
-    
+
     # nick:: ModSpox::Models::Nick
     # channel:: ModSpox::Models::Channel
     # Check if nick is currently exempt from bans
@@ -484,114 +463,148 @@ class Banner < ModSpox::Plugin
         end
         return false
     end
-    
+
     class BanRecord < Sequel::Model
         set_schema do
             primary_key :id
             timestamp :stamp, :null => false
             integer :bantime, :null => false, :default => 1
             integer :remaining, :null => false, :default => 1
-            text :mask, :null => false
+            varchar :mask, :null => false
             boolean :invite, :null => false, :default => false
             boolean :removed, :null => false, :default => false
-            foreign_key :channel_id, :null => false, :table => :channels
-            foreign_key :nick_id, :null => false, :table => :nicks
+            foreign_key :channel_id, :null => false, :table => :channels, :key => :id
+            foreign_key :nick_id, :null => false, :table => :nicks, :key => :id
         end
-        
+
         before_create do
-            update_values(:stamp => Time.now)
+            update_values(:stamp => Object::Time.now)
         end
-        
+
         def channel
             ModSpox::Models::Channel[channel_id]
         end
-        
+
         def nick
             ModSpox::Models::Nick[nick_id]
         end
     end
-    
+
     class BanMask < Sequel::Model
         set_schema do
             primary_key :id
-            text :mask, :unique => true, :null => false
+            varchar :mask, :unique => true, :null => false
             timestamp :stamp, :null => false
             integer :bantime, :null => false, :default => 1
             text :message
-            foreign_key :channel_id, :null => false, :table => :channels
+            foreign_key :channel_id, :null => false, :table => :channels, :key => :id
         end
-        
+
         def channel
             ModSpox::Models::Channel[channel_id]
         end
-        
+
         def self.map_masks
             masks = {}
             BanMask.all.each do |mask|
-                Logger.log("Processing mask for channel: #{mask.channel.name}")
+                Logger.info("Processing mask for channel: #{mask.channel.name}")
                 masks[mask.channel.name] = [] unless masks.has_key?(mask.channel.name)
                 masks[mask.channel.name] << {:mask => mask.mask, :message => mask.message, :bantime => mask.bantime, :channel => mask.channel}
             end
             return masks
         end
     end
-    
+
     class BanNickExempt < Sequel::Model
         set_schema do
             primary_key :id
-            foreign_key :nick_id, :table => :nicks, :null => false
-            foreign_key :channel_id, :table => :channels
+            foreign_key :nick_id, :table => :nicks, :null => false, :key => :id
+            foreign_key :channel_id, :table => :channels, :key => :id
         end
-        
+
         def nick
             return Models::Nick[nick_id]
         end
-        
+
         def channel
             return Models::Channel[channel_id]
         end
     end
-    
+
     class BanSourceExempt < Sequel::Model
         set_schema do
             primary_key :id
             varchar :source, :null => false
-            foreign_key :channel_id, :table => :channels
+            foreign_key :channel_id, :table => :channels, :key => :id
         end
-        
+
         def channel
             return Models::Channel[channel_id]
         end
-        
+
         def mask
             return values[:source] ? Marshal.load(values[:source].unpack('m')[0]) : nil
         end
-        
+
         def mask=(val)
             update_values(:source => [Marshal.dump(val)].pack('m'))
         end
-        
+
     end
-    
+
     class BanModeExempt < Sequel::Model
         set_schema do
             primary_key :id
             varchar :mode, :null => false
-            foreign_key :channel_id, :table => :channels, :unique => true
+            foreign_key :channel_id, :table => :channels, :key => :id
+            index [:channel_id, :mode]
         end
-        
+
         def channel
             return Models::Channel[channel_id]
-        end        
+        end
     end
-    
+
     class NotOperator < Exceptions::BotException
     end
-    
+
     class NotInChannel < Exceptions::BotException
     end
-    
+
     class BanExemption < Exceptions::BotException
     end
 
+    class Ban
+        # Nick to be kicked
+        attr_reader :nick
+        # Channel to be kicked from
+        attr_reader :channel
+        # Type of ban: :ban, :kick, :kickban
+        attr_reader :type
+        # Ban time (0 for no ban)
+        attr_reader :time
+        # Message to display in kick
+        attr_reader :message
+        def initialize(nick, channel, type=:kickban, message=nil, time=30, invite=false, display_time=false)
+            @nick = nick
+            @channel = channel
+            raise ModSpox::Exceptions::InvalidType.new('Ban requires a valid type (:ban, :kick, :kickban)') unless [:kick, :ban, :kickban].include?(type)
+            @type = type
+            @time = time.to_i
+            @message = message
+            @display_time = display_time ? true : false
+            @invite = invite ? true : false
+        end
+
+        # Display ban time in kick message
+        def display_time?
+            return @display_time
+        end
+
+        # Invite user to channel after ban expiration
+        def invite?
+            return @invite
+        end
+    end
+
 end

data/data/mod_spox/plugins/Helper.rb

@@ -9,17 +9,18 @@ class Helper < ModSpox::Plugin
         Signature.find_or_create(:signature => 'help (\S+)', :plugin => name, :method => 'plugin_help',
             :description => 'Display help information from given plugin').params = [:plugin]
     end
-    
+
     def default_help(message, params)
         plugins = Signature.select(:plugin).map(:plugin)
         plugins.uniq!
-        reply message.replyto, "Plugins currently available for help: #{plugins.join(', ')}"
+        reply message.replyto, "Plugins currently available for help: #{plugins.sort.join(', ')}"
         reply message.replyto, "Request help on a plugin: !help Plugin"
     end
-    
+
     def plugin_help(message, params)
-        sigs = Signature.filter(:plugin => params[:plugin])
-        if(sigs.count > 0)
+        sigs = []
+        Signature.all.each{|s| sigs << s if s.plugin.downcase == params[:plugin].downcase}
+        if(sigs.size > 0)
             output = []
             output << "Available triggers for plugin: \2#{params[:plugin]}\2"
             sigs.each do |sig|
@@ -30,9 +31,19 @@ class Helper < ModSpox::Plugin
                 help << "\2Description:\2 #{sig.description}" if sig.description
                 output << help.join(' ')
             end
-            reply message.source, output
+            if(message.is_dcc?)
+                reply message.replyto, output
+            else
+                reply message.source, output
+            end
         else
-            reply message.replyto, "\2Error:\2 No triggers found for plugin named: #{params[:plugin]}"
+            Signature.all.each{|s| sigs << s.plugin if /#{s.signature.gsub(/\s.*$/, '')}/ =~ params[:plugin]}
+            if(sigs.count > 0)
+                sigs.uniq!
+                reply message.replyto, "Possible plugin matches for \2#{params[:plugin]}\2: #{sigs.sort.join(', ')}"
+            else
+                reply message.replyto, "\2Error:\2 No triggers found for plugin named: #{params[:plugin]}"
+            end
         end
     end