Labeled messages

Author: mbax

src/main/java/org/kitteh/irc/client/library/defaults/element/messagetag/DefaultMessageTagLabel.java

@@ -0,0 +1,65 @@
+/*
+ * * 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.element.messagetag;
+
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.kitteh.irc.client.library.Client;
+import org.kitteh.irc.client.library.element.MessageTag;
+import org.kitteh.irc.client.library.feature.MessageTagManager;
+import org.kitteh.irc.client.library.util.TriFunction;
+
+import java.util.Objects;
+
+/**
+ * Default implementation of {@link Label}.
+ */
+public class DefaultMessageTagLabel extends MessageTagManager.DefaultMessageTag implements MessageTag.Label {
+    /**
+     * Function to create this message tag.
+     */
+    @SuppressWarnings("ConstantConditions")
+    public static final TriFunction<Client, String, String, DefaultMessageTagLabel> FUNCTION = (client, name, value) -> new DefaultMessageTagLabel(name, value);
+
+    private final String label;
+
+    private DefaultMessageTagLabel(@NonNull String name, @NonNull String value) {
+        super(name, value);
+        this.label = value;
+    }
+
+    @Override
+    public @NonNull String getLabel() {
+        return this.label;
+    }
+
+    @Override
+    public boolean equals(Object o) {
+        return o instanceof Label && this.label.equals(((Label) o).getLabel());
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash("Label", this.label);
+    }
+}

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

@@ -26,6 +26,7 @@
 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.defaults.element.messagetag.DefaultMessageTagLabel;
 import org.kitteh.irc.client.library.defaults.element.messagetag.DefaultMessageTagMsgId;
 import org.kitteh.irc.client.library.defaults.element.messagetag.DefaultMessageTagTime;
 import org.kitteh.irc.client.library.element.MessageTag;
@@ -84,6 +85,7 @@ public DefaultMessageTagManager(Client.WithManagement client) {
         super(client);
         this.registerTagCreator(CapabilityManager.Defaults.SERVER_TIME, "time", DefaultMessageTagTime.FUNCTION);
         this.registerTagCreator(CapabilityManager.Defaults.MESSAGE_TAGS, "msgid", DefaultMessageTagMsgId.FUNCTION);
+        this.registerTagCreator(CapabilityManager.Defaults.LABELED_RESPONSE, "label", DefaultMessageTagLabel.FUNCTION);
     }
 
     @Override

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

@@ -0,0 +1,51 @@
+/*
+ * * 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.event.client.AckEvent;
+import org.kitteh.irc.client.library.event.client.ClientReceiveCommandEvent;
+import org.kitteh.irc.client.library.feature.filter.CommandFilter;
+
+/**
+ * Default ACK listener, producing events using default classes.
+ */
+public class DefaultAckListener extends AbstractDefaultListenerBase {
+    /**
+     * Constructs the listener.
+     *
+     * @param client client
+     */
+    public DefaultAckListener(Client.@NonNull WithManagement client) {
+        super(client);
+    }
+
+    @CommandFilter("ACK")
+    @Handler(priority = Integer.MAX_VALUE - 1)
+    public void ack(ClientReceiveCommandEvent event) {
+        this.fire(new AckEvent(this.getClient(), event.getSource()));
+    }
+}

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

@@ -39,6 +39,12 @@ public enum DefaultListeners implements EventListenerSupplier {
      * @see DefaultAccountListener
      */
     ACCOUNT(DefaultAccountListener::new),
+    /**
+     * ACK handling.
+     *
+     * @see DefaultAckListener
+     */
+    ACK(DefaultAckListener::new),
     /**
      * AWAY handling.
      *

src/main/java/org/kitteh/irc/client/library/element/MessageTag.java

@@ -32,10 +32,27 @@
  * Reflects a message tag.
  */
 public interface MessageTag {
+    /**
+     * Represents the `label` tag as specified by the labeled responses spec.
+     */
+    interface Label extends MessageTag {
+        /**
+         * Gets the label.
+         *
+         * @return the label
+         */
+        @NonNull String getLabel();
+    }
+
     /**
      * Represents the `msgid` tag as specified by the Message IDs spec.
      */
     interface MsgId extends MessageTag {
+        /**
+         * Gets the message id.
+         *
+         * @return the message id
+         */
         @NonNull String getId();
     }
 

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

@@ -0,0 +1,45 @@
+/*
+ * * 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;
+import org.kitteh.irc.client.library.Client;
+import org.kitteh.irc.client.library.element.ServerMessage;
+import org.kitteh.irc.client.library.event.abstractbase.ServerMessageEventBase;
+
+/**
+ * An ACK has been received, which should have a label attached to correspond
+ * with a previously sent message.
+ */
+public class AckEvent extends ServerMessageEventBase {
+    /**
+     * Constructs the event.
+     *
+     * @param client the client
+     * @param sourceMessage source message
+     */
+    public AckEvent(@NonNull Client client, @NonNull ServerMessage sourceMessage) {
+        super(client, sourceMessage);
+    }
+}

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

@@ -112,11 +112,17 @@ final class Defaults {
          */
         public static final transient String INVITE_NOTIFY = "invite-notify";
 
+        /**
+         * Labeled responses, which also requires the {@link #BATCH}
+         * capability to function, via a "label" message id.
+         */
+        public static final String LABELED_RESPONSE = "labeled-response";
+
         /**
          * Message tags support, explicitly stating that client-only tags are
-         * supported, but not a necessary capability for actually supporting
-         * tags through other capabilities like account-tag, batch, or
-         * server-time.
+         * supported, required for msgid tag but not a necessary capability
+         * for actually supporting tags through other capabilities like
+         * account-tag, batch, or server-time.
          */
         public static final String MESSAGE_TAGS = "message-tags";