Initial commit

.gitignore

@@ -0,0 +1 @@
+users.db

LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2018 Noikoio <noikoio1 AT gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,4 @@
+# WorldTime
+A common problem since the beginning of the Internet: You find yourself in an online community with users scattered all over different time zones. You seek people to talk to, but they're idle. You are reminded of the concept of time zones and begin to wonder: what if this is not a good time for them?
+
+This bot aims to answer the age-old question, "What time is it for everyone?" Users specify their time zones. Others users can then ask the bot what time it is for a person in particular, or get an overview of the most common time zones amongst recently active members.

WorldTime.py

@@ -0,0 +1,259 @@
+#!/usr/bin/env python3
+
+# World Time, the Discord bot. Displays user time zones.
+# Original links:
+# - https://github.com/Noikoio/WorldTime
+# - https://discordapp.com/oauth2/authorize?client_id=447266583459528715&scope=bot
+
+# -----------
+bot_token = ''
+# -----------
+
+# Bad code ahead. I knew next to nothing about Python and I also made hasty desicions throughout.
+# Just keep that in mind if you decide to pick apart this code.
+
+# Not using discord.ext.commands extension, because see above.
+# Namely, can't figure out how to use it while also having my own on_message.
+# *And* I couldn't figure out how to customize its help message.
+
+import discord
+import asyncio
+
+import sqlite3
+from datetime import datetime
+import pytz
+
+def tsPrint(label, line):
+    """
+    Print with timestamp in a way that resembles some of my other projects
+    """
+    resultstr = datetime.utcnow().strftime('%Y-%m-%d %H:%m:%S') + ' [' + label + '] ' + line
+    print(resultstr)
+
+# For case-insensitive time zone lookup, map lowercase tzdata entries with
+# entires with proper case. pytz is case sensitive.
+tzlcmap = {x.lower():x for x in pytz.common_timezones}
+
+timefmt = "%H:%M %d-%b %Z%z"
+def tzPrint(zone : str):
+    """
+    Returns a string displaying the current time in the given time zone.
+    Resulting string should be placed in a code block.
+    """
+    padding = ''
+    now_time = datetime.now(pytz.timezone(zone))
+    if len(now_time.strftime("%Z")) != 4: padding = ' '
+    return "{:s}{:s} | {:s}".format(now_time.strftime(timefmt), padding, zone)
+
+# ---
+# Database things
+
+db = sqlite3.connect('users.db')
+dbcur = db.cursor()
+dbcur.execute('''CREATE TABLE IF NOT EXISTS users(
+    guild TEXT, user TEXT, zone TEXT, lastactive INTEGER,
+    PRIMARY KEY (guild, user)
+)''')
+db.commit()
+
+def db_update_activity(serverid : str, authorid : str):
+    '''
+    If a user exists in the database, updates their last activity timestamp.
+    '''
+    dbcur.execute('''
+        UPDATE users SET lastactive = strftime('%s', 'now')
+        WHERE guild = '{0}' AND user = '{1}'
+    '''.format(serverid, authorid))
+    db.commit()
+
+def db_delete_user(serverid : str, authorid : str):
+    '''
+    Deletes existing user from the database.
+    '''
+    dbcur.execute('''
+        DELETE FROM users
+        WHERE guild = '{0}' AND user = '{1}'
+    '''.format(serverid, authorid))
+    db.commit()
+
+def db_update_user(serverid : str, authorid : str, zone : str):
+    '''
+    Insert or update user in the database.
+    Does not do any sanitizing of incoming values, as only a small set of
+    values are allowed anyway. This is enforced by the caller.
+    '''
+    db_delete_user(serverid, authorid)
+    dbcur.execute('''
+        INSERT INTO users VALUES
+        ('{0}', '{1}', '{2}', strftime('%s', 'now'))
+    '''.format(serverid, authorid, zone))
+    db.commit()
+
+def db_get_list(serverid, userid=None):
+    c = db.cursor()
+    if userid is None:
+        c.execute('''
+        SELECT zone, count(*) as ct FROM users
+        WHERE guild = '{0}'
+        AND lastactive >= strftime('%s','now') - (72 * 60 * 60) -- only users active in the last 72 hrs
+        GROUP BY zone -- separate by popularity
+        ORDER BY ct DESC LIMIT 10 -- top 10 zones are given
+        '''.format(serverid))
+    else:
+        c.execute('''
+        SELECT zone, '0' as ct FROM users
+        WHERE guild = '{0}' AND user = '{1}'
+        '''.format(serverid, userid))
+        
+    results = c.fetchall()
+    c.close()
+    return [i[0] for i in results]
+
+# ---
+# Command things
+
+def build_help_embed(emtitle, emdesc):
+    em = discord.Embed(
+        color=14742263,
+        title=emtitle,
+        description=emdesc)
+    em.set_footer(text='World Time', icon_url=bot.user.avatar_url)
+    
+    return em
+
+async def cmd_help(message : discord.Message):
+    em = build_help_embed(
+        'Help & About',
+        'This bot aims to answer the age-old question, "What time is it for everyone here?"')
+    em.add_field(
+        name='Commands', value='''
+`tz.help` - This message.
+`tz.list` - Displays current times for all recently active known users.
+`tz.list [user]` - Displays the current time for the given *user*.
+`tz.time` - Displays the current time in your time zone.
+`tz.time [zone]` - Displays the current time in the given *zone*.
+`tz.set [zone]` - Registers or updates your *zone* with the bot.
+`tz.remove` - Removes your name from this bot.
+    ''')
+    em.add_field(
+        name='Zones', value='''
+This bot uses zone names from the tz database. Most common zones are supported. For a list of entries, see: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
+        ''')
+    await bot.send_message(message.channel, embed=em)
+
+async def cmd_list(message : discord.Message):
+    wspl = message.content.split(' ', 1)
+    if len(wspl) == 1:
+        await cmd_list_noparam(message)
+    else:
+        await cmd_list_userparam(message, wspl[1])
+async def cmd_list_noparam(message : discord.Message):
+    clist = db_get_list(message.channel.server.id)
+    if len(clist) == 0:
+        await bot.send_message(message.channel, ':x: No users with known zones have been active in the last 72 hours.')
+        return
+    clist.sort()
+    resultstr = '```\n'
+    for z in clist:
+        resultstr += tzPrint(z) + '\n'
+    resultstr += '```'
+    await bot.send_message(message.channel, resultstr)
+async def cmd_list_userparam(message : discord.Message, param):
+    # wishlist: search based on username/nickname
+    if param.startswith('<@!') and param.endswith('>'):
+        param = param[3:][:-1]
+    if param.startswith('<@') and param.endswith('>'):
+        param = param[2:][:-1]
+    if not param.isnumeric():
+        # Didn't get an ID...
+        await bot.send_message(message.channel, ':x: You must specify a user by ID or `@` mention.')
+        return
+    res = db_get_list(message.channel.server.id, param)
+    if len(res) == 0:
+        spaghetti = message.author.id == param
+        if spaghetti: await bot.send_message(message.channel, ':x: You do not have a time zone. Set it with `tz.set`.')
+        else: await bot.send_message(message.channel, ':x: The given user has not set a time zone. Ask to set it with `tz.set`.')
+        return
+    resultstr = '```\n' + tzPrint(res[0]) + '\n```'
+    await bot.send_message(message.channel, resultstr)
+
+async def cmd_time(message : discord.Message):
+    wspl = message.content.split(' ', 1)
+    if len(wspl) == 1:
+        # No parameter. So, doing the same thing anyway...
+        await cmd_list_userparam(message, message.author.id)
+    else:
+        try:
+            zoneinput = tzlcmap[wspl[1].lower()]
+        except KeyError:
+            await bot.send_message(message.channel, ':x: Not a valid zone name.')
+            return
+        resultstr = '```\n' + tzPrint(zoneinput) + '\n```'
+        await bot.send_message(message.channel, resultstr)
+
+async def cmd_set(message : discord.Message):
+    wspl = message.content.split(' ', 1)
+    if len(wspl) == 1:
+        # No parameter. But it's required
+        await bot.send_message(message.channel, ':x: Zone parameter is required.')
+        return
+    try:
+        zoneinput = tzlcmap[wspl[1].lower()]
+    except KeyError:
+        await bot.send_message(message.channel, ':x: Not a valid zone name.')
+        return
+    db_update_user(message.channel.server.id, message.author.id, zoneinput)
+    await bot.send_message(message.channel, ':white_check_mark: Your zone has been set.')
+
+async def cmd_remove(message : discord.Message):
+    db_delete_user(message.channel.server.id, message.author.id)
+    await bot.send_message(message.channel, ':white_check_mark: Your zone has been removed.')
+
+cmdlist = {
+    'help' : cmd_help,
+    'list' : cmd_list,
+    'time' : cmd_time,
+    'set'  : cmd_set,
+    'remove': cmd_remove
+}
+
+async def command_dispatch(message : discord.Message):
+    '''Interprets incoming commands'''
+    thecmd = message.content.split(' ', 1)[0].lower()
+    if thecmd.startswith('tz.'):
+        thecmd = thecmd[3:]
+    else:
+        return
+    try:
+        await cmdlist[thecmd](message)
+        tsPrint('Command invoked', '{0}/{1}: tz.{2}'.format(message.channel.server, message.author, thecmd))
+    except KeyError:
+        pass
+
+# ---
+# Bot things
+
+bot = discord.Client()
+
+@bot.event
+async def on_ready():
+    tsPrint('Status', 'Connected as {0} ({1})'.format(bot.user.name, bot.user.id))
+    await bot.change_presence(game=discord.Game(name='tz.help'))
+
+@bot.event
+async def on_message(message : discord.Message):
+    # ignore bots (should therefore also ignore self)
+    if message.author.bot: return
+    # act on DMs
+    if isinstance(message.channel, discord.PrivateChannel):
+        tsPrint('Incoming DM', '{0}: {1}'.format(message.author, message.content.replace('\n', '\\n')))
+        await bot.send_message(message.channel, '''I can't work over DMs...''')
+        # to do: small cache to not flood users who can't take a hint
+        return
+    db_update_activity(message.server.id, message.author.id)
+    await command_dispatch(message)
+
+# ---
+
+tsPrint('Status', 'Hello. Using users.db for database.')
+bot.run(bot_token)