Feature/reader search results

WordPress/src/main/AndroidManifest.xml

@@ -389,6 +389,10 @@
             android:name=".ui.reader.services.ReaderPostService"
             android:exported="false"
             android:label="Reader Post Service" />
+        <service
+            android:name=".ui.reader.services.ReaderSearchService"
+            android:exported="false"
+            android:label="Reader Search Service" />
         <service
             android:name=".ui.reader.services.ReaderCommentService"
             android:exported="false"

WordPress/src/main/java/org/wordpress/android/WordPress.java

@@ -83,6 +83,8 @@
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
+import java.util.Timer;
+import java.util.TimerTask;
 
 import de.greenrobot.event.EventBus;
 import io.fabric.sdk.android.Fabric;
@@ -718,8 +720,11 @@ private class ApplicationLifecycleMonitor implements Application.ActivityLifecyc
         private final int DEFAULT_TIMEOUT = 2 * 60; // 2 minutes
         private Date mLastPingDate;
         private Date mApplicationOpenedDate;
-        boolean mIsInBackground = true;
         boolean mFirstActivityResumed = true;
+        private Timer mActivityTransitionTimer;
+        private TimerTask mActivityTransitionTimerTask;
+        private final long MAX_ACTIVITY_TRANSITION_TIME_MS = 2000;
+        boolean mIsInBackground = true;
 
         @Override
         public void onConfigurationChanged(final Configuration newConfig) {
@@ -733,25 +738,6 @@ public void onLowMemory() {
 
         @Override
         public void onTrimMemory(final int level) {
-            if (level == ComponentCallbacks2.TRIM_MEMORY_UI_HIDDEN) {
-                // We're in the Background
-                mIsInBackground = true;
-                String lastActivityString = AppPrefs.getLastActivityStr();
-                ActivityId lastActivity = ActivityId.getActivityIdFromName(lastActivityString);
-                Map<String, Object> properties = new HashMap<String, Object>();
-                properties.put("last_visible_screen", lastActivity.toString());
-                if (mApplicationOpenedDate != null) {
-                    Date now = new Date();
-                    properties.put("time_in_app", DateTimeUtils.secondsBetween(now, mApplicationOpenedDate));
-                    mApplicationOpenedDate = null;
-                }
-                AnalyticsTracker.track(AnalyticsTracker.Stat.APPLICATION_CLOSED, properties);
-                AnalyticsTracker.endSession(false);
-                onAppGoesToBackground();
-            } else {
-                mIsInBackground = false;
-            }
-
             boolean evictBitmaps = false;
             switch (level) {
                 case TRIM_MEMORY_COMPLETE:
@@ -796,17 +782,64 @@ private void updatePushNotificationTokenIfNotLimited() {
             }
         }
 
-        public void onAppGoesToBackground() {
-            AppLog.i(T.UTILS, "App goes to background");
-            ConnectionChangeReceiver.setEnabled(WordPress.this, false);
+        /**
+         * The two methods below (startActivityTransitionTimer and stopActivityTransitionTimer)
+         * are used to track when the app goes to background.
+         *
+         * Our implementation uses `onActivityPaused` and `onActivityResumed` of ApplicationLifecycleMonitor
+         * to start and stop the timer that detects when the app goes to background.
+         *
+         * So when the user is simply navigating between the activities, the onActivityPaused() calls `startActivityTransitionTimer`
+         * and starts the timer, but almost immediately the new activity being entered, the ApplicationLifecycleMonitor cancels the timer
+         * in its onActivityResumed method, that in order calls `stopActivityTransitionTimer`.
+         * And so mIsInBackground would be false.
+         *
+         * In the case the app is sent to background, the TimerTask is instead executed, and the code that handles all the background logic is run.
+         */
+        private void startActivityTransitionTimer() {
+            this.mActivityTransitionTimer = new Timer();
+            this.mActivityTransitionTimerTask = new TimerTask() {
+                public void run() {
+                    AppLog.i(T.UTILS, "App goes to background");
+                    // We're in the Background
+                    mIsInBackground = true;
+                    String lastActivityString = AppPrefs.getLastActivityStr();
+                    ActivityId lastActivity = ActivityId.getActivityIdFromName(lastActivityString);
+                    Map<String, Object> properties = new HashMap<String, Object>();
+                    properties.put("last_visible_screen", lastActivity.toString());
+                    if (mApplicationOpenedDate != null) {
+                        Date now = new Date();
+                        properties.put("time_in_app", DateTimeUtils.secondsBetween(now, mApplicationOpenedDate));
+                        mApplicationOpenedDate = null;
+                    }
+                    AnalyticsTracker.track(AnalyticsTracker.Stat.APPLICATION_CLOSED, properties);
+                    AnalyticsTracker.endSession(false);
+                    ConnectionChangeReceiver.setEnabled(WordPress.this, false);
+                }
+            };
+
+            this.mActivityTransitionTimer.schedule(mActivityTransitionTimerTask,
+                    MAX_ACTIVITY_TRANSITION_TIME_MS);
+        }
+
+        private void stopActivityTransitionTimer() {
+            if (this.mActivityTransitionTimerTask != null) {
+                this.mActivityTransitionTimerTask.cancel();
+            }
+
+            if (this.mActivityTransitionTimer != null) {
+                this.mActivityTransitionTimer.cancel();
+            }
+
+            mIsInBackground = false;
         }
 
         /**
          * This method is called when:
          * 1. the app starts (but it's not opened by a service or a broadcast receiver, i.e. an activity is resumed)
          * 2. the app was in background and is now foreground
          */
-        public void onAppComesFromBackground() {
+        private void onAppComesFromBackground() {
             AppLog.i(T.UTILS, "App comes from background");
             ConnectionChangeReceiver.setEnabled(WordPress.this, true);
             AnalyticsUtils.refreshMetadata();
@@ -832,6 +865,8 @@ public void onActivityResumed(Activity activity) {
                 // was in background before
                 onAppComesFromBackground();
             }
+            stopActivityTransitionTimer();
+
             mIsInBackground = false;
             if (mFirstActivityResumed) {
                 deferredInit(activity);
@@ -850,6 +885,7 @@ public void onActivityDestroyed(Activity arg0) {
         @Override
         public void onActivityPaused(Activity arg0) {
             mLastPingDate = new Date();
+            startActivityTransitionTimer();
         }
 
         @Override

WordPress/src/main/java/org/wordpress/android/datasets/ReaderDatabase.java

@@ -19,7 +19,7 @@
  */
 public class ReaderDatabase extends SQLiteOpenHelper {
     protected static final String DB_NAME = "wpreader.db";
-    private static final int DB_VERSION = 116;
+    private static final int DB_VERSION = 118;
 
     /*
      * version history
@@ -68,6 +68,8 @@ public class ReaderDatabase extends SQLiteOpenHelper {
      *  114 - renamed tag_name to tag_slug in tag tables
      *  115 - added ReaderSearchTable
      *  116 - added tag_display_name to tag tables
+     *  117 - changed tbl_posts.timestamp from INTEGER to REAL
+     *  118 - renamed tbl_search_history to tbl_search_suggestions
      */
 
     /*

WordPress/src/main/java/org/wordpress/android/datasets/ReaderPostTable.java

@@ -122,7 +122,7 @@ protected static void createTables(SQLiteDatabase db) {
                 + " featured_image      TEXT,"
                 + " featured_video      TEXT,"
                 + " post_avatar         TEXT,"
-                + " timestamp           INTEGER DEFAULT 0,"
+                + " timestamp           REAL DEFAULT 0,"
                 + " published           TEXT,"
                 + " num_replies         INTEGER DEFAULT 0,"
                 + " num_likes           INTEGER DEFAULT 0,"
@@ -180,6 +180,9 @@ protected static int purge(SQLiteDatabase db) {
             numDeleted += purgePostsForTag(db, tag);
         }
 
+        // delete search results
+        numDeleted += purgeSearchResults(db);
+
         // delete posts in tbl_posts that no longer exist in tbl_post_tags
         numDeleted += db.delete("tbl_posts", "pseudo_id NOT IN (SELECT DISTINCT pseudo_id FROM tbl_post_tags)", null);
 
@@ -211,6 +214,14 @@ private static int purgePostsForTag(SQLiteDatabase db, ReaderTag tag) {
         return numDeleted;
     }
 
+    /*
+     * purge all posts that were retained from previous searches
+     */
+    private static int purgeSearchResults(SQLiteDatabase db) {
+        String[] args = {Integer.toString(ReaderTagType.SEARCH.toInt())};
+        return db.delete("tbl_post_tags", "tag_type=?", args);
+    }
+
     public static int getNumPostsInBlog(long blogId) {
         if (blogId == 0) {
             return 0;
@@ -624,7 +635,7 @@ public static void addOrUpdatePosts(final ReaderTag tag, ReaderPostList posts) {
                 stmtPosts.bindString(16, post.getFeaturedImage());
                 stmtPosts.bindString(17, post.getFeaturedVideo());
                 stmtPosts.bindString(18, post.getPostAvatar());
-                stmtPosts.bindLong  (19, post.timestamp);
+                stmtPosts.bindDouble(19, post.timestamp);
                 stmtPosts.bindString(20, post.getPublished());
                 stmtPosts.bindLong  (21, post.numReplies);
                 stmtPosts.bindLong  (22, post.numLikes);
@@ -839,7 +850,7 @@ private static ReaderPost getPostFromCursor(Cursor c) {
         post.setShortUrl(c.getString(c.getColumnIndex("short_url")));
         post.setPostAvatar(c.getString(c.getColumnIndex("post_avatar")));
 
-        post.timestamp = c.getLong(c.getColumnIndex("timestamp"));
+        post.timestamp = c.getDouble(c.getColumnIndex("timestamp"));
         post.setPublished(c.getString(c.getColumnIndex("published")));
 
         post.numReplies = c.getInt(c.getColumnIndex("num_replies"));

WordPress/src/main/java/org/wordpress/android/datasets/ReaderSearchTable.java

@@ -9,73 +9,71 @@
 import org.wordpress.android.util.DateTimeUtils;
 import org.wordpress.android.util.SqlUtils;
 
-import java.util.ArrayList;
 import java.util.Date;
-import java.util.List;
 
 /**
- * user's reader search history
+ * search suggestion table - populated by user's reader search history
  */
 public class ReaderSearchTable {
 
+    public static final String COL_QUERY = "query_string";
+
     protected static void createTables(SQLiteDatabase db) {
-        db.execSQL("CREATE TABLE tbl_search_history ("
-                 + "	query_string   TEXT NOT NULL COLLATE NOCASE PRIMARY KEY,"
-                 + "    date_used      TEXT,"
-                 + "    counter        INTEGER DEFAULT 1)");
+        db.execSQL("CREATE TABLE tbl_search_suggestions ("
+                 + "    _id            INTEGER PRIMARY KEY AUTOINCREMENT,"
+                 + "	query_string   TEXT NOT NULL COLLATE NOCASE,"
+                 + "    date_used      TEXT)");
+        db.execSQL("CREATE UNIQUE INDEX idx_search_suggestions_query ON tbl_search_suggestions(query_string)");
     }
 
     protected static void dropTables(SQLiteDatabase db) {
-        db.execSQL("DROP TABLE IF EXISTS tbl_search_history");
+        db.execSQL("DROP TABLE IF EXISTS tbl_search_suggestions");
     }
 
     /*
-     * adds the passed query string, updating the usage counter and date
+     * adds the passed query string, updating the usage date
      */
     public static void addOrUpdateQueryString(@NonNull String query) {
         String date = DateTimeUtils.javaDateToIso8601(new Date());
-        int counter = getCounterForQueryString(query) + 1;
 
         SQLiteStatement stmt = ReaderDatabase.getWritableDb().compileStatement(
-                "INSERT OR REPLACE INTO tbl_search_history (query_string, date_used, counter) VALUES (?1,?2,?3)");
+                "INSERT OR REPLACE INTO tbl_search_suggestions (query_string, date_used) VALUES (?1,?2)");
         try {
             stmt.bindString(1, query);
             stmt.bindString(2, date);
-            stmt.bindLong  (3, counter);
             stmt.execute();
         } finally {
             SqlUtils.closeStatement(stmt);
         }
     }
 
-    private static int getCounterForQueryString(@NonNull String query) {
-        String[] args = {query};
-        return SqlUtils.intForQuery(ReaderDatabase.getReadableDb(),
-                "SELECT counter FROM tbl_search_history WHERE query_string=?", args);
+    public static void deleteQueryString(@NonNull String query) {
+        String[] args = new String[]{query};
+        ReaderDatabase.getWritableDb().delete("tbl_search_suggestions", "query_string=?", args);
     }
 
-    public static List<String> getQueryStrings() {
-        return getQueryStrings(null);
-    }
-    public static List<String> getQueryStrings(String filter) {
-        List<String> queries = new ArrayList<>();
-        Cursor cursor;
+    /**
+     * Returns a cursor containing query strings previously typed by the user
+     * @param filter - filters the list using LIKE syntax (pass null for no filter)
+     * @param max - limit the list to this many items (pass zero for no limit)
+     */
+    public static Cursor getQueryStringCursor(String filter, int max) {
+        String sql;
+        String[] args;
         if (TextUtils.isEmpty(filter)) {
-            cursor = ReaderDatabase.getReadableDb().rawQuery(
-                    "SELECT query_string FROM tbl_search_history ORDER BY date_used DESC", null);
+            sql = "SELECT * FROM tbl_search_suggestions";
+            args = null;
         } else {
-            String likeFilter = filter + "%";
-            cursor = ReaderDatabase.getReadableDb().rawQuery(
-                    "SELECT query_string FROM tbl_search_history WHERE query_string LIKE ? ORDER BY date_used DESC", new String[]{likeFilter});
+            sql = "SELECT * FROM tbl_search_suggestions WHERE query_string LIKE ?";
+            args = new String[]{filter + "%"};
         }
 
-        try {
-            while (cursor.moveToNext()) {
-                queries.add(cursor.getString(0));
-            }
-            return queries;
-        } finally {
-            SqlUtils.closeCursor(cursor);
+        sql += " ORDER BY date_used DESC";
+
+        if (max > 0) {
+            sql += " LIMIT " + max;
         }
+
+        return ReaderDatabase.getReadableDb().rawQuery(sql, args);
     }
 }

WordPress/src/main/java/org/wordpress/android/models/ReaderPost.java

@@ -39,7 +39,7 @@ public class ReaderPost {
     private String primaryTag;    // most popular tag on this post based on usage in blog
     private String secondaryTag;  // second most popular tag on this post based on usage in blog
 
-    public long timestamp;        // used for sorting
+    public double timestamp;        // used for sorting
     private String published;
 
     private String url;
@@ -116,14 +116,19 @@ public static ReaderPost fromJson(JSONObject json) {
         post.blogName = JSONUtils.getStringDecoded(json, "site_name");
         post.published = JSONUtils.getString(json, "date");
 
-        // the date a post was liked is only returned by the read/liked/ endpoint - if this exists,
-        // set it as the timestamp so posts are sorted by the date they were liked rather than the
-        // date they were published (the timestamp is used to sort posts when querying)
-        String likeDate = JSONUtils.getString(json, "date_liked");
-        if (!TextUtils.isEmpty(likeDate)) {
-            post.timestamp = DateTimeUtils.iso8601ToTimestamp(likeDate);
+        // a post's timestamp determines its sort order
+        if (json.has("score")) {
+            // search results include a "score" that should be used for sorting
+            post.timestamp = json.optDouble("score");
         } else {
-            post.timestamp = DateTimeUtils.iso8601ToTimestamp(post.published);
+            // liked posts should be sorted by the date they were liked, otherwise sort by the
+            // published date
+            String likeDate = JSONUtils.getString(json, "date_liked");
+            if (!TextUtils.isEmpty(likeDate)) {
+                post.timestamp = DateTimeUtils.iso8601ToTimestamp(likeDate);
+            } else {
+                post.timestamp = DateTimeUtils.iso8601ToTimestamp(post.published);
+            }
         }
 
         // if the post is untitled, make up a title from the excerpt

WordPress/src/main/java/org/wordpress/android/models/ReaderTag.java

@@ -150,6 +150,7 @@ public static boolean isSameTag(ReaderTag tag1, ReaderTag tag2) {
     public boolean isPostsILike() {
         return tagType == ReaderTagType.DEFAULT && getEndpoint().endsWith("/read/liked");
     }
+
     public boolean isFollowedSites() {
         return tagType == ReaderTagType.DEFAULT && getEndpoint().endsWith("/read/following");
     }

WordPress/src/main/java/org/wordpress/android/models/ReaderTagType.java

@@ -4,12 +4,14 @@ public enum ReaderTagType {
     FOLLOWED,
     DEFAULT,
     RECOMMENDED,
-    CUSTOM_LIST;
+    CUSTOM_LIST,
+    SEARCH;
 
     private static final int INT_DEFAULT     = 0;
     private static final int INT_FOLLOWED    = 1;
     private static final int INT_RECOMMENDED = 2;
     private static final int INT_CUSTOM_LIST = 3;
+    private static final int INT_SEARCH      = 4;
 
     public static ReaderTagType fromInt(int value) {
         switch (value) {
@@ -19,6 +21,8 @@ public static ReaderTagType fromInt(int value) {
                 return FOLLOWED;
             case INT_CUSTOM_LIST:
                 return CUSTOM_LIST;
+            case INT_SEARCH:
+                return SEARCH;
             default :
                 return DEFAULT;
         }
@@ -32,6 +36,8 @@ public int toInt() {
                 return INT_RECOMMENDED;
             case CUSTOM_LIST:
                 return INT_CUSTOM_LIST;
+            case SEARCH:
+                return INT_SEARCH;
             default :
                 return INT_DEFAULT;
         }