etc/afpd/spotlight.h

   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 #ifndef SPOTLIGHT_H
  20 #define SPOTLIGHT_H
  21
  22 #include <stdint.h>
  23 #include <stdbool.h>
  24
  25 #include <atalk/dalloc.h>
  26 #include <atalk/globals.h>
  27
  28 /**************************************************************************************************
  29  * Spotlight module stuff
  30  **************************************************************************************************/
  31
  32 #define SL_MODULE_VERSION 1
  33
  34 struct sl_module_export {
  35     int sl_mod_version;
  36     int (*sl_mod_init)        (void *);
  37     int (*sl_mod_start_search)(void *);
  38     int (*sl_mod_fetch_result)(void *);
  39     int (*sl_mod_end_search)  (void *);
  40 };
  41
  42 extern int sl_mod_load(const char *path);
  43
  44
  45 /**************************************************************************************************
  46  * Spotlight RPC and marshalling stuff
  47  **************************************************************************************************/
  48
  49 /* FPSpotlightRPC subcommand codes */
  50 #define SPOTLIGHT_CMD_OPEN    1
  51 #define SPOTLIGHT_CMD_FLAGS   2
  52 #define SPOTLIGHT_CMD_RPC     3
  53 #define SPOTLIGHT_CMD_OPEN2   4
  54
  55 /* Can be ored and used as flags */
  56 #define SL_ENC_LITTLE_ENDIAN 1
  57 #define SL_ENC_BIG_ENDIAN    2
  58 #define SL_ENC_UTF_16        4
  59
  60 typedef DALLOC_CTX     sl_array_t;    /* an array of elements                                           */
  61 typedef DALLOC_CTX     sl_dict_t;     /* an array of key/value elements                                 */
  62 typedef DALLOC_CTX     sl_filemeta_t; /* contains one sl_array_t                                        */
  63 typedef int            sl_nil_t;      /* a nil element                                                  */
  64 typedef bool           sl_bool_t;     /* a boolean, we avoid bool_t as it's a define for something else */
  65 typedef struct timeval sl_time_t;     /* a boolean, we avoid bool_t as it's a define for something else */
  66 typedef struct {
  67     char sl_uuid[16];
  68 }  sl_uuid_t;                         /* a UUID                                                         */
  69 typedef struct {
  70     uint16_t   ca_unkn1;
  71     uint32_t   ca_context;
  72     DALLOC_CTX *ca_cnids;
  73 }  sl_cnids_t;                        /* an array of CNIDs                                              */
  74
  75 /**************************************************************************************************
  76  * Some helper stuff dealing with queries
  77  **************************************************************************************************/
  78
  79 /* Internal query state */
  80 typedef enum {
  81     SLQ_STATE_NEW      = 1,           /* Query received from client                                     */
  82     SLQ_STATE_RUNNING  = 2,           /* Query dispatched to Tracker                                    */
  83     SLQ_STATE_DONE     = 3,           /* Tracker finished                                               */
  84     SLQ_STATE_END      = 4            /* Query results returned to client                               */
  85 } slq_state_t;
  86
  87 /* Internal query data structure */
  88 typedef struct {
  89     slq_state_t    slq_state;         /* State                                                          */
  90     time_t         slq_time;          /* timestamp where we received this query                         */
  91     uint64_t       slq_ctx1;          /* client context 1                                               */
  92     uint64_t       slq_ctx2;          /* client context 2                                               */
  93     const char     *slq_qstring;      /* the Spotlight query string                                     */
  94     DALLOC_CTX     *slq_reqinfo;      /* array with requested metadata                                  */
  95     void           *slq_tracker_cursor; /* Tracker query result cursor                                  */
  96 } slq_t;
  97
  98 /**************************************************************************************************
  99  * Function declarations
 100  **************************************************************************************************/
 101
 102 extern int afp_spotlight_rpc(AFPObj *obj, char *ibuf, size_t ibuflen _U_, char *rbuf, size_t *rbuflen);
 103 extern int sl_pack(DALLOC_CTX *query, char *buf);
 104 extern int sl_unpack(DALLOC_CTX *query, const char *buf);
 105
 106 #endif /* SPOTLIGHT_H */