Merge lp:~knitzsche/scope-aggregator/hints-dismiss-via-cannedquery-user-data into lp:scope-aggregator

[Kyle Nitzsche]

this MR is 1 of 2 needed to remove the problem of hints quickstart help using the query string to signal back to the agg scope not to show quickstart any more.

I found that we can use canned query's user_data to contain the signal and this can be retrieved inside the agg scope.

The other MR is against hints scope. And of course the agg scopes that use this feature (photos and today that I know of) will also need to be updated and released with these.

[Gary.Wang (gary-wzl77)]

Looks good to me
Thanks.

P.S I was not aware that we have an api to handle this. I will make some code change to use user_data instead query_string, alongside with new features added or bug fixing.

review: Approve

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2016-02-25 22:10:24 +0000
+++ CMakeLists.txt	2016-02-26 22:05:20 +0000
@@ -1,4 +1,4 @@
-set(VERSION "4.3")
+set(VERSION "4.3.1")
 
 # Supress qDebug() output
 ADD_DEFINITIONS( -DQT_NO_DEBUG_OUTPUT )

=== modified file 'include/query.h'
--- include/query.h	2015-12-01 08:56:26 +0000
+++ include/query.h	2016-02-26 22:05:20 +0000
@@ -201,14 +201,14 @@
     bool uses_hints = false;
     unity::scopes::ScopeProxy hints_scope;
     bool hints_quickstart = false;
-    QString hints_is_hidden = "hints_is_hidden";
+    QString hints_file = "hints_is_hidden";
     QString firstboot = "firstboot";
 
     void load_hints();
     bool hints_exists();
     void display_hints_quickstart(us::SearchReplyProxy const& upstream_reply_);
     bool show_hints(us::SearchReplyProxy const& upstream_reply_);
-    bool is_hints_quickstart_dismissed();
+    bool hints_hidden();
     void dismiss_hints_quickstart();
     std::string HINTS_SCOPE_ID;//fqn of hints scope
     std::string HINTS_THIS_SCOPE;//tells hints which agg scope this is

=== modified file 'src/query.cpp'
--- src/query.cpp	2016-02-11 21:36:15 +0000
+++ src/query.cpp	2016-02-26 22:05:20 +0000
@@ -103,22 +103,61 @@
 
     load_hints();
 
+    bool hide_hints_quickstart = false;
+
     qDebug() << "==== HINTS. uses_hints" << uses_hints;
     qDebug() << "==== HINTS. display_hints_on_firstuse" << hints_quickstart;
     qDebug() << "==== HINTS. query_string" << qstr(query_string);
 
-    if (uses_hints && hints_quickstart && hints_exists() && query_string == HINTS_HIDE)
-    {
-        dismiss_hints_quickstart();
-	// when dismissing hints, query string must be set to "" to prevent subsearching 
-	// child scopes.
-        query_string = "";
-    }
-
-    if (uses_hints && hints_quickstart && hints_exists() && !is_hints_quickstart_dismissed())
-    {
-        display_hints_quickstart(upstream_reply);
-        return;
+    // user data can show whether to hide hints quickstart
+    if (query().has_user_data())
+    {
+        try 
+        {
+            std::string data = query().user_data().get_string();
+            if (data == "hide_quickstart")
+            {
+                hide_hints_quickstart = true;
+             }
+        } catch (unity::LogicException &e)
+        {
+            qWarning() << "=== HINTS. cannot get data from canned query";
+        }
+    }
+
+    qDebug() << "=== HINTS CQ hide hints: " << hide_hints_quickstart;
+    qDebug() << "=== HINTS hints_hidden: " << hints_hidden();
+    bool show_normal = true;
+
+ /*
+ * Note: To redisplay hints at runtime, touch "hints_is_hidden" in cache dir
+ * and restart unity8-dash. Restart is needed because the incoming canned
+ * query tends to persist, so once the user has dimissed hints quickstart
+ * and that signal was sent via the canned query user_data, it sticks around
+ */
+    if (hide_hints_quickstart)
+    {
+        show_normal = true;
+        if (!hints_hidden())// checks for "hints_is_hidden" cache file
+            dismiss_hints_quickstart();// write "hints_is_hidden" cache file
+    } else {
+        if (hints_hidden())// checks for "hints_is_hidden" cache file
+        {
+            qDebug() << "=== HINTS CASE 3";
+            show_normal = true; 
+        } else {
+            qDebug() << "=== HINTS CASE 4";
+            show_normal = false; 
+        }
+    }
+
+    if (!show_normal)
+    {
+        qDebug() << "==== HINTS. show_normal is FALSE, show hints"; 
+        if (uses_hints && hints_quickstart && hints_exists()) {
+            display_hints_quickstart(upstream_reply);
+            return;
+        }
     }
 
     bool has_network = true;

=== modified file 'src/utils.cpp'
--- src/utils.cpp	2016-02-09 16:11:02 +0000
+++ src/utils.cpp	2016-02-26 22:05:20 +0000
@@ -1278,6 +1278,7 @@
 
 void Query::display_hints_quickstart(us::SearchReplyProxy const& upstream_reply_)
 {
+
     Category::SCPtr hint_cat;
     SearchMetadata metadata(search_metadata());
 
@@ -1290,9 +1291,9 @@
               metadata, reply);
 }
 
-bool Query::is_hints_quickstart_dismissed(){
+bool Query::hints_hidden(){
 
-    auto filepath1 = QString::fromStdString(cache_dir_) +"/" + hints_is_hidden;
+    auto filepath1 = QString::fromStdString(cache_dir_) +"/" + hints_file;
     auto filepath2 = QString::fromStdString(cache_dir_) +"/" + firstboot;
     if (QFile::exists(filepath1) || QFile::exists(filepath2))
         return true;
@@ -1301,10 +1302,11 @@
 }
 
 void Query::dismiss_hints_quickstart() {
-    auto filepath= QString::fromStdString(cache_dir_) +"/" + hints_is_hidden;
+    qDebug() << "==== HINTS in dismiss()";
+    auto filepath= QString::fromStdString(cache_dir_) +"/" + hints_file;
     QFile file(filepath);
     file.open(QIODevice::WriteOnly);
-    QString msg = QString("Timestamp for %1").arg(qstr(HINTS_THIS_SCOPE));
+    QString msg = QString("Timestamp for %1 %2").arg(qstr(HINTS_THIS_SCOPE), QDateTime::currentDateTime().toString());
     file.write(sstr(msg).c_str(), sstr(msg).size());
     file.close();
 }