on f690181 help sign in
unity8/plugins/Unity/scope.cpp
304 lines 10 kB history raw
1/*
2 * Copyright (C) 2011 Canonical, Ltd.
3 *
4 * Authors:
5 * Florian Boucault <florian.boucault@canonical.com>
6 * Michal Hruby <michal.hruby@canonical.com>
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; version 3.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 */
21// Self
22#include "scope.h"
24// local
25#include "categories.h"
26#include "preview.h"
27#include "variantutils.h"
29// Qt
30#include <QUrl>
31#include <QDebug>
32#include <QtGui/QDesktopServices>
33#include <QQmlEngine>
35#include <UnityCore/Variant.h>
37#include <libintl.h>
39Scope::Scope(QObject *parent) : QObject(parent)
40 , m_formFactor("phone")
42 m_categories.reset(new Categories(this));
45QString Scope::id() const
47 return QString::fromStdString(m_unityScope->id());
50QString Scope::name() const
52 return QString::fromStdString(m_unityScope->name());
55QString Scope::iconHint() const
57 return QString::fromStdString(m_unityScope->icon_hint());
60QString Scope::description() const
62 return QString::fromStdString(m_unityScope->description());
65QString Scope::searchHint() const
67 return QString::fromStdString(m_unityScope->search_hint());
70bool Scope::visible() const
72 return m_unityScope->visible();
75QString Scope::shortcut() const
77 return QString::fromStdString(m_unityScope->shortcut());
80bool Scope::connected() const
82 return m_unityScope->connected();
85Categories* Scope::categories() const
87 return m_categories.get();
90QString Scope::searchQuery() const
92 return m_searchQuery;
95QString Scope::noResultsHint() const
97 return m_noResultsHint;
100QString Scope::formFactor() const
102 return m_formFactor;
105void Scope::setSearchQuery(const QString& search_query)
107 /* Checking for m_searchQuery.isNull() which returns true only when the string
108 has never been set is necessary because when search_query is the empty
109 string ("") and m_searchQuery is the null string,
110 search_query != m_searchQuery is still true.
111 */
112 if (m_searchQuery.isNull() || search_query != m_searchQuery) {
113 m_searchQuery = search_query;
114 m_unityScope->Search(search_query.toStdString(), sigc::mem_fun(this, &Scope::searchFinished));
115 Q_EMIT searchQueryChanged();
116 }
119void Scope::setNoResultsHint(const QString& hint) {
120 if (hint != m_noResultsHint) {
121 m_noResultsHint = hint;
122 Q_EMIT noResultsHintChanged();
123 }
126void Scope::setFormFactor(const QString& form_factor) {
127 if (form_factor != m_formFactor) {
128 m_formFactor = form_factor;
129 if (m_unityScope) {
130 m_unityScope->form_factor = m_formFactor.toStdString();
131 synchronizeStates(); // will trigger a re-search
132 }
133 Q_EMIT formFactorChanged();
134 }
137unity::dash::LocalResult Scope::createLocalResult(const QVariant &uri, const QVariant &icon_hint,
138 const QVariant &category, const QVariant &result_type,
139 const QVariant &mimetype, const QVariant &title,
140 const QVariant &comment, const QVariant &dnd_uri,
141 const QVariant &metadata)
143 unity::dash::LocalResult res;
144 res.uri = uri.toString().toStdString();
145 res.icon_hint = icon_hint.toString().toStdString();
146 res.category_index = category.toUInt();
147 res.result_type = result_type.toUInt();
148 res.mimetype = mimetype.toString().toStdString();
149 res.name = title.toString().toStdString();
150 res.comment = comment.toString().toStdString();
151 res.dnd_uri = dnd_uri.toString().toStdString();
152 res.hints = convertToHintsMap(metadata);
154 return res;
157// FIXME: Change to use row index.
158void Scope::activate(const QVariant &uri, const QVariant &icon_hint, const QVariant &category,
159 const QVariant &result_type, const QVariant &mimetype, const QVariant &title,
160 const QVariant &comment, const QVariant &dnd_uri, const QVariant &metadata)
162 auto res = createLocalResult(uri, icon_hint, category, result_type, mimetype, title, comment, dnd_uri, metadata);
163 m_unityScope->Activate(res);
166// FIXME: Change to use row index.
167void Scope::preview(const QVariant &uri, const QVariant &icon_hint, const QVariant &category,
168 const QVariant &result_type, const QVariant &mimetype, const QVariant &title,
169 const QVariant &comment, const QVariant &dnd_uri, const QVariant &metadata)
171 auto res = createLocalResult(uri, icon_hint, category, result_type, mimetype, title, comment, dnd_uri, metadata);
172 m_unityScope->Preview(res);
175void Scope::onActivated(unity::dash::LocalResult const& result, unity::dash::ScopeHandledType type, unity::glib::HintsMap const& hints)
177 // note: we will not get called on SHOW_PREVIEW, instead UnityCore will signal preview_ready.
178 switch (type)
179 {
180 case unity::dash::NOT_HANDLED:
181 fallbackActivate(QString::fromStdString(result.uri));
182 break;
183 case unity::dash::SHOW_DASH:
184 Q_EMIT showDash();
185 break;
186 case unity::dash::HIDE_DASH:
187 Q_EMIT hideDash();
188 break;
189 case unity::dash::GOTO_DASH_URI:
190 if (hints.find("goto-uri") != hints.end()) {
191 Q_EMIT gotoUri(QString::fromStdString(g_variant_get_string(hints.at("goto-uri"), nullptr)));
192 } else {
193 qWarning() << "Missing goto-uri hint for GOTO_DASH_URI activation reply";
194 }
195 break;
196 default:
197 qWarning() << "Unhandled activation response:" << type;
198 }
201void Scope::onPreviewReady(unity::dash::LocalResult const& /* result */, unity::dash::Preview::Ptr const& preview)
203 auto prv = Preview::newFromUnityPreview(preview);
204 // is this the best solution? QML may need to keep more than one preview instance around, so we can't own it.
205 // passing it by value is not possible.
206 QQmlEngine::setObjectOwnership(prv, QQmlEngine::JavaScriptOwnership);
207 Q_EMIT previewReady(prv);
210void Scope::fallbackActivate(const QString& uri)
212 /* FIXME: stripping all content before the first column because for some
213 reason the scopes give uri with junk content at their beginning.
214 */
215 QString tweakedUri = uri;
216 int firstColumnAt = tweakedUri.indexOf(":");
217 tweakedUri.remove(0, firstColumnAt+1);
219 /* Tries various methods to trigger a sensible action for the given 'uri'.
220 If it has no understanding of the given scheme it falls back on asking
221 Qt to open the uri.
222 */
223 QUrl url(tweakedUri);
224 if (url.scheme() == "file") {
225 /* Override the files place's default URI handler: we want the file
226 manager to handle opening folders, not the dash.
228 Ref: https://bugs.launchpad.net/upicek/+bug/689667
229 */
230 QDesktopServices::openUrl(url);
231 return;
232 }
233 if (url.scheme() == "application") {
234 // TODO: implement application handling
235 return;
236 }
238 qDebug() << "Trying to open" << uri;
240 /* Try our luck */
241 QDesktopServices::openUrl(uri); //url?
244void Scope::setUnityScope(const unity::dash::Scope::Ptr& scope)
246 m_unityScope = scope;
248 m_categories->setUnityScope(m_unityScope);
250 m_unityScope->form_factor = m_formFactor.toStdString();
251 /* Property change signals */
252 m_unityScope->id.changed.connect(sigc::mem_fun(this, &Scope::idChanged));
253 m_unityScope->name.changed.connect(sigc::mem_fun(this, &Scope::nameChanged));
254 m_unityScope->icon_hint.changed.connect(sigc::mem_fun(this, &Scope::iconHintChanged));
255 m_unityScope->description.changed.connect(sigc::mem_fun(this, &Scope::descriptionChanged));
256 m_unityScope->search_hint.changed.connect(sigc::mem_fun(this, &Scope::searchHintChanged));
257 m_unityScope->visible.changed.connect(sigc::mem_fun(this, &Scope::visibleChanged));
258 m_unityScope->shortcut.changed.connect(sigc::mem_fun(this, &Scope::shortcutChanged));
259 m_unityScope->connected.changed.connect(sigc::mem_fun(this, &Scope::connectedChanged));
260 /* Signals forwarding */
261 connect(this, SIGNAL(searchFinished(const std::string &, unity::glib::HintsMap const &, unity::glib::Error const &)), SLOT(onSearchFinished(const std::string &, unity::glib::HintsMap const &)));
263 /* FIXME: signal should be forwarded instead of calling the handler directly */
264 m_unityScope->activated.connect(sigc::mem_fun(this, &Scope::onActivated));
266 m_unityScope->preview_ready.connect(sigc::mem_fun(this, &Scope::onPreviewReady));
268 /* Synchronize local states with m_unityScope right now and whenever
269 m_unityScope becomes connected */
270 /* FIXME: should emit change notification signals for all properties */
271 connect(this, SIGNAL(connectedChanged(bool)), SLOT(synchronizeStates()));
272 synchronizeStates();
275unity::dash::Scope::Ptr Scope::unityScope() const
277 return m_unityScope;
280void Scope::synchronizeStates()
282 if (connected()) {
283 /* Forward local states to m_unityScope */
284 if (!m_searchQuery.isNull()) {
285 m_unityScope->Search(m_searchQuery.toStdString());
286 }
287 }
290void Scope::onSearchFinished(const std::string& /* query */, unity::glib::HintsMap const &hints)
292 QString hint;
294 if (!m_unityScope->results()->count()) {
295 unity::glib::HintsMap::const_iterator it = hints.find("no-results-hint");
296 if (it != hints.end()) {
297 hint = QString::fromStdString(it->second.GetString());
298 } else {
299 hint = QString::fromUtf8(dgettext("unity", "Sorry, there is nothing that matches your search."));
300 }
301 }
303 setNoResultsHint(hint);