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     reclist_destroy(s->reclist);
 617     nmem_destroy(s->nmem);
 618     service_destroy(s->service);
 619     wrbuf_destroy(s->wrbuf);
 620 }
 621
 622 struct session *new_session(NMEM nmem, struct conf_service *service)
 623 {
 624     int i;
 625     struct session *session = nmem_malloc(nmem, sizeof(*session));
 626
 627     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
 628
 629     session->service = service;
 630     session->relevance = 0;
 631     session->total_hits = 0;
 632     session->total_records = 0;
 633     session->number_of_warnings_unknown_elements = 0;
 634     session->number_of_warnings_unknown_metadata = 0;
 635     session->num_termlists = 0;
 636     session->reclist = 0;
 637     session->clients = 0;
 638     session->session_nmem = nmem;
 639     session->nmem = nmem_create();
 640     session->wrbuf = wrbuf_alloc();
 641     session->databases = 0;
 642     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 643     {
 644         session->watchlist[i].data = 0;
 645         session->watchlist[i].fun = 0;
 646     }
 647     session->normalize_cache = normalize_cache_create();
 648
 649     return session;
 650 }
 651
 652 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
 653 {
 654     struct hitsbytarget *res = 0;
 655     struct client *cl;
 656     size_t sz = 0;
 657
 658     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 659         sz++;
 660
 661     res = nmem_malloc(nmem, sizeof(*res) * sz);
 662     *count = 0;
 663     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 664     {
 665         WRBUF w = wrbuf_alloc();
 666         const char *name = session_setting_oneval(client_get_database(cl),
 667                                                   PZ_NAME);
 668
 669         res[*count].id = client_get_database(cl)->database->url;
 670         res[*count].name = *name ? name : "Unknown";
 671         res[*count].hits = client_get_hits(cl);
 672         res[*count].records = client_get_num_records(cl);
 673         res[*count].diagnostic = client_get_diagnostic(cl);
 674         res[*count].state = client_get_state_str(cl);
 675         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 676         session_settings_dump(se, client_get_database(cl), w);
 677         res[*count].settings_xml = w;
 678         (*count)++;
 679     }
 680     return res;
 681 }
 682
 683 struct termlist_score **termlist(struct session *s, const char *name, int *num)
 684 {
 685     int i;
 686
 687     for (i = 0; i < s->num_termlists; i++)
 688         if (!strcmp((const char *) s->termlists[i].name, name))
 689             return termlist_highscore(s->termlists[i].termlist, num);
 690     return 0;
 691 }
 692
 693 #ifdef MISSING_HEADERS
 694 void report_nmem_stats(void)
 695 {
 696     size_t in_use, is_free;
 697
 698     nmem_get_memory_in_use(&in_use);
 699     nmem_get_memory_free(&is_free);
 700
 701     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
 702             (long) in_use, (long) is_free);
 703 }
 704 #endif
 705
 706 struct record_cluster *show_single(struct session *s, const char *id,
 707                                    struct record_cluster **prev_r,
 708                                    struct record_cluster **next_r)
 709 {
 710     struct record_cluster *r;
 711
 712     reclist_enter(s->reclist);
 713     *prev_r = 0;
 714     *next_r = 0;
 715     while ((r = reclist_read_record(s->reclist)))
 716     {
 717         if (!strcmp(r->recid, id))
 718         {
 719             *next_r = reclist_read_record(s->reclist);
 720             break;
 721         }
 722         *prev_r = r;
 723     }
 724     reclist_leave(s->reclist);
 725     return r;
 726 }
 727
 728 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp,
 729                              int start, int *num, int *total, Odr_int *sumhits,
 730                              NMEM nmem_show)
 731 {
 732     struct record_cluster **recs = nmem_malloc(nmem_show, *num
 733                                                * sizeof(struct record_cluster *));
 734     struct reclist_sortparms *spp;
 735     int i;
 736 #if USE_TIMING
 737     yaz_timing_t t = yaz_timing_create();
 738 #endif
 739
 740     if (!s->relevance)
 741     {
 742         *num = 0;
 743         *total = 0;
 744         *sumhits = 0;
 745         recs = 0;
 746     }
 747     else
 748     {
 749         for (spp = sp; spp; spp = spp->next)
 750             if (spp->type == Metadata_sortkey_relevance)
 751             {
 752                 relevance_prepare_read(s->relevance, s->reclist);
 753                 break;
 754             }
 755         reclist_sort(s->reclist, sp);
 756
 757         reclist_enter(s->reclist);
 758         *total = reclist_get_num_records(s->reclist);
 759         *sumhits = s->total_hits;
 760
 761         for (i = 0; i < start; i++)
 762             if (!reclist_read_record(s->reclist))
 763             {
 764                 *num = 0;
 765                 recs = 0;
 766                 break;
 767             }
 768
 769         for (i = 0; i < *num; i++)
 770         {
 771             struct record_cluster *r = reclist_read_record(s->reclist);
 772             if (!r)
 773             {
 774                 *num = i;
 775                 break;
 776             }
 777             recs[i] = r;
 778         }
 779         reclist_leave(s->reclist);
 780     }
 781 #if USE_TIMING
 782     yaz_timing_stop(t);
 783     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
 784             yaz_timing_get_real(t), yaz_timing_get_user(t),
 785             yaz_timing_get_sys(t));
 786     yaz_timing_destroy(&t);
 787 #endif
 788     return recs;
 789 }
 790
 791 void statistics(struct session *se, struct statistics *stat)
 792 {
 793     struct client *cl;
 794     int count = 0;
 795
 796     memset(stat, 0, sizeof(*stat));
 797     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 798     {
 799         if (!client_get_connection(cl))
 800             stat->num_no_connection++;
 801         switch (client_get_state(cl))
 802         {
 803         case Client_Connecting: stat->num_connecting++; break;
 804         case Client_Working: stat->num_working++; break;
 805         case Client_Idle: stat->num_idle++; break;
 806         case Client_Failed: stat->num_failed++; break;
 807         case Client_Error: stat->num_error++; break;
 808         default: break;
 809         }
 810         count++;
 811     }
 812     stat->num_hits = se->total_hits;
 813     stat->num_records = se->total_records;
 814
 815     stat->num_clients = count;
 816 }
 817
 818 static struct record_metadata *record_metadata_init(
 819     NMEM nmem, const char *value, enum conf_metadata_type type,
 820     struct _xmlAttr *attr)
 821 {
 822     struct record_metadata *rec_md = record_metadata_create(nmem);
 823     struct record_metadata_attr **attrp = &rec_md->attributes;
 824
 825     for (; attr; attr = attr->next)
 826     {
 827         if (attr->children && attr->children->content)
 828         {
 829             if (strcmp((const char *) attr->name, "type"))
 830             {  /* skip the "type" attribute.. Its value is already part of
 831                   the element in output (md-%s) and so repeating it here
 832                   is redundant */
 833                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
 834                 (*attrp)->name =
 835                     nmem_strdup(nmem, (const char *) attr->name);
 836                 (*attrp)->value =
 837                     nmem_strdup(nmem, (const char *) attr->children->content);
 838                 attrp = &(*attrp)->next;
 839             }
 840         }
 841     }
 842     *attrp = 0;
 843
 844     if (type == Metadata_type_generic)
 845     {
 846         char *p = nmem_strdup(nmem, value);
 847
 848         p = normalize7bit_generic(p, " ,/.:([");
 849
 850         rec_md->data.text.disp = p;
 851         rec_md->data.text.sort = 0;
 852     }
 853     else if (type == Metadata_type_year || type == Metadata_type_date)
 854     {
 855         int first, last;
 856         int longdate = 0;
 857
 858         if (type == Metadata_type_date)
 859             longdate = 1;
 860         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
 861             return 0;
 862
 863         rec_md->data.number.min = first;
 864         rec_md->data.number.max = last;
 865     }
 866     else
 867         return 0;
 868     return rec_md;
 869 }
 870
 871 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
 872                                  struct conf_service *service, WRBUF norm_wr)
 873 {
 874     xmlNode *n;
 875     int no_found = 0;
 876     for (n = root->children; n; n = n->next)
 877     {
 878         if (n->type != XML_ELEMENT_NODE)
 879             continue;
 880         if (!strcmp((const char *) n->name, "metadata"))
 881         {
 882             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
 883             if (!strcmp(name, (const char *) type))
 884             {
 885                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
 886                 if (value)
 887                 {
 888                     const char *norm_str;
 889                     pp2_relevance_token_t prt =
 890                         pp2_relevance_tokenize(
 891                             service->mergekey_pct,
 892                             (const char *) value, 0);
 893
 894                     if (wrbuf_len(norm_wr) > 0)
 895                         wrbuf_puts(norm_wr, " ");
 896                     wrbuf_puts(norm_wr, name);
 897                     while ((norm_str =
 898                             pp2_relevance_token_next(prt)))
 899                     {
 900                         if (*norm_str)
 901                         {
 902                             wrbuf_puts(norm_wr, " ");
 903                             wrbuf_puts(norm_wr, norm_str);
 904                         }
 905                     }
 906                     xmlFree(value);
 907                     pp2_relevance_token_destroy(prt);
 908                     no_found++;
 909                 }
 910             }
 911             xmlFree(type);
 912         }
 913     }
 914     return no_found;
 915 }
 916
 917 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
 918                                 struct conf_service *service, NMEM nmem)
 919 {
 920     char *mergekey_norm = 0;
 921     xmlNode *root = xmlDocGetRootElement(doc);
 922     WRBUF norm_wr = wrbuf_alloc();
 923
 924     /* consider mergekey from XSL first */
 925     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
 926     if (mergekey)
 927     {
 928         const char *norm_str;
 929         pp2_relevance_token_t prt =
 930             pp2_relevance_tokenize(
 931                 service->mergekey_pct,
 932                 (const char *) mergekey, 0);
 933
 934         while ((norm_str = pp2_relevance_token_next(prt)))
 935         {
 936             if (*norm_str)
 937             {
 938                 if (wrbuf_len(norm_wr))
 939                     wrbuf_puts(norm_wr, " ");
 940                 wrbuf_puts(norm_wr, norm_str);
 941             }
 942         }
 943         pp2_relevance_token_destroy(prt);
 944         xmlFree(mergekey);
 945     }
 946     else
 947     {
 948         /* no mergekey defined in XSL. Look for mergekey metadata instead */
 949         int field_id;
 950         for (field_id = 0; field_id < service->num_metadata; field_id++)
 951         {
 952             struct conf_metadata *ser_md = &service->metadata[field_id];
 953             if (ser_md->mergekey != Metadata_mergekey_no)
 954             {
 955                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
 956                                               service, norm_wr);
 957                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
 958                 {
 959                     /* no mergekey on this one and it is required..
 960                        Generate unique key instead */
 961                     wrbuf_rewind(norm_wr);
 962                     break;
 963                 }
 964             }
 965         }
 966     }
 967
 968     /* generate unique key if none is not generated already or is empty */
 969     if (wrbuf_len(norm_wr) == 0)
 970     {
 971         wrbuf_printf(norm_wr, "%s-%d",
 972                      client_get_database(cl)->database->url, record_no);
 973     }
 974     if (wrbuf_len(norm_wr) > 0)
 975         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
 976     wrbuf_destroy(norm_wr);
 977     return mergekey_norm;
 978 }
 979
 980 /** \brief see if metadata for pz:recordfilter exists
 981     \param root xml root element of normalized record
 982     \param sdb session database for client
 983     \retval 0 if there is no metadata for pz:recordfilter
 984     \retval 1 if there is metadata for pz:recordfilter
 985
 986     If there is no pz:recordfilter defined, this function returns 1
 987     as well.
 988 */
 989
 990 static int check_record_filter(xmlNode *root, struct session_database *sdb)
 991 {
 992     int match = 0;
 993     xmlNode *n;
 994     const char *s;
 995     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
 996
 997     if (!s || !*s)
 998         return 1;
 999
1000     for (n = root->children; n; n = n->next)
1001     {
1002         if (n->type != XML_ELEMENT_NODE)
1003             continue;
1004         if (!strcmp((const char *) n->name, "metadata"))
1005         {
1006             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1007             if (type)
1008             {
1009                 size_t len;
1010                 const char *eq = strchr(s, '~');
1011                 if (eq)
1012                     len = eq - s;
1013                 else
1014                     len = strlen(s);
1015                 if (len == strlen((const char *)type) &&
1016                     !memcmp((const char *) type, s, len))
1017                 {
1018                     xmlChar *value = xmlNodeGetContent(n);
1019                     if (value && *value)
1020                     {
1021                         if (!eq || strstr((const char *) value, eq+1))
1022                             match = 1;
1023                     }
1024                     xmlFree(value);
1025                 }
1026                 xmlFree(type);
1027             }
1028         }
1029     }
1030     return match;
1031 }
1032
1033
1034 /** \brief ingest XML record
1035     \param cl client holds the result set for record
1036     \param rec record buffer (0 terminated)
1037     \param record_no record position (1, 2, ..)
1038     \returns resulting record or NULL on failure
1039 */
1040 struct record *ingest_record(struct client *cl, const char *rec,
1041                              int record_no)
1042 {
1043     struct session_database *sdb = client_get_database(cl);
1044     struct session *se = client_get_session(cl);
1045     xmlDoc *xdoc = normalize_record(sdb, se, rec);
1046     xmlNode *root, *n;
1047     struct record *record;
1048     struct record_cluster *cluster;
1049     const char *mergekey_norm;
1050     xmlChar *type = 0;
1051     xmlChar *value = 0;
1052     struct conf_service *service = se->service;
1053
1054     if (!xdoc)
1055         return 0;
1056
1057     root = xmlDocGetRootElement(xdoc);
1058
1059     if (!check_record_filter(root, sdb))
1060     {
1061         yaz_log(YLOG_WARN, "Filtered out record no %d from %s", record_no,
1062             sdb->database->url);
1063         xmlFreeDoc(xdoc);
1064         return 0;
1065     }
1066
1067     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, se->nmem);
1068     if (!mergekey_norm)
1069     {
1070         yaz_log(YLOG_WARN, "Got no mergekey");
1071         xmlFreeDoc(xdoc);
1072         return 0;
1073     }
1074     record = record_create(se->nmem,
1075                            service->num_metadata, service->num_sortkeys, cl,
1076                            record_no);
1077
1078     cluster = reclist_insert(se->reclist,
1079                              service,
1080                              record, (char *) mergekey_norm,
1081                              &se->total_merged);
1082     if (!cluster)
1083     {
1084         /* no room for record */
1085         xmlFreeDoc(xdoc);
1086         return 0;
1087     }
1088     if (global_parameters.dump_records)
1089         yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1090                 sdb->database->url, record_no);
1091     relevance_newrec(se->relevance, cluster);
1092
1093     // now parsing XML record and adding data to cluster or record metadata
1094     for (n = root->children; n; n = n->next)
1095     {
1096         pp2_relevance_token_t prt;
1097         if (type)
1098             xmlFree(type);
1099         if (value)
1100             xmlFree(value);
1101         type = value = 0;
1102
1103         if (n->type != XML_ELEMENT_NODE)
1104             continue;
1105         if (!strcmp((const char *) n->name, "metadata"))
1106         {
1107             struct conf_metadata *ser_md = 0;
1108             struct conf_sortkey *ser_sk = 0;
1109             struct record_metadata **wheretoput = 0;
1110             struct record_metadata *rec_md = 0;
1111             int md_field_id = -1;
1112             int sk_field_id = -1;
1113
1114             type = xmlGetProp(n, (xmlChar *) "type");
1115             value = xmlNodeListGetString(xdoc, n->children, 1);
1116
1117             if (!type || !value || !*value)
1118                 continue;
1119
1120             md_field_id
1121                 = conf_service_metadata_field_id(service, (const char *) type);
1122             if (md_field_id < 0)
1123             {
1124                 if (se->number_of_warnings_unknown_metadata == 0)
1125                 {
1126                     yaz_log(YLOG_WARN,
1127                             "Ignoring unknown metadata element: %s", type);
1128                 }
1129                 se->number_of_warnings_unknown_metadata++;
1130                 continue;
1131             }
1132
1133             ser_md = &service->metadata[md_field_id];
1134
1135             if (ser_md->sortkey_offset >= 0){
1136                 sk_field_id = ser_md->sortkey_offset;
1137                 ser_sk = &service->sortkeys[sk_field_id];
1138             }
1139
1140             // non-merged metadata
1141             rec_md = record_metadata_init(se->nmem, (const char *) value,
1142                                           ser_md->type, n->properties);
1143             if (!rec_md)
1144             {
1145                 yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
1146                         value, type);
1147                 continue;
1148             }
1149             wheretoput = &record->metadata[md_field_id];
1150             while (*wheretoput)
1151                 wheretoput = &(*wheretoput)->next;
1152             *wheretoput = rec_md;
1153
1154             // merged metadata
1155             rec_md = record_metadata_init(se->nmem, (const char *) value,
1156                                           ser_md->type, 0);
1157             wheretoput = &cluster->metadata[md_field_id];
1158
1159             // and polulate with data:
1160             // assign cluster or record based on merge action
1161             if (ser_md->merge == Metadata_merge_unique)
1162             {
1163                 struct record_metadata *mnode;
1164                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1165                     if (!strcmp((const char *) mnode->data.text.disp,
1166                                 rec_md->data.text.disp))
1167                         break;
1168                 if (!mnode)
1169                 {
1170                     rec_md->next = *wheretoput;
1171                     *wheretoput = rec_md;
1172                 }
1173             }
1174             else if (ser_md->merge == Metadata_merge_longest)
1175             {
1176                 if (!*wheretoput
1177                     || strlen(rec_md->data.text.disp)
1178                     > strlen((*wheretoput)->data.text.disp))
1179                 {
1180                     *wheretoput = rec_md;
1181                     if (ser_sk)
1182                     {
1183                         const char *sort_str = 0;
1184                         int skip_article =
1185                             ser_sk->type == Metadata_sortkey_skiparticle;
1186
1187                         if (!cluster->sortkeys[sk_field_id])
1188                             cluster->sortkeys[sk_field_id] =
1189                                 nmem_malloc(se->nmem,
1190                                             sizeof(union data_types));
1191
1192                         prt = pp2_relevance_tokenize(
1193                             service->sort_pct,
1194                             rec_md->data.text.disp, skip_article);
1195
1196                         pp2_relevance_token_next(prt);
1197
1198                         sort_str = pp2_get_sort(prt);
1199
1200                         cluster->sortkeys[sk_field_id]->text.disp =
1201                             rec_md->data.text.disp;
1202                         if (!sort_str)
1203                         {
1204                             sort_str = rec_md->data.text.disp;
1205                             yaz_log(YLOG_WARN,
1206                                     "Could not make sortkey. Bug #1858");
1207                         }
1208                         cluster->sortkeys[sk_field_id]->text.sort =
1209                             nmem_strdup(se->nmem, sort_str);
1210 #if 0
1211                         yaz_log(YLOG_LOG, "text disp=%s",
1212                                 cluster->sortkeys[sk_field_id]->text.disp);
1213                         yaz_log(YLOG_LOG, "text sort=%s",
1214                                 cluster->sortkeys[sk_field_id]->text.sort);
1215 #endif
1216                         pp2_relevance_token_destroy(prt);
1217                     }
1218                 }
1219             }
1220             else if (ser_md->merge == Metadata_merge_all)
1221             {
1222                 rec_md->next = *wheretoput;
1223                 *wheretoput = rec_md;
1224             }
1225             else if (ser_md->merge == Metadata_merge_range)
1226             {
1227                 if (!*wheretoput)
1228                 {
1229                     *wheretoput = rec_md;
1230                     if (ser_sk)
1231                         cluster->sortkeys[sk_field_id]
1232                             = &rec_md->data;
1233                 }
1234                 else
1235                 {
1236                     int this_min = rec_md->data.number.min;
1237                     int this_max = rec_md->data.number.max;
1238                     if (this_min < (*wheretoput)->data.number.min)
1239                         (*wheretoput)->data.number.min = this_min;
1240                     if (this_max > (*wheretoput)->data.number.max)
1241                         (*wheretoput)->data.number.max = this_max;
1242                 }
1243             }
1244
1245
1246             // ranking of _all_ fields enabled ...
1247             if (ser_md->rank)
1248                 relevance_countwords(se->relevance, cluster,
1249                                      (char *) value, ser_md->rank,
1250                                      ser_md->name);
1251
1252             // construct facets ...
1253             if (ser_md->termlist)
1254             {
1255                 if (ser_md->type == Metadata_type_year)
1256                 {
1257                     char year[64];
1258                     sprintf(year, "%d", rec_md->data.number.max);
1259                     add_facet(se, (char *) type, year);
1260                     if (rec_md->data.number.max != rec_md->data.number.min)
1261                     {
1262                         sprintf(year, "%d", rec_md->data.number.min);
1263                         add_facet(se, (char *) type, year);
1264                     }
1265                 }
1266                 else
1267                     add_facet(se, (char *) type, (char *) value);
1268             }
1269
1270             // cleaning up
1271             xmlFree(type);
1272             xmlFree(value);
1273             type = value = 0;
1274         }
1275         else
1276         {
1277             if (se->number_of_warnings_unknown_elements == 0)
1278                 yaz_log(YLOG_WARN,
1279                         "Unexpected element in internal record: %s", n->name);
1280             se->number_of_warnings_unknown_elements++;
1281         }
1282     }
1283     if (type)
1284         xmlFree(type);
1285     if (value)
1286         xmlFree(value);
1287
1288     xmlFreeDoc(xdoc);
1289
1290     relevance_donerecord(se->relevance, cluster);
1291     se->total_records++;
1292
1293     return record;
1294 }
1295
1296
1297
1298 /*
1299  * Local variables:
1300  * c-basic-offset: 4
1301  * c-file-style: "Stroustrup"
1302  * indent-tabs-mode: nil
1303  * End:
1304  * vim: shiftwidth=4 tabstop=8 expandtab
1305  */
1306