qrm2/exts/ae7q.py

"""
ae7q extension for qrm
---
Copyright (C) 2019 Abigail Gold, 0x5c

This file is part of discord-qrm2 and is released under the terms of the GNU
General Public License, version 2.
---
Test callsigns:
KN8U: active, restricted
AB2EE: expired, restricted
KE8FGB: assigned once, no restrictions
KV4AAA: unassigned, no records
KC4USA: reserved, no call history, *but* has application history
"""

import discord.ext.commands as commands

from bs4 import BeautifulSoup

import common as cmn


class AE7QCog(commands.Cog):
    def __init__(self, bot: commands.Bot):
        self.bot = bot
        self.session = bot.qrm.session

    @commands.group(name="ae7q", aliases=["ae"], category=cmn.cat.lookup)
    async def _ae7q_lookup(self, ctx: commands.Context):
        '''Look up a callsign, FRN, or Licensee ID on [ae7q.com](http://ae7q.com/).'''
        if ctx.invoked_subcommand is None:
            await ctx.send_help(ctx.command)

    @_ae7q_lookup.command(name="call", aliases=["c"], category=cmn.cat.lookup)
    async def _ae7q_call(self, ctx: commands.Context, callsign: str):
        '''Look up the history for a callsign on [ae7q.com](http://ae7q.com/).'''
        callsign = callsign.upper()
        desc = ''
        base_url = "http://ae7q.com/query/data/CallHistory.php?CALL="
        embed = cmn.embed_factory(ctx)

        async with self.session.get(base_url + callsign) as resp:
            if resp.status != 200:
                embed.title = "Error in AE7Q call command"
                embed.description = 'Could not load AE7Q'
                embed.colour = cmn.colours.bad
                await ctx.send(embed=embed)
                return
            page = await resp.text()

        soup = BeautifulSoup(page, features="html.parser")
        tables = [[row for row in table.find_all("tr")] for table in soup.select("table.Database")]

        table = tables[0]

        # find the first table in the page, and use it to make a description
        if len(table[0]) == 1:
            for row in table:
                desc += " ".join(row.getText().split())
                desc += '\n'
            desc = desc.replace(callsign, f'`{callsign}`')
            table = tables[1]

        table_headers = table[0].find_all("th")
        first_header = ''.join(table_headers[0].strings) if len(table_headers) > 0 else None

        # catch if the wrong table was selected
        if first_header != 'Entity Name':
            embed.title = f"AE7Q History for {callsign}"
            embed.colour = cmn.colours.bad
            embed.url = base_url + callsign
            embed.description = desc
            embed.description += f'\nNo records found for `{callsign}`'
            await ctx.send(embed=embed)
            return

        table = await process_table(table)

        embed = cmn.embed_factory(ctx)
        embed.title = f"AE7Q Records for {callsign}"
        embed.colour = cmn.colours.good
        embed.url = base_url + callsign

        # add the first three rows of the table to the embed
        for row in table[0:3]:
            header = f'**{row[0]}** ({row[1]})' # **Name** (Applicant Type)
            body = (f'Class: *{row[2]}*\n'
                    f'Region: *{row[3]}*\n'
                    f'Status: *{row[4]}*\n'
                    f'Granted: *{row[5]}*\n'
                    f'Effective: *{row[6]}*\n'
                    f'Cancelled: *{row[7]}*\n'
                    f'Expires: *{row[8]}*')
            embed.add_field(name=header, value=body, inline=False)

        if len(table) > 3:
            desc += f'\nRecords 1 to 3 of {len(table)}. See ae7q.com for more...'

        embed.description = desc

        await ctx.send(embed=embed)

    # TODO: write commands for other AE7Q response types?
    # @_ae7q_lookup.command(name="trustee")
    # async def _ae7q_trustee(self, ctx: commands.Context, callsign: str):
    #     pass

    # @_ae7q_lookup.command(name="applications", aliases=['apps'])
    # async def _ae7q_applications(self, ctx: commands.Context, callsign: str):
    #     pass

    # @_ae7q_lookup.command(name="frn")
    # async def _ae7q_frn(self, ctx: commands.Context, frn: str):
    #     base_url = "http://ae7q.com/query/data/FrnHistory.php?FRN="
    #     pass

    # @_ae7q_lookup.command(name="licensee", aliases=["lic"])
    # async def _ae7q_licensee(self, ctx: commands.Context, frn: str):
    #     base_url = "http://ae7q.com/query/data/LicenseeIdHistory.php?ID="
    #     pass


async def process_table(table: list):
    """Processes tables (including headers) and returns the processed table"""
    table_contents = []
    for tr in table[1:]:
        row = []
        for td in tr.find_all('td'):
            cell_val = td.getText().strip()
            row.append(cell_val if cell_val else '-')

            # take care of columns that span multiple rows by copying the contents rightward
            if 'colspan' in td.attrs and int(td.attrs['colspan']) > 1:
                for i in range(int(td.attrs['colspan']) - 1):
                    row.append(row[-1])

        # get rid of ditto marks by copying the contents from the previous row
        for i, cell in enumerate(row):
            if cell == "\"":
                row[i] = table_contents[-1][i]
        # add row to table
        table_contents += [row]
    return table_contents


def setup(bot: commands.Bot):
    bot.add_cog(AE7QCog(bot))