include/idzebra/recctrl.h

   1 /* $Id: recctrl.h,v 1.36 2007-10-29 13:43:57 adam Exp $
   2    Copyright (C) 1995-2007
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20
  21 */
  22
  23 #ifndef IDZEBRA_RECCTRL_H
  24 #define IDZEBRA_RECCTRL_H
  25
  26 #include <sys/types.h>
  27 #include <yaz/proto.h>
  28 #include <yaz/odr.h>
  29 #include <idzebra/res.h>
  30 #include <idzebra/data1.h>
  31 #include <idzebra/snippet.h>
  32
  33 YAZ_BEGIN_CDECL
  34
  35 /* 1 */
  36 #define ZEBRA_XPATH_ELM_BEGIN "_XPATH_BEGIN"
  37
  38 /* 2 */
  39 #define ZEBRA_XPATH_ELM_END   "_XPATH_END"
  40
  41 /* 1016 */
  42 #define ZEBRA_XPATH_CDATA     "_XPATH_CDATA"
  43
  44 /* 3 */
  45 #define ZEBRA_XPATH_ATTR_NAME       "_XPATH_ATTR_NAME"
  46
  47 /* 1015 */
  48 #define ZEBRA_XPATH_ATTR_CDATA      "_XPATH_ATTR_CDATA"
  49
  50 /** Indexing token */
  51 typedef struct {
  52     /** index type ('w', 'p', .. */
  53     unsigned index_type;
  54     /** index name, e.g. "title" */
  55     const char *index_name;
  56     /** token char data */
  57     const char *term_buf;
  58     /** length of term_buf */
  59     int  term_len;
  60     /** sequence number */
  61     zint seqno;
  62     /** segment number */
  63     zint segment;
  64     /** record ID */
  65     zint record_id;
  66     /** section ID */
  67     zint section_id;
  68     struct recExtractCtrl *extractCtrl;
  69 } RecWord;
  70
  71 /** \brief record reader stream */
  72 struct ZebraRecStream {
  73     /** client data */
  74     void      *fh;
  75     /** \brief read function */
  76     int       (*readf)(struct ZebraRecStream *s, char *buf, size_t count);
  77     /** \brief seek function */
  78     off_t     (*seekf)(struct ZebraRecStream *s, off_t offset);
  79     /** \brief tell function */
  80     off_t     (*tellf)(struct ZebraRecStream *s);
  81     /** \brief set and get of record position */
  82     off_t     (*endf)(struct ZebraRecStream *s, off_t *offset);
  83     /** \brief close and destroy stream */
  84     void      (*destroy)(struct ZebraRecStream *s);
  85 };
  86
  87 enum zebra_recctrl_action_t {
  88     action_insert = 1,
  89     action_replace,
  90     action_delete,
  91     action_update  /* insert or replace as needed */
  92 };
  93
  94 /** \brief record extract for indexing */
  95 struct recExtractCtrl {
  96     struct ZebraRecStream *stream;
  97     void      (*init)(struct recExtractCtrl *p, RecWord *w);
  98     void      *clientData;
  99     void      (*tokenAdd)(RecWord *w);
 100     void      (*setStoreData)(struct recExtractCtrl *p, void *buf, size_t size);
 101     int       first_record;
 102     int       flagShowRecords;
 103     int       seqno[256];
 104     char      match_criteria[256];
 105     zint      staticrank;
 106     void      (*schemaAdd)(struct recExtractCtrl *p, Odr_oid *oid);
 107     data1_handle dh;
 108     void      *handle;
 109     enum zebra_recctrl_action_t action;
 110 };
 111
 112 /* Retrieve record control */
 113 struct recRetrieveCtrl {
 114     struct ZebraRecStream *stream;
 115     /* Input parameters ... */
 116     Res       res;                    /* Resource pool                     */
 117     ODR       odr;                    /* ODR used to create response       */
 118     const Odr_oid * input_format;     /* Preferred record syntax OID       */
 119     Z_RecordComposition *comp;        /* formatting instructions           */
 120     char      *encoding;              /* preferred character encoding      */
 121     zint      localno;                /* local id of record                */
 122     int       score;                  /* score 0-1000 or -1 if none        */
 123     zint      staticrank;             /* static rank >= 0,  0 if none */
 124     int       recordSize;             /* size of record in bytes */
 125     char      *fname;                 /* name of file (or NULL if internal) */
 126     data1_handle dh;
 127     zebra_snippets *hit_snippet;
 128     zebra_snippets *doc_snippet;
 129
 130     /* response */
 131     const Odr_oid * output_format;    /* output format OID */
 132     void *     rec_buf;
 133     int        rec_len;
 134     int        diagnostic;
 135     char *     addinfo;
 136 };
 137
 138 typedef struct recType *RecType;
 139
 140 struct recType
 141 {
 142     int version;
 143     char *name;                           /* Name of record type */
 144     void *(*init)(Res res, RecType recType);  /* Init function - called once */
 145     ZEBRA_RES (*config)(void *clientData, Res res, const char *args); /* Config */
 146     void (*destroy)(void *clientData);    /* Destroy function */
 147     int  (*extract)(void *clientData,
 148                     struct recExtractCtrl *ctrl);   /* Extract proc */
 149     int  (*retrieve)(void *clientData,
 150                      struct recRetrieveCtrl *ctrl); /* Retrieve proc */
 151 };
 152
 153 #define RECCTRL_EXTRACT_OK    0
 154 #define RECCTRL_EXTRACT_EOF   1
 155 #define RECCTRL_EXTRACT_ERROR_GENERIC 2
 156 #define RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER 3
 157 #define RECCTRL_EXTRACT_SKIP  4
 158
 159 typedef struct recTypeClass *RecTypeClass;
 160 typedef struct recTypes *RecTypes;
 161
 162 YAZ_EXPORT
 163 RecTypeClass recTypeClass_create (Res res, NMEM nmem);
 164
 165 YAZ_EXPORT
 166 void recTypeClass_load_modules(RecTypeClass *rts, NMEM nmem,
 167                                const char *module_path);
 168
 169 YAZ_EXPORT
 170 RecTypeClass recTypeClass_add_modules(Res res, NMEM nmem,
 171                                       const char *module_path);
 172
 173 YAZ_EXPORT
 174 void recTypeClass_destroy(RecTypeClass rtc);
 175
 176 YAZ_EXPORT
 177 void recTypeClass_info(RecTypeClass rtc, void *cd,
 178                        void (*cb)(void *cd, const char *s));
 179
 180 YAZ_EXPORT
 181 RecTypes recTypes_init(RecTypeClass rtc, data1_handle dh);
 182
 183 YAZ_EXPORT
 184 void recTypes_destroy(RecTypes recTypes);
 185
 186 YAZ_EXPORT
 187 void recTypes_default_handlers(RecTypes recTypes, Res res);
 188
 189 YAZ_EXPORT
 190 RecType recType_byName(RecTypes rts, Res res, const char *name,
 191                        void **clientDataP);
 192
 193 YAZ_END_CDECL
 194
 195 #endif
 196 /*
 197  * Local variables:
 198  * c-basic-offset: 4
 199  * indent-tabs-mode: nil
 200  * End:
 201  * vim: shiftwidth=4 tabstop=8 expandtab
 202  */
 203