data/rbot/plugins/script.rb

   1 # Plugin for the Ruby IRC bot (http://linuxbrit.co.uk/rbot/)
   2 #
   3 # Create mini plugins on IRC.
   4 #
   5 # Scripts are little Ruby programs that run in the context of the script plugin. You
   6 # can create them directly in an IRC channel, and invoke them just like normal rbot plugins.
   7 #
   8 # (c) 2006 Mark Kretschmann <markey@web.de>
   9 # Licensed under GPL V2.
  10
  11
  12 Command = Struct.new( "Command", :code, :nick, :created, :channel )
  13
  14
  15 class ScriptPlugin < Plugin
  16
  17   def initialize
  18     super
  19     if @registry.has_key?(:commands)
  20       @commands = @registry[:commands]
  21     end
  22
  23     if @commands.nil?
  24       @commands = Hash.new
  25     end
  26
  27     # Migrate old Hash to new:
  28     @commands.each_pair do |name, cmd|
  29       unless cmd.instance_of?( Command )
  30         @commands[name] = Command.new( cmd, 'unknown hacker', 'somedate', '#somechan' )
  31       end
  32     end
  33   end
  34
  35
  36   def save
  37     @registry[:commands] = @commands
  38   end
  39
  40
  41   def help( plugin, topic="" )
  42     if topic == "add"
  43       "Scripts are little Ruby programs that run in the context of the script 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: 'script add greet m.reply( 'Hello ' + user )'. Invoke the script just like a plugin: '<botnick>: greet'."
  44     else
  45       "Create mini plugins on IRC. 'script add <name> <code>' => Create script named <name> with the code <source>. 'script list' => Show a list of all known scripts. 'script show <name>' => Show the source code for <name>. 'script del <name>' => Delete the script <name>."
  46     end
  47   end
  48
  49
  50   def listen( m )
  51     name = m.message.split.first
  52
  53     if m.address? and @commands.has_key?( name )
  54       code = @commands[name].code.dup.untaint
  55
  56       # Convenience variables, can be accessed by scripts:
  57       args = m.message.split
  58       args.delete_at( 0 )
  59       user = args.empty? ? m.sourcenick : args.first
  60
  61       Thread.start {
  62         # TODO allow different safe levels for different botusers
  63         $SAFE = 3
  64
  65         begin
  66           eval( code )
  67         rescue => e
  68           m.reply( "Script '#{name}' crapped out :(" )
  69           m.reply( e.inspect )
  70         end
  71       }
  72     end
  73   end
  74
  75
  76   def handle_eval( m, params )
  77     code = params[:code].to_s.dup.untaint
  78       Thread.start {
  79         # TODO allow different safe levels for different botusers
  80         begin
  81           eval( code )
  82         rescue => e
  83           m.reply( "Script '#{name}' crapped out :(" )
  84           m.reply( e.inspect )
  85         end
  86       }
  87   end
  88
  89
  90   def handle_add( m, params, force = false )
  91     name    = params[:name]
  92     if !force and @commands.has_key?( name )
  93       m.reply( "#{m.sourcenick}: #{name} already exists. Use 'add -f' if you really want to overwrite it." )
  94       return
  95     end
  96
  97     code    = params[:code].to_s
  98     nick    = m.sourcenick
  99     created = Time.new.strftime '%Y/%m/%d %H:%m'
 100     channel = m.target
 101
 102     command = Command.new( code, nick, created, channel )
 103     @commands[name] = command
 104
 105     m.reply( "done" )
 106   end
 107
 108
 109   def handle_add_force( m, params )
 110     handle_add( m, params, true )
 111   end
 112
 113
 114   def handle_del( m, params )
 115     name = params[:name]
 116     unless @commands.has_key?( name )
 117       m.reply( "Script does not exist." ); return
 118     end
 119
 120     @commands.delete( name )
 121     m.reply( "done" )
 122   end
 123
 124
 125   def handle_list( m, params )
 126     if @commands.length == 0
 127       m.reply( "No scripts available." ); return
 128     end
 129
 130     cmds_per_page = 30
 131     cmds = @commands.keys.sort
 132     num_pages = cmds.length / cmds_per_page + 1
 133     page = params[:page].to_i
 134     page = [page, 1].max
 135     page = [page, num_pages].min
 136     str = cmds[(page-1)*cmds_per_page, cmds_per_page].join(', ')
 137
 138     m.reply "Available scripts (page #{page}/#{num_pages}): #{str}"
 139   end
 140
 141
 142   def handle_show( m, params )
 143     name = params[:name]
 144     unless @commands.has_key?( name )
 145       m.reply( "Script does not exist." ); return
 146     end
 147
 148     cmd = @commands[name]
 149     m.reply( "#{cmd.code} [#{cmd.nick}, #{cmd.created} in #{cmd.channel}]" )
 150  end
 151
 152 end
 153
 154
 155 plugin = ScriptPlugin.new
 156 plugin.register( "script" )
 157 plugin.default_auth( 'edit', false )
 158 plugin.default_auth( 'eval', false )
 159
 160 plugin.map 'script add -f :name *code', :action => 'handle_add_force', :auth_path => 'edit'
 161 plugin.map 'script add :name *code',    :action => 'handle_add',       :auth_path => 'edit'
 162 plugin.map 'script del :name',          :action => 'handle_del',       :auth_path => 'edit'
 163 plugin.map 'script eval *code',         :action => 'handle_eval'
 164 plugin.map 'script list :page',         :action => 'handle_list',      :defaults => { :page => '1' }
 165 plugin.map 'script show :name',         :action => 'handle_show'
 166
 167