Add SETNAME support

Author: mbax

src/main/java/org/kitteh/irc/client/library/command/SetNameCommand.java

@@ -0,0 +1,76 @@
+/*
+ * * Copyright (C) 2013-2021 Matt Baxter https://kitteh.org
+ *
+ * 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 org.kitteh.irc.client.library.command;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.kitteh.irc.client.library.Client;
+import org.kitteh.irc.client.library.feature.CapabilityManager;
+import org.kitteh.irc.client.library.util.Sanity;
+import org.kitteh.irc.client.library.util.ToStringer;
+
+/**
+ * Sends a SETNAME request to the server.
+ */
+public class SetNameCommand extends Command<SetNameCommand> {
+    private String newName;
+
+    /**
+     * Constructs the command.
+     *
+     * @param client the client
+     * @throws IllegalArgumentException if client is null
+     */
+    public SetNameCommand(@NonNull Client client) {
+        super(client);
+    }
+
+    /**
+     * Sets the new name.
+     *
+     * @param newName new name
+     * @return this command
+     * @throws IllegalArgumentException for invalid message
+     */
+    public @NonNull SetNameCommand newName(@Nullable String newName) {
+        this.newName = (newName == null) ? null : Sanity.safeMessageCheck(newName);
+        return this;
+    }
+
+    @Override
+    public void execute() {
+        if (this.newName == null) {
+            throw new IllegalStateException("New name not specified");
+        }
+        if (!this.getClient().getCapabilityManager().getCapability(CapabilityManager.Defaults.SETNAME).isPresent()) {
+            throw new IllegalStateException("Cannot send SETNAME when the capability is not negotiated");
+        }
+        this.sendCommandLine("SETNAME :" + this.newName);
+    }
+
+    @Override
+    protected @NonNull ToStringer toStringer() {
+        return super.toStringer().add("newName", this.newName);
+    }
+}

src/main/java/org/kitteh/irc/client/library/defaults/feature/DefaultActorTracker.java

@@ -679,6 +679,14 @@ public void trackUserNickChange(@NonNull String oldNick, @NonNull String newNick
         this.trackedChannels.values().forEach(channel -> channel.trackUserNick(oldNick, newNick));
     }
 
+    @Override
+    public void trackUserRealnameChange(@NonNull String nick, @NonNull String newRealname) {
+        IrcUser u = this.trackedUsers.get(nick);
+        if (u != null) {
+            u.setRealName(newRealname);
+        }
+    }
+
     @Override
     public void trackUserPart(@NonNull String channel, @NonNull String nick) {
         IrcChannel ch = this.trackedChannels.get(channel);

src/main/java/org/kitteh/irc/client/library/defaults/listener/DefaultListeners.java

@@ -177,6 +177,12 @@ public enum DefaultListeners implements EventListenerSupplier {
      * @see DefaultQuitListener
      */
     QUIT(DefaultQuitListener::new),
+    /**
+     * SETNAME handling.
+     *
+     * @see DefaultSetNameListener
+     */
+    SETNAME(DefaultSetNameListener::new),
     /**
      * Standard Reply (FAIL, NOTE, WARN) handling.
      */

src/main/java/org/kitteh/irc/client/library/defaults/listener/DefaultSetNameListener.java

@@ -0,0 +1,76 @@
+/*
+ * * Copyright (C) 2013-2021 Matt Baxter https://kitteh.org
+ *
+ * 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 org.kitteh.irc.client.library.defaults.listener;
+
+import net.engio.mbassy.listener.Handler;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.kitteh.irc.client.library.Client;
+import org.kitteh.irc.client.library.element.User;
+import org.kitteh.irc.client.library.event.client.ClientReceiveCommandEvent;
+import org.kitteh.irc.client.library.event.user.UserRealnameChangeEvent;
+import org.kitteh.irc.client.library.feature.filter.CommandFilter;
+
+import java.util.Optional;
+
+/**
+ * Default SETNAME listener, producing events using default classes.
+ */
+public class DefaultSetNameListener extends AbstractDefaultListenerBase {
+    /**
+     * Constructs the listener.
+     *
+     * @param client client
+     */
+    public DefaultSetNameListener(Client.@NonNull WithManagement client) {
+        super(client);
+    }
+
+    @CommandFilter("SETNAME")
+    @Handler(priority = Integer.MAX_VALUE - 1)
+    public void setname(ClientReceiveCommandEvent event) {
+        if (event.getParameters().size() != 1) {
+            this.trackException(event, "Invalid number of parameters for SETNAME message");
+            return;
+        }
+
+        if (!(event.getActor() instanceof User)) {
+            this.trackException(event, "Invalid actor for SETNAME message");
+            return;
+        }
+
+        User user = (User) event.getActor();
+        Optional<User> optUser = this.getTracker().getTrackedUser(user.getNick());
+
+        if (!optUser.isPresent()) {
+            this.trackException(event, "Null old user for nick");
+            return;
+        }
+
+        User oldUser = optUser.get();
+
+        String newRealName = event.getParameters().get(0);
+        this.getTracker().trackUserRealnameChange(user.getNick(), newRealName);
+        this.fire(new UserRealnameChangeEvent(this.getClient(), event.getSource(), oldUser, this.getTracker().getTrackedUser(user.getNick()).get()));
+    }
+}

src/main/java/org/kitteh/irc/client/library/event/client/FailEvent.java

@@ -1,3 +1,26 @@
+/*
+ * * Copyright (C) 2013-2021 Matt Baxter https://kitteh.org
+ *
+ * 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 org.kitteh.irc.client.library.event.client;
 
 import org.checkerframework.checker.nullness.qual.NonNull;

src/main/java/org/kitteh/irc/client/library/event/client/NoteEvent.java

@@ -1,3 +1,26 @@
+/*
+ * * Copyright (C) 2013-2021 Matt Baxter https://kitteh.org
+ *
+ * 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 org.kitteh.irc.client.library.event.client;
 
 import org.checkerframework.checker.nullness.qual.NonNull;

src/main/java/org/kitteh/irc/client/library/event/client/StandardReplyEvent.java

@@ -1,3 +1,26 @@
+/*
+ * * Copyright (C) 2013-2021 Matt Baxter https://kitteh.org
+ *
+ * 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 org.kitteh.irc.client.library.event.client;
 
 import org.checkerframework.checker.nullness.qual.NonNull;

src/main/java/org/kitteh/irc/client/library/event/client/WarnEvent.java

@@ -1,3 +1,26 @@
+/*
+ * * Copyright (C) 2013-2021 Matt Baxter https://kitteh.org
+ *
+ * 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 org.kitteh.irc.client.library.event.client;
 
 import org.checkerframework.checker.nullness.qual.NonNull;

src/main/java/org/kitteh/irc/client/library/event/user/UserRealnameChangeEvent.java

@@ -0,0 +1,47 @@
+/*
+ * * Copyright (C) 2013-2021 Matt Baxter https://kitteh.org
+ *
+ * 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 org.kitteh.irc.client.library.event.user;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.kitteh.irc.client.library.Client;
+import org.kitteh.irc.client.library.element.ServerMessage;
+import org.kitteh.irc.client.library.element.User;
+import org.kitteh.irc.client.library.event.abstractbase.UserInfoChangeEventBase;
+
+/**
+ * A {@link User} has changed realname.
+ */
+public class UserRealnameChangeEvent extends UserInfoChangeEventBase<String> {
+    /**
+     * Creates the event.
+     *
+     * @param client client for which this is occurring
+     * @param sourceMessage source message
+     * @param oldUser user changing realname
+     * @param newUser the new user realname
+     */
+    public UserRealnameChangeEvent(@NonNull Client client, @NonNull ServerMessage sourceMessage, @NonNull User oldUser, @NonNull User newUser) {
+        super(client, sourceMessage, oldUser, newUser, user -> user.getRealName().orElse(""));
+    }
+}

src/main/java/org/kitteh/irc/client/library/feature/ActorTracker.java

@@ -257,6 +257,14 @@ public interface ActorTracker extends Resettable {
      */
     void trackUserNickChange(@NonNull String oldNick, @NonNull String newNick);
 
+    /**
+     * Tracks a user's realname changing.
+     *
+     * @param nick nick
+     * @param newRealname new realname
+     */
+    void trackUserRealnameChange(@NonNull String nick, @NonNull String newRealname);
+
     /**
      * Tracks a user parting a channel, potentially untracking them overall
      * if they are no longer in any tracked channel.