index/index.h

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