src/session.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2010 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 session.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 #include "ppmutex.h"
  61 #include "parameters.h"
  62 #include "session.h"
  63 #include "eventl.h"
  64 #include "http.h"
  65 #include "termlists.h"
  66 #include "reclists.h"
  67 #include "relevance.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     0,   // dump_records
  81     0    // debug_mode
  82 };
  83
  84 struct client_list {
  85     struct client *client;
  86     struct client_list *next;
  87 };
  88
  89 static void log_xml_doc(xmlDoc *doc)
  90 {
  91     FILE *lf = yaz_log_file();
  92     xmlChar *result = 0;
  93     int len = 0;
  94 #if LIBXML_VERSION >= 20600
  95     xmlDocDumpFormatMemory(doc, &result, &len, 1);
  96 #else
  97     xmlDocDumpMemory(doc, &result, &len);
  98 #endif
  99     if (lf && len)
 100     {
 101         (void) fwrite(result, 1, len, lf);
 102         fprintf(lf, "\n");
 103     }
 104     xmlFree(result);
 105 }
 106
 107 static void session_enter(struct session *s)
 108 {
 109     yaz_mutex_enter(s->mutex);
 110 }
 111
 112 static void session_leave(struct session *s)
 113 {
 114     yaz_mutex_leave(s->mutex);
 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 static void add_facet(struct session *s, const char *type, const char *value)
 145 {
 146     int i;
 147
 148     if (!*value)
 149         return;
 150     for (i = 0; i < s->num_termlists; i++)
 151         if (!strcmp(s->termlists[i].name, type))
 152             break;
 153     if (i == s->num_termlists)
 154     {
 155         if (i == SESSION_MAX_TERMLISTS)
 156         {
 157             yaz_log(YLOG_FATAL, "Too many termlists");
 158             return;
 159         }
 160
 161         s->termlists[i].name = nmem_strdup(s->nmem, type);
 162         s->termlists[i].termlist
 163             = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
 164         s->num_termlists = i + 1;
 165     }
 166     termlist_insert(s->termlists[i].termlist, value);
 167 }
 168
 169 static xmlDoc *record_to_xml(struct session_database *sdb, const char *rec)
 170 {
 171     struct database *db = sdb->database;
 172     xmlDoc *rdoc = 0;
 173
 174     rdoc = xmlParseMemory(rec, strlen(rec));
 175
 176     if (!rdoc)
 177     {
 178         yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s",
 179                 db->url);
 180         return 0;
 181     }
 182
 183     if (global_parameters.dump_records)
 184     {
 185         yaz_log(YLOG_LOG, "Un-normalized record from %s", db->url);
 186         log_xml_doc(rdoc);
 187     }
 188
 189     return rdoc;
 190 }
 191
 192 #define MAX_XSLT_ARGS 16
 193
 194 // Add static values from session database settings if applicable
 195 static void insert_settings_parameters(struct session_database *sdb,
 196                                        struct conf_service *service,
 197                                        char **parms,
 198                                        NMEM nmem)
 199 {
 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_lookup_offset(service, 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(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     struct conf_service *service)
 234 {
 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_lookup_offset(service, 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 static xmlDoc *normalize_record(struct session_database *sdb,
 258                                 struct conf_service *service,
 259                                 const char *rec, NMEM nmem)
 260 {
 261     xmlDoc *rdoc = record_to_xml(sdb, rec);
 262
 263     if (rdoc)
 264     {
 265         char *parms[MAX_XSLT_ARGS*2+1];
 266
 267         insert_settings_parameters(sdb, service, parms, nmem);
 268
 269         if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
 270         {
 271             yaz_log(YLOG_WARN, "Normalize failed from %s", sdb->database->url);
 272         }
 273         else
 274         {
 275             insert_settings_values(sdb, rdoc, service);
 276
 277             if (global_parameters.dump_records)
 278             {
 279                 yaz_log(YLOG_LOG, "Normalized record from %s",
 280                         sdb->database->url);
 281                 log_xml_doc(rdoc);
 282             }
 283         }
 284     }
 285     return rdoc;
 286 }
 287
 288 void session_settings_dump(struct session *se,
 289                            struct session_database *db,
 290                            WRBUF w)
 291 {
 292     if (db->settings)
 293     {
 294         int i, num = db->num_settings;
 295         for (i = 0; i < num; i++)
 296         {
 297             struct setting *s = db->settings[i];
 298             for (;s ; s = s->next)
 299             {
 300                 wrbuf_puts(w, "<set name=\"");
 301                 wrbuf_xmlputs(w, s->name);
 302                 wrbuf_puts(w, "\" value=\"");
 303                 wrbuf_xmlputs(w, s->value);
 304                 wrbuf_puts(w, "\"/>");
 305             }
 306             if (db->settings[i])
 307                 wrbuf_puts(w, "\n");
 308         }
 309     }
 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 (offset >= db->num_settings || !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 auto_stylesheet[256];
 338
 339         if (!strcmp(s, "auto"))
 340         {
 341             const char *request_syntax = session_setting_oneval(
 342                 sdb, PZ_REQUESTSYNTAX);
 343             if (request_syntax)
 344             {
 345                 char *cp;
 346                 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
 347                              "%s.xsl", request_syntax);
 348                 for (cp = auto_stylesheet; *cp; cp++)
 349                 {
 350                     /* deliberately only consider ASCII */
 351                     if (*cp > 32 && *cp < 127)
 352                         *cp = tolower(*cp);
 353                 }
 354                 s = auto_stylesheet;
 355             }
 356             else
 357             {
 358                 yaz_log(YLOG_WARN, "No pz:requestsyntax for auto stylesheet");
 359             }
 360         }
 361         sdb->map = normalize_cache_get(se->normalize_cache,
 362                                        se->service, s);
 363         if (!sdb->map)
 364             return -1;
 365     }
 366     return 0;
 367 }
 368
 369 // This analyzes settings and recomputes any supporting data structures
 370 // if necessary.
 371 static int prepare_session_database(struct session *se,
 372                                     struct session_database *sdb)
 373 {
 374     if (!sdb->settings)
 375     {
 376         yaz_log(YLOG_WARN,
 377                 "No settings associated with %s", sdb->database->url);
 378         return -1;
 379     }
 380     if (sdb->settings[PZ_XSLT] && !sdb->map)
 381     {
 382         if (prepare_map(se, sdb) < 0)
 383             return -1;
 384     }
 385     return 0;
 386 }
 387
 388 // called if watch should be removed because http_channel is to be destroyed
 389 static void session_watch_cancel(void *data, struct http_channel *c,
 390                                  void *data2)
 391 {
 392     struct session_watchentry *ent = data;
 393
 394     ent->fun = 0;
 395     ent->data = 0;
 396     ent->obs = 0;
 397 }
 398
 399 // set watch. Returns 0=OK, -1 if watch is already set
 400 int session_set_watch(struct session *s, int what,
 401                       session_watchfun fun, void *data,
 402                       struct http_channel *chan)
 403 {
 404     int ret;
 405     session_enter(s);
 406     if (s->watchlist[what].fun)
 407         ret = -1;
 408     else
 409     {
 410
 411         s->watchlist[what].fun = fun;
 412         s->watchlist[what].data = data;
 413         s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
 414                                                    session_watch_cancel);
 415         ret = 0;
 416     }
 417     session_leave(s);
 418     return 0;
 419 }
 420
 421 void session_alert_watch(struct session *s, int what)
 422 {
 423     assert(s);
 424     session_enter(s);
 425     if (s->watchlist[what].fun)
 426     {
 427         /* our watch is no longer associated with http_channel */
 428         void *data;
 429         session_watchfun fun;
 430
 431         http_remove_observer(s->watchlist[what].obs);
 432         fun = s->watchlist[what].fun;
 433         data = s->watchlist[what].data;
 434
 435         /* reset watch before fun is invoked - in case fun wants to set
 436            it again */
 437         s->watchlist[what].fun = 0;
 438         s->watchlist[what].data = 0;
 439         s->watchlist[what].obs = 0;
 440
 441         session_leave(s);
 442         fun(data);
 443     }
 444     else
 445         session_leave(s);
 446 }
 447
 448 //callback for grep_databases
 449 static void select_targets_callback(void *context, struct session_database *db)
 450 {
 451     struct session *se = (struct session*) context;
 452     struct client *cl = client_create();
 453     struct client_list *l;
 454     client_set_database(cl, db);
 455
 456     client_set_session(cl, se);
 457     l = xmalloc(sizeof(*l));
 458     l->client = cl;
 459     l->next = se->clients;
 460     se->clients = l;
 461 }
 462
 463 static void session_remove_clients(struct session *se)
 464 {
 465     struct client_list *l = se->clients;
 466     while (l)
 467     {
 468         struct client_list *l_next = l->next;
 469         client_set_session(l->client, 0);
 470         client_destroy(l->client);
 471         xfree(l);
 472         l = l_next;
 473     }
 474     se->clients = 0;
 475 }
 476
 477 // Associates a set of clients with a session;
 478 // Note: Session-databases represent databases with per-session
 479 // setting overrides
 480 static int select_targets(struct session *se, const char *filter)
 481 {
 482     session_remove_clients(se);
 483     return session_grep_databases(se, filter, select_targets_callback);
 484 }
 485
 486 int session_active_clients(struct session *s)
 487 {
 488     struct client_list *l;
 489     int res = 0;
 490
 491     for (l = s->clients; l; l = l->next)
 492         if (client_is_active(l->client))
 493             res++;
 494
 495     return res;
 496 }
 497
 498
 499 enum pazpar2_error_code search(struct session *se,
 500                                const char *query,
 501                                const char *startrecs, const char *maxrecs,
 502                                const char *filter,
 503                                const char **addinfo)
 504 {
 505     int live_channels = 0;
 506     int no_working = 0;
 507     int no_failed = 0;
 508     struct client_list *l;
 509
 510     yaz_log(YLOG_DEBUG, "Search");
 511
 512     *addinfo = 0;
 513
 514     session_enter(se);
 515     reclist_destroy(se->reclist);
 516     se->reclist = 0;
 517     nmem_reset(se->nmem);
 518     relevance_destroy(&se->relevance);
 519     se->total_records = se->total_hits = se->total_merged = 0;
 520     se->num_termlists = 0;
 521     live_channels = select_targets(se, filter);
 522     if (!live_channels)
 523     {
 524         session_leave(se);
 525         return PAZPAR2_NO_TARGETS;
 526     }
 527     se->reclist = reclist_create(se->nmem);
 528
 529     for (l = se->clients; l; l = l->next)
 530     {
 531         struct client *cl = l->client;
 532         if (maxrecs)
 533             client_set_maxrecs(cl, atoi(maxrecs));
 534         if (startrecs)
 535             client_set_startrecs(cl, atoi(startrecs));
 536         if (prepare_session_database(se, client_get_database(cl)) < 0)
 537             continue;
 538         // Parse query for target
 539         if (client_parse_query(cl, query) < 0)
 540             no_failed++;
 541         else
 542         {
 543             no_working++;
 544             if (client_prep_connection(cl, se->service->z3950_operation_timeout,
 545                                        se->service->z3950_session_timeout,
 546                                        se->service->server->iochan_man))
 547                 client_start_search(cl);
 548         }
 549     }
 550     session_leave(se);
 551     if (no_working == 0)
 552     {
 553         if (no_failed > 0)
 554         {
 555             *addinfo = "query";
 556             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 557         }
 558         else
 559             return PAZPAR2_NO_TARGETS;
 560     }
 561     return PAZPAR2_NO_ERROR;
 562 }
 563
 564 // Creates a new session_database object for a database
 565 static void session_init_databases_fun(void *context, struct database *db)
 566 {
 567     struct session *se = (struct session *) context;
 568     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 569     int i;
 570
 571     new->database = db;
 572
 573     new->map = 0;
 574     assert(db->settings);
 575     new->settings = nmem_malloc(se->session_nmem,
 576                                 sizeof(struct settings *) * db->num_settings);
 577     new->num_settings = db->num_settings;
 578     for (i = 0; i < db->num_settings; i++)
 579     {
 580         struct setting *setting = db->settings[i];
 581         new->settings[i] = setting;
 582     }
 583     new->next = se->databases;
 584     se->databases = new;
 585 }
 586
 587 // Doesn't free memory associated with sdb -- nmem takes care of that
 588 static void session_database_destroy(struct session_database *sdb)
 589 {
 590     sdb->map = 0;
 591 }
 592
 593 // Initialize session_database list -- this represents this session's view
 594 // of the database list -- subject to modification by the settings ws command
 595 void session_init_databases(struct session *se)
 596 {
 597     se->databases = 0;
 598     predef_grep_databases(se, se->service, session_init_databases_fun);
 599 }
 600
 601 // Probably session_init_databases_fun should be refactored instead of
 602 // called here.
 603 static struct session_database *load_session_database(struct session *se,
 604                                                       char *id)
 605 {
 606     struct database *db = new_database(id, se->session_nmem);
 607
 608     resolve_database(se->service, db);
 609
 610     session_init_databases_fun((void*) se, db);
 611
 612     // New sdb is head of se->databases list
 613     return se->databases;
 614 }
 615
 616 // Find an existing session database. If not found, load it
 617 static struct session_database *find_session_database(struct session *se,
 618                                                       char *id)
 619 {
 620     struct session_database *sdb;
 621
 622     for (sdb = se->databases; sdb; sdb = sdb->next)
 623         if (!strcmp(sdb->database->url, id))
 624             return sdb;
 625     return load_session_database(se, id);
 626 }
 627
 628 // Apply a session override to a database
 629 void session_apply_setting(struct session *se, char *dbname, char *setting,
 630                            char *value)
 631 {
 632     struct session_database *sdb = find_session_database(se, dbname);
 633     struct conf_service *service = se->service;
 634     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 635     int offset = settings_create_offset(service, setting);
 636
 637     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
 638                           se->session_nmem);
 639     new->precedence = 0;
 640     new->target = dbname;
 641     new->name = setting;
 642     new->value = value;
 643     new->next = sdb->settings[offset];
 644     sdb->settings[offset] = new;
 645
 646     // Force later recompute of settings-driven data structures
 647     // (happens when a search starts and client connections are prepared)
 648     switch (offset)
 649     {
 650     case PZ_XSLT:
 651         if (sdb->map)
 652         {
 653             sdb->map = 0;
 654         }
 655         break;
 656     }
 657 }
 658
 659 void destroy_session(struct session *s)
 660 {
 661     struct session_database *sdb;
 662
 663     session_remove_clients(s);
 664
 665     for (sdb = s->databases; sdb; sdb = sdb->next)
 666         session_database_destroy(sdb);
 667     normalize_cache_destroy(s->normalize_cache);
 668     relevance_destroy(&s->relevance);
 669     reclist_destroy(s->reclist);
 670     nmem_destroy(s->nmem);
 671     service_destroy(s->service);
 672     yaz_mutex_destroy(&s->mutex);
 673     wrbuf_destroy(s->wrbuf);
 674 }
 675
 676 struct session *new_session(NMEM nmem, struct conf_service *service,
 677                             const char *name)
 678 {
 679     int i;
 680     struct session *session = nmem_malloc(nmem, sizeof(*session));
 681
 682     yaz_log(YLOG_DEBUG, "New Pazpar2 session");
 683
 684     session->service = service;
 685     session->relevance = 0;
 686     session->total_hits = 0;
 687     session->total_records = 0;
 688     session->number_of_warnings_unknown_elements = 0;
 689     session->number_of_warnings_unknown_metadata = 0;
 690     session->num_termlists = 0;
 691     session->reclist = 0;
 692     session->clients = 0;
 693     session->session_nmem = nmem;
 694     session->nmem = nmem_create();
 695     session->wrbuf = wrbuf_alloc();
 696     session->databases = 0;
 697     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 698     {
 699         session->watchlist[i].data = 0;
 700         session->watchlist[i].fun = 0;
 701     }
 702     session->normalize_cache = normalize_cache_create();
 703     session->mutex = 0;
 704
 705     pazpar2_mutex_create(&session->mutex, name);
 706
 707     return session;
 708 }
 709
 710 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
 711 {
 712     struct hitsbytarget *res = 0;
 713     struct client_list *l;
 714     size_t sz = 0;
 715
 716     session_enter(se);
 717     for (l = se->clients; l; l = l->next)
 718         sz++;
 719
 720     res = nmem_malloc(nmem, sizeof(*res) * sz);
 721     *count = 0;
 722     for (l = se->clients; l; l = l->next)
 723     {
 724         struct client *cl = l->client;
 725         WRBUF w = wrbuf_alloc();
 726         const char *name = session_setting_oneval(client_get_database(cl),
 727                                                   PZ_NAME);
 728
 729         res[*count].id = client_get_database(cl)->database->url;
 730         res[*count].name = *name ? name : "Unknown";
 731         res[*count].hits = client_get_hits(cl);
 732         res[*count].records = client_get_num_records(cl);
 733         res[*count].diagnostic = client_get_diagnostic(cl);
 734         res[*count].state = client_get_state_str(cl);
 735         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 736         session_settings_dump(se, client_get_database(cl), w);
 737         res[*count].settings_xml = w;
 738         (*count)++;
 739     }
 740     session_leave(se);
 741     return res;
 742 }
 743
 744 struct termlist_score **termlist(struct session *s, const char *name, int *num)
 745 {
 746     int i;
 747     struct termlist_score **tl = 0;
 748
 749     session_enter(s);
 750     for (i = 0; i < s->num_termlists; i++)
 751         if (!strcmp((const char *) s->termlists[i].name, name))
 752         {
 753             tl = termlist_highscore(s->termlists[i].termlist, num);
 754             break;
 755         }
 756     session_leave(s);
 757     return tl;
 758 }
 759
 760 #ifdef MISSING_HEADERS
 761 void report_nmem_stats(void)
 762 {
 763     size_t in_use, is_free;
 764
 765     nmem_get_memory_in_use(&in_use);
 766     nmem_get_memory_free(&is_free);
 767
 768     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
 769             (long) in_use, (long) is_free);
 770 }
 771 #endif
 772
 773 struct record_cluster *show_single_start(struct session *s, const char *id,
 774                                          struct record_cluster **prev_r,
 775                                          struct record_cluster **next_r)
 776 {
 777     struct record_cluster *r;
 778
 779     session_enter(s);
 780     reclist_enter(s->reclist);
 781     *prev_r = 0;
 782     *next_r = 0;
 783     while ((r = reclist_read_record(s->reclist)))
 784     {
 785         if (!strcmp(r->recid, id))
 786         {
 787             *next_r = reclist_read_record(s->reclist);
 788             break;
 789         }
 790         *prev_r = r;
 791     }
 792     reclist_leave(s->reclist);
 793     if (!r)
 794         session_leave(s);
 795     return r;
 796 }
 797
 798 void show_single_stop(struct session *s, struct record_cluster *rec)
 799 {
 800     session_leave(s);
 801 }
 802
 803 struct record_cluster **show_range_start(struct session *s,
 804                                          struct reclist_sortparms *sp,
 805                                          int start, int *num, int *total, Odr_int *sumhits)
 806 {
 807     struct record_cluster **recs = nmem_malloc(s->nmem, *num
 808                                                * sizeof(struct record_cluster *));
 809     struct reclist_sortparms *spp;
 810     int i;
 811 #if USE_TIMING
 812     yaz_timing_t t = yaz_timing_create();
 813 #endif
 814
 815     session_enter(s);
 816     if (!s->relevance)
 817     {
 818         *num = 0;
 819         *total = 0;
 820         *sumhits = 0;
 821         recs = 0;
 822     }
 823     else
 824     {
 825         for (spp = sp; spp; spp = spp->next)
 826             if (spp->type == Metadata_sortkey_relevance)
 827             {
 828                 relevance_prepare_read(s->relevance, s->reclist);
 829                 break;
 830             }
 831         reclist_sort(s->reclist, sp);
 832
 833         reclist_enter(s->reclist);
 834         *total = reclist_get_num_records(s->reclist);
 835         *sumhits = s->total_hits;
 836
 837         for (i = 0; i < start; i++)
 838             if (!reclist_read_record(s->reclist))
 839             {
 840                 *num = 0;
 841                 recs = 0;
 842                 break;
 843             }
 844
 845         for (i = 0; i < *num; i++)
 846         {
 847             struct record_cluster *r = reclist_read_record(s->reclist);
 848             if (!r)
 849             {
 850                 *num = i;
 851                 break;
 852             }
 853             recs[i] = r;
 854         }
 855         reclist_leave(s->reclist);
 856     }
 857 #if USE_TIMING
 858     yaz_timing_stop(t);
 859     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
 860             yaz_timing_get_real(t), yaz_timing_get_user(t),
 861             yaz_timing_get_sys(t));
 862     yaz_timing_destroy(&t);
 863 #endif
 864     return recs;
 865 }
 866
 867 void show_range_stop(struct session *s, struct record_cluster **recs)
 868 {
 869     session_leave(s);
 870 }
 871
 872 void statistics(struct session *se, struct statistics *stat)
 873 {
 874     struct client_list *l;
 875     int count = 0;
 876
 877     memset(stat, 0, sizeof(*stat));
 878     for (l = se->clients; l; l = l->next)
 879     {
 880         struct client *cl = l->client;
 881         if (!client_get_connection(cl))
 882             stat->num_no_connection++;
 883         switch (client_get_state(cl))
 884         {
 885         case Client_Connecting: stat->num_connecting++; break;
 886         case Client_Working: stat->num_working++; break;
 887         case Client_Idle: stat->num_idle++; break;
 888         case Client_Failed: stat->num_failed++; break;
 889         case Client_Error: stat->num_error++; break;
 890         default: break;
 891         }
 892         count++;
 893     }
 894     stat->num_hits = se->total_hits;
 895     stat->num_records = se->total_records;
 896
 897     stat->num_clients = count;
 898 }
 899
 900 static struct record_metadata *record_metadata_init(
 901     NMEM nmem, const char *value, enum conf_metadata_type type,
 902     struct _xmlAttr *attr)
 903 {
 904     struct record_metadata *rec_md = record_metadata_create(nmem);
 905     struct record_metadata_attr **attrp = &rec_md->attributes;
 906
 907     for (; attr; attr = attr->next)
 908     {
 909         if (attr->children && attr->children->content)
 910         {
 911             if (strcmp((const char *) attr->name, "type"))
 912             {  /* skip the "type" attribute.. Its value is already part of
 913                   the element in output (md-%s) and so repeating it here
 914                   is redundant */
 915                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
 916                 (*attrp)->name =
 917                     nmem_strdup(nmem, (const char *) attr->name);
 918                 (*attrp)->value =
 919                     nmem_strdup(nmem, (const char *) attr->children->content);
 920                 attrp = &(*attrp)->next;
 921             }
 922         }
 923     }
 924     *attrp = 0;
 925
 926     if (type == Metadata_type_generic)
 927     {
 928         char *p = nmem_strdup(nmem, value);
 929
 930         p = normalize7bit_generic(p, " ,/.:([");
 931
 932         rec_md->data.text.disp = p;
 933         rec_md->data.text.sort = 0;
 934     }
 935     else if (type == Metadata_type_year || type == Metadata_type_date)
 936     {
 937         int first, last;
 938         int longdate = 0;
 939
 940         if (type == Metadata_type_date)
 941             longdate = 1;
 942         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
 943             return 0;
 944
 945         rec_md->data.number.min = first;
 946         rec_md->data.number.max = last;
 947     }
 948     else
 949         return 0;
 950     return rec_md;
 951 }
 952
 953 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
 954                                  struct conf_service *service, WRBUF norm_wr)
 955 {
 956     xmlNode *n;
 957     int no_found = 0;
 958     for (n = root->children; n; n = n->next)
 959     {
 960         if (n->type != XML_ELEMENT_NODE)
 961             continue;
 962         if (!strcmp((const char *) n->name, "metadata"))
 963         {
 964             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
 965             if (!strcmp(name, (const char *) type))
 966             {
 967                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
 968                 if (value)
 969                 {
 970                     const char *norm_str;
 971                     pp2_relevance_token_t prt =
 972                         pp2_relevance_tokenize(service->mergekey_pct);
 973
 974                     pp2_relevance_first(prt, (const char *) value, 0);
 975                     if (wrbuf_len(norm_wr) > 0)
 976                         wrbuf_puts(norm_wr, " ");
 977                     wrbuf_puts(norm_wr, name);
 978                     while ((norm_str =
 979                             pp2_relevance_token_next(prt)))
 980                     {
 981                         if (*norm_str)
 982                         {
 983                             wrbuf_puts(norm_wr, " ");
 984                             wrbuf_puts(norm_wr, norm_str);
 985                         }
 986                     }
 987                     xmlFree(value);
 988                     pp2_relevance_token_destroy(prt);
 989                     no_found++;
 990                 }
 991             }
 992             xmlFree(type);
 993         }
 994     }
 995     return no_found;
 996 }
 997
 998 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
 999                                 struct conf_service *service, NMEM nmem)
1000 {
1001     char *mergekey_norm = 0;
1002     xmlNode *root = xmlDocGetRootElement(doc);
1003     WRBUF norm_wr = wrbuf_alloc();
1004
1005     /* consider mergekey from XSL first */
1006     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1007     if (mergekey)
1008     {
1009         const char *norm_str;
1010         pp2_relevance_token_t prt =
1011             pp2_relevance_tokenize(service->mergekey_pct);
1012
1013         pp2_relevance_first(prt, (const char *) mergekey, 0);
1014         while ((norm_str = pp2_relevance_token_next(prt)))
1015         {
1016             if (*norm_str)
1017             {
1018                 if (wrbuf_len(norm_wr))
1019                     wrbuf_puts(norm_wr, " ");
1020                 wrbuf_puts(norm_wr, norm_str);
1021             }
1022         }
1023         pp2_relevance_token_destroy(prt);
1024         xmlFree(mergekey);
1025     }
1026     else
1027     {
1028         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1029         int field_id;
1030         for (field_id = 0; field_id < service->num_metadata; field_id++)
1031         {
1032             struct conf_metadata *ser_md = &service->metadata[field_id];
1033             if (ser_md->mergekey != Metadata_mergekey_no)
1034             {
1035                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1036                                               service, norm_wr);
1037                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1038                 {
1039                     /* no mergekey on this one and it is required..
1040                        Generate unique key instead */
1041                     wrbuf_rewind(norm_wr);
1042                     break;
1043                 }
1044             }
1045         }
1046     }
1047
1048     /* generate unique key if none is not generated already or is empty */
1049     if (wrbuf_len(norm_wr) == 0)
1050     {
1051         wrbuf_printf(norm_wr, "%s-%d",
1052                      client_get_database(cl)->database->url, record_no);
1053     }
1054     if (wrbuf_len(norm_wr) > 0)
1055         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1056     wrbuf_destroy(norm_wr);
1057     return mergekey_norm;
1058 }
1059
1060 /** \brief see if metadata for pz:recordfilter exists
1061     \param root xml root element of normalized record
1062     \param sdb session database for client
1063     \retval 0 if there is no metadata for pz:recordfilter
1064     \retval 1 if there is metadata for pz:recordfilter
1065
1066     If there is no pz:recordfilter defined, this function returns 1
1067     as well.
1068 */
1069
1070 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1071 {
1072     int match = 0;
1073     xmlNode *n;
1074     const char *s;
1075     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1076
1077     if (!s || !*s)
1078         return 1;
1079
1080     for (n = root->children; n; n = n->next)
1081     {
1082         if (n->type != XML_ELEMENT_NODE)
1083             continue;
1084         if (!strcmp((const char *) n->name, "metadata"))
1085         {
1086             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1087             if (type)
1088             {
1089                 size_t len;
1090                 const char *eq = strchr(s, '~');
1091                 if (eq)
1092                     len = eq - s;
1093                 else
1094                     len = strlen(s);
1095                 if (len == strlen((const char *)type) &&
1096                     !memcmp((const char *) type, s, len))
1097                 {
1098                     xmlChar *value = xmlNodeGetContent(n);
1099                     if (value && *value)
1100                     {
1101                         if (!eq || strstr((const char *) value, eq+1))
1102                             match = 1;
1103                     }
1104                     xmlFree(value);
1105                 }
1106                 xmlFree(type);
1107             }
1108         }
1109     }
1110     return match;
1111 }
1112
1113
1114 static int ingest_to_cluster(struct client *cl,
1115                              xmlDoc *xdoc,
1116                              xmlNode *root,
1117                              int record_no,
1118                              const char *mergekey_norm);
1119
1120 /** \brief ingest XML record
1121     \param cl client holds the result set for record
1122     \param rec record buffer (0 terminated)
1123     \param record_no record position (1, 2, ..)
1124     \retval 0 OK
1125     \retval -1 failure
1126 */
1127 int ingest_record(struct client *cl, const char *rec,
1128                   int record_no, NMEM nmem)
1129 {
1130     struct session *se = client_get_session(cl);
1131     int ret;
1132     struct session_database *sdb = client_get_database(cl);
1133     struct conf_service *service = se->service;
1134     xmlDoc *xdoc = normalize_record(sdb, service, rec, nmem);
1135     xmlNode *root;
1136     const char *mergekey_norm;
1137
1138     if (!xdoc)
1139         return -1;
1140
1141     root = xmlDocGetRootElement(xdoc);
1142
1143     if (!check_record_filter(root, sdb))
1144     {
1145         yaz_log(YLOG_WARN, "Filtered out record no %d from %s", record_no,
1146                 sdb->database->url);
1147         xmlFreeDoc(xdoc);
1148         return -1;
1149     }
1150
1151     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1152     if (!mergekey_norm)
1153     {
1154         yaz_log(YLOG_WARN, "Got no mergekey");
1155         xmlFreeDoc(xdoc);
1156         return -1;
1157     }
1158     session_enter(se);
1159     ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1160     session_leave(se);
1161
1162     xmlFreeDoc(xdoc);
1163     return ret;
1164 }
1165
1166 static int ingest_to_cluster(struct client *cl,
1167                              xmlDoc *xdoc,
1168                              xmlNode *root,
1169                              int record_no,
1170                              const char *mergekey_norm)
1171 {
1172     xmlNode *n;
1173     xmlChar *type = 0;
1174     xmlChar *value = 0;
1175     struct session_database *sdb = client_get_database(cl);
1176     struct session *se = client_get_session(cl);
1177     struct conf_service *service = se->service;
1178     struct record *record = record_create(se->nmem,
1179                                           service->num_metadata,
1180                                           service->num_sortkeys, cl,
1181                                           record_no);
1182     struct record_cluster *cluster = reclist_insert(se->reclist,
1183                                                     service,
1184                                                     record,
1185                                                     mergekey_norm,
1186                                                     &se->total_merged);
1187     if (!cluster)
1188         return -1;
1189     if (global_parameters.dump_records)
1190         yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1191                 sdb->database->url, record_no);
1192     relevance_newrec(se->relevance, cluster);
1193
1194     // now parsing XML record and adding data to cluster or record metadata
1195     for (n = root->children; n; n = n->next)
1196     {
1197         pp2_relevance_token_t prt;
1198         if (type)
1199             xmlFree(type);
1200         if (value)
1201             xmlFree(value);
1202         type = value = 0;
1203
1204         if (n->type != XML_ELEMENT_NODE)
1205             continue;
1206         if (!strcmp((const char *) n->name, "metadata"))
1207         {
1208             struct conf_metadata *ser_md = 0;
1209             struct conf_sortkey *ser_sk = 0;
1210             struct record_metadata **wheretoput = 0;
1211             struct record_metadata *rec_md = 0;
1212             int md_field_id = -1;
1213             int sk_field_id = -1;
1214
1215             type = xmlGetProp(n, (xmlChar *) "type");
1216             value = xmlNodeListGetString(xdoc, n->children, 1);
1217
1218             if (!type || !value || !*value)
1219                 continue;
1220
1221             md_field_id
1222                 = conf_service_metadata_field_id(service, (const char *) type);
1223             if (md_field_id < 0)
1224             {
1225                 if (se->number_of_warnings_unknown_metadata == 0)
1226                 {
1227                     yaz_log(YLOG_WARN,
1228                             "Ignoring unknown metadata element: %s", type);
1229                 }
1230                 se->number_of_warnings_unknown_metadata++;
1231                 continue;
1232             }
1233
1234             ser_md = &service->metadata[md_field_id];
1235
1236             if (ser_md->sortkey_offset >= 0){
1237                 sk_field_id = ser_md->sortkey_offset;
1238                 ser_sk = &service->sortkeys[sk_field_id];
1239             }
1240
1241             // non-merged metadata
1242             rec_md = record_metadata_init(se->nmem, (const char *) value,
1243                                           ser_md->type, n->properties);
1244             if (!rec_md)
1245             {
1246                 yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
1247                         value, type);
1248                 continue;
1249             }
1250             wheretoput = &record->metadata[md_field_id];
1251             while (*wheretoput)
1252                 wheretoput = &(*wheretoput)->next;
1253             *wheretoput = rec_md;
1254
1255             // merged metadata
1256             rec_md = record_metadata_init(se->nmem, (const char *) value,
1257                                           ser_md->type, 0);
1258             wheretoput = &cluster->metadata[md_field_id];
1259
1260             // and polulate with data:
1261             // assign cluster or record based on merge action
1262             if (ser_md->merge == Metadata_merge_unique)
1263             {
1264                 struct record_metadata *mnode;
1265                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1266                     if (!strcmp((const char *) mnode->data.text.disp,
1267                                 rec_md->data.text.disp))
1268                         break;
1269                 if (!mnode)
1270                 {
1271                     rec_md->next = *wheretoput;
1272                     *wheretoput = rec_md;
1273                 }
1274             }
1275             else if (ser_md->merge == Metadata_merge_longest)
1276             {
1277                 if (!*wheretoput
1278                     || strlen(rec_md->data.text.disp)
1279                     > strlen((*wheretoput)->data.text.disp))
1280                 {
1281                     *wheretoput = rec_md;
1282                     if (ser_sk)
1283                     {
1284                         const char *sort_str = 0;
1285                         int skip_article =
1286                             ser_sk->type == Metadata_sortkey_skiparticle;
1287
1288                         if (!cluster->sortkeys[sk_field_id])
1289                             cluster->sortkeys[sk_field_id] =
1290                                 nmem_malloc(se->nmem,
1291                                             sizeof(union data_types));
1292
1293                         prt = pp2_relevance_tokenize(service->sort_pct);
1294
1295                         pp2_relevance_first(prt, rec_md->data.text.disp,
1296                                             skip_article);
1297
1298                         pp2_relevance_token_next(prt);
1299
1300                         sort_str = pp2_get_sort(prt);
1301
1302                         cluster->sortkeys[sk_field_id]->text.disp =
1303                             rec_md->data.text.disp;
1304                         if (!sort_str)
1305                         {
1306                             sort_str = rec_md->data.text.disp;
1307                             yaz_log(YLOG_WARN,
1308                                     "Could not make sortkey. Bug #1858");
1309                         }
1310                         cluster->sortkeys[sk_field_id]->text.sort =
1311                             nmem_strdup(se->nmem, sort_str);
1312 #if 0
1313                         yaz_log(YLOG_LOG, "text disp=%s",
1314                                 cluster->sortkeys[sk_field_id]->text.disp);
1315                         yaz_log(YLOG_LOG, "text sort=%s",
1316                                 cluster->sortkeys[sk_field_id]->text.sort);
1317 #endif
1318                         pp2_relevance_token_destroy(prt);
1319                     }
1320                 }
1321             }
1322             else if (ser_md->merge == Metadata_merge_all)
1323             {
1324                 rec_md->next = *wheretoput;
1325                 *wheretoput = rec_md;
1326             }
1327             else if (ser_md->merge == Metadata_merge_range)
1328             {
1329                 if (!*wheretoput)
1330                 {
1331                     *wheretoput = rec_md;
1332                     if (ser_sk)
1333                         cluster->sortkeys[sk_field_id]
1334                             = &rec_md->data;
1335                 }
1336                 else
1337                 {
1338                     int this_min = rec_md->data.number.min;
1339                     int this_max = rec_md->data.number.max;
1340                     if (this_min < (*wheretoput)->data.number.min)
1341                         (*wheretoput)->data.number.min = this_min;
1342                     if (this_max > (*wheretoput)->data.number.max)
1343                         (*wheretoput)->data.number.max = this_max;
1344                 }
1345             }
1346
1347
1348             // ranking of _all_ fields enabled ...
1349             if (ser_md->rank)
1350                 relevance_countwords(se->relevance, cluster,
1351                                      (char *) value, ser_md->rank,
1352                                      ser_md->name);
1353
1354             // construct facets ...
1355             if (ser_md->termlist)
1356             {
1357                 if (ser_md->type == Metadata_type_year)
1358                 {
1359                     char year[64];
1360                     sprintf(year, "%d", rec_md->data.number.max);
1361                     add_facet(se, (char *) type, year);
1362                     if (rec_md->data.number.max != rec_md->data.number.min)
1363                     {
1364                         sprintf(year, "%d", rec_md->data.number.min);
1365                         add_facet(se, (char *) type, year);
1366                     }
1367                 }
1368                 else
1369                     add_facet(se, (char *) type, (char *) value);
1370             }
1371
1372             // cleaning up
1373             xmlFree(type);
1374             xmlFree(value);
1375             type = value = 0;
1376         }
1377         else
1378         {
1379             if (se->number_of_warnings_unknown_elements == 0)
1380                 yaz_log(YLOG_WARN,
1381                         "Unexpected element in internal record: %s", n->name);
1382             se->number_of_warnings_unknown_elements++;
1383         }
1384     }
1385     if (type)
1386         xmlFree(type);
1387     if (value)
1388         xmlFree(value);
1389
1390     relevance_donerecord(se->relevance, cluster);
1391     se->total_records++;
1392
1393     return 0;
1394 }
1395
1396 /*
1397  * Local variables:
1398  * c-basic-offset: 4
1399  * c-file-style: "Stroustrup"
1400  * indent-tabs-mode: nil
1401  * End:
1402  * vim: shiftwidth=4 tabstop=8 expandtab
1403  */
1404