Pileus Git - ~andy/gtk/blob - gtk/gtksearchenginebeagle.c

   1 /*
   2  * Copyright (C) 2005 Novell, Inc.
   3  *
   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.
   8  *
   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.
  13  *
  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,
  17  *
  18  * Author: Anders Carlsson <andersca@imendio.com>
  19  *
  20  * Based on nautilus-search-engine-beagle.c
  21  */
  22
  23 #include <config.h>
  24 #include <gmodule.h>
  25 #include "gtksearchenginebeagle.h"
  26 #if 0
  27 #include <beagle/beagle.h>
  28 #endif
  29
  30 /* We dlopen() all the following from libbeagle at runtime */
  31
  32 typedef struct _BeagleHit BeagleHit;
  33 typedef struct _BeagleQuery BeagleQuery;
  34 typedef struct _BeagleClient BeagleClient;
  35 typedef struct _BeagleRequest BeagleRequest;
  36 typedef struct _BeagleFinishedResponse BeagleFinishedResponse;
  37 typedef struct _BeagleHitsAddedResponse BeagleHitsAddedResponse;
  38 typedef struct _BeagleHitsSubtractedResponse BeagleHitsSubtractedResponse;
  39 typedef struct _BeagleQueryPartProperty BeagleQueryPartProperty;
  40 typedef struct _BeagleQueryPart BeagleQueryPart;
  41
  42 #define BEAGLE_HIT(x) ((BeagleHit *)(x))
  43 #define BEAGLE_REQUEST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), beagle_request_get_type(), BeagleRequest))
  44 #define BEAGLE_QUERY_PART(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), beagle_query_part_get_type(), BeagleQueryPart))
  45
  46 typedef enum
  47 {
  48   BEAGLE_QUERY_PART_LOGIC_REQUIRED   = 1,
  49   BEAGLE_QUERY_PART_LOGIC_PROHIBITED = 2
  50 } BeagleQueryPartLogic;
  51
  52 typedef enum
  53   {
  54     BEAGLE_PROPERTY_TYPE_UNKNOWN = 0,
  55     BEAGLE_PROPERTY_TYPE_TEXT    = 1,
  56     BEAGLE_PROPERTY_TYPE_KEYWORD = 2,
  57     BEAGLE_PROPERTY_TYPE_DATE    = 3,
  58     BEAGLE_PROPERTY_TYPE_LAST    = 4
  59 } BeaglePropertyType;
  60
  61 /* *static* wrapper function pointers */
  62 static gboolean (*beagle_client_send_request_async) (BeagleClient  *client,
  63                                                      BeagleRequest  *request,
  64                                                      GError        **err) = NULL;
  65 static G_CONST_RETURN char *(*beagle_hit_get_uri) (BeagleHit *hit) = NULL;
  66 static GSList *(*beagle_hits_added_response_get_hits) (BeagleHitsAddedResponse *response) = NULL;
  67 static GSList *(*beagle_hits_subtracted_response_get_uris) (BeagleHitsSubtractedResponse *response) = NULL;
  68 static BeagleQuery *(*beagle_query_new) (void) = NULL;
  69 static void (*beagle_query_add_text) (BeagleQuery     *query,
  70                                       const char      *str) = NULL;
  71 static void (*beagle_query_add_hit_type) (BeagleQuery *query,
  72                                           const char  *hit_type) = NULL;
  73 static void (*beagle_query_add_mime_type) (BeagleQuery *query,
  74                                           const char  *mime_type) = NULL;
  75 static void (*beagle_query_set_max_hits) (BeagleQuery *query,
  76                                           gint         max_hits) = NULL;
  77 static BeagleQueryPartProperty *(*beagle_query_part_property_new) (void) = NULL;
  78 static void (*beagle_query_part_set_logic) (BeagleQueryPart      *part,
  79                                             BeagleQueryPartLogic  logic) = NULL;
  80 static void (*beagle_query_part_property_set_key) (BeagleQueryPartProperty *part,
  81                                                    const char              *key) = NULL;
  82 static void (*beagle_query_part_property_set_value) (BeagleQueryPartProperty *part,
  83                                                      const char *             value) = NULL;
  84 static void (*beagle_query_part_property_set_property_type) (BeagleQueryPartProperty *part,
  85                                                              BeaglePropertyType       prop_type) = NULL;
  86 static void (*beagle_query_add_part) (BeagleQuery     *query,
  87                                       BeagleQueryPart *part) = NULL;
  88 static GType (*beagle_request_get_type) (void) = NULL;
  89 static GType (*beagle_query_part_get_type) (void) = NULL;
  90 static gboolean (*beagle_util_daemon_is_running) (void) = NULL;
  91 static BeagleClient *(*beagle_client_new) (const char *client_name) = NULL;
  92
  93 static struct BeagleDlMapping
  94 {
  95   const char *fn_name;
  96   gpointer *fn_ptr_ref;
  97 } beagle_dl_mapping[] =
  98 {
  99 #define MAP(a) { #a, (gpointer *)&a }
 100   MAP (beagle_client_send_request_async),
 101   MAP (beagle_hit_get_uri),
 102   MAP (beagle_hits_added_response_get_hits),
 103   MAP (beagle_hits_subtracted_response_get_uris),
 104   MAP (beagle_query_new),
 105   MAP (beagle_query_add_text),
 106   MAP (beagle_query_add_hit_type),
 107   MAP (beagle_query_add_mime_type),
 108   MAP (beagle_query_set_max_hits),
 109   MAP (beagle_query_part_property_new),
 110   MAP (beagle_query_part_set_logic),
 111   MAP (beagle_query_part_property_set_key),
 112   MAP (beagle_query_part_property_set_value),
 113   MAP (beagle_query_part_property_set_property_type),
 114   MAP (beagle_query_add_part),
 115   MAP (beagle_request_get_type),
 116   MAP (beagle_query_part_get_type),
 117   MAP (beagle_util_daemon_is_running),
 118   MAP (beagle_client_new)
 119 #undef MAP
 120 };
 121
 122 static void
 123 open_libbeagle (void)
 124 {
 125   static gboolean done = FALSE;
 126
 127   if (!done)
 128     {
 129       int i;
 130       GModule *beagle;
 131
 132       done = TRUE;
 133
 134       beagle = g_module_open ("libbeagle.so.0", G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
 135       if (!beagle)
 136         return;
 137
 138       for (i = 0; i < G_N_ELEMENTS (beagle_dl_mapping); i++)
 139         {
 140           if (!g_module_symbol (beagle, beagle_dl_mapping[i].fn_name,
 141                                 beagle_dl_mapping[i].fn_ptr_ref))
 142             {
 143               g_warning ("Missing symbol '%s' in libbeagle\n",
 144                          beagle_dl_mapping[i].fn_name);
 145               g_module_close (beagle);
 146
 147               for (i = 0; i < G_N_ELEMENTS (beagle_dl_mapping); i++)
 148                 beagle_dl_mapping[i].fn_ptr_ref = NULL;
 149
 150               return;
 151             }
 152         }
 153     }
 154 }
 155
 156
 157 struct _GtkSearchEngineBeaglePrivate
 158 {
 159   BeagleClient *client;
 160   GtkQuery *query;
 161
 162   BeagleQuery *current_query;
 163   char *current_query_uri_prefix;
 164   gboolean query_finished;
 165 };
 166
 167
 168 G_DEFINE_TYPE (GtkSearchEngineBeagle, _gtk_search_engine_beagle, GTK_TYPE_SEARCH_ENGINE);
 169
 170 static void
 171 finalize (GObject *object)
 172 {
 173   GtkSearchEngineBeagle *beagle;
 174
 175   beagle = GTK_SEARCH_ENGINE_BEAGLE (object);
 176
 177   if (beagle->priv->current_query)
 178     {
 179       g_object_unref (beagle->priv->current_query);
 180       beagle->priv->current_query = NULL;
 181       g_free (beagle->priv->current_query_uri_prefix);
 182       beagle->priv->current_query_uri_prefix = NULL;
 183     }
 184
 185   if (beagle->priv->query)
 186     {
 187       g_object_unref (beagle->priv->query);
 188       beagle->priv->query = NULL;
 189     }
 190
 191   if (beagle->priv->client)
 192     {
 193       g_object_unref (beagle->priv->client);
 194       beagle->priv->client = NULL;
 195     }
 196
 197   G_OBJECT_CLASS (_gtk_search_engine_beagle_parent_class)->finalize (object);
 198 }
 199
 200 static void
 201 beagle_hits_added (BeagleQuery             *query,
 202                    BeagleHitsAddedResponse *response,
 203                    GtkSearchEngineBeagle   *engine)
 204 {
 205   GSList *hits, *list;
 206   GList *hit_uris;
 207   const gchar *uri;
 208
 209   hit_uris = NULL;
 210
 211   hits = beagle_hits_added_response_get_hits (response);
 212
 213   for (list = hits; list != NULL; list = list->next)
 214     {
 215       BeagleHit *hit = BEAGLE_HIT (list->data);
 216
 217       uri = beagle_hit_get_uri (hit);
 218
 219       if (engine->priv->current_query_uri_prefix &&
 220           !g_str_has_prefix (uri, engine->priv->current_query_uri_prefix))
 221         continue;
 222
 223       hit_uris = g_list_prepend (hit_uris, (char *)uri);
 224     }
 225
 226   _gtk_search_engine_hits_added (GTK_SEARCH_ENGINE (engine), hit_uris);
 227   g_list_free (hit_uris);
 228 }
 229
 230 static void
 231 beagle_hits_subtracted (BeagleQuery                  *query,
 232                         BeagleHitsSubtractedResponse *response,
 233                         GtkSearchEngineBeagle        *engine)
 234 {
 235   GSList *uris, *list;
 236   GList *hit_uris;
 237
 238   hit_uris = NULL;
 239
 240   uris = beagle_hits_subtracted_response_get_uris (response);
 241
 242   for (list = uris; list != NULL; list = list->next)
 243     {
 244       hit_uris = g_list_prepend (hit_uris, (char *)list->data);
 245     }
 246
 247   _gtk_search_engine_hits_subtracted (GTK_SEARCH_ENGINE (engine), hit_uris);
 248   g_list_free (hit_uris);
 249 }
 250
 251 static void
 252 beagle_finished (BeagleQuery            *query,
 253                  BeagleFinishedResponse *response,
 254                  GtkSearchEngineBeagle  *engine)
 255 {
 256   /* For some reason we keep getting finished events,
 257    * only emit finished once */
 258   if (engine->priv->query_finished)
 259     return;
 260
 261   engine->priv->query_finished = TRUE;
 262   _gtk_search_engine_finished (GTK_SEARCH_ENGINE (engine));
 263 }
 264
 265 static void
 266 beagle_error (BeagleQuery           *query,
 267               GError                *error,
 268               GtkSearchEngineBeagle *engine)
 269 {
 270   _gtk_search_engine_error (GTK_SEARCH_ENGINE (engine), error->message);
 271 }
 272
 273 static void
 274 gtk_search_engine_beagle_start (GtkSearchEngine *engine)
 275 {
 276   GtkSearchEngineBeagle *beagle;
 277   GError *error;
 278   GList *mimetypes, *l;
 279   gchar *text, *mimetype;
 280
 281   error = NULL;
 282   beagle = GTK_SEARCH_ENGINE_BEAGLE (engine);
 283
 284   g_return_if_fail (beagle->priv->query != NULL);
 285
 286   if (beagle->priv->current_query)
 287     return;
 288
 289   beagle->priv->query_finished = FALSE;
 290   beagle->priv->current_query = beagle_query_new ();
 291   g_signal_connect (beagle->priv->current_query,
 292                     "hits-added", G_CALLBACK (beagle_hits_added), engine);
 293   g_signal_connect (beagle->priv->current_query,
 294                     "hits-subtracted", G_CALLBACK (beagle_hits_subtracted), engine);
 295   g_signal_connect (beagle->priv->current_query,
 296                     "finished", G_CALLBACK (beagle_finished), engine);
 297   g_signal_connect (beagle->priv->current_query,
 298                     "error", G_CALLBACK (beagle_error), engine);
 299
 300   /* We only want files */
 301   beagle_query_add_hit_type (beagle->priv->current_query,
 302                              "File");
 303   beagle_query_set_max_hits (beagle->priv->current_query,
 304                              1000);
 305
 306   text = _gtk_query_get_text (beagle->priv->query);
 307   beagle_query_add_text (beagle->priv->current_query,
 308                          text);
 309
 310   mimetypes = _gtk_query_get_mime_types (beagle->priv->query);
 311   for (l = mimetypes; l != NULL; l = l->next)
 312     {
 313       mimetype = l->data;
 314       beagle_query_add_mime_type (beagle->priv->current_query, mimetype);
 315     }
 316
 317   beagle->priv->current_query_uri_prefix = _gtk_query_get_location (beagle->priv->query);
 318
 319   if (!beagle_client_send_request_async (beagle->priv->client,
 320                                          BEAGLE_REQUEST (beagle->priv->current_query), &error))
 321     {
 322       _gtk_search_engine_error (engine, error->message);
 323       g_error_free (error);
 324     }
 325
 326   /* These must live during the lifetime of the query */
 327   g_free (text);
 328   g_list_foreach (mimetypes, (GFunc)g_free, NULL);
 329   g_list_free (mimetypes);
 330 }
 331
 332 static void
 333 gtk_search_engine_beagle_stop (GtkSearchEngine *engine)
 334 {
 335   GtkSearchEngineBeagle *beagle;
 336
 337   beagle = GTK_SEARCH_ENGINE_BEAGLE (engine);
 338
 339   if (beagle->priv->current_query)
 340     {
 341       g_object_unref (beagle->priv->current_query);
 342       beagle->priv->current_query = NULL;
 343       g_free (beagle->priv->current_query_uri_prefix);
 344       beagle->priv->current_query_uri_prefix = NULL;
 345     }
 346 }
 347
 348 static gboolean
 349 gtk_search_engine_beagle_is_indexed (GtkSearchEngine *engine)
 350 {
 351   return TRUE;
 352 }
 353
 354 static void
 355 gtk_search_engine_beagle_set_query (GtkSearchEngine *engine,
 356                                     GtkQuery        *query)
 357 {
 358   GtkSearchEngineBeagle *beagle;
 359
 360   beagle = GTK_SEARCH_ENGINE_BEAGLE (engine);
 361
 362   if (query)
 363     g_object_ref (query);
 364
 365   if (beagle->priv->query)
 366     g_object_unref (beagle->priv->query);
 367
 368   beagle->priv->query = query;
 369 }
 370
 371 static void
 372 _gtk_search_engine_beagle_class_init (GtkSearchEngineBeagleClass *class)
 373 {
 374   GObjectClass *gobject_class;
 375   GtkSearchEngineClass *engine_class;
 376
 377   gobject_class = G_OBJECT_CLASS (class);
 378   gobject_class->finalize = finalize;
 379
 380   engine_class = GTK_SEARCH_ENGINE_CLASS (class);
 381   engine_class->set_query = gtk_search_engine_beagle_set_query;
 382   engine_class->start = gtk_search_engine_beagle_start;
 383   engine_class->stop = gtk_search_engine_beagle_stop;
 384   engine_class->is_indexed = gtk_search_engine_beagle_is_indexed;
 385
 386   g_type_class_add_private (gobject_class, sizeof (GtkSearchEngineBeaglePrivate));
 387 }
 388
 389 static void
 390 _gtk_search_engine_beagle_init (GtkSearchEngineBeagle *engine)
 391 {
 392   engine->priv = G_TYPE_INSTANCE_GET_PRIVATE (engine, GTK_TYPE_SEARCH_ENGINE_BEAGLE, GtkSearchEngineBeaglePrivate);
 393 }
 394
 395
 396 GtkSearchEngine *
 397 _gtk_search_engine_beagle_new (void)
 398 {
 399   GtkSearchEngineBeagle *engine;
 400   BeagleClient *client;
 401
 402   open_libbeagle ();
 403
 404   if (!beagle_util_daemon_is_running)
 405     return NULL;
 406
 407   /* check whether daemon is running as beagle_client_new
 408    * doesn't fail when a stale socket file exists */
 409   if (!beagle_util_daemon_is_running ())
 410       return NULL;
 411
 412   client = beagle_client_new (NULL);
 413
 414   if (client == NULL)
 415     return NULL;
 416
 417   engine = g_object_new (GTK_TYPE_SEARCH_ENGINE_BEAGLE, NULL);
 418
 419   engine->priv->client = client;
 420
 421   return GTK_SEARCH_ENGINE (engine);
 422 }