nmode's Git Repositories - signal-cli/blob - src/main/java/org/asamk/signal/ReceiveMessageHandler.java

   1 package org.asamk.signal;
   2
   3 import org.asamk.signal.manager.Manager;
   4 import org.asamk.signal.manager.UntrustedIdentityException;
   5 import org.asamk.signal.manager.api.MessageEnvelope;
   6 import org.asamk.signal.manager.api.RecipientIdentifier;
   7 import org.asamk.signal.manager.groups.GroupId;
   8 import org.asamk.signal.manager.storage.recipients.RecipientAddress;
   9 import org.asamk.signal.output.PlainTextWriter;
  10 import org.asamk.signal.util.DateUtils;
  11 import org.slf4j.helpers.MessageFormatter;
  12
  13 import java.util.ArrayList;
  14 import java.util.Base64;
  15 import java.util.stream.Collectors;
  16
  17 public class ReceiveMessageHandler implements Manager.ReceiveMessageHandler {
  18
  19     final Manager m;
  20     final PlainTextWriter writer;
  21
  22     public ReceiveMessageHandler(Manager m, final PlainTextWriter writer) {
  23         this.m = m;
  24         this.writer = writer;
  25     }
  26
  27     @Override
  28     public void handleMessage(MessageEnvelope envelope, Throwable exception) {
  29         synchronized (writer) {
  30             handleMessageInternal(envelope, exception);
  31         }
  32     }
  33
  34     private void handleMessageInternal(MessageEnvelope envelope, Throwable exception) {
  35         var source = envelope.sourceAddress();
  36         writer.println("Envelope from: {} (device: {})",
  37                 source.map(this::formatContact).orElse("unknown source"),
  38                 envelope.sourceDevice());
  39         writer.println("Timestamp: {}", DateUtils.formatTimestamp(envelope.timestamp()));
  40         writer.println("Server timestamps: received: {} delivered: {}",
  41                 DateUtils.formatTimestamp(envelope.serverReceivedTimestamp()),
  42                 DateUtils.formatTimestamp(envelope.serverDeliveredTimestamp()));
  43         if (envelope.isUnidentifiedSender()) {
  44             writer.println("Sent by unidentified/sealed sender");
  45         }
  46
  47         if (exception != null) {
  48             if (exception instanceof UntrustedIdentityException e) {
  49                 writer.println(
  50                         "The user’s key is untrusted, either the user has reinstalled Signal or a third party sent this message.");
  51                 final var recipientName = e.getSender().getLegacyIdentifier();
  52                 writer.println(
  53                         "Use 'signal-cli -a {} listIdentities -n {}', verify the key and run 'signal-cli -a {} trust -v \"FINGER_PRINT\" {}' to mark it as trusted",
  54                         m.getSelfNumber(),
  55                         recipientName,
  56                         m.getSelfNumber(),
  57                         recipientName);
  58                 writer.println(
  59                         "If you don't care about security, use 'signal-cli -a {} trust -a {}' to trust it without verification",
  60                         m.getSelfNumber(),
  61                         recipientName);
  62             } else {
  63                 writer.println("Exception: {} ({})", exception.getMessage(), exception.getClass().getSimpleName());
  64             }
  65         }
  66
  67         if (envelope.data().isPresent()) {
  68             var message = envelope.data().get();
  69             printDataMessage(writer, message);
  70         }
  71         if (envelope.sync().isPresent()) {
  72             writer.println("Received a sync message");
  73             var syncMessage = envelope.sync().get();
  74             printSyncMessage(writer, syncMessage);
  75         }
  76         if (envelope.call().isPresent()) {
  77             writer.println("Received a call message");
  78             var callMessage = envelope.call().get();
  79             printCallMessage(writer.indentedWriter(), callMessage);
  80         }
  81         if (envelope.receipt().isPresent()) {
  82             writer.println("Received a receipt message");
  83             var receiptMessage = envelope.receipt().get();
  84             printReceiptMessage(writer.indentedWriter(), receiptMessage);
  85         }
  86         if (envelope.typing().isPresent()) {
  87             writer.println("Received a typing message");
  88             var typingMessage = envelope.typing().get();
  89             printTypingMessage(writer.indentedWriter(), typingMessage);
  90         }
  91         writer.println();
  92     }
  93
  94     private void printDataMessage(
  95             PlainTextWriter writer, MessageEnvelope.Data message
  96     ) {
  97         writer.println("Message timestamp: {}", DateUtils.formatTimestamp(message.timestamp()));
  98         if (message.isViewOnce()) {
  99             writer.println("=VIEW ONCE=");
 100         }
 101
 102         if (message.body().isPresent()) {
 103             writer.println("Body: {}", message.body().get());
 104         }
 105         if (message.groupContext().isPresent()) {
 106             writer.println("Group info:");
 107             final var groupContext = message.groupContext().get();
 108             printGroupContext(writer.indentedWriter(), groupContext);
 109         }
 110         if (message.groupCallUpdate().isPresent()) {
 111             writer.println("Group call update:");
 112             final var groupCallUpdate = message.groupCallUpdate().get();
 113             writer.indentedWriter().println("Era id: {}", groupCallUpdate.eraId());
 114         }
 115         if (message.previews().size() > 0) {
 116             writer.println("Previews:");
 117             final var previews = message.previews();
 118             for (var preview : previews) {
 119                 writer.println("- Preview");
 120                 printPreview(writer.indentedWriter(), preview);
 121             }
 122         }
 123         if (message.sharedContacts().size() > 0) {
 124             writer.println("Contacts:");
 125             for (var contact : message.sharedContacts()) {
 126                 writer.println("- Contact:");
 127                 printSharedContact(writer.indentedWriter(), contact);
 128             }
 129         }
 130         if (message.sticker().isPresent()) {
 131             final var sticker = message.sticker().get();
 132             writer.println("Sticker:");
 133             printSticker(writer.indentedWriter(), sticker);
 134         }
 135         if (message.isEndSession()) {
 136             writer.println("Is end session");
 137         }
 138         if (message.isExpirationUpdate()) {
 139             writer.println("Is Expiration update: true");
 140         }
 141         if (message.expiresInSeconds() > 0) {
 142             writer.println("Expires in: {} seconds", message.expiresInSeconds());
 143         }
 144         if (message.hasProfileKey()) {
 145             writer.println("Profile key update");
 146         }
 147         if (message.reaction().isPresent()) {
 148             writer.println("Reaction:");
 149             final var reaction = message.reaction().get();
 150             printReaction(writer.indentedWriter(), reaction);
 151         }
 152         if (message.quote().isPresent()) {
 153             writer.println("Quote:");
 154             var quote = message.quote().get();
 155             printQuote(writer.indentedWriter(), quote);
 156         }
 157         if (message.remoteDeleteId().isPresent()) {
 158             final var remoteDelete = message.remoteDeleteId().get();
 159             writer.println("Remote delete message: timestamp = {}", remoteDelete);
 160         }
 161         if (message.mentions().size() > 0) {
 162             writer.println("Mentions:");
 163             for (var mention : message.mentions()) {
 164                 printMention(writer, mention);
 165             }
 166         }
 167         if (message.attachments().size() > 0) {
 168             writer.println("Attachments:");
 169             for (var attachment : message.attachments()) {
 170                 writer.println("- Attachment:");
 171                 printAttachment(writer.indentedWriter(), attachment);
 172             }
 173         }
 174     }
 175
 176     private void printTypingMessage(
 177             final PlainTextWriter writer, final MessageEnvelope.Typing typingMessage
 178     ) {
 179         writer.println("Action: {}", typingMessage.type());
 180         writer.println("Timestamp: {}", DateUtils.formatTimestamp(typingMessage.timestamp()));
 181         if (typingMessage.groupId().isPresent()) {
 182             writer.println("Group Info:");
 183             final var groupId = typingMessage.groupId().get();
 184             printGroupInfo(writer.indentedWriter(), groupId);
 185         }
 186     }
 187
 188     private void printReceiptMessage(
 189             final PlainTextWriter writer, final MessageEnvelope.Receipt receiptMessage
 190     ) {
 191         writer.println("When: {}", DateUtils.formatTimestamp(receiptMessage.when()));
 192         if (receiptMessage.type() == MessageEnvelope.Receipt.Type.DELIVERY) {
 193             writer.println("Is delivery receipt");
 194         }
 195         if (receiptMessage.type() == MessageEnvelope.Receipt.Type.READ) {
 196             writer.println("Is read receipt");
 197         }
 198         if (receiptMessage.type() == MessageEnvelope.Receipt.Type.VIEWED) {
 199             writer.println("Is viewed receipt");
 200         }
 201         writer.println("Timestamps:");
 202         for (long timestamp : receiptMessage.timestamps()) {
 203             writer.println("- {}", DateUtils.formatTimestamp(timestamp));
 204         }
 205     }
 206
 207     private void printCallMessage(
 208             final PlainTextWriter writer, final MessageEnvelope.Call callMessage
 209     ) {
 210         if (callMessage.destinationDeviceId().isPresent()) {
 211             final var deviceId = callMessage.destinationDeviceId().get();
 212             writer.println("Destination device id: {}", deviceId);
 213         }
 214         if (callMessage.groupId().isPresent()) {
 215             final var groupId = callMessage.groupId().get();
 216             writer.println("Destination group id: {}", groupId);
 217         }
 218         if (callMessage.timestamp().isPresent()) {
 219             writer.println("Timestamp: {}", DateUtils.formatTimestamp(callMessage.timestamp().get()));
 220         }
 221         if (callMessage.answer().isPresent()) {
 222             var answerMessage = callMessage.answer().get();
 223             writer.println("Answer message: {}, sdp: {})", answerMessage.id(), answerMessage.sdp());
 224         }
 225         if (callMessage.busy().isPresent()) {
 226             var busyMessage = callMessage.busy().get();
 227             writer.println("Busy message: {}", busyMessage.id());
 228         }
 229         if (callMessage.hangup().isPresent()) {
 230             var hangupMessage = callMessage.hangup().get();
 231             writer.println("Hangup message: {}", hangupMessage.id());
 232         }
 233         if (callMessage.iceUpdate().size() > 0) {
 234             writer.println("Ice update messages:");
 235             var iceUpdateMessages = callMessage.iceUpdate();
 236             for (var iceUpdateMessage : iceUpdateMessages) {
 237                 writer.println("- {}, sdp: {}", iceUpdateMessage.id(), iceUpdateMessage.sdp());
 238             }
 239         }
 240         if (callMessage.offer().isPresent()) {
 241             var offerMessage = callMessage.offer().get();
 242             writer.println("Offer message: {}, sdp: {}", offerMessage.id(), offerMessage.sdp());
 243         }
 244         if (callMessage.opaque().isPresent()) {
 245             final var opaqueMessage = callMessage.opaque().get();
 246             writer.println("Opaque message: size {}, urgency: {}",
 247                     opaqueMessage.opaque().length,
 248                     opaqueMessage.urgency().name());
 249         }
 250     }
 251
 252     private void printSyncMessage(
 253             final PlainTextWriter writer, final MessageEnvelope.Sync syncMessage
 254     ) {
 255         if (syncMessage.contacts().isPresent()) {
 256             final var contactsMessage = syncMessage.contacts().get();
 257             var type = contactsMessage.isComplete() ? "complete" : "partial";
 258             writer.println("Received {} sync contacts:", type);
 259         }
 260         if (syncMessage.groups().isPresent()) {
 261             writer.println("Received sync groups.");
 262         }
 263         if (syncMessage.read().size() > 0) {
 264             writer.println("Received sync read messages list");
 265             for (var rm : syncMessage.read()) {
 266                 writer.println("- From: {} Message timestamp: {}",
 267                         formatContact(rm.sender()),
 268                         DateUtils.formatTimestamp(rm.timestamp()));
 269             }
 270         }
 271         if (syncMessage.viewed().size() > 0) {
 272             writer.println("Received sync viewed messages list");
 273             for (var vm : syncMessage.viewed()) {
 274                 writer.println("- From: {} Message timestamp: {}",
 275                         formatContact(vm.sender()),
 276                         DateUtils.formatTimestamp(vm.timestamp()));
 277             }
 278         }
 279         if (syncMessage.sent().isPresent()) {
 280             writer.println("Received sync sent message");
 281             final var sentTranscriptMessage = syncMessage.sent().get();
 282             String to;
 283             if (sentTranscriptMessage.destination().isPresent()) {
 284                 to = formatContact(sentTranscriptMessage.destination().get());
 285             } else if (sentTranscriptMessage.recipients().size() > 0) {
 286                 to = sentTranscriptMessage.recipients()
 287                         .stream()
 288                         .map(this::formatContact)
 289                         .collect(Collectors.joining(", "));
 290             } else {
 291                 to = "<unknown>";
 292             }
 293             writer.indentedWriter().println("To: {}", to);
 294             writer.indentedWriter()
 295                     .println("Timestamp: {}", DateUtils.formatTimestamp(sentTranscriptMessage.timestamp()));
 296             if (sentTranscriptMessage.expirationStartTimestamp() > 0) {
 297                 writer.indentedWriter()
 298                         .println("Expiration started at: {}",
 299                                 DateUtils.formatTimestamp(sentTranscriptMessage.expirationStartTimestamp()));
 300             }
 301             var message = sentTranscriptMessage.message();
 302             printDataMessage(writer.indentedWriter(), message);
 303         }
 304         if (syncMessage.blocked().isPresent()) {
 305             writer.println("Received sync message with block list");
 306             writer.println("Blocked:");
 307             final var blockedList = syncMessage.blocked().get();
 308             for (var address : blockedList.recipients()) {
 309                 writer.println("- {}", address.getLegacyIdentifier());
 310             }
 311             for (var groupId : blockedList.groupIds()) {
 312                 writer.println("- {}", groupId);
 313             }
 314         }
 315         if (syncMessage.viewOnceOpen().isPresent()) {
 316             final var viewOnceOpenMessage = syncMessage.viewOnceOpen().get();
 317             writer.println("Received sync message with view once open message:");
 318             writer.indentedWriter().println("Sender: {}", formatContact(viewOnceOpenMessage.sender()));
 319             writer.indentedWriter()
 320                     .println("Timestamp: {}", DateUtils.formatTimestamp(viewOnceOpenMessage.timestamp()));
 321         }
 322         if (syncMessage.messageRequestResponse().isPresent()) {
 323             final var requestResponseMessage = syncMessage.messageRequestResponse().get();
 324             writer.println("Received message request response:");
 325             writer.indentedWriter().println("Type: {}", requestResponseMessage.type());
 326             if (requestResponseMessage.groupId().isPresent()) {
 327                 writer.println("For group:");
 328                 printGroupInfo(writer.indentedWriter(), requestResponseMessage.groupId().get());
 329             }
 330             if (requestResponseMessage.person().isPresent()) {
 331                 writer.indentedWriter().println("For Person: {}", formatContact(requestResponseMessage.person().get()));
 332             }
 333         }
 334     }
 335
 336     private void printPreview(
 337             final PlainTextWriter writer, final MessageEnvelope.Data.Preview preview
 338     ) {
 339         writer.println("Title: {}", preview.title());
 340         writer.println("Description: {}", preview.description());
 341         writer.println("Date: {}", DateUtils.formatTimestamp(preview.date()));
 342         writer.println("Url: {}", preview.url());
 343         if (preview.image().isPresent()) {
 344             writer.println("Image:");
 345             printAttachment(writer.indentedWriter(), preview.image().get());
 346         }
 347     }
 348
 349     private void printSticker(
 350             final PlainTextWriter writer, final MessageEnvelope.Data.Sticker sticker
 351     ) {
 352         writer.println("Pack id: {}", Base64.getEncoder().encodeToString(sticker.packId()));
 353         writer.println("Pack key: {}", Base64.getEncoder().encodeToString(sticker.packKey()));
 354         writer.println("Sticker id: {}", sticker.stickerId());
 355     }
 356
 357     private void printReaction(
 358             final PlainTextWriter writer, final MessageEnvelope.Data.Reaction reaction
 359     ) {
 360         writer.println("Emoji: {}", reaction.emoji());
 361         writer.println("Target author: {}", formatContact(reaction.targetAuthor()));
 362         writer.println("Target timestamp: {}", DateUtils.formatTimestamp(reaction.targetSentTimestamp()));
 363         writer.println("Is remove: {}", reaction.isRemove());
 364     }
 365
 366     private void printQuote(
 367             final PlainTextWriter writer, final MessageEnvelope.Data.Quote quote
 368     ) {
 369         writer.println("Id: {}", quote.id());
 370         writer.println("Author: {}", formatContact(quote.author()));
 371         if (quote.text().isPresent()) {
 372             writer.println("Text: {}", quote.text().get());
 373         }
 374         if (quote.mentions() != null && quote.mentions().size() > 0) {
 375             writer.println("Mentions:");
 376             for (var mention : quote.mentions()) {
 377                 printMention(writer, mention);
 378             }
 379         }
 380         if (quote.attachments().size() > 0) {
 381             writer.println("Attachments:");
 382             for (var attachment : quote.attachments()) {
 383                 writer.println("- Attachment:");
 384                 printAttachment(writer.indentedWriter(), attachment);
 385             }
 386         }
 387     }
 388
 389     private void printSharedContact(final PlainTextWriter writer, final MessageEnvelope.Data.SharedContact contact) {
 390         writer.println("Name:");
 391         var name = contact.name();
 392         writer.indent(w -> {
 393             if (name.display().isPresent() && !name.display().get().isBlank()) {
 394                 w.println("Display name: {}", name.display().get());
 395             }
 396             if (name.given().isPresent() && !name.given().get().isBlank()) {
 397                 w.println("First name: {}", name.given().get());
 398             }
 399             if (name.middle().isPresent() && !name.middle().get().isBlank()) {
 400                 w.println("Middle name: {}", name.middle().get());
 401             }
 402             if (name.family().isPresent() && !name.family().get().isBlank()) {
 403                 w.println("Family name: {}", name.family().get());
 404             }
 405             if (name.prefix().isPresent() && !name.prefix().get().isBlank()) {
 406                 w.println("Prefix name: {}", name.prefix().get());
 407             }
 408             if (name.suffix().isPresent() && !name.suffix().get().isBlank()) {
 409                 w.println("Suffix name: {}", name.suffix().get());
 410             }
 411         });
 412
 413         if (contact.avatar().isPresent()) {
 414             var avatar = contact.avatar().get();
 415             writer.println("Avatar: (profile: {})", avatar.isProfile());
 416             printAttachment(writer.indentedWriter(), avatar.attachment());
 417         }
 418
 419         if (contact.organization().isPresent()) {
 420             writer.println("Organisation: {}", contact.organization().get());
 421         }
 422
 423         if (contact.phone().size() > 0) {
 424             writer.println("Phone details:");
 425             for (var phone : contact.phone()) {
 426                 writer.println("- Phone:");
 427                 writer.indent(w -> {
 428                     w.println("Number: {}", phone.value());
 429                     w.println("Type: {}", phone.type());
 430                     if (phone.label().isPresent() && !phone.label().get().isBlank()) {
 431                         w.println("Label: {}", phone.label().get());
 432                     }
 433                 });
 434             }
 435         }
 436
 437         if (contact.email().size() > 0) {
 438             writer.println("Email details:");
 439             for (var email : contact.email()) {
 440                 writer.println("- Email:");
 441                 writer.indent(w -> {
 442                     w.println("Address: {}", email.value());
 443                     w.println("Type: {}", email.type());
 444                     if (email.label().isPresent() && !email.label().get().isBlank()) {
 445                         w.println("Label: {}", email.label().get());
 446                     }
 447                 });
 448             }
 449         }
 450
 451         if (contact.address().size() > 0) {
 452             writer.println("Address details:");
 453             for (var address : contact.address()) {
 454                 writer.println("- Address:");
 455                 writer.indent(w -> {
 456                     w.println("Type: {}", address.type());
 457                     if (address.label().isPresent() && !address.label().get().isBlank()) {
 458                         w.println("Label: {}", address.label().get());
 459                     }
 460                     if (address.street().isPresent() && !address.street().get().isBlank()) {
 461                         w.println("Street: {}", address.street().get());
 462                     }
 463                     if (address.pobox().isPresent() && !address.pobox().get().isBlank()) {
 464                         w.println("Pobox: {}", address.pobox().get());
 465                     }
 466                     if (address.neighborhood().isPresent() && !address.neighborhood().get().isBlank()) {
 467                         w.println("Neighbourhood: {}", address.neighborhood().get());
 468                     }
 469                     if (address.city().isPresent() && !address.city().get().isBlank()) {
 470                         w.println("City: {}", address.city().get());
 471                     }
 472                     if (address.region().isPresent() && !address.region().get().isBlank()) {
 473                         w.println("Region: {}", address.region().get());
 474                     }
 475                     if (address.postcode().isPresent() && !address.postcode().get().isBlank()) {
 476                         w.println("Postcode: {}", address.postcode().get());
 477                     }
 478                     if (address.country().isPresent() && !address.country().get().isBlank()) {
 479                         w.println("Country: {}", address.country().get());
 480                     }
 481                 });
 482             }
 483         }
 484     }
 485
 486     private void printGroupContext(
 487             final PlainTextWriter writer, final MessageEnvelope.Data.GroupContext groupContext
 488     ) {
 489         printGroupInfo(writer, groupContext.groupId());
 490         writer.println("Revision: {}", groupContext.revision());
 491         writer.println("Type: {}", groupContext.isGroupUpdate() ? "UPDATE" : "DELIVER");
 492     }
 493
 494     private void printGroupInfo(final PlainTextWriter writer, final GroupId groupId) {
 495         writer.println("Id: {}", groupId.toBase64());
 496
 497         var group = m.getGroup(groupId);
 498         if (group != null) {
 499             writer.println("Name: {}", group.title());
 500         } else {
 501             writer.println("Name: <Unknown group>");
 502         }
 503     }
 504
 505     private void printMention(
 506             PlainTextWriter writer, MessageEnvelope.Data.Mention mention
 507     ) {
 508         writer.println("- {}: {} (length: {})", formatContact(mention.recipient()), mention.start(), mention.length());
 509     }
 510
 511     private void printAttachment(PlainTextWriter writer, MessageEnvelope.Data.Attachment attachment) {
 512         writer.println("Content-Type: {}", attachment.contentType());
 513         writer.println("Type: {}", attachment.id().isPresent() ? "Pointer" : "Stream");
 514         if (attachment.id().isPresent()) {
 515             writer.println("Id: {}", attachment.id().get());
 516         }
 517         if (attachment.uploadTimestamp().isPresent()) {
 518             writer.println("Upload timestamp: {}", DateUtils.formatTimestamp(attachment.uploadTimestamp().get()));
 519         }
 520         if (attachment.caption().isPresent()) {
 521             writer.println("Caption: {}", attachment.caption().get());
 522         }
 523         if (attachment.fileName().isPresent()) {
 524             writer.println("Filename: {}", attachment.fileName().get());
 525         }
 526         if (attachment.size().isPresent() || attachment.preview().isPresent()) {
 527             writer.println("Size: {}{}",
 528                     attachment.size().isPresent() ? attachment.size().get() + " bytes" : "<unavailable>",
 529                     attachment.preview().isPresent() ? " (Preview is available: "
 530                             + attachment.preview().get().length
 531                             + " bytes)" : "");
 532         }
 533         if (attachment.thumbnail().isPresent()) {
 534             writer.println("Thumbnail:");
 535             printAttachment(writer.indentedWriter(), attachment.thumbnail().get());
 536         }
 537         final var flags = new ArrayList<String>();
 538         if (attachment.isVoiceNote()) {
 539             flags.add("voice note");
 540         }
 541         if (attachment.isBorderless()) {
 542             flags.add("borderless");
 543         }
 544         if (attachment.isGif()) {
 545             flags.add("video gif");
 546         }
 547         if (flags.size() > 0) {
 548             writer.println("Flags: {}", String.join(", ", flags));
 549         }
 550         if (attachment.width().isPresent() || attachment.height().isPresent()) {
 551             writer.println("Dimensions: {}x{}", attachment.width().orElse(0), attachment.height().orElse(0));
 552         }
 553         if (attachment.file().isPresent()) {
 554             var file = attachment.file().get();
 555             if (file.exists()) {
 556                 writer.println("Stored plaintext in: {}", file);
 557             }
 558         }
 559     }
 560
 561     private String formatContact(RecipientAddress address) {
 562         final var number = address.getLegacyIdentifier();
 563         final var name = m.getContactOrProfileName(RecipientIdentifier.Single.fromAddress(address));
 564         if (name == null || name.isEmpty()) {
 565             return number;
 566         } else {
 567             return MessageFormatter.arrayFormat("“{}” {}", new Object[]{name, number}).getMessage();
 568         }
 569     }
 570 }