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