Merge lp:~rmescandon/scopecreator/rss-template-read-settings-from-metadata-take2 into lp:~scopecreator-team/scopecreator/rss-template

[Roberto Mier Escandon]

Same features than branch
scopecreator/rss-template-read-settings-from-metadata

but reading scope .ini file directly using QSettings instead of using Scope::metadata

This solution is working well and can be used as alternative to scopecreator/rss-template-read-settings-from-metadata branch. Only one of both should be merged

Same features than branch
scopecreator/rss-template-read-settings-from-metadata

but reading scope .ini file directly using QSettings instead of using Scope::metadata

This solution is working well and can be used as alternative to scopecreator/rss-template-read-settings-from-metadata branch. Only one of both should be merged

[Scott Sweeny (ssweeny)]

I've been running a scope based on this for a few weeks now and it works flawlessly :-)

Merging.

review: Approve

=== modified file 'data/rss.canonical_rss.ini.in'
--- data/rss.canonical_rss.ini.in	2015-08-08 22:18:29 +0000
+++ data/rss.canonical_rss.ini.in	2015-08-08 22:18:29 +0000
@@ -10,3 +10,6 @@
 PageHeader.Logo=logo.png
 PageHeader.Background=color:///#e9e7e8
 PageHeader.DividerColor=#ffeb00
+Emblem=logo.png
+DateTimeFormat="hh:mm, d MMMM"
+BigFirstResult=true

=== modified file 'include/scope/query.h'
--- include/scope/query.h	2015-08-08 22:18:29 +0000
+++ include/scope/query.h	2015-08-08 22:18:29 +0000
@@ -25,6 +25,9 @@
 #include <unity/scopes/SearchQueryBase.h>
 #include <unity/scopes/ReplyProxyFwd.h>
 
+#include <QSharedPointer>
+#include <QSettings>
+
 #include <map>
 
 namespace scope {
@@ -40,7 +43,8 @@
 public:
     Query(const unity::scopes::CannedQuery &query,
           const unity::scopes::SearchMetadata &metadata,
-          const std::string scope_directory);
+          const std::string& scope_directory,
+          const QSharedPointer<QSettings>& scopeConfig);
 
     ~Query() = default;
 
@@ -51,6 +55,7 @@
 private:
     api::Client client_;
     std::string scope_directory_;
+    QSharedPointer<QSettings> mScopeConfig;
 
     /// @brief keyword_feeds_ map correlating aggregator scopes keywords to feed urls
     std::map<std::string, std::string> keyword_feeds_;
@@ -65,6 +70,23 @@
     /// from an aggregator scope. If found, it is returned a std::pair with the feed url (pair.second) and its related
     /// search keyword (pair.first)
     std::pair<std::string, std::string> find_url_for_keywords(const std::set<std::string>& search_keywords);
+
+    /// @brief get_display_name returns the scope name to display
+    std::string get_display_name();
+
+    /// @brief get_icon returns the scoe icon file path. scope_directory/icon.png if value is not set in scope config
+    std::string get_icon();
+
+    /// @brief get_emblem gets the emblem by reading the appearance parameter "Emblem" value if set. If not set,
+    /// scope_directory/emblem.png file is used by default
+    std::string get_emblem();
+
+    /// @brief get_date_time_format returns the format to be shown for the date and time for every result shown in an
+    /// aggregator scope. If this parameter is not set, the default format is 'hh:mm, d MMMM'
+    std::string get_date_time_format();
+
+    /// @brief get_big_first_result returns true if wanted to have first returned value in a format with a big image and overlayed
+    bool get_big_first_result();
 };
 
 }

=== modified file 'include/scope/scope.h'
--- include/scope/scope.h	2015-03-25 03:17:53 +0000
+++ include/scope/scope.h	2015-08-08 22:18:29 +0000
@@ -28,6 +28,9 @@
 #include <unity/scopes/QueryBase.h>
 #include <unity/scopes/PreviewQueryBase.h>
 
+#include <QSettings>
+#include <QSharedPointer>
+
 namespace scope {
 
 /**
@@ -62,6 +65,12 @@
     unity::scopes::SearchQueryBase::UPtr search(
             unity::scopes::CannedQuery const& q,
             unity::scopes::SearchMetadata const&) override;
+
+private:
+    std::string scope_id_;
+    QSharedPointer<QSettings> mScopeConfig;
+
+    void loadScopeConfig();
 };
 
 }

=== modified file 'po/rss.pot'
--- po/rss.pot	2015-08-08 22:18:29 +0000
+++ po/rss.pot	2015-08-08 22:18:29 +0000
@@ -8,7 +8,7 @@
 msgstr ""
 "Project-Id-Version: PACKAGE VERSION\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2015-08-03 17:04+0200\n"
+"POT-Creation-Date: 2015-08-09 00:05+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <[e-mail]>\n"
@@ -21,6 +21,10 @@
 msgid "Vox"
 msgstr ""
 
-#: ../src/scope/query.cpp:266
+#: ../src/scope/query.cpp:309
 msgid "Open"
 msgstr ""
+
+#: ../src/scope/query.cpp:316
+msgid "More from "
+msgstr ""

=== modified file 'src/scope/query.cpp'
--- src/scope/query.cpp	2015-08-08 22:18:29 +0000
+++ src/scope/query.cpp	2015-08-08 22:18:29 +0000
@@ -19,7 +19,6 @@
 
 #include <boost/algorithm/string/trim.hpp>
 #include <boost/algorithm/string/predicate.hpp>
-#include <boost/foreach.hpp>
 
 #include <scope/localization.h>
 #include <scope/query.h>
@@ -29,6 +28,7 @@
 #include <unity/scopes/CategoryRenderer.h>
 #include <unity/scopes/Department.h>
 #include <unity/scopes/QueryBase.h>
+#include <unity/scopes/CannedQuery.h>
 #include <unity/scopes/SearchReply.h>
 #include <unity/scopes/VariantBuilder.h>
 #include <unity/scopes/SearchMetadata.h>
@@ -43,8 +43,6 @@
 #include <QJsonObject>
 #include <QDateTime>
 
-#define foreach BOOST_FOREACH
-
 namespace sc = unity::scopes;
 namespace alg = boost::algorithm;
 
@@ -52,6 +50,23 @@
 using namespace api;
 using namespace scope;
 
+std::string FIRST_NEWS_LAYOUT = R"(
+{
+    "schema-version" : 1,
+    "template" : {
+        "category-layout" : "grid",
+        "card-size": "large",
+        "overlay": true
+    },
+    "components" : {
+        "title" : "title",
+        "art" : {
+            "field": "art",
+            "aspect-ratio": 2.1
+        }
+    }
+}
+)";
 
 std::string NEWS_LAYOUT = R"(
 {
@@ -147,29 +162,32 @@
 }
 
 pair<string,string> Query::find_url_for_keywords(const set<string>& search_keywords) {
-    foreach(string search_keyword, search_keywords) {
+    for(const string& search_keyword : search_keywords) {
         auto it = keyword_feeds_.find(search_keyword);
         if (it != keyword_feeds_.end()) {
-            string found_url = it->second;
+            const string& found_url = it->second;
             return std::pair<string, string>(search_keyword, found_url);
         }
     }
     return std::pair<string, string>{};
 }
 
-Query::Query(const sc::CannedQuery &query, const sc::SearchMetadata &metadata, const string scope_directory) :
-    sc::SearchQueryBase(query, metadata),
-    client_(),
-    scope_directory_(scope_directory) {
+Query::Query(const sc::CannedQuery &query,
+             const sc::SearchMetadata &search_metadata,
+             const string& scope_directory,
+             const QSharedPointer<QSettings>& scopeConfig)
+    : sc::SearchQueryBase(query, search_metadata)
+    , client_{}
+    , scope_directory_{scope_directory}
+    , mScopeConfig{scopeConfig} {
 }
 
 void Query::cancelled() {
     client_.cancel();
 }
 
-
 void Query::run(sc::SearchReplyProxy const& reply) {
-    try {        
+    try {
         // Start by getting information about the query
         const sc::CannedQuery &query(sc::SearchQueryBase::query());
 
@@ -203,74 +221,105 @@
 
         vector<Client::Item> results = client_.getItems(feedUrl);
 
-        // Register a category for the forecast
+        // Register a category for the common news
         auto news_cat = reply->register_category("news",
                                                  "", "", sc::CategoryRenderer(NEWS_LAYOUT));
-
-        // For each of the forecast days
-        for (const auto &item : results) {
-
-            // Filter by search term if we have one
-            if (!query_string.empty()) {
-                QString qry = QString::fromStdString(query_string);
-                QString title = QString::fromStdString(item.title);
-                QString summary = QString::fromStdString(item.summary);
-                QString content = QString::fromStdString(item.content);
-
-                if (!title.contains(qry, Qt::CaseInsensitive) &&
-                    !summary.contains(qry, Qt::CaseInsensitive) &&
-                    !content.contains(qry, Qt::CaseInsensitive)) {
-                    continue;
+        auto first_news_cat = reply->register_category("first_news",
+                                                       "", "", sc::CategoryRenderer(FIRST_NEWS_LAYOUT));
+
+        if (results.size() > 0) {
+
+            // Get common values for all results to avoid asking for them in every iteration
+            std::string emblem = get_emblem();
+            std::string date_time_format = get_date_time_format();
+            bool show_big_result = get_big_first_result();
+
+            // For each of the results vector items
+            for (const auto &item : results) {
+
+                // Filter by search term if we have one
+                if (!query_string.empty()) {
+                    QString qry = QString::fromStdString(query_string);
+                    QString title = QString::fromStdString(item.title);
+                    QString summary = QString::fromStdString(item.summary);
+                    QString content = QString::fromStdString(item.content);
+
+                    if (!title.contains(qry, Qt::CaseInsensitive) &&
+                        !summary.contains(qry, Qt::CaseInsensitive) &&
+                        !content.contains(qry, Qt::CaseInsensitive)) {
+                        continue;
+                    }
                 }
-            }
-
-            // Create a result
-            sc::CategorisedResult res(news_cat);
-
-            // We must have a URI
-            res.set_uri(item.uri);
-            res.set_dnd_uri(item.uri);
-
-            // Set the rest of the attributes
-            res.set_title(item.title);
-            res.set_art(item.art);
-            res["published"] = sc::Variant(item.published);
-            res["author"] = sc::Variant(item.author);
-            res["summary"] = sc::Variant(item.summary);
-            res["content"] = sc::Variant(item.content);
-            res["emblem"] = sc::Variant(scope_directory_+"/images/emblem.png");
-
-            if (res.art().empty()) {
-                res.set_art(scope_directory_ + "/icon.png");
-            }
-
-            // if searched from aggregated, set formatted date to subtitle in case found keyword is related with news
-            if (meta.is_aggregated()) {
-                if (boost::starts_with(found_keyword, "news.")) {
+
+                // Create a result if having title at least
+                if (!item.title.empty() && !item.uri.empty()) {
+
+                    // If surfacing in not aggregated mode and set big-first-result setting to true, show first result in big
+                    sc::Category::SCPtr cat =
+                            show_big_result && !meta.is_aggregated() && query_string.empty() ?
+                                first_news_cat :
+                                news_cat;
+
+                    show_big_result = false;
+
+                    sc::CategorisedResult res(cat);
+
+                    // We must have a URI
+                    res.set_uri(item.uri);
+                    res.set_dnd_uri(item.uri);
+
+                    // Set the rest of the attributes
+                    res.set_title(item.title);
+                    res.set_art(item.art);
+                    res["author"] = sc::Variant(item.author);
+                    res["summary"] = sc::Variant(item.summary);
+                    res["content"] = sc::Variant(item.content);
+                    res["emblem"] = sc::Variant(emblem);
+
+                    if (res.art().empty()) {
+                        res.set_art(get_icon());
+                    }
+
                     QString date = QString::fromStdString(item.published);
+
                     if (!date.isEmpty()){
-                        QDateTime ipostTime = QDateTime::fromString(date, Qt::RFC2822Date);
-                        QString readeableTime = ipostTime.toString("hh:mm, d MMMM");
-                        res["subtitle"] = readeableTime.toStdString();
-                    }
-                }
-            }
-
-            sc::VariantBuilder actions;
-            actions.add_tuple({
-                {"id", sc::Variant("open")},
-                {"label", sc::Variant(_("Open"))},
-                {"uri", sc::Variant(res.dnd_uri())}
-            });
-            res["actions"] = actions.end();
-
-            // Push the result
-            if (!reply->push(res)) {
-                // If we fail to push, it means the query has been cancelled.
-                // So don't continue;
-                return;
-            }
-        }
+                        QDateTime ipostTime = QDateTime::fromString(date, Qt::ISODate);
+                        QString readableTime = ipostTime.toString(QString::fromStdString(date_time_format));
+                        res["published"] = readableTime.toStdString();
+                    }
+
+                    // if searched from aggregated, set formatted date to subtitle in case found keyword is related with news
+                    if (meta.is_aggregated()) {
+                        if (boost::starts_with(found_keyword, "news.")) {
+                            res["subtitle"] = res["published"];
+                        }
+                    }
+
+                    sc::VariantBuilder actions;
+                    actions.add_tuple({
+                        {"id", sc::Variant("open")},
+                        {"label", sc::Variant(_("Open"))},
+                        {"uri", sc::Variant(res.dnd_uri())}
+                    });
+
+                    if (meta.is_aggregated()) {
+                        actions.add_tuple({
+                            {"id", sc::Variant("more")},
+                            {"label", sc::Variant(_("More from ") + get_display_name())},
+                            {"uri",  sc::Variant(query.to_uri())}
+                        });
+                    }
+                    res["actions"] = actions.end();
+
+                    // Push the result
+                    if (!reply->push(res)) {
+                        // If we fail to push, it means the query has been cancelled.
+                        // So don't continue;
+                        return;
+                    }
+                } // end if (!item.title.empty() && !item.uri.empty()) ...
+            } // end for (const auto &item : results) ...
+        } // end if (results.size > 0) ...
 
     } catch (domain_error &e) {
         // Handle exceptions being thrown by the client API
@@ -279,3 +328,23 @@
     }
 }
 
+string Query::get_icon() {
+    return scope_directory_ + "/" + mScopeConfig->value("ScopeConfig/Icon", "/icon.png").toString().toStdString();
+}
+
+string Query::get_display_name() {
+    return mScopeConfig->value("ScopeConfig/DisplayName", "").toString().toStdString();
+}
+
+string Query::get_emblem() {
+    return scope_directory_ + "/" + mScopeConfig->value("Appearance/Emblem", "/emblem.png").toString().toStdString();
+}
+
+string Query::get_date_time_format() {
+    return mScopeConfig->value("Appearance/DateTimeFormat", "hh:mm, d MMMM").toString().toStdString();
+}
+
+bool Query::get_big_first_result() {
+    return mScopeConfig->value("Appearance/BigFirstResult", false).toBool();
+}
+

=== modified file 'src/scope/scope.cpp'
--- src/scope/scope.cpp	2015-03-25 03:17:53 +0000
+++ src/scope/scope.cpp	2015-08-08 22:18:29 +0000
@@ -1,4 +1,4 @@
-/*                                                                              
+/*
  * Copyright 2015 Canonical Ltd.                                                
  *                                                                              
  * This program is free software; you can redistribute it and/or modify         
@@ -31,21 +31,35 @@
 using namespace api;
 using namespace scope;
 
-void Scope::start(string const&) {
+void Scope::start(string const& scope_id) {
+
+    scope_id_ = scope_id;
 
     setlocale(LC_ALL, "");
     string translation_directory = ScopeBase::scope_directory()
             + "/../share/locale/";
     bindtextdomain(GETTEXT_PACKAGE, translation_directory.c_str());
+
+    loadScopeConfig();
 }
 
 void Scope::stop() {
 }
 
+void Scope::loadScopeConfig() {
+
+    std::string scope_config_file = ScopeBase::scope_directory() + "/" + scope_id_ + ".ini";
+    mScopeConfig = QSharedPointer<QSettings>::create(QString::fromStdString(scope_config_file), QSettings::IniFormat);
+
+    /*
+    qDebug() << "ALL KEYS:" << scope_config_->allKeys();
+    qDebug() << "ICON KEY:" << scope_config_->value("ScopeConfig/Icon").toString();
+    */
+}
+
 sc::SearchQueryBase::UPtr Scope::search(const sc::CannedQuery &query,
-                                        const sc::SearchMetadata &metadata) {
-    // Boilerplate construction of Query
-    return sc::SearchQueryBase::UPtr(new Query(query, metadata, scope_directory()));
+                                        const sc::SearchMetadata &search_metadata) {
+    return sc::SearchQueryBase::UPtr(new Query(query, search_metadata, scope_directory(), mScopeConfig));
 }
 
 sc::PreviewQueryBase::UPtr Scope::preview(sc::Result const& result,