src/logic.c

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