mod_spox 0.0.1

data/lib/mod_spox/messages/outgoing/WhoWas.rb

@@ -0,0 +1,23 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class WhoWas
+                # nick to whowas
+                attr_reader :nick
+                # number of entries to return
+                attr_reader :count
+                # target server
+                attr_reader :target
+                # nick:: nick to whowas
+                # count:: number of entries to return
+                # target:: target server
+                # Information about a nick that no longer exists
+                def initialize(nick, count='', target='')
+                    @nick = nick
+                    @count = count
+                    @target = target
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/messages/outgoing/Whois.rb

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Whois
+                # nick to whois
+                attr_reader :nick
+                # server to query
+                attr_reader :target_server
+                # nick:: nick to whois
+                # target_server:: server to query
+                # Query information about a user
+                def initialize(nick, target_server='')
+                    @nick = nick
+                    @target_server = target_server
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_auths.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateAuths < Sequel::Migration
+            def up
+                Models::Auth.create_table unless Models::Auth.table_exists?
+            end
+            
+            def down
+                Models::Auth.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_channel.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateChannels < Sequel::Migration
+            def up
+                Models::Channel.create_table unless Models::Channel.table_exists?
+            end
+            
+            def down
+                Models::Channel.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_channel_modes.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateChannelModes < Sequel::Migration
+            def up
+                Models::ChannelMode.create_table unless Models::ChannelMode.table_exists?
+            end
+            
+            def down
+                Models::ChannelMode.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_config.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateConfigs < Sequel::Migration
+            def up
+                Models::Config.create_table unless Models::Config.table_exists?
+            end
+            
+            def down
+                Models::Config.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_nick_channels.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateNickChannels < Sequel::Migration
+            def up
+                Models::NickChannel.create_table unless Models::NickChannel.table_exists?
+            end
+            
+            def down
+                Models::NickChannel.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_nick_modes.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateNickModes < Sequel::Migration
+            def up
+                Models::NickMode.create_table unless Models::NickMode.table_exists?
+            end
+            
+            def down
+                Models::NickMode.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_nicks.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateNicks < Sequel::Migration
+            def up
+                Models::Nick.create_table unless Models::Nick.table_exists?
+            end
+            
+            def down
+                Models::Nick.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_servers.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateServers < Sequel::Migration
+            def up
+                Models::Server.create_table unless Models::Server.table_exists?
+            end
+            
+            def down
+                Models::Server.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_settings.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateSettings < Sequel::Migration
+            def up
+                Models::Setting.create_table unless Models::Setting.table_exists?
+            end
+            
+            def down
+                Models::Setting.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_signatures.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateSignatures < Sequel::Migration
+            def up
+                Models::Signature.create_table unless Models::Signature.table_exists?
+            end
+            
+            def down
+                Models::Signature.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/migration/001_create_triggers.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Migrators
+        class CreateTriggers < Sequel::Migration
+            def up
+                Models::Trigger.create_table unless Models::Trigger.table_exists?
+            end
+            
+            def down
+                Models::Trigger.drop_table
+            end
+        end
+    end
+end

data/lib/mod_spox/models/Auth.rb

@@ -0,0 +1,79 @@
+require 'digest/sha1'
+module ModSpox
+    module Models
+    
+            # Attributes provided by model:
+            # password:: Password to autenticate against
+            # services:: Authentication by nickserv
+            # mask:: Mask to authenticate source against
+            # authed:: Nick has authenticated
+        class Auth < Sequel::Model(:auths)
+            
+            # Nick associated with this Auth
+            def nick
+                Nick[nick_id]
+            end
+            
+            def services
+                s = values[:services]
+                if(s == 0 || s == '0' || !s)
+                    return false
+                else
+                    return true
+                end
+            end
+            
+            # Groups this auth is a member of
+            def groups
+                # we grab IDs, then the object. Otherwise we get sync problems
+                group_id = []
+                AuthGroup.filter(:auth_id => pk).each do |ag|
+                    group_id << ag.group_id
+                end
+                group = []
+                group_id.each{|id| group << Group[id]}
+                return group
+            end
+            
+            # Add group to this auth's list
+            def group=(group)
+                AuthGroup.find_or_create(:auth_id => pk, :group_id => group.pk)
+            end
+            
+            # Remove given group from auth
+            def remove_group(group)
+                AuthGroup.filter(:auth_id => pk, :group_id => group.pk).each{|g|g.destroy}
+            end
+            
+            # Set services (nickserv) identification
+            def services_identified=(val)
+                set :authed => true if val && services
+            end
+            
+            # pass:: password to compare
+            # Check and authenticate against password
+            def check_password(pass)
+                if(Digest::SHA1.hexdigest(pass) == password)
+                    set :authed => true
+                    return true
+                else
+                    return false
+                end
+            end
+            
+            def password=(pass)
+                set :password => Digest::SHA1.hexdigest(pass)
+            end
+            
+            # source:: source to apply mask to
+            # Check and authenticate by mask against source
+            def check_mask(source)
+                if(source =~ /^#{mask}$/)
+                    set :authed => true
+                end
+            end
+            
+        end
+        
+    end
+end

data/lib/mod_spox/models/AuthGroup.rb

@@ -0,0 +1,15 @@
+module ModSpox
+    module Models
+        class AuthGroup < Sequel::Model(:auth_groups)
+            set_primary_key [:group_id, :auth_id]
+            
+            def auth
+                Auth[auth_id]
+            end
+            
+            def group
+                Group[group_id]
+            end
+        end
+    end
+end

data/lib/mod_spox/models/Channel.rb

@@ -0,0 +1,47 @@
+module ModSpox
+    module Models
+
+        # Attributes provided by model:
+        # name:: Channel name
+        # password:: Channel password
+        # autojoin:: Set bot to autojoin this channel
+        # topic:: Channel topic
+        # quiet:: Silence the bot in this channel
+        # parked:: Bot is currently in this channel
+        class Channel < Sequel::Model(:channels)
+            
+            # Modes for this channel
+            def channel_modes
+                ChannelMode.filter(:channel_id => pk)
+            end
+            
+            # Nicks residing within this channel
+            def nicks
+                NickChannel.filter(:channel_id => pk)
+            end
+            
+            # Adds a nick to this channel
+            def nick_add(nick)
+                NickChannel.find_or_create(:channel_id => pk, :nick_id => nick.pk)
+            end
+            
+            # Removes a nick from this channel
+            def nick_remove(nick)
+                NickChannel.filter(:channel_id => pk, :nick_id => nick.pk).first.destroy
+            end
+            
+            # Removes all nicks from this channel
+            def clear_nicks
+                NickChannel.filter(:channel_id => pk, :nick_id => nick.pk).each{|o| o.destroy}
+            end
+
+            # Purges all channel information
+            def self.clean
+                Channel.set(:topic => nil, :parked => false)
+                ChannelMode.destroy_all
+            end
+
+        end
+
+    end
+end

data/lib/mod_spox/models/ChannelMode.rb

@@ -0,0 +1,14 @@
+module ModSpox
+    module Models
+        # Attribute provided by model:
+        # mode:: mode that is set
+        class ChannelMode < Sequel::Model(:channel_modes)
+        
+            # Channel this mode is associated to
+            def channel
+                Channel[channel_id]
+            end
+
+        end
+    end
+end

data/lib/mod_spox/models/Config.rb

@@ -0,0 +1,31 @@
+module ModSpox
+    module Models
+        # Attributes provided by model:
+        # name:: name of the config item
+        # value:: value of the config item
+        # 
+        # It is important to note this model is for storing configuration
+        # values only. It will only store strings, not complex objects. If
+        # you need to store an object, use the Setting model.
+        class Config < Sequel::Model(:configs)
+
+            # key:: name of the config item
+            # Returns the value of config item named the given key
+            def self.[](key)
+                key = key.to_s if key.is_a?(Symbol)
+                match = Config.filter(:name => key).first
+                return match ? match.value : nil
+            end
+            
+            # key:: name of the config item
+            # val:: value of the config item
+            # Modifies or creates config item and stores the value
+            def self.[]=(key, val)
+                key = key.to_s if key.is_a?(Symbol)
+                model = Config.find_or_create(:name => key)
+                model.value = val
+                model.save
+            end
+        end
+    end
+end

data/lib/mod_spox/models/Group.rb

@@ -0,0 +1,13 @@
+module ModSpox
+    module Models
+        class Group < Sequel::Model(:groups)
+            def auths
+                auth = []
+                AuthGroup.filter(:group_id => pk).each do |ag|
+                    auth << ag.auth
+                end
+                return auth
+            end
+        end
+    end
+end

data/lib/mod_spox/models/Nick.rb

@@ -0,0 +1,110 @@
+module ModSpox
+    module Models
+        # Attributes provided by model:
+        # nick:: nick string
+        # username:: username of the user
+        # real_name:: real name of the user
+        # address:: hostname/ip of the user
+        # source:: full source string of the user
+        # connected_at:: time user connected
+        # connected_to:: server user connected to
+        # seconds_idle:: seconds user has been idle
+        # visible:: can the bot see the user (is in a channel the bot is parked)
+        # away:: is nick away
+        # botnick:: is the nick of the bot
+         
+        # TODO: for nick field -> "tack a COLLATE NOCASE onto the columns"
+        class Nick < Sequel::Model(:nicks)
+            
+            def visible=(val)
+                unless(val)
+                    set :username => nil
+                    set :real_name => nil
+                    set :address => nil
+                    set :source => nil
+                    set :connected_at => nil
+                    set :connected_to => nil
+                    set :seconds_idle => nil
+                    set :away => false
+                end
+                set :visible => val
+            end
+                    
+            def source=(mask)
+                set :source => mask
+                auth.check_mask(mask)
+            end
+            
+            # Auth model associated with nick
+            def auth
+                Auth.find_or_create(:nick_id => pk)
+            end
+            
+            # AuthGroups nick is authed to
+            def auth_groups
+                groups = []
+                auth_ids = []
+                group_ids = []
+                auth = Auth.filter(:nick_id => pk, :authed => true).first
+                if(auth)
+                    groups = auth.groups
+                end
+                Auth.where('mask is not null').each do |a|
+                    Logger.log("Matching AUTH against #{a.mask}", 30)
+                    if(source =~ /#{a.mask}/)
+                        auth_ids << a.pk
+                    end
+                end
+                auth_ids.each{|id| AuthGroup.filter(:auth_id => id).each{|ag| group_ids << ag.group_id}}
+                group_ids.each{|id| groups << Group[id]}
+                groups.uniq!
+                return groups
+            end
+            
+            # Set nick as member of given group
+            def group=(group)
+                auth.group = group
+            end
+            
+            # Remove nick from given group
+            def remove_group(group)
+                auth.remove_group(group)
+            end
+            
+            # Modes associated with this nick
+            def nick_modes
+                NickMode.filter(:nick_id => pk)
+            end
+            
+            # Add channel nick is found in
+            def channel_add(channel)
+                NickChannel.find_or_create(:nick_id => pk, :channel_id => channel.pk)
+            end
+            
+            # Remove channel nick is no longer found in
+            def channel_remove(channel)
+                NickChannel.filter(:nick_id => pk, :channel_id => channel.pk).first.destroy
+            end
+            
+            # Remove all channels
+            def clear_channels
+                NickChannel.filter(:nick_id => pk).each{|o|o.destroy}
+            end
+            
+            # Channels nick is currently in
+            def channels
+                NickChannel.filter(:nick_id => pk)
+            end
+            
+            # Purge all nick information
+            def self.clean
+                Nick.set(:username => nil, :real_name => nil, :address => nil,
+                                   :source => nil, :connected_at => nil, :connected_to => nil,
+                                   :seconds_idle => nil, :away => false, :visible => false, :botnick => false)
+                NickMode.destroy_all
+                Auth.set(:authed => false)
+            end
+        
+        end
+    end
+end

data/lib/mod_spox/models/NickChannel.rb

@@ -0,0 +1,43 @@
+module ModSpox
+    module Models
+        # This model is for internal use only to provide a
+        # proper relation between Nick and Channel
+        class NickChannel < Sequel::Model(:nick_channels)
+            
+            set_primary_key [:nick_id, :channel_id]
+            
+            after_save do
+                c = Channel[channel_id]
+                n = Nick[nick_id]
+                n.visible = true
+                n.save
+                c.parked = true
+                c.save
+            end
+            
+            after_destroy do
+                c = Channel[channel_id]
+                n = Nick[nick_id]
+                if(n.channels.size < 1)
+                    n.visible = false
+                    n.save
+                    NickMode.filter(:nick_id => nick_id).each{|n|n.destroy}
+                end
+                if(c.nicks.size < 1)
+                    c.parked = false
+                    c.save
+                    NickMode.filter(:channel_id => channel_id).each{|n|n.destroy}
+                    ChannelMode.filter(:channel_id => channel_id).each{|n|n.destroy}
+                end
+            end
+            
+            def nick
+                Nick[nick_id]
+            end
+            
+            def channel
+                Channel[channel_id]
+            end
+        end
+    end
+end

data/lib/mod_spox/models/NickMode.rb

@@ -0,0 +1,18 @@
+module ModSpox
+    module Models
+        # Attributes provided by model:
+        # mode:: Mode that is set
+        class NickMode < Sequel::Model(:nick_modes)
+            
+            # Nick mode is associated with
+            def nick
+                return Nick[nick_id]
+            end
+            
+            # Channel mode is associated with
+            def channel
+                return Channel[channel_id]
+            end
+        end
+    end
+end

data/lib/mod_spox/models/Server.rb

@@ -0,0 +1,12 @@
+module ModSpox
+    module Models
+        # Attributes provided by model:
+        # host:: hostname of server
+        # port:: port to connect to
+        # priority:: priority of this entry (higher number == greater priority)
+        # connected:: bot is connected to this server
+        class Server < Sequel::Model(:servers)
+            set_primary_key [:host, :port]
+        end
+    end
+end

data/lib/mod_spox/models/Setting.rb

@@ -0,0 +1,40 @@
+require 'base64'
+
+module ModSpox
+    module Models
+        # Attributes provided by model:
+        # name:: name of the setting
+        # value:: value of the setting
+        # 
+        # This model can be used to store complex objects. These objects are dumped
+        # and stored for later retrieval
+        class Setting < Sequel::Model(:settings)
+            
+            def value=(val)
+                set(:value => Base64.encode64(Marshal.dump(val)))
+            end
+            
+            def value
+                return values[:value] ? Marshal.load(Base64.decode64(values[:value])) : nil
+            end
+            
+            # key:: name of the setting
+            # Returns the setting with the given name
+            def self.[](key)
+                key = key.to_s if key.is_a?(Symbol)
+                setting = Setting.filter(:name => key).first
+                return setting ? setting.value : nil
+            end
+            
+            # key:: name of the setting
+            # val:: value of the setting
+            # Stores the val in setting named by the given key            
+            def self.[]=(key, val)
+                key = key.to_s if key.is_a?(Symbol)
+                model = Setting.find_or_create(:name => key)
+                model.value = val
+                model.save
+            end
+        end
+    end
+end

data/lib/mod_spox/models/Signature.rb

@@ -0,0 +1,30 @@
+module ModSpox
+    module Models
+        # Attributes provided by model:
+        # signature:: regex signature
+        # params:: Array of parameters to match in signature
+        # method:: method to call when matched
+        # plugin:: plugin to call when matched
+        # description:: description of trigger
+        class Signature < Sequel::Model(:signatures)
+            
+            def params=(prms)
+                raise InvalidType.new('Parameter names must be provided in an array') unless prms.kind_of?(Array)
+                set(:params => prms.reverse.join('|'))
+            end
+        
+            def params
+                return values[:params].nil? ? [] : values[:params].split('|')
+            end
+            
+            def group
+                Group[group_id]
+            end
+            
+            def group=(group)
+                set :group_id => group.pk
+            end
+
+        end
+    end
+end

data/lib/mod_spox/models/Trigger.rb

@@ -0,0 +1,9 @@
+module ModSpox
+    module Models
+        # Attributes provided by model:
+        # trigger:: trigger to match
+        # active:: trigger is active
+        class Trigger < Sequel::Model(:triggers)
+        end
+    end
+end