-
Notifications
You must be signed in to change notification settings - Fork 0
/
TwitchChatInterface.py
582 lines (472 loc) · 18.9 KB
/
TwitchChatInterface.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
import queue
import IrcController
import MessageHandler
import time
import threading
from EventHandler import EventHandler
from datetime import datetime
class TCI(object):
"""
Bulids connection, receives chat messages from server and emits corrisponding events!
This library closely follows twitch docs https://dev.twitch.tv/docs/irc
All functions or methods used as event callbacks need to have 2 input varibles
Example of how to use this
.. literalinclude:: example.py
This is the message object that is sent with event
.. _Message:
.. code-block::
class Message:
raw: str # the raw unparsed message string from server
channel: str # the channel the message is from
id: str # id of message
prefix: str # there is 3 types of prfixes
command: str # the is the command which is also the event name
text: str # the context of the message
username: str # the person who has sent the message
params: List[str] # this is a break down of the end of message
tags: Dict # these are twitch tags look
.. code-block::
class Channel:
name: str
roomID: str
mods: list
roomState: RoomState = RoomState()
userState: UserState = UserState()
class RoomState:
emote_only: int
rituals: int
followers_only: int
r9k: int
slow: int
subs_only: int
class UserState:
badge_info: str
badges: dict
color: str
display_name: str
emote_sets: str
turbo: str
user_id: str
user_type: str
"""
def __init__(self,settings: dict):
# private properties
self._channels: list = settings.get('channels')
self._user: str = settings.get('user')
self._password: str = settings.get('password')
self._caprequest: str = settings.get('caprequest')
self._server = IrcController.IrcController(settings.get("server"),settings.get("port"))
self._messageHandler: MessageHandler = MessageHandler.MessageHandler()
self._sendQ: queue.SimpleQueue = queue.SimpleQueue()
# public properties
self.event: EventHandler = EventHandler
self.COMMANDS: MessageHandler.COMMANDS = self._messageHandler.COMMANDS
self.startWithThread=threading.Thread(target=self.start, daemon=True).start
self.channels: dict = {}
self.globalUserState: MessageHandler.globalUSerState = MessageHandler.globalUSerState()
# Register System Event functions
self.event.on(self.COMMANDS.CONNECTED, self._onConnected)
self.event.on(self.COMMANDS.NOTICE, self._onNotice)
self.event.on(self.COMMANDS.ROOMSTATE, self._onRoomState)
self.event.on(self.COMMANDS.USERSTATE, self._setUserState)
self.event.on(self.COMMANDS.MESSAGEIDS.ROOM_MODS, self._setChannelMods)
self.event.on(self.COMMANDS.GLOBALUSERSTATE, self._setGlobalUserSate)
self.event.on(self.COMMANDS.ROOMSTATE.EMOTE_ONLY, self._onEmotesOnly)
self.event.on(self.COMMANDS.ROOMSTATE.FOLLOWERS_ONLY, self._onFollowersOnly)
self.event.on(self.COMMANDS.ROOMSTATE.SLOW, self._onSlowMode)
self.event.on(self.COMMANDS.ROOMSTATE.SUBS_ONLY, self._onSubsOnly)
self.event.on(self.COMMANDS.ROOMSTATE.R9K, self._onR9k)
def start(self)->None:
"""
TwitchChatInterface.start - connects to server, logins in and starts send and recieve threads
"""
self._server.connect()
self._login()
threading.Thread(target=self._emptyMsgQ, daemon=True).start()
threading.Thread(target=self._getMsgs, daemon=True).start()
def _getMsgs(self)->None:
"""
TwitchChatInterface._getMsgs [summary]
"""
data=""
while self._server.isConnected():
time.sleep(.1)
data = self._server.receive()
if data is not None:
messageParts: list(str) = data.split("\r\n")
for messagePart in messageParts:
self.event.emit(self,self.COMMANDS.RECEIVED, messagePart)
event, msg = self._messageHandler.handleMessage(messagePart)
if event is not None:
self.event.emit(self, event, msg)
def _emptyMsgQ(self)->None:
"""
TwitchChatInterface._emptyMsgQ [summary]
"""
while self._server.isConnected():
if not self._sendQ.empty():
self._server.send(self._sendQ.get())
time.sleep(1)
def _login(self)->None:
"""[summary]
"""
self._sendQ.put(f"CAP REQ :{self._caprequest}")
self._sendQ.put(f"PASS {self._password}")
self._sendQ.put(f"NICK {self._user}")
def _onConnected(self, sender: object, message)->None:
"""
TwitchChatInterface._onConnected - event callback function
:param sender: what is reasponsible for event
:type sender: object
:param message: irc message
:type message: Message
"""
if self._channels is not None:
self.join(self._channels)
def _onRoomState(self, sender: object, message)->None:
"""
_onRoomState [summary]
:param sender: what is reasponsible for event
:type sender: object
:param message: irc message
:type message: Message
"""
if len(message.tags) >= 3:
self._setRoomState(message)
elif len(message.tags) <= 2:
self._updateRoomState(message)
def _onNotice(self, sender: object, message)->None:
"""
_onNotice [summary]
.
:param sender: what is reasponsible for event
:type sender: object
:param message: irc message
:type message: Message
"""
self.event.emit(self, message.id, message)
def _setRoomState(self, message)->None:
"""
_setRoomState [summary]
:param channel: [description]
:type channel: str
:param tags: [description]
:type tags: list
"""
if message.channel not in self.channels:
self.channels[message.channel]: MessageHandler.Channel = MessageHandler.Channel()
self.channels[message.channel].roomID = message.tags.get(self.COMMANDS.ROOMSTATE.ROOM_ID)
self.channels[message.channel].name = message.channel
for key in message.tags:
if key != self.COMMANDS.ROOMSTATE.ROOM_ID:
setattr(self.channels[message.channel].roomState, key.replace('-','_'), message.tags.get(key))
self._getMods(message.channel)
def _updateRoomState(self, message)->None:
"""
_updateRoomState [summary]
:param channel: [description]
:type channel: str
:param tags: [description]
:type tags: dict
"""
for key in message.tags:
if key != self.COMMANDS.ROOMSTATE.ROOM_ID:
setattr(self.channels[message.channel].roomState, key.replace('-','_'), message.tags.get(key))
self.event.emit(self, key, message)
def _setChannelMods(self, sender: object, message)->None:
"""
_setChannelMods [summary]
:param sender: [description]
:type sender: object
:param message: [description]
:type message: Message
"""
self.channels[message.channel].mods = message.params[1].split(':')[1].split(',')
def _setUserState(self, sender, message):
"""[summary]
:param sender: [description]
:type sender: [type]
:param message: [description]
:type message: [type]
"""
if message.channel not in self.channels:
self.channels[message.channel]: MessageHandler.Channel = MessageHandler.Channel()
for key in message.tags:
setattr(self.channels[message.channel].userState, key.replace('-','_'), message.tags.get(key))
def _setGlobalUserSate(self, sender, message)->None:
"""[summary]
:param sender: [description]
:type sender: [type]
:param message: [description]
:type message: [type]
"""
for key in message.tags:
setattr(self.globalUserState, key.replace('-','_'), message.tags.get(key))
def _getMods(self, channel: str)->None:
"""
getMods [summary]
:param channel: [description]
:type channel: str
"""
self.sendMessage(channel,"/mods")
def _onEmotesOnly(self, sender, message):
"""[summary]
:param sender: [description]
:type sender: [type]
:param message: [description]
:type message: [type]
"""
if message.tags[self.COMMANDS.ROOMSTATE.EMOTE_ONLY]:
self.event.emit(self, self.COMMANDS.ROOMSTATE.EMOTE_ONLY_ON, self.channels[message.channel])
else:
self.event.emit(self, self.COMMANDS.ROOMSTATE.EMOTE_ONLY_OFF, self.channels[message.channel])
def _onFollowersOnly(self, sender, message):
"""[summary]
:param sender: [description]
:type sender: [type]
:param message: [description]
:type message: [type]
"""
if message.tags[self.COMMANDS.ROOMSTATE.FOLLOWERS_ONLY] > -1:
self.event.emit(self, self.COMMANDS.ROOMSTATE.FOLLOWERS_ONLY_ON, self.channels[message.channel])
else:
self.event.emit(self, self.COMMANDS.ROOMSTATE.FOLLOWERS_ONLY_OFF, self.channels[message.channel])
def _onSlowMode(self, sender, message):
"""[summary]
:param sender: [description]
:type sender: [type]
:param message: [description]
:type message: [type]
"""
if message.tags[self.COMMANDS.ROOMSTATE.SLOW] > 0:
self.event.emit(self, self.COMMANDS.ROOMSTATE.SLOW_ON, self.channels[message.channel])
else:
self.event.emit(self, self.COMMANDS.ROOMSTATE.SLOW_OFF, self.channels[message.channel])
def _onSubsOnly(self, sender, message):
"""[summary]
:param sender: [description]
:type sender: [type]
:param message: [description]
:type message: [type]
"""
if message.tags[self.COMMANDS.ROOMSTATE.SUBS_ONLY]:
self.event.emit(self, self.COMMANDS.ROOMSTATE.SUBS_ONLY_ON, self.channels[message.channel])
else:
self.event.emit(self, self.COMMANDS.ROOMSTATE.SUBS_ONLY_OFF, self.channels[message.channel])
def _onR9k(self, sender, message):
"""[summary]
:param sender: [description]
:type sender: [type]
:param message: [description]
:type message: [type]
"""
if message.tags[self.COMMANDS.ROOMSTATE.R9K]:
self.event.emit(self, self.COMMANDS.ROOMSTATE.R9K_ON, self.channels[message.channel])
else:
self.event.emit(self, self.COMMANDS.ROOMSTATE.R9K_OFF, self.channels[message.channel])
def _addChannel(self, channel: str)->None:
"""[summary]
:param channel: [description]
:type channel: str
"""
if channel not in self.channels:
channel = self._formatChannelName(channel)
self.channels[channel]: MessageHandler.Channel = MessageHandler.Channel()
self.channels[channel].name = channel
def _removeChannel(self, channel: str)->None:
"""[summary]
:param channel: [description]
:type channel: str
"""
if channel in self.channels:
channel = self._formatChannelName(channel)
del(self.channels[channel])
def _formatChannelName(self, channel:str)->str:
"""[summary]
:param channel: [description]
:type channel: str
:return: [description]
:rtype: str
"""
return channel if channel.startswith("#") else f"#{channel}"
def join(self, channels: list)->None:
"""
join - jions channels
:param channels: list of channel names
:type channels: list[str]
"""
for channel in channels:
channel = self._formatChannelName(channel)
self._addChannel(channel)
self._sendQ.put(f"JOIN {channel}" if '#' in channel else f"JOIN #{channel}")
def part(self, channels: list):
"""
part - Leaves channel
:param channels: list of channel names
:type channels: list[str]
"""
for channel in channels:
channel = self._formatChannelName(channel)
self._removeChannel(channel)
self._sendQ.put(f"PART {channel}" if '#' in channel else f"PART#{channel}")
def sendMessage(self, channelName: str, messageString: str)->None:
"""
sendMessage - sends a message to channel
:param channelName: Name of channel to send message
:type channelName: str
:param messageString: message to send
:type messageString: str
"""
self._sendQ.put(f"PRIVMSG {'#' if '#' not in channelName else ''}{channelName} :{messageString}")
def sendWhisper(self, channelName: str, username: str, messageString: str)->None:
"""
sendWhisper - sends whisper to user in chat
:param channelName: Name of channel to send message
:type channelName: str
:param username: Username to whisper
:type username: str
:param messageString: message to send
:type messageString: str
"""
self._sendQ.put(f"PRIVMSG {'#' if '#' not in channelName else ''}{channelName} :/w {username} {messageString}")
def timeoutUser(self, channelName: str, username: str, duration: int)->None:
"""
timeoutUser - times user in channel
:param channelName: name of channel
:type channel: str
:param username: username of person
:type username: str
:param duration: how long to timeout
:type duration: int
"""
self._sendQ.put(f"PRIVMSG #{'#' if '#' not in channelName else ''}{channelName} :/timeout {username} {duration}")
def onMessage(self, func)->None:
"""
onMessage - message event - adds callback function for event
event object is of type class Message_
:param func: The function to call on this event
:type func: a function or method
"""
self.event.on(self.COMMANDS.MESSAGE, func)
def onWhisper(self, func):
"""
onWhisper - Whisper event - adds callback function for event
event object is of type class Message_
:param func: The function to call on this event
:type func: a function or method
"""
self.event.on(self.COMMANDS.WHISPER, func)
def onRoomState(self, func):
"""
onRoomState [summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.ROOMSTATE, func)
def onMsgId(self, msgid, func):
"""
onMsgId - msgid events - adds callback to a given msgid
event object is of type class Message
:param msgid: https://dev.twitch.tv/docs/irc/msg-id or **TCI.COMMANDS.MESSAGEIDS**
:type msgid: str
:param func: The function to call on this event
:type func: a function or method
"""
self.event.on(msgid, func)
def onNotice(self, func):
"""
onNotice [summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.NOTICE, func)
def onReceived(self, func):
"""
onReceived [summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.RECEIVED, func)
def onConnected(self, func):
"""
onConnected[summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.CONNECTED, func)
def onLoginError(self, func):
"""
onLoginError [summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.LOGIN_UNSUCCESSFUL, func)
def onGlobalUserState(self, func):
"""
onGlobalUserState [summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.GLOBALUSERSTATE, func)
def onUserState(self, func):
"""
onUserState [summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.USERSTATE, func)
def onUserNotice(self, func):
"""
onUserNotice [summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.USERNOTICE, func)
def onEmotesOnlyOn(self, func):
"""[summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.ROOMSTATE.EMOTE_ONLY_ON, func)
def onEmotesOnlyOff(self, func):
"""[summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.ROOMSTATE.EMOTE_ONLY_OFF, func)
def onSubsOnlyOn(self, func):
"""[summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.ROOMSTATE.SUBS_ONLY_ON, func)
def onSubsOnlyOff(self, func):
"""[summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.ROOMSTATE.SUBS_ONLY_OFF, func)
def onFollersOnlyOn(self, func):
"""[summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.ROOMSTATE.FOLLOWERS_ONLY_ON, func)
def onFollersOnlyOff(self, func):
"""[summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.ROOMSTATE.FOLLOWERS_ONLY_OFF, func)
def onSlowModeOn(self, func):
"""[summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.ROOMSTATE.SLOW_ON, func)
def onSlowModeOff(self, func):
"""[summary]
:param func: [description]
:type func: [type]
"""
self.event.on(self.COMMANDS.ROOMSTATE.SLOW_OFF, func)