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