-
Notifications
You must be signed in to change notification settings - Fork 8
/
pyramid.py
428 lines (358 loc) · 15.3 KB
/
pyramid.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
"""Commands: "[emote]"."""
import logging
import random
from collections import Counter
from enum import Enum
from bot.commands.abstract.command import Command
from bot.utilities.permission import Permission
from bot.utilities.tools import format_list
from bot.utilities.tools import replace_vars
class EmoteType(Enum):
"""Types of twitch emote."""
INVALID = 1
TWITCH = 2
NONTWITCH = 3
class Pyramid(Command):
"""Recognizes pyramids of emotes."""
perm = Permission.User
def __init__(self, bot):
"""Initialize variables."""
self.responses = bot.config.responses["Pyramid"]
self.non_twitch_emotes = (
bot.emotes.get_global_bttv_emotes()
+ bot.emotes.get_channel_bttv_emotes()
+ bot.emotes.get_channel_ffz_emotes()
)
self.emojis = bot.emotes.get_emojis()
self.pyramid_builders = []
self.current_type = None
self.increasing = None
self.maxLevel = None
self.pyramidLevel = None
self.currentEmote = None
self.emote_input_str = ""
self.points = bot.config.config["points"]["pyramid"]
# reset, also initialize some variables
self.reset()
def match(self, bot, user, msg, tag_info):
"""Match always."""
return True
def run(self, bot, user, msg, tag_info):
"""Check whether a pyramid was successfully built or a new one was started."""
msg_type, msg_count, emote = self.get_info(msg, tag_info)
if msg_type == EmoteType.INVALID:
# Not single emote message, so we reset earlier
# print("Invalid input for pyramid -- not even an emote, or multiple emote")
self.reset()
else:
if self.valid_next_level(msg_type, msg_count, emote):
# print("Valid next level input")
self.process_next_level(msg_type, msg_count, emote, user, bot)
elif self.valid_new_start(msg_type, msg_count):
# new single emote (State: 1) -- finishing level is already handled in validNextLevel()
# print("Some entered single emote -- new pyramid")
self.reset()
self.process_next_level(msg_type, msg_count, emote, user, bot)
else:
# invalid state (State: 0)
# print("Single emote, but count is incorrect")
self.reset()
def process_next_level(self, msg_type, msg_count, emote, user, bot):
"""Processes a new pyramid level, adding the user to builders and incrementing size.
NOTE: DO NOT handle new start in this function, only valid next level
"""
self.current_type = msg_type
if msg_count < self.pyramidLevel:
self.increasing = False
else:
self.maxLevel = msg_count
self.pyramidLevel = msg_count
self.currentEmote = emote
self.pyramid_builders.append(user)
# Pyramid data is updated at this point
# can pass in more parmeters if needed, like special emotes/sub emotes
self.handle_special_rules(bot)
def handle_special_rules(self, bot):
"""Applies special rules, e.g. finishing or blocking pyramids."""
if bot.pyramid_block and self.pyramidLevel == 2:
self.block_pyramid(bot)
return
# finishing is treated as special rule
if self.pyramidLevel == 1 and not self.increasing:
self.pyramid_completed(bot)
return
def block_pyramid(self, bot):
"""Block a pyramid."""
cannot_use_emote = True
# 80% to use a quote to block
if cannot_use_emote or random.randint(1, 10) > 2:
bot.write(random.choice(self.responses["pyramidblocks"]["msg"]))
else:
# The other 20% is to complete pyramid for the user LUL
# The roll list here:
# 10% to finish pyramid with max level of 4
# 30% for max level of 3
# 60% for 2 (just use 1 emote to close the pyramid)
roll_result = random.randint(1, 10)
if roll_result == 1:
max_lv = 4
elif roll_result <= 4:
max_lv = 3
else:
max_lv = 2
self.finish_pyramid(max_lv, bot, taunt=True)
self.reset()
def finish_pyramid(self, max_lv, bot, taunt):
"""Generic function for bot to complete a pyramid based on current state.
This function does not change any value of current pyramid, it only
make bot to output.
maxLv - the expected pyramid with this maxLv to be completed
taunt - if True, the finishing level message will be shown with
taunt message, otherwise just print plain emote
"""
# invalid maxLv -- it wants a smaller pyramid?
if max_lv < self.maxLevel:
logging.error(
f"[Pyramid]: finishPyramid() -- wrong params provided, "
f"current max lv is {self.maxLevel}, but input requested a lv {max_lv} pyramid"
)
# get current state, then write the message level by level
# NOTE: We can't use self.emote to finish pyramid, since it can be id for Twitch emotes
# So I try to cheat out a bit by copying user message on valid input with self.emoteInputStr
emote = self.emote_input_str
lv = self.pyramidLevel
# if increasing (and valid), fill up to maxLv.
while lv < max_lv:
lv += 1
bot.write(self._emote_str(emote, lv))
# if decreasing/invalid lv provided, just fill decreasing emote at 2, then finish it
while lv > 0:
lv -= 1
if lv == 1:
# finish the pyramid
taunt_msg = ""
if taunt:
taunt_msg = random.choice(self.responses["finishingtaunt"]["msg"])
bot.write("{} {}".format(emote, taunt_msg))
else:
bot.write(self._emote_str(emote, lv))
def pyramid_completed(self, bot):
"""Sends appropriate messages if a pyramid is completed."""
if self.maxLevel == 2: # plebramid
self.successful_pleb_pyramid(bot)
else:
self.send_success_message(bot)
def successful_pleb_pyramid(self, bot):
"""Write messages and time out people on pleb pyramid."""
unique_users = list(set(self.pyramid_builders))
if len(unique_users) == 1:
user = unique_users[0]
if bot.get_permission(user) in [Permission.User, Permission.Subscriber]:
var = {
"<USER>": bot.twitch.display_name(user),
"<PRONOUN0>": bot.config.pronoun(user)[0],
}
bot.write(replace_vars(self.responses["plebpyramid"]["msg"], var))
bot.timeout(user, 60)
else:
var = {
"<USER>": bot.twitch.display_name(user),
"<PRONOUN0>": bot.config.pronoun(user)[0],
}
bot.write(replace_vars(self.responses["mod_plebpyramid"]["msg"], var))
else:
s = format_list(
list(map(lambda x: bot.twitch.display_name(x), unique_users))
)
var = {"<MULTIUSERS>": s}
bot.write(replace_vars(self.responses["multi_plebpyramid"]["msg"], var))
for u in unique_users:
if bot.get_permission(u) in [Permission.User, Permission.Subscriber]:
bot.timeout(u, 60)
self.reset()
def send_success_message(self, bot):
"""Send a message for a successful pyramid."""
points = self.calculate_points(bot)
if len(points) == 1:
user = self.pyramid_builders[0]
var = {
"<USER>": bot.twitch.display_name(user),
"<PRONOUN0>": bot.config.pronoun(user)[0],
"<AMOUNT>": points[user],
}
bot.write(replace_vars(self.responses["pyramid"]["msg"], var))
bot.ranking.increment_points(user, points[user], bot)
else:
s = format_list(
list(map(lambda x: bot.twitch.display_name(x), list(points.keys())))
) # calls bot.displayName on every user
p = format_list(list(points.values()))
var = {"<MULTIUSERS>": s, "<AMOUNT>": p}
bot.write(replace_vars(self.responses["multi_pyramid"]["msg"], var))
for u in list(points.keys()):
bot.ranking.increment_points(u, points[u], bot)
self.reset()
def calculate_points(self, bot):
"""Calculate the points users get for a pyramid."""
# Notes on points: we now allow infinite level (up to message limit) of
# pyramid, but only first n levels are rewarded with points now
m = {}
for i in range(len(self.points)):
user = self.pyramid_builders[i]
if user not in m:
if bot.get_permission(user) not in [
Permission.Admin,
Permission.Moderator,
]:
m[user] = self.points[i]
else:
# mods get one tenth of the points
m[user] = int(self.points[i] / 10)
else:
if bot.get_permission(user) not in [
Permission.Admin,
Permission.Moderator,
]:
m[user] = m[user] + self.points[i]
else:
# mods get one tenth of the points
m[user] = m[user] + int(self.points[i] / 10)
return m
def get_info(self, msg, tag_info):
"""Checks message and returns emote type and their count."""
e_type = EmoteType.INVALID
count = 0
emote = "" # can be int or str, depends on type
valid_t, count_t, emote_id = self.check_valid_twitch_emote_with_count(tag_info)
valid_b, count_b, emote_b = self.check_valid_non_twitch_emote_with_count(msg)
if valid_t:
e_type, count = EmoteType.TWITCH, count_t
emote = emote_id
self.emote_input_str = msg.split()[0]
elif valid_b:
e_type, count = EmoteType.NONTWITCH, count_b
emote = emote_b
self.emote_input_str = emote_b
return e_type, count, emote
def check_valid_non_twitch_emote_with_count(self, msg):
"""Checks whether message contains a valid external emote and returns it and its count."""
invalid_data = (False, -1, "")
# split msg with space, check if only one emote/emoji only
msg_counter = Counter(msg.split())
if len(msg_counter) != 1:
# more than 1 different type of messages splited with whitespace, or 0
return invalid_data
emote, count = msg_counter.popitem()
# Don't use string.count() to count: need to exclude substring like 'Kappa' in 'KappaPride'
# count = msg.count(emote)
if emote not in self.non_twitch_emotes and emote not in self.emojis:
return invalid_data
else:
# single valid emote/emoji confirmed
return True, count, emote
# NOTE: currently there are no regex type of BTTV emote and emoji
# We need to change our logic if that happens ... have to loop all regex emote to check if any matches
@staticmethod
def check_valid_twitch_emote_with_count(tag_info):
"""Checks whether message contains a valid twitch emote and returns it and its count."""
if tag_info and tag_info.get("twitch_emote_only"):
emote_stats = tag_info[
"twitch_emotes"
].copy() # make a copy since we will popitem()
emote_id, freq = emote_stats.popitem()
if len(emote_stats) == 0:
# only one emote
return True, freq, emote_id
return False, -1, -1
@staticmethod
def valid_new_start(msg_type, msg_count):
"""
can actually just do this since we already checked msgType
return msgCount == 1
"""
return (msg_type in [EmoteType.TWITCH, EmoteType.NONTWITCH]) and msg_count == 1
def valid_next_level(self, msg_type, msg_count, emote):
""" Return True if incoming message forms a valid level of pyramid
with some exceptions.
"""
# Implement as FSM. Each state is the count of valid single emote
# These 2 states are always valid
# 0 : invalid state (after reset()) -- any invalid count goes here too (reset())
# 1 : any single emote -- need to reset then add that builder, unless it
# is the finishing level (validNewStart())
# Current state | Allowed next state
# The allowed next state must have same emote as before. We exclude the above 2 states
# increasing
# 0 | None (only those 2 states are valid, let validNewStart() handle 1)
# 1 | 2 (decrease to 0 is not a finishing level)
# 2 | 3, 1 (finish plebramid)
# 3 | 4, 2
# ...
# 3 and above have same rule as 2
#
# decreasing
# 1 | None -- should not enter this state at all
# 2 | 1
# 3 | 2
# ...
# Only allow -1 every level, should not have a decreasing 1 if we code correctly
# This function check for the allowed next states above
# Small note: Golden Kappa and normal Kappa are different emote with
# current logic, since they have different emote id
if msg_type != self.current_type or emote != self.currentEmote:
# state 0 return False here, since it has to be INVALID
return False
level = self.pyramidLevel # current state
if self.increasing:
# decresing at level 1 is NOT allowed (1 -> 0)
return msg_count == level + 1 or (msg_count == level - 1 and level >= 2)
else:
if level == 1:
raise ValueError(
"We have a decreasing level 1 pyramid asking for level 0 next level"
)
return msg_count == level - 1
def reset(self):
"""Resets pyramid state to none."""
self.pyramidLevel = 0 # current pyramid level
self.maxLevel = 0
self.increasing = True
self.currentEmote = (
"" # can be both Twitch emote ID (int) or str (non Twitch emote)
)
self.current_type = EmoteType.INVALID
# store the string input of that emote if user enters a valid emote level. Currently used by bot only
self.emote_input_str = ""
self.pyramid_builders.clear()
@staticmethod
def _emote_str(emote, count):
"""Concatenates an emote count times."""
return " ".join([emote] * count)
# Expected test cases:
# normal pyramid creation level 3-9
# plebramid should trigger timeout but not count as new pyramid
# normal non pyramid message blocking
# block on
# harder case:
# Kappa
# Kappa Kappa
# LUL
# LUL LUL
# LUL
# LUL should form a pyramid and Kappa got blocked
# sub-string case:
# Kappa
# Kappa Kappa
# KappaPride
# Not a pyramid
# 4Head
# 4Head 4Head
# 4Head 4Head 4Head
# 4Head 4Head
# 4Head
# 4Head 4Head
# 4Head 4Head 4Head
# 4Head 4Head
# 4Head
#
# I think completing a pyramid should force a reset, so it is not a double