aboutsummaryrefslogtreecommitdiffstats
path: root/bot/exts/evergreen/wikipedia.py
blob: 8af2273716e99dd45141c78a4217e8f32aefc428 (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
import logging
import re
from datetime import datetime
from html import unescape
from typing import List, Optional

from discord import Color, Embed, TextChannel
from discord.ext import commands

from bot.bot import Bot
from bot.utils import LinePaginator

log = logging.getLogger(__name__)

SEARCH_API = (
    "https://en.wikipedia.org/w/api.php?action=query&list=search&prop=info&inprop=url&utf8=&"
    "format=json&origin=*&srlimit={number_of_results}&srsearch={string}"
)
WIKI_THUMBNAIL = (
    "https://upload.wikimedia.org/wikipedia/en/thumb/8/80/Wikipedia-logo-v2.svg"
    "/330px-Wikipedia-logo-v2.svg.png"
)
WIKI_SNIPPET_REGEX = r"(<!--.*?-->|<[^>]*>)"
WIKI_SEARCH_RESULT = (
    "**[{name}]({url})**\n"
    "{description}\n"
)


class WikipediaSearch(commands.Cog):
    """Get info from wikipedia."""

    def __init__(self, bot: Bot):
        self.bot = bot

    async def wiki_request(self, channel: TextChannel, search: str) -> Optional[List[str]]:
        """Search wikipedia search string and return formatted first 10 pages found."""
        url = SEARCH_API.format(number_of_results=10, string=search)
        async with self.bot.http_session.get(url=url) as resp:
            if resp.status == 200:
                raw_data = await resp.json()
                if raw_data.get("query", None) is None:
                    if raw_data.get("errors", None) is not None:
                        log.info("There was an error regarding the Wikipedia API query.")
                    else:
                        log.info("There was an issue when trying to communicate with the Wikipedia API")

                    await channel.send(
                        "There was an issue processing your Wikipedia request, please try again later.")
                    return
                else:

                    number_of_results = raw_data["query"]["searchinfo"]["totalhits"]

                    if number_of_results:
                        results = raw_data["query"]["search"]
                        lines = []

                        for article in results:
                            line = WIKI_SEARCH_RESULT.format(
                                name=article["title"],
                                description=unescape(
                                    re.sub(
                                        WIKI_SNIPPET_REGEX, "", article["snippet"]
                                    )
                                ),
                                url=f"https://en.wikipedia.org/?curid={article['pageid']}"
                            )
                            lines.append(line)

                        return lines

                    else:
                        await channel.send(
                            "Sorry, we could not find a wikipedia article using that search term."
                        )
                        return
            else:
                log.info(f"Unexpected response `{resp.status}` while searching wikipedia for `{search}`")
                await channel.send(
                    "Whoops, the Wikipedia API is having some issues right now. Try again later."
                )
                return

    @commands.cooldown(1, 10, commands.BucketType.user)
    @commands.command(name="wikipedia", aliases=("wiki",))
    async def wikipedia_search_command(self, ctx: commands.Context, *, search: str) -> None:
        """Sends paginated top 10 results of Wikipedia search.."""
        contents = await self.wiki_request(ctx.channel, search)

        if contents:
            embed = Embed(
                title="Wikipedia Search Results",
                colour=Color.blurple()
            )
            embed.set_thumbnail(url=WIKI_THUMBNAIL)
            embed.timestamp = datetime.utcnow()
            await LinePaginator.paginate(
                contents, ctx, embed
            )


def setup(bot: Bot) -> None:
    """Load the WikipediaSearch cog."""
    bot.add_cog(WikipediaSearch(bot))