index/index.h

   1 /* $Id: index.h,v 1.170 2006-07-04 14:10:29 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 zint key_get_segment (const void *p);
 108 int key_compare_it (const void *p1, const void *p2);
 109 int key_qsort_compare (const void *p1, const void *p2);
 110 void key_logdump (int mask, const void *p);
 111 void key_logdump_txt (int logmask, const void *p, const char *txt);
 112 void inv_prstat (ZebraHandle zh);
 113 void inv_compact (BFiles bfs);
 114 void key_input (ZebraHandle zh, int nkeys, int cache, Res res);
 115 ISAMS_M *key_isams_m (Res res, ISAMS_M *me);
 116 ISAMC_M *key_isamc_m (Res res, ISAMC_M *me);
 117 int merge_sort (char **buf, int from, int to);
 118 int key_SU_code (int ch, char *out);
 119
 120 #define FNAME_DICT "dict"
 121 #define FNAME_ISAM "isam"
 122 #define FNAME_ISAMC "isamc"
 123 #define FNAME_ISAMS "isams"
 124 #define FNAME_ISAMH "isamh"
 125 #define FNAME_ISAMD "isamd"
 126 #define FNAME_CONFIG "zebra.cfg"
 127
 128 #define GMATCH_DICT "gmatch"
 129 #define FMATCH_DICT "fmatch"
 130
 131 struct strtab *strtab_mk (void);
 132 int strtab_src (struct strtab *t, const char *name, void ***infop);
 133 void strtab_del (struct strtab *t,
 134                  void (*func)(const char *name, void *info, void *data),
 135                  void *data);
 136
 137 void zebraIndexLockMsg (ZebraHandle zh, const char *str);
 138 void zebraIndexUnlock (ZebraHandle zh);
 139 int zebraIndexLock (BFiles bfs, ZebraHandle zh, int commitNow, const char *rval);
 140 int zebraIndexWait (ZebraHandle zh, int commitPhase);
 141
 142 void zebra_lock_prefix (Res res, char *dst);
 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 int key_SU_decode (int *ch, const unsigned char *out);
 150 int key_SU_encode (int ch, char *out);
 151
 152 typedef struct zebra_set *ZebraSet;
 153
 154 typedef struct zebra_rank_class {
 155     struct rank_control *control;
 156     int init_flag;
 157     void *class_handle;
 158     struct zebra_rank_class *next;
 159 } *ZebraRankClass;
 160
 161 #include "reckeys.h"
 162
 163 struct zebra_register {
 164     char *name;
 165
 166     ISAMS isams;
 167     ISAMC isamc;
 168     ISAMB isamb;
 169     Dict dict;
 170     Dict matchDict;
 171     SortIdx sortIdx;
 172     int registerState; /* 0 (no commit pages), 1 (use commit pages) */
 173     time_t registerChange;
 174     BFiles bfs;
 175     Records records;
 176     ZebraExplainInfo zei;
 177
 178     char *server_path_prefix;
 179     data1_handle dh;
 180     ZebraMaps zebra_maps;
 181     ZebraRankClass rank_classes;
 182     RecTypes recTypes;
 183     int seqno;
 184     int last_val;
 185     int stop_flag;
 186
 187     zebra_rec_keys_t keys;
 188     zebra_rec_keys_t sortKeys;
 189     char **key_buf;
 190     size_t ptr_top;
 191     size_t ptr_i;
 192     size_t key_buf_used;
 193     int key_file_no;
 194 };
 195
 196 struct zebra_service {
 197     int stop_flag;
 198     Res global_res;
 199     struct zebra_session *sessions;
 200     struct zebra_register *regs;
 201     Zebra_mutex_cond session_lock;
 202     Passwd_db passwd_db;
 203     Res dbaccess;
 204     const char *path_root;
 205     RecTypeClass record_classes;
 206     NMEM nmem;
 207 };
 208
 209
 210 struct zebra_session {
 211     struct zebra_session *next;
 212     struct zebra_service *service;
 213     struct zebra_register *reg;
 214
 215     char *xadmin_databaseName;
 216
 217     char **basenames;
 218     int num_basenames;
 219     zint approx_limit;
 220     char *reg_name;
 221     char *path_reg;
 222
 223     ZebraLockHandle lock_normal;
 224     ZebraLockHandle lock_shadow;
 225
 226     int trans_no;
 227     int trans_w_no;
 228
 229     int destroyed;
 230     ZebraSet sets;
 231     Res res;
 232     Res session_res;
 233     char *user_perm;
 234     char *dbaccesslist;
 235     int errCode;
 236     zint hits;
 237     char *errString;
 238 #if HAVE_SYS_TIMES_H
 239     struct tms tms1;
 240     struct tms tms2;
 241 #endif
 242     int  shadow_enable;
 243
 244     int m_staticrank;
 245
 246     zint records_inserted;
 247     zint records_updated;
 248     zint records_deleted;
 249     zint records_processed;
 250     char *record_encoding;
 251
 252     yaz_iconv_t iconv_to_utf8;
 253     yaz_iconv_t iconv_from_utf8;
 254
 255     int m_follow_links;
 256     const char *m_group;
 257     const char *m_record_id;
 258     const char *m_record_type;
 259     int m_store_data;
 260     int m_store_keys;
 261     int m_explain_database;
 262     int m_flag_rw;
 263     int m_file_verbose_limit;
 264
 265     void *store_data_buf;
 266     size_t store_data_size;
 267     NMEM nmem_error;
 268
 269     struct zebra_limit *m_limit;
 270 };
 271
 272
 273 struct term_set_entry {
 274     char *term;
 275     struct term_set_entry *next;
 276 };
 277
 278 struct term_set_list {
 279     struct term_set_entry *first;
 280     struct term_set_entry *last;
 281 };
 282
 283
 284 void zebra_limit_destroy(struct zebra_limit *zl);
 285 struct zebra_limit *zebra_limit_create(int exclude_flag, zint *ids);
 286 void zebra_limit_for_rset(struct zebra_limit *zl,
 287                           int (**filter_func)(const void *buf, void *data),
 288                           void (**filter_destroy)(void *data),
 289                           void **filter_data);
 290
 291 struct rset_key_control *zebra_key_control_create(ZebraHandle zh);
 292
 293 ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs,
 294                          oid_value attributeSet,
 295                          NMEM stream, NMEM rset_nmem,
 296                          Z_SortKeySpecList *sort_sequence,
 297                          int num_bases, char **basenames,
 298                          RSET *result_set);
 299
 300 ZEBRA_RES rpn_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
 301                     oid_value attributeset,
 302                     int num_bases, char **basenames,
 303                     int *position, int *num_entries, ZebraScanEntry **list,
 304                     int *is_partial, RSET limit_set, int return_zero);
 305
 306 RSET rset_trunc(ZebraHandle zh, ISAM_P *isam_p, int no,
 307                 const char *term, int length_term, const char *flags,
 308                 int preserve_position, int term_type, NMEM rset_nmem,
 309                 struct rset_key_control *kctrl, int scope,
 310                 struct ord_list *ol, int reg_type,
 311                 zint hits_limit, const char *term_ref_id);
 312
 313 void resultSetAddTerm(ZebraHandle zh, ZebraSet s, int reg_type,
 314                       const char *db, const char *index_name,
 315                       const char *term);
 316 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov);
 317 ZebraSet resultSetGet (ZebraHandle zh, const char *name);
 318 ZEBRA_RES resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
 319                      int num_bases, char **basenames,
 320                      const char *setname);
 321 RSET resultSetRef (ZebraHandle zh, const char *resultSetId);
 322 void resultSetDestroy (ZebraHandle zh, int num_names, char **names,
 323                        int *statuses);
 324 ZEBRA_RES resultSetSort (ZebraHandle zh, NMEM nmem,
 325                          int num_input_setnames, const char **input_setnames,
 326                          const char *output_setname,
 327                          Z_SortKeySpecList *sort_sequence, int *sort_status);
 328 ZEBRA_RES resultSetSortSingle (ZebraHandle zh, NMEM nmem,
 329                                ZebraSet sset, RSET rset,
 330                                Z_SortKeySpecList *sort_sequence,
 331                                int *sort_status);
 332 ZEBRA_RES resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset,
 333                          NMEM nmem);
 334 void resultSetInvalidate (ZebraHandle zh);
 335
 336 int zebra_server_lock_init (ZebraService zh);
 337 int zebra_server_lock_destroy (ZebraService zh);
 338 int zebra_server_lock (ZebraService zh, int lockCommit);
 339 void zebra_server_unlock (ZebraService zh, int commitPhase);
 340 int zebra_server_lock_get_state (ZebraService zh, time_t *timep);
 341
 342 int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score,
 343                         zebra_snippets *hit_snippet, ODR stream,
 344                         oid_value input_format, Z_RecordComposition *comp,
 345                         oid_value *output_format, char **rec_bufp,
 346                         int *rec_lenp, char **basenamep,
 347                         char **addinfo);
 348
 349 void extract_get_fname_tmp (ZebraHandle zh, char *fname, int no);
 350
 351 void zebra_index_merge (ZebraHandle zh);
 352
 353 ZEBRA_RES zebra_buffer_extract_record(ZebraHandle zh,
 354                                       const char *buf, size_t buf_size,
 355                                       int delete_flag,
 356                                       int test_mode,
 357                                       const char *recordType,
 358                                       SYSNO *sysno,
 359                                       const char *match_criteria,
 360                                       const char *fname,
 361                                       int force_update,
 362                                       int allow_update);
 363
 364 #if 0
 365 int extract_rec_in_mem (ZebraHandle zh, const char *recordType,
 366                         const char *buf, size_t buf_size,
 367                         const char *databaseName, int delete_flag,
 368                         int test_mode, int *sysno,
 369                         int store_keys, int store_data,
 370                         const char *match_criteria);
 371 #endif
 372 void extract_flushWriteKeys (ZebraHandle zh, int final);
 373
 374 struct zebra_fetch_control {
 375     off_t offset_end;
 376     off_t record_offset;
 377     off_t record_int_pos;
 378     const char *record_int_buf;
 379     int record_int_len;
 380     int fd;
 381 };
 382
 383 int zebra_record_ext_read (void *fh, char *buf, size_t count);
 384 off_t zebra_record_ext_seek (void *fh, off_t offset);
 385 off_t zebra_record_ext_tell (void *fh);
 386 off_t zebra_record_int_seek (void *fh, off_t offset);
 387 off_t zebra_record_int_tell (void *fh);
 388 int zebra_record_int_read (void *fh, char *buf, size_t count);
 389 void zebra_record_int_end (void *fh, off_t offset);
 390
 391 void print_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys);
 392
 393 ZEBRA_RES zebra_snippets_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys,
 394                                   zebra_snippets *snippets);
 395 ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
 396                                     zint sysno, zebra_snippets *snippets);
 397
 398 ZEBRA_RES zebra_extract_explain(void *handle, Record rec, data1_node *n);
 399
 400 ZEBRA_RES zebra_extract_file(ZebraHandle zh, SYSNO *sysno, const char *fname,
 401                              int deleteFlag);
 402
 403 ZEBRA_RES zebra_begin_read (ZebraHandle zh);
 404 ZEBRA_RES zebra_end_read (ZebraHandle zh);
 405
 406 int zebra_file_stat (const char *file_name, struct stat *buf,
 407                      int follow_links);
 408
 409 void zebra_livcode_transform(ZebraHandle zh, Z_RPNQuery *query);
 410
 411 void *iscz1_start ();
 412 void iscz1_reset (void *vp);
 413 void iscz1_stop (void *p);
 414 void iscz1_decode (void *vp, char **dst, const char **src);
 415 void iscz1_encode (void *vp, char **dst, const char **src);
 416
 417 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
 418                     int compact_flag, Res res);
 419
 420 void zebra_setError(ZebraHandle zh, int code, const char *addinfo);
 421 void zebra_setError_zint(ZebraHandle zh, int code, zint i);
 422
 423 void zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream, int reg_type,
 424                               char **dst, const char *src);
 425
 426 ZEBRA_RES zebra_get_hit_vector(ZebraHandle zh, const char *setname, zint sysno);
 427
 428 void zebra_term_untrans(ZebraHandle zh, int reg_type,
 429                         char *dst, const char *src);
 430
 431 ZEBRA_RES zebra_apt_get_ord(ZebraHandle zh,
 432                             Z_AttributesPlusTerm *zapt,
 433                             int index_type,
 434                             const char *xpath_use,
 435                             oid_value curAttributeSet,
 436                             int *ord);
 437
 438 ZEBRA_RES zebra_attr_list_get_ord(ZebraHandle zh,
 439                                   Z_AttributeList *attr_list,
 440                                   zinfo_index_category_t cat,
 441                                   int index_type,
 442                                   oid_value curAttributeSet,
 443                                   int *ord);
 444
 445 ZEBRA_RES zebra_sort_get_ord(ZebraHandle zh,
 446                              Z_SortAttributes *sortAttributes,
 447                              int *ord,
 448                              int *numerical);
 449
 450 ZEBRA_RES zebra_update_file_match(ZebraHandle zh, const char *path);
 451 ZEBRA_RES zebra_update_from_path(ZebraHandle zh, const char *path);
 452 ZEBRA_RES zebra_delete_from_path(ZebraHandle zh, const char *path);
 453
 454 YAZ_END_CDECL
 455
 456 #endif
 457 /*
 458  * Local variables:
 459  * c-basic-offset: 4
 460  * indent-tabs-mode: nil
 461  * End:
 462  * vim: shiftwidth=4 tabstop=8 expandtab
 463  */
 464