src/logic.c

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