index/index.h

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