lib/rbot/core/basics.rb

   1 #-- vim:sw=2:et\r
   2 #++\r
   3 #\r
   4 # :title: rbot basic management from IRC\r
   5 #\r
   6 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>\r
   7 # Copyright:: (C) 2006,2007 Giuseppe Bilotta\r
   8 # License:: GPL v2\r
   9 \r
  10 class BasicsModule < CoreBotModule\r
  11 \r
  12   def ctcp_listen(m)\r
  13     who = m.private? ? "me" : m.target\r
  14     case m.ctcp.intern\r
  15     when :PING\r
  16       m.ctcp_reply m.message\r
  17       @bot.irclog "@ #{m.source} pinged #{who}"\r
  18     when :TIME\r
  19       m.ctcp_reply Time.now.to_s\r
  20       @bot.irclog "@ #{m.source} asked #{who} what time it is"\r
  21     end\r
  22   end\r
  23 \r
  24   def bot_join(m, param)\r
  25     if param[:pass]\r
  26       @bot.join param[:chan], param[:pass]\r
  27     else\r
  28       @bot.join param[:chan]\r
  29     end\r
  30   end\r
  31 \r
  32   def bot_part(m, param)\r
  33     if param[:chan]\r
  34       @bot.part param[:chan]\r
  35     else\r
  36       @bot.part m.target if m.public?\r
  37     end\r
  38   end\r
  39 \r
  40   def bot_quit(m, param)\r
  41     @bot.quit param[:msg].to_s\r
  42   end\r
  43 \r
  44   def bot_restart(m, param)\r
  45     @bot.restart param[:msg].to_s\r
  46   end\r
  47 \r
  48   def bot_hide(m, param)\r
  49     @bot.join 0\r
  50   end\r
  51 \r
  52   def bot_say(m, param)\r
  53     @bot.say param[:where], param[:what].to_s\r
  54   end\r
  55 \r
  56   def bot_action(m, param)\r
  57     @bot.action param[:where], param[:what].to_s\r
  58   end\r
  59 \r
  60   def bot_mode(m, param)\r
  61     @bot.mode param[:where], param[:what], param[:who].join(" ")\r
  62   end\r
  63 \r
  64   def bot_ping(m, param)\r
  65     m.reply "pong"\r
  66   end\r
  67 \r
  68   def bot_quiet(m, param)\r
  69     if param.has_key?(:where)\r
  70       @bot.set_quiet param[:where].sub(/^here$/, m.target.downcase)\r
  71     else\r
  72       @bot.set_quiet\r
  73     end\r
  74     # Make sense when the commmand is given in private or in a non-quieted\r
  75     # channel\r
  76     m.okay\r
  77   end\r
  78 \r
  79   def bot_talk(m, param)\r
  80     if param.has_key?(:where)\r
  81       @bot.reset_quiet param[:where].sub(/^here$/, m.target.downcase)\r
  82     else\r
  83       @bot.reset_quiet\r
  84     end\r
  85     # Make sense when the commmand is given in private or in a non-quieted\r
  86     # channel\r
  87     m.okay\r
  88   end\r
  89 \r
  90   def bot_help(m, param)\r
  91     m.reply @bot.help(param[:topic].join(" "))\r
  92   end\r
  93 \r
  94   #TODO move these to a "chatback" plugin\r
  95   # when (/^(botsnack|ciggie)$/i)\r
  96   #   @bot.say m.replyto, @lang.get("thanks_X") % m.sourcenick if(m.public?)\r
  97   #   @bot.say m.replyto, @lang.get("thanks") if(m.private?)\r
  98   # when (/^#{Regexp.escape(@bot.nick)}!*$/)\r
  99   #   @bot.say m.replyto, @lang.get("hello_X") % m.sourcenick\r
 100 \r
 101   # handle help requests for "core" topics\r
 102   def help(cmd, topic="")\r
 103     case cmd\r
 104     when "quit"\r
 105       _("quit [<message>] => quit IRC with message <message>")\r
 106     when "restart"\r
 107       _("restart => completely stop and restart the bot (including reconnect)")\r
 108     when "join"\r
 109       _("join <channel> [<key>] => join channel <channel> with secret key <key> if specified. #{myself} also responds to invites if you have the required access level")\r
 110     when "part"\r
 111       _("part <channel> => part channel <channel>")\r
 112     when "hide"\r
 113       _("hide => part all channels")\r
 114     when "nick"\r
 115       _("nick <nick> => attempt to change nick to <nick>")\r
 116     when "say"\r
 117       _("say <channel>|<nick> <message> => say <message> to <channel> or in private message to <nick>")\r
 118     when "action"\r
 119       _("action <channel>|<nick> <message> => does a /me <message> to <channel> or in private message to <nick>")\r
 120     when "quiet"\r
 121       _("quiet [in here|<channel>] => with no arguments, stop speaking in all channels, if \"in here\", stop speaking in this channel, or stop speaking in <channel>")\r
 122     when "talk"\r
 123       _("talk [in here|<channel>] => with no arguments, resume speaking in all channels, if \"in here\", resume speaking in this channel, or resume speaking in <channel>")\r
 124     when "ping"\r
 125       _("ping => replies with a pong")\r
 126     when "mode"\r
 127       _("mode <channel> <mode> <nicks> => set channel modes for <nicks> on <channel> to <mode>")\r
 128     #     when "botsnack"\r
 129     #       return "botsnack => reward #{myself} for being good"\r
 130     #     when "hello"\r
 131     #       return "hello|hi|hey|yo [#{myself}] => greet the bot"\r
 132     else\r
 133       _("%{name}: quit, restart, join, part, hide, save, nick, say, action, topic, quiet, talk, ping, mode") % {:name=>name}\r
 134       #, botsnack, hello\r
 135     end\r
 136   end\r
 137 end\r
 138 \r
 139 basics = BasicsModule.new\r
 140 \r
 141 basics.map "quit *msg",\r
 142   :action => 'bot_quit',\r
 143   :defaults => { :msg => nil },\r
 144   :auth_path => 'quit'\r
 145 basics.map "restart *msg",\r
 146   :action => 'bot_restart',\r
 147   :defaults => { :msg => nil },\r
 148   :auth_path => 'quit'\r
 149 \r
 150 basics.map "quiet [in] [:where]",\r
 151   :action => 'bot_quiet',\r
 152   :auth_path => 'talk::set'\r
 153 basics.map "talk [in] [:where]",\r
 154   :action => 'bot_talk',\r
 155   :auth_path => 'talk::set'\r
 156 \r
 157 basics.map "say :where *what",\r
 158   :action => 'bot_say',\r
 159   :auth_path => 'talk::do'\r
 160 basics.map "action :where *what",\r
 161   :action => 'bot_action',\r
 162   :auth_path => 'talk::do'\r
 163 basics.map "mode :where :what *who",\r
 164   :action => 'bot_mode',\r
 165   :auth_path => 'talk::do'\r
 166 \r
 167 basics.map "join :chan :pass", \r
 168   :action => 'bot_join',\r
 169   :defaults => {:pass => nil},\r
 170   :auth_path => 'move'\r
 171 basics.map "part :chan",\r
 172   :action => 'bot_part',\r
 173   :defaults => {:chan => nil},\r
 174   :auth_path => 'move'\r
 175 basics.map "hide",\r
 176   :action => 'bot_hide',\r
 177   :auth_path => 'move'\r
 178 \r
 179 basics.map "ping",\r
 180   :action => 'bot_ping',\r
 181   :auth_path => '!ping!'\r
 182 basics.map "help *topic",\r
 183   :action => 'bot_help',\r
 184   :defaults => { :topic => [""] },\r
 185   :auth_path => '!help!'\r
 186 \r
 187 basics.default_auth('*', false)\r
 188 \r