src/session.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2012 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 <time.h>
  29 #include <stdlib.h>
  30 #include <stdio.h>
  31 #include <string.h>
  32 #if HAVE_SYS_TIME_H
  33 #include <sys/time.h>
  34 #endif
  35 #if HAVE_UNISTD_H
  36 #include <unistd.h>
  37 #endif
  38 #ifdef WIN32
  39 #include <windows.h>
  40 #endif
  41 #include <signal.h>
  42 #include <ctype.h>
  43 #include <assert.h>
  44 #include <math.h>
  45
  46 #include <yaz/marcdisp.h>
  47 #include <yaz/comstack.h>
  48 #include <yaz/tcpip.h>
  49 #include <yaz/proto.h>
  50 #include <yaz/readconf.h>
  51 #include <yaz/pquery.h>
  52 #include <yaz/otherinfo.h>
  53 #include <yaz/yaz-util.h>
  54 #include <yaz/nmem.h>
  55 #include <yaz/query-charset.h>
  56 #include <yaz/querytowrbuf.h>
  57 #include <yaz/oid_db.h>
  58 #include <yaz/snprintf.h>
  59
  60 #define USE_TIMING 0
  61 #if USE_TIMING
  62 #include <yaz/timing.h>
  63 #endif
  64
  65 #include "ppmutex.h"
  66 #include "parameters.h"
  67 #include "session.h"
  68 #include "eventl.h"
  69 #include "http.h"
  70 #include "termlists.h"
  71 #include "reclists.h"
  72 #include "relevance.h"
  73 #include "database.h"
  74 #include "client.h"
  75 #include "settings.h"
  76 #include "normalize7bit.h"
  77
  78 #include <libxml/tree.h>
  79
  80 #define MAX_CHUNK 15
  81
  82 #define MAX(a,b) ((a)>(b)?(a):(b))
  83
  84 // Note: Some things in this structure will eventually move to configuration
  85 struct parameters global_parameters =
  86 {
  87     0,   // dump_records
  88     0,   // debug_mode
  89     0,   // predictable sessions
  90 };
  91
  92 struct client_list {
  93     struct client *client;
  94     struct client_list *next;
  95 };
  96
  97 /* session counting (1) , disable client counting (0) */
  98 static YAZ_MUTEX g_session_mutex = 0;
  99 static int no_sessions = 0;
 100 static int no_session_total = 0;
 101
 102 static int session_use(int delta)
 103 {
 104     int sessions;
 105     if (!g_session_mutex)
 106         yaz_mutex_create(&g_session_mutex);
 107     yaz_mutex_enter(g_session_mutex);
 108     no_sessions += delta;
 109     if (delta > 0)
 110         no_session_total += delta;
 111     sessions = no_sessions;
 112     yaz_mutex_leave(g_session_mutex);
 113     yaz_log(YLOG_DEBUG, "%s sessions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
 114     return sessions;
 115 }
 116
 117 int sessions_count(void)
 118 {
 119     return session_use(0);
 120 }
 121
 122 int session_count_total(void)
 123 {
 124     int total = 0;
 125     if (!g_session_mutex)
 126         return 0;
 127     yaz_mutex_enter(g_session_mutex);
 128     total = no_session_total;
 129     yaz_mutex_leave(g_session_mutex);
 130     return total;
 131 }
 132
 133 static void log_xml_doc(xmlDoc *doc)
 134 {
 135     FILE *lf = yaz_log_file();
 136     xmlChar *result = 0;
 137     int len = 0;
 138 #if LIBXML_VERSION >= 20600
 139     xmlDocDumpFormatMemory(doc, &result, &len, 1);
 140 #else
 141     xmlDocDumpMemory(doc, &result, &len);
 142 #endif
 143     if (lf && len)
 144     {
 145         (void) fwrite(result, 1, len, lf);
 146         fprintf(lf, "\n");
 147     }
 148     xmlFree(result);
 149 }
 150
 151 static void session_enter(struct session *s, const char *caller)
 152 {
 153     if (caller)
 154         session_log(s, YLOG_DEBUG, "Session lock by %s", caller);
 155     yaz_mutex_enter(s->session_mutex);
 156 }
 157
 158 static void session_leave(struct session *s, const char *caller)
 159 {
 160     yaz_mutex_leave(s->session_mutex);
 161     if (caller)
 162         session_log(s, YLOG_DEBUG, "Session unlock by %s", caller);
 163 }
 164
 165 static void session_normalize_facet(struct session *s, const char *type,
 166                                     const char *value,
 167                                     WRBUF display_wrbuf,
 168                                     WRBUF facet_wrbuf)
 169 {
 170     struct conf_service *service = s->service;
 171     pp2_charset_token_t prt;
 172     const char *facet_component;
 173     int i;
 174     const char *icu_chain_id = 0;
 175
 176     for (i = 0; i < service->num_metadata; i++)
 177         if (!strcmp((service->metadata + i)->name, type))
 178             icu_chain_id = (service->metadata + i)->facetrule;
 179     if (!icu_chain_id)
 180         icu_chain_id = "facet";
 181     prt = pp2_charset_token_create(service->charsets, icu_chain_id);
 182     if (!prt)
 183     {
 184         yaz_log(YLOG_FATAL, "Unknown ICU chain '%s' for facet of type '%s'",
 185                 icu_chain_id, type);
 186         wrbuf_destroy(facet_wrbuf);
 187         wrbuf_destroy(display_wrbuf);
 188         return;
 189     }
 190     pp2_charset_token_first(prt, value, 0);
 191     while ((facet_component = pp2_charset_token_next(prt)))
 192     {
 193         const char *display_component;
 194         if (*facet_component)
 195         {
 196             if (wrbuf_len(facet_wrbuf))
 197                 wrbuf_puts(facet_wrbuf, " ");
 198             wrbuf_puts(facet_wrbuf, facet_component);
 199         }
 200         display_component = pp2_get_display(prt);
 201         if (display_component)
 202         {
 203             if (wrbuf_len(display_wrbuf))
 204                 wrbuf_puts(display_wrbuf, " ");
 205             wrbuf_puts(display_wrbuf, display_component);
 206         }
 207     }
 208     pp2_charset_token_destroy(prt);
 209 }
 210
 211 void add_facet(struct session *s, const char *type, const char *value, int count)
 212 {
 213     WRBUF facet_wrbuf = wrbuf_alloc();
 214     WRBUF display_wrbuf = wrbuf_alloc();
 215
 216     session_normalize_facet(s, type, value, display_wrbuf, facet_wrbuf);
 217
 218     if (wrbuf_len(facet_wrbuf))
 219     {
 220         int i;
 221         for (i = 0; i < s->num_termlists; i++)
 222             if (!strcmp(s->termlists[i].name, type))
 223                 break;
 224         if (i == s->num_termlists)
 225         {
 226             if (i == SESSION_MAX_TERMLISTS)
 227             {
 228                 session_log(s, YLOG_FATAL, "Too many termlists");
 229                 wrbuf_destroy(facet_wrbuf);
 230                 wrbuf_destroy(display_wrbuf);
 231                 return;
 232             }
 233
 234             s->termlists[i].name = nmem_strdup(s->nmem, type);
 235             s->termlists[i].termlist = termlist_create(s->nmem);
 236             s->num_termlists = i + 1;
 237         }
 238
 239 #if 0
 240         session_log(s, YLOG_LOG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
 241 #endif
 242         termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
 243                         wrbuf_cstr(facet_wrbuf), count);
 244     }
 245     wrbuf_destroy(facet_wrbuf);
 246     wrbuf_destroy(display_wrbuf);
 247 }
 248
 249 static xmlDoc *record_to_xml(struct session *se,
 250                              struct session_database *sdb, const char *rec)
 251 {
 252     struct database *db = sdb->database;
 253     xmlDoc *rdoc = 0;
 254
 255     rdoc = xmlParseMemory(rec, strlen(rec));
 256
 257     if (!rdoc)
 258     {
 259         session_log(se, YLOG_WARN, "Non-wellformed XML");
 260         return 0;
 261     }
 262
 263     if (global_parameters.dump_records)
 264     {
 265         session_log(se, YLOG_LOG, "Un-normalized record from %s", db->id);
 266         log_xml_doc(rdoc);
 267     }
 268
 269     return rdoc;
 270 }
 271
 272 #define MAX_XSLT_ARGS 16
 273
 274 // Add static values from session database settings if applicable
 275 static void insert_settings_parameters(struct session_database *sdb,
 276                                        struct conf_service *service,
 277                                        char **parms,
 278                                        NMEM nmem)
 279 {
 280     int i;
 281     int nparms = 0;
 282     int offset = 0;
 283
 284     for (i = 0; i < service->num_metadata; i++)
 285     {
 286         struct conf_metadata *md = &service->metadata[i];
 287         int setting;
 288
 289         if (md->setting == Metadata_setting_parameter &&
 290             (setting = settings_lookup_offset(service, md->name)) >= 0)
 291         {
 292             const char *val = session_setting_oneval(sdb, setting);
 293             if (val && nparms < MAX_XSLT_ARGS)
 294             {
 295                 char *buf;
 296                 int len = strlen(val);
 297                 buf = nmem_malloc(nmem, len + 3);
 298                 buf[0] = '\'';
 299                 strcpy(buf + 1, val);
 300                 buf[len+1] = '\'';
 301                 buf[len+2] = '\0';
 302                 parms[offset++] = md->name;
 303                 parms[offset++] = buf;
 304                 nparms++;
 305             }
 306         }
 307     }
 308     parms[offset] = 0;
 309 }
 310
 311 // Add static values from session database settings if applicable
 312 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
 313     struct conf_service *service)
 314 {
 315     int i;
 316
 317     for (i = 0; i < service->num_metadata; i++)
 318     {
 319         struct conf_metadata *md = &service->metadata[i];
 320         int offset;
 321
 322         if (md->setting == Metadata_setting_postproc &&
 323             (offset = settings_lookup_offset(service, md->name)) >= 0)
 324         {
 325             const char *val = session_setting_oneval(sdb, offset);
 326             if (val)
 327             {
 328                 xmlNode *r = xmlDocGetRootElement(doc);
 329                 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
 330                                              (xmlChar *) val);
 331                 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
 332             }
 333         }
 334     }
 335 }
 336
 337 static xmlDoc *normalize_record(struct session *se,
 338                                 struct session_database *sdb,
 339                                 struct conf_service *service,
 340                                 const char *rec, NMEM nmem)
 341 {
 342     xmlDoc *rdoc = record_to_xml(se, sdb, rec);
 343
 344     if (rdoc)
 345     {
 346         char *parms[MAX_XSLT_ARGS*2+1];
 347
 348         insert_settings_parameters(sdb, service, parms, nmem);
 349
 350         if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
 351         {
 352             session_log(se, YLOG_WARN, "Normalize failed");
 353         }
 354         else
 355         {
 356             insert_settings_values(sdb, rdoc, service);
 357
 358             if (global_parameters.dump_records)
 359             {
 360                 session_log(se, YLOG_LOG, "Normalized record from %s",
 361                             sdb->database->id);
 362                 log_xml_doc(rdoc);
 363             }
 364         }
 365     }
 366     return rdoc;
 367 }
 368
 369 void session_settings_dump(struct session *se,
 370                            struct session_database *db,
 371                            WRBUF w)
 372 {
 373     if (db->settings)
 374     {
 375         int i, num = db->num_settings;
 376         for (i = 0; i < num; i++)
 377         {
 378             struct setting *s = db->settings[i];
 379             for (;s ; s = s->next)
 380             {
 381                 wrbuf_puts(w, "<set name=\"");
 382                 wrbuf_xmlputs(w, s->name);
 383                 wrbuf_puts(w, "\" value=\"");
 384                 wrbuf_xmlputs(w, s->value);
 385                 wrbuf_puts(w, "\"/>");
 386             }
 387             if (db->settings[i])
 388                 wrbuf_puts(w, "\n");
 389         }
 390     }
 391 }
 392
 393 // Retrieve first defined value for 'name' for given database.
 394 // Will be extended to take into account user associated with session
 395 const char *session_setting_oneval(struct session_database *db, int offset)
 396 {
 397     if (offset >= db->num_settings || !db->settings[offset])
 398         return "";
 399     return db->settings[offset]->value;
 400 }
 401
 402 // Prepare XSLT stylesheets for record normalization
 403 // Structures are allocated on the session_wide nmem to avoid having
 404 // to recompute this for every search. This would lead
 405 // to leaking if a single session was to repeatedly change the PZ_XSLT
 406 // setting. However, this is not a realistic use scenario.
 407 static int prepare_map(struct session *se, struct session_database *sdb)
 408 {
 409     if (sdb->settings && !sdb->map)
 410     {
 411         const char *s;
 412
 413         if (sdb->settings[PZ_XSLT] &&
 414             (s = session_setting_oneval(sdb, PZ_XSLT)))
 415         {
 416             char auto_stylesheet[256];
 417
 418             if (!strcmp(s, "auto"))
 419             {
 420                 const char *request_syntax = session_setting_oneval(
 421                     sdb, PZ_REQUESTSYNTAX);
 422                 if (request_syntax)
 423                 {
 424                     char *cp;
 425                     yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
 426                                  "%s.xsl", request_syntax);
 427                     for (cp = auto_stylesheet; *cp; cp++)
 428                     {
 429                         /* deliberately only consider ASCII */
 430                         if (*cp > 32 && *cp < 127)
 431                             *cp = tolower(*cp);
 432                     }
 433                     s = auto_stylesheet;
 434                 }
 435                 else
 436                 {
 437                     session_log(se, YLOG_WARN,
 438                                 "No pz:requestsyntax for auto stylesheet");
 439                 }
 440             }
 441             sdb->map = normalize_cache_get(se->normalize_cache,
 442                                            se->service, s);
 443             if (!sdb->map)
 444                 return -1;
 445         }
 446     }
 447     return 0;
 448 }
 449
 450 // called if watch should be removed because http_channel is to be destroyed
 451 static void session_watch_cancel(void *data, struct http_channel *c,
 452                                  void *data2)
 453 {
 454     struct session_watchentry *ent = data;
 455
 456     ent->fun = 0;
 457     ent->data = 0;
 458     ent->obs = 0;
 459 }
 460
 461 // set watch. Returns 0=OK, -1 if watch is already set
 462 int session_set_watch(struct session *s, int what,
 463                       session_watchfun fun, void *data,
 464                       struct http_channel *chan)
 465 {
 466     int ret;
 467     session_enter(s, "session_set_watch");
 468     if (s->watchlist[what].fun)
 469         ret = -1;
 470     else
 471     {
 472
 473         s->watchlist[what].fun = fun;
 474         s->watchlist[what].data = data;
 475         s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
 476                                                    session_watch_cancel);
 477         ret = 0;
 478     }
 479     session_leave(s, "session_set_watch");
 480     return ret;
 481 }
 482
 483 void session_alert_watch(struct session *s, int what)
 484 {
 485     assert(s);
 486     session_enter(s, "session_alert_watch");
 487     if (s->watchlist[what].fun)
 488     {
 489         /* our watch is no longer associated with http_channel */
 490         void *data;
 491         session_watchfun fun;
 492
 493         http_remove_observer(s->watchlist[what].obs);
 494         fun  = s->watchlist[what].fun;
 495         data = s->watchlist[what].data;
 496
 497         /* reset watch before fun is invoked - in case fun wants to set
 498            it again */
 499         s->watchlist[what].fun = 0;
 500         s->watchlist[what].data = 0;
 501         s->watchlist[what].obs = 0;
 502
 503         session_leave(s, "session_alert_watch");
 504         session_log(s, YLOG_DEBUG,
 505                     "Alert Watch: %d calling function: %p", what, fun);
 506         fun(data);
 507     }
 508     else
 509         session_leave(s,"session_alert_watch");
 510 }
 511
 512 //callback for grep_databases
 513 static void select_targets_callback(struct session *se,
 514                                     struct session_database *db)
 515 {
 516     struct client *cl;
 517     struct client_list *l;
 518
 519     for (l = se->clients_cached; l; l = l->next)
 520         if (client_get_database(l->client) == db)
 521             break;
 522
 523     if (l)
 524         cl = l->client;
 525     else
 526     {
 527         cl = client_create(db->database->id);
 528         client_set_database(cl, db);
 529
 530         l = xmalloc(sizeof(*l));
 531         l->client = cl;
 532         l->next = se->clients_cached;
 533         se->clients_cached = l;
 534     }
 535     /* set session always. If may be 0 if client is not active */
 536     client_set_session(cl, se);
 537
 538     l = xmalloc(sizeof(*l));
 539     l->client = cl;
 540     l->next = se->clients_active;
 541     se->clients_active = l;
 542 }
 543
 544 static void session_reset_active_clients(struct session *se,
 545                                          struct client_list *new_list)
 546 {
 547     struct client_list *l;
 548
 549     session_enter(se, "session_reset_active_clients");
 550     l = se->clients_active;
 551     se->clients_active = new_list;
 552     session_leave(se, "session_reset_active_clients");
 553
 554     while (l)
 555     {
 556         struct client_list *l_next = l->next;
 557
 558         client_lock(l->client);
 559         client_set_session(l->client, 0); /* mark client inactive */
 560         client_unlock(l->client);
 561
 562         xfree(l);
 563         l = l_next;
 564     }
 565 }
 566
 567 static void session_remove_cached_clients(struct session *se)
 568 {
 569     struct client_list *l;
 570
 571     session_reset_active_clients(se, 0);
 572
 573     session_enter(se, "session_remove_cached_clients");
 574     l = se->clients_cached;
 575     se->clients_cached = 0;
 576     session_leave(se, "session_remove_cached_clients");
 577
 578     while (l)
 579     {
 580         struct client_list *l_next = l->next;
 581         client_lock(l->client);
 582         client_set_session(l->client, 0);
 583         client_set_database(l->client, 0);
 584         client_unlock(l->client);
 585         client_destroy(l->client);
 586         xfree(l);
 587         l = l_next;
 588     }
 589 }
 590
 591 // Associates a set of clients with a session;
 592 // Note: Session-databases represent databases with per-session
 593 // setting overrides
 594 static int select_targets(struct session *se, const char *filter)
 595 {
 596     return session_grep_databases(se, filter, select_targets_callback);
 597 }
 598
 599 int session_active_clients(struct session *s)
 600 {
 601     struct client_list *l;
 602     int res = 0;
 603
 604     for (l = s->clients_active; l; l = l->next)
 605         if (client_is_active(l->client))
 606             res++;
 607
 608     return res;
 609 }
 610
 611 int session_is_preferred_clients_ready(struct session *s)
 612 {
 613     struct client_list *l;
 614     int res = 0;
 615
 616     for (l = s->clients_active; l; l = l->next)
 617         if (client_is_active_preferred(l->client))
 618             res++;
 619     session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
 620     return res == 0;
 621 }
 622
 623 static void session_clear_set(struct session *se, struct reclist_sortparms *sp)
 624 {
 625     reclist_destroy(se->reclist);
 626     se->reclist = 0;
 627     if (nmem_total(se->nmem))
 628         session_log(se, YLOG_DEBUG, "NMEN operation usage %zd",
 629                     nmem_total(se->nmem));
 630     nmem_reset(se->nmem);
 631     se->total_records = se->total_merged = 0;
 632     se->num_termlists = 0;
 633
 634     /* reset list of sorted results and clear to relevance search */
 635     se->sorted_results = nmem_malloc(se->nmem, sizeof(*se->sorted_results));
 636     se->sorted_results->name = nmem_strdup(se->nmem, sp->name);
 637     se->sorted_results->increasing = sp->increasing;
 638     se->sorted_results->type = sp->type;
 639     se->sorted_results->next = 0;
 640
 641     session_log(se, YLOG_DEBUG, "clear_set session_sort: field=%s increasing=%d type=%d configured",
 642             sp->name, sp->increasing, sp->type);
 643
 644     se->reclist = reclist_create(se->nmem);
 645 }
 646
 647 static void session_sort_unlocked(struct session *se, struct reclist_sortparms *sp)
 648 {
 649     struct reclist_sortparms *sr;
 650     struct client_list *l;
 651     const char *field = sp->name;
 652     int increasing = sp->increasing;
 653     int type  = sp->type;
 654     int clients_research = 0;
 655
 656     yaz_log(YLOG_LOG, "session_sort field=%s increasing=%d type=%d", field, increasing, type);
 657     /* see if we already have sorted for this criteria */
 658     for (sr = se->sorted_results; sr; sr = sr->next)
 659     {
 660         if (!reclist_sortparms_cmp(sr,sp))
 661             break;
 662     }
 663     if (sr)
 664     {
 665         session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d type=%d already fetched",
 666                     field, increasing, type);
 667         return;
 668     }
 669     session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d type=%d must fetch",
 670                     field, increasing, type);
 671
 672     // We need to reset reclist on every sort that changes the records, not just for position
 673     // So if just one client requires new searching, we need to clear set.
 674     // Ask each of the client if sorting requires re-search due to native sort
 675     // If it does it will require us to
 676     for (l = se->clients_active; l; l = l->next)
 677     {
 678         struct client *cl = l->client;
 679         // Assume no re-search is required.
 680         client_parse_init(cl, 1);
 681         clients_research += client_parse_sort(cl, sp);
 682     }
 683     if (clients_research) {
 684         yaz_log(YLOG_DEBUG, "Reset results due to %d clients researching", clients_research);
 685         session_clear_set(se, sp);
 686     }
 687     else {
 688         // A new sorting based on same record set
 689         sr = nmem_malloc(se->nmem, sizeof(*sr));
 690         sr->name = nmem_strdup(se->nmem, field);
 691         sr->increasing = increasing;
 692         sr->type = type;
 693         sr->next = se->sorted_results;
 694         se->sorted_results = sr;
 695         session_log(se, YLOG_DEBUG, "No research/ingesting done");
 696         return ;
 697     }
 698     session_log(se, YLOG_DEBUG, "Re- search/ingesting for clients due to change in sort order");
 699
 700     for (l = se->clients_active; l; l = l->next)
 701     {
 702         struct client *cl = l->client;
 703         if (client_get_state(cl) == Client_Connecting ||
 704             client_get_state(cl) == Client_Idle ||
 705             client_get_state(cl) == Client_Working) {
 706             client_start_search(cl);
 707         }
 708         else {
 709             yaz_log(YLOG_DEBUG, "Client %s: No re-start/ingest in show. Wrong client state: %d",
 710                         client_get_id(cl), client_get_state(cl));
 711         }
 712
 713     }
 714 }
 715
 716 void session_sort(struct session *se, struct reclist_sortparms *sp) {
 717     //session_enter(se, "session_sort");
 718     session_sort_unlocked(se, sp);
 719     //session_leave(se, "session_sort");
 720 }
 721
 722
 723 enum pazpar2_error_code session_search(struct session *se,
 724                                        const char *query,
 725                                        const char *startrecs,
 726                                        const char *maxrecs,
 727                                        const char *filter,
 728                                        const char *limit,
 729                                        const char **addinfo,
 730                                        struct reclist_sortparms *sp)
 731 {
 732     int live_channels = 0;
 733     int no_working = 0;
 734     int no_failed_query = 0;
 735     int no_failed_limit = 0;
 736     struct client_list *l, *l0;
 737     facet_limits_t facet_limits;
 738     int same_sort_order = 0;
 739
 740     session_log(se, YLOG_DEBUG, "Search");
 741
 742     *addinfo = 0;
 743
 744     if (se->settings_modified) {
 745         session_remove_cached_clients(se);
 746     }
 747     else
 748         session_reset_active_clients(se, 0);
 749
 750     session_enter(se, "session_search");
 751     se->settings_modified = 0;
 752
 753     if (se->sorted_results) {
 754         if (!reclist_sortparms_cmp(se->sorted_results, sp))
 755             same_sort_order = 1;
 756     }
 757     session_clear_set(se, sp);
 758     relevance_destroy(&se->relevance);
 759
 760     live_channels = select_targets(se, filter);
 761     if (!live_channels)
 762     {
 763         session_leave(se, "session_search");
 764         return PAZPAR2_NO_TARGETS;
 765     }
 766
 767     facet_limits = facet_limits_create(limit);
 768     if (!facet_limits)
 769     {
 770         *addinfo = "limit";
 771         session_leave(se, "session_search");
 772         return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 773     }
 774
 775     l0 = se->clients_active;
 776     se->clients_active = 0;
 777     session_leave(se, "session_search");
 778
 779     for (l = l0; l; l = l->next)
 780     {
 781         int parse_ret;
 782         struct client *cl = l->client;
 783         client_parse_init(cl, 1);
 784         if (prepare_map(se, client_get_database(cl)) < 0)
 785             continue;
 786
 787         parse_ret = client_parse_query(cl, query, facet_limits, se->service->ccl_bibset);
 788         if (parse_ret == -1)
 789             no_failed_query++;
 790         else if (parse_ret == -2)
 791             no_failed_limit++;
 792         else if (parse_ret < 0)
 793             no_working++; /* other error, such as bad CCL map */
 794         else
 795         {
 796             client_parse_range(cl, startrecs, maxrecs);
 797             client_parse_sort(cl, sp);
 798             client_start_search(cl);
 799             no_working++;
 800         }
 801     }
 802     facet_limits_destroy(facet_limits);
 803     session_reset_active_clients(se, l0);
 804
 805     if (no_working == 0)
 806     {
 807         if (no_failed_query > 0)
 808         {
 809             *addinfo = "query";
 810             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 811         }
 812         else if (no_failed_limit > 0)
 813         {
 814             *addinfo = "limit";
 815             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 816         }
 817         else
 818             return PAZPAR2_NO_TARGETS;
 819     }
 820     session_log(se, YLOG_LOG, "session_start_search done");
 821     return PAZPAR2_NO_ERROR;
 822 }
 823
 824 // Creates a new session_database object for a database
 825 static void session_init_databases_fun(void *context, struct database *db)
 826 {
 827     struct session *se = (struct session *) context;
 828     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 829     int i;
 830
 831     new->database = db;
 832
 833     new->map = 0;
 834     assert(db->settings);
 835     new->settings = nmem_malloc(se->session_nmem,
 836                                 sizeof(struct settings *) * db->num_settings);
 837     new->num_settings = db->num_settings;
 838     for (i = 0; i < db->num_settings; i++)
 839     {
 840         struct setting *setting = db->settings[i];
 841         new->settings[i] = setting;
 842     }
 843     new->next = se->databases;
 844     se->databases = new;
 845 }
 846
 847 // Doesn't free memory associated with sdb -- nmem takes care of that
 848 static void session_database_destroy(struct session_database *sdb)
 849 {
 850     sdb->map = 0;
 851 }
 852
 853 // Initialize session_database list -- this represents this session's view
 854 // of the database list -- subject to modification by the settings ws command
 855 void session_init_databases(struct session *se)
 856 {
 857     se->databases = 0;
 858     predef_grep_databases(se, se->service, session_init_databases_fun);
 859 }
 860
 861 // Probably session_init_databases_fun should be refactored instead of
 862 // called here.
 863 static struct session_database *load_session_database(struct session *se,
 864                                                       char *id)
 865 {
 866     struct database *db = new_database_inherit_settings(id, se->session_nmem, se->service->settings);
 867     session_init_databases_fun((void*) se, db);
 868
 869     // New sdb is head of se->databases list
 870     return se->databases;
 871 }
 872
 873 // Find an existing session database. If not found, load it
 874 static struct session_database *find_session_database(struct session *se,
 875                                                       char *id)
 876 {
 877     struct session_database *sdb;
 878
 879     for (sdb = se->databases; sdb; sdb = sdb->next)
 880         if (!strcmp(sdb->database->id, id))
 881             return sdb;
 882     return load_session_database(se, id);
 883 }
 884
 885 // Apply a session override to a database
 886 void session_apply_setting(struct session *se, char *dbname, char *setting,
 887                            char *value)
 888 {
 889     struct session_database *sdb = find_session_database(se, dbname);
 890     struct conf_service *service = se->service;
 891     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 892     int offset = settings_create_offset(service, setting);
 893
 894     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
 895                           se->session_nmem);
 896     new->precedence = 0;
 897     new->target = dbname;
 898     new->name = setting;
 899     new->value = value;
 900     new->next = sdb->settings[offset];
 901     sdb->settings[offset] = new;
 902
 903     se->settings_modified = 1;
 904
 905     // Force later recompute of settings-driven data structures
 906     // (happens when a search starts and client connections are prepared)
 907     switch (offset)
 908     {
 909     case PZ_XSLT:
 910         if (sdb->map)
 911         {
 912             sdb->map = 0;
 913         }
 914         break;
 915     }
 916 }
 917
 918 void session_destroy(struct session *se)
 919 {
 920     struct session_database *sdb;
 921     session_log(se, YLOG_DEBUG, "Destroying");
 922     session_use(-1);
 923     session_remove_cached_clients(se);
 924
 925     for (sdb = se->databases; sdb; sdb = sdb->next)
 926         session_database_destroy(sdb);
 927     normalize_cache_destroy(se->normalize_cache);
 928     relevance_destroy(&se->relevance);
 929     reclist_destroy(se->reclist);
 930     if (nmem_total(se->nmem))
 931         session_log(se, YLOG_DEBUG, "NMEN operation usage %zd", nmem_total(se->nmem));
 932     if (nmem_total(se->session_nmem))
 933         session_log(se, YLOG_DEBUG, "NMEN session usage %zd", nmem_total(se->session_nmem));
 934     nmem_destroy(se->nmem);
 935     service_destroy(se->service);
 936     yaz_mutex_destroy(&se->session_mutex);
 937 }
 938
 939 size_t session_get_memory_status(struct session *session) {
 940     size_t session_nmem;
 941     if (session == 0)
 942         return 0;
 943     session_enter(session, "session_get_memory_status");
 944     session_nmem = nmem_total(session->nmem);
 945     session_leave(session, "session_get_memory_status");
 946     return session_nmem;
 947 }
 948
 949
 950 struct session *new_session(NMEM nmem, struct conf_service *service,
 951                             unsigned session_id)
 952 {
 953     int i;
 954     struct session *session = nmem_malloc(nmem, sizeof(*session));
 955
 956     char tmp_str[50];
 957
 958     sprintf(tmp_str, "session#%u", session_id);
 959
 960     session->session_id = session_id;
 961     session_log(session, YLOG_DEBUG, "New");
 962     session->service = service;
 963     session->relevance = 0;
 964     session->total_records = 0;
 965     session->number_of_warnings_unknown_elements = 0;
 966     session->number_of_warnings_unknown_metadata = 0;
 967     session->num_termlists = 0;
 968     session->reclist = 0;
 969     session->clients_active = 0;
 970     session->clients_cached = 0;
 971     session->settings_modified = 0;
 972     session->session_nmem = nmem;
 973     session->nmem = nmem_create();
 974     session->databases = 0;
 975     session->sorted_results = 0;
 976
 977     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 978     {
 979         session->watchlist[i].data = 0;
 980         session->watchlist[i].fun = 0;
 981     }
 982     session->normalize_cache = normalize_cache_create();
 983     session->session_mutex = 0;
 984     pazpar2_mutex_create(&session->session_mutex, tmp_str);
 985     session_use(1);
 986     return session;
 987 }
 988
 989 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
 990
 991 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
 992                                             int *count, NMEM nmem)
 993 {
 994     struct hitsbytarget *res = 0;
 995     struct client_list *l;
 996     size_t sz = 0;
 997
 998     for (l = se->clients_active; l; l = l->next)
 999         sz++;
1000
1001     res = nmem_malloc(nmem, sizeof(*res) * sz);
1002     *count = 0;
1003     for (l = se->clients_active; l; l = l->next)
1004     {
1005         struct client *cl = l->client;
1006         WRBUF w = wrbuf_alloc();
1007         const char *name = session_setting_oneval(client_get_database(cl),
1008                                                   PZ_NAME);
1009
1010         res[*count].id = client_get_id(cl);
1011         res[*count].name = *name ? name : "Unknown";
1012         res[*count].hits = client_get_hits(cl);
1013         res[*count].approximation = client_get_approximation(cl);
1014         res[*count].records = client_get_num_records(cl);
1015         res[*count].filtered = client_get_num_records_filtered(cl);
1016         res[*count].diagnostic =
1017             client_get_diagnostic(cl, &res[*count].message,
1018                                   &res[*count].addinfo);
1019         res[*count].state = client_get_state_str(cl);
1020         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
1021         session_settings_dump(se, client_get_database(cl), w);
1022         res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
1023         wrbuf_rewind(w);
1024         wrbuf_puts(w, "");
1025         res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
1026         wrbuf_destroy(w);
1027         (*count)++;
1028     }
1029     return res;
1030 }
1031
1032 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
1033 {
1034     struct hitsbytarget *p;
1035     session_enter(se, "get_hitsbytarget");
1036     p = hitsbytarget_nb(se, count, nmem);
1037     session_leave(se, "get_hitsbytarget");
1038     return p;
1039 }
1040
1041 // Compares two hitsbytarget nodes by hitcount
1042 static int cmp_ht(const void *p1, const void *p2)
1043 {
1044     const struct hitsbytarget *h1 = p1;
1045     const struct hitsbytarget *h2 = p2;
1046     return h2->hits - h1->hits;
1047 }
1048
1049 // Compares two hitsbytarget nodes by hitcount
1050 static int cmp_ht_approx(const void *p1, const void *p2)
1051 {
1052     const struct hitsbytarget *h1 = p1;
1053     const struct hitsbytarget *h2 = p2;
1054     return h2->approximation - h1->approximation;
1055 }
1056
1057 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1058                                NMEM nmem, int version)
1059 {
1060     struct hitsbytarget *ht;
1061     int count, i;
1062
1063     ht = hitsbytarget_nb(se, &count, nmem);
1064     if (version >= 2)
1065         qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht_approx);
1066     else
1067         qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1068     for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1069     {
1070
1071         // do only print terms which have display names
1072
1073         wrbuf_puts(wrbuf, "<term>\n");
1074
1075         wrbuf_puts(wrbuf, "<id>");
1076         wrbuf_xmlputs(wrbuf, ht[i].id);
1077         wrbuf_puts(wrbuf, "</id>\n");
1078
1079         wrbuf_puts(wrbuf, "<name>");
1080         if (!ht[i].name || !ht[i].name[0])
1081             wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1082         else
1083             wrbuf_xmlputs(wrbuf, ht[i].name);
1084         wrbuf_puts(wrbuf, "</name>\n");
1085
1086         wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1087                      ht[i].hits);
1088
1089         if (version >= 2) {
1090             // Should not print if we know it isn't a approximation.
1091             wrbuf_printf(wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
1092             wrbuf_printf(wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
1093             wrbuf_printf(wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
1094         }
1095
1096         wrbuf_puts(wrbuf, "<state>");
1097         wrbuf_xmlputs(wrbuf, ht[i].state);
1098         wrbuf_puts(wrbuf, "</state>\n");
1099
1100         wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1101                      ht[i].diagnostic);
1102         wrbuf_puts(wrbuf, "</term>\n");
1103     }
1104     return count;
1105 }
1106
1107 void perform_termlist(struct http_channel *c, struct session *se,
1108                       const char *name, int num, int version)
1109 {
1110     int i, j;
1111     NMEM nmem_tmp = nmem_create();
1112     char **names;
1113     int num_names = 0;
1114
1115     if (!name)
1116         name = "*";
1117
1118     nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1119
1120     session_enter(se, "perform_termlist");
1121
1122     for (j = 0; j < num_names; j++)
1123     {
1124         const char *tname;
1125         int must_generate_empty = 1; /* bug 5350 */
1126
1127         for (i = 0; i < se->num_termlists; i++)
1128         {
1129             tname = se->termlists[i].name;
1130             if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1131             {
1132                 struct termlist_score **p = 0;
1133                 int len;
1134
1135                 wrbuf_puts(c->wrbuf, "<list name=\"");
1136                 wrbuf_xmlputs(c->wrbuf, tname);
1137                 wrbuf_puts(c->wrbuf, "\">\n");
1138                 must_generate_empty = 0;
1139
1140                 p = termlist_highscore(se->termlists[i].termlist, &len,
1141                                        nmem_tmp);
1142                 if (p)
1143                 {
1144                     int i;
1145                     for (i = 0; i < len && i < num; i++)
1146                     {
1147                         // prevent sending empty term elements
1148                         if (!p[i]->display_term || !p[i]->display_term[0])
1149                             continue;
1150
1151                         wrbuf_puts(c->wrbuf, "<term>");
1152                         wrbuf_puts(c->wrbuf, "<name>");
1153                         wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1154                         wrbuf_puts(c->wrbuf, "</name>");
1155
1156                         wrbuf_printf(c->wrbuf,
1157                                      "<frequency>%d</frequency>",
1158                                      p[i]->frequency);
1159                         wrbuf_puts(c->wrbuf, "</term>\n");
1160                     }
1161                 }
1162                 wrbuf_puts(c->wrbuf, "</list>\n");
1163             }
1164         }
1165         tname = "xtargets";
1166         if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1167         {
1168             wrbuf_puts(c->wrbuf, "<list name=\"");
1169             wrbuf_xmlputs(c->wrbuf, tname);
1170             wrbuf_puts(c->wrbuf, "\">\n");
1171
1172             targets_termlist_nb(c->wrbuf, se, num, c->nmem, version);
1173             wrbuf_puts(c->wrbuf, "</list>\n");
1174             must_generate_empty = 0;
1175         }
1176         if (must_generate_empty)
1177         {
1178             wrbuf_puts(c->wrbuf, "<list name=\"");
1179             wrbuf_xmlputs(c->wrbuf, names[j]);
1180             wrbuf_puts(c->wrbuf, "\"/>\n");
1181         }
1182     }
1183     session_leave(se, "perform_termlist");
1184     nmem_destroy(nmem_tmp);
1185 }
1186
1187 #ifdef MISSING_HEADERS
1188 void report_nmem_stats(void)
1189 {
1190     size_t in_use, is_free;
1191
1192     nmem_get_memory_in_use(&in_use);
1193     nmem_get_memory_free(&is_free);
1194
1195     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1196             (long) in_use, (long) is_free);
1197 }
1198 #endif
1199
1200 struct record_cluster *show_single_start(struct session *se, const char *id,
1201                                          struct record_cluster **prev_r,
1202                                          struct record_cluster **next_r)
1203 {
1204     struct record_cluster *r = 0;
1205
1206     session_enter(se, "show_single_start");
1207     *prev_r = 0;
1208     *next_r = 0;
1209     if (se->reclist)
1210     {
1211         reclist_enter(se->reclist);
1212         while ((r = reclist_read_record(se->reclist)))
1213         {
1214             if (!strcmp(r->recid, id))
1215             {
1216                 *next_r = reclist_read_record(se->reclist);
1217                 break;
1218             }
1219             *prev_r = r;
1220         }
1221         reclist_leave(se->reclist);
1222     }
1223     if (!r)
1224         session_leave(se, "show_single_start");
1225     return r;
1226 }
1227
1228 void show_single_stop(struct session *se, struct record_cluster *rec)
1229 {
1230     session_leave(se, "show_single_stop");
1231 }
1232
1233 struct record_cluster **show_range_start(struct session *se,
1234                                          struct reclist_sortparms *sp,
1235                                          int start, int *num, int *total, Odr_int *sumhits, Odr_int *approx_hits)
1236 {
1237     struct record_cluster **recs;
1238     struct reclist_sortparms *spp;
1239     int i;
1240 #if USE_TIMING
1241     yaz_timing_t t = yaz_timing_create();
1242 #endif
1243     session_enter(se, "show_range_start");
1244     recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
1245     if (!se->relevance)
1246     {
1247         *num = 0;
1248         *total = 0;
1249         *sumhits = 0;
1250         *approx_hits = 0;
1251         recs = 0;
1252     }
1253     else
1254     {
1255         struct client_list *l;
1256
1257         for (spp = sp; spp; spp = spp->next)
1258             if (spp->type == Metadata_sortkey_relevance)
1259             {
1260                 relevance_prepare_read(se->relevance, se->reclist);
1261                 break;
1262             }
1263         reclist_sort(se->reclist, sp);
1264
1265         reclist_enter(se->reclist);
1266         *total = reclist_get_num_records(se->reclist);
1267
1268         *sumhits = 0;
1269         *approx_hits = 0;
1270         for (l = se->clients_active; l; l = l->next) {
1271             *sumhits += client_get_hits(l->client);
1272             *approx_hits += client_get_approximation(l->client);
1273         }
1274         for (i = 0; i < start; i++)
1275             if (!reclist_read_record(se->reclist))
1276             {
1277                 *num = 0;
1278                 recs = 0;
1279                 break;
1280             }
1281
1282         for (i = 0; i < *num; i++)
1283         {
1284             struct record_cluster *r = reclist_read_record(se->reclist);
1285             if (!r)
1286             {
1287                 *num = i;
1288                 break;
1289             }
1290             recs[i] = r;
1291         }
1292         reclist_leave(se->reclist);
1293     }
1294 #if USE_TIMING
1295     yaz_timing_stop(t);
1296     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1297             yaz_timing_get_real(t), yaz_timing_get_user(t),
1298             yaz_timing_get_sys(t));
1299     yaz_timing_destroy(&t);
1300 #endif
1301     return recs;
1302 }
1303
1304 void show_range_stop(struct session *se, struct record_cluster **recs)
1305 {
1306     session_leave(se, "show_range_stop");
1307 }
1308
1309 void statistics(struct session *se, struct statistics *stat)
1310 {
1311     struct client_list *l;
1312     int count = 0;
1313
1314     memset(stat, 0, sizeof(*stat));
1315     stat->num_hits = 0;
1316     for (l = se->clients_active; l; l = l->next)
1317     {
1318         struct client *cl = l->client;
1319         if (!client_get_connection(cl))
1320             stat->num_no_connection++;
1321         stat->num_hits += client_get_hits(cl);
1322         switch (client_get_state(cl))
1323         {
1324         case Client_Connecting: stat->num_connecting++; break;
1325         case Client_Working: stat->num_working++; break;
1326         case Client_Idle: stat->num_idle++; break;
1327         case Client_Failed: stat->num_failed++; break;
1328         case Client_Error: stat->num_error++; break;
1329         default: break;
1330         }
1331         count++;
1332     }
1333     stat->num_records = se->total_records;
1334
1335     stat->num_clients = count;
1336 }
1337
1338 static struct record_metadata *record_metadata_init(
1339     NMEM nmem, const char *value, enum conf_metadata_type type,
1340     struct _xmlAttr *attr)
1341 {
1342     struct record_metadata *rec_md = record_metadata_create(nmem);
1343     struct record_metadata_attr **attrp = &rec_md->attributes;
1344
1345     for (; attr; attr = attr->next)
1346     {
1347         if (attr->children && attr->children->content)
1348         {
1349             if (strcmp((const char *) attr->name, "type"))
1350             {  /* skip the "type" attribute.. Its value is already part of
1351                   the element in output (md-%s) and so repeating it here
1352                   is redundant */
1353                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1354                 (*attrp)->name =
1355                     nmem_strdup(nmem, (const char *) attr->name);
1356                 (*attrp)->value =
1357                     nmem_strdup(nmem, (const char *) attr->children->content);
1358                 attrp = &(*attrp)->next;
1359             }
1360         }
1361     }
1362     *attrp = 0;
1363
1364     if (type == Metadata_type_generic)
1365     {
1366         char *p = nmem_strdup(nmem, value);
1367
1368         p = normalize7bit_generic(p, " ,/.:([");
1369
1370         rec_md->data.text.disp = p;
1371         rec_md->data.text.sort = 0;
1372     }
1373     else if (type == Metadata_type_year || type == Metadata_type_date)
1374     {
1375         int first, last;
1376         int longdate = 0;
1377
1378         if (type == Metadata_type_date)
1379             longdate = 1;
1380         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1381             return 0;
1382
1383         rec_md->data.number.min = first;
1384         rec_md->data.number.max = last;
1385     }
1386     else
1387         return 0;
1388     return rec_md;
1389 }
1390
1391 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1392                                  struct conf_service *service, WRBUF norm_wr)
1393 {
1394     xmlNode *n;
1395     int no_found = 0;
1396     for (n = root->children; n; n = n->next)
1397     {
1398         if (n->type != XML_ELEMENT_NODE)
1399             continue;
1400         if (!strcmp((const char *) n->name, "metadata"))
1401         {
1402             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1403             if (type == NULL) {
1404                 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1405             }
1406             else if (!strcmp(name, (const char *) type))
1407             {
1408                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1409                 if (value)
1410                 {
1411                     const char *norm_str;
1412                     pp2_charset_token_t prt =
1413                         pp2_charset_token_create(service->charsets, "mergekey");
1414
1415                     pp2_charset_token_first(prt, (const char *) value, 0);
1416                     if (wrbuf_len(norm_wr) > 0)
1417                         wrbuf_puts(norm_wr, " ");
1418                     wrbuf_puts(norm_wr, name);
1419                     while ((norm_str =
1420                             pp2_charset_token_next(prt)))
1421                     {
1422                         if (*norm_str)
1423                         {
1424                             wrbuf_puts(norm_wr, " ");
1425                             wrbuf_puts(norm_wr, norm_str);
1426                         }
1427                     }
1428                     xmlFree(value);
1429                     pp2_charset_token_destroy(prt);
1430                     no_found++;
1431                 }
1432             }
1433             xmlFree(type);
1434         }
1435     }
1436     return no_found;
1437 }
1438
1439 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1440                                 struct conf_service *service, NMEM nmem)
1441 {
1442     char *mergekey_norm = 0;
1443     xmlNode *root = xmlDocGetRootElement(doc);
1444     WRBUF norm_wr = wrbuf_alloc();
1445
1446     /* consider mergekey from XSL first */
1447     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1448     if (mergekey)
1449     {
1450         const char *norm_str;
1451         pp2_charset_token_t prt =
1452             pp2_charset_token_create(service->charsets, "mergekey");
1453
1454         pp2_charset_token_first(prt, (const char *) mergekey, 0);
1455         while ((norm_str = pp2_charset_token_next(prt)))
1456         {
1457             if (*norm_str)
1458             {
1459                 if (wrbuf_len(norm_wr))
1460                     wrbuf_puts(norm_wr, " ");
1461                 wrbuf_puts(norm_wr, norm_str);
1462             }
1463         }
1464         pp2_charset_token_destroy(prt);
1465         xmlFree(mergekey);
1466     }
1467     else
1468     {
1469         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1470         int field_id;
1471         for (field_id = 0; field_id < service->num_metadata; field_id++)
1472         {
1473             struct conf_metadata *ser_md = &service->metadata[field_id];
1474             if (ser_md->mergekey != Metadata_mergekey_no)
1475             {
1476                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1477                                               service, norm_wr);
1478                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1479                 {
1480                     /* no mergekey on this one and it is required..
1481                        Generate unique key instead */
1482                     wrbuf_rewind(norm_wr);
1483                     break;
1484                 }
1485             }
1486         }
1487     }
1488
1489     /* generate unique key if none is not generated already or is empty */
1490     if (wrbuf_len(norm_wr) == 0)
1491     {
1492         wrbuf_printf(norm_wr, "position: %s-%d",
1493                      client_get_id(cl), record_no);
1494     }
1495     else
1496     {
1497         const char *lead = "content: ";
1498         wrbuf_insert(norm_wr, 0, lead, strlen(lead));
1499     }
1500     if (wrbuf_len(norm_wr) > 0)
1501         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1502     wrbuf_destroy(norm_wr);
1503     return mergekey_norm;
1504 }
1505
1506 /** \brief see if metadata for pz:recordfilter exists
1507     \param root xml root element of normalized record
1508     \param sdb session database for client
1509     \retval 0 if there is no metadata for pz:recordfilter
1510     \retval 1 if there is metadata for pz:recordfilter
1511
1512     If there is no pz:recordfilter defined, this function returns 1
1513     as well.
1514 */
1515
1516 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1517 {
1518     int match = 0;
1519     xmlNode *n;
1520     const char *s;
1521     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1522
1523     if (!s || !*s)
1524         return 1;
1525
1526     for (n = root->children; n; n = n->next)
1527     {
1528         if (n->type != XML_ELEMENT_NODE)
1529             continue;
1530         if (!strcmp((const char *) n->name, "metadata"))
1531         {
1532             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1533             if (type)
1534             {
1535                 size_t len;
1536                 int substring;
1537                 const char *eq;
1538
1539                 if ((eq = strchr(s, '=')))
1540                     substring = 0;
1541                 else if ((eq = strchr(s, '~')))
1542                     substring = 1;
1543                 if (eq)
1544                     len = eq - s;
1545                 else
1546                     len = strlen(s);
1547                 if (len == strlen((const char *)type) &&
1548                     !memcmp((const char *) type, s, len))
1549                 {
1550                     xmlChar *value = xmlNodeGetContent(n);
1551                     if (value && *value)
1552                     {
1553                         if (!eq ||
1554                             (substring && strstr((const char *) value, eq+1)) ||
1555                             (!substring && !strcmp((const char *) value, eq + 1)))
1556                             match = 1;
1557                     }
1558                     xmlFree(value);
1559                 }
1560                 xmlFree(type);
1561             }
1562         }
1563     }
1564     return match;
1565 }
1566
1567
1568 static int ingest_to_cluster(struct client *cl,
1569                              xmlDoc *xdoc,
1570                              xmlNode *root,
1571                              int record_no,
1572                              const char *mergekey_norm);
1573
1574 /** \brief ingest XML record
1575     \param cl client holds the result set for record
1576     \param rec record buffer (0 terminated)
1577     \param record_no record position (1, 2, ..)
1578     \param nmem working NMEM
1579     \retval 0 OK
1580     \retval -1 failure
1581     \retval -2 Filtered
1582 */
1583 int ingest_record(struct client *cl, const char *rec,
1584                   int record_no, NMEM nmem)
1585 {
1586     struct session *se = client_get_session(cl);
1587     int ret = 0;
1588     struct session_database *sdb = client_get_database(cl);
1589     struct conf_service *service = se->service;
1590     xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1591     xmlNode *root;
1592     const char *mergekey_norm;
1593
1594     if (!xdoc)
1595         return -1;
1596
1597     root = xmlDocGetRootElement(xdoc);
1598
1599     if (!check_record_filter(root, sdb))
1600     {
1601         session_log(se, YLOG_LOG, "Filtered out record no %d from %s", record_no, sdb->database->id);
1602         xmlFreeDoc(xdoc);
1603         return -2;
1604     }
1605
1606     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1607     if (!mergekey_norm)
1608     {
1609         session_log(se, YLOG_WARN, "Got no mergekey");
1610         xmlFreeDoc(xdoc);
1611         return -1;
1612     }
1613     session_enter(se, "ingest_record");
1614     if (client_get_session(cl) == se)
1615         ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1616     session_leave(se, "ingest_record");
1617
1618     xmlFreeDoc(xdoc);
1619     return ret;
1620 }
1621
1622 static int match_metadata_local(struct record *record,
1623                                 struct conf_service *service,
1624                                 int md_field_id,
1625                                 char **values, int num_v)
1626 {
1627     int i;
1628     struct conf_metadata *ser_md = &service->metadata[md_field_id];
1629     struct record_metadata *rec_md = record->metadata[md_field_id];
1630     for (i = 0; i < num_v; )
1631     {
1632         if (rec_md)
1633         {
1634             if (ser_md->type == Metadata_type_year
1635                 || ser_md->type == Metadata_type_date)
1636             {
1637                 int y = atoi(values[i]);
1638                 if (y >= rec_md->data.number.min
1639                     && y <= rec_md->data.number.max)
1640                     break;
1641             }
1642             else
1643             {
1644                 yaz_log(YLOG_DEBUG, "cmp: '%s' '%s'", rec_md->data.text.disp, values[i]);
1645                 if (!strcmp(rec_md->data.text.disp, values[i]))
1646                 {
1647                     // Value equals, should not be filtered.
1648                     break;
1649                 }
1650             }
1651             rec_md = rec_md->next;
1652         }
1653         else
1654         {
1655             rec_md = record->metadata[md_field_id];
1656             i++;
1657         }
1658     }
1659     return i < num_v ? 1 : 0;
1660 }
1661
1662 // Skip record on non-zero
1663 static int check_limit_local(struct client *cl,
1664                              struct record *record,
1665                              int record_no)
1666 {
1667     int skip_record = 0;
1668     struct session *se = client_get_session(cl);
1669     struct conf_service *service = se->service;
1670     NMEM nmem_tmp = nmem_create();
1671     struct session_database *sdb = client_get_database(cl);
1672     int l = 0;
1673     while (!skip_record)
1674     {
1675         int md_field_id;
1676         char **values = 0;
1677         int num_v = 0;
1678         const char *name =
1679             client_get_facet_limit_local(cl, sdb, &l, nmem_tmp,
1680                                          &num_v, &values);
1681         if (!name)
1682             break;
1683
1684         md_field_id = conf_service_metadata_field_id(service, name);
1685         if (md_field_id < 0)
1686         {
1687             skip_record = 1;
1688             break;
1689         }
1690         if (!match_metadata_local(record, service, md_field_id,
1691                                   values, num_v))
1692         {
1693             skip_record = 1;
1694             break;
1695         }
1696     }
1697     nmem_destroy(nmem_tmp);
1698     return skip_record;
1699 }
1700
1701 static int ingest_to_cluster(struct client *cl,
1702                              xmlDoc *xdoc,
1703                              xmlNode *root,
1704                              int record_no,
1705                              const char *mergekey_norm)
1706 {
1707     xmlNode *n;
1708     xmlChar *type = 0;
1709     xmlChar *value = 0;
1710     struct session *se = client_get_session(cl);
1711     struct conf_service *service = se->service;
1712     int term_factor = 1;
1713     struct record_cluster *cluster;
1714     struct session_database *sdb = client_get_database(cl);
1715     struct record *record = record_create(se->nmem,
1716                                           service->num_metadata,
1717                                           service->num_sortkeys, cl,
1718                                           record_no);
1719
1720     for (n = root->children; n; n = n->next)
1721     {
1722         if (type)
1723             xmlFree(type);
1724         if (value)
1725             xmlFree(value);
1726         type = value = 0;
1727
1728         if (n->type != XML_ELEMENT_NODE)
1729             continue;
1730         if (!strcmp((const char *) n->name, "metadata"))
1731         {
1732             struct conf_metadata *ser_md = 0;
1733             struct record_metadata **wheretoput = 0;
1734             struct record_metadata *rec_md = 0;
1735             int md_field_id = -1;
1736
1737             type = xmlGetProp(n, (xmlChar *) "type");
1738             value = xmlNodeListGetString(xdoc, n->children, 1);
1739
1740             if (!type || !value || !*value)
1741                 continue;
1742
1743             md_field_id
1744                 = conf_service_metadata_field_id(service, (const char *) type);
1745             if (md_field_id < 0)
1746             {
1747                 if (se->number_of_warnings_unknown_metadata == 0)
1748                 {
1749                     session_log(se, YLOG_WARN,
1750                             "Ignoring unknown metadata element: %s", type);
1751                 }
1752                 se->number_of_warnings_unknown_metadata++;
1753                 continue;
1754             }
1755
1756             ser_md = &service->metadata[md_field_id];
1757
1758             // non-merged metadata
1759             rec_md = record_metadata_init(se->nmem, (const char *) value,
1760                                           ser_md->type, n->properties);
1761             if (!rec_md)
1762             {
1763                 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1764                             "for element '%s'", value, type);
1765                 continue;
1766             }
1767             wheretoput = &record->metadata[md_field_id];
1768             while (*wheretoput)
1769                 wheretoput = &(*wheretoput)->next;
1770             *wheretoput = rec_md;
1771         }
1772     }
1773
1774     if (check_limit_local(cl, record, record_no))
1775     {
1776         session_log(se, YLOG_LOG, "Facet filtered out record no %d from %s",
1777                     record_no, sdb->database->id);
1778         if (type)
1779             xmlFree(type);
1780         if (value)
1781             xmlFree(value);
1782         return -2;
1783     }
1784     cluster = reclist_insert(se->reclist, service, record,
1785                              mergekey_norm, &se->total_merged);
1786     if (!cluster)
1787         return -1;
1788
1789     {
1790         const char *use_term_factor_str =
1791             session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1792         if (use_term_factor_str && use_term_factor_str[0] == '1')
1793         {
1794             int maxrecs = client_get_maxrecs(cl);
1795             int hits = (int) client_get_hits(cl);
1796             term_factor = MAX(hits, maxrecs) /  MAX(1, maxrecs);
1797             assert(term_factor >= 1);
1798             yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1799         }
1800     }
1801
1802     if (global_parameters.dump_records)
1803         session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1804                     sdb->database->id, record_no);
1805
1806
1807     relevance_newrec(se->relevance, cluster);
1808
1809     // now parsing XML record and adding data to cluster or record metadata
1810     for (n = root->children; n; n = n->next)
1811     {
1812         pp2_charset_token_t prt;
1813         if (type)
1814             xmlFree(type);
1815         if (value)
1816             xmlFree(value);
1817         type = value = 0;
1818
1819         if (n->type != XML_ELEMENT_NODE)
1820             continue;
1821         if (!strcmp((const char *) n->name, "metadata"))
1822         {
1823             struct conf_metadata *ser_md = 0;
1824             struct conf_sortkey *ser_sk = 0;
1825             struct record_metadata **wheretoput = 0;
1826             struct record_metadata *rec_md = 0;
1827             int md_field_id = -1;
1828             int sk_field_id = -1;
1829             const char *rank;
1830             xmlChar *xml_rank;
1831
1832             type = xmlGetProp(n, (xmlChar *) "type");
1833             value = xmlNodeListGetString(xdoc, n->children, 1);
1834
1835             if (!type || !value || !*value)
1836                 continue;
1837
1838             md_field_id
1839                 = conf_service_metadata_field_id(service, (const char *) type);
1840             if (md_field_id < 0)
1841                 continue;
1842
1843             ser_md = &service->metadata[md_field_id];
1844
1845             if (ser_md->sortkey_offset >= 0)
1846             {
1847                 sk_field_id = ser_md->sortkey_offset;
1848                 ser_sk = &service->sortkeys[sk_field_id];
1849             }
1850
1851             // merged metadata
1852             rec_md = record_metadata_init(se->nmem, (const char *) value,
1853                                           ser_md->type, 0);
1854             if (!rec_md)
1855                 continue;
1856
1857             xml_rank = xmlGetProp(n, (xmlChar *) "rank");
1858             rank = xml_rank ? (const char *) xml_rank : ser_md->rank;
1859
1860             wheretoput = &cluster->metadata[md_field_id];
1861
1862             // and polulate with data:
1863             // assign cluster or record based on merge action
1864             if (ser_md->merge == Metadata_merge_unique)
1865             {
1866                 while (*wheretoput)
1867                 {
1868                     if (!strcmp((const char *) (*wheretoput)->data.text.disp,
1869                                 rec_md->data.text.disp))
1870                         break;
1871                     wheretoput = &(*wheretoput)->next;
1872                 }
1873                 if (!*wheretoput)
1874                     *wheretoput = rec_md;
1875             }
1876             else if (ser_md->merge == Metadata_merge_longest)
1877             {
1878                 if (!*wheretoput
1879                     || strlen(rec_md->data.text.disp)
1880                     > strlen((*wheretoput)->data.text.disp))
1881                 {
1882                     *wheretoput = rec_md;
1883                     if (ser_sk)
1884                     {
1885                         const char *sort_str = 0;
1886                         int skip_article =
1887                             ser_sk->type == Metadata_sortkey_skiparticle;
1888
1889                         if (!cluster->sortkeys[sk_field_id])
1890                             cluster->sortkeys[sk_field_id] =
1891                                 nmem_malloc(se->nmem,
1892                                             sizeof(union data_types));
1893
1894                         prt =
1895                             pp2_charset_token_create(service->charsets, "sort");
1896
1897                         pp2_charset_token_first(prt, rec_md->data.text.disp,
1898                                                 skip_article);
1899
1900                         pp2_charset_token_next(prt);
1901
1902                         sort_str = pp2_get_sort(prt);
1903
1904                         cluster->sortkeys[sk_field_id]->text.disp =
1905                             rec_md->data.text.disp;
1906                         if (!sort_str)
1907                         {
1908                             sort_str = rec_md->data.text.disp;
1909                             session_log(se, YLOG_WARN,
1910                                     "Could not make sortkey. Bug #1858");
1911                         }
1912                         cluster->sortkeys[sk_field_id]->text.sort =
1913                             nmem_strdup(se->nmem, sort_str);
1914                         pp2_charset_token_destroy(prt);
1915                     }
1916                 }
1917             }
1918             else if (ser_md->merge == Metadata_merge_all)
1919             {
1920                 while (*wheretoput)
1921                     wheretoput = &(*wheretoput)->next;
1922                 *wheretoput = rec_md;
1923             }
1924             else if (ser_md->merge == Metadata_merge_range)
1925             {
1926                 if (!*wheretoput)
1927                 {
1928                     *wheretoput = rec_md;
1929                     if (ser_sk)
1930                         cluster->sortkeys[sk_field_id]
1931                             = &rec_md->data;
1932                 }
1933                 else
1934                 {
1935                     int this_min = rec_md->data.number.min;
1936                     int this_max = rec_md->data.number.max;
1937                     if (this_min < (*wheretoput)->data.number.min)
1938                         (*wheretoput)->data.number.min = this_min;
1939                     if (this_max > (*wheretoput)->data.number.max)
1940                         (*wheretoput)->data.number.max = this_max;
1941                 }
1942             }
1943
1944             // ranking of _all_ fields enabled ...
1945             if (rank)
1946             {
1947                 relevance_countwords(se->relevance, cluster,
1948                                      (char *) value, rank, ser_md->name);
1949             }
1950
1951             // construct facets ... unless the client already has reported them
1952             if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1953             {
1954                 if (ser_md->type == Metadata_type_year)
1955                 {
1956                     char year[64];
1957                     sprintf(year, "%d", rec_md->data.number.max);
1958
1959                     add_facet(se, (char *) type, year, term_factor);
1960                     if (rec_md->data.number.max != rec_md->data.number.min)
1961                     {
1962                         sprintf(year, "%d", rec_md->data.number.min);
1963                         add_facet(se, (char *) type, year, term_factor);
1964                     }
1965                 }
1966                 else
1967                     add_facet(se, (char *) type, (char *) value, term_factor);
1968             }
1969
1970             // cleaning up
1971             if (xml_rank)
1972                 xmlFree(xml_rank);
1973             xmlFree(type);
1974             xmlFree(value);
1975             type = value = 0;
1976         }
1977         else
1978         {
1979             if (se->number_of_warnings_unknown_elements == 0)
1980                 session_log(se, YLOG_WARN,
1981                         "Unexpected element in internal record: %s", n->name);
1982             se->number_of_warnings_unknown_elements++;
1983         }
1984     }
1985     if (type)
1986         xmlFree(type);
1987     if (value)
1988         xmlFree(value);
1989
1990     relevance_donerecord(se->relevance, cluster);
1991     se->total_records++;
1992
1993     return 0;
1994 }
1995
1996 void session_log(struct session *s, int level, const char *fmt, ...)
1997 {
1998     char buf[1024];
1999     va_list ap;
2000     va_start(ap, fmt);
2001
2002     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
2003     yaz_log(level, "Session %u: %s", s->session_id, buf);
2004
2005     va_end(ap);
2006 }
2007
2008 /*
2009  * Local variables:
2010  * c-basic-offset: 4
2011  * c-file-style: "Stroustrup"
2012  * indent-tabs-mode: nil
2013  * End:
2014  * vim: shiftwidth=4 tabstop=8 expandtab
2015  */
2016