client.c

Go to the documentation of this file.

/* This file is part of Pazpar2.
   Copyright (C) Index Data
 
Pazpar2 is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 2, or (at your option) any later
version.
 
Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.
 
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
*/
 
#if HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#if HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#if HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef WIN32
#include <windows.h>
#endif
#include <signal.h>
#include <assert.h>
 
#include <yaz/marcdisp.h>
#include <yaz/comstack.h>
#include <yaz/tcpip.h>
#include <yaz/proto.h>
#include <yaz/readconf.h>
#include <yaz/pquery.h>
#include <yaz/otherinfo.h>
#include <yaz/yaz-util.h>
#include <yaz/nmem.h>
#include <yaz/query-charset.h>
#include <yaz/querytowrbuf.h>
#include <yaz/oid_db.h>
#include <yaz/diagbib1.h>
#include <yaz/snprintf.h>
#include <yaz/rpn2cql.h>
#include <yaz/rpn2solr.h>
#include <yaz/gettimeofday.h>
 
#define USE_TIMING 0
#if USE_TIMING
#include <yaz/timing.h>
#endif
 
#include "ppmutex.h"
#include "session.h"
#include "parameters.h"
#include "client.h"
#include "connection.h"
#include "settings.h"
#include "relevance.h"
#include "incref.h"
 
#define XDOC_CACHE_SIZE 100
 
static YAZ_MUTEX g_mutex = 0;
static int no_clients = 0;
 
static int client_use(int delta)
{
    int clients;
    if (!g_mutex)
        yaz_mutex_create(&g_mutex);
    yaz_mutex_enter(g_mutex);
    no_clients += delta;
    clients = no_clients;
    yaz_mutex_leave(g_mutex);
    yaz_log(YLOG_DEBUG, "%s clients=%d",
            delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), clients);
    return clients;
}
 
int clients_get_count(void)
{
    return client_use(0);
}
 
struct client {
    struct session_database *database;
    struct connection *connection;
    struct session *session;
    char *pquery; // Current search
    char *cqlquery; // used for SRU targets only
    char *addinfo; // diagnostic info for most resent error
    Odr_int hits;
    int record_offset;
    int show_stat_no;
    int filtered; /* number of records ignored for local filtering */
    int ingest_failures; /* number of records where XSLT/other failed */
    int record_failures; /* number of records where ZOOM reported error */
    int maxrecs;
    int startrecs;
    int diagnostic;
    char *message;
    int preferred;
    struct suggestions *suggestions;
    enum client_state state;
    struct show_raw *show_raw;
    ZOOM_resultset resultset;
    YAZ_MUTEX mutex;
    int ref_count;
    char *id;
    facet_limits_t facet_limits;
    int same_search;
    char *sort_strategy;
    char *sort_criteria;
    xmlDoc **xdoc;
};
 
struct suggestions {
    NMEM nmem;
    int num;
    char **misspelled;
    char **suggest;
    char *passthrough;
};
 
struct show_raw {
    int active; // whether this request has been sent to the server
    int position;
    int binary;
    char *syntax;
    char *esn;
    char *nativesyntax;
    void (*error_handler)(void *data, const char *addinfo);
    void (*record_handler)(void *data, const char *buf, size_t sz);
    void *data;
    struct show_raw *next;
};
 
static const char *client_states[] = {
    "Client_Connecting",
    "Client_Idle",
    "Client_Working",
    "Client_Error",
    "Client_Failed",
    "Client_Disconnected"
};
 
const char *client_get_state_str(struct client *cl)
{
    return client_states[cl->state];
}
 
enum client_state client_get_state(struct client *cl)
{
    return cl->state;
}
 
void client_set_state_nb(struct client *cl, enum client_state st)
{
    cl->state = st;
}
 
void client_set_state(struct client *cl, enum client_state st)
{
    int was_active = 0;
    if (client_is_active(cl))
        was_active = 1;
    cl->state = st;
    /* If client is going from being active to inactive and all clients
       are now idle we fire a watch for the session . The assumption is
       that session is not mutex locked if client is already active */
    if (was_active && !client_is_active(cl) && cl->session)
    {
 
        int no_active = session_active_clients(cl->session);
        yaz_log(YLOG_DEBUG, "%s: releasing watches on zero active: %d",
                client_get_id(cl), no_active);
        if (no_active == 0) {
            session_alert_watch(cl->session, SESSION_WATCH_SHOW);
            session_alert_watch(cl->session, SESSION_WATCH_BYTARGET);
            session_alert_watch(cl->session, SESSION_WATCH_TERMLIST);
            session_alert_watch(cl->session, SESSION_WATCH_SHOW_PREF);
        }
    }
}
 
static void client_init_xdoc(struct client *cl)
{
    int i;
 
    cl->xdoc = xmalloc(sizeof(*cl->xdoc) * XDOC_CACHE_SIZE);
    for (i = 0; i < XDOC_CACHE_SIZE; i++)
        cl->xdoc[i] = 0;
}
 
static void client_destroy_xdoc(struct client *cl)
{
    int i;
 
    assert(cl->xdoc);
    for (i = 0; i < XDOC_CACHE_SIZE; i++)
        if (cl->xdoc[i])
            xmlFreeDoc(cl->xdoc[i]);
    xfree(cl->xdoc);
}
 
xmlDoc *client_get_xdoc(struct client *cl, int record_no)
{
    assert(cl->xdoc);
    if (record_no >= 0 && record_no < XDOC_CACHE_SIZE)
        return cl->xdoc[record_no];
    return 0;
}
 
void client_store_xdoc(struct client *cl, int record_no, xmlDoc *xdoc)
{
    assert(cl->xdoc);
    if (record_no >= 0 && record_no < XDOC_CACHE_SIZE)
    {
        if (cl->xdoc[record_no])
            xmlFreeDoc(cl->xdoc[record_no]);
        cl->xdoc[record_no] = xdoc;
    }
    else
    {
        xmlFreeDoc(xdoc);
    }
}
 
 
static void client_show_raw_error(struct client *cl, const char *addinfo);
 
struct connection *client_get_connection(struct client *cl)
{
    return cl->connection;
}
 
struct session_database *client_get_database(struct client *cl)
{
    return cl->database;
}
 
struct session *client_get_session(struct client *cl)
{
    return cl->session;
}
 
static void client_send_raw_present(struct client *cl);
static int nativesyntax_to_type(const char *s, char *type, ZOOM_record rec);
 
static void client_show_immediate(
    ZOOM_resultset resultset, struct session_database *sdb, int position,
    void *data,
    void (*error_handler)(void *data, const char *addinfo),
    void (*record_handler)(void *data, const char *buf, size_t sz),
    int binary,
    const char *nativesyntax)
{
    ZOOM_record rec = 0;
    char type[80];
    const char *buf;
    int len;
 
    if (!resultset)
    {
        error_handler(data, "no resultset");
        return;
    }
    rec = ZOOM_resultset_record_immediate(resultset, position-1);
    if (!rec)
    {
        error_handler(data, "no record");
        return;
    }
    nativesyntax_to_type(nativesyntax, type, rec);
    buf = ZOOM_record_get(rec, type, &len);
    if (!buf)
    {
        error_handler(data, "no record");
        return;
    }
    record_handler(data, buf, len);
}
 
 
int client_show_raw_begin(struct client *cl, int position,
                          const char *syntax, const char *esn,
                          void *data,
                          void (*error_handler)(void *data, const char *addinfo),
                          void (*record_handler)(void *data, const char *buf,
                                                 size_t sz),
                          int binary,
                          const char *nativesyntax)
{
    if (!nativesyntax)
    {
        if (binary)
            nativesyntax = "raw";
        else
        {
            struct session_database *sdb = client_get_database(cl);
            nativesyntax = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
        }
    }
 
    if (syntax == 0 && esn == 0)
        client_show_immediate(cl->resultset, client_get_database(cl),
                              position, data,
                              error_handler, record_handler,
                              binary, nativesyntax);
    else
    {
        struct show_raw *rr, **rrp;
 
        if (!cl->connection)
            return -1;
 
 
        rr = xmalloc(sizeof(*rr));
        rr->position = position;
        rr->active = 0;
        rr->data = data;
        rr->error_handler = error_handler;
        rr->record_handler = record_handler;
        rr->binary = binary;
        if (syntax)
            rr->syntax = xstrdup(syntax);
        else
            rr->syntax = 0;
        if (esn)
            rr->esn = xstrdup(esn);
        else
            rr->esn = 0;
 
        assert(nativesyntax);
        rr->nativesyntax = xstrdup(nativesyntax);
 
        rr->next = 0;
 
        for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
            ;
        *rrp = rr;
 
        if (cl->state == Client_Failed)
        {
            client_show_raw_error(cl, "client failed");
        }
        else if (cl->state == Client_Disconnected)
        {
            client_show_raw_error(cl, "client disconnected");
        }
        else
        {
            client_send_raw_present(cl);
        }
    }
    return 0;
}
 
static void client_show_raw_delete(struct show_raw *r)
{
    xfree(r->syntax);
    xfree(r->esn);
    xfree(r->nativesyntax);
    xfree(r);
}
 
void client_show_raw_remove(struct client *cl, void *data)
{
    struct show_raw *rr = data;
    struct show_raw **rrp = &cl->show_raw;
    while (*rrp != rr)
        rrp = &(*rrp)->next;
    if (*rrp)
    {
        *rrp = rr->next;
        client_show_raw_delete(rr);
    }
}
 
static void client_show_raw_dequeue(struct client *cl)
{
    struct show_raw *rr = cl->show_raw;
 
    cl->show_raw = rr->next;
    client_show_raw_delete(rr);
}
 
static void client_show_raw_error(struct client *cl, const char *addinfo)
{
    while (cl->show_raw)
    {
        cl->show_raw->error_handler(cl->show_raw->data, addinfo);
        client_show_raw_dequeue(cl);
    }
}
 
static void client_send_raw_present(struct client *cl)
{
    struct session_database *sdb = client_get_database(cl);
    struct connection *co = client_get_connection(cl);
    ZOOM_resultset set = cl->resultset;
 
    int offset = cl->show_raw->position;
    const char *syntax = 0;
    const char *elements = 0;
 
    assert(cl->show_raw);
    assert(set);
 
    yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
            client_get_id(cl), 1, offset);
 
    if (cl->show_raw->syntax)
        syntax = cl->show_raw->syntax;
    else
        syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
    ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
 
    if (cl->show_raw->esn)
        elements = cl->show_raw->esn;
    else
        elements = session_setting_oneval(sdb, PZ_ELEMENTS);
    if (elements && *elements)
        ZOOM_resultset_option_set(set, "elementSetName", elements);
 
    ZOOM_resultset_records(set, 0, offset-1, 1);
    cl->show_raw->active = 1;
 
    connection_continue(co);
}
 
static int nativesyntax_to_type(const char *s, char *type,
                                ZOOM_record rec)
{
    if (s && *s)
    {
        if (!strncmp(s, "iso2709", 7))
        {
            const char *cp = strchr(s, ';');
            yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
        }
        else if (!strncmp(s, "txml", 4))
        {
            const char *cp = strchr(s, ';');
            yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
        }
        else /* pass verbatim to ZOOM - including "xml" */
            strcpy(type, s);
        return 0;
    }
    else  /* attempt to deduce structure */
    {
        const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
        if (syntax)
        {
            if (!strcmp(syntax, "XML"))
            {
                strcpy(type, "xml");
                return 0;
            }
            else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
            {
                strcpy(type, "xml; charset=marc8-s");
                return 0;
            }
            else return -1;
        }
        else return -1;
    }
}
 
static void client_report_facets(struct client *cl, ZOOM_resultset rs)
{
    struct session_database *sdb = client_get_database(cl);
    ZOOM_facet_field *facets = ZOOM_resultset_facets(rs);
 
    if (sdb && facets)
    {
        struct session *se = client_get_session(cl);
        int facet_num = ZOOM_resultset_facets_size(rs);
        struct setting *s;
 
        for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
        {
            const char *p = strchr(s->name + 3, ':');
            if (p && p[1] && s->value && s->value[0])
            {
                int facet_idx;
                p++; /* p now holds logical facet name */
                for (facet_idx = 0; facet_idx < facet_num; facet_idx++)
                {
                    const char *native_name =
                        ZOOM_facet_field_name(facets[facet_idx]);
                    if (native_name && !strcmp(s->value, native_name))
                    {
                        size_t term_idx;
                        size_t term_num =
                            ZOOM_facet_field_term_count(facets[facet_idx]);
                        for (term_idx = 0; term_idx < term_num; term_idx++ )
                        {
                            int freq;
                            const char *term =
                                ZOOM_facet_field_get_term(facets[facet_idx],
                                                          term_idx, &freq);
                            if (term)
                                add_facet(se, p, term, freq, cl);
                        }
                        break;
                    }
                }
            }
        }
    }
}
 
static void ingest_raw_record(struct client *cl, ZOOM_record rec)
{
    const char *buf;
    int len;
    char type[80];
 
    nativesyntax_to_type(cl->show_raw->nativesyntax, type, rec);
    buf = ZOOM_record_get(rec, type, &len);
    cl->show_raw->record_handler(cl->show_raw->data,  buf, len);
    client_show_raw_dequeue(cl);
}
 
struct suggestions* client_suggestions_create(const char* suggestions_string);
static void client_suggestions_destroy(struct client *cl);
 
void client_search_response(struct client *cl)
{
    struct connection *co = cl->connection;
    ZOOM_connection link = connection_get_link(co);
    ZOOM_resultset resultset = cl->resultset;
    struct session *se = client_get_session(cl);
 
    const char *error, *addinfo = 0;
 
    if (ZOOM_connection_error(link, &error, &addinfo))
    {
        cl->hits = 0;
        session_log(se, YLOG_WARN, "%s: Error %s (%s)",
                    client_get_id(cl), error, addinfo);
        client_set_state(cl, Client_Error);
    }
    else
    {
        client_report_facets(cl, resultset);
        cl->record_offset = cl->startrecs;
        cl->hits = ZOOM_resultset_size(resultset);
        session_log(se, YLOG_LOG, "%s: hits: " ODR_INT_PRINTF,
                    client_get_id(cl), cl->hits);
        if (cl->suggestions)
            client_suggestions_destroy(cl);
        cl->suggestions =
            client_suggestions_create(ZOOM_resultset_option_get(
                                          resultset, "suggestions"));
    }
}
 
void client_got_records(struct client *cl)
{
    struct session *se = cl->session;
    if (se)
    {
        client_unlock(cl);
        /* TODO possible threading issue. Session can have been destroyed */
        if (session_is_preferred_clients_ready(se))
            session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
        client_lock(cl);
        if (reclist_get_num_records(se->reclist) > 0)
        {
            client_unlock(cl);
            session_alert_watch(se, SESSION_WATCH_SHOW);
            session_alert_watch(se, SESSION_WATCH_BYTARGET);
            session_alert_watch(se, SESSION_WATCH_TERMLIST);
            session_alert_watch(se, SESSION_WATCH_RECORD);
            client_lock(cl);
        }
    }
}
 
static void client_record_ingest(struct client *cl)
{
    const char *msg, *addinfo;
    ZOOM_record rec = 0;
    ZOOM_resultset resultset = cl->resultset;
    struct session *se = client_get_session(cl);
    xmlDoc *xdoc;
    int offset = cl->record_offset + 1; /* 0 versus 1 numbered offsets */
 
    xdoc = client_get_xdoc(cl, offset);
    if (xdoc)
    {
        if (cl->session)
        {
            NMEM nmem = nmem_create();
            int rc = ingest_xml_record(cl, xdoc, offset, nmem, 1);
            if (rc == -1)
            {
                session_log(se, YLOG_WARN,
                            "%s: #%d: failed to ingest xdoc",
                            client_get_id(cl), offset);
                cl->ingest_failures++;
            }
            else if (rc == -2)
                cl->filtered++;
            nmem_destroy(nmem);
        }
    }
    else if ((rec = ZOOM_resultset_record_immediate(resultset,
                                                    cl->record_offset)))
    {
        if (cl->session == 0)
            ;  /* no operation */
        else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
        {
            session_log(se, YLOG_WARN, "Record error %s (%s): %s #%d",
                        msg, addinfo, client_get_id(cl), offset);
            cl->record_failures++;
        }
        else
        {
            struct session_database *sdb = client_get_database(cl);
            NMEM nmem = nmem_create();
            const char *xmlrec;
            char type[80];
 
            const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
            if (nativesyntax_to_type(s, type, rec))
                session_log(se, YLOG_WARN, "Failed to determine record type");
            xmlrec = ZOOM_record_get(rec, type, NULL);
            if (!xmlrec)
            {
                const char *rec_syn =  ZOOM_record_get(rec, "syntax", NULL);
                session_log(se, YLOG_WARN, "%s: #%d: ZOOM_record_get failed",
                            client_get_id(cl), offset);
                session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
                            "ZOOM record type=%s . Actual record syntax=%s",
                            s ? s : "null", type,
                            rec_syn ? rec_syn : "null");
                cl->ingest_failures++;
            }
            else
            {
                /* OK = 0, -1 = failure, -2 = Filtered */
                int rc = ingest_record(cl, xmlrec, offset, nmem);
                if (rc == -1)
                {
                    const char *rec_syn =  ZOOM_record_get(rec, "syntax", NULL);
                    session_log(se, YLOG_WARN,
                                "%s: #%d: failed to ingest record",
                                client_get_id(cl), offset);
                    session_log(se, YLOG_LOG, "pz:nativesyntax=%s . "
                                "ZOOM record type=%s . Actual record syntax=%s",
                                s ? s : "null", type,
                                rec_syn ? rec_syn : "null");
                    cl->ingest_failures++;
                }
                else if (rc == -2)
                    cl->filtered++;
            }
            nmem_destroy(nmem);
        }
    }
    else
    {
        session_log(se, YLOG_WARN, "Got NULL record from %s #%d",
                    client_get_id(cl), offset);
    }
    cl->record_offset++;
}
 
void client_record_response(struct client *cl, int *got_records)
{
    struct connection *co = cl->connection;
    ZOOM_connection link = connection_get_link(co);
    ZOOM_resultset resultset = cl->resultset;
    const char *error, *addinfo;
 
    if (ZOOM_connection_error(link, &error, &addinfo))
    {
        struct session *se = client_get_session(cl);
        session_log(se, YLOG_WARN, "%s: Error %s (%s)",
                    client_get_id(cl), error, addinfo);
        client_set_state(cl, Client_Error);
    }
    else
    {
        if (cl->show_raw && cl->show_raw->active)
        {
            ZOOM_record rec = 0;
            if ((rec = ZOOM_resultset_record_immediate(
                     resultset, cl->show_raw->position-1)))
            {
                cl->show_raw->active = 0;
                ingest_raw_record(cl, rec);
            }
            else
            {
                yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
                        cl->show_raw->position-1);
            }
        }
        else
        {
            client_record_ingest(cl);
            *got_records = 1;
        }
    }
}
 
int client_reingest(struct client *cl)
{
    int i = cl->startrecs;
    int to = cl->record_offset;
    cl->record_failures = cl->ingest_failures = cl->filtered = 0;
 
    cl->record_offset = i;
    for (; i < to; i++)
        client_record_ingest(cl);
    return 0;
}
 
static void client_set_facets_request(struct client *cl, ZOOM_connection link)
{
    struct session_database *sdb = client_get_database(cl);
 
    WRBUF w = wrbuf_alloc();
 
    struct setting *s;
 
    for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
    {
        const char *p = strchr(s->name + 3, ':');
        if (!p)
        {
            yaz_log(YLOG_WARN, "Malformed facetmap name: %s", s->name);
        }
        else if (s->value && s->value[0])
        {
            wrbuf_puts(w, "@attr 1=");
            yaz_encode_pqf_term(w, s->value, strlen(s->value));
            if (s->next)
                wrbuf_puts(w, ",");
        }
    }
    yaz_log(YLOG_DEBUG, "using facets str: %s", wrbuf_cstr(w));
    ZOOM_connection_option_set(link, "facets",
                               wrbuf_len(w) ? wrbuf_cstr(w) : 0);
    wrbuf_destroy(w);
}
 
int client_has_facet(struct client *cl, const char *name)
{
    struct session_database *sdb = client_get_database(cl);
    struct setting *s;
 
    for (s = sdb->settings[PZ_FACETMAP]; s; s = s->next)
    {
        const char *p = strchr(s->name + 3, ':');
        if ( !strncmp(p, ":split:", 7) )
            p += 6; // PAZ-1009
        if (p && !strcmp(name, p + 1))
            return 1;
    }
    return 0;
}
 
static const char *get_strategy_plus_sort(struct client *l, const char *field)
{
    struct session_database *sdb = client_get_database(l);
    struct setting *s;
 
    const char *strategy_plus_sort = 0;
 
    for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
    {
        char *p = strchr(s->name + 3, ':');
        if (!p)
        {
            yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
            continue;
        }
        p++;
        if (!strcmp(p, field))
        {
            strategy_plus_sort = s->value;
            break;
        }
    }
    return strategy_plus_sort;
}
 
void client_update_show_stat(struct client *cl, int cmd)
{
    if (cmd == 0)
        cl->show_stat_no = 0;
    else if (cmd == 1)
        cl->show_stat_no++;
}
 
int client_fetch_more(struct client *cl)
{
    struct session_database *sdb = client_get_database(cl);
    const char *str;
    int extend_recs = 0;
    int number = cl->hits - cl->record_offset;
    struct connection *co = client_get_connection(cl);
 
    str = session_setting_oneval(sdb, PZ_EXTENDRECS);
    if (!str || !*str)
        return 0;
 
    extend_recs = atoi(str);
 
    yaz_log(YLOG_DEBUG, "cl=%s show_stat_no=%d got=%d",
            client_get_id(cl), cl->show_stat_no, cl->record_offset);
    if (cl->show_stat_no + cl->ingest_failures + cl->record_failures
        < cl->record_offset)
        return 0;
    yaz_log(YLOG_DEBUG, "cl=%s Trying to fetch more", client_get_id(cl));
 
    if (number > extend_recs)
        number = extend_recs;
    if (number <= 0)
        yaz_log(YLOG_DEBUG, "cl=%s. OK no more in total set", client_get_id(cl));
    else if (!co)
        yaz_log(YLOG_DEBUG, "cl=%s. No connection", client_get_id(cl));
    else
    {
        ZOOM_resultset set = cl->resultset;
 
        str = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
        ZOOM_resultset_option_set(set, "preferredRecordSyntax", str);
        str = session_setting_oneval(sdb, PZ_ELEMENTS);
        if (str && *str)
            ZOOM_resultset_option_set(set, "elementSetName", str);
 
        ZOOM_resultset_records(set, 0, cl->record_offset, number);
        client_set_state(cl, Client_Working);
        connection_continue(co);
        return 1;
    }
    return 0;
}
 
int client_parse_init(struct client *cl, int same_search)
{
    cl->same_search = same_search;
    return 0;
}
 
/*
 * TODO consider how to extend the range
 * */
int client_parse_range(struct client *cl, const char *startrecs,
                       const char *maxrecs)
{
    if (maxrecs && atoi(maxrecs) != cl->maxrecs)
    {
        cl->same_search = 0;
        cl->maxrecs = atoi(maxrecs);
    }
 
    if (startrecs && atoi(startrecs) != cl->startrecs)
    {
        cl->same_search = 0;
        cl->startrecs = atoi(startrecs);
    }
 
    return 0;
}
 
const char *client_get_query(struct client *cl, const char **type, NMEM nmem)
{
    if (cl->pquery)
    {
        *type = "pqf";
        return nmem_strdup(nmem, cl->pquery);
    }
    if (cl->cqlquery)
    {
        *type = "cql";
        return nmem_strdup(nmem, cl->cqlquery);
    }
    *type = 0;
    return 0;
}
 
int client_start_search(struct client *cl)
{
    struct session_database *sdb = client_get_database(cl);
    struct connection *co = 0;
    ZOOM_connection link = 0;
    struct session *se = client_get_session(cl);
    ZOOM_resultset rs;
    const char *opt_piggyback   = session_setting_oneval(sdb, PZ_PIGGYBACK);
    const char *opt_queryenc    = session_setting_oneval(sdb, PZ_QUERYENCODING);
    const char *opt_elements    = session_setting_oneval(sdb, PZ_ELEMENTS);
    const char *opt_requestsyn  = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
    const char *opt_maxrecs     = session_setting_oneval(sdb, PZ_MAXRECS);
    const char *opt_sru         = session_setting_oneval(sdb, PZ_SRU);
    const char *opt_sort        = session_setting_oneval(sdb, PZ_SORT);
    const char *opt_preferred   = session_setting_oneval(sdb, PZ_PREFERRED);
    const char *extra_args      = session_setting_oneval(sdb, PZ_EXTRA_ARGS);
    const char *opt_present_chunk = session_setting_oneval(sdb, PZ_PRESENT_CHUNK);
    const char *opt_timeout     = session_setting_oneval(sdb, PZ_TIMEOUT);
    ZOOM_query query;
    char maxrecs_str[24], startrecs_str[24], present_chunk_str[24];
    struct timeval tval;
    int present_chunk = 20; // Default chunk size
    int rc_prep_connection;
    int operation_timeout = se->service->z3950_operation_timeout;
 
    cl->diagnostic = 0;
    cl->record_failures = cl->ingest_failures = cl->filtered = 0;
 
    yaz_gettimeofday(&tval);
    tval.tv_sec += 5;
 
    if (opt_timeout && *opt_timeout)
        operation_timeout = atoi(opt_timeout);
 
    if (opt_present_chunk && strcmp(opt_present_chunk,"")) {
        present_chunk = atoi(opt_present_chunk);
        yaz_log(YLOG_DEBUG, "Present chunk set to %d", present_chunk);
    }
    rc_prep_connection =
        client_prep_connection(cl, operation_timeout,
                               se->service->z3950_session_timeout,
                               se->service->server->iochan_man,
                               &tval);
    /* Nothing has changed and we already have a result */
    if (cl->same_search == 1 && rc_prep_connection == 2)
    {
        session_log(se, YLOG_LOG, "%s: reuse result", client_get_id(cl));
        client_report_facets(cl, cl->resultset);
        return client_reingest(cl);
    }
    else if (!rc_prep_connection)
    {
        return -1; /* error */
    }
    co = client_get_connection(cl);
    assert(cl);
    link = connection_get_link(co);
    assert(link);
 
    client_destroy_xdoc(cl);
    client_init_xdoc(cl);
 
    if (extra_args && *extra_args)
        ZOOM_connection_option_set(link, "extraArgs", extra_args);
 
    if (opt_preferred) {
        cl->preferred = atoi(opt_preferred);
        if (cl->preferred)
            yaz_log(YLOG_LOG, "Target %s has preferred status: %d",
                    client_get_id(cl), cl->preferred);
    }
 
    if (*opt_piggyback)
        ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
    else
        ZOOM_connection_option_set(link, "piggyback", "1");
    if (*opt_queryenc)
        ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
    if (*opt_sru && *opt_elements)
        ZOOM_connection_option_set(link, "schema", opt_elements);
    else if (*opt_elements)
        ZOOM_connection_option_set(link, "elementSetName", opt_elements);
    if (*opt_requestsyn)
        ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
 
    if (opt_maxrecs && *opt_maxrecs)
    {
        cl->maxrecs = atoi(opt_maxrecs);
    }
 
    /* convert back to string representation used in ZOOM API */
    sprintf(maxrecs_str, "%d", cl->maxrecs);
    ZOOM_connection_option_set(link, "count", maxrecs_str);
 
    /* A present_chunk less than 1 will disable chunking. */
    if (present_chunk > 0 && cl->maxrecs > present_chunk) {
        sprintf(present_chunk_str, "%d", present_chunk);
        ZOOM_connection_option_set(link, "presentChunk", present_chunk_str);
        yaz_log(YLOG_DEBUG, "Present chunk set to %s", present_chunk_str);
    }
    else {
        ZOOM_connection_option_set(link, "presentChunk", maxrecs_str);
        yaz_log(YLOG_DEBUG, "Present chunk set to %s (maxrecs)", maxrecs_str);
    }
    sprintf(startrecs_str, "%d", cl->startrecs);
    ZOOM_connection_option_set(link, "start", startrecs_str);
 
    /* TODO Verify does it break something for CQL targets(non-SOLR) ? */
    /* facets definition is in PQF */
    client_set_facets_request(cl, link);
 
    query = ZOOM_query_create();
    if (cl->cqlquery)
    {
        session_log(se, YLOG_LOG, "%s: Search CQL: %s", client_get_id(cl),
                    cl->cqlquery);
        ZOOM_query_cql(query, cl->cqlquery);
        if (*opt_sort)
            ZOOM_query_sortby(query, opt_sort);
    }
    else
    {
        session_log(se, YLOG_LOG, "%s: Search PQF: %s", client_get_id(cl),
                    cl->pquery);
        ZOOM_query_prefix(query, cl->pquery);
    }
    if (cl->sort_strategy && cl->sort_criteria) {
        yaz_log(YLOG_LOG, "Client %s: "
                "Set ZOOM sort strategy and criteria: %s %s",
                client_get_id(cl), cl->sort_strategy, cl->sort_criteria);
        ZOOM_query_sortby2(query, cl->sort_strategy, cl->sort_criteria);
    }
 
    yaz_log(YLOG_DEBUG,"Client %s: Starting search", client_get_id(cl));
    client_set_state(cl, Client_Working);
    cl->hits = 0;
    cl->record_offset = 0;
    rs = ZOOM_connection_search(link, query);
    ZOOM_query_destroy(query);
    ZOOM_resultset_destroy(cl->resultset);
    cl->resultset = rs;
    connection_continue(co);
    return 0;
}
 
struct client *client_create(const char *id)
{
    struct client *cl = xmalloc(sizeof(*cl));
    cl->maxrecs = 100;
    cl->startrecs = 0;
    cl->pquery = 0;
    cl->cqlquery = 0;
    cl->addinfo = 0;
    cl->message = 0;
    cl->database = 0;
    cl->connection = 0;
    cl->session = 0;
    cl->hits = 0;
    cl->record_offset = 0;
    cl->filtered = 0;
    cl->diagnostic = 0;
    cl->state = Client_Disconnected;
    cl->show_raw = 0;
    cl->resultset = 0;
    cl->suggestions = 0;
    cl->mutex = 0;
    pazpar2_mutex_create(&cl->mutex, "client");
    cl->preferred = 0;
    cl->ref_count = 1;
    cl->facet_limits = 0;
    cl->sort_strategy = 0;
    cl->sort_criteria = 0;
    assert(id);
    cl->id = xstrdup(id);
    client_init_xdoc(cl);
    client_use(1);
 
    yaz_log(YLOG_DEBUG, "client_create c=%p %s", cl, id);
    return cl;
}
 
void client_lock(struct client *c)
{
    yaz_mutex_enter(c->mutex);
}
 
void client_unlock(struct client *c)
{
    yaz_mutex_leave(c->mutex);
}
 
void client_incref(struct client *c)
{
    pazpar2_incref(&c->ref_count, c->mutex);
    yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
            c, client_get_id(c), c->ref_count);
}
 
int client_destroy(struct client *c)
{
    if (c)
    {
        yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
                c, client_get_id(c), c->ref_count);
        if (!pazpar2_decref(&c->ref_count, c->mutex))
        {
            xfree(c->pquery);
            c->pquery = 0;
            xfree(c->cqlquery);
            c->cqlquery = 0;
            xfree(c->addinfo);
            c->addinfo = 0;
            xfree(c->message);
            c->message = 0;
            xfree(c->id);
            xfree(c->sort_strategy);
            xfree(c->sort_criteria);
            assert(!c->connection);
            facet_limits_destroy(c->facet_limits);
 
            client_destroy_xdoc(c);
            if (c->resultset)
            {
                ZOOM_resultset_destroy(c->resultset);
            }
            yaz_mutex_destroy(&c->mutex);
            xfree(c);
            client_use(-1);
            return 1;
        }
    }
    return 0;
}
 
void client_set_connection(struct client *cl, struct connection *con)
{
    if (cl->resultset)
        ZOOM_resultset_release(cl->resultset);
    if (con)
    {
        assert(cl->connection == 0);
        cl->connection = con;
        client_incref(cl);
    }
    else
    {
        client_lock(cl);
        cl->connection = con;
        client_unlock(cl);
        client_destroy(cl);
    }
}
 
void client_disconnect(struct client *cl)
{
    if (cl->state != Client_Idle)
        client_set_state(cl, Client_Disconnected);
    client_set_connection(cl, 0);
}
 
void client_mark_dead(struct client *cl)
{
    if (cl->connection)
        connection_mark_dead(cl->connection);
}
 
void client_stop(struct client *cl)
{
    client_lock(cl);
    if (cl->state == Client_Working || cl->state == Client_Connecting)
    {
        yaz_log(YLOG_LOG, "client_stop: %s release", client_get_id(cl));
        if (cl->connection)
        {
            connection_release2(cl->connection);
            assert(cl->ref_count > 1);
            cl->ref_count--;
            cl->connection = 0;
        }
        cl->state = Client_Disconnected;
    }
    else
        yaz_log(YLOG_LOG, "client_stop: %s ignore", client_get_id(cl));
    client_unlock(cl);
}
 
// Initialize CCL map for a target
static CCL_bibset prepare_cclmap(struct client *cl, CCL_bibset base_bibset)
{
    struct session_database *sdb = client_get_database(cl);
    struct setting *s;
    CCL_bibset res;
 
    if (!sdb->settings)
        return 0;
    if (base_bibset)
        res = ccl_qual_dup(base_bibset);
    else
        res = ccl_qual_mk();
    for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
    {
        const char *addinfo = 0;
        char *p = strchr(s->name + 3, ':');
        if (!p)
        {
            WRBUF w = wrbuf_alloc();
            wrbuf_printf(w, "Malformed cclmap. name=%s", s->name);
            yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
            client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
                                  ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
                                  wrbuf_cstr(w));
            client_set_state_nb(cl, Client_Error);
            ccl_qual_rm(&res);
            wrbuf_destroy(w);
            return 0;
        }
        p++;
        if (ccl_qual_fitem2(res, s->value, p, &addinfo))
        {
            WRBUF w = wrbuf_alloc();
 
            wrbuf_printf(w, "Malformed cclmap. name=%s: value=%s (%s)",
                         s->name, p, addinfo);
            yaz_log(YLOG_WARN, "%s: %s", client_get_id(cl), wrbuf_cstr(w));
            client_set_diagnostic(cl, ZOOM_ERROR_CCL_CONFIG,
                                  ZOOM_diag_str(ZOOM_ERROR_CCL_CONFIG),
                                  wrbuf_cstr(w));
            client_set_state_nb(cl, Client_Error);
            ccl_qual_rm(&res);
            wrbuf_destroy(w);
            return 0;
        }
    }
    return res;
}
 
// returns a xmalloced CQL query corresponding to the pquery in client
static char *make_cqlquery(struct client *cl, Z_RPNQuery *zquery)
{
    cql_transform_t cqlt = cql_transform_create();
    char *r = 0;
    WRBUF wrb = wrbuf_alloc();
    int status;
 
    if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
    {
        yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
    }
    else
    {
        r = xstrdup(wrbuf_cstr(wrb));
    }
    wrbuf_destroy(wrb);
    cql_transform_close(cqlt);
    return r;
}
 
// returns a xmalloced SOLR query corresponding to the pquery in client
// TODO Could prob. be merge with the similar make_cqlquery
static char *make_solrquery(struct client *cl, Z_RPNQuery *zquery)
{
    solr_transform_t sqlt = solr_transform_create();
    char *r = 0;
    WRBUF wrb = wrbuf_alloc();
    int status;
 
    if ((status = solr_transform_rpn2solr_wrbuf(sqlt, wrb, zquery)))
    {
        yaz_log(YLOG_WARN, "Failed to generate SOLR query, code=%d", status);
    }
    else
    {
        r = xstrdup(wrbuf_cstr(wrb));
    }
    wrbuf_destroy(wrb);
    solr_transform_close(sqlt);
    return r;
}
 
const char *client_get_facet_limit_local(struct client *cl,
                                         struct session_database *sdb,
                                         int *l,
                                         NMEM nmem, int *num, char ***values)
{
    const char *name = 0;
    const char *value = 0;
    for (; (name = facet_limits_get(cl->facet_limits, *l, &value)); (*l)++)
    {
        struct setting *s = 0;
 
        for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
        {
            const char *p = strchr(s->name + 3, ':');
            if (p && !strcmp(p + 1, name) && s->value)
            {
                int j, cnum;
                char **cvalues;
                nmem_strsplit_escape2(nmem, ",", s->value, &cvalues,
                                      &cnum, 1, '\\', 1);
                for (j = 0; j < cnum; j++)
                {
                    const char *cvalue = cvalues[j];
                    while (*cvalue == ' ')
                        cvalue++;
                    if (!strncmp(cvalue, "local:", 6))
                    {
                        const char *cp = cvalue + 6;
                        while (*cp == ' ')
                            cp++;
                        nmem_strsplit_escape2(nmem, "|", value, values,
                                              num, 1, '\\', 1);
                        (*l)++;
                        return *cp ? cp : name;
                    }
                }
            }
        }
    }
    return 0;
}
 
static void ccl_quote_map_term(CCL_bibset ccl_map, WRBUF w,
                               const char *term)
{
    int quote_it = 0;
    const char *cp;
    for (cp = term; *cp; cp++)
        if ((*cp >= '0' && *cp <= '9') || strchr(" +-", *cp))
            ;
        else
            quote_it = 1;
    if (!quote_it)
        wrbuf_puts(w, term);
    else
    {
        wrbuf_putc(w, '\"');
        for (cp = term; *cp; cp++)
        {
            if (strchr( "\\\"", *cp))
                wrbuf_putc(w, '\\');
            wrbuf_putc(w, *cp);
        }
        wrbuf_putc(w, '\"');
    }
}
 
static int apply_limit(struct client *cl,
                       facet_limits_t facet_limits,
                       WRBUF w_pqf, CCL_bibset ccl_map,
                       struct conf_service *service)
{
    int ret = 0;
    int i = 0;
    const char *name;
    const char *value;
    struct session_database *sdb = client_get_database(cl);
 
    NMEM nmem_tmp = nmem_create();
    for (i = 0; (name = facet_limits_get(facet_limits, i, &value)); i++)
    {
        struct setting *s = 0;
        nmem_reset(nmem_tmp);
        /* name="pz:limitmap:author" value="rpn:@attr 1=4|local:other" */
        for (s = sdb->settings[PZ_LIMITMAP]; s; s = s->next)
        {
            const char *p = strchr(s->name + 3, ':');
            if (p && !strcmp(p + 1, name) && s->value)
            {
                char **values = 0;
                int i, num = 0;
                char **cvalues = 0;
                int j, cnum = 0;
                nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
                                      &num, 1, '\\', 1);
 
                for (i = 0; i < num; i++)
                {
                    const char *id = session_lookup_id_facet(cl->session,
                                                             cl, name,
                                                             values[i]);
                    if (id)
                    {
                        if ( *id )
                        {
                            values[i] = nmem_strdup(nmem_tmp, id);
                            yaz_log(YLOG_DEBUG,
                                "apply_limit: s='%s' found id '%s'",s->name,id );
                        }
                        else
                        {
                            yaz_log(YLOG_DEBUG,
                                "apply_limit: %s: term '%s' not found, failing client",
                                s->name, values[i] );
                            ret = -1;
                        }
                    }
                }
                nmem_strsplit_escape2(nmem_tmp, ",", s->value, &cvalues,
                                      &cnum, 1, '\\', 1);
 
                for (j = 0; ret == 0 && j < cnum; j++)
                {
                    const char *cvalue = cvalues[j];
                    while (*cvalue == ' ')
                        cvalue++;
                    if (!strncmp(cvalue, "rpn:", 4))
                    {
                        const char *pqf = cvalue + 4;
                        wrbuf_puts(w_pqf, "@and ");
                        wrbuf_puts(w_pqf, pqf);
                        wrbuf_puts(w_pqf, " ");
                        for (i = 0; i < num; i++)
                        {
                            if (i < num - 1)
                                wrbuf_puts(w_pqf, "@or ");
                            yaz_encode_pqf_term(w_pqf, values[i],
                                                strlen(values[i]));
                        }
                    }
                    else if (!strncmp(cvalue, "ccl:", 4))
                    {
                        const char *ccl = cvalue + 4;
                        WRBUF ccl_w = wrbuf_alloc();
                        for (i = 0; i < num; i++)
                        {
                            int cerror, cpos;
                            struct ccl_rpn_node *cn;
                            wrbuf_rewind(ccl_w);
                            wrbuf_puts(ccl_w, ccl);
                            wrbuf_putc(ccl_w, '=');
                            ccl_quote_map_term(ccl_map, ccl_w, values[i]);
                            cn = ccl_find_str(ccl_map, wrbuf_cstr(ccl_w),
                                              &cerror, &cpos);
                            if (cn)
                            {
                                if (i == 0)
                                    wrbuf_printf(w_pqf, "@and ");
 
                                /* or multiple values.. could be bad if last
                                   CCL parse fails, but this is unlikely to
                                   happen */
                                if (i < num - 1)
                                    wrbuf_printf(w_pqf, "@or ");
                                ccl_pquery(w_pqf, cn);
                                ccl_rpn_delete(cn);
                            }
                        }
                        wrbuf_destroy(ccl_w);
                    }
                    else if (!strncmp(cvalue, "local:", 6)) {
                        /* no operation */
                    }
                    else
                    {
                        yaz_log(YLOG_WARN, "Target %s: Bad limitmap '%s'",
                                sdb->database->id, cvalue);
                        ret = -1; /* bad limitmap */
                    }
                }
                break;
            }
        }
        if (!s)
        {
            int i;
            for (i = 0; i < service->num_metadata; i++)
            {
                struct conf_metadata *md = service->metadata + i;
                if (!strcmp(md->name, name) && md->limitcluster)
                {
                    yaz_log(YLOG_LOG, "limitcluster in use for %s",
                            md->name);
                    break;
                }
            }
            if (i == service->num_metadata)
            {
                yaz_log(YLOG_WARN, "Target %s: limit %s used, but no limitmap defined",
                        (sdb->database ? sdb->database->id : "<no id>"), name);
            }
        }
    }
    nmem_destroy(nmem_tmp);
    return ret;
}
 
// Parse the query given the settings specific to this client
// client variable same_search is set as below as well as returned:
// 0 if query is OK but different from before
// 1 if query is OK but same as before
// return -1 on query error
// return -2 on limit error
int client_parse_query(struct client *cl, const char *query,
                       facet_limits_t facet_limits, const char **error_msg)
{
    struct session *se = client_get_session(cl);
    struct conf_service *service = se->service;
    struct session_database *sdb = client_get_database(cl);
    struct ccl_rpn_node *cn;
    int cerror, cpos;
    ODR odr_out;
    CCL_bibset ccl_map = prepare_cclmap(cl, service->ccl_bibset);
    const char *sru = session_setting_oneval(sdb, PZ_SRU);
    const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
    const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
    const char *query_syntax = session_setting_oneval(sdb, PZ_QUERY_SYNTAX);
    WRBUF w_ccl, w_pqf;
    int ret_value = 1;
    Z_RPNQuery *zquery;
 
    if (!ccl_map)
        return -3;
 
    xfree(cl->cqlquery);
    cl->cqlquery = 0;
 
    w_ccl = wrbuf_alloc();
    wrbuf_puts(w_ccl, query);
 
    w_pqf = wrbuf_alloc();
    if (*pqf_prefix)
    {
        wrbuf_puts(w_pqf, pqf_prefix);
        wrbuf_puts(w_pqf, " ");
    }
 
    if (apply_limit(cl, facet_limits, w_pqf, ccl_map, service))
    {
        client_set_state(cl, Client_Error);
        ccl_qual_rm(&ccl_map);
 
        wrbuf_destroy(w_ccl);
        wrbuf_destroy(w_pqf);
 
        xfree(cl->pquery);
        cl->pquery = 0;
 
        return -2;
    }
 
    facet_limits_destroy(cl->facet_limits);
    cl->facet_limits = facet_limits_dup(facet_limits);
 
    cn = ccl_find_str(ccl_map, wrbuf_cstr(w_ccl), &cerror, &cpos);
    ccl_qual_rm(&ccl_map);
    if (!cn)
    {
        if (error_msg)
            *error_msg = ccl_err_msg(cerror);
        client_set_state(cl, Client_Error);
        session_log(se, YLOG_WARN, "Client %s: Failed to parse CCL query '%s'",
                    client_get_id(cl),
                    wrbuf_cstr(w_ccl));
        wrbuf_destroy(w_ccl);
        wrbuf_destroy(w_pqf);
 
        xfree(cl->pquery);
        cl->pquery = 0;
 
        return -1;
    }
    wrbuf_destroy(w_ccl);
 
    if (!pqf_strftime || !*pqf_strftime)
        ccl_pquery(w_pqf, cn);
    else
    {
        time_t cur_time = time(0);
        struct tm *tm =  localtime(&cur_time);
        char tmp_str[300];
        const char *cp = tmp_str;
 
        /* see man strftime(3) for things .. In particular %% gets converted
         to %.. And That's our original query .. */
        strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
        for (; *cp; cp++)
        {
            if (cp[0] == '%')
                ccl_pquery(w_pqf, cn);
            else
                wrbuf_putc(w_pqf, cp[0]);
        }
    }
 
    /* Compares query and limit with old one. If different we need to research */
    if (!cl->pquery || strcmp(cl->pquery, wrbuf_cstr(w_pqf)))
    {
        if (cl->pquery)
            session_log(se, YLOG_LOG, "Client %s: "
                        "Re-search due query/limit change: %s to %s",
                        client_get_id(cl), cl->pquery, wrbuf_cstr(w_pqf));
        xfree(cl->pquery);
        cl->pquery = xstrdup(wrbuf_cstr(w_pqf));
        // return value is no longer used.
        ret_value = 0;
        // Need to (re)search
        cl->same_search= 0;
    }
    wrbuf_destroy(w_pqf);
 
    odr_out = odr_createmem(ODR_ENCODE);
    zquery = p_query_rpn(odr_out, cl->pquery);
    if (!zquery)
    {
        session_log(se, YLOG_WARN, "Invalid PQF query for Client %s: %s",
                    client_get_id(cl), cl->pquery);
        ret_value = -1;
        *error_msg = "Invalid PQF after CCL to PQF conversion";
    }
    else
    {
        /* Support for PQF on SRU targets. */
        if (strcmp(query_syntax, "pqf") != 0 && *sru)
        {
            if (!strcmp(sru, "solr"))
                cl->cqlquery = make_solrquery(cl, zquery);
            else
                cl->cqlquery = make_cqlquery(cl, zquery);
            if (!cl->cqlquery)
            {
                *error_msg = "Cannot convert PQF to Solr/CQL";
                ret_value = -1;
            }
            else
                session_log(se, YLOG_LOG, "Client %s native query: %s (%s)",
                            client_get_id(cl), cl->cqlquery, sru);
        }
    }
    odr_destroy(odr_out);
 
    /* TODO FIX Not thread safe */
    if (!se->relevance)
    {
        // Initialize relevance structure with query terms
        se->relevance = relevance_create_ccl(se->service->charsets, cn,
                                             se->service->rank_cluster,
                                             se->service->rank_follow,
                                             se->service->rank_lead,
                                             se->service->rank_length);
    }
    ccl_rpn_delete(cn);
    return ret_value;
}
 
int client_parse_sort(struct client *cl, struct reclist_sortparms *sp,
                      int *has_sortmap)
{
    if (has_sortmap)
        *has_sortmap = 0;
    if (sp)
    {
        const char *sort_strategy_and_spec =
            get_strategy_plus_sort(cl, sp->name);
        int increasing = sp->increasing;
        if (!strcmp(sp->name, "relevance"))
            increasing = 1;
        if (sort_strategy_and_spec && strlen(sort_strategy_and_spec) < 40)
        {
            char strategy[50], *p;
            strcpy(strategy, sort_strategy_and_spec);
            p = strchr(strategy, ':');
            if (p)
            {
                // Split the string in two
                *p++ = 0;
                while (*p == ' ')
                    p++;
                if (increasing)
                    strcat(p, " <");
                else
                    strcat(p, " >");
                yaz_log(YLOG_LOG, "Client %s: "
                        "applying sorting %s %s", client_get_id(cl),
                        strategy, p);
                if (!cl->sort_strategy || strcmp(cl->sort_strategy, strategy))
                    cl->same_search = 0;
                if (!cl->sort_criteria || strcmp(cl->sort_criteria, p))
                    cl->same_search = 0;
                if (cl->same_search == 0) {
                    xfree(cl->sort_strategy);
                    cl->sort_strategy = xstrdup(strategy);
                    xfree(cl->sort_criteria);
                    cl->sort_criteria = xstrdup(p);
                }
                if (has_sortmap)
                    (*has_sortmap)++;
            }
            else {
                yaz_log(YLOG_LOG, "Client %s: "
                        "Invalid sort strategy and spec found %s",
                        client_get_id(cl), sort_strategy_and_spec);
                xfree(cl->sort_strategy);
                cl->sort_strategy  = 0;
                xfree(cl->sort_criteria);
                cl->sort_criteria = 0;
            }
        }
        else
        {
            yaz_log(YLOG_DEBUG, "Client %s: "
                    "No sort strategy and spec found.", client_get_id(cl));
            xfree(cl->sort_strategy);
            cl->sort_strategy  = 0;
            xfree(cl->sort_criteria);
            cl->sort_criteria = 0;
        }
 
    }
    return !cl->same_search;
}
 
void client_set_session(struct client *cl, struct session *se)
{
    cl->session = se;
}
 
int client_is_active(struct client *cl)
{
    if (cl->connection && (cl->state == Client_Connecting ||
                           cl->state == Client_Working))
        return 1;
    return 0;
}
 
int client_is_active_preferred(struct client *cl)
{
    /* only count if this is a preferred target. */
    if (!cl->preferred)
        return 0;
    /* TODO No sure this the condition that Seb wants */
    if (cl->connection && (cl->state == Client_Connecting ||
                           cl->state == Client_Working))
        return 1;
    return 0;
}
 
Odr_int client_get_hits(struct client *cl)
{
    return cl->hits;
}
 
Odr_int client_get_approximation(struct client *cl)
{
    if (cl->record_offset > 0)
    {
        Odr_int approx = ((10 * cl->hits * (cl->record_offset - cl->filtered))
                          / cl->record_offset + 5) /10;
        yaz_log(YLOG_DEBUG, "%s: Approx: %lld * %d / %d = %lld ",
                client_get_id(cl), cl->hits,
                cl->record_offset - cl->filtered, cl->record_offset, approx);
        return approx;
    }
    return cl->hits;
}
 
int client_get_num_records(struct client *cl, int *filtered, int *ingest,
                           int *failed)
{
    if (filtered)
        *filtered = cl->filtered;
    if (ingest)
        *ingest = cl->ingest_failures;
    if (failed)
        *failed = cl->record_failures;
    return cl->record_offset;
}
 
void client_set_diagnostic(struct client *cl, int diagnostic,
                           const char *message, const char *addinfo)
{
    cl->diagnostic = diagnostic;
    xfree(cl->message);
    cl->message = xstrdup(message);
    xfree(cl->addinfo);
    cl->addinfo = 0;
    if (addinfo)
        cl->addinfo = xstrdup(addinfo);
}
 
int client_get_diagnostic(struct client *cl, const char **message,
                          const char **addinfo)
{
    if (message)
        *message = cl->message;
    if (addinfo)
        *addinfo = cl->addinfo;
    return cl->diagnostic;
}
 
const char *client_get_suggestions_xml(struct client *cl, WRBUF wrbuf)
{
    /* int idx; */
    struct suggestions *suggestions = cl->suggestions;
 
    if (!suggestions)
        return "";
    if (suggestions->passthrough)
    {
        yaz_log(YLOG_DEBUG, "Passthrough Suggestions: \n%s\n",
                suggestions->passthrough);
        return suggestions->passthrough;
    }
    if (suggestions->num == 0)
        return "";
    /*
    for (idx = 0; idx < suggestions->num; idx++) {
        wrbuf_printf(wrbuf, "<suggest term=\"%s\"", suggestions->suggest[idx]);
        if (suggestions->misspelled[idx] && suggestions->misspelled[idx]) {
            wrbuf_puts(wrbuf, suggestions->misspelled[idx]);
            wrbuf_puts(wrbuf, "</suggest>\n");
        }
        else
            wrbuf_puts(wrbuf, "/>\n");
    }
    */
    return wrbuf_cstr(wrbuf);
}
 
void client_set_database(struct client *cl, struct session_database *db)
{
    cl->database = db;
}
 
const char *client_get_id(struct client *cl)
{
    return cl->id;
}
 
int client_get_maxrecs(struct client *cl)
{
    return cl->maxrecs;
}
 
void client_set_preferred(struct client *cl, int v)
{
    cl->preferred = v;
}
 
 
struct suggestions* client_suggestions_create(const char* suggestions_string)
{
    int i;
    NMEM nmem;
    struct suggestions *suggestions;
    if (suggestions_string == 0 || suggestions_string[0] == 0 )
        return 0;
    nmem = nmem_create();
    suggestions = nmem_malloc(nmem, sizeof(*suggestions));
    yaz_log(YLOG_DEBUG, "client target suggestions: %s.", suggestions_string);
 
    suggestions->nmem = nmem;
    suggestions->num = 0;
    suggestions->misspelled = 0;
    suggestions->suggest = 0;
    suggestions->passthrough = nmem_strdup_null(nmem, suggestions_string);
 
    if (suggestions_string)
        nmem_strsplit_escape2(suggestions->nmem, "\n", suggestions_string, &suggestions->suggest,
                              &suggestions->num, 1, '\\', 0);
    /* Set up misspelled array */
    suggestions->misspelled = (char **)
        nmem_malloc(nmem, suggestions->num * sizeof(*suggestions->misspelled));
    /* replace = with \0 .. for each item */
    for (i = 0; i < suggestions->num; i++)
    {
        char *cp = strchr(suggestions->suggest[i], '=');
        if (cp) {
            *cp = '\0';
            suggestions->misspelled[i] = cp+1;
        }
    }
    return suggestions;
}
 
static void client_suggestions_destroy(struct client *cl)
{
    NMEM nmem = cl->suggestions->nmem;
    cl->suggestions = 0;
    nmem_destroy(nmem);
}
 
/*
 * Local variables:
 * c-basic-offset: 4
 * c-file-style: "Stroustrup"
 * indent-tabs-mode: nil
 * End:
 * vim: shiftwidth=4 tabstop=8 expandtab
 */