src/logic.c

   1 /* $Id: logic.c,v 1.40 2007-06-11 12:08:23 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 #if YAZ_VERSIONL >= 0x020163
  49 #include <yaz/oid_db.h>
  50 #endif
  51
  52 #if HAVE_CONFIG_H
  53 #include "cconfig.h"
  54 #endif
  55
  56 #define USE_TIMING 0
  57 #if USE_TIMING
  58 #include <yaz/timing.h>
  59 #endif
  60
  61 #include <netinet/in.h>
  62
  63 #include "pazpar2.h"
  64 #include "eventl.h"
  65 #include "http.h"
  66 #include "termlists.h"
  67 #include "reclists.h"
  68 #include "relevance.h"
  69 #include "config.h"
  70 #include "database.h"
  71 #include "client.h"
  72 #include "settings.h"
  73 #include "normalize7bit.h"
  74
  75 #define TERMLIST_HIGH_SCORE 25
  76
  77 #define MAX_CHUNK 15
  78
  79 // Note: Some things in this structure will eventually move to configuration
  80 struct parameters global_parameters =
  81 {
  82     "",
  83     "",
  84     "",
  85     0,
  86     0, /* dump_records */
  87     0, /* debug_mode */
  88     30,
  89     "81",
  90     "Index Data PazPar2",
  91     VERSION,
  92     600, // 10 minutes
  93     60,
  94     100,
  95     MAX_CHUNK,
  96     0,
  97     0
  98 };
  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 *normalize_record(struct session_database *sdb, Z_External *rec)
 156 {
 157     struct database_retrievalmap *m;
 158     struct database *db = sdb->database;
 159     xmlDoc *rdoc = 0;
 160     const Odr_oid *oid = rec->direct_reference;
 161
 162     /* convert response record to XML somehow */
 163     if (rec->which == Z_External_octet && oid
 164         && !oid_oidcmp(oid, yaz_oid_recsyn_xml))
 165     {
 166         /* xml already */
 167         rdoc = xmlParseMemory((char*) rec->u.octet_aligned->buf,
 168                               rec->u.octet_aligned->len);
 169         if (!rdoc)
 170         {
 171             yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s",
 172                     db->url);
 173             return 0;
 174         }
 175     }
 176     else if (oid && yaz_oid_is_iso2709(oid))
 177     {
 178         /* ISO2709 gets converted to MARCXML */
 179         if (!sdb->yaz_marc)
 180         {
 181             yaz_log(YLOG_FATAL, "Unable to handle ISO2709 record");
 182             return 0;
 183         }
 184         else
 185         {
 186             xmlNode *res;
 187             char *buf;
 188             int len;
 189
 190             if (rec->which != Z_External_octet)
 191             {
 192                 yaz_log(YLOG_WARN, "Unexpected external branch, probably BER %s",
 193                         db->url);
 194                 return 0;
 195             }
 196             buf = (char*) rec->u.octet_aligned->buf;
 197             len = rec->u.octet_aligned->len;
 198             if (yaz_marc_read_iso2709(sdb->yaz_marc, buf, len) < 0)
 199             {
 200                 yaz_log(YLOG_WARN, "Failed to decode MARC %s", db->url);
 201                 return 0;
 202             }
 203
 204             yaz_marc_write_using_libxml2(sdb->yaz_marc, 1);
 205             if (yaz_marc_write_xml(sdb->yaz_marc, &res,
 206                                    "http://www.loc.gov/MARC21/slim", 0, 0) < 0)
 207             {
 208                 yaz_log(YLOG_WARN, "Failed to encode as XML %s",
 209                         db->url);
 210                 return 0;
 211             }
 212             rdoc = xmlNewDoc((xmlChar *) "1.0");
 213             xmlDocSetRootElement(rdoc, res);
 214         }
 215     }
 216     else
 217     {
 218         char oid_name_buf[OID_STR_MAX];
 219         const char *oid_name = yaz_oid_to_string_buf(oid, 0, oid_name_buf);
 220         yaz_log(YLOG_FATAL,
 221                 "Unable to handle record of type %s from %s",
 222                 oid_name, db->url);
 223         return 0;
 224     }
 225
 226     if (global_parameters.dump_records){
 227         fprintf(stderr,
 228                 "Input Record (normalized) from %s\n----------------\n",
 229                 db->url);
 230 #if LIBXML_VERSION >= 20600
 231         xmlDocFormatDump(stderr, rdoc, 1);
 232 #else
 233         xmlDocDump(stderr, rdoc);
 234 #endif
 235     }
 236
 237     for (m = sdb->map; m; m = m->next){
 238         xmlDoc *new = 0;
 239
 240         {
 241             xmlNodePtr root = 0;
 242             new = xsltApplyStylesheet(m->stylesheet, rdoc, 0);
 243             root= xmlDocGetRootElement(new);
 244         if (!new || !root || !(root->children))
 245         {
 246             yaz_log(YLOG_WARN, "XSLT transformation failed from %s",
 247                     sdb->database->url);
 248             xmlFreeDoc(new);
 249             xmlFreeDoc(rdoc);
 250             return 0;
 251         }
 252         }
 253
 254         xmlFreeDoc(rdoc);
 255         rdoc = new;
 256     }
 257     if (global_parameters.dump_records)
 258     {
 259         fprintf(stderr, "Record from %s\n----------------\n",
 260                 sdb->database->url);
 261 #if LIBXML_VERSION >= 20600
 262         xmlDocFormatDump(stderr, rdoc, 1);
 263 #else
 264         xmlDocDump(stderr, rdoc);
 265 #endif
 266     }
 267     return rdoc;
 268 }
 269
 270 // Retrieve first defined value for 'name' for given database.
 271 // Will be extended to take into account user associated with session
 272 char *session_setting_oneval(struct session_database *db, int offset)
 273 {
 274     if (!db->settings[offset])
 275         return "";
 276     return db->settings[offset]->value;
 277 }
 278
 279
 280
 281 // Initialize YAZ Map structures for MARC-based targets
 282 static int prepare_yazmarc(struct session_database *sdb)
 283 {
 284     char *s;
 285
 286     if (!sdb->settings)
 287     {
 288         yaz_log(YLOG_WARN, "No settings for %s", sdb->database->url);
 289         return -1;
 290     }
 291     if ((s = session_setting_oneval(sdb, PZ_NATIVESYNTAX))
 292         && !strncmp(s, "iso2709", 7))
 293     {
 294         char *encoding = "marc-8s", *e;
 295         yaz_iconv_t cm;
 296
 297         // See if a native encoding is specified
 298         if ((e = strchr(s, ';')))
 299             encoding = e + 1;
 300
 301         sdb->yaz_marc = yaz_marc_create();
 302         yaz_marc_subfield_str(sdb->yaz_marc, "\t");
 303
 304         cm = yaz_iconv_open("utf-8", encoding);
 305         if (!cm)
 306         {
 307             yaz_log(YLOG_FATAL,
 308                     "Unable to map from %s to UTF-8 for target %s",
 309                     encoding, sdb->database->url);
 310             return -1;
 311         }
 312         yaz_marc_iconv(sdb->yaz_marc, cm);
 313     }
 314     return 0;
 315 }
 316
 317 // Prepare XSLT stylesheets for record normalization
 318 // Structures are allocated on the session_wide nmem to avoid having
 319 // to recompute this for every search. This would lead
 320 // to leaking if a single session was to repeatedly change the PZ_XSLT
 321 // setting. However, this is not a realistic use scenario.
 322 static int prepare_map(struct session *se, struct session_database *sdb)
 323 {
 324    char *s;
 325
 326     if (!sdb->settings)
 327     {
 328         yaz_log(YLOG_WARN, "No settings on %s", sdb->database->url);
 329         return -1;
 330     }
 331     if ((s = session_setting_oneval(sdb, PZ_XSLT)))
 332     {
 333         char **stylesheets;
 334         struct database_retrievalmap **m = &sdb->map;
 335         int num, i;
 336
 337         nmem_strsplit(se->session_nmem, ",", s, &stylesheets, &num);
 338         for (i = 0; i < num; i++)
 339         {
 340             (*m) = nmem_malloc(se->session_nmem, sizeof(**m));
 341             (*m)->next = 0;
 342             if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i])))
 343             {
 344                 yaz_log(YLOG_FATAL, "Unable to load stylesheet: %s",
 345                         stylesheets[i]);
 346                 return -1;
 347             }
 348             m = &(*m)->next;
 349         }
 350     }
 351     if (!sdb->map)
 352         yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s",
 353                 sdb->database->url);
 354     return 0;
 355 }
 356
 357 // This analyzes settings and recomputes any supporting data structures
 358 // if necessary.
 359 static int prepare_session_database(struct session *se,
 360                                     struct session_database *sdb)
 361 {
 362     if (!sdb->settings)
 363     {
 364         yaz_log(YLOG_WARN,
 365                 "No settings associated with %s", sdb->database->url);
 366         return -1;
 367     }
 368     if (sdb->settings[PZ_NATIVESYNTAX] && !sdb->yaz_marc)
 369     {
 370         if (prepare_yazmarc(sdb) < 0)
 371             return -1;
 372     }
 373     if (sdb->settings[PZ_XSLT] && !sdb->map)
 374     {
 375         if (prepare_map(se, sdb) < 0)
 376             return -1;
 377     }
 378     return 0;
 379 }
 380
 381
 382 void session_set_watch(struct session *s, int what,
 383                        session_watchfun fun, void *data)
 384 {
 385     s->watchlist[what].fun = fun;
 386     s->watchlist[what].data = data;
 387 }
 388
 389 void session_alert_watch(struct session *s, int what)
 390 {
 391     if (!s->watchlist[what].fun)
 392         return;
 393     (*s->watchlist[what].fun)(s->watchlist[what].data);
 394     s->watchlist[what].fun = 0;
 395     s->watchlist[what].data = 0;
 396 }
 397
 398 //callback for grep_databases
 399 static void select_targets_callback(void *context, struct session_database *db)
 400 {
 401     struct session *se = (struct session*) context;
 402     struct client *cl = client_create();
 403     client_set_database(cl, db);
 404     client_set_session(cl, se);
 405 }
 406
 407 // Associates a set of clients with a session;
 408 // Note: Session-databases represent databases with per-session
 409 // setting overrides
 410 int select_targets(struct session *se, struct database_criterion *crit)
 411 {
 412     while (se->clients)
 413         client_destroy(se->clients);
 414
 415     return session_grep_databases(se, crit, select_targets_callback);
 416 }
 417
 418 int session_active_clients(struct session *s)
 419 {
 420     struct client *c;
 421     int res = 0;
 422
 423     for (c = s->clients; c; c = client_next_in_session(c))
 424         if (client_is_active(c))
 425             res++;
 426
 427     return res;
 428 }
 429
 430 // parses crit1=val1,crit2=val2|val3,...
 431 static struct database_criterion *parse_filter(NMEM m, const char *buf)
 432 {
 433     struct database_criterion *res = 0;
 434     char **values;
 435     int num;
 436     int i;
 437
 438     if (!buf || !*buf)
 439         return 0;
 440     nmem_strsplit(m, ",", buf,  &values, &num);
 441     for (i = 0; i < num; i++)
 442     {
 443         char **subvalues;
 444         int subnum;
 445         int subi;
 446         struct database_criterion *new = nmem_malloc(m, sizeof(*new));
 447         char *eq = strchr(values[i], '=');
 448         if (!eq)
 449         {
 450             yaz_log(YLOG_WARN, "Missing equal-sign in filter");
 451             return 0;
 452         }
 453         *(eq++) = '\0';
 454         new->name = values[i];
 455         nmem_strsplit(m, "|", eq, &subvalues, &subnum);
 456         new->values = 0;
 457         for (subi = 0; subi < subnum; subi++)
 458         {
 459             struct database_criterion_value *newv
 460                 = nmem_malloc(m, sizeof(*newv));
 461             newv->value = subvalues[subi];
 462             newv->next = new->values;
 463             new->values = newv;
 464         }
 465         new->next = res;
 466         res = new;
 467     }
 468     return res;
 469 }
 470
 471 char *search(struct session *se, char *query, char *filter)
 472 {
 473     int live_channels = 0;
 474     struct client *cl;
 475     struct database_criterion *criteria;
 476
 477     yaz_log(YLOG_DEBUG, "Search");
 478
 479     nmem_reset(se->nmem);
 480     criteria = parse_filter(se->nmem, filter);
 481     se->requestid++;
 482     live_channels = select_targets(se, criteria);
 483     if (live_channels)
 484     {
 485         int maxrecs = live_channels * global_parameters.toget;
 486         se->num_termlists = 0;
 487         se->reclist = reclist_create(se->nmem, maxrecs);
 488         // This will be initialized in send_search()
 489         se->total_records = se->total_hits = se->total_merged = 0;
 490         se->expected_maxrecs = maxrecs;
 491     }
 492     else
 493         return "NOTARGETS";
 494
 495     se->relevance = 0;
 496
 497     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 498     {
 499         if (prepare_session_database(se, client_get_database(cl)) < 0)
 500             return "CONFIG_ERROR";
 501         // Query must parse for all targets
 502         if (client_parse_query(cl, query) < 0)
 503             return "QUERY";
 504     }
 505
 506     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 507         client_prep_connection(cl);
 508
 509     return 0;
 510 }
 511
 512 // Creates a new session_database object for a database
 513 static void session_init_databases_fun(void *context, struct database *db)
 514 {
 515     struct session *se = (struct session *) context;
 516     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 517     int num = settings_num();
 518     int i;
 519
 520     new->database = db;
 521     new->yaz_marc = 0;
 522
 523 #ifdef HAVE_ICU
 524     if (global_parameters.server && global_parameters.server->icu_chn)
 525         new->pct = pp2_charset_create(global_parameters.server->icu_chn);
 526     else
 527         new->pct = pp2_charset_create(0);
 528 #else // HAVE_ICU
 529     new->pct = pp2_charset_create(0);
 530 #endif // HAVE_ICU
 531
 532     new->map = 0;
 533     new->settings
 534         = nmem_malloc(se->session_nmem, sizeof(struct settings *) * num);
 535     memset(new->settings, 0, sizeof(struct settings*) * num);
 536
 537     if (db->settings)
 538     {
 539         for (i = 0; i < num; i++)
 540             new->settings[i] = db->settings[i];
 541     }
 542     new->next = se->databases;
 543     se->databases = new;
 544 }
 545
 546 // Doesn't free memory associated with sdb -- nmem takes care of that
 547 static void session_database_destroy(struct session_database *sdb)
 548 {
 549     struct database_retrievalmap *m;
 550
 551     for (m = sdb->map; m; m = m->next)
 552         xsltFreeStylesheet(m->stylesheet);
 553     if (sdb->yaz_marc)
 554         yaz_marc_destroy(sdb->yaz_marc);
 555     if (sdb->pct)
 556         pp2_charset_destroy(sdb->pct);
 557 }
 558
 559 // Initialize session_database list -- this represents this session's view
 560 // of the database list -- subject to modification by the settings ws command
 561 void session_init_databases(struct session *se)
 562 {
 563     se->databases = 0;
 564     grep_databases(se, 0, session_init_databases_fun);
 565 }
 566
 567 // Probably session_init_databases_fun should be refactored instead of
 568 // called here.
 569 static struct session_database *load_session_database(struct session *se,
 570                                                       char *id)
 571 {
 572     struct database *db = find_database(id, 0);
 573
 574     session_init_databases_fun((void*) se, db);
 575     // New sdb is head of se->databases list
 576     return se->databases;
 577 }
 578
 579 // Find an existing session database. If not found, load it
 580 static struct session_database *find_session_database(struct session *se,
 581                                                       char *id)
 582 {
 583     struct session_database *sdb;
 584
 585     for (sdb = se->databases; sdb; sdb = sdb->next)
 586         if (!strcmp(sdb->database->url, id))
 587             return sdb;
 588     return load_session_database(se, id);
 589 }
 590
 591 // Apply a session override to a database
 592 void session_apply_setting(struct session *se, char *dbname, char *setting,
 593                            char *value)
 594 {
 595     struct session_database *sdb = find_session_database(se, dbname);
 596     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 597     int offset = settings_offset_cprefix(setting);
 598
 599     if (offset < 0)
 600     {
 601         yaz_log(YLOG_WARN, "Unknown setting %s", setting);
 602         return;
 603     }
 604     // Jakub: This breaks the filter setting.
 605     /*if (offset == PZ_ID)
 606     {
 607         yaz_log(YLOG_WARN, "No need to set pz:id setting. Ignoring");
 608         return;
 609     }*/
 610     new->precedence = 0;
 611     new->target = dbname;
 612     new->name = setting;
 613     new->value = value;
 614     new->next = sdb->settings[offset];
 615     sdb->settings[offset] = new;
 616
 617     // Force later recompute of settings-driven data structures
 618     // (happens when a search starts and client connections are prepared)
 619     switch (offset)
 620     {
 621         case PZ_NATIVESYNTAX:
 622             if (sdb->yaz_marc)
 623             {
 624                 yaz_marc_destroy(sdb->yaz_marc);
 625                 sdb->yaz_marc = 0;
 626             }
 627             break;
 628         case PZ_XSLT:
 629             if (sdb->map)
 630             {
 631                 struct database_retrievalmap *m;
 632                 // We don't worry about the map structure -- it's in nmem
 633                 for (m = sdb->map; m; m = m->next)
 634                     xsltFreeStylesheet(m->stylesheet);
 635                 sdb->map = 0;
 636             }
 637             break;
 638     }
 639 }
 640
 641 void destroy_session(struct session *s)
 642 {
 643     struct session_database *sdb;
 644
 645     yaz_log(YLOG_LOG, "Destroying session");
 646     while (s->clients)
 647         client_destroy(s->clients);
 648     for (sdb = s->databases; sdb; sdb = sdb->next)
 649         session_database_destroy(sdb);
 650     nmem_destroy(s->nmem);
 651     wrbuf_destroy(s->wrbuf);
 652 }
 653
 654 struct session *new_session(NMEM nmem)
 655 {
 656     int i;
 657     struct session *session = nmem_malloc(nmem, sizeof(*session));
 658
 659     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
 660
 661     session->total_hits = 0;
 662     session->total_records = 0;
 663     session->num_termlists = 0;
 664     session->reclist = 0;
 665     session->requestid = -1;
 666     session->clients = 0;
 667     session->expected_maxrecs = 0;
 668     session->session_nmem = nmem;
 669     session->nmem = nmem_create();
 670     session->wrbuf = wrbuf_alloc();
 671     session_init_databases(session);
 672     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 673     {
 674         session->watchlist[i].data = 0;
 675         session->watchlist[i].fun = 0;
 676     }
 677
 678     return session;
 679 }
 680
 681 struct hitsbytarget *hitsbytarget(struct session *se, int *count)
 682 {
 683     static struct hitsbytarget res[1000]; // FIXME MM
 684     struct client *cl;
 685
 686     *count = 0;
 687     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 688     {
 689         char *name = session_setting_oneval(client_get_database(cl), PZ_NAME);
 690
 691         res[*count].id = client_get_database(cl)->database->url;
 692         res[*count].name = *name ? name : "Unknown";
 693         res[*count].hits = client_get_hits(cl);
 694         res[*count].records = client_get_num_records(cl);
 695         res[*count].diagnostic = client_get_diagnostic(cl);
 696         res[*count].state = client_get_state_str(cl);
 697         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 698         (*count)++;
 699     }
 700
 701     return res;
 702 }
 703
 704 struct termlist_score **termlist(struct session *s, const char *name, int *num)
 705 {
 706     int i;
 707
 708     for (i = 0; i < s->num_termlists; i++)
 709         if (!strcmp((const char *) s->termlists[i].name, name))
 710             return termlist_highscore(s->termlists[i].termlist, num);
 711     return 0;
 712 }
 713
 714 #ifdef MISSING_HEADERS
 715 void report_nmem_stats(void)
 716 {
 717     size_t in_use, is_free;
 718
 719     nmem_get_memory_in_use(&in_use);
 720     nmem_get_memory_free(&is_free);
 721
 722     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
 723             (long) in_use, (long) is_free);
 724 }
 725 #endif
 726
 727 struct record_cluster *show_single(struct session *s, int id)
 728 {
 729     struct record_cluster *r;
 730
 731     reclist_rewind(s->reclist);
 732     while ((r = reclist_read_record(s->reclist)))
 733         if (r->recid == id)
 734             return r;
 735     return 0;
 736 }
 737
 738 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp,
 739                              int start, int *num, int *total, int *sumhits,
 740                              NMEM nmem_show)
 741 {
 742     struct record_cluster **recs = nmem_malloc(nmem_show, *num
 743                                        * sizeof(struct record_cluster *));
 744     struct reclist_sortparms *spp;
 745     int i;
 746 #if USE_TIMING
 747     yaz_timing_t t = yaz_timing_create();
 748 #endif
 749
 750     for (spp = sp; spp; spp = spp->next)
 751         if (spp->type == Metadata_sortkey_relevance)
 752         {
 753             relevance_prepare_read(s->relevance, s->reclist);
 754             break;
 755         }
 756     reclist_sort(s->reclist, sp);
 757
 758     *total = s->reclist->num_records;
 759     *sumhits = s->total_hits;
 760
 761     for (i = 0; i < start; i++)
 762         if (!reclist_read_record(s->reclist))
 763         {
 764             *num = 0;
 765             recs = 0;
 766             break;
 767         }
 768
 769     for (i = 0; i < *num; i++)
 770     {
 771         struct record_cluster *r = reclist_read_record(s->reclist);
 772         if (!r)
 773         {
 774             *num = i;
 775             break;
 776         }
 777         recs[i] = r;
 778     }
 779 #if USE_TIMING
 780     yaz_timing_stop(t);
 781     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
 782             yaz_timing_get_real(t), yaz_timing_get_user(t),
 783             yaz_timing_get_sys(t));
 784     yaz_timing_destroy(&t);
 785 #endif
 786     return recs;
 787 }
 788
 789 void statistics(struct session *se, struct statistics *stat)
 790 {
 791     struct client *cl;
 792     int count = 0;
 793
 794     memset(stat, 0, sizeof(*stat));
 795     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 796     {
 797         if (!client_get_connection(cl))
 798             stat->num_no_connection++;
 799         switch (client_get_state(cl))
 800         {
 801             case Client_Connecting: stat->num_connecting++; break;
 802             case Client_Initializing: stat->num_initializing++; break;
 803             case Client_Searching: stat->num_searching++; break;
 804             case Client_Presenting: stat->num_presenting++; break;
 805             case Client_Idle: stat->num_idle++; break;
 806             case Client_Failed: stat->num_failed++; break;
 807             case Client_Error: stat->num_error++; break;
 808             default: break;
 809         }
 810         count++;
 811     }
 812     stat->num_hits = se->total_hits;
 813     stat->num_records = se->total_records;
 814
 815     stat->num_clients = count;
 816 }
 817
 818 void start_http_listener(void)
 819 {
 820     char hp[128] = "";
 821     struct conf_server *ser = global_parameters.server;
 822
 823     if (*global_parameters.listener_override)
 824         strcpy(hp, global_parameters.listener_override);
 825     else
 826     {
 827         strcpy(hp, ser->host ? ser->host : "");
 828         if (ser->port)
 829         {
 830             if (*hp)
 831                 strcat(hp, ":");
 832             sprintf(hp + strlen(hp), "%d", ser->port);
 833         }
 834     }
 835     http_init(hp);
 836 }
 837
 838 void start_proxy(void)
 839 {
 840     char hp[128] = "";
 841     struct conf_server *ser = global_parameters.server;
 842
 843     if (*global_parameters.proxy_override)
 844         strcpy(hp, global_parameters.proxy_override);
 845     else if (ser->proxy_host || ser->proxy_port)
 846     {
 847         strcpy(hp, ser->proxy_host ? ser->proxy_host : "");
 848         if (ser->proxy_port)
 849         {
 850             if (*hp)
 851                 strcat(hp, ":");
 852             sprintf(hp + strlen(hp), "%d", ser->proxy_port);
 853         }
 854     }
 855     else
 856         return;
 857
 858     http_set_proxyaddr(hp, ser->myurl ? ser->myurl : "");
 859 }
 860
 861
 862 // Master list of connections we're handling events to
 863 static IOCHAN channel_list = 0;
 864 void pazpar2_add_channel(IOCHAN chan)
 865 {
 866     chan->next = channel_list;
 867     channel_list = chan;
 868 }
 869
 870 void pazpar2_event_loop()
 871 {
 872     event_loop(&channel_list);
 873 }
 874
 875 struct record *ingest_record(struct client *cl, Z_External *rec,
 876                              int record_no)
 877 {
 878     xmlDoc *xdoc = normalize_record(client_get_database(cl), rec);
 879     xmlNode *root, *n;
 880     struct record *record;
 881     struct record_cluster *cluster;
 882     struct session *se = client_get_session(cl);
 883     xmlChar *mergekey, *mergekey_norm;
 884     xmlChar *type = 0;
 885     xmlChar *value = 0;
 886     struct conf_service *service = global_parameters.server->service;
 887
 888     if (!xdoc)
 889         return 0;
 890
 891     root = xmlDocGetRootElement(xdoc);
 892     if (!(mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
 893     {
 894         yaz_log(YLOG_WARN, "No mergekey found in record");
 895         xmlFreeDoc(xdoc);
 896         return 0;
 897     }
 898
 899     record = record_create(se->nmem,
 900                            service->num_metadata, service->num_sortkeys, cl);
 901
 902     mergekey_norm = (xmlChar *) nmem_strdup(se->nmem, (char*) mergekey);
 903     xmlFree(mergekey);
 904     normalize7bit_mergekey((char *) mergekey_norm, 0);
 905
 906     cluster = reclist_insert(se->reclist,
 907                              global_parameters.server->service,
 908                              record, (char *) mergekey_norm,
 909                              &se->total_merged);
 910     if (global_parameters.dump_records)
 911         yaz_log(YLOG_LOG, "Cluster id %d from %s (#%d)", cluster->recid,
 912                 client_get_database(cl)->database->url, record_no);
 913     if (!cluster)
 914     {
 915         /* no room for record */
 916         xmlFreeDoc(xdoc);
 917         return 0;
 918     }
 919     relevance_newrec(se->relevance, cluster);
 920
 921
 922     // now parsing XML record and adding data to cluster or record metadata
 923     for (n = root->children; n; n = n->next)
 924     {
 925         if (type)
 926             xmlFree(type);
 927         if (value)
 928             xmlFree(value);
 929         type = value = 0;
 930
 931         if (n->type != XML_ELEMENT_NODE)
 932             continue;
 933         if (!strcmp((const char *) n->name, "metadata"))
 934         {
 935             struct conf_metadata *ser_md = 0;
 936             struct conf_sortkey *ser_sk = 0;
 937             struct record_metadata **wheretoput = 0;
 938             struct record_metadata *rec_md = 0;
 939             int md_field_id = -1;
 940             int sk_field_id = -1;
 941             int first, last;
 942
 943             type = xmlGetProp(n, (xmlChar *) "type");
 944             value = xmlNodeListGetString(xdoc, n->children, 1);
 945
 946             if (!type || !value)
 947                 continue;
 948
 949             md_field_id
 950                 = conf_service_metadata_field_id(service, (const char *) type);
 951             if (md_field_id < 0)
 952             {
 953                 yaz_log(YLOG_WARN,
 954                         "Ignoring unknown metadata element: %s", type);
 955                 continue;
 956             }
 957
 958             ser_md = &service->metadata[md_field_id];
 959
 960             if (ser_md->sortkey_offset >= 0){
 961                 sk_field_id = ser_md->sortkey_offset;
 962                 ser_sk = &service->sortkeys[sk_field_id];
 963             }
 964
 965             // Find out where we are putting it - based on merge or not
 966             if (ser_md->merge == Metadata_merge_no)
 967                 wheretoput = &record->metadata[md_field_id];
 968             else
 969                 wheretoput = &cluster->metadata[md_field_id];
 970
 971             // create new record_metadata
 972             rec_md = record_metadata_create(se->nmem);
 973
 974             // and polulate with data:
 975             // type based charmapping decisions follow here
 976             if (ser_md->type == Metadata_type_generic)
 977             {
 978
 979                 char * p = (char *) value;
 980                 p = normalize7bit_generic(p, " ,/.:([");
 981
 982                 rec_md->data.text = nmem_strdup(se->nmem, p);
 983
 984             }
 985             else if (ser_md->type == Metadata_type_year)
 986             {
 987                 if (extract7bit_years((char *) value, &first, &last) < 0)
 988                     continue;
 989             }
 990             else
 991             {
 992                 yaz_log(YLOG_WARN,
 993                         "Unknown type in metadata element %s", type);
 994                 continue;
 995             }
 996
 997             // and polulate with data:
 998             // assign cluster or record based on merge action
 999             if (ser_md->merge == Metadata_merge_unique)
1000             {
1001                 struct record_metadata *mnode;
1002                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1003                     if (!strcmp((const char *) mnode->data.text,
1004                                 rec_md->data.text))
1005                         break;
1006                 if (!mnode)
1007                 {
1008                     rec_md->next = *wheretoput;
1009                     *wheretoput = rec_md;
1010                 }
1011             }
1012             else if (ser_md->merge == Metadata_merge_longest)
1013             {
1014                 if (!*wheretoput
1015                     || strlen(rec_md->data.text)
1016                        > strlen((*wheretoput)->data.text))
1017                 {
1018                     *wheretoput = rec_md;
1019                     if (ser_sk)
1020                     {
1021                         char *s = nmem_strdup(se->nmem, rec_md->data.text);
1022                         if (!cluster->sortkeys[sk_field_id])
1023                             cluster->sortkeys[sk_field_id] =
1024                                 nmem_malloc(se->nmem,
1025                                             sizeof(union data_types));
1026                         normalize7bit_mergekey(s,
1027                              (ser_sk->type == Metadata_sortkey_skiparticle));
1028                         cluster->sortkeys[sk_field_id]->text = s;
1029                     }
1030                 }
1031             }
1032             else if (ser_md->merge == Metadata_merge_all
1033                      || ser_md->merge == Metadata_merge_no)
1034             {
1035                 rec_md->next = *wheretoput;
1036                 *wheretoput = rec_md;
1037             }
1038             else if (ser_md->merge == Metadata_merge_range)
1039             {
1040                 if (!*wheretoput)
1041                 {
1042                     *wheretoput = rec_md;
1043                     (*wheretoput)->data.number.min = first;
1044                     (*wheretoput)->data.number.max = last;
1045                     if (ser_sk)
1046                         cluster->sortkeys[sk_field_id]
1047                             = &rec_md->data;
1048                 }
1049                 else
1050                 {
1051                     if (first < (*wheretoput)->data.number.min)
1052                         (*wheretoput)->data.number.min = first;
1053                     if (last > (*wheretoput)->data.number.max)
1054                         (*wheretoput)->data.number.max = last;
1055                 }
1056 #ifdef GAGA
1057                 if (ser_sk)
1058                 {
1059                     union data_types *sdata
1060                         = cluster->sortkeys[sk_field_id];
1061                     yaz_log(YLOG_LOG, "SK range: %d-%d",
1062                             sdata->number.min, sdata->number.max);
1063                 }
1064 #endif
1065             }
1066
1067
1068             // ranking of _all_ fields enabled ...
1069             if (ser_md->rank)
1070                 relevance_countwords(se->relevance, cluster,
1071                                      (char *) value, ser_md->rank);
1072
1073             // construct facets ...
1074             if (ser_md->termlist)
1075             {
1076                 if (ser_md->type == Metadata_type_year)
1077                 {
1078                     char year[64];
1079                     sprintf(year, "%d", last);
1080                     add_facet(se, (char *) type, year);
1081                     if (first != last)
1082                     {
1083                         sprintf(year, "%d", first);
1084                         add_facet(se, (char *) type, year);
1085                     }
1086                 }
1087                 else
1088                     add_facet(se, (char *) type, (char *) value);
1089             }
1090
1091             // cleaning up
1092             xmlFree(type);
1093             xmlFree(value);
1094             type = value = 0;
1095         }
1096         else
1097             yaz_log(YLOG_WARN,
1098                     "Unexpected element %s in internal record", n->name);
1099     }
1100     if (type)
1101         xmlFree(type);
1102     if (value)
1103         xmlFree(value);
1104
1105     xmlFreeDoc(xdoc);
1106
1107     relevance_donerecord(se->relevance, cluster);
1108     se->total_records++;
1109
1110     return record;
1111 }
1112
1113
1114
1115 /*
1116  * Local variables:
1117  * c-basic-offset: 4
1118  * indent-tabs-mode: nil
1119  * End:
1120  * vim: shiftwidth=4 tabstop=8 expandtab
1121  */