Return diagnostics on Init failure
[simpleserver-moved-to-github.git] / SimpleServer.xs
index aa020fa..230cd26 100644 (file)
  */
 
 /*$Log: SimpleServer.xs,v $
-/*Revision 1.7  2001-03-13 14:17:15  sondberg
+/*Revision 1.20  2003-09-09 20:12:38  mike
+/*Return diagnostics on Init failure
+/*
+/*Revision 1.19  2003/09/09 11:40:10  mike
+/*(Finally!) support implementation-ID
+/*
+/*Revision 1.18  2003/01/03 09:05:41  sondberg
+/*Applied Dave's GRS-1 patch - actually this was already done in revision 1.17.
+/*
+/*Revision 1.16  2002/11/26 17:09:18  mike
+/*basic support for idPass authentication
+/*
+/*Revision 1.15  2002/09/16 13:55:53  sondberg
+/*Added support for authentication into SimpleServer.
+/*
+/*Revision 1.14  2002/03/05 00:34:13  mike
+/*Support for implementation_id (commented out until it's
+/*in mainstream Yaz)
+/*
+/*Revision 1.13  2002/02/28 11:21:57  mike
+/*Add RPN structure to search-handler argument hash.
+/*
+/*Revision 1.12  2001/08/30 14:02:10  sondberg
+/*Small changes.
+/*
+/*Revision 1.11  2001/08/30 13:15:11  sondberg
+/*Corrected a memory leak, one more to go.
+/*
+/*Revision 1.10  2001/08/29 11:48:36  sondberg
+/*Added routines
+/*
+/*     Net::Z3950::SimpleServer::ScanSuccess
+/*     Net::Z3950::SimpleServer::ScanPartial
+/*
+/*and a bit of documentation.
+/*
+/*Revision 1.9  2001/08/24 14:00:20  sondberg
+/*Added support for scan.
+/*
+/*Revision 1.8  2001/05/21 11:07:02  sondberg
+/*Extended maximum numbers of GRS-1 elements. Should be done dynamically.
+/*
+/*Revision 1.7  2001/03/13 14:17:15  sondberg
 /*Added support for GRS-1.
 /**/
 
@@ -40,7 +82,7 @@
 #include <unistd.h>
 #include <stdlib.h>
 #include <ctype.h>
-#define GRS_MAX_FIELDS 50
+#define GRS_MAX_FIELDS 500 
 #ifdef ASN_COMPILED
 #include <yaz/ill.h>
 #endif
@@ -73,26 +115,37 @@ SV *delete_ref = NULL;
 SV *scan_ref = NULL;
 int MAX_OID = 15;
 
+#define GRS_BUF_SIZE 512
 
 Z_GenericRecord *read_grs1(char *str, ODR o)
 {
        int type, ivalue;
-       char line[512], *buf, *ptr, *original;
-       char value[512];
+       char line[GRS_BUF_SIZE+1], *buf, *ptr, *original;
+       char value[GRS_BUF_SIZE+1];
        Z_GenericRecord *r = 0;
 
        original = str;
+       r = (Z_GenericRecord *)odr_malloc(o, sizeof(*r));
+       r->elements = (Z_TaggedElement **) odr_malloc(o, sizeof(Z_TaggedElement*) * GRS_MAX_FIELDS);
+       r->num_elements = 0;
+       
        for (;;)
        {
                Z_TaggedElement *t;
                Z_ElementData *c;
+               int len;
        
                ptr = strchr(str, '\n');
                if (!ptr) {
                        return r;
                }
-               strncpy(line, str, ptr - str);
-               line[ptr - str] = 0;
+               len = ptr - str;
+               if (len > GRS_BUF_SIZE) {
+                   yaz_log(LOG_WARN, "GRS string too long - truncating (%d > %d)", len, GRS_BUF_SIZE);
+                   len = GRS_BUF_SIZE;
+               }
+               strncpy(line, str, len);
+               line[len] = 0;
                buf = line;
                str = ptr + 1;
                while (*buf && isspace(*buf))
@@ -104,23 +157,19 @@ Z_GenericRecord *read_grs1(char *str, ODR o)
                if (sscanf(buf, "(%d,%[^)])", &type, value) != 2)
                {
                        yaz_log(LOG_WARN, "Bad data in '%s'", buf);
-                       return 0;
+                       return r;
                }
                if (!type && *value == '0')
                        return r;
                if (!(buf = strchr(buf, ')')))
-                       return 0;
+                       return r;
                buf++;
                while (*buf && isspace(*buf))
                        buf++;
-               if (!*buf)
-                       return 0;
-               if (!r)
+               if (r->num_elements >= GRS_MAX_FIELDS)
                {
-                       r = (Z_GenericRecord *)odr_malloc(o, sizeof(*r));
-                       r->elements = (Z_TaggedElement **)
-                       odr_malloc(o, sizeof(Z_TaggedElement*) * GRS_MAX_FIELDS);
-                       r->num_elements = 0;
+                       yaz_log(LOG_WARN, "Max number of GRS-1 elements exceeded [GRS_MAX_FIELDS=%d]", GRS_MAX_FIELDS);
+                       exit(0);
                }
                r->elements[r->num_elements] = t = (Z_TaggedElement *) odr_malloc(o, sizeof(Z_TaggedElement));
                t->tagType = (int *)odr_malloc(o, sizeof(int));
@@ -151,8 +200,6 @@ Z_GenericRecord *read_grs1(char *str, ODR o)
                else
                {
                        c->which = Z_ElementData_string;
-/*                     buf[strlen(buf)-1] = '\0';*/
-                       buf[strlen(buf)] = '\0';
                        c->u.string = odr_strdup(o, buf);
                }
                r->num_elements++;
@@ -254,6 +301,170 @@ WRBUF zquery2pquery(Z_Query *q)
 }
 
 
+/* Lifted verbatim from Net::Z3950 yazwrap/util.c */
+#include <stdarg.h>
+void fatal(char *fmt, ...)
+{
+    va_list ap;
+
+    fprintf(stderr, "FATAL (yazwrap): ");
+    va_start(ap, fmt);
+    vfprintf(stderr, fmt, ap);
+    va_end(ap);
+    fprintf(stderr, "\n");
+    abort();
+}
+
+
+/* Lifted verbatim from Net::Z3950 yazwrap/receive.c */
+/*
+ * Creates a new Perl object of type `class'; the newly-created scalar
+ * that is a reference to the blessed thingy `referent' is returned.
+ */
+static SV *newObject(char *class, SV *referent)
+{
+    HV *stash;
+    SV *sv;
+
+    sv = newRV_noinc((SV*) referent);
+    stash = gv_stashpv(class, 0);
+    if (stash == 0)
+       fatal("attempt to create object of undefined class '%s'", class);
+    /*assert(stash != 0);*/
+    sv_bless(sv, stash);
+    return sv;
+}
+
+
+/* Lifted verbatim from Net::Z3950 yazwrap/receive.c */
+static void setMember(HV *hv, char *name, SV *val)
+{
+    /* We don't increment `val's reference count -- I think this is
+     * right because it's created with a refcount of 1, and in fact
+     * the reference via this hash is the only reference to it in
+     * general.
+     */
+    if (!hv_store(hv, name, (U32) strlen(name), val, (U32) 0))
+       fatal("couldn't store member in hash");
+}
+
+
+/* Lifted verbatim from Net::Z3950 yazwrap/receive.c */
+static SV *translateOID(Odr_oid *x)
+{
+    /* Yaz represents an OID by an int array terminated by a negative
+     * value, typically -1; we represent it as a reference to a
+     * blessed scalar string of "."-separated elements.
+     */
+    char buf[1000];
+    int i;
+
+    *buf = '\0';
+    for (i = 0; x[i] >= 0; i++) {
+       sprintf(buf + strlen(buf), "%d", (int) x[i]);
+       if (x[i+1] >- 0)
+           strcat(buf, ".");
+    }
+
+    /*
+     * ### We'd like to return a blessed scalar (string) here, but of
+     * course you can't do that in Perl: only references can be
+     * blessed, so we'd have to return a _reference_ to a string, and
+     * bless _that_.  Better to do without the blessing, I think.
+     */
+    if (1) {
+       return newSVpv(buf, 0);
+    } else {
+       return newObject("Net::Z3950::APDU::OID", newSVpv(buf, 0));
+    }
+}
+
+
+static SV *rpn2perl(Z_RPNStructure *s)
+{
+    SV *sv;
+    HV *hv;
+    AV *av;
+
+    switch (s->which) {
+    case Z_RPNStructure_simple: {
+       Z_Operand *o = s->u.simple;
+       Z_AttributesPlusTerm *at;
+       if (o->which != Z_Operand_APT)
+           fatal("can't handle RPN simples other than APT");
+       at = o->u.attributesPlusTerm;
+       if (at->term->which != Z_Term_general)
+           fatal("can't handle RPN terms other than general");
+
+       sv = newObject("Net::Z3950::RPN::Term", (SV*) (hv = newHV()));
+       if (at->attributes) {
+           int i;
+           SV *attrs = newObject("Net::Z3950::RPN::Attributes",
+                                 (SV*) (av = newAV()));
+           for (i = 0; i < at->attributes->num_attributes; i++) {
+               Z_AttributeElement *elem = at->attributes->attributes[i];
+               HV *hv2;
+               SV *tmp = newObject("Net::Z3950::RPN::Attribute",
+                                   (SV*) (hv2 = newHV()));
+               if (elem->attributeSet)
+                   setMember(hv2, "attributeSet",
+                             translateOID(elem->attributeSet));
+               setMember(hv2, "attributeType",
+                         newSViv(*elem->attributeType));
+               assert(elem->which == Z_AttributeValue_numeric);
+               setMember(hv2, "attributeValue",
+                         newSViv(*elem->value.numeric));
+               av_push(av, tmp);
+           }
+           setMember(hv, "attributes", attrs);
+       }
+       setMember(hv, "term", newSVpv((char*) at->term->u.general->buf,
+                                     at->term->u.general->len));
+       return sv;
+    }
+    case Z_RPNStructure_complex: {
+       SV *tmp;
+       Z_Complex *c = s->u.complex;
+       char *type = 0;         /* vacuous assignment satisfies gcc -Wall */
+       switch (c->roperator->which) {
+       case Z_Operator_and:     type = "Net::Z3950::RPN::And"; break;
+       case Z_Operator_or:      type = "Net::Z3950::RPN::Or"; break;
+       case Z_Operator_and_not: type = "Net::Z3950::RPN::AndNot"; break;
+       case Z_Operator_prox:    fatal("proximity not yet supported");
+       default: fatal("unknown RPN operator %d", (int) c->roperator->which);
+       }
+       sv = newObject(type, (SV*) (av = newAV()));
+       if ((tmp = rpn2perl(c->s1)) == 0)
+           return 0;
+       av_push(av, tmp);
+       if ((tmp = rpn2perl(c->s2)) == 0)
+           return 0;
+       av_push(av, tmp);
+       return sv;
+    }
+    default: fatal("unknown RPN node type %d", (int) s->which);
+    }
+
+    return 0;
+}
+
+
+static SV *zquery2perl(Z_Query *q)
+{
+    SV *sv;
+    HV *hv;
+
+    if (q->which != Z_Query_type_1 && q->which != Z_Query_type_101) 
+       return 0;
+    sv = newObject("Net::Z3950::APDU::Query", (SV*) (hv = newHV()));
+    if (q->u.type_1->attributeSetId)
+       setMember(hv, "attributeSet",
+                 translateOID(q->u.type_1->attributeSetId));
+    setMember(hv, "query", rpn2perl(q->u.type_1->RPNStructure));
+    return sv;
+}
+
+
 int bend_sort(void *handle, bend_sort_rr *rr)
 {
        HV *href;
@@ -366,6 +577,7 @@ int bend_search(void *handle, bend_search_rr *rr)
        hv_store(href, "DATABASES", 9, newRV( (SV*) aref), 0);
        hv_store(href, "HANDLE", 6, zhandle->handle, 0);
        hv_store(href, "PID", 3, newSViv(getpid()), 0);
+       hv_store(href, "RPN", 3, zquery2perl(rr->query), 0);
        query = zquery2pquery(rr->query);
        if (query)
        {
@@ -425,6 +637,7 @@ int bend_search(void *handle, bend_search_rr *rr)
 }
 
 
+/* ### this is worryingly similar to oid2str() */
 WRBUF oid2dotted(int *oid)
 {
 
@@ -767,8 +980,132 @@ int bend_delete(void *handle, bend_delete_rr *rr)
 
 int bend_scan(void *handle, bend_scan_rr *rr)
 {
-       perl_call_sv(scan_ref, G_VOID | G_DISCARD | G_NOARGS);
-       return 0;
+        HV *href;
+       AV *aref;
+       AV *list;
+       AV *entries;
+       HV *scan_item;
+       struct scan_entry *scan_list;
+       struct scan_entry *buffer;
+       int *step_size = rr->step_size;
+       int i;
+       char **basenames;
+       SV **temp;
+       SV *err_code = sv_newmortal();
+       SV *err_str = sv_newmortal();
+       SV *point = sv_newmortal();
+       SV *status = sv_newmortal();
+       SV *number = sv_newmortal();
+       char *ptr;
+       char *ODR_errstr;
+       STRLEN len;
+       int term_len;
+       SV *term_tmp;
+       SV *entries_ref;
+       
+       Zfront_handle *zhandle = (Zfront_handle *)handle;
+
+       dSP;
+       ENTER;
+       SAVETMPS;
+       href = newHV();
+       list = newAV();
+       if (rr->term->term->which == Z_Term_general)
+       {
+               term_len = rr->term->term->u.general->len;
+               hv_store(href, "TERM", 4, newSVpv(rr->term->term->u.general->buf, term_len), 0);
+       } else {
+               rr->errcode = 229;      /* Unsupported term type */
+               return 0;
+       }
+       hv_store(href, "STEP", 4, newSViv(*step_size), 0);
+       hv_store(href, "NUMBER", 6, newSViv(rr->num_entries), 0);
+       hv_store(href, "POS", 3, newSViv(rr->term_position), 0);
+       hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
+       hv_store(href, "ERR_STR", 7, newSVpv("", 0), 0);
+       hv_store(href, "HANDLE", 6, zhandle->handle, 0);
+       hv_store(href, "STATUS", 6, newSViv(BEND_SCAN_SUCCESS), 0);
+       hv_store(href, "ENTRIES", 7, newRV((SV *) list), 0);
+        aref = newAV();
+        basenames = rr->basenames;
+        for (i = 0; i < rr->num_bases; i++)
+        {
+                av_push(aref, newSVpv(*basenames++, 0));
+        }
+       hv_store(href, "DATABASES", 9, newRV( (SV*) aref), 0);
+
+       PUSHMARK(sp);
+
+       XPUSHs(sv_2mortal(newRV( (SV*) href)));
+
+       PUTBACK;
+
+       perl_call_sv(scan_ref, G_SCALAR | G_DISCARD);
+
+       SPAGAIN;
+
+       temp = hv_fetch(href, "ERR_CODE", 8, 1);
+       err_code = newSVsv(*temp);
+
+       temp = hv_fetch(href, "ERR_STR", 7, 1);
+       err_str = newSVsv(*temp);
+
+       temp = hv_fetch(href, "HANDLE", 6, 1);
+       point = newSVsv(*temp);
+
+       temp = hv_fetch(href, "STATUS", 6, 1);
+       status = newSVsv(*temp);
+       
+       temp = hv_fetch(href, "NUMBER", 6, 1);
+       number = newSVsv(*temp);
+
+       temp = hv_fetch(href, "ENTRIES", 7, 1);
+       entries_ref = newSVsv(*temp);
+
+       PUTBACK;
+       FREETMPS;
+       LEAVE;
+
+       ptr = SvPV(err_str, len);
+       ODR_errstr = (char *)odr_malloc(rr->stream, len + 1);
+       strcpy(ODR_errstr, ptr);
+       rr->errstring = ODR_errstr;
+       rr->errcode = SvIV(err_code);
+       rr->num_entries = SvIV(number);
+       rr->status = SvIV(status);
+        scan_list = (struct scan_entry *) odr_malloc (rr->stream, rr->num_entries * sizeof(*scan_list));
+       buffer = scan_list;
+       entries = (AV *)SvRV(entries_ref);
+       for (i = 0; i < rr->num_entries; i++)
+       {
+               scan_item = (HV *)SvRV(sv_2mortal(av_shift(entries)));
+               temp = hv_fetch(scan_item, "TERM", 4, 1);
+               ptr = SvPV(*temp, len);
+               buffer->term = (char *) odr_malloc (rr->stream, len + 1); 
+               strcpy(buffer->term, ptr);
+               temp = hv_fetch(scan_item, "OCCURRENCE", 10, 1); 
+               buffer->occurrences = SvIV(*temp);
+               buffer++;
+               hv_undef(scan_item);
+       }
+       rr->entries = scan_list;
+       zhandle->handle = point;
+       handle = zhandle;
+       sv_free(err_code);
+       sv_free(err_str);
+       sv_free(status);
+       sv_free(number);
+       hv_undef(href);
+       sv_free((SV *)href);
+       av_undef(aref);
+       sv_free((SV *)aref);
+       av_undef(list);
+       sv_free((SV *)list);
+       av_undef(entries);
+       /*sv_free((SV *)entries);*/
+       sv_free(entries_ref);
+
+        return 0;
 }
 
 
@@ -777,6 +1114,7 @@ bend_initresult *bend_init(bend_initrequest *q)
        bend_initresult *r = (bend_initresult *) odr_malloc (q->stream, sizeof(*r));
        HV *href;
        SV **temp;
+       SV *id;
        SV *name;
        SV *ver;
        SV *err_str;
@@ -788,6 +1126,8 @@ bend_initresult *bend_init(bend_initrequest *q)
        /*char *name_ptr;
        char *ver_ptr;*/
        char *ptr;
+       char *user = NULL;
+       char *passwd = NULL;
 
        dSP;
        ENTER;
@@ -808,14 +1148,37 @@ bend_initresult *bend_init(bend_initrequest *q)
        {
                q->bend_fetch = bend_fetch;
        }
-       /*q->bend_scan = bend_scan;*/
+       if (scan_ref)
+       {
+               q->bend_scan = bend_scan;
+       }
                href = newHV(); 
+       hv_store(href, "IMP_ID", 6, newSVpv("", 0), 0);
        hv_store(href, "IMP_NAME", 8, newSVpv("", 0), 0);
        hv_store(href, "IMP_VER", 7, newSVpv("", 0), 0);
        hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
+       hv_store(href, "ERR_STR", 7, newSViv(0), 0);
        hv_store(href, "PEER_NAME", 9, newSVpv(q->peer_name, 0), 0);
        hv_store(href, "HANDLE", 6, newSVsv(&sv_undef), 0);
        hv_store(href, "PID", 3, newSViv(getpid()), 0);
+       if (q->auth) {
+           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);
+           } else if (q->auth->which == Z_IdAuthentication_idPass) {
+               user = q->auth->u.idPass->userId;
+               passwd = q->auth->u.idPass->password;
+           }
+           /* ### some code paths have user/password unassigned here */
+           hv_store(href, "USER", 4, newSVpv(user, 0), 0);
+           hv_store(href, "PASS", 4, newSVpv(passwd, 0), 0);
+       }
 
        PUSHMARK(sp);   
 
@@ -830,6 +1193,9 @@ bend_initresult *bend_init(bend_initrequest *q)
 
        SPAGAIN;
 
+       temp = hv_fetch(href, "IMP_ID", 6, 1);
+       id = newSVsv(*temp);
+
        temp = hv_fetch(href, "IMP_NAME", 8, 1);
        name = newSVsv(*temp);
 
@@ -839,6 +1205,9 @@ bend_initresult *bend_init(bend_initrequest *q)
        temp = hv_fetch(href, "ERR_CODE", 8, 1);
        status = newSVsv(*temp);
 
+       temp = hv_fetch(href, "ERR_STR", 7, 1);
+       err_str = newSVsv(*temp);
+
        temp = hv_fetch(href, "HANDLE", 6, 1);
        handle= newSVsv(*temp);
 
@@ -848,7 +1217,14 @@ bend_initresult *bend_init(bend_initrequest *q)
        LEAVE;
        zhandle->handle = handle;
        r->errcode = SvIV(status);
+       ptr = SvPV(err_str, len);
+       r->errstring = (char *)odr_malloc(q->stream, len + 1);
+       strcpy(r->errstring, ptr);
+       sv_free(err_str);
        r->handle = zhandle;
+       ptr = SvPV(id, len);
+       q->implementation_id = (char *)xmalloc(len + 1);
+       strcpy(q->implementation_id, ptr);
        ptr = SvPV(name, len);
        q->implementation_name = (char *)xmalloc(len + 1);
        strcpy(q->implementation_name, ptr);
@@ -984,4 +1360,21 @@ start_server(...)
                
                RETVAL = statserv_main(items, argv, bend_init, bend_close);
        OUTPUT:
-               RETVAL 
+               RETVAL
+
+
+int
+ScanSuccess()
+       CODE:
+               RETVAL = BEND_SCAN_SUCCESS;
+       OUTPUT:
+               RETVAL
+
+int
+ScanPartial()
+       CODE:
+               RETVAL = BEND_SCAN_PARTIAL;
+       OUTPUT:
+               RETVAL
+