spox-mod_spox 0.3.1

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

@@ -0,0 +1,17 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Pong
+                # server:: server to send to
+                attr_reader :server
+                # string:: string
+                attr_reader :string
+                # Send a pong
+                def initialize(server, string)
+                    @server = server
+                    @string = string
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,43 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Privmsg
+                # target for the message
+                attr_reader :target
+                # the message
+                attr_reader :message
+                # type of CTCP message
+                attr_reader :ctcp_type
+                # target:: target for the message
+                # message:: message to be sent
+                # Send a message to user or channel. Setting action to true
+                # is a shortcut to setting ctcp parameters. The action parameter
+                # will override the ctcp parameters if all are set
+                def initialize(target, message, action=false, ctcp=false, ctcp_type=nil)
+                    @target = target
+                    @message = message
+                    @action = action
+                    @ctcp = ctcp
+                    @ctcp_type = ctcp_type.upcase unless ctcp_type.nil?
+                    if(@action)
+                        @ctcp = true
+                        @ctcp_type = 'ACTION'
+                    end
+                    if(!@action && !@ctcp_type.nil?)
+                        @action = true if @ctcp_type == 'ACTION'
+                    end
+                end
+                
+                # is message an action
+                def is_action?
+                    return @action
+                end
+                
+                # is message CTCP
+                def is_ctcp?
+                    return @ctcp
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,11 @@
+require 'mod_spox/messages/outgoing/Simple'
+module ModSpox
+    module Messages
+        module Outgoing
+            # message:: quit messages
+            # Disconnects the bot from the IRC server
+            class Quit < Simple
+            end
+        end
+    end
+end

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

@@ -0,0 +1,16 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # Sends message to IRC server with no modification
+            class Raw
+                # message to send
+                attr_reader :message
+                # message:: message to send
+                # Creates new Raw message
+                def initialize(message)
+                    @message = message
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,9 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # Force server to re-read config file (oper command)
+            class Rehash
+            end
+        end
+    end
+end

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

@@ -0,0 +1,9 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # Restart the server (oper command)
+            class Restart
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class ServList
+                # mask
+                attr_reader :mask
+                # type
+                attr_reader :type
+                # mask:: mask
+                # type:: type
+                # List services currently connected to network
+                def initialize(mask, type)
+                    @mask = mask
+                    @type = type
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,12 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Simple
+                attr_reader :message
+                def initialize(message)
+                    @message = message
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Squery
+                # service to query
+                attr_reader :service_name
+                # message to send to service
+                attr_reader :message
+                # service_name:: name of the service to query
+                # message:: message to send to service
+                # Send message to a service
+                def initialize(service_name, message)
+                    @service_name = service_name
+                    @message = message
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Squit
+                # server to disconnect
+                attr_reader :server
+                # reasone for disconnection
+                attr_reader :comment
+                # server:: server to disconnect
+                # comment:: reason for disconnection
+                # Disconnect server link. Only available if bot is oper.
+                def initialize(server, comment)
+                    @comment = comment
+                    @server = server
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,18 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Stats
+                # the query
+                attr_reader :query
+                # target server
+                attr_reader :target
+                # query:: single character for query
+                # target:: target server to query (or connected server if unset)
+                def initialize(query, target='')
+                    @query = query
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,23 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Summon
+                # nick to summon
+                attr_reader :nick
+                # server nick is on
+                attr_reader :target
+                # channel to summon to
+                attr_reader :channel
+                # nick:: nick to summon
+                # target:: server which nick is on
+                # channel:: channel to summon to
+                # Summon a user
+                def initialize(nick, target='', channel='')
+                    @nick = nick
+                    @channel = channel
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Time
+                # target server
+                attr_reader :target
+                # target:: target server
+                # Request time on server
+                def initialize(channel, target='')
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Topic
+                # channel to set topic
+                attr_reader :channel
+                # the topic
+                attr_reader :topic
+                # channel:: channel to set topic in
+                # topic:: the topic
+                # Set the topic for the channel
+                def initialize(channel, topic)
+                    @channel = channel
+                    @topic = topic
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Trace
+                # target to trace to
+                attr_reader :target
+                # target:: target to trace to
+                # Find route to specifc server
+                def initialize(target)
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,9 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            # Set status as not away
+            class Unaway
+            end
+        end
+    end
+end

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

@@ -0,0 +1,23 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class User
+                # username of user
+                attr_reader :username
+                # real name of user
+                attr_reader :real_name
+                # mode of user
+                attr_reader :mode
+                # username:: username of user
+                # real_name:: real name of user
+                # mode:: default mode (see RFC 2812 for proper mode values)
+                # Create new User message
+                def initialize(username, real_name, mode=0)
+                    @username = username
+                    @real_name = real_name
+                    @mode = mode
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class UserHost
+                # nick to query
+                attr_reader :nick
+                # nick:: nick to query
+                # Request host of nick
+                def initialize(nick)
+                    @nick = nick
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,19 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class UserMode
+                # The bot's nick
+                attr_reader :nick
+                # mode to set/unset
+                attr_reader :mode
+                # nick:: The bot's nick
+                # mode:: mode to set/unset
+                # Create UserMode message
+                def initialize(nick, mode)
+                    @nick = nick
+                    @mode = mode
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,15 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Users
+                # target server
+                attr_reader :target
+                # target:: target server
+                # List users on server
+                def initialize(target='')
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,16 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Version
+                # target server to query
+                attr_reader :target
+                # target:: target server to query
+                # Query version of server. Connected server is queried
+                # if target is not defined
+                def initialize(target='')
+                    @target = target
+                end
+            end
+        end
+    end
+end

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

@@ -0,0 +1,23 @@
+module ModSpox
+    module Messages
+        module Outgoing
+            class Who
+                # mask to match
+                attr_reader :mask
+                # return only ops
+                attr_reader :op_only
+                # mask:: mask of clients to match
+                # only_ops:: only return operators
+                # Query for information matching given mask
+                def initialize(mask, op_only=false)
+                    @mask = mask
+                    @op_only = op_only
+                end
+                
+                def only_ops?
+                    return op_only
+                end
+            end
+        end
+    end
+end

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/migrations/001_initialize_models.rb

@@ -0,0 +1,115 @@
+module ModSpox
+    module Migrations
+        class InitializeModels < Sequel::Migration
+
+            def up
+                Database.db << "SET FOREIGN_KEY_CHECKS = 0" if Database.type == :mysql
+                Database.db.create_table(:nicks) do
+                    primary_key :id, :null => false
+                    varchar :nick, :null => false, :unique => true
+                    varchar :username
+                    varchar :real_name
+                    varchar :address
+                    varchar :host
+                    varchar :source
+                    timestamp :connected_at
+                    varchar :connected_to
+                    integer :seconds_idle
+                    boolean :visible, :null => false, :default => false
+                    boolean :away, :null => false, :default => false
+                    boolean :botnick, :null => false, :default => false
+                end unless Database.db.table_exists?(:nicks)
+                Database.db.create_table(:channels) do
+                    primary_key :id, :null => false
+                    varchar :name, :null => false, :unique => true
+                    varchar :password
+                    boolean :autojoin, :null => false, :default => false
+                    varchar :topic
+                    boolean :quiet, :null => false, :default => false
+                    boolean :parked, :null => false, :default => false
+                end unless Database.db.table_exists?(:channels)
+                Database.db.create_table(:auths) do
+                    primary_key :id, :null => false
+                    varchar :password
+                    boolean :services, :null => false, :default => false
+                    varchar :mask, :unique => true, :default => nil
+                    boolean :authed, :null => false, :default => false
+                    foreign_key :nick_id, :table => :nicks, :unique => true, :null => false, :key => :id
+                end unless Database.db.table_exists?(:auths)
+                Database.db.create_table(:groups) do
+                    primary_key :id, :null => false
+                    varchar :name, :null => false, :unique => true
+                end unless Database.db.table_exists?(:groups)
+                Database.db.create_table(:configs) do
+                    primary_key :id, :null => false
+                    varchar :name, :null => false, :unique => true
+                    varchar :value
+                end unless Database.db.table_exists?(:configs)
+                Database.db.create_table(:servers) do
+                    primary_key :id, :null => false
+                    varchar :host, :null => false
+                    integer :port, :null => false, :default => 6667
+                    integer :priority, :null => false, :default => 0
+                    boolean :connected, :null => false, :default => false
+                    index [:host, :port], :unique => true
+                end unless Database.db.table_exists?(:servers)
+                Database.db.create_table(:settings) do
+                    primary_key :id, :null => false
+                    varchar :name, :null => false, :unique => true
+                    text :value
+                end unless Database.db.table_exists?(:settings)
+                Database.db.create_table(:signatures) do
+                    primary_key :id, :null => false
+                    varchar :signature, :null => false
+                    varchar :params
+                    foreign_key :group_id, :table => :groups, :default => nil, :key => :id
+                    varchar :method, :null => false
+                    varchar :plugin, :null => false
+                    varchar :description
+                    varchar :requirement, :null => false, :default => 'both'
+                end unless Database.db.table_exists?(:signatures)
+                Database.db.create_table(:triggers) do
+                    primary_key :id, :null => false
+                    varchar :trigger, :unique => true, :null => false
+                    boolean :active, :null => false, :default => false
+                end unless Database.db.table_exists?(:triggers)
+                Database.db.create_table(:auth_groups) do
+                    foreign_key :group_id, :table => :groups, :null => false, :key => :id
+                    foreign_key :auth_id, :table => :auths, :null => false, :key => :id
+                    primary_key [:group_id, :auth_id]
+                end unless Database.db.table_exists?(:auth_groups)
+                Database.db.create_table(:channel_modes) do
+                    primary_key :id, :null => false
+                    varchar :mode, :null => false
+                    foreign_key :channel_id, :table => :channels, :unique => true, :null => false, :key => :id
+                end unless Database.db.table_exists?(:channel_modes)
+                Database.db.create_table(:nick_channels) do
+                    foreign_key :nick_id, :table => :nicks, :null => false, :key => :id
+                    foreign_key :channel_id, :table => :channels, :null => false, :key => :id
+                    primary_key [:nick_id, :channel_id]
+                end unless Database.db.table_exists?(:nick_channels)
+                Database.db.create_table(:nick_groups) do
+                    foreign_key :group_id, :table => :groups, :null => false, :key => :id
+                    foreign_key :nick_id, :table => :nicks, :null => false, :key => :id
+                    primary_key [:nick_id, :group_id]
+                end unless Database.db.table_exists?(:nick_groups)
+                Database.db.create_table(:nick_modes) do
+                    primary_key :id, :null => false
+                    varchar :mode, :null => false
+                    foreign_key :nick_id, :table => :nicks, :null => false, :key => :id
+                    foreign_key :channel_id, :table => :channels, :key => :id
+                    index [:nick_id, :channel_id]
+                end unless Database.db.table_exists?(:nick_modes)
+                Database.db << "SET FOREIGN_KEY_CHECKS = 1" if Database.type == :mysql
+            end
+
+            def down
+                [:nick_modes, :nick_groups, :nick_channels, :channel_modes, :auth_groups,
+                 :triggers, :signatures, :settings, :servers, :configs, :groups, :auths,
+                 :channels, :nicks].each do |table|
+                    Database.db.drop_table(table) if Database.db.table_exists?(table)
+                end
+            end
+        end
+    end
+end

data/lib/mod_spox/migrations/002_persistent_sigs.rb

@@ -0,0 +1,14 @@
+module ModSpox
+    module Migrations
+        class PersistentSigs < Sequel::Migration
+
+            def up
+                Database.db.add_column :signatures, :enabled, :boolean, :null => false, :default => true
+            end
+            
+            def down
+                Database.db.drop_column :signatures, :enabled
+            end
+        end
+    end
+end

data/lib/mod_spox/migrations/003_auth_restructure.rb

@@ -0,0 +1,31 @@
+module ModSpox
+    module Migrations
+        class AuthRestructureModeFix < Sequel::Migration
+
+            def up
+                Database.db.drop_column :auths, :mask
+                Database.db.create_table(:auth_masks) do
+                    primary_key :id, :null => false
+                    varchar :mask, :null => false, :unique => true
+                end
+                Database.db.create_table(:auth_masks_groups) do
+                    foreign_key :auth_mask_id, :table => :auth_masks, :null => false
+                    foreign_key :group_id, :null => false
+                    primary_key [:auth_mask_id, :group_id]
+                end
+                Database.db.create_table(:auth_masks_nicks) do
+                    foreign_key :auth_mask_id, :table => :auth_masks, :null => false
+                    foreign_key :nick_id, :null => false
+                    primary_key [:nick_id, :auth_mask_id]
+                end
+                Database.db.drop_table :nick_groups
+            end
+
+            def down
+                Database.db.drop_table(:auth_masks_group)
+                Database.db.drop_table(:auth_masks_nicks)
+                Database.db.drop_table(:auth_masks)
+            end
+        end
+    end
+end

data/lib/mod_spox/migrations/004_mode_index_fix.rb

@@ -0,0 +1,18 @@
+module ModSpox
+    module Migrations
+        class ModeIndexFix < Sequel::Migration
+            
+            def up
+                Database.db.drop_index :nick_modes, [:nick_id, :channel_id]
+                Database.db.add_index :nick_modes, [:nick_id, :channel_id], :unique => true
+                Database.db.drop_column :nick_modes, :mode
+                Database.db.add_column :nick_modes, :mode, :varchar, :null => true, :default => ''
+            end
+            
+            def down
+                Database.db.drop_index :nick_modes, [:nick_id, :channel_id]
+                Database.db.add_index :nick_modes, [:nick_id, :channel_id]
+            end
+        end
+    end
+end

data/lib/mod_spox/migrations/005_nick_mode_nopark.rb

@@ -0,0 +1,18 @@
+module ModSpox
+    module Migrations
+        class NickModeNoPark < Sequel::Migration
+            
+            def up
+                Database.db.drop_column :channels, :parked
+                Database.db.add_column :nicks, :mode, :varchar, :null => true, :default => ''
+                Database.db.drop_table :channel_modes
+                Database.db.add_column :channels, :mode, :varchar, :null => true, :default => ''
+            end
+            
+            def down
+                Database.db.drop_column :nicks, :mode
+                Database.add_column :nicks, :parked, :bool, :null => false, :default => true
+            end
+        end
+    end
+end