nmode's Git Repositories - signal-cli/blob - lib/src/main/java/org/asamk/signal/manager/helper/ReceiveHelper.java

   1 package org.asamk.signal.manager.helper;
   2
   3 import org.asamk.signal.manager.Manager;
   4 import org.asamk.signal.manager.actions.HandleAction;
   5 import org.asamk.signal.manager.api.ReceiveConfig;
   6 import org.asamk.signal.manager.api.UntrustedIdentityException;
   7 import org.asamk.signal.manager.internal.SignalDependencies;
   8 import org.asamk.signal.manager.jobs.CleanOldPreKeysJob;
   9 import org.asamk.signal.manager.storage.SignalAccount;
  10 import org.asamk.signal.manager.storage.messageCache.CachedMessage;
  11 import org.asamk.signal.manager.storage.recipients.RecipientAddress;
  12 import org.slf4j.Logger;
  13 import org.slf4j.LoggerFactory;
  14 import org.whispersystems.signalservice.api.messages.SignalServiceEnvelope;
  15 import org.whispersystems.signalservice.api.push.ServiceId;
  16 import org.whispersystems.signalservice.api.push.ServiceId.ACI;
  17 import org.whispersystems.signalservice.api.websocket.SignalWebSocket;
  18 import org.whispersystems.signalservice.api.websocket.WebSocketConnectionState;
  19 import org.whispersystems.signalservice.api.websocket.WebSocketUnavailableException;
  20
  21 import java.io.IOException;
  22 import java.time.Duration;
  23 import java.util.Collection;
  24 import java.util.HashMap;
  25 import java.util.HashSet;
  26 import java.util.List;
  27 import java.util.Map;
  28 import java.util.Set;
  29 import java.util.concurrent.TimeoutException;
  30
  31 import io.reactivex.rxjava3.schedulers.Schedulers;
  32
  33 public class ReceiveHelper {
  34
  35     private static final Logger logger = LoggerFactory.getLogger(ReceiveHelper.class);
  36     private static final int MAX_BACKOFF_COUNTER = 9;
  37
  38     private final SignalAccount account;
  39     private final SignalDependencies dependencies;
  40     private final Context context;
  41
  42     private ReceiveConfig receiveConfig = new ReceiveConfig(false, false, false);
  43     private boolean hasCaughtUpWithOldMessages = false;
  44     private boolean isWaitingForMessage = false;
  45     private boolean shouldStop = false;
  46     private Callable authenticationFailureListener;
  47     private Callable caughtUpWithOldMessagesListener;
  48
  49     public ReceiveHelper(final Context context) {
  50         this.account = context.getAccount();
  51         this.dependencies = context.getDependencies();
  52         this.context = context;
  53     }
  54
  55     public void setReceiveConfig(final ReceiveConfig receiveConfig) {
  56         this.receiveConfig = receiveConfig;
  57         dependencies.setAllowStories(!receiveConfig.ignoreStories());
  58     }
  59
  60     public void setAuthenticationFailureListener(final Callable authenticationFailureListener) {
  61         this.authenticationFailureListener = authenticationFailureListener;
  62     }
  63
  64     public void setCaughtUpWithOldMessagesListener(final Callable caughtUpWithOldMessagesListener) {
  65         this.caughtUpWithOldMessagesListener = caughtUpWithOldMessagesListener;
  66     }
  67
  68     public boolean requestStopReceiveMessages() {
  69         this.shouldStop = true;
  70         return isWaitingForMessage;
  71     }
  72
  73     public void receiveMessagesContinuously(Manager.ReceiveMessageHandler handler) {
  74         while (!shouldStop) {
  75             try {
  76                 receiveMessages(Duration.ofMinutes(1), false, null, handler);
  77                 break;
  78             } catch (IOException e) {
  79                 logger.warn("Receiving messages failed, retrying", e);
  80             }
  81         }
  82     }
  83
  84     public void receiveMessages(
  85             Duration timeout,
  86             boolean returnOnTimeout,
  87             Integer maxMessages,
  88             Manager.ReceiveMessageHandler handler
  89     ) throws IOException {
  90         account.setNeedsToRetryFailedMessages(true);
  91         hasCaughtUpWithOldMessages = false;
  92
  93         // Use a Map here because java Set doesn't have a get method ...
  94         Map<HandleAction, HandleAction> queuedActions = new HashMap<>();
  95
  96         final var signalWebSocket = dependencies.getAuthenticatedSignalWebSocket();
  97         final var webSocketStateDisposable = signalWebSocket.getState()
  98                 .subscribeOn(Schedulers.computation())
  99                 .observeOn(Schedulers.computation())
 100                 .distinctUntilChanged()
 101                 .subscribe(this::onWebSocketStateChange);
 102         signalWebSocket.connect();
 103
 104         try {
 105             receiveMessagesInternal(signalWebSocket, timeout, returnOnTimeout, maxMessages, handler, queuedActions);
 106         } finally {
 107             hasCaughtUpWithOldMessages = false;
 108             handleQueuedActions(queuedActions.keySet());
 109             queuedActions.clear();
 110             signalWebSocket.disconnect();
 111             webSocketStateDisposable.dispose();
 112             shouldStop = false;
 113         }
 114     }
 115
 116     private void receiveMessagesInternal(
 117             final SignalWebSocket.AuthenticatedWebSocket signalWebSocket,
 118             Duration timeout,
 119             boolean returnOnTimeout,
 120             Integer maxMessages,
 121             Manager.ReceiveMessageHandler handler,
 122             final Map<HandleAction, HandleAction> queuedActions
 123     ) throws IOException {
 124         int remainingMessages = maxMessages == null ? -1 : maxMessages;
 125         var backOffCounter = 0;
 126         isWaitingForMessage = false;
 127
 128         while (!shouldStop && remainingMessages != 0) {
 129             if (account.getNeedsToRetryFailedMessages()) {
 130                 retryFailedReceivedMessages(handler);
 131             }
 132             SignalServiceEnvelope envelope;
 133             final CachedMessage[] cachedMessage = {null};
 134             final var nowMillis = System.currentTimeMillis();
 135             if (nowMillis - account.getLastReceiveTimestamp() > 60000) {
 136                 account.setLastReceiveTimestamp(nowMillis);
 137             }
 138             logger.debug("Checking for new message from server");
 139             try {
 140                 isWaitingForMessage = true;
 141                 var queueNotEmpty = signalWebSocket.readMessageBatch(timeout.toMillis(), 1, batch -> {
 142                     logger.debug("Retrieved {} envelopes!", batch.size());
 143                     isWaitingForMessage = false;
 144                     for (final var it : batch) {
 145                         SignalServiceEnvelope envelope1 = new SignalServiceEnvelope(it.getEnvelope(),
 146                                 it.getServerDeliveredTimestamp());
 147                         final var recipientId = envelope1.getSourceServiceId()
 148                                 .map(ServiceId::parseOrNull)
 149                                 .map(s -> account.getRecipientResolver().resolveRecipient(s))
 150                                 .orElse(null);
 151                         logger.trace("Storing new message from {}", recipientId);
 152                         // store message on disk, before acknowledging receipt to the server
 153                         cachedMessage[0] = account.getMessageCache().cacheMessage(envelope1, recipientId);
 154                         try {
 155                             signalWebSocket.sendAck(it);
 156                         } catch (IOException e) {
 157                             logger.warn("Failed to ack envelope to server after storing it: {}", e.getMessage());
 158                         }
 159                     }
 160                 });
 161                 isWaitingForMessage = false;
 162                 backOffCounter = 0;
 163
 164                 if (queueNotEmpty) {
 165                     if (remainingMessages > 0) {
 166                         remainingMessages -= 1;
 167                     }
 168                     envelope = cachedMessage[0].loadEnvelope();
 169                     logger.debug("New message received from server");
 170                 } else {
 171                     logger.debug("Received indicator that server queue is empty");
 172                     handleQueuedActions(queuedActions.keySet());
 173                     queuedActions.clear();
 174
 175                     context.getJobExecutor().enqueueJob(new CleanOldPreKeysJob());
 176                     hasCaughtUpWithOldMessages = true;
 177                     caughtUpWithOldMessagesListener.call();
 178
 179                     // Continue to wait another timeout for new messages
 180                     continue;
 181                 }
 182             } catch (AssertionError e) {
 183                 if (e.getCause() instanceof InterruptedException) {
 184                     break;
 185                 } else {
 186                     throw e;
 187                 }
 188             } catch (IOException e) {
 189                 logger.debug("Pipe unexpectedly unavailable: {}", e.getMessage());
 190                 if (e instanceof WebSocketUnavailableException || "Connection closed!".equals(e.getMessage())) {
 191                     final var sleepMilliseconds = 100 * (long) Math.pow(2, backOffCounter);
 192                     backOffCounter = Math.min(backOffCounter + 1, MAX_BACKOFF_COUNTER);
 193                     logger.warn("Connection closed unexpectedly, reconnecting in {} ms", sleepMilliseconds);
 194                     try {
 195                         Thread.sleep(sleepMilliseconds);
 196                     } catch (InterruptedException interruptedException) {
 197                         return;
 198                     }
 199                     hasCaughtUpWithOldMessages = false;
 200                     signalWebSocket.connect();
 201                     continue;
 202                 }
 203                 throw e;
 204             } catch (TimeoutException e) {
 205                 backOffCounter = 0;
 206                 if (returnOnTimeout) return;
 207                 continue;
 208             } catch (Exception e) {
 209                 logger.error("Unknown error when receiving messages", e);
 210                 continue;
 211             }
 212
 213             try {
 214                 final var result = context.getIncomingMessageHandler().handleEnvelope(envelope, receiveConfig, handler);
 215                 for (final var h : result.first()) {
 216                     final var existingAction = queuedActions.get(h);
 217                     if (existingAction == null) {
 218                         queuedActions.put(h, h);
 219                     } else {
 220                         existingAction.mergeOther(h);
 221                     }
 222                 }
 223                 final var exception = result.second();
 224
 225                 if (hasCaughtUpWithOldMessages) {
 226                     handleQueuedActions(queuedActions.keySet());
 227                     queuedActions.clear();
 228                 }
 229                 if (cachedMessage[0] != null) {
 230                     if (exception instanceof UntrustedIdentityException) {
 231                         logger.debug("Keeping message with untrusted identity in message cache");
 232                         final var address = ((UntrustedIdentityException) exception).getSender();
 233                         if (envelope.getSourceServiceId().isEmpty() && address.aci().isPresent()) {
 234                             final var recipientId = account.getRecipientResolver()
 235                                     .resolveRecipient(ACI.parseOrThrow(address.aci().get()));
 236                             try {
 237                                 cachedMessage[0] = account.getMessageCache()
 238                                         .replaceSender(cachedMessage[0], recipientId);
 239                             } catch (IOException ioException) {
 240                                 logger.warn("Failed to move cached message to recipient folder: {}",
 241                                         ioException.getMessage(),
 242                                         ioException);
 243                             }
 244                         }
 245                     } else {
 246                         cachedMessage[0].delete();
 247                     }
 248                 }
 249             } catch (Exception e) {
 250                 logger.error("Unknown error when handling messages", e);
 251             }
 252         }
 253     }
 254
 255     private void retryFailedReceivedMessages(Manager.ReceiveMessageHandler handler) {
 256         Set<HandleAction> queuedActions = new HashSet<>();
 257         for (var cachedMessage : account.getMessageCache().getCachedMessages()) {
 258             var actions = retryFailedReceivedMessage(handler, cachedMessage);
 259             if (actions != null) {
 260                 queuedActions.addAll(actions);
 261             }
 262         }
 263         handleQueuedActions(queuedActions);
 264         account.setNeedsToRetryFailedMessages(false);
 265     }
 266
 267     private List<HandleAction> retryFailedReceivedMessage(
 268             final Manager.ReceiveMessageHandler handler,
 269             final CachedMessage cachedMessage
 270     ) {
 271         var envelope = cachedMessage.loadEnvelope();
 272         if (envelope == null) {
 273             cachedMessage.delete();
 274             return null;
 275         }
 276
 277         final var result = context.getIncomingMessageHandler().handleRetryEnvelope(envelope, receiveConfig, handler);
 278         final var actions = result.first();
 279         final var exception = result.second();
 280
 281         if (exception instanceof UntrustedIdentityException) {
 282             if (System.currentTimeMillis() - envelope.getServerDeliveredTimestamp() > 1000L * 60 * 60 * 24 * 14) {
 283                 // Envelope is more than two weeks old, cleaning up.
 284                 cachedMessage.delete();
 285                 return null;
 286             }
 287             if (envelope.getSourceServiceId().isEmpty()) {
 288                 final var identifier = ((UntrustedIdentityException) exception).getSender();
 289                 final var recipientId = account.getRecipientResolver()
 290                         .resolveRecipient(new RecipientAddress(identifier));
 291                 try {
 292                     account.getMessageCache().replaceSender(cachedMessage, recipientId);
 293                 } catch (IOException ioException) {
 294                     logger.warn("Failed to move cached message to recipient folder: {}",
 295                             ioException.getMessage(),
 296                             ioException);
 297                 }
 298             }
 299             return null;
 300         }
 301
 302         // If successful and for all other errors that are not recoverable, delete the cached message
 303         cachedMessage.delete();
 304         return actions;
 305     }
 306
 307     private void handleQueuedActions(final Collection<HandleAction> queuedActions) {
 308         logger.debug("Handling message actions");
 309         for (var action : queuedActions) {
 310             logger.debug("Executing action {}", action.getClass().getSimpleName());
 311             try {
 312                 action.execute(context);
 313             } catch (Throwable e) {
 314                 logger.warn("Message action failed.", e);
 315             }
 316         }
 317     }
 318
 319     private void onWebSocketStateChange(final WebSocketConnectionState s) {
 320         if (s.equals(WebSocketConnectionState.AUTHENTICATION_FAILED)) {
 321             account.setRegistered(false);
 322             authenticationFailureListener.call();
 323         }
 324     }
 325
 326     public interface Callable {
 327
 328         void call();
 329     }
 330 }