src/session.c

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