diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..ea0ebe6 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1,9 @@ +# +# Assigns extendedclip and PiggyPiglet for any PR unless a check below matches. +# +* @extendedclip @PiggyPiglet + +# +# Assigns Andre601 to any PR that targets the wiki folder. +# +/wiki/ @Andre601 diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index ddeb6e7..9c3768a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -4,14 +4,23 @@ about: Report bugs of PlaceholderAPI with this template --- -## Please read -This template is only for reporting bugs of PlaceholderAPI! -If you want to request changes to the code of PlaceholderAPI, use the [Request change (PlaceholderAPI)] template. -For changes to the wiki use the [Request change (Wiki)] template. + +## Bug Report ### Issue > What is the issue? Describe it like you would tell a friend. @@ -36,13 +45,3 @@ Please also make sure that you use the [latest release][Spigot] or the latest [d ### Installed expansions > Please list all expansions that are displayed when running `/papi list` - - - - - -[Request change (Wiki)]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_wiki.md -[Request change (PlaceholderAPI)]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_placeholderapi.md -[Spigot]: https://www.spigotmc.org/resources/6245/ -[Jenkins]: http://ci.extendedclip.com/job/PlaceholderAPI/ -[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/change_request_placeholderapi.md b/.github/ISSUE_TEMPLATE/change_request_placeholderapi.md deleted file mode 100644 index bd3ccf5..0000000 --- a/.github/ISSUE_TEMPLATE/change_request_placeholderapi.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -name: Request change (PlaceholderAPI) -about: Request a update/change of the PlaceholderAPI-code - ---- - -## Please read -This template is only for requesting new functions to be added to PlaceholderAPI or for old one to be changed! -Please use the [Request change (Wiki)] template to ask for additions/changes to the wiki. -For reporting bugs of PlaceholderAPI use the [Bug report] template. - -Also make sure that the [wiki] doesn't already mention such a function/change and that there isn't a issue about this change on the [issues] page. - -We recommend to [open a Pull Request][Pull Requests] for making changes to PlaceholderAPI's code. - -### Type -> What kind of request is this? (Multiple selections possible) - -- [ ] New function for PlaceholderAPI. -A new function that developers could use. -- [ ] Change to code (Internal). -Changes to code that won't affect the end-user. -- [ ] Change to code (External). -Changes to code that will affect the end-user (breaks stuff). -- [ ] Other: __________ - -### Info -> What is the change? -> Please provide as much information (including links, images and code-snippeds) as possible. - - - - - - -[Request change (Wiki)]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_wiki.md -[Bug report]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=bug_report.md -[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues -[wiki]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki -[Pull Requests]: https://github.com/PlaceholderAPI/PlaceholderAPI/pulls \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/change_request_wiki.md b/.github/ISSUE_TEMPLATE/change_request_wiki.md deleted file mode 100644 index cc5ed35..0000000 --- a/.github/ISSUE_TEMPLATE/change_request_wiki.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -name: Request change (Wiki) -about: Request a update/change of a wiki-page - ---- - -## Please read -This template is only for requesting new information to be added to the wiki or for updating of already existing information! -Please use the [Request change (PlaceholderAPI)] template to ask for additions/changes to the plugin PlaceholderAPI. -For reporting bugs of PlaceholderAPI use the [Bug report] template. - -Also make sure that the [wiki] doesn't already have the change and that there isn't a issue about this change on the [issues] page. - -### Type -> What kind of change is it? (Multiple selections possible) - -- [ ] New plugin/expansion supporting PlaceholderAPI. -A new plugin/expansion uses and/or provides placeholders. -- [ ] Placeholder(s) changed. -An already listed expansion/plugin has new placeholders or old ones have changed. -- [ ] Plugin/Expansion no longer supports PlaceholderAPI and/or was deleted. -- [ ] Other: __________ - -### Info -> Please provide any information that is useful including links and images. -> For plugins/expansion providing new placeholders or updating old ones, provide the placeholders (that have changed) - - - - - - -[Request change (PlaceholderAPI)]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=change_request_placeholderapi.md -[Bug report]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues/new?template=bug_report.md -[issues]: https://github.com/PlaceholderAPI/PlaceholderAPI/issues -[wiki]: https://github.com/PlaceholderAPI/PlaceholderAPI/wiki diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 1da4d14..7553dc0 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -9,3 +9,6 @@ contact_links: - name: Hastebin url: https://paste.helpch.at about: Use our Hastebin-site for sharing errors and configuration files. + - name: Update Wiki + url: https://github.com/PlaceholderAPI/PlaceholderAPI/pulls + about: Please make a Pull request towards the "wiki" folder to update the wiki. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..0e16cfa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,33 @@ +--- +name: Feature Request +about: Request a update/change of the PlaceholderAPI-code + +--- + + + +## Feature Request + +### Type +> What kind of request is this? (Multiple selections possible) + +- [ ] New function for PlaceholderAPI. +A new function that developers could use. +- [ ] Change to code (Internal). +Changes to code that won't affect the end-user. +- [ ] Change to code (External). +Changes to code that will affect the end-user (breaks stuff). +- [ ] Other: __________ + +### Info +> What is the change? +> Please provide as much information (including links, images and code-snippeds) as possible. + diff --git a/build.gradle b/build.gradle index 721f996..55dcf7a 100644 --- a/build.gradle +++ b/build.gradle @@ -12,8 +12,7 @@ description "An awesome placeholder provider!" repositories { mavenCentral() - - maven({ url = "https://rayzr.dev/repo/" }) + maven({ url = "https://repo.codemc.org/repository/maven-public" }) maven({ url = "https://hub.spigotmc.org/nexus/content/repositories/snapshots/" }) } @@ -21,7 +20,6 @@ repositories { dependencies { implementation "com.google.code.gson:gson:2.8.6" implementation "org.bstats:bstats-bukkit:1.5" - implementation "me.rayzr522:jsonmessage:1.2.1" compileOnly "org.spigotmc:spigot-api:1.16.1-R0.1-SNAPSHOT" compileOnly "org.jetbrains:annotations:19.0.0" @@ -48,20 +46,23 @@ tasks.withType(JavaCompile) { shadowJar { archiveClassifier.set("") - + relocate "org.bstats", "me.clip.placeholderapi.metrics" relocate "com.google.gson", "me.clip.placeholderapi.libs.gson" - relocate "me.rayzr522.jsonmessage", "me.clip.placeholderapi.libs.jsonmessage" } license { - header = file("headers/header.txt") - + matching('**/*.java') { + header = file('headers/main.txt') + } + + matching('**/JSONMessage.java') { + header = file('headers/jsonmessage.txt') + } + ext { year = 2020 } - - include "**/*.java" } test { @@ -92,7 +93,7 @@ publishing { publications { mavenJava(MavenPublication) { from components.java - + pom.withXml { asNode().appendNode("packaging", "jar") asNode().remove(asNode().get("dependencies")) diff --git a/headers/jsonmessage.txt b/headers/jsonmessage.txt new file mode 100644 index 0000000..ec15330 --- /dev/null +++ b/headers/jsonmessage.txt @@ -0,0 +1,7 @@ +Copyright (c) 2018-2020 Peter Blood + +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. \ No newline at end of file diff --git a/headers/header.txt b/headers/main.txt similarity index 100% rename from headers/header.txt rename to headers/main.txt diff --git a/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java b/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java index 187c552..1d57c37 100644 --- a/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java +++ b/src/main/java/me/clip/placeholderapi/PlaceholderAPI.java @@ -21,6 +21,11 @@ package me.clip.placeholderapi; import com.google.common.collect.ImmutableSet; +import java.util.List; +import java.util.Set; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import java.util.stream.Collectors; import me.clip.placeholderapi.expansion.PlaceholderExpansion; import me.clip.placeholderapi.expansion.Relational; import me.clip.placeholderapi.replacer.CharsReplacer; @@ -34,508 +39,480 @@ import org.jetbrains.annotations.ApiStatus; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; -import java.util.List; -import java.util.Set; -import java.util.regex.Matcher; -import java.util.regex.Pattern; -import java.util.stream.Collectors; +public final class PlaceholderAPI { -public final class PlaceholderAPI -{ + private static final Replacer REPLACER_PERCENT = new CharsReplacer(Closure.PERCENT); + private static final Replacer REPLACER_BRACKET = new CharsReplacer(Closure.BRACKET); - private static final Replacer REPLACER_PERCENT = new CharsReplacer(Closure.PERCENT); - private static final Replacer REPLACER_BRACKET = new CharsReplacer(Closure.BRACKET); + private static final Pattern PLACEHOLDER_PATTERN = Pattern.compile("[%]([^%]+)[%]"); + private static final Pattern BRACKET_PLACEHOLDER_PATTERN = Pattern.compile("[{]([^{}]+)[}]"); + private static final Pattern RELATIONAL_PLACEHOLDER_PATTERN = Pattern + .compile("[%](rel_)([^%]+)[%]"); - @Deprecated - private static final Pattern PLACEHOLDER_PATTERN = Pattern.compile("[%]([^%]+)[%]"); - @Deprecated - private static final Pattern BRACKET_PLACEHOLDER_PATTERN = Pattern.compile("[{]([^{}]+)[}]"); - @Deprecated - private static final Pattern RELATIONAL_PLACEHOLDER_PATTERN = Pattern.compile("[%](rel_)([^%]+)[%]"); + private PlaceholderAPI() { + } + + // === Current API === + + /** + * Translates all placeholders into their corresponding values. + *
The pattern of a valid placeholder is {@literal %_%}. + * + * @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(@Nullable final OfflinePlayer player, + @NotNull final String text) { + return REPLACER_PERCENT.apply(text, player, + PlaceholderAPIPlugin.getInstance().getLocalExpansionManager()::getExpansion); + } + + /** + * Translates all placeholders into their corresponding values. + *
The pattern of a valid placeholder is {@literal %_%}. + * + * @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 setPlaceholders(@Nullable final OfflinePlayer player, + @NotNull final List<@NotNull String> text) { + return text.stream().map(line -> setPlaceholders(player, line)).collect(Collectors.toList()); + } + + /** + * Translates all placeholders into their corresponding values. + *
The pattern of a valid placeholder is {@literal {_}}. + * + * @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(@Nullable final OfflinePlayer player, + @NotNull final String text) { + return REPLACER_BRACKET.apply(text, player, + PlaceholderAPIPlugin.getInstance().getLocalExpansionManager()::getExpansion); + } + + /** + * Translates all placeholders into their corresponding values. + *
The pattern of a valid placeholder is {@literal {_}}. + * + * @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 setBracketPlaceholders(@Nullable final OfflinePlayer player, + @NotNull final List<@NotNull String> text) { + return text.stream().map(line -> setBracketPlaceholders(player, line)) + .collect(Collectors.toList()); + } - private PlaceholderAPI() - { - } + /** + * 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.getInstance().getLocalExpansionManager() + .findExpansionByIdentifier(identifier).isPresent(); + } - // === Current API === + /** + * Get all registered placeholder identifiers + * + * @return All registered placeholder identifiers + */ + @NotNull + public static Set getRegisteredIdentifiers() { + return ImmutableSet + .copyOf(PlaceholderAPIPlugin.getInstance().getLocalExpansionManager().getIdentifiers()); + } - /** - * Translates all placeholders into their corresponding values. - *
The pattern of a valid placeholder is {@literal %_%}. - * - * @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(@Nullable final OfflinePlayer player, @NotNull final String text) - { - return REPLACER_PERCENT.apply(text, player, PlaceholderAPIPlugin.getInstance().getLocalExpansionManager()::getExpansion); - } + /** + * Get the normal placeholder pattern. + */ + public static Pattern getPlaceholderPattern() { + return PLACEHOLDER_PATTERN; + } - /** - * Translates all placeholders into their corresponding values. - *
The pattern of a valid placeholder is {@literal %_%}. - * - * @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 setPlaceholders(@Nullable final OfflinePlayer player, @NotNull final List<@NotNull String> text) - { - return text.stream().map(line -> setPlaceholders(player, line)).collect(Collectors.toList()); - } + /** + * Get the bracket placeholder pattern. + */ + public static Pattern getBracketPlaceholderPattern() { + return BRACKET_PLACEHOLDER_PATTERN; + } - /** - * Translates all placeholders into their corresponding values. - *
The pattern of a valid placeholder is {@literal {_}}. - * - * @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(@Nullable final OfflinePlayer player, @NotNull final String text) - { - return REPLACER_BRACKET.apply(text, player, PlaceholderAPIPlugin.getInstance().getLocalExpansionManager()::getExpansion); - } + /** + * Get the relational placeholder pattern. + */ + public static Pattern getRelationalPlaceholderPattern() { + return RELATIONAL_PLACEHOLDER_PATTERN; + } - /** - * Translates all placeholders into their corresponding values. - *
The pattern of a valid placeholder is {@literal {_}}. - * - * @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 setBracketPlaceholders(@Nullable final OfflinePlayer player, @NotNull final List<@NotNull String> text) - { - return text.stream().map(line -> setBracketPlaceholders(player, line)).collect(Collectors.toList()); - } + /** + * Check if a String contains any PlaceholderAPI placeholders ({@literal + * %_%}). + * + * @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 + * {_}}). + * + * @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(); + } + + // === Deprecated API === + + /** + * set relational placeholders in the text specified placeholders are matched with the pattern + * %% 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 + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. + */ + @Deprecated + public static String setRelationalPlaceholders(Player one, Player two, String text) { + return setRelationalPlaceholders(one, two, text, true); + } + + /** + * Translate placeholders in the provided List based on the relation of the two provided players. + *
The pattern of a valid placeholder is {@literal %rel__%}. + * + * @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 + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. + */ + @Deprecated + public static List setRelationalPlaceholders(Player one, Player two, List text) { + return setRelationalPlaceholders(one, two, text, true); + } + + /** + * Translate placeholders in the provided list based on the relation of the two provided players. + *
The pattern of a valid placeholder is {@literal %rel__%}. + * + * @param one First player to compare + * @param two Second player to compare + * @param text Text to parse the placeholders in + * @param colorize If color codes (&[0-1a-fk-o]) should be translated + * @return The text containing the parsed relational placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static List setRelationalPlaceholders(Player one, Player two, List text, + boolean colorize) { + if (text == null) { + return null; + } + + return text.stream() + .map(line -> setRelationalPlaceholders(one, two, line, colorize)) + .collect(Collectors.toList()); + } + + /** + * set relational placeholders in the text specified placeholders are matched with the pattern + * %% when set with this method + * + * @param one Player to compare + * @param two Player to compare + * @param text Text to parse the placeholders in + * @param colorize If color codes (&[0-1a-fk-o]) should be translated + * @return The text containing the parsed relational placeholders + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. + */ + @Deprecated + @SuppressWarnings("DuplicatedCode") + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static String setRelationalPlaceholders(Player one, Player two, String text, + boolean colorize) { + if (text == null) { + return null; + } + + if (PlaceholderAPIPlugin.getInstance().getLocalExpansionManager().getExpansionsCount() == 0) { + return colorize ? Msg.color(text) : 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(); + String params = format.substring(index + 1); + final PlaceholderExpansion expansion = PlaceholderAPIPlugin.getInstance() + .getLocalExpansionManager().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 colorize ? Msg.color(text) : text; + } + + /** + * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to + * register placeholders instead + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static boolean registerPlaceholderHook(Plugin plugin, PlaceholderHook placeholderHook) { + PlaceholderAPIPlugin.getInstance().getLogger().warning(plugin.getName() + + " is attempting to register placeholders via a PlaceholderHook class which is no longer supported!" + + " Please reach out to " + plugin.getDescription().getAuthors().toString() + + " and let them know that they need to update ASAP!"); + return false; + } + + /** + * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to + * register placeholders instead + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static boolean registerPlaceholderHook(String identifier, + PlaceholderHook placeholderHook) { + PlaceholderAPIPlugin.getInstance().getLogger().warning(identifier + + " is attempting to register placeholders via a PlaceholderHook class which is no longer supported!"); + return false; + } - /** - * 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.getInstance().getLocalExpansionManager().findExpansionByIdentifier(identifier).isPresent(); - } + /** + * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to + * unregister placeholders instead + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static boolean unregisterPlaceholderHook(Plugin plugin) { + PlaceholderAPIPlugin.getInstance().getLogger().warning(plugin.getName() + + " is attempting to unregister placeholders via the PlaceholderAPI class which is no longer supported!" + + " Please reach out to " + plugin.getDescription().getAuthors().toString() + + " and let them know that they need to update ASAP!"); + return false; + } + + /** + * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to + * unregister placeholders instead + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static boolean unregisterPlaceholderHook(String identifier) { + PlaceholderAPIPlugin.getInstance().getLogger().warning(identifier + + " is attempting to unregister placeholders through the PlaceholderAPI class which is no longer supported!"); + return false; + } + + /** + * @deprecated Please use {@link #setPlaceholders(OfflinePlayer, String)} instead + */ + @NotNull + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static String setPlaceholders(@Nullable final OfflinePlayer player, + @NotNull final String text, @NotNull final Pattern pattern, final boolean colorize) { + return setPlaceholders(player, text); + } + + /** + * @deprecated Please use {@link #setPlaceholders(OfflinePlayer, List)} instead + */ + @NotNull + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static List setPlaceholders(@Nullable final OfflinePlayer player, + @NotNull final List text, @NotNull final Pattern pattern, final boolean colorize) { + return setPlaceholders(player, text); + } + + /** + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static List setBracketPlaceholders(OfflinePlayer player, List text, + boolean colorize) { + return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize); + } + + /** + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static List setPlaceholders(OfflinePlayer player, List text, + boolean colorize) { + return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize); + } + + /** + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static List setPlaceholders(OfflinePlayer player, List text, + Pattern pattern) { + return setPlaceholders(player, text, pattern, true); + } - /** - * Get all registered placeholder identifiers - * - * @return All registered placeholder identifiers - */ - @NotNull - public static Set getRegisteredIdentifiers() - { - return ImmutableSet.copyOf(PlaceholderAPIPlugin.getInstance().getLocalExpansionManager().getIdentifiers()); - } + /** + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static String setBracketPlaceholders(OfflinePlayer player, String text, boolean colorize) { + return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize); + } + /** + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static String setPlaceholders(OfflinePlayer player, String text, boolean colorize) { + return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize); + } - // === Deprecated API === + /** + * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static String setPlaceholders(OfflinePlayer player, String text, Pattern pattern) { + return setPlaceholders(player, text, pattern, true); + } - /** - * Check if a String contains any PlaceholderAPI placeholders ({@literal %_%}). - * - * @param text String to check - * @return true if String contains any registered placeholder identifiers, false otherwise - * @deprecated Will be removed in a future release. - */ - @Deprecated - public static boolean containsPlaceholders(String text) - { - return text != null && PLACEHOLDER_PATTERN.matcher(text).find(); - } + /** + * @deprecated Will be removed in a future release. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static Set getRegisteredPlaceholderPlugins() { + return getRegisteredIdentifiers(); + } - /** - * Check if a String contains any PlaceholderAPI bracket placeholders ({@literal {_}}). - * - * @param text String to check - * @return true if String contains any registered placeholder identifiers, false otherwise - * @deprecated Will be removed in a future release. - */ - @Deprecated - public static boolean containsBracketPlaceholders(String text) - { - return text != null && BRACKET_PLACEHOLDER_PATTERN.matcher(text).find(); - } + /** + * @deprecated Will be removed in a future release. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static Set getExternalPlaceholderPlugins() { + return null; + } - /** - * set relational placeholders in the text specified placeholders are matched with the pattern - * %% 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 - * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. - */ - @Deprecated - public static String setRelationalPlaceholders(Player one, Player two, String text) - { - return setRelationalPlaceholders(one, two, text, true); - } + /** + * @deprecated Will be removed in a future release. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static String setPlaceholders(Player player, String text) { + return setPlaceholders(((OfflinePlayer) player), text); + } - /** - * Translate placeholders in the provided List based on the relation of the two provided players. - *
The pattern of a valid placeholder is {@literal %rel__%}. - * - * @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 - * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. - */ - @Deprecated - public static List setRelationalPlaceholders(Player one, Player two, List text) - { - return setRelationalPlaceholders(one, two, text, true); - } + /** + * @deprecated Will be removed in a future release. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static String setPlaceholders(Player player, String text, boolean colorize) { + return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize); + } - /** - * Translate placeholders in the provided list based on the relation of the two provided players. - *
The pattern of a valid placeholder is {@literal %rel__%}. - * - * @param one First player to compare - * @param two Second player to compare - * @param text Text to parse the placeholders in - * @param colorize If color codes (&[0-1a-fk-o]) should be translated - * @return The text containing the parsed relational placeholders - * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static List setRelationalPlaceholders(Player one, Player two, List text, boolean colorize) - { - if (text == null) - { - return null; - } + /** + * @deprecated Will be removed in a future release. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static List setPlaceholders(Player player, List text) { + return setPlaceholders(player, text, PLACEHOLDER_PATTERN, true); + } - return text.stream() - .map(line -> setRelationalPlaceholders(one, two, line, colorize)) - .collect(Collectors.toList()); - } + /** + * @deprecated Will be removed in a future release. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static List setPlaceholders(Player player, List text, boolean colorize) { + return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize); + } - /** - * set relational placeholders in the text specified placeholders are matched with the pattern - * %% when set with this method - * - * @param one Player to compare - * @param two Player to compare - * @param text Text to parse the placeholders in - * @param colorize If color codes (&[0-1a-fk-o]) should be translated - * @return The text containing the parsed relational placeholders - * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. - */ - @Deprecated - @SuppressWarnings("DuplicatedCode") - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static String setRelationalPlaceholders(Player one, Player two, String text, boolean colorize) - { - if (text == null) - { - return null; - } + /** + * @deprecated Will be removed in a future release. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static String setBracketPlaceholders(Player player, String text) { + return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true); + } - if (PlaceholderAPIPlugin.getInstance().getLocalExpansionManager().getExpansionsCount() == 0) - { - return colorize ? Msg.color(text) : text; - } + /** + * @deprecated Will be removed in a future release. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static String setBracketPlaceholders(Player player, String text, boolean colorize) { + return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize); + } - final Matcher matcher = RELATIONAL_PLACEHOLDER_PATTERN.matcher(text); + /** + * @deprecated Will be removed in a future release. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static List setBracketPlaceholders(Player player, List text) { + return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true); + } - 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(); - String params = format.substring(index + 1); - final PlaceholderExpansion expansion = PlaceholderAPIPlugin.getInstance().getLocalExpansionManager().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 colorize ? Msg.color(text) : text; - } - - /** - * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to register placeholders instead - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static boolean registerPlaceholderHook(Plugin plugin, PlaceholderHook placeholderHook) { - throw new UnsupportedOperationException(plugin.getName() + " is attempting to register placeholders via a PlaceholderHook class which is no longer supported!" - + " Please reach out to " + plugin.getDescription().getAuthors().toString() + " and let them know that they need to update ASAP!"); - } - - /** - * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to register placeholders instead - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static boolean registerPlaceholderHook(String identifier, PlaceholderHook placeholderHook) { - throw new UnsupportedOperationException(identifier + " is attempting to register placeholders via a PlaceholderHook class which is no longer supported!"); - } - - - /** - * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to unregister placeholders instead - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static boolean unregisterPlaceholderHook(Plugin plugin) { - throw new UnsupportedOperationException(plugin.getName() + " is attempting to unregister placeholders via the PlaceholderAPI class which is no longer supported!" - + " Please reach out to " + plugin.getDescription().getAuthors().toString() + " and let them know that they need to update ASAP!"); - } - - /** - * @deprecated Please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion} to unregister placeholders instead - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static boolean unregisterPlaceholderHook(String identifier) { - throw new UnsupportedOperationException(identifier + " is attempting to unregister placeholders through the PlaceholderAPI class which is no longer supported!"); - } - - /** - * @deprecated Please use {@link #setPlaceholders(OfflinePlayer, String)} instead - */ - @NotNull - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static String setPlaceholders(@Nullable final OfflinePlayer player, @NotNull final String text, @NotNull final Pattern pattern, final boolean colorize) - { - return setPlaceholders(player, text); - } - - /** - * @deprecated Please use {@link #setPlaceholders(OfflinePlayer, List)} instead - */ - @NotNull - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static List setPlaceholders(@Nullable final OfflinePlayer player, @NotNull final List text, @NotNull final Pattern pattern, final boolean colorize) - { - return setPlaceholders(player, text); - } - - /** - * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static List setBracketPlaceholders(OfflinePlayer player, List text, boolean colorize) - { - return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize); - } - - /** - * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static List setPlaceholders(OfflinePlayer player, List text, boolean colorize) - { - return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize); - } - - /** - * @deprecated Use {@link #setPlaceholders(OfflinePlayer, List)} instead. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static List setPlaceholders(OfflinePlayer player, List text, Pattern pattern) - { - return setPlaceholders(player, text, pattern, true); - } - - - /** - * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static String setBracketPlaceholders(OfflinePlayer player, String text, boolean colorize) - { - return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize); - } - - /** - * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static String setPlaceholders(OfflinePlayer player, String text, boolean colorize) - { - return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize); - } - - /** - * @deprecated Use {@link #setPlaceholders(OfflinePlayer, String)} instead. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static String setPlaceholders(OfflinePlayer player, String text, Pattern pattern) - { - return setPlaceholders(player, text, pattern, true); - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static Pattern getPlaceholderPattern() - { - return PLACEHOLDER_PATTERN; - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static Pattern getBracketPlaceholderPattern() - { - return BRACKET_PLACEHOLDER_PATTERN; - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static Pattern getRelationalPlaceholderPattern() - { - return RELATIONAL_PLACEHOLDER_PATTERN; - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static Set getRegisteredPlaceholderPlugins() - { - return getRegisteredIdentifiers(); - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static Set getExternalPlaceholderPlugins() - { - return null; - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static String setPlaceholders(Player player, String text) - { - return setPlaceholders(((OfflinePlayer) player), text); - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static String setPlaceholders(Player player, String text, boolean colorize) - { - return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize); - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static List setPlaceholders(Player player, List text) - { - return setPlaceholders(player, text, PLACEHOLDER_PATTERN, true); - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static List setPlaceholders(Player player, List text, boolean colorize) - { - return setPlaceholders(player, text, PLACEHOLDER_PATTERN, colorize); - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static String setBracketPlaceholders(Player player, String text) - { - return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true); - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static String setBracketPlaceholders(Player player, String text, boolean colorize) - { - return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize); - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static List setBracketPlaceholders(Player player, List text) - { - return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, true); - } - - /** - * @deprecated Will be removed in a future release. - */ - @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") - public static List setBracketPlaceholders(Player player, List text, boolean colorize) - { - return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize); - } + /** + * @deprecated Will be removed in a future release. + */ + @Deprecated + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") + public static List setBracketPlaceholders(Player player, List text, + boolean colorize) { + return setPlaceholders(player, text, BRACKET_PLACEHOLDER_PATTERN, colorize); + } } diff --git a/src/main/java/me/clip/placeholderapi/PlaceholderHook.java b/src/main/java/me/clip/placeholderapi/PlaceholderHook.java index 5f5c67e..0b045a9 100644 --- a/src/main/java/me/clip/placeholderapi/PlaceholderHook.java +++ b/src/main/java/me/clip/placeholderapi/PlaceholderHook.java @@ -35,11 +35,7 @@ import org.jetbrains.annotations.Nullable; public abstract class PlaceholderHook { - /** - * @deprecated This method will be completely removed, please use {@link me.clip.placeholderapi.expansion.PlaceholderExpansion#onRequest(OfflinePlayer, String)} - */ @Nullable - @Deprecated public String onRequest(@Nullable final OfflinePlayer player, @NotNull final String params) { if (player != null && player.isOnline()) diff --git a/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloud.java b/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloud.java index aa428ce..347f9ba 100644 --- a/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloud.java +++ b/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloud.java @@ -81,6 +81,8 @@ public final class CommandECloud extends PlaceholderCommand Msg.msg(sender, "&b&lPlaceholderAPI &8- &7eCloud Help Menu &8- ", " ", + "&b/papi &fenable/disable/toggle", + " &7&oEnable or disable the eCloud", "&b/papi &fecloud status", " &7&oView status of the eCloud", "&b/papi &fecloud list {page}", @@ -91,6 +93,8 @@ public final class CommandECloud extends PlaceholderCommand " &7&oView placeholders for an expansion", "&b/papi &fecloud download {version}", " &7&oDownload an expansion from the eCloud", + "&b/papi &fecloud update ", + " &7&oUpdate a specific/all installed expansions", "&b/papi &fecloud refresh", " &7&oFetch the most up to date list of expansions available.", "&b/papi &fecloud clear", diff --git a/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudDownload.java b/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudDownload.java index cd54845..543a72a 100644 --- a/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudDownload.java +++ b/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudDownload.java @@ -46,7 +46,7 @@ public final class CommandECloudDownload extends PlaceholderCommand if (params.isEmpty()) { Msg.msg(sender, - "&cYou must supply the name of an eCloud expansion."); + "&cYou must supply the name of an expansion."); return; } @@ -54,7 +54,7 @@ public final class CommandECloudDownload extends PlaceholderCommand if (expansion == null) { Msg.msg(sender, - "&cCould not find expansion named: &f" + params.get(0)); + "&cFailed to find an expansion named: &f" + params.get(0)); return; } @@ -76,7 +76,7 @@ public final class CommandECloudDownload extends PlaceholderCommand { Msg.msg(sender, "&cCould not find specified version: &f" + params.get(1), - "&7Versions: &a" + expansion.getAvailableVersions()); + "&7Available versions: &f" + expansion.getAvailableVersions()); return; } } @@ -85,12 +85,13 @@ public final class CommandECloudDownload extends PlaceholderCommand if (exception != null) { Msg.msg(sender, - "&cFailed to download expansion: &e" + exception.getMessage()); + "&cFailed to download expansion: &f" + exception.getMessage()); return; } Msg.msg(sender, - "&aSuccessfully downloaded expansion to file: &e" + file.getName()); + "&aSuccessfully downloaded expansion &f" + expansion.getName() + " [" + version.getVersion() + "] &ato file: &f" + file.getName(), + "&aMake sure to type &f/papi reload &ato enable your new expansion!"); plugin.getCloudExpansionManager().clean(); plugin.getCloudExpansionManager().fetch(plugin.getPlaceholderAPIConfig().cloudAllowUnverifiedExpansions()); diff --git a/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionInfo.java b/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionInfo.java index a57ca00..1d21d4e 100644 --- a/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionInfo.java +++ b/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionInfo.java @@ -91,7 +91,7 @@ public final class CommandECloudExpansionInfo extends PlaceholderCommand { Msg.msg(sender, "&cCould not find specified version: &f" + params.get(1), - "&7Versions: &a" + expansion.getAvailableVersions()); + "&aVersions: &f" + expansion.getAvailableVersions()); return; } diff --git a/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionList.java b/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionList.java index 3244cb6..373901e 100644 --- a/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionList.java +++ b/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionList.java @@ -30,9 +30,9 @@ import me.clip.placeholderapi.commands.PlaceholderCommand; import me.clip.placeholderapi.configuration.ExpansionSort; import me.clip.placeholderapi.expansion.PlaceholderExpansion; import me.clip.placeholderapi.expansion.cloud.CloudExpansion; +import me.clip.placeholderapi.libs.JSONMessage; import me.clip.placeholderapi.util.Format; import me.clip.placeholderapi.util.Msg; -import me.rayzr522.jsonmessage.JSONMessage; import org.bukkit.ChatColor; import org.bukkit.command.CommandSender; import org.bukkit.entity.Player; @@ -234,7 +234,7 @@ public final class CommandECloudExpansionList extends PlaceholderCommand builder.append("&bInstalled Expansions"); break; default: - builder.append("&bExpansions by &6") + builder.append("&bExpansions by &f") .append(target); break; } diff --git a/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionPlaceholders.java b/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionPlaceholders.java index cdb78d7..e4177b0 100644 --- a/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionPlaceholders.java +++ b/src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudExpansionPlaceholders.java @@ -63,7 +63,7 @@ public final class CommandECloudExpansionPlaceholders extends PlaceholderCommand if (placeholders == null || placeholders.isEmpty()) { Msg.msg(sender, - "&cThat expansion does not have placeholders listed."); + "&cThe expansion specified does not have placeholders listed."); return; } diff --git a/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandDump.java b/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandDump.java index d66a160..9f14b1a 100644 --- a/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandDump.java +++ b/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandDump.java @@ -1,3 +1,23 @@ +/* + * This file is part of PlaceholderAPI + * + * PlaceholderAPI + * Copyright (c) 2015 - 2020 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 . + */ + package me.clip.placeholderapi.commands.impl.local; import com.google.common.io.CharStreams; diff --git a/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandHelp.java b/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandHelp.java index 05aa2bd..c1a56de 100644 --- a/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandHelp.java +++ b/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandHelp.java @@ -47,7 +47,7 @@ public final class CommandHelp extends PlaceholderCommand Msg.msg(sender, "&b&lPlaceholderAPI &8- &7Help Menu &8- &7(&f" + description.getVersion() + "&7)", " ", - "&b/papi", + "&b/papi &fversion", " &7&oView plugin info/version", "&b/papi &freload", " &7&oReload the config of PAPI", @@ -61,12 +61,14 @@ public final class CommandHelp extends PlaceholderCommand " &7&oParse a message with placeholders and broadcast it", "&b/papi &fparserel &9 ", " &7&oParse a message with relational placeholders", + "&b/papi &fcmdparse &9 ", + " &7&oParse a message with relational placeholders", "&b/papi &fregister &9", " &7&oRegister an expansion by the name of the file", "&b/papi &funregister &9", " &7&oUnregister an expansion by name", "&b/papi &fdump", - " &7&oTake a dump and send it to sxtanna or someone else in HelpChat"); + " &7&oDump all relevant information needed to help debug issues into a paste link."); } } diff --git a/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandList.java b/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandList.java index 864d4e3..a2f7bc3 100644 --- a/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandList.java +++ b/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandList.java @@ -48,15 +48,15 @@ public final class CommandList extends PlaceholderCommand final Set identifiers = PlaceholderAPI.getRegisteredIdentifiers(); if (identifiers.isEmpty()) { - Msg.msg(sender, "&6There are no placeholder hooks active!"); + Msg.msg(sender, "&cThere are no placeholder hooks active!"); return; } final List> partitions = Lists.partition(identifiers.stream().sorted().collect(Collectors.toList()), 10); Msg.msg(sender, - "&6" + identifiers.size() + "&7 placeholder hook(s) active: &a", - partitions.stream().map(partition -> " " + String.join(", ", partition)).collect(Collectors.joining("\n"))); + "&7A total of &f" + identifiers.size() + "&7 placeholder hook(s) are active: &a", + partitions.stream().map(partition -> String.join("&7, &a", partition)).collect(Collectors.joining("\n"))); } } diff --git a/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandParse.java b/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandParse.java index e0298fe..2c769df 100644 --- a/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandParse.java +++ b/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandParse.java @@ -155,14 +155,14 @@ public final class CommandParse extends PlaceholderCommand final OfflinePlayer targetOne = resolvePlayer(params.get(0)); if (targetOne == null || !targetOne.isOnline()) { - Msg.msg(sender, "&cFailed to find player: &7" + params.get(0)); + Msg.msg(sender, "&cFailed to find player: &f" + params.get(0)); return; } final OfflinePlayer targetTwo = resolvePlayer(params.get(1)); if (targetTwo == null || !targetTwo.isOnline()) { - Msg.msg(sender, "&cFailed to find player: &7" + params.get(1)); + Msg.msg(sender, "&cFailed to find player: &f" + params.get(1)); return; } diff --git a/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandVersion.java b/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandVersion.java index d7562f2..ce20860 100644 --- a/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandVersion.java +++ b/src/main/java/me/clip/placeholderapi/commands/impl/local/CommandVersion.java @@ -45,10 +45,10 @@ public final class CommandVersion extends PlaceholderCommand final PluginDescriptionFile description = plugin.getDescription(); Msg.msg(sender, - "&b&lPlaceholderAPI &e(&f" + description.getVersion() + "&e)", - "&fAuthors&8: &6" + description.getAuthors(), - "&fPAPI Commands&8: &b/papi &7help", - "&feCloud Commands&8: &b/papi &7ecloud"); + "&b&lPlaceholderAPI &7(&f" + description.getVersion() + "&7)", + "&7Author: &f" + description.getAuthors(), + "&7PAPI Commands: &b/papi &fhelp", + "&7eCloud Commands&8: &b/papi &fecloud"); } } diff --git a/src/main/java/me/clip/placeholderapi/configuration/ExpansionSort.java b/src/main/java/me/clip/placeholderapi/configuration/ExpansionSort.java index b8306d7..dae101d 100644 --- a/src/main/java/me/clip/placeholderapi/configuration/ExpansionSort.java +++ b/src/main/java/me/clip/placeholderapi/configuration/ExpansionSort.java @@ -1,3 +1,23 @@ +/* + * This file is part of PlaceholderAPI + * + * PlaceholderAPI + * Copyright (c) 2015 - 2020 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 . + */ + package me.clip.placeholderapi.configuration; import me.clip.placeholderapi.expansion.cloud.CloudExpansion; diff --git a/src/main/java/me/clip/placeholderapi/expansion/PlaceholderExpansion.java b/src/main/java/me/clip/placeholderapi/expansion/PlaceholderExpansion.java index 8489764..1fd32f6 100644 --- a/src/main/java/me/clip/placeholderapi/expansion/PlaceholderExpansion.java +++ b/src/main/java/me/clip/placeholderapi/expansion/PlaceholderExpansion.java @@ -142,9 +142,7 @@ public abstract class PlaceholderExpansion extends PlaceholderHook * Attempt to register this PlaceholderExpansion * * @return true if this expansion is now registered with PlaceholderAPI - * @deprecated This is going to be final in the future, startup and shutdown logic will have their own methods soon. */ - @Deprecated public boolean register() { return canRegister() && getPlaceholderAPI().getLocalExpansionManager().register(this); @@ -272,7 +270,7 @@ public abstract class PlaceholderExpansion extends PlaceholderHook * @deprecated As of versions greater than 2.8.7, use {@link #getRequiredPlugin()} */ @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.10.8") + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") public String getPlugin() { return null; @@ -282,7 +280,7 @@ public abstract class PlaceholderExpansion extends PlaceholderHook * @deprecated As of versions greater than 2.8.7, use the expansion cloud to show a description */ @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.10.8") + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") public String getDescription() { return null; @@ -292,7 +290,7 @@ public abstract class PlaceholderExpansion extends PlaceholderHook * @deprecated As of versions greater than 2.8.7, use the expansion cloud to display a link */ @Deprecated - @ApiStatus.ScheduledForRemoval(inVersion = "2.10.8") + @ApiStatus.ScheduledForRemoval(inVersion = "2.11.0") public String getLink() { return null; diff --git a/src/main/java/me/clip/placeholderapi/expansion/manager/LocalExpansionManager.java b/src/main/java/me/clip/placeholderapi/expansion/manager/LocalExpansionManager.java index 2781e7f..cec3c90 100644 --- a/src/main/java/me/clip/placeholderapi/expansion/manager/LocalExpansionManager.java +++ b/src/main/java/me/clip/placeholderapi/expansion/manager/LocalExpansionManager.java @@ -167,12 +167,12 @@ public final class LocalExpansionManager implements Listener @ApiStatus.Internal public boolean register(@NotNull final PlaceholderExpansion expansion) { - final String identifier = expansion.getIdentifier(); + final String identifier = expansion.getIdentifier().toLowerCase(); if (expansion instanceof Configurable) { Map defaults = ((Configurable) expansion).getDefaults(); - String pre = "expansions." + expansion.getIdentifier() + "."; + String pre = "expansions." + identifier + "."; FileConfiguration cfg = plugin.getConfig(); boolean save = false; @@ -221,7 +221,7 @@ public final class LocalExpansionManager implements Listener } } - final PlaceholderExpansion removed = expansions.get(expansion.getIdentifier()); + final PlaceholderExpansion removed = expansions.get(identifier); if (removed != null && !removed.unregister()) { return false; @@ -235,7 +235,7 @@ public final class LocalExpansionManager implements Listener return false; } - expansions.put(expansion.getIdentifier(), expansion); + expansions.put(identifier, expansion); if (expansion instanceof Listener) { diff --git a/src/main/java/me/clip/placeholderapi/libs/JSONMessage.java b/src/main/java/me/clip/placeholderapi/libs/JSONMessage.java new file mode 100644 index 0000000..99a2176 --- /dev/null +++ b/src/main/java/me/clip/placeholderapi/libs/JSONMessage.java @@ -0,0 +1,1099 @@ +/* + * Copyright (c) 2018-2020 Peter Blood + * + * 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. + */ + +package me.clip.placeholderapi.libs; +import com.google.common.base.Strings; +import com.google.common.collect.BiMap; +import com.google.common.collect.ImmutableBiMap; +import com.google.gson.JsonArray; +import com.google.gson.JsonElement; +import com.google.gson.JsonObject; +import com.google.gson.JsonPrimitive; + +import org.bukkit.Bukkit; +import org.bukkit.ChatColor; +import org.bukkit.entity.Player; + +import java.lang.invoke.MethodHandle; +import java.lang.invoke.MethodHandles; +import java.lang.reflect.Constructor; +import java.lang.reflect.Field; +import java.lang.reflect.Method; +import java.util.ArrayList; +import java.util.List; +import java.util.Objects; +import java.util.UUID; +import java.util.Vector; + +/** + * This is a complete JSON message builder class. To create a new JSONMessage do + * {@link #create(String)} + * + * @author Rayzr + */ +@SuppressWarnings({"WeakerAccess", "unused"}) +public class JSONMessage { + private static final BiMap stylesToNames; + + static { + ImmutableBiMap.Builder builder = ImmutableBiMap.builder(); + for (final ChatColor style : ChatColor.values()) { + if (!style.isFormat()) { + continue; + } + + String styleName; + switch (style) { + case MAGIC: + styleName = "obfuscated"; + break; + case UNDERLINE: + styleName = "underlined"; + break; + default: + styleName = style.name().toLowerCase(); + break; + } + + builder.put(style, styleName); + } + stylesToNames = builder.build(); + } + + + private final List parts = new ArrayList<>(); + private int centeringStartIndex = -1; + + /** + * Creates a new {@link JSONMessage} object + * + * @param text The text to start with + */ + private JSONMessage(String text) { + parts.add(new MessagePart(text)); + } + + /** + * Creates a new {@link JSONMessage} object + * + * @param text The text to start with + * @return A new {@link JSONMessage} object + */ + public static JSONMessage create(String text) { + return new JSONMessage(text); + } + + /** + * Creates a new {@link JSONMessage} object + * + * @return A new {@link JSONMessage} object + */ + public static JSONMessage create() { + return create(""); + } + + /** + * Sends an action bar message + * + * @param message The message to send + * @param players The players you want to send it to + */ + public static void actionbar(String message, Player... players) { + ReflectionHelper.sendPacket(ReflectionHelper.createActionbarPacket(ChatColor.translateAlternateColorCodes('&', message)), players); + } + + /** + * @return The latest {@link MessagePart} + * @throws ArrayIndexOutOfBoundsException If {@code parts.size() <= 0}. + */ + public MessagePart last() { + if (parts.size() <= 0) { + throw new ArrayIndexOutOfBoundsException("No MessageParts exist!"); + } + return parts.get(parts.size() - 1); + } + + /** + * Converts this {@link JSONMessage} instance to actual JSON + * + * @return The JSON representation of this {@link JSONMessage} + */ + public JsonObject toJSON() { + JsonObject obj = new JsonObject(); + + obj.addProperty("text", ""); + + JsonArray array = new JsonArray(); + + parts.stream() + .map(MessagePart::toJSON) + .forEach(array::add); + + obj.add("extra", array); + + return obj; + } + + /** + * Converts this {@link JSONMessage} object to a String representation of the JSON. + * This is an alias of {@code toJSON().toString()}. + */ + @Override + public String toString() { + return toJSON().toString(); + } + + /** + * Converts this {@link JSONMessage} object to the legacy formatting system, which + * uses formatting codes (like &6, &l, &4, etc.) + * + * @return This {@link JSONMessage} instance {@link JSONMessage} in legacy format + */ + public String toLegacy() { + StringBuilder output = new StringBuilder(); + + parts.stream() + .map(MessagePart::toLegacy) + .forEach(output::append); + + return output.toString(); + } + + /** + * Sends this {@link JSONMessage} to all the players specified + * + * @param players The players you want to send this to + */ + public void send(Player... players) { + if (ReflectionHelper.MAJOR_VER >= 16) { +// ReflectionHelper.sendTextPacket(toString(), players); +// return; + } + + ReflectionHelper.sendPacket(ReflectionHelper.createTextPacket(toString()), players); + } + + /** + * Sends this as a title to all the players specified + * + * @param fadeIn How many ticks to fade in + * @param stay How many ticks to stay + * @param fadeOut How many ticks to fade out + * @param players The players to send this to + */ + public void title(int fadeIn, int stay, int fadeOut, Player... players) { + ReflectionHelper.sendPacket(ReflectionHelper.createTitleTimesPacket(fadeIn, stay, fadeOut), players); + ReflectionHelper.sendPacket(ReflectionHelper.createTitlePacket(toString()), players); + } + + /** + * Sends this as a subtitle to all the players specified. Must be used after sending a {@link #title(int, int, int, Player...) title}. + * + * @param players The players to send this to + */ + public void subtitle(Player... players) { + ReflectionHelper.sendPacket(ReflectionHelper.createSubtitlePacket(toString()), players); + } + + /** + * Sends an action bar message + * + * @param players The players you want to send this to + */ + public void actionbar(Player... players) { + actionbar(toLegacy(), players); + } + + /** + * Sets the color of the current message part. + * + * @param color The color to set + * @return This {@link JSONMessage} instance + */ + public JSONMessage color(ChatColor color) { + if (!color.isColor()) + throw new IllegalArgumentException(color.name() + " is not a color."); + + last().setColor(color); + return this; + } + + /** + * Sets the color of the current message part. + *
If the provided color is a hex color ({@code #rrggbb}) but the major version of MC is older than 1.16 will this + * default to the color WHITE. + * + * @param color The color to set + * @return This {@link JSONMessage} instance + */ + public JSONMessage color(String color) { + return color(color, ChatColor.WHITE); + } + + /** + * Sets the color of the current message part. + *
If the provided color is a hex color ({@code #rrggbb}) but the major version of MC is older than 1.16 will the provided + * default ChatColor be used instead. + * + * @param color The color to set + * @param def The default ChatColor to use, when MC version is older than 1.16 + * @return This {@link JSONMessage} instance + */ + public JSONMessage color(String color, ChatColor def) { + if (color.startsWith("#") && ReflectionHelper.MAJOR_VER < 16) + return color(def); + + last().setColor(color); + return this; + } + + /** + * Sets the font of the current message part. + *
When this is used on versions older than 1.16 will this do nothing. + * + * @param font The font to set + * @return This {@link JSONMessage} instance + */ + public JSONMessage font(String font) { + if (ReflectionHelper.MAJOR_VER < 16) + return this; + + last().setFont(font); + return this; + } + + /** + * Adds a style to the current message part. + * + * @param style The style to add + * @return This {@link JSONMessage} instance + */ + public JSONMessage style(ChatColor style) { + last().addStyle(style); + return this; + } + + /** + * Makes the text run a command. + * + * @param command The command to run + * @return This {@link JSONMessage} instance + */ + public JSONMessage runCommand(String command) { + last().setOnClick(ClickEvent.runCommand(command)); + return this; + } + + /** + * Makes the text suggest a command. + * + * @param command The command to suggest + * @return This {@link JSONMessage} instance + */ + public JSONMessage suggestCommand(String command) { + last().setOnClick(ClickEvent.suggestCommand(command)); + return this; + } + + /** + * Opens a URL. + * + * @param url The url to open + * @return This {@link JSONMessage} instance + */ + public JSONMessage openURL(String url) { + last().setOnClick(ClickEvent.openURL(url)); + return this; + } + + /** + * Copies the provided text to the Clipboard of the player. + *
When this is used on versions older than 1.15 will this default to {@link #suggestCommand(String) suggestCommand(String)}. + * + * @param text The text to copy + * @return This {@link JSONMessage} instance + */ + public JSONMessage copyText(String text) { + last().setOnClick(ClickEvent.copyText(text)); + return this; + } + + /** + * Changes the page of a book. Using this in a non-book context is useless + * and will probably error. + * + * @param page The page to change to + * @return This {@link JSONMessage} instance + */ + public JSONMessage changePage(int page) { + last().setOnClick(ClickEvent.changePage(page)); + return this; + } + + /** + * Shows text when you hover over it + * + * @param text The text to show + * @return This {@link JSONMessage} instance + */ + public JSONMessage tooltip(String text) { + last().setOnHover(HoverEvent.showText(text)); + return this; + } + + /** + * Shows text when you hover over it + * + * @param message The text to show + * @return This {@link JSONMessage} instance + */ + public JSONMessage tooltip(JSONMessage message) { + last().setOnHover(HoverEvent.showText(message)); + return this; + } + + /** + * Shows an achievement when you hover over it + * + * @param id The id of the achievement + * @return This {@link JSONMessage} instance + */ + public JSONMessage achievement(String id) { + last().setOnHover(HoverEvent.showAchievement(id)); + return this; + } + + /** + * Adds another part to this {@link JSONMessage} + * + * @param text The text to start the next {@link MessagePart} with + * @return This {@link JSONMessage} instance + */ + public JSONMessage then(String text) { + return then(new MessagePart(text)); + } + + /** + * Adds another part to this {@link JSONMessage} + * + * @param nextPart The next {@link MessagePart} + * @return This {@link JSONMessage} instance + */ + public JSONMessage then(MessagePart nextPart) { + parts.add(nextPart); + return this; + } + + /** + * Adds a horizontal bar to the message of the given length + * + * @param length The length of the horizontal bar + * @return This {@link JSONMessage} instance + */ + public JSONMessage bar(int length) { + return then(Strings.repeat("-", length)).color(ChatColor.DARK_GRAY).style(ChatColor.STRIKETHROUGH); + } + + /** + * Adds a horizontal bar to the message that's 53 characters long. This is + * the default width of the player's chat window. + * + * @return This {@link JSONMessage} instance + */ + public JSONMessage bar() { + return bar(53); + } + + /** + * Adds a blank line to the message + * + * @return This {@link JSONMessage} instance + */ + public JSONMessage newline() { + return then("\n"); + } + + /** + * Sets the starting point to begin centering JSONMessages. + * + * @return This {@link JSONMessage} instance + */ + public JSONMessage beginCenter() { + // Start with the NEXT message part. + centeringStartIndex = parts.size(); + return this; + } + + /** + * Ends the centering of the JSONMessage text. + * + * @return This {@link JSONMessage} instance + */ + public JSONMessage endCenter() { + int current = centeringStartIndex; + + while (current < parts.size()) { + Vector currentLine = new Vector<>(); + int totalLineLength = 0; + + for (; ; current++) { + MessagePart part = current < parts.size() ? parts.get(current) : null; + String raw = part == null ? null : ChatColor.stripColor(part.toLegacy()); + int rawLength = raw == null ? 0 : raw.length(); + + if (current >= parts.size() || totalLineLength + rawLength >= 53) { + int padding = Math.max(0, (53 - totalLineLength) / 2); + currentLine.firstElement().setText(Strings.repeat(" ", padding) + currentLine.firstElement().getText()); + currentLine.lastElement().setText(currentLine.lastElement().getText() + "\n"); + currentLine.clear(); + break; + } + + totalLineLength += rawLength; + currentLine.add(part); + } + } + + MessagePart last = parts.get(parts.size() - 1); + last.setText(last.getText().substring(0, last.getText().length() - 1)); + + centeringStartIndex = -1; + + return this; + } + + /////////////////////////// + // BEGIN UTILITY CLASSES // + /////////////////////////// + + /** + * Represents the JSON format that all click/hover events in JSON messages must follow. + *
+ *
+ * Reference + * + * @author Rayzr + */ + public static class MessageEvent { + + private String action; + private Object value; + + public MessageEvent(String action, Object value) { + this.action = action; + this.value = value; + } + + /** + * @return A {@link JsonObject} representing the properties of this {@link MessageEvent} + */ + public JsonObject toJSON() { + JsonObject obj = new JsonObject(); + obj.addProperty("action", action); + /* + * MC 1.16 changed "value" to "contents", but only for Hover events... Don't ask why. + * Since this lib only has tooltip and achievement can we simply check if action starts with "show_" + */ + String valueType = (ReflectionHelper.MAJOR_VER >= 16 && action.startsWith("show_")) ? "contents" : "value"; + + if (value instanceof JsonElement) { + obj.add(valueType, (JsonElement) value); + } else { + obj.addProperty(valueType, value.toString()); + } + return obj; + } + + /** + * @return The action + */ + public String getAction() { + return action; + } + + /** + * @param action The action to set + */ + public void setAction(String action) { + this.action = action; + } + + /** + * @return The value + */ + public Object getValue() { + return value; + } + + /** + * @param value The value to set + */ + public void setValue(Object value) { + this.value = value; + } + + } + + public static class ClickEvent { + + /** + * Runs a command. + * + * @param command The command to run + * @return The {@link MessageEvent} + */ + public static MessageEvent runCommand(String command) { + return new MessageEvent("run_command", command); + } + + /** + * Suggests a command by inserting it in chat. + * + * @param command The command to suggest + * @return The {@link MessageEvent} + */ + public static MessageEvent suggestCommand(String command) { + return new MessageEvent("suggest_command", command); + } + + /** + * Requires web links to be enabled on the client. + * + * @param url The url to open + * @return The {@link MessageEvent} + */ + public static MessageEvent openURL(String url) { + return new MessageEvent("open_url", url); + } + + /** + * Only used with written books. + * + * @param page The page to switch to + * @return The {@link MessageEvent} + */ + public static MessageEvent changePage(int page) { + return new MessageEvent("change_page", page); + } + + /** + * Copies the provided text to the clipboard of the player. + *
When used on versions older than 1.15 will this {@link #suggestCommand(String) suggest the text} instead. + * + * @param text The text to copy. + * @return The {@link MessageEvent} + */ + public static MessageEvent copyText(String text) { + if (ReflectionHelper.MAJOR_VER < 15) + return suggestCommand(text); + + return new MessageEvent("copy_to_clipboard", text); + } + + } + + public static class HoverEvent { + + /** + * Shows text when you hover over it + * + * @param text The text to show + * @return The {@link MessageEvent} + */ + public static MessageEvent showText(String text) { + return new MessageEvent("show_text", text); + } + + /** + * Shows text when you hover over it + * + * @param message The {@link JSONMessage} to show + * @return The {@link MessageEvent} + */ + public static MessageEvent showText(JSONMessage message) { + JsonArray arr = new JsonArray(); + arr.add(new JsonPrimitive("")); + arr.add(message.toJSON()); + return new MessageEvent("show_text", arr); + } + + /** + * Shows an achievement when you hover over it + * + * @param id The id of the achievement + * @return The {@link MessageEvent} + */ + public static MessageEvent showAchievement(String id) { + return new MessageEvent("show_achievement", id); + } + + } + + private static class ReflectionHelper { + + private static final String version; + private static Constructor chatComponentText; + + private static Class packetPlayOutChat; + private static Field packetPlayOutChatComponent; + private static Field packetPlayOutChatMessageType; + private static Field packetPlayOutChatUuid; + private static Object enumChatMessageTypeMessage; + private static Object enumChatMessageTypeActionbar; + + private static Constructor titlePacketConstructor; + private static Constructor titleTimesPacketConstructor; + private static Object enumActionTitle; + private static Object enumActionSubtitle; + + private static Field connection; + private static MethodHandle GET_HANDLE; + private static MethodHandle SEND_PACKET; + private static MethodHandle STRING_TO_CHAT; + private static boolean SETUP; + private static int MAJOR_VER = -1; + + static { + String[] split = Bukkit.getServer().getClass().getPackage().getName().split("\\."); + version = split[split.length - 1]; + + try { + MAJOR_VER = Integer.parseInt(version.split("_")[1]); + + final Class craftPlayer = getClass("{obc}.entity.CraftPlayer"); + Method getHandle = craftPlayer.getMethod("getHandle"); + connection = getHandle.getReturnType().getField("playerConnection"); + Method sendPacket = connection.getType().getMethod("sendPacket", getClass("{nms}.Packet")); + + chatComponentText = getClass("{nms}.ChatComponentText").getConstructor(String.class); + + final Class iChatBaseComponent = getClass("{nms}.IChatBaseComponent"); + + Method stringToChat; + + if (MAJOR_VER < 8) { + stringToChat = getClass("{nms}.ChatSerializer").getMethod("a", String.class); + } else { + stringToChat = getClass("{nms}.IChatBaseComponent$ChatSerializer").getMethod("a", String.class); + } + + GET_HANDLE = MethodHandles.lookup().unreflect(getHandle); + SEND_PACKET = MethodHandles.lookup().unreflect(sendPacket); + STRING_TO_CHAT = MethodHandles.lookup().unreflect(stringToChat); + + packetPlayOutChat = getClass("{nms}.PacketPlayOutChat"); + packetPlayOutChatComponent = getField(packetPlayOutChat, "a"); + packetPlayOutChatMessageType = getField(packetPlayOutChat, "b"); + packetPlayOutChatUuid = MAJOR_VER >= 16 ? getField(packetPlayOutChat, "c") : null; + + Class packetPlayOutTitle = getClass("{nms}.PacketPlayOutTitle"); + Class titleAction = getClass("{nms}.PacketPlayOutTitle$EnumTitleAction"); + + titlePacketConstructor = packetPlayOutTitle.getConstructor(titleAction, iChatBaseComponent); + titleTimesPacketConstructor = packetPlayOutTitle.getConstructor(int.class, int.class, int.class); + + enumActionTitle = titleAction.getField("TITLE").get(null); + enumActionSubtitle = titleAction.getField("SUBTITLE").get(null); + + if (MAJOR_VER >= 12) { + Method getChatMessageType = getClass("{nms}.ChatMessageType").getMethod("a", byte.class); + + enumChatMessageTypeMessage = getChatMessageType.invoke(null, (byte) 1); + enumChatMessageTypeActionbar = getChatMessageType.invoke(null, (byte) 2); + } + + SETUP = true; + } catch (Exception e) { + e.printStackTrace(); + SETUP = false; + } + } + + static void sendPacket(Object packet, Player... players) { + assertIsSetup(); + + if (packet == null) { + return; + } + + for (Player player : players) { + try { + SEND_PACKET.bindTo(connection.get(GET_HANDLE.bindTo(player).invoke())).invoke(packet); + } catch (Throwable e) { + System.err.println("Failed to send packet"); + e.printStackTrace(); + } + } + + } + + static Object createActionbarPacket(String message) { + assertIsSetup(); + + Object packet = createTextPacket(message); + setType(packet, (byte) 2); + return packet; + } + + static Object createTextPacket(String message) { + assertIsSetup(); + + try { + Object packet = packetPlayOutChat.newInstance(); + setFieldValue(packetPlayOutChatComponent, packet, fromJson(message)); + setFieldValue(packetPlayOutChatUuid, packet, UUID.randomUUID()); + setType(packet, (byte) 1); + return packet; + } catch (Exception e) { + e.printStackTrace(); + return null; + } + } + + static Object createTitlePacket(String message) { + assertIsSetup(); + + try { + return titlePacketConstructor.newInstance(enumActionTitle, fromJson(message)); + } catch (Exception e) { + e.printStackTrace(); + return null; + } + } + + static Object createTitleTimesPacket(int fadeIn, int stay, int fadeOut) { + assertIsSetup(); + + try { + return titleTimesPacketConstructor.newInstance(fadeIn, stay, fadeOut); + } catch (Exception e) { + e.printStackTrace(); + return null; + } + } + + static Object createSubtitlePacket(String message) { + assertIsSetup(); + + try { + return titlePacketConstructor.newInstance(enumActionSubtitle, fromJson(message)); + } catch (Exception e) { + e.printStackTrace(); + return null; + } + } + + private static void setType(Object chatPacket, byte type) { + assertIsSetup(); + + if (MAJOR_VER < 12) { + setFieldValue(packetPlayOutChatMessageType, chatPacket, type); + return; + } + + switch (type) { + case 1: + setFieldValue(packetPlayOutChatMessageType, chatPacket, enumChatMessageTypeMessage); + break; + case 2: + setFieldValue(packetPlayOutChatMessageType, chatPacket, enumChatMessageTypeActionbar); + break; + default: + throw new IllegalArgumentException("type must be 1 or 2"); + } + } + + /** + * Creates a ChatComponentText from plain text + * + * @param message The text to convert to a chat component + * @return The chat component + */ + static Object componentText(String message) { + assertIsSetup(); + + try { + return chatComponentText.newInstance(message); + } catch (Exception e) { + e.printStackTrace(); + return null; + } + + } + + /** + * Attempts to convert a String representing a JSON message into a usable object + * + * @param json The JSON to attempt to parse + * @return The object representing the text in JSON form, or null if something went wrong converting the String to JSON data + */ + static Object fromJson(String json) { + assertIsSetup(); + + if (!json.trim().startsWith("{")) { + return componentText(json); + } + + try { + return STRING_TO_CHAT.invoke(json); + } catch (Throwable e) { + e.printStackTrace(); + return null; + } + } + + private static void assertIsSetup() { + if (!SETUP) { + throw new IllegalStateException("JSONMessage.ReflectionHelper is not set up yet!"); + } + } + + private static Class getClass(String path) throws ClassNotFoundException { + return Class.forName(path.replace("{nms}", "net.minecraft.server." + version).replace("{obc}", "org.bukkit.craftbukkit." + version)); + } + + private static void setFieldValue(Field field, Object instance, Object value) { + if (field == null) { + // useful for fields that might not exist + return; + } + + try { + field.set(instance, value); + } catch (IllegalAccessException e) { + e.printStackTrace(); + } + } + + private static Field getField(Class classObject, String fieldName) { + try { + Field field = classObject.getDeclaredField(fieldName); + field.setAccessible(true); + return field; + } catch (NoSuchFieldException e) { + e.printStackTrace(); + return null; + } + } + + private static int getVersion() { + return MAJOR_VER; + } + } + + /** + * Defines a section of the message, and represents the format that all JSON messages must follow in Minecraft. + *
+ *
+ * Reference + * + * @author Rayzr + */ + public static class MessagePart { + + private final List styles = new ArrayList<>(); + private MessageEvent onClick; + private MessageEvent onHover; + private String color; + private ChatColor legacyColor; + private String font; + private String text; + + public MessagePart(String text) { + this.text = text == null ? "null" : text; + } + + /** + * Converts this {@link MessagePart} into a {@link JsonObject} + * + * @return The Minecraft-compatible {@link JsonObject} + */ + public JsonObject toJSON() { + Objects.requireNonNull(text); + + JsonObject obj = new JsonObject(); + obj.addProperty("text", text); + + if (color != null && !color.isEmpty()) { + obj.addProperty("color", color.toLowerCase()); + } + + for (ChatColor style : styles) { + obj.addProperty(stylesToNames.get(style), true); + } + + if (onClick != null) { + obj.add("clickEvent", onClick.toJSON()); + } + + if (onHover != null) { + obj.add("hoverEvent", onHover.toJSON()); + } + + if (font != null) { + obj.addProperty("font", font); + } + + return obj; + + } + + /** + * @return This {@link MessagePart} in legacy-style color/formatting codes + */ + public String toLegacy() { + StringBuilder output = new StringBuilder(); + ChatColor legacyColor = getColor(); + + if (legacyColor != null) { + output.append(legacyColor); + } + + styles.stream() + .map(ChatColor::toString) + .forEach(output::append); + + return output.append(text).toString(); + } + + /** + * @return The click event bound + */ + public MessageEvent getOnClick() { + return onClick; + } + + /** + * @param onClick The new click event to bind + */ + public void setOnClick(MessageEvent onClick) { + this.onClick = onClick; + } + + /** + * @return The hover event bound + */ + public MessageEvent getOnHover() { + return onHover; + } + + /** + * @param onHover The new hover event to bind + */ + public void setOnHover(MessageEvent onHover) { + this.onHover = onHover; + } + + /** + * @return The color + */ + public String getColorValue() { + return color; + } + + /** + * @return The color + * @deprecated Use {@link #getColorValue()} instead + */ + @Deprecated + public ChatColor getColor() { + if (legacyColor != null) { + return legacyColor; + } + + if (this.color.startsWith("#") && ReflectionHelper.MAJOR_VER < 16) + throw new IllegalStateException("Custom Hex colors can only be used in Minecraft 1.16 or newer!"); + + try { + return ChatColor.valueOf(this.color.toUpperCase()); + } catch (Exception ex) { + return null; + } + } + + /** + * @param color The color to set + * @deprecated Use {@link #setColor(String)} instead + */ + @Deprecated + public void setColor(ChatColor color) { + setColor(color == null ? null : color.name().toLowerCase()); + setLegacyColor(color); + } + + /** + * @param color The legacy ChatColor to set + * @deprecated Use {@link #setColor(String)} instead + */ + @Deprecated + public void setLegacyColor(ChatColor color) { + legacyColor = color; + } + + /** + * @param color The color to set + */ + public void setColor(String color) { + if (color != null && color.isEmpty()) { + throw new IllegalArgumentException("Color cannot be null!"); + } + this.color = color; + } + + /** + * @return The list of styles + */ + public List getStyles() { + return styles; + } + + /** + * @param style The new style to add + */ + public void addStyle(ChatColor style) { + if (style == null) { + throw new IllegalArgumentException("Style cannot be null!"); + } + if (!style.isFormat()) { + throw new IllegalArgumentException(style.name() + " is not a style!"); + } + styles.add(style); + } + + /** + * @return The font used + */ + public String getFont() { + return font; + } + + /** + * @param font The font to use + */ + public void setFont(String font) { + this.font = font; + } + + /** + * @return The raw text + */ + public String getText() { + return text; + } + + /** + * @param text The raw text to set + */ + public void setText(String text) { + this.text = text; + } + + } +} \ No newline at end of file diff --git a/src/main/java/me/clip/placeholderapi/replacer/CharsReplacer.java b/src/main/java/me/clip/placeholderapi/replacer/CharsReplacer.java index 5b2c2a4..13a5ca2 100644 --- a/src/main/java/me/clip/placeholderapi/replacer/CharsReplacer.java +++ b/src/main/java/me/clip/placeholderapi/replacer/CharsReplacer.java @@ -144,7 +144,7 @@ public final class CharsReplacer implements Replacer } } - final String identifierString = identifier.toString(); + final String identifierString = identifier.toString().toLowerCase(); final String parametersString = parameters.toString(); identifier.setLength(0); diff --git a/src/main/java/me/clip/placeholderapi/util/Futures.java b/src/main/java/me/clip/placeholderapi/util/Futures.java index d689b56..8b431bb 100644 --- a/src/main/java/me/clip/placeholderapi/util/Futures.java +++ b/src/main/java/me/clip/placeholderapi/util/Futures.java @@ -1,3 +1,23 @@ +/* + * This file is part of PlaceholderAPI + * + * PlaceholderAPI + * Copyright (c) 2015 - 2020 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 . + */ + package me.clip.placeholderapi.util; import org.bukkit.Bukkit; diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index 9420f1d..01e038b 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,4 +1,681 @@ -name: "@name@" +# +# GNU GENERAL PUBLIC LICENSE +# Version 3, 29 June 2007 +# +# Copyright (C) 2007 Free Software Foundation, Inc. +# Everyone is permitted to copy and distribute verbatim copies +# of this license document, but changing it is not allowed. +# +# Preamble +# +# The GNU General Public License is a free, copyleft license for +# software and other kinds of works. +# +# The licenses for most software and other practical works are designed +# to take away your freedom to share and change the works. By contrast, +# the GNU General Public License is intended to guarantee your freedom to +# share and change all versions of a program--to make sure it remains free +# software for all its users. We, the Free Software Foundation, use the +# GNU General Public License for most of our software; it applies also to +# any other work released this way by its authors. You can apply it to +# your programs, too. +# +# When we speak of free software, we are referring to freedom, not +# price. Our General Public Licenses are designed to make sure that you +# have the freedom to distribute copies of free software (and charge for +# them if you wish), that you receive source code or can get it if you +# want it, that you can change the software or use pieces of it in new +# free programs, and that you know you can do these things. +# +# To protect your rights, we need to prevent others from denying you +# these rights or asking you to surrender the rights. Therefore, you have +# certain responsibilities if you distribute copies of the software, or if +# you modify it: responsibilities to respect the freedom of others. +# +# For example, if you distribute copies of such a program, whether +# gratis or for a fee, you must pass on to the recipients the same +# freedoms that you received. You must make sure that they, too, receive +# or can get the source code. And you must show them these terms so they +# know their rights. +# +# Developers that use the GNU GPL protect your rights with two steps: +# (1) assert copyright on the software, and (2) offer you this License +# giving you legal permission to copy, distribute and/or modify it. +# +# For the developers' and authors' protection, the GPL clearly explains +# that there is no warranty for this free software. For both users' and +# authors' sake, the GPL requires that modified versions be marked as +# changed, so that their problems will not be attributed erroneously to +# authors of previous versions. +# +# Some devices are designed to deny users access to install or run +# modified versions of the software inside them, although the manufacturer +# can do so. This is fundamentally incompatible with the aim of +# protecting users' freedom to change the software. The systematic +# pattern of such abuse occurs in the area of products for individuals to +# use, which is precisely where it is most unacceptable. Therefore, we +# have designed this version of the GPL to prohibit the practice for those +# products. If such problems arise substantially in other domains, we +# stand ready to extend this provision to those domains in future versions +# of the GPL, as needed to protect the freedom of users. +# +# Finally, every program is threatened constantly by software patents. +# States should not allow patents to restrict development and use of +# software on general-purpose computers, but in those that do, we wish to +# avoid the special danger that patents applied to a free program could +# make it effectively proprietary. To prevent this, the GPL assures that +# patents cannot be used to render the program non-free. +# +# The precise terms and conditions for copying, distribution and +# modification follow. +# +# TERMS AND CONDITIONS +# +# 0. Definitions. +# +# "This License" refers to version 3 of the GNU General Public License. +# +# "Copyright" also means copyright-like laws that apply to other kinds of +# works, such as semiconductor masks. +# +# "The Program" refers to any copyrightable work licensed under this +# License. Each licensee is addressed as "you". "Licensees" and +# "recipients" may be individuals or organizations. +# +# To "modify" a work means to copy from or adapt all or part of the work +# in a fashion requiring copyright permission, other than the making of an +# exact copy. The resulting work is called a "modified version" of the +# earlier work or a work "based on" the earlier work. +# +# A "covered work" means either the unmodified Program or a work based +# on the Program. +# +# To "propagate" a work means to do anything with it that, without +# permission, would make you directly or secondarily liable for +# infringement under applicable copyright law, except executing it on a +# computer or modifying a private copy. Propagation includes copying, +# distribution (with or without modification), making available to the +# public, and in some countries other activities as well. +# +# To "convey" a work means any kind of propagation that enables other +# parties to make or receive copies. Mere interaction with a user through +# a computer network, with no transfer of a copy, is not conveying. +# +# An interactive user interface displays "Appropriate Legal Notices" +# to the extent that it includes a convenient and prominently visible +# feature that (1) displays an appropriate copyright notice, and (2) +# tells the user that there is no warranty for the work (except to the +# extent that warranties are provided), that licensees may convey the +# work under this License, and how to view a copy of this License. If +# the interface presents a list of user commands or options, such as a +# menu, a prominent item in the list meets this criterion. +# +# 1. Source Code. +# +# The "source code" for a work means the preferred form of the work +# for making modifications to it. "Object code" means any non-source +# form of a work. +# +# A "Standard Interface" means an interface that either is an official +# standard defined by a recognized standards body, or, in the case of +# interfaces specified for a particular programming language, one that +# is widely used among developers working in that language. +# +# The "System Libraries" of an executable work include anything, other +# than the work as a whole, that (a) is included in the normal form of +# packaging a Major Component, but which is not part of that Major +# Component, and (b) serves only to enable use of the work with that +# Major Component, or to implement a Standard Interface for which an +# implementation is available to the public in source code form. A +# "Major Component", in this context, means a major essential component +# (kernel, window system, and so on) of the specific operating system +# (if any) on which the executable work runs, or a compiler used to +# produce the work, or an object code interpreter used to run it. +# +# The "Corresponding Source" for a work in object code form means all +# the source code needed to generate, install, and (for an executable +# work) run the object code and to modify the work, including scripts to +# control those activities. However, it does not include the work's +# System Libraries, or general-purpose tools or generally available free +# programs which are used unmodified in performing those activities but +# which are not part of the work. For example, Corresponding Source +# includes interface definition files associated with source files for +# the work, and the source code for shared libraries and dynamically +# linked subprograms that the work is specifically designed to require, +# such as by intimate data communication or control flow between those +# subprograms and other parts of the work. +# +# The Corresponding Source need not include anything that users +# can regenerate automatically from other parts of the Corresponding +# Source. +# +# The Corresponding Source for a work in source code form is that +# same work. +# +# 2. Basic Permissions. +# +# All rights granted under this License are granted for the term of +# copyright on the Program, and are irrevocable provided the stated +# conditions are met. This License explicitly affirms your unlimited +# permission to run the unmodified Program. The output from running a +# covered work is covered by this License only if the output, given its +# content, constitutes a covered work. This License acknowledges your +# rights of fair use or other equivalent, as provided by copyright law. +# +# You may make, run and propagate covered works that you do not +# convey, without conditions so long as your license otherwise remains +# in force. You may convey covered works to others for the sole purpose +# of having them make modifications exclusively for you, or provide you +# with facilities for running those works, provided that you comply with +# the terms of this License in conveying all material for which you do +# not control copyright. Those thus making or running the covered works +# for you must do so exclusively on your behalf, under your direction +# and control, on terms that prohibit them from making any copies of +# your copyrighted material outside their relationship with you. +# +# Conveying under any other circumstances is permitted solely under +# the conditions stated below. Sublicensing is not allowed; section 10 +# makes it unnecessary. +# +# 3. Protecting Users' Legal Rights From Anti-Circumvention Law. +# +# No covered work shall be deemed part of an effective technological +# measure under any applicable law fulfilling obligations under article +# 11 of the WIPO copyright treaty adopted on 20 December 1996, or +# similar laws prohibiting or restricting circumvention of such +# measures. +# +# When you convey a covered work, you waive any legal power to forbid +# circumvention of technological measures to the extent such circumvention +# is effected by exercising rights under this License with respect to +# the covered work, and you disclaim any intention to limit operation or +# modification of the work as a means of enforcing, against the work's +# users, your or third parties' legal rights to forbid circumvention of +# technological measures. +# +# 4. Conveying Verbatim Copies. +# +# You may convey verbatim copies of the Program's source code as you +# receive it, in any medium, provided that you conspicuously and +# appropriately publish on each copy an appropriate copyright notice; +# keep intact all notices stating that this License and any +# non-permissive terms added in accord with section 7 apply to the code; +# keep intact all notices of the absence of any warranty; and give all +# recipients a copy of this License along with the Program. +# +# You may charge any price or no price for each copy that you convey, +# and you may offer support or warranty protection for a fee. +# +# 5. Conveying Modified Source Versions. +# +# You may convey a work based on the Program, or the modifications to +# produce it from the Program, in the form of source code under the +# terms of section 4, provided that you also meet all of these conditions: +# +# a) The work must carry prominent notices stating that you modified +# it, and giving a relevant date. +# +# b) The work must carry prominent notices stating that it is +# released under this License and any conditions added under section +# 7. This requirement modifies the requirement in section 4 to +# "keep intact all notices". +# +# c) You must license the entire work, as a whole, under this +# License to anyone who comes into possession of a copy. This +# License will therefore apply, along with any applicable section 7 +# additional terms, to the whole of the work, and all its parts, +# regardless of how they are packaged. This License gives no +# permission to license the work in any other way, but it does not +# invalidate such permission if you have separately received it. +# +# d) If the work has interactive user interfaces, each must display +# Appropriate Legal Notices; however, if the Program has interactive +# interfaces that do not display Appropriate Legal Notices, your +# work need not make them do so. +# +# A compilation of a covered work with other separate and independent +# works, which are not by their nature extensions of the covered work, +# and which are not combined with it such as to form a larger program, +# in or on a volume of a storage or distribution medium, is called an +# "aggregate" if the compilation and its resulting copyright are not +# used to limit the access or legal rights of the compilation's users +# beyond what the individual works permit. Inclusion of a covered work +# in an aggregate does not cause this License to apply to the other +# parts of the aggregate. +# +# 6. Conveying Non-Source Forms. +# +# You may convey a covered work in object code form under the terms +# of sections 4 and 5, provided that you also convey the +# machine-readable Corresponding Source under the terms of this License, +# in one of these ways: +# +# a) Convey the object code in, or embodied in, a physical product +# (including a physical distribution medium), accompanied by the +# Corresponding Source fixed on a durable physical medium +# customarily used for software interchange. +# +# b) Convey the object code in, or embodied in, a physical product +# (including a physical distribution medium), accompanied by a +# written offer, valid for at least three years and valid for as +# long as you offer spare parts or customer support for that product +# model, to give anyone who possesses the object code either (1) a +# copy of the Corresponding Source for all the software in the +# product that is covered by this License, on a durable physical +# medium customarily used for software interchange, for a price no +# more than your reasonable cost of physically performing this +# conveying of source, or (2) access to copy the +# Corresponding Source from a network server at no charge. +# +# c) Convey individual copies of the object code with a copy of the +# written offer to provide the Corresponding Source. This +# alternative is allowed only occasionally and noncommercially, and +# only if you received the object code with such an offer, in accord +# with subsection 6b. +# +# d) Convey the object code by offering access from a designated +# place (gratis or for a charge), and offer equivalent access to the +# Corresponding Source in the same way through the same place at no +# further charge. You need not require recipients to copy the +# Corresponding Source along with the object code. If the place to +# copy the object code is a network server, the Corresponding Source +# may be on a different server (operated by you or a third party) +# that supports equivalent copying facilities, provided you maintain +# clear directions next to the object code saying where to find the +# Corresponding Source. Regardless of what server hosts the +# Corresponding Source, you remain obligated to ensure that it is +# available for as long as needed to satisfy these requirements. +# +# e) Convey the object code using peer-to-peer transmission, provided +# you inform other peers where the object code and Corresponding +# Source of the work are being offered to the general public at no +# charge under subsection 6d. +# +# A separable portion of the object code, whose source code is excluded +# from the Corresponding Source as a System Library, need not be +# included in conveying the object code work. +# +# A "User Product" is either (1) a "consumer product", which means any +# tangible personal property which is normally used for personal, family, +# or household purposes, or (2) anything designed or sold for incorporation +# into a dwelling. In determining whether a product is a consumer product, +# doubtful cases shall be resolved in favor of coverage. For a particular +# product received by a particular user, "normally used" refers to a +# typical or common use of that class of product, regardless of the status +# of the particular user or of the way in which the particular user +# actually uses, or expects or is expected to use, the product. A product +# is a consumer product regardless of whether the product has substantial +# commercial, industrial or non-consumer uses, unless such uses represent +# the only significant mode of use of the product. +# +# "Installation Information" for a User Product means any methods, +# procedures, authorization keys, or other information required to install +# and execute modified versions of a covered work in that User Product from +# a modified version of its Corresponding Source. The information must +# suffice to ensure that the continued functioning of the modified object +# code is in no case prevented or interfered with solely because +# modification has been made. +# +# If you convey an object code work under this section in, or with, or +# specifically for use in, a User Product, and the conveying occurs as +# part of a transaction in which the right of possession and use of the +# User Product is transferred to the recipient in perpetuity or for a +# fixed term (regardless of how the transaction is characterized), the +# Corresponding Source conveyed under this section must be accompanied +# by the Installation Information. But this requirement does not apply +# if neither you nor any third party retains the ability to install +# modified object code on the User Product (for example, the work has +# been installed in ROM). +# +# The requirement to provide Installation Information does not include a +# requirement to continue to provide support service, warranty, or updates +# for a work that has been modified or installed by the recipient, or for +# the User Product in which it has been modified or installed. Access to a +# network may be denied when the modification itself materially and +# adversely affects the operation of the network or violates the rules and +# protocols for communication across the network. +# +# Corresponding Source conveyed, and Installation Information provided, +# in accord with this section must be in a format that is publicly +# documented (and with an implementation available to the public in +# source code form), and must require no special password or key for +# unpacking, reading or copying. +# +# 7. Additional Terms. +# +# "Additional permissions" are terms that supplement the terms of this +# License by making exceptions from one or more of its conditions. +# Additional permissions that are applicable to the entire Program shall +# be treated as though they were included in this License, to the extent +# that they are valid under applicable law. If additional permissions +# apply only to part of the Program, that part may be used separately +# under those permissions, but the entire Program remains governed by +# this License without regard to the additional permissions. +# +# When you convey a copy of a covered work, you may at your option +# remove any additional permissions from that copy, or from any part of +# it. (Additional permissions may be written to require their own +# removal in certain cases when you modify the work.) You may place +# additional permissions on material, added by you to a covered work, +# for which you have or can give appropriate copyright permission. +# +# Notwithstanding any other provision of this License, for material you +# add to a covered work, you may (if authorized by the copyright holders of +# that material) supplement the terms of this License with terms: +# +# a) Disclaiming warranty or limiting liability differently from the +# terms of sections 15 and 16 of this License; or +# +# b) Requiring preservation of specified reasonable legal notices or +# author attributions in that material or in the Appropriate Legal +# Notices displayed by works containing it; or +# +# c) Prohibiting misrepresentation of the origin of that material, or +# requiring that modified versions of such material be marked in +# reasonable ways as different from the original version; or +# +# d) Limiting the use for publicity purposes of names of licensors or +# authors of the material; or +# +# e) Declining to grant rights under trademark law for use of some +# trade names, trademarks, or service marks; or +# +# f) Requiring indemnification of licensors and authors of that +# material by anyone who conveys the material (or modified versions of +# it) with contractual assumptions of liability to the recipient, for +# any liability that these contractual assumptions directly impose on +# those licensors and authors. +# +# All other non-permissive additional terms are considered "further +# restrictions" within the meaning of section 10. If the Program as you +# received it, or any part of it, contains a notice stating that it is +# governed by this License along with a term that is a further +# restriction, you may remove that term. If a license document contains +# a further restriction but permits relicensing or conveying under this +# License, you may add to a covered work material governed by the terms +# of that license document, provided that the further restriction does +# not survive such relicensing or conveying. +# +# If you add terms to a covered work in accord with this section, you +# must place, in the relevant source files, a statement of the +# additional terms that apply to those files, or a notice indicating +# where to find the applicable terms. +# +# Additional terms, permissive or non-permissive, may be stated in the +# form of a separately written license, or stated as exceptions; +# the above requirements apply either way. +# +# 8. Termination. +# +# You may not propagate or modify a covered work except as expressly +# provided under this License. Any attempt otherwise to propagate or +# modify it is void, and will automatically terminate your rights under +# this License (including any patent licenses granted under the third +# paragraph of section 11). +# +# However, if you cease all violation of this License, then your +# license from a particular copyright holder is reinstated (a) +# provisionally, unless and until the copyright holder explicitly and +# finally terminates your license, and (b) permanently, if the copyright +# holder fails to notify you of the violation by some reasonable means +# prior to 60 days after the cessation. +# +# Moreover, your license from a particular copyright holder is +# reinstated permanently if the copyright holder notifies you of the +# violation by some reasonable means, this is the first time you have +# received notice of violation of this License (for any work) from that +# copyright holder, and you cure the violation prior to 30 days after +# your receipt of the notice. +# +# Termination of your rights under this section does not terminate the +# licenses of parties who have received copies or rights from you under +# this License. If your rights have been terminated and not permanently +# reinstated, you do not qualify to receive new licenses for the same +# material under section 10. +# +# 9. Acceptance Not Required for Having Copies. +# +# You are not required to accept this License in order to receive or +# run a copy of the Program. Ancillary propagation of a covered work +# occurring solely as a consequence of using peer-to-peer transmission +# to receive a copy likewise does not require acceptance. However, +# nothing other than this License grants you permission to propagate or +# modify any covered work. These actions infringe copyright if you do +# not accept this License. Therefore, by modifying or propagating a +# covered work, you indicate your acceptance of this License to do so. +# +# 10. Automatic Licensing of Downstream Recipients. +# +# Each time you convey a covered work, the recipient automatically +# receives a license from the original licensors, to run, modify and +# propagate that work, subject to this License. You are not responsible +# for enforcing compliance by third parties with this License. +# +# An "entity transaction" is a transaction transferring control of an +# organization, or substantially all assets of one, or subdividing an +# organization, or merging organizations. If propagation of a covered +# work results from an entity transaction, each party to that +# transaction who receives a copy of the work also receives whatever +# licenses to the work the party's predecessor in interest had or could +# give under the previous paragraph, plus a right to possession of the +# Corresponding Source of the work from the predecessor in interest, if +# the predecessor has it or can get it with reasonable efforts. +# +# You may not impose any further restrictions on the exercise of the +# rights granted or affirmed under this License. For example, you may +# not impose a license fee, royalty, or other charge for exercise of +# rights granted under this License, and you may not initiate litigation +# (including a cross-claim or counterclaim in a lawsuit) alleging that +# any patent claim is infringed by making, using, selling, offering for +# sale, or importing the Program or any portion of it. +# +# 11. Patents. +# +# A "contributor" is a copyright holder who authorizes use under this +# License of the Program or a work on which the Program is based. The +# work thus licensed is called the contributor's "contributor version". +# +# A contributor's "essential patent claims" are all patent claims +# owned or controlled by the contributor, whether already acquired or +# hereafter acquired, that would be infringed by some manner, permitted +# by this License, of making, using, or selling its contributor version, +# but do not include claims that would be infringed only as a +# consequence of further modification of the contributor version. For +# purposes of this definition, "control" includes the right to grant +# patent sublicenses in a manner consistent with the requirements of +# this License. +# +# Each contributor grants you a non-exclusive, worldwide, royalty-free +# patent license under the contributor's essential patent claims, to +# make, use, sell, offer for sale, import and otherwise run, modify and +# propagate the contents of its contributor version. +# +# In the following three paragraphs, a "patent license" is any express +# agreement or commitment, however denominated, not to enforce a patent +# (such as an express permission to practice a patent or covenant not to +# sue for patent infringement). To "grant" such a patent license to a +# party means to make such an agreement or commitment not to enforce a +# patent against the party. +# +# If you convey a covered work, knowingly relying on a patent license, +# and the Corresponding Source of the work is not available for anyone +# to copy, free of charge and under the terms of this License, through a +# publicly available network server or other readily accessible means, +# then you must either (1) cause the Corresponding Source to be so +# available, or (2) arrange to deprive yourself of the benefit of the +# patent license for this particular work, or (3) arrange, in a manner +# consistent with the requirements of this License, to extend the patent +# license to downstream recipients. "Knowingly relying" means you have +# actual knowledge that, but for the patent license, your conveying the +# covered work in a country, or your recipient's use of the covered work +# in a country, would infringe one or more identifiable patents in that +# country that you have reason to believe are valid. +# +# If, pursuant to or in connection with a single transaction or +# arrangement, you convey, or propagate by procuring conveyance of, a +# covered work, and grant a patent license to some of the parties +# receiving the covered work authorizing them to use, propagate, modify +# or convey a specific copy of the covered work, then the patent license +# you grant is automatically extended to all recipients of the covered +# work and works based on it. +# +# A patent license is "discriminatory" if it does not include within +# the scope of its coverage, prohibits the exercise of, or is +# conditioned on the non-exercise of one or more of the rights that are +# specifically granted under this License. You may not convey a covered +# work if you are a party to an arrangement with a third party that is +# in the business of distributing software, under which you make payment +# to the third party based on the extent of your activity of conveying +# the work, and under which the third party grants, to any of the +# parties who would receive the covered work from you, a discriminatory +# patent license (a) in connection with copies of the covered work +# conveyed by you (or copies made from those copies), or (b) primarily +# for and in connection with specific products or compilations that +# contain the covered work, unless you entered into that arrangement, +# or that patent license was granted, prior to 28 March 2007. +# +# Nothing in this License shall be construed as excluding or limiting +# any implied license or other defenses to infringement that may +# otherwise be available to you under applicable patent law. +# +# 12. No Surrender of Others' Freedom. +# +# If conditions are imposed on you (whether by court order, agreement or +# otherwise) that contradict the conditions of this License, they do not +# excuse you from the conditions of this License. If you cannot convey a +# covered work so as to satisfy simultaneously your obligations under this +# License and any other pertinent obligations, then as a consequence you may +# not convey it at all. For example, if you agree to terms that obligate you +# to collect a royalty for further conveying from those to whom you convey +# the Program, the only way you could satisfy both those terms and this +# License would be to refrain entirely from conveying the Program. +# +# 13. Use with the GNU Affero General Public License. +# +# Notwithstanding any other provision of this License, you have +# permission to link or combine any covered work with a work licensed +# under version 3 of the GNU Affero General Public License into a single +# combined work, and to convey the resulting work. The terms of this +# License will continue to apply to the part which is the covered work, +# but the special requirements of the GNU Affero General Public License, +# section 13, concerning interaction through a network will apply to the +# combination as such. +# +# 14. Revised Versions of this License. +# +# The Free Software Foundation may publish revised and/or new versions of +# the GNU General Public License from time to time. Such new versions will +# be similar in spirit to the present version, but may differ in detail to +# address new problems or concerns. +# +# Each version is given a distinguishing version number. If the +# Program specifies that a certain numbered version of the GNU General +# Public License "or any later version" applies to it, you have the +# option of following the terms and conditions either of that numbered +# version or of any later version published by the Free Software +# Foundation. If the Program does not specify a version number of the +# GNU General Public License, you may choose any version ever published +# by the Free Software Foundation. +# +# If the Program specifies that a proxy can decide which future +# versions of the GNU General Public License can be used, that proxy's +# public statement of acceptance of a version permanently authorizes you +# to choose that version for the Program. +# +# Later license versions may give you additional or different +# permissions. However, no additional obligations are imposed on any +# author or copyright holder as a result of your choosing to follow a +# later version. +# +# 15. Disclaimer of Warranty. +# +# THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +# APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +# HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +# OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +# THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +# PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +# IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +# ALL NECESSARY SERVICING, REPAIR OR CORRECTION. +# +# 16. Limitation of Liability. +# +# IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +# WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +# THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +# GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +# USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +# DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +# PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +# EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +# SUCH DAMAGES. +# +# 17. Interpretation of Sections 15 and 16. +# +# If the disclaimer of warranty and limitation of liability provided +# above cannot be given local legal effect according to their terms, +# reviewing courts shall apply local law that most closely approximates +# an absolute waiver of all civil liability in connection with the +# Program, unless a warranty or assumption of liability accompanies a +# copy of the Program in return for a fee. +# +# END OF TERMS AND CONDITIONS +# +# How to Apply These Terms to Your New Programs +# +# If you develop a new program, and you want it to be of the greatest +# possible use to the public, the best way to achieve this is to make it +# free software which everyone can redistribute and change under these terms. +# +# To do so, attach the following notices to the program. It is safest +# to attach them to the start of each source file to most effectively +# state the exclusion of warranty; and each file should have at least +# the "copyright" line and a pointer to where the full notice is found. +# +# +# Copyright (C) +# +# This program is 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. +# +# This program 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 . +# +# Also add information on how to contact you by electronic and paper mail. +# +# If the program does terminal interaction, make it output a short +# notice like this when it starts in an interactive mode: +# +# Copyright (C) +# This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. +# This is free software, and you are welcome to redistribute it +# under certain conditions; type `show c' for details. +# +# The hypothetical commands `show w' and `show c' should show the appropriate +# parts of the General Public License. Of course, your program's commands +# might be different; for a GUI interface, you would use an "about box". +# +# You should also get your employer (if you work as a programmer) or school, +# if any, to sign a "copyright disclaimer" for the program, if necessary. +# For more information on this, and how to apply and follow the GNU GPL, see +# . +# +# The GNU General Public License does not permit incorporating your program +# into proprietary programs. If your program is a subroutine library, you +# may consider it more useful to permit linking proprietary applications with +# the library. If this is what you want to do, use the GNU Lesser General +# Public License instead of this License. But first, please read +# . +# + +name: "PlaceholderAPI" main: "me.clip.placeholderapi.PlaceholderAPIPlugin" version: "@version@" diff --git a/src/test/java/me/clip/placeholderapi/replacer/ReplacerUnitTester.java b/src/test/java/me/clip/placeholderapi/replacer/ReplacerUnitTester.java index 71fae9b..6dffa48 100644 --- a/src/test/java/me/clip/placeholderapi/replacer/ReplacerUnitTester.java +++ b/src/test/java/me/clip/placeholderapi/replacer/ReplacerUnitTester.java @@ -87,7 +87,7 @@ public final class ReplacerUnitTester @Test void testCharsReplacerHandlesEscapedHex() { - final String text = "\\&xFFFFFFThis should not change."; + final String text = "\\&xffffffThis should not change."; assertEquals(text.substring(1), Values.CHARS_REPLACER.apply(text, null, Values.PLACEHOLDERS::get)); }