Add support for sending view once messages

[signal-cli] / src / main / java / org / asamk / signal / commands / SendCommand.java

diff --git a/src/main/java/org/asamk/signal/commands/SendCommand.java b/src/main/java/org/asamk/signal/commands/SendCommand.java
index c10817172e23ee5623de8e7bfb6b010ec63328a7..e022723e3ec777bb58deb019d740a1112ffe0bf3 100644 (file)
--- a/src/main/java/org/asamk/signal/commands/SendCommand.java
+++ b/src/main/java/org/asamk/signal/commands/SendCommand.java
@@ -9,14 +9,14 @@ import org.asamk.signal.commands.exceptions.UnexpectedErrorException;
 import org.asamk.signal.commands.exceptions.UserErrorException;
 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.manager.api.AttachmentInvalidException;
 import org.asamk.signal.commands.exceptions.UserErrorException;
 import org.asamk.signal.manager.Manager;
 import org.asamk.signal.manager.api.AttachmentInvalidException;

+import org.asamk.signal.manager.api.GroupNotFoundException;
+import org.asamk.signal.manager.api.GroupSendingNotAllowedException;

 import org.asamk.signal.manager.api.InvalidStickerException;
 import org.asamk.signal.manager.api.Message;
 import org.asamk.signal.manager.api.InvalidStickerException;
 import org.asamk.signal.manager.api.Message;

+import org.asamk.signal.manager.api.NotAGroupMemberException;

 import org.asamk.signal.manager.api.RecipientIdentifier;
 import org.asamk.signal.manager.api.TextStyle;
 import org.asamk.signal.manager.api.UnregisteredRecipientException;
 import org.asamk.signal.manager.api.RecipientIdentifier;
 import org.asamk.signal.manager.api.TextStyle;
 import org.asamk.signal.manager.api.UnregisteredRecipientException;

-import org.asamk.signal.manager.groups.GroupNotFoundException;
-import org.asamk.signal.manager.groups.GroupSendingNotAllowedException;
-import org.asamk.signal.manager.groups.NotAGroupMemberException;

 import org.asamk.signal.output.OutputWriter;
 import org.asamk.signal.util.CommandUtil;
 import org.asamk.signal.util.Hex;
 import org.asamk.signal.output.OutputWriter;
 import org.asamk.signal.util.CommandUtil;
 import org.asamk.signal.util.Hex;


@@ -35,7 +35,7 @@ import static org.asamk.signal.util.SendMessageResultUtils.outputResult;
 
 public class SendCommand implements JsonRpcLocalCommand {
 
 
 public class SendCommand implements JsonRpcLocalCommand {
 

-    private final static Logger logger = LoggerFactory.getLogger(SendCommand.class);
+    private static final Logger logger = LoggerFactory.getLogger(SendCommand.class);

 
     @Override
     public String getName() {
 
     @Override
     public String getName() {


@@ -47,29 +47,39 @@ public class SendCommand implements JsonRpcLocalCommand {
         subparser.help("Send a message to another user or group.");
         subparser.addArgument("recipient").help("Specify the recipients' phone number.").nargs("*");
         subparser.addArgument("-g", "--group-id", "--group").help("Specify the recipient group ID.").nargs("*");
         subparser.help("Send a message to another user or group.");
         subparser.addArgument("recipient").help("Specify the recipients' phone number.").nargs("*");
         subparser.addArgument("-g", "--group-id", "--group").help("Specify the recipient group ID.").nargs("*");

+        subparser.addArgument("-u", "--username").help("Specify the recipient username or username link.").nargs("*");

         subparser.addArgument("--note-to-self")
                 .help("Send the message to self without notification.")
                 .action(Arguments.storeTrue());
         subparser.addArgument("--note-to-self")
                 .help("Send the message to self without notification.")
                 .action(Arguments.storeTrue());

+        subparser.addArgument("--notify-self")
+                .help("If self is part of recipients/groups send a normal message, not a sync message.")
+                .action(Arguments.storeTrue());

 
         var mut = subparser.addMutuallyExclusiveGroup();
         mut.addArgument("-m", "--message").help("Specify the message to be sent.");
         mut.addArgument("--message-from-stdin")
                 .action(Arguments.storeTrue())
                 .help("Read the message from standard input.");
 
         var mut = subparser.addMutuallyExclusiveGroup();
         mut.addArgument("-m", "--message").help("Specify the message to be sent.");
         mut.addArgument("--message-from-stdin")
                 .action(Arguments.storeTrue())
                 .help("Read the message from standard input.");

+

         subparser.addArgument("-a", "--attachment")
                 .nargs("*")
                 .help("Add an attachment. "
                         + "Can be either a file path or a data URI. Data URI encoded attachments must follow the RFC 2397. Additionally a file name can be added, e.g. "
                         + "data:<MIME-TYPE>;filename=<FILENAME>;base64,<BASE64 ENCODED DATA>.");
         subparser.addArgument("-a", "--attachment")
                 .nargs("*")
                 .help("Add an attachment. "
                         + "Can be either a file path or a data URI. Data URI encoded attachments must follow the RFC 2397. Additionally a file name can be added, e.g. "
                         + "data:<MIME-TYPE>;filename=<FILENAME>;base64,<BASE64 ENCODED DATA>.");

+        subparser.addArgument("--view-once")
+                .action(Arguments.storeTrue())
+                .help("Send the message as a view once message");

         subparser.addArgument("-e", "--end-session", "--endsession")
                 .help("Clear session state and send end session message.")
                 .action(Arguments.storeTrue());
         subparser.addArgument("--mention")
                 .nargs("*")
         subparser.addArgument("-e", "--end-session", "--endsession")
                 .help("Clear session state and send end session message.")
                 .action(Arguments.storeTrue());
         subparser.addArgument("--mention")
                 .nargs("*")

-                .help("Mention another group member (syntax: start:length:recipientNumber)");
+                .help("Mention another group member (syntax: start:length:recipientNumber). "
+                        + "Unit of start and length is UTF-16 code units, NOT Unicode code points.");

         subparser.addArgument("--text-style")
                 .nargs("*")
         subparser.addArgument("--text-style")
                 .nargs("*")

-                .help("Style parts of the message text (syntax: start:length:STYLE)");
+                .help("Style parts of the message text (syntax: start:length:STYLE). "
+                        + "Unit of start and length is UTF-16 code units, NOT Unicode code points.");

         subparser.addArgument("--quote-timestamp")
                 .type(long.class)
                 .help("Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.");
         subparser.addArgument("--quote-timestamp")
                 .type(long.class)
                 .help("Specify the timestamp of a previous message with the recipient or group to add a quote to the new message.");


@@ -78,6 +88,9 @@ public class SendCommand implements JsonRpcLocalCommand {
         subparser.addArgument("--quote-mention")
                 .nargs("*")
                 .help("Quote with mention of another group member (syntax: start:length:recipientNumber)");
         subparser.addArgument("--quote-mention")
                 .nargs("*")
                 .help("Quote with mention of another group member (syntax: start:length:recipientNumber)");

+        subparser.addArgument("--quote-attachment")
+                .nargs("*")
+                .help("Specify the attachments of the original message (syntax: contentType[:filename[:previewFile]]), e.g. 'audio/aac' or 'image/png:test.png:/tmp/preview.jpg'.");

         subparser.addArgument("--quote-text-style")
                 .nargs("*")
                 .help("Quote with style parts of the message text (syntax: start:length:STYLE)");
         subparser.addArgument("--quote-text-style")
                 .nargs("*")
                 .help("Quote with style parts of the message text (syntax: start:length:STYLE)");


@@ -98,16 +111,21 @@ public class SendCommand implements JsonRpcLocalCommand {
 
     @Override
     public void handleCommand(
 
     @Override
     public void handleCommand(

-            final Namespace ns, final Manager m, final OutputWriter outputWriter
+            final Namespace ns,
+            final Manager m,
+            final OutputWriter outputWriter

     ) throws CommandException {
     ) throws CommandException {

+        final var notifySelf = Boolean.TRUE.equals(ns.getBoolean("notify-self"));

         final var isNoteToSelf = Boolean.TRUE.equals(ns.getBoolean("note-to-self"));
         final var recipientStrings = ns.<String>getList("recipient");
         final var groupIdStrings = ns.<String>getList("group-id");
         final var isNoteToSelf = Boolean.TRUE.equals(ns.getBoolean("note-to-self"));
         final var recipientStrings = ns.<String>getList("recipient");
         final var groupIdStrings = ns.<String>getList("group-id");

+        final var usernameStrings = ns.<String>getList("username");

 
         final var recipientIdentifiers = CommandUtil.getRecipientIdentifiers(m,
                 isNoteToSelf,
                 recipientStrings,
 
         final var recipientIdentifiers = CommandUtil.getRecipientIdentifiers(m,
                 isNoteToSelf,
                 recipientStrings,

-                groupIdStrings);
+                groupIdStrings,
+                usernameStrings);

 
         final var isEndSession = Boolean.TRUE.equals(ns.getBoolean("end-session"));
         if (isEndSession) {
 
         final var isEndSession = Boolean.TRUE.equals(ns.getBoolean("end-session"));
         if (isEndSession) {


@@ -145,45 +163,58 @@ public class SendCommand implements JsonRpcLocalCommand {
             messageText = "";
         }
 
             messageText = "";
         }
 

-        List<String> attachments = ns.getList("attachment");
+        var attachments = ns.<String>getList("attachment");

         if (attachments == null) {
             attachments = List.of();
         }
         if (attachments == null) {
             attachments = List.of();
         }

+        final var viewOnce = ns.getBoolean("view-once");
+
+        final var selfNumber = m.getSelfNumber();

 
 

-        List<String> mentionStrings = ns.getList("mention");
-        final var mentions = mentionStrings == null ? List.<Message.Mention>of() : parseMentions(m, mentionStrings);
+        final var mentionStrings = ns.<String>getList("mention");
+        final var mentions = mentionStrings == null
+                ? List.<Message.Mention>of()
+                : parseMentions(selfNumber, mentionStrings);

 
 

-        List<String> textStyleStrings = ns.getList("text-style");
+        final var textStyleStrings = ns.<String>getList("text-style");

         final var textStyles = textStyleStrings == null ? List.<TextStyle>of() : parseTextStyles(textStyleStrings);
 
         final Message.Quote quote;
         final var quoteTimestamp = ns.getLong("quote-timestamp");
         if (quoteTimestamp != null) {
             final var quoteAuthor = ns.getString("quote-author");
         final var textStyles = textStyleStrings == null ? List.<TextStyle>of() : parseTextStyles(textStyleStrings);
 
         final Message.Quote quote;
         final var quoteTimestamp = ns.getLong("quote-timestamp");
         if (quoteTimestamp != null) {
             final var quoteAuthor = ns.getString("quote-author");

+            if (quoteAuthor == null) {
+                throw new UserErrorException("Quote author parameter is missing");
+            }

             final var quoteMessage = ns.getString("quote-message");
             final var quoteMessage = ns.getString("quote-message");

-            List<String> quoteMentionStrings = ns.getList("quote-mention");
+            final var quoteMentionStrings = ns.<String>getList("quote-mention");

             final var quoteMentions = quoteMentionStrings == null
                     ? List.<Message.Mention>of()
             final var quoteMentions = quoteMentionStrings == null
                     ? List.<Message.Mention>of()

-                    : parseMentions(m, quoteMentionStrings);
-            List<String> quoteTextStyleStrings = ns.getList("quote-text-style");
+                    : parseMentions(selfNumber, quoteMentionStrings);
+            final var quoteTextStyleStrings = ns.<String>getList("quote-text-style");
+            final var quoteAttachmentStrings = ns.<String>getList("quote-attachment");

             final var quoteTextStyles = quoteTextStyleStrings == null
                     ? List.<TextStyle>of()
                     : parseTextStyles(quoteTextStyleStrings);
             final var quoteTextStyles = quoteTextStyleStrings == null
                     ? List.<TextStyle>of()
                     : parseTextStyles(quoteTextStyleStrings);

+            final var quoteAttachments = quoteAttachmentStrings == null
+                    ? List.<Message.Quote.Attachment>of()
+                    : parseQuoteAttachments(quoteAttachmentStrings);

             quote = new Message.Quote(quoteTimestamp,
             quote = new Message.Quote(quoteTimestamp,

-                    CommandUtil.getSingleRecipientIdentifier(quoteAuthor, m.getSelfNumber()),
+                    CommandUtil.getSingleRecipientIdentifier(quoteAuthor, selfNumber),

                     quoteMessage == null ? "" : quoteMessage,
                     quoteMentions,
                     quoteMessage == null ? "" : quoteMessage,
                     quoteMentions,

-                    quoteTextStyles);
+                    quoteTextStyles,
+                    quoteAttachments);

         } else {
             quote = null;
         }
 
         final List<Message.Preview> previews;
         } else {
             quote = null;
         }
 
         final List<Message.Preview> previews;

-        String previewUrl = ns.getString("preview-url");
+        final var previewUrl = ns.getString("preview-url");

         if (previewUrl != null) {
         if (previewUrl != null) {

-            String previewTitle = ns.getString("preview-title");
-            String previewDescription = ns.getString("preview-description");
-            String previewImage = ns.getString("preview-image");
+            final var previewTitle = ns.getString("preview-title");
+            final var previewDescription = ns.getString("preview-description");
+            final var previewImage = ns.getString("preview-image");

             previews = List.of(new Message.Preview(previewUrl,
                     Optional.ofNullable(previewTitle).orElse(""),
                     Optional.ofNullable(previewDescription).orElse(""),
             previews = List.of(new Message.Preview(previewUrl,
                     Optional.ofNullable(previewTitle).orElse(""),
                     Optional.ofNullable(previewDescription).orElse(""),


@@ -197,7 +228,7 @@ public class SendCommand implements JsonRpcLocalCommand {
         if (storyReplyTimestamp != null) {
             final var storyAuthor = ns.getString("story-author");
             storyReply = new Message.StoryReply(storyReplyTimestamp,
         if (storyReplyTimestamp != null) {
             final var storyAuthor = ns.getString("story-author");
             storyReply = new Message.StoryReply(storyReplyTimestamp,

-                    CommandUtil.getSingleRecipientIdentifier(storyAuthor, m.getSelfNumber()));
+                    CommandUtil.getSingleRecipientIdentifier(storyAuthor, selfNumber));

         } else {
             storyReply = null;
         }
         } else {
             storyReply = null;
         }


@@ -212,6 +243,7 @@ public class SendCommand implements JsonRpcLocalCommand {
         try {
             final var message = new Message(messageText,
                     attachments,
         try {
             final var message = new Message(messageText,
                     attachments,

+                    viewOnce,

                     mentions,
                     Optional.ofNullable(quote),
                     Optional.ofNullable(sticker),
                     mentions,
                     Optional.ofNullable(quote),
                     Optional.ofNullable(sticker),


@@ -220,11 +252,17 @@ public class SendCommand implements JsonRpcLocalCommand {
                     textStyles);
             var results = editTimestamp != null
                     ? m.sendEditMessage(message, recipientIdentifiers, editTimestamp)
                     textStyles);
             var results = editTimestamp != null
                     ? m.sendEditMessage(message, recipientIdentifiers, editTimestamp)

-                    : m.sendMessage(message, recipientIdentifiers);
+                    : m.sendMessage(message, recipientIdentifiers, notifySelf);

             outputResult(outputWriter, results);
         } catch (AttachmentInvalidException | IOException e) {
             outputResult(outputWriter, results);
         } catch (AttachmentInvalidException | IOException e) {

-            throw new UnexpectedErrorException("Failed to send message: " + e.getMessage() + " (" + e.getClass()
-                    .getSimpleName() + ")", e);
+            if (e instanceof IOException io && io.getMessage().contains("No prekeys available")) {
+                throw new UnexpectedErrorException("Failed to send message: " + e.getMessage() + " (" + e.getClass()
+                        .getSimpleName() + "), maybe one of the devices of the recipient wasn't online for a while.",
+                        e);
+            } else {
+                throw new UnexpectedErrorException("Failed to send message: " + e.getMessage() + " (" + e.getClass()
+                        .getSimpleName() + ")", e);
+            }

         } catch (GroupNotFoundException | NotAGroupMemberException | GroupSendingNotAllowedException e) {
             throw new UserErrorException(e.getMessage());
         } catch (UnregisteredRecipientException e) {
         } catch (GroupNotFoundException | NotAGroupMemberException | GroupSendingNotAllowedException e) {
             throw new UserErrorException(e.getMessage());
         } catch (UnregisteredRecipientException e) {


@@ -235,20 +273,21 @@ public class SendCommand implements JsonRpcLocalCommand {
     }
 
     private List<Message.Mention> parseMentions(
     }
 
     private List<Message.Mention> parseMentions(

-            final Manager m, final List<String> mentionStrings
+            final String selfNumber,
+            final List<String> mentionStrings

     ) throws UserErrorException {
     ) throws UserErrorException {

-        List<Message.Mention> mentions;
-        final Pattern mentionPattern = Pattern.compile("(\\d+):(\\d+):(.+)");
-        mentions = new ArrayList<>();
+        final var mentionPattern = Pattern.compile("(\\d+):(\\d+):(.+)");
+        final var mentions = new ArrayList<Message.Mention>();

         for (final var mention : mentionStrings) {
             final var matcher = mentionPattern.matcher(mention);
             if (!matcher.matches()) {
                 throw new UserErrorException("Invalid mention syntax ("
                         + mention
         for (final var mention : mentionStrings) {
             final var matcher = mentionPattern.matcher(mention);
             if (!matcher.matches()) {
                 throw new UserErrorException("Invalid mention syntax ("
                         + mention

-                        + ") expected 'start:end:recipientNumber'");
+                        + ") expected 'start:length:recipientNumber'");

             }
             }

-            mentions.add(new Message.Mention(CommandUtil.getSingleRecipientIdentifier(matcher.group(3),
-                    m.getSelfNumber()), Integer.parseInt(matcher.group(1)), Integer.parseInt(matcher.group(2))));
+            mentions.add(new Message.Mention(CommandUtil.getSingleRecipientIdentifier(matcher.group(3), selfNumber),
+                    Integer.parseInt(matcher.group(1)),
+                    Integer.parseInt(matcher.group(2))));

         }
         return mentions;
     }
         }
         return mentions;
     }


@@ -256,9 +295,8 @@ public class SendCommand implements JsonRpcLocalCommand {
     private List<TextStyle> parseTextStyles(
             final List<String> textStylesStrings
     ) throws UserErrorException {
     private List<TextStyle> parseTextStyles(
             final List<String> textStylesStrings
     ) throws UserErrorException {

-        List<TextStyle> textStyles;
-        final Pattern textStylePattern = Pattern.compile("(\\d+):(\\d+):(.+)");
-        textStyles = new ArrayList<>();
+        final var textStylePattern = Pattern.compile("(\\d+):(\\d+):(.+)");
+        final var textStyles = new ArrayList<TextStyle>();

         for (final var textStyle : textStylesStrings) {
             final var matcher = textStylePattern.matcher(textStyle);
             if (!matcher.matches()) {
         for (final var textStyle : textStylesStrings) {
             final var matcher = textStylePattern.matcher(textStyle);
             if (!matcher.matches()) {


@@ -278,7 +316,7 @@ public class SendCommand implements JsonRpcLocalCommand {
     }
 
     private Message.Sticker parseSticker(final String stickerString) throws UserErrorException {
     }
 
     private Message.Sticker parseSticker(final String stickerString) throws UserErrorException {

-        final Pattern stickerPattern = Pattern.compile("([\\da-f]+):(\\d+)");
+        final var stickerPattern = Pattern.compile("([\\da-f]+):(\\d+)");

         final var matcher = stickerPattern.matcher(stickerString);
         if (!matcher.matches() || matcher.group(1).length() % 2 != 0) {
             throw new UserErrorException("Invalid sticker syntax ("
         final var matcher = stickerPattern.matcher(stickerString);
         if (!matcher.matches() || matcher.group(1).length() % 2 != 0) {
             throw new UserErrorException("Invalid sticker syntax ("


@@ -287,4 +325,21 @@ public class SendCommand implements JsonRpcLocalCommand {
         }
         return new Message.Sticker(Hex.toByteArray(matcher.group(1)), Integer.parseInt(matcher.group(2)));
     }
         }
         return new Message.Sticker(Hex.toByteArray(matcher.group(1)), Integer.parseInt(matcher.group(2)));
     }

+
+    private List<Message.Quote.Attachment> parseQuoteAttachments(
+            final List<String> attachmentStrings
+    ) throws UserErrorException {
+        final var attachmentPattern = Pattern.compile("([^:]+)(:([^:]+)(:(.+))?)?");
+        final var attachments = new ArrayList<Message.Quote.Attachment>();
+        for (final var attachment : attachmentStrings) {
+            final var matcher = attachmentPattern.matcher(attachment);
+            if (!matcher.matches()) {
+                throw new UserErrorException("Invalid attachment syntax ("
+                        + attachment
+                        + ") expected 'contentType[:filename[:previewFile]]'");
+            }
+            attachments.add(new Message.Quote.Attachment(matcher.group(1), matcher.group(3), matcher.group(5)));
+        }
+        return attachments;
+    }

 }
 }