spotlight.h

Go to the documentation of this file.

/*
  Copyright (c) 2012 Frank Lahm <franklahm@gmail.com>
 
  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.
 
  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
*/
 
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif /* HAVE_CONFIG_H */
 
#ifndef SPOTLIGHT_H
#define SPOTLIGHT_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include <atalk/globals.h>
#include <atalk/volume.h>
#include <atalk/dalloc.h>
 
/******************************************************************************
 * Spotlight RPC and marshalling stuff
 ******************************************************************************/
 
/* FPSpotlightRPC subcommand codes */
#define SPOTLIGHT_CMD_OPEN    1
#define SPOTLIGHT_CMD_FLAGS   2
#define SPOTLIGHT_CMD_RPC     3
#define SPOTLIGHT_CMD_OPEN2   4
 
/* Can be ored and used as flags */
#define SL_ENC_LITTLE_ENDIAN 1
#define SL_ENC_BIG_ENDIAN    2
#define SL_ENC_UTF_16        4
 
typedef DALLOC_CTX     sl_array_t;    
typedef DALLOC_CTX     sl_dict_t;     
typedef DALLOC_CTX     sl_filemeta_t; 
typedef int            sl_nil_t;      
typedef bool           sl_bool_t;     
typedef struct timeval sl_time_t;
typedef struct {
    char sl_uuid[16];
}  sl_uuid_t;                         
typedef struct {
    uint16_t   ca_unkn1;
    uint32_t   ca_context;
    DALLOC_CTX *ca_cnids;
}  sl_cnids_t;                        
 
/******************************************************************************
 * Some helper stuff dealing with queries
 ******************************************************************************/

typedef enum {
    SLQ_STATE_NEW,            
    SLQ_STATE_RUNNING,        
    SLQ_STATE_RESULTS,        
    SLQ_STATE_FULL,           
    SLQ_STATE_DONE,           
    SLQ_STATE_CANCEL_PENDING, 
    SLQ_STATE_CANCELLED,      
    SLQ_STATE_ERROR           
} slq_state_t;

typedef enum {
    SL_INDEX_FILE_MODIFY,
    SL_INDEX_FILE_DELETE,
    SL_INDEX_DIR_DELETE,
    SL_INDEX_FILE_CREATE,
    SL_INDEX_DIR_CREATE,
    SL_INDEX_FILE_MOVE,
    SL_INDEX_DIR_MOVE
} sl_index_event_t;

struct sl_rslts {
    int         num_results;
    sl_cnids_t *cnids;
    sl_array_t *fm_array;
};

typedef struct _slq_t {
    struct list_head  slq_list;         
    slq_state_t       slq_state;        
    AFPObj           *slq_obj;          
    const struct vol *slq_vol;          
    char             *slq_scope;        
    time_t            slq_time;         
    uint64_t          slq_ctx1;         
    uint64_t          slq_ctx2;         
    sl_array_t       *slq_reqinfo;      
    const char       *slq_qstring;      
    uint64_t         *slq_cnids;        
    size_t            slq_cnids_num;    
    void             *slq_backend_private; 
    bool              slq_allow_expr;   
    uint64_t          slq_result_limit; 
    struct sl_rslts  *query_results;    
} slq_t;
 
/******************************************************************************
 * Pluggable search backend vtable
 ******************************************************************************/
 
typedef struct sl_backend_ops {
    const char  *sbo_name;
 
    /* Called once globally when the first volume using this backend is opened. */
    int  (*sbo_init)(AFPObj *obj);
 
    /* Called on afpd shutdown. */
    void (*sbo_close)(AFPObj *obj);
 
    /* Translate slq->slq_qstring into results.
     * May be async (localsearch) or synchronous (cnid).
     * On return slq_state must be SLQ_STATE_RUNNING or SLQ_STATE_DONE. */
    int  (*sbo_open_query)(slq_t *slq);
 
    /* Fetch the next batch of results into slq->query_results.
     * For async backends: pumps the event loop.
     * For sync backends: no-op after sbo_open_query() already set SLQ_STATE_DONE. */
    int  (*sbo_fetch_results)(slq_t *slq);
 
    /* Cancel and clean up query state. */
    void (*sbo_close_query)(slq_t *slq);
 
    /* Optional incremental index update hook. */
    int  (*sbo_index_event)(const AFPObj *obj,
                            const struct vol *vol,
                            sl_index_event_t event,
                            const char *path,
                            const char *oldpath);
} sl_backend_ops;
 
/******************************************************************************
 * Function declarations
 ******************************************************************************/
 
extern int afp_spotlight_rpc(AFPObj *obj, char *ibuf, size_t ibuflen _U_,
                             char *rbuf, size_t *rbuflen);
extern int sl_index_event(const AFPObj *obj,
                          const struct vol *vol,
                          sl_index_event_t event,
                          const char *path,
                          const char *oldpath);
extern int sl_pack(DALLOC_CTX *query, char *buf);
extern int sl_unpack(DALLOC_CTX *query, const char *buf);
extern int sl_unpack_len(DALLOC_CTX *query, const char *buf, size_t buf_len);
extern void configure_spotlight_attributes(const char *attributes);
 
#endif /* SPOTLIGHT_H */