src/logic.c

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