1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2011 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 static YAZ_MUTEX g_http_session_mutex = 0;
68 static int g_http_sessions = 0;
70 int http_session_use(int delta)
73 if (!g_http_session_mutex)
74 yaz_mutex_create(&g_http_session_mutex);
75 yaz_mutex_enter(g_http_session_mutex);
76 g_http_sessions += delta;
77 sessions = g_http_sessions;
78 yaz_mutex_leave(g_http_session_mutex);
79 yaz_log(YLOG_DEBUG, "%s sesions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), sessions);
84 http_sessions_t http_sessions_create(void)
86 http_sessions_t hs = xmalloc(sizeof(*hs));
89 pazpar2_mutex_create(&hs->mutex, "http_sessions");
90 hs->log_level = yaz_log_module_level("HTTP");
94 void http_sessions_destroy(http_sessions_t hs)
98 struct http_session *s = hs->session_list;
101 struct http_session *s_next = s->next;
102 iochan_destroy(s->timeout_iochan);
103 destroy_session(s->psession);
104 nmem_destroy(s->nmem);
107 yaz_mutex_destroy(&hs->mutex);
112 void http_session_destroy(struct http_session *s);
114 static void session_timeout(IOCHAN i, int event)
116 struct http_session *s = iochan_getdata(i);
117 http_session_destroy(s);
120 struct http_session *http_session_create(struct conf_service *service,
121 http_sessions_t http_sessions,
124 NMEM nmem = nmem_create();
125 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
128 sprintf(tmp_str, "session#%u", sesid);
129 r->psession = new_session(nmem, service, sesid);
130 r->session_id = sesid;
133 r->destroy_counter = r->activity_counter = 0;
134 r->http_sessions = http_sessions;
136 yaz_mutex_enter(http_sessions->mutex);
137 r->next = http_sessions->session_list;
138 http_sessions->session_list = r;
139 yaz_mutex_leave(http_sessions->mutex);
141 r->timeout_iochan = iochan_create(-1, session_timeout, 0, "http_session_timeout");
142 iochan_setdata(r->timeout_iochan, r);
143 yaz_log(http_sessions->log_level, "%p Session %u created. timeout chan=%p timeout=%d", r, sesid, r->timeout_iochan, service->session_timeout);
144 iochan_settimeout(r->timeout_iochan, service->session_timeout);
146 iochan_add(service->server->iochan_man, r->timeout_iochan);
151 void http_session_destroy(struct http_session *s)
153 int must_destroy = 0;
155 http_sessions_t http_sessions = s->http_sessions;
157 yaz_log(http_sessions->log_level, "%p HTTP Session %u destroyed", s, s->session_id);
158 yaz_mutex_enter(http_sessions->mutex);
159 /* only if http_session has no active http sessions on it can be destroyed */
160 if (s->destroy_counter == s->activity_counter) {
161 struct http_session **p = 0;
163 for (p = &http_sessions->session_list; *p; p = &(*p)->next)
170 yaz_mutex_leave(http_sessions->mutex);
172 { /* destroying for real */
173 yaz_log(http_sessions->log_level, "%p HTTP Session %u destroyed", s, s->session_id);
174 iochan_destroy(s->timeout_iochan);
175 destroy_session(s->psession);
176 http_session_use(-1);
177 nmem_destroy(s->nmem);
180 yaz_log(http_sessions->log_level, "%p HTTP Session %u destroyed delayed. Active clients (%d-%d). Waiting for new timeout.",
181 s, s->session_id, s->activity_counter, s->destroy_counter);
186 static const char *get_msg(enum pazpar2_error_code code)
188 struct pazpar2_error_msg {
189 enum pazpar2_error_code code;
192 static const struct pazpar2_error_msg ar[] = {
193 { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
194 { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
195 { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
196 { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
197 { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
198 { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
199 { PAZPAR2_RECORD_MISSING, "Record missing"},
200 { PAZPAR2_NO_TARGETS, "No targets"},
201 { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
202 { PAZPAR2_RECORD_FAIL, "Record command failed"},
203 { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
204 { PAZPAR2_NO_SERVICE, "No service"},
205 { PAZPAR2_LAST_ERROR, "Last error"},
211 if (code == ar[i].code)
218 static void error(struct http_response *rs,
219 enum pazpar2_error_code code,
222 struct http_channel *c = rs->channel;
223 WRBUF text = wrbuf_alloc();
224 const char *http_status = "417";
225 const char *msg = get_msg(code);
227 rs->msg = nmem_strdup(c->nmem, msg);
228 strcpy(rs->code, http_status);
230 wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX "<error code=\"%d\" msg=\"%s\">", (int) code,
233 wrbuf_xmlputs(text, addinfo);
234 wrbuf_puts(text, "</error>");
236 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
237 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
238 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
240 http_send_response(c);
243 unsigned int make_sessionid(void)
245 static int seq = 0; /* thread pr */
249 if (global_parameters.debug_mode)
258 if (gettimeofday(&t, 0) < 0)
260 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
263 /* at most 256 sessions per second ..
264 (long long would be more appropriate)*/
266 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
272 static struct http_session *locate_session(struct http_channel *c)
274 struct http_response *rs = c->response;
275 struct http_request *rq = c->request;
276 struct http_session *p;
277 const char *session = http_argbyname(rq, "session");
278 http_sessions_t http_sessions = c->http_sessions;
283 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
287 yaz_mutex_enter(http_sessions->mutex);
288 for (p = http_sessions->session_list; p; p = p->next)
289 if (id == p->session_id)
292 p->activity_counter++;
293 yaz_mutex_leave(http_sessions->mutex);
295 iochan_activity(p->timeout_iochan);
297 error(rs, PAZPAR2_NO_SESSION, session);
301 // Call after use of locate_session, in order to increment the destroy_counter
302 static void release_session(struct http_channel *c, struct http_session *session) {
303 http_sessions_t http_sessions = c->http_sessions;
304 yaz_mutex_enter(http_sessions->mutex);
306 session->destroy_counter++;
307 yaz_mutex_leave(http_sessions->mutex);
310 // Decode settings parameters and apply to session
311 // Syntax: setting[target]=value
312 static int process_settings(struct session *se, struct http_request *rq,
313 struct http_response *rs)
315 struct http_argument *a;
317 for (a = rq->arguments; a; a = a->next)
318 if (strchr(a->name, '['))
325 // Nmem_strsplit *rules*!!!
326 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
329 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
334 session_apply_setting(se, dbname, setting,
335 nmem_strdup(se->session_nmem, a->value));
340 static void cmd_exit(struct http_channel *c)
342 yaz_log(YLOG_WARN, "exit");
343 http_close_server(c->server);
346 static void cmd_init(struct http_channel *c)
349 struct http_request *r = c->request;
350 const char *clear = http_argbyname(r, "clear");
351 const char *content_type = http_lookup_header(r->headers, "Content-Type");
353 struct http_session *s;
354 struct http_response *rs = c->response;
355 struct conf_service *service = 0; /* no service (yet) */
357 if (r->content_len && content_type &&
358 !yaz_strcmp_del("text/xml", content_type, "; "))
360 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
364 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
367 root_n = xmlDocGetRootElement(doc);
368 service = service_create(c->server, root_n);
372 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
379 const char *service_name = http_argbyname(c->request, "service");
380 service = locate_service(c->server, service_name);
383 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
387 sesid = make_sessionid();
388 s = http_session_create(service, c->http_sessions, sesid);
390 yaz_log(c->http_sessions->log_level, "%p Session init %u ", s, sesid);
391 if (!clear || *clear == '0')
392 session_init_databases(s->psession);
394 yaz_log(YLOG_LOG, "HTTP Session %u init: No databases preloaded", sesid);
396 if (process_settings(s->psession, c->request, c->response) < 0)
399 sprintf(buf, HTTP_COMMAND_RESPONSE_PREFIX
400 "<init><status>OK</status><session>%d", sesid);
401 if (c->server->server_id)
404 strcat(buf, c->server->server_id);
406 strcat(buf, "</session>"
407 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol></init>");
408 rs->payload = nmem_strdup(c->nmem, buf);
409 http_send_response(c);
412 static void apply_local_setting(void *client_data,
415 struct session *se = (struct session *) client_data;
417 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
418 nmem_strdup(se->session_nmem, set->name),
419 nmem_strdup(se->session_nmem, set->value));
422 static void cmd_settings(struct http_channel *c)
424 struct http_response *rs = c->response;
425 struct http_request *rq = c->request;
426 struct http_session *s = locate_session(c);
427 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
432 if (rq->content_len && content_type &&
433 !yaz_strcmp_del("text/xml", content_type, "; "))
435 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
439 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
442 root_n = xmlDocGetRootElement(doc);
444 settings_read_node_x(root_n, s->psession, apply_local_setting);
448 if (process_settings(s->psession, rq, rs) < 0) {
449 release_session(c,s);
452 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<settings><status>OK</status></settings>";
453 http_send_response(c);
454 release_session(c,s);
457 // Compares two hitsbytarget nodes by hitcount
458 static int cmp_ht(const void *p1, const void *p2)
460 const struct hitsbytarget *h1 = p1;
461 const struct hitsbytarget *h2 = p2;
462 return h2->hits - h1->hits;
465 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
466 static int targets_termlist(WRBUF wrbuf, struct session *se, int num,
469 struct hitsbytarget *ht;
472 ht = hitsbytarget(se, &count, nmem);
473 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
474 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
477 // do only print terms which have display names
479 wrbuf_puts(wrbuf, "<term>\n");
481 wrbuf_puts(wrbuf, "<id>");
482 wrbuf_xmlputs(wrbuf, ht[i].id);
483 wrbuf_puts(wrbuf, "</id>\n");
485 wrbuf_puts(wrbuf, "<name>");
486 if (!ht[i].name || !ht[i].name[0])
487 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
489 wrbuf_xmlputs(wrbuf, ht[i].name);
490 wrbuf_puts(wrbuf, "</name>\n");
492 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
495 wrbuf_puts(wrbuf, "<state>");
496 wrbuf_xmlputs(wrbuf, ht[i].state);
497 wrbuf_puts(wrbuf, "</state>\n");
499 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
501 wrbuf_puts(wrbuf, "</term>\n");
506 static void cmd_termlist(struct http_channel *c)
508 struct http_response *rs = c->response;
509 struct http_request *rq = c->request;
510 struct http_session *s = locate_session(c);
511 struct termlist_score **p;
514 const char *name = http_argbyname(rq, "name");
515 const char *nums = http_argbyname(rq, "num");
518 WRBUF debug_log = wrbuf_alloc();
523 status = session_active_clients(s->psession);
527 if (strlen(name) > 255)
532 wrbuf_rewind(c->wrbuf);
534 wrbuf_puts(c->wrbuf, "<termlist>\n");
535 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
541 if (!(tp = strchr(name, ',')))
542 tp = name + strlen(name);
543 strncpy(tname, name, tp - name);
544 tname[tp - name] = '\0';
545 wrbuf_puts(c->wrbuf, "<list name=\"");
546 wrbuf_xmlputs(c->wrbuf, tname);
547 wrbuf_puts(c->wrbuf, "\">\n");
548 if (!strcmp(tname, "xtargets")) {
549 int targets = targets_termlist(c->wrbuf, s->psession, num, c->nmem);
550 wrbuf_printf(debug_log, " xtargets: %d", targets);
554 p = termlist(s->psession, tname, &len);
556 wrbuf_printf(debug_log, " %s: %d", tname, len);
558 for (i = 0; i < len && i < num; i++){
559 // prevnt sending empty term elements
560 if (!p[i]->term || !p[i]->term[0])
563 wrbuf_puts(c->wrbuf, "<term>");
564 wrbuf_puts(c->wrbuf, "<name>");
565 wrbuf_xmlputs(c->wrbuf, p[i]->term);
566 wrbuf_puts(c->wrbuf, "</name>");
568 wrbuf_printf(c->wrbuf,
569 "<frequency>%d</frequency>",
571 wrbuf_puts(c->wrbuf, "</term>\n");
575 wrbuf_puts(c->wrbuf, "</list>\n");
580 wrbuf_puts(c->wrbuf, "</termlist>\n");
581 yaz_log(YLOG_DEBUG, "termlist response: %s ", wrbuf_cstr(debug_log));
582 wrbuf_destroy(debug_log);
583 rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
584 http_send_response(c);
585 release_session(c,s);
588 size_t session_get_memory_status(struct session *session);
590 static void cmd_session_status(struct http_channel *c)
592 struct http_response *rs = c->response;
593 struct http_session *s = locate_session(c);
598 wrbuf_rewind(c->wrbuf);
599 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<sessionstatus><status>OK</status>\n");
600 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
601 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
603 session_nmem = session_get_memory_status(s->psession);
604 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
606 wrbuf_puts(c->wrbuf, "</sessionstatus>\n");
607 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
608 http_send_response(c);
609 release_session(c,s);
613 int sessions_count(void);
614 int clients_count(void);
615 int resultsets_count(void);
617 static void cmd_server_status(struct http_channel *c)
619 struct http_response *rs = c->response;
620 int sessions = sessions_count();
621 int clients = clients_count();
622 int resultsets = resultsets_count();
623 wrbuf_rewind(c->wrbuf);
624 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<server-status><status>OK</status>\n");
625 wrbuf_printf(c->wrbuf, "Sessions %u Clients: %u Resultsets: %u\n</server-status>\n", sessions, clients, resultsets);
626 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
627 http_send_response(c);
632 static void cmd_bytarget(struct http_channel *c)
634 struct http_response *rs = c->response;
635 struct http_request *rq = c->request;
636 struct http_session *s = locate_session(c);
637 struct hitsbytarget *ht;
638 const char *settings = http_argbyname(rq, "settings");
643 ht = hitsbytarget(s->psession, &count, c->nmem);
644 wrbuf_rewind(c->wrbuf);
645 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<bytarget><status>OK</status>");
647 for (i = 0; i < count; i++)
649 wrbuf_puts(c->wrbuf, "\n<target>");
651 wrbuf_puts(c->wrbuf, "<id>");
652 wrbuf_xmlputs(c->wrbuf, ht[i].id);
653 wrbuf_puts(c->wrbuf, "</id>\n");
655 if (ht[i].name && ht[i].name[0])
657 wrbuf_puts(c->wrbuf, "<name>");
658 wrbuf_xmlputs(c->wrbuf, ht[i].name);
659 wrbuf_puts(c->wrbuf, "</name>\n");
662 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
663 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
664 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
666 wrbuf_puts(c->wrbuf, "<state>");
667 wrbuf_xmlputs(c->wrbuf, ht[i].state);
668 wrbuf_puts(c->wrbuf, "</state>\n");
669 if (settings && *settings == '1')
671 wrbuf_puts(c->wrbuf, "<settings>\n");
672 wrbuf_puts(c->wrbuf, wrbuf_cstr(ht[i].settings_xml));
673 wrbuf_puts(c->wrbuf, "</settings>\n");
675 wrbuf_puts(c->wrbuf, "</target>");
676 wrbuf_destroy(ht[i].settings_xml);
679 wrbuf_puts(c->wrbuf, "</bytarget>");
680 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
681 http_send_response(c);
682 release_session(c,s);
685 static void write_metadata(WRBUF w, struct conf_service *service,
686 struct record_metadata **ml, int full)
690 for (imeta = 0; imeta < service->num_metadata; imeta++)
692 struct conf_metadata *cmd = &service->metadata[imeta];
693 struct record_metadata *md;
694 if (!cmd->brief && !full)
696 for (md = ml[imeta]; md; md = md->next)
698 struct record_metadata_attr *attr = md->attributes;
699 wrbuf_printf(w, "\n<md-%s", cmd->name);
701 for (; attr; attr = attr->next)
703 wrbuf_printf(w, " %s=\"", attr->name);
704 wrbuf_xmlputs(w, attr->value);
710 case Metadata_type_generic:
711 wrbuf_xmlputs(w, md->data.text.disp);
713 case Metadata_type_year:
714 wrbuf_printf(w, "%d", md->data.number.min);
715 if (md->data.number.min != md->data.number.max)
716 wrbuf_printf(w, "-%d", md->data.number.max);
719 wrbuf_puts(w, "[can't represent]");
721 wrbuf_printf(w, "</md-%s>", cmd->name);
726 static void write_subrecord(struct record *r, WRBUF w,
727 struct conf_service *service, int show_details)
729 const char *name = session_setting_oneval(
730 client_get_database(r->client), PZ_NAME);
732 wrbuf_puts(w, "<location id=\"");
733 wrbuf_xmlputs(w, client_get_database(r->client)->database->url);
734 wrbuf_puts(w, "\" ");
736 wrbuf_puts(w, "name=\"");
737 wrbuf_xmlputs(w, *name ? name : "Unknown");
738 wrbuf_puts(w, "\">");
740 write_metadata(w, service, r->metadata, show_details);
741 wrbuf_puts(w, "</location>\n");
744 static void show_raw_record_error(void *data, const char *addinfo)
746 http_channel_observer_t obs = data;
747 struct http_channel *c = http_channel_observer_chan(obs);
748 struct http_response *rs = c->response;
750 http_remove_observer(obs);
752 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
755 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
757 http_channel_observer_t obs = data;
758 struct http_channel *c = http_channel_observer_chan(obs);
759 struct http_response *rs = c->response;
761 http_remove_observer(obs);
763 wrbuf_write(c->wrbuf, buf, sz);
764 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
765 http_send_response(c);
769 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
771 http_channel_observer_t obs = data;
772 struct http_channel *c = http_channel_observer_chan(obs);
773 struct http_response *rs = c->response;
775 http_remove_observer(obs);
777 wrbuf_write(c->wrbuf, buf, sz);
778 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
780 rs->content_type = "application/octet-stream";
781 http_send_response(c);
785 void show_raw_reset(void *data, struct http_channel *c, void *data2)
787 //struct client *client = data;
788 //client_show_raw_remove(client, data2);
791 static void cmd_record_ready(void *data);
793 static void cmd_record(struct http_channel *c)
795 struct http_response *rs = c->response;
796 struct http_request *rq = c->request;
797 struct http_session *s = locate_session(c);
798 struct record_cluster *rec, *prev_r, *next_r;
800 struct conf_service *service;
801 const char *idstr = http_argbyname(rq, "id");
802 const char *offsetstr = http_argbyname(rq, "offset");
803 const char *binarystr = http_argbyname(rq, "binary");
807 service = s->psession->service;
810 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
813 wrbuf_rewind(c->wrbuf);
814 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
816 if (session_active_clients(s->psession) == 0)
818 error(rs, PAZPAR2_RECORD_MISSING, idstr);
820 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
821 cmd_record_ready, c, c) != 0)
823 error(rs, PAZPAR2_RECORD_MISSING, idstr);
825 release_session(c, s);
830 int offset = atoi(offsetstr);
831 const char *syntax = http_argbyname(rq, "syntax");
832 const char *esn = http_argbyname(rq, "esn");
834 struct record*r = rec->records;
837 if (binarystr && *binarystr != '0')
840 for (i = 0; i < offset && r; r = r->next, i++)
844 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
848 http_channel_observer_t obs =
849 http_add_observer(c, r->client, show_raw_reset);
850 int ret = client_show_raw_begin(r->client, r->position,
853 show_raw_record_error,
855 show_raw_record_ok_binary :
860 http_remove_observer(obs);
861 error(rs, PAZPAR2_NO_SESSION, 0);
867 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<record>\n");
868 wrbuf_puts(c->wrbuf, "<recid>");
869 wrbuf_xmlputs(c->wrbuf, rec->recid);
870 wrbuf_puts(c->wrbuf, "</recid>\n");
873 wrbuf_puts(c->wrbuf, "<prevrecid>");
874 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
875 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
879 wrbuf_puts(c->wrbuf, "<nextrecid>");
880 wrbuf_xmlputs(c->wrbuf, next_r->recid);
881 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
883 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n",
884 session_active_clients(s->psession));
885 write_metadata(c->wrbuf, service, rec->metadata, 1);
886 for (r = rec->records; r; r = r->next)
887 write_subrecord(r, c->wrbuf, service, 1);
888 wrbuf_puts(c->wrbuf, "</record>\n");
889 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
890 http_send_response(c);
892 show_single_stop(s->psession, rec);
893 release_session(c, s);
896 static void cmd_record_ready(void *data)
898 struct http_channel *c = (struct http_channel *) data;
903 static void show_records(struct http_channel *c, int active)
905 struct http_request *rq = c->request;
906 struct http_response *rs = c->response;
907 struct http_session *s = locate_session(c);
908 struct record_cluster **rl;
909 struct reclist_sortparms *sp;
910 const char *start = http_argbyname(rq, "start");
911 const char *num = http_argbyname(rq, "num");
912 const char *sort = http_argbyname(rq, "sort");
922 // We haven't counted clients yet if we're called on a block release
924 active = session_active_clients(s->psession);
927 startn = atoi(start);
932 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
934 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
935 release_session(c, s);
940 rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits);
942 wrbuf_rewind(c->wrbuf);
943 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<show>\n<status>OK</status>\n");
944 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
945 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
946 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
947 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
948 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
950 for (i = 0; i < numn; i++)
954 struct record_cluster *rec = rl[i];
955 struct conf_service *service = s->psession->service;
957 wrbuf_puts(c->wrbuf, "<hit>\n");
958 write_metadata(c->wrbuf, service, rec->metadata, 0);
959 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
960 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
962 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
963 if (strstr(sort, "relevance"))
964 wrbuf_printf(c->wrbuf, "<relevance>%d</relevance>\n",
965 rec->relevance_score);
966 wrbuf_puts(c->wrbuf, "<recid>");
967 wrbuf_xmlputs(c->wrbuf, rec->recid);
968 wrbuf_puts(c->wrbuf, "</recid>\n");
969 wrbuf_puts(c->wrbuf, "</hit>\n");
972 show_range_stop(s->psession, rl);
974 wrbuf_puts(c->wrbuf, "</show>\n");
975 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
976 http_send_response(c);
977 release_session(c, s);
980 static void show_records_ready(void *data)
982 struct http_channel *c = (struct http_channel *) data;
987 static void cmd_show(struct http_channel *c)
989 struct http_request *rq = c->request;
990 struct http_session *s = locate_session(c);
991 const char *block = http_argbyname(rq, "block");
997 status = session_active_clients(s->psession);
1001 if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0) {
1002 // if there is already a watch/block. we do not block this one
1003 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1004 show_records_ready, c, c) != 0)
1006 yaz_log(c->http_sessions->log_level,
1007 "%p Session %u: Blocking on cmd_show. Waiting for preferred targets", s, s->session_id);
1009 release_session(c,s);
1013 else if (status && reclist_get_num_records(s->psession->reclist) == 0)
1015 // if there is already a watch/block. we do not block this one
1016 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1017 show_records_ready, c, c) != 0)
1019 yaz_log(c->http_sessions->log_level, "%p Session %u: Blocking on cmd_show", s, s->session_id);
1021 release_session(c,s);
1025 show_records(c, status);
1026 release_session(c,s);
1029 static void cmd_ping(struct http_channel *c)
1031 struct http_response *rs = c->response;
1032 struct http_session *s = locate_session(c);
1035 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<ping><status>OK</status></ping>";
1036 http_send_response(c);
1037 release_session(c, s);
1040 static int utf_8_valid(const char *str)
1042 yaz_iconv_t cd = yaz_iconv_open("utf-8", "utf-8");
1045 /* check that query is UTF-8 encoded */
1046 char *inbuf = (char *) str; /* we know iconv does not alter this */
1047 size_t inbytesleft = strlen(inbuf);
1049 size_t outbytesleft = strlen(inbuf) + 10;
1050 char *out = xmalloc(outbytesleft);
1052 size_t r = yaz_iconv(cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft);
1054 /* if OK, try flushing the rest */
1055 if (r != (size_t) (-1))
1056 r = yaz_iconv(cd, 0, 0, &outbuf, &outbytesleft);
1057 yaz_iconv_close(cd);
1059 if (r == (size_t) (-1))
1065 static void cmd_search(struct http_channel *c)
1067 struct http_request *rq = c->request;
1068 struct http_response *rs = c->response;
1069 struct http_session *s = locate_session(c);
1070 const char *query = http_argbyname(rq, "query");
1071 const char *filter = http_argbyname(rq, "filter");
1072 const char *maxrecs = http_argbyname(rq, "maxrecs");
1073 const char *startrecs = http_argbyname(rq, "startrecs");
1074 enum pazpar2_error_code code;
1075 const char *addinfo = 0;
1081 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1082 release_session(c,s);
1085 if (!utf_8_valid(query))
1087 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1088 release_session(c,s);
1091 code = search(s->psession, query, startrecs, maxrecs, filter, &addinfo);
1094 error(rs, code, addinfo);
1095 release_session(c,s);
1098 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<search><status>OK</status></search>";
1099 http_send_response(c);
1100 release_session(c,s);
1104 static void cmd_stat(struct http_channel *c)
1106 struct http_response *rs = c->response;
1107 struct http_session *s = locate_session(c);
1108 struct statistics stat;
1116 clients = session_active_clients(s->psession);
1117 statistics(s->psession, &stat);
1119 if (stat.num_clients > 0) {
1120 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1123 wrbuf_rewind(c->wrbuf);
1124 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<stat>");
1125 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
1126 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1127 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
1128 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
1129 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
1130 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
1131 wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
1132 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
1133 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
1134 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
1135 wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
1136 wrbuf_puts(c->wrbuf, "</stat>");
1137 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1138 http_send_response(c);
1139 release_session(c,s);
1142 static void cmd_info(struct http_channel *c)
1144 char yaz_version_str[20];
1145 struct http_response *rs = c->response;
1147 wrbuf_rewind(c->wrbuf);
1148 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<info>\n");
1149 wrbuf_puts(c->wrbuf, " <version>\n");
1150 wrbuf_puts(c->wrbuf, "<pazpar2");
1151 #ifdef PAZPAR2_VERSION_SHA1
1152 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1154 wrbuf_puts(c->wrbuf, ">");
1155 wrbuf_xmlputs(c->wrbuf, VERSION);
1156 wrbuf_puts(c->wrbuf, "</pazpar2>");
1159 yaz_version(yaz_version_str, 0);
1160 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1161 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1162 wrbuf_puts(c->wrbuf, "\">");
1163 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1164 wrbuf_puts(c->wrbuf, "</yaz>\n");
1166 wrbuf_puts(c->wrbuf, " </version>\n");
1168 info_services(c->server, c->wrbuf);
1170 wrbuf_puts(c->wrbuf, "</info>");
1171 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1172 http_send_response(c);
1177 void (*fun)(struct http_channel *c);
1179 { "init", cmd_init },
1180 { "settings", cmd_settings },
1181 { "stat", cmd_stat },
1182 { "bytarget", cmd_bytarget },
1183 { "show", cmd_show },
1184 { "search", cmd_search },
1185 { "termlist", cmd_termlist },
1186 { "exit", cmd_exit },
1187 { "sessionstatus", cmd_session_status },
1188 { "serverstatus", cmd_server_status },
1189 { "ping", cmd_ping },
1190 { "record", cmd_record },
1191 { "info", cmd_info },
1195 void http_command(struct http_channel *c)
1197 const char *command = http_argbyname(c->request, "command");
1198 struct http_response *rs = http_create_response(c);
1203 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1204 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1208 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1211 for (i = 0; commands[i].name; i++)
1212 if (!strcmp(commands[i].name, command))
1214 (*commands[i].fun)(c);
1217 if (!commands[i].name)
1218 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1226 * c-file-style: "Stroustrup"
1227 * indent-tabs-mode: nil
1229 * vim: shiftwidth=4 tabstop=8 expandtab