1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2010 Index Data
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
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
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
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>
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>
58 #include <yaz/timing.h>
62 #include "parameters.h"
64 #include "connection.h"
66 #include "relevance.h"
69 /** \brief Represents client state for a connection to one search target */
71 struct session_database *database;
72 struct connection *connection;
73 struct session *session;
74 char *pquery; // Current search
75 char *cqlquery; // used for SRU targets only
81 enum client_state state;
82 struct show_raw *show_raw;
83 struct client *next; // next client in session or next in free list
84 ZOOM_resultset resultset;
90 int active; // whether this request has been sent to the server
95 void (*error_handler)(void *data, const char *addinfo);
96 void (*record_handler)(void *data, const char *buf, size_t sz);
98 struct show_raw *next;
101 static const char *client_states[] = {
107 "Client_Disconnected"
110 const char *client_get_state_str(struct client *cl)
112 return client_states[cl->state];
115 enum client_state client_get_state(struct client *cl)
120 void client_set_state(struct client *cl, enum client_state st)
123 /* no need to check for all client being non-active if this one
124 already is. Note that session_active_clients also LOCKS session */
126 if (!client_is_active(cl) && cl->session)
128 int no_active = session_active_clients(cl->session);
130 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
135 static void client_show_raw_error(struct client *cl, const char *addinfo);
137 // Close connection and set state to error
138 void client_fatal(struct client *cl)
140 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
141 connection_destroy(cl->connection);
142 client_set_state(cl, Client_Error);
145 struct connection *client_get_connection(struct client *cl)
147 return cl->connection;
150 struct session_database *client_get_database(struct client *cl)
155 struct session *client_get_session(struct client *cl)
160 const char *client_get_pquery(struct client *cl)
165 static void client_send_raw_present(struct client *cl);
166 static int nativesyntax_to_type(struct session_database *sdb, char *type,
169 static void client_show_immediate(
170 ZOOM_resultset resultset, struct session_database *sdb, int position,
172 void (*error_handler)(void *data, const char *addinfo),
173 void (*record_handler)(void *data, const char *buf, size_t sz),
183 error_handler(data, "no resultset");
186 rec = ZOOM_resultset_record(resultset, position-1);
189 error_handler(data, "no record");
195 nativesyntax_to_type(sdb, type, rec);
196 buf = ZOOM_record_get(rec, type, &len);
199 error_handler(data, "no record");
202 record_handler(data, buf, len);
206 int client_show_raw_begin(struct client *cl, int position,
207 const char *syntax, const char *esn,
209 void (*error_handler)(void *data, const char *addinfo),
210 void (*record_handler)(void *data, const char *buf,
214 if (syntax == 0 && esn == 0)
215 client_show_immediate(cl->resultset, client_get_database(cl),
217 error_handler, record_handler,
221 struct show_raw *rr, **rrp;
227 rr = xmalloc(sizeof(*rr));
228 rr->position = position;
231 rr->error_handler = error_handler;
232 rr->record_handler = record_handler;
235 rr->syntax = xstrdup(syntax);
239 rr->esn = xstrdup(esn);
244 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
248 if (cl->state == Client_Failed)
250 client_show_raw_error(cl, "client failed");
252 else if (cl->state == Client_Disconnected)
254 client_show_raw_error(cl, "client disconnected");
258 client_send_raw_present(cl);
264 static void client_show_raw_delete(struct show_raw *r)
271 void client_show_raw_remove(struct client *cl, void *data)
273 struct show_raw *rr = data;
274 struct show_raw **rrp = &cl->show_raw;
280 client_show_raw_delete(rr);
284 void client_show_raw_dequeue(struct client *cl)
286 struct show_raw *rr = cl->show_raw;
288 cl->show_raw = rr->next;
289 client_show_raw_delete(rr);
292 static void client_show_raw_error(struct client *cl, const char *addinfo)
296 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
297 client_show_raw_dequeue(cl);
301 static void client_send_raw_present(struct client *cl)
303 struct session_database *sdb = client_get_database(cl);
304 struct connection *co = client_get_connection(cl);
305 ZOOM_resultset set = cl->resultset;
307 int offset = cl->show_raw->position;
308 const char *syntax = 0;
309 const char *elements = 0;
311 assert(cl->show_raw);
314 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
315 client_get_url(cl), 1, offset);
317 if (cl->show_raw->syntax)
318 syntax = cl->show_raw->syntax;
320 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
321 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
323 if (cl->show_raw->esn)
324 elements = cl->show_raw->esn;
326 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
327 if (elements && *elements)
328 ZOOM_resultset_option_set(set, "elementSetName", elements);
330 ZOOM_resultset_records(set, 0, offset-1, 1);
331 cl->show_raw->active = 1;
333 connection_continue(co);
336 static int nativesyntax_to_type(struct session_database *sdb, char *type,
339 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
343 if (!strncmp(s, "iso2709", 7))
345 const char *cp = strchr(s, ';');
346 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
348 else if (!strncmp(s, "xml", 3))
352 else if (!strncmp(s, "txml", 4))
354 const char *cp = strchr(s, ';');
355 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
361 else /* attempt to deduce structure */
363 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
366 if (!strcmp(syntax, "XML"))
371 else if (!strcmp(syntax, "TXML"))
373 strcpy(type, "txml");
376 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
378 strcpy(type, "xml; charset=marc8-s");
387 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
393 if (cl->show_raw->binary)
397 struct session_database *sdb = client_get_database(cl);
398 nativesyntax_to_type(sdb, type, rec);
401 buf = ZOOM_record_get(rec, type, &len);
402 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
403 client_show_raw_dequeue(cl);
406 void client_search_response(struct client *cl)
408 struct connection *co = cl->connection;
409 struct session *se = cl->session;
410 ZOOM_connection link = connection_get_link(co);
411 ZOOM_resultset resultset = cl->resultset;
412 const char *error, *addinfo = 0;
414 if (ZOOM_connection_error(link, &error, &addinfo))
417 client_set_state(cl, Client_Error);
418 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
419 error, addinfo, client_get_url(cl));
423 cl->record_offset = cl->startrecs;
424 cl->hits = ZOOM_resultset_size(resultset);
426 se->total_hits += cl->hits;
430 void client_got_records(struct client *cl)
434 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
435 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
439 void client_record_response(struct client *cl)
441 struct connection *co = cl->connection;
442 ZOOM_connection link = connection_get_link(co);
443 ZOOM_resultset resultset = cl->resultset;
444 const char *error, *addinfo;
446 if (ZOOM_connection_error(link, &error, &addinfo))
448 client_set_state(cl, Client_Error);
449 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
450 error, addinfo, client_get_url(cl));
455 const char *msg, *addinfo;
457 if (cl->show_raw && cl->show_raw->active)
459 if ((rec = ZOOM_resultset_record(resultset,
460 cl->show_raw->position-1)))
462 cl->show_raw->active = 0;
463 ingest_raw_record(cl, rec);
467 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
468 cl->show_raw->position-1);
473 int offset = cl->record_offset;
474 if ((rec = ZOOM_resultset_record(resultset, offset)))
477 if (cl->session == 0)
479 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
480 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
481 error, addinfo, client_get_url(cl),
485 struct session_database *sdb = client_get_database(cl);
486 NMEM nmem = nmem_create();
489 if (nativesyntax_to_type(sdb, type, rec))
490 yaz_log(YLOG_WARN, "Failed to determine record type");
491 xmlrec = ZOOM_record_get(rec, type, NULL);
493 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
497 if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
498 yaz_log(YLOG_WARN, "Failed to ingest from %s",
506 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
513 void client_start_search(struct client *cl)
515 struct session_database *sdb = client_get_database(cl);
516 struct connection *co = client_get_connection(cl);
517 ZOOM_connection link = connection_get_link(co);
519 char *databaseName = sdb->database->databases[0];
520 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
521 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
522 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
523 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
524 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
525 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
526 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
527 char maxrecs_str[24], startrecs_str[24];
532 cl->record_offset = 0;
534 client_set_state(cl, Client_Working);
537 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
539 ZOOM_connection_option_set(link, "piggyback", "1");
541 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
542 if (*opt_sru && *opt_elements)
543 ZOOM_connection_option_set(link, "schema", opt_elements);
544 else if (*opt_elements)
545 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
547 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
551 sprintf(maxrecs_str, "%d", cl->maxrecs);
552 opt_maxrecs = maxrecs_str;
554 ZOOM_connection_option_set(link, "count", opt_maxrecs);
557 if (atoi(opt_maxrecs) > 20)
558 ZOOM_connection_option_set(link, "presentChunk", "20");
560 ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
562 sprintf(startrecs_str, "%d", cl->startrecs);
563 ZOOM_connection_option_set(link, "start", startrecs_str);
566 ZOOM_connection_option_set(link, "databaseName", databaseName);
570 ZOOM_query q = ZOOM_query_create();
571 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
572 ZOOM_query_cql(q, cl->cqlquery);
574 ZOOM_query_sortby(q, opt_sort);
575 rs = ZOOM_connection_search(link, q);
576 ZOOM_query_destroy(q);
580 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
581 rs = ZOOM_connection_search_pqf(link, cl->pquery);
583 ZOOM_resultset_destroy(cl->resultset);
585 connection_continue(co);
588 struct client *client_create(void)
590 struct client *r = xmalloc(sizeof(*r));
599 r->record_offset = 0;
601 r->state = Client_Disconnected;
606 yaz_mutex_create(&r->mutex);
612 void client_incref(struct client *c)
614 pazpar2_incref(&c->ref_count, c->mutex);
615 yaz_log(YLOG_DEBUG, "client_incref %s %d", client_get_url(c), c->ref_count);
618 int client_destroy(struct client *c)
622 yaz_log(YLOG_DEBUG, "client_destroy %s %d",
623 client_get_url(c), c->ref_count);
624 if (!pazpar2_decref(&c->ref_count, c->mutex))
632 ZOOM_resultset_destroy(c->resultset);
633 yaz_mutex_destroy(&c->mutex);
641 void client_set_connection(struct client *cl, struct connection *con)
645 assert(cl->connection == 0);
646 cl->connection = con;
651 cl->connection = con;
656 void client_disconnect(struct client *cl)
658 if (cl->state != Client_Idle)
659 client_set_state(cl, Client_Disconnected);
660 client_set_connection(cl, 0);
663 // Extract terms from query into null-terminated termlist
664 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
668 pull_terms(nmem, query, termlist, &num);
672 // Initialize CCL map for a target
673 static CCL_bibset prepare_cclmap(struct client *cl)
675 struct session_database *sdb = client_get_database(cl);
682 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
684 char *p = strchr(s->name + 3, ':');
687 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
692 ccl_qual_fitem(res, s->value, p);
697 // returns a xmalloced CQL query corresponding to the pquery in client
698 static char *make_cqlquery(struct client *cl)
700 cql_transform_t cqlt = cql_transform_create();
703 WRBUF wrb = wrbuf_alloc();
705 ODR odr_out = odr_createmem(ODR_ENCODE);
707 zquery = p_query_rpn(odr_out, cl->pquery);
708 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
709 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
711 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
716 r = xstrdup(wrbuf_cstr(wrb));
719 odr_destroy(odr_out);
720 cql_transform_close(cqlt);
724 // Parse the query given the settings specific to this client
725 int client_parse_query(struct client *cl, const char *query)
727 struct session *se = client_get_session(cl);
728 struct session_database *sdb = client_get_database(cl);
729 struct ccl_rpn_node *cn;
731 CCL_bibset ccl_map = prepare_cclmap(cl);
732 const char *sru = session_setting_oneval(sdb, PZ_SRU);
733 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
734 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
739 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
740 ccl_qual_rm(&ccl_map);
743 client_set_state(cl, Client_Error);
744 yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
746 client_get_database(cl)->database->url);
749 wrbuf_rewind(se->wrbuf);
752 wrbuf_puts(se->wrbuf, pqf_prefix);
753 wrbuf_puts(se->wrbuf, " ");
755 if (!pqf_strftime || !*pqf_strftime)
756 ccl_pquery(se->wrbuf, cn);
759 time_t cur_time = time(0);
760 struct tm *tm = localtime(&cur_time);
762 const char *cp = tmp_str;
764 /* see man strftime(3) for things .. In particular %% gets converted
765 to %.. And That's our original query .. */
766 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
770 ccl_pquery(se->wrbuf, cn);
772 wrbuf_putc(se->wrbuf, cp[0]);
776 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
781 if (!(cl->cqlquery = make_cqlquery(cl)))
789 // Initialize relevance structure with query terms
791 extract_terms(se->nmem, cn, p);
792 se->relevance = relevance_create(
793 se->service->relevance_pct,
794 se->nmem, (const char **) p);
802 void client_remove_from_session(struct client *c)
811 struct client **ccp = &se->clients;
813 while (*ccp && *ccp != c)
825 void client_set_session(struct client *cl, struct session *se)
828 cl->next = se->clients;
832 int client_is_active(struct client *cl)
834 if (cl->connection && (cl->state == Client_Connecting ||
835 cl->state == Client_Working))
840 struct client *client_next_in_session(struct client *cl)
848 Odr_int client_get_hits(struct client *cl)
853 int client_get_num_records(struct client *cl)
855 return cl->record_offset;
858 void client_set_diagnostic(struct client *cl, int diagnostic)
860 cl->diagnostic = diagnostic;
863 int client_get_diagnostic(struct client *cl)
865 return cl->diagnostic;
868 void client_set_database(struct client *cl, struct session_database *db)
873 struct host *client_get_host(struct client *cl)
875 return client_get_database(cl)->database->host;
878 const char *client_get_url(struct client *cl)
881 return client_get_database(cl)->database->url;
886 void client_set_maxrecs(struct client *cl, int v)
891 void client_set_startrecs(struct client *cl, int v)
899 * c-file-style: "Stroustrup"
900 * indent-tabs-mode: nil
902 * vim: shiftwidth=4 tabstop=8 expandtab