2 * Copyright (C) 2009-2011 Nokia <ivan.frade@nokia.com>
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 * Authors: Jürg Billeter <juerg.billeter@codethink.co.uk>
19 * Martyn Russell <martyn@lanedo.com>
21 * Based on nautilus-search-engine-tracker.c
33 #include "gtksearchenginetracker.h"
35 #define DBUS_SERVICE_RESOURCES "org.freedesktop.Tracker1"
36 #define DBUS_PATH_RESOURCES "/org/freedesktop/Tracker1/Resources"
37 #define DBUS_INTERFACE_RESOURCES "org.freedesktop.Tracker1.Resources"
39 #define DBUS_SERVICE_STATUS "org.freedesktop.Tracker1"
40 #define DBUS_PATH_STATUS "/org/freedesktop/Tracker1/Status"
41 #define DBUS_INTERFACE_STATUS "org.freedesktop.Tracker1.Status"
43 /* Time in second to wait for service before deciding it's not available */
44 #define WAIT_TIMEOUT_SECONDS 1
46 /* Time in second to wait for query results to come back */
47 #define QUERY_TIMEOUT_SECONDS 10
49 /* If defined, we use fts:match, this has to be enabled in Tracker to
50 * work which it usually is. The alternative is to undefine it and
51 * use filename matching instead. This doesn't use the content of the
57 * GtkSearchEngineTracker object
59 struct _GtkSearchEngineTrackerPrivate
61 GDBusConnection *connection;
62 GCancellable *cancellable;
64 gboolean query_pending;
67 G_DEFINE_TYPE (GtkSearchEngineTracker, _gtk_search_engine_tracker, GTK_TYPE_SEARCH_ENGINE);
70 finalize (GObject *object)
72 GtkSearchEngineTracker *tracker;
74 g_debug ("Finalizing GtkSearchEngineTracker");
76 tracker = GTK_SEARCH_ENGINE_TRACKER (object);
78 if (tracker->priv->cancellable)
80 g_cancellable_cancel (tracker->priv->cancellable);
81 g_object_unref (tracker->priv->cancellable);
82 tracker->priv->cancellable = NULL;
85 if (tracker->priv->query)
87 g_object_unref (tracker->priv->query);
88 tracker->priv->query = NULL;
91 if (tracker->priv->connection)
93 g_object_unref (tracker->priv->connection);
94 tracker->priv->connection = NULL;
97 G_OBJECT_CLASS (_gtk_search_engine_tracker_parent_class)->finalize (object);
100 static GDBusConnection *
101 get_connection (void)
103 GDBusConnection *connection;
104 GError *error = NULL;
107 /* Normally I hate sync calls with UIs, but we need to return NULL
108 * or a GtkSearchEngine as a result of this function.
110 connection = g_bus_get_sync (G_BUS_TYPE_SESSION, NULL, &error);
114 g_debug ("Couldn't connect to D-Bus session bus, %s", error->message);
115 g_error_free (error);
119 /* If connection is set, we know it worked. */
120 g_debug ("Finding out if Tracker is available via D-Bus...");
122 /* We only wait 1 second max, we expect it to be very fast. If we
123 * don't get a response by then, clearly we're replaying a journal
124 * or cleaning up the DB internally. Either way, services is not
127 * We use the sync call here because we don't expect to be waiting
128 * long enough to block UI painting.
130 reply = g_dbus_connection_call_sync (connection,
133 DBUS_INTERFACE_STATUS,
137 G_DBUS_CALL_FLAGS_NONE,
138 WAIT_TIMEOUT_SECONDS * 1000,
144 g_debug ("Tracker is not available, %s", error->message);
145 g_error_free (error);
146 g_object_unref (connection);
150 g_variant_unref (reply);
152 g_debug ("Tracker is ready");
158 get_query_results (GtkSearchEngineTracker *engine,
160 GAsyncReadyCallback callback,
163 g_dbus_connection_call (engine->priv->connection,
164 DBUS_SERVICE_RESOURCES,
166 DBUS_INTERFACE_RESOURCES,
168 g_variant_new ("(s)", sparql),
170 G_DBUS_CALL_FLAGS_NONE,
171 QUERY_TIMEOUT_SECONDS * 1000,
172 engine->priv->cancellable,
177 /* Stolen from libtracker-common */
179 string_list_to_gslist (gchar **strv)
186 for (i = 0; strv[i]; i++)
187 list = g_list_prepend (list, g_strdup (strv[i]));
189 return g_list_reverse (list);
192 /* Stolen from libtracker-sparql */
194 sparql_escape_string (const gchar *literal)
199 g_return_val_if_fail (literal != NULL, NULL);
201 str = g_string_new ("");
211 len = strcspn ((const gchar *) p, "\t\n\r\b\f\"\\");
212 g_string_append_len (str, (const gchar *) p, (gssize) ((glong) len));
218 g_string_append (str, "\\t");
221 g_string_append (str, "\\n");
224 g_string_append (str, "\\r");
227 g_string_append (str, "\\b");
230 g_string_append (str, "\\f");
233 g_string_append (str, "\\\"");
236 g_string_append (str, "\\\\");
244 return g_string_free (str, FALSE);
248 sparql_append_string_literal (GString *sparql,
253 s = sparql_escape_string (str);
255 g_string_append_c (sparql, '"');
256 g_string_append (sparql, s);
257 g_string_append_c (sparql, '"');
263 sparql_append_string_literal_lower_case (GString *sparql,
268 s = g_utf8_strdown (str, -1);
269 sparql_append_string_literal (sparql, s);
274 query_callback (GObject *object,
278 GtkSearchEngineTracker *tracker;
284 GError *error = NULL;
287 gdk_threads_enter ();
289 tracker = GTK_SEARCH_ENGINE_TRACKER (user_data);
291 tracker->priv->query_pending = FALSE;
293 reply = g_dbus_connection_call_finish (tracker->priv->connection, res, &error);
296 _gtk_search_engine_error (GTK_SEARCH_ENGINE (tracker), error->message);
297 g_error_free (error);
298 gdk_threads_leave ();
304 _gtk_search_engine_finished (GTK_SEARCH_ENGINE (tracker));
305 gdk_threads_leave ();
309 r = g_variant_get_child_value (reply, 0);
310 g_variant_iter_init (&iter, r);
311 n = g_variant_iter_n_children (&iter);
312 result = g_new0 (gchar *, n + 1);
313 for (i = 0; i < n; i++)
318 v = g_variant_iter_next_value (&iter);
319 strv = g_variant_get_strv (v, NULL);
320 result[i] = (gchar*)strv[0];
324 /* We iterate result by result, not n at a time. */
325 hits = string_list_to_gslist (result);
326 _gtk_search_engine_hits_added (GTK_SEARCH_ENGINE (tracker), hits);
327 _gtk_search_engine_finished (GTK_SEARCH_ENGINE (tracker));
330 g_variant_unref (reply);
333 gdk_threads_leave ();
337 gtk_search_engine_tracker_start (GtkSearchEngine *engine)
339 GtkSearchEngineTracker *tracker;
346 tracker = GTK_SEARCH_ENGINE_TRACKER (engine);
348 if (tracker->priv->query_pending)
350 g_debug ("Attempt to start a new search while one is pending, doing nothing");
354 if (tracker->priv->query == NULL)
356 g_debug ("Attempt to start a new search with no GtkQuery, doing nothing");
360 search_text = _gtk_query_get_text (tracker->priv->query);
363 location_uri = _gtk_query_get_location (tracker->priv->query);
365 sparql = g_string_new ("SELECT nie:url(?urn) "
367 " ?urn a nfo:FileDataObject ;"
368 " tracker:available true ; "
370 sparql_append_string_literal (sparql, search_text);
374 g_string_append (sparql, " . FILTER (fn:starts-with(nie:url(?urn),");
375 sparql_append_string_literal (sparql, location_uri);
376 g_string_append (sparql, "))");
379 g_string_append (sparql, " } ORDER BY DESC(fts:rank(?urn)) ASC(nie:url(?urn))");
380 #else /* FTS_MATCHING */
381 /* Using filename matching: */
382 sparql = g_string_new ("SELECT nie:url(?urn) "
384 " ?urn a nfo:FileDataObject ;"
385 " tracker:available true ."
386 " FILTER (fn:contains(fn:lower-case(nfo:fileName(?urn)),");
387 sparql_append_string_literal_lower_case (sparql, search_text);
389 g_string_append (sparql,
391 "} ORDER BY DESC(nie:url(?urn)) DESC(nfo:fileName(?urn))");
392 #endif /* FTS_MATCHING */
394 tracker->priv->query_pending = TRUE;
396 get_query_results (tracker, sparql->str, query_callback, tracker);
398 g_string_free (sparql, TRUE);
399 g_free (search_text);
403 gtk_search_engine_tracker_stop (GtkSearchEngine *engine)
405 GtkSearchEngineTracker *tracker;
407 tracker = GTK_SEARCH_ENGINE_TRACKER (engine);
409 if (tracker->priv->query && tracker->priv->query_pending)
411 g_cancellable_cancel (tracker->priv->cancellable);
412 tracker->priv->query_pending = FALSE;
417 gtk_search_engine_tracker_is_indexed (GtkSearchEngine *engine)
423 gtk_search_engine_tracker_set_query (GtkSearchEngine *engine,
426 GtkSearchEngineTracker *tracker;
428 tracker = GTK_SEARCH_ENGINE_TRACKER (engine);
431 g_object_ref (query);
433 if (tracker->priv->query)
434 g_object_unref (tracker->priv->query);
436 tracker->priv->query = query;
440 _gtk_search_engine_tracker_class_init (GtkSearchEngineTrackerClass *class)
442 GObjectClass *gobject_class;
443 GtkSearchEngineClass *engine_class;
445 gobject_class = G_OBJECT_CLASS (class);
446 gobject_class->finalize = finalize;
448 engine_class = GTK_SEARCH_ENGINE_CLASS (class);
449 engine_class->set_query = gtk_search_engine_tracker_set_query;
450 engine_class->start = gtk_search_engine_tracker_start;
451 engine_class->stop = gtk_search_engine_tracker_stop;
452 engine_class->is_indexed = gtk_search_engine_tracker_is_indexed;
454 g_type_class_add_private (gobject_class,
455 sizeof (GtkSearchEngineTrackerPrivate));
459 _gtk_search_engine_tracker_init (GtkSearchEngineTracker *engine)
461 engine->priv = G_TYPE_INSTANCE_GET_PRIVATE (engine,
462 GTK_TYPE_SEARCH_ENGINE_TRACKER,
463 GtkSearchEngineTrackerPrivate);
468 _gtk_search_engine_tracker_new (void)
470 GtkSearchEngineTracker *engine;
471 GDBusConnection *connection;
475 connection = get_connection ();
479 g_debug ("Creating GtkSearchEngineTracker...");
481 engine = g_object_new (GTK_TYPE_SEARCH_ENGINE_TRACKER, NULL);
483 engine->priv->connection = connection;
484 engine->priv->cancellable = g_cancellable_new ();
485 engine->priv->query_pending = FALSE;
487 return GTK_SEARCH_ENGINE (engine);