125 lines
4.1 KiB
Python
125 lines
4.1 KiB
Python
from typing import Dict, List
|
|
import discord
|
|
|
|
|
|
# Custom libs
|
|
|
|
from log_manager import ChannelLogs, MessageLog
|
|
from data_types import Emote
|
|
from scanner import Scanner
|
|
import emojis
|
|
|
|
|
|
async def compute(self, *args):
|
|
EmotesScanner().compute(*args)
|
|
|
|
|
|
class EmotesScanner(Scanner):
|
|
@staticmethod
|
|
def help() -> str:
|
|
return "```\n"
|
|
+"%emotes : Rank emotes by their usage\n"
|
|
+"arguments:\n"
|
|
+"* @member : filter for one or more member\n"
|
|
+"* #channel : filter for one or more channel\n"
|
|
+"* <n> : top <n> emojis, default is 20\n"
|
|
+"* all : list all common emojis in addition to this guild's\n"
|
|
+"* members : show top member for each emote\n"
|
|
+"Example: %emotes 10 all #mychannel1 #mychannel2 @user\n"
|
|
+"```"
|
|
|
|
def __init__(self):
|
|
super().__init__(
|
|
has_digit_args=True,
|
|
valid_args=["all", "members"],
|
|
help=EmotesScanner.help(),
|
|
intro_context="emotes usage",
|
|
)
|
|
self.top = 20
|
|
self.all_emojis = False
|
|
self.show_members = False
|
|
|
|
async def compute_args(self, message: discord.Message, *args: str) -> bool:
|
|
# get max emotes to view
|
|
self.top = 20
|
|
for arg in args:
|
|
if arg.isdigit():
|
|
self.top = int(arg)
|
|
# check other args
|
|
self.all_emojis = "all" in args
|
|
self.show_members = "members" in args and (
|
|
len(self.members) == 0 or len(self.members) > 1
|
|
)
|
|
return True
|
|
|
|
def compute_message(self, channel: ChannelLogs, message: MessageLog):
|
|
return analyse_message(
|
|
message, self.emotes, self.raw_members, all_emojis=self.all_emojis
|
|
)
|
|
|
|
def get_results(self, intro: str) -> List[str]:
|
|
names = [name for name in self.emotes]
|
|
names.sort(key=lambda name: self.emotes[name].score(), reverse=True)
|
|
names = names[: self.top]
|
|
res = [intro]
|
|
allow_unused = self.full and len(self.members) == 0
|
|
res += [
|
|
self.emotes[name].to_string(
|
|
names.index(name), name, False, self.show_members
|
|
)
|
|
for name in names
|
|
if allow_unused or self.emotes[name].used()
|
|
]
|
|
# Get the total of all emotes used
|
|
usage_count = 0
|
|
reaction_count = 0
|
|
for name in self.emotes:
|
|
usage_count += self.emotes[name].usages
|
|
reaction_count += self.emotes[name].reactions
|
|
res += [
|
|
f"Total: {usage_count:,} times ({usage_count / self.msg_count:.4f} / message)"
|
|
]
|
|
if reaction_count > 0:
|
|
res[-1] += f" and {reaction_count:,} reactions"
|
|
return res
|
|
|
|
|
|
# ANALYSIS
|
|
|
|
|
|
def analyse_message(
|
|
message: MessageLog,
|
|
emotes: Dict[str, Emote],
|
|
raw_members: List[int],
|
|
*,
|
|
all_emojis: bool,
|
|
) -> bool:
|
|
impacted = False
|
|
# If author is included in the selection (empty list is all)
|
|
if not message.bot and (len(raw_members) == 0 or message.author in raw_members):
|
|
impacted = True
|
|
# Find all emotes un the current message in the form "<:emoji:123456789>"
|
|
# Filter for known emotes
|
|
found = emojis.regex.findall(message.content)
|
|
# For each emote, update its usage
|
|
for name in found:
|
|
if name not in emotes:
|
|
if not all_emojis or name not in emojis.unicode_list:
|
|
continue
|
|
emotes[name].usages += 1
|
|
emotes[name].update_use(message.created_at, [message.author])
|
|
# For each reaction of this message, test if known emote and update when it's the case
|
|
for name in message.reactions:
|
|
if name not in emotes:
|
|
if not all_emojis or name not in emojis.unicode_list:
|
|
continue
|
|
if len(raw_members) == 0:
|
|
emotes[name].reactions += len(message.reactions[name])
|
|
emotes[name].update_use(message.created_at, message.reactions[name])
|
|
else:
|
|
for member in raw_members:
|
|
if member in message.reactions[name]:
|
|
emotes[name].reactions += 1
|
|
emotes[name].update_use(message.created_at, [member])
|
|
return impacted
|