Reader search design review

WordPress/src/main/AndroidManifest.xml

@@ -264,7 +264,8 @@
         <activity
             android:name=".ui.reader.ReaderPostListActivity"
             android:label="@string/reader"
-            android:theme="@style/Calypso.NoActionBar" />
+            android:theme="@style/Calypso.NoActionBar">
+        </activity>
         <activity
             android:name=".ui.reader.ReaderPostPagerActivity"
             android:label="@string/reader_title_post_detail"
@@ -398,6 +399,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/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 = 115;
+    private static final int DB_VERSION = 119;
 
     /*
      * version history
@@ -66,7 +66,11 @@ public class ReaderDatabase extends SQLiteOpenHelper {
      *  112 - no structural change, just reset db
      *  113 - added tag_title to tag tables
      *  114 - renamed tag_name to tag_slug in tag tables
-     *  115 - added tag_display_name to 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
+     *  119 - renamed tbl_posts.timestamp to sort_index
      */
 
     /*
@@ -142,6 +146,7 @@ private void createAllTables(SQLiteDatabase db) {
         ReaderUserTable.createTables(db);
         ReaderThumbnailTable.createTables(db);
         ReaderBlogTable.createTables(db);
+        ReaderSearchTable.createTables(db);
     }
 
     private void dropAllTables(SQLiteDatabase db) {
@@ -152,6 +157,7 @@ private void dropAllTables(SQLiteDatabase db) {
         ReaderUserTable.dropTables(db);
         ReaderThumbnailTable.dropTables(db);
         ReaderBlogTable.dropTables(db);
+        ReaderSearchTable.dropTables(db);
     }
 
     /*

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

@@ -45,7 +45,7 @@ public class ReaderPostTable {
           + "featured_image,"       // 16
           + "featured_video,"       // 17
           + "post_avatar,"          // 18
-          + "timestamp,"            // 19
+          + "sort_index,"           // 19 - this is a score for search results, otherwise it's a timestamp
           + "published,"            // 20
           + "num_replies,"          // 21
           + "num_likes,"            // 22
@@ -83,7 +83,7 @@ public class ReaderPostTable {
           + "tbl_posts.url,"                  // 15
           + "tbl_posts.short_url,"            // 16
           + "tbl_posts.post_avatar,"          // 17
-          + "tbl_posts.timestamp,"            // 18
+          + "tbl_posts.sort_index,"           // 18
           + "tbl_posts.published,"            // 19
           + "tbl_posts.num_replies,"          // 20
           + "tbl_posts.num_likes,"            // 21
@@ -122,7 +122,7 @@ protected static void createTables(SQLiteDatabase db) {
                 + " featured_image      TEXT,"
                 + " featured_video      TEXT,"
                 + " post_avatar         TEXT,"
-                + " timestamp           INTEGER DEFAULT 0,"
+                + " sort_index          REAL DEFAULT 0,"
                 + " published           TEXT,"
                 + " num_replies         INTEGER DEFAULT 0,"
                 + " num_likes           INTEGER DEFAULT 0,"
@@ -142,7 +142,7 @@ protected static void createTables(SQLiteDatabase db) {
                 + " xpost_blog_id       INTEGER DEFAULT 0,"
                 + " PRIMARY KEY (post_id, blog_id)"
                 + ")");
-        db.execSQL("CREATE INDEX idx_posts_timestamp ON tbl_posts(timestamp)");
+        db.execSQL("CREATE INDEX idx_posts_sort_index ON tbl_posts(sort_index)");
 
         db.execSQL("CREATE TABLE tbl_post_tags ("
                 + "   post_id           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);
 
@@ -203,14 +206,22 @@ private static int purgePostsForTag(SQLiteDatabase db, ReaderTag tag) {
                 + "  WHERE tbl_posts.pseudo_id = tbl_post_tags.pseudo_id"
                 + "  AND tbl_post_tags.tag_name=?"
                 + "  AND tbl_post_tags.tag_type=?"
-                + "  ORDER BY tbl_posts.timestamp"
+                + "  ORDER BY tbl_posts.sort_index"
                 + "  LIMIT ?"
                 + ")";
         int numDeleted = db.delete("tbl_post_tags", where, args);
         AppLog.d(AppLog.T.READER, String.format("reader post table > purged %d posts in tag %s", numDeleted, tag.getTagNameForLog()));
         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;
@@ -455,7 +466,7 @@ public static void removeGapMarkerForTag(final ReaderTag tag) {
     /*
      * returns the blogId/postId of the post with the passed tag that has a gap marker, or null if none exists
      */
-    public static ReaderBlogIdPostId getGapMarkerForTag(final ReaderTag tag) {
+    public static ReaderBlogIdPostId getGapMarkerIdsForTag(final ReaderTag tag) {
         if (tag == null) {
             return null;
         }
@@ -490,7 +501,7 @@ public static void setGapMarkerForTag(long blogId, long postId, ReaderTag tag) {
     }
 
     public static String getGapMarkerPubDateForTag(ReaderTag tag) {
-        ReaderBlogIdPostId ids = getGapMarkerForTag(tag);
+        ReaderBlogIdPostId ids = getGapMarkerIdsForTag(tag);
         if (ids == null) {
             return null;
         }
@@ -499,29 +510,29 @@ public static String getGapMarkerPubDateForTag(ReaderTag tag) {
         return SqlUtils.stringForQuery(ReaderDatabase.getReadableDb(), sql, args);
     }
 
-    private static long getGapMarkerTimestampForTag(ReaderTag tag) {
-        ReaderBlogIdPostId ids = getGapMarkerForTag(tag);
+    private static long getGapMarkerSortIndexForTag(ReaderTag tag) {
+        ReaderBlogIdPostId ids = getGapMarkerIdsForTag(tag);
         if (ids == null) {
             return 0;
         }
 
         String[] args = {Long.toString(ids.getBlogId()), Long.toString(ids.getPostId())};
-        String sql = "SELECT timestamp FROM tbl_posts WHERE blog_id=? AND post_id=?";
+        String sql = "SELECT sort_index FROM tbl_posts WHERE blog_id=? AND post_id=?";
         return SqlUtils.longForQuery(ReaderDatabase.getReadableDb(), sql, args);
     }
 
     /*
-     * delete posts with the passed tag that are older than one with the gap marker for
+     * delete posts with the passed tag that come before the one with the gap marker for
      * this tag - note this may leave some stray posts in tbl_posts, but these will
      * be cleaned up by the next purge
      */
-    public static void deletePostsOlderThanGapMarkerForTag(ReaderTag tag) {
-        long timestamp = getGapMarkerTimestampForTag(tag);
-        if (timestamp == 0) return;
+    public static void deletePostsBeforeGapMarkerForTag(ReaderTag tag) {
+        long sortIndex = getGapMarkerSortIndexForTag(tag);
+        if (sortIndex == 0) return;
 
-        String[] args = {Long.toString(timestamp), tag.getTagSlug(), Integer.toString(tag.tagType.toInt())};
+        String[] args = {Long.toString(sortIndex), tag.getTagSlug(), Integer.toString(tag.tagType.toInt())};
         String where = "pseudo_id IN (SELECT tbl_posts.pseudo_id FROM tbl_posts, tbl_post_tags"
-                + " WHERE tbl_posts.timestamp < ?"
+                + " WHERE tbl_posts.sort_index < ?"
                 + " AND tbl_posts.pseudo_id = tbl_post_tags.pseudo_id"
                 + " AND tbl_post_tags.tag_name=? AND tbl_post_tags.tag_type=?)";
         int numDeleted = ReaderDatabase.getWritableDb().delete("tbl_post_tags", where, args);
@@ -632,7 +643,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.sortIndex);
                 stmtPosts.bindString(20, post.getPublished());
                 stmtPosts.bindLong  (21, post.numReplies);
                 stmtPosts.bindLong  (22, post.numLikes);
@@ -699,7 +710,7 @@ public static ReaderPostList getPostsWithTag(ReaderTag tag, int maxPosts, boolea
             }
         }
 
-        sql += " ORDER BY tbl_posts.timestamp DESC";
+        sql += " ORDER BY tbl_posts.sort_index DESC";
 
         if (maxPosts > 0) {
             sql += " LIMIT " + Integer.toString(maxPosts);
@@ -716,7 +727,7 @@ public static ReaderPostList getPostsWithTag(ReaderTag tag, int maxPosts, boolea
 
     public static ReaderPostList getPostsInBlog(long blogId, int maxPosts, boolean excludeTextColumn) {
         String columns = (excludeTextColumn ? COLUMN_NAMES_NO_TEXT : "tbl_posts.*");
-        String sql = "SELECT " + columns + " FROM tbl_posts WHERE blog_id = ? ORDER BY tbl_posts.timestamp DESC";
+        String sql = "SELECT " + columns + " FROM tbl_posts WHERE blog_id = ? ORDER BY tbl_posts.sort_index DESC";
 
         if (maxPosts > 0) {
             sql += " LIMIT " + Integer.toString(maxPosts);
@@ -732,7 +743,7 @@ public static ReaderPostList getPostsInBlog(long blogId, int maxPosts, boolean e
 
     public static ReaderPostList getPostsInFeed(long feedId, int maxPosts, boolean excludeTextColumn) {
         String columns = (excludeTextColumn ? COLUMN_NAMES_NO_TEXT : "tbl_posts.*");
-        String sql = "SELECT " + columns + " FROM tbl_posts WHERE feed_id = ? ORDER BY tbl_posts.timestamp DESC";
+        String sql = "SELECT " + columns + " FROM tbl_posts WHERE feed_id = ? ORDER BY tbl_posts.sort_index DESC";
 
         if (maxPosts > 0) {
             sql += " LIMIT " + Integer.toString(maxPosts);
@@ -769,7 +780,7 @@ public static ReaderBlogIdPostIdList getBlogIdPostIdsWithTag(ReaderTag tag, int
             }
         }
 
-        sql += " ORDER BY tbl_posts.timestamp DESC";
+        sql += " ORDER BY tbl_posts.sort_index DESC";
 
         if (maxPosts > 0) {
             sql += " LIMIT " + Integer.toString(maxPosts);
@@ -793,7 +804,7 @@ public static ReaderBlogIdPostIdList getBlogIdPostIdsWithTag(ReaderTag tag, int
      * same as getPostsInBlog() but only returns the blogId/postId pairs
      */
     public static ReaderBlogIdPostIdList getBlogIdPostIdsInBlog(long blogId, int maxPosts) {
-        String sql = "SELECT post_id FROM tbl_posts WHERE blog_id = ? ORDER BY tbl_posts.timestamp DESC";
+        String sql = "SELECT post_id FROM tbl_posts WHERE blog_id = ? ORDER BY tbl_posts.sort_index DESC";
 
         if (maxPosts > 0) {
             sql += " LIMIT " + Integer.toString(maxPosts);
@@ -847,7 +858,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.sortIndex = c.getDouble(c.getColumnIndex("sort_index"));
         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

@@ -0,0 +1,84 @@
+package org.wordpress.android.datasets;
+
+import android.database.Cursor;
+import android.database.sqlite.SQLiteDatabase;
+import android.database.sqlite.SQLiteStatement;
+import android.support.annotation.NonNull;
+import android.text.TextUtils;
+
+import org.wordpress.android.util.DateTimeUtils;
+import org.wordpress.android.util.SqlUtils;
+
+import java.util.Date;
+
+/**
+ * search suggestion table - populated by user's reader search history
+ */
+public class ReaderSearchTable {
+
+    public static final String COL_ID    = "_id";
+    public static final String COL_QUERY = "query_string";
+
+    protected static void createTables(SQLiteDatabase db) {
+        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_suggestions");
+    }
+
+    /*
+     * adds the passed query string, updating the usage date
+     */
+    public static void addOrUpdateQueryString(@NonNull String query) {
+        String date = DateTimeUtils.javaDateToIso8601(new Date());
+
+        SQLiteStatement stmt = ReaderDatabase.getWritableDb().compileStatement(
+                "INSERT OR REPLACE INTO tbl_search_suggestions (query_string, date_used) VALUES (?1,?2)");
+        try {
+            stmt.bindString(1, query);
+            stmt.bindString(2, date);
+            stmt.execute();
+        } finally {
+            SqlUtils.closeStatement(stmt);
+        }
+    }
+
+    public static void deleteQueryString(@NonNull String query) {
+        String[]args = new String[]{query};
+        ReaderDatabase.getWritableDb().delete("tbl_search_suggestions", "query_string=?", args);
+    }
+
+    public static void deleteAllQueries() {
+        SqlUtils.deleteAllRowsInTable(ReaderDatabase.getWritableDb(), "tbl_search_suggestions");
+    }
+
+    /**
+     * 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)) {
+            sql = "SELECT * FROM tbl_search_suggestions";
+            args = null;
+        } else {
+            sql = "SELECT * FROM tbl_search_suggestions WHERE query_string LIKE ?";
+            args = new String[]{filter + "%"};
+        }
+
+        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 sortIndex;
     private String published;
 
     private String url;
@@ -116,14 +116,15 @@ 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);
+        // sort index determines how posts are sorted - this is a "score" for search results,
+        // liked date for liked posts, and published date for all others
+        if (json.has("score")) {
+            post.sortIndex = json.optDouble("score");
+        } else if (json.has("date_liked")) {
+            String likeDate = JSONUtils.getString(json, "date_liked");
+            post.sortIndex = DateTimeUtils.iso8601ToTimestamp(likeDate);
         } else {
-            post.timestamp = DateTimeUtils.iso8601ToTimestamp(post.published);
+            post.sortIndex = 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");
     }