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     "",
  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 static void log_xml_doc(xmlDoc *doc)
  99 {
 100     FILE *lf = yaz_log_file();
 101     xmlChar *result = 0;
 102     int len = 0;
 103 #if LIBXML_VERSION >= 20600
 104     xmlDocDumpFormatMemory(doc, &result, &len, 1);
 105 #else
 106     xmlDocDumpMemory(doc, &result, &len);
 107 #endif
 108     if (lf && len)
 109     {
 110         fwrite(result, 1, len, lf);
 111         fprintf(lf, "\n");
 112     }
 113     xmlFree(result);
 114 }
 115
 116 // Recursively traverse query structure to extract terms.
 117 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
 118 {
 119     char **words;
 120     int numwords;
 121     int i;
 122
 123     switch (n->kind)
 124     {
 125     case CCL_RPN_AND:
 126     case CCL_RPN_OR:
 127     case CCL_RPN_NOT:
 128     case CCL_RPN_PROX:
 129         pull_terms(nmem, n->u.p[0], termlist, num);
 130         pull_terms(nmem, n->u.p[1], termlist, num);
 131         break;
 132     case CCL_RPN_TERM:
 133         nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
 134         for (i = 0; i < numwords; i++)
 135             termlist[(*num)++] = words[i];
 136         break;
 137     default: // NOOP
 138         break;
 139     }
 140 }
 141
 142
 143
 144 static void add_facet(struct session *s, const char *type, const char *value)
 145 {
 146     int i;
 147
 148     if (!*value)
 149         return;
 150     for (i = 0; i < s->num_termlists; i++)
 151         if (!strcmp(s->termlists[i].name, type))
 152             break;
 153     if (i == s->num_termlists)
 154     {
 155         if (i == SESSION_MAX_TERMLISTS)
 156         {
 157             yaz_log(YLOG_FATAL, "Too many termlists");
 158             return;
 159         }
 160
 161         s->termlists[i].name = nmem_strdup(s->nmem, type);
 162         s->termlists[i].termlist
 163             = termlist_create(s->nmem, s->expected_maxrecs,
 164                               TERMLIST_HIGH_SCORE);
 165         s->num_termlists = i + 1;
 166     }
 167     termlist_insert(s->termlists[i].termlist, value);
 168 }
 169
 170 xmlDoc *record_to_xml(struct session_database *sdb, const char *rec)
 171 {
 172     struct database *db = sdb->database;
 173     xmlDoc *rdoc = 0;
 174
 175     rdoc = xmlParseMemory(rec, strlen(rec));
 176
 177     if (!rdoc)
 178     {
 179         yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s",
 180                 db->url);
 181         return 0;
 182     }
 183
 184     if (global_parameters.dump_records)
 185     {
 186         yaz_log(YLOG_LOG, "Un-normalized record from %s", db->url);
 187         log_xml_doc(rdoc);
 188     }
 189
 190     return rdoc;
 191 }
 192
 193 #define MAX_XSLT_ARGS 16
 194
 195 // Add static values from session database settings if applicable
 196 static void insert_settings_parameters(struct session_database *sdb,
 197                                        struct session *se, char **parms)
 198 {
 199     struct conf_service *service = global_parameters.server->service;
 200     int i;
 201     int nparms = 0;
 202     int offset = 0;
 203
 204     for (i = 0; i < service->num_metadata; i++)
 205     {
 206         struct conf_metadata *md = &service->metadata[i];
 207         int setting;
 208
 209         if (md->setting == Metadata_setting_parameter &&
 210             (setting = settings_offset(md->name)) > 0)
 211         {
 212             const char *val = session_setting_oneval(sdb, setting);
 213             if (val && nparms < MAX_XSLT_ARGS)
 214             {
 215                 char *buf;
 216                 int len = strlen(val);
 217                 buf = nmem_malloc(se->nmem, len + 3);
 218                 buf[0] = '\'';
 219                 strcpy(buf + 1, val);
 220                 buf[len+1] = '\'';
 221                 buf[len+2] = '\0';
 222                 parms[offset++] = md->name;
 223                 parms[offset++] = buf;
 224                 nparms++;
 225             }
 226         }
 227     }
 228     parms[offset] = 0;
 229 }
 230
 231 // Add static values from session database settings if applicable
 232 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc)
 233 {
 234     struct conf_service *service = global_parameters.server->service;
 235     int i;
 236
 237     for (i = 0; i < service->num_metadata; i++)
 238     {
 239         struct conf_metadata *md = &service->metadata[i];
 240         int offset;
 241
 242         if (md->setting == Metadata_setting_postproc &&
 243             (offset = settings_offset(md->name)) > 0)
 244         {
 245             const char *val = session_setting_oneval(sdb, offset);
 246             if (val)
 247             {
 248                 xmlNode *r = xmlDocGetRootElement(doc);
 249                 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
 250                                              (xmlChar *) val);
 251                 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
 252             }
 253         }
 254     }
 255 }
 256
 257 xmlDoc *normalize_record(struct session_database *sdb, struct session *se,
 258                          const char *rec)
 259 {
 260     struct database_retrievalmap *m;
 261     xmlDoc *rdoc = record_to_xml(sdb, rec);
 262     if (rdoc)
 263     {
 264         for (m = sdb->map; m; m = m->next)
 265         {
 266             xmlDoc *new = 0;
 267
 268             {
 269                 xmlNodePtr root = 0;
 270                 char *parms[MAX_XSLT_ARGS*2+1];
 271
 272                 insert_settings_parameters(sdb, se, parms);
 273
 274                 new = xsltApplyStylesheet(m->stylesheet, rdoc, (const char **) parms);
 275                 root= xmlDocGetRootElement(new);
 276                 if (!new || !root || !(root->children))
 277                 {
 278                     yaz_log(YLOG_WARN, "XSLT transformation failed from %s",
 279                             sdb->database->url);
 280                     xmlFreeDoc(new);
 281                     xmlFreeDoc(rdoc);
 282                     return 0;
 283                 }
 284             }
 285
 286             xmlFreeDoc(rdoc);
 287             rdoc = new;
 288         }
 289
 290         insert_settings_values(sdb, rdoc);
 291
 292         if (global_parameters.dump_records)
 293         {
 294             yaz_log(YLOG_LOG, "Normalized record from %s",
 295                     sdb->database->url);
 296             log_xml_doc(rdoc);
 297         }
 298     }
 299     return rdoc;
 300 }
 301
 302 // Retrieve first defined value for 'name' for given database.
 303 // Will be extended to take into account user associated with session
 304 const char *session_setting_oneval(struct session_database *db, int offset)
 305 {
 306     if (!db->settings[offset])
 307         return "";
 308     return db->settings[offset]->value;
 309 }
 310
 311 // Prepare XSLT stylesheets for record normalization
 312 // Structures are allocated on the session_wide nmem to avoid having
 313 // to recompute this for every search. This would lead
 314 // to leaking if a single session was to repeatedly change the PZ_XSLT
 315 // setting. However, this is not a realistic use scenario.
 316 static int prepare_map(struct session *se, struct session_database *sdb)
 317 {
 318     const char *s;
 319
 320     if (!sdb->settings)
 321     {
 322         yaz_log(YLOG_WARN, "No settings on %s", sdb->database->url);
 323         return -1;
 324     }
 325     if ((s = session_setting_oneval(sdb, PZ_XSLT)))
 326     {
 327         char **stylesheets;
 328         struct database_retrievalmap **m = &sdb->map;
 329         int num, i;
 330         char auto_stylesheet[256];
 331
 332         if (!strcmp(s, "auto"))
 333         {
 334             const char *request_syntax = session_setting_oneval(
 335                 sdb, PZ_REQUESTSYNTAX);
 336             if (request_syntax)
 337             {
 338                 char *cp;
 339                 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
 340                              "%s.xsl", request_syntax);
 341                 for (cp = auto_stylesheet; *cp; cp++)
 342                 {
 343                     /* deliberately only consider ASCII */
 344                     if (*cp > 32 && *cp < 127)
 345                         *cp = tolower(*cp);
 346                 }
 347                 s = auto_stylesheet;
 348             }
 349             else
 350             {
 351                 yaz_log(YLOG_WARN, "No pz:requestsyntax for auto stylesheet");
 352             }
 353         }
 354         nmem_strsplit(se->session_nmem, ",", s, &stylesheets, &num);
 355         for (i = 0; i < num; i++)
 356         {
 357             (*m) = nmem_malloc(se->session_nmem, sizeof(**m));
 358             (*m)->next = 0;
 359             if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i])))
 360             {
 361                 yaz_log(YLOG_FATAL|YLOG_ERRNO, "Unable to load stylesheet: %s",
 362                         stylesheets[i]);
 363                 return -1;
 364             }
 365             m = &(*m)->next;
 366         }
 367     }
 368     if (!sdb->map)
 369         yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s",
 370                 sdb->database->url);
 371     return 0;
 372 }
 373
 374 // This analyzes settings and recomputes any supporting data structures
 375 // if necessary.
 376 static int prepare_session_database(struct session *se,
 377                                     struct session_database *sdb)
 378 {
 379     if (!sdb->settings)
 380     {
 381         yaz_log(YLOG_WARN,
 382                 "No settings associated with %s", sdb->database->url);
 383         return -1;
 384     }
 385     if (sdb->settings[PZ_XSLT] && !sdb->map)
 386     {
 387         if (prepare_map(se, sdb) < 0)
 388             return -1;
 389     }
 390     return 0;
 391 }
 392
 393 // called if watch should be removed because http_channel is to be destroyed
 394 static void session_watch_cancel(void *data, struct http_channel *c,
 395                                  void *data2)
 396 {
 397     struct session_watchentry *ent = data;
 398
 399     ent->fun = 0;
 400     ent->data = 0;
 401     ent->obs = 0;
 402 }
 403
 404 // set watch. Returns 0=OK, -1 if watch is already set
 405 int session_set_watch(struct session *s, int what,
 406                       session_watchfun fun, void *data,
 407                       struct http_channel *chan)
 408 {
 409     if (s->watchlist[what].fun)
 410         return -1;
 411     s->watchlist[what].fun = fun;
 412     s->watchlist[what].data = data;
 413     s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
 414                                                session_watch_cancel);
 415     return 0;
 416 }
 417
 418 void session_alert_watch(struct session *s, int what)
 419 {
 420     if (s->watchlist[what].fun)
 421     {
 422         /* our watch is no longer associated with http_channel */
 423         void *data;
 424         session_watchfun fun;
 425
 426         http_remove_observer(s->watchlist[what].obs);
 427         fun = s->watchlist[what].fun;
 428         data = s->watchlist[what].data;
 429
 430         /* reset watch before fun is invoked - in case fun wants to set
 431            it again */
 432         s->watchlist[what].fun = 0;
 433         s->watchlist[what].data = 0;
 434         s->watchlist[what].obs = 0;
 435
 436         fun(data);
 437     }
 438 }
 439
 440 //callback for grep_databases
 441 static void select_targets_callback(void *context, struct session_database *db)
 442 {
 443     struct session *se = (struct session*) context;
 444     struct client *cl = client_create();
 445     client_set_database(cl, db);
 446     client_set_session(cl, se);
 447 }
 448
 449 // Associates a set of clients with a session;
 450 // Note: Session-databases represent databases with per-session
 451 // setting overrides
 452 int select_targets(struct session *se, struct database_criterion *crit)
 453 {
 454     while (se->clients)
 455         client_destroy(se->clients);
 456
 457     return session_grep_databases(se, crit, select_targets_callback);
 458 }
 459
 460 int session_active_clients(struct session *s)
 461 {
 462     struct client *c;
 463     int res = 0;
 464
 465     for (c = s->clients; c; c = client_next_in_session(c))
 466         if (client_is_active(c))
 467             res++;
 468
 469     return res;
 470 }
 471
 472 // parses crit1=val1,crit2=val2|val3,...
 473 static struct database_criterion *parse_filter(NMEM m, const char *buf)
 474 {
 475     struct database_criterion *res = 0;
 476     char **values;
 477     int num;
 478     int i;
 479
 480     if (!buf || !*buf)
 481         return 0;
 482     nmem_strsplit(m, ",", buf,  &values, &num);
 483     for (i = 0; i < num; i++)
 484     {
 485         char **subvalues;
 486         int subnum;
 487         int subi;
 488         struct database_criterion *new = nmem_malloc(m, sizeof(*new));
 489         char *eq = strchr(values[i], '=');
 490         if (!eq)
 491         {
 492             yaz_log(YLOG_WARN, "Missing equal-sign in filter");
 493             return 0;
 494         }
 495         *(eq++) = '\0';
 496         new->name = values[i];
 497         nmem_strsplit(m, "|", eq, &subvalues, &subnum);
 498         new->values = 0;
 499         for (subi = 0; subi < subnum; subi++)
 500         {
 501             struct database_criterion_value *newv
 502                 = nmem_malloc(m, sizeof(*newv));
 503             newv->value = subvalues[subi];
 504             newv->next = new->values;
 505             new->values = newv;
 506         }
 507         new->next = res;
 508         res = new;
 509     }
 510     return res;
 511 }
 512
 513 enum pazpar2_error_code search(struct session *se,
 514                                char *query, char *filter,
 515                                const char **addinfo)
 516 {
 517     int live_channels = 0;
 518     int no_working = 0;
 519     int no_failed = 0;
 520     struct client *cl;
 521     struct database_criterion *criteria;
 522
 523     yaz_log(YLOG_DEBUG, "Search");
 524
 525     *addinfo = 0;
 526     nmem_reset(se->nmem);
 527     se->relevance = 0;
 528     se->total_records = se->total_hits = se->total_merged = 0;
 529     se->reclist = 0;
 530     se->num_termlists = 0;
 531     criteria = parse_filter(se->nmem, filter);
 532     live_channels = select_targets(se, criteria);
 533     if (live_channels)
 534     {
 535         int maxrecs = live_channels * global_parameters.toget; // This is buggy!!!
 536         se->reclist = reclist_create(se->nmem, maxrecs);
 537         se->expected_maxrecs = maxrecs;
 538     }
 539     else
 540         return PAZPAR2_NO_TARGETS;
 541
 542     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 543     {
 544         if (prepare_session_database(se, client_get_database(cl)) < 0)
 545         {
 546             *addinfo = client_get_database(cl)->database->url;
 547             return PAZPAR2_CONFIG_TARGET;
 548         }
 549         // Parse query for target
 550         if (client_parse_query(cl, query) < 0)
 551             no_failed++;
 552         else
 553         {
 554             no_working++;
 555             if (client_prep_connection(cl))
 556                 client_start_search(cl);
 557         }
 558     }
 559
 560     // If no queries could be mapped, we signal an error
 561     if (no_working == 0)
 562     {
 563         *addinfo = "query";
 564         return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 565     }
 566     return PAZPAR2_NO_ERROR;
 567 }
 568
 569 // Creates a new session_database object for a database
 570 static void session_init_databases_fun(void *context, struct database *db)
 571 {
 572     struct session *se = (struct session *) context;
 573     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 574     int num = settings_num();
 575     int i;
 576
 577     new->database = db;
 578
 579     new->map = 0;
 580     new->settings
 581         = nmem_malloc(se->session_nmem, sizeof(struct settings *) * num);
 582     memset(new->settings, 0, sizeof(struct settings*) * num);
 583
 584     if (db->settings)
 585     {
 586         for (i = 0; i < num; i++)
 587             new->settings[i] = db->settings[i];
 588     }
 589     new->next = se->databases;
 590     se->databases = new;
 591 }
 592
 593 // Doesn't free memory associated with sdb -- nmem takes care of that
 594 static void session_database_destroy(struct session_database *sdb)
 595 {
 596     struct database_retrievalmap *m;
 597
 598     for (m = sdb->map; m; m = m->next)
 599         xsltFreeStylesheet(m->stylesheet);
 600 }
 601
 602 // Initialize session_database list -- this represents this session's view
 603 // of the database list -- subject to modification by the settings ws command
 604 void session_init_databases(struct session *se)
 605 {
 606     se->databases = 0;
 607     predef_grep_databases(se, 0, session_init_databases_fun);
 608 }
 609
 610 // Probably session_init_databases_fun should be refactored instead of
 611 // called here.
 612 static struct session_database *load_session_database(struct session *se,
 613                                                       char *id)
 614 {
 615     struct database *db = find_database(id, 0);
 616
 617     session_init_databases_fun((void*) se, db);
 618     // New sdb is head of se->databases list
 619     return se->databases;
 620 }
 621
 622 // Find an existing session database. If not found, load it
 623 static struct session_database *find_session_database(struct session *se,
 624                                                       char *id)
 625 {
 626     struct session_database *sdb;
 627
 628     for (sdb = se->databases; sdb; sdb = sdb->next)
 629         if (!strcmp(sdb->database->url, id))
 630             return sdb;
 631     return load_session_database(se, id);
 632 }
 633
 634 // Apply a session override to a database
 635 void session_apply_setting(struct session *se, char *dbname, char *setting,
 636                            char *value)
 637 {
 638     struct session_database *sdb = find_session_database(se, dbname);
 639     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 640     int offset = settings_offset_cprefix(setting);
 641
 642     if (offset < 0)
 643     {
 644         yaz_log(YLOG_WARN, "Unknown setting %s", setting);
 645         return;
 646     }
 647     // Jakub: This breaks the filter setting.
 648     /*if (offset == PZ_ID)
 649       {
 650       yaz_log(YLOG_WARN, "No need to set pz:id setting. Ignoring");
 651       return;
 652       }*/
 653     new->precedence = 0;
 654     new->target = dbname;
 655     new->name = setting;
 656     new->value = value;
 657     new->next = sdb->settings[offset];
 658     sdb->settings[offset] = new;
 659
 660     // Force later recompute of settings-driven data structures
 661     // (happens when a search starts and client connections are prepared)
 662     switch (offset)
 663     {
 664     case PZ_XSLT:
 665         if (sdb->map)
 666         {
 667             struct database_retrievalmap *m;
 668             // We don't worry about the map structure -- it's in nmem
 669             for (m = sdb->map; m; m = m->next)
 670                 xsltFreeStylesheet(m->stylesheet);
 671             sdb->map = 0;
 672         }
 673         break;
 674     }
 675 }
 676
 677 void destroy_session(struct session *s)
 678 {
 679     struct session_database *sdb;
 680
 681     while (s->clients)
 682         client_destroy(s->clients);
 683     for (sdb = s->databases; sdb; sdb = sdb->next)
 684         session_database_destroy(sdb);
 685     nmem_destroy(s->nmem);
 686     wrbuf_destroy(s->wrbuf);
 687 }
 688
 689 struct session *new_session(NMEM nmem)
 690 {
 691     int i;
 692     struct session *session = nmem_malloc(nmem, sizeof(*session));
 693
 694     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
 695
 696     session->relevance = 0;
 697     session->total_hits = 0;
 698     session->total_records = 0;
 699     session->number_of_warnings_unknown_elements = 0;
 700     session->number_of_warnings_unknown_metadata = 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                                    struct record_cluster **prev_r,
 770                                    struct record_cluster **next_r)
 771 {
 772     struct record_cluster *r;
 773
 774     reclist_rewind(s->reclist);
 775     *prev_r = 0;
 776     *next_r = 0;
 777     while ((r = reclist_read_record(s->reclist)))
 778     {
 779         if (!strcmp(r->recid, id))
 780         {
 781             *next_r = reclist_read_record(s->reclist);
 782             return r;
 783         }
 784         *prev_r = r;
 785     }
 786     return 0;
 787 }
 788
 789 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp,
 790                              int start, int *num, int *total, int *sumhits,
 791                              NMEM nmem_show)
 792 {
 793     struct record_cluster **recs = nmem_malloc(nmem_show, *num
 794                                                * sizeof(struct record_cluster *));
 795     struct reclist_sortparms *spp;
 796     int i;
 797 #if USE_TIMING
 798     yaz_timing_t t = yaz_timing_create();
 799 #endif
 800
 801     if (!s->relevance)
 802     {
 803         *num = 0;
 804         *total = 0;
 805         *sumhits = 0;
 806         recs = 0;
 807     }
 808     else
 809     {
 810         for (spp = sp; spp; spp = spp->next)
 811             if (spp->type == Metadata_sortkey_relevance)
 812             {
 813                 relevance_prepare_read(s->relevance, s->reclist);
 814                 break;
 815             }
 816         reclist_sort(s->reclist, sp);
 817
 818         *total = s->reclist->num_records;
 819         *sumhits = s->total_hits;
 820
 821         for (i = 0; i < start; i++)
 822             if (!reclist_read_record(s->reclist))
 823             {
 824                 *num = 0;
 825                 recs = 0;
 826                 break;
 827             }
 828
 829         for (i = 0; i < *num; i++)
 830         {
 831             struct record_cluster *r = reclist_read_record(s->reclist);
 832             if (!r)
 833             {
 834                 *num = i;
 835                 break;
 836             }
 837             recs[i] = r;
 838         }
 839     }
 840 #if USE_TIMING
 841     yaz_timing_stop(t);
 842     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
 843             yaz_timing_get_real(t), yaz_timing_get_user(t),
 844             yaz_timing_get_sys(t));
 845     yaz_timing_destroy(&t);
 846 #endif
 847     return recs;
 848 }
 849
 850 void statistics(struct session *se, struct statistics *stat)
 851 {
 852     struct client *cl;
 853     int count = 0;
 854
 855     memset(stat, 0, sizeof(*stat));
 856     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 857     {
 858         if (!client_get_connection(cl))
 859             stat->num_no_connection++;
 860         switch (client_get_state(cl))
 861         {
 862         case Client_Connecting: stat->num_connecting++; break;
 863         case Client_Working: stat->num_working++; break;
 864         case Client_Idle: stat->num_idle++; break;
 865         case Client_Failed: stat->num_failed++; break;
 866         case Client_Error: stat->num_error++; break;
 867         default: break;
 868         }
 869         count++;
 870     }
 871     stat->num_hits = se->total_hits;
 872     stat->num_records = se->total_records;
 873
 874     stat->num_clients = count;
 875 }
 876
 877 int start_http_listener(void)
 878 {
 879     char hp[128] = "";
 880     struct conf_server *ser = global_parameters.server;
 881
 882     if (*global_parameters.listener_override)
 883         strcpy(hp, global_parameters.listener_override);
 884     else
 885     {
 886         strcpy(hp, ser->host ? ser->host : "");
 887         if (ser->port)
 888         {
 889             if (*hp)
 890                 strcat(hp, ":");
 891             sprintf(hp + strlen(hp), "%d", ser->port);
 892         }
 893     }
 894     return http_init(hp);
 895 }
 896
 897 void start_proxy(void)
 898 {
 899     char hp[128] = "";
 900     struct conf_server *ser = global_parameters.server;
 901
 902     if (*global_parameters.proxy_override)
 903         strcpy(hp, global_parameters.proxy_override);
 904     else if (ser->proxy_host || ser->proxy_port)
 905     {
 906         strcpy(hp, ser->proxy_host ? ser->proxy_host : "");
 907         if (ser->proxy_port)
 908         {
 909             if (*hp)
 910                 strcat(hp, ":");
 911             sprintf(hp + strlen(hp), "%d", ser->proxy_port);
 912         }
 913     }
 914     else
 915         return;
 916
 917     http_set_proxyaddr(hp, ser->myurl ? ser->myurl : "");
 918 }
 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 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                 global_parameters.server->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                                 global_parameters.server->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 = global_parameters.server->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                              global_parameters.server->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                             global_parameters.server->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