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