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