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