1 /* This file is part of simpleserver.
2 * Copyright (C) 2000-2011 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 #include <yaz/backend.h>
36 #include <yaz/wrbuf.h>
37 #include <yaz/querytowrbuf.h>
39 #include <yaz/mutex.h>
40 #include <yaz/oid_db.h>
47 #define GRS_MAX_FIELDS 500
51 #ifndef sv_undef /* To fix the problem with Perl 5.6.0 */
52 #define sv_undef PL_sv_undef
55 YAZ_MUTEX simpleserver_mutex;
58 SV *ghandle; /* Global handle specified at creation */
59 SV *handle; /* Per-connection handle set at Init */
61 /* ### These callback-reference elements are never used! */
74 int stop_flag; /* is used to stop server prematurely .. */
77 #define ENABLE_STOP_SERVER 0
79 SV *_global_ghandle = NULL; /* To be copied into zhandle then ignored */
83 SV *search_ref = NULL;
85 SV *present_ref = NULL;
86 SV *esrequest_ref = NULL;
87 SV *delete_ref = NULL;
89 SV *explain_ref = NULL;
90 PerlInterpreter *root_perl_context;
92 #define GRS_BUF_SIZE 8192
96 * Inspects the SV indicated by svp, and returns a null pointer if
97 * it's an undefined value, or a string allocation from `stream'
98 * otherwise. Using this when filling in addinfo avoids those
99 * irritating "Use of uninitialized value in subroutine entry"
100 * warnings from Perl.
102 char *string_or_undef(SV **svp, ODR stream) {
109 ptr = SvPV(*svp, len);
110 buf = (char*) odr_malloc(stream, len+1);
116 CV * simpleserver_sv2cv(SV *handler) {
120 if (SvPOK(handler)) {
122 buf = SvPV( handler, len);
123 if ( !( ret = perl_get_cv(buf, FALSE ) ) ) {
124 fprintf( stderr, "simpleserver_sv2cv: No such handler '%s'\n\n", buf );
130 return (CV *) handler;
134 /* debugging routine to check for destruction of Perl interpreters */
136 void tst_clones(void)
139 PerlInterpreter *parent = PERL_GET_CONTEXT;
140 for (i = 0; i<5000; i++)
142 PerlInterpreter *perl_interp;
144 PERL_SET_CONTEXT(parent);
145 PL_perl_destruct_level = 2;
146 perl_interp = perl_clone(parent, CLONEf_CLONE_HOST);
147 PL_perl_destruct_level = 2;
148 PERL_SET_CONTEXT(perl_interp);
149 perl_destruct(perl_interp);
150 perl_free(perl_interp);
156 int simpleserver_clone(void) {
158 yaz_mutex_enter(simpleserver_mutex);
161 PerlInterpreter *current = PERL_GET_CONTEXT;
163 /* if current is unset, then we're in a new thread with
164 * no Perl interpreter for it. So we must create one .
165 * This will only happen when threaded is used..
168 PerlInterpreter *perl_interp;
169 PERL_SET_CONTEXT( root_perl_context );
170 perl_interp = perl_clone(root_perl_context, CLONEf_CLONE_HOST);
171 PERL_SET_CONTEXT( perl_interp );
174 yaz_mutex_leave(simpleserver_mutex);
180 void simpleserver_free(void) {
181 yaz_mutex_enter(simpleserver_mutex);
184 PerlInterpreter *current_interp = PERL_GET_CONTEXT;
186 /* If current Perl Interp is different from root interp, then
187 * we're in threaded mode and we must destroy..
189 if (current_interp != root_perl_context) {
190 PL_perl_destruct_level = 2;
191 PERL_SET_CONTEXT(current_interp);
192 perl_destruct(current_interp);
193 perl_free(current_interp);
196 yaz_mutex_leave(simpleserver_mutex);
200 Z_GenericRecord *read_grs1(char *str, ODR o)
203 char line[GRS_BUF_SIZE+1], *buf, *ptr, *original;
204 char value[GRS_BUF_SIZE+1];
205 Z_GenericRecord *r = 0;
208 r = (Z_GenericRecord *)odr_malloc(o, sizeof(*r));
209 r->elements = (Z_TaggedElement **) odr_malloc(o, sizeof(Z_TaggedElement*) * GRS_MAX_FIELDS);
218 ptr = strchr(str, '\n');
223 if (len > GRS_BUF_SIZE) {
224 yaz_log(YLOG_WARN, "GRS string too long - truncating (%d > %d)", len, GRS_BUF_SIZE);
227 strncpy(line, str, len);
231 while (*buf && isspace(*buf))
234 memmove(original, str, strlen(str));
237 if (sscanf(buf, "(%d,%[^)])", &type, value) != 2)
239 yaz_log(YLOG_WARN, "Bad data in '%s'", buf);
242 if (!type && *value == '0')
244 if (!(buf = strchr(buf, ')')))
247 while (*buf && isspace(*buf))
249 if (r->num_elements >= GRS_MAX_FIELDS)
251 yaz_log(YLOG_WARN, "Max number of GRS-1 elements exceeded [GRS_MAX_FIELDS=%d]", GRS_MAX_FIELDS);
254 r->elements[r->num_elements] = t = (Z_TaggedElement *) odr_malloc(o, sizeof(Z_TaggedElement));
255 t->tagType = odr_intdup(o, type);
256 t->tagValue = (Z_StringOrNumeric *)
257 odr_malloc(o, sizeof(Z_StringOrNumeric));
258 if ((ivalue = atoi(value)))
260 t->tagValue->which = Z_StringOrNumeric_numeric;
261 t->tagValue->u.numeric = odr_intdup(o, ivalue);
265 t->tagValue->which = Z_StringOrNumeric_string;
266 t->tagValue->u.string = odr_strdup(o, value);
268 t->tagOccurrence = 0;
270 t->appliedVariant = 0;
271 t->content = c = (Z_ElementData *)odr_malloc(o, sizeof(Z_ElementData));
274 c->which = Z_ElementData_subtree;
275 c->u.subtree = read_grs1(str, o);
279 c->which = Z_ElementData_string;
280 c->u.string = odr_strdup(o, buf);
288 static void oid2str(Odr_oid *o, WRBUF buf)
290 for (; *o >= 0; o++) {
292 sprintf(ibuf, "%d", *o);
293 wrbuf_puts(buf, ibuf);
295 wrbuf_putc(buf, '.');
299 WRBUF oid2dotted(Odr_oid *oid)
301 WRBUF buf = wrbuf_alloc();
307 WRBUF zquery2pquery(Z_Query *q)
309 WRBUF buf = wrbuf_alloc();
311 if (q->which != Z_Query_type_1 && q->which != Z_Query_type_101)
313 yaz_rpnquery_to_wrbuf(buf, q->u.type_1);
318 /* Lifted verbatim from Net::Z3950 yazwrap/util.c */
320 void fatal(char *fmt, ...)
324 fprintf(stderr, "FATAL (SimpleServer): ");
326 vfprintf(stderr, fmt, ap);
328 fprintf(stderr, "\n");
333 /* Lifted verbatim from Net::Z3950 yazwrap/receive.c */
335 * Creates a new Perl object of type `class'; the newly-created scalar
336 * that is a reference to the blessed thingy `referent' is returned.
338 static SV *newObject(char *class, SV *referent)
343 sv = newRV_noinc((SV*) referent);
344 stash = gv_stashpv(class, 0);
346 fatal("attempt to create object of undefined class '%s'", class);
347 /*assert(stash != 0);*/
353 /* Lifted verbatim from Net::Z3950 yazwrap/receive.c */
354 static void setMember(HV *hv, char *name, SV *val)
356 /* We don't increment `val's reference count -- I think this is
357 * right because it's created with a refcount of 1, and in fact
358 * the reference via this hash is the only reference to it in
361 if (!hv_store(hv, name, (U32) strlen(name), val, (U32) 0))
362 fatal("couldn't store member in hash");
366 /* Lifted verbatim from Net::Z3950 yazwrap/receive.c */
367 static SV *translateOID(Odr_oid *x)
369 /* Yaz represents an OID by an int array terminated by a negative
370 * value, typically -1; we represent it as a reference to a
371 * blessed scalar string of "."-separated elements.
377 for (i = 0; x[i] >= 0; i++) {
378 sprintf(buf + strlen(buf), "%d", (int) x[i]);
384 * ### We'd like to return a blessed scalar (string) here, but of
385 * course you can't do that in Perl: only references can be
386 * blessed, so we'd have to return a _reference_ to a string, and
387 * bless _that_. Better to do without the blessing, I think.
390 return newSVpv(buf, 0);
392 return newObject("Net::Z3950::APDU::OID", newSVpv(buf, 0));
397 static SV *apt2perl(Z_AttributesPlusTerm *at)
403 if (at->term->which != Z_Term_general)
404 fatal("can't handle RPN terms other than general");
406 sv = newObject("Net::Z3950::RPN::Term", (SV*) (hv = newHV()));
407 if (at->attributes) {
409 SV *attrs = newObject("Net::Z3950::RPN::Attributes",
410 (SV*) (av = newAV()));
411 for (i = 0; i < at->attributes->num_attributes; i++) {
412 Z_AttributeElement *elem = at->attributes->attributes[i];
414 SV *tmp = newObject("Net::Z3950::RPN::Attribute",
415 (SV*) (hv2 = newHV()));
416 if (elem->attributeSet)
417 setMember(hv2, "attributeSet",
418 translateOID(elem->attributeSet));
419 setMember(hv2, "attributeType",
420 newSViv(*elem->attributeType));
421 if (elem->which == Z_AttributeValue_numeric) {
422 setMember(hv2, "attributeValue",
423 newSViv(*elem->value.numeric));
425 Z_ComplexAttribute *c;
426 Z_StringOrNumeric *son;
427 assert(elem->which == Z_AttributeValue_complex);
428 c = elem->value.complex;
429 /* We ignore semantic actions and multiple values */
430 assert(c->num_list > 0);
432 if (son->which == Z_StringOrNumeric_numeric) {
433 setMember(hv2, "attributeValue",
434 newSViv(*son->u.numeric));
435 } else { /*Z_StringOrNumeric_string*/
436 setMember(hv2, "attributeValue",
437 newSVpv(son->u.string, 0));
442 setMember(hv, "attributes", attrs);
444 setMember(hv, "term", newSVpv((char*) at->term->u.general->buf,
445 at->term->u.general->len));
450 static SV *rpn2perl(Z_RPNStructure *s)
458 case Z_RPNStructure_simple:
461 case Z_Operand_resultSetId: {
462 /* This code causes a SIGBUS on my machine, and I have no
463 idea why. It seems as clear as day to me */
465 char *rsid = (char*) o->u.resultSetId;
466 /*printf("Encoding resultSetId '%s'\n", rsid);*/
467 sv = newObject("Net::Z3950::RPN::RSID", (SV*) (hv = newHV()));
468 /*printf("Made sv=0x%lx, hv=0x%lx\n", (unsigned long) sv ,(unsigned long) hv);*/
469 sv2 = newSVpv(rsid, strlen(rsid));
470 setMember(hv, "id", sv2);
471 /*printf("Set hv{id} to 0x%lx\n", (unsigned long) sv2);*/
476 return apt2perl(o->u.attributesPlusTerm);
479 fatal("unknown RPN simple type %d", (int) o->which);
482 case Z_RPNStructure_complex: {
484 Z_Complex *c = s->u.complex;
485 char *type = 0; /* vacuous assignment satisfies gcc -Wall */
486 switch (c->roperator->which) {
487 case Z_Operator_and: type = "Net::Z3950::RPN::And"; break;
488 case Z_Operator_or: type = "Net::Z3950::RPN::Or"; break;
489 case Z_Operator_and_not: type = "Net::Z3950::RPN::AndNot"; break;
490 case Z_Operator_prox: fatal("proximity not yet supported");
491 default: fatal("unknown RPN operator %d", (int) c->roperator->which);
493 sv = newObject(type, (SV*) (av = newAV()));
494 if ((tmp = rpn2perl(c->s1)) == 0)
497 if ((tmp = rpn2perl(c->s2)) == 0)
504 fatal("unknown RPN node type %d", (int) s->which);
511 /* Decode the Z_SortAttributes struct and store the whole thing into the
514 int simpleserver_ExpandSortAttributes (HV *sort_spec, Z_SortAttributes *sattr)
516 WRBUF attrset_wr = wrbuf_alloc();
518 Z_AttributeList *attr_list = sattr->list;
521 oid2str(sattr->id, attrset_wr);
522 hv_store(sort_spec, "ATTRSET", 7,
523 newSVpv(attrset_wr->buf, attrset_wr->pos), 0);
524 wrbuf_destroy(attrset_wr);
526 hv_store(sort_spec, "SORT_ATTR", 9, newRV( sv_2mortal( (SV*) list ) ), 0);
528 for (i = 0; i < attr_list->num_attributes; i++)
530 Z_AttributeElement *attr = *attr_list->attributes++;
531 HV *attr_spec = newHV();
533 av_push(list, newRV( sv_2mortal( (SV*) attr_spec ) ));
534 hv_store(attr_spec, "ATTR_TYPE", 9, newSViv(*attr->attributeType), 0);
536 if (attr->which == Z_AttributeValue_numeric)
538 hv_store(attr_spec, "ATTR_VALUE", 10,
539 newSViv(*attr->value.numeric), 0);
549 /* Decode the Z_SortKeySpec struct and store the whole thing in a perl hash */
550 int simpleserver_SortKeySpecToHash (HV *sort_spec, Z_SortKeySpec *spec)
552 Z_SortElement *element = spec->sortElement;
554 hv_store(sort_spec, "RELATION", 8, newSViv(*spec->sortRelation), 0);
555 hv_store(sort_spec, "CASE", 4, newSViv(*spec->caseSensitivity), 0);
556 hv_store(sort_spec, "MISSING", 7, newSViv(spec->which), 0);
558 if (element->which == Z_SortElement_generic)
560 Z_SortKey *key = element->u.generic;
562 if (key->which == Z_SortKey_sortField)
564 hv_store(sort_spec, "SORTFIELD", 9,
565 newSVpv((char *) key->u.sortField, 0), 0);
567 else if (key->which == Z_SortKey_elementSpec)
569 Z_Specification *zspec = key->u.elementSpec;
571 hv_store(sort_spec, "ELEMENTSPEC_TYPE", 16,
572 newSViv(zspec->which), 0);
574 if (zspec->which == Z_Schema_oid)
576 WRBUF elementSpec = wrbuf_alloc();
578 oid2str(zspec->schema.oid, elementSpec);
579 hv_store(sort_spec, "ELEMENTSPEC_VALUE", 17,
580 newSVpv(elementSpec->buf, elementSpec->pos), 0);
581 wrbuf_destroy(elementSpec);
583 else if (zspec->which == Z_Schema_uri)
585 hv_store(sort_spec, "ELEMENTSPEC_VALUE", 17,
586 newSVpv((char *) zspec->schema.uri, 0), 0);
589 else if (key->which == Z_SortKey_sortAttributes)
591 return simpleserver_ExpandSortAttributes(sort_spec,
592 key->u.sortAttributes);
608 static SV *zquery2perl(Z_Query *q)
613 if (q->which != Z_Query_type_1 && q->which != Z_Query_type_101)
615 sv = newObject("Net::Z3950::APDU::Query", (SV*) (hv = newHV()));
616 if (q->u.type_1->attributeSetId)
617 setMember(hv, "attributeSet",
618 translateOID(q->u.type_1->attributeSetId));
619 setMember(hv, "query", rpn2perl(q->u.type_1->RPNStructure));
624 int bend_sort(void *handle, bend_sort_rr *rr)
637 char **input_setnames;
638 Zfront_handle *zhandle = (Zfront_handle *)handle;
639 Z_SortKeySpecList *sort_spec = rr->sort_sequence;
647 input_setnames = rr->input_setnames;
648 for (i = 0; i < rr->num_input_setnames; i++)
650 av_push(aref, newSVpv(*input_setnames++, 0));
654 for (i = 0; i < sort_spec->num_specs; i++)
656 Z_SortKeySpec *spec = *sort_spec->specs++;
657 HV *sort_spec = newHV();
659 if ( simpleserver_SortKeySpecToHash(sort_spec, spec) )
660 av_push(sort_seq, newRV( sv_2mortal( (SV*) sort_spec ) ));
669 hv_store(href, "INPUT", 5, newRV( (SV*) aref), 0);
670 hv_store(href, "OUTPUT", 6, newSVpv(rr->output_setname, 0), 0);
671 hv_store(href, "SEQUENCE", 8, newRV( (SV*) sort_seq), 0);
672 hv_store(href, "GHANDLE", 7, newSVsv(zhandle->ghandle), 0);
673 hv_store(href, "HANDLE", 6, zhandle->handle, 0);
674 hv_store(href, "STATUS", 6, newSViv(0), 0);
675 hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
676 hv_store(href, "ERR_STR", 7, newSVpv("", 0), 0);
680 XPUSHs(sv_2mortal(newRV( (SV*) href)));
684 perl_call_sv(sort_ref, G_SCALAR | G_DISCARD);
688 temp = hv_fetch(href, "ERR_CODE", 8, 1);
689 err_code = newSVsv(*temp);
691 temp = hv_fetch(href, "ERR_STR", 7, 1);
692 err_str = newSVsv(*temp);
694 temp = hv_fetch(href, "STATUS", 6, 1);
695 status = newSVsv(*temp);
697 temp = hv_fetch(href, "HANDLE", 6, 1);
698 point = newSVsv(*temp);
704 sv_free( (SV*) aref);
705 sv_free( (SV*) href);
706 sv_free( (SV*) sort_seq);
708 rr->errcode = SvIV(err_code);
709 rr->sort_status = SvIV(status);
711 ptr = SvPV(err_str, len);
712 ODR_err_str = (char *)odr_malloc(rr->stream, len + 1);
713 strcpy(ODR_err_str, ptr);
714 rr->errstring = ODR_err_str;
715 zhandle->handle = point;
729 int bend_search(void *handle, bend_search_rr *rr)
738 Zfront_handle *zhandle = (Zfront_handle *)handle;
747 basenames = rr->basenames;
748 for (i = 0; i < rr->num_bases; i++)
750 av_push(aref, newSVpv(*basenames++, 0));
752 #if ENABLE_STOP_SERVER
753 if (rr->num_bases == 1 && !strcmp(rr->basenames[0], "XXstop"))
755 zhandle->stop_flag = 1;
759 hv_store(href, "SETNAME", 7, newSVpv(rr->setname, 0), 0);
760 if (rr->srw_sortKeys && *rr->srw_sortKeys)
761 hv_store(href, "SRW_SORTKEYS", 12, newSVpv(rr->srw_sortKeys, 0), 0);
762 hv_store(href, "REPL_SET", 8, newSViv(rr->replace_set), 0);
763 hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
764 hv_store(href, "ERR_STR", 7, newSVpv("", 0), 0);
765 hv_store(href, "HITS", 4, newSViv(0), 0);
766 hv_store(href, "DATABASES", 9, newRV( (SV*) aref), 0);
767 hv_store(href, "GHANDLE", 7, newSVsv(zhandle->ghandle), 0);
768 hv_store(href, "HANDLE", 6, zhandle->handle, 0);
769 hv_store(href, "PID", 3, newSViv(getpid()), 0);
770 if ((rpnSV = zquery2perl(rr->query)) != 0) {
771 hv_store(href, "RPN", 3, rpnSV, 0);
773 query = zquery2pquery(rr->query);
776 hv_store(href, "QUERY", 5, newSVpv((char *)query->buf, query->pos), 0);
778 else if (rr->query->which == Z_Query_type_104 &&
779 rr->query->u.type_104->which == Z_External_CQL) {
780 hv_store(href, "CQL", 3,
781 newSVpv(rr->query->u.type_104->u.cql, 0), 0);
790 XPUSHs(sv_2mortal(newRV( (SV*) href)));
794 handler_cv = simpleserver_sv2cv( search_ref );
795 perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
799 temp = hv_fetch(href, "HITS", 4, 1);
800 rr->hits = SvIV(*temp);
802 temp = hv_fetch(href, "ERR_CODE", 8, 1);
803 rr->errcode = SvIV(*temp);
805 temp = hv_fetch(href, "ERR_STR", 7, 1);
806 rr->errstring = string_or_undef(temp, rr->stream);
808 temp = hv_fetch(href, "HANDLE", 6, 1);
809 point = newSVsv(*temp);
814 zhandle->handle = point;
815 sv_free( (SV*) aref);
816 sv_free( (SV*) href);
818 wrbuf_destroy(query);
826 /* ### I am not 100% about the memory management in this handler */
827 int bend_delete(void *handle, bend_delete_rr *rr)
829 Zfront_handle *zhandle = (Zfront_handle *)handle;
841 hv_store(href, "GHANDLE", 7, newSVsv(zhandle->ghandle), 0);
842 hv_store(href, "HANDLE", 6, zhandle->handle, 0);
843 hv_store(href, "STATUS", 6, newSViv(0), 0);
846 XPUSHs(sv_2mortal(newRV( (SV*) href)));
849 handler_cv = simpleserver_sv2cv(delete_ref);
851 if (rr->function == 1) {
852 /* Delete all result sets in the session */
853 perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
854 temp = hv_fetch(href, "STATUS", 6, 1);
855 rr->delete_status = SvIV(*temp);
857 rr->delete_status = 0;
859 * For some reason, deleting two or more result-sets in
860 * one operation goes horribly wrong, and ### I don't have
861 * time to debug it right now.
863 if (rr->num_setnames > 1) {
864 rr->delete_status = 3; /* "System problem at target" */
865 /* There's no way to sent delete-msg using the GFS */
869 for (i = 0; i < rr->num_setnames; i++) {
870 hv_store(href, "SETNAME", 7, newSVpv(rr->setnames[i], 0), 0);
871 perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
872 temp = hv_fetch(href, "STATUS", 6, 1);
873 rr->statuses[i] = SvIV(*temp);
874 if (rr->statuses[i] != 0)
875 rr->delete_status = rr->statuses[i];
881 temp = hv_fetch(href, "HANDLE", 6, 1);
882 point = newSVsv(*temp);
886 zhandle->handle = point;
888 sv_free( (SV*) href);
898 int bend_fetch(void *handle, bend_fetch_rr *rr)
916 Zfront_handle *zhandle = (Zfront_handle *)handle;
919 Z_RecordComposition *composition;
920 Z_ElementSetNames *simple;
930 hv_store(href, "SETNAME", 7, newSVpv(rr->setname, 0), 0);
932 hv_store(href, "SCHEMA", 6, newSVpv(rr->schema, 0), 0);
934 hv_store(href, "SCHEMA", 6, newSVpv("", 0), 0);
936 temp = hv_store(href, "OFFSET", 6, newSViv(rr->number), 0);
937 if (rr->request_format != 0) {
938 oid_dotted = oid2dotted(rr->request_format);
940 /* Probably an SRU request: assume XML is required */
941 oid_dotted = wrbuf_alloc();
942 wrbuf_puts(oid_dotted, "1.2.840.10003.5.109.10");
944 hv_store(href, "REQ_FORM", 8, newSVpv((char *)oid_dotted->buf, oid_dotted->pos), 0);
945 hv_store(href, "REP_FORM", 8, newSVpv((char *)oid_dotted->buf, oid_dotted->pos), 0);
946 hv_store(href, "BASENAME", 8, newSVpv("", 0), 0);
947 hv_store(href, "RECORD", 6, newSVpv("", 0), 0);
948 hv_store(href, "LAST", 4, newSViv(0), 0);
949 hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
950 hv_store(href, "ERR_STR", 7, newSVpv("", 0), 0);
951 hv_store(href, "SUR_FLAG", 8, newSViv(0), 0);
952 hv_store(href, "GHANDLE", 7, newSVsv(zhandle->ghandle), 0);
953 hv_store(href, "HANDLE", 6, zhandle->handle, 0);
954 hv_store(href, "PID", 3, newSViv(getpid()), 0);
957 composition = rr->comp;
958 if (composition->which == Z_RecordComp_simple)
960 simple = composition->u.simple;
961 if (simple->which == Z_ElementSetNames_generic)
963 hv_store(href, "COMP", 4, newSVpv(simple->u.generic, 0), 0);
968 rr->errstring = odr_strdup(rr->stream, "non-generic 'simple' composition");
972 else if (composition->which == Z_RecordComp_complex)
974 if (composition->u.complex->generic &&
976 composition->u.complex->generic &&
977 composition->u.complex->generic->elementSpec &&
978 composition->u.complex->generic->elementSpec->which ==
979 Z_ElementSpec_elementSetName)
981 complex = composition->u.complex;
982 hv_store(href, "COMP", 4,
983 newSVpv(complex->generic->elementSpec->u.elementSetName, 0), 0);
987 #if 0 /* For now ignore this error, which is ubiquitous in SRU */
989 rr->errstring = odr_strdup(rr->stream, "'complex' composition is not generic ESN");
997 rr->errstring = odr_strdup(rr->stream, "composition neither simple nor complex");
1004 XPUSHs(sv_2mortal(newRV( (SV*) href)));
1008 handler_cv = simpleserver_sv2cv( fetch_ref );
1009 perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
1013 temp = hv_fetch(href, "BASENAME", 8, 1);
1014 basename = newSVsv(*temp);
1016 temp = hv_fetch(href, "RECORD", 6, 1);
1017 record = newSVsv(*temp);
1019 temp = hv_fetch(href, "LAST", 4, 1);
1020 last = newSVsv(*temp);
1022 temp = hv_fetch(href, "ERR_CODE", 8, 1);
1023 err_code = newSVsv(*temp);
1025 temp = hv_fetch(href, "ERR_STR", 7, 1),
1026 err_string = newSVsv(*temp);
1028 temp = hv_fetch(href, "SUR_FLAG", 8, 1);
1029 sur_flag = newSVsv(*temp);
1031 temp = hv_fetch(href, "REP_FORM", 8, 1);
1032 rep_form = newSVsv(*temp);
1034 temp = hv_fetch(href, "SCHEMA", 6, 1);
1036 schema = newSVsv(*temp);
1037 ptr = SvPV(schema, length);
1039 rr->schema = (char *)odr_malloc(rr->stream, length + 1);
1040 strcpy(rr->schema, ptr);
1044 temp = hv_fetch(href, "HANDLE", 6, 1);
1045 point = newSVsv(*temp);
1050 ptr = SvPV(basename, length);
1051 ODR_basename = (char *)odr_malloc(rr->stream, length + 1);
1052 strcpy(ODR_basename, ptr);
1053 rr->basename = ODR_basename;
1055 ptr = SvPV(rep_form, length);
1057 rr->output_format = yaz_string_to_oid_odr(yaz_oid_std(),
1058 CLASS_RECSYN, ptr, rr->stream);
1059 if (!rr->output_format)
1061 printf("Net::Z3950::SimpleServer: WARNING: Bad OID %s\n", ptr);
1063 odr_oiddup(rr->stream, yaz_oid_recsyn_sutrs);
1065 ptr = SvPV(record, length);
1066 /* Treat GRS-1 records separately */
1067 if (!oid_oidcmp(rr->output_format, yaz_oid_recsyn_grs_1))
1069 rr->record = (char *) read_grs1(ptr, rr->stream);
1074 ODR_record = (char *)odr_malloc(rr->stream, length + 1);
1075 strcpy(ODR_record, ptr);
1076 rr->record = ODR_record;
1079 zhandle->handle = point;
1081 rr->last_in_set = SvIV(last);
1085 rr->errcode = SvIV(err_code);
1086 ptr = SvPV(err_string, length);
1087 ODR_errstr = (char *)odr_malloc(rr->stream, length + 1);
1088 strcpy(ODR_errstr, ptr);
1089 rr->errstring = ODR_errstr;
1091 rr->surrogate_flag = SvIV(sur_flag);
1093 wrbuf_destroy(oid_dotted);
1094 sv_free((SV*) href);
1098 sv_free(err_string);
1114 int bend_present(void *handle, bend_present_rr *rr)
1122 Z_RecordComposition *composition;
1123 Z_ElementSetNames *simple;
1124 Z_CompSpec *complex;
1127 Zfront_handle *zhandle = (Zfront_handle *)handle;
1130 /* WRBUF oid_dotted; */
1137 hv_store(href, "GHANDLE", 7, newSVsv(zhandle->ghandle), 0);
1138 hv_store(href, "HANDLE", 6, zhandle->handle, 0);
1139 hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
1140 hv_store(href, "ERR_STR", 7, newSVpv("", 0), 0);
1141 hv_store(href, "START", 5, newSViv(rr->start), 0);
1142 hv_store(href, "SETNAME", 7, newSVpv(rr->setname, 0), 0);
1143 hv_store(href, "NUMBER", 6, newSViv(rr->number), 0);
1144 /*oid_dotted = oid2dotted(rr->request_format_raw);
1145 hv_store(href, "REQ_FORM", 8, newSVpv((char *)oid_dotted->buf, oid_dotted->pos), 0);*/
1146 hv_store(href, "PID", 3, newSViv(getpid()), 0);
1149 composition = rr->comp;
1150 if (composition->which == Z_RecordComp_simple)
1152 simple = composition->u.simple;
1153 if (simple->which == Z_ElementSetNames_generic)
1155 hv_store(href, "COMP", 4, newSVpv(simple->u.generic, 0), 0);
1160 rr->errstring = odr_strdup(rr->stream, "non-generic 'simple' composition");
1164 else if (composition->which == Z_RecordComp_complex)
1166 if (composition->u.complex->generic &&
1168 composition->u.complex->generic &&
1169 composition->u.complex->generic->elementSpec &&
1170 composition->u.complex->generic->elementSpec->which ==
1171 Z_ElementSpec_elementSetName)
1173 complex = composition->u.complex;
1174 hv_store(href, "COMP", 4,
1175 newSVpv(complex->generic->elementSpec->u.elementSetName, 0), 0);
1180 rr->errstring = odr_strdup(rr->stream, "'complex' composition is not generic ESN");
1187 rr->errstring = odr_strdup(rr->stream, "composition neither simple nor complex");
1194 XPUSHs(sv_2mortal(newRV( (SV*) href)));
1198 handler_cv = simpleserver_sv2cv( present_ref );
1199 perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
1203 temp = hv_fetch(href, "ERR_CODE", 8, 1);
1204 err_code = newSVsv(*temp);
1206 temp = hv_fetch(href, "ERR_STR", 7, 1);
1207 err_string = newSVsv(*temp);
1209 temp = hv_fetch(href, "HANDLE", 6, 1);
1210 point = newSVsv(*temp);
1217 rr->errcode = SvIV(err_code);
1219 ptr = SvPV(err_string, len);
1220 ODR_errstr = (char *)odr_malloc(rr->stream, len + 1);
1221 strcpy(ODR_errstr, ptr);
1222 rr->errstring = ODR_errstr;
1223 /* wrbuf_free(oid_dotted, 1);*/
1224 zhandle->handle = point;
1227 sv_free(err_string);
1228 sv_free( (SV*) href);
1234 int bend_esrequest(void *handle, bend_esrequest_rr *rr)
1236 perl_call_sv(esrequest_ref, G_VOID | G_DISCARD | G_NOARGS);
1241 int bend_scan(void *handle, bend_scan_rr *rr)
1248 struct scan_entry *scan_list;
1249 struct scan_entry *buffer;
1250 int *step_size = rr->step_size;
1254 SV *err_code = sv_newmortal();
1255 SV *err_str = sv_newmortal();
1256 SV *point = sv_newmortal();
1257 SV *status = sv_newmortal();
1258 SV *number = sv_newmortal();
1264 Zfront_handle *zhandle = (Zfront_handle *)handle;
1274 /* RPN is better than TERM since it includes attributes */
1275 if ((rpnSV = apt2perl(rr->term)) != 0) {
1276 setMember(href, "RPN", rpnSV);
1279 if (rr->term->term->which == Z_Term_general)
1281 term_len = rr->term->term->u.general->len;
1282 hv_store(href, "TERM", 4, newSVpv((char*) rr->term->term->u.general->buf, term_len), 0);
1284 rr->errcode = 229; /* Unsupported term type */
1287 hv_store(href, "STEP", 4, newSViv(*step_size), 0);
1288 hv_store(href, "NUMBER", 6, newSViv(rr->num_entries), 0);
1289 hv_store(href, "POS", 3, newSViv(rr->term_position), 0);
1290 hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
1291 hv_store(href, "ERR_STR", 7, newSVpv("", 0), 0);
1292 hv_store(href, "GHANDLE", 7, newSVsv(zhandle->ghandle), 0);
1293 hv_store(href, "HANDLE", 6, zhandle->handle, 0);
1294 hv_store(href, "STATUS", 6, newSViv(BEND_SCAN_SUCCESS), 0);
1295 hv_store(href, "ENTRIES", 7, newRV((SV *) list), 0);
1297 basenames = rr->basenames;
1298 for (i = 0; i < rr->num_bases; i++)
1300 av_push(aref, newSVpv(*basenames++, 0));
1302 hv_store(href, "DATABASES", 9, newRV( (SV*) aref), 0);
1306 XPUSHs(sv_2mortal(newRV( (SV*) href)));
1310 handler_cv = simpleserver_sv2cv( scan_ref );
1311 perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
1315 temp = hv_fetch(href, "ERR_CODE", 8, 1);
1316 err_code = newSVsv(*temp);
1318 temp = hv_fetch(href, "ERR_STR", 7, 1);
1319 err_str = newSVsv(*temp);
1321 temp = hv_fetch(href, "HANDLE", 6, 1);
1322 point = newSVsv(*temp);
1324 temp = hv_fetch(href, "STATUS", 6, 1);
1325 status = newSVsv(*temp);
1327 temp = hv_fetch(href, "NUMBER", 6, 1);
1328 number = newSVsv(*temp);
1330 temp = hv_fetch(href, "ENTRIES", 7, 1);
1331 entries_ref = newSVsv(*temp);
1337 ptr = SvPV(err_str, len);
1338 ODR_errstr = (char *)odr_malloc(rr->stream, len + 1);
1339 strcpy(ODR_errstr, ptr);
1340 rr->errstring = ODR_errstr;
1341 rr->errcode = SvIV(err_code);
1342 rr->num_entries = SvIV(number);
1343 rr->status = SvIV(status);
1344 scan_list = (struct scan_entry *) odr_malloc (rr->stream, rr->num_entries * sizeof(*scan_list));
1346 entries = (AV *)SvRV(entries_ref);
1347 if (rr->errcode == 0) for (i = 0; i < rr->num_entries; i++)
1349 scan_item = (HV *)SvRV(sv_2mortal(av_shift(entries)));
1350 temp = hv_fetch(scan_item, "TERM", 4, 1);
1351 ptr = SvPV(*temp, len);
1352 buffer->term = (char *) odr_malloc (rr->stream, len + 1);
1353 strcpy(buffer->term, ptr);
1354 temp = hv_fetch(scan_item, "OCCURRENCE", 10, 1);
1355 buffer->occurrences = SvIV(*temp);
1357 hv_undef(scan_item);
1359 rr->entries = scan_list;
1360 zhandle->handle = point;
1367 sv_free((SV *)href);
1369 sv_free((SV *)aref);
1371 sv_free((SV *)list);
1373 /*sv_free((SV *)entries);*/
1374 sv_free(entries_ref);
1379 int bend_explain(void *handle, bend_explain_rr *q)
1387 Zfront_handle *zhandle = (Zfront_handle *)handle;
1394 hv_store(href, "EXPLAIN", 7, newSVpv("", 0), 0);
1395 hv_store(href, "DATABASE", 8, newSVpv(q->database, 0), 0);
1396 hv_store(href, "GHANDLE", 7, newSVsv(zhandle->ghandle), 0);
1397 hv_store(href, "HANDLE", 6, zhandle->handle, 0);
1400 XPUSHs(sv_2mortal(newRV((SV*) href)));
1403 handler_cv = simpleserver_sv2cv(explain_ref);
1404 perl_call_sv((SV*) handler_cv, G_SCALAR | G_DISCARD);
1408 temp = hv_fetch(href, "EXPLAIN", 7, 1);
1409 explainsv = newSVsv(*temp);
1415 explain = SvPV(explainsv, len);
1416 q->explain_buf = (char*) odr_malloc(q->stream, len + 1);
1417 strcpy(q->explain_buf, explain);
1424 * You'll laugh when I tell you this ... Astonishingly, it turns out
1425 * that ActivePerl (which is widely used on Windows) has, in the
1426 * header file Perl\lib\CORE\XSUB.h, the following heinous crime:
1427 * # define open PerlLIO_open
1428 * This of course screws up the use of the "open" member of the
1429 * Z_IdAuthentication structure below, so we have to undo this
1437 bend_initresult *bend_init(bend_initrequest *q)
1439 int dummy = simpleserver_clone();
1440 bend_initresult *r = (bend_initresult *)
1441 odr_malloc (q->stream, sizeof(*r));
1446 NMEM nmem = nmem_create();
1447 Zfront_handle *zhandle = (Zfront_handle *) nmem_malloc (nmem,
1456 zhandle->ghandle = _global_ghandle;
1457 zhandle->nmem = nmem;
1458 zhandle->stop_flag = 0;
1462 q->bend_sort = bend_sort;
1466 q->bend_search = bend_search;
1470 q->bend_present = bend_present;
1472 /*q->bend_esrequest = bend_esrequest;*/
1474 q->bend_delete = bend_delete;
1478 q->bend_fetch = bend_fetch;
1482 q->bend_scan = bend_scan;
1486 q->bend_explain = bend_explain;
1491 /* ### These should be given initial values from the client */
1492 hv_store(href, "IMP_ID", 6, newSVpv("", 0), 0);
1493 hv_store(href, "IMP_NAME", 8, newSVpv("", 0), 0);
1494 hv_store(href, "IMP_VER", 7, newSVpv("", 0), 0);
1496 hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
1497 hv_store(href, "ERR_STR", 7, newSViv(0), 0);
1498 hv_store(href, "PEER_NAME", 9, newSVpv(q->peer_name, 0), 0);
1499 hv_store(href, "GHANDLE", 7, newSVsv(zhandle->ghandle), 0);
1500 hv_store(href, "HANDLE", 6, newSVsv(&sv_undef), 0);
1501 hv_store(href, "PID", 3, newSViv(getpid()), 0);
1504 char *passwd = NULL;
1505 if (q->auth->which == Z_IdAuthentication_open) {
1507 user = nmem_strdup (odr_getmem (q->stream), q->auth->u.open);
1508 cp = strchr (user, '/');
1510 /* password after / given */
1514 } else if (q->auth->which == Z_IdAuthentication_idPass) {
1515 user = q->auth->u.idPass->userId;
1516 passwd = q->auth->u.idPass->password;
1518 /* ### some code paths have user/password unassigned here */
1520 hv_store(href, "USER", 4, newSVpv(user, 0), 0);
1522 hv_store(href, "PASS", 4, newSVpv(passwd, 0), 0);
1527 XPUSHs(sv_2mortal(newRV((SV*) href)));
1531 if (init_ref != NULL)
1533 handler_cv = simpleserver_sv2cv( init_ref );
1534 perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
1539 temp = hv_fetch(href, "IMP_ID", 6, 1);
1540 ptr = SvPV(*temp, len);
1541 q->implementation_id = nmem_strdup(nmem, ptr);
1543 temp = hv_fetch(href, "IMP_NAME", 8, 1);
1544 ptr = SvPV(*temp, len);
1545 q->implementation_name = nmem_strdup(nmem, ptr);
1547 temp = hv_fetch(href, "IMP_VER", 7, 1);
1548 ptr = SvPV(*temp, len);
1549 q->implementation_version = nmem_strdup(nmem, ptr);
1551 temp = hv_fetch(href, "ERR_CODE", 8, 1);
1552 r->errcode = SvIV(*temp);
1554 temp = hv_fetch(href, "ERR_STR", 7, 1);
1555 ptr = SvPV(*temp, len);
1556 r->errstring = (char *)odr_malloc(q->stream, len + 1);
1557 strcpy(r->errstring, ptr);
1559 temp = hv_fetch(href, "HANDLE", 6, 1);
1560 handle= newSVsv(*temp);
1561 zhandle->handle = handle;
1563 r->handle = zhandle;
1566 sv_free((SV*) href);
1575 void bend_close(void *handle)
1578 Zfront_handle *zhandle = (Zfront_handle *)handle;
1588 hv_store(href, "GHANDLE", 7, newSVsv(zhandle->ghandle), 0);
1589 hv_store(href, "HANDLE", 6, zhandle->handle, 0);
1593 XPUSHs(sv_2mortal(newRV((SV *)href)));
1597 handler_cv = simpleserver_sv2cv( close_ref );
1598 perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
1602 sv_free((SV*) href);
1605 sv_free(zhandle->handle);
1609 stop_flag = zhandle->stop_flag;
1610 nmem_destroy(zhandle->nmem);
1611 simpleserver_free();
1619 MODULE = Net::Z3950::SimpleServer PACKAGE = Net::Z3950::SimpleServer
1628 _global_ghandle = newSVsv(arg);
1632 set_init_handler(arg)
1635 init_ref = newSVsv(arg);
1639 set_close_handler(arg)
1642 close_ref = newSVsv(arg);
1646 set_sort_handler(arg)
1649 sort_ref = newSVsv(arg);
1652 set_search_handler(arg)
1655 search_ref = newSVsv(arg);
1659 set_fetch_handler(arg)
1662 fetch_ref = newSVsv(arg);
1666 set_present_handler(arg)
1669 present_ref = newSVsv(arg);
1673 set_esrequest_handler(arg)
1676 esrequest_ref = newSVsv(arg);
1680 set_delete_handler(arg)
1683 delete_ref = newSVsv(arg);
1687 set_scan_handler(arg)
1690 scan_ref = newSVsv(arg);
1693 set_explain_handler(arg)
1696 explain_ref = newSVsv(arg);
1707 argv_buf = (char **)xmalloc((items + 1) * sizeof(char *));
1709 for (i = 0; i < items; i++)
1711 ptr = SvPV(ST(i), len);
1712 *argv_buf = (char *)xmalloc(len + 1);
1713 strcpy(*argv_buf++, ptr);
1716 root_perl_context = PERL_GET_CONTEXT;
1717 yaz_mutex_create(&simpleserver_mutex);
1719 /* only for debugging perl_clone .. */
1723 RETVAL = statserv_main(items, argv, bend_init, bend_close);
1731 RETVAL = BEND_SCAN_SUCCESS;
1738 RETVAL = BEND_SCAN_PARTIAL;
1749 ptr = SvPV(arg, len);
1750 yaz_log(YLOG_LOG, "%.*s", (int) len, ptr);
1753 yaz_diag_srw_to_bib1(srw_code)
1757 yaz_diag_bib1_to_srw(bib1_code)