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