index/index.h

   1 /* $Id: index.h,v 1.143 2005-06-09 10:39:53 adam 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 4
  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 struct sortKeys {
 203     int buf_used;
 204     int buf_max;
 205     char *buf;
 206 };
 207
 208 struct zebra_register {
 209     char *name;
 210
 211     ISAMS isams;
 212     ISAMC isamc;
 213     ISAMB isamb;
 214     Dict dict;
 215     Dict matchDict;
 216     SortIdx sortIdx;
 217     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
 218     time_t registerChange;
 219     BFiles bfs;
 220     Records records;
 221     ZebraExplainInfo zei;
 222
 223     char *server_path_prefix;
 224     data1_handle dh;
 225     ZebraMaps zebra_maps;
 226     ZebraRankClass rank_classes;
 227     RecTypes recTypes;
 228     int seqno;
 229     int last_val;
 230     int stop_flag;
 231     int active; /* 0=shutdown, 1=enabled and inactive, 2=activated */
 232
 233     struct recKeys keys;
 234 #if 1
 235     struct sortKeys sortKeys;
 236 #else
 237     struct sortKey *sortKeys;
 238 #endif
 239     char **key_buf;
 240     size_t ptr_top;
 241     size_t ptr_i;
 242     size_t key_buf_used;
 243     int key_file_no;
 244 };
 245
 246 struct zebra_service {
 247     int stop_flag;
 248     Res global_res;
 249     char *configName;
 250     struct zebra_session *sessions;
 251     struct zebra_register *regs;
 252     Zebra_mutex_cond session_lock;
 253     Passwd_db passwd_db;
 254     const char *path_root;
 255     RecTypeClass record_classes;
 256     NMEM nmem;
 257 };
 258
 259
 260 struct zebra_session {
 261     struct zebra_session *next;
 262     struct zebra_service *service;
 263     struct zebra_register *reg;
 264
 265     char *xadmin_databaseName;
 266
 267     char **basenames;
 268     int num_basenames;
 269     zint approx_limit;
 270     char *reg_name;
 271     char *path_reg;
 272
 273     ZebraLockHandle lock_normal;
 274     ZebraLockHandle lock_shadow;
 275
 276     int trans_no;
 277     int trans_w_no;
 278
 279     int destroyed;
 280     ZebraSet sets;
 281     Res res;
 282     char *user_perm;
 283     int errCode;
 284     zint hits;
 285     char *errString;
 286 #if HAVE_SYS_TIMES_H
 287     struct tms tms1;
 288     struct tms tms2;
 289 #endif
 290     int  shadow_enable;
 291
 292     zint records_inserted;
 293     zint records_updated;
 294     zint records_deleted;
 295     zint records_processed;
 296     char *record_encoding;
 297
 298     yaz_iconv_t iconv_to_utf8;
 299     yaz_iconv_t iconv_from_utf8;
 300
 301     int m_follow_links;
 302     const char *m_group;
 303     const char *m_record_id;
 304     const char *m_record_type;
 305     int m_store_data;
 306     int m_store_keys;
 307     int m_explain_database;
 308     int m_flag_rw;
 309     int m_file_verbose_limit;
 310
 311     void *store_data_buf;
 312     size_t store_data_size;
 313     NMEM nmem_error;
 314
 315     struct zebra_limit *m_limit;
 316 };
 317
 318 struct rank_control {
 319     char *name;
 320     void *(*create)(ZebraHandle zh);
 321     void (*destroy)(struct zebra_register *reg, void *class_handle);
 322     void *(*begin)(struct zebra_register *reg,
 323                    void *class_handle, RSET rset, NMEM nmem,
 324                    TERMID *terms, int numterms);
 325     /* ### Could add parameters to begin:
 326      *  char *index;    // author, title, etc.
 327      *  int dbsize;     // number of records in database
 328      *  int rssize;     // number of records in result set (estimate?)
 329      */
 330     void (*end)(struct zebra_register *reg, void *set_handle);
 331     int (*calc)(void *set_handle, zint sysno);
 332     void (*add)(void *set_handle, int seqno, TERMID term);
 333 };
 334
 335 struct term_set_entry {
 336     char *term;
 337     struct term_set_entry *next;
 338 };
 339
 340 struct term_set_list {
 341     struct term_set_entry *first;
 342     struct term_set_entry *last;
 343 };
 344
 345
 346 void zebra_limit_destroy(struct zebra_limit *zl);
 347 struct zebra_limit *zebra_limit_create(int exclude_flag, zint *ids);
 348 void zebra_limit_for_rset(struct zebra_limit *zl,
 349                           int (**filter_func)(const void *buf, void *data),
 350                           void (**filter_destroy)(void *data),
 351                           void **filter_data);
 352
 353 struct rset_key_control *zebra_key_control_create(ZebraHandle zh);
 354
 355 ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs,
 356                          oid_value attributeSet,
 357                          NMEM stream, NMEM rset_nmem,
 358                          Z_SortKeySpecList *sort_sequence,
 359                          int num_bases, char **basenames,
 360                          RSET *result_set);
 361
 362 ZEBRA_RES rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 363                     oid_value attributeset,
 364                     int num_bases, char **basenames,
 365                     int *position, int *num_entries, ZebraScanEntry **list,
 366                     int *is_partial, RSET limit_set, int return_zero);
 367
 368 RSET rset_trunc(ZebraHandle zh, ISAM_P *isam_p, int no,
 369                 const char *term, int length_term, const char *flags,
 370                 int preserve_position, int term_type, NMEM rset_nmem,
 371                 struct rset_key_control *kctrl, int scope,
 372                 struct ord_list *ol, int reg_type);
 373
 374 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
 375                        const char *db, int set,
 376                        int use, const char *term);
 377 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
 378 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
 379 ZEBRA_RES resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
 380                      int num_bases, char **basenames,
 381                      const char *setname);
 382 RSET resultSetRef (ZebraHandle zh, const char *resultSetId);
 383 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
 384                        int *statuses);
 385 ZEBRA_RES resultSetSort (ZebraHandle zh, NMEM nmem,
 386                          int num_input_setnames, const char **input_setnames,
 387                          const char *output_setname,
 388                          Z_SortKeySpecList *sort_sequence, int *sort_status);
 389 ZEBRA_RES resultSetSortSingle (ZebraHandle zh, NMEM nmem,
 390                                ZebraSet sset, RSET rset,
 391                                Z_SortKeySpecList *sort_sequence,
 392                                int *sort_status);
 393 ZEBRA_RES resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset,
 394                          NMEM nmem);
 395 void resultSetInvalidate (ZebraHandle zh);
 396
 397 int zebra_server_lock_init (ZebraService zh);
 398 int zebra_server_lock_destroy (ZebraService zh);
 399 int zebra_server_lock (ZebraService zh, int lockCommit);
 400 void zebra_server_unlock (ZebraService zh, int commitPhase);
 401 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
 402
 403 typedef struct attent
 404 {
 405     int attset_ordinal;
 406     data1_local_attribute *local_attributes;
 407 } attent;
 408
 409 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl);
 410 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name);
 411 void zebraRankDestroy (struct zebra_register *reg);
 412
 413 int att_getentbyatt(ZebraHandle zh, attent *res, oid_value set, int att,
 414                 const char *sattr);
 415
 416 extern struct rank_control *rank1_class;
 417 extern struct rank_control *rankzv_class;
 418 extern struct rank_control *rankliv_class;
 419
 420 int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score,
 421                         zebra_snippets *hit_snippet, ODR stream,
 422                         oid_value input_format, Z_RecordComposition *comp,
 423                         oid_value *output_format, char **rec_bufp,
 424                         int *rec_lenp, char **basenamep,
 425                         char **addinfo);
 426
 427 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
 428
 429 void zebra_index_merge (ZebraHandle zh);
 430
 431 ZEBRA_RES buffer_extract_record (ZebraHandle zh,
 432                                  const char *buf, size_t buf_size,
 433                                  int delete_flag,
 434                                  int test_mode,
 435                                  const char *recordType,
 436                                  SYSNO *sysno,
 437                                  const char *match_criteria,
 438                                  const char *fname,
 439                                  int force_update,
 440                                  int allow_update);
 441
 442 #if 0
 443 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
 444                         const char *buf, size_t buf_size,
 445                         const char *databaseName, int delete_flag,
 446                         int test_mode, int *sysno,
 447                         int store_keys, int store_data,
 448                         const char *match_criteria);
 449 #endif
 450 void extract_flushWriteKeys (ZebraHandle zh, int final);
 451
 452 struct zebra_fetch_control {
 453     off_t offset_end;
 454     off_t record_offset;
 455     off_t record_int_pos;
 456     const char *record_int_buf;
 457     int record_int_len;
 458     int fd;
 459 };
 460
 461 int zebra_record_ext_read (void *fh, char *buf, size_t count);
 462 off_t zebra_record_ext_seek (void *fh, off_t offset);
 463 off_t zebra_record_ext_tell (void *fh);
 464 off_t zebra_record_int_seek (void *fh, off_t offset);
 465 off_t zebra_record_int_tell (void *fh);
 466 int zebra_record_int_read (void *fh, char *buf, size_t count);
 467 void zebra_record_int_end (void *fh, off_t offset);
 468
 469 void print_rec_keys(ZebraHandle zh, struct recKeys *reckeys);
 470 ZEBRA_RES zebra_snippets_rec_keys(ZebraHandle zh, struct recKeys *reckeys,
 471                                   zebra_snippets *snippets);
 472 ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
 473                                     zint sysno, zebra_snippets *snippets);
 474
 475 void extract_flushRecordKeys (ZebraHandle zh, SYSNO sysno,
 476                               int cmd, struct recKeys *reckeys);
 477 void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
 478                             int cmd, struct sortKeys *skp);
 479 void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
 480 void extract_token_add (RecWord *p);
 481 int explain_extract (void *handle, Record rec, data1_node *n);
 482
 483 int fileExtract (ZebraHandle zh, SYSNO *sysno, const char *fname,
 484                  int deleteFlag);
 485
 486 ZEBRA_RES zebra_begin_read (ZebraHandle zh);
 487 ZEBRA_RES zebra_end_read (ZebraHandle zh);
 488
 489 int zebra_file_stat (const char *file_name, struct stat *buf,
 490                      int follow_links);
 491
 492 void zebra_livcode_transform(ZebraHandle zh, Z_RPNQuery *query);
 493
 494 void *iscz1_start ();
 495 void iscz1_reset (void *vp);
 496 void iscz1_stop (void *p);
 497 void iscz1_decode (void *vp, char **dst, const char **src);
 498 void iscz1_encode (void *vp, char **dst, const char **src);
 499
 500 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
 501                     int compact_flag, Res res);
 502
 503 void zebra_setError(ZebraHandle zh, int code, const char *addinfo);
 504 void zebra_setError_zint(ZebraHandle zh, int code, zint i);
 505
 506 void zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream, int reg_type,
 507                               char **dst, const char *src);
 508
 509 ZEBRA_RES zebra_get_hit_vector(ZebraHandle zh, const char *setname, zint sysno);
 510
 511 YAZ_END_CDECL
 512
 513 #endif