src/logic.c

   1 /* $Id: logic.c,v 1.18 2007-04-22 16:41:42 adam Exp $
   2    Copyright (c) 2006-2007, Index Data.
   3
   4 This file is part of Pazpar2.
   5
   6 Pazpar2 is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Pazpar2; see the file LICENSE.  If not, write to the
  18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.
  20  */
  21
  22 // This file contains the primary business logic. Several parts of it should
  23 // Eventually be factored into separate modules.
  24
  25 #include <stdlib.h>
  26 #include <stdio.h>
  27 #include <string.h>
  28 #include <sys/time.h>
  29 #include <unistd.h>
  30 #include <sys/socket.h>
  31 #include <netdb.h>
  32 #include <signal.h>
  33 #include <ctype.h>
  34 #include <assert.h>
  35
  36 #include <yaz/marcdisp.h>
  37 #include <yaz/comstack.h>
  38 #include <yaz/tcpip.h>
  39 #include <yaz/proto.h>
  40 #include <yaz/readconf.h>
  41 #include <yaz/pquery.h>
  42 #include <yaz/otherinfo.h>
  43 #include <yaz/yaz-util.h>
  44 #include <yaz/nmem.h>
  45 #include <yaz/query-charset.h>
  46 #include <yaz/querytowrbuf.h>
  47 #if YAZ_VERSIONL >= 0x020163
  48 #include <yaz/oid_db.h>
  49 #endif
  50
  51 #if HAVE_CONFIG_H
  52 #include "cconfig.h"
  53 #endif
  54
  55 #define USE_TIMING 0
  56 #if USE_TIMING
  57 #include <yaz/timing.h>
  58 #endif
  59
  60 #include <netinet/in.h>
  61
  62 #include "pazpar2.h"
  63 #include "eventl.h"
  64 #include "http.h"
  65 #include "termlists.h"
  66 #include "reclists.h"
  67 #include "relevance.h"
  68 #include "config.h"
  69 #include "database.h"
  70 #include "settings.h"
  71
  72 #define MAX_CHUNK 15
  73
  74 static void client_fatal(struct client *cl);
  75 static void connection_destroy(struct connection *co);
  76 static int client_prep_connection(struct client *cl);
  77 static void ingest_records(struct client *cl, Z_Records *r);
  78 void session_alert_watch(struct session *s, int what);
  79
  80 static struct connection *connection_freelist = 0;
  81 static struct client *client_freelist = 0;
  82
  83 static char *client_states[] = {
  84     "Client_Connecting",
  85     "Client_Connected",
  86     "Client_Idle",
  87     "Client_Initializing",
  88     "Client_Searching",
  89     "Client_Presenting",
  90     "Client_Error",
  91     "Client_Failed",
  92     "Client_Disconnected",
  93     "Client_Stopped"
  94 };
  95
  96 // Note: Some things in this structure will eventually move to configuration
  97 struct parameters global_parameters =
  98 {
  99     "",
 100     "",
 101     "",
 102     "",
 103     0,
 104     0,
 105     30,
 106     "81",
 107     "Index Data PazPar2",
 108     VERSION,
 109     600, // 10 minutes
 110     60,
 111     100,
 112     MAX_CHUNK,
 113     0,
 114     0
 115 };
 116
 117 static int send_apdu(struct client *c, Z_APDU *a)
 118 {
 119     struct connection *co = c->connection;
 120     char *buf;
 121     int len, r;
 122
 123     if (!z_APDU(global_parameters.odr_out, &a, 0, 0))
 124     {
 125         odr_perror(global_parameters.odr_out, "Encoding APDU");
 126         abort();
 127     }
 128     buf = odr_getbuf(global_parameters.odr_out, &len, 0);
 129     r = cs_put(co->link, buf, len);
 130     if (r < 0)
 131     {
 132         yaz_log(YLOG_WARN, "cs_put: %s", cs_errmsg(cs_errno(co->link)));
 133         return -1;
 134     }
 135     else if (r == 1)
 136     {
 137         fprintf(stderr, "cs_put incomplete (ParaZ does not handle that)\n");
 138         exit(1);
 139     }
 140     odr_reset(global_parameters.odr_out); /* release the APDU structure  */
 141     co->state = Conn_Waiting;
 142     return 0;
 143 }
 144
 145 // Set authentication token in init if one is set for the client
 146 // TODO: Extend this to handle other schemes than open (should be simple)
 147 static void init_authentication(struct client *cl, Z_InitRequest *req)
 148 {
 149     struct session_database *sdb = cl->database;
 150     char *auth = session_setting_oneval(sdb, PZ_AUTHENTICATION);
 151
 152     if (auth)
 153     {
 154         Z_IdAuthentication *idAuth = odr_malloc(global_parameters.odr_out,
 155                 sizeof(*idAuth));
 156         idAuth->which = Z_IdAuthentication_open;
 157         idAuth->u.open = auth;
 158         req->idAuthentication = idAuth;
 159     }
 160 }
 161
 162 static void send_init(IOCHAN i)
 163 {
 164
 165     struct connection *co = iochan_getdata(i);
 166     struct client *cl = co->client;
 167     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_initRequest);
 168
 169     a->u.initRequest->implementationId = global_parameters.implementationId;
 170     a->u.initRequest->implementationName = global_parameters.implementationName;
 171     a->u.initRequest->implementationVersion =
 172         global_parameters.implementationVersion;
 173     ODR_MASK_SET(a->u.initRequest->options, Z_Options_search);
 174     ODR_MASK_SET(a->u.initRequest->options, Z_Options_present);
 175     ODR_MASK_SET(a->u.initRequest->options, Z_Options_namedResultSets);
 176
 177     ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_1);
 178     ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_2);
 179     ODR_MASK_SET(a->u.initRequest->protocolVersion, Z_ProtocolVersion_3);
 180
 181     init_authentication(cl, a->u.initRequest);
 182
 183     /* add virtual host if tunneling through Z39.50 proxy */
 184
 185     if (0 < strlen(global_parameters.zproxy_override)
 186         && 0 < strlen(cl->database->database->url))
 187     {
 188 #if YAZ_VERSIONL >= 0x020163
 189         yaz_oi_set_string_oid(&a->u.initRequest->otherInfo,
 190                               global_parameters.odr_out,
 191                               yaz_oid_userinfo_proxy,
 192                               1, cl->database->database->url);
 193 #else
 194         yaz_oi_set_string_oidval(&a->u.initRequest->otherInfo,
 195                                  global_parameters.odr_out, VAL_PROXY,
 196                                  1, cl->database->database->url);
 197 #endif
 198     }
 199
 200     if (send_apdu(cl, a) >= 0)
 201     {
 202         iochan_setflags(i, EVENT_INPUT);
 203         cl->state = Client_Initializing;
 204     }
 205     else
 206         cl->state = Client_Error;
 207     odr_reset(global_parameters.odr_out);
 208 }
 209
 210 // Recursively traverse query structure to extract terms.
 211 static void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
 212 {
 213     char **words;
 214     int numwords;
 215     int i;
 216
 217     switch (n->kind)
 218     {
 219         case CCL_RPN_AND:
 220         case CCL_RPN_OR:
 221         case CCL_RPN_NOT:
 222         case CCL_RPN_PROX:
 223             pull_terms(nmem, n->u.p[0], termlist, num);
 224             pull_terms(nmem, n->u.p[1], termlist, num);
 225             break;
 226         case CCL_RPN_TERM:
 227             nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
 228             for (i = 0; i < numwords; i++)
 229                 termlist[(*num)++] = words[i];
 230             break;
 231         default: // NOOP
 232             break;
 233     }
 234 }
 235
 236 // Extract terms from query into null-terminated termlist
 237 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
 238 {
 239     int num = 0;
 240
 241     pull_terms(nmem, query, termlist, &num);
 242     termlist[num] = 0;
 243 }
 244
 245 static void send_search(IOCHAN i)
 246 {
 247     struct connection *co = iochan_getdata(i);
 248     struct client *cl = co->client;
 249     struct session *se = cl->session;
 250     struct session_database *sdb = cl->database;
 251     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_searchRequest);
 252     int ndb;
 253     char **databaselist;
 254     Z_Query *zquery;
 255     int ssub = 0, lslb = 100000, mspn = 10;
 256     char *recsyn = 0;
 257     char *piggyback = 0;
 258     char *queryenc = 0;
 259     yaz_iconv_t iconv = 0;
 260
 261     yaz_log(YLOG_DEBUG, "Sending search to %s", cl->database->database->url);
 262
 263     // constructing RPN query
 264     a->u.searchRequest->query = zquery = odr_malloc(global_parameters.odr_out,
 265             sizeof(Z_Query));
 266     zquery->which = Z_Query_type_1;
 267     zquery->u.type_1 = p_query_rpn(global_parameters.odr_out, cl->pquery);
 268
 269     // converting to target encoding
 270     if ((queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING))){
 271         iconv = yaz_iconv_open(queryenc, "UTF-8");
 272         if (iconv){
 273             yaz_query_charset_convert_rpnquery(zquery->u.type_1,
 274                                                global_parameters.odr_out,
 275                                                iconv);
 276             yaz_iconv_close(iconv);
 277         } else
 278             yaz_log(YLOG_WARN, "Query encoding failed %s %s",
 279                     cl->database->database->url, queryenc);
 280     }
 281
 282     for (ndb = 0; sdb->database->databases[ndb]; ndb++)
 283         ;
 284     databaselist = odr_malloc(global_parameters.odr_out, sizeof(char*) * ndb);
 285     for (ndb = 0; sdb->database->databases[ndb]; ndb++)
 286         databaselist[ndb] = sdb->database->databases[ndb];
 287
 288     if (!(piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK)) || *piggyback == '1')
 289     {
 290         if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
 291         {
 292 #if YAZ_VERSIONL >= 0x020163
 293             a->u.searchRequest->preferredRecordSyntax =
 294                 yaz_string_to_oid_odr(yaz_oid_std(),
 295                                       CLASS_RECSYN, recsyn,
 296                                       global_parameters.odr_out);
 297 #else
 298             a->u.searchRequest->preferredRecordSyntax =
 299                 yaz_str_to_z3950oid(global_parameters.odr_out,
 300                                     CLASS_RECSYN, recsyn);
 301 #endif
 302         }
 303         a->u.searchRequest->smallSetUpperBound = &ssub;
 304         a->u.searchRequest->largeSetLowerBound = &lslb;
 305         a->u.searchRequest->mediumSetPresentNumber = &mspn;
 306     }
 307     a->u.searchRequest->resultSetName = "Default";
 308     a->u.searchRequest->databaseNames = databaselist;
 309     a->u.searchRequest->num_databaseNames = ndb;
 310
 311
 312     {  //scope for sending and logging queries
 313         WRBUF wbquery = wrbuf_alloc();
 314         yaz_query_to_wrbuf(wbquery, zquery);
 315
 316
 317         if (send_apdu(cl, a) >= 0)
 318             {
 319                 iochan_setflags(i, EVENT_INPUT);
 320                 cl->state = Client_Searching;
 321                 cl->requestid = se->requestid;
 322                 yaz_log(YLOG_LOG, "SearchRequest %s %s %s",
 323                          cl->database->database->url,
 324                         queryenc ? queryenc : "UTF-8",
 325                         wrbuf_cstr(wbquery));
 326             }
 327         else {
 328             cl->state = Client_Error;
 329                 yaz_log(YLOG_WARN, "Failed SearchRequest %s  %s %s",
 330                          cl->database->database->url,
 331                         queryenc ? queryenc : "UTF-8",
 332                         wrbuf_cstr(wbquery));
 333         }
 334
 335         wrbuf_destroy(wbquery);
 336     }
 337
 338     odr_reset(global_parameters.odr_out);
 339 }
 340
 341 static void send_present(IOCHAN i)
 342 {
 343     struct connection *co = iochan_getdata(i);
 344     struct client *cl = co->client;
 345     struct session_database *sdb = cl->database;
 346     Z_APDU *a = zget_APDU(global_parameters.odr_out, Z_APDU_presentRequest);
 347     int toget;
 348     int start = cl->records + 1;
 349     char *recsyn;
 350
 351     toget = global_parameters.chunk;
 352     if (toget > global_parameters.toget - cl->records)
 353         toget = global_parameters.toget - cl->records;
 354     if (toget > cl->hits - cl->records)
 355         toget = cl->hits - cl->records;
 356
 357     yaz_log(YLOG_DEBUG, "Trying to present %d records\n", toget);
 358
 359     a->u.presentRequest->resultSetStartPoint = &start;
 360     a->u.presentRequest->numberOfRecordsRequested = &toget;
 361
 362     a->u.presentRequest->resultSetId = "Default";
 363
 364     if ((recsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX)))
 365     {
 366 #if YAZ_VERSIONL >= 0x020163
 367         a->u.presentRequest->preferredRecordSyntax =
 368             yaz_string_to_oid_odr(yaz_oid_std(),
 369                                   CLASS_RECSYN, recsyn,
 370                                   global_parameters.odr_out);
 371 #else
 372         a->u.presentRequest->preferredRecordSyntax =
 373             yaz_str_to_z3950oid(global_parameters.odr_out,
 374                                 CLASS_RECSYN, recsyn);
 375 #endif
 376     }
 377
 378     if (send_apdu(cl, a) >= 0)
 379     {
 380         iochan_setflags(i, EVENT_INPUT);
 381         cl->state = Client_Presenting;
 382     }
 383     else
 384         cl->state = Client_Error;
 385     odr_reset(global_parameters.odr_out);
 386 }
 387
 388 static void do_initResponse(IOCHAN i, Z_APDU *a)
 389 {
 390     struct connection *co = iochan_getdata(i);
 391     struct client *cl = co->client;
 392     Z_InitResponse *r = a->u.initResponse;
 393
 394     yaz_log(YLOG_DEBUG, "Init response %s", cl->database->database->url);
 395
 396     if (*r->result)
 397     {
 398         cl->state = Client_Idle;
 399     }
 400     else
 401         cl->state = Client_Failed; // FIXME need to do something to the connection
 402 }
 403
 404 static void do_searchResponse(IOCHAN i, Z_APDU *a)
 405 {
 406     struct connection *co = iochan_getdata(i);
 407     struct client *cl = co->client;
 408     struct session *se = cl->session;
 409     Z_SearchResponse *r = a->u.searchResponse;
 410
 411     yaz_log(YLOG_DEBUG, "Search response %s (status=%d)",
 412             cl->database->database->url, *r->searchStatus);
 413
 414     if (*r->searchStatus)
 415     {
 416         cl->hits = *r->resultCount;
 417         se->total_hits += cl->hits;
 418         if (r->presentStatus && !*r->presentStatus && r->records)
 419         {
 420             yaz_log(YLOG_DEBUG, "Records in search response %s",
 421                     cl->database->database->url);
 422             ingest_records(cl, r->records);
 423         }
 424         cl->state = Client_Idle;
 425     }
 426     else
 427     {          /*"FAILED"*/
 428         cl->hits = 0;
 429         cl->state = Client_Error;
 430         if (r->records) {
 431             Z_Records *recs = r->records;
 432             if (recs->which == Z_Records_NSD)
 433             {
 434                 yaz_log(YLOG_WARN,
 435                         "Search response: Non-surrogate diagnostic %s",
 436                         cl->database->database->url);
 437                 cl->diagnostic = *recs->u.nonSurrogateDiagnostic->condition;
 438                 cl->state = Client_Error;
 439             }
 440         }
 441     }
 442 }
 443
 444 static void do_closeResponse(IOCHAN i, Z_APDU *a)
 445 {
 446     struct connection *co = iochan_getdata(i);
 447     struct client *cl = co->client;
 448     /* Z_Close *r = a->u.close; */
 449
 450     yaz_log(YLOG_WARN, "Close response %s", cl->database->database->url);
 451
 452     cl->state = Client_Failed;
 453     connection_destroy(co);
 454 }
 455
 456
 457 char *normalize_mergekey(char *buf, int skiparticle)
 458 {
 459     char *p = buf, *pout = buf;
 460
 461     if (skiparticle)
 462     {
 463         char firstword[64];
 464         char articles[] = "the den der die des an a "; // must end in space
 465
 466         while (*p && !isalnum(*p))
 467             p++;
 468         pout = firstword;
 469         while (*p && *p != ' ' && pout - firstword < 62)
 470             *(pout++) = tolower(*(p++));
 471         *(pout++) = ' ';
 472         *(pout++) = '\0';
 473         if (!strstr(articles, firstword))
 474             p = buf;
 475         pout = buf;
 476     }
 477
 478     while (*p)
 479     {
 480         while (*p && !isalnum(*p))
 481             p++;
 482         while (isalnum(*p))
 483             *(pout++) = tolower(*(p++));
 484         if (*p)
 485             *(pout++) = ' ';
 486         while (*p && !isalnum(*p))
 487             p++;
 488     }
 489     if (buf != pout)
 490         do {
 491             *(pout--) = '\0';
 492         }
 493         while (pout > buf && *pout == ' ');
 494
 495     return buf;
 496 }
 497
 498 static void add_facet(struct session *s, const char *type, const char *value)
 499 {
 500     int i;
 501
 502     if (!*value)
 503         return;
 504     for (i = 0; i < s->num_termlists; i++)
 505         if (!strcmp(s->termlists[i].name, type))
 506             break;
 507     if (i == s->num_termlists)
 508     {
 509         if (i == SESSION_MAX_TERMLISTS)
 510         {
 511             yaz_log(YLOG_FATAL, "Too many termlists");
 512             exit(1);
 513         }
 514         s->termlists[i].name = nmem_strdup(s->nmem, type);
 515         s->termlists[i].termlist = termlist_create(s->nmem, s->expected_maxrecs, 15);
 516         s->num_termlists = i + 1;
 517     }
 518     termlist_insert(s->termlists[i].termlist, value);
 519 }
 520
 521 static xmlDoc *normalize_record(struct client *cl, Z_External *rec)
 522 {
 523     struct database_retrievalmap *m;
 524     struct session_database *sdb = cl->database;
 525     struct database *db = sdb->database;
 526     xmlNode *res;
 527     xmlDoc *rdoc;
 528
 529     // First normalize to XML
 530     if (sdb->yaz_marc)
 531     {
 532         char *buf;
 533         int len;
 534         if (rec->which != Z_External_octet)
 535         {
 536             yaz_log(YLOG_WARN, "Unexpected external branch, probably BER %s",
 537                     db->url);
 538             return 0;
 539         }
 540         buf = (char*) rec->u.octet_aligned->buf;
 541         len = rec->u.octet_aligned->len;
 542         if (yaz_marc_read_iso2709(sdb->yaz_marc, buf, len) < 0)
 543         {
 544             yaz_log(YLOG_WARN, "Failed to decode MARC %s", db->url);
 545             return 0;
 546         }
 547
 548         yaz_marc_write_using_libxml2(sdb->yaz_marc, 1);
 549         if (yaz_marc_write_xml(sdb->yaz_marc, &res,
 550                     "http://www.loc.gov/MARC21/slim", 0, 0) < 0)
 551         {
 552             yaz_log(YLOG_WARN, "Failed to encode as XML %s",
 553                     db->url);
 554             return 0;
 555         }
 556         rdoc = xmlNewDoc((xmlChar *) "1.0");
 557         xmlDocSetRootElement(rdoc, res);
 558
 559     }
 560     else
 561     {
 562         yaz_log(YLOG_FATAL,
 563                 "Unknown native_syntax in normalize_record from %s",
 564                 db->url);
 565         exit(1);
 566     }
 567
 568     if (global_parameters.dump_records){
 569         fprintf(stderr,
 570                 "Input Record (normalized) from %s\n----------------\n",
 571                 db->url);
 572 #if LIBXML_VERSION >= 20600
 573         xmlDocFormatDump(stderr, rdoc, 1);
 574 #else
 575         xmlDocDump(stderr, rdoc);
 576 #endif
 577     }
 578
 579     for (m = sdb->map; m; m = m->next){
 580         xmlDoc *new = 0;
 581
 582 #if 1
 583         {
 584             xmlNodePtr root = 0;
 585             new = xsltApplyStylesheet(m->stylesheet, rdoc, 0);
 586             root= xmlDocGetRootElement(new);
 587         if (!new || !root || !(root->children))
 588         {
 589             yaz_log(YLOG_WARN, "XSLT transformation failed from %s",
 590                     cl->database->database->url);
 591             xmlFreeDoc(new);
 592             xmlFreeDoc(rdoc);
 593             return 0;
 594         }
 595         }
 596 #endif
 597
 598 #if 0
 599         // do it another way to detect transformation errors right now
 600         // but does not seem to work either!
 601         {
 602             xsltTransformContextPtr ctxt;
 603             ctxt = xsltNewTransformContext(m->stylesheet, rdoc);
 604             new = xsltApplyStylesheetUser(m->stylesheet, rdoc, 0, 0, 0, ctxt);
 605             if ((ctxt->state == XSLT_STATE_ERROR) ||
 606                 (ctxt->state == XSLT_STATE_STOPPED)){
 607                 yaz_log(YLOG_WARN, "XSLT transformation failed from %s",
 608                         cl->database->database->url);
 609                 xmlFreeDoc(new);
 610                 xmlFreeDoc(rdoc);
 611                 return 0;
 612             }
 613         }
 614 #endif
 615
 616         xmlFreeDoc(rdoc);
 617         rdoc = new;
 618     }
 619     if (global_parameters.dump_records)
 620     {
 621         fprintf(stderr, "Record from %s\n----------------\n",
 622                 cl->database->database->url);
 623 #if LIBXML_VERSION >= 20600
 624         xmlDocFormatDump(stderr, rdoc, 1);
 625 #else
 626         xmlDocDump(stderr, rdoc);
 627 #endif
 628     }
 629     return rdoc;
 630 }
 631
 632 // Extract what appears to be years from buf, storing highest and
 633 // lowest values.
 634 static int extract_years(const char *buf, int *first, int *last)
 635 {
 636     *first = -1;
 637     *last = -1;
 638     while (*buf)
 639     {
 640         const char *e;
 641         int len;
 642
 643         while (*buf && !isdigit(*buf))
 644             buf++;
 645         len = 0;
 646         for (e = buf; *e && isdigit(*e); e++)
 647             len++;
 648         if (len == 4)
 649         {
 650             int value = atoi(buf);
 651             if (*first < 0 || value < *first)
 652                 *first = value;
 653             if (*last < 0 || value > *last)
 654                 *last = value;
 655         }
 656         buf = e;
 657     }
 658     return *first;
 659 }
 660
 661 static struct record *ingest_record(struct client *cl, Z_External *rec)
 662 {
 663     xmlDoc *xdoc = normalize_record(cl, rec);
 664     xmlNode *root, *n;
 665     struct record *res;
 666     struct record_cluster *cluster;
 667     struct session *se = cl->session;
 668     xmlChar *mergekey, *mergekey_norm;
 669     xmlChar *type = 0;
 670     xmlChar *value = 0;
 671     struct conf_service *service = global_parameters.server->service;
 672
 673     if (!xdoc)
 674         return 0;
 675
 676     root = xmlDocGetRootElement(xdoc);
 677     if (!(mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
 678     {
 679         yaz_log(YLOG_WARN, "No mergekey found in record");
 680         xmlFreeDoc(xdoc);
 681         return 0;
 682     }
 683
 684     res = nmem_malloc(se->nmem, sizeof(struct record));
 685     res->next = 0;
 686     res->client = cl;
 687     res->metadata = nmem_malloc(se->nmem,
 688             sizeof(struct record_metadata*) * service->num_metadata);
 689     memset(res->metadata, 0, sizeof(struct record_metadata*) * service->num_metadata);
 690
 691     mergekey_norm = (xmlChar *) nmem_strdup(se->nmem, (char*) mergekey);
 692     xmlFree(mergekey);
 693     normalize_mergekey((char *) mergekey_norm, 0);
 694
 695     cluster = reclist_insert(se->reclist,
 696                              global_parameters.server->service,
 697                              res, (char *) mergekey_norm,
 698                              &se->total_merged);
 699     if (global_parameters.dump_records)
 700         yaz_log(YLOG_LOG, "Cluster id %d from %s (#%d)", cluster->recid,
 701                 cl->database->database->url, cl->records);
 702     if (!cluster)
 703     {
 704         /* no room for record */
 705         xmlFreeDoc(xdoc);
 706         return 0;
 707     }
 708     relevance_newrec(se->relevance, cluster);
 709
 710     for (n = root->children; n; n = n->next)
 711     {
 712         if (type)
 713             xmlFree(type);
 714         if (value)
 715             xmlFree(value);
 716         type = value = 0;
 717
 718         if (n->type != XML_ELEMENT_NODE)
 719             continue;
 720         if (!strcmp((const char *) n->name, "metadata"))
 721         {
 722             struct conf_metadata *md = 0;
 723             struct conf_sortkey *sk = 0;
 724             struct record_metadata **wheretoput, *newm;
 725             int imeta;
 726             int first, last;
 727
 728             type = xmlGetProp(n, (xmlChar *) "type");
 729             value = xmlNodeListGetString(xdoc, n->children, 0);
 730
 731             if (!type || !value)
 732                 continue;
 733
 734             // First, find out what field we're looking at
 735             for (imeta = 0; imeta < service->num_metadata; imeta++)
 736                 if (!strcmp((const char *) type, service->metadata[imeta].name))
 737                 {
 738                     md = &service->metadata[imeta];
 739                     if (md->sortkey_offset >= 0)
 740                         sk = &service->sortkeys[md->sortkey_offset];
 741                     break;
 742                 }
 743             if (!md)
 744             {
 745                 yaz_log(YLOG_WARN, "Ignoring unknown metadata element: %s", type);
 746                 continue;
 747             }
 748
 749             // Find out where we are putting it
 750             if (md->merge == Metadata_merge_no)
 751                 wheretoput = &res->metadata[imeta];
 752             else
 753                 wheretoput = &cluster->metadata[imeta];
 754
 755             // Put it there
 756             newm = nmem_malloc(se->nmem, sizeof(struct record_metadata));
 757             newm->next = 0;
 758             if (md->type == Metadata_type_generic)
 759             {
 760                 char *p, *pe;
 761                 for (p = (char *) value; *p && isspace(*p); p++)
 762                     ;
 763                 for (pe = p + strlen(p) - 1;
 764                         pe > p && strchr(" ,/.:([", *pe); pe--)
 765                     *pe = '\0';
 766                 newm->data.text = nmem_strdup(se->nmem, p);
 767
 768             }
 769             else if (md->type == Metadata_type_year)
 770             {
 771                 if (extract_years((char *) value, &first, &last) < 0)
 772                     continue;
 773             }
 774             else
 775             {
 776                 yaz_log(YLOG_WARN, "Unknown type in metadata element %s", type);
 777                 continue;
 778             }
 779             if (md->type == Metadata_type_year && md->merge != Metadata_merge_range)
 780             {
 781                 yaz_log(YLOG_WARN, "Only range merging supported for years");
 782                 continue;
 783             }
 784             if (md->merge == Metadata_merge_unique)
 785             {
 786                 struct record_metadata *mnode;
 787                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
 788                     if (!strcmp((const char *) mnode->data.text, newm->data.text))
 789                         break;
 790                 if (!mnode)
 791                 {
 792                     newm->next = *wheretoput;
 793                     *wheretoput = newm;
 794                 }
 795             }
 796             else if (md->merge == Metadata_merge_longest)
 797             {
 798                 if (!*wheretoput ||
 799                         strlen(newm->data.text) > strlen((*wheretoput)->data.text))
 800                 {
 801                     *wheretoput = newm;
 802                     if (sk)
 803                     {
 804                         char *s = nmem_strdup(se->nmem, newm->data.text);
 805                         if (!cluster->sortkeys[md->sortkey_offset])
 806                             cluster->sortkeys[md->sortkey_offset] =
 807                                 nmem_malloc(se->nmem, sizeof(union data_types));
 808                         normalize_mergekey(s,
 809                                 (sk->type == Metadata_sortkey_skiparticle));
 810                         cluster->sortkeys[md->sortkey_offset]->text = s;
 811                     }
 812                 }
 813             }
 814             else if (md->merge == Metadata_merge_all || md->merge == Metadata_merge_no)
 815             {
 816                 newm->next = *wheretoput;
 817                 *wheretoput = newm;
 818             }
 819             else if (md->merge == Metadata_merge_range)
 820             {
 821                 assert(md->type == Metadata_type_year);
 822                 if (!*wheretoput)
 823                 {
 824                     *wheretoput = newm;
 825                     (*wheretoput)->data.number.min = first;
 826                     (*wheretoput)->data.number.max = last;
 827                     if (sk)
 828                         cluster->sortkeys[md->sortkey_offset] = &newm->data;
 829                 }
 830                 else
 831                 {
 832                     if (first < (*wheretoput)->data.number.min)
 833                         (*wheretoput)->data.number.min = first;
 834                     if (last > (*wheretoput)->data.number.max)
 835                         (*wheretoput)->data.number.max = last;
 836                 }
 837 #ifdef GAGA
 838                 if (sk)
 839                 {
 840                     union data_types *sdata = cluster->sortkeys[md->sortkey_offset];
 841                     yaz_log(YLOG_LOG, "SK range: %d-%d", sdata->number.min, sdata->number.max);
 842                 }
 843 #endif
 844             }
 845             else
 846                 yaz_log(YLOG_WARN, "Don't know how to merge on element name %s", md->name);
 847
 848             if (md->rank)
 849                 relevance_countwords(se->relevance, cluster,
 850                                      (char *) value, md->rank);
 851             if (md->termlist)
 852             {
 853                 if (md->type == Metadata_type_year)
 854                 {
 855                     char year[64];
 856                     sprintf(year, "%d", last);
 857                     add_facet(se, (char *) type, year);
 858                     if (first != last)
 859                     {
 860                         sprintf(year, "%d", first);
 861                         add_facet(se, (char *) type, year);
 862                     }
 863                 }
 864                 else
 865                     add_facet(se, (char *) type, (char *) value);
 866             }
 867             xmlFree(type);
 868             xmlFree(value);
 869             type = value = 0;
 870         }
 871         else
 872             yaz_log(YLOG_WARN, "Unexpected element %s in internal record", n->name);
 873     }
 874     if (type)
 875         xmlFree(type);
 876     if (value)
 877         xmlFree(value);
 878
 879     xmlFreeDoc(xdoc);
 880
 881     relevance_donerecord(se->relevance, cluster);
 882     se->total_records++;
 883
 884     return res;
 885 }
 886
 887 // Retrieve first defined value for 'name' for given database.
 888 // Will be extended to take into account user associated with session
 889 char *session_setting_oneval(struct session_database *db, int offset)
 890 {
 891     if (!db->settings[offset])
 892         return "";
 893     return db->settings[offset]->value;
 894 }
 895
 896 static void ingest_records(struct client *cl, Z_Records *r)
 897 {
 898 #if USE_TIMING
 899     yaz_timing_t t = yaz_timing_create();
 900 #endif
 901     struct record *rec;
 902     struct session *s = cl->session;
 903     Z_NamePlusRecordList *rlist;
 904     int i;
 905
 906     if (r->which != Z_Records_DBOSD)
 907         return;
 908     rlist = r->u.databaseOrSurDiagnostics;
 909     for (i = 0; i < rlist->num_records; i++)
 910     {
 911         Z_NamePlusRecord *npr = rlist->records[i];
 912
 913         cl->records++;
 914         if (npr->which != Z_NamePlusRecord_databaseRecord)
 915         {
 916             yaz_log(YLOG_WARN,
 917                     "Unexpected record type, probably diagnostic %s",
 918                     cl->database->database->url);
 919             continue;
 920         }
 921
 922         rec = ingest_record(cl, npr->u.databaseRecord);
 923         if (!rec)
 924             continue;
 925     }
 926     if (s->watchlist[SESSION_WATCH_RECORDS].fun && rlist->num_records)
 927         session_alert_watch(s, SESSION_WATCH_RECORDS);
 928
 929 #if USE_TIMING
 930     yaz_timing_stop(t);
 931     yaz_log(YLOG_LOG, "ingest_records %6.5f %3.2f %3.2f",
 932             yaz_timing_get_real(t), yaz_timing_get_user(t),
 933             yaz_timing_get_sys(t));
 934     yaz_timing_destroy(&t);
 935 #endif
 936 }
 937
 938 static void do_presentResponse(IOCHAN i, Z_APDU *a)
 939 {
 940     struct connection *co = iochan_getdata(i);
 941     struct client *cl = co->client;
 942     Z_PresentResponse *r = a->u.presentResponse;
 943
 944     if (r->records) {
 945         Z_Records *recs = r->records;
 946         if (recs->which == Z_Records_NSD)
 947         {
 948             yaz_log(YLOG_WARN, "Non-surrogate diagnostic %s",
 949                     cl->database->database->url);
 950             cl->diagnostic = *recs->u.nonSurrogateDiagnostic->condition;
 951             cl->state = Client_Error;
 952         }
 953     }
 954
 955     if (!*r->presentStatus && cl->state != Client_Error)
 956     {
 957         yaz_log(YLOG_DEBUG, "Good Present response %s",
 958                 cl->database->database->url);
 959         ingest_records(cl, r->records);
 960         cl->state = Client_Idle;
 961     }
 962     else if (*r->presentStatus)
 963     {
 964         yaz_log(YLOG_WARN, "Bad Present response %s",
 965                 cl->database->database->url);
 966         cl->state = Client_Error;
 967     }
 968 }
 969
 970 void connection_handler(IOCHAN i, int event)
 971 {
 972     struct connection *co = iochan_getdata(i);
 973     struct client *cl = co->client;
 974     struct session *se = 0;
 975
 976     if (cl)
 977         se = cl->session;
 978     else
 979     {
 980         yaz_log(YLOG_WARN, "Destroying orphan connection");
 981         connection_destroy(co);
 982         return;
 983     }
 984
 985     if (co->state == Conn_Connecting && event & EVENT_OUTPUT)
 986     {
 987         int errcode;
 988         socklen_t errlen = sizeof(errcode);
 989
 990         if (getsockopt(cs_fileno(co->link), SOL_SOCKET, SO_ERROR, &errcode,
 991             &errlen) < 0 || errcode != 0)
 992         {
 993             client_fatal(cl);
 994             return;
 995         }
 996         else
 997         {
 998             yaz_log(YLOG_DEBUG, "Connect OK");
 999             co->state = Conn_Open;
1000             if (cl)
1001                 cl->state = Client_Connected;
1002         }
1003     }
1004
1005     else if (event & EVENT_INPUT)
1006     {
1007         int len = cs_get(co->link, &co->ibuf, &co->ibufsize);
1008
1009         if (len < 0)
1010         {
1011             yaz_log(YLOG_WARN|YLOG_ERRNO, "Error reading from %s",
1012                     cl->database->database->url);
1013             connection_destroy(co);
1014             return;
1015         }
1016         else if (len == 0)
1017         {
1018             yaz_log(YLOG_WARN, "EOF reading from %s", cl->database->database->url);
1019             connection_destroy(co);
1020             return;
1021         }
1022         else if (len > 1) // We discard input if we have no connection
1023         {
1024             co->state = Conn_Open;
1025
1026             if (cl && (cl->requestid == se->requestid || cl->state == Client_Initializing))
1027             {
1028                 Z_APDU *a;
1029
1030                 odr_reset(global_parameters.odr_in);
1031                 odr_setbuf(global_parameters.odr_in, co->ibuf, len, 0);
1032                 if (!z_APDU(global_parameters.odr_in, &a, 0, 0))
1033                 {
1034                     client_fatal(cl);
1035                     return;
1036                 }
1037                 switch (a->which)
1038                 {
1039                     case Z_APDU_initResponse:
1040                         do_initResponse(i, a);
1041                         break;
1042                     case Z_APDU_searchResponse:
1043                         do_searchResponse(i, a);
1044                         break;
1045                     case Z_APDU_presentResponse:
1046                         do_presentResponse(i, a);
1047                         break;
1048                     case Z_APDU_close:
1049                         do_closeResponse(i, a);
1050                         break;
1051                     default:
1052                         yaz_log(YLOG_WARN,
1053                                 "Unexpected Z39.50 response from %s",
1054                                 cl->database->database->url);
1055                         client_fatal(cl);
1056                         return;
1057                 }
1058                 // We aren't expecting staggered output from target
1059                 // if (cs_more(t->link))
1060                 //    iochan_setevent(i, EVENT_INPUT);
1061             }
1062             else  // we throw away response and go to idle mode
1063             {
1064                 yaz_log(YLOG_DEBUG, "Ignoring result of expired operation");
1065                 cl->state = Client_Idle;
1066             }
1067         }
1068         /* if len==1 we do nothing but wait for more input */
1069     }
1070
1071     if (cl->state == Client_Connected) {
1072         send_init(i);
1073     }
1074
1075     if (cl->state == Client_Idle)
1076     {
1077         if (cl->requestid != se->requestid && cl->pquery) {
1078             send_search(i);
1079         }
1080         else if (cl->hits > 0 && cl->records < global_parameters.toget &&
1081             cl->records < cl->hits) {
1082             send_present(i);
1083         }
1084     }
1085 }
1086
1087 // Disassociate connection from client
1088 static void connection_release(struct connection *co)
1089 {
1090     struct client *cl = co->client;
1091
1092     yaz_log(YLOG_DEBUG, "Connection release %s", co->host->hostport);
1093     if (!cl)
1094         return;
1095     cl->connection = 0;
1096     co->client = 0;
1097 }
1098
1099 // Close connection and recycle structure
1100 static void connection_destroy(struct connection *co)
1101 {
1102     struct host *h = co->host;
1103
1104     if (co->link)
1105     {
1106         cs_close(co->link);
1107         iochan_destroy(co->iochan);
1108     }
1109
1110     yaz_log(YLOG_DEBUG, "Connection destroy %s", co->host->hostport);
1111     if (h->connections == co)
1112         h->connections = co->next;
1113     else
1114     {
1115         struct connection *pco;
1116         for (pco = h->connections; pco && pco->next != co; pco = pco->next)
1117             ;
1118         if (pco)
1119             pco->next = co->next;
1120         else
1121             abort();
1122     }
1123     if (co->client)
1124     {
1125         if (co->client->state != Client_Idle)
1126             co->client->state = Client_Disconnected;
1127         co->client->connection = 0;
1128     }
1129     co->next = connection_freelist;
1130     connection_freelist = co;
1131 }
1132
1133 static int connection_connect(struct connection *con)
1134 {
1135     COMSTACK link = 0;
1136     struct client *cl = con->client;
1137     struct host *host = con->host;
1138     void *addr;
1139     int res;
1140
1141     assert(host->ipport);
1142     assert(cl);
1143
1144     if (!(link = cs_create(tcpip_type, 0, PROTO_Z3950)))
1145     {
1146         yaz_log(YLOG_FATAL|YLOG_ERRNO, "Failed to create comstack");
1147         exit(1);
1148     }
1149
1150     if (0 == strlen(global_parameters.zproxy_override)){
1151         /* no Z39.50 proxy needed - direct connect */
1152         yaz_log(YLOG_DEBUG, "Connection create %s", cl->database->database->url);
1153
1154         if (!(addr = cs_straddr(link, host->ipport)))
1155         {
1156             yaz_log(YLOG_WARN|YLOG_ERRNO,
1157                     "Lookup of IP address %s failed", host->ipport);
1158             return -1;
1159         }
1160
1161     } else {
1162         /* Z39.50 proxy connect */
1163         yaz_log(YLOG_DEBUG, "Connection create %s proxy %s",
1164                 cl->database->database->url, global_parameters.zproxy_override);
1165
1166         if (!(addr = cs_straddr(link, global_parameters.zproxy_override)))
1167         {
1168             yaz_log(YLOG_WARN|YLOG_ERRNO,
1169                     "Lookup of IP address %s failed",
1170                     global_parameters.zproxy_override);
1171             return -1;
1172         }
1173     }
1174
1175     res = cs_connect(link, addr);
1176     if (res < 0)
1177     {
1178         yaz_log(YLOG_WARN|YLOG_ERRNO, "cs_connect %s", cl->database->database->url);
1179         return -1;
1180     }
1181     con->link = link;
1182     con->state = Conn_Connecting;
1183     con->iochan = iochan_create(cs_fileno(link), connection_handler, 0);
1184     iochan_setdata(con->iochan, con);
1185     pazpar2_add_channel(con->iochan);
1186
1187     /* this fragment is bad DRY: from client_prep_connection */
1188     cl->state = Client_Connecting;
1189     iochan_setflag(con->iochan, EVENT_OUTPUT);
1190     return 0;
1191 }
1192
1193 void connect_resolver_host(struct host *host)
1194 {
1195     struct connection *con = host->connections;
1196
1197     while (con)
1198     {
1199         if (con->state == Conn_Resolving)
1200         {
1201             if (!host->ipport) /* unresolved */
1202             {
1203                 connection_destroy(con);
1204                 /* start all over .. at some point it will be NULL */
1205                 con = host->connections;
1206             }
1207             else if (!con->client)
1208             {
1209                 yaz_log(YLOG_WARN, "connect_unresolved_host : ophan client");
1210                 connection_destroy(con);
1211                 /* start all over .. at some point it will be NULL */
1212                 con = host->connections;
1213             }
1214             else
1215             {
1216                 connection_connect(con);
1217                 con = con->next;
1218             }
1219         }
1220     }
1221 }
1222
1223
1224 // Creates a new connection for client, associated with the host of
1225 // client's database
1226 static struct connection *connection_create(struct client *cl)
1227 {
1228     struct connection *new;
1229     struct host *host = cl->database->database->host;
1230
1231     if ((new = connection_freelist))
1232         connection_freelist = new->next;
1233     else
1234     {
1235         new = xmalloc(sizeof (struct connection));
1236         new->ibuf = 0;
1237         new->ibufsize = 0;
1238     }
1239     new->host = host;
1240     new->next = new->host->connections;
1241     new->host->connections = new;
1242     new->client = cl;
1243     cl->connection = new;
1244     new->link = 0;
1245     new->state = Conn_Resolving;
1246     if (host->ipport)
1247         connection_connect(new);
1248     return new;
1249 }
1250
1251 // Close connection and set state to error
1252 static void client_fatal(struct client *cl)
1253 {
1254     yaz_log(YLOG_WARN, "Fatal error from %s", cl->database->database->url);
1255     connection_destroy(cl->connection);
1256     cl->state = Client_Error;
1257 }
1258
1259 // Ensure that client has a connection associated
1260 static int client_prep_connection(struct client *cl)
1261 {
1262     struct connection *co;
1263     struct session *se = cl->session;
1264     struct host *host = cl->database->database->host;
1265
1266     co = cl->connection;
1267
1268     yaz_log(YLOG_DEBUG, "Client prep %s", cl->database->database->url);
1269
1270     if (!co)
1271     {
1272         // See if someone else has an idle connection
1273         // We should look at timestamps here to select the longest-idle connection
1274         for (co = host->connections; co; co = co->next)
1275             if (co->state == Conn_Open && (!co->client || co->client->session != se))
1276                 break;
1277         if (co)
1278         {
1279             connection_release(co);
1280             cl->connection = co;
1281             co->client = cl;
1282         }
1283         else
1284             co = connection_create(cl);
1285     }
1286     if (co)
1287     {
1288         if (co->state == Conn_Connecting)
1289         {
1290             cl->state = Client_Connecting;
1291             iochan_setflag(co->iochan, EVENT_OUTPUT);
1292         }
1293         else if (co->state == Conn_Open)
1294         {
1295             if (cl->state == Client_Error || cl->state == Client_Disconnected)
1296                 cl->state = Client_Idle;
1297             iochan_setflag(co->iochan, EVENT_OUTPUT);
1298         }
1299         return 1;
1300     }
1301     else
1302         return 0;
1303 }
1304
1305 // Initialize YAZ Map structures for MARC-based targets
1306 static int prepare_yazmarc(struct session_database *sdb)
1307 {
1308     char *s;
1309
1310     if (!sdb->settings)
1311     {
1312         yaz_log(YLOG_WARN, "No settings for %s", sdb->database->url);
1313         return -1;
1314     }
1315     if ((s = session_setting_oneval(sdb, PZ_NATIVESYNTAX)) && !strncmp(s, "iso2709", 7))
1316     {
1317         char *encoding = "marc-8s", *e;
1318         yaz_iconv_t cm;
1319
1320         // See if a native encoding is specified
1321         if ((e = strchr(s, ';')))
1322             encoding = e + 1;
1323
1324         sdb->yaz_marc = yaz_marc_create();
1325         yaz_marc_subfield_str(sdb->yaz_marc, "\t");
1326
1327         cm = yaz_iconv_open("utf-8", encoding);
1328         if (!cm)
1329         {
1330             yaz_log(YLOG_FATAL,
1331                     "Unable to map from %s to UTF-8 for target %s",
1332                     encoding, sdb->database->url);
1333             return -1;
1334         }
1335         yaz_marc_iconv(sdb->yaz_marc, cm);
1336     }
1337     return 0;
1338 }
1339
1340 // Prepare XSLT stylesheets for record normalization
1341 // Structures are allocated on the session_wide nmem to avoid having
1342 // to recompute this for every search. This would lead
1343 // to leaking if a single session was to repeatedly change the PZ_XSLT
1344 // setting. However, this is not a realistic use scenario.
1345 static int prepare_map(struct session *se, struct session_database *sdb)
1346 {
1347    char *s;
1348
1349     if (!sdb->settings)
1350     {
1351         yaz_log(YLOG_WARN, "No settings on %s", sdb->database->url);
1352         return -1;
1353     }
1354     if ((s = session_setting_oneval(sdb, PZ_XSLT)))
1355     {
1356         char **stylesheets;
1357         struct database_retrievalmap **m = &sdb->map;
1358         int num, i;
1359
1360         nmem_strsplit(se->session_nmem, ",", s, &stylesheets, &num);
1361         for (i = 0; i < num; i++)
1362         {
1363             (*m) = nmem_malloc(se->session_nmem, sizeof(**m));
1364             (*m)->next = 0;
1365             if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i])))
1366             {
1367                 yaz_log(YLOG_FATAL, "Unable to load stylesheet: %s",
1368                         stylesheets[i]);
1369                 return -1;
1370             }
1371             m = &(*m)->next;
1372         }
1373     }
1374     if (!sdb->map)
1375         yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s",
1376                 sdb->database->url);
1377     return 0;
1378 }
1379
1380 // This analyzes settings and recomputes any supporting data structures
1381 // if necessary.
1382 static int prepare_session_database(struct session *se, struct session_database *sdb)
1383 {
1384     if (!sdb->settings)
1385     {
1386         yaz_log(YLOG_WARN, "No settings associated with %s", sdb->database->url);
1387         return -1;
1388     }
1389     if (sdb->settings[PZ_NATIVESYNTAX] && !sdb->yaz_marc)
1390     {
1391         if (prepare_yazmarc(sdb) < 0)
1392             return -1;
1393     }
1394     if (sdb->settings[PZ_XSLT] && !sdb->map)
1395     {
1396         if (prepare_map(se, sdb) < 0)
1397             return -1;
1398     }
1399     return 0;
1400 }
1401
1402 // Initialize CCL map for a target
1403 static CCL_bibset prepare_cclmap(struct client *cl)
1404 {
1405     struct session_database *sdb = cl->database;
1406     struct setting *s;
1407     CCL_bibset res;
1408
1409     if (!sdb->settings)
1410         return 0;
1411     res = ccl_qual_mk();
1412     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
1413     {
1414         char *p = strchr(s->name + 3, ':');
1415         if (!p)
1416         {
1417             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
1418             ccl_qual_rm(&res);
1419             return 0;
1420         }
1421         p++;
1422         ccl_qual_fitem(res, s->value, p);
1423     }
1424     return res;
1425 }
1426
1427 // Parse the query given the settings specific to this client
1428 static int client_parse_query(struct client *cl, const char *query)
1429 {
1430     struct session *se = cl->session;
1431     struct ccl_rpn_node *cn;
1432     int cerror, cpos;
1433     CCL_bibset ccl_map = prepare_cclmap(cl);
1434
1435     if (!ccl_map)
1436         return -1;
1437     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
1438     ccl_qual_rm(&ccl_map);
1439     if (!cn)
1440     {
1441         cl->state = Client_Error;
1442         yaz_log(YLOG_WARN, "Failed to parse query for %s",
1443                          cl->database->database->url);
1444         return -1;
1445     }
1446     wrbuf_rewind(se->wrbuf);
1447     ccl_pquery(se->wrbuf, cn);
1448     wrbuf_putc(se->wrbuf, '\0');
1449     if (cl->pquery)
1450         xfree(cl->pquery);
1451     cl->pquery = xstrdup(wrbuf_buf(se->wrbuf));
1452
1453     if (!se->relevance)
1454     {
1455         // Initialize relevance structure with query terms
1456         char *p[512];
1457         extract_terms(se->nmem, cn, p);
1458         se->relevance = relevance_create(se->nmem, (const char **) p,
1459                 se->expected_maxrecs);
1460     }
1461
1462     ccl_rpn_delete(cn);
1463     return 0;
1464 }
1465
1466 static struct client *client_create(void)
1467 {
1468     struct client *r;
1469     if (client_freelist)
1470     {
1471         r = client_freelist;
1472         client_freelist = client_freelist->next;
1473     }
1474     else
1475         r = xmalloc(sizeof(struct client));
1476     r->pquery = 0;
1477     r->database = 0;
1478     r->connection = 0;
1479     r->session = 0;
1480     r->hits = 0;
1481     r->records = 0;
1482     r->setno = 0;
1483     r->requestid = -1;
1484     r->diagnostic = 0;
1485     r->state = Client_Disconnected;
1486     r->next = 0;
1487     return r;
1488 }
1489
1490 void client_destroy(struct client *c)
1491 {
1492     struct session *se = c->session;
1493     if (c == se->clients)
1494         se->clients = c->next;
1495     else
1496     {
1497         struct client *cc;
1498         for (cc = se->clients; cc && cc->next != c; cc = cc->next)
1499             ;
1500         if (cc)
1501             cc->next = c->next;
1502     }
1503     if (c->connection)
1504         connection_release(c->connection);
1505     c->next = client_freelist;
1506     client_freelist = c;
1507 }
1508
1509 void session_set_watch(struct session *s, int what, session_watchfun fun, void *data)
1510 {
1511     s->watchlist[what].fun = fun;
1512     s->watchlist[what].data = data;
1513 }
1514
1515 void session_alert_watch(struct session *s, int what)
1516 {
1517     if (!s->watchlist[what].fun)
1518         return;
1519     (*s->watchlist[what].fun)(s->watchlist[what].data);
1520     s->watchlist[what].fun = 0;
1521     s->watchlist[what].data = 0;
1522 }
1523
1524 //callback for grep_databases
1525 static void select_targets_callback(void *context, struct session_database *db)
1526 {
1527     struct session *se = (struct session*) context;
1528     struct client *cl = client_create();
1529     cl->database = db;
1530     cl->session = se;
1531     cl->next = se->clients;
1532     se->clients = cl;
1533 }
1534
1535 // Associates a set of clients with a session;
1536 // Note: Session-databases represent databases with per-session setting overrides
1537 int select_targets(struct session *se, struct database_criterion *crit)
1538 {
1539     while (se->clients)
1540         client_destroy(se->clients);
1541
1542     return session_grep_databases(se, crit, select_targets_callback);
1543 }
1544
1545 int session_active_clients(struct session *s)
1546 {
1547     struct client *c;
1548     int res = 0;
1549
1550     for (c = s->clients; c; c = c->next)
1551         if (c->connection && (c->state == Client_Connecting ||
1552                     c->state == Client_Initializing ||
1553                     c->state == Client_Searching ||
1554                     c->state == Client_Presenting))
1555             res++;
1556
1557     return res;
1558 }
1559
1560 // parses crit1=val1,crit2=val2|val3,...
1561 static struct database_criterion *parse_filter(NMEM m, const char *buf)
1562 {
1563     struct database_criterion *res = 0;
1564     char **values;
1565     int num;
1566     int i;
1567
1568     if (!buf || !*buf)
1569         return 0;
1570     nmem_strsplit(m, ",", buf,  &values, &num);
1571     for (i = 0; i < num; i++)
1572     {
1573         char **subvalues;
1574         int subnum;
1575         int subi;
1576         struct database_criterion *new = nmem_malloc(m, sizeof(*new));
1577         char *eq = strchr(values[i], '=');
1578         if (!eq)
1579         {
1580             yaz_log(YLOG_WARN, "Missing equal-sign in filter");
1581             return 0;
1582         }
1583         *(eq++) = '\0';
1584         new->name = values[i];
1585         nmem_strsplit(m, "|", eq, &subvalues, &subnum);
1586         new->values = 0;
1587         for (subi = 0; subi < subnum; subi++)
1588         {
1589             struct database_criterion_value *newv = nmem_malloc(m, sizeof(*newv));
1590             newv->value = subvalues[subi];
1591             newv->next = new->values;
1592             new->values = newv;
1593         }
1594         new->next = res;
1595         res = new;
1596     }
1597     return res;
1598 }
1599
1600 char *search(struct session *se, char *query, char *filter)
1601 {
1602     int live_channels = 0;
1603     struct client *cl;
1604     struct database_criterion *criteria;
1605
1606     yaz_log(YLOG_DEBUG, "Search");
1607
1608     nmem_reset(se->nmem);
1609     criteria = parse_filter(se->nmem, filter);
1610     se->requestid++;
1611     live_channels = select_targets(se, criteria);
1612     if (live_channels)
1613     {
1614         int maxrecs = live_channels * global_parameters.toget;
1615         se->num_termlists = 0;
1616         se->reclist = reclist_create(se->nmem, maxrecs);
1617         // This will be initialized in send_search()
1618         se->total_records = se->total_hits = se->total_merged = 0;
1619         se->expected_maxrecs = maxrecs;
1620     }
1621     else
1622         return "NOTARGETS";
1623
1624     se->relevance = 0;
1625
1626     for (cl = se->clients; cl; cl = cl->next)
1627     {
1628         if (prepare_session_database(se, cl->database) < 0)
1629             return "CONFIG_ERROR";
1630         if (client_parse_query(cl, query) < 0)  // Query must parse for all targets
1631             return "QUERY";
1632     }
1633
1634     for (cl = se->clients; cl; cl = cl->next)
1635     {
1636         client_prep_connection(cl);
1637     }
1638
1639     return 0;
1640 }
1641
1642 // Creates a new session_database object for a database
1643 static void session_init_databases_fun(void *context, struct database *db)
1644 {
1645     struct session *se = (struct session *) context;
1646     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
1647     int num = settings_num();
1648     int i;
1649
1650     new->database = db;
1651     new->yaz_marc = 0;
1652     new->map = 0;
1653     new->settings = nmem_malloc(se->session_nmem, sizeof(struct settings *) * num);
1654     memset(new->settings, 0, sizeof(struct settings*) * num);
1655     if (db->settings)
1656     {
1657         for (i = 0; i < num; i++)
1658             new->settings[i] = db->settings[i];
1659     }
1660     new->next = se->databases;
1661     se->databases = new;
1662 }
1663
1664 // Doesn't free memory associated with sdb -- nmem takes care of that
1665 static void session_database_destroy(struct session_database *sdb)
1666 {
1667     struct database_retrievalmap *m;
1668
1669     for (m = sdb->map; m; m = m->next)
1670         xsltFreeStylesheet(m->stylesheet);
1671     if (sdb->yaz_marc)
1672         yaz_marc_destroy(sdb->yaz_marc);
1673 }
1674
1675 // Initialize session_database list -- this represents this session's view
1676 // of the database list -- subject to modification by the settings ws command
1677 void session_init_databases(struct session *se)
1678 {
1679     se->databases = 0;
1680     grep_databases(se, 0, session_init_databases_fun);
1681 }
1682
1683 // Probably session_init_databases_fun should be refactored instead of
1684 // called here.
1685 static struct session_database *load_session_database(struct session *se, char *id)
1686 {
1687     struct database *db = find_database(id, 0);
1688
1689     session_init_databases_fun((void*) se, db);
1690     // New sdb is head of se->databases list
1691     return se->databases;
1692 }
1693
1694 // Find an existing session database. If not found, load it
1695 static struct session_database *find_session_database(struct session *se, char *id)
1696 {
1697     struct session_database *sdb;
1698
1699     for (sdb = se->databases; sdb; sdb = sdb->next)
1700         if (!strcmp(sdb->database->url, id))
1701             return sdb;
1702     return load_session_database(se, id);
1703 }
1704
1705 // Apply a session override to a database
1706 void session_apply_setting(struct session *se, char *dbname, char *setting, char *value)
1707 {
1708     struct session_database *sdb = find_session_database(se, dbname);
1709     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
1710     int offset = settings_offset(setting);
1711
1712     if (offset < 0)
1713     {
1714         yaz_log(YLOG_WARN, "Unknown setting %s", setting);
1715         return;
1716     }
1717     new->precedence = 0;
1718     new->target = dbname;
1719     new->name = setting;
1720     new->value = value;
1721     new->next = sdb->settings[offset];
1722     sdb->settings[offset] = new;
1723
1724     // Force later recompute of settings-driven data structures
1725     // (happens when a search starts and client connections are prepared)
1726     switch (offset)
1727     {
1728         case PZ_NATIVESYNTAX:
1729             if (sdb->yaz_marc)
1730             {
1731                 yaz_marc_destroy(sdb->yaz_marc);
1732                 sdb->yaz_marc = 0;
1733             }
1734             break;
1735         case PZ_XSLT:
1736             if (sdb->map)
1737             {
1738                 struct database_retrievalmap *m;
1739                 // We don't worry about the map structure -- it's in nmem
1740                 for (m = sdb->map; m; m = m->next)
1741                     xsltFreeStylesheet(m->stylesheet);
1742                 sdb->map = 0;
1743             }
1744             break;
1745     }
1746 }
1747
1748 void destroy_session(struct session *s)
1749 {
1750     struct session_database *sdb;
1751
1752     yaz_log(YLOG_LOG, "Destroying session");
1753     while (s->clients)
1754         client_destroy(s->clients);
1755     for (sdb = s->databases; sdb; sdb = sdb->next)
1756         session_database_destroy(sdb);
1757     nmem_destroy(s->nmem);
1758     wrbuf_destroy(s->wrbuf);
1759 }
1760
1761 struct session *new_session(NMEM nmem)
1762 {
1763     int i;
1764     struct session *session = nmem_malloc(nmem, sizeof(*session));
1765
1766     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
1767
1768     session->total_hits = 0;
1769     session->total_records = 0;
1770     session->num_termlists = 0;
1771     session->reclist = 0;
1772     session->requestid = -1;
1773     session->clients = 0;
1774     session->expected_maxrecs = 0;
1775     session->session_nmem = nmem;
1776     session->nmem = nmem_create();
1777     session->wrbuf = wrbuf_alloc();
1778     session_init_databases(session);
1779     for (i = 0; i <= SESSION_WATCH_MAX; i++)
1780     {
1781         session->watchlist[i].data = 0;
1782         session->watchlist[i].fun = 0;
1783     }
1784
1785     return session;
1786 }
1787
1788 struct hitsbytarget *hitsbytarget(struct session *se, int *count)
1789 {
1790     static struct hitsbytarget res[1000]; // FIXME MM
1791     struct client *cl;
1792
1793     *count = 0;
1794     for (cl = se->clients; cl; cl = cl->next)
1795     {
1796         char *name = session_setting_oneval(cl->database, PZ_NAME);
1797
1798         res[*count].id = cl->database->database->url;
1799         res[*count].name = *name ? name : "Unknown";
1800         res[*count].hits = cl->hits;
1801         res[*count].records = cl->records;
1802         res[*count].diagnostic = cl->diagnostic;
1803         res[*count].state = client_states[cl->state];
1804         res[*count].connected  = cl->connection ? 1 : 0;
1805         (*count)++;
1806     }
1807
1808     return res;
1809 }
1810
1811 struct termlist_score **termlist(struct session *s, const char *name, int *num)
1812 {
1813     int i;
1814
1815     for (i = 0; i < s->num_termlists; i++)
1816         if (!strcmp((const char *) s->termlists[i].name, name))
1817             return termlist_highscore(s->termlists[i].termlist, num);
1818     return 0;
1819 }
1820
1821 #ifdef MISSING_HEADERS
1822 void report_nmem_stats(void)
1823 {
1824     size_t in_use, is_free;
1825
1826     nmem_get_memory_in_use(&in_use);
1827     nmem_get_memory_free(&is_free);
1828
1829     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1830             (long) in_use, (long) is_free);
1831 }
1832 #endif
1833
1834 struct record_cluster *show_single(struct session *s, int id)
1835 {
1836     struct record_cluster *r;
1837
1838     reclist_rewind(s->reclist);
1839     while ((r = reclist_read_record(s->reclist)))
1840         if (r->recid == id)
1841             return r;
1842     return 0;
1843 }
1844
1845 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp, int start,
1846         int *num, int *total, int *sumhits, NMEM nmem_show)
1847 {
1848     struct record_cluster **recs = nmem_malloc(nmem_show, *num
1849                                        * sizeof(struct record_cluster *));
1850     struct reclist_sortparms *spp;
1851     int i;
1852 #if USE_TIMING
1853     yaz_timing_t t = yaz_timing_create();
1854 #endif
1855
1856     for (spp = sp; spp; spp = spp->next)
1857         if (spp->type == Metadata_sortkey_relevance)
1858         {
1859             relevance_prepare_read(s->relevance, s->reclist);
1860             break;
1861         }
1862     reclist_sort(s->reclist, sp);
1863
1864     *total = s->reclist->num_records;
1865     *sumhits = s->total_hits;
1866
1867     for (i = 0; i < start; i++)
1868         if (!reclist_read_record(s->reclist))
1869         {
1870             *num = 0;
1871             recs = 0;
1872             break;
1873         }
1874
1875     for (i = 0; i < *num; i++)
1876     {
1877         struct record_cluster *r = reclist_read_record(s->reclist);
1878         if (!r)
1879         {
1880             *num = i;
1881             break;
1882         }
1883         recs[i] = r;
1884     }
1885 #if USE_TIMING
1886     yaz_timing_stop(t);
1887     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1888             yaz_timing_get_real(t), yaz_timing_get_user(t),
1889             yaz_timing_get_sys(t));
1890     yaz_timing_destroy(&t);
1891 #endif
1892     return recs;
1893 }
1894
1895 void statistics(struct session *se, struct statistics *stat)
1896 {
1897     struct client *cl;
1898     int count = 0;
1899
1900     memset(stat, 0, sizeof(*stat));
1901     for (cl = se->clients; cl; cl = cl->next)
1902     {
1903         if (!cl->connection)
1904             stat->num_no_connection++;
1905         switch (cl->state)
1906         {
1907             case Client_Connecting: stat->num_connecting++; break;
1908             case Client_Initializing: stat->num_initializing++; break;
1909             case Client_Searching: stat->num_searching++; break;
1910             case Client_Presenting: stat->num_presenting++; break;
1911             case Client_Idle: stat->num_idle++; break;
1912             case Client_Failed: stat->num_failed++; break;
1913             case Client_Error: stat->num_error++; break;
1914             default: break;
1915         }
1916         count++;
1917     }
1918     stat->num_hits = se->total_hits;
1919     stat->num_records = se->total_records;
1920
1921     stat->num_clients = count;
1922 }
1923
1924 void start_http_listener(void)
1925 {
1926     char hp[128] = "";
1927     struct conf_server *ser = global_parameters.server;
1928
1929     if (*global_parameters.listener_override)
1930         strcpy(hp, global_parameters.listener_override);
1931     else
1932     {
1933         strcpy(hp, ser->host ? ser->host : "");
1934         if (ser->port)
1935         {
1936             if (*hp)
1937                 strcat(hp, ":");
1938             sprintf(hp + strlen(hp), "%d", ser->port);
1939         }
1940     }
1941     http_init(hp);
1942 }
1943
1944 void start_proxy(void)
1945 {
1946     char hp[128] = "";
1947     struct conf_server *ser = global_parameters.server;
1948
1949     if (*global_parameters.proxy_override)
1950         strcpy(hp, global_parameters.proxy_override);
1951     else if (ser->proxy_host || ser->proxy_port)
1952     {
1953         strcpy(hp, ser->proxy_host ? ser->proxy_host : "");
1954         if (ser->proxy_port)
1955         {
1956             if (*hp)
1957                 strcat(hp, ":");
1958             sprintf(hp + strlen(hp), "%d", ser->proxy_port);
1959         }
1960     }
1961     else
1962         return;
1963
1964     http_set_proxyaddr(hp, ser->myurl ? ser->myurl : "");
1965 }
1966
1967 void start_zproxy(void)
1968 {
1969     struct conf_server *ser = global_parameters.server;
1970
1971     if (*global_parameters.zproxy_override){
1972         yaz_log(YLOG_LOG, "Z39.50 proxy  %s",
1973                 global_parameters.zproxy_override);
1974         return;
1975     }
1976
1977     else if (ser->zproxy_host || ser->zproxy_port)
1978     {
1979         char hp[128] = "";
1980
1981         strcpy(hp, ser->zproxy_host ? ser->zproxy_host : "");
1982         if (ser->zproxy_port)
1983         {
1984             if (*hp)
1985                 strcat(hp, ":");
1986             else
1987                 strcat(hp, "@:");
1988
1989             sprintf(hp + strlen(hp), "%d", ser->zproxy_port);
1990         }
1991         strcpy(global_parameters.zproxy_override, hp);
1992         yaz_log(YLOG_LOG, "Z39.50 proxy  %s",
1993                 global_parameters.zproxy_override);
1994
1995     }
1996     else
1997         return;
1998 }
1999
2000 // Master list of connections we're handling events to
2001 static IOCHAN channel_list = 0;
2002 void pazpar2_add_channel(IOCHAN chan)
2003 {
2004     chan->next = channel_list;
2005     channel_list = chan;
2006 }
2007
2008 void pazpar2_event_loop()
2009 {
2010     event_loop(&channel_list);
2011 }
2012
2013 /*
2014  * Local variables:
2015  * c-basic-offset: 4
2016  * indent-tabs-mode: nil
2017  * End:
2018  * vim: shiftwidth=4 tabstop=8 expandtab
2019  */