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