index/index.h

   1 /* $Id: index.h,v 1.165 2006-05-30 13:21:14 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
 136 void zebraIndexLockMsg (ZebraHandle zh, const char *str);
 137 void zebraIndexUnlock (ZebraHandle zh);
 138 int zebraIndexLock (BFiles bfs, ZebraHandle zh, int commitNow, const char *rval);
 139 int zebraIndexWait (ZebraHandle zh, int commitPhase);
 140
 141 void zebra_lock_prefix (Res res, char *dst);
 142
 143 #define FNAME_MAIN_LOCK   "zebraidx.LCK"
 144 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
 145 #define FNAME_ORG_LOCK    "zebraorg.LCK"
 146 #define FNAME_TOUCH_TIME  "zebraidx.time"
 147
 148 int key_SU_decode (int *ch, const unsigned char *out);
 149 int key_SU_encode (int ch, char *out);
 150
 151 #define ENCODE_BUFLEN 768
 152 struct encode_info {
 153     int  sysno;  /* previously written values for delta-compress */
 154     int  seqno;
 155     int  cmd;
 156     int prevsys; /* buffer for skipping insert/delete pairs */
 157     int prevseq;
 158     int prevcmd;
 159     int keylen; /* tells if we have an unwritten key in buf, and how long*/
 160     void *encode_handle;
 161     void *decode_handle;
 162     char buf[ENCODE_BUFLEN];
 163 };
 164
 165 void encode_key_init (struct encode_info *i);
 166 char *encode_key_int (int d, char *bp);
 167 void encode_key_write (char *k, struct encode_info *i, FILE *outf);
 168 void encode_key_flush (struct encode_info *i, FILE *outf);
 169
 170 typedef struct zebra_set *ZebraSet;
 171
 172 typedef struct zebra_rank_class {
 173     struct rank_control *control;
 174     int init_flag;
 175     void *class_handle;
 176     struct zebra_rank_class *next;
 177 } *ZebraRankClass;
 178
 179 #include "reckeys.h"
 180
 181 struct zebra_register {
 182     char *name;
 183
 184     ISAMS isams;
 185     ISAMC isamc;
 186     ISAMB isamb;
 187     Dict dict;
 188     Dict matchDict;
 189     SortIdx sortIdx;
 190     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
 191     time_t registerChange;
 192     BFiles bfs;
 193     Records records;
 194     ZebraExplainInfo zei;
 195
 196     char *server_path_prefix;
 197     data1_handle dh;
 198     ZebraMaps zebra_maps;
 199     ZebraRankClass rank_classes;
 200     RecTypes recTypes;
 201     int seqno;
 202     int last_val;
 203     int stop_flag;
 204
 205     zebra_rec_keys_t keys;
 206     zebra_rec_keys_t sortKeys;
 207     char **key_buf;
 208     size_t ptr_top;
 209     size_t ptr_i;
 210     size_t key_buf_used;
 211     int key_file_no;
 212 };
 213
 214 struct zebra_service {
 215     int stop_flag;
 216     Res global_res;
 217     struct zebra_session *sessions;
 218     struct zebra_register *regs;
 219     Zebra_mutex_cond session_lock;
 220     Passwd_db passwd_db;
 221     Res dbaccess;
 222     const char *path_root;
 223     RecTypeClass record_classes;
 224     NMEM nmem;
 225 };
 226
 227
 228 struct zebra_session {
 229     struct zebra_session *next;
 230     struct zebra_service *service;
 231     struct zebra_register *reg;
 232
 233     char *xadmin_databaseName;
 234
 235     char **basenames;
 236     int num_basenames;
 237     zint approx_limit;
 238     char *reg_name;
 239     char *path_reg;
 240
 241     ZebraLockHandle lock_normal;
 242     ZebraLockHandle lock_shadow;
 243
 244     int trans_no;
 245     int trans_w_no;
 246
 247     int destroyed;
 248     ZebraSet sets;
 249     Res res;
 250     Res session_res;
 251     char *user_perm;
 252     char *dbaccesslist;
 253     int errCode;
 254     zint hits;
 255     char *errString;
 256 #if HAVE_SYS_TIMES_H
 257     struct tms tms1;
 258     struct tms tms2;
 259 #endif
 260     int  shadow_enable;
 261
 262     int m_staticrank;
 263
 264     zint records_inserted;
 265     zint records_updated;
 266     zint records_deleted;
 267     zint records_processed;
 268     char *record_encoding;
 269
 270     yaz_iconv_t iconv_to_utf8;
 271     yaz_iconv_t iconv_from_utf8;
 272
 273     int m_follow_links;
 274     const char *m_group;
 275     const char *m_record_id;
 276     const char *m_record_type;
 277     int m_store_data;
 278     int m_store_keys;
 279     int m_explain_database;
 280     int m_flag_rw;
 281     int m_file_verbose_limit;
 282
 283     void *store_data_buf;
 284     size_t store_data_size;
 285     NMEM nmem_error;
 286
 287     struct zebra_limit *m_limit;
 288 };
 289
 290
 291 struct term_set_entry {
 292     char *term;
 293     struct term_set_entry *next;
 294 };
 295
 296 struct term_set_list {
 297     struct term_set_entry *first;
 298     struct term_set_entry *last;
 299 };
 300
 301
 302 void zebra_limit_destroy(struct zebra_limit *zl);
 303 struct zebra_limit *zebra_limit_create(int exclude_flag, zint *ids);
 304 void zebra_limit_for_rset(struct zebra_limit *zl,
 305                           int (**filter_func)(const void *buf, void *data),
 306                           void (**filter_destroy)(void *data),
 307                           void **filter_data);
 308
 309 struct rset_key_control *zebra_key_control_create(ZebraHandle zh);
 310
 311 ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs,
 312                          oid_value attributeSet,
 313                          NMEM stream, NMEM rset_nmem,
 314                          Z_SortKeySpecList *sort_sequence,
 315                          int num_bases, char **basenames,
 316                          RSET *result_set);
 317
 318 ZEBRA_RES rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 319                     oid_value attributeset,
 320                     int num_bases, char **basenames,
 321                     int *position, int *num_entries, ZebraScanEntry **list,
 322                     int *is_partial, RSET limit_set, int return_zero);
 323
 324 RSET rset_trunc(ZebraHandle zh, ISAM_P *isam_p, int no,
 325                 const char *term, int length_term, const char *flags,
 326                 int preserve_position, int term_type, NMEM rset_nmem,
 327                 struct rset_key_control *kctrl, int scope,
 328                 struct ord_list *ol, int reg_type,
 329                 zint hits_limit, const char *term_ref_id);
 330
 331 void resultSetAddTerm(ZebraHandle zh, ZebraSet s, int reg_type,
 332                       const char *db, const char *index_name,
 333                       const char *term);
 334 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
 335 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
 336 ZEBRA_RES resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
 337                      int num_bases, char **basenames,
 338                      const char *setname);
 339 RSET resultSetRef (ZebraHandle zh, const char *resultSetId);
 340 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
 341                        int *statuses);
 342 ZEBRA_RES resultSetSort (ZebraHandle zh, NMEM nmem,
 343                          int num_input_setnames, const char **input_setnames,
 344                          const char *output_setname,
 345                          Z_SortKeySpecList *sort_sequence, int *sort_status);
 346 ZEBRA_RES resultSetSortSingle (ZebraHandle zh, NMEM nmem,
 347                                ZebraSet sset, RSET rset,
 348                                Z_SortKeySpecList *sort_sequence,
 349                                int *sort_status);
 350 ZEBRA_RES resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset,
 351                          NMEM nmem);
 352 void resultSetInvalidate (ZebraHandle zh);
 353
 354 int zebra_server_lock_init (ZebraService zh);
 355 int zebra_server_lock_destroy (ZebraService zh);
 356 int zebra_server_lock (ZebraService zh, int lockCommit);
 357 void zebra_server_unlock (ZebraService zh, int commitPhase);
 358 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
 359
 360 int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score,
 361                         zebra_snippets *hit_snippet, ODR stream,
 362                         oid_value input_format, Z_RecordComposition *comp,
 363                         oid_value *output_format, char **rec_bufp,
 364                         int *rec_lenp, char **basenamep,
 365                         char **addinfo);
 366
 367 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
 368
 369 void zebra_index_merge (ZebraHandle zh);
 370
 371 ZEBRA_RES buffer_extract_record (ZebraHandle zh,
 372                                  const char *buf, size_t buf_size,
 373                                  int delete_flag,
 374                                  int test_mode,
 375                                  const char *recordType,
 376                                  SYSNO *sysno,
 377                                  const char *match_criteria,
 378                                  const char *fname,
 379                                  int force_update,
 380                                  int allow_update);
 381
 382 #if 0
 383 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
 384                         const char *buf, size_t buf_size,
 385                         const char *databaseName, int delete_flag,
 386                         int test_mode, int *sysno,
 387                         int store_keys, int store_data,
 388                         const char *match_criteria);
 389 #endif
 390 void extract_flushWriteKeys (ZebraHandle zh, int final);
 391
 392 struct zebra_fetch_control {
 393     off_t offset_end;
 394     off_t record_offset;
 395     off_t record_int_pos;
 396     const char *record_int_buf;
 397     int record_int_len;
 398     int fd;
 399 };
 400
 401 int zebra_record_ext_read (void *fh, char *buf, size_t count);
 402 off_t zebra_record_ext_seek (void *fh, off_t offset);
 403 off_t zebra_record_ext_tell (void *fh);
 404 off_t zebra_record_int_seek (void *fh, off_t offset);
 405 off_t zebra_record_int_tell (void *fh);
 406 int zebra_record_int_read (void *fh, char *buf, size_t count);
 407 void zebra_record_int_end (void *fh, off_t offset);
 408
 409 void print_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys);
 410
 411 ZEBRA_RES zebra_snippets_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys,
 412                                   zebra_snippets *snippets);
 413 ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
 414                                     zint sysno, zebra_snippets *snippets);
 415
 416 void extract_flushRecordKeys (ZebraHandle zh, SYSNO sysno,
 417                               int cmd, zebra_rec_keys_t reckeys,
 418                               zint staticrank);
 419 void extract_flushSortKeys (ZebraHandle zh, SYSNO sysno,
 420                             int cmd, zebra_rec_keys_t skp);
 421 void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
 422 void extract_token_add (RecWord *p);
 423 int explain_extract (void *handle, Record rec, data1_node *n);
 424
 425 ZEBRA_RES zebra_extract_file(ZebraHandle zh, SYSNO *sysno, const char *fname,
 426                              int deleteFlag);
 427
 428 ZEBRA_RES zebra_begin_read (ZebraHandle zh);
 429 ZEBRA_RES zebra_end_read (ZebraHandle zh);
 430
 431 int zebra_file_stat (const char *file_name, struct stat *buf,
 432                      int follow_links);
 433
 434 void zebra_livcode_transform(ZebraHandle zh, Z_RPNQuery *query);
 435
 436 void *iscz1_start ();
 437 void iscz1_reset (void *vp);
 438 void iscz1_stop (void *p);
 439 void iscz1_decode (void *vp, char **dst, const char **src);
 440 void iscz1_encode (void *vp, char **dst, const char **src);
 441
 442 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
 443                     int compact_flag, Res res);
 444
 445 void zebra_setError(ZebraHandle zh, int code, const char *addinfo);
 446 void zebra_setError_zint(ZebraHandle zh, int code, zint i);
 447
 448 void zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream, int reg_type,
 449                               char **dst, const char *src);
 450
 451 ZEBRA_RES zebra_get_hit_vector(ZebraHandle zh, const char *setname, zint sysno);
 452
 453 void zebra_term_untrans(ZebraHandle zh, int reg_type,
 454                         char *dst, const char *src);
 455
 456 ZEBRA_RES zebra_apt_get_ord(ZebraHandle zh,
 457                             Z_AttributesPlusTerm *zapt,
 458                             int index_type,
 459                             const char *xpath_use,
 460                             oid_value curAttributeSet,
 461                             int *ord);
 462
 463 ZEBRA_RES zebra_attr_list_get_ord(ZebraHandle zh,
 464                                   Z_AttributeList *attr_list,
 465                                   int index_type,
 466                                   oid_value curAttributeSet,
 467                                   int *ord);
 468
 469 ZEBRA_RES zebra_sort_get_ord(ZebraHandle zh,
 470                              Z_SortAttributes *sortAttributes,
 471                              int *ord,
 472                              int *numerical);
 473
 474 ZEBRA_RES zebra_update_file_match(ZebraHandle zh, const char *path);
 475 ZEBRA_RES zebra_update_from_path(ZebraHandle zh, const char *path);
 476 ZEBRA_RES zebra_delete_from_path(ZebraHandle zh, const char *path);
 477
 478 YAZ_END_CDECL
 479
 480 #endif
 481 /*
 482  * Local variables:
 483  * c-basic-offset: 4
 484  * indent-tabs-mode: nil
 485  * End:
 486  * vim: shiftwidth=4 tabstop=8 expandtab
 487  */
 488