index/index.h

   1 /* $Id: index.h,v 1.203 2007-10-30 19:17:15 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 ZEBRA_INDEX_H
  24 #define ZEBRA_INDEX_H
  25
  26 #include <time.h>
  27 #include <stdlib.h>
  28 #include <idzebra/version.h>
  29 #include <idzebra/util.h>
  30 #include <idzebra/flock.h>
  31 #include <sortidx.h>
  32 #include <index_types.h>
  33 #if HAVE_SYS_TIMES_H
  34 #include <sys/times.h>
  35 #endif
  36 #include <sys/stat.h>
  37
  38 #include <yaz/timing.h>
  39 #include <idzebra/dict.h>
  40 #include <idzebra/isams.h>
  41 #include <idzebra/isamc.h>
  42 #include <idzebra/isamb.h>
  43 #include <d1_absyn.h>
  44 #include <idzebra/recgrs.h>
  45 #include "recindex.h"
  46 #include <idzebra/api.h>
  47 #include "zinfo.h"
  48 #include <passwddb.h>
  49 #include <rset.h>
  50 #include <zebramap.h>
  51
  52 #include <it_key.h>
  53 #include <su_codec.h>
  54
  55 YAZ_BEGIN_CDECL
  56
  57 #define ISAM_DEFAULT "b"
  58
  59 enum dirsKind { dirs_dir, dirs_file };
  60
  61 struct dir_entry {
  62     enum dirsKind kind;
  63     char *name;
  64     time_t mtime;
  65 };
  66
  67 struct dirs_entry {
  68     enum dirsKind kind;
  69     char path[256];
  70     zint sysno;
  71     time_t mtime;
  72 };
  73
  74 void getFnameTmp(Res res, char *fname, int no);
  75
  76 struct dirs_info *dirs_open(Dict dict, const char *rep, int rw);
  77 struct dirs_info *dirs_fopen(Dict dict, const char *path, int rw);
  78 struct dirs_entry *dirs_read(struct dirs_info *p);
  79 struct dirs_entry *dirs_last(struct dirs_info *p);
  80 void dirs_mkdir(struct dirs_info *p, const char *src, time_t mtime);
  81 void dirs_rmdir(struct dirs_info *p, const char *src);
  82 void dirs_add(struct dirs_info *p, const char *src, zint sysno, time_t mtime);
  83 void dirs_del(struct dirs_info *p, const char *src);
  84 void dirs_free(struct dirs_info **pp);
  85
  86 struct dir_entry *dir_open(const char *rep, const char *base,
  87                            int follow_links);
  88 void dir_sort(struct dir_entry *e);
  89 void dir_free(struct dir_entry **e_p);
  90
  91 void repositoryUpdate(ZebraHandle zh, const char *path);
  92 void repositoryAdd(ZebraHandle zh, const char *path);
  93 void repositoryDelete(ZebraHandle zh, const char *path);
  94 void repositoryShow(ZebraHandle zh, const char *path);
  95
  96 void inv_prstat(ZebraHandle zh);
  97 void inv_compact(BFiles bfs);
  98 void key_input(ZebraHandle zh, int nkeys, int cache, Res res);
  99 ISAMS_M *key_isams_m(Res res, ISAMS_M *me);
 100 ISAMC_M *key_isamc_m(Res res, ISAMC_M *me);
 101
 102 #define FNAME_DICT "dict"
 103 #define FNAME_ISAM "isam"
 104 #define FNAME_ISAMC "isamc"
 105 #define FNAME_ISAMS "isams"
 106 #define FNAME_CONFIG "zebra.cfg"
 107
 108 #define GMATCH_DICT "gmatch"
 109 #define FMATCH_DICT "fmatch%d"
 110
 111 void zebra_lock_prefix(Res res, char *dst);
 112
 113 #define FNAME_MAIN_LOCK   "zebraidx.LCK"
 114 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
 115 #define FNAME_ORG_LOCK    "zebraorg.LCK"
 116 #define FNAME_TOUCH_TIME  "zebraidx.time"
 117
 118 typedef struct zebra_set *ZebraSet;
 119
 120 typedef struct zebra_rank_class {
 121     struct rank_control *control;
 122     int init_flag;
 123     void *class_handle;
 124     struct zebra_rank_class *next;
 125 } *ZebraRankClass;
 126
 127 #include "reckeys.h"
 128 #include "key_block.h"
 129
 130 struct zebra_register {
 131     char *name;
 132
 133     ISAMS isams;
 134     ISAMC isamc;
 135     ISAMB isamb;
 136     Dict dict;
 137     Dict matchDict;
 138     zebra_sort_index_t sort_index;
 139     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
 140     time_t registerChange;
 141     BFiles bfs;
 142     Records records;
 143     ZebraExplainInfo zei;
 144
 145     char *server_path_prefix;
 146     data1_handle dh;
 147     zebra_index_types_t index_types;
 148     zebra_maps_t zebra_maps;
 149     ZebraRankClass rank_classes;
 150     RecTypes recTypes;
 151     int seqno;
 152     int last_val;
 153     int stop_flag;
 154
 155     zebra_rec_keys_t keys;
 156     zebra_rec_keys_t sortKeys;
 157
 158     zebra_key_block_t key_block;
 159 };
 160
 161 struct zebra_service {
 162     int stop_flag;
 163     Res global_res;
 164     struct zebra_session *sessions;
 165     struct zebra_register *regs;
 166     Zebra_mutex_cond session_lock;
 167     Passwd_db passwd_db;
 168     Res dbaccess;
 169     const char *path_root;
 170     RecTypeClass record_classes;
 171     NMEM nmem;
 172     yaz_timing_t timing;
 173 };
 174
 175
 176 struct zebra_session {
 177     struct zebra_session *next;
 178     struct zebra_service *service;
 179     struct zebra_register *reg;
 180
 181     char *xadmin_databaseName;
 182
 183     char **basenames;
 184     int num_basenames;
 185     zint approx_limit;
 186     char *reg_name;
 187     char *path_reg;
 188
 189     ZebraLockHandle lock_normal;
 190     ZebraLockHandle lock_shadow;
 191
 192     int trans_no;
 193     int trans_w_no;
 194
 195     int destroyed;
 196     ZebraSet sets;
 197     Res res;
 198     Res session_res;
 199     char *user_perm;
 200     char *dbaccesslist;
 201     int errCode;
 202     char *errString;
 203     int partial_result;
 204 #if HAVE_SYS_TIMES_H
 205     struct tms tms1;
 206     struct tms tms2;
 207 #endif
 208     int  shadow_enable;
 209
 210     int m_staticrank;
 211     int m_segment_indexing;
 212
 213     zint records_inserted;
 214     zint records_updated;
 215     zint records_deleted;
 216     zint records_processed;
 217     zint records_skipped;
 218     char *record_encoding;
 219
 220     yaz_iconv_t iconv_to_utf8;
 221     yaz_iconv_t iconv_from_utf8;
 222
 223     int m_follow_links;
 224     const char *m_group;
 225     const char *m_record_id;
 226     const char *m_record_type;
 227     int m_store_data;
 228     int m_store_keys;
 229     int m_explain_database;
 230     int m_flag_rw;
 231     int m_file_verbose_limit;
 232
 233     void *store_data_buf;
 234     size_t store_data_size;
 235     NMEM nmem_error;
 236
 237     struct zebra_limit *m_limit;
 238
 239     int (*break_handler_func)(void *client_data);
 240     void *break_handler_data;
 241 };
 242
 243
 244 struct term_set_entry {
 245     char *term;
 246     struct term_set_entry *next;
 247 };
 248
 249 struct term_set_list {
 250     struct term_set_entry *first;
 251     struct term_set_entry *last;
 252 };
 253
 254
 255 void zebra_limit_destroy(struct zebra_limit *zl);
 256 struct zebra_limit *zebra_limit_create(int exclude_flag, zint *ids);
 257 void zebra_limit_for_rset(struct zebra_limit *zl,
 258                           int (**filter_func)(const void *buf, void *data),
 259                           void (**filter_destroy)(void *data),
 260                           void **filter_data);
 261
 262 struct rset_key_control *zebra_key_control_create(ZebraHandle zh);
 263
 264 ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs,
 265                          const Odr_oid *attributeSet,
 266                          NMEM stream, NMEM rset_nmem,
 267                          Z_SortKeySpecList *sort_sequence,
 268                          int num_bases, char **basenames,
 269                          RSET *result_set);
 270
 271 ZEBRA_RES rpn_get_top_approx_limit(ZebraHandle zh, Z_RPNStructure *zs,
 272                                    zint *approx_limit);
 273
 274 ZEBRA_RES rpn_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 275                    const Odr_oid *attributeset,
 276                    int num_bases, char **basenames,
 277                    int *position, int *num_entries, ZebraScanEntry **list,
 278                    int *is_partial, RSET limit_set);
 279
 280 RSET rset_trunc(ZebraHandle zh, ISAM_P *isam_p, int no,
 281                 const char *term, int length_term, const char *flags,
 282                 int preserve_position, int term_type, NMEM rset_nmem,
 283                 struct rset_key_control *kctrl, int scope,
 284                 struct ord_list *ol, const char *index_type,
 285                 zint hits_limit, const char *term_ref_id);
 286
 287 void resultSetAddTerm(ZebraHandle zh, ZebraSet s, int reg_type,
 288                       const char *db, const char *index_name,
 289                       const char *term);
 290 ZebraSet resultSetAdd(ZebraHandle zh, const char *name, int ov);
 291 ZebraSet resultSetGet(ZebraHandle zh, const char *name);
 292 ZEBRA_RES resultSetAddRPN(ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
 293                           int num_bases, char **basenames,
 294                           const char *setname,
 295                           zint *hits, int *estimated_hit_count);
 296 RSET resultSetRef(ZebraHandle zh, const char *resultSetId);
 297 void resultSetDestroy(ZebraHandle zh, int num_names, char **names,
 298                        int *statuses);
 299 ZEBRA_RES resultSetSort(ZebraHandle zh, NMEM nmem,
 300                          int num_input_setnames, const char **input_setnames,
 301                          const char *output_setname,
 302                          Z_SortKeySpecList *sort_sequence, int *sort_status);
 303 ZEBRA_RES resultSetSortSingle(ZebraHandle zh, NMEM nmem,
 304                                ZebraSet sset, RSET rset,
 305                                Z_SortKeySpecList *sort_sequence,
 306                                int *sort_status);
 307 ZEBRA_RES resultSetRank(ZebraHandle zh, ZebraSet zebraSet, RSET rset,
 308                          NMEM nmem);
 309 void resultSetInvalidate(ZebraHandle zh);
 310
 311 int zebra_record_fetch(ZebraHandle zh, const char *setname,
 312                        zint sysno, int score,
 313                        zebra_snippets *hit_snippet, ODR stream,
 314                        const Odr_oid *input_format, Z_RecordComposition *comp,
 315                        const Odr_oid **output_format, char **rec_bufp,
 316                        int *rec_lenp, char **basenamep,
 317                        char **addinfo);
 318
 319 void extract_get_fname_tmp(ZebraHandle zh, char *fname, int no);
 320
 321 void extract_snippet(ZebraHandle zh, zebra_snippets *sn,
 322                      struct ZebraRecStream *stream, RecType rt,
 323                      void *recTypeClientData);
 324
 325 int zebra_get_rec_snippets(ZebraHandle zh, zint sysno,
 326                            zebra_snippets *snippets);
 327
 328 void zebra_index_merge(ZebraHandle zh);
 329
 330 ZEBRA_RES zebra_buffer_extract_record(ZebraHandle zh,
 331                                       const char *buf, size_t buf_size,
 332                                       enum zebra_recctrl_action_t action,
 333                                       int test_mode,
 334                                       const char *recordType,
 335                                       zint *sysno,
 336                                       const char *match_criteria,
 337                                       const char *fname);
 338
 339 ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
 340                                       struct ZebraRecStream *stream,
 341                                       enum zebra_recctrl_action_t action,
 342                                       int test_mode,
 343                                       const char *recordType,
 344                                       zint *sysno,
 345                                       const char *match_criteria,
 346                                       const char *fname,
 347                                       RecType recType,
 348                                       void *recTypeClientData,
 349                                       int *more);
 350
 351 YAZ_EXPORT void zebra_create_stream_mem(struct ZebraRecStream *stream,
 352                                         const char *buf, size_t sz);
 353 YAZ_EXPORT void zebra_create_stream_fd(struct ZebraRecStream *stream,
 354                                        int fd, off_t start_offset);
 355 void print_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys);
 356
 357 ZEBRA_RES zebra_rec_keys_to_snippets(ZebraHandle zh, zebra_rec_keys_t reckeys,
 358                                      zebra_snippets *snippets);
 359 ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
 360                                     zint sysno, zebra_snippets *snippets);
 361
 362 ZEBRA_RES zebra_extract_explain(void *handle, Record rec, data1_node *n);
 363
 364 ZEBRA_RES zebra_extract_file(ZebraHandle zh, zint *sysno, const char *fname,
 365                              int deleteFlag);
 366
 367 ZEBRA_RES zebra_begin_read(ZebraHandle zh);
 368 ZEBRA_RES zebra_end_read(ZebraHandle zh);
 369
 370 int zebra_file_stat(const char *file_name, struct stat *buf,
 371                      int follow_links);
 372
 373 Dict dict_open_res(BFiles bfs, const char *name, int cache, int rw,
 374                    int compact_flag, Res res);
 375
 376 void zebra_setError(ZebraHandle zh, int code, const char *addinfo);
 377 void zebra_setError_zint(ZebraHandle zh, int code, zint i);
 378
 379 void zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream, int reg_type,
 380                               char **dst, const char *src);
 381
 382 ZEBRA_RES zebra_get_hit_vector(ZebraHandle zh, const char *setname, zint sysno);
 383
 384 void zebra_term_untrans(ZebraHandle zh, int reg_type,
 385                         char *dst, const char *src);
 386
 387 ZEBRA_RES zebra_apt_get_ord(ZebraHandle zh,
 388                             Z_AttributesPlusTerm *zapt,
 389                             const char *index_type,
 390                             const char *xpath_use,
 391                             const Odr_oid *curAttributeSet,
 392                             int *ord);
 393
 394 ZEBRA_RES zebra_attr_list_get_ord(ZebraHandle zh,
 395                                   Z_AttributeList *attr_list,
 396                                   zinfo_index_category_t cat,
 397                                   const char *index_type,
 398                                   const Odr_oid *curAttributeSet,
 399                                   int *ord);
 400
 401 ZEBRA_RES zebra_sort_get_ord(ZebraHandle zh,
 402                              Z_SortAttributes *sortAttributes,
 403                              int *ord,
 404                              int *numerical);
 405
 406 ZEBRA_RES zebra_update_file_match(ZebraHandle zh, const char *path);
 407 ZEBRA_RES zebra_update_from_path(ZebraHandle zh, const char *path);
 408 ZEBRA_RES zebra_delete_from_path(ZebraHandle zh, const char *path);
 409 ZEBRA_RES zebra_remove_file_match(ZebraHandle zh);
 410
 411 struct rpn_char_map_info
 412 {
 413     zebra_map_t zm;
 414     int reg_type;
 415 };
 416
 417 void rpn_char_map_prepare(struct zebra_register *reg, zebra_map_t zm,
 418                           struct rpn_char_map_info *map_info);
 419
 420 ZEBRA_RES zapt_term_to_utf8(ZebraHandle zh, Z_AttributesPlusTerm *zapt,
 421                             char *termz);
 422
 423
 424 void zebra_set_partial_result(ZebraHandle zh);
 425
 426 int zebra_check_res(Res res);
 427
 428 #define FIRST_IN_FIELD_STR "\001^"
 429 #define FIRST_IN_FIELD_CHAR 1
 430 #define FIRST_IN_FIELD_LEN 2
 431
 432 YAZ_END_CDECL
 433
 434 #endif
 435 /*
 436  * Local variables:
 437  * c-basic-offset: 4
 438  * indent-tabs-mode: nil
 439  * End:
 440  * vim: shiftwidth=4 tabstop=8 expandtab
 441  */
 442