src/logic.c

   1 /* $Id: logic.c,v 1.68 2007-10-02 10:08:39 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 /** \file logic.c
  23     \brief high-level logic; mostly user sessions and settings
  24 */
  25
  26 #include <stdlib.h>
  27 #include <stdio.h>
  28 #include <string.h>
  29 #include <sys/time.h>
  30 #include <unistd.h>
  31 #include <sys/socket.h>
  32 #include <netdb.h>
  33 #include <signal.h>
  34 #include <ctype.h>
  35 #include <assert.h>
  36
  37 #include <yaz/marcdisp.h>
  38 #include <yaz/comstack.h>
  39 #include <yaz/tcpip.h>
  40 #include <yaz/proto.h>
  41 #include <yaz/readconf.h>
  42 #include <yaz/pquery.h>
  43 #include <yaz/otherinfo.h>
  44 #include <yaz/yaz-util.h>
  45 #include <yaz/nmem.h>
  46 #include <yaz/query-charset.h>
  47 #include <yaz/querytowrbuf.h>
  48 #include <yaz/oid_db.h>
  49 #include <yaz/snprintf.h>
  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 "client.h"
  71 #include "settings.h"
  72 #include "normalize7bit.h"
  73
  74 #define TERMLIST_HIGH_SCORE 25
  75
  76 #define MAX_CHUNK 15
  77
  78 // Note: Some things in this structure will eventually move to configuration
  79 struct parameters global_parameters =
  80 {
  81     "",
  82     "",
  83     "",
  84     0,
  85     0,   // dump_records
  86     0,   // debug_mode
  87     30,  // operations timeout
  88     "81",
  89     "Index Data PazPar2",
  90     VERSION,
  91     60,   // session timeout
  92     100,
  93     MAX_CHUNK,
  94     0,
  95     0,
  96     180, // Z39.50 session timeout
  97     15   // Connect timeout
  98 };
  99
 100 // Recursively traverse query structure to extract terms.
 101 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
 102 {
 103     char **words;
 104     int numwords;
 105     int i;
 106
 107     switch (n->kind)
 108     {
 109     case CCL_RPN_AND:
 110     case CCL_RPN_OR:
 111     case CCL_RPN_NOT:
 112     case CCL_RPN_PROX:
 113         pull_terms(nmem, n->u.p[0], termlist, num);
 114         pull_terms(nmem, n->u.p[1], termlist, num);
 115         break;
 116     case CCL_RPN_TERM:
 117         nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
 118         for (i = 0; i < numwords; i++)
 119             termlist[(*num)++] = words[i];
 120         break;
 121     default: // NOOP
 122         break;
 123     }
 124 }
 125
 126
 127
 128 static void add_facet(struct session *s, const char *type, const char *value)
 129 {
 130     int i;
 131
 132     if (!*value)
 133         return;
 134     for (i = 0; i < s->num_termlists; i++)
 135         if (!strcmp(s->termlists[i].name, type))
 136             break;
 137     if (i == s->num_termlists)
 138     {
 139         if (i == SESSION_MAX_TERMLISTS)
 140         {
 141             yaz_log(YLOG_FATAL, "Too many termlists");
 142             return;
 143         }
 144
 145         s->termlists[i].name = nmem_strdup(s->nmem, type);
 146         s->termlists[i].termlist
 147             = termlist_create(s->nmem, s->expected_maxrecs,
 148                               TERMLIST_HIGH_SCORE);
 149         s->num_termlists = i + 1;
 150     }
 151     termlist_insert(s->termlists[i].termlist, value);
 152 }
 153
 154 xmlDoc *record_to_xml(struct session_database *sdb, Z_External *rec)
 155 {
 156     struct database *db = sdb->database;
 157     xmlDoc *rdoc = 0;
 158     const Odr_oid *oid = rec->direct_reference;
 159
 160     /* convert response record to XML somehow */
 161     if (rec->which == Z_External_octet && oid
 162         && !oid_oidcmp(oid, yaz_oid_recsyn_xml))
 163     {
 164         /* xml already */
 165         rdoc = xmlParseMemory((char*) rec->u.octet_aligned->buf,
 166                               rec->u.octet_aligned->len);
 167         if (!rdoc)
 168         {
 169             yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s",
 170                     db->url);
 171             return 0;
 172         }
 173     }
 174     else if (rec->which == Z_External_OPAC)
 175     {
 176         if (!sdb->yaz_marc)
 177         {
 178             yaz_log(YLOG_WARN, "MARC decoding not configured");
 179             return 0;
 180         }
 181         else
 182         {
 183             /* OPAC gets converted to XML too */
 184             WRBUF wrbuf_opac = wrbuf_alloc();
 185             /* MARCXML inside the OPAC XML. Charset is in effect because we
 186                use the yaz_marc handle */
 187             yaz_marc_xml(sdb->yaz_marc, YAZ_MARC_MARCXML);
 188             yaz_opac_decode_wrbuf(sdb->yaz_marc, rec->u.opac, wrbuf_opac);
 189
 190             rdoc = xmlParseMemory((char*) wrbuf_buf(wrbuf_opac),
 191                                   wrbuf_len(wrbuf_opac));
 192             if (!rdoc)
 193             {
 194                 yaz_log(YLOG_WARN, "Unable to parse OPAC XML");
 195                 /* Was used to debug bug #1348 */
 196 #if 0
 197                 FILE *f = fopen("/tmp/opac.xml.txt", "wb");
 198                 if (f)
 199                 {
 200                     fwrite(wrbuf_buf(wrbuf_opac), 1, wrbuf_len(wrbuf_opac), f);
 201                     fclose(f);
 202                 }
 203 #endif
 204             }
 205             wrbuf_destroy(wrbuf_opac);
 206         }
 207     }
 208     else if (oid && yaz_oid_is_iso2709(oid))
 209     {
 210         /* ISO2709 gets converted to MARCXML */
 211         if (!sdb->yaz_marc)
 212         {
 213             yaz_log(YLOG_WARN, "MARC decoding not configured");
 214             return 0;
 215         }
 216         else
 217         {
 218             xmlNode *res;
 219             char *buf;
 220             int len;
 221
 222             if (rec->which != Z_External_octet)
 223             {
 224                 yaz_log(YLOG_WARN, "Unexpected external branch, probably BER %s",
 225                         db->url);
 226                 return 0;
 227             }
 228             buf = (char*) rec->u.octet_aligned->buf;
 229             len = rec->u.octet_aligned->len;
 230             if (yaz_marc_read_iso2709(sdb->yaz_marc, buf, len) < 0)
 231             {
 232                 yaz_log(YLOG_WARN, "Failed to decode MARC %s", db->url);
 233                 return 0;
 234             }
 235
 236             if (yaz_marc_write_xml(sdb->yaz_marc, &res,
 237                                    "http://www.loc.gov/MARC21/slim", 0, 0) < 0)
 238             {
 239                 yaz_log(YLOG_WARN, "Failed to encode as XML %s",
 240                         db->url);
 241                 return 0;
 242             }
 243             rdoc = xmlNewDoc((xmlChar *) "1.0");
 244             xmlDocSetRootElement(rdoc, res);
 245         }
 246     }
 247     else
 248     {
 249         char oid_name_buf[OID_STR_MAX];
 250         const char *oid_name = yaz_oid_to_string_buf(oid, 0, oid_name_buf);
 251         yaz_log(YLOG_FATAL,
 252                 "Unable to handle record of type %s from %s",
 253                 oid_name, db->url);
 254         return 0;
 255     }
 256
 257     if (global_parameters.dump_records)
 258     {
 259         FILE *lf = yaz_log_file();
 260         if (lf)
 261         {
 262             yaz_log(YLOG_LOG, "Un-normalized record from %s", db->url);
 263 #if LIBXML_VERSION >= 20600
 264             xmlDocFormatDump(lf, rdoc, 1);
 265 #else
 266             xmlDocDump(lf, rdoc);
 267 #endif
 268             fprintf(lf, "\n");
 269         }
 270     }
 271     return rdoc;
 272 }
 273
 274 #define MAX_XSLT_ARGS 16
 275
 276 // Add static values from session database settings if applicable
 277 static void insert_settings_parameters(struct session_database *sdb,
 278                                        struct session *se, char **parms)
 279 {
 280     struct conf_service *service = global_parameters.server->service;
 281     int i;
 282     int nparms = 0;
 283     int offset = 0;
 284
 285     for (i = 0; i < service->num_metadata; i++)
 286     {
 287         struct conf_metadata *md = &service->metadata[i];
 288         int setting;
 289
 290         if (md->setting == Metadata_setting_parameter &&
 291             (setting = settings_offset(md->name)) > 0)
 292         {
 293             const char *val = session_setting_oneval(sdb, setting);
 294             if (val && nparms < MAX_XSLT_ARGS)
 295             {
 296                 char *buf;
 297                 int len = strlen(val);
 298                 buf = nmem_malloc(se->nmem, len + 3);
 299                 buf[0] = '\'';
 300                 strcpy(buf + 1, val);
 301                 buf[len+1] = '\'';
 302                 buf[len+2] = '\0';
 303                 parms[offset++] = md->name;
 304                 parms[offset++] = buf;
 305                 nparms++;
 306             }
 307         }
 308     }
 309     parms[offset] = 0;
 310 }
 311
 312 // Add static values from session database settings if applicable
 313 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc)
 314 {
 315     struct conf_service *service = global_parameters.server->service;
 316     int i;
 317
 318     for (i = 0; i < service->num_metadata; i++)
 319     {
 320         struct conf_metadata *md = &service->metadata[i];
 321         int offset;
 322
 323         if (md->setting == Metadata_setting_postproc &&
 324             (offset = settings_offset(md->name)) > 0)
 325         {
 326             const char *val = session_setting_oneval(sdb, offset);
 327             if (val)
 328             {
 329                 xmlNode *r = xmlDocGetRootElement(doc);
 330                 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
 331                                              (xmlChar *) val);
 332                 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
 333             }
 334         }
 335     }
 336 }
 337
 338 xmlDoc *normalize_record(struct session_database *sdb, struct session *se,
 339                          Z_External *rec)
 340 {
 341     struct database_retrievalmap *m;
 342     xmlDoc *rdoc = record_to_xml(sdb, rec);
 343     if (rdoc)
 344     {
 345         for (m = sdb->map; m; m = m->next)
 346         {
 347             xmlDoc *new = 0;
 348
 349             {
 350                 xmlNodePtr root = 0;
 351                 char *parms[MAX_XSLT_ARGS*2+1];
 352
 353                 insert_settings_parameters(sdb, se, parms);
 354
 355                 new = xsltApplyStylesheet(m->stylesheet, rdoc, (const char **) parms);
 356                 root= xmlDocGetRootElement(new);
 357                 if (!new || !root || !(root->children))
 358                 {
 359                     yaz_log(YLOG_WARN, "XSLT transformation failed from %s",
 360                             sdb->database->url);
 361                     xmlFreeDoc(new);
 362                     xmlFreeDoc(rdoc);
 363                     return 0;
 364                 }
 365             }
 366
 367             xmlFreeDoc(rdoc);
 368             rdoc = new;
 369         }
 370
 371         insert_settings_values(sdb, rdoc);
 372
 373         if (global_parameters.dump_records)
 374         {
 375             FILE *lf = yaz_log_file();
 376
 377             if (lf)
 378             {
 379                 yaz_log(YLOG_LOG, "Normalized record from %s",
 380                         sdb->database->url);
 381 #if LIBXML_VERSION >= 20600
 382                 xmlDocFormatDump(lf, rdoc, 1);
 383 #else
 384                 xmlDocDump(lf, rdoc);
 385 #endif
 386                 fprintf(lf, "\n");
 387             }
 388         }
 389     }
 390     return rdoc;
 391 }
 392
 393 // Retrieve first defined value for 'name' for given database.
 394 // Will be extended to take into account user associated with session
 395 const char *session_setting_oneval(struct session_database *db, int offset)
 396 {
 397     if (!db->settings[offset])
 398         return "";
 399     return db->settings[offset]->value;
 400 }
 401
 402
 403
 404 // Initialize YAZ Map structures for MARC-based targets
 405 static int prepare_yazmarc(struct session_database *sdb)
 406 {
 407     const char *s;
 408
 409     if (!sdb->settings)
 410     {
 411         yaz_log(YLOG_WARN, "No settings for %s", sdb->database->url);
 412         return -1;
 413     }
 414     if ((s = session_setting_oneval(sdb, PZ_NATIVESYNTAX))
 415         && !strncmp(s, "iso2709", 7))
 416     {
 417         char *encoding = "marc-8s", *e;
 418         yaz_iconv_t cm;
 419
 420         // See if a native encoding is specified
 421         if ((e = strchr(s, ';')))
 422             encoding = e + 1;
 423
 424         sdb->yaz_marc = yaz_marc_create();
 425         yaz_marc_subfield_str(sdb->yaz_marc, "\t");
 426
 427         cm = yaz_iconv_open("utf-8", encoding);
 428         if (!cm)
 429         {
 430             yaz_log(YLOG_FATAL,
 431                     "Unable to map from %s to UTF-8 for target %s",
 432                     encoding, sdb->database->url);
 433             return -1;
 434         }
 435         yaz_marc_iconv(sdb->yaz_marc, cm);
 436     }
 437     return 0;
 438 }
 439
 440 // Prepare XSLT stylesheets for record normalization
 441 // Structures are allocated on the session_wide nmem to avoid having
 442 // to recompute this for every search. This would lead
 443 // to leaking if a single session was to repeatedly change the PZ_XSLT
 444 // setting. However, this is not a realistic use scenario.
 445 static int prepare_map(struct session *se, struct session_database *sdb)
 446 {
 447     const char *s;
 448
 449     if (!sdb->settings)
 450     {
 451         yaz_log(YLOG_WARN, "No settings on %s", sdb->database->url);
 452         return -1;
 453     }
 454     if ((s = session_setting_oneval(sdb, PZ_XSLT)))
 455     {
 456         char **stylesheets;
 457         struct database_retrievalmap **m = &sdb->map;
 458         int num, i;
 459         char auto_stylesheet[256];
 460
 461         if (!strcmp(s, "auto"))
 462         {
 463             const char *request_syntax = session_setting_oneval(
 464                 sdb, PZ_REQUESTSYNTAX);
 465             if (request_syntax)
 466             {
 467                 char *cp;
 468                 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
 469                              "%s.xsl", request_syntax);
 470                 for (cp = auto_stylesheet; *cp; cp++)
 471                 {
 472                     /* deliberately only consider ASCII */
 473                     if (*cp > 32 && *cp < 127)
 474                         *cp = tolower(*cp);
 475                 }
 476                 s = auto_stylesheet;
 477             }
 478             else
 479             {
 480                 yaz_log(YLOG_WARN, "No pz:requestsyntax for auto stylesheet");
 481             }
 482         }
 483         nmem_strsplit(se->session_nmem, ",", s, &stylesheets, &num);
 484         for (i = 0; i < num; i++)
 485         {
 486             (*m) = nmem_malloc(se->session_nmem, sizeof(**m));
 487             (*m)->next = 0;
 488             if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i])))
 489             {
 490                 yaz_log(YLOG_FATAL|YLOG_ERRNO, "Unable to load stylesheet: %s",
 491                         stylesheets[i]);
 492                 return -1;
 493             }
 494             m = &(*m)->next;
 495         }
 496     }
 497     if (!sdb->map)
 498         yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s",
 499                 sdb->database->url);
 500     return 0;
 501 }
 502
 503 // This analyzes settings and recomputes any supporting data structures
 504 // if necessary.
 505 static int prepare_session_database(struct session *se,
 506                                     struct session_database *sdb)
 507 {
 508     if (!sdb->settings)
 509     {
 510         yaz_log(YLOG_WARN,
 511                 "No settings associated with %s", sdb->database->url);
 512         return -1;
 513     }
 514     if (sdb->settings[PZ_NATIVESYNTAX] && !sdb->yaz_marc)
 515     {
 516         if (prepare_yazmarc(sdb) < 0)
 517             return -1;
 518     }
 519     if (sdb->settings[PZ_XSLT] && !sdb->map)
 520     {
 521         if (prepare_map(se, sdb) < 0)
 522             return -1;
 523     }
 524     return 0;
 525 }
 526
 527 // called if watch should be removed because http_channel is to be destroyed
 528 static void session_watch_cancel(void *data, struct http_channel *c)
 529 {
 530     struct session_watchentry *ent = data;
 531
 532     ent->fun = 0;
 533     ent->data = 0;
 534     ent->obs = 0;
 535 }
 536
 537 // set watch. Returns 0=OK, -1 if watch is already set
 538 int session_set_watch(struct session *s, int what,
 539                       session_watchfun fun, void *data,
 540                       struct http_channel *chan)
 541 {
 542     if (s->watchlist[what].fun)
 543         return -1;
 544     s->watchlist[what].fun = fun;
 545     s->watchlist[what].data = data;
 546     s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
 547                                                session_watch_cancel);
 548     return 0;
 549 }
 550
 551 void session_alert_watch(struct session *s, int what)
 552 {
 553     if (s->watchlist[what].fun)
 554     {
 555         /* our watch is no longer associated with http_channel */
 556         http_remove_observer(s->watchlist[what].obs);
 557         session_watchfun fun = s->watchlist[what].fun;
 558         void *data = s->watchlist[what].data;
 559
 560         /* reset watch before fun is invoked - in case fun wants to set
 561            it again */
 562         s->watchlist[what].fun = 0;
 563         s->watchlist[what].data = 0;
 564         s->watchlist[what].obs = 0;
 565
 566         fun(data);
 567     }
 568 }
 569
 570 //callback for grep_databases
 571 static void select_targets_callback(void *context, struct session_database *db)
 572 {
 573     struct session *se = (struct session*) context;
 574     struct client *cl = client_create();
 575     client_set_database(cl, db);
 576     client_set_session(cl, se);
 577 }
 578
 579 // Associates a set of clients with a session;
 580 // Note: Session-databases represent databases with per-session
 581 // setting overrides
 582 int select_targets(struct session *se, struct database_criterion *crit)
 583 {
 584     while (se->clients)
 585         client_destroy(se->clients);
 586
 587     return session_grep_databases(se, crit, select_targets_callback);
 588 }
 589
 590 int session_active_clients(struct session *s)
 591 {
 592     struct client *c;
 593     int res = 0;
 594
 595     for (c = s->clients; c; c = client_next_in_session(c))
 596         if (client_is_active(c))
 597             res++;
 598
 599     return res;
 600 }
 601
 602 // parses crit1=val1,crit2=val2|val3,...
 603 static struct database_criterion *parse_filter(NMEM m, const char *buf)
 604 {
 605     struct database_criterion *res = 0;
 606     char **values;
 607     int num;
 608     int i;
 609
 610     if (!buf || !*buf)
 611         return 0;
 612     nmem_strsplit(m, ",", buf,  &values, &num);
 613     for (i = 0; i < num; i++)
 614     {
 615         char **subvalues;
 616         int subnum;
 617         int subi;
 618         struct database_criterion *new = nmem_malloc(m, sizeof(*new));
 619         char *eq = strchr(values[i], '=');
 620         if (!eq)
 621         {
 622             yaz_log(YLOG_WARN, "Missing equal-sign in filter");
 623             return 0;
 624         }
 625         *(eq++) = '\0';
 626         new->name = values[i];
 627         nmem_strsplit(m, "|", eq, &subvalues, &subnum);
 628         new->values = 0;
 629         for (subi = 0; subi < subnum; subi++)
 630         {
 631             struct database_criterion_value *newv
 632                 = nmem_malloc(m, sizeof(*newv));
 633             newv->value = subvalues[subi];
 634             newv->next = new->values;
 635             new->values = newv;
 636         }
 637         new->next = res;
 638         res = new;
 639     }
 640     return res;
 641 }
 642
 643 enum pazpar2_error_code search(struct session *se,
 644                                char *query, char *filter,
 645                                const char **addinfo)
 646 {
 647     int live_channels = 0;
 648     int no_working = 0;
 649     int no_failed = 0;
 650     struct client *cl;
 651     struct database_criterion *criteria;
 652
 653     yaz_log(YLOG_DEBUG, "Search");
 654
 655     *addinfo = 0;
 656     nmem_reset(se->nmem);
 657     se->relevance = 0;
 658     se->total_records = se->total_hits = se->total_merged = 0;
 659     se->reclist = 0;
 660     se->num_termlists = 0;
 661     criteria = parse_filter(se->nmem, filter);
 662     se->requestid++;
 663     live_channels = select_targets(se, criteria);
 664     if (live_channels)
 665     {
 666         int maxrecs = live_channels * global_parameters.toget;
 667         se->reclist = reclist_create(se->nmem, maxrecs);
 668         se->expected_maxrecs = maxrecs;
 669     }
 670     else
 671         return PAZPAR2_NO_TARGETS;
 672
 673     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 674     {
 675         if (prepare_session_database(se, client_get_database(cl)) < 0)
 676         {
 677             *addinfo = client_get_database(cl)->database->url;
 678             return PAZPAR2_CONFIG_TARGET;
 679         }
 680         // Parse query for target
 681         if (client_parse_query(cl, query) < 0)
 682             no_failed++;
 683         else
 684         {
 685             no_working++;
 686             client_prep_connection(cl);
 687         }
 688     }
 689
 690     // If no queries could be mapped, we signal an error
 691     if (no_working == 0)
 692     {
 693         *addinfo = "query";
 694         return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 695     }
 696     return PAZPAR2_NO_ERROR;
 697 }
 698
 699 // Creates a new session_database object for a database
 700 static void session_init_databases_fun(void *context, struct database *db)
 701 {
 702     struct session *se = (struct session *) context;
 703     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 704     int num = settings_num();
 705     int i;
 706
 707     new->database = db;
 708     new->yaz_marc = 0;
 709
 710     new->map = 0;
 711     new->settings
 712         = nmem_malloc(se->session_nmem, sizeof(struct settings *) * num);
 713     memset(new->settings, 0, sizeof(struct settings*) * num);
 714
 715     if (db->settings)
 716     {
 717         for (i = 0; i < num; i++)
 718             new->settings[i] = db->settings[i];
 719     }
 720     new->next = se->databases;
 721     se->databases = new;
 722 }
 723
 724 // Doesn't free memory associated with sdb -- nmem takes care of that
 725 static void session_database_destroy(struct session_database *sdb)
 726 {
 727     struct database_retrievalmap *m;
 728
 729     for (m = sdb->map; m; m = m->next)
 730         xsltFreeStylesheet(m->stylesheet);
 731     if (sdb->yaz_marc)
 732         yaz_marc_destroy(sdb->yaz_marc);
 733 }
 734
 735 // Initialize session_database list -- this represents this session's view
 736 // of the database list -- subject to modification by the settings ws command
 737 void session_init_databases(struct session *se)
 738 {
 739     se->databases = 0;
 740     predef_grep_databases(se, 0, session_init_databases_fun);
 741 }
 742
 743 // Probably session_init_databases_fun should be refactored instead of
 744 // called here.
 745 static struct session_database *load_session_database(struct session *se,
 746                                                       char *id)
 747 {
 748     struct database *db = find_database(id, 0);
 749
 750     session_init_databases_fun((void*) se, db);
 751     // New sdb is head of se->databases list
 752     return se->databases;
 753 }
 754
 755 // Find an existing session database. If not found, load it
 756 static struct session_database *find_session_database(struct session *se,
 757                                                       char *id)
 758 {
 759     struct session_database *sdb;
 760
 761     for (sdb = se->databases; sdb; sdb = sdb->next)
 762         if (!strcmp(sdb->database->url, id))
 763             return sdb;
 764     return load_session_database(se, id);
 765 }
 766
 767 // Apply a session override to a database
 768 void session_apply_setting(struct session *se, char *dbname, char *setting,
 769                            char *value)
 770 {
 771     struct session_database *sdb = find_session_database(se, dbname);
 772     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 773     int offset = settings_offset_cprefix(setting);
 774
 775     if (offset < 0)
 776     {
 777         yaz_log(YLOG_WARN, "Unknown setting %s", setting);
 778         return;
 779     }
 780     // Jakub: This breaks the filter setting.
 781     /*if (offset == PZ_ID)
 782       {
 783       yaz_log(YLOG_WARN, "No need to set pz:id setting. Ignoring");
 784       return;
 785       }*/
 786     new->precedence = 0;
 787     new->target = dbname;
 788     new->name = setting;
 789     new->value = value;
 790     new->next = sdb->settings[offset];
 791     sdb->settings[offset] = new;
 792
 793     // Force later recompute of settings-driven data structures
 794     // (happens when a search starts and client connections are prepared)
 795     switch (offset)
 796     {
 797     case PZ_NATIVESYNTAX:
 798         if (sdb->yaz_marc)
 799         {
 800             yaz_marc_destroy(sdb->yaz_marc);
 801             sdb->yaz_marc = 0;
 802         }
 803         break;
 804     case PZ_XSLT:
 805         if (sdb->map)
 806         {
 807             struct database_retrievalmap *m;
 808             // We don't worry about the map structure -- it's in nmem
 809             for (m = sdb->map; m; m = m->next)
 810                 xsltFreeStylesheet(m->stylesheet);
 811             sdb->map = 0;
 812         }
 813         break;
 814     }
 815 }
 816
 817 void destroy_session(struct session *s)
 818 {
 819     struct session_database *sdb;
 820
 821     while (s->clients)
 822         client_destroy(s->clients);
 823     for (sdb = s->databases; sdb; sdb = sdb->next)
 824         session_database_destroy(sdb);
 825     nmem_destroy(s->nmem);
 826     wrbuf_destroy(s->wrbuf);
 827 }
 828
 829 struct session *new_session(NMEM nmem)
 830 {
 831     int i;
 832     struct session *session = nmem_malloc(nmem, sizeof(*session));
 833
 834     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
 835
 836     session->relevance = 0;
 837     session->total_hits = 0;
 838     session->total_records = 0;
 839     session->num_termlists = 0;
 840     session->reclist = 0;
 841     session->requestid = -1;
 842     session->clients = 0;
 843     session->expected_maxrecs = 0;
 844     session->session_nmem = nmem;
 845     session->nmem = nmem_create();
 846     session->wrbuf = wrbuf_alloc();
 847     session->databases = 0;
 848     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 849     {
 850         session->watchlist[i].data = 0;
 851         session->watchlist[i].fun = 0;
 852     }
 853     return session;
 854 }
 855
 856 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
 857 {
 858     struct hitsbytarget *res = 0;
 859     struct client *cl;
 860     size_t sz = 0;
 861
 862     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 863         sz++;
 864
 865     res = nmem_malloc(nmem, sizeof(*res) * sz);
 866     *count = 0;
 867     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 868     {
 869         const char *name = session_setting_oneval(client_get_database(cl),
 870                                                   PZ_NAME);
 871
 872         res[*count].id = client_get_database(cl)->database->url;
 873         res[*count].name = *name ? name : "Unknown";
 874         res[*count].hits = client_get_hits(cl);
 875         res[*count].records = client_get_num_records(cl);
 876         res[*count].diagnostic = client_get_diagnostic(cl);
 877         res[*count].state = client_get_state_str(cl);
 878         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 879         (*count)++;
 880     }
 881     return res;
 882 }
 883
 884 struct termlist_score **termlist(struct session *s, const char *name, int *num)
 885 {
 886     int i;
 887
 888     for (i = 0; i < s->num_termlists; i++)
 889         if (!strcmp((const char *) s->termlists[i].name, name))
 890             return termlist_highscore(s->termlists[i].termlist, num);
 891     return 0;
 892 }
 893
 894 #ifdef MISSING_HEADERS
 895 void report_nmem_stats(void)
 896 {
 897     size_t in_use, is_free;
 898
 899     nmem_get_memory_in_use(&in_use);
 900     nmem_get_memory_free(&is_free);
 901
 902     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
 903             (long) in_use, (long) is_free);
 904 }
 905 #endif
 906
 907 struct record_cluster *show_single(struct session *s, const char *id)
 908 {
 909     struct record_cluster *r;
 910
 911     reclist_rewind(s->reclist);
 912     while ((r = reclist_read_record(s->reclist)))
 913         if (!strcmp(r->recid, id))
 914             return r;
 915     return 0;
 916 }
 917
 918 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp,
 919                              int start, int *num, int *total, int *sumhits,
 920                              NMEM nmem_show)
 921 {
 922     struct record_cluster **recs = nmem_malloc(nmem_show, *num
 923                                                * sizeof(struct record_cluster *));
 924     struct reclist_sortparms *spp;
 925     int i;
 926 #if USE_TIMING
 927     yaz_timing_t t = yaz_timing_create();
 928 #endif
 929
 930     if (!s->relevance)
 931     {
 932         *num = 0;
 933         *total = 0;
 934         *sumhits = 0;
 935         recs = 0;
 936     }
 937     else
 938     {
 939         for (spp = sp; spp; spp = spp->next)
 940             if (spp->type == Metadata_sortkey_relevance)
 941             {
 942                 relevance_prepare_read(s->relevance, s->reclist);
 943                 break;
 944             }
 945         reclist_sort(s->reclist, sp);
 946
 947         *total = s->reclist->num_records;
 948         *sumhits = s->total_hits;
 949
 950         for (i = 0; i < start; i++)
 951             if (!reclist_read_record(s->reclist))
 952             {
 953                 *num = 0;
 954                 recs = 0;
 955                 break;
 956             }
 957
 958         for (i = 0; i < *num; i++)
 959         {
 960             struct record_cluster *r = reclist_read_record(s->reclist);
 961             if (!r)
 962             {
 963                 *num = i;
 964                 break;
 965             }
 966             recs[i] = r;
 967         }
 968     }
 969 #if USE_TIMING
 970     yaz_timing_stop(t);
 971     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
 972             yaz_timing_get_real(t), yaz_timing_get_user(t),
 973             yaz_timing_get_sys(t));
 974     yaz_timing_destroy(&t);
 975 #endif
 976     return recs;
 977 }
 978
 979 void statistics(struct session *se, struct statistics *stat)
 980 {
 981     struct client *cl;
 982     int count = 0;
 983
 984     memset(stat, 0, sizeof(*stat));
 985     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 986     {
 987         if (!client_get_connection(cl))
 988             stat->num_no_connection++;
 989         switch (client_get_state(cl))
 990         {
 991         case Client_Connecting: stat->num_connecting++; break;
 992         case Client_Initializing: stat->num_initializing++; break;
 993         case Client_Searching: stat->num_searching++; break;
 994         case Client_Presenting: stat->num_presenting++; break;
 995         case Client_Idle: stat->num_idle++; break;
 996         case Client_Failed: stat->num_failed++; break;
 997         case Client_Error: stat->num_error++; break;
 998         default: break;
 999         }
1000         count++;
1001     }
1002     stat->num_hits = se->total_hits;
1003     stat->num_records = se->total_records;
1004
1005     stat->num_clients = count;
1006 }
1007
1008 void start_http_listener(void)
1009 {
1010     char hp[128] = "";
1011     struct conf_server *ser = global_parameters.server;
1012
1013     if (*global_parameters.listener_override)
1014         strcpy(hp, global_parameters.listener_override);
1015     else
1016     {
1017         strcpy(hp, ser->host ? ser->host : "");
1018         if (ser->port)
1019         {
1020             if (*hp)
1021                 strcat(hp, ":");
1022             sprintf(hp + strlen(hp), "%d", ser->port);
1023         }
1024     }
1025     http_init(hp);
1026 }
1027
1028 void start_proxy(void)
1029 {
1030     char hp[128] = "";
1031     struct conf_server *ser = global_parameters.server;
1032
1033     if (*global_parameters.proxy_override)
1034         strcpy(hp, global_parameters.proxy_override);
1035     else if (ser->proxy_host || ser->proxy_port)
1036     {
1037         strcpy(hp, ser->proxy_host ? ser->proxy_host : "");
1038         if (ser->proxy_port)
1039         {
1040             if (*hp)
1041                 strcat(hp, ":");
1042             sprintf(hp + strlen(hp), "%d", ser->proxy_port);
1043         }
1044     }
1045     else
1046         return;
1047
1048     http_set_proxyaddr(hp, ser->myurl ? ser->myurl : "");
1049 }
1050
1051
1052 // Master list of connections we're handling events to
1053 static IOCHAN channel_list = 0;
1054 void pazpar2_add_channel(IOCHAN chan)
1055 {
1056     chan->next = channel_list;
1057     channel_list = chan;
1058 }
1059
1060 void pazpar2_event_loop()
1061 {
1062     event_loop(&channel_list);
1063 }
1064
1065 static struct record_metadata *record_metadata_init(
1066     NMEM nmem, char *value, enum conf_metadata_type type)
1067 {
1068     struct record_metadata *rec_md = record_metadata_create(nmem);
1069     if (type == Metadata_type_generic)
1070     {
1071         char * p = value;
1072         p = normalize7bit_generic(p, " ,/.:([");
1073
1074         rec_md->data.text.disp = nmem_strdup(nmem, p);
1075         rec_md->data.text.sort = 0;
1076     }
1077     else if (type == Metadata_type_year)
1078     {
1079         int first, last;
1080         if (extract7bit_years((char *) value, &first, &last) < 0)
1081             return 0;
1082         rec_md->data.number.min = first;
1083         rec_md->data.number.max = last;
1084     }
1085     else
1086         return 0;
1087     return rec_md;
1088 }
1089
1090 struct record *ingest_record(struct client *cl, Z_External *rec,
1091                              int record_no)
1092 {
1093     xmlDoc *xdoc = normalize_record(client_get_database(cl),
1094                                     client_get_session(cl), rec);
1095     xmlNode *root, *n;
1096     struct record *record;
1097     struct record_cluster *cluster;
1098     struct session *se = client_get_session(cl);
1099     xmlChar *mergekey, *mergekey_norm;
1100     xmlChar *type = 0;
1101     xmlChar *value = 0;
1102     struct conf_service *service = global_parameters.server->service;
1103     const char *norm_str = 0;
1104     pp2_relevance_token_t prt = 0;
1105     WRBUF norm_wr = 0;
1106
1107     if (!xdoc)
1108         return 0;
1109
1110     root = xmlDocGetRootElement(xdoc);
1111     if (!(mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
1112     {
1113         yaz_log(YLOG_WARN, "No mergekey found in record");
1114         xmlFreeDoc(xdoc);
1115         return 0;
1116     }
1117
1118     record = record_create(se->nmem,
1119                            service->num_metadata, service->num_sortkeys, cl,
1120                            record_no);
1121
1122     prt = pp2_relevance_tokenize(
1123         global_parameters.server->mergekey_pct, (const char *) mergekey);
1124
1125
1126     norm_wr = wrbuf_alloc();
1127
1128     while ((norm_str = pp2_relevance_token_next(prt)))
1129     {
1130         if (*norm_str)
1131         {
1132             if (wrbuf_len(norm_wr))
1133                 wrbuf_puts(norm_wr, " ");
1134             wrbuf_puts(norm_wr, norm_str);
1135         }
1136     }
1137
1138     mergekey_norm = (xmlChar *)nmem_strdup(se->nmem, wrbuf_cstr(norm_wr));
1139     wrbuf_destroy(norm_wr);
1140
1141     pp2_relevance_token_destroy(prt);
1142
1143     xmlFree(mergekey);
1144
1145     cluster = reclist_insert(se->reclist,
1146                              global_parameters.server->service,
1147                              record, (char *) mergekey_norm,
1148                              &se->total_merged);
1149     if (global_parameters.dump_records)
1150         yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1151                 client_get_database(cl)->database->url, record_no);
1152     if (!cluster)
1153     {
1154         /* no room for record */
1155         xmlFreeDoc(xdoc);
1156         return 0;
1157     }
1158     relevance_newrec(se->relevance, cluster);
1159
1160
1161      // now parsing XML record and adding data to cluster or record metadata
1162      for (n = root->children; n; n = n->next)
1163      {
1164          if (type)
1165              xmlFree(type);
1166          if (value)
1167              xmlFree(value);
1168          type = value = 0;
1169
1170          if (n->type != XML_ELEMENT_NODE)
1171              continue;
1172          if (!strcmp((const char *) n->name, "metadata"))
1173          {
1174              struct conf_metadata *ser_md = 0;
1175              struct conf_sortkey *ser_sk = 0;
1176              struct record_metadata **wheretoput = 0;
1177              struct record_metadata *rec_md = 0;
1178              int md_field_id = -1;
1179              int sk_field_id = -1;
1180
1181              type = xmlGetProp(n, (xmlChar *) "type");
1182              value = xmlNodeListGetString(xdoc, n->children, 1);
1183
1184              if (!type || !value || !*value)
1185                  continue;
1186
1187              md_field_id
1188                  = conf_service_metadata_field_id(service, (const char *) type);
1189              if (md_field_id < 0)
1190              {
1191                  yaz_log(YLOG_WARN,
1192                          "Ignoring unknown metadata element: %s", type);
1193                  continue;
1194              }
1195
1196              ser_md = &service->metadata[md_field_id];
1197
1198              if (ser_md->sortkey_offset >= 0){
1199                  sk_field_id = ser_md->sortkey_offset;
1200                  ser_sk = &service->sortkeys[sk_field_id];
1201              }
1202
1203              // non-merged metadata
1204              rec_md = record_metadata_init(se->nmem, (char *) value,
1205                                            ser_md->type);
1206              if (!rec_md)
1207              {
1208                  yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
1209                          value, type);
1210                  continue;
1211              }
1212              rec_md->next = record->metadata[md_field_id];
1213              record->metadata[md_field_id] = rec_md;
1214
1215              // merged metadata
1216              rec_md = record_metadata_init(se->nmem, (char *) value,
1217                                            ser_md->type);
1218              wheretoput = &cluster->metadata[md_field_id];
1219
1220              // and polulate with data:
1221              // assign cluster or record based on merge action
1222              if (ser_md->merge == Metadata_merge_unique)
1223              {
1224                  struct record_metadata *mnode;
1225                  for (mnode = *wheretoput; mnode; mnode = mnode->next)
1226                      if (!strcmp((const char *) mnode->data.text.disp,
1227                                  rec_md->data.text.disp))
1228                          break;
1229                  if (!mnode)
1230                  {
1231                      rec_md->next = *wheretoput;
1232                      *wheretoput = rec_md;
1233                  }
1234              }
1235              else if (ser_md->merge == Metadata_merge_longest)
1236              {
1237                  if (!*wheretoput
1238                      || strlen(rec_md->data.text.disp)
1239                      > strlen((*wheretoput)->data.text.disp))
1240                  {
1241                      *wheretoput = rec_md;
1242                      if (ser_sk)
1243                      {
1244                          const char *sort_str = 0;
1245                          int skip_article =
1246                              ser_sk->type == Metadata_sortkey_skiparticle;
1247
1248                          if (!cluster->sortkeys[sk_field_id])
1249                              cluster->sortkeys[sk_field_id] =
1250                                  nmem_malloc(se->nmem,
1251                                              sizeof(union data_types));
1252
1253                          prt = pp2_relevance_tokenize(
1254                              global_parameters.server->sort_pct,
1255                              rec_md->data.text.disp);
1256
1257                          pp2_relevance_token_next(prt);
1258
1259                          sort_str = pp2_get_sort(prt, skip_article);
1260
1261                          cluster->sortkeys[sk_field_id]->text.disp =
1262                              rec_md->data.text.disp;
1263                          cluster->sortkeys[sk_field_id]->text.sort =
1264                              nmem_strdup(se->nmem, sort_str);
1265 #if 0
1266                          yaz_log(YLOG_LOG, "text disp=%s",
1267                                  cluster->sortkeys[sk_field_id]->text.disp);
1268                          yaz_log(YLOG_LOG, "text sort=%s",
1269                                  cluster->sortkeys[sk_field_id]->text.sort);
1270 #endif
1271                          pp2_relevance_token_destroy(prt);
1272                     }
1273                 }
1274             }
1275             else if (ser_md->merge == Metadata_merge_all)
1276             {
1277                 rec_md->next = *wheretoput;
1278                 *wheretoput = rec_md;
1279             }
1280             else if (ser_md->merge == Metadata_merge_range)
1281             {
1282                 if (!*wheretoput)
1283                 {
1284                     *wheretoput = rec_md;
1285                     if (ser_sk)
1286                         cluster->sortkeys[sk_field_id]
1287                             = &rec_md->data;
1288                 }
1289                 else
1290                 {
1291                     int this_min = rec_md->data.number.min;
1292                     int this_max = rec_md->data.number.max;
1293                     if (this_min < (*wheretoput)->data.number.min)
1294                         (*wheretoput)->data.number.min = this_min;
1295                     if (this_max > (*wheretoput)->data.number.max)
1296                         (*wheretoput)->data.number.max = this_max;
1297                 }
1298 #ifdef GAGA
1299                 if (ser_sk)
1300                 {
1301                     union data_types *sdata
1302                         = cluster->sortkeys[sk_field_id];
1303                     yaz_log(YLOG_LOG, "SK range: %d-%d",
1304                             sdata->number.min, sdata->number.max);
1305                 }
1306 #endif
1307             }
1308
1309
1310             // ranking of _all_ fields enabled ...
1311             if (ser_md->rank)
1312                 relevance_countwords(se->relevance, cluster,
1313                                      (char *) value, ser_md->rank);
1314
1315             // construct facets ...
1316             if (ser_md->termlist)
1317             {
1318                 if (ser_md->type == Metadata_type_year)
1319                 {
1320                     char year[64];
1321                     sprintf(year, "%d", rec_md->data.number.max);
1322                     add_facet(se, (char *) type, year);
1323                     if (rec_md->data.number.max != rec_md->data.number.min)
1324                     {
1325                         sprintf(year, "%d", rec_md->data.number.min);
1326                         add_facet(se, (char *) type, year);
1327                     }
1328                 }
1329                 else
1330                     add_facet(se, (char *) type, (char *) value);
1331             }
1332
1333             // cleaning up
1334             xmlFree(type);
1335             xmlFree(value);
1336             type = value = 0;
1337         }
1338         else
1339             yaz_log(YLOG_WARN,
1340                     "Unexpected element %s in internal record", n->name);
1341     }
1342     if (type)
1343         xmlFree(type);
1344     if (value)
1345         xmlFree(value);
1346
1347     xmlFreeDoc(xdoc);
1348
1349     relevance_donerecord(se->relevance, cluster);
1350     se->total_records++;
1351
1352     return record;
1353 }
1354
1355
1356
1357 /*
1358  * Local variables:
1359  * c-basic-offset: 4
1360  * indent-tabs-mode: nil
1361  * End:
1362  * vim: shiftwidth=4 tabstop=8 expandtab
1363  */