index/index.h

   1 /* $Id: index.h,v 1.152 2005-10-20 18:28:10 quinn Exp $
   2    Copyright (C) 1995-2005
   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 Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23 #ifndef INDEX_H
  24 #define INDEX_H
  25
  26 #include <time.h>
  27 #include <stdlib.h>
  28 #include <idzebra/version.h>
  29 #include <idzebra/util.h>
  30 #include <sortidx.h>
  31
  32 #if HAVE_SYS_TIMES_H
  33 #include <sys/times.h>
  34 #endif
  35 #include <sys/stat.h>
  36
  37 #include <idzebra/dict.h>
  38 #include <idzebra/isams.h>
  39 #include <idzebra/isamc.h>
  40 #include <idzebra/isamb.h>
  41 #include <d1_absyn.h>
  42 #include <idzebra/recgrs.h>
  43 #include "recindex.h"
  44 #include <idzebra/api.h>
  45 #include "zinfo.h"
  46 #include <passwddb.h>
  47 #include <rset.h>
  48
  49 YAZ_BEGIN_CDECL
  50
  51 #define ISAM_DEFAULT "b"
  52
  53 #define SU_SCHEME 1
  54
  55 #define IT_MAX_WORD 256
  56
  57 #define IT_KEY_LEVEL_MAX 5
  58 struct it_key {
  59     int  len;
  60     zint mem[IT_KEY_LEVEL_MAX];
  61 };
  62
  63 enum dirsKind { dirs_dir, dirs_file };
  64
  65 struct dir_entry {
  66     enum dirsKind kind;
  67     char *name;
  68     time_t mtime;
  69 };
  70
  71 struct dirs_entry {
  72     enum dirsKind kind;
  73     char path[256];
  74     SYSNO sysno;
  75     time_t mtime;
  76 };
  77
  78 void getFnameTmp (Res res, char *fname, int no);
  79
  80 struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
  81 struct dirs_info *dirs_fopen (Dict dict, const char *path, int rw);
  82 struct dirs_entry *dirs_read (struct dirs_info *p);
  83 struct dirs_entry *dirs_last (struct dirs_info *p);
  84 void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
  85 void dirs_rmdir (struct dirs_info *p, const char *src);
  86 void dirs_add (struct dirs_info *p, const char *src, SYSNO sysno, time_t mtime);
  87 void dirs_del (struct dirs_info *p, const char *src);
  88 void dirs_free (struct dirs_info **pp);
  89
  90 struct dir_entry *dir_open (const char *rep, const char *base,
  91                             int follow_links);
  92 void dir_sort (struct dir_entry *e);
  93 void dir_free (struct dir_entry **e_p);
  94
  95 void repositoryUpdate (ZebraHandle zh, const char *path);
  96 void repositoryAdd (ZebraHandle zh, const char *path);
  97 void repositoryDelete (ZebraHandle zh, const char *path);
  98 void repositoryShow (ZebraHandle zh, const char *path);
  99
 100 int key_open (ZebraHandle zh, int mem);
 101 int key_close (ZebraHandle zh);
 102 int key_compare (const void *p1, const void *p2);
 103 void key_init(struct it_key *k);
 104 char *key_print_it (const void *p, char *buf);
 105 zint key_get_seq (const void *p);
 106 int key_compare_it (const void *p1, const void *p2);
 107 int key_qsort_compare (const void *p1, const void *p2);
 108 void key_logdump (int mask, const void *p);
 109 void key_logdump_txt (int logmask, const void *p, const char *txt);
 110 void inv_prstat (ZebraHandle zh);
 111 void inv_compact (BFiles bfs);
 112 void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
 113 ISAMS_M *key_isams_m (Res res, ISAMS_M *me);
 114 ISAMC_M *key_isamc_m (Res res, ISAMC_M *me);
 115 int merge_sort (char **buf, int from, int to);
 116 int key_SU_code (int ch, char *out);
 117
 118 #define FNAME_DICT "dict"
 119 #define FNAME_ISAM "isam"
 120 #define FNAME_ISAMC "isamc"
 121 #define FNAME_ISAMS "isams"
 122 #define FNAME_ISAMH "isamh"
 123 #define FNAME_ISAMD "isamd"
 124 #define FNAME_CONFIG "zebra.cfg"
 125
 126 #define GMATCH_DICT "gmatch"
 127 #define FMATCH_DICT "fmatch"
 128
 129 struct strtab *strtab_mk (void);
 130 int strtab_src (struct strtab *t, const char *name, void ***infop);
 131 void strtab_del (struct strtab *t,
 132                  void (*func)(const char *name, void *info, void *data),
 133                  void *data);
 134 int index_char_cvt (int c);
 135 int index_word_prefix (char *string, int attset_ordinal,
 136                        int local_attribute, const char *databaseName);
 137
 138
 139 void zebraIndexLockMsg (ZebraHandle zh, const char *str);
 140 void zebraIndexUnlock (ZebraHandle zh);
 141 int zebraIndexLock (BFiles bfs, ZebraHandle zh, int commitNow, const char *rval);
 142 int zebraIndexWait (ZebraHandle zh, int commitPhase);
 143
 144 #define FNAME_MAIN_LOCK   "zebraidx.LCK"
 145 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
 146 #define FNAME_ORG_LOCK    "zebraorg.LCK"
 147 #define FNAME_TOUCH_TIME  "zebraidx.time"
 148
 149 typedef struct zebra_lock_info *ZebraLockHandle;
 150 ZebraLockHandle zebra_lock_create(const char *dir,
 151                                   const char *file, int excl_flag);
 152 void zebra_lock_destroy (ZebraLockHandle h);
 153 int zebra_lock (ZebraLockHandle h);
 154 int zebra_lock_nb (ZebraLockHandle h);
 155 int zebra_unlock (ZebraLockHandle h);
 156 int zebra_lock_fd (ZebraLockHandle h);
 157 void zebra_lock_prefix (Res res, char *dst);
 158 char *zebra_mk_fname (const char *dir, const char *name);
 159
 160 int zebra_lock_w (ZebraLockHandle h);
 161 int zebra_lock_r (ZebraLockHandle h);
 162
 163 void zebra_load_atts (data1_handle dh, Res res);
 164
 165 int key_SU_decode (int *ch, const unsigned char *out);
 166 int key_SU_encode (int ch, char *out);
 167
 168 #define ENCODE_BUFLEN 768
 169 struct encode_info {
 170     int  sysno;  /* previously written values for delta-compress */
 171     int  seqno;
 172     int  cmd;
 173     int prevsys; /* buffer for skipping insert/delete pairs */
 174     int prevseq;
 175     int prevcmd;
 176     int keylen; /* tells if we have an unwritten key in buf, and how long*/
 177     void *encode_handle;
 178     char buf[ENCODE_BUFLEN];
 179 };
 180
 181 void encode_key_init (struct encode_info *i);
 182 char *encode_key_int (int d, char *bp);
 183 void encode_key_write (char *k, struct encode_info *i, FILE *outf);
 184 void encode_key_flush (struct encode_info *i, FILE *outf);
 185
 186 typedef struct zebra_set *ZebraSet;
 187
 188 typedef struct zebra_rank_class {
 189     struct rank_control *control;
 190     int init_flag;
 191     void *class_handle;
 192     struct zebra_rank_class *next;
 193 } *ZebraRankClass;
 194
 195 struct recKeys {
 196     int buf_used;
 197     int buf_max;
 198     char *buf;
 199     void *codec_handle;
 200 };
 201
 202 #if NATTR
 203
 204 #else
 205 struct sortKeys {
 206     int buf_used;
 207     int buf_max;
 208     char *buf;
 209 };
 210 #endif
 211
 212 struct zebra_register {
 213     char *name;
 214
 215     ISAMS isams;
 216     ISAMC isamc;
 217     ISAMB isamb;
 218     Dict dict;
 219     Dict matchDict;
 220     SortIdx sortIdx;
 221     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
 222     time_t registerChange;
 223     BFiles bfs;
 224     Records records;
 225     ZebraExplainInfo zei;
 226
 227     char *server_path_prefix;
 228     data1_handle dh;
 229     ZebraMaps zebra_maps;
 230     ZebraRankClass rank_classes;
 231     RecTypes recTypes;
 232     int seqno;
 233     int last_val;
 234     int stop_flag;
 235     int active; /* 0=shutdown, 1=enabled and inactive, 2=activated */
 236
 237     struct recKeys keys;
 238 #if NATTR
 239     struct recKeys sortKeys;
 240 #else
 241     struct sortKeys sortKeys;
 242 #endif
 243     char **key_buf;
 244     size_t ptr_top;
 245     size_t ptr_i;
 246     size_t key_buf_used;
 247     int key_file_no;
 248 };
 249
 250 struct zebra_service {
 251     int stop_flag;
 252     Res global_res;
 253     struct zebra_session *sessions;
 254     struct zebra_register *regs;
 255     Zebra_mutex_cond session_lock;
 256     Passwd_db passwd_db;
 257     Res dbaccess;
 258     const char *path_root;
 259     RecTypeClass record_classes;
 260     NMEM nmem;
 261 };
 262
 263
 264 struct zebra_session {
 265     struct zebra_session *next;
 266     struct zebra_service *service;
 267     struct zebra_register *reg;
 268
 269     char *xadmin_databaseName;
 270
 271     char **basenames;
 272     int num_basenames;
 273     zint approx_limit;
 274     char *reg_name;
 275     char *path_reg;
 276
 277     ZebraLockHandle lock_normal;
 278     ZebraLockHandle lock_shadow;
 279
 280     int trans_no;
 281     int trans_w_no;
 282
 283     int destroyed;
 284     ZebraSet sets;
 285     Res res;
 286     Res session_res;
 287     char *user_perm;
 288     char *dbaccesslist;
 289     int errCode;
 290     zint hits;
 291     char *errString;
 292 #if HAVE_SYS_TIMES_H
 293     struct tms tms1;
 294     struct tms tms2;
 295 #endif
 296     int  shadow_enable;
 297
 298     int m_staticrank;
 299
 300     zint records_inserted;
 301     zint records_updated;
 302     zint records_deleted;
 303     zint records_processed;
 304     char *record_encoding;
 305
 306     yaz_iconv_t iconv_to_utf8;
 307     yaz_iconv_t iconv_from_utf8;
 308
 309     int m_follow_links;
 310     const char *m_group;
 311     const char *m_record_id;
 312     const char *m_record_type;
 313     int m_store_data;
 314     int m_store_keys;
 315     int m_explain_database;
 316     int m_flag_rw;
 317     int m_file_verbose_limit;
 318
 319     void *store_data_buf;
 320     size_t store_data_size;
 321     NMEM nmem_error;
 322
 323     struct zebra_limit *m_limit;
 324 };
 325
 326 struct rank_control {
 327     char *name;
 328     void *(*create)(ZebraHandle zh);
 329     void (*destroy)(struct zebra_register *reg, void *class_handle);
 330     void *(*begin)(struct zebra_register *reg,
 331                    void *class_handle, RSET rset, NMEM nmem,
 332                    TERMID *terms, int numterms);
 333     /* ### Could add parameters to begin:
 334      *  char *index;    // author, title, etc.
 335      *  int dbsize;     // number of records in database
 336      *  int rssize;     // number of records in result set (estimate?)
 337      */
 338     void (*end)(struct zebra_register *reg, void *set_handle);
 339     int (*calc)(void *set_handle, zint sysno, zint staticrank,
 340                 int *stop_flag);
 341     void (*add)(void *set_handle, int seqno, TERMID term);
 342 };
 343
 344 struct term_set_entry {
 345     char *term;
 346     struct term_set_entry *next;
 347 };
 348
 349 struct term_set_list {
 350     struct term_set_entry *first;
 351     struct term_set_entry *last;
 352 };
 353
 354
 355 void zebra_limit_destroy(struct zebra_limit *zl);
 356 struct zebra_limit *zebra_limit_create(int exclude_flag, zint *ids);
 357 void zebra_limit_for_rset(struct zebra_limit *zl,
 358                           int (**filter_func)(const void *buf, void *data),
 359                           void (**filter_destroy)(void *data),
 360                           void **filter_data);
 361
 362 struct rset_key_control *zebra_key_control_create(ZebraHandle zh);
 363
 364 ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs,
 365                          oid_value attributeSet,
 366                          NMEM stream, NMEM rset_nmem,
 367                          Z_SortKeySpecList *sort_sequence,
 368                          int num_bases, char **basenames,
 369                          RSET *result_set);
 370
 371 ZEBRA_RES rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 372                     oid_value attributeset,
 373                     int num_bases, char **basenames,
 374                     int *position, int *num_entries, ZebraScanEntry **list,
 375                     int *is_partial, RSET limit_set, int return_zero);
 376
 377 RSET rset_trunc(ZebraHandle zh, ISAM_P *isam_p, int no,
 378                 const char *term, int length_term, const char *flags,
 379                 int preserve_position, int term_type, NMEM rset_nmem,
 380                 struct rset_key_control *kctrl, int scope,
 381                 struct ord_list *ol, int reg_type,
 382                 zint hits_limit, const char *term_ref_id);
 383
 384 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
 385                        const char *db, int set,
 386                        int use, const char *term);
 387 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
 388 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
 389 ZEBRA_RES resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
 390                      int num_bases, char **basenames,
 391                      const char *setname);
 392 RSET resultSetRef (ZebraHandle zh, const char *resultSetId);
 393 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
 394                        int *statuses);
 395 ZEBRA_RES resultSetSort (ZebraHandle zh, NMEM nmem,
 396                          int num_input_setnames, const char **input_setnames,
 397                          const char *output_setname,
 398                          Z_SortKeySpecList *sort_sequence, int *sort_status);
 399 ZEBRA_RES resultSetSortSingle (ZebraHandle zh, NMEM nmem,
 400                                ZebraSet sset, RSET rset,
 401                                Z_SortKeySpecList *sort_sequence,
 402                                int *sort_status);
 403 ZEBRA_RES resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset,
 404                          NMEM nmem);
 405 void resultSetInvalidate (ZebraHandle zh);
 406
 407 int zebra_server_lock_init (ZebraService zh);
 408 int zebra_server_lock_destroy (ZebraService zh);
 409 int zebra_server_lock (ZebraService zh, int lockCommit);
 410 void zebra_server_unlock (ZebraService zh, int commitPhase);
 411 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
 412
 413 typedef struct attent
 414 {
 415     int attset_ordinal;
 416     data1_local_attribute *local_attributes;
 417 } attent;
 418
 419 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl);
 420 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
 421 void zebraRankDestroy (struct zebra_register *reg);
 422
 423 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att,
 424                 const char *sattr);
 425
 426 extern struct rank_control *rank_1_class;
 427 extern struct rank_control *rank_zv_class;
 428 extern struct rank_control *rank_static_class;
 429
 430 int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score,
 431                         zebra_snippets *hit_snippet, ODR stream,
 432                         oid_value input_format, Z_RecordComposition *comp,
 433                         oid_value *output_format, char **rec_bufp,
 434                         int *rec_lenp, char **basenamep,
 435                         char **addinfo);
 436
 437 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
 438
 439 void zebra_index_merge (ZebraHandle zh);
 440
 441 ZEBRA_RES buffer_extract_record (ZebraHandle zh,
 442                                  const char *buf, size_t buf_size,
 443                                  int delete_flag,
 444                                  int test_mode,
 445                                  const char *recordType,
 446                                  SYSNO *sysno,
 447                                  const char *match_criteria,
 448                                  const char *fname,
 449                                  int force_update,
 450                                  int allow_update);
 451
 452 #if 0
 453 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
 454                         const char *buf, size_t buf_size,
 455                         const char *databaseName, int delete_flag,
 456                         int test_mode, int *sysno,
 457                         int store_keys, int store_data,
 458                         const char *match_criteria);
 459 #endif
 460 void extract_flushWriteKeys (ZebraHandle zh, int final);
 461
 462 struct zebra_fetch_control {
 463     off_t offset_end;
 464     off_t record_offset;
 465     off_t record_int_pos;
 466     const char *record_int_buf;
 467     int record_int_len;
 468     int fd;
 469 };
 470
 471 int zebra_record_ext_read (void *fh, char *buf, size_t count);
 472 off_t zebra_record_ext_seek (void *fh, off_t offset);
 473 off_t zebra_record_ext_tell (void *fh);
 474 off_t zebra_record_int_seek (void *fh, off_t offset);
 475 off_t zebra_record_int_tell (void *fh);
 476 int zebra_record_int_read (void *fh, char *buf, size_t count);
 477 void zebra_record_int_end (void *fh, off_t offset);
 478
 479 void print_rec_keys(ZebraHandle zh, struct recKeys *reckeys);
 480 ZEBRA_RES zebra_snippets_rec_keys(ZebraHandle zh, struct recKeys *reckeys,
 481                                   zebra_snippets *snippets);
 482 ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
 483                                     zint sysno, zebra_snippets *snippets);
 484
 485 void extract_flushRecordKeys (ZebraHandle zh, SYSNO sysno,
 486                               int cmd, struct recKeys *reckeys,
 487                               zint staticrank);
 488 #if NATTR
 489 void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
 490                             int cmd, struct recKeys *skp);
 491 #else
 492 void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
 493                             int cmd, struct sortKeys *skp);
 494 #endif
 495 void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
 496 void extract_token_add (RecWord *p);
 497 int explain_extract (void *handle, Record rec, data1_node *n);
 498
 499 int fileExtract (ZebraHandle zh, SYSNO *sysno, const char *fname,
 500                  int deleteFlag);
 501
 502 ZEBRA_RES zebra_begin_read (ZebraHandle zh);
 503 ZEBRA_RES zebra_end_read (ZebraHandle zh);
 504
 505 int zebra_file_stat (const char *file_name, struct stat *buf,
 506                      int follow_links);
 507
 508 void zebra_livcode_transform(ZebraHandle zh, Z_RPNQuery *query);
 509
 510 void *iscz1_start ();
 511 void iscz1_reset (void *vp);
 512 void iscz1_stop (void *p);
 513 void iscz1_decode (void *vp, char **dst, const char **src);
 514 void iscz1_encode (void *vp, char **dst, const char **src);
 515
 516 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
 517                     int compact_flag, Res res);
 518
 519 void zebra_setError(ZebraHandle zh, int code, const char *addinfo);
 520 void zebra_setError_zint(ZebraHandle zh, int code, zint i);
 521
 522 void zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream, int reg_type,
 523                               char **dst, const char *src);
 524
 525 ZEBRA_RES zebra_get_hit_vector(ZebraHandle zh, const char *setname, zint sysno);
 526
 527 void zebra_term_untrans(ZebraHandle zh, int reg_type,
 528                         char *dst, const char *src);
 529
 530 YAZ_END_CDECL
 531
 532 #endif