Fix memory leak due to the use of perl_clone. A mutex is used
[simpleserver-moved-to-github.git] / SimpleServer.xs
1 /*
2
3  * $Id: SimpleServer.xs,v 1.23 2004-05-13 18:55:40 adam Exp $ 
4  * ----------------------------------------------------------------------
5  * 
6  * Copyright (c) 2000, Index Data.
7  *
8  * Permission to use, copy, modify, distribute, and sell this software and
9  * its documentation, in whole or in part, for any purpose, is hereby granted,
10  * provided that:
11  *
12  * 1. This copyright and permission notice appear in all copies of the
13  * software and its documentation. Notices of copyright or attribution
14  * which appear at the beginning of any file must remain unchanged.
15  *
16  * 2. The name of Index Data or the individual authors may not be used to
17  * endorse or promote products derived from this software without specific
18  * prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
22  * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
23  * IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
24  * INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
25  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
26  * NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
27  * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
28  * OF THIS SOFTWARE.
29  */
30
31
32
33 #include "EXTERN.h"
34 #include "perl.h"
35 #include "embed.h"
36 #include "XSUB.h"
37 #include <yaz/backend.h>
38 #include <yaz/log.h>
39 #include <yaz/wrbuf.h>
40 #include <stdio.h>
41 #ifdef WIN32
42 #else
43 #include <unistd.h>
44 #endif
45 #include <stdlib.h>
46 #include <ctype.h>
47 #define GRS_MAX_FIELDS 500 
48 #ifdef ASN_COMPILED
49 #include <yaz/ill.h>
50 #endif
51 #ifndef sv_undef                /* To fix the problem with Perl 5.6.0 */
52 #define sv_undef PL_sv_undef
53 #endif
54
55 NMEM_MUTEX simpleserver_mutex;
56
57 typedef struct {
58         SV *handle;
59
60         SV *init_ref;
61         SV *close_ref;
62         SV *sort_ref;
63         SV *search_ref;
64         SV *fetch_ref;
65         SV *present_ref;
66         SV *esrequest_ref;
67         SV *delete_ref;
68         SV *scan_ref;
69 } Zfront_handle;
70
71 SV *init_ref = NULL;
72 SV *close_ref = NULL;
73 SV *sort_ref = NULL;
74 SV *search_ref = NULL;
75 SV *fetch_ref = NULL;
76 SV *present_ref = NULL;
77 SV *esrequest_ref = NULL;
78 SV *delete_ref = NULL;
79 SV *scan_ref = NULL;
80 PerlInterpreter *root_perl_context;
81 int MAX_OID = 15;
82
83 #define GRS_BUF_SIZE 512
84
85 CV * simpleserver_sv2cv(SV *handler) {
86     STRLEN len;
87     char *buf;
88    
89     if (SvPOK(handler)) {
90         CV *ret;
91         buf = SvPV( handler, len);
92         if ( !( ret = perl_get_cv(buf, FALSE ) ) ) {
93             fprintf( stderr, "simpleserver_sv2cv: No such handler '%s'\n\n", buf );
94             exit(1);
95         }
96         
97         return ret;
98     } else {
99         return (CV *) handler;
100     }
101 }
102
103 /* debuggin routine to check for destruction of Perl interpreters */
104 #if 0
105 int tst_clones(void)
106 {
107     int i; 
108     PerlInterpreter *parent = PERL_GET_CONTEXT;
109     for (i = 0; i<500; i++)
110     {
111         PerlInterpreter *perl_interp = perl_clone(parent, 0);
112         PERL_SET_CONTEXT( perl_interp );
113         PL_perl_destruct_level = 2;
114         PERL_SET_CONTEXT( parent );
115         perl_destruct(perl_interp);
116         perl_free(perl_interp);
117     }
118     exit (0);
119 }
120 #endif
121
122 int simpleserver_clone(void) {
123      nmem_mutex_enter(simpleserver_mutex);
124      if (1)
125      {
126          PerlInterpreter *current = PERL_GET_CONTEXT;
127
128          /* if current is unset, then we're in a new thread with
129           * no Perl interpreter for it. So we must create one .
130           * This will only happen when threaded is used..
131           */
132          if (!current) {
133              PERL_SET_CONTEXT( root_perl_context );
134              PerlInterpreter *perl_interp = perl_clone(root_perl_context, 0);
135              PERL_SET_CONTEXT( perl_interp );
136          }
137      }
138      nmem_mutex_leave(simpleserver_mutex);
139      return 0;
140 }
141
142
143 void simpleserver_free(void) {
144     nmem_mutex_enter(simpleserver_mutex);
145     if (1)
146     {
147         PerlInterpreter *current_interp = PERL_GET_CONTEXT;
148
149         /* If current Perl Interp is different from root interp, then
150          * we're in threaded mode and we must destroy.. 
151          */
152         if (current_interp != root_perl_context) {
153             PL_perl_destruct_level = 2;
154             PERL_SET_CONTEXT(root_perl_context);
155             perl_destruct(current_interp);
156             perl_free(current_interp);
157         }
158     }
159     nmem_mutex_leave(simpleserver_mutex);
160 }
161
162
163 Z_GenericRecord *read_grs1(char *str, ODR o)
164 {
165         int type, ivalue;
166         char line[GRS_BUF_SIZE+1], *buf, *ptr, *original;
167         char value[GRS_BUF_SIZE+1];
168         Z_GenericRecord *r = 0;
169
170         original = str;
171         r = (Z_GenericRecord *)odr_malloc(o, sizeof(*r));
172         r->elements = (Z_TaggedElement **) odr_malloc(o, sizeof(Z_TaggedElement*) * GRS_MAX_FIELDS);
173         r->num_elements = 0;
174         
175         for (;;)
176         {
177                 Z_TaggedElement *t;
178                 Z_ElementData *c;
179                 int len;
180         
181                 ptr = strchr(str, '\n');
182                 if (!ptr) {
183                         return r;
184                 }
185                 len = ptr - str;
186                 if (len > GRS_BUF_SIZE) {
187                     yaz_log(LOG_WARN, "GRS string too long - truncating (%d > %d)", len, GRS_BUF_SIZE);
188                     len = GRS_BUF_SIZE;
189                 }
190                 strncpy(line, str, len);
191                 line[len] = 0;
192                 buf = line;
193                 str = ptr + 1;
194                 while (*buf && isspace(*buf))
195                         buf++;
196                 if (*buf == '}') {
197                         memmove(original, str, strlen(str));
198                         return r;
199                 }
200                 if (sscanf(buf, "(%d,%[^)])", &type, value) != 2)
201                 {
202                         yaz_log(LOG_WARN, "Bad data in '%s'", buf);
203                         return r;
204                 }
205                 if (!type && *value == '0')
206                         return r;
207                 if (!(buf = strchr(buf, ')')))
208                         return r;
209                 buf++;
210                 while (*buf && isspace(*buf))
211                         buf++;
212                 if (r->num_elements >= GRS_MAX_FIELDS)
213                 {
214                         yaz_log(LOG_WARN, "Max number of GRS-1 elements exceeded [GRS_MAX_FIELDS=%d]", GRS_MAX_FIELDS);
215                         exit(0);
216                 }
217                 r->elements[r->num_elements] = t = (Z_TaggedElement *) odr_malloc(o, sizeof(Z_TaggedElement));
218                 t->tagType = (int *)odr_malloc(o, sizeof(int));
219                 *t->tagType = type;
220                 t->tagValue = (Z_StringOrNumeric *)
221                         odr_malloc(o, sizeof(Z_StringOrNumeric));
222                 if ((ivalue = atoi(value)))
223                 {
224                         t->tagValue->which = Z_StringOrNumeric_numeric;
225                         t->tagValue->u.numeric = (int *)odr_malloc(o, sizeof(int));
226                         *t->tagValue->u.numeric = ivalue;
227                 }
228                 else
229                 {
230                         t->tagValue->which = Z_StringOrNumeric_string;
231                         t->tagValue->u.string = (char *)odr_malloc(o, strlen(value)+1);
232                         strcpy(t->tagValue->u.string, value);
233                 }
234                 t->tagOccurrence = 0;
235                 t->metaData = 0;
236                 t->appliedVariant = 0;
237                 t->content = c = (Z_ElementData *)odr_malloc(o, sizeof(Z_ElementData));
238                 if (*buf == '{')
239                 {
240                         c->which = Z_ElementData_subtree;
241                         c->u.subtree = read_grs1(str, o);
242                 }
243                 else
244                 {
245                         c->which = Z_ElementData_string;
246                         c->u.string = odr_strdup(o, buf);
247                 }
248                 r->num_elements++;
249         }
250 }
251
252
253
254
255 static void oid2str(Odr_oid *o, WRBUF buf)
256 {
257     for (; *o >= 0; o++) {
258         char ibuf[16];
259         sprintf(ibuf, "%d", *o);
260         wrbuf_puts(buf, ibuf);
261         if (o[1] > 0)
262             wrbuf_putc(buf, '.');
263     }
264 }
265
266
267 static int rpn2pquery(Z_RPNStructure *s, WRBUF buf)
268 {
269     switch (s->which) {
270         case Z_RPNStructure_simple: {
271             Z_Operand *o = s->u.simple;
272
273             switch (o->which) {
274                 case Z_Operand_APT: {
275                     Z_AttributesPlusTerm *at = o->u.attributesPlusTerm;
276
277                     if (at->attributes) {
278                         int i;
279                         char ibuf[16];
280
281                         for (i = 0; i < at->attributes->num_attributes; i++) {
282                             wrbuf_puts(buf, "@attr ");
283                             if (at->attributes->attributes[i]->attributeSet) {
284                                 oid2str(at->attributes->attributes[i]->attributeSet, buf);
285                                 wrbuf_putc(buf, ' ');
286                             }
287                             sprintf(ibuf, "%d=", *at->attributes->attributes[i]->attributeType);
288                             assert(at->attributes->attributes[i]->which == Z_AttributeValue_numeric);
289                             wrbuf_puts(buf, ibuf);
290                             sprintf(ibuf, "%d ", *at->attributes->attributes[i]->value.numeric);
291                             wrbuf_puts(buf, ibuf);
292                         }
293                     }
294                     switch (at->term->which) {
295                         case Z_Term_general: {
296                             wrbuf_putc(buf, '"');
297                             wrbuf_write(buf, (char*) at->term->u.general->buf, at->term->u.general->len);
298                             wrbuf_puts(buf, "\" ");
299                             break;
300                         }
301                         default: abort();
302                     }
303                     break;
304                 }
305                 default: abort();
306             }
307             break;
308         }
309         case Z_RPNStructure_complex: {
310             Z_Complex *c = s->u.complex;
311
312             switch (c->roperator->which) {
313                 case Z_Operator_and: wrbuf_puts(buf, "@and "); break;
314                 case Z_Operator_or: wrbuf_puts(buf, "@or "); break;
315                 case Z_Operator_and_not: wrbuf_puts(buf, "@not "); break;
316                 case Z_Operator_prox: abort();
317                 default: abort();
318             }
319             if (!rpn2pquery(c->s1, buf))
320                 return 0;
321             if (!rpn2pquery(c->s2, buf))
322                 return 0;
323             break;
324         }
325         default: abort();
326     }
327     return 1;
328 }
329
330
331 WRBUF zquery2pquery(Z_Query *q)
332 {
333     WRBUF buf = wrbuf_alloc();
334
335     if (q->which != Z_Query_type_1 && q->which != Z_Query_type_101) 
336         return 0;
337     if (q->u.type_1->attributeSetId) {
338         /* Output attribute set ID */
339         wrbuf_puts(buf, "@attrset ");
340         oid2str(q->u.type_1->attributeSetId, buf);
341         wrbuf_putc(buf, ' ');
342     }
343     return rpn2pquery(q->u.type_1->RPNStructure, buf) ? buf : 0;
344 }
345
346
347 /* Lifted verbatim from Net::Z3950 yazwrap/util.c */
348 #include <stdarg.h>
349 void fatal(char *fmt, ...)
350 {
351     va_list ap;
352
353     fprintf(stderr, "FATAL (yazwrap): ");
354     va_start(ap, fmt);
355     vfprintf(stderr, fmt, ap);
356     va_end(ap);
357     fprintf(stderr, "\n");
358     abort();
359 }
360
361
362 /* Lifted verbatim from Net::Z3950 yazwrap/receive.c */
363 /*
364  * Creates a new Perl object of type `class'; the newly-created scalar
365  * that is a reference to the blessed thingy `referent' is returned.
366  */
367 static SV *newObject(char *class, SV *referent)
368 {
369     HV *stash;
370     SV *sv;
371
372     sv = newRV_noinc((SV*) referent);
373     stash = gv_stashpv(class, 0);
374     if (stash == 0)
375         fatal("attempt to create object of undefined class '%s'", class);
376     /*assert(stash != 0);*/
377     sv_bless(sv, stash);
378     return sv;
379 }
380
381
382 /* Lifted verbatim from Net::Z3950 yazwrap/receive.c */
383 static void setMember(HV *hv, char *name, SV *val)
384 {
385     /* We don't increment `val's reference count -- I think this is
386      * right because it's created with a refcount of 1, and in fact
387      * the reference via this hash is the only reference to it in
388      * general.
389      */
390     if (!hv_store(hv, name, (U32) strlen(name), val, (U32) 0))
391         fatal("couldn't store member in hash");
392 }
393
394
395 /* Lifted verbatim from Net::Z3950 yazwrap/receive.c */
396 static SV *translateOID(Odr_oid *x)
397 {
398     /* Yaz represents an OID by an int array terminated by a negative
399      * value, typically -1; we represent it as a reference to a
400      * blessed scalar string of "."-separated elements.
401      */
402     char buf[1000];
403     int i;
404
405     *buf = '\0';
406     for (i = 0; x[i] >= 0; i++) {
407         sprintf(buf + strlen(buf), "%d", (int) x[i]);
408         if (x[i+1] >- 0)
409             strcat(buf, ".");
410     }
411
412     /*
413      * ### We'd like to return a blessed scalar (string) here, but of
414      *  course you can't do that in Perl: only references can be
415      *  blessed, so we'd have to return a _reference_ to a string, and
416      *  bless _that_.  Better to do without the blessing, I think.
417      */
418     if (1) {
419         return newSVpv(buf, 0);
420     } else {
421         return newObject("Net::Z3950::APDU::OID", newSVpv(buf, 0));
422     }
423 }
424
425
426 static SV *rpn2perl(Z_RPNStructure *s)
427 {
428     SV *sv;
429     HV *hv;
430     AV *av;
431
432     switch (s->which) {
433     case Z_RPNStructure_simple: {
434         Z_Operand *o = s->u.simple;
435         Z_AttributesPlusTerm *at;
436         if (o->which != Z_Operand_APT)
437             fatal("can't handle RPN simples other than APT");
438         at = o->u.attributesPlusTerm;
439         if (at->term->which != Z_Term_general)
440             fatal("can't handle RPN terms other than general");
441
442         sv = newObject("Net::Z3950::RPN::Term", (SV*) (hv = newHV()));
443         if (at->attributes) {
444             int i;
445             SV *attrs = newObject("Net::Z3950::RPN::Attributes",
446                                   (SV*) (av = newAV()));
447             for (i = 0; i < at->attributes->num_attributes; i++) {
448                 Z_AttributeElement *elem = at->attributes->attributes[i];
449                 HV *hv2;
450                 SV *tmp = newObject("Net::Z3950::RPN::Attribute",
451                                     (SV*) (hv2 = newHV()));
452                 if (elem->attributeSet)
453                     setMember(hv2, "attributeSet",
454                               translateOID(elem->attributeSet));
455                 setMember(hv2, "attributeType",
456                           newSViv(*elem->attributeType));
457                 assert(elem->which == Z_AttributeValue_numeric);
458                 setMember(hv2, "attributeValue",
459                           newSViv(*elem->value.numeric));
460                 av_push(av, tmp);
461             }
462             setMember(hv, "attributes", attrs);
463         }
464         setMember(hv, "term", newSVpv((char*) at->term->u.general->buf,
465                                       at->term->u.general->len));
466         return sv;
467     }
468     case Z_RPNStructure_complex: {
469         SV *tmp;
470         Z_Complex *c = s->u.complex;
471         char *type = 0;         /* vacuous assignment satisfies gcc -Wall */
472         switch (c->roperator->which) {
473         case Z_Operator_and:     type = "Net::Z3950::RPN::And"; break;
474         case Z_Operator_or:      type = "Net::Z3950::RPN::Or"; break;
475         case Z_Operator_and_not: type = "Net::Z3950::RPN::AndNot"; break;
476         case Z_Operator_prox:    fatal("proximity not yet supported");
477         default: fatal("unknown RPN operator %d", (int) c->roperator->which);
478         }
479         sv = newObject(type, (SV*) (av = newAV()));
480         if ((tmp = rpn2perl(c->s1)) == 0)
481             return 0;
482         av_push(av, tmp);
483         if ((tmp = rpn2perl(c->s2)) == 0)
484             return 0;
485         av_push(av, tmp);
486         return sv;
487     }
488     default: fatal("unknown RPN node type %d", (int) s->which);
489     }
490
491     return 0;
492 }
493
494
495 static SV *zquery2perl(Z_Query *q)
496 {
497     SV *sv;
498     HV *hv;
499
500     if (q->which != Z_Query_type_1 && q->which != Z_Query_type_101) 
501         return 0;
502     sv = newObject("Net::Z3950::APDU::Query", (SV*) (hv = newHV()));
503     if (q->u.type_1->attributeSetId)
504         setMember(hv, "attributeSet",
505                   translateOID(q->u.type_1->attributeSetId));
506     setMember(hv, "query", rpn2perl(q->u.type_1->RPNStructure));
507     return sv;
508 }
509
510
511 int bend_sort(void *handle, bend_sort_rr *rr)
512 {
513         HV *href;
514         AV *aref;
515         SV **temp;
516         SV *err_code;
517         SV *err_str;
518         SV *status;
519         STRLEN len;
520         char *ptr;
521         char *ODR_err_str;
522         char **input_setnames;
523         Zfront_handle *zhandle = (Zfront_handle *)handle;
524         int i;
525         
526         dSP;
527         ENTER;
528         SAVETMPS;
529         
530         aref = newAV();
531         input_setnames = rr->input_setnames;
532         for (i = 0; i < rr->num_input_setnames; i++)
533         {
534                 av_push(aref, newSVpv(*input_setnames++, 0));
535         }
536         href = newHV();
537         hv_store(href, "INPUT", 5, newRV( (SV*) aref), 0);
538         hv_store(href, "OUTPUT", 6, newSVpv(rr->output_setname, 0), 0);
539         hv_store(href, "HANDLE", 6, zhandle->handle, 0);
540         hv_store(href, "STATUS", 6, newSViv(0), 0);
541
542         PUSHMARK(sp);
543
544         XPUSHs(sv_2mortal(newRV( (SV*) href)));
545
546         PUTBACK;
547
548         perl_call_sv(sort_ref, G_SCALAR | G_DISCARD);
549
550         SPAGAIN;
551
552         temp = hv_fetch(href, "ERR_CODE", 8, 1);
553         err_code = newSVsv(*temp);
554
555         temp = hv_fetch(href, "ERR_STR", 7, 1);
556         err_str = newSVsv(*temp);
557
558         temp = hv_fetch(href, "STATUS", 6, 1);
559         status = newSVsv(*temp);
560
561
562         
563
564         PUTBACK;
565         FREETMPS;
566         LEAVE;
567
568         hv_undef(href),
569         av_undef(aref);
570         rr->errcode = SvIV(err_code);
571         rr->sort_status = SvIV(status);
572         ptr = SvPV(err_str, len);
573         ODR_err_str = (char *)odr_malloc(rr->stream, len + 1);
574         strcpy(ODR_err_str, ptr);
575         rr->errstring = ODR_err_str;
576
577         sv_free(err_code);
578         sv_free(err_str);
579         sv_free(status);
580         
581         return 0;
582 }
583
584
585 int bend_search(void *handle, bend_search_rr *rr)
586 {
587         HV *href;
588         AV *aref;
589         SV **temp;
590         SV *hits;
591         SV *err_code;
592         SV *err_str;
593         char *ODR_errstr;
594         STRLEN len;
595         int i;
596         char **basenames;
597         int n;
598         WRBUF query;
599         char *ptr;
600         SV *point;
601         SV *ODR_point;
602         Zfront_handle *zhandle = (Zfront_handle *)handle;
603         CV* handler_cv = 0;
604
605         dSP;
606         ENTER;
607         SAVETMPS;
608
609         aref = newAV();
610         basenames = rr->basenames;
611         for (i = 0; i < rr->num_bases; i++)
612         {
613                 av_push(aref, newSVpv(*basenames++, 0));
614         }
615         href = newHV();         
616         hv_store(href, "SETNAME", 7, newSVpv(rr->setname, 0), 0);
617         hv_store(href, "REPL_SET", 8, newSViv(rr->replace_set), 0);
618         hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
619         hv_store(href, "ERR_STR", 7, newSVpv("", 0), 0);
620         hv_store(href, "HITS", 4, newSViv(0), 0);
621         hv_store(href, "DATABASES", 9, newRV( (SV*) aref), 0);
622         hv_store(href, "HANDLE", 6, zhandle->handle, 0);
623         hv_store(href, "PID", 3, newSViv(getpid()), 0);
624         hv_store(href, "RPN", 3, zquery2perl(rr->query), 0);
625         query = zquery2pquery(rr->query);
626         if (query)
627         {
628                 hv_store(href, "QUERY", 5, newSVpv((char *)query->buf, query->pos), 0);
629         }
630         else
631         {       
632                 rr->errcode = 108;
633         }
634         PUSHMARK(sp);
635         
636         XPUSHs(sv_2mortal(newRV( (SV*) href)));
637         
638         PUTBACK;
639
640         handler_cv = simpleserver_sv2cv( search_ref );
641         perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
642
643         SPAGAIN;
644
645         temp = hv_fetch(href, "HITS", 4, 1);
646         hits = newSVsv(*temp);
647
648         temp = hv_fetch(href, "ERR_CODE", 8, 1);
649         err_code = newSVsv(*temp);
650
651         temp = hv_fetch(href, "ERR_STR", 7, 1);
652         err_str = newSVsv(*temp);
653
654         temp = hv_fetch(href, "HANDLE", 6, 1);
655         point = newSVsv(*temp);
656
657         PUTBACK;
658         FREETMPS;
659         LEAVE;
660         
661         hv_undef(href);
662         av_undef(aref);
663         rr->hits = SvIV(hits);
664         rr->errcode = SvIV(err_code);
665         ptr = SvPV(err_str, len);
666         ODR_errstr = (char *)odr_malloc(rr->stream, len + 1);
667         strcpy(ODR_errstr, ptr);
668         rr->errstring = ODR_errstr;
669 /*      ODR_point = (SV *)odr_malloc(rr->stream, sizeof(*point));
670         memcpy(ODR_point, point, sizeof(*point));
671         zhandle->handle = ODR_point;*/
672         zhandle->handle = point;
673         handle = zhandle;
674         sv_free(hits);
675         sv_free(err_code);
676         sv_free(err_str);
677         sv_free( (SV*) aref);
678         sv_free( (SV*) href);
679         /*sv_free(point);*/
680         wrbuf_free(query, 1);
681         return 0;
682 }
683
684
685 /* ### this is worryingly similar to oid2str() */
686 WRBUF oid2dotted(int *oid)
687 {
688
689         WRBUF buf = wrbuf_alloc();
690         int dot = 0;
691
692         for (; *oid != -1 ; oid++)
693         {
694                 char ibuf[16];
695                 if (dot)
696                 {
697                         wrbuf_putc(buf, '.');
698                 }
699                 else
700                 {
701                         dot = 1;
702                 }
703                 sprintf(ibuf, "%d", *oid);
704                 wrbuf_puts(buf, ibuf);
705         }
706         return buf;
707 }
708                 
709
710 int dotted2oid(char *dotted, int *buffer)
711 {
712         int *oid;
713         char ibuf[16];
714         char *ptr;
715         int n = 0;
716
717         ptr = ibuf;
718         oid = buffer;
719         while (*dotted)
720         {
721                 if (*dotted == '.')
722                 {
723                         n++;
724                         if (n == MAX_OID)  /* Terminate if more than MAX_OID entries */
725                         {
726                                 *oid = -1;
727                                 return -1;
728                         }
729                         *ptr = 0;
730                         sscanf(ibuf, "%d", oid++);
731                         ptr = ibuf;
732                         dotted++;
733
734                 }
735                 else
736                 {
737                         *ptr++ = *dotted++;
738                 }
739         }
740         if (n < MAX_OID)
741         {
742                 *ptr = 0;
743                 sscanf(ibuf, "%d", oid++);
744         }
745         *oid = -1;
746         return 0;
747 }
748
749
750 int bend_fetch(void *handle, bend_fetch_rr *rr)
751 {
752         HV *href;
753         SV **temp;
754         SV *basename;
755         SV *record;
756         SV *last;
757         SV *err_code;
758         SV *err_string;
759         SV *sur_flag;
760         SV *point;
761         SV *rep_form;
762         char *ptr;
763         char *ODR_record;
764         char *ODR_basename;
765         char *ODR_errstr;
766         int *ODR_oid_buf;
767         oident *oid;
768         WRBUF oid_dotted;
769         Zfront_handle *zhandle = (Zfront_handle *)handle;
770         CV* handler_cv = 0;
771
772         Z_RecordComposition *composition;
773         Z_ElementSetNames *simple;
774         STRLEN length;
775
776         dSP;
777         ENTER;
778         SAVETMPS;
779
780         rr->errcode = 0;
781         href = newHV();
782         hv_store(href, "SETNAME", 7, newSVpv(rr->setname, 0), 0);
783         temp = hv_store(href, "OFFSET", 6, newSViv(rr->number), 0);
784         oid_dotted = oid2dotted(rr->request_format_raw);
785         hv_store(href, "REQ_FORM", 8, newSVpv((char *)oid_dotted->buf, oid_dotted->pos), 0);
786         hv_store(href, "REP_FORM", 8, newSVpv((char *)oid_dotted->buf, oid_dotted->pos), 0);
787         hv_store(href, "BASENAME", 8, newSVpv("", 0), 0);
788         hv_store(href, "RECORD", 6, newSVpv("", 0), 0);
789         hv_store(href, "LAST", 4, newSViv(0), 0);
790         hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
791         hv_store(href, "ERR_STR", 7, newSVpv("", 0), 0);
792         hv_store(href, "SUR_FLAG", 8, newSViv(0), 0);
793         hv_store(href, "HANDLE", 6, zhandle->handle, 0);
794         hv_store(href, "PID", 3, newSViv(getpid()), 0);
795         if (rr->comp)
796         {
797                 composition = rr->comp;
798                 if (composition->which == Z_RecordComp_simple)
799                 {
800                         simple = composition->u.simple;
801                         if (simple->which == Z_ElementSetNames_generic)
802                         {
803                                 hv_store(href, "COMP", 4, newSVpv(simple->u.generic, 0), 0);
804                         } 
805                         else
806                         {
807                                 rr->errcode = 26;
808                         }
809                 }
810                 else
811                 {
812                         rr->errcode = 26;
813                 }
814         }
815
816         PUSHMARK(sp);
817
818         XPUSHs(sv_2mortal(newRV( (SV*) href)));
819
820         PUTBACK;
821         
822         handler_cv = simpleserver_sv2cv( fetch_ref );
823         perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
824
825         SPAGAIN;
826
827         temp = hv_fetch(href, "BASENAME", 8, 1);
828         basename = newSVsv(*temp);
829
830         temp = hv_fetch(href, "RECORD", 6, 1);
831         record = newSVsv(*temp);
832
833         temp = hv_fetch(href, "LAST", 4, 1);
834         last = newSVsv(*temp);
835
836         temp = hv_fetch(href, "ERR_CODE", 8, 1);
837         err_code = newSVsv(*temp);
838
839         temp = hv_fetch(href, "ERR_STR", 7, 1),
840         err_string = newSVsv(*temp);
841
842         temp = hv_fetch(href, "SUR_FLAG", 8, 1);
843         sur_flag = newSVsv(*temp);
844
845         temp = hv_fetch(href, "REP_FORM", 8, 1);
846         rep_form = newSVsv(*temp);
847
848         temp = hv_fetch(href, "HANDLE", 6, 1);
849         point = newSVsv(*temp);
850
851         PUTBACK;
852         FREETMPS;
853         LEAVE;
854
855         hv_undef(href);
856         
857         ptr = SvPV(basename, length);
858         ODR_basename = (char *)odr_malloc(rr->stream, length + 1);
859         strcpy(ODR_basename, ptr);
860         rr->basename = ODR_basename;
861
862         ptr = SvPV(rep_form, length);
863         ODR_oid_buf = (int *)odr_malloc(rr->stream, (MAX_OID + 1) * sizeof(int));
864         if (dotted2oid(ptr, ODR_oid_buf) == -1)         /* Maximum number of OID elements exceeded */
865         {
866                 printf("Net::Z3950::SimpleServer: WARNING: OID structure too long, max length is %d\n", MAX_OID);
867         }
868         rr->output_format_raw = ODR_oid_buf;    
869         
870         ptr = SvPV(record, length);
871         oid = oid_getentbyoid(ODR_oid_buf);
872         if (oid->value == VAL_GRS1)             /* Treat GRS-1 records separately */
873         {
874                 rr->record = (char *) read_grs1(ptr, rr->stream);
875                 rr->len = -1;
876         }
877         else
878         {
879                 ODR_record = (char *)odr_malloc(rr->stream, length + 1);
880                 strcpy(ODR_record, ptr);
881                 rr->record = ODR_record;
882                 rr->len = length;
883         }
884         zhandle->handle = point;
885         handle = zhandle;
886         rr->last_in_set = SvIV(last);
887         
888         if (!(rr->errcode))
889         {
890                 rr->errcode = SvIV(err_code);
891                 ptr = SvPV(err_string, length);
892                 ODR_errstr = (char *)odr_malloc(rr->stream, length + 1);
893                 strcpy(ODR_errstr, ptr);
894                 rr->errstring = ODR_errstr;
895         }
896         rr->surrogate_flag = SvIV(sur_flag);
897
898         wrbuf_free(oid_dotted, 1);
899         sv_free((SV*) href);
900         sv_free(basename);
901         sv_free(record);
902         sv_free(last);
903         sv_free(err_string);
904         sv_free(err_code),
905         sv_free(sur_flag);
906         sv_free(rep_form);
907         
908         return 0;
909 }
910
911
912 int bend_present(void *handle, bend_present_rr *rr)
913 {
914
915         HV *href;
916         SV **temp;
917         SV *err_code;
918         SV *err_string;
919         SV *hits;
920         SV *point;
921         STRLEN len;
922         Z_RecordComposition *composition;
923         Z_ElementSetNames *simple;
924         char *ODR_errstr;
925         char *ptr;
926         Zfront_handle *zhandle = (Zfront_handle *)handle;
927         CV* handler_cv = 0;
928
929 /*      WRBUF oid_dotted; */
930
931         dSP;
932         ENTER;
933         SAVETMPS;
934
935         href = newHV();
936         hv_store(href, "HANDLE", 6, zhandle->handle, 0);
937         hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
938         hv_store(href, "ERR_STR", 7, newSVpv("", 0), 0);
939         hv_store(href, "START", 5, newSViv(rr->start), 0);
940         hv_store(href, "SETNAME", 7, newSVpv(rr->setname, 0), 0);
941         hv_store(href, "NUMBER", 6, newSViv(rr->number), 0);
942         /*oid_dotted = oid2dotted(rr->request_format_raw);
943         hv_store(href, "REQ_FORM", 8, newSVpv((char *)oid_dotted->buf, oid_dotted->pos), 0);*/
944         hv_store(href, "HITS", 4, newSViv(0), 0);
945         hv_store(href, "PID", 3, newSViv(getpid()), 0);
946         if (rr->comp)
947         {
948                 composition = rr->comp;
949                 if (composition->which == Z_RecordComp_simple)
950                 {
951                         simple = composition->u.simple;
952                         if (simple->which == Z_ElementSetNames_generic)
953                         {
954                                 hv_store(href, "COMP", 4, newSVpv(simple->u.generic, 0), 0);
955                         } 
956                         else
957                         {
958                                 rr->errcode = 26;
959                                 return 0;
960                         }
961                 }
962                 else
963                 {
964                         rr->errcode = 26;
965                         return 0;
966                 }
967         }
968
969         PUSHMARK(sp);
970         
971         XPUSHs(sv_2mortal(newRV( (SV*) href)));
972         
973         PUTBACK;
974         
975         handler_cv = simpleserver_sv2cv( present_ref );
976         perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
977         
978         SPAGAIN;
979
980         temp = hv_fetch(href, "ERR_CODE", 8, 1);
981         err_code = newSVsv(*temp);
982
983         temp = hv_fetch(href, "ERR_STR", 7, 1);
984         err_string = newSVsv(*temp);
985
986         temp = hv_fetch(href, "HITS", 4, 1);
987         hits = newSVsv(*temp);
988
989         temp = hv_fetch(href, "HANDLE", 6, 1);
990         point = newSVsv(*temp);
991
992         PUTBACK;
993         FREETMPS;
994         LEAVE;
995         
996         hv_undef(href);
997         rr->errcode = SvIV(err_code);
998         rr->hits = SvIV(hits);
999
1000         ptr = SvPV(err_string, len);
1001         ODR_errstr = (char *)odr_malloc(rr->stream, len + 1);
1002         strcpy(ODR_errstr, ptr);
1003         rr->errstring = ODR_errstr;
1004 /*      wrbuf_free(oid_dotted, 1);*/
1005         zhandle->handle = point;
1006         handle = zhandle;
1007         sv_free(err_code);
1008         sv_free(err_string);
1009         sv_free(hits);
1010         sv_free( (SV*) href);
1011
1012         return 0;
1013 }
1014
1015
1016 int bend_esrequest(void *handle, bend_esrequest_rr *rr)
1017 {
1018         perl_call_sv(esrequest_ref, G_VOID | G_DISCARD | G_NOARGS);
1019         return 0;
1020 }
1021
1022
1023 int bend_delete(void *handle, bend_delete_rr *rr)
1024 {
1025         perl_call_sv(delete_ref, G_VOID | G_DISCARD | G_NOARGS);
1026         return 0;
1027 }
1028
1029
1030 int bend_scan(void *handle, bend_scan_rr *rr)
1031 {
1032         HV *href;
1033         AV *aref;
1034         AV *list;
1035         AV *entries;
1036         HV *scan_item;
1037         struct scan_entry *scan_list;
1038         struct scan_entry *buffer;
1039         int *step_size = rr->step_size;
1040         int i;
1041         char **basenames;
1042         SV **temp;
1043         SV *err_code = sv_newmortal();
1044         SV *err_str = sv_newmortal();
1045         SV *point = sv_newmortal();
1046         SV *status = sv_newmortal();
1047         SV *number = sv_newmortal();
1048         char *ptr;
1049         char *ODR_errstr;
1050         STRLEN len;
1051         int term_len;
1052         SV *term_tmp;
1053         SV *entries_ref;
1054         Zfront_handle *zhandle = (Zfront_handle *)handle;
1055         CV* handler_cv = 0;
1056
1057         dSP;
1058         ENTER;
1059         SAVETMPS;
1060         href = newHV();
1061         list = newAV();
1062         if (rr->term->term->which == Z_Term_general)
1063         {
1064                 term_len = rr->term->term->u.general->len;
1065                 hv_store(href, "TERM", 4, newSVpv(rr->term->term->u.general->buf, term_len), 0);
1066         } else {
1067                 rr->errcode = 229;      /* Unsupported term type */
1068                 return 0;
1069         }
1070         hv_store(href, "STEP", 4, newSViv(*step_size), 0);
1071         hv_store(href, "NUMBER", 6, newSViv(rr->num_entries), 0);
1072         hv_store(href, "POS", 3, newSViv(rr->term_position), 0);
1073         hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
1074         hv_store(href, "ERR_STR", 7, newSVpv("", 0), 0);
1075         hv_store(href, "HANDLE", 6, zhandle->handle, 0);
1076         hv_store(href, "STATUS", 6, newSViv(BEND_SCAN_SUCCESS), 0);
1077         hv_store(href, "ENTRIES", 7, newRV((SV *) list), 0);
1078         aref = newAV();
1079         basenames = rr->basenames;
1080         for (i = 0; i < rr->num_bases; i++)
1081         {
1082                 av_push(aref, newSVpv(*basenames++, 0));
1083         }
1084         hv_store(href, "DATABASES", 9, newRV( (SV*) aref), 0);
1085
1086         PUSHMARK(sp);
1087
1088         XPUSHs(sv_2mortal(newRV( (SV*) href)));
1089
1090         PUTBACK;
1091
1092         handler_cv = simpleserver_sv2cv( scan_ref );
1093         perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
1094
1095         SPAGAIN;
1096
1097         temp = hv_fetch(href, "ERR_CODE", 8, 1);
1098         err_code = newSVsv(*temp);
1099
1100         temp = hv_fetch(href, "ERR_STR", 7, 1);
1101         err_str = newSVsv(*temp);
1102
1103         temp = hv_fetch(href, "HANDLE", 6, 1);
1104         point = newSVsv(*temp);
1105
1106         temp = hv_fetch(href, "STATUS", 6, 1);
1107         status = newSVsv(*temp);
1108         
1109         temp = hv_fetch(href, "NUMBER", 6, 1);
1110         number = newSVsv(*temp);
1111
1112         temp = hv_fetch(href, "ENTRIES", 7, 1);
1113         entries_ref = newSVsv(*temp);
1114
1115         PUTBACK;
1116         FREETMPS;
1117         LEAVE;
1118
1119         ptr = SvPV(err_str, len);
1120         ODR_errstr = (char *)odr_malloc(rr->stream, len + 1);
1121         strcpy(ODR_errstr, ptr);
1122         rr->errstring = ODR_errstr;
1123         rr->errcode = SvIV(err_code);
1124         rr->num_entries = SvIV(number);
1125         rr->status = SvIV(status);
1126         scan_list = (struct scan_entry *) odr_malloc (rr->stream, rr->num_entries * sizeof(*scan_list));
1127         buffer = scan_list;
1128         entries = (AV *)SvRV(entries_ref);
1129         for (i = 0; i < rr->num_entries; i++)
1130         {
1131                 scan_item = (HV *)SvRV(sv_2mortal(av_shift(entries)));
1132                 temp = hv_fetch(scan_item, "TERM", 4, 1);
1133                 ptr = SvPV(*temp, len);
1134                 buffer->term = (char *) odr_malloc (rr->stream, len + 1); 
1135                 strcpy(buffer->term, ptr);
1136                 temp = hv_fetch(scan_item, "OCCURRENCE", 10, 1); 
1137                 buffer->occurrences = SvIV(*temp);
1138                 buffer++;
1139                 hv_undef(scan_item);
1140         }
1141         rr->entries = scan_list;
1142         zhandle->handle = point;
1143         handle = zhandle;
1144         sv_free(err_code);
1145         sv_free(err_str);
1146         sv_free(status);
1147         sv_free(number);
1148         hv_undef(href);
1149         sv_free((SV *)href);
1150         av_undef(aref);
1151         sv_free((SV *)aref);
1152         av_undef(list);
1153         sv_free((SV *)list);
1154         av_undef(entries);
1155         /*sv_free((SV *)entries);*/
1156         sv_free(entries_ref);
1157
1158         return 0;
1159 }
1160
1161
1162 bend_initresult *bend_init(bend_initrequest *q)
1163 {
1164         int dummy = simpleserver_clone();
1165         bend_initresult *r = (bend_initresult *) odr_malloc (q->stream, sizeof(*r));
1166         HV *href;
1167         SV **temp;
1168         SV *id;
1169         SV *name;
1170         SV *ver;
1171         SV *err_str;
1172         SV *status;
1173         Zfront_handle *zhandle =  (Zfront_handle *) xmalloc (sizeof(*zhandle));
1174         STRLEN len;
1175         int n;
1176         SV *handle;
1177         /*char *name_ptr;
1178         char *ver_ptr;*/
1179         char *ptr;
1180         char *user = NULL;
1181         char *passwd = NULL;
1182         CV* handler_cv = 0;
1183
1184         dSP;
1185         ENTER;
1186         SAVETMPS;
1187
1188         /*q->bend_sort = bend_sort;*/
1189         if (search_ref)
1190         {
1191                 q->bend_search = bend_search;
1192         }
1193         if (present_ref)
1194         {
1195                 q->bend_present = bend_present;
1196         }
1197         /*q->bend_esrequest = bend_esrequest;*/
1198         /*q->bend_delete = bend_delete;*/
1199         if (fetch_ref)
1200         {
1201                 q->bend_fetch = bend_fetch;
1202         }
1203         if (scan_ref)
1204         {
1205                 q->bend_scan = bend_scan;
1206         }
1207         href = newHV(); 
1208         hv_store(href, "IMP_ID", 6, newSVpv("", 0), 0);
1209         hv_store(href, "IMP_NAME", 8, newSVpv("", 0), 0);
1210         hv_store(href, "IMP_VER", 7, newSVpv("", 0), 0);
1211         hv_store(href, "ERR_CODE", 8, newSViv(0), 0);
1212         hv_store(href, "ERR_STR", 7, newSViv(0), 0);
1213         hv_store(href, "PEER_NAME", 9, newSVpv(q->peer_name, 0), 0);
1214         hv_store(href, "HANDLE", 6, newSVsv(&sv_undef), 0);
1215         hv_store(href, "PID", 3, newSViv(getpid()), 0);
1216         if (q->auth) {
1217             if (q->auth->which == Z_IdAuthentication_open) {
1218                 char *openpass = xstrdup (q->auth->u.open);
1219                 char *cp = strchr (openpass, '/');
1220                 if (cp) {
1221                     *cp = '\0';
1222                     user = nmem_strdup (odr_getmem (q->stream), openpass);
1223                     passwd = nmem_strdup (odr_getmem (q->stream), cp + 1);
1224                 }
1225                 xfree(openpass);
1226             } else if (q->auth->which == Z_IdAuthentication_idPass) {
1227                 user = q->auth->u.idPass->userId;
1228                 passwd = q->auth->u.idPass->password;
1229             }
1230             /* ### some code paths have user/password unassigned here */
1231             hv_store(href, "USER", 4, newSVpv(user, 0), 0);
1232             hv_store(href, "PASS", 4, newSVpv(passwd, 0), 0);
1233         }
1234
1235         PUSHMARK(sp);   
1236
1237         XPUSHs(sv_2mortal(newRV( (SV*) href)));
1238
1239         PUTBACK;
1240
1241         if (init_ref != NULL)
1242         {
1243              handler_cv = simpleserver_sv2cv( init_ref );
1244              perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
1245         }
1246
1247         SPAGAIN;
1248
1249         temp = hv_fetch(href, "IMP_ID", 6, 1);
1250         id = newSVsv(*temp);
1251
1252         temp = hv_fetch(href, "IMP_NAME", 8, 1);
1253         name = newSVsv(*temp);
1254
1255         temp = hv_fetch(href, "IMP_VER", 7, 1);
1256         ver = newSVsv(*temp);
1257
1258         temp = hv_fetch(href, "ERR_CODE", 8, 1);
1259         status = newSVsv(*temp);
1260
1261         temp = hv_fetch(href, "ERR_STR", 7, 1);
1262         err_str = newSVsv(*temp);
1263
1264         temp = hv_fetch(href, "HANDLE", 6, 1);
1265         handle= newSVsv(*temp);
1266
1267         hv_undef(href);
1268         PUTBACK;
1269         FREETMPS;
1270         LEAVE;
1271         zhandle->handle = handle;
1272         r->errcode = SvIV(status);
1273         ptr = SvPV(err_str, len);
1274         r->errstring = (char *)odr_malloc(q->stream, len + 1);
1275         strcpy(r->errstring, ptr);
1276         sv_free(err_str);
1277         r->handle = zhandle;
1278         ptr = SvPV(id, len);
1279         q->implementation_id = (char *)xmalloc(len + 1);
1280         strcpy(q->implementation_id, ptr);
1281         ptr = SvPV(name, len);
1282         q->implementation_name = (char *)xmalloc(len + 1);
1283         strcpy(q->implementation_name, ptr);
1284 /*      q->implementation_name = SvPV(name, len);*/
1285         ptr = SvPV(ver, len);
1286         q->implementation_version = (char *)xmalloc(len + 1);
1287         strcpy(q->implementation_version, ptr);
1288         
1289         return r;
1290 }
1291
1292
1293 void bend_close(void *handle)
1294 {
1295         HV *href;
1296         Zfront_handle *zhandle = (Zfront_handle *)handle;
1297         SV **temp;
1298         CV* handler_cv = 0;
1299
1300
1301         if (close_ref)
1302         {
1303                 dSP;
1304                 ENTER;
1305                 SAVETMPS;
1306                 href = newHV();
1307                 hv_store(href, "HANDLE", 6, zhandle->handle, 0);
1308
1309                 PUSHMARK(sp);
1310
1311                 XPUSHs(sv_2mortal(newRV((SV *)href)));
1312
1313                 PUTBACK;
1314         
1315                 handler_cv = simpleserver_sv2cv( close_ref );
1316                 perl_call_sv( (SV *) handler_cv, G_SCALAR | G_DISCARD);
1317         
1318                 SPAGAIN;
1319
1320                 PUTBACK;
1321                 FREETMPS;
1322                 LEAVE;
1323         }
1324         xfree(handle);
1325         simpleserver_free();
1326         
1327         return;
1328 }
1329
1330
1331 MODULE = Net::Z3950::SimpleServer       PACKAGE = Net::Z3950::SimpleServer
1332
1333 void
1334 set_init_handler(arg)
1335                 SV *arg
1336         CODE:
1337                 init_ref = newSVsv(arg);
1338                 
1339
1340 void
1341 set_close_handler(arg)
1342                 SV *arg
1343         CODE:
1344                 close_ref = newSVsv(arg);
1345
1346
1347 void
1348 set_sort_handler(arg)
1349                 SV *arg
1350         CODE:
1351                 sort_ref = newSVsv(arg);
1352
1353 void
1354 set_search_handler(arg)
1355                 SV *arg
1356         CODE:
1357                 search_ref = newSVsv(arg);
1358
1359
1360 void
1361 set_fetch_handler(arg)
1362                 SV *arg
1363         CODE:
1364                 fetch_ref = newSVsv(arg);
1365
1366
1367 void
1368 set_present_handler(arg)
1369                 SV *arg
1370         CODE:
1371                 present_ref = newSVsv(arg);
1372
1373
1374 void
1375 set_esrequest_handler(arg)
1376                 SV *arg
1377         CODE:
1378                 esrequest_ref = newSVsv(arg);
1379
1380
1381 void
1382 set_delete_handler(arg)
1383                 SV *arg
1384         CODE:
1385                 delete_ref = newSVsv(arg);
1386
1387
1388 void
1389 set_scan_handler(arg)
1390                 SV *arg
1391         CODE:
1392                 scan_ref = newSVsv(arg);
1393
1394
1395 int
1396 start_server(...)
1397         PREINIT:
1398                 char **argv;
1399                 char **argv_buf;
1400                 char *ptr;
1401                 int i;
1402                 STRLEN len;
1403         CODE:
1404                 argv_buf = (char **)xmalloc((items + 1) * sizeof(char *));
1405                 argv = argv_buf;
1406                 for (i = 0; i < items; i++)
1407                 {
1408                         ptr = SvPV(ST(i), len);
1409                         *argv_buf = (char *)xmalloc(len + 1);
1410                         strcpy(*argv_buf++, ptr); 
1411                 }
1412                 *argv_buf = NULL;
1413                 root_perl_context = PERL_GET_CONTEXT;
1414                 nmem_mutex_create(&simpleserver_mutex);
1415 #if 0
1416                 tst_clones();
1417 #endif
1418                 
1419                 RETVAL = statserv_main(items, argv, bend_init, bend_close);
1420         OUTPUT:
1421                 RETVAL
1422
1423
1424 int
1425 ScanSuccess()
1426         CODE:
1427                 RETVAL = BEND_SCAN_SUCCESS;
1428         OUTPUT:
1429                 RETVAL
1430
1431 int
1432 ScanPartial()
1433         CODE:
1434                 RETVAL = BEND_SCAN_PARTIAL;
1435         OUTPUT:
1436                 RETVAL
1437
1438