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