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