Add a cancel button to progress notifications.

Author: Sam1301

app/src/main/java/com/zulip/android/activities/ZulipActivity.java

@@ -1127,6 +1127,16 @@ private MultipartBody.Part prepareFilePart(String partName, final File file, int
     private NotificationManager mNotificationManager;
     private NotificationCompat.Builder mBuilder;
 
+    private HashMap<Integer, Call<UploadResponse>> mCancelHashMap;
+
+    public void cancelRequest(int notificationId) throws NullPointerException{
+        Call<UploadResponse> call = mCancelHashMap.get(notificationId);
+        if (call != null) {
+            call.cancel();
+            mCancelHashMap.remove(notificationId);
+        }
+    }
+
     /**
      * Modifies notification {@link Notifications} of specifies {@param notificationId}
      * and sets its {@param content}.
@@ -1142,6 +1152,7 @@ private void setNotification(int notificationId, String content) {
                 .setOngoing(false)
                 // Removes the progress bar
                 .setProgress(0, 0, false);
+        mBuilder.mActions.clear();
         PendingIntent contentIntent = PendingIntent.getActivity(
                 getApplicationContext(),
                 0,
@@ -1158,13 +1169,15 @@ private void setNotification(int notificationId, String content) {
      * @param notificationId
      * @param percentage
      */
-    private void progressNotification(int notificationId, int percentage, String progress, String title) {
+    private void progressNotification(int notificationId, int percentage, String progress, String title, PendingIntent pendingIntent) {
         mBuilder.setSmallIcon(android.R.drawable.stat_sys_upload)
                 .setContentTitle(title)
                 .setContentText(progress)
                 .setAutoCancel(false)
                 .setOngoing(true)
                 .setProgress(100, percentage, false);
+        mBuilder.mActions.clear();
+        mBuilder.addAction(R.drawable.ic_cancel_black_24dp, getString(R.string.cancel_content_desp), pendingIntent);
         mNotificationManager.notify(notificationId, mBuilder.build());
     }
 
@@ -1188,6 +1201,7 @@ private void endNotification(int notificationId, String content) {
                 new Intent(),
                 PendingIntent.FLAG_UPDATE_CURRENT);
         mBuilder.setContentIntent(contentIntent);
+        mBuilder.mActions.clear();
         mNotificationManager.notify(notificationId, mBuilder.build());
     }
 
@@ -1207,6 +1221,12 @@ private void uploadFile(final File file) {
         // generate unique notification Id for this upload
         final int notifId = (int) (new Date().getTime() % Integer.MAX_VALUE);
 
+        // cancel pending intent
+        Intent actionIntent = new Intent(this, GcmBroadcastReceiver.class);
+        actionIntent.putExtra("id", notifId);
+        actionIntent.setAction(Constants.CANCEL);
+        final PendingIntent piAction = PendingIntent.getBroadcast(this, notifId, actionIntent, PendingIntent.FLAG_UPDATE_CURRENT);
+
         // update notification after every one second
         final long startTime = System.currentTimeMillis();
         final int[] counter = {0};
@@ -1215,7 +1235,7 @@ private void uploadFile(final File file) {
             public void onProgressUpdate(int percentage, String progress, int notificationId) {
                 if (System.currentTimeMillis() - startTime >= 1000 * counter[0]) {
                     // update notification
-                    progressNotification(notificationId, percentage, progress, file.getName());
+                    progressNotification(notificationId, percentage, progress, file.getName(), piAction);
                     counter[0]++;
                 }
             }
@@ -1224,12 +1244,16 @@ public void onProgressUpdate(int percentage, String progress, int notificationId
         // MultipartBody.Part is used to send also the actual file name
         MultipartBody.Part body = prepareFilePart("file", file, notifId, progressListener);
 
-        // start notification
-        setNotification(notifId, getString(R.string.init_notif_title) + getString(R.string.to_string) + getNotifTitle());
-
         // finally, execute the request
         // create upload service client
         Call<UploadResponse> call = ((ZulipApp) getApplicationContext()).getUploadServices().upload(body);
+        if (mCancelHashMap == null) {
+            mCancelHashMap = new HashMap<>();
+        }
+        mCancelHashMap.put(notifId, call);
+        Toast.makeText(this, R.string.upload_started_str, Toast.LENGTH_SHORT).show();
+        // start notification
+        setNotification(notifId, getString(R.string.init_notif_title) + getString(R.string.to_string) + getNotifTitle());
         call.enqueue(new DefaultCallback<UploadResponse>() {
             @Override
             public void onSuccess(Call<UploadResponse> call, Response<UploadResponse> response) {
@@ -1250,8 +1274,13 @@ public void onSuccess(Call<UploadResponse> call, Response<UploadResponse> respon
                 } else {
                     endNotification(notifId, getString(R.string.failed_to_upload));
                 }
-                mNotificationManager.cancel(notifId);
-
+                if (!(mCancelHashMap != null && mCancelHashMap.size() == 1)) {
+                    mNotificationManager.cancel(notifId);
+                }
+                if (mCancelHashMap != null) {
+                    mCancelHashMap.remove(notifId);
+                    mCancelHashMap = mCancelHashMap.isEmpty() ? null : mCancelHashMap;
+                }
             }
 
             @Override
@@ -1268,6 +1297,10 @@ public void onFailure(Call<UploadResponse> call, Throwable t) {
                 if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR1 && isDestroyed()) {
                     return;
                 }
+                if (call.isCanceled()) {
+                    mNotificationManager.cancel(notifId);
+                    return;
+                }
                 endNotification(notifId, getString(R.string.failed_to_upload));
                 mNotificationManager.cancel(notifId);
                 ZLog.logException(t);
@@ -2501,6 +2534,11 @@ protected void onDestroy() {
             mNotificationManager = (NotificationManager) this.getSystemService(Context.NOTIFICATION_SERVICE);
         }
         mNotificationManager.cancelAll();
+        if (mCancelHashMap != null) {
+            for (Call call : mCancelHashMap.values()) {
+                call.cancel();
+            }
+        }
     }
 
     /**

app/src/main/java/com/zulip/android/gcm/GcmBroadcastReceiver.java

@@ -8,6 +8,9 @@
 import android.util.Log;
 
 import com.google.android.gms.gcm.GoogleCloudMessaging;
+import com.zulip.android.ZulipApp;
+import com.zulip.android.util.Constants;
+import com.zulip.android.util.ZLog;
 
 // This class receives GCM messages from the cloud. It then passes them through a series of steps
 // to get a notification on the menu bar. See
@@ -22,13 +25,24 @@
 public class GcmBroadcastReceiver extends BroadcastReceiver {
 
     private static final String TAG = "GCM";
-
     public static String getGCMReceiverAction(Context appContext) {
         return appContext.getPackageName() + ".PushMessage.BROADCAST";
     }
 
     @Override
     public void onReceive(Context context, Intent intent) {
+        // handle cancel notification action on uploads
+        final String action = intent.getAction();
+        if (Constants.CANCEL.equals(action)) {
+            int notifId = intent.getIntExtra("id", 0);
+            try {
+                ZulipApp.get().getZulipActivity().cancelRequest(notifId);
+            } catch (NullPointerException e) {
+                ZLog.log("onReceive: app destroyed but notification visible");
+                return;
+            }
+        }
+
         Bundle extras = intent.getExtras();
         GoogleCloudMessaging gcm = GoogleCloudMessaging.getInstance(context);
         // The getMessageType() intent parameter must be the intent you received

app/src/main/java/com/zulip/android/util/Constants.java

@@ -1,5 +1,7 @@
 package com.zulip.android.util;
 
+import static android.R.string.cancel;
+
 /**
  * List of all Constants used in the projects
  */
@@ -16,7 +18,6 @@ public class Constants {
     public static String DATE_FORMAT = "dd/MM/yyyy";
     public static final int HIDE_FAB_AFTER_SEC = 5;
     public static final int REQUEST_PICK_FILE = 3;
-
     public static final long STATUS_UPDATER_INTERVAL = 25 * 1000; //in milliseconds
     public static final int INACTIVE_TIME_OUT = 2 * 60; //in milliseconds
     public static final int PEOPLE_DRAWER_ACTIVE_GROUP_ID = 0;
@@ -26,4 +27,5 @@ public class Constants {
     public static final int ALL_PEOPLE_ID = -1;
     // row number which is used to differentiate the '@-mentions' in people drawer
     public static int MENTIONS = -2;
+    public static final String CANCEL = "Cancel";
 }

app/src/main/java/com/zulip/android/util/ZLog.java

@@ -17,4 +17,11 @@ public static void logException(Throwable e) {
         }
     }
 
+    public static void log(String message) {
+        if (!BuildHelper.shouldLogToCrashlytics()) {
+            Log.e("Error", message);
+        } else {
+            Crashlytics.log(message);
+        }
+    }
 }

app/src/main/res/values/strings.xml

@@ -173,4 +173,5 @@
     <string name="photo_dialog">Take photo</string>
     <string name="pick_dialog">Pick a file</string>
     <string name="to_string">" to "</string>
+    <string name="upload_started_str">Upload started</string>
 </resources>