Fixes commons-app#3790- Use WorkManagers to upload contributions (commons-app#4298)

* Fixes commons-app#3790
Use WorkManagers to process upload contributions
** Removed UploadService and Added UploadWorker to process contributions Upload
** Made nescessary changes to remove the usages of the Service from the classes
** UI Fxies- Minor changes in the retry and cancel uplaod icons to give them a clickable area of 48 dp

* Fixes commons-app#3790
Use WorkManagers to process upload contributions
** Removed UploadService and Added UploadWorker to process contributions Upload
** Made nescessary changes to remove the usages of the Service from the classes
** UI Fxies- Minor changes in the retry and cancel uplaod icons to give them a clickable area of 48 dp

* Updated JavaDocs in UploadWorker, Fixed Test cases

* Updated JavaDocs in UploadWorker, Fixed Test cases

* Updated gradle

* Revert "Updated gradle"

This reverts commit c8979fe.

* rolledback to compileSDKVersion 28, fixed tests

* Don't call the show notifications on the main thread

* Bug Fix- Duplicate contributions, handle upload stash errors

Author: ashishkumar468

app/build.gradle

@@ -67,9 +67,11 @@ dependencies {
     implementation "com.squareup.okhttp3:logging-interceptor:$OKHTTP_VERSION"
 
     // Dependency injector
+    implementation "com.google.dagger:dagger-android:$DAGGER_VERSION"
     implementation "com.google.dagger:dagger-android-support:$DAGGER_VERSION"
     kapt "com.google.dagger:dagger-android-processor:$DAGGER_VERSION"
     kapt "com.google.dagger:dagger-compiler:$DAGGER_VERSION"
+    annotationProcessor "com.google.dagger:dagger-android-processor:$DAGGER_VERSION"
 
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$KOTLIN_VERSION"
     implementation "org.jetbrains.kotlin:kotlin-reflect:$KOTLIN_VERSION"
@@ -145,6 +147,10 @@ dependencies {
     implementation "androidx.preference:preference-ktx:$PREFERENCE_VERSION"
 
     implementation "androidx.multidex:multidex:$MULTIDEX_VERSION"
+
+    def work_version = "2.4.0"
+    // Kotlin + coroutines
+    implementation "androidx.work:work-runtime-ktx:$work_version"
 }
 
 android {

app/src/main/AndroidManifest.xml

@@ -135,8 +135,7 @@
             android:name=".review.ReviewActivity"
             android:label="@string/title_activity_review" />
 
-        <service android:name=".upload.UploadService" />
-        <service
+      <service
             android:name=".auth.WikiAccountAuthenticatorService"
             android:exported="true"
             android:process=":auth">

app/src/main/java/fr/free/nrw/commons/CommonsApplication.java

@@ -47,7 +47,9 @@
 import io.reactivex.plugins.RxJavaPlugins;
 import io.reactivex.schedulers.Schedulers;
 import java.io.File;
+import java.util.HashMap;
 import java.util.HashSet;
+import java.util.Map;
 import java.util.Set;
 import javax.inject.Inject;
 import javax.inject.Named;
@@ -126,7 +128,12 @@ public AppLanguageLookUpTable getLanguageLookUpTable() {
 
     @Inject ContributionDao contributionDao;
 
-    /**
+  /**
+   * In memory list of contributios whose uploads ahve been paused by the user
+   */
+  public static Map<String, Boolean> pauseUploads = new HashMap<>();
+
+  /**
      * Used to declare and initialize various components and dependencies
      */
     @Override

app/src/main/java/fr/free/nrw/commons/auth/SessionManager.java

@@ -136,4 +136,14 @@ public Completable logout() {
                     currentAccount = null;
                 });
     }
+
+    /**
+     * Return a corresponding boolean preference
+     *
+     * @param key
+     * @return
+     */
+    public boolean getPreference(String key) {
+        return defaultKvStore.getBoolean(key);
+    }
 }

app/src/main/java/fr/free/nrw/commons/contributions/ChunkInfo.kt

@@ -5,7 +5,7 @@ import android.os.Parcelable
 import fr.free.nrw.commons.upload.UploadResult
 
 data class ChunkInfo(
-    val uploadResult: UploadResult,
+    val uploadResult: UploadResult?,
     val indexOfNextChunkToUpload: Int,
     val totalChunks: Int
 ) : Parcelable {

app/src/main/java/fr/free/nrw/commons/contributions/ContributionController.java

@@ -1,13 +1,11 @@
 package fr.free.nrw.commons.contributions;
 
-import static fr.free.nrw.commons.upload.UploadService.EXTRA_FILES;
 import static fr.free.nrw.commons.wikidata.WikidataConstants.PLACE_OBJECT;
 
 import android.Manifest;
 import android.app.Activity;
 import android.content.Context;
 import android.content.Intent;
-import android.util.Log;
 import androidx.annotation.NonNull;
 import fr.free.nrw.commons.R;
 import fr.free.nrw.commons.filepicker.DefaultCallback;
@@ -29,7 +27,6 @@
 public class ContributionController {
 
     public static final String ACTION_INTERNAL_UPLOADS = "internalImageUploads";
-
     private final JsonKvStore defaultKvStore;
 
     @Inject
@@ -130,7 +127,8 @@ private Intent handleImagesPicked(Context context,
         List<UploadableFile> imagesFiles) {
         Intent shareIntent = new Intent(context, UploadActivity.class);
         shareIntent.setAction(ACTION_INTERNAL_UPLOADS);
-        shareIntent.putParcelableArrayListExtra(EXTRA_FILES, new ArrayList<>(imagesFiles));
+        shareIntent
+            .putParcelableArrayListExtra(UploadActivity.EXTRA_FILES, new ArrayList<>(imagesFiles));
         Place place = defaultKvStore.getJson(PLACE_OBJECT, Place.class);
 
         if (place != null) {

app/src/main/java/fr/free/nrw/commons/contributions/ContributionDao.java

@@ -39,12 +39,6 @@ public void deleteAndSaveContribution(final Contribution oldContribution,
     saveSynchronous(newContribution);
   }
 
-  public Completable saveAndDelete(final Contribution oldContribution,
-      final Contribution newContribution) {
-    return Completable
-        .fromAction(() -> deleteAndSaveContribution(oldContribution, newContribution));
-  }
-
   @Insert(onConflict = OnConflictStrategy.REPLACE)
   public abstract Single<List<Long>> save(List<Contribution> contribution);
 
@@ -62,11 +56,8 @@ public Completable delete(final Contribution contribution) {
   @Query("SELECT * from contribution WHERE pageId=:pageId")
   public abstract Contribution getContribution(String pageId);
 
-  @Query("SELECT * from contribution WHERE state=:state")
-  public abstract Single<List<Contribution>> getContribution(int state);
-
-  @Query("UPDATE contribution SET state=:state WHERE state in (:toUpdateStates)")
-  public abstract Single<Integer> updateStates(int state, int[] toUpdateStates);
+  @Query("SELECT * from contribution WHERE state IN (:states) order by media_dateUploaded DESC")
+  public abstract Single<List<Contribution>> getContribution(List<Integer> states);
 
   @Query("SELECT COUNT(*) from contribution WHERE state in (:toUpdateStates)")
   public abstract Single<Integer> getPendingUploads(int[] toUpdateStates);

app/src/main/java/fr/free/nrw/commons/contributions/ContributionsContract.java

@@ -1,5 +1,6 @@
 package fr.free.nrw.commons.contributions;
 
+import android.content.Context;
 import fr.free.nrw.commons.BasePresenter;
 
 /**
@@ -10,6 +11,8 @@ public class ContributionsContract {
     public interface View {
 
         void showMessage(String localizedMessage);
+
+        Context getContext();
     }
 
     public interface UserActionListener extends BasePresenter<ContributionsContract.View> {
@@ -18,5 +21,6 @@ public interface UserActionListener extends BasePresenter<ContributionsContract.
 
         void deleteUpload(Contribution contribution);
 
+        void saveContribution(Contribution contribution);
     }
 }

app/src/main/java/fr/free/nrw/commons/contributions/ContributionsFragment.java

@@ -6,49 +6,30 @@
 
 import android.Manifest;
 import android.annotation.SuppressLint;
-import android.app.Activity;
-import android.content.ComponentName;
 import android.content.Context;
-import android.content.Intent;
-import android.content.ServiceConnection;
 import android.os.Bundle;
-import android.os.IBinder;
 import android.view.LayoutInflater;
 import android.view.Menu;
 import android.view.MenuInflater;
 import android.view.MenuItem;
 import android.view.MenuItem.OnMenuItemClickListener;
 import android.view.View;
-import android.view.View.OnClickListener;
 import android.view.ViewGroup;
 import android.widget.CheckBox;
 import android.widget.LinearLayout;
 import android.widget.TextView;
 import android.widget.Toast;
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
-import androidx.appcompat.widget.SwitchCompat;
 import androidx.fragment.app.Fragment;
 import androidx.fragment.app.FragmentManager.OnBackStackChangedListener;
 import androidx.fragment.app.FragmentTransaction;
-
-import fr.free.nrw.commons.CommonsApplication;
-import fr.free.nrw.commons.MediaDataExtractor;
-import fr.free.nrw.commons.auth.SessionManager;
-import fr.free.nrw.commons.notification.Notification;
-import fr.free.nrw.commons.notification.NotificationController;
-import fr.free.nrw.commons.theme.BaseActivity;
-import fr.free.nrw.commons.upload.UploadService.ServiceCallback;
-import io.reactivex.disposables.Disposable;
-import java.util.List;
-
-import javax.inject.Inject;
-import javax.inject.Named;
-
 import butterknife.BindView;
 import butterknife.ButterKnife;
+import fr.free.nrw.commons.CommonsApplication;
 import fr.free.nrw.commons.Media;
 import fr.free.nrw.commons.R;
+import fr.free.nrw.commons.auth.SessionManager;
 import fr.free.nrw.commons.campaigns.Campaign;
 import fr.free.nrw.commons.campaigns.CampaignView;
 import fr.free.nrw.commons.campaigns.CampaignsPresenter;
@@ -66,8 +47,10 @@
 import fr.free.nrw.commons.nearby.NearbyController;
 import fr.free.nrw.commons.nearby.NearbyNotificationCardView;
 import fr.free.nrw.commons.nearby.Place;
+import fr.free.nrw.commons.notification.Notification;
 import fr.free.nrw.commons.notification.NotificationActivity;
-import fr.free.nrw.commons.upload.UploadService;
+import fr.free.nrw.commons.notification.NotificationController;
+import fr.free.nrw.commons.theme.BaseActivity;
 import fr.free.nrw.commons.utils.ConfigUtils;
 import fr.free.nrw.commons.utils.DialogUtil;
 import fr.free.nrw.commons.utils.NetworkUtils;
@@ -77,6 +60,9 @@
 import io.reactivex.android.schedulers.AndroidSchedulers;
 import io.reactivex.disposables.CompositeDisposable;
 import io.reactivex.schedulers.Schedulers;
+import java.util.List;
+import javax.inject.Inject;
+import javax.inject.Named;
 import timber.log.Timber;
 
 public class ContributionsFragment
@@ -85,16 +71,14 @@ public class ContributionsFragment
         OnBackStackChangedListener,
         LocationUpdateListener,
     MediaDetailProvider,
-    ICampaignsView, ContributionsContract.View, Callback , ServiceCallback {
+    ICampaignsView, ContributionsContract.View, Callback{
     @Inject @Named("default_preferences") JsonKvStore store;
     @Inject NearbyController nearbyController;
     @Inject OkHttpJsonApiClient okHttpJsonApiClient;
     @Inject CampaignsPresenter presenter;
     @Inject LocationServiceManager locationManager;
     @Inject NotificationController notificationController;
 
-    private UploadService uploadService;
-    private boolean isUploadServiceConnected;
     private CompositeDisposable compositeDisposable = new CompositeDisposable();
 
     private ContributionsListFragment contributionsListFragment;
@@ -127,33 +111,7 @@ public static ContributionsFragment newInstance() {
         return fragment;
     }
 
-    /**
-     * Since we will need to use parent activity on onAuthCookieAcquired, we have to wait
-     * fragment to be attached. Latch will be responsible for this sync.
-     */
-    private ServiceConnection uploadServiceConnection = new ServiceConnection() {
-        @Override
-        public void onServiceConnected(ComponentName componentName, IBinder binder) {
-            uploadService = (UploadService) ((UploadService.UploadServiceLocalBinder) binder)
-                    .getService();
-            uploadService.setServiceCallback(ContributionsFragment.this);
-            isUploadServiceConnected = true;
-        }
-
-        @Override
-        public void onServiceDisconnected(ComponentName componentName) {
-            // this should never happen
-            Timber.e(new RuntimeException("UploadService died but the rest of the process did not!"));
-            isUploadServiceConnected = false;
-        }
-
-        @Override
-        public void onBindingDied(final ComponentName name) {
-            isUploadServiceConnected = false;
-        }
-    };
     private boolean shouldShowMediaDetailsFragment;
-    private boolean isAuthCookieAcquired;
 
     @Override
     public void onCreate(@Nullable Bundle savedInstanceState) {
@@ -272,7 +230,6 @@ public void onAttach(Context context) {
         until fragment life time ends.
          */
         if (!isFragmentAttachedBefore && getActivity() != null) {
-            onAuthCookieAcquired();
             isFragmentAttachedBefore = true;
         }
     }
@@ -312,19 +269,6 @@ public void onBackStackChanged() {
         fetchCampaigns();
     }
 
-    /**
-     * Called when onAuthCookieAcquired is called on authenticated parent activity
-     */
-    void onAuthCookieAcquired() {
-        // Since we call onAuthCookieAcquired method from onAttach, isAdded is still false. So don't use it
-        isAuthCookieAcquired=true;
-        if (getActivity() != null) { // If fragment is attached to parent activity
-            getActivity().bindService(getUploadServiceIntent(), uploadServiceConnection, Context.BIND_AUTO_CREATE);
-            isUploadServiceConnected = true;
-        }
-
-    }
-
     private void initFragments() {
         if (null == contributionsListFragment) {
             contributionsListFragment = new ContributionsListFragment();
@@ -381,13 +325,6 @@ public void removeFragment(Fragment fragment) {
         getChildFragmentManager().executePendingTransactions();
     }
 
-
-    public Intent getUploadServiceIntent(){
-        Intent intent = new Intent(getActivity(), UploadService.class);
-        intent.setAction(UploadService.ACTION_START_SERVICE);
-        return intent;
-    }
-
     @SuppressWarnings("ConstantConditions")
     private void setUploadCount() {
         compositeDisposable.add(okHttpJsonApiClient
@@ -524,14 +461,6 @@ public void onDestroy() {
             locationManager.unregisterLocationManager();
             locationManager.removeLocationListener(this);
             super.onDestroy();
-
-            if (isUploadServiceConnected) {
-                if (getActivity() != null) {
-                    uploadService.setServiceCallback(null);
-                    getActivity().unbindService(uploadServiceConnection);
-                    isUploadServiceConnected = false;
-                }
-            }
         } catch (IllegalArgumentException | IllegalStateException exception) {
             Timber.e(exception);
         }
@@ -594,7 +523,6 @@ private void fetchCampaigns() {
 
     @Override public void onDestroyView() {
         super.onDestroyView();
-        isUploadServiceConnected = false;
         presenter.onDetachView();
     }
 
@@ -606,8 +534,9 @@ private void fetchCampaigns() {
     @Override
     public void retryUpload(Contribution contribution) {
         if (NetworkUtils.isInternetConnectionEstablished(getContext())) {
-            if (contribution.getState() == STATE_FAILED || contribution.getState() == STATE_PAUSED || contribution.getState()==Contribution.STATE_QUEUED_LIMITED_CONNECTION_MODE && null != uploadService) {
-                uploadService.queue(contribution);
+            if (contribution.getState() == STATE_FAILED || contribution.getState() == STATE_PAUSED || contribution.getState()==Contribution.STATE_QUEUED_LIMITED_CONNECTION_MODE) {
+                contribution.setState(Contribution.STATE_QUEUED);
+                contributionsPresenter.saveContribution(contribution);
                 Timber.d("Restarting for %s", contribution.toString());
             } else {
                 Timber.d("Skipping re-upload for non-failed %s", contribution.toString());
@@ -624,7 +553,11 @@ public void retryUpload(Contribution contribution) {
      */
     @Override
     public void pauseUpload(Contribution contribution) {
-        uploadService.pauseUpload(contribution);
+        //Pause the upload in the global singleton
+        CommonsApplication.pauseUploads.put(contribution.getPageId(), true);
+        //Retain the paused state in DB
+        contribution.setState(STATE_PAUSED);
+        contributionsPresenter.saveContribution(contribution);
     }
 
     /**
@@ -677,10 +610,5 @@ public void backButtonClicked() {
     public MediaDetailPagerFragment getMediaDetailPagerFragment() {
         return mediaDetailPagerFragment;
     }
-
-    @Override
-    public void updateUploadCount() {
-        setUploadCount();
-    }
 }