X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=index%2Findex.h;h=2ee8b61557dc7c3c5ed9b24c5478e1ed8e145a2e;hb=27bdd6aa26843aeac89f635ed495996088d8e8aa;hp=694b36d62c5dd918b5a4b6f17dfcb95f41845e46;hpb=4c6c27a5098e5fd9425051ef97f98e898c098a20;p=idzebra-moved-to-github.git diff --git a/index/index.h b/index/index.h index 694b36d..2ee8b61 100644 --- a/index/index.h +++ b/index/index.h @@ -1,159 +1,56 @@ -/* - * Copyright (C) 1994-1995, Index Data I/S - * All rights reserved. - * Sebastian Hammer, Adam Dickmeiss - * - * $Log: index.h,v $ - * Revision 1.39 1996-05-14 14:04:33 adam - * In zebraidx, the 'stat' command is improved. Statistics about ISAM/DICT - * is collected. - * - * Revision 1.38 1996/04/12 07:02:23 adam - * File update of single files. - * - * Revision 1.37 1996/03/26 16:01:13 adam - * New setting lockPath: directory of various lock files. - * - * Revision 1.36 1996/03/21 14:50:09 adam - * File update uses modify-time instead of change-time. - * - * Revision 1.35 1996/02/12 18:45:36 adam - * New fileVerboseFlag in record group control. - * - * Revision 1.34 1995/12/11 11:43:29 adam - * Locking based on fcntl instead of flock. - * Setting commitEnable removed. Command line option -n can be used to - * prevent commit if commit setting is defined in the configuration file. - * - * Revision 1.33 1995/12/08 16:22:53 adam - * Work on update while servers are running. Three lock files introduced. - * The servers reload their registers when necessary, but they don't - * reestablish result sets yet. - * - * Revision 1.32 1995/12/07 17:38:46 adam - * Work locking mechanisms for concurrent updates/commit. - * - * Revision 1.31 1995/12/06 12:41:22 adam - * New command 'stat' for the index program. - * Filenames can be read from stdin by specifying '-'. - * Bug fix/enhancement of the transformation from terms to regular - * expressons in the search engine. - * - * Revision 1.30 1995/12/05 11:25:02 adam - * Include of zebraver.h. - * - * Revision 1.29 1995/11/28 09:09:40 adam - * Zebra config renamed. - * Use setting 'recordId' to identify record now. - * Bug fix in recindex.c: rec_release_blocks was invokeded even - * though the blocks were already released. - * File traversal properly deletes records when needed. - * - * Revision 1.28 1995/11/27 13:58:53 adam - * New option -t. storeStore data implemented in server. - * - * Revision 1.27 1995/11/25 10:24:06 adam - * More record fields - they are enumerated now. - * New options: flagStoreData flagStoreKey. - * - * Revision 1.26 1995/11/22 17:19:17 adam - * Record management uses the bfile system. - * - * Revision 1.25 1995/11/21 15:29:12 adam - * Config file 'base' read by default by both indexer and server. - * - * Revision 1.24 1995/11/21 15:01:15 adam - * New general match criteria implemented. - * New feature: document groups. - * - * Revision 1.23 1995/11/20 16:59:45 adam - * New update method: the 'old' keys are saved for each records. - * - * Revision 1.22 1995/11/20 11:56:26 adam - * Work on new traversal. - * - * Revision 1.21 1995/11/16 15:34:55 adam - * Uses new record management system in both indexer and server. - * - * Revision 1.20 1995/11/15 14:46:18 adam - * Started work on better record management system. - * - * Revision 1.19 1995/10/27 14:00:11 adam - * Implemented detection of database availability. - * - * Revision 1.18 1995/10/17 18:02:08 adam - * New feature: databases. Implemented as prefix to words in dictionary. - * - * Revision 1.17 1995/10/13 16:01:49 adam - * Work on relations. - * - * Revision 1.16 1995/10/10 12:24:38 adam - * Temporary sort files are compressed. - * - * Revision 1.15 1995/10/04 16:57:19 adam - * Key input and merge sort in one pass. - * - * Revision 1.14 1995/09/29 14:01:40 adam - * Bug fixes. - * - * Revision 1.13 1995/09/28 14:22:56 adam - * Sort uses smaller temporary files. - * - * Revision 1.12 1995/09/28 12:10:32 adam - * Bug fixes. Field prefix used in queries. - * - * Revision 1.11 1995/09/27 12:22:28 adam - * More work on extract in record control. - * Field name is not in isam keys but in prefix in dictionary words. - * - * Revision 1.10 1995/09/14 07:48:23 adam - * Record control management. - * - * Revision 1.9 1995/09/11 13:09:33 adam - * More work on relevance feedback. - * - * Revision 1.8 1995/09/08 14:52:27 adam - * Minor changes. Dictionary is lower case now. - * - * Revision 1.7 1995/09/06 16:11:16 adam - * Option: only one word key per file. - * - * Revision 1.6 1995/09/05 15:28:39 adam - * More work on search engine. - * - * Revision 1.5 1995/09/04 12:33:42 adam - * Various cleanup. YAZ util used instead. - * - * Revision 1.4 1995/09/04 09:10:35 adam - * More work on index add/del/update. - * Merge sort implemented. - * Initial work on z39 server. - * - * Revision 1.3 1995/09/01 14:06:35 adam - * Split of work into more files. - * - * Revision 1.2 1995/09/01 10:30:24 adam - * More work on indexing. Not working yet. - * - * Revision 1.1 1995/08/31 14:50:24 adam - * New simple file index tool. - * - */ +/* This file is part of the Zebra server. + Copyright (C) 2004-2013 Index Data + +Zebra is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free +Software Foundation; either version 2, or (at your option) any later +version. + +Zebra is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef ZEBRA_INDEX_H +#define ZEBRA_INDEX_H #include -#include -#include -#include -#include - -#define IT_MAX_WORD 256 -#define IT_KEY_HAVE_SEQNO 1 -#define IT_KEY_HAVE_FIELD 0 - -struct it_key { - int sysno; - int seqno; -}; +#include +#include +#include +#include +#include +#if HAVE_SYS_TIMES_H +#include +#endif +#include + +#include +#include +#include +#include +#include +#include +#include +#include "recindex.h" +#include +#include "zinfo.h" +#include +#include +#include + +#include +#include + +YAZ_BEGIN_CDECL + +#define ISAM_DEFAULT "b" enum dirsKind { dirs_dir, dirs_file }; @@ -166,86 +63,389 @@ struct dir_entry { struct dirs_entry { enum dirsKind kind; char path[256]; - SYSNO sysno; + zint sysno; time_t mtime; }; -struct recordGroup { - char *groupName; - char *databaseName; - char *path; - char *recordId; - char *recordType; - int flagStoreData; - int flagStoreKeys; - int fileVerboseFlag; -}; +void getFnameTmp(Res res, char *fname, int no); - -struct dirs_info *dirs_open (Dict dict, const char *rep); -struct dirs_info *dirs_fopen (Dict dict, const char *path); -struct dirs_entry *dirs_read (struct dirs_info *p); -struct dirs_entry *dirs_last (struct dirs_info *p); -void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime); -void dirs_rmdir (struct dirs_info *p, const char *src); -void dirs_add (struct dirs_info *p, const char *src, int sysno, time_t mtime); -void dirs_del (struct dirs_info *p, const char *src); -void dirs_free (struct dirs_info **pp); - -struct dir_entry *dir_open (const char *rep); -void dir_sort (struct dir_entry *e); -void dir_free (struct dir_entry **e_p); - -void repositoryUpdate (struct recordGroup *rGroup); -void repositoryAdd (struct recordGroup *rGroup); -void repositoryDelete (struct recordGroup *rGroup); -void repositoryShow (struct recordGroup *rGroup); - -void key_open (int mem); -int key_close (void); -void key_write (int cmd, struct it_key *k, const char *str); -int key_compare (const void *p1, const void *p2); -int key_qsort_compare (const void *p1, const void *p2); -void key_logdump (int mask, const void *p); -void inv_prstat (const char *dict_fname, const char *isam_fname); -void key_input (const char *dict_fname, const char *isam_fname, - int nkeys, int cache); -int merge_sort (char **buf, int from, int to); - -#define TEMP_FNAME "keys%d.tmp" -#define FNAME_WORD_DICT "worddict" -#define FNAME_WORD_ISAM "wordisam" -#define FNAME_CONFIG "zebra.cfg" +struct dirs_info *dirs_open(Dict dict, const char *rep, int rw); +struct dirs_info *dirs_fopen(Dict dict, const char *path, int rw); +struct dirs_entry *dirs_read(struct dirs_info *p); +struct dirs_entry *dirs_last(struct dirs_info *p); +void dirs_mkdir(struct dirs_info *p, const char *src, time_t mtime); +void dirs_rmdir(struct dirs_info *p, const char *src); +void dirs_add(struct dirs_info *p, const char *src, zint sysno, time_t mtime); +void dirs_del(struct dirs_info *p, const char *src); +void dirs_free(struct dirs_info **pp); -#define GMATCH_DICT "gmatch" -#define FMATCH_DICT "fmatch" +struct dir_entry *dir_open(const char *rep, const char *base, + int follow_links); +void dir_sort(struct dir_entry *e); +void dir_free(struct dir_entry **e_p); -struct strtab *strtab_mk (void); -int strtab_src (struct strtab *t, const char *name, void ***infop); -void strtab_del (struct strtab *t, - void (*func)(const char *name, void *info, void *data), - void *data); -int index_char_cvt (int c); -int index_word_prefix (char *string, int attset_ordinal, - int local_attribute, const char *databaseName); +void repositoryUpdate(ZebraHandle zh, const char *path); +void repositoryAdd(ZebraHandle zh, const char *path); +void repositoryDelete(ZebraHandle zh, const char *path); +void repositoryShow(ZebraHandle zh, const char *path); -int fileExtract (SYSNO *sysno, const char *fname, - const struct recordGroup *rGroup, int deleteFlag); +void inv_prstat(ZebraHandle zh); +void inv_compact(BFiles bfs); +void key_input(ZebraHandle zh, int nkeys, int cache, Res res); +ISAMS_M *key_isams_m(Res res, ISAMS_M *me); +ISAMC_M *key_isamc_m(Res res, ISAMC_M *me); -void rec_prstat (void); +#define FNAME_DICT "dict" +#define FNAME_ISAM "isam" +#define FNAME_ISAMC "isamc" +#define FNAME_ISAMS "isams" +#define FNAME_CONFIG "zebra.cfg" -void zebraLockPrefix (char *pathPrefix); +#define GMATCH_DICT "gmatch" +#define FMATCH_DICT "fmatch%d" -void zebraIndexLockMsg (const char *str); -void zebraIndexUnlock (void); -void zebraIndexLock (int commitNow); -int zebraIndexWait (int commitPhase); +void zebra_lock_prefix(Res res, char *dst); #define FNAME_MAIN_LOCK "zebraidx.LCK" #define FNAME_COMMIT_LOCK "zebracmt.LCK" #define FNAME_ORG_LOCK "zebraorg.LCK" #define FNAME_TOUCH_TIME "zebraidx.time" -int zebraLock (int fd, int wr); -int zebraLockNB (int fd, int wr); -int zebraUnlock (int fd); +typedef struct zebra_set *ZebraSet; + +typedef struct zebra_rank_class { + struct rank_control *control; + int init_flag; + void *class_handle; + struct zebra_rank_class *next; +} *ZebraRankClass; + +#include "reckeys.h" +#include "key_block.h" + +struct zebra_register { + char *name; + + ISAMS isams; + ISAMC isamc; + ISAMB isamb; + Dict dict; + Dict matchDict; + zebra_sort_index_t sort_index; + int registerState; /* 0 (no commit pages), 1 (use commit pages) */ + time_t registerChange; + BFiles bfs; + Records records; + ZebraExplainInfo zei; + + char *server_path_prefix; + data1_handle dh; + zebra_maps_t zebra_maps; + ZebraRankClass rank_classes; + RecTypes recTypes; + int seqno; + int last_val; + int stop_flag; + + zebra_rec_keys_t keys; + zebra_rec_keys_t sortKeys; + + zebra_key_block_t key_block; +}; + +struct zebra_service { + int stop_flag; + Res global_res; + struct zebra_session *sessions; + struct zebra_register *regs; + Zebra_mutex_cond session_lock; + Passwd_db passwd_db; + Res dbaccess; + const char *path_root; + RecTypeClass record_classes; + NMEM nmem; + yaz_timing_t timing; +}; + + +struct zebra_session { + struct zebra_session *next; + struct zebra_service *service; + struct zebra_register *reg; + + char *xadmin_databaseName; + + char **basenames; + int num_basenames; + zint approx_limit; + char *reg_name; + char *path_reg; + + ZebraLockHandle lock_normal; + ZebraLockHandle lock_shadow; + + int trans_no; + int trans_w_no; + + int destroyed; + ZebraSet sets; + Res res; + Res session_res; + char *user_perm; + char *dbaccesslist; + int errCode; + char *errString; + int partial_result; +#if HAVE_SYS_TIMES_H + struct tms tms1; + struct tms tms2; +#endif + int shadow_enable; + + int m_staticrank; + int m_segment_indexing; + + zint records_inserted; + zint records_updated; + zint records_deleted; + zint records_processed; + zint records_skipped; + char *record_encoding; + + yaz_iconv_t iconv_to_utf8; + yaz_iconv_t iconv_from_utf8; + + int m_follow_links; + const char *m_group; + const char *m_record_id; + const char *m_record_type; + int m_store_data; + int m_store_keys; + int m_explain_database; + int m_flag_rw; + int m_file_verbose_limit; + + void *store_data_buf; + size_t store_data_size; + NMEM nmem_error; + + struct zebra_limit *m_limit; + + int (*break_handler_func)(void *client_data); + void *break_handler_data; +}; + + +struct term_set_entry { + char *term; + struct term_set_entry *next; +}; + +struct term_set_list { + struct term_set_entry *first; + struct term_set_entry *last; +}; + + +void zebra_limit_destroy(struct zebra_limit *zl); +struct zebra_limit *zebra_limit_create(int exclude_flag, zint *ids); +void zebra_limit_for_rset(struct zebra_limit *zl, + int (**filter_func)(const void *buf, void *data), + void (**filter_destroy)(void *data), + void **filter_data); + +struct rset_key_control *zebra_key_control_create(ZebraHandle zh); + +ZEBRA_RES rpn_search_top(ZebraHandle zh, Z_RPNStructure *zs, + const Odr_oid *attributeSet, zint hits_limit, + NMEM stream, NMEM rset_nmem, + Z_SortKeySpecList *sort_sequence, + int num_bases, const char **basenames, + RSET *result_set); + +ZEBRA_RES rpn_get_top_approx_limit(ZebraHandle zh, Z_RPNStructure *zs, + zint *approx_limit); + +ZEBRA_RES rpn_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt, + const Odr_oid *attributeset, + int num_bases, char **basenames, + int *position, int *num_entries, ZebraScanEntry **list, + int *is_partial, const char *set_name); + +RSET rset_trunc(ZebraHandle zh, ISAM_P *isam_p, int no, + const char *term, int length_term, const char *flags, + int preserve_position, int term_type, NMEM rset_nmem, + struct rset_key_control *kctrl, int scope, + struct ord_list *ol, const char *index_type, + zint hits_limit, const char *term_ref_id); + +ZEBRA_RES resultSetGetBaseNames(ZebraHandle zh, const char *setname, + const char ***basenames, int *num_bases); + +void resultSetAddTerm(ZebraHandle zh, ZebraSet s, int reg_type, + const char *db, const char *index_name, + const char *term); +ZebraSet resultSetAdd(ZebraHandle zh, const char *name, int ov); +ZebraSet resultSetGet(ZebraHandle zh, const char *name); +ZEBRA_RES resultSetAddRPN(ZebraHandle zh, NMEM m, Z_RPNQuery *rpn, + int num_bases, char **basenames, + const char *setname, + zint *hits, int *estimated_hit_count); +RSET resultSetRef(ZebraHandle zh, const char *resultSetId); +void resultSetDestroy(ZebraHandle zh, int num_names, char **names, + int *statuses); +ZEBRA_RES resultSetSort(ZebraHandle zh, NMEM nmem, + int num_input_setnames, const char **input_setnames, + const char *output_setname, + Z_SortKeySpecList *sort_sequence, int *sort_status); +ZEBRA_RES resultSetSortSingle(ZebraHandle zh, NMEM nmem, + ZebraSet sset, RSET rset, + Z_SortKeySpecList *sort_sequence, + int *sort_status); +ZEBRA_RES resultSetRank(ZebraHandle zh, ZebraSet zebraSet, RSET rset, + NMEM nmem); +void resultSetInvalidate(ZebraHandle zh); + +int zebra_record_fetch(ZebraHandle zh, const char *setname, + zint sysno, int score, + ODR stream, + const Odr_oid *input_format, Z_RecordComposition *comp, + const Odr_oid **output_format, char **rec_bufp, + int *rec_lenp, char **basenamep, + WRBUF addinfo_w); + +void extract_get_fname_tmp(ZebraHandle zh, char *fname, int no); + +void extract_snippet(ZebraHandle zh, zebra_snippets *sn, + struct ZebraRecStream *stream, RecType rt, + void *recTypeClientData); + +int zebra_get_rec_snippets(ZebraHandle zh, zint sysno, + zebra_snippets *snippets); + +void zebra_index_merge(ZebraHandle zh); + +ZEBRA_RES zebra_buffer_extract_record(ZebraHandle zh, + const char *buf, size_t buf_size, + enum zebra_recctrl_action_t action, + const char *recordType, + zint *sysno, + const char *match_criteria, + const char *fname); + + +YAZ_EXPORT void zebra_create_stream_mem(struct ZebraRecStream *stream, + const char *buf, size_t sz); +YAZ_EXPORT void zebra_create_stream_fd(struct ZebraRecStream *stream, + int fd, off_t start_offset); +void print_rec_keys(ZebraHandle zh, zebra_rec_keys_t reckeys); + +ZEBRA_RES zebra_rec_keys_to_snippets(ZebraHandle zh, zebra_rec_keys_t reckeys, + zebra_snippets *snippets); +ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname, + zint sysno, zebra_snippets *snippets); + +ZEBRA_RES zebra_extract_explain(void *handle, Record rec, data1_node *n); + +ZEBRA_RES zebra_extract_file(ZebraHandle zh, zint *sysno, const char *fname, + enum zebra_recctrl_action_t action); + +ZEBRA_RES zebra_begin_read(ZebraHandle zh); +ZEBRA_RES zebra_end_read(ZebraHandle zh); + +int zebra_file_stat(const char *file_name, struct stat *buf, + int follow_links); + +Dict dict_open_res(BFiles bfs, const char *name, int cache, int rw, + int compact_flag, Res res); + +void zebra_setError(ZebraHandle zh, int code, const char *addinfo); +void zebra_setError_zint(ZebraHandle zh, int code, zint i); + +int zebra_term_untrans_iconv(ZebraHandle zh, NMEM stream, + const char *index_type, + char **dst, const char *src); + +ZEBRA_RES zebra_get_hit_vector(ZebraHandle zh, const char *setname, zint sysno); + +int zebra_term_untrans(ZebraHandle zh, const char *index_type, + char *dst, const char *src); + +ZEBRA_RES zebra_apt_get_ord(ZebraHandle zh, + Z_AttributesPlusTerm *zapt, + const char *index_type, + const char *xpath_use, + const Odr_oid *curAttributeSet, + int *ord); + +ZEBRA_RES zebra_attr_list_get_ord(ZebraHandle zh, + Z_AttributeList *attr_list, + zinfo_index_category_t cat, + const char *index_type, + const Odr_oid *curAttributeSet, + int *ord); + +ZEBRA_RES zebra_sort_get_ord(ZebraHandle zh, + Z_SortAttributes *sortAttributes, + int *ord, + int *numerical); + +ZEBRA_RES zebra_update_file_match(ZebraHandle zh, const char *path); +ZEBRA_RES zebra_update_from_path(ZebraHandle zh, const char *path, + enum zebra_recctrl_action_t action); +ZEBRA_RES zebra_remove_file_match(ZebraHandle zh); + +struct rpn_char_map_info +{ + zebra_map_t zm; + int reg_type; +}; + +void rpn_char_map_prepare(struct zebra_register *reg, zebra_map_t zm, + struct rpn_char_map_info *map_info); + +ZEBRA_RES zapt_term_to_utf8(ZebraHandle zh, Z_AttributesPlusTerm *zapt, + char *termz); + + +void zebra_set_partial_result(ZebraHandle zh); + +int zebra_check_res(Res res); + +#define FIRST_IN_FIELD_STR "\001^" +#define FIRST_IN_FIELD_CHAR 1 +#define FIRST_IN_FIELD_LEN 2 + +ZEBRA_RES zebra_term_limits_APT(ZebraHandle zh, + Z_AttributesPlusTerm *zapt, + zint *hits_limit_value, + const char **term_ref_id_str, + NMEM nmem); + +ZEBRA_RES zebra_result_recid_to_sysno(ZebraHandle zh, + const char *setname, + zint recid, + zint *sysnos, int *no_sysnos); + +void zebra_count_set(ZebraHandle zh, RSET rset, zint *count, + zint approx_limit); + +RSET zebra_create_rset_isam(ZebraHandle zh, + NMEM rset_nmem, struct rset_key_control *kctl, + int scope, ISAM_P pos, TERMID termid); + +void zebra_it_key_str_dump(ZebraHandle zh, struct it_key *key, + const char *str, size_t slen, NMEM nmem, int level); + +YAZ_END_CDECL + +#endif +/* + * Local variables: + * c-basic-offset: 4 + * c-file-style: "Stroustrup" + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +