272 lines
9.9 KiB
Python
272 lines
9.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
###
|
|
# Copyright (c) 2015, PrgmrBill
|
|
# All rights reserved.
|
|
#
|
|
#
|
|
###
|
|
|
|
import supybot.utils as utils
|
|
from supybot.commands import *
|
|
import supybot.plugins as plugins
|
|
import supybot.ircmsgs as ircmsgs
|
|
import supybot.ircutils as ircutils
|
|
import supybot.callbacks as callbacks
|
|
import re
|
|
import requests
|
|
from urlparse import urlparse
|
|
from bs4 import BeautifulSoup
|
|
import random
|
|
import json
|
|
import cgi
|
|
|
|
try:
|
|
from supybot.i18n import PluginInternationalization
|
|
_ = PluginInternationalization('SpiffyTitles')
|
|
except ImportError:
|
|
# Placeholder that allows to run the plugin on a bot
|
|
# without the i18n module
|
|
_ = lambda x: x
|
|
|
|
|
|
class SpiffyTitles(callbacks.Plugin):
|
|
"""Displays link titles when posted in a channel"""
|
|
threaded = True
|
|
callBefore = ['Web']
|
|
|
|
def doPrivmsg(self, irc, msg):
|
|
channel = msg.args[0].lower()
|
|
is_channel = irc.isChannel(channel)
|
|
is_ctcp = ircmsgs.isCtcp(msg)
|
|
message = msg.args[1]
|
|
|
|
if is_channel and not is_ctcp:
|
|
channel_whitelist = self.get_channel_whitelist()
|
|
|
|
url = self.get_url_from_message(message)
|
|
|
|
if url:
|
|
# If there is a channel whitelist and the origin channel is
|
|
# not in the whitelist, bail out.
|
|
if len(channel_whitelist) and channel not in channel_whitelist:
|
|
self.log.info("SpiffyTitles: ignoring link in %s due to whitelist %s" % (channel, str(channel_whitelist)))
|
|
return
|
|
|
|
info = urlparse(url)
|
|
|
|
if info:
|
|
domain = info.netloc
|
|
is_ignored = self.is_ignored_domain(domain)
|
|
|
|
if is_ignored:
|
|
self.log.info("SpiffyTitles: ignoring url due to pattern match: %s" % (url))
|
|
return
|
|
|
|
handlers = {
|
|
"youtube.com": self.handler_youtube,
|
|
"www.youtube.com": self.handler_youtube,
|
|
"youtu.be": self.handler_youtube
|
|
}
|
|
|
|
try:
|
|
handler = handlers[domain]
|
|
title = handler(url, info, irc)
|
|
except KeyError:
|
|
title = self.handler_default(url, info, irc)
|
|
else:
|
|
self.log.error("SpiffyTitles: unable to determine domain from url %s" % (url))
|
|
title = self.handler_default(url, irc)
|
|
|
|
if title is not None:
|
|
formatted_title = self.get_formatted_title(title)
|
|
|
|
self.log.info("SpiffyTitles: title found: %s" % (formatted_title))
|
|
|
|
irc.reply(formatted_title)
|
|
|
|
def get_channel_whitelist(self):
|
|
white_list = self.registryValue("channelWhitelist")
|
|
channels = []
|
|
|
|
if len(white_list):
|
|
for channel in white_list:
|
|
if channel:
|
|
normalized_channel = channel.strip().lower()
|
|
|
|
channels.append(normalized_channel)
|
|
|
|
return channels
|
|
|
|
def is_ignored_domain(self, domain):
|
|
ignored_patterns = self.registryValue("ignoredDomainPatterns")
|
|
num_patterns = len(ignored_patterns)
|
|
|
|
if num_patterns:
|
|
self.log.debug("SpiffyTitles: matching %s against %s" % (num_patterns, str(ignored_patterns)))
|
|
|
|
for pattern in ignored_patterns:
|
|
try:
|
|
pattern_search_result = re.search(pattern, domain)
|
|
|
|
if pattern_search_result is not None:
|
|
match = pattern_search_result.group()
|
|
|
|
return match
|
|
except re.Error:
|
|
self.log.error("SpiffyTitles: invalid regular expression: %s" % (pattern))
|
|
|
|
def get_video_id_from_url(self, url, info, irc):
|
|
try:
|
|
path = info.path
|
|
domain = info.netloc
|
|
video_id = ""
|
|
|
|
if domain == "youtu.be":
|
|
video_id = path.split("/")[1]
|
|
else:
|
|
parsed = cgi.parse_qsl(info.query)
|
|
video_id = dict(parsed)["v"]
|
|
|
|
if video_id:
|
|
return video_id
|
|
else:
|
|
self.log.error("SpiffyTitles: error getting video id from %s" % (url))
|
|
|
|
except IndexError, e:
|
|
self.log.error("SpiffyTitles: error getting video id from %s (%s)" % (url, str(e)))
|
|
|
|
def handler_youtube(self, url, domain, irc):
|
|
self.log.info("SpiffyTitles: calling youtube handler for %s" % (url))
|
|
video_id = self.get_video_id_from_url(url, domain, irc)
|
|
template = self.registryValue("youtubeTitleTemplate")
|
|
title = ""
|
|
|
|
if video_id:
|
|
api_url = "https://gdata.youtube.com/feeds/api/videos/%s?v=2&alt=jsonc" % (video_id)
|
|
agent = self.get_user_agent()
|
|
headers = {
|
|
"User-Agent": agent
|
|
}
|
|
|
|
self.log.info("SpiffyTitles: requesting %s" % (api_url))
|
|
|
|
request = requests.get(api_url, headers=headers)
|
|
ok = request.status_code == requests.codes.ok
|
|
|
|
if ok:
|
|
response = json.loads(request.text)
|
|
|
|
if response:
|
|
try:
|
|
data = response["data"]
|
|
tmp_title = data['title']
|
|
rating = round(data['rating'], 2)
|
|
view_count = '{:,}'.format(int(data['viewCount']))
|
|
|
|
title = template % (tmp_title, view_count, rating)
|
|
|
|
except IndexError:
|
|
self.log.error("SpiffyTitles: IndexError parsing Youtube API JSON response")
|
|
else:
|
|
self.log.error("SpiffyTitles: Error parsing Youtube API JSON response")
|
|
else:
|
|
self.log.error("SpiffyTitles: Youtube API HTTP %s: %s" % (request.status_code,
|
|
request.text))
|
|
|
|
# If we found a title, return that. otherwise, use default handler
|
|
if title:
|
|
return title
|
|
else:
|
|
self.log.info("SpiffyTitles: falling back to default handler")
|
|
|
|
return self.handler_default(url, domain, irc)
|
|
|
|
def handler_default(self, url, domain, irc):
|
|
self.log.info("SpiffyTitles: calling default handler for %s" % (url))
|
|
template = self.registryValue("defaultTitleTemplate")
|
|
html = self.get_source_by_url(url)
|
|
|
|
if html:
|
|
title = self.get_title_from_html(html)
|
|
title_template = template % (title)
|
|
|
|
return title_template
|
|
|
|
def get_formatted_title(self, title):
|
|
useBold = self.registryValue("useBold")
|
|
|
|
# Replace anywhere in string
|
|
title = title.replace("\n", "")
|
|
title = title.replace("\t", "")
|
|
|
|
if useBold:
|
|
title = ircutils.bold(title)
|
|
|
|
# Strip whitespace on either side
|
|
title = title.strip()
|
|
|
|
return title
|
|
|
|
def get_title_from_html(self, html):
|
|
soup = BeautifulSoup(html)
|
|
|
|
if soup:
|
|
title = soup.find("head").find("title")
|
|
|
|
if title:
|
|
return title.get_text().strip()
|
|
|
|
def get_source_by_url(self, url):
|
|
try:
|
|
agent = self.get_user_agent()
|
|
headers = {
|
|
"User-Agent": agent
|
|
}
|
|
request = requests.get(url, headers=headers)
|
|
|
|
ok = request.status_code == requests.codes.ok
|
|
|
|
if ok:
|
|
# Check the content type which comes in the format: text/html; charset=UTF-8
|
|
content_type = request.headers.get("content-type").split(";")[0].strip()
|
|
acceptable_types = self.registryValue("mimeTypes")
|
|
mime_type_acceptable = content_type in acceptable_types
|
|
|
|
self.log.info("SpiffyTitles: content type %s" % (content_type))
|
|
|
|
if mime_type_acceptable:
|
|
text = request.content
|
|
|
|
return text
|
|
else:
|
|
self.log.debug("SpiffyTitles: unacceptable mime type %s for url %s" % (content_type, url))
|
|
else:
|
|
self.log.error("SpiffyTitles HTTP response code %s - %s" % (request.status_code,
|
|
request.content))
|
|
|
|
except requests.exceptions.Timeout, e:
|
|
self.log.error("SpiffyTitles Timeout: %s" % (str(e)))
|
|
except requests.exceptions.ConnectionError, e:
|
|
self.log.error("SpiffyTitles ConnectionError: %s" % (str(e)))
|
|
except requests.exceptions.HTTPError, e:
|
|
self.log.error("SpiffyTitles HTTPError: %s" % (str(e)))
|
|
except requests.exceptions.InvalidURL, e:
|
|
self.log.error("SpiffyTitles InvalidURL: %s" % (str(e)))
|
|
|
|
def get_user_agent(self):
|
|
agents = self.registryValue("userAgents")
|
|
|
|
return random.choice(agents)
|
|
|
|
def get_url_from_message(self, input):
|
|
url_re = self.registryValue("urlRegularExpression")
|
|
match = re.search(url_re, input)
|
|
|
|
if match:
|
|
return match.group(0)
|
|
|
|
Class = SpiffyTitles
|
|
|
|
|
|
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79:
|