New result set model and modular ranking system. Moved towards
[idzebra-moved-to-github.git] / index / zserver.c
index 9013c55..a6ecfd3 100644 (file)
 /*
- * Copyright (C) 1994-1995, Index Data I/S 
+ * Copyright (C) 1995-1998, Index Data I/S 
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: zserver.c,v $
- * Revision 1.31  1995-12-08 16:22:56  adam
+ * 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.
  * Initial work on z39 server.
  *
  */
+
 #include <stdio.h>
 #include <assert.h>
-#include <unistd.h>
 #include <fcntl.h>
+#ifdef WINDOWS
+#include <io.h>
+#include <process.h>
+#else
+#include <unistd.h>
+#endif
 
-#include <common.h>
 #include <data1.h>
-#include <recctrl.h>
 #include <dmalloc.h>
-#include "zserver.h"
-
-ZServerInfo server_info;
-
-static int register_lock (ZServerInfo *zi)
-{
-    time_t lastChange;
-    int state = zebraServerLockGetState(&lastChange);
 
-    switch (state)
-    {
-    case 'c':
-        state = 1;
-        break;
-    default:
-        state = 0;
-    }
-    zebraServerLock (state);
-    if (zi->registerState == state)
-    {
-        if (zi->registerChange >= lastChange)
-            return 0;
-        logf (LOG_LOG, "Register completely updated since last access");
-    }
-    else if (zi->registerState == -1)
-        logf (LOG_LOG, "Reading register using state %d pid=%ld", state,
-              (long) getpid());
-    else
-        logf (LOG_LOG, "Register has changed state from %d to %d",
-              zi->registerState, state);
-    zi->registerChange = lastChange;
-    if (zi->records)
-    {
-        dict_close (zi->wordDict);
-        is_close (zi->wordIsam);
-        rec_close (&zi->records);
-    }
-    bf_cache (state);
-    zi->registerState = state;
-    zi->records = rec_open (0);
-    if (!(zi->wordDict = dict_open (FNAME_WORD_DICT, 40, 0)))
-        return -1;
-    if (!(zi->wordIsam = is_open (FNAME_WORD_ISAM, key_compare, 0,
-                                  sizeof (struct it_key))))
-        return -1;
-    return 0;
-}
+#include "zserver.h"
 
-static int register_unlock (ZServerInfo *zi)
-{
-    if (zi->registerState != -1)
-        zebraServerUnlock (zi->registerState);
-}
+static int bend_sort (void *handle, bend_sort_rr *rr);
 
 bend_initresult *bend_init (bend_initrequest *q)
 {
-    static bend_initresult r;
-    static char *name = "zserver";
+    bend_initresult *r = odr_malloc (q->stream, sizeof(*r));
+    ZebraHandle zh;
+    struct statserv_options_block *sob;
 
-    r.errcode = 0;
-    r.errstring = 0;
-    r.handle = name;
+    r->errcode = 0;
+    r->errstring = 0;
+    q->bend_sort = bend_sort;
 
     logf (LOG_DEBUG, "bend_init");
 
-    if (!common_resource)
+    sob = statserv_getcontrol ();
+    if (!(zh = zebra_open (NULL, sob->configname)))
     {
-        struct statserv_options_block *sob;
-
-        sob = statserv_getcontrol ();
-        logf (LOG_LOG, "Reading resources from %s", sob->configname);
-        if (!(common_resource = res_open (sob->configname)))
-        {
-            logf (LOG_FATAL, "Cannot open resource `%s'", sob->configname);
-            exit (1);
-        }
+       logf (LOG_FATAL, "Failed to open Zebra `%s'", sob->configname);
+       r->errcode = 1;
+       return r;
     }
-    data1_tabpath = res_get(common_resource, "profilePath");
-    server_info.sets = NULL;
-    server_info.registerState = -1;  /* trigger open of registers! */
-    server_info.registerChange = 0;
-
-    server_info.records = NULL;
-    server_info.wordDict = NULL;
-    server_info.wordIsam = NULL;
-    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;
-
-    r.errcode = 0;
-    r.errstring = 0;
-    r.hits = 0;
-
-    register_lock (&server_info);
-    odr_reset (server_info.odr);
-    server_info.errCode = 0;
-    server_info.errString = NULL;
+    ZebraHandle zh = handle;
+    bend_searchresult *r = odr_malloc (q->stream, sizeof(*r));
 
+    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);
-        r.errstring = server_info.errString;
+    case Z_Query_type_1: case Z_Query_type_101:
+       zebra_search_rpn (zh, 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;
     default:
-        r.errcode = 107;
+        r->errcode = 107;
     }
-    register_unlock (&server_info);
-    return &r;
+    return r;
 }
 
-static int record_ext_read (int fd, char *buf, size_t count)
-{
-    return read (fd, buf, count);
-}
-
-static int record_int_pos;
-static char *record_int_buf;
-static int record_int_len;
-
-static int record_int_read (int fd, char *buf, size_t count)
-{
-    int l = record_int_len - record_int_pos;
-    if (l <= 0)
-        return 0;
-    l = (l < count) ? l : count;
-    memcpy (buf, record_int_buf + record_int_pos, l);
-    record_int_pos += l;
-    return l;
-}
-
-static int record_fetch (ZServerInfo *zi, int sysno, int score, ODR stream,
-                          oid_value input_format, Z_RecordComposition *comp,
-                         oid_value *output_format, char **rec_bufp,
-                         int *rec_lenp)
+bend_fetchresult *bend_fetch (void *handle, bend_fetchrequest *q, int *num)
 {
-    Record rec;
-    char *fname, *file_type;
-    RecType rt;
-    struct recRetrieveCtrl retrieveCtrl;
-    char subType[128];
+    ZebraHandle zh = handle;
+    bend_fetchresult *r = odr_malloc (q->stream, sizeof(*r));
+    ZebraRetrievalRecord retrievalRecord;
 
-    rec = rec_get (zi->records, sysno);
-    file_type = rec->info[recInfo_fileType];
-    fname = rec->info[recInfo_filename];
+    retrievalRecord.position = q->number;
+    
+    zebra_records_retrieve (zh, q->stream, q->setname, q->comp,
+                           q->format, 1, &retrievalRecord);
 
-    if (!(rt = recType_byName (file_type, subType)))
+    if (zh->errCode)
     {
-        logf (LOG_FATAL|LOG_ERRNO, "Retrieve: Cannot handle type %s", 
-              file_type);
-        exit (1);
+       r->errcode = zh->errCode;
+       r->errstring = zh->errString;
     }
-    logf (LOG_DEBUG, "retrieve localno=%d score=%d", sysno, score);
-    if (rec->size[recInfo_storeData] > 0)
-    {
-        retrieveCtrl.readf = record_int_read;
-        record_int_len = rec->size[recInfo_storeData];
-        record_int_buf = rec->info[recInfo_storeData];
-        record_int_pos = 0;
-        logf (LOG_DEBUG, "Internal retrieve. %d bytes", record_int_len);
-    }
-    else 
+    else
     {
-        if ((retrieveCtrl.fd = open (fname, O_RDONLY)) == -1)
-        {
-            char *msg = "Record doesn't exist";
-            logf (LOG_WARN|LOG_ERRNO, "Retrieve: Open record file %s", fname);
-            *output_format = VAL_SUTRS;
-            *rec_bufp = msg;
-            *rec_lenp = strlen (msg);
-            rec_rm (&rec);
-            return 0;     /* or 14: System error in presenting records */
-        }
-        retrieveCtrl.readf = record_ext_read;
+       r->errcode = 0;
+       r->basename = retrievalRecord.base;
+       r->record = retrievalRecord.buf;
+       r->len = retrievalRecord.len;
+       r->format = retrievalRecord.format;
     }
-    retrieveCtrl.subType = subType;
-    retrieveCtrl.localno = sysno;
-    retrieveCtrl.score = score;
-    retrieveCtrl.odr = stream;
-    retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
-    retrieveCtrl.comp = comp;
-    retrieveCtrl.diagnostic = 0;
-    (*rt->retrieve)(&retrieveCtrl);
-    *output_format = retrieveCtrl.output_format;
-    *rec_bufp = retrieveCtrl.rec_buf;
-    *rec_lenp = retrieveCtrl.rec_len;
-    close (retrieveCtrl.fd);
-    rec_rm (&rec);
-
-    return retrieveCtrl.diagnostic;
+    return r;
 }
 
-bend_fetchresult *bend_fetch (void *handle, bend_fetchrequest *q, int *num)
+bend_deleteresult *bend_delete (void *handle, bend_deleterequest *q, int *num)
 {
-    static bend_fetchresult r;
-    int positions[2];
-    ZServerSetSysno *records;
-
-    register_lock (&server_info);
-
-    r.errstring = 0;
-    r.last_in_set = 0;
-    r.basename = "base";
-
-    odr_reset (server_info.odr);
-    server_info.errCode = 0;
+    return 0;
+}
 
-    positions[0] = q->number;
-    records = resultSetSysnoGet (&server_info, q->setname, 1, positions);
-    if (!records)
-    {
-        logf (LOG_DEBUG, "resultSetRecordGet, error");
-        r.errcode = 13;
-        register_unlock (&server_info);
-        return &r;
-    }
-    if (!records[0].sysno)
+bend_scanresult *bend_scan (void *handle, bend_scanrequest *q, int *num)
+{
+    ZebraScanEntry *entries;
+    ZebraHandle zh = handle;
+    bend_scanresult *r = odr_malloc (q->stream, sizeof(*r));
+    int is_partial, i;
+    
+    r->term_position = q->term_position;
+    r->num_entries = q->num_entries;
+
+    r->entries = 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);
-        register_unlock (&server_info);
-        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,
-                              q->comp, &r.format, &r.record, &r.len);
-    resultSetSysnoDel (&server_info, records, 1);
-    register_unlock (&server_info);
-    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)
 {
-    register_lock (&server_info);
-    register_unlock (&server_info);
-    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;
-
-    register_lock (&server_info);
-    odr_reset (server_info.odr);
-    server_info.errCode = 0;
-    server_info.errString = 0;
+    ZebraHandle zh = handle;
 
-    r.term_position = q->term_position;
-    r.num_entries = q->num_entries;
-    r.errcode = rpn_scan (&server_info, q->term,
-                          q->num_bases, q->basenames,
-                          &r.term_position,
-                          &r.num_entries, &r.entries, &status);
-    r.errstring = server_info.errString;
-    r.status = status;
-    register_unlock (&server_info);
-    return &r;
+    zebra_sort (zh, rr->stream, rr->num_input_setnames, rr->input_setnames,
+               rr->output_setname, rr->sort_sequence, &rr->sort_status);
+    rr->errcode = zh->errCode;
+    rr->errstring = zh->errString;
+    return 0;
 }
 
-void bend_close (void *handle)
+#ifndef WINDOWS
+static void pre_init (struct statserv_options_block *sob)
 {
-    if (server_info.records)
+    char *pidfile = "zebrasrv.pid";
+    int fd = creat (pidfile, 0666);
+    
+    if (fd == -1)
+       logf (LOG_WARN|LOG_ERRNO, "creat %s", pidfile);
+    else
     {
-        dict_close (server_info.wordDict);
-        is_close (server_info.wordIsam);
-        rec_close (&server_info.records);
-        register_unlock (&server_info);
+       char pidstr[30];
+       
+       sprintf (pidstr, "%ld", (long) getpid ());
+       write (fd, pidstr, strlen(pidstr));
+       close (fd);
     }
-    return;
 }
+#endif
 
 int main (int argc, char **argv)
 {
@@ -405,6 +374,9 @@ int main (int argc, char **argv)
 
     sob = statserv_getcontrol ();
     strcpy (sob->configname, FNAME_CONFIG);
+#ifndef WINDOWS
+    sob->pre_init = pre_init;
+#endif
     statserv_setcontrol (sob);
 
     return statserv_main (argc, argv);