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