Code to retrive unknown notification and UI (commons-app#2340)

* request change, changed notification icon

* Completed task 1 of the work

* commit changes

* commit changes

* updated notification class

* before notification id

* gradle reverted

* Minor changes to mark notifications as read

* commit changes

* delete on swipe

* notification count

* sipe to delete

* changes

* worked on changes requested

* commit changes

* Fix notification count

* reviewed changes

* round icon, swipe with icon

* Fix pending NPE issues with notifications

* final commit

* graddle changes

* removed changes for testing

Author: vanshikaarora

app/build.gradle

@@ -88,6 +88,9 @@ dependencies {
     implementation "com.android.support:customtabs:$SUPPORT_LIB_VERSION"
     implementation "com.android.support:cardview-v7:$SUPPORT_LIB_VERSION"
     implementation 'com.android.support.constraint:constraint-layout:1.1.3'
+    //swipe_layout
+    implementation 'com.daimajia.swipelayout:library:1.2.0@aar'
+    implementation 'com.nineoldandroids:library:2.4.0'
 }
 
 android {

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

@@ -31,7 +31,6 @@
 import android.widget.Toast;
 
 import java.util.ArrayList;
-import java.util.concurrent.CountDownLatch;
 
 import javax.inject.Inject;
 import javax.inject.Named;
@@ -56,7 +55,6 @@
 import fr.free.nrw.commons.nearby.NearbyNotificationCardView;
 import fr.free.nrw.commons.nearby.Place;
 import fr.free.nrw.commons.notification.NotificationController;
-import fr.free.nrw.commons.notification.UnreadNotificationsCheckAsync;
 import fr.free.nrw.commons.settings.Prefs;
 import fr.free.nrw.commons.upload.UploadService;
 import fr.free.nrw.commons.utils.ConfigUtils;
@@ -87,8 +85,7 @@ public class ContributionsFragment
     @Inject @Named("default_preferences") BasicKvStore defaultKvStore;
     @Inject ContributionDao contributionDao;
     @Inject MediaWikiApi mediaWikiApi;
-    @Inject NotificationController notificationController;
-    @Inject NearbyController nearbyController;
+                        @Inject NearbyController nearbyController;
 
     private ArrayList<DataSetObserver> observersWaitingForLoad = new ArrayList<>();
     private UploadService uploadService;
@@ -213,7 +210,6 @@ public void onAttach(Context context) {
         if (((MainActivity)getActivity()).isAuthCookieAcquired && !isFragmentAttachedBefore) {
             onAuthCookieAcquired(((MainActivity)getActivity()).uploadServiceIntent);
             isFragmentAttachedBefore = true;
-            new UnreadNotificationsCheckAsync((MainActivity) getActivity(), notificationController).execute();
 
         }
     }
@@ -478,14 +474,6 @@ public void betaSetUploadCount(int betaUploadCount) {
         displayUploadCount(betaUploadCount);
     }
 
-    /**
-     * Updates notification indicator on toolbar to indicate there are unread notifications
-     * @param isThereUnreadNotifications true if user checked notifications before last notification date
-     */
-    public void updateNotificationsNotification(boolean isThereUnreadNotifications) {
-        ((MainActivity)getActivity()).updateNotificationIcon(isThereUnreadNotifications);
-    }
-
     @Override
     public void onPause() {
         super.onPause();

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

@@ -1,5 +1,6 @@
 package fr.free.nrw.commons.contributions;
 
+import android.annotation.SuppressLint;
 import android.app.AlertDialog;
 import android.content.Intent;
 import android.content.pm.PackageManager;
@@ -8,14 +9,14 @@
 import android.support.v4.app.Fragment;
 import android.support.v4.app.FragmentManager;
 import android.support.v4.app.FragmentPagerAdapter;
-import android.support.v4.content.ContextCompat;
 import android.support.v4.view.ViewPager;
 import android.view.LayoutInflater;
 import android.view.Menu;
 import android.view.MenuInflater;
 import android.view.MenuItem;
 import android.view.View;
 import android.widget.ImageView;
+import android.widget.TextView;
 
 import com.esafirm.imagepicker.features.ImagePicker;
 import com.esafirm.imagepicker.model.Image;
@@ -35,10 +36,15 @@
 import fr.free.nrw.commons.location.LocationServiceManager;
 import fr.free.nrw.commons.nearby.NearbyFragment;
 import fr.free.nrw.commons.nearby.NearbyNotificationCardView;
+import fr.free.nrw.commons.notification.Notification;
 import fr.free.nrw.commons.notification.NotificationActivity;
+import fr.free.nrw.commons.notification.NotificationController;
 import fr.free.nrw.commons.upload.UploadService;
 import fr.free.nrw.commons.utils.ImageUtils;
 import fr.free.nrw.commons.utils.IntentUtils;
+import io.reactivex.Observable;
+import io.reactivex.android.schedulers.AndroidSchedulers;
+import io.reactivex.schedulers.Schedulers;
 import timber.log.Timber;
 
 import static android.content.ContentResolver.requestSync;
@@ -58,6 +64,8 @@ public class MainActivity extends AuthenticatedActivity implements FragmentManag
     @Inject
     @Named("default_preferences")
     public BasicKvStore defaultKvStore;
+    @Inject
+    NotificationController notificationController;
 
 
     public Intent uploadServiceIntent;
@@ -69,10 +77,12 @@ public class MainActivity extends AuthenticatedActivity implements FragmentManag
 
     public boolean isContributionsFragmentVisible = true; // False means nearby fragment is visible
     private Menu menu;
-    private boolean isThereUnreadNotifications = false;
 
     private boolean onOrientationChanged = false;
 
+    private MenuItem notificationsMenuItem;
+    private TextView notificationCount;
+
     public void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_contributions);
@@ -82,6 +92,7 @@ public void onCreate(Bundle savedInstanceState) {
         initDrawer();
         setTitle(getString(R.string.navigation_item_home)); // Should I create a new string variable with another name instead?
 
+
         if (savedInstanceState != null ) {
             onOrientationChanged = true; // Will be used in nearby fragment to determine significant update of map
 
@@ -126,13 +137,11 @@ private void addTabsAndFragments() {
         tabLayout.getTabAt(1).setCustomView(nearbyTabLinearLayout);
 
         nearbyInfo.setOnClickListener(view ->
-                new AlertDialog.Builder(MainActivity.this)
-                    .setTitle(R.string.title_activity_nearby)
-                    .setMessage(R.string.showcase_view_whole_nearby_activity)
-                    .setCancelable(true)
-                    .setPositiveButton(android.R.string.ok, (dialog, id) -> dialog.cancel())
-                    .create()
-                    .show()
+                new AlertDialog.Builder(MainActivity.this).setTitle(R.string.title_activity_nearby).setMessage(R.string.showcase_view_whole_nearby_activity)
+                        .setCancelable(true)
+                        .setPositiveButton(android.R.string.ok, (dialog, id) -> dialog.cancel())
+                        .create()
+                        .show()
         );
 
         if (uploadServiceIntent != null) {
@@ -278,20 +287,35 @@ public boolean onCreateOptionsMenu(Menu menu) {
         MenuInflater inflater = getMenuInflater();
         inflater.inflate(R.menu.contribution_activity_notification_menu, menu);
 
-        if (!isThereUnreadNotifications) {
-            // TODO: used vectors are not compatible with API 19 and below, change them
-            menu.findItem(R.id.notifications).setIcon(ContextCompat.getDrawable(this, R.drawable.ic_notification_white_clip_art));
-        } else {
-            menu.findItem(R.id.notifications).setIcon(ContextCompat.getDrawable(this, R.drawable.ic_notification_white_clip_art_dot));
-        }
-
+        notificationsMenuItem = menu.findItem(R.id.notifications);
+        final View notification = notificationsMenuItem.getActionView();
+        notificationCount = notification.findViewById(R.id.notification_count_badge);
+        notification.setOnClickListener(view -> NotificationActivity.startYourself(MainActivity.this));
         this.menu = menu;
-
         updateMenuItem();
-
+        setNotificationCount();
         return true;
     }
 
+    @SuppressLint("CheckResult")
+    private void setNotificationCount() {
+        Observable.fromCallable(() -> notificationController.getNotifications())
+                .subscribeOn(Schedulers.io())
+                .observeOn(AndroidSchedulers.mainThread())
+                .subscribe(this::initNotificationViews,
+                        throwable -> Timber.e(throwable, "Error occurred while loading notifications"));
+    }
+
+    private void initNotificationViews(List<Notification> notificationList) {
+        Timber.d("Number of notifications is %d", notificationList.size());
+        if (notificationList.isEmpty()) {
+            notificationCount.setVisibility(View.GONE);
+        } else {
+            notificationCount.setVisibility(View.VISIBLE);
+            notificationCount.setText(String.valueOf(notificationList.size()));
+        }
+    }
+
     /**
      * Responsible with displaying required menu items according to displayed fragment.
      * Notifications icon when contributions list is visible, list sheet icon when nearby is visible
@@ -319,7 +343,7 @@ public boolean onOptionsItemSelected(MenuItem item) {
                 // Starts notification activity on click to notification icon
                 NotificationActivity.startYourself(this);
                 return true;
-            case R.id.list_sheet:
+            case R.id.list_sheet:NotificationActivity.startYourself(this);
                 if (contributionsActivityPagerAdapter.getItem(1) != null) {
                     ((NearbyFragment)contributionsActivityPagerAdapter.getItem(1)).listOptionMenuIteClicked();
                 }
@@ -335,21 +359,6 @@ private boolean deviceHasCamera() {
                 pm.hasSystemFeature(PackageManager.FEATURE_CAMERA_FRONT);
     }
 
-    /**
-     * Update notification icon if there is an unread notification
-     * @param isThereUnreadNotifications true if user didn't visit notifications activity since
-     *                                   latest notification came to account
-     */
-    public void updateNotificationIcon(boolean isThereUnreadNotifications) {
-        if (!isThereUnreadNotifications) {
-            this.isThereUnreadNotifications = false;
-            menu.findItem(R.id.notifications).setIcon(ContextCompat.getDrawable(this, R.drawable.ic_notification_white_clip_art));
-        } else {
-            this.isThereUnreadNotifications = true;
-            menu.findItem(R.id.notifications).setIcon(ContextCompat.getDrawable(this, R.drawable.ic_notification_white_clip_art_dot));
-        }
-    }
-
     public class ContributionsActivityPagerAdapter extends FragmentPagerAdapter {
         FragmentManager fragmentManager;
         private boolean isContributionsListFragment = true; // to know what to put in first tab, Contributions of Media Details
@@ -471,7 +480,7 @@ public void onRequestPermissionsResult(int requestCode,
                     if (!isContributionsFragmentVisible) {
                         viewPager.setCurrentItem(CONTRIBUTIONS_TAB_POSITION);
 
-                    // TODO: If contrib fragment is visible and location permission is not given, display permission request button
+                        // TODO: If contrib fragment is visible and location permission is not given, display permission request button
                     } else {
 
                     }

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

@@ -164,17 +164,6 @@ public JsonKvStore providesDirectNearbyUploadKvStore(Context context, Gson gson)
         return new JsonKvStore(context, "direct_nearby_upload_prefs", gson);
     }
 
-    /**
-     * Is used to determine when user is viewed notifications activity last
-     * @param context
-     * @return date of lastReadNotificationDate
-     */
-    @Provides
-    @Named("last_read_notification_date")
-    public BasicKvStore providesLastReadNotificationDateKvStore(Context context) {
-        return new BasicKvStore(context, "last_read_notification_date");
-    }
-
     @Provides
     public UploadController providesUploadController(SessionManager sessionManager,
                                                      @Named("default_preferences") BasicKvStore kvStore,

app/src/main/java/fr/free/nrw/commons/mwapi/ApacheHttpClientMediaWikiApi.java

@@ -54,6 +54,7 @@
 import fr.free.nrw.commons.notification.NotificationUtils;
 import fr.free.nrw.commons.utils.ConfigUtils;
 import fr.free.nrw.commons.utils.DateUtils;
+import fr.free.nrw.commons.utils.StringUtils;
 import fr.free.nrw.commons.utils.ViewUtil;
 import in.yuvi.http.fluent.Http;
 import io.reactivex.Observable;
@@ -82,7 +83,7 @@ public class ApacheHttpClientMediaWikiApi implements MediaWikiApi {
     private Gson gson;
     private final OkHttpClient okHttpClient;
     private final String WIKIMEDIA_CAMPAIGNS_BASE_URL =
-        "https://raw.githubusercontent.com/commons-app/campaigns/master/campaigns.json";
+            "https://raw.githubusercontent.com/commons-app/campaigns/master/campaigns.json";
 
     private final String ERROR_CODE_BAD_TOKEN = "badtoken";
 
@@ -587,6 +588,7 @@ public List<Notification> getNotifications() {
                     .param("meta", "notifications")
                     .param("notformat", "model")
                     .param("notwikis", "wikidatawiki|commonswiki|enwiki")
+                    .param("notfilter","!read")
                     .get()
                     .getNode("/api/query/notifications/list");
         } catch (IOException e) {
@@ -599,11 +601,26 @@ public List<Notification> getNotifications() {
                 || notificationNode.getDocument().getChildNodes().getLength() == 0) {
             return new ArrayList<>();
         }
-
         NodeList childNodes = notificationNode.getDocument().getChildNodes();
         return NotificationUtils.getNotificationsFromList(context, childNodes);
     }
 
+    @Override
+    public boolean markNotificationAsRead(Notification notification) throws IOException {
+        Timber.d("Trying to mark notification as read: %s", notification.toString());
+        String result = api.action("echomarkread")
+                .param("token", getEditToken())
+                .param("list", notification.notificationId)
+                .post()
+                .getString("/api/query/echomarkread/@result");
+
+        if (StringUtils.isNullOrWhiteSpace(result)) {
+            return false;
+        }
+
+        return result.equals("success");
+    }
+
     /**
      * The method takes categoryName as input and returns a List of Subcategories
      * It uses the generator query API to get the subcategories in a category, 500 at a time.

app/src/main/java/fr/free/nrw/commons/mwapi/MediaWikiApi.java

@@ -84,6 +84,9 @@ public interface MediaWikiApi {
     @NonNull
     List<Notification> getNotifications() throws IOException;
 
+    @NonNull
+    boolean markNotificationAsRead(Notification notification) throws IOException;
+
     @NonNull
     Observable<String> searchTitles(String title, int searchCatsLimit);
 

app/src/main/java/fr/free/nrw/commons/notification/Notification.java

@@ -12,14 +12,30 @@ public class Notification {
     public String link;
     public String iconUrl;
     public String dateWithYear;
+    public String notificationId;
 
-    public Notification(NotificationType notificationType, String notificationText, String date, String description, String link, String iconUrl, String dateWithYear) {
+    public Notification(NotificationType notificationType, String notificationText, String date, String description, String link, String iconUrl, String dateWithYear, String notificationId) {
         this.notificationType = notificationType;
         this.notificationText = notificationText;
         this.date = date;
         this.description = description;
         this.link = link;
         this.iconUrl = iconUrl;
         this.dateWithYear = dateWithYear;
+        this.notificationId=notificationId;
+    }
+
+    @Override
+    public String toString() {
+        return "Notification" +
+                "notificationType='" + notificationType + '\'' +
+                ", notificationText='" + notificationText + '\'' +
+                ", date='" + date + '\'' +
+                ", description='" + description + '\'' +
+                ", link='" + link + '\'' +
+                ", iconUrl='" + iconUrl + '\'' +
+                ", dateWithYear=" + dateWithYear +
+                ", notificationId='" + notificationId + '\'' +
+                '}';
     }
 }