WidgetUtil.java

/*
 *     Copyright 2015-2016 Austin Keener & Michael Ritter
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.dv8tion.jda.core.utils;

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.JsonNode;
import com.mashape.unirest.http.Unirest;
import com.mashape.unirest.http.exceptions.UnirestException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import net.dv8tion.jda.core.OnlineStatus;
import net.dv8tion.jda.core.entities.Game;
import net.dv8tion.jda.core.entities.Guild;
import net.dv8tion.jda.core.entities.IMentionable;
import net.dv8tion.jda.core.entities.ISnowflake;
import net.dv8tion.jda.core.entities.impl.UserImpl;
import net.dv8tion.jda.core.exceptions.RateLimitedException;
import net.dv8tion.jda.core.requests.Requester;
import net.dv8tion.jda.core.utils.WidgetUtil.Widget.VoiceChannel;
import net.dv8tion.jda.core.utils.WidgetUtil.Widget.VoiceState;
import net.dv8tion.jda.core.utils.WidgetUtil.Widget.Member;
import org.apache.http.util.Args;
import org.json.JSONArray;
import org.json.JSONObject;

/**
 * The WidgetUtil is a class for interacting with various facets of Discord's
 * guild widgets
 */
public class WidgetUtil 
{
    public static final String WIDGET_PNG = Requester.DISCORD_API_PREFIX + "guilds/%s/widget.png?style=%s";
    public static final String WIDGET_URL = Requester.DISCORD_API_PREFIX + "guilds/%s/widget.json";
    public static final String WIDGET_HTML = "<iframe src=\"https://discordapp.com/widget?id=%s&theme=%s\" width=\"%d\" height=\"%d\" allowtransparency=\"true\" frameborder=\"0\"></iframe>";
    
    /**
     * Gets the banner image for the specified guild of the specified type.
     * This banner will only be available if the guild in question has the
     * Widget enabled.
     * 
     * @param guild The guild
     * @param type The type (visual style) of the banner
     * @return A String containing the URL of the banner image
     */
    public static String getWidgetBanner(Guild guild, BannerType type)
    {
        Args.notNull(guild, "Guild");
        return getWidgetBanner(guild.getId(), type);
    }
    
    /**
     * Gets the banner image for the specified guild of the specified type.
     * This banner will only be available if the guild in question has the
     * Widget enabled. Additionally, this method can be used independently of
     * being on the guild in question.
     * 
     * @param guildId the guild ID
     * @param type The type (visual style) of the banner
     * @return A String containing the URL of the banner image
     */
    public static String getWidgetBanner(String guildId, BannerType type)
    {
        Args.notNull(guildId, "GuildId");
        Args.notNull(type, "BannerType");
        return String.format(WIDGET_PNG, guildId, type.name().toLowerCase());
    }
    
    /**
     * Gets the pre-made HTML Widget for the specified guild using the specified
     * settings. The widget will only display correctly if the guild in question
     * has the Widget enabled.
     * 
     * @param guild the guild
     * @param theme the theme, light or dark
     * @param width the width of the widget
     * @param height the height of the widget
     * @return a String containing the pre-made widget with the supplied settings
     */
    public static String getPremadeWidgetHtml(Guild guild, WidgetTheme theme, int width, int height)
    {
        Args.notNull(guild, "Guild");
        return getPremadeWidgetHtml(guild.getId(), theme, width, height);
    }
    
    /**
     * Gets the pre-made HTML Widget for the specified guild using the specified
     * settings. The widget will only display correctly if the guild in question
     * has the Widget enabled. Additionally, this method can be used independently
     * of being on the guild in question.
     * 
     * @param guildId the guild ID
     * @param theme the theme, light or dark
     * @param width the width of the widget
     * @param height the height of the widget
     * @return a String containing the pre-made widget with the supplied settings
     */
    public static String getPremadeWidgetHtml(String guildId, WidgetTheme theme, int width, int height)
    {
        Args.notNull(guildId, "GuildId");
        Args.notNull(theme, "WidgetTheme");
        Args.notNegative(width, "Width");
        Args.notNegative(height, "Height");
        return String.format(WIDGET_HTML, guildId, theme.name().toLowerCase(), width, height);
    }
    
    /**
     * Makes a GET request to get the information for a Guild's widget. This
     * widget (if available) contains information about the guild, including the
     * Guild's name, an invite code (if set), a list of voice channels, and a
     * list of online members (plus the voice states of any members in voice
     * channels). This Widget can be obtained from any valid guild ID that has 
     * it enabled; no accounts need to be on the server to access this information.
     * 
     * @param guildId
     * @return null if the provided guild ID is not a valid Discord guild ID
     * @return a Widget object with null fields and isAvailable() returning
     *         false if the guild ID is valid but the guild in question does not
     *         have the widget enabled
     * @return a filled-in Widget object if the guild ID is valid and the guild
     *         in question has the widget enabled.
     */
    public static Widget getWidget(String guildId) throws RateLimitedException
    {
        Args.notNull(guildId, "GuildId");
        try
        {
            HttpResponse<JsonNode> result = Unirest.get(String.format(WIDGET_URL, guildId)).asJson();
            switch(result.getStatus())
            {
                case 200: return new Widget(result.getBody().getObject()); // ok
                case 400:              // not valid snowflake
                case 404: return null; // guild not found
                case 403: return new Widget(guildId); // widget disabled
                case 429: // ratelimited
                {
                    long retryAfter;
                    try
                    {
                        retryAfter = result.getBody().getObject().getLong("retry_after");
                    }
                    catch (Exception e)
                    {
                        retryAfter = 0;
                    }
                    throw new RateLimitedException(WIDGET_URL, retryAfter);
                }
                default: throw new RuntimeException("An unknown status was returned: " + result.getStatus() + " " + result.getStatusText());
            }
        }
        catch (UnirestException ex)
        {
            throw new RuntimeException(ex);
        }
    }
    
    /**
     * Represents the available banner types <br>
     * Each of these has a different appearance: <br>
     * <b>Shield</b> - tiny, only contains Discord logo and online count <br>
     * <b>Banner1</b> - medium, contains server name, icon, and online count, and a "Powered by Discord" bar on the bottom <br>
     * <b>Banner2</b> - small, contains server name, icon, and online count, and a Discord logo on the side <br>
     * <b>Banner3</b> - medium, contains server name, icon, and online count, and a Discord logo with a "Chat Now" bar on the bottom <br>
     * <b>Banner4</b> - large, contains a very big Discord logo, server name, icon, and online count, and a big "Join My Server" button
     */
    public enum BannerType
    {
        SHIELD, BANNER1, BANNER2, BANNER3, BANNER4
    }
    
    /**
     * Represents the color scheme of the widget <br>
     * These color themes match Discord's dark and light themes
     */
    public enum WidgetTheme
    {
        LIGHT, DARK
    }
    
    public static class Widget implements ISnowflake
    {
        private final boolean isAvailable;
        private final String id;
        private final String name;
        private final String invite;
        private final HashMap<String, VoiceChannel> channels;
        private final HashMap<String, Member> members;
        
        /**
         * Constructs an unavailable Widget
         */
        private Widget(String guildId)
        {
            isAvailable = false;
            id = guildId;
            name = null;
            invite = null;
            channels = null;
            members = null;
        }
        
        /**
         * Constructs an available Widget
         * @param id
         * @param name
         * @param invite
         * @param channels
         * @param members 
         */
        private Widget(JSONObject json)
        {
            String inviteCode = json.isNull("instant_invite") ? null : json.getString("instant_invite");
            if (inviteCode != null)
                inviteCode = inviteCode.substring(inviteCode.lastIndexOf("/") + 1);
            
            isAvailable = true;
            id = json.getString("id");
            name = json.getString("name");
            invite = inviteCode;
            channels = new HashMap<>();
            members = new HashMap<>();
            
            JSONArray channelsJson = json.getJSONArray("channels");
            for (int i = 0; i < channelsJson.length(); i++)
            {
                JSONObject channel = channelsJson.getJSONObject(i);
                channels.put(channel.getString("id"), new VoiceChannel(channel, this));
            }
            
            JSONArray membersJson = json.getJSONArray("members");
            for (int i = 0; i<membersJson.length(); i++)
            {
                JSONObject memberJson = membersJson.getJSONObject(i);
                Member member = new Member(memberJson, this);
                if (!memberJson.isNull("channel_id")) // voice state
                {
                    VoiceChannel channel = channels.get(memberJson.getString("channel_id"));
                    member.setVoiceState(new VoiceState(channel, 
                            memberJson.getBoolean("mute"), 
                            memberJson.getBoolean("deaf"), 
                            memberJson.getBoolean("suppress"), 
                            memberJson.getBoolean("self_mute"), 
                            memberJson.getBoolean("self_deaf"),
                            member,
                            this));
                    channel.addMember(member);
                }
                members.put(member.getId(), member);
            }
        }
        
        /**
         * Shows whether or not the widget for a guild is available. If this
         * method returns false, all other values will be null
         * 
         * @return true if the widget is available, false otherwise
         */
        public boolean isAvailable()
        {
            return isAvailable;
        }
        
        /**
         * Gets the ID of the guild
         * 
         * @return the ID of the guild
         */
        @Override
        public String getId()
        {
            return id;
        }
        
        /**
         * Gets the name of the guild
         * 
         * @return the name of the guild
         */
        public String getName()
        {
            return name;
        }
        
        /**
         * Gets an invite code for the guild, or null if no invite channel is
         * enabled in the widget
         * 
         * @return an invite code for the guild, if widget invites are enabled
         */
        public String getInviteCode()
        {
            return invite;
        }
        
        /**
         * Gets the list of voice channels in the guild
         * 
         * @return the list of voice channels in the guild
         */
        public List<VoiceChannel> getVoiceChannels()
        {
            return new ArrayList<>(channels.values());
        }
        
        /**
         * Gets a voice channel with the given ID, or null if the voice channel is not found
         * 
         * @param id the ID of the voice channel
         * @return possibly-null VoiceChannel with the given ID. 
         */
        public VoiceChannel getVoiceChannelById(String id)
        {
            return channels.get(id);
        }
        
        /**
         * Gets a list of online members in the guild
         * 
         * @return the list of members
         */
        public List<Member> getMembers()
        {
            return new ArrayList<>(members.values());
        }
        
        /**
         * Gets a member with the given ID, or null if the member is not found
         * 
         * @param id the ID of the member
         * @return possibly-null Member with the given ID. 
         */
        public Member getMemberById(String id)
        {
            return members.get(id);
        }

        @Override
        public int hashCode() {
            return id.hashCode();
        }

        @Override
        public boolean equals(Object obj) {
            if (!(obj instanceof Widget))
                return false;
            Widget oWidget = (Widget) obj;
            return this == oWidget || this.id.equals(oWidget.getId());
        }
        
        @Override
        public String toString()
        {
            return "W:" + (isAvailable() ? getName() : "") + '(' + getId() + ')';
        }
        
        
        
        public static class Member implements ISnowflake, IMentionable
        {
            private final boolean bot;
            private final String id;
            private final String username;
            private final String discriminator;
            private final String avatar;
            private final String nickname;
            private final OnlineStatus status;
            private final Game game;
            private final Widget widget;
            private VoiceState state;
            
            private Member(JSONObject json, Widget widget)
            {
                this.widget = widget;
                this.bot = !json.isNull("bot") && json.getBoolean("bot");
                this.id = json.getString("id");
                this.username = json.getString("username");
                this.discriminator = json.getString("discriminator");
                this.avatar = json.isNull("avatar") ? null : json.getString("avatar");
                this.nickname = json.isNull("nick") ? null : json.getString("nick");
                this.status = OnlineStatus.fromKey(json.getString("status"));
                this.game = json.isNull("game") ? null : 
                            json.getJSONObject("game").isNull("name") || json.getJSONObject("game").getString("name").isEmpty() ? null :
                            Game.of(json.getJSONObject("game").getString("name"));
            }
            
            private void setVoiceState(VoiceState voiceState)
            {
                state = voiceState;
            }
            
            /**
             * Returns whether or not the given member is a bot account
             * 
             * @return true if the member is a bot, false otherwise
             */
            public boolean isBot()
            {
                return bot;
            }
            
            /**
             * Returns the username of the member
             * 
             * @return the username of the member
             */
            public String getName()
            {
                return username;
            }
            
            /**
             * Gets the ID of the member
             * 
             * @return the never-null id of the member
             */
            @Override
            public String getId()
            {
                return id;
            }

            /**
             * Gets the member as a mention
             * 
             * @return a never-null mention of the member
             */
            @Override
            public String getAsMention()
            {
                return "<@" + getId() + ">";
            }
            
            /**
             * Gets the discriminator of the member
             * 
             * @return the never-null discriminator of the member
             */
            public String getDiscriminator()
            {
                return discriminator;
            }
            
            /**
             * Gets the avatar hash of the member, or null if they do not have
             * an avatar set.
             * 
             * @return possibly-null String containing the avatar hash of the
             * member
             */
            public String getAvatarId()
            {
                return avatar;
            }
            
            /**
             * Gets the avatar url of the member, or null if they do not have
             * an avatar set.
             * 
             * @return possibly-null String containing the avatar url of the
             * member
             */
            public String getAvatarUrl()
            {
                return getAvatarId() == null ? null : "https://cdn.discordapp.com/avatars/" + getId() + "/" + getAvatarId() 
                        + (getAvatarId().startsWith("a_") ? ".gif" : ".png");
            }

            /**
             * Gets the asset id of the member's default avatar
             * 
             * @return never-null String containing the asset id of the member's
             * default avatar
             */
            public String getDefaultAvatarId()
            {
                return UserImpl.DefaultAvatar.values()[Integer.parseInt(getDiscriminator()) % UserImpl.DefaultAvatar.values().length].toString();
            }

            /**
             * Gets the url of the member's default avatar
             * 
             * @return never-null String containing the url of the member's
             * default avatar
             */
            public String getDefaultAvatarUrl()
            {
                return "https://discordapp.com/assets/" + getDefaultAvatarId() + ".png";
            }

            /**
            * The URL for the user's avatar image
            * If they do not have an avatar set, this will return the URL of their
            * default avatar
            * 
            * @return
            *      Never-null String containing the member's effective avatar url.
            */
            public String getEffectiveAvatarUrl()
            {
                return getAvatarUrl() == null ? getDefaultAvatarUrl() : getAvatarUrl();
            }
            
            /**
             * Gets the nickname of the member. If they do not have a nickname on
             * the guild, this will return null;
             * 
             * @return possibly-null String containing the nickname of the member
             */
            public String getNickname()
            {
                return nickname;
            }
            
            /**
             * Gets the visible name of the member. If they have a nickname set,
             * this will be their nickname. Otherwise, it will be their username.
             * 
             * @return never-null String containing the member's effective (visible) name
             */
            public String getEffectiveName()
            {
                return nickname == null ? username : nickname;
            }
            
            /**
             * Gets the online status of the member. The widget does not show
             * offline members, so this status should never be offline
             * 
             * @return the {@link net.dv8tion.jda.core.OnlineStatus OnlineStatus} of the member
             */
            public OnlineStatus getOnlineStatus()
            {
                return status;
            }
            
            /**
            * The game that the member is currently playing.
            * This game cannot be a stream.
            * If the user is not currently playing a game, this will return null.
            *
            * @return
            *      Possibly-null {@link net.dv8tion.jda.core.entities.Game Game} containing the game that the member is currently playing.
            */
            public Game getGame()
            {
                return game;
            }
            
            /**
             * The current voice state of the member.
             * If the user is not in voice, this will return a VoiceState with a null channel.
             * 
             * @return never-null VoiceState of the member
             */
            public VoiceState getVoiceState()
            {
                return state == null ? new VoiceState(this, widget) : state;
            }

            /**
             * Gets the widget that to which this member belongs
             * 
             * @return the Widget that holds this member
             */
            public Widget getWidget()
            {
                return widget;
            }

            @Override
            public int hashCode() {
                return (widget.getId() + ' ' + id).hashCode();
            }

            @Override
            public boolean equals(Object obj) {
                if (!(obj instanceof Member))
                    return false;
                Member oMember = (Member) obj;
                return this == oMember || (this.id.equals(oMember.getId()) && this.widget.getId().equals(oMember.getWidget().getId()));
            }
            
            @Override
            public String toString()
            {
                return "W.M:" + getName() + '(' + getId() + ')';
            }
            
        }
        
        
        public static class VoiceChannel
        {
            private final int position;
            private final String id;
            private final String name;
            private final List<Member> members;
            private final Widget widget;
            
            private VoiceChannel(JSONObject json, Widget widget)
            {
                this.widget = widget;
                this.position = json.getInt("position");
                this.id = json.getString("id");
                this.name = json.getString("name");
                this.members = new ArrayList<>();
            }
            
            private void addMember(Member member)
            {
                members.add(member);
            }
            
            /**
             * Gets the integer position of the channel
             * 
             * @return integer position of the channel
             */
            public int getPosition()
            {
                return position;
            }
            
            /**
             * Gets the Discord ID of the channel
             * 
             * @return id of the channel
             */
            public String getId()
            {
                return id;
            }
            
            /**
             * Gets the name of the channel
             * 
             * @return name of the channel
             */
            public String getName()
            {
                return name;
            }
            
            /**
             * Gets a list of all members in the channel
             * 
             * @return never-null, possibly-empty list of members in the channel
             */
            public List<Member> getMembers()
            {
                return members;
            }

            /**
             * Gets the Widget to which this voice channel belongs
             * 
             * @return the Widget object that holds this voice channel
             */
            public Widget getWidget()
            {
                return widget;
            }

            @Override
            public int hashCode() {
                return id.hashCode();
            }

            @Override
            public boolean equals(Object obj) {
                if (!(obj instanceof VoiceChannel))
                    return false;
                VoiceChannel oVChannel = (VoiceChannel) obj;
                return this == oVChannel || this.id.equals(oVChannel.getId());
            }
            
            @Override
            public String toString()
            {
                return "W.VC:" + getName() + '(' + getId() + ')';
            }
        }
        
        public static class VoiceState
        {
            private final VoiceChannel channel;
            private final boolean muted;
            private final boolean deafened;
            private final boolean suppress;
            private final boolean selfMute;
            private final boolean selfDeaf;
            private final Member member;
            private final Widget widget;
            
            private VoiceState(Member member, Widget widget)
            {
                this(null, false, false, false, false, false, member, widget);
            }
            
            private VoiceState(VoiceChannel channel, boolean muted, boolean deafened, boolean suppress, boolean selfMute, boolean selfDeaf, Member member, Widget widget)
            {
                this.channel = channel;
                this.muted = muted;
                this.deafened = deafened;
                this.suppress = suppress;
                this.selfMute = selfMute;
                this.selfDeaf = selfDeaf;
                this.member = member;
                this.widget = widget;
            }
            
            /**
             * Gets the channel the member is in
             * 
             * @return never-null VoiceChannel
             */
            public VoiceChannel getChannel()
            {
                return channel;
            }
            
            /**
             * Used to determine if the member is currently in a voice channel.
             * If this is false, getChannel() will return null
             * 
             * @return true if the member is in a voice channel
             */
            public boolean inVoiceChannel()
            {
                return channel != null;
            }
            
            /**
             * Gets if the member is muted by an admin
             * 
             * @return true if the member is muted
             */
            public boolean isGuildMuted()
            {
                return muted;
            }
            
            /**
             * Gets if the member is deafened by an admin
             * 
             * @return true if the member is deafened
             */
            public boolean isGuildDeafened()
            {
                return deafened;
            }
            
            /**
             * Gets if the member is suppressed
             * 
             * @return true if the member is suppressed
             */
            public boolean isSuppressed()
            {
                return suppress;
            }
            
            /**
             * Gets if the member is self-muted
             * 
             * @return true if the member is self-muted
             */
            public boolean isSelfMuted()
            {
                return selfMute;
            }
            
            /**
             * Gets if the member is self-deafened
             * 
             * @return true if the member is self-deafened
             */
            public boolean isSelfDeafened()
            {
                return selfDeaf;
            }
            
            /**
             * Gets if the member is muted, either by an admin or self-muted
             * 
             * @return true if the member is self-muted or guild-muted
             */
            public boolean isMuted()
            {
                return selfMute || muted;
            }
            
            /**
             * Gets if the member is deafened, either by an admin or self-deafened
             * 
             * @return true if the member is self-deafened or guild-deafened
             */
            public boolean isDeafened()
            {
                return selfDeaf || deafened;
            }
            
            public Member getMember()
            {
                return member;
            }
            
            public Widget getWidget()
            {
                return widget;
            }

            @Override
            public int hashCode() {
                return member.hashCode();
            }
            
            @Override
            public boolean equals(Object obj) {
                if (!(obj instanceof VoiceState))
                    return false;
                VoiceState oState = (VoiceState) obj;
                return this == oState || (this.member.equals(oState.getMember()) && this.widget.equals(oState.getWidget()));
            }
            
            @Override
            public String toString() {
                return "VS:" + widget.getName() + ':' + member.getEffectiveName();
            }
        }
    }
}