data/rbot/plugins/script.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: Script plugin for rbot
   5 #
   6 # Author:: Mark Kretschmann <markey@web.de>
   7 # Copyright:: (C) 2006 Mark Kretschmann
   8 # License:: GPL v2
   9 #
  10 # Create mini plugins on IRC.
  11 #
  12 # Scripts are little Ruby programs that run in the context of the script
  13 # plugin. You can create them directly in an IRC channel, and invoke them just
  14 # like normal rbot plugins.
  15
  16 define_structure :Command, :code, :nick, :created, :channel
  17
  18 class ScriptPlugin < Plugin
  19
  20   def initialize
  21     super
  22     if @registry.has_key?(:commands)
  23       @commands = @registry[:commands]
  24       raise unless @commands
  25     else
  26       @commands = Hash.new
  27     end
  28   end
  29
  30
  31   def save
  32     @registry[:commands] = @commands
  33   end
  34
  35
  36   def help( plugin, topic="" )
  37     if topic == "add"
  38       "Scripts are little Ruby programs that run in the context of the script plugin. You can access @bot (class Irc::Bot), m (class Irc::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'."
  39     else
  40       "Create mini plugins on IRC. 'script add <name> <code>' => Create script named <name> with the Ruby program <code>. '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>. 'script eval <expr>' => evaluate expression <expr>. 'script echo <expr>' => evaluate and display expression <expr>."
  41     end
  42   end
  43
  44   def report_error(m, name, e)
  45     # ed = e.backtrace.unshift(e.inspect).join(' ')
  46     ed = e.inspect
  47     m.reply( "Script '#{name}' crapped out :( #{ed}" )
  48   end
  49
  50
  51   def message( m )
  52     name = m.message.split.first
  53
  54     if m.address? and @commands.has_key?( name )
  55       auth_path = "script::run::#{name}".intern
  56       return unless @bot.auth.allow?(auth_path, m.source, m.replyto)
  57
  58       code = @commands[name].code.dup.untaint
  59
  60       # Convenience variables, can be accessed by scripts:
  61       args = m.message.split
  62       args.delete_at( 0 )
  63       user = args.empty? ? m.sourcenick : args.first
  64
  65       Thread.start {
  66         # TODO allow different safe levels for different botusers
  67         $SAFE = 3
  68
  69         begin
  70           eval( code )
  71         rescue Exception => e
  72           report_error(m, name, e)
  73         end
  74       }
  75       m.replied = true
  76     end
  77   end
  78
  79   def handle_allow_deny(m, p)
  80     name = p[:stuff]
  81     if @commands.has_key?( name )
  82       @bot.plugins['auth'].auth_allow_deny(m, p.merge(
  83         :auth_path => "script::run::#{name}".intern
  84       ))
  85     else
  86       m.reply(_("%{stuff} is not a script I know of") % p)
  87     end
  88   end
  89
  90   def handle_allow(m, p)
  91     handle_allow_deny(m, p.merge(:allow => true))
  92   end
  93
  94   def handle_deny(m, p)
  95     handle_allow_deny(m, p.merge(:allow => false))
  96   end
  97
  98
  99
 100   def handle_eval( m, params )
 101     code = params[:code].to_s.dup.untaint
 102     Thread.start {
 103       # TODO allow different safe levels for different botusers
 104       begin
 105         eval( code )
 106       rescue Exception => e
 107         report_error(m, code, e)
 108       end
 109     }
 110     m.replied = true
 111   end
 112
 113
 114   def handle_echo( m, params )
 115     code = params[:code].to_s.dup.untaint
 116     Thread.start {
 117       # TODO allow different safe levels for different botusers
 118       begin
 119         m.reply eval( code ).to_s
 120       rescue Exception => e
 121         report_error(m, code, e)
 122       end
 123     }
 124     m.replied = true
 125   end
 126
 127
 128   def handle_add( m, params, force = false )
 129     name    = params[:name]
 130     if !force and @commands.has_key?( name )
 131       m.reply( "#{m.sourcenick}: #{name} already exists. Use 'add -f' if you really want to overwrite it." )
 132       return
 133     end
 134
 135     code    = params[:code].to_s
 136     nick    = m.sourcenick
 137     created = Time.new.strftime '%Y/%m/%d %H:%m'
 138     channel = m.target.to_s
 139
 140     command = Command.new( code, nick, created, channel )
 141     @commands[name] = command
 142
 143     m.okay
 144   end
 145
 146
 147   def handle_add_force( m, params )
 148     handle_add( m, params, true )
 149   end
 150
 151
 152   def handle_del( m, params )
 153     name = params[:name]
 154     unless @commands.has_key?( name )
 155       m.reply( "Script does not exist." ); return
 156     end
 157
 158     @commands.delete( name )
 159     m.okay
 160   end
 161
 162
 163   def handle_list( m, params )
 164     if @commands.length == 0
 165       m.reply( "No scripts available." ); return
 166     end
 167
 168     cmds_per_page = 30
 169     cmds = @commands.keys.sort
 170     num_pages = cmds.length / cmds_per_page + 1
 171     page = params[:page].to_i
 172     page = [page, 1].max
 173     page = [page, num_pages].min
 174     str = cmds[(page-1)*cmds_per_page, cmds_per_page].join(', ')
 175
 176     m.reply "Available scripts (page #{page}/#{num_pages}): #{str}"
 177   end
 178
 179
 180   def handle_show( m, params )
 181     name = params[:name]
 182     unless @commands.has_key?( name )
 183       m.reply( "Script does not exist." ); return
 184     end
 185
 186     cmd = @commands[name]
 187     m.reply( "#{cmd.code} [#{cmd.nick}, #{cmd.created} in #{cmd.channel}]" )
 188  end
 189
 190 end
 191
 192
 193 plugin = ScriptPlugin.new
 194
 195 plugin.default_auth( 'edit', false )
 196 plugin.default_auth( 'eval', false )
 197 plugin.default_auth( 'echo', false )
 198 plugin.default_auth( 'run', true )
 199
 200 plugin.map 'script add -f :name *code', :action => 'handle_add_force', :auth_path => 'edit'
 201 plugin.map 'script add :name *code',    :action => 'handle_add',       :auth_path => 'edit'
 202 plugin.map 'script del :name',          :action => 'handle_del',       :auth_path => 'edit'
 203 plugin.map 'script eval *code',         :action => 'handle_eval'
 204 plugin.map 'script echo *code',         :action => 'handle_echo'
 205 plugin.map 'script list :page',         :action => 'handle_list',      :defaults => { :page => '1' }
 206 plugin.map 'script show :name',         :action => 'handle_show'
 207
 208 plugin.map 'script allow :stuff for :user [*where]',
 209   :action => 'handle_allow',
 210   :requirements => {:where => /^(?:anywhere|everywhere|[io]n \S+)$/},
 211   :auth_path => 'edit'
 212 plugin.map 'script deny :stuff for :user [*where]',
 213   :action => 'handle_deny',
 214   :requirements => {:where => /^(?:anywhere|everywhere|[io]n \S+)$/},
 215   :auth_path => 'edit'
 216