src/logic.c

   1 /* $Id: logic.c,v 1.47 2007-06-28 09:36:10 adam Exp $
   2    Copyright (c) 2006-2007, Index Data.
   3
   4 This file is part of Pazpar2.
   5
   6 Pazpar2 is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Pazpar2; see the file LICENSE.  If not, write to the
  18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.
  20  */
  21
  22 /** \file logic.c
  23     \brief high-level logic; mostly user sessions and settings
  24 */
  25
  26 #include <stdlib.h>
  27 #include <stdio.h>
  28 #include <string.h>
  29 #include <sys/time.h>
  30 #include <unistd.h>
  31 #include <sys/socket.h>
  32 #include <netdb.h>
  33 #include <signal.h>
  34 #include <ctype.h>
  35 #include <assert.h>
  36
  37 #include <yaz/marcdisp.h>
  38 #include <yaz/comstack.h>
  39 #include <yaz/tcpip.h>
  40 #include <yaz/proto.h>
  41 #include <yaz/readconf.h>
  42 #include <yaz/pquery.h>
  43 #include <yaz/otherinfo.h>
  44 #include <yaz/yaz-util.h>
  45 #include <yaz/nmem.h>
  46 #include <yaz/query-charset.h>
  47 #include <yaz/querytowrbuf.h>
  48 #include <yaz/oid_db.h>
  49
  50 #if HAVE_CONFIG_H
  51 #include "cconfig.h"
  52 #endif
  53
  54 #define USE_TIMING 0
  55 #if USE_TIMING
  56 #include <yaz/timing.h>
  57 #endif
  58
  59 #include <netinet/in.h>
  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 "config.h"
  68 #include "database.h"
  69 #include "client.h"
  70 #include "settings.h"
  71 #include "normalize7bit.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,
  87     "81",
  88     "Index Data PazPar2",
  89     VERSION,
  90     600, // 10 minutes
  91     60,
  92     100,
  93     MAX_CHUNK,
  94     0,
  95     0
  96 };
  97
  98
  99 // Recursively traverse query structure to extract terms.
 100 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
 101 {
 102     char **words;
 103     int numwords;
 104     int i;
 105
 106     switch (n->kind)
 107     {
 108         case CCL_RPN_AND:
 109         case CCL_RPN_OR:
 110         case CCL_RPN_NOT:
 111         case CCL_RPN_PROX:
 112             pull_terms(nmem, n->u.p[0], termlist, num);
 113             pull_terms(nmem, n->u.p[1], termlist, num);
 114             break;
 115         case CCL_RPN_TERM:
 116             nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
 117             for (i = 0; i < numwords; i++)
 118                 termlist[(*num)++] = words[i];
 119             break;
 120         default: // NOOP
 121             break;
 122     }
 123 }
 124
 125
 126
 127 static void add_facet(struct session *s, const char *type, const char *value)
 128 {
 129     int i;
 130
 131     if (!*value)
 132         return;
 133     for (i = 0; i < s->num_termlists; i++)
 134         if (!strcmp(s->termlists[i].name, type))
 135             break;
 136     if (i == s->num_termlists)
 137     {
 138         if (i == SESSION_MAX_TERMLISTS)
 139         {
 140             yaz_log(YLOG_FATAL, "Too many termlists");
 141             return;
 142         }
 143
 144         s->termlists[i].name = nmem_strdup(s->nmem, type);
 145         s->termlists[i].termlist
 146             = termlist_create(s->nmem, s->expected_maxrecs,
 147                               TERMLIST_HIGH_SCORE);
 148         s->num_termlists = i + 1;
 149     }
 150     termlist_insert(s->termlists[i].termlist, value);
 151 }
 152
 153 xmlDoc *record_to_xml(struct session_database *sdb, Z_External *rec)
 154 {
 155     struct database *db = sdb->database;
 156     xmlDoc *rdoc = 0;
 157     const Odr_oid *oid = rec->direct_reference;
 158
 159     /* convert response record to XML somehow */
 160     if (rec->which == Z_External_octet && oid
 161         && !oid_oidcmp(oid, yaz_oid_recsyn_xml))
 162     {
 163         /* xml already */
 164         rdoc = xmlParseMemory((char*) rec->u.octet_aligned->buf,
 165                               rec->u.octet_aligned->len);
 166         if (!rdoc)
 167         {
 168             yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s",
 169                     db->url);
 170             return 0;
 171         }
 172     }
 173     else if (oid && yaz_oid_is_iso2709(oid))
 174     {
 175         /* ISO2709 gets converted to MARCXML */
 176         if (!sdb->yaz_marc)
 177         {
 178             yaz_log(YLOG_FATAL, "Unable to handle ISO2709 record");
 179             return 0;
 180         }
 181         else
 182         {
 183             xmlNode *res;
 184             char *buf;
 185             int len;
 186
 187             if (rec->which != Z_External_octet)
 188             {
 189                 yaz_log(YLOG_WARN, "Unexpected external branch, probably BER %s",
 190                         db->url);
 191                 return 0;
 192             }
 193             buf = (char*) rec->u.octet_aligned->buf;
 194             len = rec->u.octet_aligned->len;
 195             if (yaz_marc_read_iso2709(sdb->yaz_marc, buf, len) < 0)
 196             {
 197                 yaz_log(YLOG_WARN, "Failed to decode MARC %s", db->url);
 198                 return 0;
 199             }
 200
 201             yaz_marc_write_using_libxml2(sdb->yaz_marc, 1);
 202             if (yaz_marc_write_xml(sdb->yaz_marc, &res,
 203                                    "http://www.loc.gov/MARC21/slim", 0, 0) < 0)
 204             {
 205                 yaz_log(YLOG_WARN, "Failed to encode as XML %s",
 206                         db->url);
 207                 return 0;
 208             }
 209             rdoc = xmlNewDoc((xmlChar *) "1.0");
 210             xmlDocSetRootElement(rdoc, res);
 211         }
 212     }
 213     else
 214     {
 215         char oid_name_buf[OID_STR_MAX];
 216         const char *oid_name = yaz_oid_to_string_buf(oid, 0, oid_name_buf);
 217         yaz_log(YLOG_FATAL,
 218                 "Unable to handle record of type %s from %s",
 219                 oid_name, db->url);
 220         return 0;
 221     }
 222
 223     if (global_parameters.dump_records){
 224         fprintf(stderr,
 225                 "Input Record (normalized) from %s\n----------------\n",
 226                 db->url);
 227 #if LIBXML_VERSION >= 20600
 228         xmlDocFormatDump(stderr, rdoc, 1);
 229 #else
 230         xmlDocDump(stderr, rdoc);
 231 #endif
 232     }
 233     return rdoc;
 234 }
 235
 236 xmlDoc *normalize_record(struct session_database *sdb, Z_External *rec)
 237 {
 238     struct database_retrievalmap *m;
 239     xmlDoc *rdoc = record_to_xml(sdb, rec);
 240     if (rdoc)
 241     {
 242         for (m = sdb->map; m; m = m->next){
 243             xmlDoc *new = 0;
 244
 245             {
 246                 xmlNodePtr root = 0;
 247                 new = xsltApplyStylesheet(m->stylesheet, rdoc, 0);
 248                 root= xmlDocGetRootElement(new);
 249                 if (!new || !root || !(root->children))
 250                 {
 251                     yaz_log(YLOG_WARN, "XSLT transformation failed from %s",
 252                             sdb->database->url);
 253                     xmlFreeDoc(new);
 254                     xmlFreeDoc(rdoc);
 255                     return 0;
 256                 }
 257             }
 258
 259             xmlFreeDoc(rdoc);
 260             rdoc = new;
 261         }
 262         if (global_parameters.dump_records)
 263         {
 264             fprintf(stderr, "Record from %s\n----------------\n",
 265                     sdb->database->url);
 266 #if LIBXML_VERSION >= 20600
 267             xmlDocFormatDump(stderr, rdoc, 1);
 268 #else
 269             xmlDocDump(stderr, rdoc);
 270 #endif
 271         }
 272     }
 273     return rdoc;
 274 }
 275
 276 // Retrieve first defined value for 'name' for given database.
 277 // Will be extended to take into account user associated with session
 278 char *session_setting_oneval(struct session_database *db, int offset)
 279 {
 280     if (!db->settings[offset])
 281         return "";
 282     return db->settings[offset]->value;
 283 }
 284
 285
 286
 287 // Initialize YAZ Map structures for MARC-based targets
 288 static int prepare_yazmarc(struct session_database *sdb)
 289 {
 290     char *s;
 291
 292     if (!sdb->settings)
 293     {
 294         yaz_log(YLOG_WARN, "No settings for %s", sdb->database->url);
 295         return -1;
 296     }
 297     if ((s = session_setting_oneval(sdb, PZ_NATIVESYNTAX))
 298         && !strncmp(s, "iso2709", 7))
 299     {
 300         char *encoding = "marc-8s", *e;
 301         yaz_iconv_t cm;
 302
 303         // See if a native encoding is specified
 304         if ((e = strchr(s, ';')))
 305             encoding = e + 1;
 306
 307         sdb->yaz_marc = yaz_marc_create();
 308         yaz_marc_subfield_str(sdb->yaz_marc, "\t");
 309
 310         cm = yaz_iconv_open("utf-8", encoding);
 311         if (!cm)
 312         {
 313             yaz_log(YLOG_FATAL,
 314                     "Unable to map from %s to UTF-8 for target %s",
 315                     encoding, sdb->database->url);
 316             return -1;
 317         }
 318         yaz_marc_iconv(sdb->yaz_marc, cm);
 319     }
 320     return 0;
 321 }
 322
 323 // Prepare XSLT stylesheets for record normalization
 324 // Structures are allocated on the session_wide nmem to avoid having
 325 // to recompute this for every search. This would lead
 326 // to leaking if a single session was to repeatedly change the PZ_XSLT
 327 // setting. However, this is not a realistic use scenario.
 328 static int prepare_map(struct session *se, struct session_database *sdb)
 329 {
 330    char *s;
 331
 332     if (!sdb->settings)
 333     {
 334         yaz_log(YLOG_WARN, "No settings on %s", sdb->database->url);
 335         return -1;
 336     }
 337     if ((s = session_setting_oneval(sdb, PZ_XSLT)))
 338     {
 339         char **stylesheets;
 340         struct database_retrievalmap **m = &sdb->map;
 341         int num, i;
 342
 343         nmem_strsplit(se->session_nmem, ",", s, &stylesheets, &num);
 344         for (i = 0; i < num; i++)
 345         {
 346             (*m) = nmem_malloc(se->session_nmem, sizeof(**m));
 347             (*m)->next = 0;
 348             if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i])))
 349             {
 350                 yaz_log(YLOG_FATAL|YLOG_ERRNO, "Unable to load stylesheet: %s",
 351                         stylesheets[i]);
 352                 return -1;
 353             }
 354             m = &(*m)->next;
 355         }
 356     }
 357     if (!sdb->map)
 358         yaz_log(YLOG_WARN, "No Normalization stylesheet for target %s",
 359                 sdb->database->url);
 360     return 0;
 361 }
 362
 363 // This analyzes settings and recomputes any supporting data structures
 364 // if necessary.
 365 static int prepare_session_database(struct session *se,
 366                                     struct session_database *sdb)
 367 {
 368     if (!sdb->settings)
 369     {
 370         yaz_log(YLOG_WARN,
 371                 "No settings associated with %s", sdb->database->url);
 372         return -1;
 373     }
 374     if (sdb->settings[PZ_NATIVESYNTAX] && !sdb->yaz_marc)
 375     {
 376         if (prepare_yazmarc(sdb) < 0)
 377             return -1;
 378     }
 379     if (sdb->settings[PZ_XSLT] && !sdb->map)
 380     {
 381         if (prepare_map(se, sdb) < 0)
 382             return -1;
 383     }
 384     return 0;
 385 }
 386
 387 // called if watch should be removed because http_channel is to be destroyed
 388 static void session_watch_cancel(void *data, struct http_channel *c)
 389 {
 390     struct session_watchentry *ent = data;
 391
 392     ent->fun = 0;
 393     ent->data = 0;
 394     ent->obs = 0;
 395 }
 396
 397 // set watch. Returns 0=OK, -1 if watch is already set
 398 int session_set_watch(struct session *s, int what,
 399                       session_watchfun fun, void *data,
 400                       struct http_channel *chan)
 401 {
 402     if (s->watchlist[what].fun)
 403         return -1;
 404     s->watchlist[what].fun = fun;
 405     s->watchlist[what].data = data;
 406     s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
 407                                                session_watch_cancel);
 408     return 0;
 409 }
 410
 411 void session_alert_watch(struct session *s, int what)
 412 {
 413     if (!s->watchlist[what].fun)
 414         return;
 415     http_remove_observer(s->watchlist[what].obs);
 416     (*s->watchlist[what].fun)(s->watchlist[what].data);
 417     s->watchlist[what].fun = 0;
 418     s->watchlist[what].data = 0;
 419     s->watchlist[what].obs = 0;
 420 }
 421
 422 //callback for grep_databases
 423 static void select_targets_callback(void *context, struct session_database *db)
 424 {
 425     struct session *se = (struct session*) context;
 426     struct client *cl = client_create();
 427     client_set_database(cl, db);
 428     client_set_session(cl, se);
 429 }
 430
 431 // Associates a set of clients with a session;
 432 // Note: Session-databases represent databases with per-session
 433 // setting overrides
 434 int select_targets(struct session *se, struct database_criterion *crit)
 435 {
 436     while (se->clients)
 437         client_destroy(se->clients);
 438
 439     return session_grep_databases(se, crit, select_targets_callback);
 440 }
 441
 442 int session_active_clients(struct session *s)
 443 {
 444     struct client *c;
 445     int res = 0;
 446
 447     for (c = s->clients; c; c = client_next_in_session(c))
 448         if (client_is_active(c))
 449             res++;
 450
 451     return res;
 452 }
 453
 454 // parses crit1=val1,crit2=val2|val3,...
 455 static struct database_criterion *parse_filter(NMEM m, const char *buf)
 456 {
 457     struct database_criterion *res = 0;
 458     char **values;
 459     int num;
 460     int i;
 461
 462     if (!buf || !*buf)
 463         return 0;
 464     nmem_strsplit(m, ",", buf,  &values, &num);
 465     for (i = 0; i < num; i++)
 466     {
 467         char **subvalues;
 468         int subnum;
 469         int subi;
 470         struct database_criterion *new = nmem_malloc(m, sizeof(*new));
 471         char *eq = strchr(values[i], '=');
 472         if (!eq)
 473         {
 474             yaz_log(YLOG_WARN, "Missing equal-sign in filter");
 475             return 0;
 476         }
 477         *(eq++) = '\0';
 478         new->name = values[i];
 479         nmem_strsplit(m, "|", eq, &subvalues, &subnum);
 480         new->values = 0;
 481         for (subi = 0; subi < subnum; subi++)
 482         {
 483             struct database_criterion_value *newv
 484                 = nmem_malloc(m, sizeof(*newv));
 485             newv->value = subvalues[subi];
 486             newv->next = new->values;
 487             new->values = newv;
 488         }
 489         new->next = res;
 490         res = new;
 491     }
 492     return res;
 493 }
 494
 495 enum pazpar2_error_code search(struct session *se,
 496                                char *query, char *filter,
 497                                const char **addinfo)
 498 {
 499     int live_channels = 0;
 500     struct client *cl;
 501     struct database_criterion *criteria;
 502
 503     yaz_log(YLOG_DEBUG, "Search");
 504
 505     *addinfo = 0;
 506     nmem_reset(se->nmem);
 507     criteria = parse_filter(se->nmem, filter);
 508     se->requestid++;
 509     live_channels = select_targets(se, criteria);
 510     if (live_channels)
 511     {
 512         int maxrecs = live_channels * global_parameters.toget;
 513         se->num_termlists = 0;
 514         se->reclist = reclist_create(se->nmem, maxrecs);
 515         // This will be initialized in send_search()
 516         se->total_records = se->total_hits = se->total_merged = 0;
 517         se->expected_maxrecs = maxrecs;
 518     }
 519     else
 520         return PAZPAR2_NO_TARGETS;
 521
 522     se->relevance = 0;
 523
 524     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 525     {
 526         if (prepare_session_database(se, client_get_database(cl)) < 0)
 527         {
 528             *addinfo = client_get_database(cl)->database->url;
 529             return PAZPAR2_CONFIG_TARGET;
 530         }
 531         // Query must parse for all targets
 532         if (client_parse_query(cl, query) < 0)
 533         {
 534             *addinfo = "query";
 535             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 536         }
 537     }
 538
 539     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 540         client_prep_connection(cl);
 541
 542     return PAZPAR2_NO_ERROR;
 543 }
 544
 545 // Creates a new session_database object for a database
 546 static void session_init_databases_fun(void *context, struct database *db)
 547 {
 548     struct session *se = (struct session *) context;
 549     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 550     int num = settings_num();
 551     int i;
 552
 553     new->database = db;
 554     new->yaz_marc = 0;
 555
 556 #ifdef HAVE_ICU
 557     if (global_parameters.server && global_parameters.server->icu_chn)
 558         new->pct = pp2_charset_create(global_parameters.server->icu_chn);
 559     else
 560         new->pct = pp2_charset_create(0);
 561 #else // HAVE_ICU
 562     new->pct = pp2_charset_create(0);
 563 #endif // HAVE_ICU
 564
 565     new->map = 0;
 566     new->settings
 567         = nmem_malloc(se->session_nmem, sizeof(struct settings *) * num);
 568     memset(new->settings, 0, sizeof(struct settings*) * num);
 569
 570     if (db->settings)
 571     {
 572         for (i = 0; i < num; i++)
 573             new->settings[i] = db->settings[i];
 574     }
 575     new->next = se->databases;
 576     se->databases = new;
 577 }
 578
 579 // Doesn't free memory associated with sdb -- nmem takes care of that
 580 static void session_database_destroy(struct session_database *sdb)
 581 {
 582     struct database_retrievalmap *m;
 583
 584     for (m = sdb->map; m; m = m->next)
 585         xsltFreeStylesheet(m->stylesheet);
 586     if (sdb->yaz_marc)
 587         yaz_marc_destroy(sdb->yaz_marc);
 588     if (sdb->pct)
 589         pp2_charset_destroy(sdb->pct);
 590 }
 591
 592 // Initialize session_database list -- this represents this session's view
 593 // of the database list -- subject to modification by the settings ws command
 594 void session_init_databases(struct session *se)
 595 {
 596     se->databases = 0;
 597     predef_grep_databases(se, 0, session_init_databases_fun);
 598 }
 599
 600 // Probably session_init_databases_fun should be refactored instead of
 601 // called here.
 602 static struct session_database *load_session_database(struct session *se,
 603                                                       char *id)
 604 {
 605     struct database *db = find_database(id, 0);
 606
 607     session_init_databases_fun((void*) se, db);
 608     // New sdb is head of se->databases list
 609     return se->databases;
 610 }
 611
 612 // Find an existing session database. If not found, load it
 613 static struct session_database *find_session_database(struct session *se,
 614                                                       char *id)
 615 {
 616     struct session_database *sdb;
 617
 618     for (sdb = se->databases; sdb; sdb = sdb->next)
 619         if (!strcmp(sdb->database->url, id))
 620             return sdb;
 621     return load_session_database(se, id);
 622 }
 623
 624 // Apply a session override to a database
 625 void session_apply_setting(struct session *se, char *dbname, char *setting,
 626                            char *value)
 627 {
 628     struct session_database *sdb = find_session_database(se, dbname);
 629     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 630     int offset = settings_offset_cprefix(setting);
 631
 632     if (offset < 0)
 633     {
 634         yaz_log(YLOG_WARN, "Unknown setting %s", setting);
 635         return;
 636     }
 637     // Jakub: This breaks the filter setting.
 638     /*if (offset == PZ_ID)
 639     {
 640         yaz_log(YLOG_WARN, "No need to set pz:id setting. Ignoring");
 641         return;
 642     }*/
 643     new->precedence = 0;
 644     new->target = dbname;
 645     new->name = setting;
 646     new->value = value;
 647     new->next = sdb->settings[offset];
 648     sdb->settings[offset] = new;
 649
 650     // Force later recompute of settings-driven data structures
 651     // (happens when a search starts and client connections are prepared)
 652     switch (offset)
 653     {
 654         case PZ_NATIVESYNTAX:
 655             if (sdb->yaz_marc)
 656             {
 657                 yaz_marc_destroy(sdb->yaz_marc);
 658                 sdb->yaz_marc = 0;
 659             }
 660             break;
 661         case PZ_XSLT:
 662             if (sdb->map)
 663             {
 664                 struct database_retrievalmap *m;
 665                 // We don't worry about the map structure -- it's in nmem
 666                 for (m = sdb->map; m; m = m->next)
 667                     xsltFreeStylesheet(m->stylesheet);
 668                 sdb->map = 0;
 669             }
 670             break;
 671     }
 672 }
 673
 674 void destroy_session(struct session *s)
 675 {
 676     struct session_database *sdb;
 677
 678     while (s->clients)
 679         client_destroy(s->clients);
 680     for (sdb = s->databases; sdb; sdb = sdb->next)
 681         session_database_destroy(sdb);
 682     nmem_destroy(s->nmem);
 683     wrbuf_destroy(s->wrbuf);
 684 }
 685
 686 struct session *new_session(NMEM nmem)
 687 {
 688     int i;
 689     struct session *session = nmem_malloc(nmem, sizeof(*session));
 690
 691     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
 692
 693     session->relevance = 0;
 694     session->total_hits = 0;
 695     session->total_records = 0;
 696     session->num_termlists = 0;
 697     session->reclist = 0;
 698     session->requestid = -1;
 699     session->clients = 0;
 700     session->expected_maxrecs = 0;
 701     session->session_nmem = nmem;
 702     session->nmem = nmem_create();
 703     session->wrbuf = wrbuf_alloc();
 704     session->databases = 0;
 705     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 706     {
 707         session->watchlist[i].data = 0;
 708         session->watchlist[i].fun = 0;
 709     }
 710
 711     return session;
 712 }
 713
 714 struct hitsbytarget *hitsbytarget(struct session *se, int *count)
 715 {
 716     static struct hitsbytarget res[1000]; // FIXME MM
 717     struct client *cl;
 718
 719     *count = 0;
 720     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 721     {
 722         char *name = session_setting_oneval(client_get_database(cl), PZ_NAME);
 723
 724         res[*count].id = client_get_database(cl)->database->url;
 725         res[*count].name = *name ? name : "Unknown";
 726         res[*count].hits = client_get_hits(cl);
 727         res[*count].records = client_get_num_records(cl);
 728         res[*count].diagnostic = client_get_diagnostic(cl);
 729         res[*count].state = client_get_state_str(cl);
 730         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 731         (*count)++;
 732     }
 733
 734     return res;
 735 }
 736
 737 struct termlist_score **termlist(struct session *s, const char *name, int *num)
 738 {
 739     int i;
 740
 741     for (i = 0; i < s->num_termlists; i++)
 742         if (!strcmp((const char *) s->termlists[i].name, name))
 743             return termlist_highscore(s->termlists[i].termlist, num);
 744     return 0;
 745 }
 746
 747 #ifdef MISSING_HEADERS
 748 void report_nmem_stats(void)
 749 {
 750     size_t in_use, is_free;
 751
 752     nmem_get_memory_in_use(&in_use);
 753     nmem_get_memory_free(&is_free);
 754
 755     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
 756             (long) in_use, (long) is_free);
 757 }
 758 #endif
 759
 760 struct record_cluster *show_single(struct session *s, int id)
 761 {
 762     struct record_cluster *r;
 763
 764     reclist_rewind(s->reclist);
 765     while ((r = reclist_read_record(s->reclist)))
 766         if (r->recid == id)
 767             return r;
 768     return 0;
 769 }
 770
 771 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp,
 772                              int start, int *num, int *total, int *sumhits,
 773                              NMEM nmem_show)
 774 {
 775     struct record_cluster **recs = nmem_malloc(nmem_show, *num
 776                                        * sizeof(struct record_cluster *));
 777     struct reclist_sortparms *spp;
 778     int i;
 779 #if USE_TIMING
 780     yaz_timing_t t = yaz_timing_create();
 781 #endif
 782
 783     if (!s->relevance)
 784     {
 785         *num = 0;
 786         *total = 0;
 787         *sumhits = 0;
 788         recs = 0;
 789     }
 790     else
 791     {
 792         for (spp = sp; spp; spp = spp->next)
 793             if (spp->type == Metadata_sortkey_relevance)
 794             {
 795                 relevance_prepare_read(s->relevance, s->reclist);
 796                 break;
 797             }
 798         reclist_sort(s->reclist, sp);
 799
 800         *total = s->reclist->num_records;
 801         *sumhits = s->total_hits;
 802
 803         for (i = 0; i < start; i++)
 804             if (!reclist_read_record(s->reclist))
 805             {
 806                 *num = 0;
 807                 recs = 0;
 808                 break;
 809             }
 810
 811         for (i = 0; i < *num; i++)
 812         {
 813             struct record_cluster *r = reclist_read_record(s->reclist);
 814             if (!r)
 815             {
 816                 *num = i;
 817                 break;
 818             }
 819             recs[i] = r;
 820         }
 821     }
 822 #if USE_TIMING
 823     yaz_timing_stop(t);
 824     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
 825             yaz_timing_get_real(t), yaz_timing_get_user(t),
 826             yaz_timing_get_sys(t));
 827     yaz_timing_destroy(&t);
 828 #endif
 829     return recs;
 830 }
 831
 832 void statistics(struct session *se, struct statistics *stat)
 833 {
 834     struct client *cl;
 835     int count = 0;
 836
 837     memset(stat, 0, sizeof(*stat));
 838     for (cl = se->clients; cl; cl = client_next_in_session(cl))
 839     {
 840         if (!client_get_connection(cl))
 841             stat->num_no_connection++;
 842         switch (client_get_state(cl))
 843         {
 844             case Client_Connecting: stat->num_connecting++; break;
 845             case Client_Initializing: stat->num_initializing++; break;
 846             case Client_Searching: stat->num_searching++; break;
 847             case Client_Presenting: stat->num_presenting++; break;
 848             case Client_Idle: stat->num_idle++; break;
 849             case Client_Failed: stat->num_failed++; break;
 850             case Client_Error: stat->num_error++; break;
 851             default: break;
 852         }
 853         count++;
 854     }
 855     stat->num_hits = se->total_hits;
 856     stat->num_records = se->total_records;
 857
 858     stat->num_clients = count;
 859 }
 860
 861 void start_http_listener(void)
 862 {
 863     char hp[128] = "";
 864     struct conf_server *ser = global_parameters.server;
 865
 866     if (*global_parameters.listener_override)
 867         strcpy(hp, global_parameters.listener_override);
 868     else
 869     {
 870         strcpy(hp, ser->host ? ser->host : "");
 871         if (ser->port)
 872         {
 873             if (*hp)
 874                 strcat(hp, ":");
 875             sprintf(hp + strlen(hp), "%d", ser->port);
 876         }
 877     }
 878     http_init(hp);
 879 }
 880
 881 void start_proxy(void)
 882 {
 883     char hp[128] = "";
 884     struct conf_server *ser = global_parameters.server;
 885
 886     if (*global_parameters.proxy_override)
 887         strcpy(hp, global_parameters.proxy_override);
 888     else if (ser->proxy_host || ser->proxy_port)
 889     {
 890         strcpy(hp, ser->proxy_host ? ser->proxy_host : "");
 891         if (ser->proxy_port)
 892         {
 893             if (*hp)
 894                 strcat(hp, ":");
 895             sprintf(hp + strlen(hp), "%d", ser->proxy_port);
 896         }
 897     }
 898     else
 899         return;
 900
 901     http_set_proxyaddr(hp, ser->myurl ? ser->myurl : "");
 902 }
 903
 904
 905 // Master list of connections we're handling events to
 906 static IOCHAN channel_list = 0;
 907 void pazpar2_add_channel(IOCHAN chan)
 908 {
 909     chan->next = channel_list;
 910     channel_list = chan;
 911 }
 912
 913 void pazpar2_event_loop()
 914 {
 915     event_loop(&channel_list);
 916 }
 917
 918 struct record *ingest_record(struct client *cl, Z_External *rec,
 919                              int record_no)
 920 {
 921     xmlDoc *xdoc = normalize_record(client_get_database(cl), rec);
 922     xmlNode *root, *n;
 923     struct record *record;
 924     struct record_cluster *cluster;
 925     struct session *se = client_get_session(cl);
 926     xmlChar *mergekey, *mergekey_norm;
 927     xmlChar *type = 0;
 928     xmlChar *value = 0;
 929     struct conf_service *service = global_parameters.server->service;
 930
 931     if (!xdoc)
 932         return 0;
 933
 934     root = xmlDocGetRootElement(xdoc);
 935     if (!(mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
 936     {
 937         yaz_log(YLOG_WARN, "No mergekey found in record");
 938         xmlFreeDoc(xdoc);
 939         return 0;
 940     }
 941
 942     record = record_create(se->nmem,
 943                            service->num_metadata, service->num_sortkeys, cl,
 944                            record_no);
 945
 946     mergekey_norm = (xmlChar *) nmem_strdup(se->nmem, (char*) mergekey);
 947     xmlFree(mergekey);
 948     normalize7bit_mergekey((char *) mergekey_norm, 0);
 949
 950     cluster = reclist_insert(se->reclist,
 951                              global_parameters.server->service,
 952                              record, (char *) mergekey_norm,
 953                              &se->total_merged);
 954     if (global_parameters.dump_records)
 955         yaz_log(YLOG_LOG, "Cluster id %d from %s (#%d)", cluster->recid,
 956                 client_get_database(cl)->database->url, record_no);
 957     if (!cluster)
 958     {
 959         /* no room for record */
 960         xmlFreeDoc(xdoc);
 961         return 0;
 962     }
 963     relevance_newrec(se->relevance, cluster);
 964
 965
 966     // now parsing XML record and adding data to cluster or record metadata
 967     for (n = root->children; n; n = n->next)
 968     {
 969         if (type)
 970             xmlFree(type);
 971         if (value)
 972             xmlFree(value);
 973         type = value = 0;
 974
 975         if (n->type != XML_ELEMENT_NODE)
 976             continue;
 977         if (!strcmp((const char *) n->name, "metadata"))
 978         {
 979             struct conf_metadata *ser_md = 0;
 980             struct conf_sortkey *ser_sk = 0;
 981             struct record_metadata **wheretoput = 0;
 982             struct record_metadata *rec_md = 0;
 983             int md_field_id = -1;
 984             int sk_field_id = -1;
 985             int first, last;
 986
 987             type = xmlGetProp(n, (xmlChar *) "type");
 988             value = xmlNodeListGetString(xdoc, n->children, 1);
 989
 990             if (!type || !value)
 991                 continue;
 992
 993             md_field_id
 994                 = conf_service_metadata_field_id(service, (const char *) type);
 995             if (md_field_id < 0)
 996             {
 997                 yaz_log(YLOG_WARN,
 998                         "Ignoring unknown metadata element: %s", type);
 999                 continue;
1000             }
1001
1002             ser_md = &service->metadata[md_field_id];
1003
1004             if (ser_md->sortkey_offset >= 0){
1005                 sk_field_id = ser_md->sortkey_offset;
1006                 ser_sk = &service->sortkeys[sk_field_id];
1007             }
1008
1009             // Find out where we are putting it - based on merge or not
1010             if (ser_md->merge == Metadata_merge_no)
1011                 wheretoput = &record->metadata[md_field_id];
1012             else
1013                 wheretoput = &cluster->metadata[md_field_id];
1014
1015             // create new record_metadata
1016             rec_md = record_metadata_create(se->nmem);
1017
1018             // and polulate with data:
1019             // type based charmapping decisions follow here
1020             if (ser_md->type == Metadata_type_generic)
1021             {
1022
1023                 char * p = (char *) value;
1024                 p = normalize7bit_generic(p, " ,/.:([");
1025
1026                 rec_md->data.text = nmem_strdup(se->nmem, p);
1027
1028             }
1029             else if (ser_md->type == Metadata_type_year)
1030             {
1031                 if (extract7bit_years((char *) value, &first, &last) < 0)
1032                     continue;
1033             }
1034             else
1035             {
1036                 yaz_log(YLOG_WARN,
1037                         "Unknown type in metadata element %s", type);
1038                 continue;
1039             }
1040
1041             // and polulate with data:
1042             // assign cluster or record based on merge action
1043             if (ser_md->merge == Metadata_merge_unique)
1044             {
1045                 struct record_metadata *mnode;
1046                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1047                     if (!strcmp((const char *) mnode->data.text,
1048                                 rec_md->data.text))
1049                         break;
1050                 if (!mnode)
1051                 {
1052                     rec_md->next = *wheretoput;
1053                     *wheretoput = rec_md;
1054                 }
1055             }
1056             else if (ser_md->merge == Metadata_merge_longest)
1057             {
1058                 if (!*wheretoput
1059                     || strlen(rec_md->data.text)
1060                        > strlen((*wheretoput)->data.text))
1061                 {
1062                     *wheretoput = rec_md;
1063                     if (ser_sk)
1064                     {
1065                         char *s = nmem_strdup(se->nmem, rec_md->data.text);
1066                         if (!cluster->sortkeys[sk_field_id])
1067                             cluster->sortkeys[sk_field_id] =
1068                                 nmem_malloc(se->nmem,
1069                                             sizeof(union data_types));
1070                         normalize7bit_mergekey(s,
1071                              (ser_sk->type == Metadata_sortkey_skiparticle));
1072                         cluster->sortkeys[sk_field_id]->text = s;
1073                     }
1074                 }
1075             }
1076             else if (ser_md->merge == Metadata_merge_all
1077                      || ser_md->merge == Metadata_merge_no)
1078             {
1079                 rec_md->next = *wheretoput;
1080                 *wheretoput = rec_md;
1081             }
1082             else if (ser_md->merge == Metadata_merge_range)
1083             {
1084                 if (!*wheretoput)
1085                 {
1086                     *wheretoput = rec_md;
1087                     (*wheretoput)->data.number.min = first;
1088                     (*wheretoput)->data.number.max = last;
1089                     if (ser_sk)
1090                         cluster->sortkeys[sk_field_id]
1091                             = &rec_md->data;
1092                 }
1093                 else
1094                 {
1095                     if (first < (*wheretoput)->data.number.min)
1096                         (*wheretoput)->data.number.min = first;
1097                     if (last > (*wheretoput)->data.number.max)
1098                         (*wheretoput)->data.number.max = last;
1099                 }
1100 #ifdef GAGA
1101                 if (ser_sk)
1102                 {
1103                     union data_types *sdata
1104                         = cluster->sortkeys[sk_field_id];
1105                     yaz_log(YLOG_LOG, "SK range: %d-%d",
1106                             sdata->number.min, sdata->number.max);
1107                 }
1108 #endif
1109             }
1110
1111
1112             // ranking of _all_ fields enabled ...
1113             if (ser_md->rank)
1114                 relevance_countwords(se->relevance, cluster,
1115                                      (char *) value, ser_md->rank);
1116
1117             // construct facets ...
1118             if (ser_md->termlist)
1119             {
1120                 if (ser_md->type == Metadata_type_year)
1121                 {
1122                     char year[64];
1123                     sprintf(year, "%d", last);
1124                     add_facet(se, (char *) type, year);
1125                     if (first != last)
1126                     {
1127                         sprintf(year, "%d", first);
1128                         add_facet(se, (char *) type, year);
1129                     }
1130                 }
1131                 else
1132                     add_facet(se, (char *) type, (char *) value);
1133             }
1134
1135             // cleaning up
1136             xmlFree(type);
1137             xmlFree(value);
1138             type = value = 0;
1139         }
1140         else
1141             yaz_log(YLOG_WARN,
1142                     "Unexpected element %s in internal record", n->name);
1143     }
1144     if (type)
1145         xmlFree(type);
1146     if (value)
1147         xmlFree(value);
1148
1149     xmlFreeDoc(xdoc);
1150
1151     relevance_donerecord(se->relevance, cluster);
1152     se->total_records++;
1153
1154     return record;
1155 }
1156
1157
1158
1159 /*
1160  * Local variables:
1161  * c-basic-offset: 4
1162  * indent-tabs-mode: nil
1163  * End:
1164  * vim: shiftwidth=4 tabstop=8 expandtab
1165  */