src/client.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 client.c
  21     \brief Z39.50 client
  22 */
  23
  24 #if HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27 #include <pthread.h>
  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 <assert.h>
  39
  40 #include <yaz/marcdisp.h>
  41 #include <yaz/comstack.h>
  42 #include <yaz/tcpip.h>
  43 #include <yaz/proto.h>
  44 #include <yaz/readconf.h>
  45 #include <yaz/pquery.h>
  46 #include <yaz/otherinfo.h>
  47 #include <yaz/yaz-util.h>
  48 #include <yaz/nmem.h>
  49 #include <yaz/query-charset.h>
  50 #include <yaz/querytowrbuf.h>
  51 #include <yaz/oid_db.h>
  52 #include <yaz/diagbib1.h>
  53 #include <yaz/snprintf.h>
  54 #include <yaz/rpn2cql.h>
  55
  56 #define USE_TIMING 0
  57 #if USE_TIMING
  58 #include <yaz/timing.h>
  59 #endif
  60
  61 #include "ppmutex.h"
  62 #include "session.h"
  63 #include "parameters.h"
  64 #include "client.h"
  65 #include "connection.h"
  66 #include "settings.h"
  67 #include "relevance.h"
  68 #include "incref.h"
  69
  70 /* client counting (1) , disable client counting (0) */
  71 #if 1
  72 static YAZ_MUTEX g_mutex = 0;
  73 static int no_clients = 0;
  74
  75 static void client_use(int delta)
  76 {
  77     if (!g_mutex)
  78         yaz_mutex_create(&g_mutex);
  79     yaz_mutex_enter(g_mutex);
  80     no_clients += delta;
  81     yaz_mutex_leave(g_mutex);
  82     yaz_log(YLOG_LOG, "%s clients=%d", delta > 0 ? "INC" : "DEC", no_clients);
  83 }
  84 #else
  85 #define client_use(x)
  86 #endif
  87
  88 /** \brief Represents client state for a connection to one search target */
  89 struct client {
  90     struct session_database *database;
  91     struct connection *connection;
  92     struct session *session;
  93     char *pquery; // Current search
  94     char *cqlquery; // used for SRU targets only
  95     Odr_int hits;
  96     int record_offset;
  97     int maxrecs;
  98     int startrecs;
  99     int diagnostic;
 100     enum client_state state;
 101     struct show_raw *show_raw;
 102     ZOOM_resultset resultset;
 103     YAZ_MUTEX mutex;
 104     int ref_count;
 105 };
 106
 107 struct show_raw {
 108     int active; // whether this request has been sent to the server
 109     int position;
 110     int binary;
 111     char *syntax;
 112     char *esn;
 113     void (*error_handler)(void *data, const char *addinfo);
 114     void (*record_handler)(void *data, const char *buf, size_t sz);
 115     void *data;
 116     struct show_raw *next;
 117 };
 118
 119 static const char *client_states[] = {
 120     "Client_Connecting",
 121     "Client_Idle",
 122     "Client_Working",
 123     "Client_Error",
 124     "Client_Failed",
 125     "Client_Disconnected"
 126 };
 127
 128 const char *client_get_state_str(struct client *cl)
 129 {
 130     return client_states[cl->state];
 131 }
 132
 133 enum client_state client_get_state(struct client *cl)
 134 {
 135     return cl->state;
 136 }
 137
 138 void client_set_state(struct client *cl, enum client_state st)
 139 {
 140     cl->state = st;
 141     /* no need to check for all client being non-active if this one
 142        already is. Note that session_active_clients also LOCKS session */
 143 #if 0
 144     if (!client_is_active(cl) && cl->session)
 145     {
 146         int no_active = session_active_clients(cl->session);
 147         if (no_active == 0)
 148             session_alert_watch(cl->session, SESSION_WATCH_SHOW);
 149     }
 150 #endif
 151 }
 152
 153 static void client_show_raw_error(struct client *cl, const char *addinfo);
 154
 155 struct connection *client_get_connection(struct client *cl)
 156 {
 157     return cl->connection;
 158 }
 159
 160 struct session_database *client_get_database(struct client *cl)
 161 {
 162     return cl->database;
 163 }
 164
 165 struct session *client_get_session(struct client *cl)
 166 {
 167     return cl->session;
 168 }
 169
 170 const char *client_get_pquery(struct client *cl)
 171 {
 172     return cl->pquery;
 173 }
 174
 175 static void client_send_raw_present(struct client *cl);
 176 static int nativesyntax_to_type(struct session_database *sdb, char *type,
 177                                 ZOOM_record rec);
 178
 179 static void client_show_immediate(
 180     ZOOM_resultset resultset, struct session_database *sdb, int position,
 181     void *data,
 182     void (*error_handler)(void *data, const char *addinfo),
 183     void (*record_handler)(void *data, const char *buf, size_t sz),
 184     int binary)
 185 {
 186     ZOOM_record rec = 0;
 187     char type[80];
 188     const char *buf;
 189     int len;
 190
 191     if (!resultset)
 192     {
 193         error_handler(data, "no resultset");
 194         return;
 195     }
 196     rec = ZOOM_resultset_record(resultset, position-1);
 197     if (!rec)
 198     {
 199         error_handler(data, "no record");
 200         return;
 201     }
 202     if (binary)
 203         strcpy(type, "raw");
 204     else
 205         nativesyntax_to_type(sdb, type, rec);
 206     buf = ZOOM_record_get(rec, type, &len);
 207     if (!buf)
 208     {
 209         error_handler(data, "no record");
 210         return;
 211     }
 212     record_handler(data, buf, len);
 213 }
 214
 215
 216 int client_show_raw_begin(struct client *cl, int position,
 217                           const char *syntax, const char *esn,
 218                           void *data,
 219                           void (*error_handler)(void *data, const char *addinfo),
 220                           void (*record_handler)(void *data, const char *buf,
 221                                                  size_t sz),
 222                           int binary)
 223 {
 224     if (syntax == 0 && esn == 0)
 225         client_show_immediate(cl->resultset, client_get_database(cl),
 226                               position, data,
 227                               error_handler, record_handler,
 228                               binary);
 229     else
 230     {
 231         struct show_raw *rr, **rrp;
 232
 233         if (!cl->connection)
 234             return -1;
 235
 236
 237         rr = xmalloc(sizeof(*rr));
 238         rr->position = position;
 239         rr->active = 0;
 240         rr->data = data;
 241         rr->error_handler = error_handler;
 242         rr->record_handler = record_handler;
 243         rr->binary = binary;
 244         if (syntax)
 245             rr->syntax = xstrdup(syntax);
 246         else
 247             rr->syntax = 0;
 248         if (esn)
 249             rr->esn = xstrdup(esn);
 250         else
 251             rr->esn = 0;
 252         rr->next = 0;
 253
 254         for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
 255             ;
 256         *rrp = rr;
 257
 258         if (cl->state == Client_Failed)
 259         {
 260             client_show_raw_error(cl, "client failed");
 261         }
 262         else if (cl->state == Client_Disconnected)
 263         {
 264             client_show_raw_error(cl, "client disconnected");
 265         }
 266         else
 267         {
 268             client_send_raw_present(cl);
 269         }
 270     }
 271     return 0;
 272 }
 273
 274 static void client_show_raw_delete(struct show_raw *r)
 275 {
 276     xfree(r->syntax);
 277     xfree(r->esn);
 278     xfree(r);
 279 }
 280
 281 void client_show_raw_remove(struct client *cl, void *data)
 282 {
 283     struct show_raw *rr = data;
 284     struct show_raw **rrp = &cl->show_raw;
 285     while (*rrp != rr)
 286         rrp = &(*rrp)->next;
 287     if (*rrp)
 288     {
 289         *rrp = rr->next;
 290         client_show_raw_delete(rr);
 291     }
 292 }
 293
 294 void client_show_raw_dequeue(struct client *cl)
 295 {
 296     struct show_raw *rr = cl->show_raw;
 297
 298     cl->show_raw = rr->next;
 299     client_show_raw_delete(rr);
 300 }
 301
 302 static void client_show_raw_error(struct client *cl, const char *addinfo)
 303 {
 304     while (cl->show_raw)
 305     {
 306         cl->show_raw->error_handler(cl->show_raw->data, addinfo);
 307         client_show_raw_dequeue(cl);
 308     }
 309 }
 310
 311 static void client_send_raw_present(struct client *cl)
 312 {
 313     struct session_database *sdb = client_get_database(cl);
 314     struct connection *co = client_get_connection(cl);
 315     ZOOM_resultset set = cl->resultset;
 316
 317     int offset = cl->show_raw->position;
 318     const char *syntax = 0;
 319     const char *elements = 0;
 320
 321     assert(cl->show_raw);
 322     assert(set);
 323
 324     yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
 325             client_get_url(cl), 1, offset);
 326
 327     if (cl->show_raw->syntax)
 328         syntax = cl->show_raw->syntax;
 329     else
 330         syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 331     ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
 332
 333     if (cl->show_raw->esn)
 334         elements = cl->show_raw->esn;
 335     else
 336         elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 337     if (elements && *elements)
 338         ZOOM_resultset_option_set(set, "elementSetName", elements);
 339
 340     ZOOM_resultset_records(set, 0, offset-1, 1);
 341     cl->show_raw->active = 1;
 342
 343     connection_continue(co);
 344 }
 345
 346 static int nativesyntax_to_type(struct session_database *sdb, char *type,
 347                                 ZOOM_record rec)
 348 {
 349     const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
 350
 351     if (s && *s)
 352     {
 353         if (!strncmp(s, "iso2709", 7))
 354         {
 355             const char *cp = strchr(s, ';');
 356             yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
 357         }
 358         else if (!strncmp(s, "xml", 3))
 359         {
 360             strcpy(type, "xml");
 361         }
 362         else if (!strncmp(s, "txml", 4))
 363         {
 364             const char *cp = strchr(s, ';');
 365             yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
 366         }
 367         else
 368             return -1;
 369         return 0;
 370     }
 371     else  /* attempt to deduce structure */
 372     {
 373         const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
 374         if (syntax)
 375         {
 376             if (!strcmp(syntax, "XML"))
 377             {
 378                 strcpy(type, "xml");
 379                 return 0;
 380             }
 381             else if (!strcmp(syntax, "TXML"))
 382                 {
 383                     strcpy(type, "txml");
 384                     return 0;
 385                 }
 386             else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
 387             {
 388                 strcpy(type, "xml; charset=marc8-s");
 389                 return 0;
 390             }
 391             else return -1;
 392         }
 393         else return -1;
 394     }
 395 }
 396
 397 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
 398 {
 399     const char *buf;
 400     int len;
 401     char type[80];
 402
 403     if (cl->show_raw->binary)
 404         strcpy(type, "raw");
 405     else
 406     {
 407         struct session_database *sdb = client_get_database(cl);
 408         nativesyntax_to_type(sdb, type, rec);
 409     }
 410
 411     buf = ZOOM_record_get(rec, type, &len);
 412     cl->show_raw->record_handler(cl->show_raw->data,  buf, len);
 413     client_show_raw_dequeue(cl);
 414 }
 415
 416 void client_search_response(struct client *cl)
 417 {
 418     struct connection *co = cl->connection;
 419     struct session *se = cl->session;
 420     ZOOM_connection link = connection_get_link(co);
 421     ZOOM_resultset resultset = cl->resultset;
 422     const char *error, *addinfo = 0;
 423
 424     if (ZOOM_connection_error(link, &error, &addinfo))
 425     {
 426         cl->hits = 0;
 427         client_set_state(cl, Client_Error);
 428         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 429                 error, addinfo, client_get_url(cl));
 430     }
 431     else
 432     {
 433         cl->record_offset = cl->startrecs;
 434         cl->hits = ZOOM_resultset_size(resultset);
 435         if (se)
 436             se->total_hits += cl->hits;
 437     }
 438 }
 439
 440 void client_got_records(struct client *cl)
 441 {
 442     if (cl->session)
 443     {
 444         session_alert_watch(cl->session, SESSION_WATCH_SHOW);
 445         session_alert_watch(cl->session, SESSION_WATCH_RECORD);
 446     }
 447 }
 448
 449 void client_record_response(struct client *cl)
 450 {
 451     struct connection *co = cl->connection;
 452     ZOOM_connection link = connection_get_link(co);
 453     ZOOM_resultset resultset = cl->resultset;
 454     const char *error, *addinfo;
 455
 456     if (ZOOM_connection_error(link, &error, &addinfo))
 457     {
 458         client_set_state(cl, Client_Error);
 459         yaz_log(YLOG_WARN, "Search error %s (%s): %s",
 460             error, addinfo, client_get_url(cl));
 461     }
 462     else
 463     {
 464         ZOOM_record rec = 0;
 465         const char *msg, *addinfo;
 466
 467         if (cl->show_raw && cl->show_raw->active)
 468         {
 469             if ((rec = ZOOM_resultset_record(resultset,
 470                                              cl->show_raw->position-1)))
 471             {
 472                 cl->show_raw->active = 0;
 473                 ingest_raw_record(cl, rec);
 474             }
 475             else
 476             {
 477                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 478                         cl->show_raw->position-1);
 479             }
 480         }
 481         else
 482         {
 483             int offset = cl->record_offset;
 484             if ((rec = ZOOM_resultset_record(resultset, offset)))
 485             {
 486                 cl->record_offset++;
 487                 if (cl->session == 0)
 488                     ;
 489                 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
 490                 {
 491                     yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
 492                             msg, addinfo, client_get_url(cl),
 493                             cl->record_offset);
 494                 }
 495                 else
 496                 {
 497                     struct session_database *sdb = client_get_database(cl);
 498                     NMEM nmem = nmem_create();
 499                     const char *xmlrec;
 500                     char type[80];
 501
 502                     if (nativesyntax_to_type(sdb, type, rec))
 503                         yaz_log(YLOG_WARN, "Failed to determine record type");
 504                     xmlrec = ZOOM_record_get(rec, type, NULL);
 505                     if (!xmlrec)
 506                         yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
 507                                 client_get_url(cl));
 508                     else
 509                     {
 510                         if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
 511                             yaz_log(YLOG_WARN, "Failed to ingest from %s",
 512                                     client_get_url(cl));
 513                     }
 514                     nmem_destroy(nmem);
 515                 }
 516             }
 517             else
 518             {
 519                 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
 520                         offset);
 521             }
 522         }
 523     }
 524 }
 525
 526 void client_start_search(struct client *cl)
 527 {
 528     struct session_database *sdb = client_get_database(cl);
 529     struct connection *co = client_get_connection(cl);
 530     ZOOM_connection link = connection_get_link(co);
 531     ZOOM_resultset rs;
 532     char *databaseName = sdb->database->databases[0];
 533     const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
 534     const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
 535     const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
 536     const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
 537     const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
 538     const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
 539     const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
 540     char maxrecs_str[24], startrecs_str[24];
 541
 542     assert(link);
 543
 544     cl->hits = -1;
 545     cl->record_offset = 0;
 546     cl->diagnostic = 0;
 547     client_set_state(cl, Client_Working);
 548
 549     if (*opt_piggyback)
 550         ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
 551     else
 552         ZOOM_connection_option_set(link, "piggyback", "1");
 553     if (*opt_queryenc)
 554         ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
 555     if (*opt_sru && *opt_elements)
 556         ZOOM_connection_option_set(link, "schema", opt_elements);
 557     else if (*opt_elements)
 558         ZOOM_connection_option_set(link, "elementSetName", opt_elements);
 559     if (*opt_requestsyn)
 560         ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
 561
 562     if (!*opt_maxrecs)
 563     {
 564         sprintf(maxrecs_str, "%d", cl->maxrecs);
 565         opt_maxrecs = maxrecs_str;
 566     }
 567     ZOOM_connection_option_set(link, "count", opt_maxrecs);
 568
 569
 570     if (atoi(opt_maxrecs) > 20)
 571         ZOOM_connection_option_set(link, "presentChunk", "20");
 572     else
 573         ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
 574
 575     sprintf(startrecs_str, "%d", cl->startrecs);
 576     ZOOM_connection_option_set(link, "start", startrecs_str);
 577
 578     if (databaseName)
 579         ZOOM_connection_option_set(link, "databaseName", databaseName);
 580
 581     if (cl->cqlquery)
 582     {
 583         ZOOM_query q = ZOOM_query_create();
 584         yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
 585         ZOOM_query_cql(q, cl->cqlquery);
 586         if (*opt_sort)
 587             ZOOM_query_sortby(q, opt_sort);
 588         rs = ZOOM_connection_search(link, q);
 589         ZOOM_query_destroy(q);
 590     }
 591     else
 592     {
 593         yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
 594         rs = ZOOM_connection_search_pqf(link, cl->pquery);
 595     }
 596     ZOOM_resultset_destroy(cl->resultset);
 597     cl->resultset = rs;
 598     connection_continue(co);
 599 }
 600
 601 struct client *client_create(void)
 602 {
 603     struct client *r = xmalloc(sizeof(*r));
 604     r->maxrecs = 100;
 605     r->startrecs = 0;
 606     r->pquery = 0;
 607     r->cqlquery = 0;
 608     r->database = 0;
 609     r->connection = 0;
 610     r->session = 0;
 611     r->hits = 0;
 612     r->record_offset = 0;
 613     r->diagnostic = 0;
 614     r->state = Client_Disconnected;
 615     r->show_raw = 0;
 616     r->resultset = 0;
 617     r->mutex = 0;
 618     pazpar2_mutex_create(&r->mutex, "client");
 619
 620     r->ref_count = 1;
 621     client_use(1);
 622
 623     return r;
 624 }
 625
 626 void client_incref(struct client *c)
 627 {
 628     pazpar2_incref(&c->ref_count, c->mutex);
 629     yaz_log(YLOG_LOG, "client_incref c=%p %s cnt=%d",
 630             c, client_get_url(c), c->ref_count);
 631 }
 632
 633 int client_destroy(struct client *c)
 634 {
 635     if (c)
 636     {
 637         yaz_log(YLOG_LOG, "client_destroy c=%p %s cnt=%d",
 638                 c, client_get_url(c), c->ref_count);
 639         if (!pazpar2_decref(&c->ref_count, c->mutex))
 640         {
 641             xfree(c->pquery);
 642             c->pquery = 0;
 643             xfree(c->cqlquery);
 644             c->cqlquery = 0;
 645             assert(!c->connection);
 646             assert(!c->resultset);
 647
 648             yaz_mutex_destroy(&c->mutex);
 649             xfree(c);
 650             client_use(-1);
 651             return 1;
 652         }
 653     }
 654     return 0;
 655 }
 656
 657 void client_set_connection(struct client *cl, struct connection *con)
 658 {
 659     if (cl->resultset)
 660     {
 661         ZOOM_resultset_destroy(cl->resultset);
 662         cl->resultset = 0;
 663     }
 664     if (con)
 665     {
 666         assert(cl->connection == 0);
 667         cl->connection = con;
 668         client_incref(cl);
 669     }
 670     else
 671     {
 672         cl->connection = con;
 673         client_destroy(cl);
 674     }
 675 }
 676
 677 void client_disconnect(struct client *cl)
 678 {
 679     if (cl->state != Client_Idle)
 680         client_set_state(cl, Client_Disconnected);
 681     client_set_connection(cl, 0);
 682 }
 683
 684 // Extract terms from query into null-terminated termlist
 685 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
 686 {
 687     int num = 0;
 688
 689     pull_terms(nmem, query, termlist, &num);
 690     termlist[num] = 0;
 691 }
 692
 693 // Initialize CCL map for a target
 694 static CCL_bibset prepare_cclmap(struct client *cl)
 695 {
 696     struct session_database *sdb = client_get_database(cl);
 697     struct setting *s;
 698     CCL_bibset res;
 699
 700     if (!sdb->settings)
 701         return 0;
 702     res = ccl_qual_mk();
 703     for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
 704     {
 705         char *p = strchr(s->name + 3, ':');
 706         if (!p)
 707         {
 708             yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
 709             ccl_qual_rm(&res);
 710             return 0;
 711         }
 712         p++;
 713         ccl_qual_fitem(res, s->value, p);
 714     }
 715     return res;
 716 }
 717
 718 // returns a xmalloced CQL query corresponding to the pquery in client
 719 static char *make_cqlquery(struct client *cl)
 720 {
 721     cql_transform_t cqlt = cql_transform_create();
 722     Z_RPNQuery *zquery;
 723     char *r;
 724     WRBUF wrb = wrbuf_alloc();
 725     int status;
 726     ODR odr_out = odr_createmem(ODR_ENCODE);
 727
 728     zquery = p_query_rpn(odr_out, cl->pquery);
 729     yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
 730     if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
 731     {
 732         yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
 733         r = 0;
 734     }
 735     else
 736     {
 737         r = xstrdup(wrbuf_cstr(wrb));
 738     }
 739     wrbuf_destroy(wrb);
 740     odr_destroy(odr_out);
 741     cql_transform_close(cqlt);
 742     return r;
 743 }
 744
 745 // Parse the query given the settings specific to this client
 746 int client_parse_query(struct client *cl, const char *query)
 747 {
 748     struct session *se = client_get_session(cl);
 749     struct session_database *sdb = client_get_database(cl);
 750     struct ccl_rpn_node *cn;
 751     int cerror, cpos;
 752     CCL_bibset ccl_map = prepare_cclmap(cl);
 753     const char *sru = session_setting_oneval(sdb, PZ_SRU);
 754     const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
 755     const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
 756
 757     if (!ccl_map)
 758         return -1;
 759
 760     cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
 761     ccl_qual_rm(&ccl_map);
 762     if (!cn)
 763     {
 764         client_set_state(cl, Client_Error);
 765         yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
 766                 query,
 767                 client_get_database(cl)->database->url);
 768         return -1;
 769     }
 770     wrbuf_rewind(se->wrbuf);
 771     if (*pqf_prefix)
 772     {
 773         wrbuf_puts(se->wrbuf, pqf_prefix);
 774         wrbuf_puts(se->wrbuf, " ");
 775     }
 776     if (!pqf_strftime || !*pqf_strftime)
 777         ccl_pquery(se->wrbuf, cn);
 778     else
 779     {
 780         time_t cur_time = time(0);
 781         struct tm *tm =  localtime(&cur_time);
 782         char tmp_str[300];
 783         const char *cp = tmp_str;
 784
 785         /* see man strftime(3) for things .. In particular %% gets converted
 786          to %.. And That's our original query .. */
 787         strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
 788         for (; *cp; cp++)
 789         {
 790             if (cp[0] == '%')
 791                 ccl_pquery(se->wrbuf, cn);
 792             else
 793                 wrbuf_putc(se->wrbuf, cp[0]);
 794         }
 795     }
 796     xfree(cl->pquery);
 797     cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
 798
 799     xfree(cl->cqlquery);
 800     if (*sru)
 801     {
 802         if (!(cl->cqlquery = make_cqlquery(cl)))
 803             return -1;
 804     }
 805     else
 806         cl->cqlquery = 0;
 807
 808     if (!se->relevance)
 809     {
 810         // Initialize relevance structure with query terms
 811         char *p[512];
 812         extract_terms(se->nmem, cn, p);
 813         se->relevance = relevance_create(
 814             se->service->relevance_pct,
 815             se->nmem, (const char **) p);
 816     }
 817
 818     ccl_rpn_delete(cn);
 819     return 0;
 820 }
 821
 822 void client_set_session(struct client *cl, struct session *se)
 823 {
 824     cl->session = se;
 825 }
 826
 827 int client_is_active(struct client *cl)
 828 {
 829     if (cl->connection && (cl->state == Client_Connecting ||
 830                            cl->state == Client_Working))
 831         return 1;
 832     return 0;
 833 }
 834
 835 Odr_int client_get_hits(struct client *cl)
 836 {
 837     return cl->hits;
 838 }
 839
 840 int client_get_num_records(struct client *cl)
 841 {
 842     return cl->record_offset;
 843 }
 844
 845 void client_set_diagnostic(struct client *cl, int diagnostic)
 846 {
 847     cl->diagnostic = diagnostic;
 848 }
 849
 850 int client_get_diagnostic(struct client *cl)
 851 {
 852     return cl->diagnostic;
 853 }
 854
 855 void client_set_database(struct client *cl, struct session_database *db)
 856 {
 857     cl->database = db;
 858 }
 859
 860 struct host *client_get_host(struct client *cl)
 861 {
 862     return client_get_database(cl)->database->host;
 863 }
 864
 865 const char *client_get_url(struct client *cl)
 866 {
 867     if (cl->database)
 868         return client_get_database(cl)->database->url;
 869     else
 870         return "NOURL";
 871 }
 872
 873 void client_set_maxrecs(struct client *cl, int v)
 874 {
 875     cl->maxrecs = v;
 876 }
 877
 878 void client_set_startrecs(struct client *cl, int v)
 879 {
 880     cl->startrecs = v;
 881 }
 882
 883 /*
 884  * Local variables:
 885  * c-basic-offset: 4
 886  * c-file-style: "Stroustrup"
 887  * indent-tabs-mode: nil
 888  * End:
 889  * vim: shiftwidth=4 tabstop=8 expandtab
 890  */
 891