roxbot/roxbot/converters.py

# -*- coding: utf-8 -*-

# MIT License
#
# Copyright (c) 2017-2018 Roxanne Gibson
#
# 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.


from discord.ext import commands


class User(commands.UserConverter):
    """Overriding the discord version to add a slower global look up for when it is a requirement to return a user who has left the guild.

    Converts to a :class:`User`.

    All lookups are via the global user cache. (Excluding the last one which makes an api call to discord.

    The lookup strategy is as follows (in order):

    1. Lookup by ID.
    2. Lookup by mention.
    3. Lookup by name#discrim
    4. Lookup by name
    5. Lookup by fetch_user
    """
    async def convert(self, ctx, argument):
        try:
            result = await super().convert(ctx, argument)
        except commands.BadArgument as e:
            try:
                result = await ctx.bot.fetch_user(argument)
            except:  # Bare except or otherwise it will raise its own BadArgument and have a pretty shitty error message that isn't useful.
                raise e

        return result


class Emoji():
    """discord.Emoji converter for Roxbot. Is a combo of the EmojiConverter and PartialEmojiConverter converter classes."""
    async def convert(self, ctx, argument):
        try:
            return await commands.EmojiConverter().convert(ctx, argument)
        except commands.errors.BadArgument:
            return await commands.PartialEmojiConverter().convert(ctx, argument)


class AvatarURL(commands.UserConverter):
    """
    Overriding the discord version to make it a converter appropriate for the image cog.

    Converts the input into a avatar url or url to an image provided. Either through URL or Attachments.

    1. Look up if argument is a URL
    3. Look up if argument is user

    Will do a user lookup, if that fails, then tries to parse the argument for a link
    """
    async def convert(self, ctx, argument):
        if any(x in argument.split(".")[-1].lower() for x in ("png", "jpg", "jpeg")):
            return argument.strip("<>")
        else:
            try:
                user = await super().convert(ctx, argument)
                return user.avatar_url_as(format="png")
            except:  # Same as above
                raise commands.BadArgument("No valid image/user given.")