src/session.c

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