Implement better backup failure notification strategy.

2026-04-21 00:59:49 +01:00 · 2020-10-20 15:13:05 -03:00
parent ffc7c13717
commit f4d3fe9176
4 changed files with 93 additions and 21 deletions
--- a/app/src/main/java/org/thoughtcrime/securesms/backup/BackupFileIOError.java
+++ b/app/src/main/java/org/thoughtcrime/securesms/backup/BackupFileIOError.java
@@ -0,0 +1,77 @@
+package org.thoughtcrime.securesms.backup;
+
+import android.app.Notification;
+import android.app.PendingIntent;
+import android.content.Context;
+import android.content.Intent;
+
+import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
+import androidx.annotation.StringRes;
+import androidx.core.app.NotificationCompat;
+import androidx.core.app.NotificationManagerCompat;
+
+import org.thoughtcrime.securesms.ApplicationPreferencesActivity;
+import org.thoughtcrime.securesms.R;
+import org.thoughtcrime.securesms.notifications.NotificationChannels;
+
+import java.io.IOException;
+
+public enum BackupFileIOError {
+  ACCESS_ERROR(R.string.LocalBackupJobApi29_backups_disabled, R.string.LocalBackupJobApi29_your_backup_directory_has_been_deleted_or_moved),
+  FILE_TOO_LARGE(R.string.LocalBackupJobApi29_backup_failed, R.string.LocalBackupJobApi29_your_backup_file_is_too_large),
+  NOT_ENOUGH_SPACE(R.string.LocalBackupJobApi29_backup_failed, R.string.LocalBackupJobApi29_there_is_not_enough_space),
+  UNKNOWN(R.string.LocalBackupJobApi29_backup_failed, R.string.LocalBackupJobApi29_backup_failed_for_an_unknown_reason);
+
+  private static final short BACKUP_FAILED_ID = 31321;
+
+  private final @StringRes int titleId;
+  private final @StringRes int messageId;
+
+  BackupFileIOError(@StringRes int titleId, @StringRes int messageId) {
+    this.titleId     = titleId;
+    this.messageId   = messageId;
+  }
+
+  public static void clearNotification(@NonNull Context context) {
+    NotificationManagerCompat.from(context).cancel(BACKUP_FAILED_ID);
+  }
+
+  public void postNotification(@NonNull Context context) {
+    Intent intent = new Intent(context, ApplicationPreferencesActivity.class);
+
+    intent.putExtra(ApplicationPreferencesActivity.LAUNCH_TO_BACKUPS_FRAGMENT, true);
+
+    PendingIntent pendingIntent            = PendingIntent.getActivity(context, -1, intent, 0);
+    Notification backupFailedNotification = new NotificationCompat.Builder(context, NotificationChannels.BACKUPS)
+                                                                  .setSmallIcon(R.drawable.ic_signal_backup)
+                                                                  .setContentTitle(context.getString(titleId))
+                                                                  .setContentText(context.getString(messageId))
+                                                                  .setContentIntent(pendingIntent)
+                                                                  .build();
+
+    NotificationManagerCompat.from(context)
+                             .notify(BACKUP_FAILED_ID, backupFailedNotification);
+  }
+
+  public static void postNotificationForException(@NonNull Context context, @NonNull IOException e, int runAttempt) {
+    BackupFileIOError error = getFromException(e);
+
+    if (error != null) {
+      error.postNotification(context);
+    }
+
+    if (error == null && runAttempt > 0) {
+      UNKNOWN.postNotification(context);
+    }
+  }
+
+  private static @Nullable BackupFileIOError getFromException(@NonNull IOException e) {
+    if (e.getMessage() != null) {
+           if (e.getMessage().contains("EFBIG"))  return FILE_TOO_LARGE;
+      else if (e.getMessage().contains("ENOSPC")) return NOT_ENOUGH_SPACE;
+    }
+
+    return null;
+  }
+}