Added EmailChangedEvent (#1549)

* Added EmailChangedEvent

* Fix failing tests

Silly.

* Documented the EmailChangedEvent

* Separate messages for cancelled email event

* Added lang todos for all the languages I can't speak

I wish I could though.

* Checkstyle satisfaction

* Changed log level to info for cancelled events

src/main/java/fr/xephi/authme/data/VerificationCodeManager.java

@@ -162,7 +162,7 @@ public class VerificationCodeManager implements SettingsDependent, HasCleanup {
      *
      * @param name the name of the player to generate a code for
      */
-    public void verify(String name){
+    public void verify(String name) {
         verifiedPlayers.add(name.toLowerCase());
     }
 

src/main/java/fr/xephi/authme/events/EmailChangedEvent.java

@@ -0,0 +1,87 @@
+package fr.xephi.authme.events;
+
+import org.bukkit.entity.Player;
+import org.bukkit.event.Cancellable;
+import org.bukkit.event.Event;
+import org.bukkit.event.HandlerList;
+
+import javax.annotation.Nullable;
+
+/**
+ * This event is called when a player adds or changes his email address.
+ */
+public class EmailChangedEvent extends CustomEvent implements Cancellable {
+    private static final HandlerList handlers = new HandlerList();
+    private final Player player;
+    private final String oldEmail;
+    private final String newEmail;
+    private boolean isCancelled;
+
+    /**
+     * Constructor
+     *
+     * @param player The player that changed email
+     * @param oldEmail Old email player had on file. Can be null when user adds an email
+     * @param newEmail New email that player tries to set. In case of adding email, this will contain
+     *                the email is trying to set.
+     * @param isAsync should this event be called asynchronously?
+     */
+    public EmailChangedEvent(Player player, @Nullable String oldEmail, String newEmail, boolean isAsync) {
+        super(isAsync);
+        this.player = player;
+        this.oldEmail = oldEmail;
+        this.newEmail = newEmail;
+    }
+
+    @Override
+    public boolean isCancelled() {
+        return isCancelled;
+    }
+
+    /**
+     * Gets the player who changes the email
+     *
+     * @return The player who changed the email
+     */
+    public Player getPlayer() {
+        return player;
+    }
+
+    /**
+     * Gets the old email in case user tries to change existing email.
+     *
+     * @return old email stored on file. Can be null when user never had an email and adds a new one.
+     */
+    public @Nullable String getOldEmail() {
+        return this.oldEmail;
+    }
+
+    /**
+     * Gets the new email.
+     *
+     * @return the email user is trying to set. If user adds email and never had one before,
+     *        this is where such email can be found.
+     */
+    public String getNewEmail() {
+        return this.newEmail;
+    }
+
+    @Override
+    public void setCancelled(boolean cancelled) {
+        this.isCancelled = cancelled;
+    }
+
+    @Override
+    public HandlerList getHandlers() {
+        return handlers;
+    }
+
+    /**
+     * Return the list of handlers, equivalent to {@link #getHandlers()} and required by {@link Event}.
+     *
+     * @return The list of handlers
+     */
+    public static HandlerList getHandlerList() {
+        return handlers;
+    }
+}

src/main/java/fr/xephi/authme/message/MessageKey.java

@@ -167,12 +167,18 @@ public enum MessageKey {
     /** Email address successfully added to your account! */
     EMAIL_ADDED_SUCCESS("email.added"),
 
+    /** Adding email was not allowed */
+    EMAIL_ADD_NOT_ALLOWED("email.add_not_allowed"),
+
     /** Please confirm your email address! */
     CONFIRM_EMAIL_MESSAGE("email.request_confirmation"),
 
     /** Email address changed correctly! */
     EMAIL_CHANGED_SUCCESS("email.changed"),
 
+    /** Changing email was not allowed */
+    EMAIL_CHANGE_NOT_ALLOWED("email.change_not_allowed"),
+
     /** Your current email address is: %email */
     EMAIL_SHOW("email.email_show", "%email"),
 

src/main/java/fr/xephi/authme/process/email/AsyncAddEmail.java

@@ -4,8 +4,10 @@ import fr.xephi.authme.ConsoleLogger;
 import fr.xephi.authme.data.auth.PlayerAuth;
 import fr.xephi.authme.data.auth.PlayerCache;
 import fr.xephi.authme.datasource.DataSource;
+import fr.xephi.authme.events.EmailChangedEvent;
 import fr.xephi.authme.message.MessageKey;
 import fr.xephi.authme.process.AsynchronousProcess;
+import fr.xephi.authme.service.BukkitService;
 import fr.xephi.authme.service.CommonService;
 import fr.xephi.authme.service.ValidationService;
 import fr.xephi.authme.service.bungeecord.BungeeSender;
@@ -35,6 +37,9 @@ public class AsyncAddEmail implements AsynchronousProcess {
     @Inject
     private BungeeSender bungeeSender;
 
+    @Inject
+    private BukkitService bukkitService;
+
     AsyncAddEmail() { }
 
     /**
@@ -57,6 +62,13 @@ public class AsyncAddEmail implements AsynchronousProcess {
             } else if (!validationService.isEmailFreeForRegistration(email, player)) {
                 service.send(player, MessageKey.EMAIL_ALREADY_USED_ERROR);
             } else {
+                EmailChangedEvent event = bukkitService.createAndCallEvent(isAsync
+                    -> new EmailChangedEvent(player, null, email, isAsync));
+                if (event.isCancelled()) {
+                    ConsoleLogger.info("Could not add email to player '" + player + "' – event was cancelled");
+                    service.send(player, MessageKey.EMAIL_ADD_NOT_ALLOWED);
+                    return;
+                }
                 auth.setEmail(email);
                 if (dataSource.updateEmail(auth)) {
                     playerCache.updatePlayer(auth);

src/main/java/fr/xephi/authme/process/email/AsyncChangeEmail.java

@@ -1,10 +1,13 @@
 package fr.xephi.authme.process.email;
 
+import fr.xephi.authme.ConsoleLogger;
 import fr.xephi.authme.data.auth.PlayerAuth;
 import fr.xephi.authme.data.auth.PlayerCache;
 import fr.xephi.authme.datasource.DataSource;
+import fr.xephi.authme.events.EmailChangedEvent;
 import fr.xephi.authme.message.MessageKey;
 import fr.xephi.authme.process.AsynchronousProcess;
+import fr.xephi.authme.service.BukkitService;
 import fr.xephi.authme.service.CommonService;
 import fr.xephi.authme.service.ValidationService;
 import fr.xephi.authme.service.bungeecord.BungeeSender;
@@ -32,6 +35,9 @@ public class AsyncChangeEmail implements AsynchronousProcess {
 
     @Inject
     private BungeeSender bungeeSender;
+    
+    @Inject
+    private BukkitService bukkitService;
 
     AsyncChangeEmail() { }
 
@@ -57,14 +63,22 @@ public class AsyncChangeEmail implements AsynchronousProcess {
             } else if (!validationService.isEmailFreeForRegistration(newEmail, player)) {
                 service.send(player, MessageKey.EMAIL_ALREADY_USED_ERROR);
             } else {
-                saveNewEmail(auth, player, newEmail);
+                saveNewEmail(auth, player, oldEmail, newEmail);
             }
         } else {
             outputUnloggedMessage(player);
         }
     }
 
-    private void saveNewEmail(PlayerAuth auth, Player player, String newEmail) {
+    private void saveNewEmail(PlayerAuth auth, Player player, String oldEmail, String newEmail) {
+        EmailChangedEvent event = bukkitService.createAndCallEvent(isAsync
+            -> new EmailChangedEvent(player, oldEmail, newEmail, isAsync));
+        if (event.isCancelled()) {
+            ConsoleLogger.info("Could not change email for player '" + player + "' – event was cancelled");
+            service.send(player, MessageKey.EMAIL_CHANGE_NOT_ALLOWED);
+            return;
+        }
+
         auth.setEmail(newEmail);
         if (dataSource.updateEmail(auth)) {
             playerCache.updatePlayer(auth);