]> jfr.im git - z_archive/twitter.git/blobdiff - twitter/ircbot.py
- Documentation updates.
[z_archive/twitter.git] / twitter / ircbot.py
index 36acde7e971c0014f4fbdbe0c702b7257ff7958b..53e4edef2bd64d9a0c35023586eb009c965ae8c3 100644 (file)
@@ -17,7 +17,7 @@ CONFIG_FILE
 server: <irc_server>
 port: <irc_port>
 nick: <irc_nickname>
-channel: <irc_channel_to_join>
+channel: <irc_channels_to_join>
 
 [twitter]
 email: <twitter_account_email>
@@ -25,15 +25,26 @@ password: <twitter_account_password>
 
   If no config file is given "twitterbot.ini" will be used by default.
 
+  The channel argument can accept multiple channels separated by commas.
 """
+
+BOT_VERSION = "TwitterBot 1.1 (http://mike.verdone.ca/twitter)"
+
+IRC_BOLD = chr(0x02)
+IRC_ITALIC = chr(0x16)
+IRC_UNDERLINE = chr(0x1f)
+IRC_REGULAR = chr(0x0f)
+
 import sys
 import time
 from dateutil.parser import parse
-from ConfigParser import ConfigParser
+from ConfigParser import SafeConfigParser
 from heapq import heappop, heappush
 import traceback
+import os.path
 
 from api import Twitter, TwitterError
+from util import htmlentitydecode
 
 try:
     import irclib
@@ -73,19 +84,17 @@ class Scheduler(object):
         now = time.time()
         task = heappop(self.task_heap)
         wait = task.next - now
+        task.next = now + task.delta
+        heappush(self.task_heap, task)
         if (wait > 0):
             time.sleep(wait)
         task()
-        task.next = now + task.delta
-        heappush(self.task_heap, task)
         debug("tasks: " + str(self.task_heap))
         
     def run_forever(self):
-        try:
-            while True:
-                self.next_task()
-        except KeyboardInterrupt:
-            pass
+        while True:
+            self.next_task()
+
             
 class TwitterBot(object):
     def __init__(self, configFilename):
@@ -93,13 +102,14 @@ class TwitterBot(object):
         self.config = load_config(self.configFilename)
         self.irc = irclib.IRC()
         self.irc.add_global_handler('privmsg', self.handle_privmsg)
+        self.irc.add_global_handler('ctcp', self.handle_ctcp)
         self.ircServer = self.irc.server()
         self.twitter = Twitter(
             self.config.get('twitter', 'email'),
             self.config.get('twitter', 'password'))
         self.sched = Scheduler(
             (SchedTask(self.process_events, 1),
-             SchedTask(self.check_statuses, 60)))
+             SchedTask(self.check_statuses, 120)))
         self.lastUpdate = time.gmtime()
 
     def check_statuses(self):
@@ -111,17 +121,28 @@ class TwitterBot(object):
             traceback.print_exc(file=sys.stderr)
             return
         
+        nextLastUpdate = self.lastUpdate
         for update in updates:
             crt = parse(update['created_at']).utctimetuple()
             if (crt > self.lastUpdate):
-                self.privmsg_channel(
-                    "=^_^= %s %s" %(
-                        update['user']['screen_name'],
-                        update['text']))
-                self.lastUpdate = crt
+                text = (htmlentitydecode(
+                    update['text'].replace('\n', ' '))
+                    .encode('utf-8', 'replace'))
+
+                # Skip updates beginning with @
+                # TODO This would be better if we only ignored messages
+                #   to people who are not on our following list.
+                if not text.startswith("@"):
+                    self.privmsg_channels(
+                        u"=^_^=  %s%s%s %s" %(
+                            IRC_BOLD, update['user']['screen_name'],
+                            IRC_BOLD, text.decode('utf-8')))
+                
+                nextLastUpdate = crt
             else:
                 break
-
+        self.lastUpdate = nextLastUpdate
+        
     def process_events(self):
         debug("In process_events")
         self.irc.process_once()
@@ -144,10 +165,26 @@ class TwitterBot(object):
                     + "(unfollow <twitter_name>) to make me stop.")
         except Exception:
             traceback.print_exc(file=sys.stderr)
+    
+    def handle_ctcp(self, conn, evt):
+        args = evt.arguments()
+        source = evt.source().split('!')[0]
+        if (args):
+            if args[0] == 'VERSION':
+                conn.ctcp_reply(source, "VERSION " + BOT_VERSION)
+            elif args[0] == 'PING':
+                conn.ctcp_reply(source, "PING")
+            elif args[0] == 'CLIENTINFO':
+                conn.ctcp_reply(source, "CLIENTINFO PING VERSION CLIENTINFO")
 
     def privmsg_channel(self, msg):
         return self.ircServer.privmsg(
-            self.config.get('irc', 'channel'), msg)
+            self.config.get('irc', 'channel'), msg.encode('utf-8'))
+            
+    def privmsg_channels(self, msg):
+        return_response=True
+        channels=self.config.get('irc','channel').split(',')
+        return self.ircServer.privmsg_many(channels, msg.encode('utf-8'))
             
     def follow(self, conn, evt, name):
         userNick = evt.source().split('!')[0]
@@ -168,7 +205,7 @@ class TwitterBot(object):
             conn.privmsg(
                 userNick,
                 "=^_^= Okay! I'm now following %s." %(name))
-            self.privmsg_channel(
+            self.privmsg_channels(
                 "=o_o= %s has asked me to start following %s" %(
                     userNick, name))
     
@@ -185,7 +222,7 @@ class TwitterBot(object):
             conn.privmsg(
                 userNick,
                 "=^_^= Okay! I've stopped following %s." %(name))
-            self.privmsg_channel(
+            self.privmsg_channels(
                 "=o_o= %s has asked me to stop following %s" %(
                     userNick, name))
     
@@ -194,28 +231,59 @@ class TwitterBot(object):
             self.config.get('irc', 'server'), 
             self.config.getint('irc', 'port'),
             self.config.get('irc', 'nick'))
-        self.ircServer.join(self.config.get('irc', 'channel'))
-        try:
-            self.sched.run_forever()
-        except KeyboardInterrupt:
-            pass
+        channels=self.config.get('irc', 'channel').split(',')
+        for channel in channels:
+            self.ircServer.join(channel)
+
+        while True:
+            try:
+                self.sched.run_forever()
+            except KeyboardInterrupt:
+                break
+            except TwitterError:
+                # twitter.com is probably down because it sucks. ignore the fault and keep going
+                pass
 
 def load_config(filename):
     defaults = dict(server=dict(port=6667, nick="twitterbot"))
-    cp = ConfigParser(defaults)
+    cp = SafeConfigParser(defaults)
     cp.read((filename,))
+    
+    # attempt to read these properties-- they are required
+    cp.get('twitter', 'email'),
+    cp.get('twitter', 'password')
+    cp.get('irc', 'server')
+    cp.getint('irc', 'port')
+    cp.get('irc', 'nick')
+    cp.get('irc', 'channel')
+
     return cp
 
+# So there was a joke here about the twitter business model
+# but I got rid of it. Not because I want this codebase to
+# be "professional" in any way, but because someone forked
+# this and deleted the comment because they couldn't take
+# a joke. Hi guy!
+#
+# Fact: The number one use of Google Code is to look for that
+# comment in the Linux kernel that goes "FUCK me gently with
+# a chainsaw." Pretty sure Linus himself wrote it.
+
 def main():
     configFilename = "twitterbot.ini"
     if (sys.argv[1:]):
         configFilename = sys.argv[1]
+        
     try:
+        if not os.path.exists(configFilename):
+            raise Exception()
         load_config(configFilename)
-    except:
-        print >> sys.stderr, "Error loading ini file %s" %(
+    except Exception, e:
+        print >> sys.stderr, "Error while loading ini file %s" %(
             configFilename)
-        print __doc__
+        print >> sys.stderr, e
+        print >> sys.stderr, __doc__
         sys.exit(1)
+
     bot = TwitterBot(configFilename)
     return bot.run()