Implement database/data collection

Author: klercke

.gitignore

@@ -1,2 +1,3 @@
 .env
 *.log
+*.csv

__pycache__/activity.cpython-37.pyc

@@ -0,0 +1,84 @@
+"""
+Author: Konnor Klercke
+File: users.py
+Purpose: Provide data on users to protobot.py
+"""
+
+
+#####################################
+                                    #
+from dataclasses import dataclass   #
+import csv                          #                
+                                    #
+#####################################
+
+
+#################################
+                                #
+USER_DATABSE = 'data/users.csv' #
+                                #
+#################################
+
+
+USERS = dict()
+
+
+@dataclass
+class User:
+
+    uuid: int
+    username: str
+    score: int
+    allowmoderator: bool
+    rankexempt: bool
+
+    def __str__(self):
+        return f"{self.username}{{UUID: {self.uuid}, Score: {self.score}, AllowModerator: {self.allowmoderator}, RankExempt: {self.rankexempt}}}"
+
+    
+    def changeScore(self, delta):
+        self.score += delta
+        return self.score
+
+
+def addUser(uuid, username, score=0, allowmoderator=True, rankexempt=False):
+    newUser = User(uuid, username, score, allowmoderator, rankexempt)
+    USERS[uuid] = newUser
+
+
+def writeDatabase():
+    with open('data/users.csv', mode='w', encoding='utf-8') as dataFile:
+        fieldnames = ['uuid', 'username', 'score', 'allowmoderator', 'rankexempt']
+        writer = csv.DictWriter(dataFile, fieldnames=fieldnames, lineterminator = '\n')
+
+        writer.writeheader()
+        for user in USERS.values():
+            writer.writerow({
+                'uuid': user.uuid, 
+                'username': user.username, 
+                'score': user.score, 
+                'allowmoderator': user.allowmoderator, 
+                'rankexempt': user.rankexempt})
+
+
+def readDatabase():
+    with open('data/users.csv', mode='r') as dataFile:
+        dataFile = csv.DictReader(dataFile)
+        for row in dataFile:
+            user = User(int(row['uuid']), row['username'], int(row['score']), bool(row['allowmoderator']), (row['rankexempt']))
+            USERS[int(row['uuid'])] = user
+
+
+def printDatabase():
+    for user in USERS.values():
+            print(user)
+
+
+def main():
+    readDatabase()
+    printDatabase()
+    writeDatabase()
+
+
+if __name__ == "__main__":
+    main()

activity.py

@@ -14,6 +14,8 @@
 from discord.ext import commands    #
 import logging                      #
 import time                         #
+import asyncio                      #
+import activity                     #
                                     #
 #####################################
 
@@ -64,7 +66,7 @@ async def on_connect():
 async def on_ready():
     """
     Prints a list of guilds the bot is connected to when the bot is finished processing
-    date from Discord servers.
+    date from Discord servers. Also calls the initizaling functions in activity.py.
     """
 
     logging.info('Bot loading complete. Current guilds: ')
@@ -73,6 +75,11 @@ async def on_ready():
         label = guild.name + " (" + str(guild.id) + ")"
         logging.info(label)
 
+    activity.readDatabase()
+
+    for guild in bot.guilds:
+        addAllUsersFromGuildToDatabase(guild)
+
 
 @bot.event
 async def on_disconnect():
@@ -82,21 +89,40 @@ async def on_disconnect():
 
     logging.warning('Lost connection to Discord.')
 
+@bot.event
+async def on_guild_join(guild):
+    """
+    Logs a message when bot joins a new guild.
+    """
+
+    logging.warning(f"Joined new guild: {guild.name + ' (' + str(guild.id) + ')'}")
 
 
 @bot.event
 async def on_member_join(member):
     """
-    Direct-messages a user whenever the join the server
+    Direct-messages a user whenever the join a server
     """
 
     await member.create_dm()
-    await member.dm_channel.send(
-        f"Hi {member.name}, welcome to Konnor's Discord server. Please set your "
-        "nickname to match the naming scheme used on the server. For example, if "
-        "my name was John, my nickname would be \"Protobot | John\". Please also "
-        "make sure to read any messages pinned in the #important channel."
-    )
+    if (member.guild.id == 150717946333888514):
+        welcome_message = (
+            f"Hi {member.name}, welcome to Konnor's Discord server. Please set your " 
+            "nickname to match the naming scheme used on the server. For example, if "
+            "my name was John, my nickname would be \"Protobot | John\". Please also "
+            "make sure to read any messages pinned in the #important channel."
+        )
+
+    elif (member.guild.id == 720996920939642912):
+        welcome_message = f"Welcome to the testing server, {member.name}!"
+
+    else:
+        welcome_message = f"Welcome to {member.guild.name}, {member.name}!"
+
+    await member.dm_channel.send(welcome_message)
+
+
+
 
 
 @bot.event
@@ -124,7 +150,6 @@ async def on_message(message):
 
         return 
 
-
     elif 'happy birthday' in message.content.lower():
         """
         Lets the bot say happy birthday whenever a user says it
@@ -136,7 +161,6 @@ async def on_message(message):
         for recipient in mentions:
             await message.channel.send(f"Happy Birthday <@{recipient.id}>! 🎈🎉🎂")
 
-
     elif 'im' in message.content.lower() or 'i\'m' in message.content.lower() or 'i am' in message.content.lower():
         """
         Lets the bot tell the famous "Hi x! I'm dad!" joke
@@ -157,7 +181,41 @@ async def on_message(message):
                     await message.channel.send(response)
                     break
 
-
     await bot.process_commands(message)
 
+
+async def run_once_per_day():
+    """
+    Runs a block of code every day sometime between 00:00 and 01:00 local time.
+    """
+
+    await bot.wait_until_ready()
+
+    if (int(time.strftime('%H', time.localtime())) < 1):
+        # This code will run if it is the correct time
+        logging.info("Running nightly operations.")
+    else:
+        logging.debug("Attempted to run daily event out of defined hours.")
+
+    # Check every hour
+    await asyncio.sleep(3600)
+
+
+def addAllUsersFromGuildToDatabase(guild):
+    for user in guild.members:
+        if (not user.bot):
+            addUserToDatabase(user.id, user.name)
+    
+    activity.writeDatabase()
+
+
+def addUserToDatabase(uuid, name, score=0, allowmoderator=True, rankexempt=False):
+    if (not uuid in activity.USERS.keys()):
+                activity.addUser(uuid, name, score, allowmoderator, rankexempt)
+                logging.info(f"Registered new user {name} ({uuid}) to database.")
+    
+    activity.writeDatabase()
+
+
+bot.loop.create_task(run_once_per_day())
 bot.run(TOKEN)