git.oblomov.eu Git - rbot/blob - data/rbot/plugins/twitter.rb

   1 #-- vim:sw=2:et
   2 #++
   3 #
   4 # :title: Twitter Status Update for rbot
   5 #
   6 # Author:: Carter Parks (carterparks) <carter@carterparks.com>
   7 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
   8 #
   9 # Copyright:: (C) 2007 Carter Parks
  10 # Copyright:: (C) 2007 Giuseppe Bilotta
  11 #
  12 # Users can setup their twitter username and password and then begin updating
  13 # twitter whenever
  14
  15 require 'rexml/rexml'
  16 require 'cgi'
  17
  18 class TwitterPlugin < Plugin
  19   Config.register Config::IntegerValue.new('twitter.status_count',
  20     :default => 1, :validate => Proc.new { |v| v > 0 && v <= 10},
  21     :desc => "Maximum number of status updates shown by 'twitter status'")
  22   Config.register Config::IntegerValue.new('twitter.friends_status_count',
  23     :default => 3, :validate => Proc.new { |v| v > 0 && v <= 10},
  24     :desc => "Maximum number of status updates shown by 'twitter friends status'")
  25
  26   def initialize
  27     super
  28
  29     class << @registry
  30       def store(val)
  31         val
  32       end
  33       def restore(val)
  34         val
  35       end
  36     end
  37
  38     @header = {
  39       'X-Twitter-Client' => 'rbot twitter plugin'
  40     }
  41   end
  42
  43   # return a help string when the bot is asked for help on this plugin
  44   def help(plugin, topic="")
  45     return "twitter status [nick] => show nick's (or your) status, use 'twitter friends status [nick]' to also show the friends' timeline | twitter update [status] => updates your status on twitter | twitter identify [username] [password] => ties your nick to your twitter username and password | twitter actions [on|off] => enable/disable twitting of actions (/me does ...)"
  46   end
  47
  48   # update the status on twitter
  49   def get_status(m, params)
  50
  51     nick = params[:nick] || @registry[m.sourcenick + "_username"]
  52
  53     if not nick
  54       m.reply "you should specify the username of the twitter touse, or identify using 'twitter identify [username] [password]'"
  55       return false
  56     end
  57
  58     user = URI.escape(nick)
  59
  60     count = @bot.config['twitter.status_count']
  61     unless params[:friends]
  62       uri = "http://twitter.com/statuses/user_timeline/#{user}.xml?count=#{count}"
  63     else
  64       count = @bot.config['twitter.friends_status_count']
  65       uri = "http://twitter.com/statuses/friends_timeline/#{user}.xml"
  66     end
  67
  68     response = @bot.httputil.get(uri, :headers => @header, :cache => false)
  69     debug response
  70
  71     texts = []
  72
  73     if response
  74       begin
  75         rex = REXML::Document.new(response)
  76         rex.root.elements.each("status") { |st|
  77           # month, day, hour, min, sec, year = st.elements['created_at'].text.match(/\w+ (\w+) (\d+) (\d+):(\d+):(\d+) \S+ (\d+)/)[1..6]
  78           # debug [year, month, day, hour, min, sec].inspect
  79           # time = Time.local(year.to_i, month, day.to_i, hour.to_i, min.to_i, sec.to_i)
  80           time = Time.parse(st.elements['created_at'].text)
  81           now = Time.now
  82           # Sometimes, time can be in the future; invert the relation in this case
  83           delta = ((time > now) ? time - now : now - time)
  84           msg = st.elements['text'].to_s + " (#{Utils.secs_to_string(delta.to_i)} ago via #{st.elements['source'].to_s})"
  85           author = ""
  86           if params[:friends]
  87             author = Utils.decode_html_entities(st.elements['user'].elements['name'].text) + ": " rescue ""
  88           end
  89           texts << author+Utils.decode_html_entities(msg).ircify_html
  90         }
  91         if params[:friends]
  92           # friends always return the latest 20 updates, so we clip the count
  93           texts[count..-1]=nil
  94         end
  95       rescue
  96         error $!
  97         m.reply "could not parse status for #{nick}"
  98         return false
  99       end
 100       m.reply texts.reverse.join("\n")
 101       return true
 102     else
 103       m.reply "could not get status for #{nick}"
 104       return false
 105     end
 106   end
 107
 108   # update the status on twitter
 109   def update_status(m, params)
 110
 111
 112     unless @registry.has_key?(m.sourcenick + "_password") && @registry.has_key?(m.sourcenick + "_username")
 113       m.reply "you must identify using 'twitter identify [username] [password]'"
 114       return false
 115     end
 116
 117     user = URI.escape(@registry[m.sourcenick + "_username"])
 118     pass = URI.escape(@registry[m.sourcenick + "_password"])
 119     uri = "http://#{user}:#{pass}@twitter.com/statuses/update.xml"
 120
 121     msg = params[:status].to_s
 122
 123     if msg.length > 160
 124       m.reply "your status message update is too long, please keep it under 140 characters if possible, 160 characters maximum"
 125       return
 126     end
 127
 128     if msg.length > 140
 129       m.reply "your status message is longer than 140 characters, which is not optimal, but I'm going to update anyway"
 130     end
 131
 132     source = "source=rbot"
 133     msg = "status=#{CGI.escape(msg)}"
 134     body = [source,msg].join("&")
 135
 136     response = @bot.httputil.post(uri, body, :headers => @header)
 137     debug response
 138
 139     reply_method = params[:notify] ? :notify : :reply
 140     if response.class == Net::HTTPOK
 141       m.__send__(reply_method, "status updated")
 142     else
 143       m.__send__(reply_method, "could not update status")
 144     end
 145   end
 146
 147   # ties a nickname to a twitter username and password
 148   def identify(m, params)
 149     @registry[m.sourcenick + "_username"] = params[:username].to_s
 150     @registry[m.sourcenick + "_password"] = params[:password].to_s
 151     m.reply "you're all setup!"
 152   end
 153
 154   # update on ACTION if the user has enabled the option
 155   def ctcp_listen(m)
 156     return unless m.action?
 157     return unless @registry[m.sourcenick + "_actions"]
 158     update_status(m, :status => m.message, :notify => true)
 159   end
 160
 161   # show or toggle action twitting
 162   def actions(m, params)
 163     case params[:toggle]
 164     when 'on'
 165       @registry[m.sourcenick + "_actions"] = true
 166       m.okay
 167     when 'off'
 168       @registry.delete(m.sourcenick + "_actions")
 169       m.okay
 170     else
 171       if @registry[m.sourcenick + "_actions"]
 172         m.reply _("actions will be twitted")
 173       else
 174         m.reply _("actions will not be twitted")
 175       end
 176     end
 177   end
 178 end
 179
 180 # create an instance of our plugin class and register for the "length" command
 181 plugin = TwitterPlugin.new
 182 plugin.map 'twitter identify :username :password', :action => "identify", :public => false
 183 plugin.map 'twitter update *status', :action => "update_status", :threaded => true
 184 plugin.map 'twitter status [:nick]', :action => "get_status", :threaded => true
 185 plugin.map 'twitter actions [:toggle]', :action => "actions", :requirements => { :toggle => /^on|off$/ }
 186 plugin.map 'twitter :friends [status] [:nick]', :action => "get_status", :requirements => { :friends => /^friends?$/ }, :threaded => true
 187