src/logic.c

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