discord4j.rest.util.Image Maven / Gradle / Ivy

Go to download
/*
 * This file is part of Discord4J.
 *
 * Discord4J is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Discord4J is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Discord4J. If not, see .
 */
package discord4j.rest.util;

import discord4j.common.ReactorResources;
import reactor.core.publisher.Mono;
import reactor.util.annotation.Nullable;

import java.util.Arrays;
import java.util.Base64;
import java.util.Objects;

/**
 * Represents a Discord image.
 *
 * @see Image Formatting
 */
public final class Image {

    /**
     * Constructs an {@code Image} utilizing raw image data.
     *
     * @param data The raw image data.
     * @param format The {@link Format} of the data.
     * @return An {@code Image} with raw image data.
     */
    public static Image ofRaw(final byte[] data, final Format format) {
        return new Image(data, format);
    }

    /**
     * Constructs an {@code Image} using the resource at the given url.
     *
     * @param url The url of the image.
     * @return A {@link Mono} where, upon successful completion, emits an {@link Image} with the data at the url. If an
     * error is received, it is emitted through the {@code Mono}.
     */
    public static Mono ofUrl(final String url) {
        return ReactorResources.DEFAULT_HTTP_CLIENT.get()
                .get()
                .uri(url)
                .responseSingle((res, body) -> body.asByteArray().map(image -> {
                    Format format = Format.fromContentType(res.responseHeaders().get("Content-Type"));
                    return Image.ofRaw(image, format);
                }));
    }

    /** The raw image data. */
    private final byte[] data;

    /** The format of the image. */
    private final Format format;

    private Image(byte[] data, Format format) {
        this.data = data;
        this.format = format;
    }

    /**
     * Gets the raw data of the image.
     *
     * @return The raw data of the image.
     */
    public byte[] getData() {
        return data;
    }

    /**
     * Gets the format of the image.
     *
     * @return The format of the image.
     */
    public Format getFormat() {
        return format;
    }

    /**
     * Gets the Base64-encoded data of the image.
     *
     * @return The Base64-encoded data of the image.
     */
    public String getHash() {
        return Base64.getEncoder().encodeToString(data);
    }

    /**
     * Gets a data URI for this image.
     *
     * @return The data URI for this image.
     */
    public String getDataUri() {
        return String.format("data:image/%s;base64,%s", format.extension, getHash());
    }

    @Override
    public String toString() {
        return "Image{" +
                "data=" + Arrays.toString(data) +
                ", format=" + format +
                '}';
    }

    @Override
    public boolean equals(@Nullable Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Image image = (Image) o;
        return Arrays.equals(data, image.data) &&
                format == image.format;
    }

    @Override
    public int hashCode() {
        int result = Objects.hash(format);
        result = 31 * result + Arrays.hashCode(data);
        return result;
    }

    /**
     * The format of an image. This enum represents all the types supported by Discord.
     *
     * @see Image Formats
     */
    public enum Format {

        /** Unknown image format. */
        UNKNOWN("UNKNOWN"),

        /** Represents the Joint Photographic Experts Group format. */
        JPEG("jpeg"),

        /** Represents the Portable Network Graphics format. */
        PNG("png"),

        /** Represents the WebP format. */
        WEB_P("webp"),

        /** Represents the Graphics Interchange Format format. */
        GIF("gif");

        /** The file extension associated with this format. */
        private final String extension;

        /**
         * Constructs a {@code Image.Format}.
         *
         * @param extension The file extension associated with this format.
         */
        Format(final String extension) {
            this.extension = extension;
        }

        /**
         * Gets the file extension associated with this format.
         *
         * @return The file extension associated with this format.
         */
        public String getExtension() {
            return extension;
        }

        private static Format fromContentType(String contentType) {
            switch (contentType) {
                case "image/jpeg": return JPEG;
                case "image/png": return PNG;
                case "image/webp": return WEB_P;
                case "image/gif": return GIF;
                default: return UNKNOWN;
            }
        }
    }
}