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     session_enter(s);
 418     if (s->watchlist[what].fun)
 419     {
 420         /* our watch is no longer associated with http_channel */
 421         void *data;
 422         session_watchfun fun;
 423
 424         http_remove_observer(s->watchlist[what].obs);
 425         fun = s->watchlist[what].fun;
 426         data = s->watchlist[what].data;
 427
 428         /* reset watch before fun is invoked - in case fun wants to set
 429            it again */
 430         s->watchlist[what].fun = 0;
 431         s->watchlist[what].data = 0;
 432         s->watchlist[what].obs = 0;
 433
 434         session_leave(s);
 435         fun(data);
 436     }
 437     else
 438         session_leave(s);
 439 }
 440
 441 //callback for grep_databases
 442 static void select_targets_callback(void *context, struct session_database *db)
 443 {
 444     struct session *se = (struct session*) context;
 445     struct client *cl = client_create();
 446     client_set_database(cl, db);
 447     client_set_session(cl, se);
 448 }
 449
 450 static void session_remove_clients(struct session *se)
 451 {
 452     struct client *cl = se->clients;
 453     while (cl)
 454     {
 455         struct client *cl_next = client_next_in_session(cl);
 456         client_remove_from_session(cl);
 457         client_destroy(cl);
 458         cl = cl_next;
 459     }
 460     se->clients = 0;
 461 }
 462
 463 // Associates a set of clients with a session;
 464 // Note: Session-databases represent databases with per-session
 465 // setting overrides
 466 static int select_targets(struct session *se, const char *filter)
 467 {
 468     session_remove_clients(se);
 469     return session_grep_databases(se, filter, select_targets_callback);
 470 }
 471
 472 int session_active_clients(struct session *s)
 473 {
 474     struct client *c;
 475     int res = 0;
 476
 477     for (c = s->clients; c; c = client_next_in_session(c))
 478         if (client_is_active(c))
 479             res++;
 480
 481     return res;
 482 }
 483
 484
 485 enum pazpar2_error_code search(struct session *se,
 486                                const char *query,
 487                                const char *startrecs, const char *maxrecs,
 488                                const char *filter,
 489                                const char **addinfo)
 490 {
 491     int live_channels = 0;
 492     int no_working = 0;
 493     int no_failed = 0;
 494     struct client *cl;
 495
 496     yaz_log(YLOG_DEBUG, "Search");
 497
 498     *addinfo = 0;
 499
 500     session_enter(se);
 501     reclist_destroy(se->reclist);
 502     se->reclist = 0;
 503     nmem_reset(se->nmem);
 504     se->relevance = 0;
 505     se->total_records = se->total_hits = se->total_merged = 0;
 506     se->num_termlists = 0;
 507     live_channels = select_targets(se, filter);
 508     if (!live_channels)
 509     {
 510         session_leave(se);
 511         return PAZPAR2_NO_TARGETS;
 512     }
 513     se->reclist = reclist_create(se->nmem);
 514
 515     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 516     {
 517         if (maxrecs)
 518             client_set_maxrecs(cl, atoi(maxrecs));
 519         if (startrecs)
 520             client_set_startrecs(cl, atoi(startrecs));
 521         if (prepare_session_database(se, client_get_database(cl)) < 0)
 522             continue;
 523         // Parse query for target
 524         if (client_parse_query(cl, query) < 0)
 525             no_failed++;
 526         else
 527         {
 528             no_working++;
 529             if (client_prep_connection(cl, se->service->z3950_operation_timeout,
 530                                        se->service->z3950_session_timeout,
 531                                        se->service->server->iochan_man))
 532                 client_start_search(cl);
 533         }
 534     }
 535     session_leave(se);
 536     if (no_working == 0)
 537     {
 538         if (no_failed > 0)
 539         {
 540             *addinfo = "query";
 541             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 542         }
 543         else
 544             return PAZPAR2_NO_TARGETS;
 545     }
 546     return PAZPAR2_NO_ERROR;
 547 }
 548
 549 // Creates a new session_database object for a database
 550 static void session_init_databases_fun(void *context, struct database *db)
 551 {
 552     struct session *se = (struct session *) context;
 553     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 554     int i;
 555
 556     new->database = db;
 557
 558     new->map = 0;
 559     assert(db->settings);
 560     new->settings = nmem_malloc(se->session_nmem,
 561                                 sizeof(struct settings *) * db->num_settings);
 562     new->num_settings = db->num_settings;
 563     for (i = 0; i < db->num_settings; i++)
 564     {
 565         struct setting *setting = db->settings[i];
 566         new->settings[i] = setting;
 567     }
 568     new->next = se->databases;
 569     se->databases = new;
 570 }
 571
 572 // Doesn't free memory associated with sdb -- nmem takes care of that
 573 static void session_database_destroy(struct session_database *sdb)
 574 {
 575     sdb->map = 0;
 576 }
 577
 578 // Initialize session_database list -- this represents this session's view
 579 // of the database list -- subject to modification by the settings ws command
 580 void session_init_databases(struct session *se)
 581 {
 582     se->databases = 0;
 583     predef_grep_databases(se, se->service, session_init_databases_fun);
 584 }
 585
 586 // Probably session_init_databases_fun should be refactored instead of
 587 // called here.
 588 static struct session_database *load_session_database(struct session *se,
 589                                                       char *id)
 590 {
 591     struct database *db = new_database(id, se->session_nmem);
 592
 593     resolve_database(se->service, db);
 594
 595     session_init_databases_fun((void*) se, db);
 596
 597     // New sdb is head of se->databases list
 598     return se->databases;
 599 }
 600
 601 // Find an existing session database. If not found, load it
 602 static struct session_database *find_session_database(struct session *se,
 603                                                       char *id)
 604 {
 605     struct session_database *sdb;
 606
 607     for (sdb = se->databases; sdb; sdb = sdb->next)
 608         if (!strcmp(sdb->database->url, id))
 609             return sdb;
 610     return load_session_database(se, id);
 611 }
 612
 613 // Apply a session override to a database
 614 void session_apply_setting(struct session *se, char *dbname, char *setting,
 615                            char *value)
 616 {
 617     struct session_database *sdb = find_session_database(se, dbname);
 618     struct conf_service *service = se->service;
 619     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 620     int offset = settings_create_offset(service, setting);
 621
 622     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
 623                           se->session_nmem);
 624     new->precedence = 0;
 625     new->target = dbname;
 626     new->name = setting;
 627     new->value = value;
 628     new->next = sdb->settings[offset];
 629     sdb->settings[offset] = new;
 630
 631     // Force later recompute of settings-driven data structures
 632     // (happens when a search starts and client connections are prepared)
 633     switch (offset)
 634     {
 635     case PZ_XSLT:
 636         if (sdb->map)
 637         {
 638             sdb->map = 0;
 639         }
 640         break;
 641     }
 642 }
 643
 644 void destroy_session(struct session *s)
 645 {
 646     struct session_database *sdb;
 647
 648     session_remove_clients(s);
 649
 650     for (sdb = s->databases; sdb; sdb = sdb->next)
 651         session_database_destroy(sdb);
 652     normalize_cache_destroy(s->normalize_cache);
 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 {
 662     int i;
 663     struct session *session = nmem_malloc(nmem, sizeof(*session));
 664
 665     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
 666
 667     session->service = service;
 668     session->relevance = 0;
 669     session->total_hits = 0;
 670     session->total_records = 0;
 671     session->number_of_warnings_unknown_elements = 0;
 672     session->number_of_warnings_unknown_metadata = 0;
 673     session->num_termlists = 0;
 674     session->reclist = 0;
 675     session->clients = 0;
 676     session->session_nmem = nmem;
 677     session->nmem = nmem_create();
 678     session->wrbuf = wrbuf_alloc();
 679     session->databases = 0;
 680     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 681     {
 682         session->watchlist[i].data = 0;
 683         session->watchlist[i].fun = 0;
 684     }
 685     session->normalize_cache = normalize_cache_create();
 686     session->mutex = 0;
 687     yaz_mutex_create(&session->mutex);
 688
 689     return session;
 690 }
 691
 692 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
 693 {
 694     struct hitsbytarget *res = 0;
 695     struct client *cl;
 696     size_t sz = 0;
 697
 698     session_enter(se);
 699     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 700         sz++;
 701
 702     res = nmem_malloc(nmem, sizeof(*res) * sz);
 703     *count = 0;
 704     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 705     {
 706         WRBUF w = wrbuf_alloc();
 707         const char *name = session_setting_oneval(client_get_database(cl),
 708                                                   PZ_NAME);
 709
 710         res[*count].id = client_get_database(cl)->database->url;
 711         res[*count].name = *name ? name : "Unknown";
 712         res[*count].hits = client_get_hits(cl);
 713         res[*count].records = client_get_num_records(cl);
 714         res[*count].diagnostic = client_get_diagnostic(cl);
 715         res[*count].state = client_get_state_str(cl);
 716         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 717         session_settings_dump(se, client_get_database(cl), w);
 718         res[*count].settings_xml = w;
 719         (*count)++;
 720     }
 721     session_leave(se);
 722     return res;
 723 }
 724
 725 struct termlist_score **termlist(struct session *s, const char *name, int *num)
 726 {
 727     int i;
 728     struct termlist_score **tl = 0;
 729
 730     session_enter(s);
 731     for (i = 0; i < s->num_termlists; i++)
 732         if (!strcmp((const char *) s->termlists[i].name, name))
 733         {
 734             tl = termlist_highscore(s->termlists[i].termlist, num);
 735             break;
 736         }
 737     session_leave(s);
 738     return tl;
 739 }
 740
 741 #ifdef MISSING_HEADERS
 742 void report_nmem_stats(void)
 743 {
 744     size_t in_use, is_free;
 745
 746     nmem_get_memory_in_use(&in_use);
 747     nmem_get_memory_free(&is_free);
 748
 749     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
 750             (long) in_use, (long) is_free);
 751 }
 752 #endif
 753
 754 struct record_cluster *show_single_start(struct session *s, const char *id,
 755                                          struct record_cluster **prev_r,
 756                                          struct record_cluster **next_r)
 757 {
 758     struct record_cluster *r;
 759
 760     session_enter(s);
 761     reclist_enter(s->reclist);
 762     *prev_r = 0;
 763     *next_r = 0;
 764     while ((r = reclist_read_record(s->reclist)))
 765     {
 766         if (!strcmp(r->recid, id))
 767         {
 768             *next_r = reclist_read_record(s->reclist);
 769             break;
 770         }
 771         *prev_r = r;
 772     }
 773     reclist_leave(s->reclist);
 774     if (!r)
 775         session_leave(s);
 776     return r;
 777 }
 778
 779 void show_single_stop(struct session *s, struct record_cluster *rec)
 780 {
 781     session_leave(s);
 782 }
 783
 784 struct record_cluster **show_range_start(struct session *s,
 785                                          struct reclist_sortparms *sp,
 786                                          int start, int *num, int *total, Odr_int *sumhits)
 787 {
 788     struct record_cluster **recs = nmem_malloc(s->nmem, *num
 789                                                * sizeof(struct record_cluster *));
 790     struct reclist_sortparms *spp;
 791     int i;
 792 #if USE_TIMING
 793     yaz_timing_t t = yaz_timing_create();
 794 #endif
 795
 796     session_enter(s);
 797     if (!s->relevance)
 798     {
 799         *num = 0;
 800         *total = 0;
 801         *sumhits = 0;
 802         recs = 0;
 803     }
 804     else
 805     {
 806         for (spp = sp; spp; spp = spp->next)
 807             if (spp->type == Metadata_sortkey_relevance)
 808             {
 809                 relevance_prepare_read(s->relevance, s->reclist);
 810                 break;
 811             }
 812         reclist_sort(s->reclist, sp);
 813
 814         reclist_enter(s->reclist);
 815         *total = reclist_get_num_records(s->reclist);
 816         *sumhits = s->total_hits;
 817
 818         for (i = 0; i < start; i++)
 819             if (!reclist_read_record(s->reclist))
 820             {
 821                 *num = 0;
 822                 recs = 0;
 823                 break;
 824             }
 825
 826         for (i = 0; i < *num; i++)
 827         {
 828             struct record_cluster *r = reclist_read_record(s->reclist);
 829             if (!r)
 830             {
 831                 *num = i;
 832                 break;
 833             }
 834             recs[i] = r;
 835         }
 836         reclist_leave(s->reclist);
 837     }
 838 #if USE_TIMING
 839     yaz_timing_stop(t);
 840     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
 841             yaz_timing_get_real(t), yaz_timing_get_user(t),
 842             yaz_timing_get_sys(t));
 843     yaz_timing_destroy(&t);
 844 #endif
 845     return recs;
 846 }
 847
 848 void show_range_stop(struct session *s, struct record_cluster **recs)
 849 {
 850     session_leave(s);
 851 }
 852
 853 void statistics(struct session *se, struct statistics *stat)
 854 {
 855     struct client *cl;
 856     int count = 0;
 857
 858     memset(stat, 0, sizeof(*stat));
 859     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 860     {
 861         if (!client_get_connection(cl))
 862             stat->num_no_connection++;
 863         switch (client_get_state(cl))
 864         {
 865         case Client_Connecting: stat->num_connecting++; break;
 866         case Client_Working: stat->num_working++; break;
 867         case Client_Idle: stat->num_idle++; break;
 868         case Client_Failed: stat->num_failed++; break;
 869         case Client_Error: stat->num_error++; break;
 870         default: break;
 871         }
 872         count++;
 873     }
 874     stat->num_hits = se->total_hits;
 875     stat->num_records = se->total_records;
 876
 877     stat->num_clients = count;
 878 }
 879
 880 static struct record_metadata *record_metadata_init(
 881     NMEM nmem, const char *value, enum conf_metadata_type type,
 882     struct _xmlAttr *attr)
 883 {
 884     struct record_metadata *rec_md = record_metadata_create(nmem);
 885     struct record_metadata_attr **attrp = &rec_md->attributes;
 886
 887     for (; attr; attr = attr->next)
 888     {
 889         if (attr->children && attr->children->content)
 890         {
 891             if (strcmp((const char *) attr->name, "type"))
 892             {  /* skip the "type" attribute.. Its value is already part of
 893                   the element in output (md-%s) and so repeating it here
 894                   is redundant */
 895                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
 896                 (*attrp)->name =
 897                     nmem_strdup(nmem, (const char *) attr->name);
 898                 (*attrp)->value =
 899                     nmem_strdup(nmem, (const char *) attr->children->content);
 900                 attrp = &(*attrp)->next;
 901             }
 902         }
 903     }
 904     *attrp = 0;
 905
 906     if (type == Metadata_type_generic)
 907     {
 908         char *p = nmem_strdup(nmem, value);
 909
 910         p = normalize7bit_generic(p, " ,/.:([");
 911
 912         rec_md->data.text.disp = p;
 913         rec_md->data.text.sort = 0;
 914     }
 915     else if (type == Metadata_type_year || type == Metadata_type_date)
 916     {
 917         int first, last;
 918         int longdate = 0;
 919
 920         if (type == Metadata_type_date)
 921             longdate = 1;
 922         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
 923             return 0;
 924
 925         rec_md->data.number.min = first;
 926         rec_md->data.number.max = last;
 927     }
 928     else
 929         return 0;
 930     return rec_md;
 931 }
 932
 933 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
 934                                  struct conf_service *service, WRBUF norm_wr)
 935 {
 936     xmlNode *n;
 937     int no_found = 0;
 938     for (n = root->children; n; n = n->next)
 939     {
 940         if (n->type != XML_ELEMENT_NODE)
 941             continue;
 942         if (!strcmp((const char *) n->name, "metadata"))
 943         {
 944             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
 945             if (!strcmp(name, (const char *) type))
 946             {
 947                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
 948                 if (value)
 949                 {
 950                     const char *norm_str;
 951                     pp2_relevance_token_t prt =
 952                         pp2_relevance_tokenize(
 953                             service->mergekey_pct,
 954                             (const char *) value, 0);
 955
 956                     if (wrbuf_len(norm_wr) > 0)
 957                         wrbuf_puts(norm_wr, " ");
 958                     wrbuf_puts(norm_wr, name);
 959                     while ((norm_str =
 960                             pp2_relevance_token_next(prt)))
 961                     {
 962                         if (*norm_str)
 963                         {
 964                             wrbuf_puts(norm_wr, " ");
 965                             wrbuf_puts(norm_wr, norm_str);
 966                         }
 967                     }
 968                     xmlFree(value);
 969                     pp2_relevance_token_destroy(prt);
 970                     no_found++;
 971                 }
 972             }
 973             xmlFree(type);
 974         }
 975     }
 976     return no_found;
 977 }
 978
 979 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
 980                                 struct conf_service *service, NMEM nmem)
 981 {
 982     char *mergekey_norm = 0;
 983     xmlNode *root = xmlDocGetRootElement(doc);
 984     WRBUF norm_wr = wrbuf_alloc();
 985
 986     /* consider mergekey from XSL first */
 987     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
 988     if (mergekey)
 989     {
 990         const char *norm_str;
 991         pp2_relevance_token_t prt =
 992             pp2_relevance_tokenize(
 993                 service->mergekey_pct,
 994                 (const char *) mergekey, 0);
 995
 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(
1276                             service->sort_pct,
1277                             rec_md->data.text.disp, skip_article);
1278
1279                         pp2_relevance_token_next(prt);
1280
1281                         sort_str = pp2_get_sort(prt);
1282
1283                         cluster->sortkeys[sk_field_id]->text.disp =
1284                             rec_md->data.text.disp;
1285                         if (!sort_str)
1286                         {
1287                             sort_str = rec_md->data.text.disp;
1288                             yaz_log(YLOG_WARN,
1289                                     "Could not make sortkey. Bug #1858");
1290                         }
1291                         cluster->sortkeys[sk_field_id]->text.sort =
1292                             nmem_strdup(se->nmem, sort_str);
1293 #if 0
1294                         yaz_log(YLOG_LOG, "text disp=%s",
1295                                 cluster->sortkeys[sk_field_id]->text.disp);
1296                         yaz_log(YLOG_LOG, "text sort=%s",
1297                                 cluster->sortkeys[sk_field_id]->text.sort);
1298 #endif
1299                         pp2_relevance_token_destroy(prt);
1300                     }
1301                 }
1302             }
1303             else if (ser_md->merge == Metadata_merge_all)
1304             {
1305                 rec_md->next = *wheretoput;
1306                 *wheretoput = rec_md;
1307             }
1308             else if (ser_md->merge == Metadata_merge_range)
1309             {
1310                 if (!*wheretoput)
1311                 {
1312                     *wheretoput = rec_md;
1313                     if (ser_sk)
1314                         cluster->sortkeys[sk_field_id]
1315                             = &rec_md->data;
1316                 }
1317                 else
1318                 {
1319                     int this_min = rec_md->data.number.min;
1320                     int this_max = rec_md->data.number.max;
1321                     if (this_min < (*wheretoput)->data.number.min)
1322                         (*wheretoput)->data.number.min = this_min;
1323                     if (this_max > (*wheretoput)->data.number.max)
1324                         (*wheretoput)->data.number.max = this_max;
1325                 }
1326             }
1327
1328
1329             // ranking of _all_ fields enabled ...
1330             if (ser_md->rank)
1331                 relevance_countwords(se->relevance, cluster,
1332                                      (char *) value, ser_md->rank,
1333                                      ser_md->name);
1334
1335             // construct facets ...
1336             if (ser_md->termlist)
1337             {
1338                 if (ser_md->type == Metadata_type_year)
1339                 {
1340                     char year[64];
1341                     sprintf(year, "%d", rec_md->data.number.max);
1342                     add_facet(se, (char *) type, year);
1343                     if (rec_md->data.number.max != rec_md->data.number.min)
1344                     {
1345                         sprintf(year, "%d", rec_md->data.number.min);
1346                         add_facet(se, (char *) type, year);
1347                     }
1348                 }
1349                 else
1350                     add_facet(se, (char *) type, (char *) value);
1351             }
1352
1353             // cleaning up
1354             xmlFree(type);
1355             xmlFree(value);
1356             type = value = 0;
1357         }
1358         else
1359         {
1360             if (se->number_of_warnings_unknown_elements == 0)
1361                 yaz_log(YLOG_WARN,
1362                         "Unexpected element in internal record: %s", n->name);
1363             se->number_of_warnings_unknown_elements++;
1364         }
1365     }
1366     if (type)
1367         xmlFree(type);
1368     if (value)
1369         xmlFree(value);
1370
1371     relevance_donerecord(se->relevance, cluster);
1372     se->total_records++;
1373
1374     return 0;
1375 }
1376
1377 /*
1378  * Local variables:
1379  * c-basic-offset: 4
1380  * c-file-style: "Stroustrup"
1381  * indent-tabs-mode: nil
1382  * End:
1383  * vim: shiftwidth=4 tabstop=8 expandtab
1384  */
1385