mod_spox 0.1.0.1 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,39 @@
+0.2.0 Release (Beta status)
+    Core:
+    * Removed support for MySQL and SQLite (SQLite support may be added at a later date)
+    * Rebuilt and optimized timer
+    * Rebuilt and optimized pooling
+    * Fixed authentication bugs
+    * Added basic DCC support (still in alpha state)
+    * Added daemon support
+    * Updated tinyurl helper to use api
+    * Updated format_seconds helper
+    * Added a format_bytes helper method
+    * Fixed PluginManager to handle bad plugins better
+    * termios support has been removed
+    * Tested for full support on Ruby 1.8 and Ruby 1.9
+    * Tested for alpha support on JRuby > 1.1.3
+    Plugins:
+    * New plugins added:
+        * Status - Status and version information from the bot
+        * NickServ - Identify with services
+        * Twitter - Use twitter via IRC
+        * GoogleIt - Will help people unfamiliar with google
+        * Slashdot - Last 5 from the Slashdot feed
+        * PoolConfig - Configure bot thread pooling
+        * RegexTracker - Track regular expressions found in privmsgs
+        * TracTicket - Add help tickets to a trac system
+        * DCC - Basic DCC chat and file server (alpha state - only works with some clients)
+    * AutoRejoin plugin will automatically join channels on connect
+    * Confess fixed to use it's own sqlite database. See: http://dev.modspox.com/cgi-bin/trac.cgi/wiki/ConfessSqlite
+    * Headers fixed to support http and https plus support for non-standard ports
+    * PhpLookup fixed for new manual layout
+    * Translate fixed to interact with yahoo properly
+    * Karma now has standardized parenthesis usage as well as anti-karma
+    
+    Lots of other fixes throughout. Clean install is recommended. Please read the install
+    guide for an overview of what information you will need and what setup is required.
+    
 0.1.0.1 Release (Bug fix)
     * Fix made to work with sequel 2.2
     

data/INSTALL

@@ -5,11 +5,11 @@ gem install --include-dependencies mod_spox
 Requirements include:
     * sequel
         * database driver
-    * Ruby >= 1.8.4
+    * Ruby >= 1.8.6
     
 Optional:
     * fastthread
     * termios
     
 More detailed information can be found at:
-http://dev.modspox.com/cgi-bin/trac.cgi/wiki/InstallHowto
+http://dev.modspox.com/cgi-bin/trac.cgi/wiki/InstallHowto

data/README

@@ -23,7 +23,6 @@ mod_spox
  
 == Optional
 
- * termios
  * fastthread
  
 == Install

data/bin/mod_spox

@@ -2,14 +2,14 @@
 
 ## include our needed libraries ##
 
-['rubygems', 'sequel', 'thread', 'etc', 'getoptlong'].each{|file| 
+['rubygems', 'sequel', 'thread', 'etc', 'getoptlong', 'logger'].each do |file|
     begin
         require file
     rescue Object => boom
         puts "ERROR: Failed to load required library: #{file}"
         exit 1
     end
-}
+end
 
 ## optional libraries ##
 begin
@@ -18,15 +18,21 @@ rescue Object => boom
     # ignore if not found #
 end
 
-$BOTVERSION='0.1.0.1'
+$BOTVERSION='0.2.0'
+$BOTCODENAME='avocado'
 $VERBOSITY = 0
 $MOD_SPOX_PATH = nil
+$DAEMON_BOT = false
+$LOGTO = $stdout
+$LOGLEVEL = :fatal
+$JDBC = false
+
 Sequel::Model.unrestrict_primary_key
 
 begin
     require 'mod_spox/Loader'
 rescue
-    p 'ERROR: Failed to load mod_spox'
+    puts 'ERROR: Failed to load mod_spox'
     exit 1
 end
 include ModSpox
@@ -34,40 +40,73 @@ include ModSpox
 opts = GetoptLong.new(
     ['--config', '-c', GetoptLong::NO_ARGUMENT],
     ['--debug', '-d', GetoptLong::OPTIONAL_ARGUMENT],
+    ['--verbosity', '-V', GetoptLong::OPTIONAL_ARGUMENT],
     ['--version', '-v', GetoptLong::NO_ARGUMENT],
+    ['--jdbc', '-j', GetoptLong::NO_ARGUMENT],
     ['--help', '-h', GetoptLong::NO_ARGUMENT],
-    ['--path', '-p', GetoptLong::REQUIRED_ARGUMENT]
+    ['--path', '-p', GetoptLong::REQUIRED_ARGUMENT],
+    ['--daemon', '-D', GetoptLong::NO_ARGUMENT]
 )
 verbose = 0
 opts.each do |opt, arg|
     case opt
         when '--help'
             puts 'Usage: mod_spox [opts]'
-            puts '--config -c:     starts configuration wizard'
-            puts '--debug -d:      turns on debugging (include number >0 for more info)'
-            puts '--version -v:    output bot version information'
-            puts '--help -h:       print this help message'
+            puts '--config -c:                        starts configuration wizard'
+            puts '--path -p /config/path              path to configuration directory'
+            puts '--jdbc -j                           use jdbc database driver (jruby)'
+            puts '--debug -d [logfile]:               turns on debugging and outputs to file (default STDOUT)'
+            puts '--verbosity -V [(info|warn|fatal)]: verbosity of debug output (default fatal)'
+            puts '--deamon -D:                        daemonizes the process'
+            puts '--version -v:                       output bot version information'
+            puts '--help -h:                          print this help message'
             exit
         when '--version'
             puts "mod_spox IRC bot version: #{$BOTVERSION}"
             puts 'http://rubyforge.org/projects/modspox'
             exit
+        when '--jdbc'
+            $JDBC = true
+            begin
+                require 'jdbc/postgres'
+            rescue Object => boom
+                puts 'Failed to load JDBC Postgres gem'
+                exit 1
+            end
         when '--debug'
-            if(arg && arg =~ /^[0-9]+/)
-                $VERBOSITY = arg.to_i
+            if(arg && File.writable?(arg))
+                $LOGTO = arg
+            else
+                $LOGTO = $stdout
             end
         when '--config'
             require 'mod_spox/ConfigurationWizard'
             wizard = ConfigurationWizard.new
-            wizard.run
+            BotConfig.configured? ? wizard.update : wizard.run
             exit
         when '--path'
             $MOD_SPOX_PATH = arg
+        when '--daemon'
+            begin
+                $DAEMON_BOT = true
+                require 'daemons'
+            rescue Object => boom
+                puts 'Error: You must install the Daemons gem: (http://daemons.rubyforge.org)'
+                exit 1
+            end
+        when '--verbosity'
+            if(arg && arg =~ /^(info|warn|fatal)$/)
+                $LOGLEVEL = arg.to_sym
+            end
     end
 end
 
 initialize_bot
 require 'mod_spox/Bot'
 
+if($DAEMON_BOT)
+    Daemonize.daemonize(nil, 'mod_spox')
+end
+
 bot = Bot.new
 bot.run

data/data/mod_spox/extras/AOLSpeak.rb

@@ -1,7 +1,7 @@
 class AOLSpeak < ModSpox::Plugin
 
     include Models
-    
+
     def initialize(pipeline)
         super
         group = Group.find_or_create(:name => 'banner')
@@ -9,20 +9,13 @@ class AOLSpeak < ModSpox::Plugin
         Signature.find_or_create(:signature => 'aolkick (\S+) ?(\S+)?', :plugin => name, :method => 'aolkick', :description => 'AOL speak kick',
             :group_id => group.pk).params = [:nick, :channel]
         build_aolspeak
-        @banner = nil
-        @pipeline.hook(self, :banner_watch, :Internal_PluginResponse)
-        @pipeline << Messages::Internal::PluginRequest.new(self, 'Banner')
     end
-    
+
     def aolspeak(message, params)
         reply message.replyto, @aolspeak[rand(@aolspeak.size) - 1]
     end
-    
+
     def aolkick(message, params)
-        if(@banner.nil?)
-            @pipeline << Messages::Internal::PluginRequest.new(self, 'Banner')
-            sleep(0.1)
-        end
         if(params[:channel])
             channel = Models::Channel.filter(:name => params[:channel]).first
         else
@@ -30,21 +23,15 @@ class AOLSpeak < ModSpox::Plugin
         end
         nick = Helpers.find_model(params[:nick], false)
         if(channel && nick)
-            @banner.plugin.ban(nick, channel, 60, @aolspeak[rand(@aolspeak.size) - 1], invite=false, show_time=false)
+            @pipeline << plugin_const(:Banner_Ban).new(nick, channel, :kickban, @aolspeak[rand(@aolspeak.size) - 1], 60, false, 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
         end
     end
 
-    def banner_watch(message)
-        if(message.origin == self && message.found?)
-            @banner = message.plugin
-        end
-    end
-
     private
-    
+
     def build_aolspeak
         @aolspeak = [
             'ALL OREAND THE GIFCHERRY BUSH DA BOON CHASED DA WHEASELGIFPASTECLITNUGGET SHIT]',

data/data/mod_spox/extras/AutoKick.rb

@@ -16,15 +16,13 @@ class AutoKick < ModSpox::Plugin
             :group_id => group.pk, :description => 'Remove an autokick rule').params = [:id]
         Signature.find_or_create(:signature => 'autokick colors ?(on|off)?', :plugin => name, :method => 'colors',
             :group_id => group.pk, :description => 'Kick user for using colors', :requirement => 'public').params = [:action]
-        @pipeline.hook(self, :banner_watch, :Internal_PluginResponse)
-        @banner = nil
         @map = nil
         @colors = Setting[:colorkick]
-        @colors = Array.new if @colors.nil?
+        @colors = Array.new unless @colors.is_a?(Array)
         AutoKickRecord.create_table unless AutoKickRecord.table_exists?
         do_listen
     end
-    
+
     def colors(message, params)
         if(params[:action])
             if(params[:action] == 'on')
@@ -32,12 +30,16 @@ class AutoKick < ModSpox::Plugin
                     reply message.replyto, 'Colored autokick is already enabled'
                 else
                     @colors << message.target.pk
-                    Setting[:colorkick] = @colors
+                    record = Setting.find_or_create(:name => 'colorkick')
+                    record.value = @colors
+                    record.save
                     reply message.replyto, 'Colored autokick has been enabled'
                 end
             else
                 @colors.delete(message.target.pk)
-                Setting[:colorkick] = @colors
+                record = Setting.find_or_create(:name => 'colorkick')
+                record.value = @colors
+                record.save
                 reply message.replyto, 'Colored autokick has been disabled'
             end
         else
@@ -45,7 +47,7 @@ class AutoKick < ModSpox::Plugin
             reply message.replyto, "Colored autokick is currently \2#{status}\2"
         end
     end
-    
+
     def list(message, params)
         records = AutoKickRecord.all
         unless(records.empty?)
@@ -56,7 +58,7 @@ class AutoKick < ModSpox::Plugin
             reply message.replyto, 'No rules currently enabled'
         end
     end
-    
+
     def add(message, params)
         if(params[:channel])
             channel = Channel.filter(:name => params[:channel]).first
@@ -71,7 +73,7 @@ class AutoKick < ModSpox::Plugin
             reply message.replyto, "\2Error:\2 I have no record of #{params[:channel]}. Failed to add autokick rule."
         end
     end
-    
+
     def remove(message, params)
         record = AutoKickRecord[params[:id].to_i]
         if(record)
@@ -82,32 +84,33 @@ class AutoKick < ModSpox::Plugin
             reply message.replyto, "\2Error:\2 Failed to find an autokick rule with ID: #{params[:id]}"
         end
     end
-    
+
     def listener(message)
+        return unless message.is_public?
         if(@map.keys.include?(message.target.pk))
+            bmessage = nil
+            btime = 0
             @map[message.target.pk].each do |pattern|
                 reg = Regexp.new(pattern, Regexp::IGNORECASE)
                 unless(reg.match(message.message).nil?)
                     record = AutoKickRecord.filter(:pattern => pattern).first
-                    @banner.plugin.ban(message.source, message.target, record.bantime, record.message, false, true)
+                    bmessage = record.message
+                    btime += record.bantime
                 end
-            end 
+            end
+            unless(bmessage.nil?)
+                @pipeline << plugin_const(:Banner_Ban).new(message.source, message.target, :kickban, bmessage, btime, false, true)
+            end
         end
         if(@colors.include?(message.target.pk))
             if(message.is_colored?)
-                @banner.plugin.ban(message.source, message.target, 60, 'No color codes allowed', false, true)
+                @pipeline << plugin_const(:Banner_Ban).new(message.source, message.target, :kickban, 'No color codes allowed', 60, false, true)
             end
         end
     end
-    
-    def banner_watch(message)
-        if(message.origin == self && message.found?)
-            @banner = message.plugin
-        end
-    end
-    
+
     private
-    
+
     def do_listen
         @map = nil
         begin
@@ -122,11 +125,10 @@ class AutoKick < ModSpox::Plugin
                 @map[record.channel_id] = [] unless @map[record.channel_id]
                 @map[record.channel_id] << record.pattern
             end
-            @pipeline << Messages::Internal::PluginRequest.new(self, 'Banner')
             @pipeline.hook(self, :listener, :Incoming_Privmsg)
         end
     end
-    
+
     class AutoKickRecord < Sequel::Model
         set_schema do
             primary_key :id
@@ -135,6 +137,25 @@ class AutoKick < ModSpox::Plugin
             text :message, :null => false
             foreign_key :channel_id, :table => :channels
         end
+
+        def channel
+            ModSpox::Models::Channel[channel_id]
+        end
+    end
+    
+    class AutoKickPersonal < Sequel::Model
+        set_schema do
+            primary_key :id
+            varchar :pattern, :default => nil
+            integer :bantime, :null => false, :default => 60
+            varchar :message, :null => false
+            foreign_key :nick_id, :table => :nicks
+            foreign_key :channel_id, :table => :channels
+        end
+        
+        def nick
+            ModSpox::Models::Nick[nick_id]
+        end
         
         def channel
             ModSpox::Models::Channel[channel_id]

data/data/mod_spox/extras/AutoMode.rb

@@ -54,11 +54,8 @@ class AutoMode < ModSpox::Plugin
     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"
+        ModeRecord.filter(:nick_id => m.source.pk, :channel_id => m.target.pk).each do |record|
+            @pipeline << Messages::Outgoing::ChannelMode.new(m.target, '+v', m.source.nick) if me.is_op?(m.target) && record.voice
         end
     end
     

data/data/mod_spox/extras/AutoRejoin.rb

@@ -3,6 +3,9 @@ class AutoRejoin < ModSpox::Plugin
     def initialize(pipeline)
         super
         @pipeline.hook(self, :check_kick, :Incoming_Kick)
+        @pipeline.hook(self, :check_join, :Incoming_Join)
+        @pipeline.hook(self, :check_part, :Incoming_Part)
+        @pipeline.hook(self, :do_joins, :Incoming_Welcome)
     end
     
     def check_kick(message)
@@ -10,5 +13,23 @@ class AutoRejoin < ModSpox::Plugin
             @pipeline << Messages::Outgoing::Join.new(message.channel)
         end
     end
+    
+    def check_join(m)
+        if(m.nick == me)
+            m.channel.update(:autojoin => true)
+        end
+    end
+    
+    def check_part(m)
+        if(m.nick == me)
+            m.channel.update(:autojoin => false)
+        end
+    end
+    
+    def do_joins(m)
+        Models::Channel.filter(:autojoin => true).each do |channel|
+            @pipeline << Messages::Outgoing::Join.new(channel)
+        end
+    end
 
 end

data/data/mod_spox/extras/Bouncer.rb

@@ -28,7 +28,7 @@ class Bouncer < ModSpox::Plugin
     
     def get_msgs(message)
         unless(@clients.empty?)
-        Logger.log("BOUNCER: Sending to #{@clients.size} clients")
+        Logger.info("BOUNCER: Sending to #{@clients.size} clients")
             @clients.each do |client|
                 begin
                     if(message.raw_content.is_a?(Array))
@@ -107,18 +107,18 @@ class Bouncer < ModSpox::Plugin
                 until(@socket.closed?)
                     begin
                         new_con = @socket.accept_nonblock
-                        Logger.log("BOUNCER: New connection established on bouncer")
+                        Logger.info("BOUNCER: New connection established on bouncer")
                         @clients << {
                                     :connection => new_con, 
                                     :thread => Thread.new(new_con) do | con |
                                         begin
-                                        Logger.log("CONNECTION: #{con}")
+                                        Logger.info("CONNECTION: #{con}")
                                         until(con.closed?)
-                                            Logger.log("WAITING FOR STUFF ON :#{con}")
+                                            Logger.info("WAITING FOR STUFF ON :#{con}")
                                             Kernel.select([con], nil, nil, nil)
-                                            Logger.log("Woken up and ready to read")
+                                            Logger.info("Woken up and ready to read")
                                             string = con.gets
-                                            Logger.log("BOUNCER GOT MESSAGE: #{string}")
+                                            Logger.info("BOUNCER GOT MESSAGE: #{string}")
                                             if(string.empty?)
                                                 raise Exception.new("EMPTY STRING")
                                             else
@@ -126,7 +126,7 @@ class Bouncer < ModSpox::Plugin
                                             end
                                         end
                                         rescue Object => boom
-                                        Logger.log("THREAD BOUNCER ERROR: #{boom}")
+                                        Logger.warn("THREAD BOUNCER ERROR: #{boom}")
                                         end
                                         end
                                     }
@@ -139,7 +139,7 @@ class Bouncer < ModSpox::Plugin
             end
             start_processor
         else
-            Logger.log("Error: Bouncer was not started. Failed to find set port number")
+            Logger.warn("Error: Bouncer was not started. Failed to find set port number")
         end
     end
     
@@ -158,7 +158,7 @@ class Bouncer < ModSpox::Plugin
         begin
             while(@listener) do
                 info = @to_server.pop
-                Logger.log("Processing message: #{info[:message]}")
+                Logger.info("Processing message: #{info[:message]}")
                 if(info[:message] =~ /^USER\s/i)
                     initialize_connection(info[:socket])
                 else
@@ -166,7 +166,7 @@ class Bouncer < ModSpox::Plugin
                 end
             end
         rescue Object => boom
-            Logger.log("BOUNCER ERROR: #{boom}")
+            Logger.warn("BOUNCER ERROR: #{boom}")
             unless(@clients.empty?)
                 @clients.each do |socket|
                     socket[:connection].close

data/data/mod_spox/extras/Bytes.rb

@@ -0,0 +1,12 @@
+class Bytes < ModSpox::Plugin
+    include Models
+    def initialize(args)
+        super
+        Signature.find_or_create(:signature => 'bytes (\d+)', :plugin => name, :method => 'convert',
+            :description => 'Convert bytes to human readable string').params = [:bytes]
+    end
+    
+    def convert(message, params)
+        reply message.replyto, "#{params[:bytes]} is roughly #{Helpers.format_size(params[:bytes].to_i)}"
+    end
+end