PerfectlyNormal-Flexo 0.4.0 → 0.4.2

data/flexo.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name         = "Flexo"
-  s.version      = "0.4.0"
-	s.date         = "2008-10-15"
+  s.version      = "0.4.2"
+	s.date         = "2008-10-19"
   s.author       = "Per Christian B. Viken"
   s.email        = "perchr@northblue.org"
   s.homepage     = "http://eastblue.org/dev/flexo/"

data/lib/flexo/constants.rb

@@ -9,7 +9,7 @@ module Flexo
 
     CHANPREFIX = ['#', '&', '+', '!']
 
-    FLEXO_VERSION = '0.4.0'
+    FLEXO_VERSION = '0.4.2'
     FLEXO_RELEASE = 'Bendless Love'
   end
 end

data/lib/flexo/dispatcher.rb

@@ -96,24 +96,14 @@ module Flexo
     end
 
     # Removes an event handler.
-    # Known to be broken.
-    # DO NOT USE.
-    # See bug #28
     def unsubscribe(handler)
       @manager.logger.debug("Going to remove handler #{handler}")
-      events = []
-      @manager.mutex do
-        @handlers.each { |e,handlers| 
-          if handlers.delete(handler) 
-            events << e
-            @manager.logger.debug("Adding #{e} to removal queue")
-          end
-        }
-        events.each { |e|
-          @manager.logger.debug("Removing #{e}")
-          @handlers.delete(e)
-        }
+      
+      @handlers.each do |event,handlers|
+        handlers.delete handler
       end
+      
+      @manager.logger.debug("Handler #{handler} removed")
     end
 
     # Easy way to add a trigger.
@@ -121,7 +111,8 @@ module Flexo
     def add_trigger(pattern, &block)
       trigger = Flexo::Trigger.new(pattern, &block)
       @manager.mutex { @triggers << trigger }
-      trigger
+      
+      return trigger
     end
 
     # Easy way to remove a trigger.

data/lib/flexo/manager.rb

@@ -55,8 +55,11 @@ module Flexo
 
       @logger.debug "Creating PluginManager"
       @pluginmanager = Flexo::PluginManager.new(@pluginmutex)
-      @pluginmanager.load_plugin('control')
-      @pluginmanager.load_plugin('auth')
+      
+      @config['plugin.autoload'] ||= []
+      @config['plugin.autoload'].each do |plugin|
+        @pluginmanager.load_plugin(plugin)
+      end
 
       @logger.debug "Creating Sender"
       @sender        = Flexo::Sender.new
@@ -80,21 +83,16 @@ module Flexo
       @logger.info "Setting up default handlers"
       dispatcher.subscribe(:PING) { |ping| ping.pong }
       dispatcher.subscribe(Flexo::Events::PrivmsgEvent) { |msg|
-        return unless msg.ctcp?
-
-        case msg.text.split(' ')[0].upcase
-        when 'VERSION'
-          l  = "\001VERSION Flexo #{Flexo::Constants::FLEXO_VERSION} "
-          l += "(#{Flexo::Constants::FLEXO_RELEASE})\001"
-          @sender.notice(msg.data.hostmask.nickname, l)
-        when 'PING'
-          arg = msg.text.split(' ')[1]
-          cmd = "\001PING #{arg}\001"
-          @sender.notice(msg.data.hostmask.nickname, cmd)
-        when 'QUIT'
-          if msg.text.split(' ')[1] == 'lololz'
-            @server.disconnect
-            exit
+        if msg.ctcp?
+          case msg.text.split(' ')[0].upcase
+          when 'VERSION'
+            l  = "\001VERSION Flexo #{Flexo::Constants::FLEXO_VERSION} "
+            l += "(#{Flexo::Constants::FLEXO_RELEASE})\001"
+            @sender.notice(msg.data.hostmask.nickname, l)
+          when 'PING'
+            arg = msg.text.split(' ')[1]
+            cmd = "\001PING #{arg}\001"
+            @sender.notice(msg.data.hostmask.nickname, cmd)
           end
         end
       }
@@ -146,9 +144,17 @@ module Flexo
       return @server
     end
     
+    def plugin
+      return @pluginmanager
+    end
+    
     def load_plugin(plugin)
       return @pluginmanager.load_plugin(plugin)
     end
+    
+    def find_plugins
+      return @pluginmanager.find_plugins
+    end
 
     def nickname; return @nickname; end
     def nickname=(nick); @nickname = nick; nick; end

data/lib/flexo/plugin.rb

@@ -18,10 +18,31 @@ module Flexo
 
     # Variable, mutex, check.
     def initialize(plugins, *args)
-      @manager = Flexo::Manager.instance
-      @plugins = plugins
+      @manager  = Flexo::Manager.instance
+      @plugins  = plugins
+      @triggers = []
+      @handlers = []
       @manager.logger.debug "Created #{self.class}, with #{@plugins.to_a}"
     end
+    
+    # Unloading a plugin. This default action unsubscribes all triggers 
+    # and handlers, so nothing goes wrong when the plugin is unloaded and 
+    # the dispatcher still tries to run their blocks
+    def unload
+      @manager.logger.debug "Plugin: Unloading"
+      @manager.logger.debug "  has #{@triggers.length} triggers"
+      @manager.logger.debug "  and #{@handlers.length} handlers"
+      
+      @triggers.each do |trigger|
+        @manager.logger.debug "  Removing trigger #{trigger}"
+        remove_trigger trigger
+      end
+      
+      @handlers.each do |handler|
+        @manager.logger.debug "  Removing handler #{handler}"
+        unsubscribe handler
+      end
+    end
 
     # Overriding method_missing to let plugins use commands
     # from other plugins. If the plugin tries to use a function
@@ -48,7 +69,7 @@ module Flexo
 
     # Convenience. See Flexo::Dispatcher.subscribe
     def subscribe(event, &block)
-      @manager.dispatcher.subscribe(event, &block)
+      mutex { @handlers << @manager.dispatcher.subscribe(event, &block) }
     end
 
     # Convenience. See Flexo::Dispatcher.unsubscribe
@@ -58,7 +79,8 @@ module Flexo
 
     # Convenience. See Flexo::Dispatcher.add_trigger
     def add_trigger(pattern, &block)
-      @manager.dispatcher.add_trigger(pattern, &block)
+      @manager.logger.debug("Adding a trigger against #{pattern}")
+      mutex { @triggers << @manager.dispatcher.add_trigger(pattern, &block) }
     end
 
     # Convenience. See Flexo::Dispatcher.remove_trigger

data/lib/flexo/pluginmanager.rb

@@ -5,6 +5,9 @@ module Flexo
   # Here's the interesting parts. This class is responsible for...
   # Managing plugins! Who would've thought that...
   class PluginManager
+    attr_reader :plugins_loaded
+    attr_reader :plugins_available
+    
     # As usual. Set up some things. Create some arrays, some hashes,
     # get a mutex. All that
     def initialize(mutex)
@@ -44,6 +47,7 @@ module Flexo
               "The plugin name #{klass::NAME} is already being used by another plugin."
             end
             @plugins_available << klass
+            @plugins_available.uniq!
           end
         end
       end
@@ -99,8 +103,16 @@ module Flexo
         @manager.logger.debug "  Already loaded #{klass.class}"
         plugin = @plugins_loaded[klass::NAME]
       end
-      
+
       plugin
     end
+    
+    # Unloads a plugin
+    def unload_plugin(plugin)
+      @manager.logger.debug "Going to unload plugin #{plugin}"
+      klass = @plugins_loaded[plugin]
+      @manager.mutex { @plugins_loaded.delete(plugin) }
+      klass.unload
+    end
   end
 end

data/lib/flexo/server.rb

@@ -10,13 +10,11 @@ module Flexo
     attr_reader :thread
     attr_reader :server
     attr_reader :nickname
-    attr_reader :monitor
 
     def initialize
       @manager  = Flexo::Manager.instance
       @socket   = nil
       @server   = nil
-      @monitor  = nil
     end
 
     def setup
@@ -29,17 +27,11 @@ module Flexo
           end
           disconnect
         rescue Errno::ETIMEDOUT
-          @manager.logger.warn "Connection lost. Reconnecting"
-          connect
-        end
-      end
-
-      # Set up a thread to check the connection once
-      # in a while. See bug #15
-      @monitor = Thread.new do
-        while true
-          sleep 45
-          check_connection
+          @manager.logger.error "Connection lost. Reconnecting"
+          reconnect
+        rescue Errno::ECONNRESET
+          @manager.logger.error "Connection reset by peer. Reconnecting after five seconds"
+          reconnect 5
         end
       end
     end
@@ -51,19 +43,49 @@ module Flexo
     # Called by Sender.quote. This function just writes the 
     # prepared line to the socket.
     def quote(data)
-      @socket.print("#{data.chomp}\r\n")
+      begin
+        @socket.print("#{data.chomp}\r\n")
+        @socket.flush
+      rescue IOError => e
+        @manager.logger.error("Connection to #{@server} lost")
+        disconnect
+        exit 1
+      end
     end
 
     # Does the connecting, looping through the defined
     # servers, trying the next one if it fails.
     def connect
       debug "Starting to connect!"
+      host = @manager.config['core.hostname'].to_s
       @manager.config['core.server'].each do |server|
         debug "Connecting to #{server[:host]}:#{server[:port]}"
+        debug "  using host #{host}" if host.length > 0
+        debug "  using SSL" if server[:ssl]
         timeout(30) do
           err = 0
           begin
-            @socket = TCPSocket.new(server[:host], server[:port])
+            if host.length > 0
+              @socket = TCPSocket.new(server[:host], server[:port], host)
+            else
+              @socket = TCPSocket.new(server[:host], server[:port])
+            end
+
+            if(server[:ssl])
+              begin
+                require 'openssl'
+              rescue LoadError
+                @manager.logger.error "SSL library not available."
+                continue
+              end
+              
+              context = OpenSSL::SSL::SSLContext.new()
+              # FIXME: Might want to change this one, or at least have it configurable
+              context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+              @socket = OpenSSL::SSL::SSLSocket.new(@socket, context)
+              @socket.sync_close = true
+              @socket.connect
+            end
           rescue Errno::ECONNREFUSED => h
             msg = "Connection to #{server[:host]} at port #{server[:port]} was refused"
             err = 1
@@ -76,6 +98,9 @@ module Flexo
           rescue Errno::EADDRNOTAVAIL => h
             msg = "Unable to assign requested address"
             err = 2
+          rescue OpenSSL::SSL::SSLError => h
+            msg = "Unable to connect using SSL (#{h.message})"
+            err = 1
           end
 
           if(err != 0)
@@ -87,6 +112,7 @@ module Flexo
             end
           else
             @manager.logger.info("Connected to #{server[:host]}")
+            @server = server[:host]
             login
             return
           end
@@ -94,13 +120,6 @@ module Flexo
       end
     end
 
-    def check_connection
-      if(@socket == nil || @socket.closed?)
-        @manager.logger.error("Not connected to a server. Trying again.")
-        connect
-      end
-    end
-
     # This function goes through the login-process
     def login
       config = @manager.config
@@ -126,5 +145,12 @@ module Flexo
     def disconnect
       @socket.close unless @socket.closed?
     end
+    
+    # Reconnects
+    def reconnect(s = 0)
+      disconnect
+      sleep s
+      connect
+    end
   end
 end

data/lib/flexo/trigger.rb

@@ -40,5 +40,9 @@ module Flexo
     def to_proc
       proc { |event| call(event) }
     end
+    
+    def unsubscribe
+      @manager.dispatcher.unsubscribe @handler
+    end
   end
 end

data/plugins/auth.rb

@@ -10,7 +10,7 @@ module Flexo
     # executes.
     class AuthPlugin < Flexo::Plugin
       NAME    = 'auth'
-      VERSION = '0.1.3'
+      VERSION = '0.1.4'
       SUMMARY = 'Access control list for managing users and their permissions.'
       DEPENDS = ['pstore', 'ruby-digest/md5']
 
@@ -28,8 +28,8 @@ module Flexo
         add_restricted_trigger(/^user remove ([a-zA-Z][a-zA-Z0-9_-]*)$/, :level => 256, &method(:cmd_remove))
         add_trigger(/^user lookup ([a-zA-Z][a-zA-Z0-9_-]*)$/, &method(:cmd_lookup))
 
-        pstore_open("#{@manager.config.path}/user.db")
-        pstore_transaction do |pstore| 
+        @db = pstore_open("#{@manager.config.path}/user.db")
+        @db.transaction do |pstore| 
           pstore[:users] ||= Hash.new
         end
       end
@@ -37,7 +37,7 @@ module Flexo
       # Returns the number of users currently registered
       # in the database.
       def usercount 
-        pstore_transaction do |pstore|
+        @db.transaction do |pstore|
           return pstore[:users].length
         end
       end
@@ -47,6 +47,7 @@ module Flexo
       # whether the user is allowed to run the command or not.
       def add_restricted_trigger(pattern, opts = {}, &block)
         opts = { :level => 0 }.merge(opts)
+        @manager.logger.debug("Adding restricted trigger against #{pattern}")
         add_trigger(pattern) do |privmsg,*args|
           @manager.logger.debug "Trying to run a restricted method"
           level = opts[:level].to_i
@@ -63,6 +64,12 @@ module Flexo
             block.call(privmsg,*args)
           end
         end
+        
+        # Plenty of plugins use this method, and their trigger
+        # gets added to this class's triggers. Therefore
+        # we pop it, and return it, leaving it up to the plugin to 
+        # keep track of those
+        return @triggers.pop
       end
 
       # Finds a user in the database
@@ -71,7 +78,7 @@ module Flexo
         @manager.logger.debug "AuthPlugin: Trying to find #{nick}"
         user = nil
         
-        pstore_transaction do |pstore|
+        @db.transaction do |pstore|
           user = pstore[:users].find do |name,user|
             user[:hostmasks].any? do |dbnick,dbhost|
               dbnick.downcase == nick.downcase &&\
@@ -95,7 +102,7 @@ module Flexo
       def username_exists?(username)
         found = false
         @manager.logger.debug "Going to see if #{username} exists"
-        pstore_transaction do |pstore|
+        @db.transaction do |pstore|
           pstore[:users].keys.any? { |dbname| 
             @manager.logger.debug "  Checking #{dbname} against #{username}"
             found = (dbname.downcase == username.downcase)
@@ -111,7 +118,7 @@ module Flexo
         @manager.logger.debug "Auth: Host: Checking if #{nick} and #{mask} exists"
         found = false
         
-        pstore_transaction do |pstore|
+        @db.transaction do |pstore|
           pstore[:users].any? do |name,user|
             user[:hostmasks].any? do |dbnick,dbmask|
               found = true if (dbnick.downcase == nick.downcase && dbmask.downcase == mask.downcase)
@@ -126,7 +133,7 @@ module Flexo
       # Returns true if the username/password combination 
       # matches, and false if it does not.
       def is_correct?(user, pass)
-        c = pstore_transaction do |pstore|
+        c = @db.transaction do |pstore|
           pstore[:users][user.downcase][:password] == Digest::MD5.hexdigest(pass).to_s
         end
 
@@ -145,14 +152,14 @@ module Flexo
           :level     => level.to_i
         }
 
-        pstore_transaction do |pstore|
+        @db.transaction do |pstore|
           pstore[:users][user] = tmpuser
         end
       end
 
       # Adds a nickname/hostmask combo to a given user
       def addmask(user, nick, mask)
-        pstore_transaction do |pstore|
+        @db.transaction do |pstore|
           pstore[:users][user.downcase][:hostmasks] << [nick, mask]
         end
       end
@@ -189,7 +196,7 @@ module Flexo
       def cmd_changelevel(privmsg, username, level)
         return notify_user_not_found(privmsg) if !username_exists?(username)
 
-        pstore_transaction do |pstore|
+        @db.transaction do |pstore|
           pstore[:users][username.downcase][:level] = level.to_i
         end
 
@@ -201,7 +208,7 @@ module Flexo
         @manager.logger.debug "AuthPlugin: Going to remove #{username}"
         return notify_user_not_found(privmsg) if !username_exists?(username)
 
-        pstore_transaction do |pstore|
+        @db.transaction do |pstore|
           pstore[:users].delete(username.downcase)
         end
 
@@ -219,7 +226,7 @@ module Flexo
 
         level = 0
         
-        pstore_transaction do |pstore|
+        @db.transaction do |pstore|
           level = pstore[:users][username.downcase][:level]
         end
 
@@ -253,4 +260,4 @@ module Flexo
       end
     end
   end
-end
+end

data/plugins/control.rb

@@ -14,11 +14,13 @@ module Flexo
         super
 
         @manager.logger.debug("ControlPlugin started")
-        add_restricted_trigger(/^ctrl quit ?(.+)*$/, :level => 256, &method(:cmd_quit))
-        add_restricted_trigger(/^ctrl join (#\S+)$/, :level => 192, &method(:cmd_join))
-        add_restricted_trigger(/^ctrl part (#\S+)$/, :level => 192, &method(:cmd_part))
-        add_restricted_trigger(/^ctrl plugin load (\S+)$/, :level => 256, &method(:cmd_loadplugin))
-        add_restricted_trigger(/^ctrl plugin unload (\S+)$/, :level => 256, &method(:cmd_unloadplugin))
+        @triggers << add_restricted_trigger(/^ctrl quit ?(.+)*$/, :level => 256, &method(:cmd_quit))
+        @triggers << add_restricted_trigger(/^ctrl join (#\S+)$/, :level => 192, &method(:cmd_join))
+        @triggers << add_restricted_trigger(/^ctrl part (#\S+)$/, :level => 192, &method(:cmd_part))
+        @triggers << add_restricted_trigger(/^ctrl plugin load (\S+)$/, :level => 256, &method(:cmd_loadplugin))
+        @triggers << add_restricted_trigger(/^ctrl plugin unload (\S+)$/, :level => 256, &method(:cmd_unloadplugin))
+        @triggers << add_restricted_trigger(/^ctrl plugin find$/, :level => 256, &method(:cmd_findplugins))
+        add_trigger(/^ctrl plugin list$/, &method(:cmd_listplugin))
       end
 
       private
@@ -31,7 +33,8 @@ module Flexo
         @manager.sender.part(channel)
       end
       
-      def cmd_quit(privmsg, message = "Leaving!")
+      def cmd_quit(privmsg, message)
+        message ||= "Leaving!"
         @manager.logger.info("Requested to quit...")
         @manager.sender.quit(message)
       end
@@ -46,8 +49,33 @@ module Flexo
       end
       
       def cmd_unloadplugin(privmsg, plugin)
-        privmsg.reply "Not implemented yet"
+        loaded = @manager.plugin.plugins_loaded
+        
+        if(!loaded.include?(plugin))
+          privmsg.reply "The plugin #{plugin} is not loaded"
+        else
+          @manager.plugin.unload_plugin(plugin)
+          privmsg.reply "Successfully unloaded #{plugin}"
+        end
+      end
+      
+      def cmd_listplugin(privmsg)
+        loaded    = @manager.plugin.plugins_loaded
+        available = @manager.plugin.plugins_available
+        
+        available.each do |plug|
+          str  = "#{plug::NAME} (#{plug::VERSION}"
+          str += ", loaded" if loaded.include?(plug::NAME)
+          str += ") - #{plug::SUMMARY}"
+          
+          privmsg.reply str
+        end
+      end
+      
+      def cmd_findplugins(privmsg)
+        @manager.find_plugins
+        privmsg.reply "Reloaded list of plugins"
       end
     end
   end
-end
+end

data/plugins/pstore.rb

@@ -2,31 +2,37 @@ module Flexo
   module Plugins
     class PStorePlugin < Flexo::Plugin
       NAME    = 'pstore'
-      VERSION = '0.1.0'
+      VERSION = '0.1.3'
       SUMMARY = 'A plugin that provides permanent storage for other plugins'
       DEPENDS = ['ruby-pstore']
       
       def initialize(*args)
         super
-        @pstore  = nil
         @manager = Flexo::Manager.instance
       end
       
       # Opens a database.
       def pstore_open(file)
         begin
-          @pstore = PStore.new(file)
+          return PStoreWrapper.new(file)
         rescue
           raise PluginError("PStore: Unable to open database")
         end
       end
-
+    end
+  
+    class PStoreWrapper
+      def initialize(file)
+        @manager = Flexo::Manager.instance
+        @pstore  = PStore.new(file)
+      end
+      
       # Convenience function for utilizing the mutex, creating
       # a transaction on our PStore-object, and running a code
       # block against it.
-      def pstore_transaction(&block)
+      def transaction(&block)
         @manager.logger.debug "PStore: Starting transaction"
-        mutex { @pstore.transaction(&block) }
+        @manager.pluginmutex { @pstore.transaction(&block) }
         @manager.logger.debug "PStore: Transaction complete"
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: PerfectlyNormal-Flexo
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors: 
 - Per Christian B. Viken
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-15 00:00:00 -07:00
+date: 2008-10-19 00:00:00 -07:00
 default_executable: 
 dependencies: []