plugin(script): remove deprecated $SAFE

[user/henk/code/ruby/rbot.git] / data / rbot / plugins / ri.rb

diff --git a/data/rbot/plugins/ri.rb b/data/rbot/plugins/ri.rb
index f55cdf4dd8c0c8047ad6a3ec90507e179de8266f..9cb7edb24a41caa525d1928cd5d24b5b349db629 100644 (file)
--- a/data/rbot/plugins/ri.rb
+++ b/data/rbot/plugins/ri.rb
@@ -1,16 +1,42 @@
-class RiPlugin < Plugin
+#-- vim:sw=2:et
+#++
+#
+# :title: 'ri' -- ruby documentation plugin
+#
+# Author:: Eric Hodel <drbrain@segment7.net> (aka drbrain)
+# Author:: Michael Brailsford  <brailsmt@yahoo.com> aka brailsmt
+# Author:: dmitry kim <dmitry dot kim at gmail dot com>
+# Copyright:: (C) 2007, dmitry kim
+# Copyright:: (C) Eric Hodel
+# Copyright:: (C) Michael Brailsford
+# License:: MIT
+#
 
-  BotConfig.register BotConfigIntegerValue.new('ri.max_length',
-    :default => 512,
-    :desc => "Maximum length of ri entry (in bytes) which is ok to be sent to channels")
+class RiPlugin < Plugin
 
+  RI_COMMAND = %w{ri -f ansi -T}
 
-  RI_COMMAND = %w{ri -f simple -T}
+  Config.register Config::IntegerValue.new('ri.max_length',
+    :default => 512,
+    :desc => "Maximum length of ri entry (in bytes) which is ok to be sent to channels or other users")
 
   def help(plugin, topic="")
-    "ri <something> => returns ruby documentation for <something>"
+    "ri <something> => returns ruby documentation for <something>; ri [tell] <whom> [about] <something> => sends the documentation entry about <something> to <whom> using /msg"
   end
+
   def ri(m, params)
+    tgt = nil
+    if params[:who]
+      if m.private?
+        if params[:who] != m.sourcenick
+          m.reply '"ri tell <who>" syntax is only allowed in public channels'
+          return
+        end
+      elsif !(tgt = m.channel.users[params[:who]])
+        m.reply "sorry, i don't see user #{params[:who]} here on #{m.channel}"
+        return
+      end
+    end
     args = RI_COMMAND.dup
     if a = params[:something]
       if a == '-c'
@@ -23,17 +49,26 @@ class RiPlugin < Plugin
     begin
       ret = Utils.safe_exec(*args)
     rescue
-      ret = "failed to execute ri"
+      return m.reply("failed to execute ri")
     end
     ret = ret.gsub(/\t/, "  ").split(/\n/).join(" ").gsub(/\s\s+/, '  ')
-    
-    if ret.length > @bot.config['ri.max_length'] && !m.private?
-      ret = 'entry is too long to send to the channel, use /msg to ask me about it'
+
+    if ret.length > @bot.config['ri.max_length']
+      if !m.private? && tgt.to_s != m.sourcenick
+        return m.reply('entry is too long to send to the channel or to some other user, use /msg to ask me about it')
+      end
+    end
+    if tgt
+      @bot.say(tgt, ret)
+      m.okay
+    else
+      m.reply(ret)
     end
-    m.reply(ret)
     return
   end
 end
+
 plugin = RiPlugin.new
-plugin.map 'ri :something',
+plugin.map 'ri :something', :requirements => {:something => /^((-c)|(\w\S+))$/}
+plugin.map 'ri [tell] :who [about] :something',
   :requirements => {:something => /^((-c)|(\w\S+))$/}