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