etc/afpd/spotlight_module.c

   1 /*
   2   Copyright (c) 2012 Frank Lahm <franklahm@gmail.com>
   3
   4   This program is free software; you can redistribute it and/or modify
   5   it under the terms of the GNU General Public License as published by
   6   the Free Software Foundation; either version 2 of the License, or
   7   (at your option) any later version.
   8
   9   This program 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
  12   GNU General Public License for more details.
  13 */
  14
  15 #ifdef HAVE_CONFIG_H
  16 #include "config.h"
  17 #endif /* HAVE_CONFIG_H */
  18
  19 #include <string.h>
  20 #include <locale.h>
  21
  22 #include <gio/gio.h>
  23 #include <tracker-sparql.h>
  24 #include <libtracker-miner/tracker-miner.h>
  25
  26 #include <atalk/util.h>
  27 #include <atalk/errchk.h>
  28 #include <atalk/logger.h>
  29 #include <atalk/unix.h>
  30
  31 #include "spotlight.h"
  32 #include "spotlight_rawquery_parser.h"
  33
  34 #define MAX_SL_RESULTS 20
  35
  36 static TrackerSparqlConnection *connection;
  37 static TrackerMinerManager *manager;
  38
  39 static char *tracker_to_unix_path(const char *uri)
  40 {
  41     EC_INIT;
  42     GFile *f = NULL;
  43     char *path = NULL;
  44
  45     EC_NULL_LOG( f = g_file_new_for_uri(uri) );
  46     EC_NULL_LOG( path = g_file_get_path(f) );
  47
  48 EC_CLEANUP:
  49     if (f)
  50         g_object_unref(f);
  51     if (ret != 0)
  52         return NULL;
  53     return path;
  54 }
  55
  56 static int sl_mod_init(void *p)
  57 {
  58     EC_INIT;
  59     GError *error = NULL;
  60     const char *msg = p;
  61
  62     LOG(log_info, logtype_sl, "Initializing Spotlight module");
  63
  64     g_type_init();
  65     setenv("DBUS_SESSION_BUS_ADDRESS", "unix:path=/tmp/spotlight.ipc", 1);
  66     setenv("TRACKER_SPARQL_BACKEND", "bus", 1);
  67
  68 #ifdef DEBUG
  69     setenv("TRACKER_VERBOSITY", "3", 1);
  70     dup2(type_configs[logtype_sl].fd, 1);
  71     dup2(type_configs[logtype_sl].fd, 2);
  72 #endif
  73
  74     become_root();
  75     connection = tracker_sparql_connection_get(NULL, &error);
  76     manager = tracker_miner_manager_new_full(FALSE, &error);
  77     unbecome_root();
  78
  79     if (!connection) {
  80         LOG(log_error, logtype_sl, "Couldn't obtain a direct connection to the Tracker store: %s",
  81             error ? error->message : "unknown error");
  82         g_clear_error(&error);
  83         EC_FAIL;
  84     }
  85
  86     if (!manager) {
  87         LOG(log_error, logtype_sl, "Couldn't connect to Tracker miner");
  88         g_clear_error(&error);
  89         EC_FAIL;
  90     }
  91
  92 EC_CLEANUP:
  93     EC_EXIT;
  94 }
  95
  96
  97 static void tracker_cb(GObject *source_object, GAsyncResult *res, gpointer user_data)
  98 {
  99     slq_t *slq = user_data;
 100     TrackerSparqlCursor *cursor;
 101     GError *error = NULL;
 102
 103     LOG(log_debug, logtype_sl, "tracker_cb");
 104
 105     cursor = tracker_sparql_connection_query_finish(connection, res, &error);
 106
 107     if (error) {
 108         LOG(log_error, logtype_sl, "sl_mod_fetch_result: Couldn't query the Tracker Store: '%s'",
 109             error ? error->message : "unknown error");
 110         g_clear_error(&error);
 111         return;
 112     }
 113
 114     slq->slq_tracker_cursor = cursor;
 115 }
 116
 117 static int sl_mod_start_search(void *p)
 118 {
 119     EC_INIT;
 120     slq_t *slq = p;
 121     gchar *sparql_query;
 122     GError *error = NULL;
 123
 124     LOG(log_debug, logtype_sl, "sl_mod_start_search: Spotlight query string: \"%s\"", slq->slq_qstring);
 125
 126     EC_ZERO_LOGSTR( map_spotlight_to_sparql_query(slq, &sparql_query),
 127                     "Mapping Spotlight query failed: \"%s\"", slq->slq_qstring );
 128     LOG(log_debug, logtype_sl, "sl_mod_start_search: SPARQL query: \"%s\"", sparql_query);
 129
 130 #if 0
 131     /* Start the async query */
 132     tracker_sparql_connection_query_async(connection, sparql_query, NULL, tracker_cb, slq);
 133 #endif
 134
 135     become_root();
 136     slq->slq_tracker_cursor = tracker_sparql_connection_query(connection, sparql_query, NULL, &error);
 137     unbecome_root();
 138
 139     if (error) {
 140         LOG(log_error, logtype_sl, "Couldn't query the Tracker Store: '%s'",
 141             error ? error->message : "unknown error");
 142         g_clear_error(&error);
 143         EC_FAIL;
 144     }
 145     slq->slq_state = SLQ_STATE_RUNNING;
 146
 147 EC_CLEANUP:
 148     EC_EXIT;
 149 }
 150
 151 static int add_filemeta(sl_array_t *reqinfo, sl_array_t *fm_array, cnid_t id, const char *path)
 152 {
 153     EC_INIT;
 154     sl_array_t *meta;
 155     sl_nil_t nil = 0;
 156     int i, metacount;
 157
 158     if ((metacount = talloc_array_length(reqinfo->dd_talloc_array)) == 0) {
 159         dalloc_add_copy(fm_array, &nil, sl_nil_t);
 160         goto EC_CLEANUP;
 161     }
 162
 163     LOG(log_debug, logtype_sl, "add_filemeta: metadata count: %d", metacount);
 164
 165     meta = talloc_zero(fm_array, sl_array_t);
 166
 167     for (i = 0; i < metacount; i++) {
 168         if (STRCMP(reqinfo->dd_talloc_array[i], ==, "kMDItemDisplayName")) {
 169             char *p, *name;
 170             if ((p = strrchr(path, '/'))) {
 171                 name = dalloc_strdup(meta, p + 1);
 172                 dalloc_add(meta, name, "char *");
 173             }
 174         } else {
 175             dalloc_add_copy(meta, &nil, sl_nil_t);
 176         }
 177     }
 178
 179     dalloc_add(fm_array, meta, sl_array_t);
 180
 181 EC_CLEANUP:
 182     EC_EXIT;
 183 }
 184
 185 static int sl_mod_fetch_result(void *p)
 186 {
 187     EC_INIT;
 188     slq_t *slq = p;
 189     GError *error = NULL;
 190     int i = 0;
 191     cnid_t did, id;
 192     const gchar *uri;
 193     char *path;
 194     sl_cnids_t *cnids;
 195     sl_filemeta_t *fm;
 196     sl_array_t *fm_array;
 197     sl_nil_t nil;
 198     uint64_t uint64;
 199     gboolean qres, firstmatch = true;
 200
 201     if (!slq->slq_tracker_cursor) {
 202         LOG(log_debug, logtype_sl, "sl_mod_fetch_result: no results found");
 203         goto EC_CLEANUP;
 204     }
 205
 206     /* Prepare CNIDs */
 207     cnids = talloc_zero(slq->slq_reply, sl_cnids_t);
 208     cnids->ca_cnids = talloc_zero(cnids, DALLOC_CTX);
 209     cnids->ca_unkn1 = 0xadd;
 210     cnids->ca_context = slq->slq_ctx2;
 211
 212     /* Prepare FileMeta */
 213     fm = talloc_zero(slq->slq_reply, sl_filemeta_t);
 214     fm_array = talloc_zero(fm, sl_array_t);
 215     dalloc_add(fm, fm_array, sl_array_t);
 216
 217     LOG(log_debug, logtype_sl, "sl_mod_fetch_result: now interating Tracker results cursor");
 218
 219     while ((slq->slq_state == SLQ_STATE_RUNNING) && (i <= MAX_SL_RESULTS)) {
 220         become_root();
 221         qres = tracker_sparql_cursor_next(slq->slq_tracker_cursor, NULL, &error);
 222         unbecome_root();
 223
 224         if (!qres)
 225             break;
 226
 227         if (firstmatch) {
 228             /* For some reason the list of results always starts with a nil entry */
 229             dalloc_add_copy(fm_array, &nil, sl_nil_t);
 230             firstmatch = false;
 231         }
 232
 233         become_root();
 234         uri = tracker_sparql_cursor_get_string(slq->slq_tracker_cursor, 0, NULL);
 235         unbecome_root();
 236
 237         EC_NULL_LOG( path = tracker_to_unix_path(uri) );
 238
 239         if ((id = cnid_for_path(slq->slq_vol->v_cdb, slq->slq_vol->v_path, path, &did)) == CNID_INVALID) {
 240             LOG(log_error, logtype_sl, "sl_mod_fetch_result: cnid_for_path error: %s", path);
 241             goto loop_cleanup;
 242         }
 243         LOG(log_debug, logtype_sl, "Result %d: CNID: %" PRIu32 ", path: \"%s\"", i, ntohl(id), path);
 244
 245         uint64 = ntohl(id);
 246         dalloc_add_copy(cnids->ca_cnids, &uint64, uint64_t);
 247         add_filemeta(slq->slq_reqinfo, fm_array, id, path);
 248
 249     loop_cleanup:
 250         g_free(path);
 251         i++;
 252    }
 253
 254     if (error) {
 255         LOG(log_error, logtype_sl, "Couldn't query the Tracker Store: '%s'",
 256             error ? error->message : "unknown error");
 257         g_clear_error (&error);
 258         EC_FAIL;
 259     }
 260
 261     if (i < MAX_SL_RESULTS)
 262         slq->slq_state = SLQ_STATE_DONE;
 263
 264     uint64 = (i > 0) ? 35 : 0; /* OS X AFP server returns 35 here if results are found */
 265     dalloc_add_copy(slq->slq_reply, &uint64, uint64_t);
 266     dalloc_add(slq->slq_reply, cnids, sl_cnids_t);
 267     dalloc_add(slq->slq_reply, fm, sl_filemeta_t);
 268
 269 EC_CLEANUP:
 270     if (ret != 0) {
 271         if (slq->slq_tracker_cursor) {
 272             g_object_unref(slq->slq_tracker_cursor);
 273             slq->slq_tracker_cursor = NULL;
 274         }
 275     }
 276     EC_EXIT;
 277 }
 278
 279 /* Free ressources allocated in this module */
 280 static int sl_mod_close_query(void *p)
 281 {
 282     EC_INIT;
 283     slq_t *slq = p;
 284
 285     if (slq->slq_tracker_cursor) {
 286         g_object_unref(slq->slq_tracker_cursor);
 287         slq->slq_tracker_cursor = NULL;
 288     }
 289
 290 EC_CLEANUP:
 291     EC_EXIT;
 292 }
 293
 294 static int sl_mod_error(void *p)
 295 {
 296     EC_INIT;
 297     slq_t *slq = p;
 298
 299     if (!slq)
 300         goto EC_CLEANUP;
 301
 302     if (slq->slq_tracker_cursor) {
 303         g_object_unref(slq->slq_tracker_cursor);
 304         slq->slq_tracker_cursor = NULL;
 305     }
 306
 307 EC_CLEANUP:
 308     EC_EXIT;
 309 }
 310
 311 static int sl_mod_index_file(const void *p)
 312 {
 313 #ifdef HAVE_TRACKER_MINER
 314     EC_INIT;
 315     const char *f = p;
 316
 317     if (!f)
 318         goto EC_CLEANUP;
 319
 320     GError *error = NULL;
 321     GFile *file = NULL;
 322
 323     file = g_file_new_for_commandline_arg(f);
 324
 325     become_root();
 326     tracker_miner_manager_index_file(manager, file, &error);
 327     unbecome_root();
 328
 329     if (error)
 330         LOG(log_error, logtype_sl, "sl_mod_index_file(\"%s\"): indexing failed", f);
 331     else
 332         LOG(log_debug, logtype_sl, "sl_mod_index_file(\"%s\"): indexing file was successful", f);
 333
 334 EC_CLEANUP:
 335     if (file)
 336         g_object_unref(file);
 337     EC_EXIT;
 338 #else
 339     return 0;
 340 #endif
 341 }
 342
 343 struct sl_module_export sl_mod = {
 344     SL_MODULE_VERSION,
 345     sl_mod_init,
 346     sl_mod_start_search,
 347     sl_mod_fetch_result,
 348     sl_mod_close_query,
 349     sl_mod_error,
 350     sl_mod_index_file
 351 };