server/seshigh.c

   1 /*
   2  * Copyright (c) 1995-2001, Index Data
   3  * See the file LICENSE for details.
   4  *
   5  * $Id: seshigh.c,v 1.121 2001-11-13 23:00:42 adam Exp $
   6  */
   7
   8 /*
   9  * Frontend server logic.
  10  *
  11  * This code receives incoming APDUs, and handles client requests by means
  12  * of the backend API.
  13  *
  14  * Some of the code is getting quite involved, compared to simpler servers -
  15  * primarily because it is asynchronous both in the communication with
  16  * the user and the backend. We think the complexity will pay off in
  17  * the form of greater flexibility when more asynchronous facilities
  18  * are implemented.
  19  *
  20  * Memory management has become somewhat involved. In the simple case, where
  21  * only one PDU is pending at a time, it will simply reuse the same memory,
  22  * once it has found its working size. When we enable multiple concurrent
  23  * operations, perhaps even with multiple parallel calls to the backend, it
  24  * will maintain a pool of buffers for encoding and decoding, trying to
  25  * minimize memory allocation/deallocation during normal operation.
  26  *
  27  */
  28
  29 #include <stdlib.h>
  30 #include <stdio.h>
  31 #ifdef WIN32
  32 #include <process.h>
  33 #else
  34 #include <unistd.h>
  35 #endif
  36 #include <assert.h>
  37
  38 #include <yaz/yconfig.h>
  39 #include <yaz/xmalloc.h>
  40 #include <yaz/comstack.h>
  41 #include "eventl.h"
  42 #include "session.h"
  43 #include <yaz/proto.h>
  44 #include <yaz/oid.h>
  45 #include <yaz/log.h>
  46 #include <yaz/logrpn.h>
  47 #include <yaz/statserv.h>
  48
  49 #include <yaz/backend.h>
  50
  51 static int process_request(association *assoc, request *req, char **msg);
  52 void backend_response(IOCHAN i, int event);
  53 static int process_response(association *assoc, request *req, Z_APDU *res);
  54 static Z_APDU *process_initRequest(association *assoc, request *reqb);
  55 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
  56     int *fd);
  57 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
  58     bend_search_rr *bsrr, int *fd);
  59 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
  60     int *fd);
  61 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd);
  62 static Z_APDU *process_sortRequest(association *assoc, request *reqb, int *fd);
  63 static void process_close(association *assoc, request *reqb);
  64 void save_referenceId (request *reqb, Z_ReferenceId *refid);
  65 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
  66     int *fd);
  67 static Z_APDU *process_segmentRequest (association *assoc, request *reqb);
  68
  69 static FILE *apduf = 0; /* for use in static mode */
  70 static statserv_options_block *control_block = 0;
  71
  72 /* Chas: Added in from DALI */
  73 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd);
  74 /* Chas: End of addition from DALI */
  75
  76 /*
  77  * Create and initialize a new association-handle.
  78  *  channel  : iochannel for the current line.
  79  *  link     : communications channel.
  80  * Returns: 0 or a new association handle.
  81  */
  82 association *create_association(IOCHAN channel, COMSTACK link)
  83 {
  84     association *anew;
  85
  86     if (!control_block)
  87         control_block = statserv_getcontrol();
  88     if (!(anew = (association *)xmalloc(sizeof(*anew))))
  89         return 0;
  90     anew->init = 0;
  91     anew->client_chan = channel;
  92     anew->client_link = link;
  93     anew->cs_get_mask = 0;
  94     anew->cs_put_mask = 0;
  95     anew->cs_accept_mask = 0;
  96     if (!(anew->decode = odr_createmem(ODR_DECODE)) ||
  97         !(anew->encode = odr_createmem(ODR_ENCODE)))
  98         return 0;
  99     if (*control_block->apdufile)
 100     {
 101         char filename[256];
 102         FILE *f;
 103
 104         strcpy(filename, control_block->apdufile);
 105         if (!(anew->print = odr_createmem(ODR_PRINT)))
 106             return 0;
 107         if (*control_block->apdufile != '-')
 108         {
 109             strcpy(filename, control_block->apdufile);
 110             if (!control_block->dynamic)
 111             {
 112                 if (!apduf)
 113                 {
 114                     if (!(apduf = fopen(filename, "w")))
 115                     {
 116                         yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
 117                         return 0;
 118                     }
 119                     setvbuf(apduf, 0, _IONBF, 0);
 120                 }
 121                 f = apduf;
 122             }
 123             else
 124             {
 125                 sprintf(filename + strlen(filename), ".%d", getpid());
 126                 if (!(f = fopen(filename, "w")))
 127                 {
 128                     yaz_log(LOG_WARN|LOG_ERRNO, "%s", filename);
 129                     return 0;
 130                 }
 131                 setvbuf(f, 0, _IONBF, 0);
 132             }
 133             odr_setprint(anew->print, f);
 134         }
 135     }
 136     else
 137         anew->print = 0;
 138     anew->input_buffer = 0;
 139     anew->input_buffer_len = 0;
 140     anew->backend = 0;
 141     anew->state = ASSOC_NEW;
 142     request_initq(&anew->incoming);
 143     request_initq(&anew->outgoing);
 144     anew->proto = cs_getproto(link);
 145     return anew;
 146 }
 147
 148 /*
 149  * Free association and release resources.
 150  */
 151 void destroy_association(association *h)
 152 {
 153     statserv_options_block *cb = statserv_getcontrol();
 154
 155     xfree(h->init);
 156     odr_destroy(h->decode);
 157     odr_destroy(h->encode);
 158     if (h->print)
 159         odr_destroy(h->print);
 160     if (h->input_buffer)
 161     xfree(h->input_buffer);
 162     if (h->backend)
 163         (*cb->bend_close)(h->backend);
 164     while (request_deq(&h->incoming));
 165     while (request_deq(&h->outgoing));
 166     request_delq(&h->incoming);
 167     request_delq(&h->outgoing);
 168     xfree(h);
 169     if (control_block && control_block->one_shot)
 170         exit (0);
 171 }
 172
 173 static void do_close_req(association *a, int reason, char *message,
 174                          request *req)
 175 {
 176     Z_APDU apdu;
 177     Z_Close *cls = zget_Close(a->encode);
 178
 179     /* Purge request queue */
 180     while (request_deq(&a->incoming));
 181     while (request_deq(&a->outgoing));
 182     if (a->version >= 3)
 183     {
 184         yaz_log(LOG_LOG, "Sending Close PDU, reason=%d, message=%s",
 185             reason, message ? message : "none");
 186         apdu.which = Z_APDU_close;
 187         apdu.u.close = cls;
 188         *cls->closeReason = reason;
 189         cls->diagnosticInformation = message;
 190         process_response(a, req, &apdu);
 191         iochan_settimeout(a->client_chan, 60);
 192     }
 193     else
 194     {
 195         yaz_log(LOG_DEBUG, "v2 client. No Close PDU");
 196         iochan_setevent(a->client_chan, EVENT_TIMEOUT); /* force imm close */
 197     }
 198     a->state = ASSOC_DEAD;
 199 }
 200
 201 static void do_close(association *a, int reason, char *message)
 202 {
 203     do_close_req (a, reason, message, request_get(&a->outgoing));
 204 }
 205
 206 /*
 207  * This is where PDUs from the client are read and the further
 208  * processing is initiated. Flow of control moves down through the
 209  * various process_* functions below, until the encoded result comes back up
 210  * to the output handler in here.
 211  *
 212  *  h     : the I/O channel that has an outstanding event.
 213  *  event : the current outstanding event.
 214  */
 215 void ir_session(IOCHAN h, int event)
 216 {
 217     int res;
 218     association *assoc = (association *)iochan_getdata(h);
 219     COMSTACK conn = assoc->client_link;
 220     request *req;
 221
 222     assert(h && conn && assoc);
 223     if (event == EVENT_TIMEOUT)
 224     {
 225         if (assoc->state != ASSOC_UP)
 226         {
 227             yaz_log(LOG_LOG, "Final timeout - closing connection.");
 228             cs_close(conn);
 229             destroy_association(assoc);
 230             iochan_destroy(h);
 231         }
 232         else
 233         {
 234             yaz_log(LOG_LOG, "Session idle too long. Sending close.");
 235             do_close(assoc, Z_Close_lackOfActivity, 0);
 236         }
 237         return;
 238     }
 239     if (event & assoc->cs_accept_mask)
 240     {
 241         yaz_log (LOG_DEBUG, "ir_session (accept)");
 242         if (!cs_accept (conn))
 243         {
 244             yaz_log (LOG_LOG, "accept failed");
 245             destroy_association(assoc);
 246             iochan_destroy(h);
 247         }
 248         iochan_clearflag (h, EVENT_OUTPUT|EVENT_OUTPUT);
 249         if (conn->io_pending)
 250         {   /* cs_accept didn't complete */
 251             assoc->cs_accept_mask =
 252                 ((conn->io_pending & CS_WANT_WRITE) ? EVENT_OUTPUT : 0) |
 253                 ((conn->io_pending & CS_WANT_READ) ? EVENT_INPUT : 0);
 254
 255             iochan_setflag (h, assoc->cs_accept_mask);
 256         }
 257         else
 258         {   /* cs_accept completed. Prepare for reading (cs_get) */
 259             assoc->cs_accept_mask = 0;
 260             assoc->cs_get_mask = EVENT_INPUT;
 261             iochan_setflag (h, assoc->cs_get_mask);
 262         }
 263         return;
 264     }
 265     if ((event & assoc->cs_get_mask) || (event & EVENT_WORK)) /* input */
 266     {
 267         if ((assoc->cs_put_mask & EVENT_INPUT) == 0 && (event & assoc->cs_get_mask))
 268         {
 269             yaz_log(LOG_DEBUG, "ir_session (input)");
 270             /* We aren't speaking to this fellow */
 271             if (assoc->state == ASSOC_DEAD)
 272             {
 273                 yaz_log(LOG_LOG, "Closed connection after reject");
 274                 cs_close(conn);
 275                 destroy_association(assoc);
 276                 iochan_destroy(h);
 277                 return;
 278             }
 279             assoc->cs_get_mask = EVENT_INPUT;
 280             if ((res = cs_get(conn, &assoc->input_buffer,
 281                 &assoc->input_buffer_len)) <= 0)
 282             {
 283                 yaz_log(LOG_LOG, "Connection closed by client");
 284                 cs_close(conn);
 285                 destroy_association(assoc);
 286                 iochan_destroy(h);
 287                 return;
 288             }
 289             else if (res == 1) /* incomplete read - wait for more  */
 290             {
 291                 if (conn->io_pending & CS_WANT_WRITE)
 292                     assoc->cs_get_mask |= EVENT_OUTPUT;
 293                 iochan_setflag(h, assoc->cs_get_mask);
 294                 return;
 295             }
 296             if (cs_more(conn)) /* more stuff - call us again later, please */
 297                 iochan_setevent(h, EVENT_INPUT);
 298
 299             /* we got a complete PDU. Let's decode it */
 300             yaz_log(LOG_DEBUG, "Got PDU, %d bytes", res);
 301             req = request_get(&assoc->incoming); /* get a new request structure */
 302             odr_reset(assoc->decode);
 303             odr_setbuf(assoc->decode, assoc->input_buffer, res, 0);
 304             if (!z_APDU(assoc->decode, &req->apdu_request, 0, 0))
 305             {
 306                 yaz_log(LOG_LOG, "ODR error on incoming PDU: %s [near byte %d] ",
 307                         odr_errmsg(odr_geterror(assoc->decode)),
 308                         odr_offset(assoc->decode));
 309                 yaz_log(LOG_LOG, "PDU dump:");
 310                 odr_dumpBER(yaz_log_file(), assoc->input_buffer, res);
 311                 do_close(assoc, Z_Close_protocolError, "Malformed package");
 312                 return;
 313             }
 314             req->request_mem = odr_extract_mem(assoc->decode);
 315             if (assoc->print && !z_APDU(assoc->print, &req->apdu_request, 0, 0))
 316             {
 317                 yaz_log(LOG_WARN, "ODR print error: %s",
 318                     odr_errmsg(odr_geterror(assoc->print)));
 319                 odr_reset(assoc->print);
 320             }
 321             request_enq(&assoc->incoming, req);
 322         }
 323
 324         /* can we do something yet? */
 325         req = request_head(&assoc->incoming);
 326         if (req->state == REQUEST_IDLE)
 327         {
 328             char *msg;
 329             request_deq(&assoc->incoming);
 330             if (process_request(assoc, req, &msg) < 0)
 331                 do_close_req(assoc, Z_Close_systemProblem, msg, req);
 332         }
 333     }
 334     if (event & assoc->cs_put_mask)
 335     {
 336         request *req = request_head(&assoc->outgoing);
 337
 338         assoc->cs_put_mask = 0;
 339         yaz_log(LOG_DEBUG, "ir_session (output)");
 340         req->state = REQUEST_PENDING;
 341         switch (res = cs_put(conn, req->response, req->len_response))
 342         {
 343         case -1:
 344             yaz_log(LOG_LOG, "Connection closed by client");
 345             cs_close(conn);
 346             destroy_association(assoc);
 347             iochan_destroy(h);
 348             break;
 349         case 0: /* all sent - release the request structure */
 350             yaz_log(LOG_DEBUG, "Wrote PDU, %d bytes", req->len_response);
 351             nmem_destroy(req->request_mem);
 352             request_deq(&assoc->outgoing);
 353             request_release(req);
 354             if (!request_head(&assoc->outgoing))
 355             {   /* restore mask for cs_get operation ... */
 356                 iochan_clearflag(h, EVENT_OUTPUT|EVENT_INPUT);
 357                 iochan_setflag(h, assoc->cs_get_mask);
 358             }
 359             break;
 360         default:
 361             if (conn->io_pending & CS_WANT_WRITE)
 362                 assoc->cs_put_mask |= EVENT_OUTPUT;
 363             if (conn->io_pending & CS_WANT_READ)
 364                 assoc->cs_put_mask |= EVENT_INPUT;
 365             iochan_setflag(h, assoc->cs_put_mask);
 366         }
 367     }
 368     if (event & EVENT_EXCEPT)
 369     {
 370         yaz_log(LOG_LOG, "ir_session (exception)");
 371         cs_close(conn);
 372         destroy_association(assoc);
 373         iochan_destroy(h);
 374     }
 375 }
 376
 377 /*
 378  * Initiate request processing.
 379  */
 380 static int process_request(association *assoc, request *req, char **msg)
 381 {
 382     int fd = -1;
 383     Z_APDU *res;
 384     int retval;
 385
 386     *msg = "Unknown Error";
 387     assert(req && req->state == REQUEST_IDLE);
 388     if (req->apdu_request->which != Z_APDU_initRequest && !assoc->init)
 389     {
 390         *msg = "Missing InitRequest";
 391         return -1;
 392     }
 393     switch (req->apdu_request->which)
 394     {
 395     case Z_APDU_initRequest:
 396         res = process_initRequest(assoc, req); break;
 397     case Z_APDU_searchRequest:
 398         res = process_searchRequest(assoc, req, &fd); break;
 399     case Z_APDU_presentRequest:
 400         res = process_presentRequest(assoc, req, &fd); break;
 401     case Z_APDU_scanRequest:
 402         if (assoc->init->bend_scan)
 403             res = process_scanRequest(assoc, req, &fd);
 404         else
 405         {
 406             *msg = "Cannot handle Scan APDU";
 407             return -1;
 408         }
 409         break;
 410     case Z_APDU_extendedServicesRequest:
 411         if (assoc->init->bend_esrequest)
 412             res = process_ESRequest(assoc, req, &fd);
 413         else
 414         {
 415             *msg = "Cannot handle Extended Services APDU";
 416             return -1;
 417         }
 418         break;
 419     case Z_APDU_sortRequest:
 420         if (assoc->init->bend_sort)
 421             res = process_sortRequest(assoc, req, &fd);
 422         else
 423         {
 424             *msg = "Cannot handle Sort APDU";
 425             return -1;
 426         }
 427         break;
 428     case Z_APDU_close:
 429         process_close(assoc, req);
 430         return 0;
 431     case Z_APDU_deleteResultSetRequest:
 432         if (assoc->init->bend_delete)
 433             res = process_deleteRequest(assoc, req, &fd);
 434         else
 435         {
 436             *msg = "Cannot handle Delete APDU";
 437             return -1;
 438         }
 439         break;
 440     case Z_APDU_segmentRequest:
 441         if (assoc->init->bend_segment)
 442         {
 443             res = process_segmentRequest (assoc, req);
 444         }
 445         else
 446         {
 447             *msg = "Cannot handle Segment APDU";
 448             return -1;
 449         }
 450         break;
 451     default:
 452         *msg = "Bad APDU received";
 453         return -1;
 454     }
 455     if (res)
 456     {
 457         yaz_log(LOG_DEBUG, "  result immediately available");
 458         retval = process_response(assoc, req, res);
 459     }
 460     else if (fd < 0)
 461     {
 462         yaz_log(LOG_DEBUG, "  result unavailble");
 463         retval = 0;
 464     }
 465     else /* no result yet - one will be provided later */
 466     {
 467         IOCHAN chan;
 468
 469         /* Set up an I/O handler for the fd supplied by the backend */
 470
 471         yaz_log(LOG_DEBUG, "   establishing handler for result");
 472         req->state = REQUEST_PENDING;
 473         if (!(chan = iochan_create(fd, backend_response, EVENT_INPUT)))
 474             abort();
 475         iochan_setdata(chan, assoc);
 476         retval = 0;
 477     }
 478     return retval;
 479 }
 480
 481 /*
 482  * Handle message from the backend.
 483  */
 484 void backend_response(IOCHAN i, int event)
 485 {
 486     association *assoc = (association *)iochan_getdata(i);
 487     request *req = request_head(&assoc->incoming);
 488     Z_APDU *res;
 489     int fd;
 490
 491     yaz_log(LOG_DEBUG, "backend_response");
 492     assert(assoc && req && req->state != REQUEST_IDLE);
 493     /* determine what it is we're waiting for */
 494     switch (req->apdu_request->which)
 495     {
 496         case Z_APDU_searchRequest:
 497             res = response_searchRequest(assoc, req, 0, &fd); break;
 498 #if 0
 499         case Z_APDU_presentRequest:
 500             res = response_presentRequest(assoc, req, 0, &fd); break;
 501         case Z_APDU_scanRequest:
 502             res = response_scanRequest(assoc, req, 0, &fd); break;
 503 #endif
 504         default:
 505             yaz_log(LOG_WARN, "Serious programmer's lapse or bug");
 506             abort();
 507     }
 508     if ((res && process_response(assoc, req, res) < 0) || fd < 0)
 509     {
 510         yaz_log(LOG_LOG, "Fatal error when talking to backend");
 511         do_close(assoc, Z_Close_systemProblem, 0);
 512         iochan_destroy(i);
 513         return;
 514     }
 515     else if (!res) /* no result yet - try again later */
 516     {
 517         yaz_log(LOG_DEBUG, "   no result yet");
 518         iochan_setfd(i, fd); /* in case fd has changed */
 519     }
 520 }
 521
 522 /*
 523  * Encode response, and transfer the request structure to the outgoing queue.
 524  */
 525 static int process_response(association *assoc, request *req, Z_APDU *res)
 526 {
 527     odr_setbuf(assoc->encode, req->response, req->size_response, 1);
 528
 529     if (assoc->print && !z_APDU(assoc->print, &res, 0, 0))
 530     {
 531         yaz_log(LOG_WARN, "ODR print error: %s",
 532             odr_errmsg(odr_geterror(assoc->print)));
 533         odr_reset(assoc->print);
 534     }
 535     if (!z_APDU(assoc->encode, &res, 0, 0))
 536     {
 537         yaz_log(LOG_WARN, "ODR error when encoding response: %s",
 538             odr_errmsg(odr_geterror(assoc->decode)));
 539         return -1;
 540     }
 541     req->response = odr_getbuf(assoc->encode, &req->len_response,
 542         &req->size_response);
 543     odr_setbuf(assoc->encode, 0, 0, 0); /* don'txfree if we abort later */
 544     odr_reset(assoc->encode);
 545     req->state = REQUEST_IDLE;
 546     request_enq(&assoc->outgoing, req);
 547     /* turn the work over to the ir_session handler */
 548     iochan_setflag(assoc->client_chan, EVENT_OUTPUT);
 549     assoc->cs_put_mask = EVENT_OUTPUT;
 550     /* Is there more work to be done? give that to the input handler too */
 551 #if 1
 552     if (request_head(&assoc->incoming))
 553     {
 554         yaz_log (LOG_DEBUG, "more work to be done");
 555         iochan_setevent(assoc->client_chan, EVENT_WORK);
 556     }
 557 #endif
 558     return 0;
 559 }
 560
 561 /*
 562  * Handle init request.
 563  * At the moment, we don't check the options
 564  * anywhere else in the code - we just try not to do anything that would
 565  * break a naive client. We'll toss 'em into the association block when
 566  * we need them there.
 567  */
 568 static Z_APDU *process_initRequest(association *assoc, request *reqb)
 569 {
 570     statserv_options_block *cb = statserv_getcontrol();
 571     Z_InitRequest *req = reqb->apdu_request->u.initRequest;
 572     Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_initResponse);
 573     Z_InitResponse *resp = apdu->u.initResponse;
 574     bend_initresult *binitres;
 575     char options[100];
 576
 577     xfree (assoc->init);
 578     assoc->init = (bend_initrequest *) xmalloc (sizeof(*assoc->init));
 579
 580     yaz_log(LOG_LOG, "Got initRequest");
 581     if (req->implementationId)
 582         yaz_log(LOG_LOG, "Id:        %s", req->implementationId);
 583     if (req->implementationName)
 584         yaz_log(LOG_LOG, "Name:      %s", req->implementationName);
 585     if (req->implementationVersion)
 586         yaz_log(LOG_LOG, "Version:   %s", req->implementationVersion);
 587
 588     assoc->init->stream = assoc->encode;
 589     assoc->init->print = assoc->print;
 590     assoc->init->auth = req->idAuthentication;
 591     assoc->init->referenceId = req->referenceId;
 592     assoc->init->implementation_version = 0;
 593     assoc->init->implementation_name = 0;
 594     assoc->init->bend_sort = NULL;
 595     assoc->init->bend_search = NULL;
 596     assoc->init->bend_present = NULL;
 597     assoc->init->bend_esrequest = NULL;
 598     assoc->init->bend_delete = NULL;
 599     assoc->init->bend_scan = NULL;
 600     assoc->init->bend_segment = NULL;
 601     assoc->init->bend_fetch = NULL;
 602
 603     assoc->init->peer_name =
 604         odr_strdup (assoc->encode, cs_addrstr(assoc->client_link));
 605     if (!(binitres = (*cb->bend_init)(assoc->init)))
 606     {
 607         yaz_log(LOG_WARN, "Bad response from backend.");
 608         return 0;
 609     }
 610
 611     assoc->backend = binitres->handle;
 612     if ((assoc->init->bend_sort))
 613         yaz_log (LOG_DEBUG, "Sort handler installed");
 614     if ((assoc->init->bend_search))
 615         yaz_log (LOG_DEBUG, "Search handler installed");
 616     if ((assoc->init->bend_present))
 617         yaz_log (LOG_DEBUG, "Present handler installed");
 618     if ((assoc->init->bend_esrequest))
 619         yaz_log (LOG_DEBUG, "ESRequest handler installed");
 620     if ((assoc->init->bend_delete))
 621         yaz_log (LOG_DEBUG, "Delete handler installed");
 622     if ((assoc->init->bend_scan))
 623         yaz_log (LOG_DEBUG, "Scan handler installed");
 624     if ((assoc->init->bend_segment))
 625         yaz_log (LOG_DEBUG, "Segment handler installed");
 626
 627     resp->referenceId = req->referenceId;
 628     *options = '\0';
 629     /* let's tell the client what we can do */
 630     if (ODR_MASK_GET(req->options, Z_Options_search))
 631     {
 632         ODR_MASK_SET(resp->options, Z_Options_search);
 633         strcat(options, "srch");
 634     }
 635     if (ODR_MASK_GET(req->options, Z_Options_present))
 636     {
 637         ODR_MASK_SET(resp->options, Z_Options_present);
 638         strcat(options, " prst");
 639     }
 640     if (ODR_MASK_GET(req->options, Z_Options_delSet) &&
 641         assoc->init->bend_delete)
 642     {
 643         ODR_MASK_SET(resp->options, Z_Options_delSet);
 644         strcat(options, " del");
 645     }
 646     if (ODR_MASK_GET(req->options, Z_Options_extendedServices) &&
 647         assoc->init->bend_esrequest)
 648     {
 649         ODR_MASK_SET(resp->options, Z_Options_extendedServices);
 650         strcat (options, " extendedServices");
 651     }
 652     if (ODR_MASK_GET(req->options, Z_Options_namedResultSets))
 653     {
 654         ODR_MASK_SET(resp->options, Z_Options_namedResultSets);
 655         strcat(options, " namedresults");
 656     }
 657     if (ODR_MASK_GET(req->options, Z_Options_scan) && assoc->init->bend_scan)
 658     {
 659         ODR_MASK_SET(resp->options, Z_Options_scan);
 660         strcat(options, " scan");
 661     }
 662     if (ODR_MASK_GET(req->options, Z_Options_concurrentOperations))
 663     {
 664         ODR_MASK_SET(resp->options, Z_Options_concurrentOperations);
 665         strcat(options, " concurop");
 666     }
 667     if (ODR_MASK_GET(req->options, Z_Options_sort) && assoc->init->bend_sort)
 668     {
 669         ODR_MASK_SET(resp->options, Z_Options_sort);
 670         strcat(options, " sort");
 671     }
 672     if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_1))
 673     {
 674         ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_1);
 675         assoc->version = 2; /* 1 & 2 are equivalent */
 676     }
 677     if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_2))
 678     {
 679         ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_2);
 680         assoc->version = 2;
 681     }
 682     if (ODR_MASK_GET(req->protocolVersion, Z_ProtocolVersion_3))
 683     {
 684         ODR_MASK_SET(resp->protocolVersion, Z_ProtocolVersion_3);
 685         assoc->version = 3;
 686     }
 687     yaz_log(LOG_LOG, "Negotiated to v%d: %s", assoc->version, options);
 688     assoc->maximumRecordSize = *req->maximumRecordSize;
 689     if (assoc->maximumRecordSize > control_block->maxrecordsize)
 690         assoc->maximumRecordSize = control_block->maxrecordsize;
 691     assoc->preferredMessageSize = *req->preferredMessageSize;
 692     if (assoc->preferredMessageSize > assoc->maximumRecordSize)
 693         assoc->preferredMessageSize = assoc->maximumRecordSize;
 694
 695 #if 0
 696     assoc->maximumRecordSize = 3000000;
 697     assoc->preferredMessageSize = 3000000;
 698 #endif
 699
 700     resp->preferredMessageSize = &assoc->preferredMessageSize;
 701     resp->maximumRecordSize = &assoc->maximumRecordSize;
 702
 703     resp->implementationName = "GFS/YAZ";
 704
 705     if (assoc->init->implementation_name)
 706     {
 707         char *nv = (char *)
 708             odr_malloc (assoc->encode,
 709                         strlen(assoc->init->implementation_name) + 10 +
 710                                strlen(resp->implementationName));
 711         sprintf (nv, "%s / %s",
 712                  resp->implementationName, assoc->init->implementation_name);
 713         resp->implementationName = nv;
 714     }
 715     if (assoc->init->implementation_version)
 716     {
 717         char *nv = (char *)
 718             odr_malloc (assoc->encode,
 719                         strlen(assoc->init->implementation_version) + 10 +
 720                                strlen(resp->implementationVersion));
 721         sprintf (nv, "YAZ %s / %s",
 722                  resp->implementationVersion,
 723                  assoc->init->implementation_version);
 724         resp->implementationVersion = nv;
 725     }
 726
 727     if (binitres->errcode)
 728     {
 729         yaz_log(LOG_LOG, "Connection rejected by backend.");
 730         *resp->result = 0;
 731         assoc->state = ASSOC_DEAD;
 732     }
 733     else
 734         assoc->state = ASSOC_UP;
 735     return apdu;
 736 }
 737
 738 /*
 739  * These functions should be merged.
 740  */
 741
 742 static void set_addinfo (Z_DefaultDiagFormat *dr, char *addinfo, ODR odr)
 743 {
 744     dr->which = Z_DefaultDiagFormat_v2Addinfo;
 745     dr->u.v2Addinfo = odr_strdup (odr, addinfo ? addinfo : "");
 746 }
 747
 748 /*
 749  * nonsurrogate diagnostic record.
 750  */
 751 static Z_Records *diagrec(association *assoc, int error, char *addinfo)
 752 {
 753     Z_Records *rec = (Z_Records *)
 754         odr_malloc (assoc->encode, sizeof(*rec));
 755     int *err = odr_intdup(assoc->encode, error);
 756     Z_DiagRec *drec = (Z_DiagRec *)
 757         odr_malloc (assoc->encode, sizeof(*drec));
 758     Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
 759         odr_malloc (assoc->encode, sizeof(*dr));
 760
 761     yaz_log(LOG_DEBUG, "Diagnostic: %d -- %s", error, addinfo ? addinfo :
 762         "NULL");
 763     rec->which = Z_Records_NSD;
 764     rec->u.nonSurrogateDiagnostic = dr;
 765     dr->diagnosticSetId =
 766         yaz_oidval_to_z3950oid (assoc->encode, CLASS_DIAGSET, VAL_BIB1);
 767     dr->condition = err;
 768     set_addinfo (dr, addinfo, assoc->encode);
 769     return rec;
 770 }
 771
 772 /*
 773  * surrogate diagnostic.
 774  */
 775 static Z_NamePlusRecord *surrogatediagrec(association *assoc, char *dbname,
 776                                           int error, char *addinfo)
 777 {
 778     Z_NamePlusRecord *rec = (Z_NamePlusRecord *)
 779         odr_malloc (assoc->encode, sizeof(*rec));
 780     int *err = odr_intdup(assoc->encode, error);
 781     Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
 782     Z_DefaultDiagFormat *dr = (Z_DefaultDiagFormat *)
 783         odr_malloc (assoc->encode, sizeof(*dr));
 784
 785     yaz_log(LOG_DEBUG, "SurrogateDiagnotic: %d -- %s", error, addinfo);
 786     rec->databaseName = dbname;
 787     rec->which = Z_NamePlusRecord_surrogateDiagnostic;
 788     rec->u.surrogateDiagnostic = drec;
 789     drec->which = Z_DiagRec_defaultFormat;
 790     drec->u.defaultFormat = dr;
 791     dr->diagnosticSetId =
 792         yaz_oidval_to_z3950oid (assoc->encode, CLASS_DIAGSET, VAL_BIB1);
 793     dr->condition = err;
 794     set_addinfo (dr, addinfo, assoc->encode);
 795
 796     return rec;
 797 }
 798
 799 /*
 800  * multiple nonsurrogate diagnostics.
 801  */
 802 static Z_DiagRecs *diagrecs(association *assoc, int error, char *addinfo)
 803 {
 804     Z_DiagRecs *recs = (Z_DiagRecs *)odr_malloc (assoc->encode, sizeof(*recs));
 805     int *err = odr_intdup(assoc->encode, error);
 806     Z_DiagRec **recp = (Z_DiagRec **)odr_malloc (assoc->encode, sizeof(*recp));
 807     Z_DiagRec *drec = (Z_DiagRec *)odr_malloc (assoc->encode, sizeof(*drec));
 808     Z_DefaultDiagFormat *rec = (Z_DefaultDiagFormat *)
 809         odr_malloc (assoc->encode, sizeof(*rec));
 810
 811     yaz_log(LOG_DEBUG, "DiagRecs: %d -- %s", error, addinfo ? addinfo : "");
 812
 813     recs->num_diagRecs = 1;
 814     recs->diagRecs = recp;
 815     recp[0] = drec;
 816     drec->which = Z_DiagRec_defaultFormat;
 817     drec->u.defaultFormat = rec;
 818
 819     rec->diagnosticSetId =
 820         yaz_oidval_to_z3950oid (assoc->encode, CLASS_DIAGSET, VAL_BIB1);
 821     rec->condition = err;
 822
 823     rec->which = Z_DefaultDiagFormat_v2Addinfo;
 824     rec->u.v2Addinfo = odr_strdup (assoc->encode, addinfo ? addinfo : "");
 825     return recs;
 826 }
 827
 828 static Z_Records *pack_records(association *a, char *setname, int start,
 829                                int *num, Z_RecordComposition *comp,
 830                                int *next, int *pres, oid_value format,
 831                                Z_ReferenceId *referenceId,
 832                                int *oid)
 833 {
 834     int recno, total_length = 0, toget = *num, dumped_records = 0;
 835     Z_Records *records =
 836         (Z_Records *) odr_malloc (a->encode, sizeof(*records));
 837     Z_NamePlusRecordList *reclist =
 838         (Z_NamePlusRecordList *) odr_malloc (a->encode, sizeof(*reclist));
 839     Z_NamePlusRecord **list =
 840         (Z_NamePlusRecord **) odr_malloc (a->encode, sizeof(*list) * toget);
 841
 842     records->which = Z_Records_DBOSD;
 843     records->u.databaseOrSurDiagnostics = reclist;
 844     reclist->num_records = 0;
 845     reclist->records = list;
 846     *pres = Z_PRES_SUCCESS;
 847     *num = 0;
 848     *next = 0;
 849
 850     yaz_log(LOG_LOG, "Request to pack %d+%d", start, toget);
 851     yaz_log(LOG_DEBUG, "pms=%d, mrs=%d", a->preferredMessageSize,
 852         a->maximumRecordSize);
 853     for (recno = start; reclist->num_records < toget; recno++)
 854     {
 855         bend_fetch_rr freq;
 856         Z_NamePlusRecord *thisrec;
 857         int this_length = 0;
 858         /*
 859          * we get the number of bytes allocated on the stream before any
 860          * allocation done by the backend - this should give us a reasonable
 861          * idea of the total size of the data so far.
 862          */
 863         total_length = odr_total(a->encode) - dumped_records;
 864         freq.errcode = 0;
 865         freq.errstring = 0;
 866         freq.basename = 0;
 867         freq.len = 0;
 868         freq.record = 0;
 869         freq.last_in_set = 0;
 870         freq.setname = setname;
 871         freq.surrogate_flag = 0;
 872         freq.number = recno;
 873         freq.comp = comp;
 874         freq.request_format = format;
 875         freq.request_format_raw = oid;
 876         freq.output_format = format;
 877         freq.output_format_raw = 0;
 878         freq.stream = a->encode;
 879         freq.print = a->print;
 880         freq.surrogate_flag = 0;
 881         freq.referenceId = referenceId;
 882         (*a->init->bend_fetch)(a->backend, &freq);
 883         /* backend should be able to signal whether error is system-wide
 884            or only pertaining to current record */
 885         if (freq.errcode)
 886         {
 887             if (!freq.surrogate_flag)
 888             {
 889                 *pres = Z_PRES_FAILURE;
 890                 return diagrec(a, freq.errcode, freq.errstring);
 891             }
 892             reclist->records[reclist->num_records] =
 893                 surrogatediagrec(a, freq.basename, freq.errcode,
 894                                  freq.errstring);
 895             reclist->num_records++;
 896             *next = freq.last_in_set ? 0 : recno + 1;
 897             continue;
 898         }
 899         if (freq.len >= 0)
 900             this_length = freq.len;
 901         else
 902             this_length = odr_total(a->encode) - total_length;
 903         yaz_log(LOG_DEBUG, "  fetched record, len=%d, total=%d",
 904             this_length, total_length);
 905         if (this_length + total_length > a->preferredMessageSize)
 906         {
 907             /* record is small enough, really */
 908             if (this_length <= a->preferredMessageSize)
 909             {
 910                 yaz_log(LOG_DEBUG, "  Dropped last normal-sized record");
 911                 *pres = Z_PRES_PARTIAL_2;
 912                 break;
 913             }
 914             /* record can only be fetched by itself */
 915             if (this_length < a->maximumRecordSize)
 916             {
 917                 yaz_log(LOG_DEBUG, "  Record > prefmsgsz");
 918                 if (toget > 1)
 919                 {
 920                     yaz_log(LOG_DEBUG, "  Dropped it");
 921                     reclist->records[reclist->num_records] =
 922                          surrogatediagrec(a, freq.basename, 16, 0);
 923                     reclist->num_records++;
 924                     *next = freq.last_in_set ? 0 : recno + 1;
 925                     dumped_records += this_length;
 926                     continue;
 927                 }
 928             }
 929             else /* too big entirely */
 930             {
 931                 yaz_log(LOG_DEBUG, "Record > maxrcdsz");
 932                 reclist->records[reclist->num_records] =
 933                     surrogatediagrec(a, freq.basename, 17, 0);
 934                 reclist->num_records++;
 935                 *next = freq.last_in_set ? 0 : recno + 1;
 936                 dumped_records += this_length;
 937                 continue;
 938             }
 939         }
 940
 941         if (!(thisrec = (Z_NamePlusRecord *)
 942               odr_malloc(a->encode, sizeof(*thisrec))))
 943             return 0;
 944         if (!(thisrec->databaseName = (char *)odr_malloc(a->encode,
 945             strlen(freq.basename) + 1)))
 946             return 0;
 947         strcpy(thisrec->databaseName, freq.basename);
 948         thisrec->which = Z_NamePlusRecord_databaseRecord;
 949
 950         if (freq.output_format_raw)
 951         {
 952             struct oident *ident = oid_getentbyoid(freq.output_format_raw);
 953             freq.output_format = ident->value;
 954         }
 955         thisrec->u.databaseRecord = z_ext_record(a->encode, freq.output_format,
 956                                                  freq.record, freq.len);
 957         if (!thisrec->u.databaseRecord)
 958             return 0;
 959         reclist->records[reclist->num_records] = thisrec;
 960         reclist->num_records++;
 961         *next = freq.last_in_set ? 0 : recno + 1;
 962     }
 963     *num = reclist->num_records;
 964     return records;
 965 }
 966
 967 static Z_APDU *process_searchRequest(association *assoc, request *reqb,
 968     int *fd)
 969 {
 970     Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
 971     bend_search_rr *bsrr =
 972         (bend_search_rr *)nmem_malloc (reqb->request_mem, sizeof(*bsrr));
 973
 974     yaz_log(LOG_LOG, "Got SearchRequest.");
 975     bsrr->fd = fd;
 976     bsrr->request = reqb;
 977     bsrr->association = assoc;
 978     bsrr->referenceId = req->referenceId;
 979     save_referenceId (reqb, bsrr->referenceId);
 980
 981     yaz_log (LOG_LOG, "ResultSet '%s'", req->resultSetName);
 982     if (req->databaseNames)
 983     {
 984         int i;
 985         for (i = 0; i < req->num_databaseNames; i++)
 986             yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
 987     }
 988     switch (req->query->which)
 989     {
 990     case Z_Query_type_1: case Z_Query_type_101:
 991         log_rpn_query (req->query->u.type_1);
 992     }
 993     if (assoc->init->bend_search)
 994     {
 995         bsrr->setname = req->resultSetName;
 996         bsrr->replace_set = *req->replaceIndicator;
 997         bsrr->num_bases = req->num_databaseNames;
 998         bsrr->basenames = req->databaseNames;
 999         bsrr->query = req->query;
1000         bsrr->stream = assoc->encode;
1001         bsrr->decode = assoc->decode;
1002         bsrr->print = assoc->print;
1003         bsrr->errcode = 0;
1004         bsrr->hits = 0;
1005         bsrr->errstring = NULL;
1006         (assoc->init->bend_search)(assoc->backend, bsrr);
1007         if (!bsrr->request)
1008             return 0;
1009     }
1010 #if 0
1011     else
1012     {
1013         bend_searchrequest bsrq;
1014         bend_searchresult *bsrt;
1015
1016         bsrq.setname = req->resultSetName;
1017         bsrq.replace_set = *req->replaceIndicator;
1018         bsrq.num_bases = req->num_databaseNames;
1019         bsrq.basenames = req->databaseNames;
1020         bsrq.query = req->query;
1021         bsrq.referenceId = req->referenceId;
1022         bsrq.stream = assoc->encode;
1023         bsrq.decode = assoc->decode;
1024         bsrq.print = assoc->print;
1025         if (!(bsrt = bend_search (assoc->backend, &bsrq, fd)))
1026             return 0;
1027         bsrr->hits = bsrt->hits;
1028         bsrr->errcode = bsrt->errcode;
1029         bsrr->errstring = bsrt->errstring;
1030     }
1031 #endif
1032     return response_searchRequest(assoc, reqb, bsrr, fd);
1033 }
1034
1035 int bend_searchresponse(void *handle, bend_search_rr *bsrr) {return 0;}
1036
1037 /*
1038  * Prepare a searchresponse based on the backend results. We probably want
1039  * to look at making the fetching of records nonblocking as well, but
1040  * so far, we'll keep things simple.
1041  * If bsrt is null, that means we're called in response to a communications
1042  * event, and we'll have to get the response for ourselves.
1043  */
1044 static Z_APDU *response_searchRequest(association *assoc, request *reqb,
1045     bend_search_rr *bsrt, int *fd)
1046 {
1047     Z_SearchRequest *req = reqb->apdu_request->u.searchRequest;
1048     Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1049     Z_SearchResponse *resp = (Z_SearchResponse *)
1050         odr_malloc (assoc->encode, sizeof(*resp));
1051     int *nulint = odr_intdup (assoc->encode, 0);
1052     bool_t *sr = odr_intdup(assoc->encode, 1);
1053     int *next = odr_intdup(assoc->encode, 0);
1054     int *none = odr_intdup(assoc->encode, Z_RES_NONE);
1055
1056     apdu->which = Z_APDU_searchResponse;
1057     apdu->u.searchResponse = resp;
1058     resp->referenceId = req->referenceId;
1059     resp->additionalSearchInfo = 0;
1060     resp->otherInfo = 0;
1061     *fd = -1;
1062     if (!bsrt && !bend_searchresponse(assoc->backend, bsrt))
1063     {
1064         yaz_log(LOG_FATAL, "Bad result from backend");
1065         return 0;
1066     }
1067     else if (bsrt->errcode)
1068     {
1069         resp->records = diagrec(assoc, bsrt->errcode, bsrt->errstring);
1070         resp->resultCount = nulint;
1071         resp->numberOfRecordsReturned = nulint;
1072         resp->nextResultSetPosition = nulint;
1073         resp->searchStatus = nulint;
1074         resp->resultSetStatus = none;
1075         resp->presentStatus = 0;
1076     }
1077     else
1078     {
1079         int *toget = odr_intdup(assoc->encode, 0);
1080         int *presst = odr_intdup(assoc->encode, 0);
1081         Z_RecordComposition comp, *compp = 0;
1082
1083         resp->records = 0;
1084         resp->resultCount = &bsrt->hits;
1085
1086         comp.which = Z_RecordComp_simple;
1087         /* how many records does the user agent want, then? */
1088         if (bsrt->hits <= *req->smallSetUpperBound)
1089         {
1090             *toget = bsrt->hits;
1091             if ((comp.u.simple = req->smallSetElementSetNames))
1092                 compp = &comp;
1093         }
1094         else if (bsrt->hits < *req->largeSetLowerBound)
1095         {
1096             *toget = *req->mediumSetPresentNumber;
1097             if (*toget > bsrt->hits)
1098                 *toget = bsrt->hits;
1099             if ((comp.u.simple = req->mediumSetElementSetNames))
1100                 compp = &comp;
1101         }
1102         else
1103             *toget = 0;
1104
1105         if (*toget && !resp->records)
1106         {
1107             oident *prefformat;
1108             oid_value form;
1109
1110             if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
1111                 form = VAL_NONE;
1112             else
1113                 form = prefformat->value;
1114             resp->records = pack_records(assoc, req->resultSetName, 1,
1115                 toget, compp, next, presst, form, req->referenceId,
1116                                          req->preferredRecordSyntax);
1117             if (!resp->records)
1118                 return 0;
1119             resp->numberOfRecordsReturned = toget;
1120             resp->nextResultSetPosition = next;
1121             resp->searchStatus = sr;
1122             resp->resultSetStatus = 0;
1123             resp->presentStatus = presst;
1124         }
1125         else
1126         {
1127             if (*resp->resultCount)
1128                 *next = 1;
1129             resp->numberOfRecordsReturned = nulint;
1130             resp->nextResultSetPosition = next;
1131             resp->searchStatus = sr;
1132             resp->resultSetStatus = 0;
1133             resp->presentStatus = 0;
1134         }
1135     }
1136     return apdu;
1137 }
1138
1139 /*
1140  * Maybe we got a little over-friendly when we designed bend_fetch to
1141  * get only one record at a time. Some backends can optimise multiple-record
1142  * fetches, and at any rate, there is some overhead involved in
1143  * all that selecting and hopping around. Problem is, of course, that the
1144  * frontend can't know ahead of time how many records it'll need to
1145  * fill the negotiated PDU size. Annoying. Segmentation or not, Z/SR
1146  * is downright lousy as a bulk data transfer protocol.
1147  *
1148  * To start with, we'll do the fetching of records from the backend
1149  * in one operation: To save some trips in and out of the event-handler,
1150  * and to simplify the interface to pack_records. At any rate, asynch
1151  * operation is more fun in operations that have an unpredictable execution
1152  * speed - which is normally more true for search than for present.
1153  */
1154 static Z_APDU *process_presentRequest(association *assoc, request *reqb,
1155                                       int *fd)
1156 {
1157     Z_PresentRequest *req = reqb->apdu_request->u.presentRequest;
1158     oident *prefformat;
1159     oid_value form;
1160     Z_APDU *apdu;
1161     Z_PresentResponse *resp;
1162     int *next;
1163     int *num;
1164
1165     yaz_log(LOG_LOG, "Got PresentRequest.");
1166
1167     if (!(prefformat = oid_getentbyoid(req->preferredRecordSyntax)))
1168         form = VAL_NONE;
1169     else
1170         form = prefformat->value;
1171     resp = (Z_PresentResponse *)odr_malloc (assoc->encode, sizeof(*resp));
1172     resp->records = 0;
1173     resp->presentStatus = odr_intdup(assoc->encode, 0);
1174     if (assoc->init->bend_present)
1175     {
1176         bend_present_rr *bprr = (bend_present_rr *)
1177             nmem_malloc (reqb->request_mem, sizeof(*bprr));
1178         bprr->setname = req->resultSetId;
1179         bprr->start = *req->resultSetStartPoint;
1180         bprr->number = *req->numberOfRecordsRequested;
1181         bprr->format = form;
1182         bprr->comp = req->recordComposition;
1183         bprr->referenceId = req->referenceId;
1184         bprr->stream = assoc->encode;
1185         bprr->print = assoc->print;
1186         bprr->request = reqb;
1187         bprr->association = assoc;
1188         bprr->errcode = 0;
1189         bprr->errstring = NULL;
1190         (*assoc->init->bend_present)(assoc->backend, bprr);
1191
1192         if (!bprr->request)
1193             return 0;
1194         if (bprr->errcode)
1195         {
1196             resp->records = diagrec(assoc, bprr->errcode, bprr->errstring);
1197             *resp->presentStatus = Z_PRES_FAILURE;
1198         }
1199     }
1200     apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1201     next = odr_intdup(assoc->encode, 0);
1202     num = odr_intdup(assoc->encode, 0);
1203
1204     apdu->which = Z_APDU_presentResponse;
1205     apdu->u.presentResponse = resp;
1206     resp->referenceId = req->referenceId;
1207     resp->otherInfo = 0;
1208
1209     if (!resp->records)
1210     {
1211         *num = *req->numberOfRecordsRequested;
1212         resp->records =
1213             pack_records(assoc, req->resultSetId, *req->resultSetStartPoint,
1214                      num, req->recordComposition, next, resp->presentStatus,
1215                          form, req->referenceId, req->preferredRecordSyntax);
1216     }
1217     if (!resp->records)
1218         return 0;
1219     resp->numberOfRecordsReturned = num;
1220     resp->nextResultSetPosition = next;
1221
1222     return apdu;
1223 }
1224
1225 /*
1226  * Scan was implemented rather in a hurry, and with support for only the basic
1227  * elements of the service in the backend API. Suggestions are welcome.
1228  */
1229 static Z_APDU *process_scanRequest(association *assoc, request *reqb, int *fd)
1230 {
1231     Z_ScanRequest *req = reqb->apdu_request->u.scanRequest;
1232     Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1233     Z_ScanResponse *res = (Z_ScanResponse *)
1234         odr_malloc (assoc->encode, sizeof(*res));
1235     int *scanStatus = odr_intdup(assoc->encode, Z_Scan_failure);
1236     int *numberOfEntriesReturned = odr_intdup(assoc->encode, 0);
1237     Z_ListEntries *ents = (Z_ListEntries *)
1238         odr_malloc (assoc->encode, sizeof(*ents));
1239     Z_DiagRecs *diagrecs_p = NULL;
1240     oident *attent;
1241     oident *attset;
1242
1243     yaz_log(LOG_LOG, "Got ScanRequest");
1244
1245     apdu->which = Z_APDU_scanResponse;
1246     apdu->u.scanResponse = res;
1247     res->referenceId = req->referenceId;
1248     res->stepSize = odr_intdup(assoc->encode, 0);
1249
1250     if (req->stepSize)
1251         *res->stepSize = *req->stepSize;
1252     res->scanStatus = scanStatus;
1253     res->numberOfEntriesReturned = numberOfEntriesReturned;
1254     res->positionOfTerm = 0;
1255     res->entries = ents;
1256     ents->num_entries = 0;
1257     ents->entries = NULL;
1258     ents->num_nonsurrogateDiagnostics = 0;
1259     ents->nonsurrogateDiagnostics = NULL;
1260     res->attributeSet = 0;
1261     res->otherInfo = 0;
1262
1263     if (req->attributeSet && (!(attent = oid_getentbyoid(req->attributeSet)) ||
1264                               attent->oclass != CLASS_ATTSET
1265                               || attent->value != VAL_BIB1))
1266         diagrecs_p = diagrecs(assoc, 121, 0);
1267     else if (req->stepSize && *req->stepSize > 0)
1268         diagrecs_p = diagrecs(assoc, 205, 0);
1269     else
1270     {
1271         bend_scan_rr *bsrr = (bend_scan_rr *)
1272             odr_malloc (assoc->encode, sizeof(*bsrr));
1273         if (req->databaseNames)
1274         {
1275             int i;
1276             for (i = 0; i < req->num_databaseNames; i++)
1277                 yaz_log (LOG_LOG, "Database '%s'", req->databaseNames[i]);
1278         }
1279         bsrr->num_bases = req->num_databaseNames;
1280         bsrr->basenames = req->databaseNames;
1281         bsrr->num_entries = *req->numberOfTermsRequested;
1282         bsrr->term = req->termListAndStartPoint;
1283         bsrr->referenceId = req->referenceId;
1284         bsrr->stream = assoc->encode;
1285         bsrr->print = assoc->print;
1286         bsrr->step_size = res->stepSize;
1287         if (!(attset = oid_getentbyoid(req->attributeSet)) ||
1288             attset->oclass != CLASS_RECSYN)
1289             bsrr->attributeset = VAL_NONE;
1290         else
1291             bsrr->attributeset = attset->value;
1292         log_scan_term (req->termListAndStartPoint, bsrr->attributeset);
1293         bsrr->term_position = req->preferredPositionInResponse ?
1294             *req->preferredPositionInResponse : 1;
1295         ((int (*)(void *, bend_scan_rr *))
1296          (*assoc->init->bend_scan))(assoc->backend, bsrr);
1297         if (bsrr->errcode)
1298             diagrecs_p = diagrecs(assoc, bsrr->errcode, bsrr->errstring);
1299         else
1300         {
1301             int i;
1302             Z_Entry **tab = (Z_Entry **)
1303                 odr_malloc (assoc->encode, sizeof(*tab) * bsrr->num_entries);
1304
1305             if (bsrr->status == BEND_SCAN_PARTIAL)
1306                 *scanStatus = Z_Scan_partial_5;
1307             else
1308                 *scanStatus = Z_Scan_success;
1309             ents->entries = tab;
1310             ents->num_entries = bsrr->num_entries;
1311             res->numberOfEntriesReturned = &ents->num_entries;
1312             res->positionOfTerm = &bsrr->term_position;
1313             for (i = 0; i < bsrr->num_entries; i++)
1314             {
1315                 Z_Entry *e;
1316                 Z_TermInfo *t;
1317                 Odr_oct *o;
1318
1319                 tab[i] = e = (Z_Entry *)odr_malloc(assoc->encode, sizeof(*e));
1320                 if (bsrr->entries[i].occurrences >= 0)
1321                 {
1322                     e->which = Z_Entry_termInfo;
1323                     e->u.termInfo = t = (Z_TermInfo *)
1324                         odr_malloc(assoc->encode, sizeof(*t));
1325                     t->suggestedAttributes = 0;
1326                     t->displayTerm = 0;
1327                     t->alternativeTerm = 0;
1328                     t->byAttributes = 0;
1329                     t->otherTermInfo = 0;
1330                     t->globalOccurrences = &bsrr->entries[i].occurrences;
1331                     t->term = (Z_Term *)
1332                         odr_malloc(assoc->encode, sizeof(*t->term));
1333                     t->term->which = Z_Term_general;
1334                     t->term->u.general = o =
1335                         (Odr_oct *)odr_malloc(assoc->encode, sizeof(Odr_oct));
1336                     o->buf = (unsigned char *)
1337                         odr_malloc(assoc->encode, o->len = o->size =
1338                                    strlen(bsrr->entries[i].term));
1339                     memcpy(o->buf, bsrr->entries[i].term, o->len);
1340                     yaz_log(LOG_DEBUG, "  term #%d: '%s' (%d)", i,
1341                          bsrr->entries[i].term, bsrr->entries[i].occurrences);
1342                 }
1343                 else
1344                 {
1345                     Z_DiagRecs *drecs = diagrecs (assoc,
1346                                                   bsrr->entries[i].errcode,
1347                                                   bsrr->entries[i].errstring);
1348                     assert (drecs->num_diagRecs == 1);
1349                     e->which = Z_Entry_surrogateDiagnostic;
1350                     assert (drecs->diagRecs[0]);
1351                     e->u.surrogateDiagnostic = drecs->diagRecs[0];
1352                 }
1353             }
1354         }
1355     }
1356     if (diagrecs_p)
1357     {
1358         ents->num_nonsurrogateDiagnostics = diagrecs_p->num_diagRecs;
1359         ents->nonsurrogateDiagnostics = diagrecs_p->diagRecs;
1360     }
1361     return apdu;
1362 }
1363
1364 static Z_APDU *process_sortRequest(association *assoc, request *reqb,
1365     int *fd)
1366 {
1367     Z_SortRequest *req = reqb->apdu_request->u.sortRequest;
1368     Z_SortResponse *res = (Z_SortResponse *)
1369         odr_malloc (assoc->encode, sizeof(*res));
1370     bend_sort_rr *bsrr = (bend_sort_rr *)
1371         odr_malloc (assoc->encode, sizeof(*bsrr));
1372
1373     Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1374
1375     yaz_log(LOG_LOG, "Got SortRequest.");
1376
1377     bsrr->num_input_setnames = req->num_inputResultSetNames;
1378     bsrr->input_setnames = req->inputResultSetNames;
1379     bsrr->referenceId = req->referenceId;
1380     bsrr->output_setname = req->sortedResultSetName;
1381     bsrr->sort_sequence = req->sortSequence;
1382     bsrr->stream = assoc->encode;
1383     bsrr->print = assoc->print;
1384
1385     bsrr->sort_status = Z_SortStatus_failure;
1386     bsrr->errcode = 0;
1387     bsrr->errstring = 0;
1388
1389     (*assoc->init->bend_sort)(assoc->backend, bsrr);
1390
1391     res->referenceId = bsrr->referenceId;
1392     res->sortStatus = odr_intdup(assoc->encode, bsrr->sort_status);
1393     res->resultSetStatus = 0;
1394     if (bsrr->errcode)
1395     {
1396         Z_DiagRecs *dr = diagrecs (assoc, bsrr->errcode, bsrr->errstring);
1397         res->diagnostics = dr->diagRecs;
1398         res->num_diagnostics = dr->num_diagRecs;
1399     }
1400     else
1401     {
1402         res->num_diagnostics = 0;
1403         res->diagnostics = 0;
1404     }
1405     res->otherInfo = 0;
1406
1407     apdu->which = Z_APDU_sortResponse;
1408     apdu->u.sortResponse = res;
1409     return apdu;
1410 }
1411
1412 static Z_APDU *process_deleteRequest(association *assoc, request *reqb,
1413     int *fd)
1414 {
1415     Z_DeleteResultSetRequest *req =
1416         reqb->apdu_request->u.deleteResultSetRequest;
1417     Z_DeleteResultSetResponse *res = (Z_DeleteResultSetResponse *)
1418         odr_malloc (assoc->encode, sizeof(*res));
1419     bend_delete_rr *bdrr = (bend_delete_rr *)
1420         odr_malloc (assoc->encode, sizeof(*bdrr));
1421     Z_APDU *apdu = (Z_APDU *)odr_malloc (assoc->encode, sizeof(*apdu));
1422
1423     yaz_log(LOG_LOG, "Got DeleteRequest.");
1424
1425     bdrr->num_setnames = req->num_resultSetList;
1426     bdrr->setnames = req->resultSetList;
1427     bdrr->stream = assoc->encode;
1428     bdrr->print = assoc->print;
1429     bdrr->function = *req->deleteFunction;
1430     bdrr->referenceId = req->referenceId;
1431     bdrr->statuses = 0;
1432     if (bdrr->num_setnames > 0)
1433     {
1434         int i;
1435         bdrr->statuses = (int*)
1436             odr_malloc(assoc->encode, sizeof(*bdrr->statuses) *
1437                        bdrr->num_setnames);
1438         for (i = 0; i < bdrr->num_setnames; i++)
1439             bdrr->statuses[i] = 0;
1440     }
1441     (*assoc->init->bend_delete)(assoc->backend, bdrr);
1442
1443     res->referenceId = req->referenceId;
1444
1445     res->deleteOperationStatus = odr_intdup(assoc->encode,bdrr->delete_status);
1446
1447     res->deleteListStatuses = 0;
1448     if (bdrr->num_setnames > 0)
1449     {
1450         int i;
1451         res->deleteListStatuses = (Z_ListStatuses *)
1452             odr_malloc(assoc->encode, sizeof(*res->deleteListStatuses));
1453         res->deleteListStatuses->num = bdrr->num_setnames;
1454         res->deleteListStatuses->elements =
1455             (Z_ListStatus **)
1456             odr_malloc (assoc->encode,
1457                         sizeof(*res->deleteListStatuses->elements) *
1458                         bdrr->num_setnames);
1459         for (i = 0; i<bdrr->num_setnames; i++)
1460         {
1461             res->deleteListStatuses->elements[i] =
1462                 (Z_ListStatus *)
1463                 odr_malloc (assoc->encode,
1464                             sizeof(**res->deleteListStatuses->elements));
1465             res->deleteListStatuses->elements[i]->status = bdrr->statuses+i;
1466             res->deleteListStatuses->elements[i]->id =
1467                 odr_strdup (assoc->encode, bdrr->setnames[i]);
1468
1469         }
1470     }
1471     res->numberNotDeleted = 0;
1472     res->bulkStatuses = 0;
1473     res->deleteMessage = 0;
1474     res->otherInfo = 0;
1475
1476     apdu->which = Z_APDU_deleteResultSetResponse;
1477     apdu->u.deleteResultSetResponse = res;
1478     return apdu;
1479 }
1480
1481 static void process_close(association *assoc, request *reqb)
1482 {
1483     Z_Close *req = reqb->apdu_request->u.close;
1484     static char *reasons[] =
1485     {
1486         "finished",
1487         "shutdown",
1488         "systemProblem",
1489         "costLimit",
1490         "resources",
1491         "securityViolation",
1492         "protocolError",
1493         "lackOfActivity",
1494         "peerAbort",
1495         "unspecified"
1496     };
1497
1498     yaz_log(LOG_LOG, "Got Close, reason %s, message %s",
1499         reasons[*req->closeReason], req->diagnosticInformation ?
1500         req->diagnosticInformation : "NULL");
1501     if (assoc->version < 3) /* to make do_force respond with close */
1502         assoc->version = 3;
1503     do_close_req(assoc, Z_Close_finished,
1504                  "Association terminated by client", reqb);
1505 }
1506
1507 void save_referenceId (request *reqb, Z_ReferenceId *refid)
1508 {
1509     if (refid)
1510     {
1511         reqb->len_refid = refid->len;
1512         reqb->refid = (char *)nmem_malloc (reqb->request_mem, refid->len);
1513         memcpy (reqb->refid, refid->buf, refid->len);
1514     }
1515     else
1516     {
1517         reqb->len_refid = 0;
1518         reqb->refid = NULL;
1519     }
1520 }
1521
1522 void bend_request_send (bend_association a, bend_request req, Z_APDU *res)
1523 {
1524     process_response (a, req, res);
1525 }
1526
1527 bend_request bend_request_mk (bend_association a)
1528 {
1529     request *nreq = request_get (&a->outgoing);
1530     nreq->request_mem = nmem_create ();
1531     return nreq;
1532 }
1533
1534 Z_ReferenceId *bend_request_getid (ODR odr, bend_request req)
1535 {
1536     Z_ReferenceId *id;
1537     if (!req->refid)
1538         return 0;
1539     id = (Odr_oct *)odr_malloc (odr, sizeof(*odr));
1540     id->buf = (unsigned char *)odr_malloc (odr, req->len_refid);
1541     id->len = id->size = req->len_refid;
1542     memcpy (id->buf, req->refid, req->len_refid);
1543     return id;
1544 }
1545
1546 void bend_request_destroy (bend_request *req)
1547 {
1548     nmem_destroy((*req)->request_mem);
1549     request_release(*req);
1550     *req = NULL;
1551 }
1552
1553 int bend_backend_respond (bend_association a, bend_request req)
1554 {
1555     char *msg;
1556     int r;
1557     r = process_request (a, req, &msg);
1558     if (r < 0)
1559         logf (LOG_WARN, "%s", msg);
1560     return r;
1561 }
1562
1563 void bend_request_setdata(bend_request r, void *p)
1564 {
1565     r->clientData = p;
1566 }
1567
1568 void *bend_request_getdata(bend_request r)
1569 {
1570     return r->clientData;
1571 }
1572
1573 static Z_APDU *process_segmentRequest (association *assoc, request *reqb)
1574 {
1575     bend_segment_rr request;
1576
1577     request.segment = reqb->apdu_request->u.segmentRequest;
1578     request.stream = assoc->encode;
1579     request.decode = assoc->decode;
1580     request.print = assoc->print;
1581     request.association = assoc;
1582
1583     (*assoc->init->bend_segment)(assoc->backend, &request);
1584
1585     return 0;
1586 }
1587
1588 static Z_APDU *process_ESRequest(association *assoc, request *reqb, int *fd)
1589 {
1590     bend_esrequest_rr esrequest;
1591
1592     Z_ExtendedServicesRequest *req = reqb->apdu_request->u.extendedServicesRequest;
1593     Z_APDU *apdu = zget_APDU(assoc->encode, Z_APDU_extendedServicesResponse);
1594
1595     Z_ExtendedServicesResponse *resp = apdu->u.extendedServicesResponse;
1596
1597     yaz_log(LOG_DEBUG,"inside Process esRequest");
1598
1599     esrequest.esr = reqb->apdu_request->u.extendedServicesRequest;
1600     esrequest.stream = assoc->encode;
1601     esrequest.decode = assoc->decode;
1602     esrequest.print = assoc->print;
1603     esrequest.errcode = 0;
1604     esrequest.errstring = NULL;
1605     esrequest.request = reqb;
1606     esrequest.association = assoc;
1607     esrequest.taskPackage = 0;
1608     esrequest.referenceId = req->referenceId;
1609
1610     (*assoc->init->bend_esrequest)(assoc->backend, &esrequest);
1611
1612     /* If the response is being delayed, return NULL */
1613     if (esrequest.request == NULL)
1614         return(NULL);
1615
1616     resp->referenceId = req->referenceId;
1617
1618     if (esrequest.errcode == -1)
1619     {
1620         /* Backend service indicates request will be processed */
1621         yaz_log(LOG_DEBUG,"Request could be processed...Accepted !");
1622         *resp->operationStatus = Z_ExtendedServicesResponse_accepted;
1623     }
1624     else if (esrequest.errcode == 0)
1625     {
1626         /* Backend service indicates request will be processed */
1627         yaz_log(LOG_DEBUG,"Request could be processed...Done !");
1628         *resp->operationStatus = Z_ExtendedServicesResponse_done;
1629     }
1630     else
1631     {
1632         Z_DiagRecs *diagRecs = diagrecs (assoc, esrequest.errcode,
1633                                          esrequest.errstring);
1634
1635         /* Backend indicates error, request will not be processed */
1636         yaz_log(LOG_DEBUG,"Request could not be processed...failure !");
1637         *resp->operationStatus = Z_ExtendedServicesResponse_failure;
1638         resp->num_diagnostics = diagRecs->num_diagRecs;
1639         resp->diagnostics = diagRecs->diagRecs;
1640     }
1641     /* Do something with the members of bend_extendedservice */
1642     if (esrequest.taskPackage)
1643         resp->taskPackage = z_ext_record (assoc->encode, VAL_EXTENDED,
1644                                          (const char *)  esrequest.taskPackage,
1645                                           -1);
1646     yaz_log(LOG_DEBUG,"Send the result apdu");
1647     return apdu;
1648 }