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     {
 456         struct client *cl = se->clients;
 457         client_remove_from_session(cl);
 458         client_destroy(cl);
 459     }
 460 }
 461
 462 // Associates a set of clients with a session;
 463 // Note: Session-databases represent databases with per-session
 464 // setting overrides
 465 static int select_targets(struct session *se, const char *filter)
 466 {
 467     session_remove_clients(se);
 468     return session_grep_databases(se, filter, select_targets_callback);
 469 }
 470
 471 int session_active_clients(struct session *s)
 472 {
 473     struct client *c;
 474     int res = 0;
 475
 476     for (c = s->clients; c; c = client_next_in_session(c))
 477         if (client_is_active(c))
 478             res++;
 479
 480     return res;
 481 }
 482
 483
 484 enum pazpar2_error_code search(struct session *se,
 485                                const char *query,
 486                                const char *startrecs, const char *maxrecs,
 487                                const char *filter,
 488                                const char **addinfo)
 489 {
 490     int live_channels = 0;
 491     int no_working = 0;
 492     int no_failed = 0;
 493     struct client *cl;
 494
 495     yaz_log(YLOG_DEBUG, "Search");
 496
 497     *addinfo = 0;
 498
 499     session_enter(se);
 500     reclist_destroy(se->reclist);
 501     se->reclist = 0;
 502     nmem_reset(se->nmem);
 503     relevance_destroy(&se->relevance);
 504     se->total_records = se->total_hits = se->total_merged = 0;
 505     se->num_termlists = 0;
 506     live_channels = select_targets(se, filter);
 507     if (!live_channels)
 508     {
 509         session_leave(se);
 510         return PAZPAR2_NO_TARGETS;
 511     }
 512     se->reclist = reclist_create(se->nmem);
 513
 514     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 515     {
 516         if (maxrecs)
 517             client_set_maxrecs(cl, atoi(maxrecs));
 518         if (startrecs)
 519             client_set_startrecs(cl, atoi(startrecs));
 520         if (prepare_session_database(se, client_get_database(cl)) < 0)
 521             continue;
 522         // Parse query for target
 523         if (client_parse_query(cl, query) < 0)
 524             no_failed++;
 525         else
 526         {
 527             no_working++;
 528             if (client_prep_connection(cl, se->service->z3950_operation_timeout,
 529                                        se->service->z3950_session_timeout,
 530                                        se->service->server->iochan_man))
 531                 client_start_search(cl);
 532         }
 533     }
 534     session_leave(se);
 535     if (no_working == 0)
 536     {
 537         if (no_failed > 0)
 538         {
 539             *addinfo = "query";
 540             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 541         }
 542         else
 543             return PAZPAR2_NO_TARGETS;
 544     }
 545     return PAZPAR2_NO_ERROR;
 546 }
 547
 548 // Creates a new session_database object for a database
 549 static void session_init_databases_fun(void *context, struct database *db)
 550 {
 551     struct session *se = (struct session *) context;
 552     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 553     int i;
 554
 555     new->database = db;
 556
 557     new->map = 0;
 558     assert(db->settings);
 559     new->settings = nmem_malloc(se->session_nmem,
 560                                 sizeof(struct settings *) * db->num_settings);
 561     new->num_settings = db->num_settings;
 562     for (i = 0; i < db->num_settings; i++)
 563     {
 564         struct setting *setting = db->settings[i];
 565         new->settings[i] = setting;
 566     }
 567     new->next = se->databases;
 568     se->databases = new;
 569 }
 570
 571 // Doesn't free memory associated with sdb -- nmem takes care of that
 572 static void session_database_destroy(struct session_database *sdb)
 573 {
 574     sdb->map = 0;
 575 }
 576
 577 // Initialize session_database list -- this represents this session's view
 578 // of the database list -- subject to modification by the settings ws command
 579 void session_init_databases(struct session *se)
 580 {
 581     se->databases = 0;
 582     predef_grep_databases(se, se->service, session_init_databases_fun);
 583 }
 584
 585 // Probably session_init_databases_fun should be refactored instead of
 586 // called here.
 587 static struct session_database *load_session_database(struct session *se,
 588                                                       char *id)
 589 {
 590     struct database *db = new_database(id, se->session_nmem);
 591
 592     resolve_database(se->service, db);
 593
 594     session_init_databases_fun((void*) se, db);
 595
 596     // New sdb is head of se->databases list
 597     return se->databases;
 598 }
 599
 600 // Find an existing session database. If not found, load it
 601 static struct session_database *find_session_database(struct session *se,
 602                                                       char *id)
 603 {
 604     struct session_database *sdb;
 605
 606     for (sdb = se->databases; sdb; sdb = sdb->next)
 607         if (!strcmp(sdb->database->url, id))
 608             return sdb;
 609     return load_session_database(se, id);
 610 }
 611
 612 // Apply a session override to a database
 613 void session_apply_setting(struct session *se, char *dbname, char *setting,
 614                            char *value)
 615 {
 616     struct session_database *sdb = find_session_database(se, dbname);
 617     struct conf_service *service = se->service;
 618     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 619     int offset = settings_create_offset(service, setting);
 620
 621     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
 622                           se->session_nmem);
 623     new->precedence = 0;
 624     new->target = dbname;
 625     new->name = setting;
 626     new->value = value;
 627     new->next = sdb->settings[offset];
 628     sdb->settings[offset] = new;
 629
 630     // Force later recompute of settings-driven data structures
 631     // (happens when a search starts and client connections are prepared)
 632     switch (offset)
 633     {
 634     case PZ_XSLT:
 635         if (sdb->map)
 636         {
 637             sdb->map = 0;
 638         }
 639         break;
 640     }
 641 }
 642
 643 void destroy_session(struct session *s)
 644 {
 645     struct session_database *sdb;
 646
 647     session_remove_clients(s);
 648
 649     for (sdb = s->databases; sdb; sdb = sdb->next)
 650         session_database_destroy(sdb);
 651     normalize_cache_destroy(s->normalize_cache);
 652     relevance_destroy(&s->relevance);
 653     reclist_destroy(s->reclist);
 654     nmem_destroy(s->nmem);
 655     service_destroy(s->service);
 656     yaz_mutex_destroy(&s->mutex);
 657     wrbuf_destroy(s->wrbuf);
 658 }
 659
 660 struct session *new_session(NMEM nmem, struct conf_service *service,
 661                             const char *name)
 662 {
 663     int i;
 664     struct session *session = nmem_malloc(nmem, sizeof(*session));
 665
 666     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
 667
 668     session->service = service;
 669     session->relevance = 0;
 670     session->total_hits = 0;
 671     session->total_records = 0;
 672     session->number_of_warnings_unknown_elements = 0;
 673     session->number_of_warnings_unknown_metadata = 0;
 674     session->num_termlists = 0;
 675     session->reclist = 0;
 676     session->clients = 0;
 677     session->session_nmem = nmem;
 678     session->nmem = nmem_create();
 679     session->wrbuf = wrbuf_alloc();
 680     session->databases = 0;
 681     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 682     {
 683         session->watchlist[i].data = 0;
 684         session->watchlist[i].fun = 0;
 685     }
 686     session->normalize_cache = normalize_cache_create();
 687     session->mutex = 0;
 688
 689     pazpar2_mutex_create(&session->mutex, name);
 690
 691     return session;
 692 }
 693
 694 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
 695 {
 696     struct hitsbytarget *res = 0;
 697     struct client *cl;
 698     size_t sz = 0;
 699
 700     session_enter(se);
 701     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 702         sz++;
 703
 704     res = nmem_malloc(nmem, sizeof(*res) * sz);
 705     *count = 0;
 706     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 707     {
 708         WRBUF w = wrbuf_alloc();
 709         const char *name = session_setting_oneval(client_get_database(cl),
 710                                                   PZ_NAME);
 711
 712         res[*count].id = client_get_database(cl)->database->url;
 713         res[*count].name = *name ? name : "Unknown";
 714         res[*count].hits = client_get_hits(cl);
 715         res[*count].records = client_get_num_records(cl);
 716         res[*count].diagnostic = client_get_diagnostic(cl);
 717         res[*count].state = client_get_state_str(cl);
 718         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 719         session_settings_dump(se, client_get_database(cl), w);
 720         res[*count].settings_xml = w;
 721         (*count)++;
 722     }
 723     session_leave(se);
 724     return res;
 725 }
 726
 727 struct termlist_score **termlist(struct session *s, const char *name, int *num)
 728 {
 729     int i;
 730     struct termlist_score **tl = 0;
 731
 732     session_enter(s);
 733     for (i = 0; i < s->num_termlists; i++)
 734         if (!strcmp((const char *) s->termlists[i].name, name))
 735         {
 736             tl = termlist_highscore(s->termlists[i].termlist, num);
 737             break;
 738         }
 739     session_leave(s);
 740     return tl;
 741 }
 742
 743 #ifdef MISSING_HEADERS
 744 void report_nmem_stats(void)
 745 {
 746     size_t in_use, is_free;
 747
 748     nmem_get_memory_in_use(&in_use);
 749     nmem_get_memory_free(&is_free);
 750
 751     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
 752             (long) in_use, (long) is_free);
 753 }
 754 #endif
 755
 756 struct record_cluster *show_single_start(struct session *s, const char *id,
 757                                          struct record_cluster **prev_r,
 758                                          struct record_cluster **next_r)
 759 {
 760     struct record_cluster *r;
 761
 762     session_enter(s);
 763     reclist_enter(s->reclist);
 764     *prev_r = 0;
 765     *next_r = 0;
 766     while ((r = reclist_read_record(s->reclist)))
 767     {
 768         if (!strcmp(r->recid, id))
 769         {
 770             *next_r = reclist_read_record(s->reclist);
 771             break;
 772         }
 773         *prev_r = r;
 774     }
 775     reclist_leave(s->reclist);
 776     if (!r)
 777         session_leave(s);
 778     return r;
 779 }
 780
 781 void show_single_stop(struct session *s, struct record_cluster *rec)
 782 {
 783     session_leave(s);
 784 }
 785
 786 struct record_cluster **show_range_start(struct session *s,
 787                                          struct reclist_sortparms *sp,
 788                                          int start, int *num, int *total, Odr_int *sumhits)
 789 {
 790     struct record_cluster **recs = nmem_malloc(s->nmem, *num
 791                                                * sizeof(struct record_cluster *));
 792     struct reclist_sortparms *spp;
 793     int i;
 794 #if USE_TIMING
 795     yaz_timing_t t = yaz_timing_create();
 796 #endif
 797
 798     session_enter(s);
 799     if (!s->relevance)
 800     {
 801         *num = 0;
 802         *total = 0;
 803         *sumhits = 0;
 804         recs = 0;
 805     }
 806     else
 807     {
 808         for (spp = sp; spp; spp = spp->next)
 809             if (spp->type == Metadata_sortkey_relevance)
 810             {
 811                 relevance_prepare_read(s->relevance, s->reclist);
 812                 break;
 813             }
 814         reclist_sort(s->reclist, sp);
 815
 816         reclist_enter(s->reclist);
 817         *total = reclist_get_num_records(s->reclist);
 818         *sumhits = s->total_hits;
 819
 820         for (i = 0; i < start; i++)
 821             if (!reclist_read_record(s->reclist))
 822             {
 823                 *num = 0;
 824                 recs = 0;
 825                 break;
 826             }
 827
 828         for (i = 0; i < *num; i++)
 829         {
 830             struct record_cluster *r = reclist_read_record(s->reclist);
 831             if (!r)
 832             {
 833                 *num = i;
 834                 break;
 835             }
 836             recs[i] = r;
 837         }
 838         reclist_leave(s->reclist);
 839     }
 840 #if USE_TIMING
 841     yaz_timing_stop(t);
 842     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
 843             yaz_timing_get_real(t), yaz_timing_get_user(t),
 844             yaz_timing_get_sys(t));
 845     yaz_timing_destroy(&t);
 846 #endif
 847     return recs;
 848 }
 849
 850 void show_range_stop(struct session *s, struct record_cluster **recs)
 851 {
 852     session_leave(s);
 853 }
 854
 855 void statistics(struct session *se, struct statistics *stat)
 856 {
 857     struct client *cl;
 858     int count = 0;
 859
 860     memset(stat, 0, sizeof(*stat));
 861     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 862     {
 863         if (!client_get_connection(cl))
 864             stat->num_no_connection++;
 865         switch (client_get_state(cl))
 866         {
 867         case Client_Connecting: stat->num_connecting++; break;
 868         case Client_Working: stat->num_working++; break;
 869         case Client_Idle: stat->num_idle++; break;
 870         case Client_Failed: stat->num_failed++; break;
 871         case Client_Error: stat->num_error++; break;
 872         default: break;
 873         }
 874         count++;
 875     }
 876     stat->num_hits = se->total_hits;
 877     stat->num_records = se->total_records;
 878
 879     stat->num_clients = count;
 880 }
 881
 882 static struct record_metadata *record_metadata_init(
 883     NMEM nmem, const char *value, enum conf_metadata_type type,
 884     struct _xmlAttr *attr)
 885 {
 886     struct record_metadata *rec_md = record_metadata_create(nmem);
 887     struct record_metadata_attr **attrp = &rec_md->attributes;
 888
 889     for (; attr; attr = attr->next)
 890     {
 891         if (attr->children && attr->children->content)
 892         {
 893             if (strcmp((const char *) attr->name, "type"))
 894             {  /* skip the "type" attribute.. Its value is already part of
 895                   the element in output (md-%s) and so repeating it here
 896                   is redundant */
 897                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
 898                 (*attrp)->name =
 899                     nmem_strdup(nmem, (const char *) attr->name);
 900                 (*attrp)->value =
 901                     nmem_strdup(nmem, (const char *) attr->children->content);
 902                 attrp = &(*attrp)->next;
 903             }
 904         }
 905     }
 906     *attrp = 0;
 907
 908     if (type == Metadata_type_generic)
 909     {
 910         char *p = nmem_strdup(nmem, value);
 911
 912         p = normalize7bit_generic(p, " ,/.:([");
 913
 914         rec_md->data.text.disp = p;
 915         rec_md->data.text.sort = 0;
 916     }
 917     else if (type == Metadata_type_year || type == Metadata_type_date)
 918     {
 919         int first, last;
 920         int longdate = 0;
 921
 922         if (type == Metadata_type_date)
 923             longdate = 1;
 924         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
 925             return 0;
 926
 927         rec_md->data.number.min = first;
 928         rec_md->data.number.max = last;
 929     }
 930     else
 931         return 0;
 932     return rec_md;
 933 }
 934
 935 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
 936                                  struct conf_service *service, WRBUF norm_wr)
 937 {
 938     xmlNode *n;
 939     int no_found = 0;
 940     for (n = root->children; n; n = n->next)
 941     {
 942         if (n->type != XML_ELEMENT_NODE)
 943             continue;
 944         if (!strcmp((const char *) n->name, "metadata"))
 945         {
 946             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
 947             if (!strcmp(name, (const char *) type))
 948             {
 949                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
 950                 if (value)
 951                 {
 952                     const char *norm_str;
 953                     pp2_relevance_token_t prt =
 954                         pp2_relevance_tokenize(service->mergekey_pct);
 955
 956                     pp2_relevance_first(prt, (const char *) value, 0);
 957                     if (wrbuf_len(norm_wr) > 0)
 958                         wrbuf_puts(norm_wr, " ");
 959                     wrbuf_puts(norm_wr, name);
 960                     while ((norm_str =
 961                             pp2_relevance_token_next(prt)))
 962                     {
 963                         if (*norm_str)
 964                         {
 965                             wrbuf_puts(norm_wr, " ");
 966                             wrbuf_puts(norm_wr, norm_str);
 967                         }
 968                     }
 969                     xmlFree(value);
 970                     pp2_relevance_token_destroy(prt);
 971                     no_found++;
 972                 }
 973             }
 974             xmlFree(type);
 975         }
 976     }
 977     return no_found;
 978 }
 979
 980 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
 981                                 struct conf_service *service, NMEM nmem)
 982 {
 983     char *mergekey_norm = 0;
 984     xmlNode *root = xmlDocGetRootElement(doc);
 985     WRBUF norm_wr = wrbuf_alloc();
 986
 987     /* consider mergekey from XSL first */
 988     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
 989     if (mergekey)
 990     {
 991         const char *norm_str;
 992         pp2_relevance_token_t prt =
 993             pp2_relevance_tokenize(service->mergekey_pct);
 994
 995         pp2_relevance_first(prt, (const char *) mergekey, 0);
 996         while ((norm_str = pp2_relevance_token_next(prt)))
 997         {
 998             if (*norm_str)
 999             {
1000                 if (wrbuf_len(norm_wr))
1001                     wrbuf_puts(norm_wr, " ");
1002                 wrbuf_puts(norm_wr, norm_str);
1003             }
1004         }
1005         pp2_relevance_token_destroy(prt);
1006         xmlFree(mergekey);
1007     }
1008     else
1009     {
1010         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1011         int field_id;
1012         for (field_id = 0; field_id < service->num_metadata; field_id++)
1013         {
1014             struct conf_metadata *ser_md = &service->metadata[field_id];
1015             if (ser_md->mergekey != Metadata_mergekey_no)
1016             {
1017                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1018                                               service, norm_wr);
1019                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1020                 {
1021                     /* no mergekey on this one and it is required..
1022                        Generate unique key instead */
1023                     wrbuf_rewind(norm_wr);
1024                     break;
1025                 }
1026             }
1027         }
1028     }
1029
1030     /* generate unique key if none is not generated already or is empty */
1031     if (wrbuf_len(norm_wr) == 0)
1032     {
1033         wrbuf_printf(norm_wr, "%s-%d",
1034                      client_get_database(cl)->database->url, record_no);
1035     }
1036     if (wrbuf_len(norm_wr) > 0)
1037         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1038     wrbuf_destroy(norm_wr);
1039     return mergekey_norm;
1040 }
1041
1042 /** \brief see if metadata for pz:recordfilter exists
1043     \param root xml root element of normalized record
1044     \param sdb session database for client
1045     \retval 0 if there is no metadata for pz:recordfilter
1046     \retval 1 if there is metadata for pz:recordfilter
1047
1048     If there is no pz:recordfilter defined, this function returns 1
1049     as well.
1050 */
1051
1052 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1053 {
1054     int match = 0;
1055     xmlNode *n;
1056     const char *s;
1057     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1058
1059     if (!s || !*s)
1060         return 1;
1061
1062     for (n = root->children; n; n = n->next)
1063     {
1064         if (n->type != XML_ELEMENT_NODE)
1065             continue;
1066         if (!strcmp((const char *) n->name, "metadata"))
1067         {
1068             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1069             if (type)
1070             {
1071                 size_t len;
1072                 const char *eq = strchr(s, '~');
1073                 if (eq)
1074                     len = eq - s;
1075                 else
1076                     len = strlen(s);
1077                 if (len == strlen((const char *)type) &&
1078                     !memcmp((const char *) type, s, len))
1079                 {
1080                     xmlChar *value = xmlNodeGetContent(n);
1081                     if (value && *value)
1082                     {
1083                         if (!eq || strstr((const char *) value, eq+1))
1084                             match = 1;
1085                     }
1086                     xmlFree(value);
1087                 }
1088                 xmlFree(type);
1089             }
1090         }
1091     }
1092     return match;
1093 }
1094
1095
1096 static int ingest_to_cluster(struct client *cl,
1097                              xmlDoc *xdoc,
1098                              xmlNode *root,
1099                              int record_no,
1100                              const char *mergekey_norm);
1101
1102 /** \brief ingest XML record
1103     \param cl client holds the result set for record
1104     \param rec record buffer (0 terminated)
1105     \param record_no record position (1, 2, ..)
1106     \retval 0 OK
1107     \retval -1 failure
1108 */
1109 int ingest_record(struct client *cl, const char *rec,
1110                   int record_no, NMEM nmem)
1111 {
1112     struct session *se = client_get_session(cl);
1113     int ret;
1114     struct session_database *sdb = client_get_database(cl);
1115     struct conf_service *service = se->service;
1116     xmlDoc *xdoc = normalize_record(sdb, service, rec, nmem);
1117     xmlNode *root;
1118     const char *mergekey_norm;
1119
1120     if (!xdoc)
1121         return -1;
1122
1123     root = xmlDocGetRootElement(xdoc);
1124
1125     if (!check_record_filter(root, sdb))
1126     {
1127         yaz_log(YLOG_WARN, "Filtered out record no %d from %s", record_no,
1128                 sdb->database->url);
1129         xmlFreeDoc(xdoc);
1130         return -1;
1131     }
1132
1133     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1134     if (!mergekey_norm)
1135     {
1136         yaz_log(YLOG_WARN, "Got no mergekey");
1137         xmlFreeDoc(xdoc);
1138         return -1;
1139     }
1140     session_enter(se);
1141     ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1142     session_leave(se);
1143
1144     xmlFreeDoc(xdoc);
1145     return ret;
1146 }
1147
1148 static int ingest_to_cluster(struct client *cl,
1149                              xmlDoc *xdoc,
1150                              xmlNode *root,
1151                              int record_no,
1152                              const char *mergekey_norm)
1153 {
1154     xmlNode *n;
1155     xmlChar *type = 0;
1156     xmlChar *value = 0;
1157     struct session_database *sdb = client_get_database(cl);
1158     struct session *se = client_get_session(cl);
1159     struct conf_service *service = se->service;
1160     struct record *record = record_create(se->nmem,
1161                                           service->num_metadata,
1162                                           service->num_sortkeys, cl,
1163                                           record_no);
1164     struct record_cluster *cluster = reclist_insert(se->reclist,
1165                                                     service,
1166                                                     record,
1167                                                     mergekey_norm,
1168                                                     &se->total_merged);
1169     if (!cluster)
1170         return -1;
1171     if (global_parameters.dump_records)
1172         yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1173                 sdb->database->url, record_no);
1174     relevance_newrec(se->relevance, cluster);
1175
1176     // now parsing XML record and adding data to cluster or record metadata
1177     for (n = root->children; n; n = n->next)
1178     {
1179         pp2_relevance_token_t prt;
1180         if (type)
1181             xmlFree(type);
1182         if (value)
1183             xmlFree(value);
1184         type = value = 0;
1185
1186         if (n->type != XML_ELEMENT_NODE)
1187             continue;
1188         if (!strcmp((const char *) n->name, "metadata"))
1189         {
1190             struct conf_metadata *ser_md = 0;
1191             struct conf_sortkey *ser_sk = 0;
1192             struct record_metadata **wheretoput = 0;
1193             struct record_metadata *rec_md = 0;
1194             int md_field_id = -1;
1195             int sk_field_id = -1;
1196
1197             type = xmlGetProp(n, (xmlChar *) "type");
1198             value = xmlNodeListGetString(xdoc, n->children, 1);
1199
1200             if (!type || !value || !*value)
1201                 continue;
1202
1203             md_field_id
1204                 = conf_service_metadata_field_id(service, (const char *) type);
1205             if (md_field_id < 0)
1206             {
1207                 if (se->number_of_warnings_unknown_metadata == 0)
1208                 {
1209                     yaz_log(YLOG_WARN,
1210                             "Ignoring unknown metadata element: %s", type);
1211                 }
1212                 se->number_of_warnings_unknown_metadata++;
1213                 continue;
1214             }
1215
1216             ser_md = &service->metadata[md_field_id];
1217
1218             if (ser_md->sortkey_offset >= 0){
1219                 sk_field_id = ser_md->sortkey_offset;
1220                 ser_sk = &service->sortkeys[sk_field_id];
1221             }
1222
1223             // non-merged metadata
1224             rec_md = record_metadata_init(se->nmem, (const char *) value,
1225                                           ser_md->type, n->properties);
1226             if (!rec_md)
1227             {
1228                 yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
1229                         value, type);
1230                 continue;
1231             }
1232             wheretoput = &record->metadata[md_field_id];
1233             while (*wheretoput)
1234                 wheretoput = &(*wheretoput)->next;
1235             *wheretoput = rec_md;
1236
1237             // merged metadata
1238             rec_md = record_metadata_init(se->nmem, (const char *) value,
1239                                           ser_md->type, 0);
1240             wheretoput = &cluster->metadata[md_field_id];
1241
1242             // and polulate with data:
1243             // assign cluster or record based on merge action
1244             if (ser_md->merge == Metadata_merge_unique)
1245             {
1246                 struct record_metadata *mnode;
1247                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1248                     if (!strcmp((const char *) mnode->data.text.disp,
1249                                 rec_md->data.text.disp))
1250                         break;
1251                 if (!mnode)
1252                 {
1253                     rec_md->next = *wheretoput;
1254                     *wheretoput = rec_md;
1255                 }
1256             }
1257             else if (ser_md->merge == Metadata_merge_longest)
1258             {
1259                 if (!*wheretoput
1260                     || strlen(rec_md->data.text.disp)
1261                     > strlen((*wheretoput)->data.text.disp))
1262                 {
1263                     *wheretoput = rec_md;
1264                     if (ser_sk)
1265                     {
1266                         const char *sort_str = 0;
1267                         int skip_article =
1268                             ser_sk->type == Metadata_sortkey_skiparticle;
1269
1270                         if (!cluster->sortkeys[sk_field_id])
1271                             cluster->sortkeys[sk_field_id] =
1272                                 nmem_malloc(se->nmem,
1273                                             sizeof(union data_types));
1274
1275                         prt = pp2_relevance_tokenize(service->sort_pct);
1276
1277                         pp2_relevance_first(prt, rec_md->data.text.disp,
1278                                             skip_article);
1279
1280                         pp2_relevance_token_next(prt);
1281
1282                         sort_str = pp2_get_sort(prt);
1283
1284                         cluster->sortkeys[sk_field_id]->text.disp =
1285                             rec_md->data.text.disp;
1286                         if (!sort_str)
1287                         {
1288                             sort_str = rec_md->data.text.disp;
1289                             yaz_log(YLOG_WARN,
1290                                     "Could not make sortkey. Bug #1858");
1291                         }
1292                         cluster->sortkeys[sk_field_id]->text.sort =
1293                             nmem_strdup(se->nmem, sort_str);
1294 #if 0
1295                         yaz_log(YLOG_LOG, "text disp=%s",
1296                                 cluster->sortkeys[sk_field_id]->text.disp);
1297                         yaz_log(YLOG_LOG, "text sort=%s",
1298                                 cluster->sortkeys[sk_field_id]->text.sort);
1299 #endif
1300                         pp2_relevance_token_destroy(prt);
1301                     }
1302                 }
1303             }
1304             else if (ser_md->merge == Metadata_merge_all)
1305             {
1306                 rec_md->next = *wheretoput;
1307                 *wheretoput = rec_md;
1308             }
1309             else if (ser_md->merge == Metadata_merge_range)
1310             {
1311                 if (!*wheretoput)
1312                 {
1313                     *wheretoput = rec_md;
1314                     if (ser_sk)
1315                         cluster->sortkeys[sk_field_id]
1316                             = &rec_md->data;
1317                 }
1318                 else
1319                 {
1320                     int this_min = rec_md->data.number.min;
1321                     int this_max = rec_md->data.number.max;
1322                     if (this_min < (*wheretoput)->data.number.min)
1323                         (*wheretoput)->data.number.min = this_min;
1324                     if (this_max > (*wheretoput)->data.number.max)
1325                         (*wheretoput)->data.number.max = this_max;
1326                 }
1327             }
1328
1329
1330             // ranking of _all_ fields enabled ...
1331             if (ser_md->rank)
1332                 relevance_countwords(se->relevance, cluster,
1333                                      (char *) value, ser_md->rank,
1334                                      ser_md->name);
1335
1336             // construct facets ...
1337             if (ser_md->termlist)
1338             {
1339                 if (ser_md->type == Metadata_type_year)
1340                 {
1341                     char year[64];
1342                     sprintf(year, "%d", rec_md->data.number.max);
1343                     add_facet(se, (char *) type, year);
1344                     if (rec_md->data.number.max != rec_md->data.number.min)
1345                     {
1346                         sprintf(year, "%d", rec_md->data.number.min);
1347                         add_facet(se, (char *) type, year);
1348                     }
1349                 }
1350                 else
1351                     add_facet(se, (char *) type, (char *) value);
1352             }
1353
1354             // cleaning up
1355             xmlFree(type);
1356             xmlFree(value);
1357             type = value = 0;
1358         }
1359         else
1360         {
1361             if (se->number_of_warnings_unknown_elements == 0)
1362                 yaz_log(YLOG_WARN,
1363                         "Unexpected element in internal record: %s", n->name);
1364             se->number_of_warnings_unknown_elements++;
1365         }
1366     }
1367     if (type)
1368         xmlFree(type);
1369     if (value)
1370         xmlFree(value);
1371
1372     relevance_donerecord(se->relevance, cluster);
1373     se->total_records++;
1374
1375     return 0;
1376 }
1377
1378 /*
1379  * Local variables:
1380  * c-basic-offset: 4
1381  * c-file-style: "Stroustrup"
1382  * indent-tabs-mode: nil
1383  * End:
1384  * vim: shiftwidth=4 tabstop=8 expandtab
1385  */
1386