PerfectlyNormal-Flexo 0.3.9

data/lib/flexo/server.rb

@@ -0,0 +1,130 @@
+require 'timeout'
+require 'socket'
+require 'thread'
+
+module Flexo
+  # The class that does all the socket-works.
+  # Using Sender, it sends commands to the server, and, using Dispatcher,
+  # gets the responses sent back into Flexo for further processing.
+  class Server
+    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
+      connect
+
+      @thread = @manager.thread do
+        begin
+          while line = @socket.gets
+            @manager.dispatcher.receive(line)
+          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
+        end
+      end
+    end
+
+    def debug(line) # :nodoc:
+      @manager.logger.debug(line)
+    end
+
+    # Called by Sender.quote. This function just writes the 
+    # prepared line to the socket.
+    def quote(data)
+      @socket.print("#{data.chomp}\r\n")
+    end
+
+    # Does the connecting, looping through the defined
+    # servers, trying the next one if it fails.
+    def connect
+      debug "Starting to connect!"
+      @manager.config['core.server'].each do |server|
+        debug "Connecting to #{server[:host]}:#{server[:port]}"
+        timeout(30) do
+          err = 0
+          begin
+            @socket = TCPSocket.new(server[:host], server[:port])
+          rescue Errno::ECONNREFUSED => h
+            msg = "Connection to #{server[:host]} at port #{server[:port]} was refused"
+            err = 1
+          rescue Errno::EHOSTUNREACH => h
+            msg = "#{server[:host]} is unreachable!"
+            err = 1
+          rescue Timeout::Error => h
+            msg = "Connection to #{server[:host]} timed out"
+            err = 1
+          rescue Errno::EADDRNOTAVAIL => h
+            msg = "Unable to assign requested address"
+            err = 2
+          end
+
+          if(err != 0)
+            @socket = nil
+            @manager.logger.warn(msg)
+            if err > 1 # Critical error!
+              @manager.logger.error("Critical errors encountered!")
+              exit 1
+            end
+          else
+            @manager.logger.info("Connected to #{server[:host]}")
+            login
+            return
+          end
+        end
+      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
+
+      # First, we add a handler to fix things
+      # if our nickname is taken
+      nicktaken = @manager.dispatcher.subscribe(Flexo::Events::ReplyEvent) do |event|
+        if event.numeric == 433
+          nick = config['core.nick'].shift
+          quote "NICK #{nick}"
+          @manager.logger.info("Nickname taken, trying #{nick}")
+          @manager.nickname = nick
+        end
+      end
+
+      nick = config['core.nick'].shift
+      @manager.sender.nick nick
+      @manager.sender.user config['core.username'], 0, config['core.realname']
+      @manager.nickname = nick
+    end
+
+    # Disconnects from the server
+    def disconnect
+      @socket.close unless @socket.closed?
+    end
+  end
+end

data/lib/flexo/trigger.rb

@@ -0,0 +1,44 @@
+module Flexo
+  # A Trigger is a special type of handler, designed
+  # to trigger an action when a certain Flexo::Events::PrivmsgEvent
+  # is receieved. The PrivmsgEvent is matched against a regexp, and, 
+  # if it matches, the action is triggered.
+  class Trigger
+    attr_reader :pattern
+    attr_reader :prefix
+
+    # Creates a trigger.
+    #
+    # _pattern_ is a string or a regular expression to match
+    # against the message. Any group matches will be passed
+    # as arguments to the block
+    def initialize(pattern, &block)
+      @manager = Flexo::Manager.instance
+      @pattern = Regexp.new(pattern)
+      @prefix  = @manager.config['core.trigger_prefix']
+      @block   = block
+      @handler = @manager.dispatcher.subscribe(Flexo::Events::PrivmsgEvent, &self)
+    end
+
+    # Invokes the trigger
+    def call(privmsg)
+      if(privmsg.text[0...@prefix.size] == @prefix)
+        text = privmsg.text[@prefix.size..-1]
+      elsif(privmsg.to_me? && privmsg.text[0...@prefix.length] == @prefix)
+        text = privmsg.text[@prefix.size..-1]
+      elsif(privmsg.to_me?)
+        text = privmsg.text
+      else
+        return
+      end
+
+      m = text.match(@pattern)
+      @block.call(privmsg, *m[1..-1]) if m
+    end
+
+    # Turns the Trigger into a Proc
+    def to_proc
+      proc { |event| call(event) }
+    end
+  end
+end

data/plugins/auth.rb

@@ -0,0 +1,256 @@
+module Flexo
+  module Plugins
+    # A plugin for managing a list of users and their privileges
+    # within Flexo. The usage of this plugin allows other plugins
+    # to add restricted commands that require a certain access level.
+    #
+    # There's no way to "log in", but each time a user tries to run
+    # a restricted command, their current nickname and hostmask
+    # is matched against the database, and if found, the command
+    # executes.
+    class AuthPlugin < Flexo::Plugin
+      NAME    = 'auth'
+      VERSION = '0.1.3'
+      SUMMARY = 'Access control list for managing users and their permissions.'
+      DEPENDS = ['pstore', 'ruby-digest/md5']
+
+      attr_accessor :default_level
+
+      def initialize(*args)
+        super
+        @manager.logger.debug "Loaded AuthPlugin"
+        @default_level = 0
+
+        add_trigger(/^user register ([a-zA-Z][a-zA-Z0-9_-]*) (\S+)$/, &method(:cmd_register))
+        add_trigger(/^user addmask ([a-zA-Z][a-zA-Z0-9_-]*) (\S+)$/,  &method(:cmd_addmask))
+
+        add_restricted_trigger(/^user change ([a-zA-Z][a-zA-Z0-9_-]*) (\d{1,3})$/, :level => 256, &method(:cmd_changelevel))
+        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| 
+          pstore[:users] ||= Hash.new
+        end
+      end
+
+      # Returns the number of users currently registered
+      # in the database.
+      def usercount 
+        pstore_transaction do |pstore|
+          return pstore[:users].length
+        end
+      end
+
+      # Similar to Flexo::Dispatcher.add_trigger, except this
+      # also takes an access level argument to determine
+      # whether the user is allowed to run the command or not.
+      def add_restricted_trigger(pattern, opts = {}, &block)
+        opts = { :level => 0 }.merge(opts)
+        add_trigger(pattern) do |privmsg,*args|
+          @manager.logger.debug "Trying to run a restricted method"
+          level = opts[:level].to_i
+          user  = get_user_from_hostmask(privmsg.from, privmsg.data.hostmask.hostname)
+
+          if user && user[:level] < level
+            @manager.logger.debug "  Not authorized for that"
+            privmsg.reply("Not authorized.", false)
+          elsif !user && level > 0
+            @manager.logger.debug "  But not registered"
+            privmsg.reply("Need to register.", false)
+          else
+            @manager.logger.debug "  And running the command!"
+            block.call(privmsg,*args)
+          end
+        end
+      end
+
+      # Finds a user in the database
+      # Returns nil if not found
+      def get_user_from_hostmask(nick, host)
+        @manager.logger.debug "AuthPlugin: Trying to find #{nick}"
+        user = nil
+        
+        pstore_transaction do |pstore|
+          user = pstore[:users].find do |name,user|
+            user[:hostmasks].any? do |dbnick,dbhost|
+              dbnick.downcase == nick.downcase &&\
+              dbhost.downcase == host.downcase
+            end
+          end
+        end
+
+        return user[1] if user
+        return nil
+      end
+
+      private
+
+      # Convenience function for sending a privmsg to a user
+      def msg(target, msg)
+        target.reply(msg)
+      end
+
+      # Checks if a given username is registered.
+      def username_exists?(username)
+        found = false
+        @manager.logger.debug "Going to see if #{username} exists"
+        pstore_transaction do |pstore|
+          pstore[:users].keys.any? { |dbname| 
+            @manager.logger.debug "  Checking #{dbname} against #{username}"
+            found = (dbname.downcase == username.downcase)
+          }
+        end
+
+        @manager.logger.debug "Found == #{found}"
+        return found
+      end
+
+      # Checks if a given hostmask is registered.
+      def hostmask_exists?(nick, mask)        
+        @manager.logger.debug "Auth: Host: Checking if #{nick} and #{mask} exists"
+        found = false
+        
+        pstore_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)
+            end
+          end
+        end
+        
+        @manager.logger.debug "Auth: Host: Returning #{found}"
+        return found
+      end
+
+      # Returns true if the username/password combination 
+      # matches, and false if it does not.
+      def is_correct?(user, pass)
+        c = pstore_transaction do |pstore|
+          pstore[:users][user.downcase][:password] == Digest::MD5.hexdigest(pass).to_s
+        end
+
+        return c
+      end
+
+      # Creates a new user in the database
+      # Not meant to be called directly, but to be used
+      # from a running Flexo-instance, using the register-command.
+      def register(user, pass, nick, host, level)
+        user.downcase!
+        tmpuser = {
+          :username  => user,
+          :password  => Digest::MD5.hexdigest(pass).to_s,
+          :hostmasks => [[nick, host]],
+          :level     => level.to_i
+        }
+
+        pstore_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|
+          pstore[:users][user.downcase][:hostmasks] << [nick, mask]
+        end
+      end
+
+      # Triggered when a user tries to register via a privmsg
+      def cmd_register(privmsg, username, password)
+        @manager.logger.debug "AuthPlugin: Going to register #{username}"
+        p = privmsg
+        return notify_cannot_register_in_public(p) if privmsg.to_channel?
+        return notify_username_taken(p) if username_exists?(username)
+        return notify_hostmask_taken(p) if hostmask_exists?(privmsg.from, privmsg.data.mask.host)
+
+        master = (usercount == 0 ? true : false)
+        register(username, password, privmsg.sender, privmsg.data.hostmask.hostname, (master ? 256 : @default_level.to_i))
+
+        @manager.logger.debug "AuthPlugin: Successfully registered #{username}"
+        privmsg.reply("You have been successfully registered.", false)
+        privmsg.reply("You have been added as a master!", false) if master
+      end
+
+      # Triggered when a user wants to add a new hostmask to themselves
+      def cmd_addmask(privmsg, username, password)
+        @manager.logger.debug "AuthPlugin: Adding a mask to #{username}"
+        p = privmsg
+        return notify_cannot_register_in_public(p) if privmsg.to_channel?
+        return notify_incorrect_information(p) if (!username_exists?(username) || !is_correct?(username, password))
+        return notify_hostmask_taken(p) if hostmask_exists?(privmsg.sender, privmsg.data.hostmask.hostname)
+
+        addmask(username, privmsg.from, privmsg.data.hostmask.hostname)
+        msg(privmsg, "Successfully added the new mask to your account")
+      end
+
+      # Triggers when an admin want to change the level of a user
+      def cmd_changelevel(privmsg, username, level)
+        return notify_user_not_found(privmsg) if !username_exists?(username)
+
+        pstore_transaction do |pstore|
+          pstore[:users][username.downcase][:level] = level.to_i
+        end
+
+        msg(privmsg, "Successfully changed access level of user")
+      end
+
+      # Triggers when an admin deletes a user
+      def cmd_remove(privmsg, username)
+        @manager.logger.debug "AuthPlugin: Going to remove #{username}"
+        return notify_user_not_found(privmsg) if !username_exists?(username)
+
+        pstore_transaction do |pstore|
+          pstore[:users].delete(username.downcase)
+        end
+
+        privmsg.reply("Successfully deleted user")
+        @manager.logger.debug "AuthPlugin: Removed #{username}"
+      end
+
+      # Triggered when a user wants to lookup another user
+      def cmd_lookup(privmsg, username)
+        @manager.logger.debug "AuthPlugin: Going to lookup #{username}"
+        if !username_exists?(username)
+          @manager.logger.debug "AuthPlugin:  #{username} not found!"
+          return notify_user_not_found(privmsg)
+        end
+
+        level = 0
+        
+        pstore_transaction do |pstore|
+          level = pstore[:users][username.downcase][:level]
+        end
+
+        msg(privmsg, "#{username} has a level of #{level.to_s}")
+      end
+
+      # Convenience function for errors
+      def notify_cannot_register_in_public(privmsg)
+        @manager.logger.debug("Can't register in public!")
+        privmsg.reply "You cannot perform this in public! Try with a privmsg"
+      end
+
+      def notify_username_taken(privmsg)
+        @manager.logger.debug("Username taken!")
+        privmsg.reply "That username is already taken"
+      end
+
+      def notify_hostmask_taken(privmsg)
+        @manager.logger.debug("Hostnake taken!")
+        privmsg.reply "That hostmask is already registered to a different user."
+      end
+
+      def notify_incorrect_information(privmsg)
+        @manager.logger.debug("Incorrect information!")
+        privmsg.reply "Username or password is incorrect."
+      end
+      
+      def notify_user_not_found(privmsg)
+        @manager.logger.debug("User not found")
+        privmsg.reply "User not found"
+      end
+    end
+  end
+end

data/plugins/control.rb

@@ -0,0 +1,36 @@
+module Flexo
+  module Plugins
+    # Allows a user to control Flexo through commands
+    # on IRC. Requires Flexo::Plugins::AuthPlugin in order
+    # to maintain the user database and authenticate users, 
+    # as well as for adding the restricted commands
+    class ControlPlugin < Flexo::Plugin
+      NAME    = 'Control'
+      VERSION = '0.1.0'
+      SUMMARY = 'Control a Flexo instance through IRC'
+      DEPENDS = ['auth']
+
+      def initialize(*args)
+        super
+
+        @manager.logger.debug("ControlPlugin started")
+        add_trigger(/^ctrl quit$/, &method(:cmd_quit))
+        add_trigger(/^ctrl realquit$/, &method(:cmd_realquit))
+        add_trigger(/^ctrl join (#\S+)$/, &method(:cmd_join))
+      end
+
+      def cmd_join(privmsg, channel)
+        @manager.sender.join(channel)
+      end
+      
+      def cmd_quit(privmsg)
+        @manager.logger.debug("Trying to quit")
+        privmsg.reply("No!")
+      end
+      
+      def cmd_realquit(privmsg)
+        @manager.sender.quit("Leaving!")
+      end
+    end
+  end
+end

data/plugins/dbus.rb

@@ -0,0 +1,39 @@
+module Flexo
+  module Plugins
+    class DBusPlugin < Flexo::Plugin
+      NAME    = "DBus"
+      VERSION = "0.1.0"
+      SUMMARY = "Adds the possibility for remote-controlling Flexo via DBus"
+      DEPENDS = ['ruby-dbus']
+
+      def initialize(*args)
+        super
+
+        @bus       = DBus::SessionBus.instance
+        @service   = @bus.request_service("org.northblue.Flexo.service")
+        @dbusflexo = Flexo::Plugins::DBusPlugin::Flexo.new(@manager, 
+        "/org/northblue/Flexo/instance")
+        @service.export(@dbusflexo)
+
+        Thread.new do
+          main = DBus::Main.new
+          main << @bus
+          main.run
+        end
+      end
+    end
+
+    class DBusPlugin::Flexo < ::DBus::Object
+      def initialize(path, manager)
+        super path
+        @manager = manager
+      end
+
+      dbus_interface "org.northblue.Flexo.interface" do
+        dbus_method :flexo_get_nick do
+          puts "My nick is #{@manager.nickname}"
+        end
+      end
+    end
+  end
+end

data/plugins/pstore.rb

@@ -0,0 +1,34 @@
+module Flexo
+  module Plugins
+    class PStorePlugin < Flexo::Plugin
+      NAME    = 'pstore'
+      VERSION = '0.1.0'
+      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)
+        rescue
+          raise PluginError("PStore: Unable to open database")
+        end
+      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)
+        @manager.logger.debug "PStore: Starting transaction"
+        mutex { @pstore.transaction(&block) }
+        @manager.logger.debug "PStore: Transaction complete"
+      end
+    end
+  end
+end

data/plugins/svnlookup.rb

@@ -0,0 +1,63 @@
+begin
+  require 'svn/info'
+rescue LoadError
+  raise PluginDependencyError, "Ruby-bindings for Subversion not found"
+end
+
+module Flexo
+  module Plugins
+    # SVN Lookup -- Registers a command to view commit
+    # messages for a subversion repository.
+    # Requires Flexo to be running at the same machine
+    # as the repositories is hosted, since, for now, 
+    # this plugin requires read-access to the filesystem.
+    class SvnLookupPlugin < Flexo::Plugin
+      NAME    = 'SvnLookup'
+      VERSION = '0.1.0'
+      SUMMARY = 'Replies to !svn <project> [<revision>] with information about the commit'
+      DEPENDS = []
+
+      def initialize(*args)
+        super
+        @manager.config['plugins.svn.repositories'] ||= '/var/svn/repositories'
+        @path = @manager.config['plugins.svn.repositories']
+
+        add_trigger(/^svn (\S+) (\d+)?/, &method(:cmd_lookup))
+      end
+
+      private
+
+      def lookup(privmsg, project, revision = 'latest')
+        @manager.logger.debug "Requested information for #{project} (#{revision})"
+        begin
+          if revision == 'latest'
+            revision = Svn::Repos.open("#{@path}/#{project}").fs.youngest_rev
+          end
+
+          @info = Svn::Info.new("#{@path}/#{project}", revision)
+        rescue => e
+          raise PluginError, "#{e.message}\n#{e.backtrace}"
+        end
+
+        author         = @info.author
+        files_added    = @info.added_files.length
+        files_updated  = @info.updated_files.length
+        files_deleted  = @info.deleted_files.length
+        dirs_changed   = @info.changed_dirs.length
+
+        str_changedirs = (dirs_changed < 5 ? "in #{@info.changed_dirs.join(', ')}" : 'in the repository')
+        str_changed    = []
+        str_changed   << "#{files_added.to_s} added" if files_added > 0
+        str_changed   << "#{files_updated.to_s} updated" if files_updated > 0
+        str_changed   << "#{files_deleted.to_s} deleted" if files_deleted > 0
+        str_changed    = (str_changed.length > 0 ? changes.join(', ') : '')
+        str_changelog  = @info.log
+
+        str_full       = "[#{project}] #{str_changed} #{str_changedirs}."
+        str_full      += " r#{revision} commited by #{author}: #{str_changelog}"
+
+        privmsg.reply str_full
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: PerfectlyNormal-Flexo
+version: !ruby/object:Gem::Version 
+  version: 0.3.9
+platform: ruby
+authors: 
+- Per Christian B. Viken
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-10-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: perchr@northblue.org
+executables: 
+- flexo
+- mkflexorc
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- Rakefile
+- LICENSE
+- flexo.gemspec
+- lib/daemonize.rb
+- lib/caselesshash.rb
+- lib/flexo/server.rb
+- lib/flexo/data.rb
+- lib/flexo/errors.rb
+- lib/flexo/plugin.rb
+- lib/flexo/numerics.rb
+- lib/flexo/handler.rb
+- lib/flexo/client.rb
+- lib/flexo/sender.rb
+- lib/flexo/pluginmanager.rb
+- lib/flexo/logger.rb
+- lib/flexo/constants.rb
+- lib/flexo/events/kick.rb
+- lib/flexo/events/join.rb
+- lib/flexo/events/privmsg.rb
+- lib/flexo/events/unknown.rb
+- lib/flexo/events/reply.rb
+- lib/flexo/events/ping.rb
+- lib/flexo/events/pong.rb
+- lib/flexo/events/topic.rb
+- lib/flexo/events/mode.rb
+- lib/flexo/events/quit.rb
+- lib/flexo/events/notice.rb
+- lib/flexo/events/part.rb
+- lib/flexo/events/nick.rb
+- lib/flexo/config.rb
+- lib/flexo/trigger.rb
+- lib/flexo/manager.rb
+- lib/flexo/dispatcher.rb
+- lib/flexo/event.rb
+- plugins/pstore.rb
+- plugins/auth.rb
+- plugins/control.rb
+- plugins/dbus.rb
+- plugins/svnlookup.rb
+has_rdoc: true
+homepage: http://eastblue.org/dev/flexo/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simple, extensible IRC bot based on Flux
+test_files: []
+