mod_spox 0.1.0.1 → 0.2.0

data/lib/mod_spox/Bot.rb

@@ -1,5 +1,5 @@
 ['mod_spox/Logger',
- 'mod_spox/Socket',
+ 'mod_spox/Sockets',
  'mod_spox/Pipeline',
  'mod_spox/PluginManager',
  'mod_spox/MessageFactory',
@@ -7,110 +7,126 @@
  'mod_spox/Timer',
  'mod_spox/messages/Messages',
  'mod_spox/models/Models',
- 'mod_spox/Monitors',
- 'mod_spox/Helpers'].each{|f|require f}
+ 'mod_spox/Helpers',
+ 'mod_spox/Pool'].each{|f|require f}
 module ModSpox
 
     class Bot
-    
+
         # bot timer
         attr_reader :timer
-        
+
         # message pipeline
         attr_reader :pipeline
-        
+
         # plugin manager
         attr_reader :plugin_manager
-        
+
         # message factory
         attr_reader :factory
-    
+
+        # DCC sockets
+        attr_reader :dcc_sockets
+
         # Create a Bot
         def initialize
-            Logger.severity($VERBOSITY)
-            Logger.fd
+            Logger.initialize($LOGTO, $LOGLEVEL)
+            Pool.instance
             clean_models
             @start_time = Time.now
             @pipeline = Pipeline.new
             @timer = Timer.new(@pipeline)
+            @timer.start
             @config = BaseConfig.new(BotConfig[:userconfigpath])
             @factory = MessageFactory.new(@pipeline)
             @socket = nil
             @plugin_manager = PluginManager.new(@pipeline)
+            if(@config[:plugin_upgrade] == 'yes')
+                @plugin_manager.upgrade_plugins
+                Logger.info('Main bot thread is now sleeping for 10 seconds to allow upgrade to conclude')
+                sleep(10)
+                Logger.info('Main bot thread sleep completed. Continuing loading.')
+            end
+            @config[:plugin_upgrade] = 'no'
+            @config.write_configuration
             @shutdown = false
-            @socket = nil
+            @socket = Sockets.new(self)
             @nick = nil
             @thread = Thread.current
-            @waiter = Monitors::Boolean.new
+            @lock = Mutex.new
+            @waiter = ConditionVariable.new
             hook_pipeline
         end
-        
+
         # Run the bot
         def run
-            trap('SIGTERM'){ Logger.log("Caught SIGTERM"); @shutdown = true; @waiter.wakeup; sleep(0.1); Thread.current.exit; Logger.kill; }
-            trap('SIGKILL'){ Logger.log("Caught SIGKILL"); @shutdown = true; @waiter.wakeup; sleep(0.1); Thread.current.exit; Logger.kill; }
-            trap('SIGINT'){ Logger.log("Caught SIGINT"); @shutdown = true; @waiter.wakeup; sleep(0.1); Thread.current.exit; Logger.kill; }
-            trap('SIGQUIT'){ Logger.log("Caught SIGQUIT"); @shutdown = true; @waiter.wakeup; sleep(0.1); Thread.current.exit; Logger.kill; }
+            trap('SIGTERM'){ Logger.warn("Caught SIGTERM"); start_shutdown }
+            trap('SIGKILL'){ Logger.warn("Caught SIGKILL"); start_shutdown }
+            trap('SIGINT'){ Logger.warn("Caught SIGINT"); start_shutdown }
+            trap('SIGQUIT'){ Logger.warn("Caught SIGQUIT"); start_shutdown }
             until @shutdown do
-                @timer.start
                 @pipeline << Messages::Internal::BotInitialized.new
                 begin
-                    @waiter.wait
+                    @lock.synchronize do
+                        Logger.info('Putting main execution thread to sleep until shutdown')
+                        @waiter.wait(@lock)
+                        Logger.info('Main execution thread has been restored.')
+                    end
                 rescue Object => boom
-                    Logger.log("Caught exception: #{boom}")
+                    Logger.fatal("Caught exception: #{boom}")
+                ensure
+                    shutdown
                 end
-                shutdown
             end
         end
-        
+
         # Shut the bot down
         def shutdown
             @shutdown = true
+            Logger.info('Shutdown sequence initiated')
             @plugin_manager.destroy_plugins
-            @thread.run
             @timer.stop
-            @timer.destroy
-            @factory.destroy
             @pipeline << Messages::Internal::Shutdown.new
             sleep(0.1)
-            @pipeline.destroy
             @socket.shutdown unless @socket.nil?
             clean_models
         end
-        
+
         # Reload the bot (basically a restart)
         def reload
-            @thread.run
+            @lock.synchronize do
+                @waiter.signal
+            end
         end
-        
+
         # message:: Messages::Internal::EstablishConnection message
         # Initialize connection to IRC server
         def bot_connect(message)
-            Logger.log("Received a connection command", 10)
+            Logger.info("Received a connection command")
             begin
-                @socket = Socket.new(self, message.server, message.port)
-                @socket.connect
+                @socket = Sockets.new(self) if @socket.nil?
+                @socket.irc_connect(message.server, message.port)
                 @pipeline << Messages::Internal::Connected.new(message.server, message.port)
             rescue Object => boom
-                Logger.log("Failed connection to server: #{boom}")
+                Logger.warn("Failed connection to server: #{boom}")
                 @pipeline << Messages::Internal::ConnectionFailed.new(message.server, message.port)
             end
         end
-        
+
         # message:: Messages::Internal::StatusRequest message
         # Returns the current status of the bot
         def status(message)
-            @pipeline << Messages::Internal::StatusResponse(message.requester, stats)
+            @pipeline << Messages::Internal::StatusResponse.new(message.requester, bot_stats)
         end
-        
+
         # Returns status of the bot in a formatted string
-        def stats
-            return ["Uptime: #{Helpers::format_seconds(@start_time - Time.now)}",
-                    "Plugins: #{@plugins.plugins.size} loaded",
-                    "Lines sent: #{@socket.sent}",
-                    "Lines received: #{@socket.received}"].join(' ')
+        def bot_stats
+            return {:uptime => Helpers::format_seconds(Time.now - @start_time),
+                    :plugins => @plugin_manager.plugins.size,
+                    :sent => @socket.irc_socket.sent,
+                    :received => @socket.irc_socket.received}
         end
-        
+
         # Adds hooks to pipeline for processing messages
         def hook_pipeline
             {:Outgoing_Admin => :admin, :Outgoing_Away => :away,
@@ -141,46 +157,46 @@ module ModSpox
              :Outgoing_Raw => :raw
              }.each_pair{ |type,method| @pipeline.hook(self, method, type) }
         end
-        
+
         # message:: Messages::Internal::TimerClear
         # Clear all actions from timer
         def clear_timer(message)
             @timer.clear
         end
-        
+
         # message:: Messages::Internal::Disconnected
         # Disconnect the bot from the IRC server
         def disconnected(message)
             @socket.shutdown
             @socket = nil
         end
-        
+
         # Stop the bot
         def halt(message)
             @shutdown = true
-            @thread.run
+            reload
         end
-        
+
         # message:: Messages::Internal::ChangeNick message
         # Changes the bot's nick to the given nick
         def set_nick(message)
             @nick = message.new_nick
         end
-        
+
         # message:: Messages::Internal::NickRequest
         # Sends the bot's nick to plugins
         def get_nick(message)
             @pipeline << Messages::Internal::NickResponse(message.requester, @nick)
         end
-        
+
         # message:: Messages::Outgoing::Pass message
         # Sends PASS message to server
         def pass(message)
             @socket << "PASS #{message.password}"
         end
-        
+
         # message:: Messages::Outgoing::Nick message
-        # Sends NICK message to server        
+        # Sends NICK message to server
         def nick(message)
             nick = message.nick.is_a?(Models::Nick) ? message.nick.nick : message.nick
             @socket << "NICK #{nick}"
@@ -211,7 +227,7 @@ module ModSpox
         def quit(message)
             @socket << "QUIT :#{message.message}"
         end
-        
+
         # message:: Messages::Outgoing::Squit message
         # Sends SQUIT message to server
         def squit(message)
@@ -241,7 +257,7 @@ module ModSpox
             channel = channel.name if channel.is_a?(Models::Channel)
             @socket << "MODE #{channel} #{message.mode} #{target}"
         end
-        
+
         # message:: Messages::Outgoing::Topic message
         # Sends TOPIC message to server
         def topic(message)
@@ -262,7 +278,7 @@ module ModSpox
             channel = message.channel.is_a?(Models::Channel) ? message.channel.name : message.channel
             @socket << "LIST #{channel}"
         end
-        
+
         # message:: Messages::Outgoing::Invite message
         # Sends INVITE message to server
         def invite(message)
@@ -270,7 +286,7 @@ module ModSpox
             channel = message.channel.is_a?(Models::Channel) ? message.channel.name : message.channel
             @socket << "INVITE #{nick} #{channel}"
         end
-       
+
         # message:: Messages::Outgoing::Kick message
         # Sends KICK message to server
         def kick(message)
@@ -290,10 +306,10 @@ module ModSpox
                 part.split("\n").each do |content|
                     while(content.size > 450)
                         output = content[0..450]
-                        content.slice!(0, 450) #(450, content.size)
-                        @socket << "PRIVMSG #{target} :#{message.is_action? ? "\cAACTION #{output}\cA" : output}"
+                        content.slice!(0, 451) #(450, content.size)
+                        @socket << "PRIVMSG #{target} :#{message.is_ctcp? ? "\cA#{message.ctcp_type} #{output}\cA" : output}"
                     end
-                    @socket << "PRIVMSG #{target} :#{message.is_action? ? "\cAACTION #{content}\cA" : content}"
+                    @socket << "PRIVMSG #{target} :#{message.is_ctcp? ? "\cA#{message.ctcp_type} #{content}\cA" : content}"
                 end
             end
         end
@@ -305,13 +321,13 @@ module ModSpox
             target = message.target.nick if message.target.is_a?(Models::Nick)
             @socket << "NOTICE #{target} :#{message}"
         end
-        
+
         # message:: Messages::Outgoing::Motd message
         # Sends MOTD message to server
         def motd(message)
             @socket << "MOTD #{message.target}"
         end
-        
+
         # message:: Messages::Outgoing::Lusers message
         # Sends LUSERS message to server
         def lusers(message)
@@ -323,20 +339,20 @@ module ModSpox
         def version(message)
             @socket << "VERSION #{message.target}"
         end
-        
+
         # message:: Messages::Outgoing::Stats message
         # Sends STATS message to server
         def stats(message)
             raise Exceptions::InvalidValue.new('Query must be a single character') unless message.query =~ /^[a-z]$/
             @socket << "STATS #{message.query} #{message.target}"
         end
-        
+
         # message:: Messages::Outgoing::Links message
         # Sends LINKS message to server
         def links(message)
             @socket << "LIST #{message.server} #{message.mask}"
         end
-        
+
         # message:: Messages::Outgoing::Time message
         # Sends TIME message to server
         def time(message)
@@ -366,7 +382,7 @@ module ModSpox
         def info(message)
             @socket << "INFO #{message.target}"
         end
-        
+
         # message:: Messages::Outgoing::ServList message
         # Sends SERVLIST message to server
         def servlist(message)
@@ -392,7 +408,7 @@ module ModSpox
             nick = message.nick.is_a?(Models::Nick) ? message.nick.nick : message.nick
             @socket << "WHOIS #{message.target_server} #{nick}"
         end
-        
+
         # message:: Messages::Outgoing::WhoWas message
         # Sends WHOWAS message to server
         def whowas(message)
@@ -418,25 +434,25 @@ module ModSpox
         def pong(message)
             @socket << "PONG #{message.server} #{message.string.nil? ? '' : ":#{message.string}"}"
         end
-        
+
         # message:: Messages::Outgoing::Away message
         # Sends AWAY message to server
         def away(message)
             @socket << "AWAY :#{message.message}"
         end
-        
+
         # message:: Messages::Outgoing::Unaway message
         # Sends AWAY message to server
         def unaway(message)
             @socket << "AWAY"
         end
-        
+
         # message:: Messages::Outgoing::Rehash message
         # Sends REHASH message to server
         def rehash(message)
             @socket << "REHASH"
         end
-        
+
         # message:: Messages::Outgoing::Die message
         # Sends DIE message to server
         def die(message)
@@ -456,13 +472,13 @@ module ModSpox
             channel = message.channel.is_a?(Models::Channel) ? message.channel.name : message.channel
             @socket << "SUMMON #{nick} #{message.target} #{channel}"
         end
-        
+
         # message:: Messages::Outgoing::Users message
         # Sends USERS message to server
         def users(message)
             @socket << "USERS #{message.target}"
         end
-        
+
         def wallops
         end
 
@@ -478,16 +494,23 @@ module ModSpox
         def ison(message)
             nick = message.nick.is_a?(Models::Nick) ? message.nick.nick : message.nick
             @socket << "ISON #{nick}"
-        end 
-        
+        end
+
         # message:: Messages::Outoing::Raw message
         # Send raw message to server
         def raw(message)
             @socket << message.message
         end
-        
+
         private
-        
+
+        def start_shutdown
+            @shutdown = true
+            @lock.synchronize do
+                @waiter.signal
+            end
+        end
+
         # Cleans information from models to avoid
         # stale values
         def clean_models

data/lib/mod_spox/BotConfig.rb

@@ -18,7 +18,7 @@ module ModSpox
         # :userpath => path to mod_spox directory in user's home directory
         # :userpluginpath => path to user's plugin directory
         # :userconfigpath => path to the user configuration file        
-        def self.populate
+        def BotConfig.populate(createdir=true)
             gemname, gem = Gem.source_index.find{|name, spec|
                 spec.name == 'mod_spox' && spec.version.version = $BOTVERSION
             }
@@ -33,24 +33,32 @@ module ModSpox
                            :userpath => "#{up}/.mod_spox",
                            :userpluginpath => "#{up}/.mod_spox/plugins",
                            :userconfigpath => "#{up}/.mod_spox/config"}
-                [@@config[:userpath], @@config[:userpluginpath]].each do |path|
-                    Dir.mkdir(path) unless File.exists?(path)
+                if(createdir)
+                    [@@config[:userpath], @@config[:userpluginpath]].each do |path|
+                        Dir.mkdir(path) unless File.exists?(path)
+                    end
                 end
             else
-                p gem
-                p gemname
                 raise Exceptions::InstallationError.new('Failed to find mod_spox gem')
             end
         end
         
         # name:: Name of the path string you would like
         # Provides access to important path values
-        def self.[](name)
+        def BotConfig.[](name)
             BotConfig.populate unless @@config
             name = name.to_sym unless name.is_a?(Symbol)
             raise Exceptions::UnknownKey.new("Failed to find given key: #{name}") unless @@config.has_key?(name)
             return @@config[name]
         end
+        
+        # Returns if the bot has been configured
+        def BotConfig.configured?
+            BotConfig.populate(false)
+            path = BotConfig[:userpath]
+            @@config = nil
+            return File.exists?(path)
+        end
     
     end