1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2013 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 error(struct http_response *rs,
267 enum pazpar2_error_code code,
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);
281 wrbuf_xmlputs(text, addinfo);
282 wrbuf_puts(text, "</error>");
284 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
285 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
286 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
288 http_send_response(c);
291 static void response_open_command(struct http_channel *c, const char *command)
293 wrbuf_rewind(c->wrbuf);
294 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX);
296 wrbuf_printf(c->wrbuf, "<%s>", command);
299 static void response_open_ok(struct http_channel *c, const char *command)
301 response_open_command(c, command);
302 wrbuf_puts(c->wrbuf, "<status>OK</status>");
305 static void response_close(struct http_channel *c, const char *command)
307 struct http_response *rs = c->response;
310 wrbuf_printf(c->wrbuf, "</%s>", command);
311 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
312 http_send_response(c);
315 unsigned int make_sessionid(void)
317 static int seq = 0; /* thread pr */
321 if (global_parameters.predictable_sessions)
330 if (gettimeofday(&t, 0) < 0)
332 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
335 /* at most 256 sessions per second ..
336 (long long would be more appropriate)*/
338 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
344 static struct http_session *locate_session(struct http_channel *c)
346 struct http_request *rq = c->request;
347 struct http_response *rs = c->response;
348 struct http_session *p;
349 const char *session = http_argbyname(rq, "session");
350 http_sessions_t http_sessions = c->http_sessions;
355 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
359 yaz_mutex_enter(http_sessions->mutex);
360 for (p = http_sessions->session_list; p; p = p->next)
361 if (id == p->session_id)
364 p->activity_counter++;
365 yaz_mutex_leave(http_sessions->mutex);
367 iochan_activity(p->timeout_iochan);
369 error(rs, PAZPAR2_NO_SESSION, session);
373 // Call after use of locate_session, in order to increment the destroy_counter
374 static void release_session(struct http_channel *c,
375 struct http_session *session)
377 http_sessions_t http_sessions = c->http_sessions;
378 yaz_mutex_enter(http_sessions->mutex);
380 session->destroy_counter++;
381 yaz_mutex_leave(http_sessions->mutex);
384 // Decode settings parameters and apply to session
385 // Syntax: setting[target]=value
386 static int process_settings(struct session *se, struct http_request *rq,
387 struct http_response *rs)
389 struct http_argument *a;
391 for (a = rq->arguments; a; a = a->next)
392 if (strchr(a->name, '['))
399 // Nmem_strsplit *rules*!!!
400 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
403 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
408 session_apply_setting(se, dbname, setting,
409 nmem_strdup(se->session_nmem, a->value));
414 static void cmd_exit(struct http_channel *c)
416 yaz_log(YLOG_WARN, "exit");
418 response_open_ok(c, "exit");
419 response_close(c, "exit");
420 if (global_parameters.debug_mode)
421 http_close_server(c->server);
424 static void cmd_init(struct http_channel *c)
426 struct http_request *r = c->request;
427 const char *clear = http_argbyname(r, "clear");
428 const char *content_type = http_lookup_header(r->headers, "Content-Type");
430 struct http_session *s;
431 struct http_response *rs = c->response;
432 struct conf_service *service = 0; /* no service (yet) */
434 if (r->content_len && content_type &&
435 !yaz_strcmp_del("text/xml", content_type, "; "))
437 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
441 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
444 root_n = xmlDocGetRootElement(doc);
445 service = service_create(c->server, root_n);
449 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
456 const char *service_name = http_argbyname(c->request, "service");
457 service = locate_service(c->server, service_name);
460 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
464 sesid = make_sessionid();
465 s = http_session_create(service, c->http_sessions, sesid);
467 if (!clear || *clear == '0')
468 session_init_databases(s->psession);
470 session_log(s->psession, YLOG_LOG, "No databases preloaded");
472 if (process_settings(s->psession, c->request, c->response) < 0)
475 response_open_ok(c, "init");
476 wrbuf_printf(c->wrbuf, "<session>%d", sesid);
477 if (c->server->server_id)
479 wrbuf_puts(c->wrbuf, ".");
480 wrbuf_puts(c->wrbuf, c->server->server_id);
482 wrbuf_puts(c->wrbuf, "</session>"
483 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol>");
485 wrbuf_printf(c->wrbuf, "<keepAlive>%d</keepAlive>\n",
486 1000 * ((s->psession->service->session_timeout >= 20) ?
487 (s->psession->service->session_timeout - 10) : 50));
488 response_close(c, "init");
491 static void apply_local_setting(void *client_data,
494 struct session *se = (struct session *) client_data;
496 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
497 nmem_strdup(se->session_nmem, set->name),
498 nmem_strdup(se->session_nmem, set->value));
501 static void cmd_settings(struct http_channel *c)
503 struct http_response *rs = c->response;
504 struct http_request *rq = c->request;
505 struct http_session *s = locate_session(c);
506 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
511 if (rq->content_len && content_type &&
512 !yaz_strcmp_del("text/xml", content_type, "; "))
514 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
519 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
520 release_session(c, s);
523 root_n = xmlDocGetRootElement(doc);
524 ret = settings_read_node_x(root_n, s->psession, apply_local_setting);
528 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
529 release_session(c, s);
533 if (process_settings(s->psession, rq, rs) < 0)
535 release_session(c, s);
538 response_open_ok(c, "settings");
539 response_close(c, "settings");
540 release_session(c, s);
543 static void termlist_response(struct http_channel *c, struct http_session *s,
544 const char *cmd_status)
546 struct http_request *rq = c->request;
547 const char *name = http_argbyname(rq, "name");
548 const char *nums = http_argbyname(rq, "num");
549 int version = get_version(rq);
556 status = session_active_clients(s->psession);
558 response_open_command(c, "termlist");
559 /* new protocol add a status to response. Triggered by a status parameter */
561 wrbuf_printf(c->wrbuf, "<status>%s</status>\n", cmd_status);
562 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
564 perform_termlist(c, s->psession, name, num, version);
566 response_close(c, "termlist");
569 static void termlist_result_ready(void *data)
571 struct http_channel *c = (struct http_channel *) data;
572 struct http_request *rq = c->request;
573 const char *report = http_argbyname(rq, "report");
574 const char *status = 0;
575 struct http_session *s = locate_session(c);
576 if (report && !strcmp("status", report))
580 session_log(s->psession, c->http_sessions->log_level,
581 "termlist watch released");
582 termlist_response(c, s, status);
583 release_session(c, s);
587 static void cmd_termlist(struct http_channel *c)
589 struct http_request *rq = c->request;
590 struct http_response *rs = c->response;
591 struct http_session *s = locate_session(c);
592 const char *block = http_argbyname(rq, "block");
593 const char *report = http_argbyname(rq, "report");
594 int report_status = 0;
595 int report_error = 0;
596 const char *status_message = 0;
599 if (report && !strcmp("error", report))
602 status_message = "OK";
604 if (report && !strcmp("status", report))
607 status_message = "OK";
612 active_clients = session_active_clients(s->psession);
613 if (block && !strcmp("1", block) && active_clients)
615 // if there is already a watch/block. we do not block this one
616 if (session_set_watch(s->psession, SESSION_WATCH_TERMLIST,
617 termlist_result_ready, c, c) != 0)
619 session_log(s->psession, YLOG_WARN, "Attempt to block "
620 "multiple times on termlist block. Not supported!");
622 error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
623 release_session(c, s);
626 else if (report_status)
627 status_message = "WARNING (Already blocked on termlist)";
629 session_log(s->psession, YLOG_WARN,
630 "Ignoring termlist block. Return current result");
634 session_log(s->psession, c->http_sessions->log_level,
635 "Blocking on command termlist");
636 release_session(c, s);
641 termlist_response(c, s, status_message);
642 release_session(c, s);
645 size_t session_get_memory_status(struct session *session);
647 static void session_status(struct http_channel *c, struct http_session *s)
650 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n",
651 s->activity_counter);
652 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n",
653 nmem_total(s->nmem) );
654 session_nmem = session_get_memory_status(s->psession);
655 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
658 static void cmd_service(struct http_channel *c)
660 struct http_session *s = locate_session(c);
665 response_open_command(c, 0);
666 xml_node = s->psession->service->xml_node;
669 xmlNode *tmp = xmlCopyNode(xml_node, 1);
670 xmlBufferPtr buf = xmlBufferCreate();
672 xmlNodeDump(buf, tmp->doc, tmp, 0, 0);
674 wrbuf_write(c->wrbuf, (const char *) buf->content, buf->use);
679 response_close(c, 0);
680 release_session(c, s);
683 static void cmd_session_status(struct http_channel *c)
685 struct http_session *s = locate_session(c);
689 response_open_ok(c, "session-status");
690 session_status(c, s);
691 response_close(c, "session-status");
692 release_session(c, s);
695 #ifdef HAVE_RESULTSETS_COUNT
696 int resultsets_count(void);
698 #define resultsets_count() 0
701 static void cmd_server_status(struct http_channel *c)
703 int sessions = sessions_count();
704 int clients = clients_count();
705 int resultsets = resultsets_count();
707 response_open_ok(c, "server-status");
708 wrbuf_printf(c->wrbuf, "\n <sessions>%u</sessions>\n", sessions);
709 wrbuf_printf(c->wrbuf, " <clients>%u</clients>\n", clients);
710 /* Only works if yaz has been compiled with enabling of this */
711 wrbuf_printf(c->wrbuf, " <resultsets>%u</resultsets>\n",resultsets);
712 print_meminfo(c->wrbuf);
714 /* TODO add all sessions status */
715 /* http_sessions_t http_sessions = c->http_sessions; */
716 /* struct http_session *p; */
718 yaz_mutex_enter(http_sessions->mutex);
719 for (p = http_sessions->session_list; p; p = p->next)
721 p->activity_counter++;
722 wrbuf_puts(c->wrbuf, "<session-status>\n");
723 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
724 yaz_mutex_leave(http_sessions->mutex);
725 session_status(c, p);
726 wrbuf_puts(c->wrbuf, "</session-status>\n");
727 yaz_mutex_enter(http_sessions->mutex);
728 p->activity_counter--;
730 yaz_mutex_leave(http_sessions->mutex);
732 response_close(c, "server-status");
736 static void bytarget_response(struct http_channel *c, struct http_session *s,
737 const char *cmd_status)
740 struct http_request *rq = c->request;
741 const char *settings = http_argbyname(rq, "settings");
742 int version = get_version(rq);
743 struct hitsbytarget *ht = get_hitsbytarget(s->psession, &count, c->nmem);
746 /* Old protocol, always ok */
747 response_open_ok(c, "bytarget");
750 /* New protocol, OK or WARNING (...)*/
751 response_open_command(c, "bytarget");
752 wrbuf_printf(c->wrbuf, "<status>%s</status>", cmd_status);
756 session_log(s->psession, YLOG_WARN,
757 "Empty bytarget Response. No targets found!");
758 for (i = 0; i < count; i++)
760 wrbuf_puts(c->wrbuf, "\n<target>");
762 wrbuf_puts(c->wrbuf, "<id>");
763 wrbuf_xmlputs(c->wrbuf, ht[i].id);
764 wrbuf_puts(c->wrbuf, "</id>\n");
766 if (ht[i].name && ht[i].name[0])
768 wrbuf_puts(c->wrbuf, "<name>");
769 wrbuf_xmlputs(c->wrbuf, ht[i].name);
770 wrbuf_puts(c->wrbuf, "</name>\n");
773 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
774 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n",
776 if (ht[i].diagnostic)
778 wrbuf_puts(c->wrbuf, "<message>");
779 wrbuf_xmlputs(c->wrbuf, ht[i].message);
780 wrbuf_puts(c->wrbuf, "</message>\n");
781 wrbuf_puts(c->wrbuf, "<addinfo>");
783 wrbuf_xmlputs(c->wrbuf, ht[i].addinfo);
784 wrbuf_puts(c->wrbuf, "</addinfo>\n");
787 wrbuf_printf(c->wrbuf, "<records>%d</records>\n",
788 ht[i].records - ht[i].filtered);
791 wrbuf_printf(c->wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
792 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF
793 "</approximation>\n", ht[i].approximation);
795 wrbuf_puts(c->wrbuf, "<state>");
796 wrbuf_xmlputs(c->wrbuf, ht[i].state);
797 wrbuf_puts(c->wrbuf, "</state>\n");
798 if (settings && *settings == '1')
800 wrbuf_puts(c->wrbuf, "<settings>\n");
801 wrbuf_puts(c->wrbuf, ht[i].settings_xml);
802 wrbuf_puts(c->wrbuf, "</settings>\n");
804 if (ht[i].suggestions_xml && ht[i].suggestions_xml[0])
806 wrbuf_puts(c->wrbuf, "<suggestions>");
807 wrbuf_puts(c->wrbuf, ht[i].suggestions_xml);
808 wrbuf_puts(c->wrbuf, "</suggestions>");
810 wrbuf_puts(c->wrbuf, "</target>");
812 response_close(c, "bytarget");
815 static void bytarget_result_ready(void *data)
817 struct http_channel *c = (struct http_channel *) data;
818 struct http_session *s = locate_session(c);
819 const char *status_message = "OK";
822 session_log(s->psession, c->http_sessions->log_level,
823 "bytarget watch released");
824 bytarget_response(c, s, status_message);
825 release_session(c, s);
828 yaz_log(c->http_sessions->log_level,
829 "No Session found for released bytarget watch");
833 static void cmd_bytarget(struct http_channel *c)
835 struct http_request *rq = c->request;
836 struct http_response *rs = c->response;
837 struct http_session *s = locate_session(c);
838 const char *block = http_argbyname(rq, "block");
839 const char *report = http_argbyname(rq, "report");
840 int report_error = 0;
841 int report_status = 0;
842 const char *status_message = "OK";
845 if (report && !strcmp("error", report))
847 if (report && !strcmp("status", report))
853 no_active = session_active_clients(s->psession);
854 if (block && !strcmp("1", block) && no_active)
856 // if there is already a watch/block. we do not block this one
857 if (session_set_watch(s->psession, SESSION_WATCH_BYTARGET,
858 bytarget_result_ready, c, c) != 0)
860 session_log(s->psession, YLOG_WARN, "Attempt to block "
861 "multiple times on bytarget block. Not supported!");
864 error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget");
865 release_session(c, s);
868 else if (report_status)
869 status_message = "WARNING (Already blocked on bytarget)";
871 session_log(s->psession, YLOG_WARN, "Ignoring bytarget block."
872 " Return current result.");
876 session_log(s->psession, c->http_sessions->log_level,
877 "Blocking on command bytarget");
878 release_session(c, s);
882 bytarget_response(c, s, status_message);
883 release_session(c, s);
886 static void write_metadata(WRBUF w, struct conf_service *service,
887 struct record_metadata **ml, int full, int indent)
891 for (imeta = 0; imeta < service->num_metadata; imeta++)
893 struct conf_metadata *cmd = &service->metadata[imeta];
894 struct record_metadata *md;
895 if (!cmd->brief && !full)
897 for (md = ml[imeta]; md; md = md->next)
899 struct record_metadata_attr *attr = md->attributes;
901 for (i = 0; i < indent; i++)
903 wrbuf_printf(w, "<md-%s", cmd->name);
905 for (; attr; attr = attr->next)
907 wrbuf_printf(w, " %s=\"", attr->name);
908 wrbuf_xmlputs(w, attr->value);
914 case Metadata_type_generic:
915 wrbuf_xmlputs(w, md->data.text.disp);
917 case Metadata_type_year:
918 wrbuf_printf(w, "%d", md->data.number.min);
919 if (md->data.number.min != md->data.number.max)
920 wrbuf_printf(w, "-%d", md->data.number.max);
923 wrbuf_puts(w, "[can't represent]");
926 wrbuf_printf(w, "</md-%s>\n", cmd->name);
931 static void write_subrecord(struct record *r, WRBUF w,
932 struct conf_service *service, int show_details)
934 const char *name = session_setting_oneval(
935 client_get_database(r->client), PZ_NAME);
937 wrbuf_puts(w, " <location id=\"");
938 wrbuf_xmlputs(w, client_get_id(r->client));
939 wrbuf_puts(w, "\"\n");
941 wrbuf_puts(w, " name=\"");
942 wrbuf_xmlputs(w, *name ? name : "Unknown");
943 wrbuf_puts(w, "\" ");
945 wrbuf_puts(w, "checksum=\"");
946 wrbuf_printf(w, "%u", r->checksum);
947 wrbuf_puts(w, "\">\n");
949 write_metadata(w, service, r->metadata, show_details, 2);
950 wrbuf_puts(w, " </location>\n");
953 static void show_raw_record_error(void *data, const char *addinfo)
955 http_channel_observer_t obs = data;
956 struct http_channel *c = http_channel_observer_chan(obs);
957 struct http_response *rs = c->response;
959 http_remove_observer(obs);
961 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
964 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
966 http_channel_observer_t obs = data;
967 struct http_channel *c = http_channel_observer_chan(obs);
968 struct http_response *rs = c->response;
970 http_remove_observer(obs);
972 wrbuf_write(c->wrbuf, buf, sz);
973 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
974 http_send_response(c);
978 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
980 http_channel_observer_t obs = data;
981 struct http_channel *c = http_channel_observer_chan(obs);
982 struct http_response *rs = c->response;
984 http_remove_observer(obs);
986 wrbuf_write(c->wrbuf, buf, sz);
987 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
989 rs->content_type = "application/octet-stream";
990 http_send_response(c);
994 void show_raw_reset(void *data, struct http_channel *c, void *data2)
996 //struct client *client = data;
997 //client_show_raw_remove(client, data2);
1000 static void cmd_record_ready(void *data);
1002 static void show_record(struct http_channel *c, struct http_session *s)
1004 struct http_response *rs = c->response;
1005 struct http_request *rq = c->request;
1006 struct record_cluster *rec, *prev_r, *next_r;
1007 struct conf_service *service;
1008 const char *idstr = http_argbyname(rq, "id");
1009 const char *offsetstr = http_argbyname(rq, "offset");
1010 const char *binarystr = http_argbyname(rq, "binary");
1011 const char *checksumstr = http_argbyname(rq, "checksum");
1015 service = s->psession->service;
1018 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
1021 wrbuf_rewind(c->wrbuf);
1022 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
1024 if (session_active_clients(s->psession) == 0)
1026 error(rs, PAZPAR2_RECORD_MISSING, idstr);
1028 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
1029 cmd_record_ready, c, c) != 0)
1031 error(rs, PAZPAR2_RECORD_MISSING, idstr);
1035 if (offsetstr || checksumstr)
1037 const char *syntax = http_argbyname(rq, "syntax");
1038 const char *esn = http_argbyname(rq, "esn");
1040 struct record*r = rec->records;
1042 const char *nativesyntax = http_argbyname(rq, "nativesyntax");
1044 if (binarystr && *binarystr != '0')
1049 unsigned v = strtoul(checksumstr, 0, 10);
1050 for (i = 0; r; r = r->next)
1051 if (v == r->checksum)
1054 error(rs, PAZPAR2_RECORD_FAIL, "no record");
1058 int offset = atoi(offsetstr);
1059 for (i = 0; i < offset && r; r = r->next, i++)
1062 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
1066 http_channel_observer_t obs =
1067 http_add_observer(c, r->client, show_raw_reset);
1068 int ret = client_show_raw_begin(r->client, r->position,
1071 show_raw_record_error,
1073 show_raw_record_ok_binary :
1074 show_raw_record_ok),
1079 http_remove_observer(obs);
1080 error(rs, PAZPAR2_NO_SESSION, 0);
1087 response_open_command(c, "record");
1088 wrbuf_puts(c->wrbuf, "\n <recid>");
1089 wrbuf_xmlputs(c->wrbuf, rec->recid);
1090 wrbuf_puts(c->wrbuf, "</recid>\n");
1093 wrbuf_puts(c->wrbuf, " <prevrecid>");
1094 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
1095 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
1099 wrbuf_puts(c->wrbuf, " <nextrecid>");
1100 wrbuf_xmlputs(c->wrbuf, next_r->recid);
1101 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
1103 wrbuf_printf(c->wrbuf, " <activeclients>%d</activeclients>\n",
1104 session_active_clients(s->psession));
1105 write_metadata(c->wrbuf, service, rec->metadata, 1, 1);
1106 for (r = rec->records; r; r = r->next)
1107 write_subrecord(r, c->wrbuf, service, 2);
1108 response_close(c, "record");
1110 show_single_stop(s->psession, rec);
1113 static void cmd_record_ready(void *data)
1115 struct http_channel *c = (struct http_channel *) data;
1116 struct http_session *s = locate_session(c);
1119 session_log(s->psession, c->http_sessions->log_level,
1120 "record watch released");
1122 release_session(c, s);
1126 static void cmd_record(struct http_channel *c)
1128 struct http_session *s = locate_session(c);
1132 release_session(c, s);
1137 static void show_records(struct http_channel *c, struct http_session *s,
1140 struct http_request *rq = c->request;
1141 struct http_response *rs = c->response;
1142 struct record_cluster **rl;
1143 struct reclist_sortparms *sp;
1144 const char *start = http_argbyname(rq, "start");
1145 const char *num = http_argbyname(rq, "num");
1146 const char *sort = http_argbyname(rq, "sort");
1147 int version = get_version(rq);
1153 Odr_int approx_hits;
1155 struct conf_service *service = 0;
1159 // We haven't counted clients yet if we're called on a block release
1161 active = session_active_clients(s->psession);
1164 startn = atoi(start);
1168 service = s->psession->service;
1170 sort = service->default_sort;
1171 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1173 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1178 rl = show_range_start(s->psession, sp, startn, &numn, &total,
1179 &total_hits, &approx_hits, show_records_ready, c);
1183 response_open_ok(c, "show");
1184 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
1185 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
1186 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
1188 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF
1189 "</approximation>\n", approx_hits);
1191 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
1192 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
1194 for (i = 0; i < numn; i++)
1198 struct record_cluster *rec = rl[i];
1199 struct conf_service *service = s->psession->service;
1201 wrbuf_puts(c->wrbuf, "<hit>\n");
1202 write_metadata(c->wrbuf, service, rec->metadata, 0, 1);
1203 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
1204 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
1205 wrbuf_printf(c->wrbuf, " <count>%d</count>\n", ccount);
1206 if (strstr(sort, "relevance"))
1208 wrbuf_printf(c->wrbuf, " <relevance>%d</relevance>\n",
1209 rec->relevance_score);
1210 if (service->rank_debug)
1212 wrbuf_printf(c->wrbuf, " <relevance_info>\n");
1213 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain1));
1214 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain2));
1215 wrbuf_printf(c->wrbuf, " </relevance_info>\n");
1218 wrbuf_puts(c->wrbuf, " <recid>");
1219 wrbuf_xmlputs(c->wrbuf, rec->recid);
1220 wrbuf_puts(c->wrbuf, "</recid>\n");
1221 wrbuf_puts(c->wrbuf, "</hit>\n");
1224 show_range_stop(s->psession, rl);
1226 response_close(c, "show");
1229 static void show_records_ready(void *data)
1231 struct http_channel *c = (struct http_channel *) data;
1232 struct http_session *s = locate_session(c);
1235 session_log(s->psession, c->http_sessions->log_level,
1236 "show watch released");
1237 show_records(c, s, -1);
1240 /* some error message */
1242 release_session(c, s);
1245 static void cmd_show(struct http_channel *c)
1247 struct http_request *rq = c->request;
1248 struct http_response *rs = c->response;
1249 struct http_session *s = locate_session(c);
1250 const char *block = http_argbyname(rq, "block");
1251 const char *sort = http_argbyname(rq, "sort");
1252 const char *block_error = http_argbyname(rq, "report");
1253 const char *mergekey = http_argbyname(rq, "mergekey");
1254 const char *rank = http_argbyname(rq, "rank");
1255 struct conf_service *service = 0;
1256 struct reclist_sortparms *sp;
1258 int report_error = 0;
1260 if (block_error && !strcmp("1", block_error))
1264 service = s->psession->service;
1266 sort = service->default_sort;
1267 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1269 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1270 release_session(c, s);
1273 session_sort(s->psession, sp, mergekey, rank);
1275 status = session_active_clients(s->psession);
1279 if (!strcmp(block, "preferred")
1280 && !session_is_preferred_clients_ready(s->psession)
1281 && reclist_get_num_records(s->psession->reclist) == 0)
1283 // if there is already a watch/block. we do not block this one
1284 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1285 show_records_ready, c, c) == 0)
1287 session_log(s->psession, c->http_sessions->log_level,
1288 "Blocking on command show (preferred targets)");
1289 release_session(c, s);
1294 session_log(s->psession, YLOG_WARN, "Attempt to block"
1295 " multiple times on show (preferred targets) block."
1299 error(rs, PAZPAR2_ALREADY_BLOCKED,
1300 "show (preferred targets)");
1301 release_session(c, s);
1305 session_log(s->psession, YLOG_WARN,
1306 "Ignoring show(preferred) block."
1307 " Returning current result");
1313 // if there is already a watch/block. we do not block this one
1314 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1315 show_records_ready, c, c) != 0)
1317 session_log(s->psession, YLOG_WARN, "Attempt to block"
1318 " multiple times on show block. Not supported!");
1321 error(rs, PAZPAR2_ALREADY_BLOCKED, "show");
1322 release_session(c, s);
1326 session_log(s->psession, YLOG_WARN, "Ignoring show block."
1327 " Returning current result");
1331 session_log(s->psession, c->http_sessions->log_level,
1332 "Blocking on command show");
1333 release_session(c, s);
1338 show_records(c, s, status);
1339 release_session(c, s);
1342 static void cmd_ping(struct http_channel *c)
1344 struct http_session *s = locate_session(c);
1347 response_open_ok(c, "ping");
1348 response_close(c, "ping");
1349 release_session(c, s);
1352 static void cmd_search(struct http_channel *c)
1354 struct http_request *rq = c->request;
1355 struct http_response *rs = c->response;
1356 struct http_session *s = locate_session(c);
1357 const char *query = http_argbyname(rq, "query");
1358 const char *filter = http_argbyname(rq, "filter");
1359 const char *maxrecs = http_argbyname(rq, "maxrecs");
1360 const char *startrecs = http_argbyname(rq, "startrecs");
1361 const char *limit = http_argbyname(rq, "limit");
1362 const char *sort = http_argbyname(rq, "sort");
1363 const char *mergekey = http_argbyname(rq, "mergekey");
1364 const char *rank = http_argbyname(rq, "rank");
1365 enum pazpar2_error_code code;
1366 const char *addinfo = 0;
1367 struct reclist_sortparms *sp;
1368 struct conf_service *service = 0;
1375 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1376 release_session(c, s);
1379 if (!yaz_utf8_check(query))
1381 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1382 release_session(c, s);
1385 service = s->psession->service;
1387 sort = service->default_sort;
1389 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1391 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1392 release_session(c, s);
1396 code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
1397 &addinfo, sp, mergekey, rank);
1400 error(rs, code, addinfo);
1401 release_session(c, s);
1404 response_open_ok(c, "search");
1405 response_close(c, "search");
1406 release_session(c, s);
1410 static void cmd_stat(struct http_channel *c)
1412 struct http_session *s = locate_session(c);
1413 struct statistics stat;
1421 clients = session_active_clients(s->psession);
1422 statistics(s->psession, &stat);
1424 if (stat.num_clients > 0)
1426 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1429 response_open_command(c, "stat");
1430 wrbuf_printf(c->wrbuf, "\n <activeclients>%d</activeclients>\n", clients);
1431 wrbuf_printf(c->wrbuf, " <hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1432 wrbuf_printf(c->wrbuf, " <records>%d</records>\n", stat.num_records);
1433 wrbuf_printf(c->wrbuf, " <clients>%d</clients>\n", stat.num_clients);
1434 wrbuf_printf(c->wrbuf, " <unconnected>%d</unconnected>\n", stat.num_no_connection);
1435 wrbuf_printf(c->wrbuf, " <connecting>%d</connecting>\n", stat.num_connecting);
1436 wrbuf_printf(c->wrbuf, " <working>%d</working>\n", stat.num_working);
1437 wrbuf_printf(c->wrbuf, " <idle>%d</idle>\n", stat.num_idle);
1438 wrbuf_printf(c->wrbuf, " <failed>%d</failed>\n", stat.num_failed);
1439 wrbuf_printf(c->wrbuf, " <error>%d</error>\n", stat.num_error);
1440 wrbuf_printf(c->wrbuf, " <progress>%.2f</progress>\n", progress);
1441 response_close(c, "stat");
1442 release_session(c, s);
1445 static void cmd_info(struct http_channel *c)
1447 char yaz_version_str[20];
1448 char yaz_sha1_str[42];
1450 response_open_command(c, "info");
1451 wrbuf_puts(c->wrbuf, "\n <version>\n");
1452 wrbuf_puts(c->wrbuf, " <pazpar2");
1453 #ifdef PAZPAR2_VERSION_SHA1
1454 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1456 wrbuf_puts(c->wrbuf, ">");
1457 wrbuf_xmlputs(c->wrbuf, VERSION);
1458 wrbuf_puts(c->wrbuf, "</pazpar2>\n");
1460 yaz_version(yaz_version_str, yaz_sha1_str);
1461 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1462 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1463 wrbuf_puts(c->wrbuf, "\" sha1=\"");
1464 wrbuf_xmlputs(c->wrbuf, yaz_sha1_str);
1465 wrbuf_puts(c->wrbuf, "\">");
1466 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1467 wrbuf_puts(c->wrbuf, "</yaz>\n");
1469 wrbuf_puts(c->wrbuf, " </version>\n");
1472 char hostname_str[64];
1473 if (gethostname(hostname_str, sizeof(hostname_str)) == 0)
1475 wrbuf_puts(c->wrbuf, " <host>");
1476 wrbuf_xmlputs(c->wrbuf, hostname_str);
1477 wrbuf_puts(c->wrbuf, "</host>\n");
1481 info_services(c->server, c->wrbuf);
1483 response_close(c, "info");
1488 void (*fun)(struct http_channel *c);
1490 { "init", cmd_init },
1491 { "settings", cmd_settings },
1492 { "stat", cmd_stat },
1493 { "bytarget", cmd_bytarget },
1494 { "show", cmd_show },
1495 { "search", cmd_search },
1496 { "termlist", cmd_termlist },
1497 { "exit", cmd_exit },
1498 { "session-status", cmd_session_status },
1499 { "server-status", cmd_server_status },
1500 { "service", cmd_service },
1501 { "ping", cmd_ping },
1502 { "record", cmd_record },
1503 { "info", cmd_info },
1507 void http_command(struct http_channel *c)
1509 const char *command = http_argbyname(c->request, "command");
1510 struct http_response *rs = http_create_response(c);
1515 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1516 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1520 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1523 for (i = 0; commands[i].name; i++)
1524 if (!strcmp(commands[i].name, command))
1526 (*commands[i].fun)(c);
1529 if (!commands[i].name)
1530 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1538 * c-file-style: "Stroustrup"
1539 * indent-tabs-mode: nil
1541 * vim: shiftwidth=4 tabstop=8 expandtab