2 Copyright (c) 2012 Frank Lahm <franklahm@gmail.com>
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 */
25 #include <atalk/dalloc.h>
26 #include <atalk/globals.h>
27 #include <atalk/volume.h>
29 /**************************************************************************************************
30 * Spotlight module stuff
31 **************************************************************************************************/
33 #define SL_MODULE_VERSION 1
35 struct sl_module_export {
37 int (*sl_mod_init) (void *);
38 int (*sl_mod_start_search)(void *);
39 int (*sl_mod_fetch_result)(void *);
40 int (*sl_mod_end_search) (void *);
41 int (*sl_mod_error) (void *);
42 int (*sl_mod_index_file) (const void *);
45 extern int sl_mod_load(const char *path);
46 extern void sl_index_file(const char *path);
48 /**************************************************************************************************
49 * Spotlight RPC and marshalling stuff
50 **************************************************************************************************/
52 /* FPSpotlightRPC subcommand codes */
53 #define SPOTLIGHT_CMD_OPEN 1
54 #define SPOTLIGHT_CMD_FLAGS 2
55 #define SPOTLIGHT_CMD_RPC 3
56 #define SPOTLIGHT_CMD_OPEN2 4
58 /* Can be ored and used as flags */
59 #define SL_ENC_LITTLE_ENDIAN 1
60 #define SL_ENC_BIG_ENDIAN 2
61 #define SL_ENC_UTF_16 4
63 typedef DALLOC_CTX sl_array_t; /* an array of elements */
64 typedef DALLOC_CTX sl_dict_t; /* an array of key/value elements */
65 typedef DALLOC_CTX sl_filemeta_t; /* contains one sl_array_t */
66 typedef int sl_nil_t; /* a nil element */
67 typedef bool sl_bool_t; /* a boolean, we avoid bool_t as it's a define for something else */
68 typedef struct timeval sl_time_t; /* a boolean, we avoid bool_t as it's a define for something else */
71 } sl_uuid_t; /* a UUID */
76 } sl_cnids_t; /* an array of CNIDs */
78 /**************************************************************************************************
79 * Some helper stuff dealing with queries
80 **************************************************************************************************/
82 /* Internal query state */
84 SLQ_STATE_NEW = 1, /* Query received from client */
85 SLQ_STATE_RUNNING = 2, /* Query dispatched to Tracker */
86 SLQ_STATE_DONE = 3, /* Tracker finished */
87 SLQ_STATE_END = 4 /* Query results returned to client */
90 /* Internal query data structure */
91 typedef struct _slq_t {
92 struct list_head slq_list; /* queries are stored in a list */
93 slq_state_t slq_state; /* State */
94 AFPObj *slq_obj; /* global AFPObj handle */
95 const struct vol *slq_vol; /* volume handle */
96 DALLOC_CTX *slq_reply; /* reply handle */
97 time_t slq_time; /* timestamp where we received this query */
98 uint64_t slq_ctx1; /* client context 1 */
99 uint64_t slq_ctx2; /* client context 2 */
100 sl_array_t *slq_reqinfo; /* array with requested metadata */
101 const char *slq_qstring; /* the Spotlight query string */
102 uint64_t *slq_cnids; /* Pointer to array with CNIDs to which a query applies */
103 size_t slq_cnids_num; /* Size of slq_cnids array */
104 #ifdef HAVE_TRACKER_SPARQL
105 void *slq_tracker_cursor; /* Tracker SPARQL query result cursor */
107 #ifdef HAVE_TRACKER_0_6
108 char *slq_trackerquery; /* query string*/
109 int slq_service; /* Tracker service */
110 int slq_offset; /* search offset */
114 /**************************************************************************************************
115 * Function declarations
116 **************************************************************************************************/
118 extern int afp_spotlight_rpc(AFPObj *obj, char *ibuf, size_t ibuflen _U_, char *rbuf, size_t *rbuflen);
119 extern int sl_pack(DALLOC_CTX *query, char *buf);
120 extern int sl_unpack(DALLOC_CTX *query, const char *buf);
122 #endif /* SPOTLIGHT_H */