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