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
39 #include <yaz/marcdisp.h>
40 #include <yaz/comstack.h>
41 #include <yaz/tcpip.h>
42 #include <yaz/proto.h>
43 #include <yaz/readconf.h>
44 #include <yaz/pquery.h>
45 #include <yaz/otherinfo.h>
46 #include <yaz/yaz-util.h>
48 #include <yaz/query-charset.h>
49 #include <yaz/querytowrbuf.h>
50 #include <yaz/oid_db.h>
51 #include <yaz/diagbib1.h>
52 #include <yaz/snprintf.h>
53 #include <yaz/rpn2cql.h>
57 #include <yaz/timing.h>
62 #include "parameters.h"
64 #include "connection.h"
66 #include "relevance.h"
69 /* client counting (1) , disable client counting (0) */
71 static YAZ_MUTEX g_mutex = 0;
72 static int no_clients = 0;
74 static void client_use(int delta)
77 yaz_mutex_create(&g_mutex);
78 yaz_mutex_enter(g_mutex);
80 yaz_mutex_leave(g_mutex);
81 yaz_log(YLOG_DEBUG, "%s clients=%d", delta > 0 ? "INC" : "DEC", no_clients);
87 /** \brief Represents client state for a connection to one search target */
89 struct session_database *database;
90 struct connection *connection;
91 struct session *session;
92 char *pquery; // Current search
93 char *cqlquery; // used for SRU targets only
99 enum client_state state;
100 struct show_raw *show_raw;
101 ZOOM_resultset resultset;
107 int active; // whether this request has been sent to the server
112 void (*error_handler)(void *data, const char *addinfo);
113 void (*record_handler)(void *data, const char *buf, size_t sz);
115 struct show_raw *next;
118 static const char *client_states[] = {
124 "Client_Disconnected"
127 const char *client_get_state_str(struct client *cl)
129 return client_states[cl->state];
132 enum client_state client_get_state(struct client *cl)
137 void client_set_state(struct client *cl, enum client_state st)
140 /* no need to check for all client being non-active if this one
141 already is. Note that session_active_clients also LOCKS session */
143 if (!client_is_active(cl) && cl->session)
145 int no_active = session_active_clients(cl->session);
147 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
152 static void client_show_raw_error(struct client *cl, const char *addinfo);
154 struct connection *client_get_connection(struct client *cl)
156 return cl->connection;
159 struct session_database *client_get_database(struct client *cl)
164 struct session *client_get_session(struct client *cl)
169 const char *client_get_pquery(struct client *cl)
174 static void client_send_raw_present(struct client *cl);
175 static int nativesyntax_to_type(struct session_database *sdb, char *type,
178 static void client_show_immediate(
179 ZOOM_resultset resultset, struct session_database *sdb, int position,
181 void (*error_handler)(void *data, const char *addinfo),
182 void (*record_handler)(void *data, const char *buf, size_t sz),
192 error_handler(data, "no resultset");
195 rec = ZOOM_resultset_record(resultset, position-1);
198 error_handler(data, "no record");
204 nativesyntax_to_type(sdb, type, rec);
205 buf = ZOOM_record_get(rec, type, &len);
208 error_handler(data, "no record");
211 record_handler(data, buf, len);
215 int client_show_raw_begin(struct client *cl, int position,
216 const char *syntax, const char *esn,
218 void (*error_handler)(void *data, const char *addinfo),
219 void (*record_handler)(void *data, const char *buf,
223 if (syntax == 0 && esn == 0)
224 client_show_immediate(cl->resultset, client_get_database(cl),
226 error_handler, record_handler,
230 struct show_raw *rr, **rrp;
236 rr = xmalloc(sizeof(*rr));
237 rr->position = position;
240 rr->error_handler = error_handler;
241 rr->record_handler = record_handler;
244 rr->syntax = xstrdup(syntax);
248 rr->esn = xstrdup(esn);
253 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
257 if (cl->state == Client_Failed)
259 client_show_raw_error(cl, "client failed");
261 else if (cl->state == Client_Disconnected)
263 client_show_raw_error(cl, "client disconnected");
267 client_send_raw_present(cl);
273 static void client_show_raw_delete(struct show_raw *r)
280 void client_show_raw_remove(struct client *cl, void *data)
282 struct show_raw *rr = data;
283 struct show_raw **rrp = &cl->show_raw;
289 client_show_raw_delete(rr);
293 void client_show_raw_dequeue(struct client *cl)
295 struct show_raw *rr = cl->show_raw;
297 cl->show_raw = rr->next;
298 client_show_raw_delete(rr);
301 static void client_show_raw_error(struct client *cl, const char *addinfo)
305 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
306 client_show_raw_dequeue(cl);
310 static void client_send_raw_present(struct client *cl)
312 struct session_database *sdb = client_get_database(cl);
313 struct connection *co = client_get_connection(cl);
314 ZOOM_resultset set = cl->resultset;
316 int offset = cl->show_raw->position;
317 const char *syntax = 0;
318 const char *elements = 0;
320 assert(cl->show_raw);
323 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
324 client_get_url(cl), 1, offset);
326 if (cl->show_raw->syntax)
327 syntax = cl->show_raw->syntax;
329 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
330 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
332 if (cl->show_raw->esn)
333 elements = cl->show_raw->esn;
335 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
336 if (elements && *elements)
337 ZOOM_resultset_option_set(set, "elementSetName", elements);
339 ZOOM_resultset_records(set, 0, offset-1, 1);
340 cl->show_raw->active = 1;
342 connection_continue(co);
345 static int nativesyntax_to_type(struct session_database *sdb, char *type,
348 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
352 if (!strncmp(s, "iso2709", 7))
354 const char *cp = strchr(s, ';');
355 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
357 else if (!strncmp(s, "xml", 3))
361 else if (!strncmp(s, "txml", 4))
363 const char *cp = strchr(s, ';');
364 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
370 else /* attempt to deduce structure */
372 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
375 if (!strcmp(syntax, "XML"))
380 else if (!strcmp(syntax, "TXML"))
382 strcpy(type, "txml");
385 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
387 strcpy(type, "xml; charset=marc8-s");
396 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
402 if (cl->show_raw->binary)
406 struct session_database *sdb = client_get_database(cl);
407 nativesyntax_to_type(sdb, type, rec);
410 buf = ZOOM_record_get(rec, type, &len);
411 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
412 client_show_raw_dequeue(cl);
415 void client_search_response(struct client *cl)
417 struct connection *co = cl->connection;
418 struct session *se = cl->session;
419 ZOOM_connection link = connection_get_link(co);
420 ZOOM_resultset resultset = cl->resultset;
421 const char *error, *addinfo = 0;
423 if (ZOOM_connection_error(link, &error, &addinfo))
426 client_set_state(cl, Client_Error);
427 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
428 error, addinfo, client_get_url(cl));
432 cl->record_offset = cl->startrecs;
433 cl->hits = ZOOM_resultset_size(resultset);
435 se->total_hits += cl->hits;
439 void client_got_records(struct client *cl)
441 struct session *se = cl->session;
445 session_alert_watch(se, SESSION_WATCH_SHOW);
446 session_alert_watch(se, SESSION_WATCH_RECORD);
451 void client_record_response(struct client *cl)
453 struct connection *co = cl->connection;
454 ZOOM_connection link = connection_get_link(co);
455 ZOOM_resultset resultset = cl->resultset;
456 const char *error, *addinfo;
458 if (ZOOM_connection_error(link, &error, &addinfo))
460 client_set_state(cl, Client_Error);
461 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
462 error, addinfo, client_get_url(cl));
467 const char *msg, *addinfo;
469 if (cl->show_raw && cl->show_raw->active)
471 if ((rec = ZOOM_resultset_record(resultset,
472 cl->show_raw->position-1)))
474 cl->show_raw->active = 0;
475 ingest_raw_record(cl, rec);
479 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
480 cl->show_raw->position-1);
485 int offset = cl->record_offset;
486 if ((rec = ZOOM_resultset_record(resultset, offset)))
489 if (cl->session == 0)
491 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
493 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
494 msg, addinfo, client_get_url(cl),
499 struct session_database *sdb = client_get_database(cl);
500 NMEM nmem = nmem_create();
504 if (nativesyntax_to_type(sdb, type, rec))
505 yaz_log(YLOG_WARN, "Failed to determine record type");
506 xmlrec = ZOOM_record_get(rec, type, NULL);
508 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
512 if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
513 yaz_log(YLOG_WARN, "Failed to ingest from %s",
521 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
528 void client_start_search(struct client *cl)
530 struct session_database *sdb = client_get_database(cl);
531 struct connection *co = client_get_connection(cl);
532 ZOOM_connection link = connection_get_link(co);
534 char *databaseName = sdb->database->databases[0];
535 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
536 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
537 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
538 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
539 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
540 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
541 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
542 char maxrecs_str[24], startrecs_str[24];
547 cl->record_offset = 0;
549 client_set_state(cl, Client_Working);
552 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
554 ZOOM_connection_option_set(link, "piggyback", "1");
556 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
557 if (*opt_sru && *opt_elements)
558 ZOOM_connection_option_set(link, "schema", opt_elements);
559 else if (*opt_elements)
560 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
562 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
566 sprintf(maxrecs_str, "%d", cl->maxrecs);
567 opt_maxrecs = maxrecs_str;
569 ZOOM_connection_option_set(link, "count", opt_maxrecs);
572 if (atoi(opt_maxrecs) > 20)
573 ZOOM_connection_option_set(link, "presentChunk", "20");
575 ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
577 sprintf(startrecs_str, "%d", cl->startrecs);
578 ZOOM_connection_option_set(link, "start", startrecs_str);
581 ZOOM_connection_option_set(link, "databaseName", databaseName);
585 ZOOM_query q = ZOOM_query_create();
586 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
587 ZOOM_query_cql(q, cl->cqlquery);
589 ZOOM_query_sortby(q, opt_sort);
590 rs = ZOOM_connection_search(link, q);
591 ZOOM_query_destroy(q);
595 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
596 rs = ZOOM_connection_search_pqf(link, cl->pquery);
598 ZOOM_resultset_destroy(cl->resultset);
600 connection_continue(co);
603 struct client *client_create(void)
605 struct client *r = xmalloc(sizeof(*r));
614 r->record_offset = 0;
616 r->state = Client_Disconnected;
620 pazpar2_mutex_create(&r->mutex, "client");
628 void client_lock(struct client *c)
630 yaz_mutex_enter(c->mutex);
633 void client_unlock(struct client *c)
635 yaz_mutex_leave(c->mutex);
638 void client_incref(struct client *c)
640 pazpar2_incref(&c->ref_count, c->mutex);
641 yaz_log(YLOG_DEBUG, "client_incref c=%p %s cnt=%d",
642 c, client_get_url(c), c->ref_count);
645 int client_destroy(struct client *c)
649 yaz_log(YLOG_DEBUG, "client_destroy c=%p %s cnt=%d",
650 c, client_get_url(c), c->ref_count);
651 if (!pazpar2_decref(&c->ref_count, c->mutex))
657 assert(!c->connection);
658 assert(!c->resultset);
660 yaz_mutex_destroy(&c->mutex);
669 void client_set_connection(struct client *cl, struct connection *con)
673 ZOOM_resultset_destroy(cl->resultset);
678 assert(cl->connection == 0);
679 cl->connection = con;
684 cl->connection = con;
689 void client_disconnect(struct client *cl)
691 if (cl->state != Client_Idle)
692 client_set_state(cl, Client_Disconnected);
693 client_set_connection(cl, 0);
696 // Extract terms from query into null-terminated termlist
697 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
701 pull_terms(nmem, query, termlist, &num);
705 // Initialize CCL map for a target
706 static CCL_bibset prepare_cclmap(struct client *cl)
708 struct session_database *sdb = client_get_database(cl);
715 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
717 char *p = strchr(s->name + 3, ':');
720 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
725 ccl_qual_fitem(res, s->value, p);
730 // returns a xmalloced CQL query corresponding to the pquery in client
731 static char *make_cqlquery(struct client *cl)
733 cql_transform_t cqlt = cql_transform_create();
736 WRBUF wrb = wrbuf_alloc();
738 ODR odr_out = odr_createmem(ODR_ENCODE);
740 zquery = p_query_rpn(odr_out, cl->pquery);
741 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
742 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
744 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
749 r = xstrdup(wrbuf_cstr(wrb));
752 odr_destroy(odr_out);
753 cql_transform_close(cqlt);
757 // Parse the query given the settings specific to this client
758 int client_parse_query(struct client *cl, const char *query)
760 struct session *se = client_get_session(cl);
761 struct session_database *sdb = client_get_database(cl);
762 struct ccl_rpn_node *cn;
764 CCL_bibset ccl_map = prepare_cclmap(cl);
765 const char *sru = session_setting_oneval(sdb, PZ_SRU);
766 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
767 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
772 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
773 ccl_qual_rm(&ccl_map);
776 client_set_state(cl, Client_Error);
777 yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
779 client_get_database(cl)->database->url);
782 wrbuf_rewind(se->wrbuf);
785 wrbuf_puts(se->wrbuf, pqf_prefix);
786 wrbuf_puts(se->wrbuf, " ");
788 if (!pqf_strftime || !*pqf_strftime)
789 ccl_pquery(se->wrbuf, cn);
792 time_t cur_time = time(0);
793 struct tm *tm = localtime(&cur_time);
795 const char *cp = tmp_str;
797 /* see man strftime(3) for things .. In particular %% gets converted
798 to %.. And That's our original query .. */
799 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
803 ccl_pquery(se->wrbuf, cn);
805 wrbuf_putc(se->wrbuf, cp[0]);
809 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
814 if (!(cl->cqlquery = make_cqlquery(cl)))
822 // Initialize relevance structure with query terms
824 extract_terms(se->nmem, cn, p);
825 se->relevance = relevance_create(
826 se->service->relevance_pct,
827 se->nmem, (const char **) p);
834 void client_set_session(struct client *cl, struct session *se)
839 int client_is_active(struct client *cl)
841 if (cl->connection && (cl->state == Client_Connecting ||
842 cl->state == Client_Working))
847 Odr_int client_get_hits(struct client *cl)
852 int client_get_num_records(struct client *cl)
854 return cl->record_offset;
857 void client_set_diagnostic(struct client *cl, int diagnostic)
859 cl->diagnostic = diagnostic;
862 int client_get_diagnostic(struct client *cl)
864 return cl->diagnostic;
867 void client_set_database(struct client *cl, struct session_database *db)
872 struct host *client_get_host(struct client *cl)
874 return client_get_database(cl)->database->host;
877 const char *client_get_url(struct client *cl)
880 return client_get_database(cl)->database->url;
885 void client_set_maxrecs(struct client *cl, int v)
890 void client_set_startrecs(struct client *cl, int v)
898 * c-file-style: "Stroustrup"
899 * indent-tabs-mode: nil
901 * vim: shiftwidth=4 tabstop=8 expandtab