Merge lp:~knitzsche/scope-aggregator/bug-1602141-only-show-help-for-installed into lp:scope-aggregator

[Kyle Nitzsche]

do not display quick start help result for any click child scope that is not installed.

[lp:~knitzsche/scope-aggregator/bug-1602141-only-show-help-for-installed]

170. By Kyle Nitzsche on 2016-07-19

The previous commit handled half of the problem: suppressing irrelevant
quick start resuls by not displaying it when it relates to a click packaged
scope that is not installed.

This commit handles the another case, currently invoked for google.

That is, the Today scope quick start help has a result that
simply allows the user to open Settings > Accounts for Google provider.
This result is not connected to any specific child scope.
With this commit. you can declare in the hints.json file that a result
is not to be displayed in the supplied comma separated list of locales
in the form:
ll_CC (where ll is the lang code and CC is the country code).

For example, this hides the only item in the google-account category
when in two locales: es_ES and fr_FR:

(A more real-world example would be China: zh_CN)

"local":
{
    "content":
    {
        "categories":
        [
            {
                "id": "google-account",
                "_title": "See your events and more from Google.",
                "layout":
                {
                    [...]
                },
                "items": [
                    {
                        "hide_in_locales":"es_ES,fr_FR",
                        "_title": "<b> Review your Google sync settings</b>",
                        "_description": "Adding your Google ...",
                        "art":"google.png",
                        "action": {
                            "_name": "Add account",
                            "uri": "settings:///system/online-accounts"
                        }
                    }
                ]
            },

171. By Kyle Nitzsche on 2016-07-19

remove debug from log and set ver to 4.12

172. By Kyle Nitzsche on 2016-07-19

remove a couple qDebug() statemetns.

[Zhang Enwei (zhangew401)]

Hi Kyle,
For scopes that are using new online account settings, the service name is not the scope id. It is scopeid_providername and it is generated by online-account-hooks2.
Please refer to
http://bazaar.launchpad.net/~facebook-scope-team/facebook-scope/trunk/revision/144#src/query.cpp
https://bazaar.launchpad.net/~hanloon-team/hanloon/unity-scope-fitbit/revision/48#src/fitbit.go
https://developer.ubuntu.com/en/phone/platform/guides/online-accounts-developer-guide/（there are errors in this page)

[lp:~knitzsche/scope-aggregator/bug-1602141-only-show-help-for-installed]

173. By Kyle Nitzsche on 2016-07-25

This commit also supports making an online accounts client for child scopes
that have been been migrated to the new online accounts starting with
15.04.4. Such child scopes use a different id when creating the client for them.

before 15.04.4: id is pkg_app
starting with 15.04.4: id is pkg_ap_provider

This commit splits the ServiceName value (from hints.json)
on "_". The scope ID (needed to check if the scope is installed/registered
is the first two tokens (rejoined by "_"). If there is no third token, that
is used to create the online accounts client, thus working for child scopes
not yet migrated to 15.04.4 online accounts.

If there is a third token, it is the provider and it is appended to the
scope id and is used to create the online accounts client, thus supporting
updated child scopes.

[Kyle Nitzsche (knitzsche)]

Note that I tested rev 170 change with:
* fbphotos scope 1.32 (which uses the new post 15.04.4 online accounts)
* photos-scope from here: https://code.launchpad.net/~knitzsche/photos-scope/mr-300480-verification

[Kyle Nitzsche (knitzsche)]

Oops. previous comment should have said I tested rev *173* (not rev 170)

[Zhang Enwei (zhangew401)]

Look good to me!

review: Approve

[Gary.Wang (gary-wzl77)]

Hi Kyle
   Thanks for this MP.
   Please see my inline comment.

...
(A more real-world example would be China: zh_CN)
...
This made me LOL.:P

review: Needs Fixing

[lp:~knitzsche/scope-aggregator/bug-1602141-only-show-help-for-installed]

174. By Kyle Nitzsche on 2016-07-26

use QStringLiteral
version to 4.11
supress QT debug

[Kyle Nitzsche (knitzsche)]

thanks Gary (for the QStringLiteral reminder) and Enwei (for your reviews). I'll merge this. Cheers

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2016-07-19 01:59:33 +0000
+++ CMakeLists.txt	2016-07-26 15:15:42 +0000
@@ -1,4 +1,4 @@
-set(VERSION "4.10")
+set(VERSION "4.11")
 
 # Supress qDebug() output
 ADD_DEFINITIONS( -DQT_NO_DEBUG_OUTPUT )

=== modified file 'data/hints.json'
--- data/hints.json	2016-06-23 19:37:49 +0000
+++ data/hints.json	2016-07-26 15:15:42 +0000
@@ -68,6 +68,7 @@
                     },
                     "items": [
                         {
+                            "hide_in_locales": "zh_CN",
                             "_title": "<b>   Review your Google sync settings</b>",
                             "_description": "Adding your Google account will allow Today to display your events and contacts.<br><br>Press the button below to add your account (or go to accounts in the Settings app).<br><br>Remember to enable the contact and calendar sync once you have successfully added it.",
                             "art":"icons/today/google.png",

=== modified file 'src/utils.cpp'
--- src/utils.cpp	2016-07-19 01:59:33 +0000
+++ src/utils.cpp	2016-07-26 15:15:42 +0000
@@ -1231,6 +1231,18 @@
             res["subtitle"] = _(sstr(res_[QStringLiteral("_subtitle")].toString()).c_str());
             res["description"] = _(sstr(res_[QStringLiteral("_description")].toString()).c_str());
             std::string uri = "http://www.ubuntu.com";
+            if (res_.contains(QStringLiteral("hide_in_locales")))
+            {
+                QStringList hide_in_locales = res_[QStringLiteral("hide_in_locales")].toString().split(",");
+                std::string lcRaw = setlocale(LC_ALL, ""); 
+                std::string lc_lang = lcRaw.size() > 5 ? lcRaw.substr(0, 2) : "";
+                std::string lc_country  = lcRaw.size() > 5 ? lcRaw.substr(3, 2) : "";
+                std::string lc = lc_lang + "_" + lc_country;
+                if (hide_in_locales.contains(qstr(lc)))
+                {
+                    continue;
+                }
+            }
             if (res_.contains("uri"))
             {
                 uri = sstr(res_["uri"].toString());
@@ -1255,12 +1267,23 @@
                 auto oaccount = res_[QStringLiteral("oaccount")].toObject();
                 auto queryScope = sstr(oaccount[QStringLiteral("QueryScope")].toString());
 
-                us::OnlineAccountClient oa_client(sstr(oaccount[QStringLiteral("ServiceName")].toString()),
+                // before framework 15.0.4.4 the service name is the FQ scope id and contains one "_"
+                // with 15.04.4, it is FQ scope id += _PROVIDER
+                // we also want the fully qualified scope id to check with registry if it is installed.
+                // to support both cases:
+                QStringList parts = oaccount[QStringLiteral("ServiceName")].toString().split("_");
+                QString provider = oaccount[QStringLiteral("ProviderName")].toString();
+                QString sc_id = parts[0] + "_" + parts[1];
+                QString id = sc_id;
+                if (parts.size() > 2) // framework 15.04.4 or higher 
+                {
+                    id += "_" + provider;
+                }
+                us::OnlineAccountClient oa_client(sstr(id),
                                                   sstr(oaccount[QStringLiteral("ServiceType")].toString()),
-                                                  sstr(oaccount[QStringLiteral("ProviderName")].toString()));
+                                                  sstr(provider));
                 bool alreadyLoggedIn = false;
                 oa_client.refresh_service_statuses();
-                auto vectoraccounts = oa_client.get_service_statuses();
                 for (auto const& status : oa_client.get_service_statuses())
                 {
                     if (status.service_enabled)
@@ -1269,6 +1292,14 @@
                         break;
                     }
                 }
+                // do not display quick start help for scopes that are not registered in the system
+                auto reg_scopes = registry_->list();
+                us::MetadataMap::const_iterator scope_it;
+                scope_it = reg_scopes.find(sstr(sc_id));
+                if (scope_it == reg_scopes.end()) {
+                    qWarning () << QString("%1: OA scope is NOT REGISTERED, skipping for HINTS: %2").arg(oaccount[QStringLiteral("ServiceName")].toString());
+                    continue;
+                }
                 if (alreadyLoggedIn) {
                     //the hints code does this when the person is already logged in to the service.
                     //auto tmp = oaccount["_loggedin"].toString().toStdString();