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 *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 (prepare_session_database(se, client_get_database(cl)) < 0)
 506             continue;
 507         // Parse query for target
 508         if (client_parse_query(cl, query) < 0)
 509             no_failed++;
 510         else
 511         {
 512             no_working++;
 513             if (client_prep_connection(cl, se->service->z3950_operation_timeout,
 514                                        se->service->z3950_session_timeout))
 515                 client_start_search(cl);
 516         }
 517     }
 518     if (no_working == 0)
 519     {
 520         if (no_failed > 0)
 521         {
 522             *addinfo = "query";
 523             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 524         }
 525         else
 526             return PAZPAR2_NO_TARGETS;
 527     }
 528     return PAZPAR2_NO_ERROR;
 529 }
 530
 531 // Creates a new session_database object for a database
 532 static void session_init_databases_fun(void *context, struct database *db)
 533 {
 534     struct session *se = (struct session *) context;
 535     struct conf_service *service = se->service;
 536     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 537     int num = settings_num(service);
 538     int i;
 539
 540     new->database = db;
 541
 542     new->map = 0;
 543     new->settings
 544         = nmem_malloc(se->session_nmem, sizeof(struct settings *) * num);
 545     memset(new->settings, 0, sizeof(struct settings*) * num);
 546
 547     if (db->settings)
 548     {
 549         for (i = 0; i < num; i++)
 550             new->settings[i] = db->settings[i];
 551     }
 552     new->next = se->databases;
 553     se->databases = new;
 554 }
 555
 556 // Doesn't free memory associated with sdb -- nmem takes care of that
 557 static void session_database_destroy(struct session_database *sdb)
 558 {
 559     sdb->map = 0;
 560 }
 561
 562 // Initialize session_database list -- this represents this session's view
 563 // of the database list -- subject to modification by the settings ws command
 564 void session_init_databases(struct session *se)
 565 {
 566     se->databases = 0;
 567     predef_grep_databases(se, se->service, 0, session_init_databases_fun);
 568 }
 569
 570 // Probably session_init_databases_fun should be refactored instead of
 571 // called here.
 572 static struct session_database *load_session_database(struct session *se,
 573                                                       char *id)
 574 {
 575     struct database *db = find_database(id, 0, se->service);
 576
 577     resolve_database(db);
 578
 579     session_init_databases_fun((void*) se, db);
 580     // New sdb is head of se->databases list
 581     return se->databases;
 582 }
 583
 584 // Find an existing session database. If not found, load it
 585 static struct session_database *find_session_database(struct session *se,
 586                                                       char *id)
 587 {
 588     struct session_database *sdb;
 589
 590     for (sdb = se->databases; sdb; sdb = sdb->next)
 591         if (!strcmp(sdb->database->url, id))
 592             return sdb;
 593     return load_session_database(se, id);
 594 }
 595
 596 // Apply a session override to a database
 597 void session_apply_setting(struct session *se, char *dbname, char *setting,
 598                            char *value)
 599 {
 600     struct session_database *sdb = find_session_database(se, dbname);
 601     struct conf_service *service = se->service;
 602     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 603     int offset = settings_offset_cprefix(service, setting);
 604
 605     if (offset < 0)
 606     {
 607         yaz_log(YLOG_WARN, "Unknown setting %s", setting);
 608         return;
 609     }
 610     // Jakub: This breaks the filter setting.
 611     /*if (offset == PZ_ID)
 612       {
 613       yaz_log(YLOG_WARN, "No need to set pz:id setting. Ignoring");
 614       return;
 615       }*/
 616     new->precedence = 0;
 617     new->target = dbname;
 618     new->name = setting;
 619     new->value = value;
 620     new->next = sdb->settings[offset];
 621     sdb->settings[offset] = new;
 622
 623     // Force later recompute of settings-driven data structures
 624     // (happens when a search starts and client connections are prepared)
 625     switch (offset)
 626     {
 627     case PZ_XSLT:
 628         if (sdb->map)
 629         {
 630             sdb->map = 0;
 631         }
 632         break;
 633     }
 634 }
 635
 636 void destroy_session(struct session *s)
 637 {
 638     struct session_database *sdb;
 639
 640     while (s->clients)
 641         client_destroy(s->clients);
 642     for (sdb = s->databases; sdb; sdb = sdb->next)
 643         session_database_destroy(sdb);
 644     normalize_cache_destroy(s->normalize_cache);
 645     nmem_destroy(s->nmem);
 646     service_destroy(s->service);
 647     wrbuf_destroy(s->wrbuf);
 648 }
 649
 650 struct session *new_session(NMEM nmem, struct conf_service *service)
 651 {
 652     int i;
 653     struct session *session = nmem_malloc(nmem, sizeof(*session));
 654
 655     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
 656
 657     session->service = service;
 658     session->relevance = 0;
 659     session->total_hits = 0;
 660     session->total_records = 0;
 661     session->number_of_warnings_unknown_elements = 0;
 662     session->number_of_warnings_unknown_metadata = 0;
 663     session->num_termlists = 0;
 664     session->reclist = 0;
 665     session->clients = 0;
 666     session->session_nmem = nmem;
 667     session->nmem = nmem_create();
 668     session->wrbuf = wrbuf_alloc();
 669     session->databases = 0;
 670     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 671     {
 672         session->watchlist[i].data = 0;
 673         session->watchlist[i].fun = 0;
 674     }
 675     session->normalize_cache = normalize_cache_create();
 676
 677     return session;
 678 }
 679
 680 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
 681 {
 682     struct hitsbytarget *res = 0;
 683     struct client *cl;
 684     size_t sz = 0;
 685
 686     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 687         sz++;
 688
 689     res = nmem_malloc(nmem, sizeof(*res) * sz);
 690     *count = 0;
 691     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 692     {
 693         const char *name = session_setting_oneval(client_get_database(cl),
 694                                                   PZ_NAME);
 695
 696         res[*count].id = client_get_database(cl)->database->url;
 697         res[*count].name = *name ? name : "Unknown";
 698         res[*count].hits = client_get_hits(cl);
 699         res[*count].records = client_get_num_records(cl);
 700         res[*count].diagnostic = client_get_diagnostic(cl);
 701         res[*count].state = client_get_state_str(cl);
 702         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 703         (*count)++;
 704     }
 705     return res;
 706 }
 707
 708 struct termlist_score **termlist(struct session *s, const char *name, int *num)
 709 {
 710     int i;
 711
 712     for (i = 0; i < s->num_termlists; i++)
 713         if (!strcmp((const char *) s->termlists[i].name, name))
 714             return termlist_highscore(s->termlists[i].termlist, num);
 715     return 0;
 716 }
 717
 718 #ifdef MISSING_HEADERS
 719 void report_nmem_stats(void)
 720 {
 721     size_t in_use, is_free;
 722
 723     nmem_get_memory_in_use(&in_use);
 724     nmem_get_memory_free(&is_free);
 725
 726     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
 727             (long) in_use, (long) is_free);
 728 }
 729 #endif
 730
 731 struct record_cluster *show_single(struct session *s, const char *id,
 732                                    struct record_cluster **prev_r,
 733                                    struct record_cluster **next_r)
 734 {
 735     struct record_cluster *r;
 736
 737     reclist_rewind(s->reclist);
 738     *prev_r = 0;
 739     *next_r = 0;
 740     while ((r = reclist_read_record(s->reclist)))
 741     {
 742         if (!strcmp(r->recid, id))
 743         {
 744             *next_r = reclist_read_record(s->reclist);
 745             return r;
 746         }
 747         *prev_r = r;
 748     }
 749     return 0;
 750 }
 751
 752 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp,
 753                              int start, int *num, int *total, int *sumhits,
 754                              NMEM nmem_show)
 755 {
 756     struct record_cluster **recs = nmem_malloc(nmem_show, *num
 757                                                * sizeof(struct record_cluster *));
 758     struct reclist_sortparms *spp;
 759     int i;
 760 #if USE_TIMING
 761     yaz_timing_t t = yaz_timing_create();
 762 #endif
 763
 764     if (!s->relevance)
 765     {
 766         *num = 0;
 767         *total = 0;
 768         *sumhits = 0;
 769         recs = 0;
 770     }
 771     else
 772     {
 773         for (spp = sp; spp; spp = spp->next)
 774             if (spp->type == Metadata_sortkey_relevance)
 775             {
 776                 relevance_prepare_read(s->relevance, s->reclist);
 777                 break;
 778             }
 779         reclist_sort(s->reclist, sp);
 780
 781         *total = reclist_get_num_records(s->reclist);
 782         *sumhits = s->total_hits;
 783
 784         for (i = 0; i < start; i++)
 785             if (!reclist_read_record(s->reclist))
 786             {
 787                 *num = 0;
 788                 recs = 0;
 789                 break;
 790             }
 791
 792         for (i = 0; i < *num; i++)
 793         {
 794             struct record_cluster *r = reclist_read_record(s->reclist);
 795             if (!r)
 796             {
 797                 *num = i;
 798                 break;
 799             }
 800             recs[i] = r;
 801         }
 802     }
 803 #if USE_TIMING
 804     yaz_timing_stop(t);
 805     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
 806             yaz_timing_get_real(t), yaz_timing_get_user(t),
 807             yaz_timing_get_sys(t));
 808     yaz_timing_destroy(&t);
 809 #endif
 810     return recs;
 811 }
 812
 813 void statistics(struct session *se, struct statistics *stat)
 814 {
 815     struct client *cl;
 816     int count = 0;
 817
 818     memset(stat, 0, sizeof(*stat));
 819     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 820     {
 821         if (!client_get_connection(cl))
 822             stat->num_no_connection++;
 823         switch (client_get_state(cl))
 824         {
 825         case Client_Connecting: stat->num_connecting++; break;
 826         case Client_Working: stat->num_working++; break;
 827         case Client_Idle: stat->num_idle++; break;
 828         case Client_Failed: stat->num_failed++; break;
 829         case Client_Error: stat->num_error++; break;
 830         default: break;
 831         }
 832         count++;
 833     }
 834     stat->num_hits = se->total_hits;
 835     stat->num_records = se->total_records;
 836
 837     stat->num_clients = count;
 838 }
 839
 840
 841 // Master list of connections we're handling events to
 842 static IOCHAN channel_list = 0;  /* thread pr */
 843
 844 void pazpar2_add_channel(IOCHAN chan)
 845 {
 846     chan->next = channel_list;
 847     channel_list = chan;
 848 }
 849
 850 void pazpar2_event_loop()
 851 {
 852     event_loop(&channel_list);
 853 }
 854
 855 static struct record_metadata *record_metadata_init(
 856     NMEM nmem, char *value, enum conf_metadata_type type)
 857 {
 858     struct record_metadata *rec_md = record_metadata_create(nmem);
 859     if (type == Metadata_type_generic)
 860     {
 861         char * p = value;
 862         p = normalize7bit_generic(p, " ,/.:([");
 863
 864         rec_md->data.text.disp = nmem_strdup(nmem, p);
 865         rec_md->data.text.sort = 0;
 866     }
 867     else if (type == Metadata_type_year || type == Metadata_type_date)
 868     {
 869         int first, last;
 870         int longdate = 0;
 871
 872         if (type == Metadata_type_date)
 873             longdate = 1;
 874         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
 875             return 0;
 876
 877         rec_md->data.number.min = first;
 878         rec_md->data.number.max = last;
 879     }
 880     else
 881         return 0;
 882     return rec_md;
 883 }
 884
 885 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
 886                                  struct conf_service *service, WRBUF norm_wr)
 887 {
 888     xmlNode *n;
 889     int no_found = 0;
 890     for (n = root->children; n; n = n->next)
 891     {
 892         if (n->type != XML_ELEMENT_NODE)
 893             continue;
 894         if (!strcmp((const char *) n->name, "metadata"))
 895         {
 896             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
 897             if (!strcmp(name, (const char *) type))
 898             {
 899                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
 900                 if (value)
 901                 {
 902                     const char *norm_str;
 903                     pp2_relevance_token_t prt =
 904                         pp2_relevance_tokenize(
 905                             service->mergekey_pct,
 906                             (const char *) value);
 907
 908                     wrbuf_puts(norm_wr, name);
 909                     wrbuf_puts(norm_wr, "=");
 910                     while ((norm_str =
 911                             pp2_relevance_token_next(prt)))
 912                     {
 913                         if (*norm_str)
 914                         {
 915                             if (wrbuf_len(norm_wr))
 916                                 wrbuf_puts(norm_wr, " ");
 917                             wrbuf_puts(norm_wr, norm_str);
 918                         }
 919                     }
 920                     xmlFree(value);
 921                     pp2_relevance_token_destroy(prt);
 922                     no_found++;
 923                 }
 924             }
 925             xmlFree(type);
 926         }
 927     }
 928     return no_found;
 929 }
 930
 931 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
 932                                 struct conf_service *service, NMEM nmem)
 933 {
 934     char *mergekey_norm = 0;
 935     xmlNode *root = xmlDocGetRootElement(doc);
 936     WRBUF norm_wr = wrbuf_alloc();
 937
 938     /* consider mergekey from XSL first */
 939     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
 940     if (mergekey)
 941     {
 942         const char *norm_str;
 943         pp2_relevance_token_t prt =
 944             pp2_relevance_tokenize(
 945                 service->mergekey_pct,
 946                 (const char *) mergekey);
 947
 948         while ((norm_str = pp2_relevance_token_next(prt)))
 949         {
 950             if (*norm_str)
 951             {
 952                 if (wrbuf_len(norm_wr))
 953                     wrbuf_puts(norm_wr, " ");
 954                 wrbuf_puts(norm_wr, norm_str);
 955             }
 956         }
 957         pp2_relevance_token_destroy(prt);
 958         xmlFree(mergekey);
 959     }
 960     else
 961     {
 962         /* no mergekey defined in XSL. Look for mergekey metadata instead */
 963         int field_id;
 964         for (field_id = 0; field_id < service->num_metadata; field_id++)
 965         {
 966             struct conf_metadata *ser_md = &service->metadata[field_id];
 967             if (ser_md->mergekey != Metadata_mergekey_no)
 968             {
 969                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
 970                                               service, norm_wr);
 971                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
 972                 {
 973                     /* no mergekey on this one and it is required..
 974                        Generate unique key instead */
 975                     wrbuf_rewind(norm_wr);
 976                     break;
 977                 }
 978             }
 979         }
 980     }
 981
 982     /* generate unique key if none is not generated already or is empty */
 983     if (wrbuf_len(norm_wr) == 0)
 984     {
 985         wrbuf_printf(norm_wr, "%s-%d",
 986                      client_get_database(cl)->database->url, record_no);
 987     }
 988     if (wrbuf_len(norm_wr) > 0)
 989         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
 990     wrbuf_destroy(norm_wr);
 991     return mergekey_norm;
 992 }
 993
 994 /** \brief see if metadata for pz:recordfilter exists
 995     \param root xml root element of normalized record
 996     \param sdb session database for client
 997     \retval 0 if there is no metadata for pz:recordfilter
 998     \retval 1 if there is metadata for pz:recordfilter
 999
1000     If there is no pz:recordfilter defined, this function returns 1
1001     as well.
1002 */
1003
1004 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1005 {
1006     int match = 0;
1007     xmlNode *n;
1008     const char *s;
1009     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1010
1011     if (!s || !*s)
1012         return 1;
1013
1014     for (n = root->children; n; n = n->next)
1015     {
1016         if (n->type != XML_ELEMENT_NODE)
1017             continue;
1018         if (!strcmp((const char *) n->name, "metadata"))
1019         {
1020             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1021             if (type)
1022             {
1023                 size_t len;
1024                 const char *eq = strchr(s, '=');
1025                 if (eq)
1026                     len = eq - s;
1027                 else
1028                     len = strlen(s);
1029                 if (len == strlen((const char *)type) &&
1030                     !memcmp((const char *) type, s, len))
1031                 {
1032                     xmlChar *value = xmlNodeGetContent(n);
1033                     if (value && *value)
1034                     {
1035                         if (!eq || strstr((const char *) value, eq+1))
1036                             match = 1;
1037                     }
1038                     xmlFree(value);
1039                 }
1040                 xmlFree(type);
1041             }
1042         }
1043     }
1044     return match;
1045 }
1046
1047
1048 /** \brief ingest XML record
1049     \param cl client holds the result set for record
1050     \param rec record buffer (0 terminated)
1051     \param record_no record position (1, 2, ..)
1052     \returns resulting record or NULL on failure
1053 */
1054 struct record *ingest_record(struct client *cl, const char *rec,
1055                              int record_no)
1056 {
1057     struct session_database *sdb = client_get_database(cl);
1058     struct session *se = client_get_session(cl);
1059     xmlDoc *xdoc = normalize_record(sdb, se, rec);
1060     xmlNode *root, *n;
1061     struct record *record;
1062     struct record_cluster *cluster;
1063     const char *mergekey_norm;
1064     xmlChar *type = 0;
1065     xmlChar *value = 0;
1066     struct conf_service *service = se->service;
1067
1068     if (!xdoc)
1069         return 0;
1070
1071     root = xmlDocGetRootElement(xdoc);
1072
1073     if (!check_record_filter(root, sdb))
1074     {
1075         yaz_log(YLOG_WARN, "Filtered out record no %d from %s", record_no,
1076             sdb->database->url);
1077         xmlFreeDoc(xdoc);
1078         return 0;
1079     }
1080
1081     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, se->nmem);
1082     if (!mergekey_norm)
1083     {
1084         yaz_log(YLOG_WARN, "Got no mergekey");
1085         xmlFreeDoc(xdoc);
1086         return 0;
1087     }
1088     record = record_create(se->nmem,
1089                            service->num_metadata, service->num_sortkeys, cl,
1090                            record_no);
1091
1092     cluster = reclist_insert(se->reclist,
1093                              service,
1094                              record, (char *) mergekey_norm,
1095                              &se->total_merged);
1096     if (!cluster)
1097     {
1098         /* no room for record */
1099         xmlFreeDoc(xdoc);
1100         return 0;
1101     }
1102     if (global_parameters.dump_records)
1103         yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1104                 sdb->database->url, record_no);
1105     relevance_newrec(se->relevance, cluster);
1106
1107     // now parsing XML record and adding data to cluster or record metadata
1108     for (n = root->children; n; n = n->next)
1109     {
1110         pp2_relevance_token_t prt;
1111         if (type)
1112             xmlFree(type);
1113         if (value)
1114             xmlFree(value);
1115         type = value = 0;
1116
1117         if (n->type != XML_ELEMENT_NODE)
1118             continue;
1119         if (!strcmp((const char *) n->name, "metadata"))
1120         {
1121             struct conf_metadata *ser_md = 0;
1122             struct conf_sortkey *ser_sk = 0;
1123             struct record_metadata **wheretoput = 0;
1124             struct record_metadata *rec_md = 0;
1125             int md_field_id = -1;
1126             int sk_field_id = -1;
1127
1128             type = xmlGetProp(n, (xmlChar *) "type");
1129             value = xmlNodeListGetString(xdoc, n->children, 1);
1130
1131             if (!type || !value || !*value)
1132                 continue;
1133
1134             md_field_id
1135                 = conf_service_metadata_field_id(service, (const char *) type);
1136             if (md_field_id < 0)
1137             {
1138                 if (se->number_of_warnings_unknown_metadata == 0)
1139                 {
1140                     yaz_log(YLOG_WARN,
1141                             "Ignoring unknown metadata element: %s", type);
1142                 }
1143                 se->number_of_warnings_unknown_metadata++;
1144                 continue;
1145             }
1146
1147             ser_md = &service->metadata[md_field_id];
1148
1149             if (ser_md->sortkey_offset >= 0){
1150                 sk_field_id = ser_md->sortkey_offset;
1151                 ser_sk = &service->sortkeys[sk_field_id];
1152             }
1153
1154             // non-merged metadata
1155             rec_md = record_metadata_init(se->nmem, (char *) value,
1156                                           ser_md->type);
1157             if (!rec_md)
1158             {
1159                 yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
1160                         value, type);
1161                 continue;
1162             }
1163             wheretoput = &record->metadata[md_field_id];
1164             while (*wheretoput)
1165                 wheretoput = &(*wheretoput)->next;
1166             *wheretoput = rec_md;
1167
1168             // merged metadata
1169             rec_md = record_metadata_init(se->nmem, (char *) value,
1170                                           ser_md->type);
1171             wheretoput = &cluster->metadata[md_field_id];
1172
1173             // and polulate with data:
1174             // assign cluster or record based on merge action
1175             if (ser_md->merge == Metadata_merge_unique)
1176             {
1177                 struct record_metadata *mnode;
1178                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1179                     if (!strcmp((const char *) mnode->data.text.disp,
1180                                 rec_md->data.text.disp))
1181                         break;
1182                 if (!mnode)
1183                 {
1184                     rec_md->next = *wheretoput;
1185                     *wheretoput = rec_md;
1186                 }
1187             }
1188             else if (ser_md->merge == Metadata_merge_longest)
1189             {
1190                 if (!*wheretoput
1191                     || strlen(rec_md->data.text.disp)
1192                     > strlen((*wheretoput)->data.text.disp))
1193                 {
1194                     *wheretoput = rec_md;
1195                     if (ser_sk)
1196                     {
1197                         const char *sort_str = 0;
1198                         int skip_article =
1199                             ser_sk->type == Metadata_sortkey_skiparticle;
1200
1201                         if (!cluster->sortkeys[sk_field_id])
1202                             cluster->sortkeys[sk_field_id] =
1203                                 nmem_malloc(se->nmem,
1204                                             sizeof(union data_types));
1205
1206                         prt = pp2_relevance_tokenize(
1207                             service->sort_pct,
1208                             rec_md->data.text.disp);
1209
1210                         pp2_relevance_token_next(prt);
1211
1212                         sort_str = pp2_get_sort(prt, skip_article);
1213
1214                         cluster->sortkeys[sk_field_id]->text.disp =
1215                             rec_md->data.text.disp;
1216                         if (!sort_str)
1217                         {
1218                             sort_str = rec_md->data.text.disp;
1219                             yaz_log(YLOG_WARN,
1220                                     "Could not make sortkey. Bug #1858");
1221                         }
1222                         cluster->sortkeys[sk_field_id]->text.sort =
1223                             nmem_strdup(se->nmem, sort_str);
1224 #if 0
1225                         yaz_log(YLOG_LOG, "text disp=%s",
1226                                 cluster->sortkeys[sk_field_id]->text.disp);
1227                         yaz_log(YLOG_LOG, "text sort=%s",
1228                                 cluster->sortkeys[sk_field_id]->text.sort);
1229 #endif
1230                         pp2_relevance_token_destroy(prt);
1231                     }
1232                 }
1233             }
1234             else if (ser_md->merge == Metadata_merge_all)
1235             {
1236                 rec_md->next = *wheretoput;
1237                 *wheretoput = rec_md;
1238             }
1239             else if (ser_md->merge == Metadata_merge_range)
1240             {
1241                 if (!*wheretoput)
1242                 {
1243                     *wheretoput = rec_md;
1244                     if (ser_sk)
1245                         cluster->sortkeys[sk_field_id]
1246                             = &rec_md->data;
1247                 }
1248                 else
1249                 {
1250                     int this_min = rec_md->data.number.min;
1251                     int this_max = rec_md->data.number.max;
1252                     if (this_min < (*wheretoput)->data.number.min)
1253                         (*wheretoput)->data.number.min = this_min;
1254                     if (this_max > (*wheretoput)->data.number.max)
1255                         (*wheretoput)->data.number.max = this_max;
1256                 }
1257             }
1258
1259
1260             // ranking of _all_ fields enabled ...
1261             if (ser_md->rank)
1262                 relevance_countwords(se->relevance, cluster,
1263                                      (char *) value, ser_md->rank);
1264
1265             // construct facets ...
1266             if (ser_md->termlist)
1267             {
1268                 if (ser_md->type == Metadata_type_year)
1269                 {
1270                     char year[64];
1271                     sprintf(year, "%d", rec_md->data.number.max);
1272                     add_facet(se, (char *) type, year);
1273                     if (rec_md->data.number.max != rec_md->data.number.min)
1274                     {
1275                         sprintf(year, "%d", rec_md->data.number.min);
1276                         add_facet(se, (char *) type, year);
1277                     }
1278                 }
1279                 else
1280                     add_facet(se, (char *) type, (char *) value);
1281             }
1282
1283             // cleaning up
1284             xmlFree(type);
1285             xmlFree(value);
1286             type = value = 0;
1287         }
1288         else
1289         {
1290             if (se->number_of_warnings_unknown_elements == 0)
1291                 yaz_log(YLOG_WARN,
1292                         "Unexpected element in internal record: %s", n->name);
1293             se->number_of_warnings_unknown_elements++;
1294         }
1295     }
1296     if (type)
1297         xmlFree(type);
1298     if (value)
1299         xmlFree(value);
1300
1301     xmlFreeDoc(xdoc);
1302
1303     relevance_donerecord(se->relevance, cluster);
1304     se->total_records++;
1305
1306     return record;
1307 }
1308
1309
1310
1311 /*
1312  * Local variables:
1313  * c-basic-offset: 4
1314  * c-file-style: "Stroustrup"
1315  * indent-tabs-mode: nil
1316  * End:
1317  * vim: shiftwidth=4 tabstop=8 expandtab
1318  */
1319