mod_spox 0.2.0 → 0.3.0

data/README.rdoc

@@ -0,0 +1,73 @@
+== mod_spox IRC bot
+
+mod_spox is an IRC robot, written in Ruby, and will completely change your prospective on life. mod_spox is proof that doing nothing is complex, and that doing nothing can, in fact, be doing something.
+
+The core of mod_spox is basically a framework for interacting with IRC. By itself, the bot does nothing of value, aside from sucking up bandwidth and resources from the server it is connected to. The core bot can connect to a server, format information from the server, and send information back to the server properly. That's pretty much it. 
+
+The framework provided by mod_spox allows it to quickly transform from a useless bag of bytes to something entertaining, annoying, helpful, and aggravating, occasionally all at the same time. This transformation is accomplished through the use of plugins which use the framework to accomplish feats of greatness.
+
+== Critical informations
+
+* Author: spox <spox@rubyforge.org>
+* {Dev Site}[http://dev.modspox.com]
+* {Rubyforge}[http://rubyforge.org/projects/modspox]
+* {GitHub}[http://github.com/spox/mod_spox/tree/master]
+
+== Aquiring
+
+* Gem:    gem install mod_spox
+
+== Aquiring current unstable
+
+Gem:
+    gem sources -a http://gems.github.com
+    gem install spox-mod_spox
+
+Source:
+    git clone git://github.com/spox/mod_spox.git
+    cd mod_spox/
+    gem build *.gemspec
+    gem install ./
+
+== Requirements
+
+* {Sequel}[http://sequel.rubyforge.org]
+* {ActionTimer}[http://dev.modspox.com/~sine/ActionTimer]
+* {ActionPool}[http://dev.modspox.com/~sine/ActionPool]
+* {spockets}[http://dev.modspox.com/~sine/spockets]
+* Database adapter of choice compatible with sequel
+
+== Configuration
+
+    mod_spox --config
+
+== Running
+
+=== Plain
+
+    mod_spox
+
+=== Debug to STDOUT
+
+    mod_spox -V info -d
+
+=== Daemonize with debug to file
+
+    mod_spox -V info -d /home/user/logfiles/mod_spox.log -D
+
+== Extending
+
+{Plugins HOWTO}[http://dev.modspox.com/trac/mod_spox/wiki/PluginHowto]
+
+== Helping
+
+Helpful things if you are feeling helpful:
+
+* Report bugs
+* Write unit tests
+* New and/or useful plugins
+
+== License
+
+    mod_spox is licensed under the GPLv3
+    Copyright (c) 2009 spox <spox@modspox.com>

data/bin/mod_spox

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-
+# encoding: utf-8
 ## include our needed libraries ##
 
 ['rubygems', 'sequel', 'thread', 'etc', 'getoptlong', 'logger'].each do |file|
@@ -18,16 +18,14 @@ rescue Object => boom
     # ignore if not found #
 end
 
-$BOTVERSION='0.2.0'
-$BOTCODENAME='avocado'
-$VERBOSITY = 0
-$MOD_SPOX_PATH = nil
-$DAEMON_BOT = false
-$LOGTO = $stdout
-$LOGLEVEL = :fatal
-$JDBC = false
+require 'mod_spox/Version'
 
+# lets get sequel setup like we want it #
+require 'sequel/extensions/migration'
+Sequel::Model.plugin :validation_helpers
+Sequel::Model.plugin :schema
 Sequel::Model.unrestrict_primary_key
+# okay, lets go #
 
 begin
     require 'mod_spox/Loader'
@@ -66,7 +64,7 @@ opts.each do |opt, arg|
             puts 'http://rubyforge.org/projects/modspox'
             exit
         when '--jdbc'
-            $JDBC = true
+            ModSpox.jdbc = true
             begin
                 require 'jdbc/postgres'
             rescue Object => boom
@@ -74,10 +72,10 @@ opts.each do |opt, arg|
                 exit 1
             end
         when '--debug'
-            if(arg && File.writable?(arg))
-                $LOGTO = arg
+            if(arg && arg.gsub(' ', '').size > 0)
+                ModSpox.logto = arg
             else
-                $LOGTO = $stdout
+                ModSpox.logto = $stdout
             end
         when '--config'
             require 'mod_spox/ConfigurationWizard'
@@ -85,28 +83,30 @@ opts.each do |opt, arg|
             BotConfig.configured? ? wizard.update : wizard.run
             exit
         when '--path'
-            $MOD_SPOX_PATH = arg
+            ModSpox.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
+            ModSpox.daemon_bot = true
         when '--verbosity'
-            if(arg && arg =~ /^(info|warn|fatal)$/)
-                $LOGLEVEL = arg.to_sym
+            if(arg && arg =~ /^(info|warn|error|fatal)$/)
+                ModSpox.loglevel = arg.to_sym
             end
     end
 end
 
-initialize_bot
+ModSpox.initialize_bot
 require 'mod_spox/Bot'
-
-if($DAEMON_BOT)
-    Daemonize.daemonize(nil, 'mod_spox')
+if(ModSpox.daemon_bot)
+    if(RUBY_VERSION > '1.9.0')
+        Process.daemon if ModSpox.daemon_bot
+    else
+        begin
+            require 'daemons'
+            Daemons.daemonize
+        rescue Object
+            puts "ERROR: Failed to load daemons gem"
+            exit 1
+        end
+    end
 end
-
 bot = Bot.new
 bot.run

data/data/mod_spox/extras/AOLSpeak.rb

@@ -5,9 +5,8 @@ class AOLSpeak < ModSpox::Plugin
     def initialize(pipeline)
         super
         group = Group.find_or_create(:name => 'banner')
-        Signature.find_or_create(:signature => 'aolspeak', :plugin => name, :method => 'aolspeak', :description => 'AOL speak')
-        Signature.find_or_create(:signature => 'aolkick (\S+) ?(\S+)?', :plugin => name, :method => 'aolkick', :description => 'AOL speak kick',
-            :group_id => group.pk).params = [:nick, :channel]
+        add_sig(:sig => 'aolspeak', :method => :aolspeak, :desc => 'AOL speak')
+        add_sig(:sig => 'aolkick (\S+) ?(\S+)?', :method => :aolkick, :desc => 'AOL speak kick', :group => group, :params => [:nick, :channel])
         build_aolspeak
     end
 

data/data/mod_spox/extras/AutoKick.rb

@@ -5,19 +5,13 @@ class AutoKick < ModSpox::Plugin
     def initialize(pipeline)
         super
         group = Group.find_or_create(:name => 'autokick')
-        Signature.find_or_create(:signature => 'autokick list', :plugin => name, :method => 'list', :group_id => group.pk,
-            :description => 'List active autokick rules')
-        Signature.find_or_create(:signature => 'autokick add (#\S+) (\d+) (\S+) (.+)', :plugin => name, :method => 'add',
-            :group_id => group.pk, :description => 'Add new autokick rule for current channel',
-            :requirement => 'public').params = [:channel, :time, :regex, :message]
-        Signature.find_or_create(:signature => 'autokick add (\d+) (\S+) (.+)', :plugin => name, :method => 'add',
-            :group_id => group.pk, :description => 'Add a new autokick rule').params = [:time, :regex, :message]
-        Signature.find_or_create(:signature => 'autokick remove (\d+)', :plugin => name, :method => 'remove',
-            :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]
+        add_sig(:sig => 'autokick list', :method => :list, :group => group, :desc => 'List active autokick rules')
+        add_sig(:sig => 'autokick add (#\S+) (\d+) (\S+) (.+)', :method => :add, :group => group, :desc => 'Add new autokick rule for current channel', :req => 'public', :params => [:channel, :time, :regex, :message])
+        add_sig(:sig => 'autokick add (\d+) (\S+) (.+)', :method => :add, :group => group, :desc => 'Add a new autokick rule', :params => [:time, :regex, :message])
+        add_sig(:sig => 'autokick remove (\d+)', :method => :remove, :group => group, :desc => 'Remove an autokick rule', :params => [:id])
+        add_sig(:sig => 'autokick colors ?(on|off)?', :method => :colors, :group => group, :desc => 'Kick user for using colors', :req => 'public', :params => [:action])
         @map = nil
-        @colors = Setting[:colorkick]
+        @colors = Setting.val(:colorkick)
         @colors = Array.new unless @colors.is_a?(Array)
         AutoKickRecord.create_table unless AutoKickRecord.table_exists?
         do_listen
@@ -138,9 +132,7 @@ class AutoKick < ModSpox::Plugin
             foreign_key :channel_id, :table => :channels
         end
 
-        def channel
-            ModSpox::Models::Channel[channel_id]
-        end
+        many_to_one :channel, :class => ModSpox::Models::Channel
     end
     
     class AutoKickPersonal < Sequel::Model
@@ -152,14 +144,9 @@ class AutoKick < ModSpox::Plugin
             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]
-        end
+
+        many_to_one :nick, :class => ModSpox::Models::Nick
+        many_to_one :channel, :class => ModSpox::Models::Channel
     end
 
 end

data/data/mod_spox/extras/AutoMode.rb

@@ -6,18 +6,12 @@ class AutoMode < ModSpox::Plugin
         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]
+        add_sig(:sig => 'addop (\S+)', :method => :addop, :group => @admin, :desc => 'Add a nick to the auto op list', :req => 'public', :params => [:nick])
+        add_sig(:sig => 'addvoice (\S+)', :method => :addvoice, :group => @admin, :desc => 'Add a nick to the auto voice list', :req => 'public', :params => [:nick])
+        add_sig(:sig => 'op', :method => :op, :group => @user, :desc => 'Instruct bot to give you operator status', :req => 'public')
+        add_sig(:sig => 'voice', :method => :voice, :group => @user, :desc => 'Instruct bot to give you voice status', :req => 'public')
+        add_sig(:sig => 'automode list (\S+)', :method => :list, :group => @admin, :desc => 'Show list of current auto-modes for channel', :params => [:channel])
+        add_sig(:sig => 'delmode (\S+)', :method => :remove, :group => @admin, :desc => 'Remove nick from any auto-modes in channel', :req => 'public', :params => [:nick])
         ModeRecord.create_table unless ModeRecord.table_exists?
         @pipeline.hook(self, :check_join, :Incoming_Join)
     end
@@ -63,7 +57,7 @@ class AutoMode < ModSpox::Plugin
         channel = Helpers.find_model(p[:channel], false)
         if(channel.is_a?(Channel))
             records = ModeRecord.filter(:channel_id => channel.pk)
-            if(records.size > 0)
+            if(records.count > 0)
                 reply m.replyto, "\2Auto-Mode Listing:\2"
                 sleep(0.01)
                 records.each do |record|
@@ -91,7 +85,7 @@ class AutoMode < ModSpox::Plugin
     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)
+        if(matches.count > 0)
             matches.each do |record|
                 mode = record.voice ? '+v' : '+o'
                 @pipeline << Messages::Outgoing::ChannelMode.new(m.channel, mode, m.nick.nick)
@@ -106,7 +100,7 @@ class AutoMode < ModSpox::Plugin
     
     def remove_modee(nick)
         modee = Group.find_or_create(:name => 'modee')
-        if(ModeRecord.filter(:nick_id => nick.pk).size < 1)
+        if(ModeRecord.filter(:nick_id => nick.pk).count < 1)
             nick.remove_group(modee)
         end
     end
@@ -119,14 +113,9 @@ class AutoMode < ModSpox::Plugin
             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
+
+        many_to_one :channel, :class => ModSpox::Models::Channel
+        many_to_one :nick, :class => ModSpox::Models::Nick
     end
     
 end

data/data/mod_spox/extras/Bash.rb

@@ -0,0 +1,55 @@
+# ex: set ts=4 et:
+require "net/http"
+require "cgi"
+
+# bash.org quote plugin
+# by pizza
+
+class Bash < ModSpox::Plugin
+
+    def initialize(pipeline)
+        super
+        add_sig(:sig => 'bash( (top|latest|#\d+))?', :method => :random, :desc => 'Bash quote fetcher', :params => [:wspace, :cmd])
+        @site = 'http://bash.org/'
+    end
+    
+    def random(m, params)
+        begin
+            u = @site + '?top'
+            if 'latest' == params[:cmd]
+              u = @site + '?latest'
+            elsif /^#(\d+)$/.match(params[:cmd])
+              u = @site + '?' + $1
+            end
+            reply m.replyto, get_text(u)
+        rescue Object => boom
+            error m.replyto, "Failed to fetch. #{boom}"
+        end
+    end
+    
+    private
+    
+    def get_text(url)
+        begin
+            data = Net::HTTP.get_response(URI.parse(url)).body
+            # parse individual entries, they have a "qt" section within "quote"
+            m = data.scan(/<p class="qt">(.*?)<\/p>/m)
+            raise 'No quotes found' unless m.length > 0
+            if m.length > 1
+                m = m.delete_if{|x| x[0].length > 200 }
+                raise 'Only overly long quotes found' unless m.length > 0
+            end
+            i = rand(m.length)                  # NOTE: this works fine for individuals, since rand(1) is always 0
+            n = m[i][0].gsub(/<[^<]+>/, '')     # select a random quote
+            o = Helpers.convert_entities(n)     # unescape html entities
+            p = o.gsub("\r\n", " ").strip       # replace newlines with spaces and trim
+            q = p.gsub(/(<([^>]+)>(?:[^<]+))<\2>/){ $1 }    # replace duplicated name tags; condense lines
+            r = q.gsub(/\s{2,}/, ' ')           # condense spaces
+            return r
+        rescue Object => boom
+            Logger.error(boom)
+            raise boom
+        end
+    end
+end
+

data/data/mod_spox/extras/Bouncer.rb

@@ -1,44 +1,34 @@
+require 'openssl'
+
 class Bouncer < ModSpox::Plugin
-    
-    include Models
-    
+
     def initialize(pipeline)
         super
-        admin = Group.find_or_create(:name => 'bouncer')
-        Signature.find_or_create(:signature => 'bouncer port ?(\d+)?', :plugin => name, :method => 'port',
-            :group_id => admin.pk, :description => 'Show or set bouncer port').params = [:port]
-        Signature.find_or_create(:signature => 'bouncer (start|stop|restart)', :plugin => name, :method => 'do_service',
-            :group_id => admin.pk, :description => 'Start or stop the bouncer').params = [:action]
-        Signature.find_or_create(:signature => 'bouncer status', :plugin => name, :method => 'status',
-            :group_id => admin.pk, :description => 'Show current bouncer status')
-        Signature.find_or_create(:signature => 'bouncer disconnect', :plugin => name, :method => 'disconnect',
-            :group_id => admin.pk, :description => 'Disconnect all users connected to bouncer')
-        Signature.find_or_create(:signature => 'bouncer clients', :plugin => name, :method => 'clients',
-            :group_id => admin.pk, :description => 'List clients connected to bouncer')
+        bounce = Group.find_or_create(:name => 'bouncer')
+        add_sig(:sig => 'bouncer port( (\d+))?', :method => :port, :group => bounce, :desc => 'Show or set bouncer port',
+            :params => [:port])
+        add_sig(:sig => 'bouncer (start|stop|restart)', :method => :do_service, :group => bounce, :desc => 'Start, stop, or restart bouncer')
+        add_sig(:sig => 'bouncer status', :method => :status, :group => bounce, :desc => 'Show current bouncer status')
+        add_sig(:sig => 'bouncer disconnect', :method => :disconnect, :group => bounce, :desc => 'Disconnect all connected clients')
+        add_sig(:sig => 'bouncer clients'< :method => :clients, :group => bounce, :desc => 'List clients connected to bouncer')
         @pipeline.hook(self, :get_msgs, :Incoming)
         @listener = nil
         @clients = []
         @socket = nil
         @processor = nil
         @to_server = Queue.new
-        if(Config[:bouncer_port])
-            start_listener
-        end
+        start_listener if Models::Config.filter(:name => 'bouncer_port').count > 0
     end
     
     def get_msgs(message)
         unless(@clients.empty?)
-        Logger.info("BOUNCER: Sending to #{@clients.size} clients")
+            Logger.info("Bouncer has #{@clients.size} clients to send a message to")
             @clients.each do |client|
                 begin
-                    if(message.raw_content.is_a?(Array))
-                        message.raw_content.each do |m|
-                            client[:connection].puts(m + "\n")
-                        end
-                    else
-                        client[:connection].puts(message.raw_content + "\n")
-                    end
+                    output = message.raw_content.is_a?(Array) ? message.raw_content.join("\n") : message.raw_content + "\n"
+                    client[:connection].puts(output)
                 rescue Object => boom
+                    Logger.warn("Bouncer encountered unexpected error. Disconnecting client. #{boom}")
                     client[:thread].kill if client[:thread].alive?
                     @clients.delete(client)
                 end
@@ -46,54 +36,92 @@ class Bouncer < ModSpox::Plugin
         end
     end
     
-    def port(message, params)
-        unless(params[:port])
-            if(Config[:bouncer_port])
-                reply message.replyto, "Bouncer is currently listening on port: #{Config[:bouncer_port]}"
+    def port(m, params)
+        if(params[:port])
+            if(Models::Config.filter(:name => 'bouncer_port').count > 0)
+                reply m.replyto, "Bouncer port is set to: #{Models::Config.filter(:name => 'bouncer_port').first.value
             else
-                reply message.replyto, "\2Warning:\2 Listening port is not currently set for bouncer"
+                error m.replyo, 'No port has been set for bouncer'
             end
         else
-            Config[:bouncer_port] = params[:port].to_i
-            reply message.replyto, "Bouncer will now listen on port: #{params[:port].to_i}"
-            restart_listener
+            parmas[:port].strip!
+            c = Models::Config.find_or_create(:name => 'bouncer_port')
+            c.value = params[:port]
+            c.save
+            information m.replyto, "Bouncer port is not set to: #{params[:port]}"
         end
     end
     
-    def do_service(message, params)
-        if(params[:action] == 'start')
-            if(listening?)
-                reply message.replyto, "\2Error:\2 Bouncer is already running"
-            else
-                start_listener
-                reply message.replyto, "Bouncer has been started"
-            end
-        elsif(params[:action] == 'stop')
-            if(listening?)
+    def do_service(m, params)
+        begin
+            case params[:action]
+            when 'start'
+                if(listening?)
+                    error m.replyto, 'Bouncer is already running'
+                else
+                    start_listener
+                    information m.replyto, 'Bouncer has been started'
+                end
+            when 'stop'
+                if(listening?)
+                    stop_listener
+                    information m.replyto, 'Bouncer has been stopped'
+                else
+                    error m.replyto, 'Bouncer is not currently running'
+                end
+            when 'restart'
                 stop_listener
-                reply message.replyto, "Bouncer has been stopped"
-            else
-                reply message.replyto, "\2Error:\2 Bouncer is not currently running"
+                start_listener
+                information m.replyto, 'Bouncer has been restarted'
             end
-        elsif(params[:action] == 'restart')
-            stop_listener
-            start_listener
-            reply message.replyto, "Bouncer has been restarted"
+        rescue Object => boom
+            error m.replyto, "Error was encountered during #{params[:action]} process. (#{boom})"
         end
     end
-    
-    def disconnect(message, params)
+
+    def disconnect(m, params)
         unless(@clients.empty?)
-            @clients.each do |socket|
-                socket[:connection].close
-                @clients.delete(socket)
+            @clients.each do |client|
+                client[:connection].close unless client[:connection].closed?
+                @clients.delete(client)
             end
-            reply message.replyto, "Bouncer has disconnected all clients"
+            information m.replyto, 'All clients have been disconnected'
         else
-            reply message.replyto, "\2Error:\2 No clients connected to bouncer"
+            warning m.replyto, 'No clients are connected to bouncer'
         end
     end
     
+    def status(m, params)
+        warning m.replyto, 'not implemented'
+    end
+
+    private
+    
+    def start_listener
+        port = Models::Config.filter(:name => 'bouncer_port').first
+        raise 'Port has not been set' unless port
+        port = port.value.to_i
+        @socket = OpenSSL::SSL::SSLServer.new(port)
+        @listener = Thread.new do
+            until(@socket.closed?)
+                begin
+                    new_con = @socket.accept_nonblock
+                    add_client(new_con)
+                rescue Errno::EAGAIN, Errno::EWOULDBLOCK, Errno::ECONNABORTED, Errno::EPROTO, Errno::EINTR
+                        IO.select([@socket])
+                        retry
+                rescue Object => boom
+                    Logger.warn "Bouncer listener encountered an error: #{boom}"
+                end
+            end
+        end
+    end
+    
+    def add_client
+    end
+
+class Bouncer < ModSpox::Plugin
+    
     def status(message, params)
     end