1 /* This file is part of Pazpar2.
2 Copyright (C) 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"
47 void print_meminfo(WRBUF wrbuf)
49 struct mallinfo minfo;
51 wrbuf_printf(wrbuf, " <memory>\n"
52 " <arena>%d</arena>\n"
53 " <uordblks>%d</uordblks>\n"
54 " <fordblks>%d</fordblks>\n"
55 " <ordblks>%d</ordblks>\n"
56 " <keepcost>%d</keepcost>\n"
57 " <hblks>%d</hblks>\n"
58 " <hblkhd>%d</hblkhd>\n"
60 " <virtuse>%d</virtuse>\n"
62 minfo.arena, minfo.uordblks, minfo.fordblks,minfo.ordblks, minfo.keepcost, minfo.hblks, minfo.hblkhd, minfo.arena + minfo.hblkhd, minfo.uordblks + minfo.hblkhd);
66 #define print_meminfo(x)
70 // Update this when the protocol changes
71 #define PAZPAR2_PROTOCOL_VERSION "1"
73 #define HTTP_COMMAND_RESPONSE_PREFIX "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
76 IOCHAN timeout_iochan; // NOTE: This is NOT associated with a socket
77 struct session *psession;
78 unsigned int session_id;
83 http_sessions_t http_sessions;
84 struct http_session *next;
87 struct http_sessions {
88 struct http_session *session_list;
93 static YAZ_MUTEX g_http_session_mutex = 0;
94 static int g_http_sessions = 0;
96 static void show_records_ready(void *data);
98 int get_version(struct http_request *rq) {
99 const char *version = http_argbyname(rq, "version");
101 if (version && strcmp(version, "")) {
102 version_no = atoi(version);
108 int http_session_use(int delta)
111 if (!g_http_session_mutex)
112 yaz_mutex_create(&g_http_session_mutex);
113 yaz_mutex_enter(g_http_session_mutex);
114 g_http_sessions += delta;
115 sessions = g_http_sessions;
116 yaz_mutex_leave(g_http_session_mutex);
117 yaz_log(YLOG_DEBUG, "%s http_sessions=%d", delta == 0 ? "" :
118 (delta > 0 ? "INC" : "DEC"), sessions);
123 http_sessions_t http_sessions_create(void)
125 http_sessions_t hs = xmalloc(sizeof(*hs));
126 hs->session_list = 0;
128 pazpar2_mutex_create(&hs->mutex, "http_sessions");
129 hs->log_level = yaz_log_module_level("http");
133 void http_sessions_destroy(http_sessions_t hs)
137 struct http_session *s = hs->session_list;
140 struct http_session *s_next = s->next;
141 iochan_destroy(s->timeout_iochan);
142 session_destroy(s->psession);
143 nmem_destroy(s->nmem);
146 yaz_mutex_destroy(&hs->mutex);
151 void http_session_destroy(struct http_session *s);
153 static void session_timeout(IOCHAN i, int event)
155 struct http_session *s = iochan_getdata(i);
156 http_session_destroy(s);
159 struct http_session *http_session_create(struct conf_service *service,
160 http_sessions_t http_sessions,
163 NMEM nmem = nmem_create();
164 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
167 sprintf(tmp_str, "session#%u", sesid);
168 r->psession = new_session(nmem, service, sesid);
169 r->session_id = sesid;
172 r->destroy_counter = r->activity_counter = 0;
173 r->http_sessions = http_sessions;
175 yaz_mutex_enter(http_sessions->mutex);
176 r->next = http_sessions->session_list;
177 http_sessions->session_list = r;
178 yaz_mutex_leave(http_sessions->mutex);
180 r->timeout_iochan = iochan_create(-1, session_timeout, 0,
181 "http_session_timeout");
182 iochan_setdata(r->timeout_iochan, r);
184 session_log(r->psession, http_sessions->log_level,
185 "HTTP session create. timeout chan=%p ses=%d",
186 r->timeout_iochan, service->session_timeout);
187 iochan_settimeout(r->timeout_iochan, service->session_timeout);
189 iochan_add(service->server->iochan_man, r->timeout_iochan);
194 void http_session_destroy(struct http_session *s)
196 int must_destroy = 0;
198 http_sessions_t http_sessions = s->http_sessions;
200 session_log(s->psession, http_sessions->log_level,
201 "HTTP session destroy");
202 yaz_mutex_enter(http_sessions->mutex);
203 /* only if http_session has no active http sessions on it can be destroyed */
204 if (s->destroy_counter == s->activity_counter)
206 struct http_session **p = 0;
208 for (p = &http_sessions->session_list; *p; p = &(*p)->next)
215 yaz_mutex_leave(http_sessions->mutex);
217 { /* destroying for real */
218 session_log(s->psession, http_sessions->log_level, "About to destroyd");
219 iochan_destroy(s->timeout_iochan);
220 session_destroy(s->psession);
221 http_session_use(-1);
222 nmem_destroy(s->nmem);
226 session_log(s->psession, http_sessions->log_level,
227 "Destroy delayed. Active clients (%d-%d)",
228 s->activity_counter, s->destroy_counter);
233 static const char *get_msg(enum pazpar2_error_code code)
235 struct pazpar2_error_msg {
236 enum pazpar2_error_code code;
239 static const struct pazpar2_error_msg ar[] = {
240 { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
241 { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
242 { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
243 { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
244 { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
245 { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
246 { PAZPAR2_RECORD_MISSING, "Record missing"},
247 { PAZPAR2_NO_TARGETS, "No targets"},
248 { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
249 { PAZPAR2_RECORD_FAIL, "Record command failed"},
250 { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
251 { PAZPAR2_NO_SERVICE, "No service"},
252 { PAZPAR2_ALREADY_BLOCKED, "Already blocked in session on: "},
253 { PAZPAR2_LAST_ERROR, "Last error"},
259 if (code == ar[i].code)
266 static void error2(struct http_response *rs,
267 enum pazpar2_error_code code,
268 const char *addinfo, const char *addinfo2)
270 struct http_channel *c = rs->channel;
271 WRBUF text = wrbuf_alloc();
272 const char *http_status = "417";
273 const char *msg = get_msg(code);
275 rs->msg = nmem_strdup(c->nmem, msg);
276 strcpy(rs->code, http_status);
278 wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX
279 "<error code=\"%d\" msg=\"%s\">", (int) code, msg);
282 wrbuf_xmlputs(text, addinfo);
285 wrbuf_xmlputs(text, ": ");
286 wrbuf_xmlputs(text, addinfo2);
289 wrbuf_puts(text, "</error>");
291 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
292 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
293 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
295 http_send_response(c);
298 static void error(struct http_response *rs,
299 enum pazpar2_error_code code,
302 error2(rs, code, addinfo, 0);
305 static void response_open_command(struct http_channel *c, const char *command)
307 wrbuf_rewind(c->wrbuf);
308 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX);
310 wrbuf_printf(c->wrbuf, "<%s>", command);
313 static void response_open_ok(struct http_channel *c, const char *command)
315 response_open_command(c, command);
316 wrbuf_puts(c->wrbuf, "<status>OK</status>");
319 static void response_close(struct http_channel *c, const char *command)
321 struct http_response *rs = c->response;
324 wrbuf_printf(c->wrbuf, "</%s>", command);
325 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
326 http_send_response(c);
329 unsigned int make_sessionid(void)
331 static int seq = 0; /* thread pr */
335 if (global_parameters.predictable_sessions)
344 if (gettimeofday(&t, 0) < 0)
346 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
349 /* at most 256 sessions per second ..
350 (long long would be more appropriate)*/
352 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
358 static struct http_session *locate_session(struct http_channel *c)
360 struct http_request *rq = c->request;
361 struct http_response *rs = c->response;
362 struct http_session *p;
363 const char *session = http_argbyname(rq, "session");
364 http_sessions_t http_sessions = c->http_sessions;
369 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
373 yaz_mutex_enter(http_sessions->mutex);
374 for (p = http_sessions->session_list; p; p = p->next)
375 if (id == p->session_id)
378 p->activity_counter++;
379 yaz_mutex_leave(http_sessions->mutex);
381 iochan_activity(p->timeout_iochan);
383 error(rs, PAZPAR2_NO_SESSION, session);
387 // Call after use of locate_session, in order to increment the destroy_counter
388 static void release_session(struct http_channel *c,
389 struct http_session *session)
391 http_sessions_t http_sessions = c->http_sessions;
392 yaz_mutex_enter(http_sessions->mutex);
394 session->destroy_counter++;
395 yaz_mutex_leave(http_sessions->mutex);
398 // Decode settings parameters and apply to session
399 // Syntax: setting[target]=value
400 static int process_settings(struct session *se, struct http_request *rq,
401 struct http_response *rs)
403 struct http_argument *a;
404 NMEM nmem = nmem_create();
406 for (a = rq->arguments; a; a = a->next)
407 if (strchr(a->name, '['))
414 // Nmem_strsplit *rules*!!!
415 nmem_strsplit(nmem, "[]", a->name, &res, &num);
418 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
424 session_apply_setting(se, dbname, setting, a->value);
430 static void cmd_exit(struct http_channel *c)
432 yaz_log(YLOG_WARN, "exit");
434 response_open_ok(c, "exit");
435 response_close(c, "exit");
436 if (global_parameters.debug_mode)
437 http_close_server(c->server);
440 static void cmd_init(struct http_channel *c)
442 struct http_request *r = c->request;
443 const char *clear = http_argbyname(r, "clear");
444 const char *content_type = http_lookup_header(r->headers, "Content-Type");
446 struct http_session *s;
447 struct http_response *rs = c->response;
448 struct conf_service *service = 0; /* no service (yet) */
450 if (r->content_len && content_type &&
451 !yaz_strcmp_del("text/xml", content_type, "; "))
453 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
457 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
460 root_n = xmlDocGetRootElement(doc);
461 service = service_create(c->server, root_n);
465 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
472 const char *service_name = http_argbyname(c->request, "service");
473 service = locate_service(c->server, service_name);
476 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
480 sesid = make_sessionid();
481 s = http_session_create(service, c->http_sessions, sesid);
483 if (!clear || *clear == '0')
484 session_init_databases(s->psession);
486 session_log(s->psession, YLOG_LOG, "No databases preloaded");
488 if (process_settings(s->psession, c->request, c->response) < 0)
491 response_open_ok(c, "init");
492 wrbuf_printf(c->wrbuf, "<session>%d", sesid);
493 if (c->server->server_id)
495 wrbuf_puts(c->wrbuf, ".");
496 wrbuf_puts(c->wrbuf, c->server->server_id);
498 wrbuf_puts(c->wrbuf, "</session>"
499 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol>");
501 wrbuf_printf(c->wrbuf, "<keepAlive>%d</keepAlive>\n",
502 1000 * ((s->psession->service->session_timeout >= 20) ?
503 (s->psession->service->session_timeout - 10) : 50));
504 response_close(c, "init");
507 static void apply_local_setting(void *client_data,
510 struct session *se = (struct session *) client_data;
512 session_apply_setting(se, set->target, set->name, set->value);
515 static void cmd_settings(struct http_channel *c)
517 struct http_response *rs = c->response;
518 struct http_request *rq = c->request;
519 struct http_session *s = locate_session(c);
520 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
525 if (rq->content_len && content_type &&
526 !yaz_strcmp_del("text/xml", content_type, "; "))
528 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
533 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
534 release_session(c, s);
537 root_n = xmlDocGetRootElement(doc);
538 ret = settings_read_node_x(root_n, s->psession, apply_local_setting);
542 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
543 release_session(c, s);
547 if (process_settings(s->psession, rq, rs) < 0)
549 release_session(c, s);
552 response_open_ok(c, "settings");
553 response_close(c, "settings");
554 release_session(c, s);
557 static void termlist_response(struct http_channel *c, struct http_session *s,
558 const char *cmd_status)
560 struct http_request *rq = c->request;
561 const char *name = http_argbyname(rq, "name");
562 const char *nums = http_argbyname(rq, "num");
563 int version = get_version(rq);
570 status = session_active_clients(s->psession);
572 response_open_command(c, "termlist");
573 /* new protocol add a status to response. Triggered by a status parameter */
575 wrbuf_printf(c->wrbuf, "<status>%s</status>\n", cmd_status);
576 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
578 perform_termlist(c, s->psession, name, num, version);
580 response_close(c, "termlist");
583 static void termlist_result_ready(void *data)
585 struct http_channel *c = (struct http_channel *) data;
586 struct http_request *rq = c->request;
587 const char *report = http_argbyname(rq, "report");
588 const char *status = 0;
589 struct http_session *s = locate_session(c);
590 if (report && !strcmp("status", report))
594 session_log(s->psession, c->http_sessions->log_level,
595 "termlist watch released");
596 termlist_response(c, s, status);
597 release_session(c, s);
601 static void cmd_termlist(struct http_channel *c)
603 struct http_request *rq = c->request;
604 struct http_response *rs = c->response;
605 struct http_session *s = locate_session(c);
606 const char *block = http_argbyname(rq, "block");
607 const char *report = http_argbyname(rq, "report");
608 int report_status = 0;
609 int report_error = 0;
610 const char *status_message = 0;
613 if (report && !strcmp("error", report))
616 status_message = "OK";
618 if (report && !strcmp("status", report))
621 status_message = "OK";
626 active_clients = session_active_clients(s->psession);
627 if (block && !strcmp("1", block) && active_clients)
629 // if there is already a watch/block. we do not block this one
630 if (session_set_watch(s->psession, SESSION_WATCH_TERMLIST,
631 termlist_result_ready, c, c) != 0)
633 session_log(s->psession, YLOG_WARN, "Attempt to block "
634 "multiple times on termlist block. Not supported!");
636 error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
637 release_session(c, s);
640 else if (report_status)
641 status_message = "WARNING (Already blocked on termlist)";
643 session_log(s->psession, YLOG_WARN,
644 "Ignoring termlist block. Return current result");
648 session_log(s->psession, c->http_sessions->log_level,
649 "Blocking on command termlist");
650 release_session(c, s);
655 termlist_response(c, s, status_message);
656 release_session(c, s);
659 size_t session_get_memory_status(struct session *session);
661 static void session_status(struct http_channel *c, struct http_session *s)
664 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n",
665 s->activity_counter);
666 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n",
667 nmem_total(s->nmem) );
668 session_nmem = session_get_memory_status(s->psession);
669 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
672 static void cmd_service(struct http_channel *c)
674 struct http_session *s = locate_session(c);
678 response_open_command(c, 0);
679 if (s->psession->service->xml_node)
680 wrbuf_puts(c->wrbuf, s->psession->service->xml_node);
681 response_close(c, 0);
682 release_session(c, s);
685 static void cmd_session_status(struct http_channel *c)
687 struct http_session *s = locate_session(c);
691 response_open_ok(c, "session-status");
692 session_status(c, s);
693 response_close(c, "session-status");
694 release_session(c, s);
697 #ifdef HAVE_RESULTSETS_COUNT
698 int resultsets_count(void);
700 #define resultsets_count() 0
703 static void cmd_server_status(struct http_channel *c)
705 int sessions = sessions_count();
706 int clients = clients_count();
707 int resultsets = resultsets_count();
709 response_open_ok(c, "server-status");
710 wrbuf_printf(c->wrbuf, "\n <sessions>%u</sessions>\n", sessions);
711 wrbuf_printf(c->wrbuf, " <clients>%u</clients>\n", clients);
712 /* Only works if yaz has been compiled with enabling of this */
713 wrbuf_printf(c->wrbuf, " <resultsets>%u</resultsets>\n",resultsets);
714 print_meminfo(c->wrbuf);
716 /* TODO add all sessions status */
717 /* http_sessions_t http_sessions = c->http_sessions; */
718 /* struct http_session *p; */
720 yaz_mutex_enter(http_sessions->mutex);
721 for (p = http_sessions->session_list; p; p = p->next)
723 p->activity_counter++;
724 wrbuf_puts(c->wrbuf, "<session-status>\n");
725 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
726 yaz_mutex_leave(http_sessions->mutex);
727 session_status(c, p);
728 wrbuf_puts(c->wrbuf, "</session-status>\n");
729 yaz_mutex_enter(http_sessions->mutex);
730 p->activity_counter--;
732 yaz_mutex_leave(http_sessions->mutex);
734 response_close(c, "server-status");
738 static void bytarget_response(struct http_channel *c, struct http_session *s,
739 const char *cmd_status)
742 struct http_request *rq = c->request;
743 const char *settings = http_argbyname(rq, "settings");
744 int version = get_version(rq);
745 struct hitsbytarget *ht = get_hitsbytarget(s->psession, &count, c->nmem);
748 /* Old protocol, always ok */
749 response_open_ok(c, "bytarget");
752 /* New protocol, OK or WARNING (...)*/
753 response_open_command(c, "bytarget");
754 wrbuf_printf(c->wrbuf, "<status>%s</status>", cmd_status);
758 session_log(s->psession, YLOG_WARN,
759 "Empty bytarget Response. No targets found!");
760 for (i = 0; i < count; i++)
762 wrbuf_puts(c->wrbuf, "\n<target>");
764 wrbuf_puts(c->wrbuf, "<id>");
765 wrbuf_xmlputs(c->wrbuf, ht[i].id);
766 wrbuf_puts(c->wrbuf, "</id>\n");
768 if (ht[i].name && ht[i].name[0])
770 wrbuf_puts(c->wrbuf, "<name>");
771 wrbuf_xmlputs(c->wrbuf, ht[i].name);
772 wrbuf_puts(c->wrbuf, "</name>\n");
775 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
776 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n",
778 if (ht[i].diagnostic)
780 wrbuf_puts(c->wrbuf, "<message>");
781 wrbuf_xmlputs(c->wrbuf, ht[i].message);
782 wrbuf_puts(c->wrbuf, "</message>\n");
783 wrbuf_puts(c->wrbuf, "<addinfo>");
785 wrbuf_xmlputs(c->wrbuf, ht[i].addinfo);
786 wrbuf_puts(c->wrbuf, "</addinfo>\n");
789 wrbuf_printf(c->wrbuf, "<records>%d</records>\n",
790 ht[i].records - ht[i].filtered);
791 wrbuf_printf(c->wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
794 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF
795 "</approximation>\n", ht[i].approximation);
797 wrbuf_puts(c->wrbuf, "<state>");
798 wrbuf_xmlputs(c->wrbuf, ht[i].state);
799 wrbuf_puts(c->wrbuf, "</state>\n");
800 if (settings && *settings == '1')
802 wrbuf_puts(c->wrbuf, "<settings>\n");
803 wrbuf_puts(c->wrbuf, ht[i].settings_xml);
804 wrbuf_puts(c->wrbuf, "</settings>\n");
806 if (ht[i].suggestions_xml && ht[i].suggestions_xml[0])
808 wrbuf_puts(c->wrbuf, "<suggestions>");
809 wrbuf_puts(c->wrbuf, ht[i].suggestions_xml);
810 wrbuf_puts(c->wrbuf, "</suggestions>");
812 if (ht[i].query_data)
814 wrbuf_puts(c->wrbuf, "<query_type>");
815 wrbuf_xmlputs(c->wrbuf, ht[i].query_type);
816 wrbuf_puts(c->wrbuf, "</query_type>\n");
817 wrbuf_puts(c->wrbuf, "<query_data>");
818 wrbuf_xmlputs(c->wrbuf, ht[i].query_data);
819 wrbuf_puts(c->wrbuf, "</query_data>\n");
821 wrbuf_puts(c->wrbuf, "</target>");
823 response_close(c, "bytarget");
826 static void bytarget_result_ready(void *data)
828 struct http_channel *c = (struct http_channel *) data;
829 struct http_session *s = locate_session(c);
830 const char *status_message = "OK";
833 session_log(s->psession, c->http_sessions->log_level,
834 "bytarget watch released");
835 bytarget_response(c, s, status_message);
836 release_session(c, s);
839 yaz_log(c->http_sessions->log_level,
840 "No Session found for released bytarget watch");
844 static void cmd_bytarget(struct http_channel *c)
846 struct http_request *rq = c->request;
847 struct http_response *rs = c->response;
848 struct http_session *s = locate_session(c);
849 const char *block = http_argbyname(rq, "block");
850 const char *report = http_argbyname(rq, "report");
851 int report_error = 0;
852 int report_status = 0;
853 const char *status_message = "OK";
856 if (report && !strcmp("error", report))
858 if (report && !strcmp("status", report))
864 no_active = session_active_clients(s->psession);
865 if (block && !strcmp("1", block) && no_active)
867 // if there is already a watch/block. we do not block this one
868 if (session_set_watch(s->psession, SESSION_WATCH_BYTARGET,
869 bytarget_result_ready, c, c) != 0)
871 session_log(s->psession, YLOG_WARN, "Attempt to block "
872 "multiple times on bytarget block. Not supported!");
875 error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget");
876 release_session(c, s);
879 else if (report_status)
880 status_message = "WARNING (Already blocked on bytarget)";
882 session_log(s->psession, YLOG_WARN, "Ignoring bytarget block."
883 " Return current result.");
887 session_log(s->psession, c->http_sessions->log_level,
888 "Blocking on command bytarget");
889 release_session(c, s);
893 bytarget_response(c, s, status_message);
894 release_session(c, s);
897 static void write_metadata(WRBUF w, struct conf_service *service,
898 struct record_metadata **ml, unsigned flags,
903 for (imeta = 0; imeta < service->num_metadata; imeta++)
905 struct conf_metadata *cmd = &service->metadata[imeta];
906 struct record_metadata *md;
907 if (!cmd->brief && !(flags & 1))
909 for (md = ml[imeta]; md; md = md->next)
911 struct record_metadata_attr *attr = md->attributes;
913 for (i = 0; i < indent; i++)
915 wrbuf_printf(w, "<md-%s", cmd->name);
917 for (; attr; attr = attr->next)
919 wrbuf_printf(w, " %s=\"", attr->name);
920 wrbuf_xmlputs(w, attr->value);
926 case Metadata_type_generic:
927 if (md->data.text.snippet && (flags & 2))
928 wrbuf_puts(w, md->data.text.snippet);
930 wrbuf_xmlputs(w, md->data.text.disp);
932 case Metadata_type_year:
933 wrbuf_printf(w, "%d", md->data.number.min);
934 if (md->data.number.min != md->data.number.max)
935 wrbuf_printf(w, "-%d", md->data.number.max);
937 case Metadata_type_float:
938 wrbuf_printf(w, "%f", md->data.fnumber);
941 wrbuf_puts(w, "[can't represent]");
944 wrbuf_printf(w, "</md-%s>\n", cmd->name);
949 static void write_subrecord(struct record *r, WRBUF w,
950 struct conf_service *service, unsigned flags,
953 const char *name = session_setting_oneval(
954 client_get_database(r->client), PZ_NAME);
956 wrbuf_puts(w, " <location id=\"");
957 wrbuf_xmlputs(w, client_get_id(r->client));
958 wrbuf_puts(w, "\"\n");
960 wrbuf_puts(w, " name=\"");
961 wrbuf_xmlputs(w, *name ? name : "Unknown");
962 wrbuf_puts(w, "\" ");
964 wrbuf_puts(w, "checksum=\"");
965 wrbuf_printf(w, "%u", r->checksum);
966 wrbuf_puts(w, "\">\n");
968 write_metadata(w, service, r->metadata, flags, indent);
969 wrbuf_puts(w, " </location>\n");
972 static void show_raw_record_error(void *data, const char *addinfo)
974 http_channel_observer_t obs = data;
975 struct http_channel *c = http_channel_observer_chan(obs);
976 struct http_response *rs = c->response;
978 http_remove_observer(obs);
980 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
983 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
985 http_channel_observer_t obs = data;
986 struct http_channel *c = http_channel_observer_chan(obs);
987 struct http_response *rs = c->response;
989 http_remove_observer(obs);
991 wrbuf_write(c->wrbuf, buf, sz);
992 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
993 http_send_response(c);
997 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
999 http_channel_observer_t obs = data;
1000 struct http_channel *c = http_channel_observer_chan(obs);
1001 struct http_response *rs = c->response;
1003 http_remove_observer(obs);
1005 wrbuf_write(c->wrbuf, buf, sz);
1006 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1008 rs->content_type = "application/octet-stream";
1009 http_send_response(c);
1013 void show_raw_reset(void *data, struct http_channel *c, void *data2)
1015 //struct client *client = data;
1016 //client_show_raw_remove(client, data2);
1019 static void cmd_record_ready(void *data);
1021 static void show_record(struct http_channel *c, struct http_session *s)
1023 struct http_response *rs = c->response;
1024 struct http_request *rq = c->request;
1025 struct record_cluster *rec, *prev_r, *next_r;
1026 struct conf_service *service;
1027 const char *idstr = http_argbyname(rq, "id");
1028 const char *offsetstr = http_argbyname(rq, "offset");
1029 const char *binarystr = http_argbyname(rq, "binary");
1030 const char *checksumstr = http_argbyname(rq, "checksum");
1031 const char *snippets = http_argbyname(rq, "snippets");
1032 unsigned flags = (snippets && *snippets == '1') ? 3 : 1;
1036 service = s->psession->service;
1039 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
1042 wrbuf_rewind(c->wrbuf);
1043 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
1045 if (session_active_clients(s->psession) == 0)
1047 error(rs, PAZPAR2_RECORD_MISSING, idstr);
1049 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
1050 cmd_record_ready, c, c) != 0)
1052 error(rs, PAZPAR2_RECORD_MISSING, idstr);
1056 if (offsetstr || checksumstr)
1058 const char *syntax = http_argbyname(rq, "syntax");
1059 const char *esn = http_argbyname(rq, "esn");
1061 struct record*r = rec->records;
1063 const char *nativesyntax = http_argbyname(rq, "nativesyntax");
1065 if (binarystr && *binarystr != '0')
1070 unsigned v = strtoul(checksumstr, 0, 10);
1071 for (i = 0; r; r = r->next)
1072 if (v == r->checksum)
1075 error(rs, PAZPAR2_RECORD_FAIL, "no record");
1079 int offset = atoi(offsetstr);
1080 for (i = 0; i < offset && r; r = r->next, i++)
1083 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
1087 http_channel_observer_t obs =
1088 http_add_observer(c, r->client, show_raw_reset);
1089 int ret = client_show_raw_begin(r->client, r->position,
1092 show_raw_record_error,
1094 show_raw_record_ok_binary :
1095 show_raw_record_ok),
1100 http_remove_observer(obs);
1101 error(rs, PAZPAR2_NO_SESSION, 0);
1108 response_open_command(c, "record");
1109 wrbuf_puts(c->wrbuf, "\n <recid>");
1110 wrbuf_xmlputs(c->wrbuf, rec->recid);
1111 wrbuf_puts(c->wrbuf, "</recid>\n");
1114 wrbuf_puts(c->wrbuf, " <prevrecid>");
1115 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
1116 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
1120 wrbuf_puts(c->wrbuf, " <nextrecid>");
1121 wrbuf_xmlputs(c->wrbuf, next_r->recid);
1122 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
1124 wrbuf_printf(c->wrbuf, " <activeclients>%d</activeclients>\n",
1125 session_active_clients(s->psession));
1126 write_metadata(c->wrbuf, service, rec->metadata, flags, 1);
1127 for (r = rec->records; r; r = r->next)
1128 write_subrecord(r, c->wrbuf, service, flags, 2);
1129 response_close(c, "record");
1131 show_single_stop(s->psession, rec);
1134 static void cmd_record_ready(void *data)
1136 struct http_channel *c = (struct http_channel *) data;
1137 struct http_session *s = locate_session(c);
1140 session_log(s->psession, c->http_sessions->log_level,
1141 "record watch released");
1143 release_session(c, s);
1147 static void cmd_record(struct http_channel *c)
1149 struct http_session *s = locate_session(c);
1153 release_session(c, s);
1158 static void show_records(struct http_channel *c, struct http_session *s,
1161 struct http_request *rq = c->request;
1162 struct http_response *rs = c->response;
1163 struct record_cluster **rl;
1164 struct reclist_sortparms *sp;
1165 const char *start = http_argbyname(rq, "start");
1166 const char *num = http_argbyname(rq, "num");
1167 const char *sort = http_argbyname(rq, "sort");
1168 int version = get_version(rq);
1169 const char *snippets = http_argbyname(rq, "snippets");
1170 unsigned flags = (snippets && *snippets == '1') ? 2 : 0;
1176 Odr_int approx_hits;
1178 struct conf_service *service = 0;
1182 // We haven't counted clients yet if we're called on a block release
1184 active = session_active_clients(s->psession);
1187 startn = atoi(start);
1191 service = s->psession->service;
1193 sort = service->default_sort;
1194 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1196 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1201 rl = show_range_start(s->psession, sp, startn, &numn, &total,
1202 &total_hits, &approx_hits, show_records_ready, c);
1206 response_open_ok(c, "show");
1207 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
1208 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
1209 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
1211 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF
1212 "</approximation>\n", approx_hits);
1214 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
1215 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
1217 for (i = 0; i < numn; i++)
1221 struct record_cluster *rec = rl[i];
1222 struct conf_service *service = s->psession->service;
1224 wrbuf_puts(c->wrbuf, "<hit>\n");
1225 write_metadata(c->wrbuf, service, rec->metadata, flags, 1);
1226 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
1227 write_subrecord(p, c->wrbuf, service, flags, 2);
1228 wrbuf_printf(c->wrbuf, " <count>%d</count>\n", ccount);
1229 if (strstr(sort, "relevance"))
1231 wrbuf_printf(c->wrbuf, " <relevance>%d</relevance>\n",
1232 rec->relevance_score);
1233 if (service->rank_debug)
1235 wrbuf_printf(c->wrbuf, " <relevance_info>\n");
1236 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain1));
1237 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain2));
1238 wrbuf_printf(c->wrbuf, " </relevance_info>\n");
1241 wrbuf_puts(c->wrbuf, " <recid>");
1242 wrbuf_xmlputs(c->wrbuf, rec->recid);
1243 wrbuf_puts(c->wrbuf, "</recid>\n");
1244 wrbuf_puts(c->wrbuf, "</hit>\n");
1247 show_range_stop(s->psession, rl);
1249 response_close(c, "show");
1252 static void show_records_ready(void *data)
1254 struct http_channel *c = (struct http_channel *) data;
1255 struct http_session *s = locate_session(c);
1258 session_log(s->psession, c->http_sessions->log_level,
1259 "show watch released");
1260 show_records(c, s, -1);
1263 /* some error message */
1265 release_session(c, s);
1268 static void cmd_show(struct http_channel *c)
1270 struct http_request *rq = c->request;
1271 struct http_response *rs = c->response;
1272 struct http_session *s = locate_session(c);
1273 const char *block = http_argbyname(rq, "block");
1274 const char *sort = http_argbyname(rq, "sort");
1275 const char *block_error = http_argbyname(rq, "report");
1276 const char *mergekey = http_argbyname(rq, "mergekey");
1277 const char *rank = http_argbyname(rq, "rank");
1278 struct conf_service *service = 0;
1279 struct reclist_sortparms *sp;
1281 int report_error = 0;
1283 if (block_error && !strcmp("1", block_error))
1287 service = s->psession->service;
1289 sort = service->default_sort;
1290 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1292 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1293 release_session(c, s);
1296 session_sort(s->psession, sp, mergekey, rank);
1298 status = session_active_clients(s->psession);
1300 if (block && reclist_get_num_records(s->psession->reclist) == 0)
1302 if (!strcmp(block, "preferred")
1303 && !session_is_preferred_clients_ready(s->psession)
1304 && reclist_get_num_records(s->psession->reclist) == 0)
1306 // if there is already a watch/block. we do not block this one
1307 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1308 show_records_ready, c, c) == 0)
1310 session_log(s->psession, c->http_sessions->log_level,
1311 "Blocking on command show (preferred targets)");
1312 release_session(c, s);
1317 session_log(s->psession, YLOG_WARN, "Attempt to block"
1318 " multiple times on show (preferred targets) block."
1322 error(rs, PAZPAR2_ALREADY_BLOCKED,
1323 "show (preferred targets)");
1324 release_session(c, s);
1328 session_log(s->psession, YLOG_WARN,
1329 "Ignoring show(preferred) block."
1330 " Returning current result");
1336 // if there is already a watch/block. we do not block this one
1337 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1338 show_records_ready, c, c) != 0)
1340 session_log(s->psession, YLOG_WARN, "Attempt to block"
1341 " multiple times on show block. Not supported!");
1344 error(rs, PAZPAR2_ALREADY_BLOCKED, "show");
1345 release_session(c, s);
1349 session_log(s->psession, YLOG_WARN, "Ignoring show block."
1350 " Returning current result");
1354 session_log(s->psession, c->http_sessions->log_level,
1355 "Blocking on command show");
1356 release_session(c, s);
1361 show_records(c, s, status);
1362 release_session(c, s);
1365 static void cmd_ping(struct http_channel *c)
1367 struct http_session *s = locate_session(c);
1370 response_open_ok(c, "ping");
1371 response_close(c, "ping");
1372 release_session(c, s);
1375 static void cmd_search(struct http_channel *c)
1377 struct http_request *rq = c->request;
1378 struct http_response *rs = c->response;
1379 struct http_session *s = locate_session(c);
1380 const char *query = http_argbyname(rq, "query");
1381 const char *filter = http_argbyname(rq, "filter");
1382 const char *maxrecs = http_argbyname(rq, "maxrecs");
1383 const char *startrecs = http_argbyname(rq, "startrecs");
1384 const char *limit = http_argbyname(rq, "limit");
1385 const char *sort = http_argbyname(rq, "sort");
1386 const char *mergekey = http_argbyname(rq, "mergekey");
1387 const char *rank = http_argbyname(rq, "rank");
1388 enum pazpar2_error_code code;
1389 const char *addinfo = 0;
1390 const char *addinfo2 = 0;
1391 struct reclist_sortparms *sp;
1392 struct conf_service *service = 0;
1399 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1400 release_session(c, s);
1403 if (!yaz_utf8_check(query))
1405 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1406 release_session(c, s);
1409 service = s->psession->service;
1411 sort = service->default_sort;
1413 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1415 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1416 release_session(c, s);
1420 code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
1421 &addinfo, &addinfo2, sp, mergekey, rank);
1424 error2(rs, code, addinfo, addinfo2);
1425 release_session(c, s);
1428 response_open_ok(c, "search");
1429 response_close(c, "search");
1430 release_session(c, s);
1434 static void cmd_stat(struct http_channel *c)
1436 struct http_session *s = locate_session(c);
1437 struct statistics stat;
1445 clients = session_active_clients(s->psession);
1446 statistics(s->psession, &stat);
1448 if (stat.num_clients > 0)
1450 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1453 response_open_command(c, "stat");
1454 wrbuf_printf(c->wrbuf, "\n <activeclients>%d</activeclients>\n", clients);
1455 wrbuf_printf(c->wrbuf, " <hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1456 wrbuf_printf(c->wrbuf, " <records>%d</records>\n", stat.num_records);
1457 wrbuf_printf(c->wrbuf, " <clients>%d</clients>\n", stat.num_clients);
1458 wrbuf_printf(c->wrbuf, " <unconnected>%d</unconnected>\n", stat.num_no_connection);
1459 wrbuf_printf(c->wrbuf, " <connecting>%d</connecting>\n", stat.num_connecting);
1460 wrbuf_printf(c->wrbuf, " <working>%d</working>\n", stat.num_working);
1461 wrbuf_printf(c->wrbuf, " <idle>%d</idle>\n", stat.num_idle);
1462 wrbuf_printf(c->wrbuf, " <failed>%d</failed>\n", stat.num_failed);
1463 wrbuf_printf(c->wrbuf, " <error>%d</error>\n", stat.num_error);
1464 wrbuf_printf(c->wrbuf, " <progress>%.2f</progress>\n", progress);
1465 response_close(c, "stat");
1466 release_session(c, s);
1469 static void cmd_stop(struct http_channel *c)
1471 struct http_session *s = locate_session(c);
1474 response_open_ok(c, "stop");
1475 session_stop(s->psession);
1476 response_close(c, "stop");
1477 release_session(c, s);
1480 static void cmd_info(struct http_channel *c)
1482 char yaz_version_str[20];
1483 char yaz_sha1_str[42];
1485 response_open_command(c, "info");
1486 wrbuf_puts(c->wrbuf, "\n <version>\n");
1487 wrbuf_puts(c->wrbuf, " <pazpar2");
1488 #ifdef PAZPAR2_VERSION_SHA1
1489 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1491 wrbuf_puts(c->wrbuf, ">");
1492 wrbuf_xmlputs(c->wrbuf, VERSION);
1493 wrbuf_puts(c->wrbuf, "</pazpar2>\n");
1495 yaz_version(yaz_version_str, yaz_sha1_str);
1496 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1497 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1498 wrbuf_puts(c->wrbuf, "\" sha1=\"");
1499 wrbuf_xmlputs(c->wrbuf, yaz_sha1_str);
1500 wrbuf_puts(c->wrbuf, "\">");
1501 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1502 wrbuf_puts(c->wrbuf, "</yaz>\n");
1504 wrbuf_puts(c->wrbuf, " </version>\n");
1507 char hostname_str[64];
1508 if (gethostname(hostname_str, sizeof(hostname_str)) == 0)
1510 wrbuf_puts(c->wrbuf, " <host>");
1511 wrbuf_xmlputs(c->wrbuf, hostname_str);
1512 wrbuf_puts(c->wrbuf, "</host>\n");
1516 info_services(c->server, c->wrbuf);
1518 response_close(c, "info");
1523 void (*fun)(struct http_channel *c);
1525 { "init", cmd_init },
1526 { "settings", cmd_settings },
1527 { "stat", cmd_stat },
1528 { "bytarget", cmd_bytarget },
1529 { "show", cmd_show },
1530 { "search", cmd_search },
1531 { "termlist", cmd_termlist },
1532 { "exit", cmd_exit },
1533 { "session-status", cmd_session_status },
1534 { "server-status", cmd_server_status },
1535 { "service", cmd_service },
1536 { "ping", cmd_ping },
1537 { "record", cmd_record },
1538 { "info", cmd_info },
1539 { "stop", cmd_stop },
1543 void http_command(struct http_channel *c)
1545 const char *command = http_argbyname(c->request, "command");
1546 struct http_response *rs = http_create_response(c);
1551 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1552 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1556 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1559 for (i = 0; commands[i].name; i++)
1560 if (!strcmp(commands[i].name, command))
1562 (*commands[i].fun)(c);
1565 if (!commands[i].name)
1566 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1574 * c-file-style: "Stroustrup"
1575 * indent-tabs-mode: nil
1577 * vim: shiftwidth=4 tabstop=8 expandtab