2 * Copyright (C) 2009-2010 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
30 #include "gtksearchenginetracker.h"
32 /* If defined, we use fts:match, this has to be enabled in Tracker to
33 * work which it usually is. The alternative is to undefine it and
34 * use filename matching instead. This doesn't use the content of the
39 #define MODULE_FILENAME "libtracker-sparql-0.10.so.0"
41 #define MODULE_MAP(a) { #a, (gpointer *)&a }
43 /* Connection object */
44 typedef struct _TrackerSparqlConnection TrackerSparqlConnection;
46 #define TRACKER_SPARQL_TYPE_CONNECTION (tracker_sparql_connection_get_type ())
47 #define TRACKER_SPARQL_CONNECTION(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TRACKER_SPARQL_TYPE_CONNECTION, TrackerSparqlConnection))
50 typedef struct _TrackerSparqlCursor TrackerSparqlCursor;
52 #define TRACKER_SPARQL_TYPE_CURSOR (tracker_sparql_cursor_get_type ())
53 #define TRACKER_SPARQL_CURSOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TRACKER_SPARQL_TYPE_CURSOR, TrackerSparqlCursor))
56 static GType (*tracker_sparql_connection_get_type) (void) = NULL;
57 static TrackerSparqlConnection * (*tracker_sparql_connection_get) (GCancellable *cancellable,
58 GError **error) = NULL;
59 static void (*tracker_sparql_connection_query_async) (TrackerSparqlConnection *self,
61 GCancellable *cancellable,
62 GAsyncReadyCallback callback,
63 gpointer user_data) = NULL;
64 static TrackerSparqlCursor * (*tracker_sparql_connection_query_finish) (TrackerSparqlConnection *self,
66 GError **error) = NULL;
67 static GType (*tracker_sparql_cursor_get_type) (void) = NULL;
68 static void (*tracker_sparql_cursor_next_async) (TrackerSparqlCursor *self,
69 GCancellable *cancellable,
70 GAsyncReadyCallback callback,
71 gpointer user_data) = NULL;
72 static gboolean (*tracker_sparql_cursor_next_finish) (TrackerSparqlCursor *self,
74 GError **error) = NULL;
75 static const gchar * (*tracker_sparql_cursor_get_string) (TrackerSparqlCursor *self,
77 glong *length) = NULL;
78 static gchar * (*tracker_sparql_escape_string) (const gchar *literal) = NULL;
80 static struct TrackerFunctions
85 MODULE_MAP (tracker_sparql_connection_get_type),
86 MODULE_MAP (tracker_sparql_connection_get),
87 MODULE_MAP (tracker_sparql_connection_query_async),
88 MODULE_MAP (tracker_sparql_connection_query_finish),
89 MODULE_MAP (tracker_sparql_cursor_get_type),
90 MODULE_MAP (tracker_sparql_cursor_next_async),
91 MODULE_MAP (tracker_sparql_cursor_next_finish),
92 MODULE_MAP (tracker_sparql_cursor_get_string),
93 MODULE_MAP (tracker_sparql_escape_string)
99 static gboolean inited = FALSE;
107 flags = G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL;
109 /* Only support 0.10 onwards */
110 if ((m = g_module_open (MODULE_FILENAME, flags)) == NULL)
112 g_debug ("No tracker backend available or it is not new enough");
113 g_debug ("Only available using '%s'", MODULE_FILENAME);
119 /* Check for the symbols we need */
120 for (i = 0; i < G_N_ELEMENTS (funcs); i++)
122 if (!g_module_symbol (m, funcs[i].name, funcs[i].pointer))
124 g_warning ("Missing symbol '%s' in libtracker-sparql\n",
128 for (i = 0; i < G_N_ELEMENTS (funcs); i++)
129 funcs[i].pointer = NULL;
139 * GtkSearchEngineTracker object
141 struct _GtkSearchEngineTrackerPrivate
143 TrackerSparqlConnection *connection;
144 GCancellable *cancellable;
146 gboolean query_pending;
149 G_DEFINE_TYPE (GtkSearchEngineTracker, _gtk_search_engine_tracker, GTK_TYPE_SEARCH_ENGINE);
151 static void cursor_callback (GObject *object,
152 GAsyncResult *result,
156 finalize (GObject *object)
158 GtkSearchEngineTracker *tracker;
160 tracker = GTK_SEARCH_ENGINE_TRACKER (object);
162 if (tracker->priv->cancellable)
164 g_cancellable_cancel (tracker->priv->cancellable);
165 g_object_unref (tracker->priv->cancellable);
166 tracker->priv->cancellable = NULL;
169 if (tracker->priv->query)
171 g_object_unref (tracker->priv->query);
172 tracker->priv->query = NULL;
175 if (tracker->priv->connection)
177 g_object_unref (tracker->priv->connection);
178 tracker->priv->connection = NULL;
181 G_OBJECT_CLASS (_gtk_search_engine_tracker_parent_class)->finalize (object);
185 cursor_next (GtkSearchEngineTracker *tracker,
186 TrackerSparqlCursor *cursor)
188 tracker_sparql_cursor_next_async (cursor,
189 tracker->priv->cancellable,
195 cursor_callback (GObject *object,
196 GAsyncResult *result,
199 GtkSearchEngineTracker *tracker;
200 GError *error = NULL;
201 TrackerSparqlCursor *cursor;
205 gdk_threads_enter ();
207 tracker = GTK_SEARCH_ENGINE_TRACKER (user_data);
209 cursor = TRACKER_SPARQL_CURSOR (object);
210 success = tracker_sparql_cursor_next_finish (cursor, result, &error);
214 _gtk_search_engine_error (GTK_SEARCH_ENGINE (tracker), error->message);
216 g_error_free (error);
219 g_object_unref (cursor);
221 gdk_threads_leave ();
227 _gtk_search_engine_finished (GTK_SEARCH_ENGINE (tracker));
230 g_object_unref (cursor);
232 gdk_threads_leave ();
236 /* We iterate result by result, not n at a time. */
237 hits = g_list_append (NULL, (gchar*) tracker_sparql_cursor_get_string (cursor, 0, NULL));
238 _gtk_search_engine_hits_added (GTK_SEARCH_ENGINE (tracker), hits);
242 cursor_next (tracker, cursor);
244 gdk_threads_leave ();
249 query_callback (GObject *object,
250 GAsyncResult *result,
253 GtkSearchEngineTracker *tracker;
254 TrackerSparqlConnection *connection;
255 TrackerSparqlCursor *cursor;
256 GError *error = NULL;
258 gdk_threads_enter ();
260 tracker = GTK_SEARCH_ENGINE_TRACKER (user_data);
262 tracker->priv->query_pending = FALSE;
264 connection = TRACKER_SPARQL_CONNECTION (object);
265 cursor = tracker_sparql_connection_query_finish (connection,
271 _gtk_search_engine_error (GTK_SEARCH_ENGINE (tracker), error->message);
272 g_error_free (error);
273 gdk_threads_leave ();
279 _gtk_search_engine_finished (GTK_SEARCH_ENGINE (tracker));
280 gdk_threads_leave ();
284 cursor_next (tracker, cursor);
285 gdk_threads_leave ();
289 sparql_append_string_literal (GString *sparql,
294 s = tracker_sparql_escape_string (str);
296 g_string_append_c (sparql, '"');
297 g_string_append (sparql, s);
298 g_string_append_c (sparql, '"');
304 gtk_search_engine_tracker_start (GtkSearchEngine *engine)
306 GtkSearchEngineTracker *tracker;
313 tracker = GTK_SEARCH_ENGINE_TRACKER (engine);
315 if (tracker->priv->query_pending)
317 g_debug ("Attempt to start a new search while one is pending, doing nothing");
321 if (tracker->priv->query == NULL)
323 g_debug ("Attempt to start a new search with no GtkQuery, doing nothing");
327 search_text = _gtk_query_get_text (tracker->priv->query);
330 location_uri = _gtk_query_get_location (tracker->priv->query);
332 sparql = g_string_new ("SELECT nie:url(?urn) "
334 " ?urn a nfo:FileDataObject ;"
335 " tracker:available true ; "
337 sparql_append_string_literal (sparql, search_text);
341 g_string_append (sparql, " . FILTER (fn:starts-with(nie:url(?urn),");
342 sparql_append_string_literal (sparql, location_uri);
343 g_string_append (sparql, "))");
346 g_string_append (sparql, " } ORDER BY DESC(fts:rank(?urn)) ASC(nie:url(?urn))");
347 #else /* FTS_MATCHING */
348 /* Using filename matching: */
349 sparql = g_string_new ("SELECT nie:url(?urn) "
351 " ?urn a nfo:FileDataObject ;"
352 " tracker:available true ."
353 " FILTER (fn:contains(nfo:fileName(?urn),");
354 sparql_append_string_literal (sparql, search_text);
356 g_string_append (sparql,
358 "} ORDER BY DESC(nie:url(?urn)) DESC(nfo:fileName(?urn))");
359 #endif /* FTS_MATCHING */
361 tracker_sparql_connection_query_async (tracker->priv->connection,
363 tracker->priv->cancellable,
366 g_string_free (sparql, TRUE);
368 tracker->priv->query_pending = TRUE;
369 g_free (search_text);
373 gtk_search_engine_tracker_stop (GtkSearchEngine *engine)
375 GtkSearchEngineTracker *tracker;
377 tracker = GTK_SEARCH_ENGINE_TRACKER (engine);
379 if (tracker->priv->query && tracker->priv->query_pending)
381 g_cancellable_cancel (tracker->priv->cancellable);
382 tracker->priv->query_pending = FALSE;
387 gtk_search_engine_tracker_is_indexed (GtkSearchEngine *engine)
393 gtk_search_engine_tracker_set_query (GtkSearchEngine *engine,
396 GtkSearchEngineTracker *tracker;
398 tracker = GTK_SEARCH_ENGINE_TRACKER (engine);
401 g_object_ref (query);
403 if (tracker->priv->query)
404 g_object_unref (tracker->priv->query);
406 tracker->priv->query = query;
410 _gtk_search_engine_tracker_class_init (GtkSearchEngineTrackerClass *class)
412 GObjectClass *gobject_class;
413 GtkSearchEngineClass *engine_class;
415 gobject_class = G_OBJECT_CLASS (class);
416 gobject_class->finalize = finalize;
418 engine_class = GTK_SEARCH_ENGINE_CLASS (class);
419 engine_class->set_query = gtk_search_engine_tracker_set_query;
420 engine_class->start = gtk_search_engine_tracker_start;
421 engine_class->stop = gtk_search_engine_tracker_stop;
422 engine_class->is_indexed = gtk_search_engine_tracker_is_indexed;
424 g_type_class_add_private (gobject_class, sizeof (GtkSearchEngineTrackerPrivate));
428 _gtk_search_engine_tracker_init (GtkSearchEngineTracker *engine)
430 engine->priv = G_TYPE_INSTANCE_GET_PRIVATE (engine,
431 GTK_TYPE_SEARCH_ENGINE_TRACKER,
432 GtkSearchEngineTrackerPrivate);
437 _gtk_search_engine_tracker_new (void)
439 GtkSearchEngineTracker *engine;
440 TrackerSparqlConnection *connection;
441 GCancellable *cancellable;
442 GError *error = NULL;
447 cancellable = g_cancellable_new ();
448 connection = tracker_sparql_connection_get (cancellable, &error);
452 g_warning ("Could not establish a connection to Tracker: %s", error->message);
453 g_error_free (error);
456 else if (!connection)
458 g_warning ("Could not establish a connection to Tracker, no TrackerSparqlConnection was returned");
462 engine = g_object_new (GTK_TYPE_SEARCH_ENGINE_TRACKER, NULL);
464 engine->priv->connection = connection;
465 engine->priv->cancellable = cancellable;
466 engine->priv->query_pending = FALSE;
468 return GTK_SEARCH_ENGINE (engine);