Refactor uploads (commons-app#2981)

* Feature/refractor uploads [WIP] (commons-app#2887)

* Fix duplicate param information (commons-app#2515)

* Bug fix issue commons-app#2476 (commons-app#2526)

* Added wikidataEntityID in all db versions, handled db.execSql via method runQuery

* Versioning and changelog for v2.10.2 (commons-app#2531)

* Update changelog.md

* Versioning for v2.10.2

* Update changelog.md

* Bugfix/issue 2580 (commons-app#2584)

* Corrected string placedholders in certain string files

* Corrected string placedholders in certain string files[Bug fix commons-app#2580]

* Bug Fix commons-app#2585 (commons-app#2647)

* Bug Fix commons-app#2585
* Added null checks on view in SearchImageFragment when updating views from external sources
* Disposed the disposables in SearchActivity and SearchImageFragment when no longer in active lifecycle

* use FragmentUtils to verify fragment active state

* Bug Fix issue commons-app#2648 (commons-app#2678)

* Bug Fix issue commons-app#2648
* Handled external storage permission before file download

* * Removed redudant check for permission in MediaDetailPagerFragment (Dexter already does that)
* Removed duplicate code in PermissionUtil$checkPermissionsAndPerformAction, used the existing function with conditional extra parameters

* string name typo correction

* BugFix issue commons-app#2652 (commons-app#2706)

* Addded null check on bookmark before operating on it

* BugFix issue commons-app#2711 (commons-app#2712)

* Added null checks in OkHttpJsonApiClient$searchImages MwQueryResponse

* BugFix commons-app#2718 (commons-app#2719)

* Handled null auth cookies

* Fix commons-app#2791: NPE when nominating for deletion and leaving screen (commons-app#2792)

* Bug Fix issue commons-app#2789 (commons-app#2790)

* Handled Illegal State Exception for non existent appropriate view parents in ViewUtils$showShortSnackbar

* BugFix commons-app#2720 (commons-app#2831)

BugFix deprecated licenes commons-app#2720

* ui fixes, wip, upload

* *Issue commons-app#2886, BugFix commons-app#2832[wip]
* updated UploadActivity code
* modified ui
* Updated UploadPresenterTest

* * updated interfaces names to follow names suffixed with Contract
* added test cases

* card view elevation

* view pager disabled swipe

* bug fix, duplicate image

* used existing non-swipable view pager

* Avoid image view resize with keyboard, added adjustPan and stateVisible as softinputMode for UploadActivity

* retain UploadBaseFragment instances on orientation changes

* * Added test cases for UploadMediaPresenter
* Injected io and main thread schedulers

* categories presenter test cased wip

* Added CategoriesPresenter test

* * Added the logic to show open map (with to be uploaded image's coordinates while uploading image)

* codacy suggested changes * added java docs

* Added travis_wait fot android-wait-for-emulator

* ranamed interface onResponseCallback to Callback

* * Added api to delete picture in UploadModel
* cleanUp in UploadModel. once upload has been initiated
* Removed unused methods from UploadModel and the corresponding test class

* * Added tests for UploadPresenter
* Travis suggested changes
* Addded copy previous title and description

* * Made the upload add descriptions visible when keyboard visible
* add description request focus only when user manually requests it

* Added JavaDocs, review suggested changes

* Fix dagger injection

* use DialogUtil to show info in descriptions

* use activity context for DialogUtil

* Minor changes

* Bug fix, reduced the add description edit text clickable bound (commons-app#2973)

* Bugfix/uploads (commons-app#3000)

* merged with master

* BugFix IllegalStateException
* setRetainState(true), not required with FragmentStatePagerAdapter
* Increase the ViewPager's Offscreen Limit, we want all the fragments to be active

* BugFix, clear selected categoris for previous upload session
* Clear Selected Categories
* Addded JavaDocs for CategoriesModel

* Code Formatting in app/src/main/java/fr/free/nrw/commons/upload/UploadModel.java

* Added class level JavaDoc UploadRemoteDataSource

* Added class level JavaDoc for UploadRepository

* Added JavaDocs for ThumbnailsAdapter

* Added JavaDocs for MediaLicensePresenter, CategoriesPresenter

* Removed null check on category query
* Show default catgeories based on image title and gps location when category text empty
* Allow search for empty category search

* Attached image scale listener to upload media image

* Bug fix, reduced the add description edit text clickable bound

* Fix memory leak (commons-app#3001)

* Bugfix/uploads (commons-app#3002)

* merged with master

* BugFix IllegalStateException
* setRetainState(true), not required with FragmentStatePagerAdapter
* Increase the ViewPager's Offscreen Limit, we want all the fragments to be active

* BugFix, clear selected categoris for previous upload session
* Clear Selected Categories
* Addded JavaDocs for CategoriesModel

* Code Formatting in app/src/main/java/fr/free/nrw/commons/upload/UploadModel.java

* Added class level JavaDoc UploadRemoteDataSource

* Added class level JavaDoc for UploadRepository

* Added JavaDocs for ThumbnailsAdapter

* Added JavaDocs for MediaLicensePresenter, CategoriesPresenter

* Removed null check on category query
* Show default catgeories based on image title and gps location when category text empty
* Allow search for empty category search

* Attached image scale listener to upload media image

* Bug fix, reduced the add description edit text clickable bound

* Added tooltip in Title in UploadMediaFragment

* BugFix recent categories

* Updated test methods

* Bugfix/uploads (commons-app#3011)

* merged with master

* BugFix IllegalStateException
* setRetainState(true), not required with FragmentStatePagerAdapter
* Increase the ViewPager's Offscreen Limit, we want all the fragments to be active

* BugFix, clear selected categoris for previous upload session
* Clear Selected Categories
* Addded JavaDocs for CategoriesModel

* Code Formatting in app/src/main/java/fr/free/nrw/commons/upload/UploadModel.java

* Added class level JavaDoc UploadRemoteDataSource

* Added class level JavaDoc for UploadRepository

* Added JavaDocs for ThumbnailsAdapter

* Added JavaDocs for MediaLicensePresenter, CategoriesPresenter

* Removed null check on category query
* Show default catgeories based on image title and gps location when category text empty
* Allow search for empty category search

* Attached image scale listener to upload media image

* Bug fix, reduced the add description edit text clickable bound

* Added tooltip in Title in UploadMediaFragment

* BugFix recent categories

* Updated test methods

* Avoid memory leak, free the adpater in MediaLicenseFragment.onDestroyView

* bugfix/uploads (commons-app#3012)

* merged with master

* BugFix IllegalStateException
* setRetainState(true), not required with FragmentStatePagerAdapter
* Increase the ViewPager's Offscreen Limit, we want all the fragments to be active

* BugFix, clear selected categoris for previous upload session
* Clear Selected Categories
* Addded JavaDocs for CategoriesModel

* Code Formatting in app/src/main/java/fr/free/nrw/commons/upload/UploadModel.java

* Added class level JavaDoc UploadRemoteDataSource

* Added class level JavaDoc for UploadRepository

* Added JavaDocs for ThumbnailsAdapter

* Added JavaDocs for MediaLicensePresenter, CategoriesPresenter

* Removed null check on category query
* Show default catgeories based on image title and gps location when category text empty
* Allow search for empty category search

* Attached image scale listener to upload media image

* Bug fix, reduced the add description edit text clickable bound

* Added tooltip in Title in UploadMediaFragment

* BugFix recent categories

* Updated test methods

* Avoid memory leak, free the adpater in MediaLicenseFragment.onDestroyView

* BugFix Illegal State Exception in ViewpPagerAdapter

* Remove irrelevant comment

* merge conflict with strings (commons-app#3016)

Author: ashishkumar468

app/build.gradle

@@ -65,6 +65,8 @@ dependencies {
     testImplementation 'androidx.test:core:1.2.0'
     testImplementation 'com.nhaarman:mockito-kotlin:1.5.0'
     testImplementation 'com.squareup.okhttp3:mockwebserver:3.10.0'
+    testImplementation "org.powermock:powermock-module-junit4:2.0.0-beta.5"
+    testImplementation "org.powermock:powermock-api-mockito2:2.0.0-beta.5"
 
     // Android testing
     androidTestImplementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$KOTLIN_VERSION"

app/src/main/AndroidManifest.xml

@@ -50,10 +50,13 @@
         </activity>
         <activity android:name=".WelcomeActivity" />
 
-        <activity android:name=".upload.UploadActivity"
+        <activity
+            android:name=".upload.UploadActivity"
+            android:configChanges="orientation|screenSize|keyboard"
             android:icon="@mipmap/ic_launcher"
             android:label="@string/app_name"
-            android:configChanges="orientation|screenSize|keyboard">
+            android:windowSoftInputMode="adjustResize"
+            >
             <intent-filter android:label="@string/intent_share_upload_label">
                 <action android:name="android.intent.action.SEND" />
 

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

@@ -3,11 +3,11 @@
 /**
  * Base presenter, enforcing contracts to atach and detach view
  */
-public interface BasePresenter {
+public interface BasePresenter<T> {
     /**
      * Until a view is attached, it is open to listen events from the presenter
      */
-    void onAttachView(MvpView view);
+    void onAttachView(T view);
 
     /**
      * Detaching a view makes sure that the view no more receives events from the presenter

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

@@ -11,16 +11,16 @@
 
 import org.wikipedia.dataclient.WikiSite;
 import org.wikipedia.page.PageTitle;
+import fr.free.nrw.commons.location.LatLng;
+import fr.free.nrw.commons.utils.ViewUtil;
 
 import java.util.Locale;
 import java.util.regex.Pattern;
 
 import androidx.annotation.NonNull;
 import androidx.browser.customtabs.CustomTabsIntent;
 import androidx.core.content.ContextCompat;
-import fr.free.nrw.commons.location.LatLng;
 import fr.free.nrw.commons.settings.Prefs;
-import fr.free.nrw.commons.utils.ViewUtil;
 import timber.log.Timber;
 
 import static android.widget.Toast.LENGTH_SHORT;

app/src/main/java/fr/free/nrw/commons/campaigns/CampaignsPresenter.java

@@ -28,7 +28,7 @@
  * success and error
  */
 @Singleton
-public class CampaignsPresenter implements BasePresenter {
+public class CampaignsPresenter implements BasePresenter<ICampaignsView> {
     private final OkHttpJsonApiClient okHttpJsonApiClient;
 
     private ICampaignsView view;
@@ -40,8 +40,9 @@ public CampaignsPresenter(OkHttpJsonApiClient okHttpJsonApiClient) {
         this.okHttpJsonApiClient = okHttpJsonApiClient;
     }
 
-    @Override public void onAttachView(MvpView view) {
-        this.view = (ICampaignsView) view;
+    @Override
+    public void onAttachView(ICampaignsView view) {
+        this.view = view;
     }
 
     @Override public void onDetachView() {

app/src/main/java/fr/free/nrw/commons/category/CategoriesModel.java

@@ -1,25 +1,25 @@
 package fr.free.nrw.commons.category;
 
 import android.text.TextUtils;
-
+import fr.free.nrw.commons.kvstore.JsonKvStore;
+import fr.free.nrw.commons.mwapi.MediaWikiApi;
+import fr.free.nrw.commons.upload.GpsCategoryModel;
+import fr.free.nrw.commons.utils.StringSortingUtils;
+import io.reactivex.Observable;
 import java.util.ArrayList;
 import java.util.Calendar;
 import java.util.Comparator;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
-
 import javax.inject.Inject;
 import javax.inject.Named;
-
-import fr.free.nrw.commons.kvstore.JsonKvStore;
-import fr.free.nrw.commons.mwapi.MediaWikiApi;
-import fr.free.nrw.commons.upload.GpsCategoryModel;
-import fr.free.nrw.commons.utils.StringSortingUtils;
-import io.reactivex.Observable;
 import timber.log.Timber;
 
-public class CategoriesModel implements CategoryClickedListener {
+/**
+ * The model class for categories in upload
+ */
+public class CategoriesModel{
     private static final int SEARCH_CATS_LIMIT = 25;
 
     private final MediaWikiApi mwApi;
@@ -41,13 +41,22 @@ public CategoriesModel(MediaWikiApi mwApi,
         this.selectedCategories = new ArrayList<>();
     }
 
-    //region Misc. utility methods
+    /**
+     * Sorts CategoryItem by similarity
+     * @param filter
+     * @return
+     */
     public Comparator<CategoryItem> sortBySimilarity(final String filter) {
         Comparator<String> stringSimilarityComparator = StringSortingUtils.sortBySimilarity(filter);
         return (firstItem, secondItem) -> stringSimilarityComparator
                 .compare(firstItem.getName(), secondItem.getName());
     }
 
+    /**
+     * Returns if the item contains an year
+     * @param item
+     * @return
+     */
     public boolean containsYear(String item) {
         //Check for current and previous year to exclude these categories from removal
         Calendar now = Calendar.getInstance();
@@ -67,6 +76,10 @@ public boolean containsYear(String item) {
                 || (item.matches(".*0s.*") && !item.matches(".*(200|201)0s.*")));
     }
 
+    /**
+     * Updates category count in category dao
+     * @param item
+     */
     public void updateCategoryCount(CategoryItem item) {
         Category category = categoryDao.find(item.getName());
 
@@ -78,29 +91,27 @@ public void updateCategoryCount(CategoryItem item) {
         category.incTimesUsed();
         categoryDao.save(category);
     }
-    //endregion
-
-    //region Category Caching
-    public void cacheAll(HashMap<String, ArrayList<String>> categories) {
-        categoriesCache.putAll(categories);
-    }
-
-    public HashMap<String, ArrayList<String>> getCategoriesCache() {
-        return categoriesCache;
-    }
 
     boolean cacheContainsKey(String term) {
         return categoriesCache.containsKey(term);
     }
     //endregion
 
-    //region Category searching
+    /**
+     * Regional category search
+     * @param term
+     * @param imageTitleList
+     * @return
+     */
     public Observable<CategoryItem> searchAll(String term, List<String> imageTitleList) {
-        //If user hasn't typed anything in yet, get GPS and recent items
+        //If query text is empty, show him category based on gps and title and recent searches
         if (TextUtils.isEmpty(term)) {
-            return gpsCategories()
-                    .concatWith(titleCategories(imageTitleList))
-                    .concatWith(recentCategories());
+            Observable<CategoryItem> categoryItemObservable = gpsCategories()
+                    .concatWith(titleCategories(imageTitleList));
+            if (hasDirectCategories()) {
+                categoryItemObservable.concatWith(directCategories().concatWith(recentCategories()));
+            }
+            return categoryItemObservable;
         }
 
         //if user types in something that is in cache, return cached category
@@ -115,43 +126,28 @@ public Observable<CategoryItem> searchAll(String term, List<String> imageTitleLi
                 .map(name -> new CategoryItem(name, false));
     }
 
-    public Observable<CategoryItem> searchCategories(String term, List<String> imageTitleList) {
-        //If user hasn't typed anything in yet, get GPS and recent items
-        if (TextUtils.isEmpty(term)) {
-            return gpsCategories()
-                    .concatWith(titleCategories(imageTitleList))
-                    .concatWith(recentCategories());
-        }
-
-        return mwApi
-                .searchCategories(term, SEARCH_CATS_LIMIT)
-                .map(s -> new CategoryItem(s, false));
-    }
 
+    /**
+     * Returns cached categories
+     * @param term
+     * @return
+     */
     private ArrayList<String> getCachedCategories(String term) {
         return categoriesCache.get(term);
     }
 
-    public Observable<CategoryItem> defaultCategories(List<String> titleList) {
-        Observable<CategoryItem> directCat = directCategories();
-        if (hasDirectCategories()) {
-            Timber.d("Image has direct Cat");
-            return directCat
-                    .concatWith(gpsCategories())
-                    .concatWith(titleCategories(titleList))
-                    .concatWith(recentCategories());
-        } else {
-            Timber.d("Image has no direct Cat");
-            return gpsCategories()
-                    .concatWith(titleCategories(titleList))
-                    .concatWith(recentCategories());
-        }
-    }
-
+    /**
+     * Returns if we have a category in DirectKV Store
+     * @return
+     */
     private boolean hasDirectCategories() {
         return !directKvStore.getString("Category", "").equals("");
     }
 
+    /**
+     * Returns categories in DirectKVStore
+     * @return
+     */
     private Observable<CategoryItem> directCategories() {
         String directCategory = directKvStore.getString("Category", "");
         List<String> categoryList = new ArrayList<>();
@@ -164,30 +160,49 @@ private Observable<CategoryItem> directCategories() {
         return Observable.fromIterable(categoryList).map(name -> new CategoryItem(name, false));
     }
 
+    /**
+     * Returns GPS categories
+     * @return
+     */
     Observable<CategoryItem> gpsCategories() {
         return Observable.fromIterable(gpsCategoryModel.getCategoryList())
                 .map(name -> new CategoryItem(name, false));
     }
 
+    /**
+     * Returns title based categories
+     * @param titleList
+     * @return
+     */
     private Observable<CategoryItem> titleCategories(List<String> titleList) {
         return Observable.fromIterable(titleList)
                 .concatMap(this::getTitleCategories);
     }
 
+    /**
+     * Return category for single title
+     * @param title
+     * @return
+     */
     private Observable<CategoryItem> getTitleCategories(String title) {
         return mwApi.searchTitles(title, SEARCH_CATS_LIMIT)
                 .map(name -> new CategoryItem(name, false));
     }
 
+    /**
+     * Returns recent categories
+     * @return
+     */
     private Observable<CategoryItem> recentCategories() {
         return Observable.fromIterable(categoryDao.recentCategories(SEARCH_CATS_LIMIT))
                 .map(s -> new CategoryItem(s, false));
     }
-    //endregion
 
-    //region Category Selection
-    @Override
-    public void categoryClicked(CategoryItem item) {
+    /**
+     * Handles category item selection
+     * @param item
+     */
+    public void onCategoryItemClicked(CategoryItem item) {
         if (item.isSelected()) {
             selectCategory(item);
             updateCategoryCount(item);
@@ -196,29 +211,48 @@ public void categoryClicked(CategoryItem item) {
         }
     }
 
+    /**
+     * Select's category
+     * @param item
+     */
     public void selectCategory(CategoryItem item) {
         selectedCategories.add(item);
     }
 
+    /**
+     * Unselect Category
+     * @param item
+     */
     public void unselectCategory(CategoryItem item) {
         selectedCategories.remove(item);
     }
 
-    public int selectedCategoriesCount() {
-        return selectedCategories.size();
-    }
 
+    /**
+     * Get Selected Categories
+     * @return
+     */
     public List<CategoryItem> getSelectedCategories() {
         return selectedCategories;
     }
 
+    /**
+     * Get Categories String List
+     * @return
+     */
     public List<String> getCategoryStringList() {
         List<String> output = new ArrayList<>();
         for (CategoryItem item : selectedCategories) {
             output.add(item.getName());
         }
         return output;
     }
-    //endregion
 
+    /**
+     * Cleanup the existing in memory cache's
+     */
+    public void cleanUp() {
+        this.categoriesCache.clear();
+        this.selectedCategories.clear();
+    }
 }

app/src/main/java/fr/free/nrw/commons/category/CategoryItem.java

@@ -19,7 +19,7 @@ public CategoryItem[] newArray(int i) {
         }
     };
 
-    CategoryItem(String name, boolean selected) {
+    public CategoryItem(String name, boolean selected) {
         this.name = name;
         this.selected = selected;
     }

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

@@ -100,7 +100,7 @@ ContentValues toContentValues(Contribution contribution) {
             cv.put(Table.COLUMN_UPLOADED, contribution.getDateUploaded().getTime());
         }
         cv.put(Table.COLUMN_LENGTH, contribution.getDataLength());
-        //This was always meant to store the date created..If somehow date created is not fetched while actually saving the contribution, lets save today's date
+        //This was always meant to store the date created..If somehow date created is not fetched while actually saving the contribution, lets saveValue today's date
         cv.put(Table.COLUMN_TIMESTAMP, contribution.getDateCreated()==null?System.currentTimeMillis():contribution.getDateCreated().getTime());
         cv.put(Table.COLUMN_STATE, contribution.getState());
         cv.put(Table.COLUMN_TRANSFERRED, contribution.getTransferred());

app/src/main/java/fr/free/nrw/commons/di/CommonsApplicationComponent.java

@@ -15,6 +15,7 @@
 import fr.free.nrw.commons.review.ReviewController;
 import fr.free.nrw.commons.settings.SettingsFragment;
 import fr.free.nrw.commons.upload.FileProcessor;
+import fr.free.nrw.commons.upload.UploadModule;
 import fr.free.nrw.commons.widget.PicOfDayAppWidget;
 
 
@@ -27,7 +28,7 @@
         ActivityBuilderModule.class,
         FragmentBuilderModule.class,
         ServiceBuilderModule.class,
-        ContentProviderBuilderModule.class
+        ContentProviderBuilderModule.class, UploadModule.class
 })
 public interface CommonsApplicationComponent extends AndroidInjector<ApplicationlessInjection> {
     void inject(CommonsApplication application);