4 # :title: Script plugin for rbot
6 # Author:: Mark Kretschmann <markey@web.de>
7 # Copyright:: (C) 2006 Mark Kretschmann
10 # Create mini plugins on IRC.
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.
16 define_structure :Command, :code, :nick, :created, :channel
18 class ScriptPlugin < Plugin
22 if @registry.has_key?(:commands)
23 @commands = @registry[:commands]
24 raise unless @commands
32 @registry[:commands] = @commands
36 def help( plugin, topic="" )
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'."
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>."
44 def report_error(m, name, e)
45 # ed = e.backtrace.unshift(e.inspect).join(' ')
47 m.reply( "Script '#{name}' crapped out :( #{ed}" )
52 name = m.message.split.first
54 if m.address? and @commands.has_key?( name )
55 code = @commands[name].code.dup.untaint
57 # Convenience variables, can be accessed by scripts:
58 args = m.message.split
60 user = args.empty? ? m.sourcenick : args.first
63 # TODO allow different safe levels for different botusers
69 report_error(m, name, e)
77 def handle_eval( m, params )
78 code = params[:code].to_s.dup.untaint
80 # TODO allow different safe levels for different botusers
84 report_error(m, code, e)
91 def handle_echo( m, params )
92 code = params[:code].to_s.dup.untaint
94 # TODO allow different safe levels for different botusers
96 m.reply eval( code ).to_s
98 report_error(m, code, e)
105 def handle_add( m, params, force = false )
107 if !force and @commands.has_key?( name )
108 m.reply( "#{m.sourcenick}: #{name} already exists. Use 'add -f' if you really want to overwrite it." )
112 code = params[:code].to_s
114 created = Time.new.strftime '%Y/%m/%d %H:%m'
115 channel = m.target.to_s
117 command = Command.new( code, nick, created, channel )
118 @commands[name] = command
124 def handle_add_force( m, params )
125 handle_add( m, params, true )
129 def handle_del( m, params )
131 unless @commands.has_key?( name )
132 m.reply( "Script does not exist." ); return
135 @commands.delete( name )
140 def handle_list( m, params )
141 if @commands.length == 0
142 m.reply( "No scripts available." ); return
146 cmds = @commands.keys.sort
147 num_pages = cmds.length / cmds_per_page + 1
148 page = params[:page].to_i
150 page = [page, num_pages].min
151 str = cmds[(page-1)*cmds_per_page, cmds_per_page].join(', ')
153 m.reply "Available scripts (page #{page}/#{num_pages}): #{str}"
157 def handle_show( m, params )
159 unless @commands.has_key?( name )
160 m.reply( "Script does not exist." ); return
163 cmd = @commands[name]
164 m.reply( "#{cmd.code} [#{cmd.nick}, #{cmd.created} in #{cmd.channel}]" )
170 plugin = ScriptPlugin.new
172 plugin.default_auth( 'edit', false )
173 plugin.default_auth( 'eval', false )
174 plugin.default_auth( 'echo', false )
176 plugin.map 'script add -f :name *code', :action => 'handle_add_force', :auth_path => 'edit'
177 plugin.map 'script add :name *code', :action => 'handle_add', :auth_path => 'edit'
178 plugin.map 'script del :name', :action => 'handle_del', :auth_path => 'edit'
179 plugin.map 'script eval *code', :action => 'handle_eval'
180 plugin.map 'script echo *code', :action => 'handle_echo'
181 plugin.map 'script list :page', :action => 'handle_list', :defaults => { :page => '1' }
182 plugin.map 'script show :name', :action => 'handle_show'