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"
46 void print_meminfo(WRBUF wrbuf) {
47 struct mallinfo minfo;
49 wrbuf_printf(wrbuf, " <memory>\n"
50 " <arena>%d</arena>\n"
51 " <uordblks>%d</uordblks>\n"
52 " <fordblks>%d</fordblks>\n"
53 " <ordblks>%d</ordblks>\n"
54 " <keepcost>%d</keepcost>\n"
55 " <hblks>%d</hblks>\n"
56 " <hblkhd>%d</hblkhd>\n"
58 " <virtuse>%d</virtuse>\n"
60 minfo.arena, minfo.uordblks, minfo.fordblks,minfo.ordblks, minfo.keepcost, minfo.hblks, minfo.hblkhd, minfo.arena + minfo.hblkhd, minfo.uordblks + minfo.hblkhd);
64 #define print_meminfo(x)
68 // Update this when the protocol changes
69 #define PAZPAR2_PROTOCOL_VERSION "1"
71 #define HTTP_COMMAND_RESPONSE_PREFIX "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
74 IOCHAN timeout_iochan; // NOTE: This is NOT associated with a socket
75 struct session *psession;
76 unsigned int session_id;
81 http_sessions_t http_sessions;
82 struct http_session *next;
85 struct http_sessions {
86 struct http_session *session_list;
91 static YAZ_MUTEX g_http_session_mutex = 0;
92 static int g_http_sessions = 0;
94 int http_session_use(int delta)
97 if (!g_http_session_mutex)
98 yaz_mutex_create(&g_http_session_mutex);
99 yaz_mutex_enter(g_http_session_mutex);
100 g_http_sessions += delta;
101 sessions = g_http_sessions;
102 yaz_mutex_leave(g_http_session_mutex);
103 yaz_log(YLOG_DEBUG, "%s sesions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), sessions);
108 http_sessions_t http_sessions_create(void)
110 http_sessions_t hs = xmalloc(sizeof(*hs));
111 hs->session_list = 0;
113 pazpar2_mutex_create(&hs->mutex, "http_sessions");
114 hs->log_level = yaz_log_module_level("HTTP");
118 void http_sessions_destroy(http_sessions_t hs)
122 struct http_session *s = hs->session_list;
125 struct http_session *s_next = s->next;
126 iochan_destroy(s->timeout_iochan);
127 destroy_session(s->psession);
128 nmem_destroy(s->nmem);
131 yaz_mutex_destroy(&hs->mutex);
136 void http_session_destroy(struct http_session *s);
138 static void session_timeout(IOCHAN i, int event)
140 struct http_session *s = iochan_getdata(i);
141 http_session_destroy(s);
144 struct http_session *http_session_create(struct conf_service *service,
145 http_sessions_t http_sessions,
148 NMEM nmem = nmem_create();
149 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
152 sprintf(tmp_str, "session#%u", sesid);
153 r->psession = new_session(nmem, service, sesid);
154 r->session_id = sesid;
157 r->destroy_counter = r->activity_counter = 0;
158 r->http_sessions = http_sessions;
160 yaz_mutex_enter(http_sessions->mutex);
161 r->next = http_sessions->session_list;
162 http_sessions->session_list = r;
163 yaz_mutex_leave(http_sessions->mutex);
165 r->timeout_iochan = iochan_create(-1, session_timeout, 0, "http_session_timeout");
166 iochan_setdata(r->timeout_iochan, r);
167 yaz_log(http_sessions->log_level, "%p Session %u created. timeout chan=%p timeout=%d", r, sesid, r->timeout_iochan, service->session_timeout);
168 iochan_settimeout(r->timeout_iochan, service->session_timeout);
170 iochan_add(service->server->iochan_man, r->timeout_iochan);
175 void http_session_destroy(struct http_session *s)
177 int must_destroy = 0;
179 http_sessions_t http_sessions = s->http_sessions;
181 yaz_log(http_sessions->log_level, "%p HTTP Session %u destroyed", s, s->session_id);
182 yaz_mutex_enter(http_sessions->mutex);
183 /* only if http_session has no active http sessions on it can be destroyed */
184 if (s->destroy_counter == s->activity_counter) {
185 struct http_session **p = 0;
187 for (p = &http_sessions->session_list; *p; p = &(*p)->next)
194 yaz_mutex_leave(http_sessions->mutex);
196 { /* destroying for real */
197 yaz_log(http_sessions->log_level, "%p HTTP Session %u destroyed", s, s->session_id);
198 iochan_destroy(s->timeout_iochan);
199 destroy_session(s->psession);
200 http_session_use(-1);
201 nmem_destroy(s->nmem);
204 yaz_log(http_sessions->log_level, "%p HTTP Session %u destroyed delayed. Active clients (%d-%d). Waiting for new timeout.",
205 s, s->session_id, s->activity_counter, s->destroy_counter);
210 static const char *get_msg(enum pazpar2_error_code code)
212 struct pazpar2_error_msg {
213 enum pazpar2_error_code code;
216 static const struct pazpar2_error_msg ar[] = {
217 { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
218 { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
219 { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
220 { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
221 { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
222 { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
223 { PAZPAR2_RECORD_MISSING, "Record missing"},
224 { PAZPAR2_NO_TARGETS, "No targets"},
225 { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
226 { PAZPAR2_RECORD_FAIL, "Record command failed"},
227 { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
228 { PAZPAR2_NO_SERVICE, "No service"},
229 { PAZPAR2_LAST_ERROR, "Last error"},
235 if (code == ar[i].code)
242 static void error(struct http_response *rs,
243 enum pazpar2_error_code code,
246 struct http_channel *c = rs->channel;
247 WRBUF text = wrbuf_alloc();
248 const char *http_status = "417";
249 const char *msg = get_msg(code);
251 rs->msg = nmem_strdup(c->nmem, msg);
252 strcpy(rs->code, http_status);
254 wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX "<error code=\"%d\" msg=\"%s\">", (int) code,
257 wrbuf_xmlputs(text, addinfo);
258 wrbuf_puts(text, "</error>");
260 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
261 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
262 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
264 http_send_response(c);
267 unsigned int make_sessionid(void)
269 static int seq = 0; /* thread pr */
273 if (global_parameters.predictable_sessions)
282 if (gettimeofday(&t, 0) < 0)
284 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
287 /* at most 256 sessions per second ..
288 (long long would be more appropriate)*/
290 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
296 static struct http_session *locate_session(struct http_channel *c)
298 struct http_response *rs = c->response;
299 struct http_request *rq = c->request;
300 struct http_session *p;
301 const char *session = http_argbyname(rq, "session");
302 http_sessions_t http_sessions = c->http_sessions;
307 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
311 yaz_mutex_enter(http_sessions->mutex);
312 for (p = http_sessions->session_list; p; p = p->next)
313 if (id == p->session_id)
316 p->activity_counter++;
317 yaz_mutex_leave(http_sessions->mutex);
319 iochan_activity(p->timeout_iochan);
321 error(rs, PAZPAR2_NO_SESSION, session);
325 // Call after use of locate_session, in order to increment the destroy_counter
326 static void release_session(struct http_channel *c, struct http_session *session) {
327 http_sessions_t http_sessions = c->http_sessions;
328 yaz_mutex_enter(http_sessions->mutex);
330 session->destroy_counter++;
331 yaz_mutex_leave(http_sessions->mutex);
334 // Decode settings parameters and apply to session
335 // Syntax: setting[target]=value
336 static int process_settings(struct session *se, struct http_request *rq,
337 struct http_response *rs)
339 struct http_argument *a;
341 for (a = rq->arguments; a; a = a->next)
342 if (strchr(a->name, '['))
349 // Nmem_strsplit *rules*!!!
350 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
353 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
358 session_apply_setting(se, dbname, setting,
359 nmem_strdup(se->session_nmem, a->value));
364 static void cmd_exit(struct http_channel *c)
367 struct http_response *rs = c->response;
368 yaz_log(YLOG_WARN, "exit");
369 sprintf(buf, HTTP_COMMAND_RESPONSE_PREFIX "<exit><status>OK</status></exit>");
370 rs->payload = nmem_strdup(c->nmem, buf);
371 http_send_response(c);
372 http_close_server(c->server);
375 static void cmd_init(struct http_channel *c)
378 struct http_request *r = c->request;
379 const char *clear = http_argbyname(r, "clear");
380 const char *content_type = http_lookup_header(r->headers, "Content-Type");
382 struct http_session *s;
383 struct http_response *rs = c->response;
384 struct conf_service *service = 0; /* no service (yet) */
386 if (r->content_len && content_type &&
387 !yaz_strcmp_del("text/xml", content_type, "; "))
389 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
393 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
396 root_n = xmlDocGetRootElement(doc);
397 service = service_create(c->server, root_n);
401 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
408 const char *service_name = http_argbyname(c->request, "service");
409 service = locate_service(c->server, service_name);
412 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
416 sesid = make_sessionid();
417 s = http_session_create(service, c->http_sessions, sesid);
419 yaz_log(c->http_sessions->log_level, "%p Session init %u ", s, sesid);
420 if (!clear || *clear == '0')
421 session_init_databases(s->psession);
423 yaz_log(YLOG_LOG, "HTTP Session %u init: No databases preloaded", sesid);
425 if (process_settings(s->psession, c->request, c->response) < 0)
428 sprintf(buf, HTTP_COMMAND_RESPONSE_PREFIX
429 "<init><status>OK</status><session>%d", sesid);
430 if (c->server->server_id)
433 strcat(buf, c->server->server_id);
435 strcat(buf, "</session>"
436 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol></init>");
437 rs->payload = nmem_strdup(c->nmem, buf);
438 http_send_response(c);
441 static void apply_local_setting(void *client_data,
444 struct session *se = (struct session *) client_data;
446 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
447 nmem_strdup(se->session_nmem, set->name),
448 nmem_strdup(se->session_nmem, set->value));
451 static void cmd_settings(struct http_channel *c)
453 struct http_response *rs = c->response;
454 struct http_request *rq = c->request;
455 struct http_session *s = locate_session(c);
456 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
461 if (rq->content_len && content_type &&
462 !yaz_strcmp_del("text/xml", content_type, "; "))
464 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
468 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
471 root_n = xmlDocGetRootElement(doc);
473 settings_read_node_x(root_n, s->psession, apply_local_setting);
477 if (process_settings(s->psession, rq, rs) < 0) {
478 release_session(c,s);
481 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<settings><status>OK</status></settings>";
482 http_send_response(c);
483 release_session(c,s);
486 // Compares two hitsbytarget nodes by hitcount
487 static int cmp_ht(const void *p1, const void *p2)
489 const struct hitsbytarget *h1 = p1;
490 const struct hitsbytarget *h2 = p2;
491 return h2->hits - h1->hits;
494 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
495 static int targets_termlist(WRBUF wrbuf, struct session *se, int num,
498 struct hitsbytarget *ht;
501 ht = hitsbytarget(se, &count, nmem);
502 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
503 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
506 // do only print terms which have display names
508 wrbuf_puts(wrbuf, "<term>\n");
510 wrbuf_puts(wrbuf, "<id>");
511 wrbuf_xmlputs(wrbuf, ht[i].id);
512 wrbuf_puts(wrbuf, "</id>\n");
514 wrbuf_puts(wrbuf, "<name>");
515 if (!ht[i].name || !ht[i].name[0])
516 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
518 wrbuf_xmlputs(wrbuf, ht[i].name);
519 wrbuf_puts(wrbuf, "</name>\n");
521 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
524 wrbuf_puts(wrbuf, "<state>");
525 wrbuf_xmlputs(wrbuf, ht[i].state);
526 wrbuf_puts(wrbuf, "</state>\n");
528 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
530 wrbuf_puts(wrbuf, "</term>\n");
535 static void cmd_termlist(struct http_channel *c)
537 struct http_response *rs = c->response;
538 struct http_request *rq = c->request;
539 struct http_session *s = locate_session(c);
540 struct termlist_score **p;
543 const char *name = http_argbyname(rq, "name");
544 const char *nums = http_argbyname(rq, "num");
547 WRBUF debug_log = wrbuf_alloc();
552 status = session_active_clients(s->psession);
556 if (strlen(name) > 255)
561 wrbuf_rewind(c->wrbuf);
563 wrbuf_puts(c->wrbuf, "<termlist>\n");
564 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
570 if (!(tp = strchr(name, ',')))
571 tp = name + strlen(name);
572 strncpy(tname, name, tp - name);
573 tname[tp - name] = '\0';
574 wrbuf_puts(c->wrbuf, "<list name=\"");
575 wrbuf_xmlputs(c->wrbuf, tname);
576 wrbuf_puts(c->wrbuf, "\">\n");
577 if (!strcmp(tname, "xtargets")) {
578 int targets = targets_termlist(c->wrbuf, s->psession, num, c->nmem);
579 wrbuf_printf(debug_log, " xtargets: %d", targets);
583 p = termlist(s->psession, tname, &len);
585 wrbuf_printf(debug_log, " %s: %d", tname, len);
587 for (i = 0; i < len && i < num; i++){
588 // prevnt sending empty term elements
589 if (!p[i]->term || !p[i]->term[0])
592 wrbuf_puts(c->wrbuf, "<term>");
593 wrbuf_puts(c->wrbuf, "<name>");
594 wrbuf_xmlputs(c->wrbuf, p[i]->term);
595 wrbuf_puts(c->wrbuf, "</name>");
597 wrbuf_printf(c->wrbuf,
598 "<frequency>%d</frequency>",
600 wrbuf_puts(c->wrbuf, "</term>\n");
604 wrbuf_puts(c->wrbuf, "</list>\n");
609 wrbuf_puts(c->wrbuf, "</termlist>\n");
610 yaz_log(YLOG_DEBUG, "termlist response: %s ", wrbuf_cstr(debug_log));
611 wrbuf_destroy(debug_log);
612 rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
613 http_send_response(c);
614 release_session(c,s);
617 size_t session_get_memory_status(struct session *session);
619 static void session_status(struct http_channel *c, struct http_session *s)
622 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
623 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
624 session_nmem = session_get_memory_status(s->psession);
625 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
628 static void cmd_session_status(struct http_channel *c) {
629 struct http_response *rs = c->response;
630 struct http_session *s = locate_session(c);
634 wrbuf_rewind(c->wrbuf);
635 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<sessionstatus><status>OK</status>\n");
636 session_status(c, s);
637 wrbuf_puts(c->wrbuf, "</sessionstatus>\n");
638 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
639 http_send_response(c);
640 release_session(c,s);
644 int sessions_count(void);
645 int clients_count(void);
646 #ifdef HAVE_RESULTSETS_COUNT
647 int resultsets_count(void);
649 #define resultsets_count() 0
652 static void cmd_server_status(struct http_channel *c)
654 struct http_response *rs = c->response;
655 int sessions = sessions_count();
656 int clients = clients_count();
657 int resultsets = resultsets_count();
658 wrbuf_rewind(c->wrbuf);
659 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<server-status>\n");
660 wrbuf_printf(c->wrbuf, " <sessions>%u</sessions>\n", sessions);
661 wrbuf_printf(c->wrbuf, " <clients>%u</clients>\n", clients);
662 /* Only works if yaz has been compiled with enabling of this */
663 wrbuf_printf(c->wrbuf, " <resultsets>%u</resultsets>\n",resultsets);
664 print_meminfo(c->wrbuf);
666 /* TODO add all sessions status */
667 /* http_sessions_t http_sessions = c->http_sessions; */
668 /* struct http_session *p; */
670 yaz_mutex_enter(http_sessions->mutex);
671 for (p = http_sessions->session_list; p; p = p->next) {
672 p->activity_counter++;
673 wrbuf_puts(c->wrbuf, "<session-status>\n");
674 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
675 yaz_mutex_leave(http_sessions->mutex);
676 session_status(c, p);
677 wrbuf_puts(c->wrbuf, "</session-status>\n");
678 yaz_mutex_enter(http_sessions->mutex);
679 p->activity_counter--;
681 yaz_mutex_leave(http_sessions->mutex);
683 wrbuf_puts(c->wrbuf, "</server-status>\n");
684 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
685 http_send_response(c);
690 static void cmd_bytarget(struct http_channel *c)
692 struct http_response *rs = c->response;
693 struct http_request *rq = c->request;
694 struct http_session *s = locate_session(c);
695 struct hitsbytarget *ht;
696 const char *settings = http_argbyname(rq, "settings");
701 ht = hitsbytarget(s->psession, &count, c->nmem);
702 wrbuf_rewind(c->wrbuf);
703 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<bytarget><status>OK</status>");
705 for (i = 0; i < count; i++)
707 wrbuf_puts(c->wrbuf, "\n<target>");
709 wrbuf_puts(c->wrbuf, "<id>");
710 wrbuf_xmlputs(c->wrbuf, ht[i].id);
711 wrbuf_puts(c->wrbuf, "</id>\n");
713 if (ht[i].name && ht[i].name[0])
715 wrbuf_puts(c->wrbuf, "<name>");
716 wrbuf_xmlputs(c->wrbuf, ht[i].name);
717 wrbuf_puts(c->wrbuf, "</name>\n");
720 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
721 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
722 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
724 wrbuf_puts(c->wrbuf, "<state>");
725 wrbuf_xmlputs(c->wrbuf, ht[i].state);
726 wrbuf_puts(c->wrbuf, "</state>\n");
727 if (settings && *settings == '1')
729 wrbuf_puts(c->wrbuf, "<settings>\n");
730 wrbuf_puts(c->wrbuf, ht[i].settings_xml);
731 wrbuf_puts(c->wrbuf, "</settings>\n");
733 wrbuf_puts(c->wrbuf, "</target>");
736 wrbuf_puts(c->wrbuf, "</bytarget>");
737 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
738 http_send_response(c);
739 release_session(c,s);
742 static void write_metadata(WRBUF w, struct conf_service *service,
743 struct record_metadata **ml, int full)
747 for (imeta = 0; imeta < service->num_metadata; imeta++)
749 struct conf_metadata *cmd = &service->metadata[imeta];
750 struct record_metadata *md;
751 if (!cmd->brief && !full)
753 for (md = ml[imeta]; md; md = md->next)
755 struct record_metadata_attr *attr = md->attributes;
756 wrbuf_printf(w, "\n<md-%s", cmd->name);
758 for (; attr; attr = attr->next)
760 wrbuf_printf(w, " %s=\"", attr->name);
761 wrbuf_xmlputs(w, attr->value);
767 case Metadata_type_generic:
768 wrbuf_xmlputs(w, md->data.text.disp);
770 case Metadata_type_year:
771 wrbuf_printf(w, "%d", md->data.number.min);
772 if (md->data.number.min != md->data.number.max)
773 wrbuf_printf(w, "-%d", md->data.number.max);
776 wrbuf_puts(w, "[can't represent]");
778 wrbuf_printf(w, "</md-%s>", cmd->name);
783 static void write_subrecord(struct record *r, WRBUF w,
784 struct conf_service *service, int show_details)
786 const char *name = session_setting_oneval(
787 client_get_database(r->client), PZ_NAME);
789 wrbuf_puts(w, "<location id=\"");
790 wrbuf_xmlputs(w, client_get_database(r->client)->database->url);
791 wrbuf_puts(w, "\" ");
793 wrbuf_puts(w, "name=\"");
794 wrbuf_xmlputs(w, *name ? name : "Unknown");
795 wrbuf_puts(w, "\">");
797 write_metadata(w, service, r->metadata, show_details);
798 wrbuf_puts(w, "</location>\n");
801 static void show_raw_record_error(void *data, const char *addinfo)
803 http_channel_observer_t obs = data;
804 struct http_channel *c = http_channel_observer_chan(obs);
805 struct http_response *rs = c->response;
807 http_remove_observer(obs);
809 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
812 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
814 http_channel_observer_t obs = data;
815 struct http_channel *c = http_channel_observer_chan(obs);
816 struct http_response *rs = c->response;
818 http_remove_observer(obs);
820 wrbuf_write(c->wrbuf, buf, sz);
821 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
822 http_send_response(c);
826 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
828 http_channel_observer_t obs = data;
829 struct http_channel *c = http_channel_observer_chan(obs);
830 struct http_response *rs = c->response;
832 http_remove_observer(obs);
834 wrbuf_write(c->wrbuf, buf, sz);
835 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
837 rs->content_type = "application/octet-stream";
838 http_send_response(c);
842 void show_raw_reset(void *data, struct http_channel *c, void *data2)
844 //struct client *client = data;
845 //client_show_raw_remove(client, data2);
848 static void cmd_record_ready(void *data);
850 static void cmd_record(struct http_channel *c)
852 struct http_response *rs = c->response;
853 struct http_request *rq = c->request;
854 struct http_session *s = locate_session(c);
855 struct record_cluster *rec, *prev_r, *next_r;
857 struct conf_service *service;
858 const char *idstr = http_argbyname(rq, "id");
859 const char *offsetstr = http_argbyname(rq, "offset");
860 const char *binarystr = http_argbyname(rq, "binary");
864 service = s->psession->service;
867 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
870 wrbuf_rewind(c->wrbuf);
871 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
873 if (session_active_clients(s->psession) == 0)
875 error(rs, PAZPAR2_RECORD_MISSING, idstr);
877 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
878 cmd_record_ready, c, c) != 0)
880 error(rs, PAZPAR2_RECORD_MISSING, idstr);
882 release_session(c, s);
887 int offset = atoi(offsetstr);
888 const char *syntax = http_argbyname(rq, "syntax");
889 const char *esn = http_argbyname(rq, "esn");
891 struct record*r = rec->records;
894 if (binarystr && *binarystr != '0')
897 for (i = 0; i < offset && r; r = r->next, i++)
901 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
905 http_channel_observer_t obs =
906 http_add_observer(c, r->client, show_raw_reset);
907 int ret = client_show_raw_begin(r->client, r->position,
910 show_raw_record_error,
912 show_raw_record_ok_binary :
917 http_remove_observer(obs);
918 error(rs, PAZPAR2_NO_SESSION, 0);
924 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<record>\n");
925 wrbuf_puts(c->wrbuf, "<recid>");
926 wrbuf_xmlputs(c->wrbuf, rec->recid);
927 wrbuf_puts(c->wrbuf, "</recid>\n");
930 wrbuf_puts(c->wrbuf, "<prevrecid>");
931 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
932 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
936 wrbuf_puts(c->wrbuf, "<nextrecid>");
937 wrbuf_xmlputs(c->wrbuf, next_r->recid);
938 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
940 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n",
941 session_active_clients(s->psession));
942 write_metadata(c->wrbuf, service, rec->metadata, 1);
943 for (r = rec->records; r; r = r->next)
944 write_subrecord(r, c->wrbuf, service, 1);
945 wrbuf_puts(c->wrbuf, "</record>\n");
946 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
947 http_send_response(c);
949 show_single_stop(s->psession, rec);
950 release_session(c, s);
953 static void cmd_record_ready(void *data)
955 struct http_channel *c = (struct http_channel *) data;
960 static void show_records(struct http_channel *c, int active)
962 struct http_request *rq = c->request;
963 struct http_response *rs = c->response;
964 struct http_session *s = locate_session(c);
965 struct record_cluster **rl;
966 struct reclist_sortparms *sp;
967 const char *start = http_argbyname(rq, "start");
968 const char *num = http_argbyname(rq, "num");
969 const char *sort = http_argbyname(rq, "sort");
979 // We haven't counted clients yet if we're called on a block release
981 active = session_active_clients(s->psession);
984 startn = atoi(start);
989 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
991 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
992 release_session(c, s);
997 rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits);
999 wrbuf_rewind(c->wrbuf);
1000 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<show>\n<status>OK</status>\n");
1001 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
1002 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
1003 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
1004 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
1005 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
1007 for (i = 0; i < numn; i++)
1011 struct record_cluster *rec = rl[i];
1012 struct conf_service *service = s->psession->service;
1014 wrbuf_puts(c->wrbuf, "<hit>\n");
1015 write_metadata(c->wrbuf, service, rec->metadata, 0);
1016 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
1017 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
1019 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
1020 if (strstr(sort, "relevance"))
1021 wrbuf_printf(c->wrbuf, "<relevance>%d</relevance>\n",
1022 rec->relevance_score);
1023 wrbuf_puts(c->wrbuf, "<recid>");
1024 wrbuf_xmlputs(c->wrbuf, rec->recid);
1025 wrbuf_puts(c->wrbuf, "</recid>\n");
1026 wrbuf_puts(c->wrbuf, "</hit>\n");
1029 show_range_stop(s->psession, rl);
1031 wrbuf_puts(c->wrbuf, "</show>\n");
1032 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1033 http_send_response(c);
1034 release_session(c, s);
1037 static void show_records_ready(void *data)
1039 struct http_channel *c = (struct http_channel *) data;
1041 show_records(c, -1);
1044 static void cmd_show(struct http_channel *c)
1046 struct http_request *rq = c->request;
1047 struct http_session *s = locate_session(c);
1048 const char *block = http_argbyname(rq, "block");
1054 status = session_active_clients(s->psession);
1058 if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0) {
1059 // if there is already a watch/block. we do not block this one
1060 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1061 show_records_ready, c, c) != 0)
1063 yaz_log(c->http_sessions->log_level,
1064 "%p Session %u: Blocking on cmd_show. Waiting for preferred targets", s, s->session_id);
1066 release_session(c,s);
1070 else if (status && reclist_get_num_records(s->psession->reclist) == 0)
1072 // if there is already a watch/block. we do not block this one
1073 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1074 show_records_ready, c, c) != 0)
1076 yaz_log(c->http_sessions->log_level, "%p Session %u: Blocking on cmd_show", s, s->session_id);
1078 release_session(c,s);
1082 show_records(c, status);
1083 release_session(c,s);
1086 static void cmd_ping(struct http_channel *c)
1088 struct http_response *rs = c->response;
1089 struct http_session *s = locate_session(c);
1092 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<ping><status>OK</status></ping>";
1093 http_send_response(c);
1094 release_session(c, s);
1097 static int utf_8_valid(const char *str)
1099 yaz_iconv_t cd = yaz_iconv_open("utf-8", "utf-8");
1102 /* check that query is UTF-8 encoded */
1103 char *inbuf = (char *) str; /* we know iconv does not alter this */
1104 size_t inbytesleft = strlen(inbuf);
1106 size_t outbytesleft = strlen(inbuf) + 10;
1107 char *out = xmalloc(outbytesleft);
1109 size_t r = yaz_iconv(cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft);
1111 /* if OK, try flushing the rest */
1112 if (r != (size_t) (-1))
1113 r = yaz_iconv(cd, 0, 0, &outbuf, &outbytesleft);
1114 yaz_iconv_close(cd);
1116 if (r == (size_t) (-1))
1122 static void cmd_search(struct http_channel *c)
1124 struct http_request *rq = c->request;
1125 struct http_response *rs = c->response;
1126 struct http_session *s = locate_session(c);
1127 const char *query = http_argbyname(rq, "query");
1128 const char *filter = http_argbyname(rq, "filter");
1129 const char *maxrecs = http_argbyname(rq, "maxrecs");
1130 const char *startrecs = http_argbyname(rq, "startrecs");
1131 enum pazpar2_error_code code;
1132 const char *addinfo = 0;
1138 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1139 release_session(c,s);
1142 if (!utf_8_valid(query))
1144 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1145 release_session(c,s);
1148 code = search(s->psession, query, startrecs, maxrecs, filter, &addinfo);
1151 error(rs, code, addinfo);
1152 release_session(c,s);
1155 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<search><status>OK</status></search>";
1156 http_send_response(c);
1157 release_session(c,s);
1161 static void cmd_stat(struct http_channel *c)
1163 struct http_response *rs = c->response;
1164 struct http_session *s = locate_session(c);
1165 struct statistics stat;
1173 clients = session_active_clients(s->psession);
1174 statistics(s->psession, &stat);
1176 if (stat.num_clients > 0) {
1177 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1180 wrbuf_rewind(c->wrbuf);
1181 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<stat>");
1182 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
1183 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1184 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
1185 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
1186 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
1187 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
1188 wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
1189 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
1190 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
1191 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
1192 wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
1193 wrbuf_puts(c->wrbuf, "</stat>");
1194 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1195 http_send_response(c);
1196 release_session(c,s);
1199 static void cmd_info(struct http_channel *c)
1201 char yaz_version_str[20];
1202 struct http_response *rs = c->response;
1204 wrbuf_rewind(c->wrbuf);
1205 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<info>\n");
1206 wrbuf_puts(c->wrbuf, " <version>\n");
1207 wrbuf_puts(c->wrbuf, " <pazpar2");
1208 #ifdef PAZPAR2_VERSION_SHA1
1209 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1211 wrbuf_puts(c->wrbuf, ">");
1212 wrbuf_xmlputs(c->wrbuf, VERSION);
1213 wrbuf_puts(c->wrbuf, "</pazpar2>");
1216 yaz_version(yaz_version_str, 0);
1217 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1218 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1219 wrbuf_puts(c->wrbuf, "\">");
1220 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1221 wrbuf_puts(c->wrbuf, "</yaz>\n");
1223 wrbuf_puts(c->wrbuf, " </version>\n");
1225 info_services(c->server, c->wrbuf);
1227 wrbuf_puts(c->wrbuf, "</info>");
1228 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1229 http_send_response(c);
1234 void (*fun)(struct http_channel *c);
1236 { "init", cmd_init },
1237 { "settings", cmd_settings },
1238 { "stat", cmd_stat },
1239 { "bytarget", cmd_bytarget },
1240 { "show", cmd_show },
1241 { "search", cmd_search },
1242 { "termlist", cmd_termlist },
1243 { "exit", cmd_exit },
1244 { "session-status", cmd_session_status },
1245 { "server-status", cmd_server_status },
1246 { "ping", cmd_ping },
1247 { "record", cmd_record },
1248 { "info", cmd_info },
1252 void http_command(struct http_channel *c)
1254 const char *command = http_argbyname(c->request, "command");
1255 struct http_response *rs = http_create_response(c);
1260 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1261 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1265 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1268 for (i = 0; commands[i].name; i++)
1269 if (!strcmp(commands[i].name, command))
1271 (*commands[i].fun)(c);
1274 if (!commands[i].name)
1275 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1283 * c-file-style: "Stroustrup"
1284 * indent-tabs-mode: nil
1286 * vim: shiftwidth=4 tabstop=8 expandtab