index/index.h

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