Improved installation. Updated for inclusion of YAZ header files.
[idzebra-moved-to-github.git] / index / zserver.c
index b036efe..3b060d5 100644 (file)
 /*
- * Copyright (C) 1994-1995, Index Data I/S 
+ * Copyright (C) 1995-1999, Index Data 
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: zserver.c,v $
- * Revision 1.14  1995-10-09 16:18:37  adam
+ * 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
  * Initial work on z39 server.
  *
  */
+
 #include <stdio.h>
 #include <assert.h>
-#include <unistd.h>
 #include <fcntl.h>
+#ifdef WIN32
+#include <io.h>
+#include <process.h>
+#else
+#include <unistd.h>
+#endif
+
+#include <yaz/data1.h>
 
-#include <recctrl.h>
-#include <dmalloc.h>
 #include "zserver.h"
 
-ZServerInfo server_info;
+#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);
 
 bend_initresult *bend_init (bend_initrequest *q)
 {
-    static bend_initresult r;
-    static char *name = "zserver";
+    bend_initresult *r = (bend_initresult *)
+       odr_malloc (q->stream, sizeof(*r));
+    ZebraHandle zh;
+    struct statserv_options_block *sob;
+    char *user = NULL;
+    char *passwd = NULL;
+
+    r->errcode = 0;
+    r->errstring = 0;
+    q->bend_sort = bend_sort;
+    q->bend_delete = bend_delete;
 
-    r.errcode = 0;
-    r.errstring = 0;
-    r.handle = name;
+    q->implementation_name = "Z'mbol Information Server";
+    q->implementation_version = "Z'mbol 1.0";
 
-    server_info.sets = NULL;
-    if (!(server_info.sys_idx_fd = open (FNAME_SYS_IDX, O_RDONLY)))
+    logf (LOG_DEBUG, "bend_init");
+
+    sob = statserv_getcontrol ();
+    if (!(zh = zebra_open (sob->configname)))
     {
-        r.errcode = 1;
-        r.errstring = "dict_open fail: filedict";
-        return &r;
+       logf (LOG_FATAL, "Failed to open Zebra `%s'", sob->configname);
+       r->errcode = 1;
+       return r;
     }
-    if (!(server_info.fileDict = dict_open (FNAME_FILE_DICT, 10, 0)))
-    {
-        r.errcode = 1;
-        r.errstring = "dict_open fail: filedict";
-        return &r;
-    }    
-    if (!(server_info.wordDict = dict_open (FNAME_WORD_DICT, 40, 0)))
+    if (q->auth)
     {
-        dict_close (server_info.fileDict);
-        r.errcode = 1;
-        r.errstring = "dict_open fail: worddict";
-        return &r;
-    }    
-    if (!(server_info.wordIsam = is_open (FNAME_WORD_ISAM, key_compare, 0,
-                                          sizeof (struct it_key))))
+       if (q->auth->which == Z_IdAuthentication_open)
+       {
+           char *openpass = xstrdup (q->auth->u.open);
+           char *cp = strchr (openpass, '/');
+           if (cp)
+           {
+               *cp = '\0';
+               user = nmem_strdup (odr_getmem (q->stream), openpass);
+               passwd = nmem_strdup (odr_getmem (q->stream), cp+1);
+           }
+           xfree (openpass);
+       }
+    }
+    if (zebra_auth (zh, user, passwd))
     {
-        dict_close (server_info.wordDict);
-        dict_close (server_info.fileDict);
-        r.errcode = 1;
-        r.errstring = "is_open fail: wordisam";
-        return &r;
+       r->errcode = 222;
+       r->errstring = user;
+       zebra_close (zh);
+       return r;
     }
-    server_info.odr = odr_createmem (ODR_ENCODE);
-    return &r;
+    r->handle = zh;
+    return r;
 }
 
 bend_searchresult *bend_search (void *handle, bend_searchrequest *q, int *fd)
 {
-    static bend_searchresult r;
+    ZebraHandle zh = (ZebraHandle) handle;
+    bend_searchresult *r = (bend_searchresult *)
+       odr_malloc (q->stream, sizeof(*r));
 
-    r.errcode = 0;
-    r.errstring = 0;
-    r.hits = 0;
-
-    odr_reset (server_info.odr);
-    server_info.errCode = 0;
+    r->hits = 0;
+    r->errcode = 0;
+    r->errstring = NULL;
+    
+    logf (LOG_LOG, "ResultSet '%s'", q->setname);
     switch (q->query->which)
     {
-    case Z_Query_type_1:
-        r.errcode = rpn_search (&server_info, q->query->u.type_1,
-                                q->num_bases, q->basenames, q->setname,
-                                &r.hits);
+    case Z_Query_type_1: case Z_Query_type_101:
+       zebra_search_rpn (zh, q->decode, q->stream, q->query->u.type_1,
+                         q->num_bases, q->basenames, q->setname);
+       r->errcode = zh->errCode;
+       r->errstring = zh->errString;
+       r->hits = zh->hits;
         break;
+    case Z_Query_type_2:
+       r->errcode = 107;
+       r->errstring = "type-2";
+       break;
     default:
-        r.errcode = 107;
+        r->errcode = 107;
     }
-    return &r;
-}
-
-static int record_read (int fd, char *buf, size_t count)
-{
-    return read (fd, buf, count);
+    return r;
 }
 
-static int record_fetch (ZServerInfo *zi, int sysno, int score, ODR stream,
-                          oid_value input_format, oid_value *output_format,
-                          char **rec_bufp, int *rec_lenp)
+bend_fetchresult *bend_fetch (void *handle, bend_fetchrequest *q, int *num)
 {
-    char record_info[SYS_IDX_ENTRY_LEN];
-    char *fname, *file_type;
-    RecType rt;
-    struct recRetrieveCtrl retrieveCtrl;
+    ZebraHandle zh = (ZebraHandle) handle;
+    bend_fetchresult *r = (bend_fetchresult *)
+       odr_malloc (q->stream, sizeof(*r));
+    ZebraRetrievalRecord retrievalRecord;
 
-    if (lseek (zi->sys_idx_fd, sysno * SYS_IDX_ENTRY_LEN,
-               SEEK_SET) == -1)
-    {
-        logf (LOG_FATAL|LOG_ERRNO, "Retrieve: lseek of sys_idx");
-        exit (1);
-    }
-    if (read (zi->sys_idx_fd, record_info, SYS_IDX_ENTRY_LEN) == -1)
+    retrievalRecord.position = q->number;
+    
+    r->last_in_set = 0;
+    zebra_records_retrieve (zh, q->stream, q->setname, q->comp,
+                           q->format, 1, &retrievalRecord);
+    if (zh->errCode)                  /* non Surrogate Diagnostic */
     {
-        logf (LOG_FATAL|LOG_ERRNO, "Retrieve: read of sys_idx");
-        exit (1);
+       r->errcode = zh->errCode;
+       r->errstring = zh->errString;
     }
-    file_type = record_info;
-    fname = record_info + strlen(record_info) + 1;
-    if (!(rt = recType_byName (file_type)))
+    else if (retrievalRecord.errCode) /* Surrogate Diagnostic */
     {
-        logf (LOG_FATAL|LOG_ERRNO, "Retrieve: Cannot handle type %s", 
-              file_type);
-        exit (1);
+       q->surrogate_flag = 1;
+       r->errcode = retrievalRecord.errCode;
+       r->errstring = retrievalRecord.errString;
+       r->basename = retrievalRecord.base;
     }
-    if ((retrieveCtrl.fd = open (fname, O_RDONLY)) == -1)
+    else                              /* Database Record */
     {
-        logf (LOG_FATAL|LOG_ERRNO, "Retrieve: Open record file %s", fname);
-        exit (1);
+       r->errcode = 0;
+       r->basename = retrievalRecord.base;
+       r->record = retrievalRecord.buf;
+       r->len = retrievalRecord.len;
+       r->format = retrievalRecord.format;
     }
-    logf (LOG_DEBUG, "retrieve localno=%d score=%d", sysno, score);
-    retrieveCtrl.localno = sysno;
-    retrieveCtrl.score = score;
-    retrieveCtrl.odr = stream;
-    retrieveCtrl.readf = record_read;
-    retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
-    retrieveCtrl.diagnostic = 0;
-    (*rt->retrieve)(&retrieveCtrl);
-    *output_format = retrieveCtrl.output_format;
-    *rec_bufp = retrieveCtrl.rec_buf;
-    *rec_lenp = retrieveCtrl.rec_len;
-    close (retrieveCtrl.fd);
-    return retrieveCtrl.diagnostic;
+    return r;
 }
 
-bend_fetchresult *bend_fetch (void *handle, bend_fetchrequest *q, int *num)
+bend_scanresult *bend_scan (void *handle, bend_scanrequest *q, int *num)
 {
-    static bend_fetchresult r;
-    int positions[2];
-    ZServerSetSysno *records;
+    ZebraScanEntry *entries;
+    ZebraHandle zh = (ZebraHandle) handle;
+    bend_scanresult *r = (bend_scanresult *)
+       odr_malloc (q->stream, sizeof(*r));
+    int is_partial, i;
+    
+    r->term_position = q->term_position;
+    r->num_entries = q->num_entries;
 
-    r.errstring = 0;
-    r.last_in_set = 0;
-    r.basename = "base";
-
-    odr_reset (server_info.odr);
-    server_info.errCode = 0;
-
-    positions[0] = q->number;
-    records = resultSetSysnoGet (&server_info, q->setname, 1, positions);
-    if (!records)
-    {
-        logf (LOG_DEBUG, "resultSetRecordGet, error");
-        r.errcode = 13;
-        return &r;
-    }
-    if (!records[0].sysno)
+    r->entries = (struct scan_entry *)
+       odr_malloc (q->stream, sizeof(*r->entries) * q->num_entries);
+    zebra_scan (zh, q->stream, q->term,
+               q->attributeset,
+               q->num_bases, q->basenames,
+               &r->term_position,
+               &r->num_entries, &entries, &is_partial);
+    if (is_partial)
+       r->status = BEND_SCAN_PARTIAL;
+    else
+       r->status = BEND_SCAN_SUCCESS;
+    for (i = 0; i < r->num_entries; i++)
     {
-        r.errcode = 13;
-        logf (LOG_DEBUG, "Out of range. pos=%d", q->number);
-        return &r;
+       r->entries[i].term = entries[i].term;
+       r->entries[i].occurrences = entries[i].occurrences;
     }
-    r.errcode = record_fetch (&server_info, records[0].sysno,
-                              records[0].score, q->stream,
-                              q->format, &r.format, &r.record, &r.len);
-    return &r;
+    r->errcode = zh->errCode;
+    r->errstring = zh->errString;
+    return r;
 }
 
-bend_deleteresult *bend_delete (void *handle, bend_deleterequest *q, int *num)
+void bend_close (void *handle)
 {
-    return 0;
+    zebra_close ((ZebraHandle) handle);
 }
 
-bend_scanresult *bend_scan (void *handle, bend_scanrequest *q, int *num)
+int bend_sort (void *handle, bend_sort_rr *rr)
 {
-    static bend_scanresult r;
-    int status;
+    ZebraHandle zh = (ZebraHandle) handle;
+
+    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;
+    return 0;
+}
 
-    odr_reset (server_info.odr);
-    server_info.errCode = 0;
+int bend_delete (void *handle, bend_delete_rr *rr)
+{
+    ZebraHandle zh = (ZebraHandle) handle;
 
-    r.errstring = 0;
-    r.term_position = q->term_position;
-    r.num_entries = q->num_entries;
-    r.errcode = rpn_scan (&server_info, server_info.odr, q->term,
-                          &r.term_position,
-                          &r.num_entries, &r.entries, &status);
-    r.status = status;
-    return &r;
+    rr->delete_status =        zebra_deleleResultSet(zh, rr->function,
+                                             rr->num_setnames, rr->setnames,
+                                             rr->statuses);
+    return 0;
 }
 
-void bend_close (void *handle)
+#ifndef WIN32
+static void bend_start (struct statserv_options_block *sob)
 {
-    dict_close (server_info.fileDict);
-    dict_close (server_info.wordDict);
-    is_close (server_info.wordIsam);
-    close (server_info.sys_idx_fd);
-    return;
+    if (!sob->inetd) 
+    {
+        char *pidfile = "zebrasrv.pid";
+        int fd = creat (pidfile, 0666);
+        if (fd == -1)
+            logf (LOG_WARN|LOG_ERRNO, "creat %s", pidfile);
+        else
+        {
+           char pidstr[30];
+       
+           sprintf (pidstr, "%ld", (long) getpid ());
+           write (fd, pidstr, strlen(pidstr));
+           close (fd);
+        }
+    }
 }
+#endif
 
 int main (int argc, char **argv)
 {
-    char *base_name = "base";
+    struct statserv_options_block *sob;
 
-    if (!(common_resource = res_open (base_name)))
-    {
-        logf (LOG_FATAL, "Cannot open resource `%s'", base_name);
-        exit (1);
-    }
+    sob = statserv_getcontrol ();
+    strcpy (sob->configname, FNAME_CONFIG);
+#ifndef WIN32
+    sob->bend_start = bend_start;
+#endif
+    statserv_setcontrol (sob);
+
+#if ZEBRASDR
+    zebraSdr_std ();
+#endif
     return statserv_main (argc, argv);
 }