Initial import of my "command" plugin. Allows to create mini plugins directly from IRC.

1 files changed, 147 insertions, 0 deletions

diff --git a/data/rbot/plugins/command.rb b/data/rbot/plugins/command.rb
new file mode 100644
index 00000000..80ed4019
--- /dev/null
+++ b/data/rbot/plugins/command.rb
@@ -0,0 +1,147 @@
+# Plugin for the Ruby IRC bot (http://linuxbrit.co.uk/rbot/)
+#
+# Create mini plugins on IRC.
+#
+# Commands are little Ruby programs that run in the context of the command plugin. You 
+# can create them directly in an IRC channel, and invoke them just like normal rbot plugins. 
+#
+# (c) 2006 Mark Kretschmann <markey@web.de>
+# Licensed under GPL V2.
+
+
+Command = Struct.new( "Command", :code, :nick, :created, :channel )
+
+
+class CommandPlugin < Plugin
+
+  def initialize
+    super
+    if @registry.has_key?(:commands)
+      @commands = @registry[:commands]
+    else
+      @commands = Hash.new
+    end
+
+    # Migrate old Hash to new:
+    @commands.each_pair do |name, cmd|
+      unless cmd.instance_of?( Command )
+        @commands[name] = Command.new( cmd, 'unknown hacker', 'somedate', '#somechan' )
+      end
+    end
+  end
+
+
+  def save
+    @registry[:commands] = @commands
+  end
+
+
+  def help( plugin, topic="" )
+    if topic == "add"
+      "Commands are little Ruby programs that run in the context of the command plugin. You can access @bot (class IrcBot), m (class PrivMessage), user (class String, either the first argument, or if missing the sourcenick), and args (class Array, an array of arguments). Example: 'command add greet m.reply( 'Hello ' + user )'. Invoke the command just like a plugin: '<botnick>: greet'."
+    else  
+      "Create mini plugins on IRC. 'command add <name> <code>' => Create command named <name> with the code <source>. 'command list' => Show a list of all known commands. 'command show <name>' => Show the source code for <name>. 'command del <name>' => Delete command <name>."
+    end
+  end
+
+
+  def listen( m )
+    name = m.message.split.first
+
+    if m.address? and @commands.has_key?( name )
+      code = @commands[name].code.dup.untaint
+
+      # Convenience variables, can be accessed by commands:
+      args = m.message.split
+      args.delete_at( 0 ) 
+      user = args.empty? ? m.sourcenick : args.first  
+
+      Thread.start {
+        $SAFE = 3
+
+        begin
+          eval( code )
+        rescue => e
+          m.reply( "Command '#{name}' crapped out :(" )
+          m.reply( e.inspect )
+        end
+      }
+    end
+  end
+
+
+  def handle_add( m, params, force = false )
+    name    = params[:name]
+    if !force and @commands.has_key?( name )
+      m.reply( "#{m.sourcenick}: #{name} already exists. Use 'add -f' if you really want to overwrite it." )
+      return
+    end
+
+    code    = params[:code].join( " " )
+    nick    = m.sourcenick
+    created = Time.new.strftime '%Y/%m/%d %H:%m'
+    channel = m.target
+
+    command = Command.new( code, nick, created, channel )
+    @commands[name] = command
+
+    m.reply( "done" )
+  end
+
+
+  def handle_add_force( m, params )
+    handle_add( m, params, true )
+  end
+    
+
+  def handle_del( m, params )
+    name = params[:name]
+    unless @commands.has_key?( name )
+      m.reply( "Command does not exist." ); return
+    end
+
+    @commands.delete( name )
+    m.reply( "done" )
+  end
+
+
+  def handle_list( m, params )
+    if @commands.length == 0
+      m.reply( "No commands available." ); return
+    end
+
+    cmds_per_page = 30
+    cmds = @commands.keys.sort
+    num_pages = cmds.length / cmds_per_page
+    page = params[:page].to_i
+    page = [page, 1].max
+    page = [page, num_pages].min
+    str = cmds[(page-1)*cmds_per_page, cmds_per_page].join(', ') 
+
+    m.reply "Available commands (page #{page}/#{num_pages}): #{str}" 
+  end
+
+
+  def handle_show( m, params )
+    name = params[:name]
+    unless @commands.has_key?( name )
+      m.reply( "Command does not exist." ); return
+    end
+
+    cmd = @commands[name]
+    m.reply( "#{cmd.code} [#{cmd.nick}, #{cmd.created} in #{cmd.channel}]" )
+ end
+
+end
+
+
+plugin = CommandPlugin.new
+plugin.register( "command" )
+
+plugin.map 'command add -f :name *code', :action => 'handle_add_force', :auth => 'commandedit'
+plugin.map 'command add :name *code',    :action => 'handle_add',       :auth => 'commandedit'
+plugin.map 'command del :name',          :action => 'handle_del',       :auth => 'commandedit'
+plugin.map 'command list :page',         :action => 'handle_list',      :defaults => { :page => '1' }
+plugin.map 'command show :name',         :action => 'handle_show'
+
+