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