PlaceholderAPI/src/main/java/at/helpch/placeholderapi/PlaceholderAPI.java

/*
 * This file is part of PlaceholderAPI
 *
 * PlaceholderAPI
 * Copyright (c) 2015 - 2026 PlaceholderAPI Team
 *
 * PlaceholderAPI free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * PlaceholderAPI 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */

package at.helpch.placeholderapi;

import java.util.List;
import java.util.Locale;
import java.util.Objects;
import java.util.Set;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;

import at.helpch.placeholderapi.expansion.PlaceholderExpansion;
import at.helpch.placeholderapi.expansion.Relational;
import at.helpch.placeholderapi.replacer.CharsReplacer;
import at.helpch.placeholderapi.replacer.MessageReplacer;
import at.helpch.placeholderapi.replacer.Replacer;
import at.helpch.placeholderapi.replacer.Replacer.Closure;
import com.hypixel.hytale.server.core.Message;
import com.hypixel.hytale.server.core.entity.entities.Player;
import com.hypixel.hytale.server.core.universe.PlayerRef;
import org.jetbrains.annotations.NotNull;

public final class PlaceholderAPI {

    private static final Replacer REPLACER_PERCENT = new CharsReplacer(Closure.PERCENT);
    private static final Replacer REPLACER_BRACKET = new CharsReplacer(Closure.BRACKET);

    static final Pattern PLACEHOLDER_PATTERN = Pattern.compile("[%]([^%]+)[%]");
    static final Pattern BRACKET_PLACEHOLDER_PATTERN = Pattern.compile("[{]([^{}]+)[}]");
    static final Pattern RELATIONAL_PLACEHOLDER_PATTERN = Pattern
            .compile("[%](rel_)([^%]+)[%]");


    private PlaceholderAPI() {
    }

    // === Current API ===

    /**
     * Translates all placeholders into their corresponding values.
     * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
     *
     * @param player Player to parse the placeholders against
     * @param text   Text to set the placeholder values in
     * @return String containing all translated placeholders
     */
    @NotNull
    public static String setPlaceholders(final PlayerRef player,
                                         @NotNull final String text) {
        return REPLACER_PERCENT.apply(text, player,
                PlaceholderAPIPlugin.instance().localExpansionManager()::getExpansion);
    }

    /**
     * Translates all placeholders into their corresponding values.
     * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
     *
     * @param player   Player to parse the placeholders against
     * @param original Message to set the placeholder values in
     * @return Message containing all translated placeholders
     */
    @NotNull
    public static Message setPlaceholders(final PlayerRef player,
                                          @NotNull final Message original) {
        return MessageReplacer.replace(original, str -> setPlaceholders(player, str));
    }

    /**
     * Translates all placeholders into their corresponding values.
     * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
     *
     * @param player Player to parse the placeholders against
     * @param text   List of Strings to set the placeholder values in
     * @return String containing all translated placeholders
     */
    @NotNull
    public static List<String> setPlaceholders(final PlayerRef player,
                                               @NotNull final List<String> text) {
        return text.stream().map(line -> setPlaceholders(player, line)).collect(Collectors.toList());
    }

//    /**
//     * Translates all placeholders into their corresponding values.
//     * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
//     *
//     * @param player   Player to parse the placeholders against
//     * @param original List of Messages to set the placeholder values in
//     * @return List of Message containing all translated placeholders
//     */
//    @NotNull
//    public static List<Message> setPlaceholders(final Player player,
//                                               @NotNull final List<Message> original) {
//        return original.stream().map(msg -> setPlaceholders(player, msg)).collect(Collectors.toList());
//    }

//    /**
//     * Translates all placeholders into their corresponding values.
//     * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
//     *
//     * @param player Player to parse the placeholders against
//     * @param text   Text to set the placeholder values in
//     * @return String containing all translated placeholders
//     */
//    @NotNull
//    public static String setPlaceholders(final Player player, @NotNull String text) {
//        return setPlaceholders(((OfflinePlayer) player), text);
//    }

//    /**
//     * Translates all placeholders into their corresponding values.
//     * <br>The pattern of a valid placeholder is {@literal %<identifier>_<params>%}.
//     *
//     * @param player Player to parse the placeholders against
//     * @param text   List of Strings to set the placeholder values in
//     * @return String containing all translated placeholders
//     */
//    @NotNull
//    public static List<String> setPlaceholders(final Player player, @NotNull List<@NotNull String> text) {
//        return setPlaceholders(((OfflinePlayer) player), text);
//    }

    /**
     * Translates all placeholders into their corresponding values.
     * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
     *
     * @param player Player to parse the placeholders against
     * @param text   Text to set the placeholder values in
     * @return String containing all translated placeholders
     */
    @NotNull
    public static String setBracketPlaceholders(final PlayerRef player,
                                                @NotNull final String text) {
        return REPLACER_BRACKET.apply(text, player,
                PlaceholderAPIPlugin.instance().localExpansionManager()::getExpansion);
    }

    @NotNull
    public static Message setBracketPlaceholders(final PlayerRef player,
                                                 @NotNull final Message original) {
        return MessageReplacer.replace(original, str -> setBracketPlaceholders(player, str));
    }

    /**
     * Translates all placeholders into their corresponding values.
     * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
     *
     * @param player Player to parse the placeholders against
     * @param text   List of Strings to set the placeholder values in
     * @return String containing all translated placeholders
     */
    @NotNull
    public static List<@NotNull String> setBracketPlaceholders(final PlayerRef player,
                                                               @NotNull final List<@NotNull String> text) {
        return text.stream().map(line -> setBracketPlaceholders(player, line))
                .collect(Collectors.toList());
    }

//    /**
//     * Translates all placeholders into their corresponding values.
//     * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
//     *
//     * @param player Player to parse the placeholders against
//     * @param text   Text to set the placeholder values in
//     * @return String containing all translated placeholders
//     */
//    @NotNull
//    public static String setBracketPlaceholders(Player player, @NotNull String text) {
//        return setBracketPlaceholders((OfflinePlayer) player, text);
//    }
//
//    /**
//     * Translates all placeholders into their corresponding values.
//     * <br>The pattern of a valid placeholder is {@literal {<identifier>_<params>}}.
//     *
//     * @param player Player to parse the placeholders against
//     * @param text   List of Strings to set the placeholder values in
//     * @return String containing all translated placeholders
//     */
//    @NotNull
//    public static List<String> setBracketPlaceholders(Player player, @NotNull List<String> text) {
//        return setBracketPlaceholders((OfflinePlayer) player, text);
//    }

    /**
     * set relational placeholders in the text specified placeholders are matched with the pattern
     * {@literal %<rel_(identifier)_(params)>%} when set with this method
     *
     * @param one  First player to compare
     * @param two  Second player to compare
     * @param text Text to parse the placeholders in
     * @return The text containing the parsed relational placeholders
     */
    public static String setRelationalPlaceholders(Player one, Player two, String text) {
        final Matcher matcher = RELATIONAL_PLACEHOLDER_PATTERN.matcher(text);

        while (matcher.find()) {
            final String format = matcher.group(2);
            final int index = format.indexOf("_");

            if (index <= 0 || index >= format.length()) {
                continue;
            }

            String identifier = format.substring(0, index).toLowerCase(Locale.ROOT);
            String params = format.substring(index + 1);
            final PlaceholderExpansion expansion = PlaceholderAPIPlugin.instance()
                    .localExpansionManager().getExpansion(identifier);

            if (!(expansion instanceof Relational)) {
                continue;
            }

            final String value = ((Relational) expansion).onPlaceholderRequest(one, two, params);

            if (value != null) {
                text = text.replaceAll(Pattern.quote(matcher.group()), Matcher.quoteReplacement(value));
            }
        }

        return text;
    }

    /**
     * Translate placeholders in the provided List based on the relation of the two provided players.
     * <br>The pattern of a valid placeholder is {@literal %rel_<identifier>_<param>%}.
     *
     * @param one  Player to compare
     * @param two  Player to compare
     * @param text text to parse the placeholder values to
     * @return The text containing the parsed relational placeholders
     */
    public static List<String> setRelationalPlaceholders(Player one, Player two, List<String> text) {
        return text.stream().map(line -> setRelationalPlaceholders(one, two, line))
                .collect(Collectors.toList());
    }

    /**
     * Check if a specific placeholder identifier is currently registered
     *
     * @param identifier The identifier to check
     * @return true if identifier is already registered
     */
    public static boolean isRegistered(@NotNull final String identifier) {
        return PlaceholderAPIPlugin.instance().localExpansionManager()
                .findExpansionByIdentifier(identifier).isPresent();
    }

    /**
     * Get all registered placeholder identifiers
     *
     * @return A Set of type String containing the identifiers of all registered expansions.
     */
    @NotNull
    public static Set<String> getRegisteredIdentifiers() {
        return Set
                .copyOf(PlaceholderAPIPlugin.instance().localExpansionManager().getIdentifiers());
    }

    /**
     * Get the normal placeholder pattern.
     *
     * @return Regex Pattern of {@literal [%]([^%]+)[%]}
     */
    public static Pattern getPlaceholderPattern() {
        return PLACEHOLDER_PATTERN;
    }

    /**
     * Get the bracket placeholder pattern.
     *
     * @return Regex Pattern of {@literal [{]([^{}]+)[}]}
     */
    public static Pattern getBracketPlaceholderPattern() {
        return BRACKET_PLACEHOLDER_PATTERN;
    }

    /**
     * Get the relational placeholder pattern.
     *
     * @return Regex Pattern of {@literal [%](rel_)([^%]+)[%]}
     */
    public static Pattern getRelationalPlaceholderPattern() {
        return RELATIONAL_PLACEHOLDER_PATTERN;
    }

    /**
     * Check if a String contains any PlaceholderAPI placeholders ({@literal
     * %<identifier>_<params>%}).
     *
     * @param text String to check
     * @return true if String contains any matches to the normal placeholder pattern, false otherwise
     */
    public static boolean containsPlaceholders(String text) {
        return text != null && PLACEHOLDER_PATTERN.matcher(text).find();
    }

    /**
     * Check if a String contains any PlaceholderAPI bracket placeholders ({@literal
     * {<identifier>_<params>}}).
     *
     * @param text String to check
     * @return true if String contains any matches to the bracket placeholder pattern, false otherwise
     */
    public static boolean containsBracketPlaceholders(String text) {
        return text != null && BRACKET_PLACEHOLDER_PATTERN.matcher(text).find();
    }
}