Merge lp:~kalikiana/midori/historydb into lp:midori

[Cris Dywan]

Introduce object oriented API for access to History Database

Goals include: introduce object-oriented API, hide SQL internals, allow HistoryDatabase in memory for testing or private browsing, all async (panel specifically), find a way to integrate downloads with history
Note that this will only cover the initial API and autocompletion; to keep review manageable separate branches will deal with speed dial, panel, etc

[Paweł Forysiuk (tuxator)]

Looks good.

review: Approve

=== modified file 'midori/midori-historycompletion.vala'
--- midori/midori-historycompletion.vala	2013-07-14 16:31:30 +0000
+++ midori/midori-historycompletion.vala	2013-07-24 17:43:25 +0000
@@ -11,22 +11,19 @@
 
 namespace Midori {
     public class HistoryCompletion : Completion {
-        unowned Sqlite.Database db;
+        HistoryDatabase? database = null;
 
         public HistoryCompletion () {
             GLib.Object (description: _("Bookmarks and History"));
         }
 
         public override void prepare (GLib.Object app) {
-            GLib.Object history;
-            app.get ("history", out history);
-            return_if_fail (history != null);
-            db = history.get_data<Sqlite.Database?> ("db");
-            return_if_fail (db != null);
+            database = new HistoryDatabase (app);
+            return_if_fail (database != null);
         }
 
         public override bool can_complete (string text) {
-            return db != null;
+            return database != null;
         }
 
         public override bool can_action (string action) {
@@ -34,71 +31,26 @@
         }
 
         public override async List<Suggestion>? complete (string text, string? action, Cancellable cancellable) {
-            return_val_if_fail (db != null, null);
-
-            Sqlite.Statement stmt;
-            unowned string sqlcmd = """
-                SELECT type, uri, title FROM (
-                SELECT 1 AS type, uri, title, count() AS ct FROM history
-                WHERE uri LIKE ?1 OR title LIKE ?1 GROUP BY uri
-                UNION ALL
-                SELECT 2 AS type, replace(uri, '%s', keywords) AS uri,
-                       keywords AS title, count() AS ct FROM search
-                WHERE uri LIKE ?1 OR title LIKE ?1 GROUP BY uri
-                UNION ALL
-                SELECT 1 AS type, uri, title, 50 AS ct FROM bookmarks
-                WHERE title LIKE ?1 OR uri LIKE ?1 AND uri !='' AND uri NOT LIKE 'javascript:%'
-                ) GROUP BY uri ORDER BY ct DESC LIMIT ?2
-                """;
-            if (db.prepare_v2 (sqlcmd, -1, out stmt, null) != Sqlite.OK) {
-                critical (_("Failed to initialize history: %s"), db.errmsg ());
-                return null;
-            }
-
-            string query = "%" + text.replace (" ", "%") + "%";
-            stmt.bind_text (1, query);
-            stmt.bind_int64 (2, max_items);
-
-            int result = stmt.step ();
-            if (result != Sqlite.ROW) {
-                if (result == Sqlite.ERROR)
-                    critical (_("Failed to select from history: %s"), db.errmsg ());
-                return null;
-            }
+            return_val_if_fail (database != null, null);
+
+            List<HistoryItem> items = yield database.list_by_count_with_bookmarks (text, max_items, cancellable);
+            if (items == null)
+                return null;
 
             var suggestions = new List<Suggestion> ();
-            while (result == Sqlite.ROW) {
-                int64 type = stmt.column_int64 (0);
-                unowned string uri = stmt.column_text (1);
-                unowned string title = stmt.column_text (2);
-                Gdk.Pixbuf? icon = Midori.Paths.get_icon (uri, null);
-                Suggestion suggestion;
-
-                switch (type) {
-                    case 1: /* history_view */
-                        suggestion = new Suggestion (uri, title, false, null, icon);
-                        suggestions.append (suggestion);
-                        break;
-                    case 2: /* search_view */
-                        string desc = _("Search for %s").printf (title) + "\n" + uri;
-                        /* FIXME: Theming? Win32? */
-                        string background = "gray";
-                        suggestion = new Suggestion (uri, desc, false, background, icon);
-                        suggestions.append (suggestion);
-                        break;
-                    default:
-                        warn_if_reached ();
-                        break;
-                }
-
-                uint src = Idle.add (complete.callback);
-                yield;
-                Source.remove (src);
-
-                if (cancellable.is_cancelled ())
-                    return null;
-
-                result = stmt.step ();
+            foreach (var item in items) {
+                if (item is Midori.HistoryWebsite) {
+                    var website = item as Midori.HistoryWebsite;
+                    suggestions.append (new Suggestion (website.uri, website.title,
+                        false, null, Midori.Paths.get_icon (website.uri, null)));
+                }
+                else if (item is Midori.HistorySearch) {
+                    var search = item as Midori.HistorySearch;
+                    suggestions.append (new Suggestion (search.uri, search.title + "\n" + search.uri,
+                        false, "gray", Midori.Paths.get_icon (search.uri, null)));
+                }
+                else
+                    warn_if_reached ();
             }
 
             if (cancellable.is_cancelled ())

=== added file 'midori/midori-historydatabase.vala'
--- midori/midori-historydatabase.vala	1970-01-01 00:00:00 +0000
+++ midori/midori-historydatabase.vala	2013-07-24 17:43:25 +0000
@@ -0,0 +1,128 @@
+/*
+ Copyright (C) 2013 Christian Dywan <[e-mail]>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Lesser General Public
+ License as published by the Free Software Foundation; either
+ version 2.1 of the License, or (at your option) any later version.
+
+ See the file COPYING for the full license text.
+*/
+
+namespace Midori {
+    public class HistoryWebsite : HistoryItem {
+        public string uri { get; set; }
+        public HistoryWebsite (string uri, string? title, int64 date) {
+            GLib.Object (uri: uri,
+                         title: title,
+                         date: date);
+        }
+    }
+
+    public class HistorySearch : HistoryItem {
+        public string uri { get; set; }
+        public string keywords { get; set; }
+        public HistorySearch (string uri, string keywords, int64 date) {
+            GLib.Object (uri: uri,
+                         keywords: keywords,
+                         title: _("Search for %s").printf (keywords),
+                         date: date);
+        }
+    }
+
+    public class HistoryItem : GLib.Object {
+        public string? title { get; set; }
+        public int64 date { get; set; }
+    }
+
+    public class HistoryDatabase : GLib.Object {
+        unowned Sqlite.Database db = null;
+
+        public HistoryDatabase (GLib.Object app) {
+            GLib.Object history;
+            app.get ("history", out history);
+            return_val_if_fail (history != null, null);
+            db = history.get_data<Sqlite.Database?> ("db");
+            return_val_if_fail (db != null, null);
+        }
+
+        public async List<HistoryItem>? query (string sqlcmd, string? filter, int day, int max_items, Cancellable cancellable) {
+            return_val_if_fail (db != null, null);
+
+            Sqlite.Statement stmt;
+            int result;
+
+            result = db.prepare_v2 (sqlcmd, -1, out stmt, null);
+            if (result != Sqlite.OK) {
+                critical (_("Failed to select from history: %s"), db.errmsg ());
+                return null;
+            }
+
+            if (":filter" in sqlcmd) {
+                string real_filter = "%" + filter.replace (" ", "%") + "%";
+                stmt.bind_text (stmt.bind_parameter_index (":filter"), real_filter);
+            }
+            if (":day" in sqlcmd)
+                stmt.bind_int64 (stmt.bind_parameter_index (":day"), day);
+            if (":limit" in sqlcmd)
+                stmt.bind_int64 (stmt.bind_parameter_index (":limit"), max_items);
+
+            result = stmt.step ();
+            if (!(result == Sqlite.DONE || result == Sqlite.ROW)) {
+                critical (_("Failed to select from history: %s"), db.errmsg ());
+                return null;
+            }
+
+            var items = new List<HistoryItem> ();
+            while (result == Sqlite.ROW) {
+                int64 type = stmt.column_int64 (0);
+                int64 date = stmt.column_int64 (1);
+                switch (type) {
+                    case 1:
+                        string uri = stmt.column_text (2);
+                        string title = stmt.column_text (3);
+                        items.append (new HistoryWebsite (uri, title, date));
+                        break;
+                    case 2:
+                        string uri = stmt.column_text (2);
+                        string title = stmt.column_text (3);
+                        items.append (new HistorySearch (uri, title, date));
+                        break;
+                    default:
+                        warn_if_reached ();
+                        break;
+                }
+
+                uint src = Idle.add (query.callback);
+                yield;
+                Source.remove (src);
+
+                if (cancellable.is_cancelled ())
+                    return null;
+
+                result = stmt.step ();
+            }
+
+            if (cancellable.is_cancelled ())
+                return null;
+            return items;
+        }
+
+        public async List<HistoryItem>? list_by_count_with_bookmarks (string? filter, int max_items, Cancellable cancellable) {
+            unowned string sqlcmd = """
+                SELECT type, date, uri, title FROM (
+                SELECT 1 AS type, date, uri, title, count() AS ct FROM history
+                WHERE uri LIKE :filter OR title LIKE :filter GROUP BY uri
+                UNION ALL
+                SELECT 2 AS type, day AS date, replace(uri, '%s', keywords) AS uri,
+                       keywords AS title, count() AS ct FROM search
+                WHERE uri LIKE :filter OR title LIKE :filter GROUP BY uri
+                UNION ALL
+                SELECT 1 AS type, last_visit AS date, uri, title, 50 AS ct FROM bookmarks
+                WHERE title LIKE :filter OR uri LIKE :filter AND uri !='' AND uri NOT LIKE 'javascript:%'
+                ) GROUP BY uri ORDER BY ct DESC LIMIT :limit
+                """;
+            return yield query (sqlcmd, filter, 0, max_items, cancellable);
+        }
+   }
+}