Limnoria/plugins/ShrinkUrl/plugin.py

278 lines
9.9 KiB
Python
Raw Normal View History

###
# Copyright (c) 2002-2004, Jeremiah Fincher
# Copyright (c) 2009-2010, James McCoy
# Copyright (c) 2010-2021, Valentin Lorentz
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions, and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the author of this software nor the name of
# contributors to this software may be used to endorse or promote products
# derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
import re
import sys
import time
import json
import supybot.log as log
import supybot.conf as conf
import supybot.utils as utils
from supybot.commands import *
import supybot.ircmsgs as ircmsgs
import supybot.plugins as plugins
import supybot.ircutils as ircutils
import supybot.callbacks as callbacks
from supybot.i18n import PluginInternationalization, internationalizeDocstring
_ = PluginInternationalization('ShrinkUrl')
class CdbShrunkenUrlDB(object):
def __init__(self, filename):
self.dbs = {}
cdb = conf.supybot.databases.types.cdb
services = list(conf.supybot.plugins.ShrinkUrl.default.validStrings)
services.append('Expand')
for service in services:
dbname = filename.replace('.db', service.capitalize() + '.db')
try:
self.dbs[service] = cdb.connect(dbname)
except OSError as e:
log.error(
'ShrinkUrl: Can not open database %s: %s',
dbname, e)
raise KeyError("Could not open %s" % dbname)
except:
log.exception(
'ShrinkUrl: Can not read database %s (data corruption?)',
dbname)
raise KeyError("Could not open %s" % dbname)
def get(self, service, url):
return self.dbs[service][url]
def set(self, service, url, shrunkurl):
self.dbs[service][url] = shrunkurl
def close(self):
for service in self.dbs:
self.dbs[service].close()
def flush(self):
for service in self.dbs:
self.dbs[service].flush()
ShrunkenUrlDB = plugins.DB('ShrinkUrl', {'cdb': CdbShrunkenUrlDB})
class ShrinkError(Exception):
pass
def retry(f):
def newf(*args, **kwargs):
2015-08-10 19:36:07 +02:00
for x in range(0, 3):
try:
return f(*args, **kwargs)
except Exception:
log.exception('Shrinking URL failed. Trying again.')
time.sleep(1)
return f(*args, **kwargs)
return newf
class ShrinkUrl(callbacks.PluginRegexp):
"""This plugin features commands to shorten URLs through different services,
like tinyurl."""
regexps = ['shrinkSnarfer']
def __init__(self, irc):
self.__parent = super(ShrinkUrl, self)
self.__parent.__init__(irc)
self.db = ShrunkenUrlDB()
def die(self):
self.db.close()
def callCommand(self, command, irc, msg, *args, **kwargs):
try:
self.__parent.callCommand(command, irc, msg, *args, **kwargs)
except utils.web.Error as e:
irc.error(str(e))
def _outFilterThread(self, irc, msg):
(channel, text) = msg.args
network = irc.network
for m in utils.web.httpUrlRe.finditer(text):
url = m.group(1)
if len(url) > self.registryValue('minimumLength', channel, network):
try:
cmd = self.registryValue('serviceRotation',
channel, network, value=False)
cmd = cmd.getService().capitalize()
except ValueError:
cmd = self.registryValue('default', channel, network) \
.capitalize()
try:
shortUrl = getattr(self, '_get%sUrl' % cmd)(url)
text = text.replace(url, shortUrl)
except (utils.web.Error, AttributeError, ShrinkError):
pass
newMsg = ircmsgs.privmsg(channel, text, msg=msg)
newMsg.tag('shrunken')
irc.queueMsg(newMsg)
def outFilter(self, irc, msg):
if msg.command != 'PRIVMSG':
2015-11-11 13:20:44 +01:00
return msg
if msg.channel:
if not msg.shrunken:
if self.registryValue('outFilter', msg.channel, irc.network):
if utils.web.httpUrlRe.search(msg.args[1]):
self._outFilterThread(irc, msg)
return None
return msg
def shrinkSnarfer(self, irc, msg, match):
channel = msg.channel
network = irc.network
if not channel:
return
if self.registryValue('shrinkSnarfer', channel, network):
url = match.group(0)
r = self.registryValue('nonSnarfingRegexp', channel, network)
if r and r.search(url) is not None:
2005-02-01 10:41:39 +01:00
self.log.debug('Matched nonSnarfingRegexp: %u', url)
return
minlen = self.registryValue('minimumLength', channel, network)
try:
cmd = self.registryValue('serviceRotation',
channel, network, value=False)
cmd = cmd.getService().capitalize()
except ValueError:
cmd = self.registryValue('default', channel, network) \
.capitalize()
if len(url) >= minlen:
try:
shorturl = getattr(self, '_get%sUrl' % cmd)(url)
except (utils.web.Error, AttributeError, ShrinkError):
2005-02-01 10:41:39 +01:00
self.log.info('Couldn\'t get shorturl for %u', url)
return
if self.registryValue('shrinkSnarfer.showDomain',
channel, network):
domain = ' (at %s)' % utils.web.getDomain(url)
else:
domain = ''
2005-03-10 00:29:49 +01:00
if self.registryValue('bold'):
s = format('%u%s', ircutils.bold(shorturl), domain)
2005-03-10 00:29:49 +01:00
else:
s = format('%u%s', shorturl, domain)
m = irc.reply(s, prefixNick=False)
if m is not None:
m.tag('shrunken')
shrinkSnarfer = urlSnarfer(shrinkSnarfer)
shrinkSnarfer.__doc__ = utils.web._httpUrlRe
@retry
def _getTinyUrl(self, url):
try:
return self.db.get('tiny', url)
except KeyError:
text = utils.web.getUrl('http://tinyurl.com/api-create.php?url=' + url)
text = text.decode()
if text.startswith('Error'):
raise ShrinkError(text[5:])
self.db.set('tiny', url, text)
return text
@internationalizeDocstring
def tiny(self, irc, msg, args, url):
"""<url>
Returns a TinyURL.com version of <url>
"""
try:
tinyurl = self._getTinyUrl(url)
m = irc.reply(tinyurl)
if m is not None:
m.tag('shrunken')
except ShrinkError as e:
irc.errorPossibleBug(str(e))
tiny = thread(wrap(tiny, ['httpUrl']))
2012-08-11 11:07:40 +02:00
_ur1Api = 'http://ur1.ca/'
_ur1Regexp = re.compile(r'<a href="(?P<url>[^"]+)">')
@retry
2012-08-11 11:07:40 +02:00
def _getUr1Url(self, url):
try:
return self.db.get('ur1ca', utils.web.urlquote(url))
except KeyError:
parameters = utils.web.urlencode({'longurl': url})
response = utils.web.getUrl(self._ur1Api, data=parameters)
ur1ca = self._ur1Regexp.search(response.decode()).group('url')
if ur1ca:
2012-08-11 11:07:40 +02:00
self.db.set('ur1', url, ur1ca)
return ur1ca
else:
2014-03-05 14:14:36 +01:00
raise ShrinkError(response)
2012-08-11 11:07:40 +02:00
def ur1(self, irc, msg, args, url):
"""<url>
Returns an ur1 version of <url>.
"""
try:
ur1url = self._getUr1Url(url)
m = irc.reply(ur1url)
if m is not None:
m.tag('shrunken')
except ShrinkError as e:
2012-08-11 11:07:40 +02:00
irc.error(str(e))
ur1 = thread(wrap(ur1, ['httpUrl']))
2012-08-11 11:07:40 +02:00
_x0Api = 'https://x0.no/api/?%s'
@retry
2009-10-09 04:58:57 +02:00
def _getX0Url(self, url):
try:
return self.db.get('x0', url)
except KeyError:
text = utils.web.getUrl(self._x0Api % url).decode()
2009-10-09 04:58:57 +02:00
if text.startswith('ERROR:'):
raise ShrinkError(text[6:])
2009-10-09 04:58:57 +02:00
self.db.set('x0', url, text)
return text
@internationalizeDocstring
2009-10-09 04:58:57 +02:00
def x0(self, irc, msg, args, url):
"""<url>
Returns an x0.no version of <url>.
"""
try:
x0url = self._getX0Url(url)
m = irc.reply(x0url)
if m is not None:
m.tag('shrunken')
except ShrinkError as e:
2009-10-09 04:58:57 +02:00
irc.error(str(e))
x0 = thread(wrap(x0, ['httpUrl']))
2009-10-09 04:58:57 +02:00
Class = ShrinkUrl
# vim:set shiftwidth=4 softtabstop=4 expandtab textwidth=79: