src/session.c

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