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