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;
67 http_sessions_t http_sessions_create(void)
69 http_sessions_t hs = xmalloc(sizeof(*hs));
72 pazpar2_mutex_create(&hs->mutex, "http_sessions");
73 hs->log_level = yaz_log_module_level("HTTP");
77 void http_sessions_destroy(http_sessions_t hs)
81 struct http_session *s = hs->session_list;
84 struct http_session *s_next = s->next;
85 iochan_destroy(s->timeout_iochan);
86 destroy_session(s->psession);
87 nmem_destroy(s->nmem);
90 yaz_mutex_destroy(&hs->mutex);
95 void http_session_destroy(struct http_session *s);
97 static void session_timeout(IOCHAN i, int event)
99 struct http_session *s = iochan_getdata(i);
100 http_session_destroy(s);
103 struct http_session *http_session_create(struct conf_service *service,
104 http_sessions_t http_sessions,
107 NMEM nmem = nmem_create();
108 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
111 sprintf(tmp_str, "session#%u", sesid);
112 r->psession = new_session(nmem, service, tmp_str);
113 r->session_id = sesid;
116 r->destroy_counter = r->activity_counter = 0;
117 r->http_sessions = http_sessions;
119 yaz_mutex_enter(http_sessions->mutex);
120 r->next = http_sessions->session_list;
121 http_sessions->session_list = r;
122 yaz_mutex_leave(http_sessions->mutex);
124 r->timeout_iochan = iochan_create(-1, session_timeout, 0, "http_session_timeout");
125 iochan_setdata(r->timeout_iochan, r);
126 yaz_log(http_sessions->log_level, "%p Session %u created. timeout chan=%p timeout=%d", r, sesid, r->timeout_iochan, service->session_timeout);
127 iochan_settimeout(r->timeout_iochan, service->session_timeout);
129 iochan_add(service->server->iochan_man, r->timeout_iochan);
133 void http_session_destroy(struct http_session *s)
135 int must_destroy = 0;
137 http_sessions_t http_sessions = s->http_sessions;
139 yaz_log(http_sessions->log_level, "%p Session %u destroyed", s, s->session_id);
140 yaz_mutex_enter(http_sessions->mutex);
141 /* only if http_session has no active http sessions on it can be destroyed */
142 if (s->destroy_counter == s->activity_counter) {
143 struct http_session **p = 0;
145 for (p = &http_sessions->session_list; *p; p = &(*p)->next)
152 yaz_mutex_leave(http_sessions->mutex);
154 { /* destroying for real */
155 yaz_log(http_sessions->log_level, "%p Session %u destroyed", s, s->session_id);
156 iochan_destroy(s->timeout_iochan);
157 destroy_session(s->psession);
158 nmem_destroy(s->nmem);
161 yaz_log(http_sessions->log_level, "%p Session %u destroyed delayed. Active clients (%d-%d). Waiting for new timeout.",
162 s, s->session_id, s->activity_counter, s->destroy_counter);
167 static const char *get_msg(enum pazpar2_error_code code)
169 struct pazpar2_error_msg {
170 enum pazpar2_error_code code;
173 static const struct pazpar2_error_msg ar[] = {
174 { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
175 { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
176 { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
177 { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
178 { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
179 { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
180 { PAZPAR2_RECORD_MISSING, "Record missing"},
181 { PAZPAR2_NO_TARGETS, "No targets"},
182 { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
183 { PAZPAR2_RECORD_FAIL, "Record command failed"},
184 { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
185 { PAZPAR2_NO_SERVICE, "No service"},
186 { PAZPAR2_LAST_ERROR, "Last error"},
192 if (code == ar[i].code)
199 static void error(struct http_response *rs,
200 enum pazpar2_error_code code,
203 struct http_channel *c = rs->channel;
204 WRBUF text = wrbuf_alloc();
205 const char *http_status = "417";
206 const char *msg = get_msg(code);
208 rs->msg = nmem_strdup(c->nmem, msg);
209 strcpy(rs->code, http_status);
211 wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX "<error code=\"%d\" msg=\"%s\">", (int) code,
214 wrbuf_xmlputs(text, addinfo);
215 wrbuf_puts(text, "</error>");
217 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
218 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
219 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
221 http_send_response(c);
224 unsigned int make_sessionid(void)
226 static int seq = 0; /* thread pr */
230 if (global_parameters.debug_mode)
239 if (gettimeofday(&t, 0) < 0)
241 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
244 /* at most 256 sessions per second ..
245 (long long would be more appropriate)*/
247 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
253 static struct http_session *locate_session(struct http_channel *c)
255 struct http_response *rs = c->response;
256 struct http_request *rq = c->request;
257 struct http_session *p;
258 const char *session = http_argbyname(rq, "session");
259 http_sessions_t http_sessions = c->http_sessions;
264 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
268 yaz_mutex_enter(http_sessions->mutex);
269 for (p = http_sessions->session_list; p; p = p->next)
270 if (id == p->session_id)
273 p->activity_counter++;
274 yaz_mutex_leave(http_sessions->mutex);
276 iochan_activity(p->timeout_iochan);
278 error(rs, PAZPAR2_NO_SESSION, session);
282 // Call after use of locate_session, in order to increment the destroy_counter
283 static void release_session(struct http_channel *c, struct http_session *session) {
284 http_sessions_t http_sessions = c->http_sessions;
285 yaz_mutex_enter(http_sessions->mutex);
287 session->destroy_counter++;
288 yaz_mutex_leave(http_sessions->mutex);
291 // Decode settings parameters and apply to session
292 // Syntax: setting[target]=value
293 static int process_settings(struct session *se, struct http_request *rq,
294 struct http_response *rs)
296 struct http_argument *a;
298 for (a = rq->arguments; a; a = a->next)
299 if (strchr(a->name, '['))
306 // Nmem_strsplit *rules*!!!
307 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
310 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
315 session_apply_setting(se, dbname, setting,
316 nmem_strdup(se->session_nmem, a->value));
321 static void cmd_exit(struct http_channel *c)
323 yaz_log(YLOG_WARN, "exit");
324 http_close_server(c->server);
327 static void cmd_init(struct http_channel *c)
330 struct http_request *r = c->request;
331 const char *clear = http_argbyname(r, "clear");
332 const char *content_type = http_lookup_header(r->headers, "Content-Type");
334 struct http_session *s;
335 struct http_response *rs = c->response;
336 struct conf_service *service = 0; /* no service (yet) */
338 if (r->content_len && content_type &&
339 !yaz_strcmp_del("text/xml", content_type, "; "))
341 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
345 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
348 root_n = xmlDocGetRootElement(doc);
349 service = service_create(c->server, root_n);
353 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
360 const char *service_name = http_argbyname(c->request, "service");
361 service = locate_service(c->server, service_name);
364 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
368 sesid = make_sessionid();
369 s = http_session_create(service, c->http_sessions, sesid);
371 yaz_log(c->http_sessions->log_level, "%p Session init %u ", s, sesid);
372 if (!clear || *clear == '0')
373 session_init_databases(s->psession);
375 yaz_log(YLOG_LOG, "HTTP Session %u init: No databases preloaded", sesid);
377 if (process_settings(s->psession, c->request, c->response) < 0)
380 sprintf(buf, HTTP_COMMAND_RESPONSE_PREFIX
381 "<init><status>OK</status><session>%d", sesid);
382 if (c->server->server_id)
385 strcat(buf, c->server->server_id);
387 strcat(buf, "</session>"
388 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol></init>");
389 rs->payload = nmem_strdup(c->nmem, buf);
390 http_send_response(c);
393 static void apply_local_setting(void *client_data,
396 struct session *se = (struct session *) client_data;
398 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
399 nmem_strdup(se->session_nmem, set->name),
400 nmem_strdup(se->session_nmem, set->value));
403 static void cmd_settings(struct http_channel *c)
405 struct http_response *rs = c->response;
406 struct http_request *rq = c->request;
407 struct http_session *s = locate_session(c);
408 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
413 if (rq->content_len && content_type &&
414 !yaz_strcmp_del("text/xml", content_type, "; "))
416 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
420 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
423 root_n = xmlDocGetRootElement(doc);
425 settings_read_node_x(root_n, s->psession, apply_local_setting);
429 if (process_settings(s->psession, rq, rs) < 0) {
430 release_session(c,s);
433 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<settings><status>OK</status></settings>";
434 http_send_response(c);
435 release_session(c,s);
438 // Compares two hitsbytarget nodes by hitcount
439 static int cmp_ht(const void *p1, const void *p2)
441 const struct hitsbytarget *h1 = p1;
442 const struct hitsbytarget *h2 = p2;
443 return h2->hits - h1->hits;
446 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
447 static int targets_termlist(WRBUF wrbuf, struct session *se, int num,
450 struct hitsbytarget *ht;
453 ht = hitsbytarget(se, &count, nmem);
454 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
455 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
458 // do only print terms which have display names
460 wrbuf_puts(wrbuf, "<term>\n");
462 wrbuf_puts(wrbuf, "<id>");
463 wrbuf_xmlputs(wrbuf, ht[i].id);
464 wrbuf_puts(wrbuf, "</id>\n");
466 wrbuf_puts(wrbuf, "<name>");
467 if (!ht[i].name || !ht[i].name[0])
468 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
470 wrbuf_xmlputs(wrbuf, ht[i].name);
471 wrbuf_puts(wrbuf, "</name>\n");
473 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
476 wrbuf_puts(wrbuf, "<state>");
477 wrbuf_xmlputs(wrbuf, ht[i].state);
478 wrbuf_puts(wrbuf, "</state>\n");
480 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
482 wrbuf_puts(wrbuf, "</term>\n");
487 static void cmd_termlist(struct http_channel *c)
489 struct http_response *rs = c->response;
490 struct http_request *rq = c->request;
491 struct http_session *s = locate_session(c);
492 struct termlist_score **p;
495 const char *name = http_argbyname(rq, "name");
496 const char *nums = http_argbyname(rq, "num");
499 WRBUF debug_log = wrbuf_alloc();
504 status = session_active_clients(s->psession);
508 if (strlen(name) > 255)
513 wrbuf_rewind(c->wrbuf);
515 wrbuf_puts(c->wrbuf, "<termlist>\n");
516 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
522 if (!(tp = strchr(name, ',')))
523 tp = name + strlen(name);
524 strncpy(tname, name, tp - name);
525 tname[tp - name] = '\0';
526 wrbuf_puts(c->wrbuf, "<list name=\"");
527 wrbuf_xmlputs(c->wrbuf, tname);
528 wrbuf_puts(c->wrbuf, "\">\n");
529 if (!strcmp(tname, "xtargets")) {
530 int targets = targets_termlist(c->wrbuf, s->psession, num, c->nmem);
531 wrbuf_printf(debug_log, " xtargets: %d", targets);
535 p = termlist(s->psession, tname, &len);
537 wrbuf_printf(debug_log, " %s: %d", tname, len);
539 for (i = 0; i < len && i < num; i++){
540 // prevnt sending empty term elements
541 if (!p[i]->term || !p[i]->term[0])
544 wrbuf_puts(c->wrbuf, "<term>");
545 wrbuf_puts(c->wrbuf, "<name>");
546 wrbuf_xmlputs(c->wrbuf, p[i]->term);
547 wrbuf_puts(c->wrbuf, "</name>");
549 wrbuf_printf(c->wrbuf,
550 "<frequency>%d</frequency>",
552 wrbuf_puts(c->wrbuf, "</term>\n");
556 wrbuf_puts(c->wrbuf, "</list>\n");
561 wrbuf_puts(c->wrbuf, "</termlist>\n");
562 yaz_log(YLOG_DEBUG, "termlist response: %s ", wrbuf_cstr(debug_log));
563 wrbuf_destroy(debug_log);
564 rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
565 http_send_response(c);
566 release_session(c,s);
570 static void cmd_bytarget(struct http_channel *c)
572 struct http_response *rs = c->response;
573 struct http_request *rq = c->request;
574 struct http_session *s = locate_session(c);
575 struct hitsbytarget *ht;
576 const char *settings = http_argbyname(rq, "settings");
581 ht = hitsbytarget(s->psession, &count, c->nmem);
582 wrbuf_rewind(c->wrbuf);
583 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<bytarget><status>OK</status>");
585 for (i = 0; i < count; i++)
587 wrbuf_puts(c->wrbuf, "\n<target>");
589 wrbuf_puts(c->wrbuf, "<id>");
590 wrbuf_xmlputs(c->wrbuf, ht[i].id);
591 wrbuf_puts(c->wrbuf, "</id>\n");
593 if (ht[i].name && ht[i].name[0])
595 wrbuf_puts(c->wrbuf, "<name>");
596 wrbuf_xmlputs(c->wrbuf, ht[i].name);
597 wrbuf_puts(c->wrbuf, "</name>\n");
600 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
601 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
602 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
604 wrbuf_puts(c->wrbuf, "<state>");
605 wrbuf_xmlputs(c->wrbuf, ht[i].state);
606 wrbuf_puts(c->wrbuf, "</state>\n");
607 if (settings && *settings == '1')
609 wrbuf_puts(c->wrbuf, "<settings>\n");
610 wrbuf_puts(c->wrbuf, wrbuf_cstr(ht[i].settings_xml));
611 wrbuf_puts(c->wrbuf, "</settings>\n");
613 wrbuf_puts(c->wrbuf, "</target>");
614 wrbuf_destroy(ht[i].settings_xml);
617 wrbuf_puts(c->wrbuf, "</bytarget>");
618 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
619 http_send_response(c);
620 release_session(c,s);
623 static void write_metadata(WRBUF w, struct conf_service *service,
624 struct record_metadata **ml, int full)
628 for (imeta = 0; imeta < service->num_metadata; imeta++)
630 struct conf_metadata *cmd = &service->metadata[imeta];
631 struct record_metadata *md;
632 if (!cmd->brief && !full)
634 for (md = ml[imeta]; md; md = md->next)
636 struct record_metadata_attr *attr = md->attributes;
637 wrbuf_printf(w, "\n<md-%s", cmd->name);
639 for (; attr; attr = attr->next)
641 wrbuf_printf(w, " %s=\"", attr->name);
642 wrbuf_xmlputs(w, attr->value);
648 case Metadata_type_generic:
649 wrbuf_xmlputs(w, md->data.text.disp);
651 case Metadata_type_year:
652 wrbuf_printf(w, "%d", md->data.number.min);
653 if (md->data.number.min != md->data.number.max)
654 wrbuf_printf(w, "-%d", md->data.number.max);
657 wrbuf_puts(w, "[can't represent]");
659 wrbuf_printf(w, "</md-%s>", cmd->name);
664 static void write_subrecord(struct record *r, WRBUF w,
665 struct conf_service *service, int show_details)
667 const char *name = session_setting_oneval(
668 client_get_database(r->client), PZ_NAME);
670 wrbuf_puts(w, "<location id=\"");
671 wrbuf_xmlputs(w, client_get_database(r->client)->database->url);
672 wrbuf_puts(w, "\" ");
674 wrbuf_puts(w, "name=\"");
675 wrbuf_xmlputs(w, *name ? name : "Unknown");
676 wrbuf_puts(w, "\">");
678 write_metadata(w, service, r->metadata, show_details);
679 wrbuf_puts(w, "</location>\n");
682 static void show_raw_record_error(void *data, const char *addinfo)
684 http_channel_observer_t obs = data;
685 struct http_channel *c = http_channel_observer_chan(obs);
686 struct http_response *rs = c->response;
688 http_remove_observer(obs);
690 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
693 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
695 http_channel_observer_t obs = data;
696 struct http_channel *c = http_channel_observer_chan(obs);
697 struct http_response *rs = c->response;
699 http_remove_observer(obs);
701 wrbuf_write(c->wrbuf, buf, sz);
702 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
703 http_send_response(c);
707 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
709 http_channel_observer_t obs = data;
710 struct http_channel *c = http_channel_observer_chan(obs);
711 struct http_response *rs = c->response;
713 http_remove_observer(obs);
715 wrbuf_write(c->wrbuf, buf, sz);
716 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
718 rs->content_type = "application/octet-stream";
719 http_send_response(c);
723 void show_raw_reset(void *data, struct http_channel *c, void *data2)
725 //struct client *client = data;
726 //client_show_raw_remove(client, data2);
729 static void cmd_record_ready(void *data);
731 static void cmd_record(struct http_channel *c)
733 struct http_response *rs = c->response;
734 struct http_request *rq = c->request;
735 struct http_session *s = locate_session(c);
736 struct record_cluster *rec, *prev_r, *next_r;
738 struct conf_service *service;
739 const char *idstr = http_argbyname(rq, "id");
740 const char *offsetstr = http_argbyname(rq, "offset");
741 const char *binarystr = http_argbyname(rq, "binary");
745 service = s->psession->service;
748 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
751 wrbuf_rewind(c->wrbuf);
752 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
754 if (session_active_clients(s->psession) == 0)
756 error(rs, PAZPAR2_RECORD_MISSING, idstr);
758 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
759 cmd_record_ready, c, c) != 0)
761 error(rs, PAZPAR2_RECORD_MISSING, idstr);
763 release_session(c, s);
768 int offset = atoi(offsetstr);
769 const char *syntax = http_argbyname(rq, "syntax");
770 const char *esn = http_argbyname(rq, "esn");
772 struct record*r = rec->records;
775 if (binarystr && *binarystr != '0')
778 for (i = 0; i < offset && r; r = r->next, i++)
782 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
786 http_channel_observer_t obs =
787 http_add_observer(c, r->client, show_raw_reset);
788 int ret = client_show_raw_begin(r->client, r->position,
791 show_raw_record_error,
793 show_raw_record_ok_binary :
798 http_remove_observer(obs);
799 error(rs, PAZPAR2_NO_SESSION, 0);
805 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<record>\n");
806 wrbuf_puts(c->wrbuf, "<recid>");
807 wrbuf_xmlputs(c->wrbuf, rec->recid);
808 wrbuf_puts(c->wrbuf, "</recid>\n");
811 wrbuf_puts(c->wrbuf, "<prevrecid>");
812 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
813 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
817 wrbuf_puts(c->wrbuf, "<nextrecid>");
818 wrbuf_xmlputs(c->wrbuf, next_r->recid);
819 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
821 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n",
822 session_active_clients(s->psession));
823 write_metadata(c->wrbuf, service, rec->metadata, 1);
824 for (r = rec->records; r; r = r->next)
825 write_subrecord(r, c->wrbuf, service, 1);
826 wrbuf_puts(c->wrbuf, "</record>\n");
827 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
828 http_send_response(c);
830 show_single_stop(s->psession, rec);
831 release_session(c, s);
834 static void cmd_record_ready(void *data)
836 struct http_channel *c = (struct http_channel *) data;
841 static void show_records(struct http_channel *c, int active)
843 struct http_request *rq = c->request;
844 struct http_response *rs = c->response;
845 struct http_session *s = locate_session(c);
846 struct record_cluster **rl;
847 struct reclist_sortparms *sp;
848 const char *start = http_argbyname(rq, "start");
849 const char *num = http_argbyname(rq, "num");
850 const char *sort = http_argbyname(rq, "sort");
860 // We haven't counted clients yet if we're called on a block release
862 active = session_active_clients(s->psession);
865 startn = atoi(start);
870 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
872 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
873 release_session(c, s);
878 rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits);
880 wrbuf_rewind(c->wrbuf);
881 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<show>\n<status>OK</status>\n");
882 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
883 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
884 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
885 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
886 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
888 for (i = 0; i < numn; i++)
892 struct record_cluster *rec = rl[i];
893 struct conf_service *service = s->psession->service;
895 wrbuf_puts(c->wrbuf, "<hit>\n");
896 write_metadata(c->wrbuf, service, rec->metadata, 0);
897 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
898 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
900 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
901 if (strstr(sort, "relevance"))
902 wrbuf_printf(c->wrbuf, "<relevance>%d</relevance>\n",
903 rec->relevance_score);
904 wrbuf_puts(c->wrbuf, "<recid>");
905 wrbuf_xmlputs(c->wrbuf, rec->recid);
906 wrbuf_puts(c->wrbuf, "</recid>\n");
907 wrbuf_puts(c->wrbuf, "</hit>\n");
910 show_range_stop(s->psession, rl);
912 wrbuf_puts(c->wrbuf, "</show>\n");
913 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
914 http_send_response(c);
915 release_session(c, s);
918 static void show_records_ready(void *data)
920 struct http_channel *c = (struct http_channel *) data;
925 static void cmd_show(struct http_channel *c)
927 struct http_request *rq = c->request;
928 struct http_session *s = locate_session(c);
929 const char *block = http_argbyname(rq, "block");
935 status = session_active_clients(s->psession);
939 if (status && reclist_get_num_records(s->psession->reclist) == 0)
941 // if there is already a watch/block. we do not block this one
942 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
943 show_records_ready, c, c) != 0)
945 yaz_log(c->http_sessions->log_level, "%p Session %u: Blocking on cmd_show", s, s->session_id);
947 release_session(c,s);
951 show_records(c, status);
952 release_session(c,s);
955 static void cmd_ping(struct http_channel *c)
957 struct http_response *rs = c->response;
958 struct http_session *s = locate_session(c);
961 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<ping><status>OK</status></ping>";
962 http_send_response(c);
963 release_session(c, s);
966 static int utf_8_valid(const char *str)
968 yaz_iconv_t cd = yaz_iconv_open("utf-8", "utf-8");
971 /* check that query is UTF-8 encoded */
972 char *inbuf = (char *) str; /* we know iconv does not alter this */
973 size_t inbytesleft = strlen(inbuf);
975 size_t outbytesleft = strlen(inbuf) + 10;
976 char *out = xmalloc(outbytesleft);
978 size_t r = yaz_iconv(cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft);
980 /* if OK, try flushing the rest */
981 if (r != (size_t) (-1))
982 r = yaz_iconv(cd, 0, 0, &outbuf, &outbytesleft);
985 if (r == (size_t) (-1))
991 static void cmd_search(struct http_channel *c)
993 struct http_request *rq = c->request;
994 struct http_response *rs = c->response;
995 struct http_session *s = locate_session(c);
996 const char *query = http_argbyname(rq, "query");
997 const char *filter = http_argbyname(rq, "filter");
998 const char *maxrecs = http_argbyname(rq, "maxrecs");
999 const char *startrecs = http_argbyname(rq, "startrecs");
1000 enum pazpar2_error_code code;
1001 const char *addinfo = 0;
1007 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1008 release_session(c,s);
1011 if (!utf_8_valid(query))
1013 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1014 release_session(c,s);
1017 code = search(s->psession, query, startrecs, maxrecs, filter, &addinfo);
1020 error(rs, code, addinfo);
1021 release_session(c,s);
1024 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<search><status>OK</status></search>";
1025 http_send_response(c);
1026 release_session(c,s);
1030 static void cmd_stat(struct http_channel *c)
1032 struct http_response *rs = c->response;
1033 struct http_session *s = locate_session(c);
1034 struct statistics stat;
1042 clients = session_active_clients(s->psession);
1043 statistics(s->psession, &stat);
1045 if (stat.num_clients > 0) {
1046 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1049 wrbuf_rewind(c->wrbuf);
1050 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<stat>");
1051 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
1052 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1053 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
1054 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
1055 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
1056 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
1057 wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
1058 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
1059 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
1060 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
1061 wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
1062 wrbuf_puts(c->wrbuf, "</stat>");
1063 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1064 http_send_response(c);
1065 release_session(c,s);
1068 static void cmd_info(struct http_channel *c)
1070 char yaz_version_str[20];
1071 struct http_response *rs = c->response;
1073 wrbuf_rewind(c->wrbuf);
1074 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<info>\n");
1075 wrbuf_puts(c->wrbuf, " <version>\n");
1076 wrbuf_puts(c->wrbuf, "<pazpar2");
1077 #ifdef PAZPAR2_VERSION_SHA1
1078 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1080 wrbuf_puts(c->wrbuf, ">");
1081 wrbuf_xmlputs(c->wrbuf, VERSION);
1082 wrbuf_puts(c->wrbuf, "</pazpar2>");
1085 yaz_version(yaz_version_str, 0);
1086 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1087 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1088 wrbuf_puts(c->wrbuf, "\">");
1089 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1090 wrbuf_puts(c->wrbuf, "</yaz>\n");
1092 wrbuf_puts(c->wrbuf, " </version>\n");
1094 wrbuf_puts(c->wrbuf, "</info>");
1095 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1096 http_send_response(c);
1101 void (*fun)(struct http_channel *c);
1103 { "init", cmd_init },
1104 { "settings", cmd_settings },
1105 { "stat", cmd_stat },
1106 { "bytarget", cmd_bytarget },
1107 { "show", cmd_show },
1108 { "search", cmd_search },
1109 { "termlist", cmd_termlist },
1110 { "exit", cmd_exit },
1111 { "ping", cmd_ping },
1112 { "record", cmd_record },
1113 { "info", cmd_info },
1117 void http_command(struct http_channel *c)
1119 const char *command = http_argbyname(c->request, "command");
1120 struct http_response *rs = http_create_response(c);
1125 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1126 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1130 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1133 for (i = 0; commands[i].name; i++)
1134 if (!strcmp(commands[i].name, command))
1136 (*commands[i].fun)(c);
1139 if (!commands[i].name)
1140 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1148 * c-file-style: "Stroustrup"
1149 * indent-tabs-mode: nil
1151 * vim: shiftwidth=4 tabstop=8 expandtab