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>
63 #include "parameters.h"
65 #include "connection.h"
67 #include "relevance.h"
70 /* client counting (1) , disable client counting (0) */
72 static YAZ_MUTEX g_mutex = 0;
73 static int no_clients = 0;
75 static void client_use(int delta)
78 yaz_mutex_create(&g_mutex);
79 yaz_mutex_enter(g_mutex);
81 yaz_mutex_leave(g_mutex);
82 yaz_log(YLOG_LOG, "%s clients=%d", delta > 0 ? "INC" : "DEC", no_clients);
88 /** \brief Represents client state for a connection to one search target */
90 struct session_database *database;
91 struct connection *connection;
92 struct session *session;
93 char *pquery; // Current search
94 char *cqlquery; // used for SRU targets only
100 enum client_state state;
101 struct show_raw *show_raw;
102 struct client *next; // next client in session or next in free list
103 ZOOM_resultset resultset;
109 int active; // whether this request has been sent to the server
114 void (*error_handler)(void *data, const char *addinfo);
115 void (*record_handler)(void *data, const char *buf, size_t sz);
117 struct show_raw *next;
120 static const char *client_states[] = {
126 "Client_Disconnected"
129 const char *client_get_state_str(struct client *cl)
131 return client_states[cl->state];
134 enum client_state client_get_state(struct client *cl)
139 void client_set_state(struct client *cl, enum client_state st)
142 /* no need to check for all client being non-active if this one
143 already is. Note that session_active_clients also LOCKS session */
145 if (!client_is_active(cl) && cl->session)
147 int no_active = session_active_clients(cl->session);
149 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
154 static void client_show_raw_error(struct client *cl, const char *addinfo);
156 // Close connection and set state to error
157 void client_fatal(struct client *cl)
159 yaz_log(YLOG_WARN, "Fatal error from %s", client_get_url(cl));
160 connection_destroy(cl->connection);
161 client_set_state(cl, Client_Error);
164 struct connection *client_get_connection(struct client *cl)
166 return cl->connection;
169 struct session_database *client_get_database(struct client *cl)
174 struct session *client_get_session(struct client *cl)
179 const char *client_get_pquery(struct client *cl)
184 static void client_send_raw_present(struct client *cl);
185 static int nativesyntax_to_type(struct session_database *sdb, char *type,
188 static void client_show_immediate(
189 ZOOM_resultset resultset, struct session_database *sdb, int position,
191 void (*error_handler)(void *data, const char *addinfo),
192 void (*record_handler)(void *data, const char *buf, size_t sz),
202 error_handler(data, "no resultset");
205 rec = ZOOM_resultset_record(resultset, position-1);
208 error_handler(data, "no record");
214 nativesyntax_to_type(sdb, type, rec);
215 buf = ZOOM_record_get(rec, type, &len);
218 error_handler(data, "no record");
221 record_handler(data, buf, len);
225 int client_show_raw_begin(struct client *cl, int position,
226 const char *syntax, const char *esn,
228 void (*error_handler)(void *data, const char *addinfo),
229 void (*record_handler)(void *data, const char *buf,
233 if (syntax == 0 && esn == 0)
234 client_show_immediate(cl->resultset, client_get_database(cl),
236 error_handler, record_handler,
240 struct show_raw *rr, **rrp;
246 rr = xmalloc(sizeof(*rr));
247 rr->position = position;
250 rr->error_handler = error_handler;
251 rr->record_handler = record_handler;
254 rr->syntax = xstrdup(syntax);
258 rr->esn = xstrdup(esn);
263 for (rrp = &cl->show_raw; *rrp; rrp = &(*rrp)->next)
267 if (cl->state == Client_Failed)
269 client_show_raw_error(cl, "client failed");
271 else if (cl->state == Client_Disconnected)
273 client_show_raw_error(cl, "client disconnected");
277 client_send_raw_present(cl);
283 static void client_show_raw_delete(struct show_raw *r)
290 void client_show_raw_remove(struct client *cl, void *data)
292 struct show_raw *rr = data;
293 struct show_raw **rrp = &cl->show_raw;
299 client_show_raw_delete(rr);
303 void client_show_raw_dequeue(struct client *cl)
305 struct show_raw *rr = cl->show_raw;
307 cl->show_raw = rr->next;
308 client_show_raw_delete(rr);
311 static void client_show_raw_error(struct client *cl, const char *addinfo)
315 cl->show_raw->error_handler(cl->show_raw->data, addinfo);
316 client_show_raw_dequeue(cl);
320 static void client_send_raw_present(struct client *cl)
322 struct session_database *sdb = client_get_database(cl);
323 struct connection *co = client_get_connection(cl);
324 ZOOM_resultset set = cl->resultset;
326 int offset = cl->show_raw->position;
327 const char *syntax = 0;
328 const char *elements = 0;
330 assert(cl->show_raw);
333 yaz_log(YLOG_DEBUG, "%s: trying to present %d record(s) from %d",
334 client_get_url(cl), 1, offset);
336 if (cl->show_raw->syntax)
337 syntax = cl->show_raw->syntax;
339 syntax = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
340 ZOOM_resultset_option_set(set, "preferredRecordSyntax", syntax);
342 if (cl->show_raw->esn)
343 elements = cl->show_raw->esn;
345 elements = session_setting_oneval(sdb, PZ_ELEMENTS);
346 if (elements && *elements)
347 ZOOM_resultset_option_set(set, "elementSetName", elements);
349 ZOOM_resultset_records(set, 0, offset-1, 1);
350 cl->show_raw->active = 1;
352 connection_continue(co);
355 static int nativesyntax_to_type(struct session_database *sdb, char *type,
358 const char *s = session_setting_oneval(sdb, PZ_NATIVESYNTAX);
362 if (!strncmp(s, "iso2709", 7))
364 const char *cp = strchr(s, ';');
365 yaz_snprintf(type, 80, "xml; charset=%s", cp ? cp+1 : "marc-8s");
367 else if (!strncmp(s, "xml", 3))
371 else if (!strncmp(s, "txml", 4))
373 const char *cp = strchr(s, ';');
374 yaz_snprintf(type, 80, "txml; charset=%s", cp ? cp+1 : "marc-8s");
380 else /* attempt to deduce structure */
382 const char *syntax = ZOOM_record_get(rec, "syntax", NULL);
385 if (!strcmp(syntax, "XML"))
390 else if (!strcmp(syntax, "TXML"))
392 strcpy(type, "txml");
395 else if (!strcmp(syntax, "USmarc") || !strcmp(syntax, "MARC21"))
397 strcpy(type, "xml; charset=marc8-s");
406 static void ingest_raw_record(struct client *cl, ZOOM_record rec)
412 if (cl->show_raw->binary)
416 struct session_database *sdb = client_get_database(cl);
417 nativesyntax_to_type(sdb, type, rec);
420 buf = ZOOM_record_get(rec, type, &len);
421 cl->show_raw->record_handler(cl->show_raw->data, buf, len);
422 client_show_raw_dequeue(cl);
425 void client_search_response(struct client *cl)
427 struct connection *co = cl->connection;
428 struct session *se = cl->session;
429 ZOOM_connection link = connection_get_link(co);
430 ZOOM_resultset resultset = cl->resultset;
431 const char *error, *addinfo = 0;
433 if (ZOOM_connection_error(link, &error, &addinfo))
436 client_set_state(cl, Client_Error);
437 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
438 error, addinfo, client_get_url(cl));
442 cl->record_offset = cl->startrecs;
443 cl->hits = ZOOM_resultset_size(resultset);
445 se->total_hits += cl->hits;
449 void client_got_records(struct client *cl)
453 session_alert_watch(cl->session, SESSION_WATCH_SHOW);
454 session_alert_watch(cl->session, SESSION_WATCH_RECORD);
458 void client_record_response(struct client *cl)
460 struct connection *co = cl->connection;
461 ZOOM_connection link = connection_get_link(co);
462 ZOOM_resultset resultset = cl->resultset;
463 const char *error, *addinfo;
465 if (ZOOM_connection_error(link, &error, &addinfo))
467 client_set_state(cl, Client_Error);
468 yaz_log(YLOG_WARN, "Search error %s (%s): %s",
469 error, addinfo, client_get_url(cl));
474 const char *msg, *addinfo;
476 if (cl->show_raw && cl->show_raw->active)
478 if ((rec = ZOOM_resultset_record(resultset,
479 cl->show_raw->position-1)))
481 cl->show_raw->active = 0;
482 ingest_raw_record(cl, rec);
486 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
487 cl->show_raw->position-1);
492 int offset = cl->record_offset;
493 if ((rec = ZOOM_resultset_record(resultset, offset)))
496 if (cl->session == 0)
498 else if (ZOOM_record_error(rec, &msg, &addinfo, 0))
500 yaz_log(YLOG_WARN, "Record error %s (%s): %s (rec #%d)",
501 msg, addinfo, client_get_url(cl),
506 struct session_database *sdb = client_get_database(cl);
507 NMEM nmem = nmem_create();
511 if (nativesyntax_to_type(sdb, type, rec))
512 yaz_log(YLOG_WARN, "Failed to determine record type");
513 xmlrec = ZOOM_record_get(rec, type, NULL);
515 yaz_log(YLOG_WARN, "ZOOM_record_get failed from %s",
519 if (ingest_record(cl, xmlrec, cl->record_offset, nmem))
520 yaz_log(YLOG_WARN, "Failed to ingest from %s",
528 yaz_log(YLOG_WARN, "Expected record, but got NULL, offset=%d",
535 void client_start_search(struct client *cl)
537 struct session_database *sdb = client_get_database(cl);
538 struct connection *co = client_get_connection(cl);
539 ZOOM_connection link = connection_get_link(co);
541 char *databaseName = sdb->database->databases[0];
542 const char *opt_piggyback = session_setting_oneval(sdb, PZ_PIGGYBACK);
543 const char *opt_queryenc = session_setting_oneval(sdb, PZ_QUERYENCODING);
544 const char *opt_elements = session_setting_oneval(sdb, PZ_ELEMENTS);
545 const char *opt_requestsyn = session_setting_oneval(sdb, PZ_REQUESTSYNTAX);
546 const char *opt_maxrecs = session_setting_oneval(sdb, PZ_MAXRECS);
547 const char *opt_sru = session_setting_oneval(sdb, PZ_SRU);
548 const char *opt_sort = session_setting_oneval(sdb, PZ_SORT);
549 char maxrecs_str[24], startrecs_str[24];
554 cl->record_offset = 0;
556 client_set_state(cl, Client_Working);
559 ZOOM_connection_option_set(link, "piggyback", opt_piggyback);
561 ZOOM_connection_option_set(link, "piggyback", "1");
563 ZOOM_connection_option_set(link, "rpnCharset", opt_queryenc);
564 if (*opt_sru && *opt_elements)
565 ZOOM_connection_option_set(link, "schema", opt_elements);
566 else if (*opt_elements)
567 ZOOM_connection_option_set(link, "elementSetName", opt_elements);
569 ZOOM_connection_option_set(link, "preferredRecordSyntax", opt_requestsyn);
573 sprintf(maxrecs_str, "%d", cl->maxrecs);
574 opt_maxrecs = maxrecs_str;
576 ZOOM_connection_option_set(link, "count", opt_maxrecs);
579 if (atoi(opt_maxrecs) > 20)
580 ZOOM_connection_option_set(link, "presentChunk", "20");
582 ZOOM_connection_option_set(link, "presentChunk", opt_maxrecs);
584 sprintf(startrecs_str, "%d", cl->startrecs);
585 ZOOM_connection_option_set(link, "start", startrecs_str);
588 ZOOM_connection_option_set(link, "databaseName", databaseName);
592 ZOOM_query q = ZOOM_query_create();
593 yaz_log(YLOG_LOG, "Search %s CQL: %s", sdb->database->url, cl->cqlquery);
594 ZOOM_query_cql(q, cl->cqlquery);
596 ZOOM_query_sortby(q, opt_sort);
597 rs = ZOOM_connection_search(link, q);
598 ZOOM_query_destroy(q);
602 yaz_log(YLOG_LOG, "Search %s PQF: %s", sdb->database->url, cl->pquery);
603 rs = ZOOM_connection_search_pqf(link, cl->pquery);
605 ZOOM_resultset_destroy(cl->resultset);
607 connection_continue(co);
610 struct client *client_create(void)
612 struct client *r = xmalloc(sizeof(*r));
621 r->record_offset = 0;
623 r->state = Client_Disconnected;
628 pazpar2_mutex_create(&r->mutex, "client");
636 void client_incref(struct client *c)
638 pazpar2_incref(&c->ref_count, c->mutex);
639 yaz_log(YLOG_LOG, "client_incref c=%p %s cnt=%d",
640 c, client_get_url(c), c->ref_count);
643 int client_destroy(struct client *c)
647 yaz_log(YLOG_LOG, "client_destroy c=%p %s cnt=%d",
648 c, client_get_url(c), c->ref_count);
649 if (!pazpar2_decref(&c->ref_count, c->mutex))
656 assert(!c->connection);
657 assert(!c->resultset);
659 yaz_mutex_destroy(&c->mutex);
668 void client_set_connection(struct client *cl, struct connection *con)
672 ZOOM_resultset_destroy(cl->resultset);
677 assert(cl->connection == 0);
678 cl->connection = con;
683 cl->connection = con;
688 void client_disconnect(struct client *cl)
690 if (cl->state != Client_Idle)
691 client_set_state(cl, Client_Disconnected);
692 client_set_connection(cl, 0);
695 // Extract terms from query into null-terminated termlist
696 static void extract_terms(NMEM nmem, struct ccl_rpn_node *query, char **termlist)
700 pull_terms(nmem, query, termlist, &num);
704 // Initialize CCL map for a target
705 static CCL_bibset prepare_cclmap(struct client *cl)
707 struct session_database *sdb = client_get_database(cl);
714 for (s = sdb->settings[PZ_CCLMAP]; s; s = s->next)
716 char *p = strchr(s->name + 3, ':');
719 yaz_log(YLOG_WARN, "Malformed cclmap name: %s", s->name);
724 ccl_qual_fitem(res, s->value, p);
729 // returns a xmalloced CQL query corresponding to the pquery in client
730 static char *make_cqlquery(struct client *cl)
732 cql_transform_t cqlt = cql_transform_create();
735 WRBUF wrb = wrbuf_alloc();
737 ODR odr_out = odr_createmem(ODR_ENCODE);
739 zquery = p_query_rpn(odr_out, cl->pquery);
740 yaz_log(YLOG_LOG, "PQF: %s", cl->pquery);
741 if ((status = cql_transform_rpn2cql_wrbuf(cqlt, wrb, zquery)))
743 yaz_log(YLOG_WARN, "Failed to generate CQL query, code=%d", status);
748 r = xstrdup(wrbuf_cstr(wrb));
751 odr_destroy(odr_out);
752 cql_transform_close(cqlt);
756 // Parse the query given the settings specific to this client
757 int client_parse_query(struct client *cl, const char *query)
759 struct session *se = client_get_session(cl);
760 struct session_database *sdb = client_get_database(cl);
761 struct ccl_rpn_node *cn;
763 CCL_bibset ccl_map = prepare_cclmap(cl);
764 const char *sru = session_setting_oneval(sdb, PZ_SRU);
765 const char *pqf_prefix = session_setting_oneval(sdb, PZ_PQF_PREFIX);
766 const char *pqf_strftime = session_setting_oneval(sdb, PZ_PQF_STRFTIME);
771 cn = ccl_find_str(ccl_map, query, &cerror, &cpos);
772 ccl_qual_rm(&ccl_map);
775 client_set_state(cl, Client_Error);
776 yaz_log(YLOG_WARN, "Failed to parse CCL query %s for %s",
778 client_get_database(cl)->database->url);
781 wrbuf_rewind(se->wrbuf);
784 wrbuf_puts(se->wrbuf, pqf_prefix);
785 wrbuf_puts(se->wrbuf, " ");
787 if (!pqf_strftime || !*pqf_strftime)
788 ccl_pquery(se->wrbuf, cn);
791 time_t cur_time = time(0);
792 struct tm *tm = localtime(&cur_time);
794 const char *cp = tmp_str;
796 /* see man strftime(3) for things .. In particular %% gets converted
797 to %.. And That's our original query .. */
798 strftime(tmp_str, sizeof(tmp_str)-1, pqf_strftime, tm);
802 ccl_pquery(se->wrbuf, cn);
804 wrbuf_putc(se->wrbuf, cp[0]);
808 cl->pquery = xstrdup(wrbuf_cstr(se->wrbuf));
813 if (!(cl->cqlquery = make_cqlquery(cl)))
821 // Initialize relevance structure with query terms
823 extract_terms(se->nmem, cn, p);
824 se->relevance = relevance_create(
825 se->service->relevance_pct,
826 se->nmem, (const char **) p);
834 void client_remove_from_session(struct client *c)
842 struct client **ccp = &se->clients;
844 while (*ccp && *ccp != c)
855 void client_set_session(struct client *cl, struct session *se)
858 cl->next = se->clients;
862 int client_is_active(struct client *cl)
864 if (cl->connection && (cl->state == Client_Connecting ||
865 cl->state == Client_Working))
870 struct client *client_next_in_session(struct client *cl)
878 Odr_int client_get_hits(struct client *cl)
883 int client_get_num_records(struct client *cl)
885 return cl->record_offset;
888 void client_set_diagnostic(struct client *cl, int diagnostic)
890 cl->diagnostic = diagnostic;
893 int client_get_diagnostic(struct client *cl)
895 return cl->diagnostic;
898 void client_set_database(struct client *cl, struct session_database *db)
903 struct host *client_get_host(struct client *cl)
905 return client_get_database(cl)->database->host;
908 const char *client_get_url(struct client *cl)
911 return client_get_database(cl)->database->url;
916 void client_set_maxrecs(struct client *cl, int v)
921 void client_set_startrecs(struct client *cl, int v)
929 * c-file-style: "Stroustrup"
930 * indent-tabs-mode: nil
932 * vim: shiftwidth=4 tabstop=8 expandtab