X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=index%2Fretrieve.c;h=cffbc408b7a7202a03efc5a77a4c7eb6846252c6;hb=a00cd5d59423f99eddcea98bd10c5fca80b318bb;hp=650eb82b38158b59854a67ac5ac1f612dc58d699;hpb=313737060e826ddd9687b340750b49ebe38db40e;p=idzebra-moved-to-github.git diff --git a/index/retrieve.c b/index/retrieve.c index 650eb82..cffbc40 100644 --- a/index/retrieve.c +++ b/index/retrieve.c @@ -1,63 +1,24 @@ -/* - * Copyright (C) 1995-1999, Index Data - * All rights reserved. - * Sebastian Hammer, Adam Dickmeiss - * - * $Log: retrieve.c,v $ - * Revision 1.17 2002-05-03 13:49:04 adam - * play with shellsort - * - * Revision 1.16 2002/04/04 20:50:37 adam - * Multi register works with record paths and data1 profile path - * - * Revision 1.15 2002/04/04 14:14:13 adam - * Multiple registers (alpha early) - * - * Revision 1.14 2001/01/22 11:41:41 adam - * Added support for raw retrieval (element set name "R"). - * - * Revision 1.13 2000/03/20 19:08:36 adam - * Added remote record import using Z39.50 extended services and Segment - * Requests. - * - * Revision 1.12 2000/03/15 15:00:30 adam - * First work on threaded version. - * - * Revision 1.11 1999/10/29 10:00:00 adam - * Fixed minor bug where database name wasn't set in zebra_record_fetch. - * - * Revision 1.10 1999/05/26 07:49:13 adam - * C++ compilation. - * - * Revision 1.9 1999/05/20 12:57:18 adam - * Implemented TCL filter. Updated recctrl system. - * - * Revision 1.8 1999/03/09 16:27:49 adam - * More work on SDRKit integration. - * - * Revision 1.7 1999/03/02 16:15:43 quinn - * Added "tagsysno" and "tagrank" directives to zebra.cfg. - * - * Revision 1.6 1999/02/18 15:01:25 adam - * Minor changes. - * - * Revision 1.5 1999/02/17 11:29:56 adam - * Fixed in record_fetch. Minor updates to API. - * - * Revision 1.4 1999/02/02 14:51:07 adam - * Updated WIN32 code specific sections. Changed header. - * - * Revision 1.3 1998/10/28 10:54:40 adam - * SDRKit integration. - * - * Revision 1.2 1998/10/16 08:14:33 adam - * Updated record control system. - * - * Revision 1.1 1998/03/05 08:45:13 adam - * New result set model and modular ranking system. Moved towards - * descent server API. System information stored as "SGML" records. - * - */ +/* $Id: retrieve.c,v 1.54 2006-11-17 08:20:17 marc Exp $ + Copyright (C) 1995-2006 + Index Data ApS + +This file is part of the Zebra server. + +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 + +*/ #include #include @@ -66,164 +27,445 @@ #ifdef WIN32 #include #include -#else +#endif +#if HAVE_UNISTD_H #include #endif #include "index.h" +#include #include -int zebra_record_ext_read (void *fh, char *buf, size_t count) -{ - struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh; - return read (fc->fd, buf, count); -} -off_t zebra_record_ext_seek (void *fh, off_t offset) -{ - struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh; - return lseek (fc->fd, offset + fc->record_offset, SEEK_SET); -} -off_t zebra_record_ext_tell (void *fh) -{ - struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh; - return lseek (fc->fd, 0, SEEK_CUR) - fc->record_offset; + +static int zebra_create_record_stream(ZebraHandle zh, + Record *rec, + struct ZebraRecStream *stream){ + + RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, *rec); + + if ((*rec)->size[recInfo_storeData] > 0){ + zebra_create_stream_mem(stream, (*rec)->info[recInfo_storeData], + (*rec)->size[recInfo_storeData]); + } + else { + char full_rep[1024]; + int fd; + + if (zh->path_reg && !yaz_is_abspath((*rec)->info[recInfo_filename])){ + strcpy(full_rep, zh->path_reg); + strcat(full_rep, "/"); + strcat(full_rep, (*rec)->info[recInfo_filename]); + } + else + strcpy(full_rep, (*rec)->info[recInfo_filename]); + + if ((fd = open (full_rep, O_BINARY|O_RDONLY)) == -1){ + yaz_log (YLOG_WARN|YLOG_ERRNO, "Retrieve fail; missing file: %s", + full_rep); + rec_free(rec); + return 14; + } + zebra_create_stream_fd(stream, fd, recordAttr->recordOffset); + } + return 0; } + + -off_t zebra_record_int_seek (void *fh, off_t offset) +static void parse_zebra_elem(const char *elem, + const char **index, size_t *index_len, + const char **type, size_t *type_len) { - struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh; - return (off_t) (fc->record_int_pos = offset); + *type = 0; + *type_len = 0; + + *index = 0; + *index_len = 0; + + if (elem && *elem) + { + const char *cp = strchr(elem, ':'); + + if (!cp) /* no colon */ + { + *index = elem; + *index_len = strlen(elem); + } + else if (cp[1] == '\0') /* 'index:' */ + { + *index = elem; + *index_len = cp - elem; + } + else + { + *index = elem; + *index_len = cp - elem; + *type = cp+1; + *type_len = strlen(cp+1); + } + } } -off_t zebra_record_int_tell (void *fh) + +int zebra_special_index_fetch(ZebraHandle zh, SYSNO sysno, ODR odr, + Record rec, + const char *elemsetname, + oid_value input_format, + oid_value *output_format, + char **rec_bufp, int *rec_lenp) { - struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh; - return (off_t) fc->record_int_pos; + const char *retrieval_index; + size_t retrieval_index_len; + const char *retrieval_type; + size_t retrieval_type_len; + WRBUF wrbuf = 0; + zebra_rec_keys_t keys; + + /* set output variables before processing possible error states */ + /* *rec_lenp = 0; */ + + /* only accept XML and SUTRS requests */ + if (input_format != VAL_TEXT_XML + && input_format != VAL_SUTRS){ + yaz_log(YLOG_WARN, "unsupported format for element set zebra::%s", + elemsetname); + *output_format = VAL_NONE; + return YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST; + } + + parse_zebra_elem(elemsetname, + &retrieval_index, &retrieval_index_len, + &retrieval_type, &retrieval_type_len); + + if (retrieval_type_len != 0 && retrieval_type_len != 1) + { + return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_; + } + + if (retrieval_index_len) + { + char retrieval_index_cstr[256]; + + if (retrieval_index_len < sizeof(retrieval_index_cstr) -1) + { + memcpy(retrieval_index_cstr, retrieval_index, retrieval_index_len); + retrieval_index_cstr[retrieval_index_len] = '\0'; + + if (zebraExplain_lookup_attr_str(zh->reg->zei, + zinfo_index_category_index, + (retrieval_type_len == 0 ? -1 : + retrieval_type[0]), + retrieval_index_cstr) == -1) + { + return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_; + } + } + } + + keys = zebra_rec_keys_open(); + zebra_rec_keys_set_buf(keys, rec->info[recInfo_delKeys], + rec->size[recInfo_delKeys], 0); + + wrbuf = wrbuf_alloc(); + if (zebra_rec_keys_rewind(keys)){ + size_t slen; + const char *str; + struct it_key key_in; + + if (input_format == VAL_TEXT_XML){ + *output_format = VAL_TEXT_XML; + /*wrbuf_printf(wrbuf, + "\n");*/ + + wrbuf_printf(wrbuf, + "\n", + sysno, elemsetname); + } + else if (input_format == VAL_SUTRS) + *output_format = VAL_SUTRS; + + + while(zebra_rec_keys_read(keys, &str, &slen, &key_in)){ + int i; + int ord = CAST_ZINT_TO_INT(key_in.mem[0]); + int index_type; + const char *db = 0; + const char *string_index = 0; + size_t string_index_len; + char dst_buf[IT_MAX_WORD]; + + zebraExplain_lookup_ord(zh->reg->zei, ord, &index_type, &db, + &string_index); + string_index_len = strlen(string_index); + if (retrieval_index == 0 + || (string_index_len == retrieval_index_len + && !memcmp(string_index, retrieval_index, + string_index_len))){ + + if (retrieval_type == 0 + || (retrieval_type_len == 1 + && retrieval_type[0] == index_type)){ + + if (input_format == VAL_TEXT_XML){ + wrbuf_printf(wrbuf, " ", + key_in.mem[key_in.len -1]); + + zebra_term_untrans(zh, index_type, dst_buf, str); + wrbuf_xmlputs(wrbuf, dst_buf); + wrbuf_printf(wrbuf, "\n"); + } + else if (input_format == VAL_SUTRS){ + wrbuf_printf(wrbuf, "%s ", string_index); + + wrbuf_printf(wrbuf, "%c", index_type); + + for (i = 1; i < key_in.len; i++) + wrbuf_printf(wrbuf, " " ZINT_FORMAT, + key_in.mem[i]); + + zebra_term_untrans(zh, index_type, dst_buf, str); + wrbuf_printf(wrbuf, " %s", dst_buf); + + wrbuf_printf(wrbuf, "\n"); + } + } + } + } + if (input_format == VAL_TEXT_XML) + wrbuf_printf(wrbuf, "\n"); + } + *rec_lenp = wrbuf_len(wrbuf); + *rec_bufp = odr_malloc(odr, *rec_lenp); + memcpy(*rec_bufp, wrbuf_buf(wrbuf), *rec_lenp); + wrbuf_free(wrbuf, 1); + zebra_rec_keys_close(keys); + return 0; } -int zebra_record_int_read (void *fh, char *buf, size_t count) + +int zebra_special_fetch(ZebraHandle zh, SYSNO sysno, ODR odr, + const char *elemsetname, + oid_value input_format, + oid_value *output_format, + char **rec_bufp, int *rec_lenp) { - struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh; - int l = fc->record_int_len - fc->record_int_pos; - if (l <= 0) + Record rec; + + /* set output variables before processing possible error states */ + /* *rec_lenp = 0; */ + + /* only accept XML and SUTRS requests */ + if (input_format != VAL_TEXT_XML + && input_format != VAL_SUTRS){ + yaz_log(YLOG_WARN, "unsupported format for element set zebra::%s", + elemsetname); + return YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST; + } + + /* processing zebra::meta::sysno elemset without fetching binary data */ + if (elemsetname && 0 == strcmp(elemsetname, "meta::sysno")) + { + char rec_str[128]; + if (input_format == VAL_SUTRS){ + sprintf(rec_str, ZINT_FORMAT, sysno); + *output_format = VAL_SUTRS; + } + else if (input_format == VAL_TEXT_XML){ + sprintf(rec_str, "\n", + sysno, elemsetname); + *output_format = VAL_TEXT_XML; + } + *rec_lenp = strlen(rec_str); + if (*rec_lenp){ + *rec_bufp = odr_strdup(odr, rec_str); + return 0; + } else { + return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS; + } + } + + /* fetching binary record up for all other display elementsets */ + rec = rec_get(zh->reg->records, sysno); + if (!rec){ + yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno); + return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS; + } + + /* processing special elementsetnames zebra::index:: */ + if (elemsetname && 0 == strncmp(elemsetname, "index::", 7)){ + + int ret = zebra_special_index_fetch(zh, sysno, odr, rec, + elemsetname + 7, + input_format, output_format, + rec_bufp, rec_lenp); + + rec_free(&rec); + return ret; + } + + /* processing special elementsetnames zebra::data */ + if (elemsetname && 0 == strcmp(elemsetname, "data")){ + struct ZebraRecStream stream; + RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, rec); + zebra_create_record_stream(zh, &rec, &stream); + *output_format = input_format; + *rec_lenp = recordAttr->recordSize; + *rec_bufp = (char *) odr_malloc(odr, *rec_lenp); + stream.readf(&stream, *rec_bufp, *rec_lenp); + stream.destroy(&stream); + rec_free(&rec); return 0; - l = (l < (int) count) ? l : count; - memcpy (buf, fc->record_int_buf + fc->record_int_pos, l); - fc->record_int_pos += l; - return l; -} + } -void zebra_record_int_end (void *fh, off_t off) -{ - struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh; - fc->offset_end = off; + if (rec) + rec_free(&rec); + return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_; } -int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream, - oid_value input_format, Z_RecordComposition *comp, - oid_value *output_format, char **rec_bufp, - int *rec_lenp, char **basenamep) + +int zebra_record_fetch(ZebraHandle zh, SYSNO sysno, int score, + zebra_snippets *hit_snippet, ODR odr, + oid_value input_format, Z_RecordComposition *comp, + oid_value *output_format, + char **rec_bufp, int *rec_lenp, char **basenamep, + char **addinfo) { Record rec; char *fname, *file_type, *basename; - RecType rt; - struct recRetrieveCtrl retrieveCtrl; - char subType[128]; - struct zebra_fetch_control fc; + const char *elemsetname; + struct ZebraRecStream stream; RecordAttr *recordAttr; void *clientData; + int return_code = 0; + + *basenamep = 0; + *addinfo = 0; + elemsetname = yaz_get_esn(comp); + + /* processing zebra special elementset names of form 'zebra:: */ + if (elemsetname && 0 == strncmp(elemsetname, "zebra::", 7)) + return zebra_special_fetch(zh, sysno, odr, + elemsetname + 7, + input_format, output_format, + rec_bufp, rec_lenp); + - rec = rec_get (zh->reg->records, sysno); + /* processing all other element set names */ + rec = rec_get(zh->reg->records, sysno); if (!rec) { - logf (LOG_DEBUG, "rec_get fail on sysno=%d", sysno); - *basenamep = 0; - return 14; + yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno); + *basenamep = 0; + return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS; } - recordAttr = rec_init_attr (zh->reg->zei, rec); + + + recordAttr = rec_init_attr(zh->reg->zei, rec); file_type = rec->info[recInfo_fileType]; fname = rec->info[recInfo_filename]; basename = rec->info[recInfo_databaseName]; - *basenamep = (char *) odr_malloc (stream, strlen(basename)+1); + *basenamep = (char *) odr_malloc (odr, strlen(basename)+1); strcpy (*basenamep, basename); - if (comp && comp->which == Z_RecordComp_simple && - comp->u.simple->which == Z_ElementSetNames_generic) - { - if (!strcmp (comp->u.simple->u.generic, "R")) - file_type = "text"; - } - if (!(rt = recType_byName (zh->reg->recTypes, - file_type, subType, &clientData))) - { - logf (LOG_WARN, "Retrieve: Cannot handle type %s", file_type); - return 14; - } - logf (LOG_DEBUG, "retrieve localno=%d score=%d", sysno, score); - retrieveCtrl.fh = &fc; - fc.fd = -1; - if (rec->size[recInfo_storeData] > 0) - { - retrieveCtrl.readf = zebra_record_int_read; - retrieveCtrl.seekf = zebra_record_int_seek; - retrieveCtrl.tellf = zebra_record_int_tell; - fc.record_int_len = rec->size[recInfo_storeData]; - fc.record_int_buf = rec->info[recInfo_storeData]; - fc.record_int_pos = 0; - logf (LOG_DEBUG, "Internal retrieve. %d bytes", fc.record_int_len); - } - else + yaz_log(YLOG_DEBUG, "retrieve localno=" ZINT_FORMAT " score=%d", + sysno, score); + + zebra_create_record_stream(zh, &rec, &stream); + { - char full_rep[1024]; + /* snippets code */ + zebra_snippets *snippet; + zebra_rec_keys_t reckeys = zebra_rec_keys_open(); + RecType rt; + struct recRetrieveCtrl retrieveCtrl; - if (zh->path_reg && !yaz_is_abspath (fname)) + retrieveCtrl.stream = &stream; + retrieveCtrl.fname = fname; + retrieveCtrl.localno = sysno; + retrieveCtrl.staticrank = recordAttr->staticrank; + retrieveCtrl.score = score; + retrieveCtrl.recordSize = recordAttr->recordSize; + retrieveCtrl.odr = odr; + retrieveCtrl.input_format = retrieveCtrl.output_format = input_format; + retrieveCtrl.comp = comp; + retrieveCtrl.encoding = zh->record_encoding; + retrieveCtrl.diagnostic = 0; + retrieveCtrl.addinfo = 0; + retrieveCtrl.dh = zh->reg->dh; + retrieveCtrl.res = zh->res; + retrieveCtrl.rec_buf = 0; + retrieveCtrl.rec_len = -1; + retrieveCtrl.hit_snippet = hit_snippet; + retrieveCtrl.doc_snippet = zebra_snippets_create(); + + zebra_rec_keys_set_buf(reckeys, + rec->info[recInfo_delKeys], + rec->size[recInfo_delKeys], + 0); + zebra_rec_keys_to_snippets(zh, reckeys, retrieveCtrl.doc_snippet); + zebra_rec_keys_close(reckeys); + +#if 0 + /* for debugging purposes */ + yaz_log(YLOG_LOG, "DOC SNIPPET:"); + zebra_snippets_log(retrieveCtrl.doc_snippet, YLOG_LOG); + yaz_log(YLOG_LOG, "HIT SNIPPET:"); + zebra_snippets_log(retrieveCtrl.hit_snippet, YLOG_LOG); +#endif + snippet = zebra_snippets_window(retrieveCtrl.doc_snippet, + retrieveCtrl.hit_snippet, + 10); +#if 0 + /* for debugging purposes */ + yaz_log(YLOG_LOG, "WINDOW SNIPPET:"); + zebra_snippets_log(snippet, YLOG_LOG); +#endif + + if (!(rt = recType_byName(zh->reg->recTypes, zh->res, + file_type, &clientData))) { - strcpy (full_rep, zh->path_reg); - strcat (full_rep, "/"); - strcat (full_rep, fname); + return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS; } else - strcpy (full_rep, fname); - - - if ((fc.fd = open (full_rep, O_BINARY|O_RDONLY)) == -1) { - logf (LOG_WARN|LOG_ERRNO, "Retrieve fail; missing file: %s", - full_rep); - rec_rm (&rec); - return 14; + (*rt->retrieve)(clientData, &retrieveCtrl); + return_code = retrieveCtrl.diagnostic; + + *output_format = retrieveCtrl.output_format; + *rec_bufp = (char *) retrieveCtrl.rec_buf; + *rec_lenp = retrieveCtrl.rec_len; + *addinfo = retrieveCtrl.addinfo; } - fc.record_offset = recordAttr->recordOffset; - retrieveCtrl.readf = zebra_record_ext_read; - retrieveCtrl.seekf = zebra_record_ext_seek; - retrieveCtrl.tellf = zebra_record_ext_tell; + zebra_snippets_destroy(snippet); + zebra_snippets_destroy(retrieveCtrl.doc_snippet); + } - zebra_record_ext_seek (retrieveCtrl.fh, 0); - } - retrieveCtrl.subType = subType; - retrieveCtrl.localno = sysno; - retrieveCtrl.score = score; - retrieveCtrl.recordSize = recordAttr->recordSize; - retrieveCtrl.odr = stream; - retrieveCtrl.input_format = retrieveCtrl.output_format = input_format; - retrieveCtrl.comp = comp; - retrieveCtrl.diagnostic = 0; - retrieveCtrl.dh = zh->reg->dh; - retrieveCtrl.res = zh->res; - retrieveCtrl.rec_buf = 0; - retrieveCtrl.rec_len = -1; - - (*rt->retrieve)(clientData, &retrieveCtrl); - *output_format = retrieveCtrl.output_format; - *rec_bufp = (char *) retrieveCtrl.rec_buf; - *rec_lenp = retrieveCtrl.rec_len; - if (fc.fd != -1) - close (fc.fd); - rec_rm (&rec); - - return retrieveCtrl.diagnostic; + stream.destroy(&stream); + rec_free(&rec); + + return return_code; } + +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ +