1 package org
.asamk
.signal
;
3 import org
.asamk
.signal
.manager
.Manager
;
4 import org
.asamk
.signal
.manager
.api
.MessageEnvelope
;
5 import org
.asamk
.signal
.manager
.api
.RecipientAddress
;
6 import org
.asamk
.signal
.manager
.api
.RecipientIdentifier
;
7 import org
.asamk
.signal
.manager
.api
.UntrustedIdentityException
;
8 import org
.asamk
.signal
.manager
.groups
.GroupId
;
9 import org
.asamk
.signal
.output
.PlainTextWriter
;
10 import org
.asamk
.signal
.util
.DateUtils
;
11 import org
.asamk
.signal
.util
.Hex
;
12 import org
.slf4j
.helpers
.MessageFormatter
;
14 import java
.util
.ArrayList
;
15 import java
.util
.stream
.Collectors
;
17 public class ReceiveMessageHandler
implements Manager
.ReceiveMessageHandler
{
20 final PlainTextWriter writer
;
22 public ReceiveMessageHandler(Manager m
, final PlainTextWriter writer
) {
28 public void handleMessage(MessageEnvelope envelope
, Throwable exception
) {
29 synchronized (writer
) {
30 handleMessageInternal(envelope
, exception
);
34 private void handleMessageInternal(MessageEnvelope envelope
, Throwable exception
) {
35 var source
= envelope
.sourceAddress();
36 writer
.println("Envelope from: {} (device: {}) to {}",
37 source
.map(this::formatContact
).orElse("unknown source"),
38 envelope
.sourceDevice(),
40 writer
.println("Timestamp: {}", DateUtils
.formatTimestamp(envelope
.timestamp()));
41 writer
.println("Server timestamps: received: {} delivered: {}",
42 DateUtils
.formatTimestamp(envelope
.serverReceivedTimestamp()),
43 DateUtils
.formatTimestamp(envelope
.serverDeliveredTimestamp()));
44 if (envelope
.isUnidentifiedSender()) {
45 writer
.println("Sent by unidentified/sealed sender");
48 if (exception
!= null) {
49 if (exception
instanceof UntrustedIdentityException e
) {
51 "The user’s key is untrusted, either the user has reinstalled Signal or a third party sent this message.");
52 final var recipientName
= e
.getSender().getLegacyIdentifier();
54 "Use 'signal-cli -a {} listIdentities -n {}', verify the key and run 'signal-cli -a {} trust -v \"FINGER_PRINT\" {}' to mark it as trusted",
60 "If you don't care about security, use 'signal-cli -a {} trust -a {}' to trust it without verification",
64 writer
.println("Exception: {} ({})", exception
.getMessage(), exception
.getClass().getSimpleName());
68 if (envelope
.data().isPresent()) {
69 var message
= envelope
.data().get();
70 printDataMessage(writer
, message
);
72 if (envelope
.story().isPresent()) {
73 var message
= envelope
.story().get();
74 printStoryMessage(writer
.indentedWriter(), message
);
76 if (envelope
.sync().isPresent()) {
77 writer
.println("Received a sync message");
78 var syncMessage
= envelope
.sync().get();
79 printSyncMessage(writer
, syncMessage
);
81 if (envelope
.call().isPresent()) {
82 writer
.println("Received a call message");
83 var callMessage
= envelope
.call().get();
84 printCallMessage(writer
.indentedWriter(), callMessage
);
86 if (envelope
.receipt().isPresent()) {
87 writer
.println("Received a receipt message");
88 var receiptMessage
= envelope
.receipt().get();
89 printReceiptMessage(writer
.indentedWriter(), receiptMessage
);
91 if (envelope
.typing().isPresent()) {
92 writer
.println("Received a typing message");
93 var typingMessage
= envelope
.typing().get();
94 printTypingMessage(writer
.indentedWriter(), typingMessage
);
99 private void printDataMessage(
100 PlainTextWriter writer
, MessageEnvelope
.Data message
102 writer
.println("Message timestamp: {}", DateUtils
.formatTimestamp(message
.timestamp()));
103 if (message
.isViewOnce()) {
104 writer
.println("=VIEW ONCE=");
107 if (message
.body().isPresent()) {
108 writer
.println("Body: {}", message
.body().get());
110 if (message
.groupContext().isPresent()) {
111 writer
.println("Group info:");
112 final var groupContext
= message
.groupContext().get();
113 printGroupContext(writer
.indentedWriter(), groupContext
);
115 if (message
.storyContext().isPresent()) {
116 writer
.println("Story reply:");
117 final var storyContext
= message
.storyContext().get();
118 printStoryContext(writer
.indentedWriter(), storyContext
);
120 if (message
.groupCallUpdate().isPresent()) {
121 writer
.println("Group call update:");
122 final var groupCallUpdate
= message
.groupCallUpdate().get();
123 writer
.indentedWriter().println("Era id: {}", groupCallUpdate
.eraId());
125 if (message
.previews().size() > 0) {
126 writer
.println("Previews:");
127 final var previews
= message
.previews();
128 for (var preview
: previews
) {
129 writer
.println("- Preview");
130 printPreview(writer
.indentedWriter(), preview
);
133 if (message
.sharedContacts().size() > 0) {
134 writer
.println("Contacts:");
135 for (var contact
: message
.sharedContacts()) {
136 writer
.println("- Contact:");
137 printSharedContact(writer
.indentedWriter(), contact
);
140 if (message
.sticker().isPresent()) {
141 final var sticker
= message
.sticker().get();
142 writer
.println("Sticker:");
143 printSticker(writer
.indentedWriter(), sticker
);
145 if (message
.isEndSession()) {
146 writer
.println("Is end session");
148 if (message
.isExpirationUpdate()) {
149 writer
.println("Is Expiration update: true");
151 if (message
.expiresInSeconds() > 0) {
152 writer
.println("Expires in: {} seconds", message
.expiresInSeconds());
154 if (message
.isProfileKeyUpdate()) {
155 writer
.println("Profile key update");
157 if (message
.hasProfileKey()) {
158 writer
.println("With profile key");
160 if (message
.reaction().isPresent()) {
161 writer
.println("Reaction:");
162 final var reaction
= message
.reaction().get();
163 printReaction(writer
.indentedWriter(), reaction
);
165 if (message
.quote().isPresent()) {
166 writer
.println("Quote:");
167 var quote
= message
.quote().get();
168 printQuote(writer
.indentedWriter(), quote
);
170 if (message
.remoteDeleteId().isPresent()) {
171 final var remoteDelete
= message
.remoteDeleteId().get();
172 writer
.println("Remote delete message: timestamp = {}", remoteDelete
);
174 if (message
.mentions().size() > 0) {
175 writer
.println("Mentions:");
176 for (var mention
: message
.mentions()) {
177 printMention(writer
, mention
);
180 if (message
.attachments().size() > 0) {
181 writer
.println("Attachments:");
182 for (var attachment
: message
.attachments()) {
183 writer
.println("- Attachment:");
184 printAttachment(writer
.indentedWriter(), attachment
);
189 private void printStoryMessage(
190 PlainTextWriter writer
, MessageEnvelope
.Story message
192 writer
.println("Story: with replies: {}", message
.allowsReplies());
193 if (message
.groupId().isPresent()) {
194 writer
.println("Group info:");
195 printGroupInfo(writer
.indentedWriter(), message
.groupId().get());
197 if (message
.textAttachment().isPresent()) {
198 writer
.println("Body: {}", message
.textAttachment().get().text().orElse(""));
200 if (message
.textAttachment().get().preview().isPresent()) {
201 writer
.println("Preview:");
202 printPreview(writer
.indentedWriter(), message
.textAttachment().get().preview().get());
205 if (message
.fileAttachment().isPresent()) {
206 writer
.println("Attachments:");
207 printAttachment(writer
.indentedWriter(), message
.fileAttachment().get());
211 private void printTypingMessage(
212 final PlainTextWriter writer
, final MessageEnvelope
.Typing typingMessage
214 writer
.println("Action: {}", typingMessage
.type());
215 writer
.println("Timestamp: {}", DateUtils
.formatTimestamp(typingMessage
.timestamp()));
216 if (typingMessage
.groupId().isPresent()) {
217 writer
.println("Group Info:");
218 final var groupId
= typingMessage
.groupId().get();
219 printGroupInfo(writer
.indentedWriter(), groupId
);
223 private void printReceiptMessage(
224 final PlainTextWriter writer
, final MessageEnvelope
.Receipt receiptMessage
226 writer
.println("When: {}", DateUtils
.formatTimestamp(receiptMessage
.when()));
227 if (receiptMessage
.type() == MessageEnvelope
.Receipt
.Type
.DELIVERY
) {
228 writer
.println("Is delivery receipt");
230 if (receiptMessage
.type() == MessageEnvelope
.Receipt
.Type
.READ
) {
231 writer
.println("Is read receipt");
233 if (receiptMessage
.type() == MessageEnvelope
.Receipt
.Type
.VIEWED
) {
234 writer
.println("Is viewed receipt");
236 writer
.println("Timestamps:");
237 for (long timestamp
: receiptMessage
.timestamps()) {
238 writer
.println("- {}", DateUtils
.formatTimestamp(timestamp
));
242 private void printCallMessage(
243 final PlainTextWriter writer
, final MessageEnvelope
.Call callMessage
245 if (callMessage
.destinationDeviceId().isPresent()) {
246 final var deviceId
= callMessage
.destinationDeviceId().get();
247 writer
.println("Destination device id: {}", deviceId
);
249 if (callMessage
.groupId().isPresent()) {
250 final var groupId
= callMessage
.groupId().get();
251 writer
.println("Destination group id: {}", groupId
);
253 if (callMessage
.timestamp().isPresent()) {
254 writer
.println("Timestamp: {}", DateUtils
.formatTimestamp(callMessage
.timestamp().get()));
256 if (callMessage
.answer().isPresent()) {
257 var answerMessage
= callMessage
.answer().get();
258 writer
.println("Answer message: {}, sdp: {})", answerMessage
.id(), answerMessage
.sdp());
260 if (callMessage
.busy().isPresent()) {
261 var busyMessage
= callMessage
.busy().get();
262 writer
.println("Busy message: {}", busyMessage
.id());
264 if (callMessage
.hangup().isPresent()) {
265 var hangupMessage
= callMessage
.hangup().get();
266 writer
.println("Hangup message: {}", hangupMessage
.id());
268 if (callMessage
.iceUpdate().size() > 0) {
269 writer
.println("Ice update messages:");
270 var iceUpdateMessages
= callMessage
.iceUpdate();
271 for (var iceUpdateMessage
: iceUpdateMessages
) {
272 writer
.println("- {}, sdp: {}", iceUpdateMessage
.id(), iceUpdateMessage
.sdp());
275 if (callMessage
.offer().isPresent()) {
276 var offerMessage
= callMessage
.offer().get();
277 writer
.println("Offer message: {}, sdp: {}", offerMessage
.id(), offerMessage
.sdp());
279 if (callMessage
.opaque().isPresent()) {
280 final var opaqueMessage
= callMessage
.opaque().get();
281 writer
.println("Opaque message: size {}, urgency: {}",
282 opaqueMessage
.opaque().length
,
283 opaqueMessage
.urgency().name());
287 private void printSyncMessage(
288 final PlainTextWriter writer
, final MessageEnvelope
.Sync syncMessage
290 if (syncMessage
.contacts().isPresent()) {
291 final var contactsMessage
= syncMessage
.contacts().get();
292 var type
= contactsMessage
.isComplete() ?
"complete" : "partial";
293 writer
.println("Received {} sync contacts:", type
);
295 if (syncMessage
.groups().isPresent()) {
296 writer
.println("Received sync groups.");
298 if (syncMessage
.read().size() > 0) {
299 writer
.println("Received sync read messages list");
300 for (var rm
: syncMessage
.read()) {
301 writer
.println("- From: {} Message timestamp: {}",
302 formatContact(rm
.sender()),
303 DateUtils
.formatTimestamp(rm
.timestamp()));
306 if (syncMessage
.viewed().size() > 0) {
307 writer
.println("Received sync viewed messages list");
308 for (var vm
: syncMessage
.viewed()) {
309 writer
.println("- From: {} Message timestamp: {}",
310 formatContact(vm
.sender()),
311 DateUtils
.formatTimestamp(vm
.timestamp()));
314 if (syncMessage
.sent().isPresent()) {
315 writer
.println("Received sync sent message");
316 final var sentTranscriptMessage
= syncMessage
.sent().get();
318 if (sentTranscriptMessage
.destination().isPresent()) {
319 to = formatContact(sentTranscriptMessage
.destination().get());
320 } else if (sentTranscriptMessage
.recipients().size() > 0) {
321 to = sentTranscriptMessage
.recipients()
323 .map(this::formatContact
)
324 .collect(Collectors
.joining(", "));
328 writer
.indentedWriter().println("To: {}", to);
329 writer
.indentedWriter()
330 .println("Timestamp: {}", DateUtils
.formatTimestamp(sentTranscriptMessage
.timestamp()));
331 if (sentTranscriptMessage
.expirationStartTimestamp() > 0) {
332 writer
.indentedWriter()
333 .println("Expiration started at: {}",
334 DateUtils
.formatTimestamp(sentTranscriptMessage
.expirationStartTimestamp()));
336 if (sentTranscriptMessage
.message().isPresent()) {
337 var message
= sentTranscriptMessage
.message().get();
338 printDataMessage(writer
.indentedWriter(), message
);
340 if (sentTranscriptMessage
.story().isPresent()) {
341 var message
= sentTranscriptMessage
.story().get();
342 printStoryMessage(writer
.indentedWriter(), message
);
345 if (syncMessage
.blocked().isPresent()) {
346 writer
.println("Received sync message with block list");
347 writer
.println("Blocked:");
348 final var blockedList
= syncMessage
.blocked().get();
349 for (var address
: blockedList
.recipients()) {
350 writer
.println("- {}", address
.getLegacyIdentifier());
352 for (var groupId
: blockedList
.groupIds()) {
353 writer
.println("- {}", groupId
.toBase64());
356 if (syncMessage
.viewOnceOpen().isPresent()) {
357 final var viewOnceOpenMessage
= syncMessage
.viewOnceOpen().get();
358 writer
.println("Received sync message with view once open message:");
359 writer
.indentedWriter().println("Sender: {}", formatContact(viewOnceOpenMessage
.sender()));
360 writer
.indentedWriter()
361 .println("Timestamp: {}", DateUtils
.formatTimestamp(viewOnceOpenMessage
.timestamp()));
363 if (syncMessage
.messageRequestResponse().isPresent()) {
364 final var requestResponseMessage
= syncMessage
.messageRequestResponse().get();
365 writer
.println("Received message request response:");
366 writer
.indentedWriter().println("Type: {}", requestResponseMessage
.type());
367 if (requestResponseMessage
.groupId().isPresent()) {
368 writer
.println("For group:");
369 printGroupInfo(writer
.indentedWriter(), requestResponseMessage
.groupId().get());
371 if (requestResponseMessage
.person().isPresent()) {
372 writer
.indentedWriter().println("For Person: {}", formatContact(requestResponseMessage
.person().get()));
377 private void printPreview(
378 final PlainTextWriter writer
, final MessageEnvelope
.Data
.Preview preview
380 writer
.println("Title: {}", preview
.title());
381 writer
.println("Description: {}", preview
.description());
382 writer
.println("Date: {}", DateUtils
.formatTimestamp(preview
.date()));
383 writer
.println("Url: {}", preview
.url());
384 if (preview
.image().isPresent()) {
385 writer
.println("Image:");
386 printAttachment(writer
.indentedWriter(), preview
.image().get());
390 private void printSticker(
391 final PlainTextWriter writer
, final MessageEnvelope
.Data
.Sticker sticker
393 writer
.println("Pack id: {}", Hex
.toStringCondensed(sticker
.packId().serialize()));
394 writer
.println("Sticker id: {}", sticker
.stickerId());
397 private void printReaction(
398 final PlainTextWriter writer
, final MessageEnvelope
.Data
.Reaction reaction
400 writer
.println("Emoji: {}", reaction
.emoji());
401 writer
.println("Target author: {}", formatContact(reaction
.targetAuthor()));
402 writer
.println("Target timestamp: {}", DateUtils
.formatTimestamp(reaction
.targetSentTimestamp()));
403 writer
.println("Is remove: {}", reaction
.isRemove());
406 private void printQuote(
407 final PlainTextWriter writer
, final MessageEnvelope
.Data
.Quote quote
409 writer
.println("Id: {}", quote
.id());
410 writer
.println("Author: {}", formatContact(quote
.author()));
411 if (quote
.text().isPresent()) {
412 writer
.println("Text: {}", quote
.text().get());
414 if (quote
.mentions() != null && quote
.mentions().size() > 0) {
415 writer
.println("Mentions:");
416 for (var mention
: quote
.mentions()) {
417 printMention(writer
, mention
);
420 if (quote
.attachments().size() > 0) {
421 writer
.println("Attachments:");
422 for (var attachment
: quote
.attachments()) {
423 writer
.println("- Attachment:");
424 printAttachment(writer
.indentedWriter(), attachment
);
429 private void printSharedContact(final PlainTextWriter writer
, final MessageEnvelope
.Data
.SharedContact contact
) {
430 writer
.println("Name:");
431 var name
= contact
.name();
433 if (name
.display().isPresent() && !name
.display().get().isBlank()) {
434 w
.println("Display name: {}", name
.display().get());
436 if (name
.given().isPresent() && !name
.given().get().isBlank()) {
437 w
.println("First name: {}", name
.given().get());
439 if (name
.middle().isPresent() && !name
.middle().get().isBlank()) {
440 w
.println("Middle name: {}", name
.middle().get());
442 if (name
.family().isPresent() && !name
.family().get().isBlank()) {
443 w
.println("Family name: {}", name
.family().get());
445 if (name
.prefix().isPresent() && !name
.prefix().get().isBlank()) {
446 w
.println("Prefix name: {}", name
.prefix().get());
448 if (name
.suffix().isPresent() && !name
.suffix().get().isBlank()) {
449 w
.println("Suffix name: {}", name
.suffix().get());
453 if (contact
.avatar().isPresent()) {
454 var avatar
= contact
.avatar().get();
455 writer
.println("Avatar: (profile: {})", avatar
.isProfile());
456 printAttachment(writer
.indentedWriter(), avatar
.attachment());
459 if (contact
.organization().isPresent()) {
460 writer
.println("Organisation: {}", contact
.organization().get());
463 if (contact
.phone().size() > 0) {
464 writer
.println("Phone details:");
465 for (var phone
: contact
.phone()) {
466 writer
.println("- Phone:");
468 w
.println("Number: {}", phone
.value());
469 w
.println("Type: {}", phone
.type());
470 if (phone
.label().isPresent() && !phone
.label().get().isBlank()) {
471 w
.println("Label: {}", phone
.label().get());
477 if (contact
.email().size() > 0) {
478 writer
.println("Email details:");
479 for (var email
: contact
.email()) {
480 writer
.println("- Email:");
482 w
.println("Address: {}", email
.value());
483 w
.println("Type: {}", email
.type());
484 if (email
.label().isPresent() && !email
.label().get().isBlank()) {
485 w
.println("Label: {}", email
.label().get());
491 if (contact
.address().size() > 0) {
492 writer
.println("Address details:");
493 for (var address
: contact
.address()) {
494 writer
.println("- Address:");
496 w
.println("Type: {}", address
.type());
497 if (address
.label().isPresent() && !address
.label().get().isBlank()) {
498 w
.println("Label: {}", address
.label().get());
500 if (address
.street().isPresent() && !address
.street().get().isBlank()) {
501 w
.println("Street: {}", address
.street().get());
503 if (address
.pobox().isPresent() && !address
.pobox().get().isBlank()) {
504 w
.println("Pobox: {}", address
.pobox().get());
506 if (address
.neighborhood().isPresent() && !address
.neighborhood().get().isBlank()) {
507 w
.println("Neighbourhood: {}", address
.neighborhood().get());
509 if (address
.city().isPresent() && !address
.city().get().isBlank()) {
510 w
.println("City: {}", address
.city().get());
512 if (address
.region().isPresent() && !address
.region().get().isBlank()) {
513 w
.println("Region: {}", address
.region().get());
515 if (address
.postcode().isPresent() && !address
.postcode().get().isBlank()) {
516 w
.println("Postcode: {}", address
.postcode().get());
518 if (address
.country().isPresent() && !address
.country().get().isBlank()) {
519 w
.println("Country: {}", address
.country().get());
526 private void printGroupContext(
527 final PlainTextWriter writer
, final MessageEnvelope
.Data
.GroupContext groupContext
529 printGroupInfo(writer
, groupContext
.groupId());
530 writer
.println("Revision: {}", groupContext
.revision());
531 writer
.println("Type: {}", groupContext
.isGroupUpdate() ?
"UPDATE" : "DELIVER");
534 private void printStoryContext(
535 final PlainTextWriter writer
, final MessageEnvelope
.Data
.StoryContext storyContext
537 writer
.println("Sender: {}", formatContact(storyContext
.author()));
538 writer
.println("Sent timestamp: {}", storyContext
.sentTimestamp());
541 private void printGroupInfo(final PlainTextWriter writer
, final GroupId groupId
) {
542 writer
.println("Id: {}", groupId
.toBase64());
544 var group
= m
.getGroup(groupId
);
546 writer
.println("Name: {}", group
.title());
548 writer
.println("Name: <Unknown group>");
552 private void printMention(
553 PlainTextWriter writer
, MessageEnvelope
.Data
.Mention mention
555 writer
.println("- {}: {} (length: {})", formatContact(mention
.recipient()), mention
.start(), mention
.length());
558 private void printAttachment(PlainTextWriter writer
, MessageEnvelope
.Data
.Attachment attachment
) {
559 writer
.println("Content-Type: {}", attachment
.contentType());
560 writer
.println("Type: {}", attachment
.id().isPresent() ?
"Pointer" : "Stream");
561 if (attachment
.id().isPresent()) {
562 writer
.println("Id: {}", attachment
.id().get());
564 if (attachment
.uploadTimestamp().isPresent()) {
565 writer
.println("Upload timestamp: {}", DateUtils
.formatTimestamp(attachment
.uploadTimestamp().get()));
567 if (attachment
.caption().isPresent()) {
568 writer
.println("Caption: {}", attachment
.caption().get());
570 if (attachment
.fileName().isPresent()) {
571 writer
.println("Filename: {}", attachment
.fileName().get());
573 if (attachment
.size().isPresent() || attachment
.preview().isPresent()) {
574 writer
.println("Size: {}{}",
575 attachment
.size().isPresent() ? attachment
.size().get() + " bytes" : "<unavailable>",
576 attachment
.preview().isPresent() ?
" (Preview is available: "
577 + attachment
.preview().get().length
580 if (attachment
.thumbnail().isPresent()) {
581 writer
.println("Thumbnail:");
582 printAttachment(writer
.indentedWriter(), attachment
.thumbnail().get());
584 final var flags
= new ArrayList
<String
>();
585 if (attachment
.isVoiceNote()) {
586 flags
.add("voice note");
588 if (attachment
.isBorderless()) {
589 flags
.add("borderless");
591 if (attachment
.isGif()) {
592 flags
.add("video gif");
594 if (flags
.size() > 0) {
595 writer
.println("Flags: {}", String
.join(", ", flags
));
597 if (attachment
.width().isPresent() || attachment
.height().isPresent()) {
598 writer
.println("Dimensions: {}x{}", attachment
.width().orElse(0), attachment
.height().orElse(0));
600 if (attachment
.file().isPresent()) {
601 var file
= attachment
.file().get();
603 writer
.println("Stored plaintext in: {}", file
);
608 private String
formatContact(RecipientAddress address
) {
609 final var number
= address
.getLegacyIdentifier();
610 final var name
= m
.getContactOrProfileName(RecipientIdentifier
.Single
.fromAddress(address
));
611 if (name
== null || name
.isEmpty()) {
614 return MessageFormatter
.arrayFormat("“{}” {}", new Object
[]{name
, number
}).getMessage();