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