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 "parameters.h"
  61 #include "session.h"
  62 #include "eventl.h"
  63 #include "http.h"
  64 #include "termlists.h"
  65 #include "reclists.h"
  66 #include "relevance.h"
  67 #include "database.h"
  68 #include "client.h"
  69 #include "settings.h"
  70 #include "normalize7bit.h"
  71
  72 #define TERMLIST_HIGH_SCORE 25
  73
  74 #define MAX_CHUNK 15
  75
  76 // Note: Some things in this structure will eventually move to configuration
  77 struct parameters global_parameters =
  78 {
  79     0,   // dump_records
  80     0    // debug_mode
  81 };
  82
  83 static void log_xml_doc(xmlDoc *doc)
  84 {
  85     FILE *lf = yaz_log_file();
  86     xmlChar *result = 0;
  87     int len = 0;
  88 #if LIBXML_VERSION >= 20600
  89     xmlDocDumpFormatMemory(doc, &result, &len, 1);
  90 #else
  91     xmlDocDumpMemory(doc, &result, &len);
  92 #endif
  93     if (lf && len)
  94     {
  95         (void) fwrite(result, 1, len, lf);
  96         fprintf(lf, "\n");
  97     }
  98     xmlFree(result);
  99 }
 100
 101 static void session_enter(struct session *s)
 102 {
 103     yaz_mutex_enter(s->mutex);
 104 }
 105
 106 static void session_leave(struct session *s)
 107 {
 108     yaz_mutex_leave(s->mutex);
 109 }
 110
 111 // Recursively traverse query structure to extract terms.
 112 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
 113 {
 114     char **words;
 115     int numwords;
 116     int i;
 117
 118     switch (n->kind)
 119     {
 120     case CCL_RPN_AND:
 121     case CCL_RPN_OR:
 122     case CCL_RPN_NOT:
 123     case CCL_RPN_PROX:
 124         pull_terms(nmem, n->u.p[0], termlist, num);
 125         pull_terms(nmem, n->u.p[1], termlist, num);
 126         break;
 127     case CCL_RPN_TERM:
 128         nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
 129         for (i = 0; i < numwords; i++)
 130             termlist[(*num)++] = words[i];
 131         break;
 132     default: // NOOP
 133         break;
 134     }
 135 }
 136
 137
 138 static void add_facet(struct session *s, const char *type, const char *value)
 139 {
 140     int i;
 141
 142     if (!*value)
 143         return;
 144     for (i = 0; i < s->num_termlists; i++)
 145         if (!strcmp(s->termlists[i].name, type))
 146             break;
 147     if (i == s->num_termlists)
 148     {
 149         if (i == SESSION_MAX_TERMLISTS)
 150         {
 151             yaz_log(YLOG_FATAL, "Too many termlists");
 152             return;
 153         }
 154
 155         s->termlists[i].name = nmem_strdup(s->nmem, type);
 156         s->termlists[i].termlist
 157             = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
 158         s->num_termlists = i + 1;
 159     }
 160     termlist_insert(s->termlists[i].termlist, value);
 161 }
 162
 163 static xmlDoc *record_to_xml(struct session_database *sdb, const char *rec)
 164 {
 165     struct database *db = sdb->database;
 166     xmlDoc *rdoc = 0;
 167
 168     rdoc = xmlParseMemory(rec, strlen(rec));
 169
 170     if (!rdoc)
 171     {
 172         yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s",
 173                 db->url);
 174         return 0;
 175     }
 176
 177     if (global_parameters.dump_records)
 178     {
 179         yaz_log(YLOG_LOG, "Un-normalized record from %s", db->url);
 180         log_xml_doc(rdoc);
 181     }
 182
 183     return rdoc;
 184 }
 185
 186 #define MAX_XSLT_ARGS 16
 187
 188 // Add static values from session database settings if applicable
 189 static void insert_settings_parameters(struct session_database *sdb,
 190                                        struct conf_service *service,
 191                                        char **parms,
 192                                        NMEM nmem)
 193 {
 194     int i;
 195     int nparms = 0;
 196     int offset = 0;
 197
 198     for (i = 0; i < service->num_metadata; i++)
 199     {
 200         struct conf_metadata *md = &service->metadata[i];
 201         int setting;
 202
 203         if (md->setting == Metadata_setting_parameter &&
 204             (setting = settings_lookup_offset(service, md->name)) >= 0)
 205         {
 206             const char *val = session_setting_oneval(sdb, setting);
 207             if (val && nparms < MAX_XSLT_ARGS)
 208             {
 209                 char *buf;
 210                 int len = strlen(val);
 211                 buf = nmem_malloc(nmem, len + 3);
 212                 buf[0] = '\'';
 213                 strcpy(buf + 1, val);
 214                 buf[len+1] = '\'';
 215                 buf[len+2] = '\0';
 216                 parms[offset++] = md->name;
 217                 parms[offset++] = buf;
 218                 nparms++;
 219             }
 220         }
 221     }
 222     parms[offset] = 0;
 223 }
 224
 225 // Add static values from session database settings if applicable
 226 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
 227     struct conf_service *service)
 228 {
 229     int i;
 230
 231     for (i = 0; i < service->num_metadata; i++)
 232     {
 233         struct conf_metadata *md = &service->metadata[i];
 234         int offset;
 235
 236         if (md->setting == Metadata_setting_postproc &&
 237             (offset = settings_lookup_offset(service, md->name)) >= 0)
 238         {
 239             const char *val = session_setting_oneval(sdb, offset);
 240             if (val)
 241             {
 242                 xmlNode *r = xmlDocGetRootElement(doc);
 243                 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
 244                                              (xmlChar *) val);
 245                 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
 246             }
 247         }
 248     }
 249 }
 250
 251 static xmlDoc *normalize_record(struct session_database *sdb,
 252                                 struct conf_service *service,
 253                                 const char *rec, NMEM nmem)
 254 {
 255     xmlDoc *rdoc = record_to_xml(sdb, rec);
 256
 257     if (rdoc)
 258     {
 259         char *parms[MAX_XSLT_ARGS*2+1];
 260
 261         insert_settings_parameters(sdb, service, parms, nmem);
 262
 263         if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
 264         {
 265             yaz_log(YLOG_WARN, "Normalize failed from %s", sdb->database->url);
 266         }
 267         else
 268         {
 269             insert_settings_values(sdb, rdoc, service);
 270
 271             if (global_parameters.dump_records)
 272             {
 273                 yaz_log(YLOG_LOG, "Normalized record from %s",
 274                         sdb->database->url);
 275                 log_xml_doc(rdoc);
 276             }
 277         }
 278     }
 279     return rdoc;
 280 }
 281
 282 void session_settings_dump(struct session *se,
 283                            struct session_database *db,
 284                            WRBUF w)
 285 {
 286     if (db->settings)
 287     {
 288         int i, num = db->num_settings;
 289         for (i = 0; i < num; i++)
 290         {
 291             struct setting *s = db->settings[i];
 292             for (;s ; s = s->next)
 293             {
 294                 wrbuf_puts(w, "<set name=\"");
 295                 wrbuf_xmlputs(w, s->name);
 296                 wrbuf_puts(w, "\" value=\"");
 297                 wrbuf_xmlputs(w, s->value);
 298                 wrbuf_puts(w, "\"/>");
 299             }
 300             if (db->settings[i])
 301                 wrbuf_puts(w, "\n");
 302         }
 303     }
 304 }
 305
 306 // Retrieve first defined value for 'name' for given database.
 307 // Will be extended to take into account user associated with session
 308 const char *session_setting_oneval(struct session_database *db, int offset)
 309 {
 310     if (offset >= db->num_settings || !db->settings[offset])
 311         return "";
 312     return db->settings[offset]->value;
 313 }
 314
 315 // Prepare XSLT stylesheets for record normalization
 316 // Structures are allocated on the session_wide nmem to avoid having
 317 // to recompute this for every search. This would lead
 318 // to leaking if a single session was to repeatedly change the PZ_XSLT
 319 // setting. However, this is not a realistic use scenario.
 320 static int prepare_map(struct session *se, struct session_database *sdb)
 321 {
 322     const char *s;
 323
 324     if (!sdb->settings)
 325     {
 326         yaz_log(YLOG_WARN, "No settings on %s", sdb->database->url);
 327         return -1;
 328     }
 329     if ((s = session_setting_oneval(sdb, PZ_XSLT)))
 330     {
 331         char auto_stylesheet[256];
 332
 333         if (!strcmp(s, "auto"))
 334         {
 335             const char *request_syntax = session_setting_oneval(
 336                 sdb, PZ_REQUESTSYNTAX);
 337             if (request_syntax)
 338             {
 339                 char *cp;
 340                 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
 341                              "%s.xsl", request_syntax);
 342                 for (cp = auto_stylesheet; *cp; cp++)
 343                 {
 344                     /* deliberately only consider ASCII */
 345                     if (*cp > 32 && *cp < 127)
 346                         *cp = tolower(*cp);
 347                 }
 348                 s = auto_stylesheet;
 349             }
 350             else
 351             {
 352                 yaz_log(YLOG_WARN, "No pz:requestsyntax for auto stylesheet");
 353             }
 354         }
 355         sdb->map = normalize_cache_get(se->normalize_cache,
 356                                        se->service, s);
 357         if (!sdb->map)
 358             return -1;
 359     }
 360     return 0;
 361 }
 362
 363 // This analyzes settings and recomputes any supporting data structures
 364 // if necessary.
 365 static int prepare_session_database(struct session *se,
 366                                     struct session_database *sdb)
 367 {
 368     if (!sdb->settings)
 369     {
 370         yaz_log(YLOG_WARN,
 371                 "No settings associated with %s", sdb->database->url);
 372         return -1;
 373     }
 374     if (sdb->settings[PZ_XSLT] && !sdb->map)
 375     {
 376         if (prepare_map(se, sdb) < 0)
 377             return -1;
 378     }
 379     return 0;
 380 }
 381
 382 // called if watch should be removed because http_channel is to be destroyed
 383 static void session_watch_cancel(void *data, struct http_channel *c,
 384                                  void *data2)
 385 {
 386     struct session_watchentry *ent = data;
 387
 388     ent->fun = 0;
 389     ent->data = 0;
 390     ent->obs = 0;
 391 }
 392
 393 // set watch. Returns 0=OK, -1 if watch is already set
 394 int session_set_watch(struct session *s, int what,
 395                       session_watchfun fun, void *data,
 396                       struct http_channel *chan)
 397 {
 398     int ret;
 399     session_enter(s);
 400     if (s->watchlist[what].fun)
 401         ret = -1;
 402     else
 403     {
 404
 405         s->watchlist[what].fun = fun;
 406         s->watchlist[what].data = data;
 407         s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
 408                                                    session_watch_cancel);
 409         ret = 0;
 410     }
 411     session_leave(s);
 412     return 0;
 413 }
 414
 415 void session_alert_watch(struct session *s, int what)
 416 {
 417     assert(s);
 418     session_enter(s);
 419     if (s->watchlist[what].fun)
 420     {
 421         /* our watch is no longer associated with http_channel */
 422         void *data;
 423         session_watchfun fun;
 424
 425         http_remove_observer(s->watchlist[what].obs);
 426         fun = s->watchlist[what].fun;
 427         data = s->watchlist[what].data;
 428
 429         /* reset watch before fun is invoked - in case fun wants to set
 430            it again */
 431         s->watchlist[what].fun = 0;
 432         s->watchlist[what].data = 0;
 433         s->watchlist[what].obs = 0;
 434
 435         session_leave(s);
 436         fun(data);
 437     }
 438     else
 439         session_leave(s);
 440 }
 441
 442 //callback for grep_databases
 443 static void select_targets_callback(void *context, struct session_database *db)
 444 {
 445     struct session *se = (struct session*) context;
 446     struct client *cl = client_create();
 447     client_set_database(cl, db);
 448     client_set_session(cl, se);
 449 }
 450
 451 static void session_remove_clients(struct session *se)
 452 {
 453     struct client *cl = se->clients;
 454     while (cl)
 455     {
 456         struct client *cl_next = client_next_in_session(cl);
 457         client_remove_from_session(cl);
 458         client_destroy(cl);
 459         cl = cl_next;
 460     }
 461     se->clients = 0;
 462 }
 463
 464 // Associates a set of clients with a session;
 465 // Note: Session-databases represent databases with per-session
 466 // setting overrides
 467 static int select_targets(struct session *se, const char *filter)
 468 {
 469     session_remove_clients(se);
 470     return session_grep_databases(se, filter, select_targets_callback);
 471 }
 472
 473 int session_active_clients(struct session *s)
 474 {
 475     struct client *c;
 476     int res = 0;
 477
 478     for (c = s->clients; c; c = client_next_in_session(c))
 479         if (client_is_active(c))
 480             res++;
 481
 482     return res;
 483 }
 484
 485
 486 enum pazpar2_error_code search(struct session *se,
 487                                const char *query,
 488                                const char *startrecs, const char *maxrecs,
 489                                const char *filter,
 490                                const char **addinfo)
 491 {
 492     int live_channels = 0;
 493     int no_working = 0;
 494     int no_failed = 0;
 495     struct client *cl;
 496
 497     yaz_log(YLOG_DEBUG, "Search");
 498
 499     *addinfo = 0;
 500
 501     session_enter(se);
 502     reclist_destroy(se->reclist);
 503     se->reclist = 0;
 504     nmem_reset(se->nmem);
 505     se->relevance = 0;
 506     se->total_records = se->total_hits = se->total_merged = 0;
 507     se->num_termlists = 0;
 508     live_channels = select_targets(se, filter);
 509     if (!live_channels)
 510     {
 511         session_leave(se);
 512         return PAZPAR2_NO_TARGETS;
 513     }
 514     se->reclist = reclist_create(se->nmem);
 515
 516     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 517     {
 518         if (maxrecs)
 519             client_set_maxrecs(cl, atoi(maxrecs));
 520         if (startrecs)
 521             client_set_startrecs(cl, atoi(startrecs));
 522         if (prepare_session_database(se, client_get_database(cl)) < 0)
 523             continue;
 524         // Parse query for target
 525         if (client_parse_query(cl, query) < 0)
 526             no_failed++;
 527         else
 528         {
 529             no_working++;
 530             if (client_prep_connection(cl, se->service->z3950_operation_timeout,
 531                                        se->service->z3950_session_timeout,
 532                                        se->service->server->iochan_man))
 533                 client_start_search(cl);
 534         }
 535     }
 536     session_leave(se);
 537     if (no_working == 0)
 538     {
 539         if (no_failed > 0)
 540         {
 541             *addinfo = "query";
 542             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 543         }
 544         else
 545             return PAZPAR2_NO_TARGETS;
 546     }
 547     return PAZPAR2_NO_ERROR;
 548 }
 549
 550 // Creates a new session_database object for a database
 551 static void session_init_databases_fun(void *context, struct database *db)
 552 {
 553     struct session *se = (struct session *) context;
 554     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 555     int i;
 556
 557     new->database = db;
 558
 559     new->map = 0;
 560     assert(db->settings);
 561     new->settings = nmem_malloc(se->session_nmem,
 562                                 sizeof(struct settings *) * db->num_settings);
 563     new->num_settings = db->num_settings;
 564     for (i = 0; i < db->num_settings; i++)
 565     {
 566         struct setting *setting = db->settings[i];
 567         new->settings[i] = setting;
 568     }
 569     new->next = se->databases;
 570     se->databases = new;
 571 }
 572
 573 // Doesn't free memory associated with sdb -- nmem takes care of that
 574 static void session_database_destroy(struct session_database *sdb)
 575 {
 576     sdb->map = 0;
 577 }
 578
 579 // Initialize session_database list -- this represents this session's view
 580 // of the database list -- subject to modification by the settings ws command
 581 void session_init_databases(struct session *se)
 582 {
 583     se->databases = 0;
 584     predef_grep_databases(se, se->service, session_init_databases_fun);
 585 }
 586
 587 // Probably session_init_databases_fun should be refactored instead of
 588 // called here.
 589 static struct session_database *load_session_database(struct session *se,
 590                                                       char *id)
 591 {
 592     struct database *db = new_database(id, se->session_nmem);
 593
 594     resolve_database(se->service, db);
 595
 596     session_init_databases_fun((void*) se, db);
 597
 598     // New sdb is head of se->databases list
 599     return se->databases;
 600 }
 601
 602 // Find an existing session database. If not found, load it
 603 static struct session_database *find_session_database(struct session *se,
 604                                                       char *id)
 605 {
 606     struct session_database *sdb;
 607
 608     for (sdb = se->databases; sdb; sdb = sdb->next)
 609         if (!strcmp(sdb->database->url, id))
 610             return sdb;
 611     return load_session_database(se, id);
 612 }
 613
 614 // Apply a session override to a database
 615 void session_apply_setting(struct session *se, char *dbname, char *setting,
 616                            char *value)
 617 {
 618     struct session_database *sdb = find_session_database(se, dbname);
 619     struct conf_service *service = se->service;
 620     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 621     int offset = settings_create_offset(service, setting);
 622
 623     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
 624                           se->session_nmem);
 625     new->precedence = 0;
 626     new->target = dbname;
 627     new->name = setting;
 628     new->value = value;
 629     new->next = sdb->settings[offset];
 630     sdb->settings[offset] = new;
 631
 632     // Force later recompute of settings-driven data structures
 633     // (happens when a search starts and client connections are prepared)
 634     switch (offset)
 635     {
 636     case PZ_XSLT:
 637         if (sdb->map)
 638         {
 639             sdb->map = 0;
 640         }
 641         break;
 642     }
 643 }
 644
 645 void destroy_session(struct session *s)
 646 {
 647     struct session_database *sdb;
 648
 649     session_remove_clients(s);
 650
 651     for (sdb = s->databases; sdb; sdb = sdb->next)
 652         session_database_destroy(sdb);
 653     normalize_cache_destroy(s->normalize_cache);
 654     reclist_destroy(s->reclist);
 655     nmem_destroy(s->nmem);
 656     service_destroy(s->service);
 657     yaz_mutex_destroy(&s->mutex);
 658     wrbuf_destroy(s->wrbuf);
 659 }
 660
 661 struct session *new_session(NMEM nmem, struct conf_service *service)
 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     yaz_mutex_create(&session->mutex);
 689     yaz_mutex_set_name(session->mutex, "session");
 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(
 955                             service->mergekey_pct,
 956                             (const char *) value, 0);
 957
 958                     if (wrbuf_len(norm_wr) > 0)
 959                         wrbuf_puts(norm_wr, " ");
 960                     wrbuf_puts(norm_wr, name);
 961                     while ((norm_str =
 962                             pp2_relevance_token_next(prt)))
 963                     {
 964                         if (*norm_str)
 965                         {
 966                             wrbuf_puts(norm_wr, " ");
 967                             wrbuf_puts(norm_wr, norm_str);
 968                         }
 969                     }
 970                     xmlFree(value);
 971                     pp2_relevance_token_destroy(prt);
 972                     no_found++;
 973                 }
 974             }
 975             xmlFree(type);
 976         }
 977     }
 978     return no_found;
 979 }
 980
 981 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
 982                                 struct conf_service *service, NMEM nmem)
 983 {
 984     char *mergekey_norm = 0;
 985     xmlNode *root = xmlDocGetRootElement(doc);
 986     WRBUF norm_wr = wrbuf_alloc();
 987
 988     /* consider mergekey from XSL first */
 989     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
 990     if (mergekey)
 991     {
 992         const char *norm_str;
 993         pp2_relevance_token_t prt =
 994             pp2_relevance_tokenize(
 995                 service->mergekey_pct,
 996                 (const char *) mergekey, 0);
 997
 998         while ((norm_str = pp2_relevance_token_next(prt)))
 999         {
1000             if (*norm_str)
1001             {
1002                 if (wrbuf_len(norm_wr))
1003                     wrbuf_puts(norm_wr, " ");
1004                 wrbuf_puts(norm_wr, norm_str);
1005             }
1006         }
1007         pp2_relevance_token_destroy(prt);
1008         xmlFree(mergekey);
1009     }
1010     else
1011     {
1012         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1013         int field_id;
1014         for (field_id = 0; field_id < service->num_metadata; field_id++)
1015         {
1016             struct conf_metadata *ser_md = &service->metadata[field_id];
1017             if (ser_md->mergekey != Metadata_mergekey_no)
1018             {
1019                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1020                                               service, norm_wr);
1021                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1022                 {
1023                     /* no mergekey on this one and it is required..
1024                        Generate unique key instead */
1025                     wrbuf_rewind(norm_wr);
1026                     break;
1027                 }
1028             }
1029         }
1030     }
1031
1032     /* generate unique key if none is not generated already or is empty */
1033     if (wrbuf_len(norm_wr) == 0)
1034     {
1035         wrbuf_printf(norm_wr, "%s-%d",
1036                      client_get_database(cl)->database->url, record_no);
1037     }
1038     if (wrbuf_len(norm_wr) > 0)
1039         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1040     wrbuf_destroy(norm_wr);
1041     return mergekey_norm;
1042 }
1043
1044 /** \brief see if metadata for pz:recordfilter exists
1045     \param root xml root element of normalized record
1046     \param sdb session database for client
1047     \retval 0 if there is no metadata for pz:recordfilter
1048     \retval 1 if there is metadata for pz:recordfilter
1049
1050     If there is no pz:recordfilter defined, this function returns 1
1051     as well.
1052 */
1053
1054 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1055 {
1056     int match = 0;
1057     xmlNode *n;
1058     const char *s;
1059     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1060
1061     if (!s || !*s)
1062         return 1;
1063
1064     for (n = root->children; n; n = n->next)
1065     {
1066         if (n->type != XML_ELEMENT_NODE)
1067             continue;
1068         if (!strcmp((const char *) n->name, "metadata"))
1069         {
1070             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1071             if (type)
1072             {
1073                 size_t len;
1074                 const char *eq = strchr(s, '~');
1075                 if (eq)
1076                     len = eq - s;
1077                 else
1078                     len = strlen(s);
1079                 if (len == strlen((const char *)type) &&
1080                     !memcmp((const char *) type, s, len))
1081                 {
1082                     xmlChar *value = xmlNodeGetContent(n);
1083                     if (value && *value)
1084                     {
1085                         if (!eq || strstr((const char *) value, eq+1))
1086                             match = 1;
1087                     }
1088                     xmlFree(value);
1089                 }
1090                 xmlFree(type);
1091             }
1092         }
1093     }
1094     return match;
1095 }
1096
1097
1098 static int ingest_to_cluster(struct client *cl,
1099                              xmlDoc *xdoc,
1100                              xmlNode *root,
1101                              int record_no,
1102                              const char *mergekey_norm);
1103
1104 /** \brief ingest XML record
1105     \param cl client holds the result set for record
1106     \param rec record buffer (0 terminated)
1107     \param record_no record position (1, 2, ..)
1108     \retval 0 OK
1109     \retval -1 failure
1110 */
1111 int ingest_record(struct client *cl, const char *rec,
1112                   int record_no, NMEM nmem)
1113 {
1114     struct session *se = client_get_session(cl);
1115     int ret;
1116     struct session_database *sdb = client_get_database(cl);
1117     struct conf_service *service = se->service;
1118     xmlDoc *xdoc = normalize_record(sdb, service, rec, nmem);
1119     xmlNode *root;
1120     const char *mergekey_norm;
1121
1122     if (!xdoc)
1123         return -1;
1124
1125     root = xmlDocGetRootElement(xdoc);
1126
1127     if (!check_record_filter(root, sdb))
1128     {
1129         yaz_log(YLOG_WARN, "Filtered out record no %d from %s", record_no,
1130                 sdb->database->url);
1131         xmlFreeDoc(xdoc);
1132         return -1;
1133     }
1134
1135     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1136     if (!mergekey_norm)
1137     {
1138         yaz_log(YLOG_WARN, "Got no mergekey");
1139         xmlFreeDoc(xdoc);
1140         return -1;
1141     }
1142     session_enter(se);
1143     ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1144     session_leave(se);
1145
1146     xmlFreeDoc(xdoc);
1147     return ret;
1148 }
1149
1150 static int ingest_to_cluster(struct client *cl,
1151                              xmlDoc *xdoc,
1152                              xmlNode *root,
1153                              int record_no,
1154                              const char *mergekey_norm)
1155 {
1156     xmlNode *n;
1157     xmlChar *type = 0;
1158     xmlChar *value = 0;
1159     struct session_database *sdb = client_get_database(cl);
1160     struct session *se = client_get_session(cl);
1161     struct conf_service *service = se->service;
1162     struct record *record = record_create(se->nmem,
1163                                           service->num_metadata,
1164                                           service->num_sortkeys, cl,
1165                                           record_no);
1166     struct record_cluster *cluster = reclist_insert(se->reclist,
1167                                                     service,
1168                                                     record,
1169                                                     mergekey_norm,
1170                                                     &se->total_merged);
1171     if (!cluster)
1172         return -1;
1173     if (global_parameters.dump_records)
1174         yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1175                 sdb->database->url, record_no);
1176     relevance_newrec(se->relevance, cluster);
1177
1178     // now parsing XML record and adding data to cluster or record metadata
1179     for (n = root->children; n; n = n->next)
1180     {
1181         pp2_relevance_token_t prt;
1182         if (type)
1183             xmlFree(type);
1184         if (value)
1185             xmlFree(value);
1186         type = value = 0;
1187
1188         if (n->type != XML_ELEMENT_NODE)
1189             continue;
1190         if (!strcmp((const char *) n->name, "metadata"))
1191         {
1192             struct conf_metadata *ser_md = 0;
1193             struct conf_sortkey *ser_sk = 0;
1194             struct record_metadata **wheretoput = 0;
1195             struct record_metadata *rec_md = 0;
1196             int md_field_id = -1;
1197             int sk_field_id = -1;
1198
1199             type = xmlGetProp(n, (xmlChar *) "type");
1200             value = xmlNodeListGetString(xdoc, n->children, 1);
1201
1202             if (!type || !value || !*value)
1203                 continue;
1204
1205             md_field_id
1206                 = conf_service_metadata_field_id(service, (const char *) type);
1207             if (md_field_id < 0)
1208             {
1209                 if (se->number_of_warnings_unknown_metadata == 0)
1210                 {
1211                     yaz_log(YLOG_WARN,
1212                             "Ignoring unknown metadata element: %s", type);
1213                 }
1214                 se->number_of_warnings_unknown_metadata++;
1215                 continue;
1216             }
1217
1218             ser_md = &service->metadata[md_field_id];
1219
1220             if (ser_md->sortkey_offset >= 0){
1221                 sk_field_id = ser_md->sortkey_offset;
1222                 ser_sk = &service->sortkeys[sk_field_id];
1223             }
1224
1225             // non-merged metadata
1226             rec_md = record_metadata_init(se->nmem, (const char *) value,
1227                                           ser_md->type, n->properties);
1228             if (!rec_md)
1229             {
1230                 yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
1231                         value, type);
1232                 continue;
1233             }
1234             wheretoput = &record->metadata[md_field_id];
1235             while (*wheretoput)
1236                 wheretoput = &(*wheretoput)->next;
1237             *wheretoput = rec_md;
1238
1239             // merged metadata
1240             rec_md = record_metadata_init(se->nmem, (const char *) value,
1241                                           ser_md->type, 0);
1242             wheretoput = &cluster->metadata[md_field_id];
1243
1244             // and polulate with data:
1245             // assign cluster or record based on merge action
1246             if (ser_md->merge == Metadata_merge_unique)
1247             {
1248                 struct record_metadata *mnode;
1249                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1250                     if (!strcmp((const char *) mnode->data.text.disp,
1251                                 rec_md->data.text.disp))
1252                         break;
1253                 if (!mnode)
1254                 {
1255                     rec_md->next = *wheretoput;
1256                     *wheretoput = rec_md;
1257                 }
1258             }
1259             else if (ser_md->merge == Metadata_merge_longest)
1260             {
1261                 if (!*wheretoput
1262                     || strlen(rec_md->data.text.disp)
1263                     > strlen((*wheretoput)->data.text.disp))
1264                 {
1265                     *wheretoput = rec_md;
1266                     if (ser_sk)
1267                     {
1268                         const char *sort_str = 0;
1269                         int skip_article =
1270                             ser_sk->type == Metadata_sortkey_skiparticle;
1271
1272                         if (!cluster->sortkeys[sk_field_id])
1273                             cluster->sortkeys[sk_field_id] =
1274                                 nmem_malloc(se->nmem,
1275                                             sizeof(union data_types));
1276
1277                         prt = pp2_relevance_tokenize(
1278                             service->sort_pct,
1279                             rec_md->data.text.disp, skip_article);
1280
1281                         pp2_relevance_token_next(prt);
1282
1283                         sort_str = pp2_get_sort(prt);
1284
1285                         cluster->sortkeys[sk_field_id]->text.disp =
1286                             rec_md->data.text.disp;
1287                         if (!sort_str)
1288                         {
1289                             sort_str = rec_md->data.text.disp;
1290                             yaz_log(YLOG_WARN,
1291                                     "Could not make sortkey. Bug #1858");
1292                         }
1293                         cluster->sortkeys[sk_field_id]->text.sort =
1294                             nmem_strdup(se->nmem, sort_str);
1295 #if 0
1296                         yaz_log(YLOG_LOG, "text disp=%s",
1297                                 cluster->sortkeys[sk_field_id]->text.disp);
1298                         yaz_log(YLOG_LOG, "text sort=%s",
1299                                 cluster->sortkeys[sk_field_id]->text.sort);
1300 #endif
1301                         pp2_relevance_token_destroy(prt);
1302                     }
1303                 }
1304             }
1305             else if (ser_md->merge == Metadata_merge_all)
1306             {
1307                 rec_md->next = *wheretoput;
1308                 *wheretoput = rec_md;
1309             }
1310             else if (ser_md->merge == Metadata_merge_range)
1311             {
1312                 if (!*wheretoput)
1313                 {
1314                     *wheretoput = rec_md;
1315                     if (ser_sk)
1316                         cluster->sortkeys[sk_field_id]
1317                             = &rec_md->data;
1318                 }
1319                 else
1320                 {
1321                     int this_min = rec_md->data.number.min;
1322                     int this_max = rec_md->data.number.max;
1323                     if (this_min < (*wheretoput)->data.number.min)
1324                         (*wheretoput)->data.number.min = this_min;
1325                     if (this_max > (*wheretoput)->data.number.max)
1326                         (*wheretoput)->data.number.max = this_max;
1327                 }
1328             }
1329
1330
1331             // ranking of _all_ fields enabled ...
1332             if (ser_md->rank)
1333                 relevance_countwords(se->relevance, cluster,
1334                                      (char *) value, ser_md->rank,
1335                                      ser_md->name);
1336
1337             // construct facets ...
1338             if (ser_md->termlist)
1339             {
1340                 if (ser_md->type == Metadata_type_year)
1341                 {
1342                     char year[64];
1343                     sprintf(year, "%d", rec_md->data.number.max);
1344                     add_facet(se, (char *) type, year);
1345                     if (rec_md->data.number.max != rec_md->data.number.min)
1346                     {
1347                         sprintf(year, "%d", rec_md->data.number.min);
1348                         add_facet(se, (char *) type, year);
1349                     }
1350                 }
1351                 else
1352                     add_facet(se, (char *) type, (char *) value);
1353             }
1354
1355             // cleaning up
1356             xmlFree(type);
1357             xmlFree(value);
1358             type = value = 0;
1359         }
1360         else
1361         {
1362             if (se->number_of_warnings_unknown_elements == 0)
1363                 yaz_log(YLOG_WARN,
1364                         "Unexpected element in internal record: %s", n->name);
1365             se->number_of_warnings_unknown_elements++;
1366         }
1367     }
1368     if (type)
1369         xmlFree(type);
1370     if (value)
1371         xmlFree(value);
1372
1373     relevance_donerecord(se->relevance, cluster);
1374     se->total_records++;
1375
1376     return 0;
1377 }
1378
1379 /*
1380  * Local variables:
1381  * c-basic-offset: 4
1382  * c-file-style: "Stroustrup"
1383  * indent-tabs-mode: nil
1384  * End:
1385  * vim: shiftwidth=4 tabstop=8 expandtab
1386  */
1387