aboutsummaryrefslogtreecommitdiffstats
path: root/bot/cogs/hacktober/candy_collection.py
blob: f5f17abb7cbb410f3990ee67429d73e2cd997623 (plain) (blame)
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
import functools
import json
import os
import random

import discord
from discord.ext import commands

from bot.constants import HACKTOBER_CHANNEL_ID

json_location = os.path.join("bot", "resources", "halloween", "candy_collection.json")

# chance is 1 in x range, so 1 in 20 range would give 5% chance (for add candy)
ADD_CANDY_REACTION_CHANCE = 20  # 5%
ADD_CANDY_EXISTING_REACTION_CHANCE = 10  # 10%
ADD_SKULL_REACTION_CHANCE = 50  # 2%
ADD_SKULL_EXISTING_REACTION_CHANCE = 20  # 5%


class CandyCollection:
    def __init__(self, bot):
        self.bot = bot
        with open(json_location) as candy:
            self.candy_json = json.load(candy)
            self.msg_reacted = self.candy_json['msg_reacted']
        self.get_candyinfo = dict()
        for userinfo in self.candy_json['records']:
            userid = userinfo['userid']
            self.get_candyinfo[userid] = userinfo

    async def on_message(self, message):
        """
        Randomly adds candy or skull to certain messages
        """

        # make sure its a human message
        if message.author.bot:
            return
        # ensure it's hacktober channel
        if message.channel.id != HACKTOBER_CHANNEL_ID:
            return

        # do random check for skull first as it has the lower chance
        if random.randint(1, ADD_SKULL_REACTION_CHANCE) == 1:
            d = {"reaction": '\N{SKULL}', "msg_id": message.id, "won": False}
            self.msg_reacted.append(d)
            return await message.add_reaction('\N{SKULL}')
        # check for the candy chance next
        if random.randint(1, ADD_CANDY_REACTION_CHANCE) == 1:
            d = {"reaction": '\N{CANDY}', "msg_id": message.id, "won": False}
            self.msg_reacted.append(d)
            return await message.add_reaction('\N{CANDY}')

    async def on_reaction_add(self, reaction, user):
        """
        Add/remove candies from a person if the reaction satisfies criteria
        """

        message = reaction.message
        # check to ensure the reactor is human
        if user.bot:
            return
        # check to ensure it is in correct channel
        if message.channel.id != HACKTOBER_CHANNEL_ID:
            return

        # if its not a candy or skull, and it is one of 10 most recent messages,
        # proceed to add a skull/candy with higher chance
        if str(reaction.emoji) not in ('\N{SKULL}', '\N{CANDY}'):
            if message.id in await self.ten_recent_msg():
                await self.reacted_msg_chance(message)
            return

        for react in self.msg_reacted:
            # check to see if the message id of a message we added a
            # reaction to is in json file, and if nobody has won/claimed it yet
            if react['msg_id'] == message.id and react['won'] is False:
                react['user_reacted'] = user.id
                react['won'] = True
                try:
                    # if they have record/candies in json already it will do this
                    user_records = self.get_candyinfo[user.id]
                    if str(reaction.emoji) == '\N{CANDY}':
                        user_records['record'] += 1
                    if str(reaction.emoji) == '\N{SKULL}':
                        if user_records['record'] <= 3:
                            user_records['record'] = 0
                            lost = 'all of your'
                        else:
                            lost = random.randint(1, 3)
                            user_records['record'] -= lost
                        await self.send_spook_msg(message.author, message.channel, lost)

                except KeyError:
                    # otherwise it will raise KeyError so we need to add them to file
                    if str(reaction.emoji) == '\N{CANDY}':
                        print('ok')
                        d = {"userid": user.id, "record": 1}
                        self.candy_json['records'].append(d)
                await self.remove_reactions(reaction)

    async def reacted_msg_chance(self, message):
        """
        Randomly add a skull or candy to a message if there is a reaction there already
        (higher probability)
        """

        if random.randint(1, ADD_SKULL_EXISTING_REACTION_CHANCE) == 1:
            d = {"reaction": '\N{SKULL}', "msg_id": message.id, "won": False}
            self.msg_reacted.append(d)
            return await message.add_reaction('\N{SKULL}')

        if random.randint(1, ADD_CANDY_EXISTING_REACTION_CHANCE) == 1:
            d = {"reaction": '\N{CANDY}', "msg_id": message.id, "won": False}
            self.msg_reacted.append(d)
            return await message.add_reaction('\N{CANDY}')

    async def ten_recent_msg(self):
        """Get the last 10 messages sent in the channel"""
        ten_recent = []
        recent_msg = max(message.id for message
                         in self.bot._connection._messages
                         if message.channel.id == self.HACKTOBER_CHANNEL_ID)

        channel = await self.hacktober_channel()
        ten_recent.append(recent_msg.id)

        for i in range(9):
            o = discord.Object(id=recent_msg.id + i)
            msg = await next(channel.history(limit=1, before=o))
            ten_recent.append(msg.id)

        return ten_recent

    async def get_message(self, msg_id):
        """
        Get the message from it's ID.
        """

        try:
            o = discord.Object(id=msg_id + 1)
            # Use history rather than get_message due to
            #         poor ratelimit (50/1s vs 1/1s)
            msg = await next(self.hacktober_channel.history(limit=1, before=o))

            if msg.id != msg_id:
                return None

            return msg

        except Exception:
            return None

    async def hacktober_channel(self):
        """
        Get #hacktoberbot channel from it's id
        """
        return self.bot.get_channel(id=HACKTOBER_CHANNEL_ID)

    async def remove_reactions(self, reaction):
        """
        Remove all candy/skull reactions
        """

        try:
            async for user in reaction.users():
                await reaction.message.remove_reaction(reaction.emoji, user)

        except discord.HTTPException:
            pass

    async def send_spook_msg(self, author, channel, candies):
        """
        Send a spooky message
        """
        e = discord.Embed(colour=author.colour)
        e.set_author(name="Ghosts and Ghouls and Jack o' lanterns at night; "
                          f"I took {candies} candies and quickly took flight.")
        await channel.send(embed=e)

    def save_to_json(self):
        """
        Save json to the file.
        """
        with open(json_location, 'w') as outfile:
            json.dump(self.candy_json, outfile)

    @commands.command()
    async def candy(self, ctx):
        """
        Get the candy leaderboard and save to json when this is called
        """

        # use run_in_executor to prevent blocking
        thing = functools.partial(self.save_to_json)
        await self.bot.loop.run_in_executor(None, thing)

        emoji = (
            '\N{FIRST PLACE MEDAL}',
            '\N{SECOND PLACE MEDAL}',
            '\N{THIRD PLACE MEDAL}',
            '\N{SPORTS MEDAL}',
            '\N{SPORTS MEDAL}'
        )

        top_sorted = sorted(self.candy_json['records'], key=lambda k: k.get('record', 0), reverse=True)
        top_five = top_sorted[:5]

        usersid = []
        records = []
        for record in top_five:
            usersid.append(record['userid'])
            records.append(record['record'])

        value = '\n'.join(f'{emoji[index]} <@{usersid[index]}>: {records[index]}'
                          for index in range(0, len(usersid))) or 'No Candies'

        e = discord.Embed(colour=discord.Colour.blurple())
        e.add_field(name="Top Candy Records", value=value, inline=False)
        e.add_field(name='\u200b',
                    value=f"Candies will randomly appear on messages sent. "
                          f"\nHit the candy when it appears as fast as possible to get the candy! "
                          f"\nBut beware the ghosts...",
                    inline=False)
        await ctx.send(embed=e)


def setup(bot):
    bot.add_cog(CandyCollection(bot))