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         $SAFE = 3
  63
  64         begin
  65           eval( code )
  66         rescue => e
  67           m.reply( "Script '#{name}' crapped out :(" )
  68           m.reply( e.inspect )
  69         end
  70       }
  71     end
  72   end
  73
  74
  75   def handle_add( m, params, force = false )
  76     name    = params[:name]
  77     if !force and @commands.has_key?( name )
  78       m.reply( "#{m.sourcenick}: #{name} already exists. Use 'add -f' if you really want to overwrite it." )
  79       return
  80     end
  81
  82     code    = params[:code].join( " " )
  83     nick    = m.sourcenick
  84     created = Time.new.strftime '%Y/%m/%d %H:%m'
  85     channel = m.target
  86
  87     command = Command.new( code, nick, created, channel )
  88     @commands[name] = command
  89
  90     m.reply( "done" )
  91   end
  92
  93
  94   def handle_add_force( m, params )
  95     handle_add( m, params, true )
  96   end
  97
  98
  99   def handle_del( m, params )
 100     name = params[:name]
 101     unless @commands.has_key?( name )
 102       m.reply( "Script does not exist." ); return
 103     end
 104
 105     @commands.delete( name )
 106     m.reply( "done" )
 107   end
 108
 109
 110   def handle_list( m, params )
 111     if @commands.length == 0
 112       m.reply( "No scripts available." ); return
 113     end
 114
 115     cmds_per_page = 30
 116     cmds = @commands.keys.sort
 117     num_pages = cmds.length / cmds_per_page + 1
 118     page = params[:page].to_i
 119     page = [page, 1].max
 120     page = [page, num_pages].min
 121     str = cmds[(page-1)*cmds_per_page, cmds_per_page].join(', ')
 122
 123     m.reply "Available scripts (page #{page}/#{num_pages}): #{str}"
 124   end
 125
 126
 127   def handle_show( m, params )
 128     name = params[:name]
 129     unless @commands.has_key?( name )
 130       m.reply( "Script does not exist." ); return
 131     end
 132
 133     cmd = @commands[name]
 134     m.reply( "#{cmd.code} [#{cmd.nick}, #{cmd.created} in #{cmd.channel}]" )
 135  end
 136
 137 end
 138
 139
 140 plugin = ScriptPlugin.new
 141 plugin.register( "script" )
 142 plugin.default_auth( 'edit', false )
 143
 144 plugin.map 'script add -f :name *code', :action => 'handle_add_force', :auth_path => 'edit!'
 145 plugin.map 'script add :name *code',    :action => 'handle_add',       :auth_path => 'edit!'
 146 plugin.map 'script del :name',          :action => 'handle_del',       :auth_path => 'edit!'
 147 plugin.map 'script list :page',         :action => 'handle_list',      :defaults => { :page => '1' }
 148 plugin.map 'script show :name',         :action => 'handle_show'
 149
 150