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     se->requestid++;
 534     live_channels = select_targets(se, criteria);
 535     if (live_channels)
 536     {
 537         int maxrecs = live_channels * global_parameters.toget;
 538         se->reclist = reclist_create(se->nmem, maxrecs);
 539         se->expected_maxrecs = maxrecs;
 540     }
 541     else
 542         return PAZPAR2_NO_TARGETS;
 543
 544     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 545     {
 546         if (prepare_session_database(se, client_get_database(cl)) < 0)
 547         {
 548             *addinfo = client_get_database(cl)->database->url;
 549             return PAZPAR2_CONFIG_TARGET;
 550         }
 551         // Parse query for target
 552         if (client_parse_query(cl, query) < 0)
 553             no_failed++;
 554         else
 555         {
 556             no_working++;
 557             if (client_prep_connection(cl))
 558                 client_start_search(cl);
 559         }
 560     }
 561
 562     // If no queries could be mapped, we signal an error
 563     if (no_working == 0)
 564     {
 565         *addinfo = "query";
 566         return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 567     }
 568     return PAZPAR2_NO_ERROR;
 569 }
 570
 571 // Creates a new session_database object for a database
 572 static void session_init_databases_fun(void *context, struct database *db)
 573 {
 574     struct session *se = (struct session *) context;
 575     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 576     int num = settings_num();
 577     int i;
 578
 579     new->database = db;
 580
 581     new->map = 0;
 582     new->settings
 583         = nmem_malloc(se->session_nmem, sizeof(struct settings *) * num);
 584     memset(new->settings, 0, sizeof(struct settings*) * num);
 585
 586     if (db->settings)
 587     {
 588         for (i = 0; i < num; i++)
 589             new->settings[i] = db->settings[i];
 590     }
 591     new->next = se->databases;
 592     se->databases = new;
 593 }
 594
 595 // Doesn't free memory associated with sdb -- nmem takes care of that
 596 static void session_database_destroy(struct session_database *sdb)
 597 {
 598     struct database_retrievalmap *m;
 599
 600     for (m = sdb->map; m; m = m->next)
 601         xsltFreeStylesheet(m->stylesheet);
 602 }
 603
 604 // Initialize session_database list -- this represents this session's view
 605 // of the database list -- subject to modification by the settings ws command
 606 void session_init_databases(struct session *se)
 607 {
 608     se->databases = 0;
 609     predef_grep_databases(se, 0, session_init_databases_fun);
 610 }
 611
 612 // Probably session_init_databases_fun should be refactored instead of
 613 // called here.
 614 static struct session_database *load_session_database(struct session *se,
 615                                                       char *id)
 616 {
 617     struct database *db = find_database(id, 0);
 618
 619     session_init_databases_fun((void*) se, db);
 620     // New sdb is head of se->databases list
 621     return se->databases;
 622 }
 623
 624 // Find an existing session database. If not found, load it
 625 static struct session_database *find_session_database(struct session *se,
 626                                                       char *id)
 627 {
 628     struct session_database *sdb;
 629
 630     for (sdb = se->databases; sdb; sdb = sdb->next)
 631         if (!strcmp(sdb->database->url, id))
 632             return sdb;
 633     return load_session_database(se, id);
 634 }
 635
 636 // Apply a session override to a database
 637 void session_apply_setting(struct session *se, char *dbname, char *setting,
 638                            char *value)
 639 {
 640     struct session_database *sdb = find_session_database(se, dbname);
 641     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 642     int offset = settings_offset_cprefix(setting);
 643
 644     if (offset < 0)
 645     {
 646         yaz_log(YLOG_WARN, "Unknown setting %s", setting);
 647         return;
 648     }
 649     // Jakub: This breaks the filter setting.
 650     /*if (offset == PZ_ID)
 651       {
 652       yaz_log(YLOG_WARN, "No need to set pz:id setting. Ignoring");
 653       return;
 654       }*/
 655     new->precedence = 0;
 656     new->target = dbname;
 657     new->name = setting;
 658     new->value = value;
 659     new->next = sdb->settings[offset];
 660     sdb->settings[offset] = new;
 661
 662     // Force later recompute of settings-driven data structures
 663     // (happens when a search starts and client connections are prepared)
 664     switch (offset)
 665     {
 666     case PZ_XSLT:
 667         if (sdb->map)
 668         {
 669             struct database_retrievalmap *m;
 670             // We don't worry about the map structure -- it's in nmem
 671             for (m = sdb->map; m; m = m->next)
 672                 xsltFreeStylesheet(m->stylesheet);
 673             sdb->map = 0;
 674         }
 675         break;
 676     }
 677 }
 678
 679 void destroy_session(struct session *s)
 680 {
 681     struct session_database *sdb;
 682
 683     while (s->clients)
 684         client_destroy(s->clients);
 685     for (sdb = s->databases; sdb; sdb = sdb->next)
 686         session_database_destroy(sdb);
 687     nmem_destroy(s->nmem);
 688     wrbuf_destroy(s->wrbuf);
 689 }
 690
 691 struct session *new_session(NMEM nmem)
 692 {
 693     int i;
 694     struct session *session = nmem_malloc(nmem, sizeof(*session));
 695
 696     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
 697
 698     session->relevance = 0;
 699     session->total_hits = 0;
 700     session->total_records = 0;
 701     session->number_of_warnings_unknown_elements = 0;
 702     session->num_termlists = 0;
 703     session->reclist = 0;
 704     session->requestid = -1;
 705     session->clients = 0;
 706     session->expected_maxrecs = 0;
 707     session->session_nmem = nmem;
 708     session->nmem = nmem_create();
 709     session->wrbuf = wrbuf_alloc();
 710     session->databases = 0;
 711     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 712     {
 713         session->watchlist[i].data = 0;
 714         session->watchlist[i].fun = 0;
 715     }
 716     return session;
 717 }
 718
 719 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
 720 {
 721     struct hitsbytarget *res = 0;
 722     struct client *cl;
 723     size_t sz = 0;
 724
 725     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 726         sz++;
 727
 728     res = nmem_malloc(nmem, sizeof(*res) * sz);
 729     *count = 0;
 730     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 731     {
 732         const char *name = session_setting_oneval(client_get_database(cl),
 733                                                   PZ_NAME);
 734
 735         res[*count].id = client_get_database(cl)->database->url;
 736         res[*count].name = *name ? name : "Unknown";
 737         res[*count].hits = client_get_hits(cl);
 738         res[*count].records = client_get_num_records(cl);
 739         res[*count].diagnostic = client_get_diagnostic(cl);
 740         res[*count].state = client_get_state_str(cl);
 741         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 742         (*count)++;
 743     }
 744     return res;
 745 }
 746
 747 struct termlist_score **termlist(struct session *s, const char *name, int *num)
 748 {
 749     int i;
 750
 751     for (i = 0; i < s->num_termlists; i++)
 752         if (!strcmp((const char *) s->termlists[i].name, name))
 753             return termlist_highscore(s->termlists[i].termlist, num);
 754     return 0;
 755 }
 756
 757 #ifdef MISSING_HEADERS
 758 void report_nmem_stats(void)
 759 {
 760     size_t in_use, is_free;
 761
 762     nmem_get_memory_in_use(&in_use);
 763     nmem_get_memory_free(&is_free);
 764
 765     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
 766             (long) in_use, (long) is_free);
 767 }
 768 #endif
 769
 770 struct record_cluster *show_single(struct session *s, const char *id)
 771 {
 772     struct record_cluster *r;
 773
 774     reclist_rewind(s->reclist);
 775     while ((r = reclist_read_record(s->reclist)))
 776         if (!strcmp(r->recid, id))
 777             return r;
 778     return 0;
 779 }
 780
 781 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp,
 782                              int start, int *num, int *total, int *sumhits,
 783                              NMEM nmem_show)
 784 {
 785     struct record_cluster **recs = nmem_malloc(nmem_show, *num
 786                                                * sizeof(struct record_cluster *));
 787     struct reclist_sortparms *spp;
 788     int i;
 789 #if USE_TIMING
 790     yaz_timing_t t = yaz_timing_create();
 791 #endif
 792
 793     if (!s->relevance)
 794     {
 795         *num = 0;
 796         *total = 0;
 797         *sumhits = 0;
 798         recs = 0;
 799     }
 800     else
 801     {
 802         for (spp = sp; spp; spp = spp->next)
 803             if (spp->type == Metadata_sortkey_relevance)
 804             {
 805                 relevance_prepare_read(s->relevance, s->reclist);
 806                 break;
 807             }
 808         reclist_sort(s->reclist, sp);
 809
 810         *total = s->reclist->num_records;
 811         *sumhits = s->total_hits;
 812
 813         for (i = 0; i < start; i++)
 814             if (!reclist_read_record(s->reclist))
 815             {
 816                 *num = 0;
 817                 recs = 0;
 818                 break;
 819             }
 820
 821         for (i = 0; i < *num; i++)
 822         {
 823             struct record_cluster *r = reclist_read_record(s->reclist);
 824             if (!r)
 825             {
 826                 *num = i;
 827                 break;
 828             }
 829             recs[i] = r;
 830         }
 831     }
 832 #if USE_TIMING
 833     yaz_timing_stop(t);
 834     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
 835             yaz_timing_get_real(t), yaz_timing_get_user(t),
 836             yaz_timing_get_sys(t));
 837     yaz_timing_destroy(&t);
 838 #endif
 839     return recs;
 840 }
 841
 842 void statistics(struct session *se, struct statistics *stat)
 843 {
 844     struct client *cl;
 845     int count = 0;
 846
 847     memset(stat, 0, sizeof(*stat));
 848     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 849     {
 850         if (!client_get_connection(cl))
 851             stat->num_no_connection++;
 852         switch (client_get_state(cl))
 853         {
 854         case Client_Connecting: stat->num_connecting++; break;
 855         case Client_Working: stat->num_working++; break;
 856         case Client_Idle: stat->num_idle++; break;
 857         case Client_Failed: stat->num_failed++; break;
 858         case Client_Error: stat->num_error++; break;
 859         default: break;
 860         }
 861         count++;
 862     }
 863     stat->num_hits = se->total_hits;
 864     stat->num_records = se->total_records;
 865
 866     stat->num_clients = count;
 867 }
 868
 869 int start_http_listener(void)
 870 {
 871     char hp[128] = "";
 872     struct conf_server *ser = global_parameters.server;
 873
 874     if (*global_parameters.listener_override)
 875         strcpy(hp, global_parameters.listener_override);
 876     else
 877     {
 878         strcpy(hp, ser->host ? ser->host : "");
 879         if (ser->port)
 880         {
 881             if (*hp)
 882                 strcat(hp, ":");
 883             sprintf(hp + strlen(hp), "%d", ser->port);
 884         }
 885     }
 886     return http_init(hp);
 887 }
 888
 889 void start_proxy(void)
 890 {
 891     char hp[128] = "";
 892     struct conf_server *ser = global_parameters.server;
 893
 894     if (*global_parameters.proxy_override)
 895         strcpy(hp, global_parameters.proxy_override);
 896     else if (ser->proxy_host || ser->proxy_port)
 897     {
 898         strcpy(hp, ser->proxy_host ? ser->proxy_host : "");
 899         if (ser->proxy_port)
 900         {
 901             if (*hp)
 902                 strcat(hp, ":");
 903             sprintf(hp + strlen(hp), "%d", ser->proxy_port);
 904         }
 905     }
 906     else
 907         return;
 908
 909     http_set_proxyaddr(hp, ser->myurl ? ser->myurl : "");
 910 }
 911
 912
 913 // Master list of connections we're handling events to
 914 static IOCHAN channel_list = 0;
 915 void pazpar2_add_channel(IOCHAN chan)
 916 {
 917     chan->next = channel_list;
 918     channel_list = chan;
 919 }
 920
 921 void pazpar2_event_loop()
 922 {
 923     event_loop(&channel_list);
 924 }
 925
 926 static struct record_metadata *record_metadata_init(
 927     NMEM nmem, char *value, enum conf_metadata_type type)
 928 {
 929     struct record_metadata *rec_md = record_metadata_create(nmem);
 930     if (type == Metadata_type_generic)
 931     {
 932         char * p = value;
 933         p = normalize7bit_generic(p, " ,/.:([");
 934
 935         rec_md->data.text.disp = nmem_strdup(nmem, p);
 936         rec_md->data.text.sort = 0;
 937     }
 938     else if (type == Metadata_type_year || type == Metadata_type_date)
 939     {
 940         int first, last;
 941         int longdate = 0;
 942
 943         if (type == Metadata_type_date)
 944             longdate = 1;
 945         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
 946             return 0;
 947
 948         rec_md->data.number.min = first;
 949         rec_md->data.number.max = last;
 950     }
 951     else
 952         return 0;
 953     return rec_md;
 954 }
 955
 956 struct record *ingest_record(struct client *cl, const char *rec,
 957                              int record_no)
 958 {
 959     xmlDoc *xdoc = normalize_record(client_get_database(cl),
 960                                     client_get_session(cl), rec);
 961     xmlNode *root, *n;
 962     struct record *record;
 963     struct record_cluster *cluster;
 964     struct session *se = client_get_session(cl);
 965     xmlChar *mergekey, *mergekey_norm;
 966     xmlChar *type = 0;
 967     xmlChar *value = 0;
 968     struct conf_service *service = global_parameters.server->service;
 969     const char *norm_str = 0;
 970     pp2_relevance_token_t prt = 0;
 971     WRBUF norm_wr = 0;
 972
 973     if (!xdoc)
 974         return 0;
 975
 976     root = xmlDocGetRootElement(xdoc);
 977     if (!(mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
 978     {
 979         yaz_log(YLOG_WARN, "No mergekey found in record");
 980         xmlFreeDoc(xdoc);
 981         return 0;
 982     }
 983
 984     record = record_create(se->nmem,
 985                            service->num_metadata, service->num_sortkeys, cl,
 986                            record_no);
 987
 988     prt = pp2_relevance_tokenize(
 989         global_parameters.server->mergekey_pct, (const char *) mergekey);
 990
 991
 992     norm_wr = wrbuf_alloc();
 993
 994     while ((norm_str = pp2_relevance_token_next(prt)))
 995     {
 996         if (*norm_str)
 997         {
 998             if (wrbuf_len(norm_wr))
 999                 wrbuf_puts(norm_wr, " ");
1000             wrbuf_puts(norm_wr, norm_str);
1001         }
1002     }
1003
1004     mergekey_norm = (xmlChar *)nmem_strdup(se->nmem, wrbuf_cstr(norm_wr));
1005     wrbuf_destroy(norm_wr);
1006
1007     pp2_relevance_token_destroy(prt);
1008
1009     xmlFree(mergekey);
1010
1011     cluster = reclist_insert(se->reclist,
1012                              global_parameters.server->service,
1013                              record, (char *) mergekey_norm,
1014                              &se->total_merged);
1015     if (global_parameters.dump_records)
1016         yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1017                 client_get_database(cl)->database->url, record_no);
1018     if (!cluster)
1019     {
1020         /* no room for record */
1021         xmlFreeDoc(xdoc);
1022         return 0;
1023     }
1024     relevance_newrec(se->relevance, cluster);
1025
1026
1027      // now parsing XML record and adding data to cluster or record metadata
1028      for (n = root->children; n; n = n->next)
1029      {
1030          if (type)
1031              xmlFree(type);
1032          if (value)
1033              xmlFree(value);
1034          type = value = 0;
1035
1036          if (n->type != XML_ELEMENT_NODE)
1037              continue;
1038          if (!strcmp((const char *) n->name, "metadata"))
1039          {
1040              struct conf_metadata *ser_md = 0;
1041              struct conf_sortkey *ser_sk = 0;
1042              struct record_metadata **wheretoput = 0;
1043              struct record_metadata *rec_md = 0;
1044              int md_field_id = -1;
1045              int sk_field_id = -1;
1046
1047              type = xmlGetProp(n, (xmlChar *) "type");
1048              value = xmlNodeListGetString(xdoc, n->children, 1);
1049
1050              if (!type || !value || !*value)
1051                  continue;
1052
1053              md_field_id
1054                  = conf_service_metadata_field_id(service, (const char *) type);
1055              if (md_field_id < 0)
1056              {
1057                  yaz_log(YLOG_WARN,
1058                          "Ignoring unknown metadata element: %s", type);
1059                  continue;
1060              }
1061
1062              ser_md = &service->metadata[md_field_id];
1063
1064              if (ser_md->sortkey_offset >= 0){
1065                  sk_field_id = ser_md->sortkey_offset;
1066                  ser_sk = &service->sortkeys[sk_field_id];
1067              }
1068
1069              // non-merged metadata
1070              rec_md = record_metadata_init(se->nmem, (char *) value,
1071                                            ser_md->type);
1072              if (!rec_md)
1073              {
1074                  yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
1075                          value, type);
1076                  continue;
1077              }
1078              wheretoput = &record->metadata[md_field_id];
1079              while (*wheretoput)
1080                  wheretoput = &(*wheretoput)->next;
1081              *wheretoput = rec_md;
1082
1083              // merged metadata
1084              rec_md = record_metadata_init(se->nmem, (char *) value,
1085                                            ser_md->type);
1086              wheretoput = &cluster->metadata[md_field_id];
1087
1088              // and polulate with data:
1089              // assign cluster or record based on merge action
1090              if (ser_md->merge == Metadata_merge_no)
1091              {
1092                  while (*wheretoput)
1093                      wheretoput = &(*wheretoput)->next;
1094                  *wheretoput = rec_md;
1095              }
1096              if (ser_md->merge == Metadata_merge_unique)
1097              {
1098                  struct record_metadata *mnode;
1099                  for (mnode = *wheretoput; mnode; mnode = mnode->next)
1100                      if (!strcmp((const char *) mnode->data.text.disp,
1101                                  rec_md->data.text.disp))
1102                          break;
1103                  if (!mnode)
1104                  {
1105                      rec_md->next = *wheretoput;
1106                      *wheretoput = rec_md;
1107                  }
1108              }
1109              else if (ser_md->merge == Metadata_merge_longest)
1110              {
1111                  if (!*wheretoput
1112                      || strlen(rec_md->data.text.disp)
1113                      > strlen((*wheretoput)->data.text.disp))
1114                  {
1115                      *wheretoput = rec_md;
1116                      if (ser_sk)
1117                      {
1118                          const char *sort_str = 0;
1119                          int skip_article =
1120                              ser_sk->type == Metadata_sortkey_skiparticle;
1121
1122                          if (!cluster->sortkeys[sk_field_id])
1123                              cluster->sortkeys[sk_field_id] =
1124                                  nmem_malloc(se->nmem,
1125                                              sizeof(union data_types));
1126
1127                          prt = pp2_relevance_tokenize(
1128                              global_parameters.server->sort_pct,
1129                              rec_md->data.text.disp);
1130
1131                          pp2_relevance_token_next(prt);
1132
1133                          sort_str = pp2_get_sort(prt, skip_article);
1134
1135                          cluster->sortkeys[sk_field_id]->text.disp =
1136                              rec_md->data.text.disp;
1137                          if (!sort_str)
1138                          {
1139                              sort_str = rec_md->data.text.disp;
1140                              yaz_log(YLOG_WARN,
1141                                      "Could not make sortkey. Bug #1858");
1142                          }
1143                          cluster->sortkeys[sk_field_id]->text.sort =
1144                              nmem_strdup(se->nmem, sort_str);
1145 #if 0
1146                          yaz_log(YLOG_LOG, "text disp=%s",
1147                                  cluster->sortkeys[sk_field_id]->text.disp);
1148                          yaz_log(YLOG_LOG, "text sort=%s",
1149                                  cluster->sortkeys[sk_field_id]->text.sort);
1150 #endif
1151                          pp2_relevance_token_destroy(prt);
1152                     }
1153                 }
1154             }
1155             else if (ser_md->merge == Metadata_merge_all)
1156             {
1157                 rec_md->next = *wheretoput;
1158                 *wheretoput = rec_md;
1159             }
1160             else if (ser_md->merge == Metadata_merge_range)
1161             {
1162                 if (!*wheretoput)
1163                 {
1164                     *wheretoput = rec_md;
1165                     if (ser_sk)
1166                         cluster->sortkeys[sk_field_id]
1167                             = &rec_md->data;
1168                 }
1169                 else
1170                 {
1171                     int this_min = rec_md->data.number.min;
1172                     int this_max = rec_md->data.number.max;
1173                     if (this_min < (*wheretoput)->data.number.min)
1174                         (*wheretoput)->data.number.min = this_min;
1175                     if (this_max > (*wheretoput)->data.number.max)
1176                         (*wheretoput)->data.number.max = this_max;
1177                 }
1178             }
1179
1180
1181             // ranking of _all_ fields enabled ...
1182             if (ser_md->rank)
1183                 relevance_countwords(se->relevance, cluster,
1184                                      (char *) value, ser_md->rank);
1185
1186             // construct facets ...
1187             if (ser_md->termlist)
1188             {
1189                 if (ser_md->type == Metadata_type_year)
1190                 {
1191                     char year[64];
1192                     sprintf(year, "%d", rec_md->data.number.max);
1193                     add_facet(se, (char *) type, year);
1194                     if (rec_md->data.number.max != rec_md->data.number.min)
1195                     {
1196                         sprintf(year, "%d", rec_md->data.number.min);
1197                         add_facet(se, (char *) type, year);
1198                     }
1199                 }
1200                 else
1201                     add_facet(se, (char *) type, (char *) value);
1202             }
1203
1204             // cleaning up
1205             xmlFree(type);
1206             xmlFree(value);
1207             type = value = 0;
1208         }
1209          else
1210          {
1211              if (se->number_of_warnings_unknown_elements == 0)
1212                  yaz_log(YLOG_WARN,
1213                          "Unexpected element in internal record: %s", n->name);
1214              se->number_of_warnings_unknown_elements++;
1215          }
1216     }
1217     if (type)
1218         xmlFree(type);
1219     if (value)
1220         xmlFree(value);
1221
1222     xmlFreeDoc(xdoc);
1223
1224     relevance_donerecord(se->relevance, cluster);
1225     se->total_records++;
1226
1227     return record;
1228 }
1229
1230
1231
1232 /*
1233  * Local variables:
1234  * c-basic-offset: 4
1235  * indent-tabs-mode: nil
1236  * End:
1237  * vim: shiftwidth=4 tabstop=8 expandtab
1238  */