]>
jfr.im git - z_archive/twitter.git/blob - twitter/ircbot.py
4 A twitter IRC bot. Twitterbot connected to an IRC server and idles in
5 a channel, polling a twitter account and broadcasting all updates to
10 twitterbot [config_file]
14 The config file is an ini-style file that must contain the following:
20 channel: <irc_channels_to_join>
21 prefixes: <prefix_type>
24 oauth_token_file: <oauth_token_filename>
27 If no config file is given "twitterbot.ini" will be used by default.
29 The channel argument can accept multiple channels separated by commas.
31 The default token file is ~/.twitterbot_oauth.
33 The default prefix type is 'cats'. You can also use 'none'.
37 from __future__
import print_function
39 BOT_VERSION
= "TwitterBot 1.9.1 (http://mike.verdone.ca/twitter)"
41 CONSUMER_KEY
= "XryIxN3J2ACaJs50EizfLQ"
42 CONSUMER_SECRET
= "j7IuDCNjftVY8DBauRdqXs4jDl5Fgk1IJRag8iE"
45 IRC_ITALIC
= chr(0x16)
46 IRC_UNDERLINE
= chr(0x1f)
47 IRC_REGULAR
= chr(0x0f)
51 from datetime
import datetime
, timedelta
52 from email
.utils
import parsedate
54 from configparser
import ConfigParser
56 from ConfigParser
import ConfigParser
57 from heapq
import heappop
, heappush
62 from .api
import Twitter
, TwitterError
63 from .oauth
import OAuth
, read_token_file
64 from .oauth_dance
import oauth_dance
65 from .util
import htmlentitydecode
77 ACTIVE_PREFIXES
=dict()
79 def get_prefix(prefix_typ
=None):
80 return ACTIVE_PREFIXES
.get(prefix_typ
, ACTIVE_PREFIXES
.get('new_tweet', ''))
87 "This module requires python irclib available from "
88 + "https://github.com/sixohsix/python-irclib/zipball/python-irclib3-0.4.8")
90 OAUTH_FILE
= os
.environ
.get('HOME', os
.environ
.get('USERPROFILE', '')) + os
.sep
+ '.twitterbot_oauth'
93 # uncomment this for debug text stuff
94 # print(msg, file=sys.stdout)
97 class SchedTask(object):
98 def __init__(self
, task
, delta
):
101 self
.next
= time
.time()
104 return "<SchedTask %s next:%i delta:%i>" %(
105 self
.task
.__name
__, self
.__next
__, self
.delta
)
107 def __lt__(self
, other
):
108 return self
.next
< other
.next
113 class Scheduler(object):
114 def __init__(self
, tasks
):
117 heappush(self
.task_heap
, task
)
121 task
= heappop(self
.task_heap
)
122 wait
= task
.next
- now
123 task
.next
= now
+ task
.delta
124 heappush(self
.task_heap
, task
)
128 #debug("tasks: " + str(self.task_heap))
130 def run_forever(self
):
135 class TwitterBot(object):
136 def __init__(self
, configFilename
):
137 self
.configFilename
= configFilename
138 self
.config
= load_config(self
.configFilename
)
140 global ACTIVE_PREFIXES
141 ACTIVE_PREFIXES
= PREFIXES
[self
.config
.get('irc', 'prefixes')]
143 oauth_file
= self
.config
.get('twitter', 'oauth_token_file')
144 if not os
.path
.exists(oauth_file
):
145 oauth_dance("IRC Bot", CONSUMER_KEY
, CONSUMER_SECRET
, oauth_file
)
146 oauth_token
, oauth_secret
= read_token_file(oauth_file
)
148 self
.twitter
= Twitter(
150 oauth_token
, oauth_secret
, CONSUMER_KEY
, CONSUMER_SECRET
),
151 domain
='api.twitter.com')
153 self
.irc
= irclib
.IRC()
154 self
.irc
.add_global_handler('privmsg', self
.handle_privmsg
)
155 self
.irc
.add_global_handler('ctcp', self
.handle_ctcp
)
156 self
.irc
.add_global_handler('umode', self
.handle_umode
)
157 self
.ircServer
= self
.irc
.server()
159 self
.sched
= Scheduler(
160 (SchedTask(self
.process_events
, 1),
161 SchedTask(self
.check_statuses
, 120)))
162 self
.lastUpdate
= (datetime
.utcnow() - timedelta(minutes
=10)).utctimetuple()
164 def check_statuses(self
):
165 debug("In check_statuses")
167 updates
= reversed(self
.twitter
.statuses
.home_timeline())
168 except Exception as e
:
169 print("Exception while querying twitter:", file=sys
.stderr
)
170 traceback
.print_exc(file=sys
.stderr
)
173 nextLastUpdate
= self
.lastUpdate
174 for update
in updates
:
175 crt
= parsedate(update
['created_at'])
176 if (crt
> nextLastUpdate
):
177 text
= (htmlentitydecode(
178 update
['text'].replace('\n', ' '))
179 .encode('utf8', 'replace'))
181 # Skip updates beginning with @
182 # TODO This would be better if we only ignored messages
183 # to people who are not on our following list.
184 if not text
.startswith(b
"@"):
185 msg
= "%s %s%s%s %s" %(
187 IRC_BOLD
, update
['user']['screen_name'],
188 IRC_BOLD
, text
.decode('utf8'))
189 self
.privmsg_channels(msg
)
193 self
.lastUpdate
= nextLastUpdate
195 def process_events(self
):
196 self
.irc
.process_once()
198 def handle_privmsg(self
, conn
, evt
):
200 args
= evt
.arguments()[0].split(' ')
204 if (args
[0] == 'follow' and args
[1:]):
205 self
.follow(conn
, evt
, args
[1])
206 elif (args
[0] == 'unfollow' and args
[1:]):
207 self
.unfollow(conn
, evt
, args
[1])
210 evt
.source().split('!')[0],
211 "%sHi! I'm Twitterbot! you can (follow "
212 "<twitter_name>) to make me follow a user or "
213 "(unfollow <twitter_name>) to make me stop." %
216 traceback
.print_exc(file=sys
.stderr
)
218 def handle_ctcp(self
, conn
, evt
):
219 args
= evt
.arguments()
220 source
= evt
.source().split('!')[0]
222 if args
[0] == 'VERSION':
223 conn
.ctcp_reply(source
, "VERSION " + BOT_VERSION
)
224 elif args
[0] == 'PING':
225 conn
.ctcp_reply(source
, "PING")
226 elif args
[0] == 'CLIENTINFO':
227 conn
.ctcp_reply(source
, "CLIENTINFO PING VERSION CLIENTINFO")
229 def handle_umode(self
, conn
, evt
):
231 QuakeNet ignores all your commands until after the MOTD. This
232 handler defers joining until after it sees a magic line. It
233 also tries to join right after connect, but this will just
234 make it join again which should be safe.
236 args
= evt
.arguments()
237 if (args
and args
[0] == '+i'):
238 channels
= self
.config
.get('irc', 'channel').split(',')
239 for channel
in channels
:
240 self
.ircServer
.join(channel
)
242 def privmsg_channels(self
, msg
):
244 channels
=self
.config
.get('irc','channel').split(',')
245 return self
.ircServer
.privmsg_many(channels
, msg
.encode('utf8'))
247 def follow(self
, conn
, evt
, name
):
248 userNick
= evt
.source().split('!')[0]
249 friends
= [x
['name'] for x
in self
.twitter
.statuses
.friends()]
250 debug("Current friends: %s" %(friends))
251 if (name
in friends
):
254 "%sI'm already following %s." %(get_prefix('error'), name
))
257 self
.twitter
.friendships
.create(screen_name
=name
)
261 "%sI can't follow that user. Are you sure the name is correct?" %(
267 "%sOkay! I'm now following %s." %(get_prefix('followed'), name
))
268 self
.privmsg_channels(
269 "%s%s has asked me to start following %s" %(
270 get_prefix('inform'), userNick
, name
))
272 def unfollow(self
, conn
, evt
, name
):
273 userNick
= evt
.source().split('!')[0]
274 friends
= [x
['name'] for x
in self
.twitter
.statuses
.friends()]
275 debug("Current friends: %s" %(friends))
276 if (name
not in friends
):
279 "%sI'm not following %s." %(get_prefix('error'), name
))
281 self
.twitter
.friendships
.destroy(screen_name
=name
)
284 "%sOkay! I've stopped following %s." %(
285 get_prefix('stop_follow'), name
))
286 self
.privmsg_channels(
287 "%s%s has asked me to stop following %s" %(
288 get_prefix('inform'), userNick
, name
))
290 def _irc_connect(self
):
291 self
.ircServer
.connect(
292 self
.config
.get('irc', 'server'),
293 self
.config
.getint('irc', 'port'),
294 self
.config
.get('irc', 'nick'))
295 channels
=self
.config
.get('irc', 'channel').split(',')
296 for channel
in channels
:
297 self
.ircServer
.join(channel
)
304 self
.sched
.run_forever()
305 except KeyboardInterrupt:
308 # twitter.com is probably down because it
309 # sucks. ignore the fault and keep going
311 except irclib
.ServerNotConnectedError
:
312 # Try and reconnect to IRC.
316 def load_config(filename
):
317 # Note: Python ConfigParser module has the worst interface in the
320 cp
.add_section('irc')
321 cp
.set('irc', 'port', '6667')
322 cp
.set('irc', 'nick', 'twitterbot')
323 cp
.set('irc', 'prefixes', 'cats')
324 cp
.add_section('twitter')
325 cp
.set('twitter', 'oauth_token_file', OAUTH_FILE
)
329 # attempt to read these properties-- they are required
330 cp
.get('twitter', 'oauth_token_file'),
331 cp
.get('irc', 'server')
332 cp
.getint('irc', 'port')
333 cp
.get('irc', 'nick')
334 cp
.get('irc', 'channel')
338 # So there was a joke here about the twitter business model
339 # but I got rid of it. Not because I want this codebase to
340 # be "professional" in any way, but because someone forked
341 # this and deleted the comment because they couldn't take
344 # Fact: The number one use of Google Code is to look for that
345 # comment in the Linux kernel that goes "FUCK me gently with
346 # a chainsaw." Pretty sure Linus himself wrote it.
349 configFilename
= "twitterbot.ini"
351 configFilename
= sys
.argv
[1]
354 if not os
.path
.exists(configFilename
):
356 load_config(configFilename
)
357 except Exception as e
:
358 print("Error while loading ini file %s" %(
359 configFilename
), file=sys
.stderr
)
360 print(e
, file=sys
.stderr
)
361 print(__doc__
, file=sys
.stderr
)
364 bot
= TwitterBot(configFilename
)