]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/url.rb
rss plugin: all watchers are now informed of feed updates when anybody asks for the...
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / url.rb
index 0d85d473a1e6be42bc4a7be89b05d5d058761758..c3463d5d30cbb3984b5c1b49325933f711cafd4c 100644 (file)
@@ -1,22 +1,36 @@
-require 'uri'
+define_structure :Url, :channel, :nick, :time, :url, :info
 
-Url = Struct.new("Url", :channel, :nick, :time, :url)
-TITLE_RE = /<\s*?title\s*?>(.+?)<\s*?\/title\s*?>/im
+class ::UrlLinkError < RuntimeError
+end
 
 class UrlPlugin < Plugin
+  TITLE_RE = /<\s*?title\s*?>(.+?)<\s*?\/title\s*?>/im
+  LINK_INFO = "[Link Info]"
+  OUR_UNSAFE = Regexp.new("[^#{URI::PATTERN::UNRESERVED}#{URI::PATTERN::RESERVED}%# ]", false, 'N')
+
   BotConfig.register BotConfigIntegerValue.new('url.max_urls',
     :default => 100, :validate => Proc.new{|v| v > 0},
     :desc => "Maximum number of urls to store. New urls replace oldest ones.")
-  BotConfig.register BotConfigBooleanValue.new('url.display_link_info',
-    :default => false,
-    :desc => "Get the title of any links pasted to the channel and display it (also tells if the link is broken or the site is down)")
+  BotConfig.register BotConfigIntegerValue.new('url.display_link_info',
+    :default => 0,
+    :desc => "Get the title of links pasted to the channel and display it (also tells if the link is broken or the site is down). Do it for at most this many links per line (set to 0 to disable)")
   BotConfig.register BotConfigBooleanValue.new('url.titles_only',
     :default => false,
     :desc => "Only show info for links that have <title> tags (in other words, don't display info for jpegs, mpegs, etc.)")
+  BotConfig.register BotConfigBooleanValue.new('url.first_par',
+    :default => false,
+    :desc => "Also try to get the first paragraph of a web page")
+  BotConfig.register BotConfigBooleanValue.new('url.info_on_list',
+    :default => false,
+    :desc => "Show link info when listing/searching for urls")
+
 
   def initialize
     super
     @registry.set_default(Array.new)
+    unless @bot.config['url.display_link_info'].kind_of?(Integer)
+      @bot.config.items[:'url.display_link_info'].set_string(@bot.config['url.display_link_info'].to_s)
+    end
   end
 
   def help(plugin, topic="")
@@ -25,99 +39,169 @@ class UrlPlugin < Plugin
 
   def get_title_from_html(pagedata)
     return unless TITLE_RE.match(pagedata)
-    title = $1.strip.gsub(/\s*\n+\s*/, " ")
-    title = Utils.decode_html_entities title
-    "title: #{title}"
+    $1.ircify_html
   end
 
-  def get_title_for_url(uri_str)
+  def get_title_for_url(uri_str, nick = nil, channel = nil)
 
     url = uri_str.kind_of?(URI) ? uri_str : URI.parse(uri_str)
     return if url.scheme !~ /https?/
 
+    logopts = Hash.new
+    logopts[:nick] = nick if nick
+    logopts[:channel] = channel if channel
+
     title = nil
+    extra = String.new
 
     begin
-      @bot.httputil.get_response(url) { |response|
-        case response
+      debug "+ getting #{url.request_uri}"
+      @bot.httputil.get_response(url) { |resp|
+        case resp
         when Net::HTTPSuccess
-          if response['content-type'] =~ /^text\//
-            # since the content is 'text/*' and is small enough to
-            # be a webpage, retrieve the title from the page
-            debug "+ getting #{url.request_uri}"
-
-            # we look for the title in the first 4k bytes
-            # TODO make the amount of data configurable
-            response.partial_body(4096) { |part|
-              title = get_title_from_html(part)
-              return title if title
-            }
-            # if nothing was found, return nothing
-            return
+
+          debug resp.to_hash
+
+          if resp['content-type'] =~ /^text\/|(?:x|ht)ml/
+            # The page is text or HTML, so we can try finding a title and, if
+            # requested, the first par.
+            #
+            # We act differently depending on whether we want the first par or
+            # not: in the first case we download the initial part and the parse
+            # it; in the second case we only download as much as we need to find
+            # the title
+            #
+            if @bot.config['url.first_par']
+              partial = resp.partial_body(@bot.config['http.info_bytes'])
+              logopts[:title] = title = get_title_from_html(partial)
+              if url.fragment and not url.fragment.empty?
+                fragreg = /.*?<a\s+[^>]*name=["']?#{url.fragment}["']?.*?>/im
+                partial.sub!(fragreg,'')
+              end
+              first_par = Utils.ircify_first_html_par(partial, :strip => title)
+              unless first_par.empty?
+                logopts[:extra] = first_par
+                extra << ", #{Bold}text#{Bold}: #{first_par}"
+              end
+              call_event(:url_added, url.to_s, logopts)
+              return "#{Bold}title#{Bold}: #{title}#{extra}" if title
+            else
+              resp.partial_body(@bot.config['http.info_bytes']) { |part|
+                logopts[:title] = title = get_title_from_html(part)
+                call_event(:url_added, url.to_s, logopts)
+                return "#{Bold}title#{Bold}: #{title}" if title
+              }
+            end
+          # if nothing was found, provide more basic info, as for non-html pages
           else
-            unless @bot.config['url.titles_only']
-              # content doesn't have title, just display info.
-              size = response['content-length'].gsub(/(\d)(?=\d{3}+(?:\.|$))(\d{3}\..*)?/,'\1,\2')
-              size = size ? ", size: #{size} bytes" : ""
-              return "type: #{response['content-type']}#{size}"
+            resp.no_cache = true
+          end
+
+          enc = resp['content-encoding']
+          logopts[:extra] = String.new
+          logopts[:extra] << "Content Type: #{resp['content-type']}"
+          if enc
+            logopts[:extra] << ", encoding: #{enc}"
+            extra << ", #{Bold}encoding#{Bold}: #{enc}"
+          end
+
+          unless @bot.config['url.titles_only']
+            # content doesn't have title, just display info.
+            size = resp['content-length'].gsub(/(\d)(?=\d{3}+(?:\.|$))(\d{3}\..*)?/,'\1,\2') rescue nil
+            if size
+              logopts[:extra] << ", size: #{size} bytes"
+              size = ", #{Bold}size#{Bold}: #{size} bytes"
             end
+            call_event(:url_added, url.to_s, logopts)
+            return "#{Bold}type#{Bold}: #{resp['content-type']}#{size}#{extra}"
           end
-        when Net::HTTPResponse
-          return "Error getting link (#{response.code} - #{response.message})"
+          call_event(:url_added, url.to_s, logopts)
         else
-          raise response
+          raise UrlLinkError, "getting link (#{resp.code} - #{resp.message})"
         end
       }
-    rescue Object => e
-      if e.class <= StandardError
-        error e.inspect
-        debug e.backtrace.join("\n")
+      return nil
+    rescue Exception => e
+      case e
+      when UrlLinkError
+        raise e
+      else
+        error e
+        raise "connecting to site/processing information (#{e.message})"
       end
-
-      msg = e.respond_to?(:message) ? e.message : e.to_s
-      return "Error connecting to site (#{e.message})"
     end
   end
 
   def listen(m)
     return unless m.kind_of?(PrivMessage)
     return if m.address?
-    # TODO support multiple urls in one line
-    if m.message =~ /(f|ht)tps?:\/\//
-      if m.message =~ /((f|ht)tps?:\/\/.*?)(?:\s+|$)/
-        urlstr = $1
-        list = @registry[m.target]
-
-        if @bot.config['url.display_link_info']
-          Thread.start do
-            debug "Getting title for #{urlstr}..."
-            begin
-              title = get_title_for_url urlstr
-              if title
-                m.reply "[Link Info] #{title}"
-                debug "Title found!"
-              else
-                debug "Title not found!"
-              end
-            rescue => e
-              debug "Failed: #{e}"
+
+    escaped = URI.escape(m.message, OUR_UNSAFE)
+    urls = URI.extract(escaped)
+    return if urls.empty?
+    debug "found urls #{urls.inspect}"
+    list = @registry[m.target]
+    urls_displayed = 0
+    urls.each { |urlstr|
+      debug "working on #{urlstr}"
+      next unless urlstr =~ /^https?:/
+      title = nil
+      debug "display link info: #{@bot.config['url.display_link_info']}"
+      if @bot.config['url.display_link_info'] > urls_displayed
+        urls_displayed += 1
+        Thread.start do
+          debug "Getting title for #{urlstr}..."
+          begin
+            title = get_title_for_url urlstr, m.source.nick, m.channel
+            if title
+              m.reply "#{LINK_INFO} #{title}", :overlong => :truncate
+              debug "Title found!"
+            else
+              debug "Title not found!"
             end
+          rescue => e
+            m.reply "Error #{e.message}"
           end
         end
+      end
+
+      # check to see if this url is already listed
+      next if list.find {|u| u.url == urlstr }
 
-        # check to see if this url is already listed
-        return if list.find {|u| u.url == urlstr }
+      url = Url.new(m.target, m.sourcenick, Time.new, urlstr, title)
+      debug "#{list.length} urls so far"
+      if list.length > @bot.config['url.max_urls']
+        list.pop
+      end
+      debug "storing url #{url.url}"
+      list.unshift url
+      debug "#{list.length} urls now"
+    }
+    @registry[m.target] = list
+  end
 
-        url = Url.new(m.target, m.sourcenick, Time.new, urlstr)
-        debug "#{list.length} urls so far"
-        if list.length > @bot.config['url.max_urls']
-          list.pop
+  def reply_urls(opts={})
+    list = opts[:list]
+    max = opts[:max]
+    channel = opts[:channel]
+    m = opts[:msg]
+    return unless list and max and m
+    list[0..(max-1)].each do |url|
+      disp = "[#{url.time.strftime('%Y/%m/%d %H:%M:%S')}] <#{url.nick}> #{url.url}"
+      if @bot.config['url.info_on_list']
+        title = url.info || get_title_for_url(url.url, url.nick, channel) rescue nil
+        # If the url info was missing and we now have some, try to upgrade it
+        if channel and title and not url.info
+          ll = @registry[channel]
+          debug ll
+          if el = ll.find { |u| u.url == url.url }
+            el.info = title
+            @registry[channel] = ll
+          end
         end
-        debug "storing url #{url.url}"
-        list.unshift url
-        debug "#{list.length} urls now"
-        @registry[m.target] = list
+        disp << " --> #{title}" if title
       end
+      m.reply disp, :overlong => :truncate
     end
   end
 
@@ -130,9 +214,7 @@ class UrlPlugin < Plugin
     if list.empty?
       m.reply "no urls seen yet for channel #{channel}"
     else
-      list[0..(max-1)].each do |url|
-        m.reply "[#{url.time.strftime('%Y/%m/%d %H:%M:%S')}] <#{url.nick}> #{url.url}"
-      end
+      reply_urls :msg => m, :channel => channel, :list => list, :max => max
     end
   end
 
@@ -144,17 +226,17 @@ class UrlPlugin < Plugin
     max = 1 if max < 1
     regex = Regexp.new(string, Regexp::IGNORECASE)
     list = @registry[channel].find_all {|url|
-      regex.match(url.url) || regex.match(url.nick)
+      regex.match(url.url) || regex.match(url.nick) ||
+        (@bot.config['url.info_on_list'] && regex.match(url.info))
     }
     if list.empty?
       m.reply "no matches for channel #{channel}"
     else
-      list[0..(max-1)].each do |url|
-        m.reply "[#{url.time.strftime('%Y/%m/%d %H:%M:%S')}] <#{url.nick}> #{url.url}"
-      end
+      reply_urls :msg => m, :channel => channel, :list => list, :max => max
     end
   end
 end
+
 plugin = UrlPlugin.new
 plugin.map 'urls search :channel :limit :string', :action => 'search',
                           :defaults => {:limit => 4},