Zebra with full functionality
[idzebra-moved-to-github.git] / index / zserver.c
index 0509ecb..66217cd 100644 (file)
@@ -1,283 +1,8 @@
 /*
- * Copyright (C) 1995-2000, Index Data 
+ * Copyright (C) 1995-2002, Index Data 
  * All rights reserved.
  *
- * $Log: zserver.c,v $
- * Revision 1.80  2000-09-05 14:04:05  adam
- * Updates for prefix 'yaz_' for YAZ log functions.
- *
- * Revision 1.79  2000/05/09 10:56:50  adam
- * Added call to xmalloc/nmem debugging functions.
- *
- * Revision 1.78  2000/04/05 09:49:35  adam
- * On Unix, zebra/z'mbol uses automake.
- *
- * Revision 1.77  2000/03/20 19:08:36  adam
- * Added remote record import using Z39.50 extended services and Segment
- * Requests.
- *
- * Revision 1.76  2000/03/15 15:00:31  adam
- * First work on threaded version.
- *
- * Revision 1.75  1999/11/30 13:48:04  adam
- * Improved installation. Updated for inclusion of YAZ header files.
- *
- * Revision 1.74  1999/11/29 15:13:26  adam
- * Server sets implementationName - and Version.
- *
- * Revision 1.73  1999/11/04 15:00:45  adam
- * Implemented delete result set(s).
- *
- * Revision 1.71  1999/07/14 10:59:26  adam
- * Changed functions isc_getmethod, isams_getmethod.
- * Improved fatal error handling (such as missing EXPLAIN schema).
- *
- * Revision 1.70  1999/06/10 12:14:56  adam
- * Fixed to use bend_start instead of pre_init.
- *
- * Revision 1.69  1999/06/10 09:20:03  adam
- * Minor change to pre_init handler.
- *
- * Revision 1.68  1999/05/26 07:49:13  adam
- * C++ compilation.
- *
- * Revision 1.67  1999/02/02 14:51:14  adam
- * Updated WIN32 code specific sections. Changed header.
- *
- * Revision 1.66  1998/10/28 10:54:41  adam
- * SDRKit integration.
- *
- * Revision 1.65  1998/10/18 07:54:54  adam
- * Additional info added for diagnostics 114 (Unsupported use attribute) and
- * 121 (Unsupported attribute set).
- *
- * Revision 1.64  1998/09/22 10:48:21  adam
- * Minor changes in search API.
- *
- * Revision 1.63  1998/09/02 13:53:21  adam
- * Extra parameter decode added to search routines to implement
- * persistent queries.
- *
- * Revision 1.62  1998/08/06 14:35:28  adam
- * Routine bend_deleterequest removed.
- *
- * Revision 1.61  1998/06/24 12:16:15  adam
- * Support for relations on text operands. Open range support in
- * DFA module (i.e. [-j], [g-]).
- *
- * Revision 1.60  1998/06/22 11:36:49  adam
- * Added authentication check facility to zebra.
- *
- * Revision 1.59  1998/06/12 12:22:13  adam
- * Work on Zebra API.
- *
- * Revision 1.58  1998/05/27 16:57:46  adam
- * Zebra returns surrogate diagnostic for single records when
- * appropriate.
- *
- * Revision 1.57  1998/04/03 14:45:18  adam
- * Fixed setting of last_in_set in bend_fetch.
- *
- * Revision 1.56  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.
- *
- * Revision 1.55  1998/02/10 12:03:06  adam
- * Implemented Sort.
- *
- * Revision 1.54  1998/01/29 13:39:13  adam
- * Compress ISAM is default.
- *
- * Revision 1.53  1998/01/12 15:04:09  adam
- * The test option (-s) only uses read-lock (and not write lock).
- *
- * Revision 1.52  1997/11/18 10:05:08  adam
- * Changed character map facility so that admin can specify character
- * mapping files for each register type, w, p, etc.
- *
- * Revision 1.51  1997/10/27 14:33:06  adam
- * Moved towards generic character mapping depending on "structure"
- * field in abstract syntax file. Fixed a few memory leaks. Fixed
- * bug with negative integers when doing searches with relational
- * operators.
- *
- * Revision 1.50  1997/09/29 09:08:36  adam
- * Revised locking system to be thread safe for the server.
- *
- * Revision 1.49  1997/09/25 14:57:23  adam
- * Windows NT port.
- *
- * Revision 1.48  1997/09/17 12:19:19  adam
- * Zebra version corresponds to YAZ version 1.4.
- * Changed Zebra server so that it doesn't depend on global common_resource.
- *
- * Revision 1.47  1997/09/04 13:58:36  adam
- * New retrieve/extract method tellf (added).
- * Added O_BINARY for open calls.
- *
- * Revision 1.46  1997/07/28 08:30:47  adam
- * Server returns diagnostic 14 when record doesn't exist.
- *
- * Revision 1.45  1996/12/23 15:30:45  adam
- * Work on truncation.
- * Bug fix: result sets weren't deleted after server shut down.
- *
- * Revision 1.44  1996/12/11 12:08:01  adam
- * Added better compression.
- *
- * Revision 1.43  1996/11/15 15:03:58  adam
- * Logging of execution speed by using the times(2) call.
- *
- * Revision 1.42  1996/11/08  11:10:36  adam
- * Buffers used during file match got bigger.
- * Compressed ISAM support everywhere.
- * Bug fixes regarding masking characters in queries.
- * Redesigned Regexp-2 queries.
- *
- * Revision 1.41  1996/10/29 14:09:56  adam
- * Use of cisam system - enabled if setting isamc is 1.
- *
- * Revision 1.40  1996/06/04 10:19:02  adam
- * Minor changes - removed include of ctype.h.
- *
- * Revision 1.39  1996/05/31  09:07:05  quinn
- * Work on character-set handling
- *
- * Revision 1.38  1996/05/14  11:34:01  adam
- * Scan support in multiple registers/databases.
- *
- * Revision 1.37  1996/05/14  06:16:48  adam
- * Compact use/set bytes used in search service.
- *
- * Revision 1.36  1996/05/01 13:46:37  adam
- * First work on multiple records in one file.
- * New option, -offset, to the "unread" command in the filter module.
- *
- * Revision 1.35  1996/03/26  16:01:14  adam
- * New setting lockPath: directory of various lock files.
- *
- * Revision 1.34  1996/03/20  09:36:46  adam
- * Function dict_lookup_grep got extra parameter, init_pos, which marks
- * from which position in pattern approximate pattern matching should occur.
- * Approximate pattern matching is used in relevance=re-2.
- *
- * Revision 1.33  1996/01/17  14:57:56  adam
- * Prototype changed for reader functions in extract/retrieve. File
- *  is identified by 'void *' instead of 'int.
- *
- * Revision 1.32  1995/12/11  09:12:58  adam
- * The rec_get function returns NULL if record doesn't exist - will
- * happen in the server if the result set records have been deleted since
- * the creation of the set (i.e. the search).
- * The server saves a result temporarily if it is 'volatile', i.e. the
- * set is register dependent.
- *
- * Revision 1.31  1995/12/08  16:22:56  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.30  1995/12/07  17:38:48  adam
- * Work locking mechanisms for concurrent updates/commit.
- *
- * Revision 1.29  1995/12/04  14:22:32  adam
- * Extra arg to recType_byName.
- * Started work on new regular expression parsed input to
- * structured records.
- *
- * Revision 1.28  1995/11/28  09:09:48  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.27  1995/11/27  13:58:54  adam
- * New option -t. storeStore data implemented in server.
- *
- * Revision 1.26  1995/11/25  10:24:07  adam
- * More record fields - they are enumerated now.
- * New options: flagStoreData flagStoreKey.
- *
- * Revision 1.25  1995/11/21  15:29:13  adam
- * Config file 'base' read by default by both indexer and server.
- *
- * Revision 1.24  1995/11/20  16:59:47  adam
- * New update method: the 'old' keys are saved for each records.
- *
- * Revision 1.23  1995/11/16  17:00:56  adam
- * Better logging of rpn query.
- *
- * Revision 1.22  1995/11/16  15:34:55  adam
- * Uses new record management system in both indexer and server.
- *
- * Revision 1.21  1995/11/01  16:25:52  quinn
- * *** empty log message ***
- *
- * Revision 1.20  1995/10/27  14:00:12  adam
- * Implemented detection of database availability.
- *
- * Revision 1.19  1995/10/17  18:02:11  adam
- * New feature: databases. Implemented as prefix to words in dictionary.
- *
- * Revision 1.18  1995/10/16  14:03:09  quinn
- * Changes to support element set names and espec1
- *
- * Revision 1.17  1995/10/16  09:32:40  adam
- * More work on relational op.
- *
- * Revision 1.16  1995/10/13  12:26:44  adam
- * Optimization of truncation.
- *
- * Revision 1.15  1995/10/12  12:40:55  adam
- * Bug fixes in rpn_prox.
- *
- * Revision 1.14  1995/10/09  16:18:37  adam
- * Function dict_lookup_grep got extra client data parameter.
- *
- * Revision 1.13  1995/10/06  14:38:00  adam
- * New result set method: r_score.
- * Local no (sysno) and score is transferred to retrieveCtrl.
- *
- * Revision 1.12  1995/10/06  13:52:06  adam
- * Bug fixes. Handler may abort further scanning.
- *
- * Revision 1.11  1995/10/06  10:43:57  adam
- * Scan added. 'occurrences' in scan entries not set yet.
- *
- * Revision 1.10  1995/10/02  16:43:32  quinn
- * Set default resulting record type in fetch.
- *
- * Revision 1.9  1995/10/02  15:18:52  adam
- * New member in recRetrieveCtrl: diagnostic.
- *
- * Revision 1.8  1995/09/28  09:19:47  adam
- * xfree/xmalloc used everywhere.
- * Extract/retrieve method seems to work for text records.
- *
- * Revision 1.7  1995/09/27  16:17:32  adam
- * More work on retrieve.
- *
- * Revision 1.6  1995/09/08  08:53:22  adam
- * Record buffer maintained in server_info.
- *
- * Revision 1.5  1995/09/06  16:11:18  adam
- * Option: only one word key per file.
- *
- * Revision 1.4  1995/09/06  10:33:04  adam
- * More work on present. Some log messages removed.
- *
- * Revision 1.3  1995/09/05  15:28:40  adam
- * More work on search engine.
- *
- * Revision 1.2  1995/09/04  12:33:43  adam
- * Various cleanup. YAZ util used instead.
- *
- * Revision 1.1  1995/09/04  09:10:41  adam
- * More work on index add/del/update.
- * Merge sort implemented.
- * Initial work on z39 server.
- *
+ * $Id: zserver.c,v 1.87 2002-04-05 08:46:26 adam Exp $
  */
 
 #include <stdio.h>
 
 #include "zserver.h"
 
-#ifndef ZEBRASDR
-#define ZEBRASDR 0
-#endif
-#if ZEBRASDR
-#include "zebrasdr.h"
-#endif
-
 static int bend_sort (void *handle, bend_sort_rr *rr);
 static int bend_delete (void *handle, bend_delete_rr *rr);
 static int bend_esrequest (void *handle, bend_esrequest_rr *rr);
@@ -331,15 +49,20 @@ bend_initresult *bend_init (bend_initrequest *q)
     q->bend_fetch = bend_fetch;
     q->bend_scan = bend_scan;
 
+#if ZMBOL
     q->implementation_name = "Z'mbol Information Server";
-    q->implementation_version = "Z'mbol 1.0";
+    q->implementation_version = "Z'mbol " ZEBRAVER;
+#else
+    q->implementation_name = "Zebra Information Server";
+    q->implementation_version = "Zebra " ZEBRAVER;
+#endif
 
     logf (LOG_DEBUG, "bend_init");
 
     sob = statserv_getcontrol ();
     if (!(zh = zebra_open (sob->handle)))
     {
-       logf (LOG_FATAL, "Failed to open Zebra `%s'", sob->configname);
+       yaz_log (LOG_FATAL, "Failed to open config `%s'", sob->configname);
        r->errcode = 1;
        return r;
     }
@@ -358,7 +81,7 @@ bend_initresult *bend_init (bend_initrequest *q)
            xfree (openpass);
        }
     }
-    if (zebra_auth (zh->service, user, passwd))
+    if (zebra_auth (zh, user, passwd))
     {
        r->errcode = 222;
        r->errstring = user;
@@ -369,6 +92,76 @@ bend_initresult *bend_init (bend_initrequest *q)
     return r;
 }
 
+static void search_terms (ZebraHandle zh, bend_search_rr *r)
+{
+    int count;
+    int no_terms;
+    int i;
+    struct Z_External *ext;
+    Z_SearchInfoReport *sr;
+
+    /* get no of terms for result set */
+    zebra_resultSetTerms (zh, r->setname, -1, &count, &no_terms);
+    if (!no_terms)
+        return;
+
+    r->search_info = odr_malloc (r->stream, sizeof(*r->search_info));
+
+    r->search_info->num_elements = 1;
+    r->search_info->list =
+        odr_malloc (r->stream, sizeof(*r->search_info->list));
+    r->search_info->list[0] =
+        odr_malloc (r->stream, sizeof(**r->search_info->list));
+    r->search_info->list[0]->category = 0;
+    r->search_info->list[0]->which = Z_OtherInfo_externallyDefinedInfo;
+    ext = odr_malloc (r->stream, sizeof(*ext));
+    r->search_info->list[0]->information.externallyDefinedInfo = ext;
+    ext->direct_reference =
+        yaz_oidval_to_z3950oid (r->stream, CLASS_USERINFO, VAL_SEARCHRES1);
+    ext->indirect_reference = 0;
+    ext->descriptor = 0;
+    ext->which = Z_External_searchResult1;
+    sr = odr_malloc (r->stream, sizeof(Z_SearchInfoReport));
+    ext->u.searchResult1 = sr;
+    sr->num = no_terms;
+    sr->elements = odr_malloc (r->stream, sr->num *
+                               sizeof(*sr->elements));
+    for (i = 0; i<no_terms; i++)
+    {
+        Z_Term *term;
+        const char *termz = zebra_resultSetTerms (zh, r->setname, i,
+                                                  &count, &no_terms);
+        
+        sr->elements[i] = odr_malloc (r->stream, sizeof(**sr->elements));
+        sr->elements[i]->subqueryId = 0;
+        sr->elements[i]->fullQuery = odr_malloc (r->stream, 
+                                                 sizeof(bool_t));
+        *sr->elements[i]->fullQuery = 0;
+        sr->elements[i]->subqueryExpression = 
+            odr_malloc (r->stream, sizeof(Z_QueryExpression));
+        sr->elements[i]->subqueryExpression->which = 
+            Z_QueryExpression_term;
+        sr->elements[i]->subqueryExpression->u.term =
+            odr_malloc (r->stream, sizeof(Z_QueryExpressionTerm));
+        term = odr_malloc (r->stream, sizeof(Z_Term));
+        sr->elements[i]->subqueryExpression->u.term->queryTerm = term;
+
+        term->which = Z_Term_general;
+        term->u.general = odr_malloc (r->stream, sizeof(Odr_oct));
+        term->u.general->buf = odr_strdup (r->stream, termz);
+
+        term->u.general->len = strlen (termz);
+        term->u.general->size = strlen (termz);
+        
+        sr->elements[i]->subqueryExpression->u.term->termComment = 0;
+        sr->elements[i]->subqueryInterpretation = 0;
+        sr->elements[i]->subqueryRecommendation = 0;
+        sr->elements[i]->subqueryCount = odr_intdup (r->stream, count);
+        sr->elements[i]->subqueryWeight = 0;
+        sr->elements[i]->resultsByDB = 0;
+    }
+}
+
 int bend_search (void *handle, bend_search_rr *r)
 {
     ZebraHandle zh = (ZebraHandle) handle;
@@ -377,15 +170,21 @@ int bend_search (void *handle, bend_search_rr *r)
     r->errcode = 0;
     r->errstring = NULL;
     
+    if (zebra_select_databases (zh, r->num_bases,
+                                (const char **) r->basenames))
+    {
+        zebra_result (zh, &r->errcode, &r->errstring);
+        return 0;
+    }
     logf (LOG_LOG, "ResultSet '%s'", r->setname);
     switch (r->query->which)
     {
     case Z_Query_type_1: case Z_Query_type_101:
        zebra_search_rpn (zh, r->decode, r->stream, r->query->u.type_1,
-                         r->num_bases, r->basenames, r->setname);
-       r->errcode = zh->errCode;
-       r->errstring = zh->errString;
-       r->hits = zh->hits;
+                         r->setname, &r->hits);
+        zebra_result (zh, &r->errcode, &r->errstring);
+        if (!r->errcode)
+            search_terms (zh, r);
         break;
     case Z_Query_type_2:
        r->errcode = 107;
@@ -397,6 +196,7 @@ int bend_search (void *handle, bend_search_rr *r)
     return 0;
 }
 
+
 int bend_fetch (void *handle, bend_fetch_rr *r)
 {
     ZebraHandle zh = (ZebraHandle) handle;
@@ -407,19 +207,16 @@ int bend_fetch (void *handle, bend_fetch_rr *r)
     r->last_in_set = 0;
     zebra_records_retrieve (zh, r->stream, r->setname, r->comp,
                            r->request_format, 1, &retrievalRecord);
-    if (zh->errCode)                  /* non Surrogate Diagnostic */
-    {
-       r->errcode = zh->errCode;
-       r->errstring = zh->errString;
-    }
-    else if (retrievalRecord.errCode) /* Surrogate Diagnostic */
+    zebra_result (zh, &r->errcode, &r->errstring);
+    /*  non Surrogate Diagnostic OR Surrogate Diagnostic */
+    if (r->errcode == 0 && retrievalRecord.errCode)
     {
        r->surrogate_flag = 1;
        r->errcode = retrievalRecord.errCode;
        r->errstring = retrievalRecord.errString;
        r->basename = retrievalRecord.base;
     }
-    else                              /* Database Record */
+    else if (r->errcode == 0)        /* Database Record */
     {
        r->errcode = 0;
        r->basename = retrievalRecord.base;
@@ -435,12 +232,17 @@ static int bend_scan (void *handle, bend_scan_rr *r)
     ZebraScanEntry *entries;
     ZebraHandle zh = (ZebraHandle) handle;
     int is_partial, i;
-    
+
+    if (zebra_select_databases (zh, r->num_bases, 
+                                (const char **) r->basenames))
+    {
+        zebra_result (zh, &r->errcode, &r->errstring);
+        return 0;
+    }
     r->entries = (struct scan_entry *)
        odr_malloc (r->stream, sizeof(*r->entries) * r->num_entries);
     zebra_scan (zh, r->stream, r->term,
                r->attributeset,
-               r->num_bases, r->basenames,
                &r->term_position,
                &r->num_entries, &entries, &is_partial);
     if (is_partial)
@@ -452,8 +254,7 @@ static int bend_scan (void *handle, bend_scan_rr *r)
        r->entries[i].term = entries[i].term;
        r->entries[i].occurrences = entries[i].occurrences;
     }
-    r->errcode = zh->errCode;
-    r->errstring = zh->errString;
+    zebra_result (zh, &r->errcode, &r->errstring);
     return 0;
 }
 
@@ -471,8 +272,7 @@ int bend_sort (void *handle, bend_sort_rr *rr)
     zebra_sort (zh, rr->stream,
                 rr->num_input_setnames, (const char **) rr->input_setnames,
                rr->output_setname, rr->sort_sequence, &rr->sort_status);
-    rr->errcode = zh->errCode;
-    rr->errstring = zh->errString;
+    zebra_result (zh, &rr->errcode, &rr->errstring);
     return 0;
 }
 
@@ -523,7 +323,6 @@ static int es_admin_request (ZebraHandle zh, Z_AdminEsRequest *r)
        break;
     default:
        yaz_log(LOG_LOG, "unknown admin");
-       zh->errCode = 1001;
     }
     if (r->toKeep->databaseName)
     {
@@ -543,7 +342,6 @@ static int es_admin (ZebraHandle zh, Z_Admin *r)
        yaz_log (LOG_LOG, "adm taskpackage (unhandled)");
        break;
     default:
-       zh->errCode = 1001;
        break;
     }
 
@@ -578,8 +376,8 @@ int bend_esrequest (void *handle, bend_esrequest_rr *rr)
     else if (rr->esr->taskSpecificParameters->which == Z_External_ESAdmin)
     {
        es_admin (zh, rr->esr->taskSpecificParameters->u.adminService);
-       rr->errcode = zh->errCode;
-       rr->errstring = zh->errString;
+
+        zebra_result (zh, &rr->errcode, &rr->errstring);
     }
     else if (rr->esr->taskSpecificParameters->which == Z_External_itemOrder)
     {
@@ -834,7 +632,7 @@ int main (int argc, char **argv)
     struct statserv_options_block *sob;
 
     sob = statserv_getcontrol ();
-    strcpy (sob->configname, FNAME_CONFIG);
+    strcpy (sob->configname, "zebra.cfg");
     sob->bend_start = bend_start;
     sob->bend_stop = bend_stop;