src/logic.c

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