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
24 #include <sys/types.h>
33 #include <yaz/snprintf.h>
34 #include <yaz/yaz-util.h>
38 #include "parameters.h"
44 // Update this when the protocol changes
45 #define PAZPAR2_PROTOCOL_VERSION "1"
47 #define HTTP_COMMAND_RESPONSE_PREFIX "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
50 IOCHAN timeout_iochan; // NOTE: This is NOT associated with a socket
51 struct session *psession;
52 unsigned int session_id;
57 http_sessions_t http_sessions;
58 struct http_session *next;
61 struct http_sessions {
62 struct http_session *session_list;
66 http_sessions_t http_sessions_create(void)
68 http_sessions_t hs = xmalloc(sizeof(*hs));
71 pazpar2_mutex_create(&hs->mutex, "http_sessions");
75 void http_sessions_destroy(http_sessions_t hs)
79 struct http_session *s = hs->session_list;
82 struct http_session *s_next = s->next;
83 iochan_destroy(s->timeout_iochan);
84 destroy_session(s->psession);
85 nmem_destroy(s->nmem);
88 yaz_mutex_destroy(&hs->mutex);
93 void http_session_destroy(struct http_session *s);
95 static void session_timeout(IOCHAN i, int event)
97 struct http_session *s = iochan_getdata(i);
98 http_session_destroy(s);
101 struct http_session *http_session_create(struct conf_service *service,
102 http_sessions_t http_sessions,
105 NMEM nmem = nmem_create();
106 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
109 sprintf(tmp_str, "session#%u", sesid);
110 r->psession = new_session(nmem, service, tmp_str);
111 r->session_id = sesid;
114 r->destroy_counter = r->activity_counter = 0;
115 r->http_sessions = http_sessions;
117 yaz_mutex_enter(http_sessions->mutex);
118 r->next = http_sessions->session_list;
119 http_sessions->session_list = r;
120 yaz_mutex_leave(http_sessions->mutex);
122 r->timeout_iochan = iochan_create(-1, session_timeout, 0, "http_session_timeout");
123 iochan_setdata(r->timeout_iochan, r);
124 yaz_log(YLOG_LOG, "%p HTTP session %u created. timeout chan=%p timeout=%d", r, sesid, r->timeout_iochan, service->session_timeout);
125 iochan_settimeout(r->timeout_iochan, service->session_timeout);
127 iochan_add(service->server->iochan_man, r->timeout_iochan);
131 void http_session_destroy(struct http_session *s)
133 int must_destroy = 0;
135 http_sessions_t http_sessions = s->http_sessions;
137 yaz_log(YLOG_LOG, "%p HTTP session destroy %u", s, s->session_id);
138 yaz_mutex_enter(http_sessions->mutex);
139 /* only if http_session has no active http sessions on it can be destroyed */
140 if (s->destroy_counter == s->activity_counter) {
142 struct http_session **p = 0;
143 for (p = &http_sessions->session_list; *p; p = &(*p)->next)
150 yaz_mutex_leave(http_sessions->mutex);
152 { /* destroying for real */
153 yaz_log(YLOG_LOG, "Destroying session %u", s->session_id);
154 iochan_destroy(s->timeout_iochan);
155 destroy_session(s->psession);
156 nmem_destroy(s->nmem);
159 yaz_log(YLOG_DEBUG, "%p HTTP Session %d. Active clients (%d-%d). Waiting for new timeout.", s, s->session_id, s->activity_counter, s->destroy_counter);
164 static const char *get_msg(enum pazpar2_error_code code)
166 struct pazpar2_error_msg {
167 enum pazpar2_error_code code;
170 static const struct pazpar2_error_msg ar[] = {
171 { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
172 { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
173 { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
174 { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
175 { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
176 { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
177 { PAZPAR2_RECORD_MISSING, "Record missing"},
178 { PAZPAR2_NO_TARGETS, "No targets"},
179 { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
180 { PAZPAR2_RECORD_FAIL, "Record command failed"},
181 { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
182 { PAZPAR2_NO_SERVICE, "No service"},
183 { PAZPAR2_LAST_ERROR, "Last error"},
189 if (code == ar[i].code)
196 static void error(struct http_response *rs,
197 enum pazpar2_error_code code,
200 struct http_channel *c = rs->channel;
201 WRBUF text = wrbuf_alloc();
202 const char *http_status = "417";
203 const char *msg = get_msg(code);
205 rs->msg = nmem_strdup(c->nmem, msg);
206 strcpy(rs->code, http_status);
208 wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX "<error code=\"%d\" msg=\"%s\">", (int) code,
211 wrbuf_xmlputs(text, addinfo);
212 wrbuf_puts(text, "</error>");
214 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
215 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
216 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
218 http_send_response(c);
221 unsigned int make_sessionid(void)
223 static int seq = 0; /* thread pr */
227 if (global_parameters.debug_mode)
236 if (gettimeofday(&t, 0) < 0)
238 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
241 /* at most 256 sessions per second ..
242 (long long would be more appropriate)*/
244 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
250 static struct http_session *locate_session(struct http_channel *c)
252 struct http_response *rs = c->response;
253 struct http_request *rq = c->request;
254 struct http_session *p;
255 const char *session = http_argbyname(rq, "session");
256 http_sessions_t http_sessions = c->http_sessions;
261 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
265 yaz_mutex_enter(http_sessions->mutex);
266 for (p = http_sessions->session_list; p; p = p->next)
267 if (id == p->session_id)
270 p->activity_counter++;
271 yaz_mutex_leave(http_sessions->mutex);
273 iochan_activity(p->timeout_iochan);
275 error(rs, PAZPAR2_NO_SESSION, session);
279 // Call after use of locate_session, in order to increment the destroy_counter
280 static struct http_session *release_session(struct http_channel *c, struct http_session *session) {
281 http_sessions_t http_sessions = c->http_sessions;
282 yaz_mutex_enter(http_sessions->mutex);
284 session->destroy_counter++;
285 yaz_mutex_leave(http_sessions->mutex);
288 // Decode settings parameters and apply to session
289 // Syntax: setting[target]=value
290 static int process_settings(struct session *se, struct http_request *rq,
291 struct http_response *rs)
293 struct http_argument *a;
295 for (a = rq->arguments; a; a = a->next)
296 if (strchr(a->name, '['))
303 // Nmem_strsplit *rules*!!!
304 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
307 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
312 session_apply_setting(se, dbname, setting,
313 nmem_strdup(se->session_nmem, a->value));
318 static void cmd_exit(struct http_channel *c)
320 yaz_log(YLOG_WARN, "exit");
321 http_close_server(c->server);
324 static void cmd_init(struct http_channel *c)
327 struct http_request *r = c->request;
328 const char *clear = http_argbyname(r, "clear");
329 const char *content_type = http_lookup_header(r->headers, "Content-Type");
331 struct http_session *s;
332 struct http_response *rs = c->response;
333 struct conf_service *service = 0; /* no service (yet) */
335 if (r->content_len && content_type &&
336 !yaz_strcmp_del("text/xml", content_type, "; "))
338 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
342 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
345 root_n = xmlDocGetRootElement(doc);
346 service = service_create(c->server, root_n);
350 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
357 const char *service_name = http_argbyname(c->request, "service");
358 service = locate_service(c->server, service_name);
361 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
365 sesid = make_sessionid();
366 s = http_session_create(service, c->http_sessions, sesid);
368 yaz_log(YLOG_DEBUG, "HTTP Session init");
369 if (!clear || *clear == '0')
370 session_init_databases(s->psession);
372 yaz_log(YLOG_LOG, "No databases preloaded");
374 if (process_settings(s->psession, c->request, c->response) < 0)
377 sprintf(buf, HTTP_COMMAND_RESPONSE_PREFIX
378 "<init><status>OK</status><session>%d", sesid);
379 if (c->server->server_id)
382 strcat(buf, c->server->server_id);
384 strcat(buf, "</session>"
385 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol></init>");
386 rs->payload = nmem_strdup(c->nmem, buf);
387 http_send_response(c);
390 static void apply_local_setting(void *client_data,
393 struct session *se = (struct session *) client_data;
395 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
396 nmem_strdup(se->session_nmem, set->name),
397 nmem_strdup(se->session_nmem, set->value));
400 static void cmd_settings(struct http_channel *c)
402 struct http_response *rs = c->response;
403 struct http_request *rq = c->request;
404 struct http_session *s = locate_session(c);
405 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
410 if (rq->content_len && content_type &&
411 !yaz_strcmp_del("text/xml", content_type, "; "))
413 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
417 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
420 root_n = xmlDocGetRootElement(doc);
422 settings_read_node_x(root_n, s->psession, apply_local_setting);
426 if (process_settings(s->psession, rq, rs) < 0)
428 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<settings><status>OK</status></settings>";
429 http_send_response(c);
430 release_session(c,s);
433 // Compares two hitsbytarget nodes by hitcount
434 static int cmp_ht(const void *p1, const void *p2)
436 const struct hitsbytarget *h1 = p1;
437 const struct hitsbytarget *h2 = p2;
438 return h2->hits - h1->hits;
441 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
442 static void targets_termlist(WRBUF wrbuf, struct session *se, int num,
445 struct hitsbytarget *ht;
448 ht = hitsbytarget(se, &count, nmem);
449 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
450 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
453 // do only print terms which have display names
455 wrbuf_puts(wrbuf, "<term>\n");
457 wrbuf_puts(wrbuf, "<id>");
458 wrbuf_xmlputs(wrbuf, ht[i].id);
459 wrbuf_puts(wrbuf, "</id>\n");
461 wrbuf_puts(wrbuf, "<name>");
462 if (!ht[i].name || !ht[i].name[0])
463 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
465 wrbuf_xmlputs(wrbuf, ht[i].name);
466 wrbuf_puts(wrbuf, "</name>\n");
468 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
471 wrbuf_puts(wrbuf, "<state>");
472 wrbuf_xmlputs(wrbuf, ht[i].state);
473 wrbuf_puts(wrbuf, "</state>\n");
475 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
477 wrbuf_puts(wrbuf, "</term>\n");
481 static void cmd_termlist(struct http_channel *c)
483 struct http_response *rs = c->response;
484 struct http_request *rq = c->request;
485 struct http_session *s = locate_session(c);
486 struct termlist_score **p;
489 const char *name = http_argbyname(rq, "name");
490 const char *nums = http_argbyname(rq, "num");
497 status = session_active_clients(s->psession);
501 if (strlen(name) > 255)
506 wrbuf_rewind(c->wrbuf);
508 wrbuf_puts(c->wrbuf, "<termlist>\n");
509 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
515 if (!(tp = strchr(name, ',')))
516 tp = name + strlen(name);
517 strncpy(tname, name, tp - name);
518 tname[tp - name] = '\0';
520 wrbuf_puts(c->wrbuf, "<list name=\"");
521 wrbuf_xmlputs(c->wrbuf, tname);
522 wrbuf_puts(c->wrbuf, "\">\n");
523 if (!strcmp(tname, "xtargets"))
524 targets_termlist(c->wrbuf, s->psession, num, c->nmem);
527 p = termlist(s->psession, tname, &len);
529 for (i = 0; i < len && i < num; i++){
530 // prevnt sending empty term elements
531 if (!p[i]->term || !p[i]->term[0])
534 wrbuf_puts(c->wrbuf, "<term>");
535 wrbuf_puts(c->wrbuf, "<name>");
536 wrbuf_xmlputs(c->wrbuf, p[i]->term);
537 wrbuf_puts(c->wrbuf, "</name>");
539 wrbuf_printf(c->wrbuf,
540 "<frequency>%d</frequency>",
542 wrbuf_puts(c->wrbuf, "</term>\n");
545 wrbuf_puts(c->wrbuf, "</list>\n");
550 wrbuf_puts(c->wrbuf, "</termlist>\n");
551 rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
552 http_send_response(c);
553 release_session(c,s);
557 static void cmd_bytarget(struct http_channel *c)
559 struct http_response *rs = c->response;
560 struct http_request *rq = c->request;
561 struct http_session *s = locate_session(c);
562 struct hitsbytarget *ht;
563 const char *settings = http_argbyname(rq, "settings");
568 ht = hitsbytarget(s->psession, &count, c->nmem);
569 wrbuf_rewind(c->wrbuf);
570 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<bytarget><status>OK</status>");
572 for (i = 0; i < count; i++)
574 wrbuf_puts(c->wrbuf, "\n<target>");
576 wrbuf_puts(c->wrbuf, "<id>");
577 wrbuf_xmlputs(c->wrbuf, ht[i].id);
578 wrbuf_puts(c->wrbuf, "</id>\n");
580 if (ht[i].name && ht[i].name[0])
582 wrbuf_puts(c->wrbuf, "<name>");
583 wrbuf_xmlputs(c->wrbuf, ht[i].name);
584 wrbuf_puts(c->wrbuf, "</name>\n");
587 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
588 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
589 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
591 wrbuf_puts(c->wrbuf, "<state>");
592 wrbuf_xmlputs(c->wrbuf, ht[i].state);
593 wrbuf_puts(c->wrbuf, "</state>\n");
594 if (settings && *settings == '1')
596 wrbuf_puts(c->wrbuf, "<settings>\n");
597 wrbuf_puts(c->wrbuf, wrbuf_cstr(ht[i].settings_xml));
598 wrbuf_puts(c->wrbuf, "</settings>\n");
600 wrbuf_puts(c->wrbuf, "</target>");
601 wrbuf_destroy(ht[i].settings_xml);
604 wrbuf_puts(c->wrbuf, "</bytarget>");
605 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
606 http_send_response(c);
607 release_session(c,s);
610 static void write_metadata(WRBUF w, struct conf_service *service,
611 struct record_metadata **ml, int full)
615 for (imeta = 0; imeta < service->num_metadata; imeta++)
617 struct conf_metadata *cmd = &service->metadata[imeta];
618 struct record_metadata *md;
619 if (!cmd->brief && !full)
621 for (md = ml[imeta]; md; md = md->next)
623 struct record_metadata_attr *attr = md->attributes;
624 wrbuf_printf(w, "\n<md-%s", cmd->name);
626 for (; attr; attr = attr->next)
628 wrbuf_printf(w, " %s=\"", attr->name);
629 wrbuf_xmlputs(w, attr->value);
635 case Metadata_type_generic:
636 wrbuf_xmlputs(w, md->data.text.disp);
638 case Metadata_type_year:
639 wrbuf_printf(w, "%d", md->data.number.min);
640 if (md->data.number.min != md->data.number.max)
641 wrbuf_printf(w, "-%d", md->data.number.max);
644 wrbuf_puts(w, "[can't represent]");
646 wrbuf_printf(w, "</md-%s>", cmd->name);
651 static void write_subrecord(struct record *r, WRBUF w,
652 struct conf_service *service, int show_details)
654 const char *name = session_setting_oneval(
655 client_get_database(r->client), PZ_NAME);
657 wrbuf_puts(w, "<location id=\"");
658 wrbuf_xmlputs(w, client_get_database(r->client)->database->url);
659 wrbuf_puts(w, "\" ");
661 wrbuf_puts(w, "name=\"");
662 wrbuf_xmlputs(w, *name ? name : "Unknown");
663 wrbuf_puts(w, "\">");
665 write_metadata(w, service, r->metadata, show_details);
666 wrbuf_puts(w, "</location>\n");
669 static void show_raw_record_error(void *data, const char *addinfo)
671 http_channel_observer_t obs = data;
672 struct http_channel *c = http_channel_observer_chan(obs);
673 struct http_response *rs = c->response;
675 http_remove_observer(obs);
677 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
680 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
682 http_channel_observer_t obs = data;
683 struct http_channel *c = http_channel_observer_chan(obs);
684 struct http_response *rs = c->response;
686 http_remove_observer(obs);
688 wrbuf_write(c->wrbuf, buf, sz);
689 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
690 http_send_response(c);
694 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
696 http_channel_observer_t obs = data;
697 struct http_channel *c = http_channel_observer_chan(obs);
698 struct http_response *rs = c->response;
700 http_remove_observer(obs);
702 wrbuf_write(c->wrbuf, buf, sz);
703 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
705 rs->content_type = "application/octet-stream";
706 http_send_response(c);
710 void show_raw_reset(void *data, struct http_channel *c, void *data2)
712 //struct client *client = data;
713 //client_show_raw_remove(client, data2);
716 static void cmd_record_ready(void *data);
718 static void cmd_record(struct http_channel *c)
720 struct http_response *rs = c->response;
721 struct http_request *rq = c->request;
722 struct http_session *s = locate_session(c);
723 struct record_cluster *rec, *prev_r, *next_r;
725 struct conf_service *service;
726 const char *idstr = http_argbyname(rq, "id");
727 const char *offsetstr = http_argbyname(rq, "offset");
728 const char *binarystr = http_argbyname(rq, "binary");
732 service = s->psession->service;
735 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
738 wrbuf_rewind(c->wrbuf);
739 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
741 if (session_active_clients(s->psession) == 0)
743 error(rs, PAZPAR2_RECORD_MISSING, idstr);
745 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
746 cmd_record_ready, c, c) != 0)
748 error(rs, PAZPAR2_RECORD_MISSING, idstr);
750 release_session(c, s);
755 int offset = atoi(offsetstr);
756 const char *syntax = http_argbyname(rq, "syntax");
757 const char *esn = http_argbyname(rq, "esn");
759 struct record*r = rec->records;
762 if (binarystr && *binarystr != '0')
765 for (i = 0; i < offset && r; r = r->next, i++)
769 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
773 http_channel_observer_t obs =
774 http_add_observer(c, r->client, show_raw_reset);
775 int ret = client_show_raw_begin(r->client, r->position,
778 show_raw_record_error,
780 show_raw_record_ok_binary :
785 http_remove_observer(obs);
786 error(rs, PAZPAR2_NO_SESSION, 0);
792 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<record>\n");
793 wrbuf_puts(c->wrbuf, "<recid>");
794 wrbuf_xmlputs(c->wrbuf, rec->recid);
795 wrbuf_puts(c->wrbuf, "</recid>\n");
798 wrbuf_puts(c->wrbuf, "<prevrecid>");
799 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
800 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
804 wrbuf_puts(c->wrbuf, "<nextrecid>");
805 wrbuf_xmlputs(c->wrbuf, next_r->recid);
806 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
808 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n",
809 session_active_clients(s->psession));
810 write_metadata(c->wrbuf, service, rec->metadata, 1);
811 for (r = rec->records; r; r = r->next)
812 write_subrecord(r, c->wrbuf, service, 1);
813 wrbuf_puts(c->wrbuf, "</record>\n");
814 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
815 http_send_response(c);
817 show_single_stop(s->psession, rec);
818 release_session(c, s);
821 static void cmd_record_ready(void *data)
823 struct http_channel *c = (struct http_channel *) data;
828 static void show_records(struct http_channel *c, int active)
830 struct http_request *rq = c->request;
831 struct http_response *rs = c->response;
832 struct http_session *s = locate_session(c);
833 struct record_cluster **rl;
834 struct reclist_sortparms *sp;
835 const char *start = http_argbyname(rq, "start");
836 const char *num = http_argbyname(rq, "num");
837 const char *sort = http_argbyname(rq, "sort");
847 // We haven't counted clients yet if we're called on a block release
849 active = session_active_clients(s->psession);
852 startn = atoi(start);
857 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
859 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
860 release_session(c, s);
865 rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits);
867 wrbuf_rewind(c->wrbuf);
868 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<show>\n<status>OK</status>\n");
869 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
870 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
871 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
872 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
873 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
875 for (i = 0; i < numn; i++)
879 struct record_cluster *rec = rl[i];
880 struct conf_service *service = s->psession->service;
882 wrbuf_puts(c->wrbuf, "<hit>\n");
883 write_metadata(c->wrbuf, service, rec->metadata, 0);
884 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
885 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
887 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
888 if (strstr(sort, "relevance"))
889 wrbuf_printf(c->wrbuf, "<relevance>%d</relevance>\n",
890 rec->relevance_score);
891 wrbuf_puts(c->wrbuf, "<recid>");
892 wrbuf_xmlputs(c->wrbuf, rec->recid);
893 wrbuf_puts(c->wrbuf, "</recid>\n");
894 wrbuf_puts(c->wrbuf, "</hit>\n");
897 show_range_stop(s->psession, rl);
899 wrbuf_puts(c->wrbuf, "</show>\n");
900 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
901 http_send_response(c);
902 release_session(c, s);
905 static void show_records_ready(void *data)
907 struct http_channel *c = (struct http_channel *) data;
912 static void cmd_show(struct http_channel *c)
914 struct http_request *rq = c->request;
915 struct http_session *s = locate_session(c);
916 const char *block = http_argbyname(rq, "block");
922 status = session_active_clients(s->psession);
926 if (status && reclist_get_num_records(s->psession->reclist) == 0)
928 // if there is already a watch/block. we do not block this one
929 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
930 show_records_ready, c, c) != 0)
932 yaz_log(YLOG_DEBUG, "Blocking on cmd_show");
938 show_records(c, status);
939 release_session(c,s);
942 static void cmd_ping(struct http_channel *c)
944 struct http_response *rs = c->response;
945 struct http_session *s = locate_session(c);
948 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<ping><status>OK</status></ping>";
949 http_send_response(c);
950 release_session(c, s);
953 static int utf_8_valid(const char *str)
955 yaz_iconv_t cd = yaz_iconv_open("utf-8", "utf-8");
958 /* check that query is UTF-8 encoded */
959 char *inbuf = (char *) str; /* we know iconv does not alter this */
960 size_t inbytesleft = strlen(inbuf);
962 size_t outbytesleft = strlen(inbuf) + 10;
963 char *out = xmalloc(outbytesleft);
965 size_t r = yaz_iconv(cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft);
967 /* if OK, try flushing the rest */
968 if (r != (size_t) (-1))
969 r = yaz_iconv(cd, 0, 0, &outbuf, &outbytesleft);
972 if (r == (size_t) (-1))
978 static void cmd_search(struct http_channel *c)
980 struct http_request *rq = c->request;
981 struct http_response *rs = c->response;
982 struct http_session *s = locate_session(c);
983 const char *query = http_argbyname(rq, "query");
984 const char *filter = http_argbyname(rq, "filter");
985 const char *maxrecs = http_argbyname(rq, "maxrecs");
986 const char *startrecs = http_argbyname(rq, "startrecs");
987 enum pazpar2_error_code code;
988 const char *addinfo = 0;
994 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
995 release_session(c,s);
998 if (!utf_8_valid(query))
1000 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1001 release_session(c,s);
1004 code = search(s->psession, query, startrecs, maxrecs, filter, &addinfo);
1007 error(rs, code, addinfo);
1008 release_session(c,s);
1011 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<search><status>OK</status></search>";
1012 http_send_response(c);
1013 release_session(c,s);
1017 static void cmd_stat(struct http_channel *c)
1019 struct http_response *rs = c->response;
1020 struct http_session *s = locate_session(c);
1021 struct statistics stat;
1029 clients = session_active_clients(s->psession);
1030 statistics(s->psession, &stat);
1032 if (stat.num_clients > 0) {
1033 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1036 wrbuf_rewind(c->wrbuf);
1037 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<stat>");
1038 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
1039 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1040 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
1041 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
1042 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
1043 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
1044 wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
1045 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
1046 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
1047 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
1048 wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
1049 wrbuf_puts(c->wrbuf, "</stat>");
1050 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1051 http_send_response(c);
1052 release_session(c,s);
1055 static void cmd_info(struct http_channel *c)
1057 char yaz_version_str[20];
1058 struct http_response *rs = c->response;
1060 wrbuf_rewind(c->wrbuf);
1061 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<info>\n");
1062 wrbuf_puts(c->wrbuf, " <version>\n");
1063 wrbuf_puts(c->wrbuf, "<pazpar2");
1064 #ifdef PAZPAR2_VERSION_SHA1
1065 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1067 wrbuf_puts(c->wrbuf, ">");
1068 wrbuf_xmlputs(c->wrbuf, VERSION);
1069 wrbuf_puts(c->wrbuf, "</pazpar2>");
1072 yaz_version(yaz_version_str, 0);
1073 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1074 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1075 wrbuf_puts(c->wrbuf, "\">");
1076 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1077 wrbuf_puts(c->wrbuf, "</yaz>\n");
1079 wrbuf_puts(c->wrbuf, " </version>\n");
1081 wrbuf_puts(c->wrbuf, "</info>");
1082 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1083 http_send_response(c);
1088 void (*fun)(struct http_channel *c);
1090 { "init", cmd_init },
1091 { "settings", cmd_settings },
1092 { "stat", cmd_stat },
1093 { "bytarget", cmd_bytarget },
1094 { "show", cmd_show },
1095 { "search", cmd_search },
1096 { "termlist", cmd_termlist },
1097 { "exit", cmd_exit },
1098 { "ping", cmd_ping },
1099 { "record", cmd_record },
1100 { "info", cmd_info },
1104 void http_command(struct http_channel *c)
1106 const char *command = http_argbyname(c->request, "command");
1107 struct http_response *rs = http_create_response(c);
1112 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1113 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1117 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1120 for (i = 0; commands[i].name; i++)
1121 if (!strcmp(commands[i].name, command))
1123 (*commands[i].fun)(c);
1126 if (!commands[i].name)
1127 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1135 * c-file-style: "Stroustrup"
1136 * indent-tabs-mode: nil
1138 * vim: shiftwidth=4 tabstop=8 expandtab