Limnoria/plugins/RSS.py

173 lines
6.2 KiB
Python
Raw Normal View History

2003-04-06 13:42:41 +02:00
#!/usr/bin/env python
###
# Copyright (c) 2002, Jeremiah Fincher
# 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.
###
"""
Provides basic functionality for handling RSS/RDF feeds. Depends on the Alias
module for user-friendliness.
2003-04-06 13:42:41 +02:00
"""
2003-11-25 09:23:47 +01:00
__revision__ = "$Id$"
import plugins
2003-04-06 13:42:41 +02:00
2003-12-03 22:21:43 +01:00
import sets
2003-04-06 13:49:53 +02:00
import time
2003-12-03 22:21:43 +01:00
import types
from itertools import imap
2003-04-06 13:49:53 +02:00
2003-04-06 13:42:41 +02:00
import rssparser
2003-12-03 22:21:43 +01:00
import conf
2003-04-19 23:40:39 +02:00
import utils
2003-04-06 13:42:41 +02:00
import privmsgs
import callbacks
def configure(onStart, afterConnect, advanced):
from questions import expect, anything, something, yn
onStart.append('load RSS')
prompt = 'Would you like to add an RSS feed?'
while yn(prompt) == 'y':
prompt = 'Would you like to add another RSS feed?'
2003-08-28 23:27:15 +02:00
name = something('What\'s the name of the website?')
url = something('What\'s the URL of the RSS feed?')
2003-12-03 22:21:43 +01:00
onStart.append('rss add %s %s' % (name, url))
#onStart.append('alias lock %s' % name)
2003-08-20 18:26:23 +02:00
2003-04-06 13:42:41 +02:00
class RSS(callbacks.Privmsg):
threaded = True
def __init__(self):
callbacks.Privmsg.__init__(self)
2003-12-03 22:21:43 +01:00
self.feedNames = sets.Set()
self.lastRequest = {}
self.cachedFeeds = {}
2003-12-03 22:21:43 +01:00
def add(self, irc, msg, args):
"""<name> <url>
Adds a command to this plugin that will look up the RSS feed at the
given URL.
"""
(name, url) = privmsgs.getArgs(args, required=2)
docstring = """takes no arguments
Reports the titles for %s at the RSS feed <%s>. RSS feeds are only
looked up every half hour at the most (since that's how most
websites prefer it).
""" % (name, url)
name = callbacks.canonicalName(name)
if hasattr(self, name):
s = 'I already have a command in this plugin named %s' % name
irc.error(msg, s)
return
2003-12-03 22:21:43 +01:00
def f(self, irc, msg, args):
args.insert(0, url)
self.rss(irc, msg, args)
f = types.FunctionType(f.func_code, f.func_globals,
f.func_name, closure=f.func_closure)
f.__doc__ = docstring
self.feedNames.add(name)
setattr(self.__class__, name, f)
irc.reply(msg, conf.replySuccess)
def remove(self, irc, msg, args):
"""<name>
Removes the command for looking up RSS feeds at <name> from
this plugin.
"""
name = privmsgs.getArgs(args)
name = callbacks.canonicalName(name)
if name not in self.feedNames:
irc.error(msg, 'That\'s not a valid RSS feed command name.')
return
delattr(self.__class__, name)
irc.reply(msg, conf.replySuccess)
def rss(self, irc, msg, args):
"""<url>
Gets the title components of the given RSS feed.
"""
url = privmsgs.getArgs(args)
now = time.time()
if url not in self.lastRequest or now - self.lastRequest[url] > 1800:
results = rssparser.parse(url)
self.cachedFeeds[url] = results
self.lastRequest[url] = now
feed = self.cachedFeeds[url]
2003-11-21 20:07:14 +01:00
headlines = [utils.htmlToText(d['title'].strip())
for d in feed['items']]
if not headlines:
irc.error(msg, 'Error grabbing RSS feed')
return
headlines = imap(utils.htmlToText, headlines)
irc.reply(msg, ' :: '.join(headlines))
2003-08-20 18:26:23 +02:00
def info(self, irc, msg, args):
"""<url>
Returns information from the given RSS feed, namely the title,
URL, description, and last update date, if available.
"""
url = privmsgs.getArgs(args)
now = time.time()
if url not in self.lastRequest or now - self.lastRequest[url] > 1800:
results = rssparser.parse(url)
self.cachedFeeds[url] = results
self.lastRequest[url] = now
feed = self.cachedFeeds[url]
info = feed['channel']
if not info:
irc.error(msg, 'Error grabbing RSS feed')
return
# check the 'modified' key, if it's there, convert it here first
2003-04-19 23:40:39 +02:00
if 'modified' in feed:
seconds = time.mktime(feed['modified'])
2003-08-28 19:55:01 +02:00
now = time.mktime(time.gmtime())
when = utils.timeElapsed(now - seconds) + ' ago'
else:
2003-04-19 23:40:39 +02:00
when = "time unavailable"
# The rest of the entries are all available in the channel key
2003-04-19 23:40:39 +02:00
response = 'Title: %s; URL: <%s>; ' \
'Description: %s; Last updated %s.' % (
2003-08-20 18:26:23 +02:00
info.get('title', 'unavailable').strip(),
2003-04-19 23:40:39 +02:00
info.get('link', 'unavailable').strip(),
info.get('description', 'unavailable').strip(),
when)
2003-04-19 09:01:01 +02:00
irc.reply(msg, ' '.join(response.split()))
2003-04-06 13:42:41 +02:00
Class = RSS
# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=78: