102 lines
3.0 KiB
Java
102 lines
3.0 KiB
Java
/*
|
|
* 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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
package fr.neatmonster.nocheatplus.checks.chat;
|
|
|
|
import org.bukkit.entity.Player;
|
|
|
|
import fr.neatmonster.nocheatplus.players.IPlayerData;
|
|
|
|
/**
|
|
* Captcha related operations.<br>
|
|
* Auxiliary interface, most methods should need sync over data, unless stated otherwise.
|
|
* @author mc_dev
|
|
*
|
|
*/
|
|
public interface ICaptcha {
|
|
|
|
/**
|
|
* Check if the captcha has been entered correctly.
|
|
* Reset if correct, otherwise increase tries and execute actions if necessary.
|
|
* @param player
|
|
* @param message
|
|
* @param cc
|
|
* @param data
|
|
* @param isMainThread
|
|
*/
|
|
public void checkCaptcha(Player player, String message, ChatConfig cc, ChatData data, boolean isMainThread);
|
|
|
|
/**
|
|
* Just send the current captcha to the player.
|
|
* @param player
|
|
* @param cc
|
|
* @param data
|
|
*/
|
|
public void sendCaptcha(Player player, ChatConfig cc, ChatData data);
|
|
|
|
/**
|
|
* Generate a new captcha and send to the player.
|
|
* @param player
|
|
* @param cc
|
|
* @param data
|
|
*/
|
|
public void sendNewCaptcha(Player player, ChatConfig cc, ChatData data);
|
|
|
|
/**
|
|
* Check if checkCaptcha should be called.
|
|
*
|
|
* @param player
|
|
* @param cc
|
|
* @param data
|
|
* @param pData
|
|
* @return
|
|
*/
|
|
public boolean shouldCheckCaptcha(Player player, ChatConfig cc, ChatData data, IPlayerData pData);
|
|
|
|
/**
|
|
* Check if captcha should be generated and send to the player.
|
|
*
|
|
* @param player
|
|
* @param cc
|
|
* @param data
|
|
* @param pData
|
|
* @return
|
|
*/
|
|
public boolean shouldStartCaptcha(Player player, ChatConfig cc, ChatData data, IPlayerData pData);
|
|
|
|
/**
|
|
* Just resets tries, generate new captcha if necessary.
|
|
*
|
|
* @param player
|
|
* @param cc
|
|
* @param data
|
|
* @param pData
|
|
*/
|
|
public void resetCaptcha(Player player, ChatConfig cc, ChatData data, IPlayerData pData);
|
|
|
|
/**
|
|
* Convenience method. Should synchronize over data of player (!).
|
|
* @param player
|
|
*/
|
|
public void resetCaptcha(Player player);
|
|
|
|
/**
|
|
* Generate a captcha.
|
|
* @param cc
|
|
* @param data
|
|
* @param reset If to reset tries.
|
|
*/
|
|
public void generateCaptcha(ChatConfig cc, ChatData data, boolean reset);
|
|
}
|