2 Copyright (C) Ralph Boehme 2012-2014
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.
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.
17 #endif /* HAVE_CONFIG_H */
23 #include <tracker-sparql.h>
24 #include <libtracker-miner/tracker-miner.h>
26 #include <atalk/util.h>
27 #include <atalk/errchk.h>
28 #include <atalk/logger.h>
29 #include <atalk/unix.h>
30 #include <atalk/spotlight.h>
32 #include "slmod_sparql_parser.h"
34 #define MAX_SL_RESULTS 20
36 static TrackerSparqlConnection *connection;
38 static char *tracker_to_unix_path(const char *uri)
44 EC_NULL_LOG( f = g_file_new_for_uri(uri) );
45 EC_NULL_LOG( path = g_file_get_path(f) );
55 static int sl_mod_init(void *p)
59 AFPObj *obj = (AFPObj *)p;
60 const char *attributes;
62 LOG(log_info, logtype_sl, "Initializing Spotlight module");
65 setenv("DBUS_SESSION_BUS_ADDRESS", "unix:path=" _PATH_STATEDIR "/spotlight.ipc", 1);
66 setenv("TRACKER_SPARQL_BACKEND", "bus", 1);
69 setenv("TRACKER_VERBOSITY", "3", 1);
70 dup2(type_configs[logtype_sl].fd, 1);
71 dup2(type_configs[logtype_sl].fd, 2);
75 connection = tracker_sparql_connection_get(NULL, &error);
76 #if 0 /* this may hang, so disable it as we don't use the miner anyway */
77 manager = tracker_miner_manager_new_full(FALSE, &error);
82 LOG(log_error, logtype_sl, "Couldn't obtain a direct connection to the Tracker store: %s",
83 error ? error->message : "unknown error");
84 g_clear_error(&error);
90 LOG(log_error, logtype_sl, "Couldn't connect to Tracker miner");
91 g_clear_error(&error);
96 attributes = atalk_iniparser_getstring(obj->iniconfig, INISEC_GLOBAL, "spotlight attributes", NULL);
98 configure_spotlight_attributes(attributes);
106 static void tracker_cb(GObject *source_object, GAsyncResult *res, gpointer user_data)
108 slq_t *slq = user_data;
109 TrackerSparqlCursor *cursor;
110 GError *error = NULL;
112 LOG(log_debug, logtype_sl, "tracker_cb");
114 cursor = tracker_sparql_connection_query_finish(connection, res, &error);
117 LOG(log_error, logtype_sl, "sl_mod_fetch_result: Couldn't query the Tracker Store: '%s'",
118 error ? error->message : "unknown error");
119 g_clear_error(&error);
123 slq->slq_tracker_cursor = cursor;
126 static int sl_mod_start_search(void *p)
131 GError *error = NULL;
133 LOG(log_debug, logtype_sl, "sl_mod_start_search: Spotlight query string: \"%s\"", slq->slq_qstring);
135 EC_ZERO_LOGSTR( map_spotlight_to_sparql_query(slq, &sparql_query),
136 "Mapping Spotlight query failed: \"%s\"", slq->slq_qstring );
137 LOG(log_debug, logtype_sl, "sl_mod_start_search: SPARQL query: \"%s\"", sparql_query);
140 /* Start the async query */
141 tracker_sparql_connection_query_async(connection, sparql_query, NULL, tracker_cb, slq);
145 slq->slq_tracker_cursor = tracker_sparql_connection_query(connection, sparql_query, NULL, &error);
149 LOG(log_error, logtype_sl, "Couldn't query the Tracker Store: '%s'",
150 error ? error->message : "unknown error");
151 g_clear_error(&error);
154 slq->slq_state = SLQ_STATE_RUNNING;
160 static int add_filemeta(sl_array_t *reqinfo, sl_array_t *fm_array, cnid_t id, const char *path, const struct stat *sp)
169 if ((metacount = talloc_array_length(reqinfo->dd_talloc_array)) == 0) {
170 dalloc_add_copy(fm_array, &nil, sl_nil_t);
174 LOG(log_debug, logtype_sl, "add_filemeta: metadata count: %d", metacount);
176 meta = talloc_zero(fm_array, sl_array_t);
178 for (i = 0; i < metacount; i++) {
179 if (STRCMP(reqinfo->dd_talloc_array[i], ==, "kMDItemDisplayName") ||
180 STRCMP(reqinfo->dd_talloc_array[i], ==, "kMDItemFSName")) {
182 if ((p = strrchr(path, '/'))) {
183 name = dalloc_strdup(meta, p + 1);
184 dalloc_add(meta, name, "char *");
186 } else if (STRCMP(reqinfo->dd_talloc_array[i], ==, "kMDItemFSSize")) {
187 uint64 = sp->st_size;
188 dalloc_add_copy(meta, &uint64, uint64_t);
189 } else if (STRCMP(reqinfo->dd_talloc_array[i], ==, "kMDItemFSOwnerUserID")) {
191 dalloc_add_copy(meta, &uint64, uint64_t);
192 } else if (STRCMP(reqinfo->dd_talloc_array[i], ==, "kMDItemFSOwnerGroupID")) {
194 dalloc_add_copy(meta, &uint64, uint64_t);
195 } else if (STRCMP(reqinfo->dd_talloc_array[i], ==, "kMDItemFSContentChangeDate")) {
196 sl_time.tv_sec = sp->st_mtime;
197 dalloc_add_copy(meta, &sl_time, sl_time_t);
199 dalloc_add_copy(meta, &nil, sl_nil_t);
203 dalloc_add(fm_array, meta, sl_array_t);
209 static int cnid_cmp_fn(const void *p1, const void *p2)
211 const uint64_t *cnid1 = p1, *cnid2 = p2;
212 if (*cnid1 == *cnid2)
220 static int sl_mod_fetch_result(void *p)
224 GError *error = NULL;
231 sl_array_t *fm_array;
234 gboolean qres, firstmatch = true;
236 if (!slq->slq_tracker_cursor) {
237 LOG(log_debug, logtype_sl, "sl_mod_fetch_result: no results found");
242 cnids = talloc_zero(slq->slq_reply, sl_cnids_t);
243 cnids->ca_cnids = talloc_zero(cnids, DALLOC_CTX);
244 cnids->ca_unkn1 = 0xadd;
245 cnids->ca_context = slq->slq_ctx2;
247 /* Prepare FileMeta */
248 fm = talloc_zero(slq->slq_reply, sl_filemeta_t);
249 fm_array = talloc_zero(fm, sl_array_t);
250 /* For some reason the list of results always starts with a nil entry */
251 dalloc_add_copy(fm_array, &nil, sl_nil_t);
252 dalloc_add(fm, fm_array, sl_array_t);
254 LOG(log_debug, logtype_sl, "sl_mod_fetch_result: now interating Tracker results cursor");
256 while ((slq->slq_state == SLQ_STATE_RUNNING) && (i <= MAX_SL_RESULTS)) {
258 qres = tracker_sparql_cursor_next(slq->slq_tracker_cursor, NULL, &error);
266 /* For some reason the list of results always starts with a nil entry */
267 dalloc_add_copy(fm_array, &nil, sl_nil_t);
273 uri = tracker_sparql_cursor_get_string(slq->slq_tracker_cursor, 0, NULL);
276 EC_NULL_LOG( path = tracker_to_unix_path(uri) );
278 if ((id = cnid_for_path(slq->slq_vol->v_cdb, slq->slq_vol->v_path, path, &did)) == CNID_INVALID) {
279 LOG(log_debug, logtype_sl, "sl_mod_fetch_result: cnid_for_path error: %s", path);
282 LOG(log_debug, logtype_sl, "Result %d: CNID: %" PRIu32 ", path: \"%s\"", i, ntohl(id), path);
285 if (slq->slq_cnids) {
286 if (!bsearch(&uint64, slq->slq_cnids, slq->slq_cnids_num, sizeof(uint64_t), cnid_cmp_fn))
291 if (stat(path, &sb) != 0)
294 dalloc_add_copy(cnids->ca_cnids, &uint64, uint64_t);
295 add_filemeta(slq->slq_reqinfo, fm_array, id, path, &sb);
303 LOG(log_error, logtype_sl, "Couldn't query the Tracker Store: '%s'",
304 error ? error->message : "unknown error");
305 g_clear_error (&error);
309 if (i < MAX_SL_RESULTS)
310 slq->slq_state = SLQ_STATE_DONE;
312 uint64 = (i > 0) ? 35 : 0; /* OS X AFP server returns 35 here if results are found */
313 dalloc_add_copy(slq->slq_reply, &uint64, uint64_t);
314 dalloc_add(slq->slq_reply, cnids, sl_cnids_t);
315 dalloc_add(slq->slq_reply, fm, sl_filemeta_t);
319 if (slq->slq_tracker_cursor) {
320 g_object_unref(slq->slq_tracker_cursor);
321 slq->slq_tracker_cursor = NULL;
327 /* Free ressources allocated in this module */
328 static int sl_mod_close_query(void *p)
333 if (slq->slq_tracker_cursor) {
334 g_object_unref(slq->slq_tracker_cursor);
335 slq->slq_tracker_cursor = NULL;
342 static int sl_mod_fetch_attrs(void *p)
347 sl_array_t *fm_array;
350 LOG(log_debug, logtype_sl, "sl_mod_fetch_attrs(\"%s\")", slq->slq_path);
353 EC_ZERO( stat(slq->slq_path, &sb) );
355 /* Prepare FileMeta */
356 fm = talloc_zero(slq->slq_reply, sl_filemeta_t);
357 fm_array = talloc_zero(fm, sl_array_t);
358 dalloc_add(fm, fm_array, fm_array_t);
359 /* For some reason the list of results always starts with a nil entry */
360 dalloc_add_copy(fm_array, &nil, sl_nil_t);
362 add_filemeta(slq->slq_reqinfo, fm_array, CNID_INVALID, slq->slq_path, &sb);
365 dalloc_add(slq->slq_reply, fm, sl_filemeta_t);
371 static int sl_mod_error(void *p)
379 if (slq->slq_tracker_cursor) {
380 g_object_unref(slq->slq_tracker_cursor);
381 slq->slq_tracker_cursor = NULL;
388 static int sl_mod_index_file(const void *p)
391 * This seems to cause index problems on volumes that are watched and indexed
392 * by Tracker, so we disable this extra manual indexing for now.
393 * It's primary pupose was ensuring files created via AFP are indexed on large
394 * volumes where the filesystem event notification engine (eg FAM or FEN) may
395 * impose limits on the maximum number of watched directories.
400 struct sl_module_export sl_mod = {