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