port twitter module to ircbot v2
handles the on-demand commands but no timeline polling
This commit is contained in:
parent
618a042935
commit
76e9046549
|
|
@ -44,6 +44,7 @@ INSTALLED_APPS = (
|
|||
'pi',
|
||||
'races',
|
||||
'seen',
|
||||
'twitter',
|
||||
)
|
||||
|
||||
MIDDLEWARE_CLASSES = (
|
||||
|
|
@ -143,6 +144,11 @@ IRCBOT_XMLRPC_PORT = 13132
|
|||
|
||||
# IRC module stuff
|
||||
|
||||
# twitter
|
||||
|
||||
TWITTER_CONSUMER_KEY = None
|
||||
TWITTER_CONSUMER_SECRET = None
|
||||
|
||||
# weather
|
||||
|
||||
WEATHER_WEATHER_UNDERGROUND_API_KEY = None
|
||||
|
|
|
|||
|
|
@ -33,6 +33,14 @@ class Plugin(object):
|
|||
|
||||
log.info(u"stopped %s", self.__class__.__name__)
|
||||
|
||||
def _unencode_xml(self, text):
|
||||
"""Convert <, >, & to their real entities."""
|
||||
|
||||
text = text.replace('<', '<')
|
||||
text = text.replace('>', '>')
|
||||
text = text.replace('&', '&')
|
||||
return text
|
||||
|
||||
|
||||
def is_admin(source):
|
||||
"""Check if the provided event source is a bot admin."""
|
||||
|
|
|
|||
|
|
@ -0,0 +1,8 @@
|
|||
"""Manage twitter models in the admin interface."""
|
||||
|
||||
from django.contrib import admin
|
||||
|
||||
from twitter.models import TwitterClient
|
||||
|
||||
|
||||
admin.site.register(TwitterClient)
|
||||
|
|
@ -0,0 +1,248 @@
|
|||
"""Access to Twitter through bot commands."""
|
||||
|
||||
from __future__ import unicode_literals
|
||||
|
||||
import logging
|
||||
import thread
|
||||
import time
|
||||
|
||||
import twython
|
||||
|
||||
from django.conf import settings
|
||||
|
||||
from ircbot.lib import Plugin, is_admin
|
||||
from twitter.models import TwitterClient
|
||||
|
||||
|
||||
log = logging.getLogger('twitter.ircplugin')
|
||||
|
||||
|
||||
class Twitter(Plugin):
|
||||
|
||||
"""Access Twitter via the bot as an authenticated client."""
|
||||
|
||||
def __init__(self, bot, connection, event):
|
||||
"""Initialize some stuff."""
|
||||
|
||||
self.authed = False
|
||||
self.twit = twython.Twython(settings.TWITTER_CONSUMER_KEY, settings.TWITTER_CONSUMER_SECRET)
|
||||
self.temp_token = None
|
||||
self.temp_token_secret = None
|
||||
|
||||
super(Twitter, self).__init__(bot, connection, event)
|
||||
|
||||
def start(self):
|
||||
"""Prepare for oauth stuff (but don't execute it yet)."""
|
||||
|
||||
self.connection.reactor.add_global_regex_handler(['pubmsg', 'privmsg'],
|
||||
r'^!twitter\s+getstatus(\s+nosource)?(\s+noid)?\s+(\S+)$',
|
||||
self.handle_getstatus, -20)
|
||||
self.connection.reactor.add_global_regex_handler(['pubmsg', 'privmsg'],
|
||||
r'^!twitter\s+getuserstatus(\s+nosource)?(\s+noid)?\s+(\S+)(\s+.*|$)',
|
||||
self.handle_getuserstatus, -20)
|
||||
self.connection.reactor.add_global_regex_handler(['pubmsg', 'privmsg'], r'^!twitter\s+tweet\s+(.*)',
|
||||
self.handle_tweet, -20)
|
||||
self.connection.reactor.add_global_regex_handler(['pubmsg', 'privmsg'], r'^!twitter\s+gettoken$',
|
||||
self.handle_gettoken, -20)
|
||||
self.connection.reactor.add_global_regex_handler(['pubmsg', 'privmsg'], r'^!twitter\s+auth\s+(\S+)$',
|
||||
self.handle_auth, -20)
|
||||
self.connection.reactor.add_global_regex_handler(['pubmsg', 'privmsg'], r'^!twitter\s+replyto\s+(\S+)\s+(.*)',
|
||||
self.handle_replyto, -20)
|
||||
|
||||
# try getting the stored auth tokens and logging in
|
||||
try:
|
||||
twittersettings = TwitterClient.objects.get(pk=1)
|
||||
if twittersettings.oauth_token != '' and twittersettings.oauth_token_secret != '':
|
||||
self.twit = twython.Twython(settings.TWITTER_CONSUMER_KEY, settings.TWITTER_CONSUMER_SECRET,
|
||||
twittersettings.oauth_token, twittersettings.oauth_token_secret)
|
||||
if self.twit.verify_credentials():
|
||||
self.authed = True
|
||||
log.debug("Logged in to Twitter with saved token.")
|
||||
else:
|
||||
self.twit = twython.Twython(settings.TWITTER_CONSUMER_KEY, settings.TWITTER_CONSUMER_SECRET)
|
||||
else:
|
||||
self.twit = twython.Twython(settings.TWITTER_CONSUMER_KEY, settings.TWITTER_CONSUMER_SECRET)
|
||||
except TwitterClient.DoesNotExist:
|
||||
log.error("twitter settings module does not exist")
|
||||
|
||||
super(Twitter, self).start()
|
||||
|
||||
def stop(self):
|
||||
"""Tear down handlers."""
|
||||
|
||||
self.connection.reactor.remove_global_regex_handler(['pubmsg', 'privmsg'], self.handle_getstatus)
|
||||
self.connection.reactor.remove_global_regex_handler(['pubmsg', 'privmsg'], self.handle_getuserstatus)
|
||||
self.connection.reactor.remove_global_regex_handler(['pubmsg', 'privmsg'], self.handle_tweet)
|
||||
self.connection.reactor.remove_global_regex_handler(['pubmsg', 'privmsg'], self.handle_gettoken)
|
||||
self.connection.reactor.remove_global_regex_handler(['pubmsg', 'privmsg'], self.handle_auth)
|
||||
self.connection.reactor.remove_global_regex_handler(['pubmsg', 'privmsg'], self.handle_replyto)
|
||||
|
||||
super(Twitter, self).stop()
|
||||
|
||||
def handle_getstatus(self, connection, event, match):
|
||||
"""Get a status by tweet ID."""
|
||||
|
||||
print_source = True
|
||||
print_id = True
|
||||
if match.group(1):
|
||||
print_source = False
|
||||
if match.group(2):
|
||||
print_id = False
|
||||
status = match.group(3)
|
||||
try:
|
||||
tweet = self.twit.show_status(id=status)
|
||||
return self._return_tweet_or_retweet_text(event, tweet=tweet, print_source=print_source, print_id=print_id)
|
||||
except twython.exceptions.TwythonError as e:
|
||||
return self.bot.reply(event, "Couldn't obtain status: {0:s}".format(e))
|
||||
|
||||
def handle_getuserstatus(self, connection, event, match):
|
||||
"""Get a status for a user. Allows for getting one other than the most recent."""
|
||||
|
||||
print_source = True
|
||||
print_id = True
|
||||
if match.group(1):
|
||||
print_source = False
|
||||
if match.group(2):
|
||||
print_id = False
|
||||
user = match.group(3)
|
||||
index = match.group(4)
|
||||
|
||||
try:
|
||||
if index:
|
||||
index = int(index)
|
||||
if index > 0:
|
||||
index = 0
|
||||
else:
|
||||
index = 0
|
||||
except ValueError as e:
|
||||
log.error("Couldn't convert index")
|
||||
log.exception(e)
|
||||
index = 0
|
||||
|
||||
count = (-1*index) + 1
|
||||
|
||||
try:
|
||||
tweets = self.twit.get_user_timeline(screen_name=user, count=count, include_rts=True)
|
||||
if tweets:
|
||||
tweet = tweets[-1*index]
|
||||
return self._return_tweet_or_retweet_text(event, tweet=tweet, print_source=print_source,
|
||||
print_id=print_id)
|
||||
except twython.exceptions.TwythonError as e:
|
||||
return self.bot.reply(event, "Couldn't obtain status: {0:s}".format(e))
|
||||
except ValueError as e:
|
||||
return self.bot.reply(event, "Couldn't obtain status: {0:s}".format(e))
|
||||
|
||||
def handle_tweet(self, connection, event, match):
|
||||
"""Tweet. Needs authentication."""
|
||||
|
||||
tweet = match.group(1)
|
||||
if not self.twit.verify_credentials():
|
||||
return self.bot.reply(event, "You must be authenticated to tweet.")
|
||||
if not is_admin(event.source):
|
||||
return self.bot.reply(event, "Only admins can tweet.")
|
||||
|
||||
try:
|
||||
if self.twit.update_status(status=tweet, display_coordinates=False) is not None:
|
||||
return self.bot.reply(event, "'{0:s}' tweeted.".format(tweet))
|
||||
else:
|
||||
return self.bot.reply(event, "Unknown error sending tweet(s).")
|
||||
except twython.exceptions.TwythonError as e:
|
||||
return self.bot.reply(event, "Couldn't tweet: {0:s}".format(e))
|
||||
|
||||
def handle_replyto(self, connection, event, match):
|
||||
"""Reply to a tweet, in the twitter in_reply_to_status_id sense. Needs authentication."""
|
||||
|
||||
status_id = match.group(1)
|
||||
tweet = match.group(2)
|
||||
|
||||
if not self.twit.verify_credentials():
|
||||
return self.bot.reply(event, "You must be authenticated to tweet.")
|
||||
if not is_admin(event.source):
|
||||
return self.bot.reply(event, "Only admins can tweet.")
|
||||
|
||||
replyee_tweet = self.twit.show_status(id=status_id)
|
||||
target = replyee_tweet['user']['screen_name'].encode('utf-8', 'ignore')
|
||||
|
||||
try:
|
||||
reptweet = "@{0:s}: {1:s}".format(target, tweet)
|
||||
if self.twit.update_status(status=reptweet, display_coordinates=False, in_reply_to_status_id=status_id) is not None:
|
||||
return self.bot.reply(event, "'{0:s}' tweeted.".format(tweet))
|
||||
else:
|
||||
return self.bot.reply(event, "Unknown error sending tweet.")
|
||||
except twython.exceptions.TwythonError as e:
|
||||
return self.bot.reply(event, "Couldn't tweet: {0:s}".format(e))
|
||||
|
||||
def handle_gettoken(self, connection, event, match):
|
||||
"""Get an oauth token, so that the user may authenticate the bot."""
|
||||
|
||||
try:
|
||||
if not self.twit.verify_credentials():
|
||||
self.authed = False
|
||||
self.twit = twython.Twython(settings.TWITTER_CONSUMER_KEY, settings.TWITTER_CONSUMER_SECRET)
|
||||
except twython.TwythonError:
|
||||
self.authed = False
|
||||
self.twit = twython.Twython(settings.TWITTER_CONSUMER_KEY, settings.TWITTER_CONSUMER_SECRET)
|
||||
|
||||
auth = self.twit.get_authentication_tokens()
|
||||
self.temp_token = auth['oauth_token']
|
||||
self.temp_token_secret = auth['oauth_token_secret']
|
||||
return self.bot.reply(event, "Go to the following link in your browser: {0:s} and send me the pin."
|
||||
"".format(auth['auth_url']))
|
||||
|
||||
def handle_auth(self, connection, event, match):
|
||||
"""Authenticate, given a PIN (following gettoken)."""
|
||||
|
||||
oauth_verifier = match.group(1)
|
||||
self.twit = twython.Twython(settings.TWITTER_CONSUMER_KEY, settings.TWITTER_CONSUMER_SECRET,
|
||||
self.temp_token, self.temp_token_secret)
|
||||
final_step = self.twit.get_authorized_tokens(oauth_verifier)
|
||||
|
||||
self.twit = twython.Twython(settings.TWITTER_CONSUMER_KEY, settings.TWITTER_CONSUMER_SECRET,
|
||||
final_step['oauth_token'], final_step['oauth_token_secret'])
|
||||
|
||||
try:
|
||||
twittersettings = TwitterClient.objects.get(pk=1)
|
||||
twittersettings.oauth_token = final_step['oauth_token']
|
||||
twittersettings.oauth_token_secret = final_step['oauth_token_secret']
|
||||
twittersettings.clean()
|
||||
twittersettings.save()
|
||||
|
||||
if self.twit.verify_credentials():
|
||||
self.authed = True
|
||||
# print timeline stuff. this will set up the appropriate timer
|
||||
return self.bot.reply(event, "The bot is now logged in.")
|
||||
else:
|
||||
self.twit = twython.Twython(settings.TWITTER_CONSUMER_KEY, settings.TWITTER_CONSUMER_SECRET)
|
||||
return self.bot.reply(event, "The bot was not able to authenticate.")
|
||||
except TwitterClient.DoesNotExist:
|
||||
log.error("twitter settings object does not exist")
|
||||
return self.bot.reply(event, "twitter module not configured")
|
||||
|
||||
def _return_tweet_or_retweet_text(self, event, tweet, print_source=False, print_id=True):
|
||||
"""Return a string of the author and text body of a status, accounting for whether
|
||||
or not the fetched status is a retweet.
|
||||
"""
|
||||
|
||||
retweet = getattr(tweet, 'retweeted_status', None)
|
||||
if retweet:
|
||||
if print_source:
|
||||
reply = "@%s (RT @%s): %s" % (tweet['user']['screen_name'].encode('utf-8', 'ignore'),
|
||||
retweet['user']['screen_name'].encode('utf-8', 'ignore'),
|
||||
self._unencode_xml(retweet['text'].encode('utf-8', 'ignore')))
|
||||
else:
|
||||
reply = "(RT @%s): %s" % (retweet['user']['screen_name'].encode('utf-8', 'ignore'),
|
||||
self._unencode_xml(retweet['text'].encode('utf-8', 'ignore')))
|
||||
else:
|
||||
if print_source:
|
||||
reply = "@%s: %s" % (tweet['user']['screen_name'].encode('utf-8', 'ignore'),
|
||||
self._unencode_xml(tweet['text'].encode('utf-8', 'ignore')))
|
||||
else:
|
||||
reply = "%s" % (self._unencode_xml(tweet['text'].encode('utf-8', 'ignore')))
|
||||
|
||||
if print_id:
|
||||
reply = reply + " [{0:d}]".format(tweet['id'])
|
||||
|
||||
return self.bot.reply(event, reply)
|
||||
|
||||
|
||||
plugin = Twitter
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
from __future__ import unicode_literals
|
||||
|
||||
from django.db import models, migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.CreateModel(
|
||||
name='TwitterClient',
|
||||
fields=[
|
||||
('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
|
||||
('since_id', models.PositiveIntegerField()),
|
||||
('output_channel', models.CharField(default='', max_length=200)),
|
||||
('oauth_token', models.CharField(default='', max_length=256)),
|
||||
('oauth_token_secret', models.CharField(default='', max_length=256)),
|
||||
],
|
||||
),
|
||||
]
|
||||
|
|
@ -0,0 +1,29 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
from __future__ import unicode_literals
|
||||
|
||||
from django.db import models, migrations
|
||||
|
||||
|
||||
class Migration(migrations.Migration):
|
||||
|
||||
dependencies = [
|
||||
('twitter', '0001_initial'),
|
||||
]
|
||||
|
||||
operations = [
|
||||
migrations.AlterField(
|
||||
model_name='twitterclient',
|
||||
name='oauth_token',
|
||||
field=models.CharField(default='', max_length=256, blank=True),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name='twitterclient',
|
||||
name='oauth_token_secret',
|
||||
field=models.CharField(default='', max_length=256, blank=True),
|
||||
),
|
||||
migrations.AlterField(
|
||||
model_name='twitterclient',
|
||||
name='output_channel',
|
||||
field=models.CharField(default='', max_length=200, blank=True),
|
||||
),
|
||||
]
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
"""Twitter settings models."""
|
||||
|
||||
from __future__ import unicode_literals
|
||||
|
||||
import logging
|
||||
|
||||
from django.db import models
|
||||
|
||||
|
||||
log = logging.getLogger('twitter.models')
|
||||
|
||||
|
||||
class TwitterClient(models.Model):
|
||||
|
||||
"""Track twitter settings and similar."""
|
||||
|
||||
since_id = models.PositiveIntegerField()
|
||||
output_channel = models.CharField(max_length=200, default='', blank=True)
|
||||
oauth_token = models.CharField(max_length=256, default='', blank=True)
|
||||
oauth_token_secret = models.CharField(max_length=256, default='', blank=True)
|
||||
Loading…
Reference in New Issue