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