Merge lp:~jamesh/unity-scope-scopes/online-recommendations into lp:unity-scope-scopes

[James Henstridge]

Integrate results from the onlinescopes scope when the user performs a search.

When the user performs a search, integrate results from the com.canonical.scopes.onlinescopes scope.

This may still need a bit of work to ensure it matches design (either on this side or the remote end).

[lp:~jamesh/unity-scope-scopes/online-recommendations]

22. By James Henstridge on 2014-02-25

Add Author metadata.

=== modified file 'src/CMakeLists.txt'
--- src/CMakeLists.txt	2014-02-06 04:39:29 +0000
+++ src/CMakeLists.txt	2014-02-25 08:47:57 +0000
@@ -3,6 +3,7 @@
 add_library(scopes
   MODULE
   scopes-scope.cpp
+  resultforwarder.cpp
 )
 target_link_libraries(scopes ${UNITY_LDFLAGS})
 

=== added file 'src/resultforwarder.cpp'
--- src/resultforwarder.cpp	1970-01-01 00:00:00 +0000
+++ src/resultforwarder.cpp	2014-02-25 08:47:57 +0000
@@ -0,0 +1,65 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by Jussi Pakkanen <[e-mail]>
+ *
+ */
+
+#include "resultforwarder.h"
+#include <unity/scopes/SearchReply.h>
+
+using namespace unity::scopes;
+
+void ResultForwarder::push(Category::SCPtr category) {
+    upstream->register_category(category);
+}
+
+void ResultForwarder::push(CategorisedResult result) {
+    upstream->push(result);
+    if (!ready_)
+    {
+        ready_ = true;
+        notify_observers();
+    }
+}
+
+void ResultForwarder::finished(ListenerBase::Reason /*reason*/, std::string const& /*error_message*/) {
+    if (!ready_)
+    {
+        ready_ = true;
+        notify_observers();
+    }
+}
+
+void ResultForwarder::notify_observers()
+{
+    for (auto o: observers_)
+    {
+        o->on_forwarder_ready(this);
+    }
+}
+
+void ResultForwarder::add_observer(std::shared_ptr<ResultForwarder> result_forwarder)
+{
+    if (result_forwarder.get() != this)
+    {
+        observers_.push_back(result_forwarder);
+    }
+}
+
+void ResultForwarder::on_forwarder_ready(ResultForwarder*)
+{
+    // base impl does nothing
+}

=== added file 'src/resultforwarder.h'
--- src/resultforwarder.h	1970-01-01 00:00:00 +0000
+++ src/resultforwarder.h	2014-02-25 08:47:57 +0000
@@ -0,0 +1,57 @@
+/*
+ * Copyright (C) 2014 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by Jussi Pakkanen <[e-mail]>
+ *
+ */
+
+#ifndef RESULTFORWARDER_H_
+#define RESULTFORWARDER_H_
+
+#include<unity/scopes/SearchListener.h>
+#include<unity/scopes/ReplyProxyFwd.h>
+#include<unity/scopes/ListenerBase.h>
+#include<unity/scopes/CategorisedResult.h>
+#include<list>
+
+class ResultForwarder : public unity::scopes::SearchListener {
+
+public:
+
+    ResultForwarder(unity::scopes::SearchReplyProxy const& upstream) :
+        upstream(upstream),
+        ready_(false) {
+    }
+    virtual ~ResultForwarder() {}
+
+    virtual void push(unity::scopes::Category::SCPtr category) override;
+    virtual void push(unity::scopes::CategorisedResult result) override;
+    void add_observer(std::shared_ptr<ResultForwarder> result_forwarder);
+
+    virtual void finished(unity::scopes::ListenerBase::Reason reason,
+            std::string const& error_message) override;
+
+protected:
+    virtual void on_forwarder_ready(ResultForwarder*);
+    unity::scopes::SearchReplyProxy upstream;
+    void notify_observers();
+
+private:
+    std::list<std::shared_ptr<ResultForwarder>> observers_;
+    bool ready_;
+};
+
+
+#endif

=== modified file 'src/scopes-scope.cpp'
--- src/scopes-scope.cpp	2014-02-20 18:11:52 +0000
+++ src/scopes-scope.cpp	2014-02-25 08:47:57 +0000
@@ -17,6 +17,7 @@
  */
 
 #include <algorithm>
+#include <iostream>
 #include <map>
 
 #include <unity/scopes/Category.h>
@@ -27,9 +28,12 @@
 #include <unity/scopes/ScopeExceptions.h>
 #include <unity/scopes/VariantBuilder.h>
 #include "scopes-scope.h"
+#include "resultforwarder.h"
 
 using namespace unity::scopes;
 
+static const char ONLINE_SCOPE_ID[] = "com.canonical.scopes.onlinescopes";
+
 static const char MISSING_ICON[] = "/usr/share/icons/unity-icon-theme/places/svg/service-generic.svg";
 static const char SCOPES_CATEGORY_DEFINITION[] = R"(
 {
@@ -47,9 +51,15 @@
   }
 }
 )";
+// unconfuse emacs: "
 
 int ScopesScope::start(std::string const&, RegistryProxy const &registry) {
     this->registry = registry;
+    try {
+        online_scope = registry->get_metadata(ONLINE_SCOPE_ID).proxy();
+    } catch (std::exception &e) {
+        std::cerr << "Could not instantiate online scopes scope: " << e.what() << std::endl;
+    }
     return VERSION;
 }
 
@@ -226,6 +236,11 @@
         }
         reply->push(result);
     }
+
+    if (scope.online_scope && !query.query_string().empty()) {
+        auto online_reply = std::make_shared<ResultForwarder>(reply);
+        create_subquery(scope.online_scope, query.query_string(), online_reply);
+    }
 }
 
 ScopesPreview::ScopesPreview(ScopesScope &scope, Result const &result)

=== modified file 'src/scopes-scope.h'
--- src/scopes-scope.h	2014-02-11 09:51:16 +0000
+++ src/scopes-scope.h	2014-02-25 08:47:57 +0000
@@ -38,6 +38,8 @@
 
 private:
     unity::scopes::RegistryProxy registry;
+
+    unity::scopes::ScopeProxy online_scope;
 };
 
 class ScopesQuery : public unity::scopes::SearchQuery

=== modified file 'src/scopes.ini'
--- src/scopes.ini	2014-02-13 11:24:49 +0000
+++ src/scopes.ini	2014-02-25 08:47:57 +0000
@@ -1,5 +1,6 @@
 [ScopeConfig]
 DisplayName = Scopes
+Author = Canonical Ltd.
 Description = This is an Ubuntu search plugin that enables information from available search plugins to be searched and displayed in the Dash underneath the Dash plugins header. If you do not wish to search this content source, you can disable this search plugin.
 SearchHint = Search for scopes
 HotKey =