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 sessions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), sessions);
122 http_sessions_t http_sessions_create(void)
124 http_sessions_t hs = xmalloc(sizeof(*hs));
125 hs->session_list = 0;
127 pazpar2_mutex_create(&hs->mutex, "http_sessions");
128 hs->log_level = yaz_log_module_level("HTTP");
132 void http_sessions_destroy(http_sessions_t hs)
136 struct http_session *s = hs->session_list;
139 struct http_session *s_next = s->next;
140 iochan_destroy(s->timeout_iochan);
141 session_destroy(s->psession);
142 nmem_destroy(s->nmem);
145 yaz_mutex_destroy(&hs->mutex);
150 void http_session_destroy(struct http_session *s);
152 static void session_timeout(IOCHAN i, int event)
154 struct http_session *s = iochan_getdata(i);
155 http_session_destroy(s);
158 struct http_session *http_session_create(struct conf_service *service,
159 http_sessions_t http_sessions,
162 NMEM nmem = nmem_create();
163 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
166 sprintf(tmp_str, "session#%u", sesid);
167 r->psession = new_session(nmem, service, sesid);
168 r->session_id = sesid;
171 r->destroy_counter = r->activity_counter = 0;
172 r->http_sessions = http_sessions;
174 yaz_mutex_enter(http_sessions->mutex);
175 r->next = http_sessions->session_list;
176 http_sessions->session_list = r;
177 yaz_mutex_leave(http_sessions->mutex);
179 r->timeout_iochan = iochan_create(-1, session_timeout, 0, "http_session_timeout");
180 iochan_setdata(r->timeout_iochan, r);
181 yaz_log(http_sessions->log_level, "Session %u created. timeout chan=%p timeout=%d", sesid, r->timeout_iochan, service->session_timeout);
182 iochan_settimeout(r->timeout_iochan, service->session_timeout);
184 iochan_add(service->server->iochan_man, r->timeout_iochan);
189 void http_session_destroy(struct http_session *s)
191 int must_destroy = 0;
193 http_sessions_t http_sessions = s->http_sessions;
195 yaz_log(http_sessions->log_level, "Session %u destroy", s->session_id);
196 yaz_mutex_enter(http_sessions->mutex);
197 /* only if http_session has no active http sessions on it can be destroyed */
198 if (s->destroy_counter == s->activity_counter)
200 struct http_session **p = 0;
202 for (p = &http_sessions->session_list; *p; p = &(*p)->next)
209 yaz_mutex_leave(http_sessions->mutex);
211 { /* destroying for real */
212 yaz_log(http_sessions->log_level, "Session %u destroyed", s->session_id);
213 iochan_destroy(s->timeout_iochan);
214 session_destroy(s->psession);
215 http_session_use(-1);
216 nmem_destroy(s->nmem);
219 yaz_log(http_sessions->log_level, "Session %u destroying delayed. Active clients (%d-%d). Waiting for new timeout.",
220 s->session_id, s->activity_counter, s->destroy_counter);
225 static const char *get_msg(enum pazpar2_error_code code)
227 struct pazpar2_error_msg {
228 enum pazpar2_error_code code;
231 static const struct pazpar2_error_msg ar[] = {
232 { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
233 { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
234 { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
235 { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
236 { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
237 { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
238 { PAZPAR2_RECORD_MISSING, "Record missing"},
239 { PAZPAR2_NO_TARGETS, "No targets"},
240 { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
241 { PAZPAR2_RECORD_FAIL, "Record command failed"},
242 { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
243 { PAZPAR2_NO_SERVICE, "No service"},
244 { PAZPAR2_ALREADY_BLOCKED, "Already blocked in session on: "},
245 { PAZPAR2_LAST_ERROR, "Last error"},
251 if (code == ar[i].code)
258 static void error(struct http_response *rs,
259 enum pazpar2_error_code code,
262 struct http_channel *c = rs->channel;
263 WRBUF text = wrbuf_alloc();
264 const char *http_status = "417";
265 const char *msg = get_msg(code);
267 rs->msg = nmem_strdup(c->nmem, msg);
268 strcpy(rs->code, http_status);
270 wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX "<error code=\"%d\" msg=\"%s\">", (int) code,
273 wrbuf_xmlputs(text, addinfo);
274 wrbuf_puts(text, "</error>");
276 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
277 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
278 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
280 http_send_response(c);
283 static void response_open_no_status(struct http_channel *c, const char *command)
285 wrbuf_rewind(c->wrbuf);
286 wrbuf_printf(c->wrbuf, "%s<%s>",
287 HTTP_COMMAND_RESPONSE_PREFIX, command);
290 static void response_open(struct http_channel *c, const char *command)
292 response_open_no_status(c, command);
293 wrbuf_puts(c->wrbuf, "<status>OK</status>");
296 static void response_close(struct http_channel *c, const char *command)
298 struct http_response *rs = c->response;
300 wrbuf_printf(c->wrbuf, "</%s>", command);
301 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
302 http_send_response(c);
305 unsigned int make_sessionid(void)
307 static int seq = 0; /* thread pr */
311 if (global_parameters.predictable_sessions)
320 if (gettimeofday(&t, 0) < 0)
322 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
325 /* at most 256 sessions per second ..
326 (long long would be more appropriate)*/
328 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
334 static struct http_session *locate_session(struct http_channel *c)
336 struct http_request *rq = c->request;
337 struct http_response *rs = c->response;
338 struct http_session *p;
339 const char *session = http_argbyname(rq, "session");
340 http_sessions_t http_sessions = c->http_sessions;
345 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
349 yaz_mutex_enter(http_sessions->mutex);
350 for (p = http_sessions->session_list; p; p = p->next)
351 if (id == p->session_id)
354 p->activity_counter++;
355 yaz_mutex_leave(http_sessions->mutex);
357 iochan_activity(p->timeout_iochan);
359 error(rs, PAZPAR2_NO_SESSION, session);
363 // Call after use of locate_session, in order to increment the destroy_counter
364 static void release_session(struct http_channel *c,
365 struct http_session *session)
367 http_sessions_t http_sessions = c->http_sessions;
368 yaz_mutex_enter(http_sessions->mutex);
370 session->destroy_counter++;
371 yaz_mutex_leave(http_sessions->mutex);
374 // Decode settings parameters and apply to session
375 // Syntax: setting[target]=value
376 static int process_settings(struct session *se, struct http_request *rq,
377 struct http_response *rs)
379 struct http_argument *a;
381 for (a = rq->arguments; a; a = a->next)
382 if (strchr(a->name, '['))
389 // Nmem_strsplit *rules*!!!
390 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
393 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
398 session_apply_setting(se, dbname, setting,
399 nmem_strdup(se->session_nmem, a->value));
404 static void cmd_exit(struct http_channel *c)
406 yaz_log(YLOG_WARN, "exit");
408 response_open(c, "exit");
409 response_close(c, "exit");
410 if (global_parameters.debug_mode)
411 http_close_server(c->server);
414 static void cmd_init(struct http_channel *c)
416 struct http_request *r = c->request;
417 const char *clear = http_argbyname(r, "clear");
418 const char *content_type = http_lookup_header(r->headers, "Content-Type");
420 struct http_session *s;
421 struct http_response *rs = c->response;
422 struct conf_service *service = 0; /* no service (yet) */
424 if (r->content_len && content_type &&
425 !yaz_strcmp_del("text/xml", content_type, "; "))
427 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
431 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
434 root_n = xmlDocGetRootElement(doc);
435 service = service_create(c->server, root_n);
439 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
446 const char *service_name = http_argbyname(c->request, "service");
447 service = locate_service(c->server, service_name);
450 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
454 sesid = make_sessionid();
455 s = http_session_create(service, c->http_sessions, sesid);
457 yaz_log(c->http_sessions->log_level, "Session init %u ", sesid);
458 if (!clear || *clear == '0')
459 session_init_databases(s->psession);
461 yaz_log(YLOG_LOG, "Session %u init: No databases preloaded", sesid);
463 if (process_settings(s->psession, c->request, c->response) < 0)
466 response_open(c, "init");
467 wrbuf_printf(c->wrbuf, "<session>%d", sesid);
468 if (c->server->server_id)
470 wrbuf_puts(c->wrbuf, ".");
471 wrbuf_puts(c->wrbuf, c->server->server_id);
473 wrbuf_puts(c->wrbuf, "</session>"
474 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol>");
476 wrbuf_printf(c->wrbuf, "<keepAlive>%d</keepAlive>\n", 1000 * ((s->psession->service->session_timeout >= 20) ?
477 (s->psession->service->session_timeout - 10) : 50));
478 response_close(c, "init");
481 static void apply_local_setting(void *client_data,
484 struct session *se = (struct session *) client_data;
486 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
487 nmem_strdup(se->session_nmem, set->name),
488 nmem_strdup(se->session_nmem, set->value));
491 static void cmd_settings(struct http_channel *c)
493 struct http_response *rs = c->response;
494 struct http_request *rq = c->request;
495 struct http_session *s = locate_session(c);
496 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
501 if (rq->content_len && content_type &&
502 !yaz_strcmp_del("text/xml", content_type, "; "))
504 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
509 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
510 release_session(c,s);
513 root_n = xmlDocGetRootElement(doc);
514 ret = settings_read_node_x(root_n, s->psession, apply_local_setting);
518 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
519 release_session(c,s);
523 if (process_settings(s->psession, rq, rs) < 0)
525 release_session(c, s);
528 response_open(c, "settings");
529 response_close(c, "settings");
530 release_session(c, s);
533 static void termlist_response(struct http_channel *c, struct http_session *s, const char *cmd_status)
535 struct http_request *rq = c->request;
536 const char *name = http_argbyname(rq, "name");
537 const char *nums = http_argbyname(rq, "num");
538 int version = get_version(rq);
545 status = session_active_clients(s->psession);
547 response_open_no_status(c, "termlist");
548 /* new protocol add a status to response. Triggered by a status parameter */
549 if (cmd_status != 0) {
550 wrbuf_printf(c->wrbuf, "<status>%s</status>\n", cmd_status);
552 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
554 perform_termlist(c, s->psession, name, num, version);
556 response_close(c, "termlist");
559 static void termlist_result_ready(void *data)
561 struct http_channel *c = (struct http_channel *) data;
562 struct http_request *rq = c->request;
563 const char *report = http_argbyname(rq, "report");
564 const char *status = 0;
565 struct http_session *s = locate_session(c);
566 if (report && !strcmp("status", report))
569 yaz_log(c->http_sessions->log_level, "Session %u termlist watch released", s->session_id);
570 termlist_response(c, s, status);
571 release_session(c,s);
575 static void cmd_termlist(struct http_channel *c)
577 struct http_request *rq = c->request;
578 struct http_response *rs = c->response;
579 struct http_session *s = locate_session(c);
580 const char *block = http_argbyname(rq, "block");
581 const char *report = http_argbyname(rq, "report");
582 int report_status = 0;
583 int report_error = 0;
584 const char *status_message = 0;
586 if (report && !strcmp("error", report)) {
588 status_message = "OK";
590 if (report && !strcmp("status", report)) {
592 status_message = "OK";
597 active_clients = session_active_clients(s->psession);
598 if (block && !strcmp("1", block) && active_clients)
600 // if there is already a watch/block. we do not block this one
601 if (session_set_watch(s->psession, SESSION_WATCH_TERMLIST,
602 termlist_result_ready, c, c) != 0)
604 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on termlist block. Not supported!", s->session_id);
606 error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
607 release_session(c, s);
610 else if (report_status) {
611 status_message = "WARNING (Already blocked on termlist)";
614 yaz_log(YLOG_WARN, "Session %u: Ignoring termlist block. Return current result", s->session_id);
619 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command termlist", s->session_id);
620 release_session(c, s);
625 termlist_response(c, s, status_message);
626 release_session(c, s);
629 size_t session_get_memory_status(struct session *session);
631 static void session_status(struct http_channel *c, struct http_session *s)
634 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
635 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
636 session_nmem = session_get_memory_status(s->psession);
637 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
640 static void cmd_session_status(struct http_channel *c)
642 struct http_session *s = locate_session(c);
646 response_open(c, "session-status");
647 session_status(c, s);
648 response_close(c, "session-status");
649 release_session(c, s);
652 int sessions_count(void);
653 int clients_count(void);
654 #ifdef HAVE_RESULTSETS_COUNT
655 int resultsets_count(void);
657 #define resultsets_count() 0
660 static void cmd_server_status(struct http_channel *c)
662 int sessions = sessions_count();
663 int clients = clients_count();
664 int resultsets = resultsets_count();
666 response_open(c, "server-status");
667 wrbuf_printf(c->wrbuf, "\n <sessions>%u</sessions>\n", sessions);
668 wrbuf_printf(c->wrbuf, " <clients>%u</clients>\n", clients);
669 /* Only works if yaz has been compiled with enabling of this */
670 wrbuf_printf(c->wrbuf, " <resultsets>%u</resultsets>\n",resultsets);
671 print_meminfo(c->wrbuf);
673 /* TODO add all sessions status */
674 /* http_sessions_t http_sessions = c->http_sessions; */
675 /* struct http_session *p; */
677 yaz_mutex_enter(http_sessions->mutex);
678 for (p = http_sessions->session_list; p; p = p->next)
680 p->activity_counter++;
681 wrbuf_puts(c->wrbuf, "<session-status>\n");
682 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
683 yaz_mutex_leave(http_sessions->mutex);
684 session_status(c, p);
685 wrbuf_puts(c->wrbuf, "</session-status>\n");
686 yaz_mutex_enter(http_sessions->mutex);
687 p->activity_counter--;
689 yaz_mutex_leave(http_sessions->mutex);
691 response_close(c, "server-status");
695 static void bytarget_response(struct http_channel *c, struct http_session *s, const char *cmd_status) {
697 struct hitsbytarget *ht;
698 struct http_request *rq = c->request;
699 const char *settings = http_argbyname(rq, "settings");
700 int version = get_version(rq);
701 ht = get_hitsbytarget(s->psession, &count, c->nmem);
703 /* Old protocol, always ok */
704 response_open(c, "bytarget");
706 /* New protocol, OK or WARNING (...)*/
707 response_open_no_status(c, "bytarget");
708 wrbuf_printf(c->wrbuf, "<status>%s</status>", cmd_status);
712 yaz_log(YLOG_WARN, "Empty bytarget Response. No targets found!");
713 for (i = 0; i < count; i++)
715 wrbuf_puts(c->wrbuf, "\n<target>");
717 wrbuf_puts(c->wrbuf, "<id>");
718 wrbuf_xmlputs(c->wrbuf, ht[i].id);
719 wrbuf_puts(c->wrbuf, "</id>\n");
721 if (ht[i].name && ht[i].name[0])
723 wrbuf_puts(c->wrbuf, "<name>");
724 wrbuf_xmlputs(c->wrbuf, ht[i].name);
725 wrbuf_puts(c->wrbuf, "</name>\n");
728 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
729 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
730 if (ht[i].diagnostic)
732 wrbuf_puts(c->wrbuf, "<message>");
733 wrbuf_xmlputs(c->wrbuf, ht[i].message);
734 wrbuf_puts(c->wrbuf, "</message>\n");
735 wrbuf_puts(c->wrbuf, "<addinfo>");
737 wrbuf_xmlputs(c->wrbuf, ht[i].addinfo);
738 wrbuf_puts(c->wrbuf, "</addinfo>\n");
741 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
743 wrbuf_printf(c->wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
744 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
746 wrbuf_puts(c->wrbuf, "<state>");
747 wrbuf_xmlputs(c->wrbuf, ht[i].state);
748 wrbuf_puts(c->wrbuf, "</state>\n");
749 if (settings && *settings == '1')
751 wrbuf_puts(c->wrbuf, "<settings>\n");
752 wrbuf_puts(c->wrbuf, ht[i].settings_xml);
753 wrbuf_puts(c->wrbuf, "</settings>\n");
755 if (ht[i].suggestions_xml && ht[i].suggestions_xml[0]) {
756 wrbuf_puts(c->wrbuf, "<suggestions>");
757 wrbuf_puts(c->wrbuf, ht[i].suggestions_xml);
758 wrbuf_puts(c->wrbuf, "</suggestions>");
760 wrbuf_puts(c->wrbuf, "</target>");
762 response_close(c, "bytarget");
765 static void bytarget_result_ready(void *data)
767 struct http_channel *c = (struct http_channel *) data;
768 struct http_session *s = locate_session(c);
769 const char *status_message = "OK";
771 yaz_log(c->http_sessions->log_level, "Session %u: bytarget watch released", s->session_id);
772 bytarget_response(c, s, status_message);
773 release_session(c, s);
776 yaz_log(c->http_sessions->log_level, "No Session found for released bytarget watch");
781 static void cmd_bytarget(struct http_channel *c)
783 struct http_request *rq = c->request;
784 struct http_response *rs = c->response;
785 struct http_session *s = locate_session(c);
786 const char *block = http_argbyname(rq, "block");
787 const char *report = http_argbyname(rq, "report");
788 int report_error = 0;
789 int report_status = 0;
790 const char *status_message = "OK";
793 if (report && !strcmp("error", report)) {
796 if (report && !strcmp("status", report)) {
803 no_active = session_active_clients(s->psession);
804 if (block && !strcmp("1",block) && no_active)
806 // if there is already a watch/block. we do not block this one
807 if (session_set_watch(s->psession, SESSION_WATCH_BYTARGET,
808 bytarget_result_ready, c, c) != 0)
810 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on bytarget block. Not supported!", s->session_id);
812 error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget");
813 release_session(c, s);
816 else if (report_status) {
817 status_message = "WARNING (Already blocked on bytarget)";
820 yaz_log(YLOG_WARN, "Session %u: Ignoring bytarget block. Return current result.", s->session_id);
825 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command bytarget", s->session_id);
826 release_session(c, s);
830 bytarget_response(c, s, status_message);
831 release_session(c, s);
834 static void write_metadata(WRBUF w, struct conf_service *service,
835 struct record_metadata **ml, int full, int indent)
839 for (imeta = 0; imeta < service->num_metadata; imeta++)
841 struct conf_metadata *cmd = &service->metadata[imeta];
842 struct record_metadata *md;
843 if (!cmd->brief && !full)
845 for (md = ml[imeta]; md; md = md->next)
847 struct record_metadata_attr *attr = md->attributes;
849 for (i = 0; i < indent; i++)
851 wrbuf_printf(w, "<md-%s", cmd->name);
853 for (; attr; attr = attr->next)
855 wrbuf_printf(w, " %s=\"", attr->name);
856 wrbuf_xmlputs(w, attr->value);
862 case Metadata_type_generic:
863 wrbuf_xmlputs(w, md->data.text.disp);
865 case Metadata_type_year:
866 wrbuf_printf(w, "%d", md->data.number.min);
867 if (md->data.number.min != md->data.number.max)
868 wrbuf_printf(w, "-%d", md->data.number.max);
871 wrbuf_puts(w, "[can't represent]");
874 wrbuf_printf(w, "</md-%s>\n", cmd->name);
879 static void write_subrecord(struct record *r, WRBUF w,
880 struct conf_service *service, int show_details)
882 const char *name = session_setting_oneval(
883 client_get_database(r->client), PZ_NAME);
885 wrbuf_puts(w, " <location id=\"");
886 wrbuf_xmlputs(w, client_get_id(r->client));
887 wrbuf_puts(w, "\"\n");
889 wrbuf_puts(w, " name=\"");
890 wrbuf_xmlputs(w, *name ? name : "Unknown");
891 wrbuf_puts(w, "\" ");
893 wrbuf_puts(w, "checksum=\"");
894 wrbuf_printf(w, "%u", r->checksum);
895 wrbuf_puts(w, "\">\n");
897 write_metadata(w, service, r->metadata, show_details, 2);
898 wrbuf_puts(w, " </location>\n");
901 static void show_raw_record_error(void *data, const char *addinfo)
903 http_channel_observer_t obs = data;
904 struct http_channel *c = http_channel_observer_chan(obs);
905 struct http_response *rs = c->response;
907 http_remove_observer(obs);
909 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
912 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
914 http_channel_observer_t obs = data;
915 struct http_channel *c = http_channel_observer_chan(obs);
916 struct http_response *rs = c->response;
918 http_remove_observer(obs);
920 wrbuf_write(c->wrbuf, buf, sz);
921 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
922 http_send_response(c);
926 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
928 http_channel_observer_t obs = data;
929 struct http_channel *c = http_channel_observer_chan(obs);
930 struct http_response *rs = c->response;
932 http_remove_observer(obs);
934 wrbuf_write(c->wrbuf, buf, sz);
935 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
937 rs->content_type = "application/octet-stream";
938 http_send_response(c);
942 void show_raw_reset(void *data, struct http_channel *c, void *data2)
944 //struct client *client = data;
945 //client_show_raw_remove(client, data2);
948 static void cmd_record_ready(void *data);
950 static void show_record(struct http_channel *c, struct http_session *s)
952 struct http_response *rs = c->response;
953 struct http_request *rq = c->request;
954 struct record_cluster *rec, *prev_r, *next_r;
955 struct conf_service *service;
956 const char *idstr = http_argbyname(rq, "id");
957 const char *offsetstr = http_argbyname(rq, "offset");
958 const char *binarystr = http_argbyname(rq, "binary");
959 const char *checksumstr = http_argbyname(rq, "checksum");
963 service = s->psession->service;
966 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
969 wrbuf_rewind(c->wrbuf);
970 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
972 if (session_active_clients(s->psession) == 0)
974 error(rs, PAZPAR2_RECORD_MISSING, idstr);
976 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
977 cmd_record_ready, c, c) != 0)
979 error(rs, PAZPAR2_RECORD_MISSING, idstr);
983 if (offsetstr || checksumstr)
985 const char *syntax = http_argbyname(rq, "syntax");
986 const char *esn = http_argbyname(rq, "esn");
988 struct record*r = rec->records;
990 const char *nativesyntax = http_argbyname(rq, "nativesyntax");
992 if (binarystr && *binarystr != '0')
997 long v = atol(checksumstr);
998 for (i = 0; r; r = r->next)
999 if (v == r->checksum)
1002 error(rs, PAZPAR2_RECORD_FAIL, "no record");
1006 int offset = atoi(offsetstr);
1007 for (i = 0; i < offset && r; r = r->next, i++)
1010 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
1014 http_channel_observer_t obs =
1015 http_add_observer(c, r->client, show_raw_reset);
1016 int ret = client_show_raw_begin(r->client, r->position,
1019 show_raw_record_error,
1021 show_raw_record_ok_binary :
1022 show_raw_record_ok),
1027 http_remove_observer(obs);
1028 error(rs, PAZPAR2_NO_SESSION, 0);
1035 response_open_no_status(c, "record");
1036 wrbuf_puts(c->wrbuf, "\n <recid>");
1037 wrbuf_xmlputs(c->wrbuf, rec->recid);
1038 wrbuf_puts(c->wrbuf, "</recid>\n");
1041 wrbuf_puts(c->wrbuf, " <prevrecid>");
1042 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
1043 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
1047 wrbuf_puts(c->wrbuf, " <nextrecid>");
1048 wrbuf_xmlputs(c->wrbuf, next_r->recid);
1049 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
1051 wrbuf_printf(c->wrbuf, " <activeclients>%d</activeclients>\n",
1052 session_active_clients(s->psession));
1053 write_metadata(c->wrbuf, service, rec->metadata, 1, 1);
1054 for (r = rec->records; r; r = r->next)
1055 write_subrecord(r, c->wrbuf, service, 2);
1056 response_close(c, "record");
1058 show_single_stop(s->psession, rec);
1061 static void cmd_record_ready(void *data)
1063 struct http_channel *c = (struct http_channel *) data;
1064 struct http_session *s = locate_session(c);
1066 yaz_log(c->http_sessions->log_level, "Session %u: record watch released", s->session_id);
1068 release_session(c,s);
1072 static void cmd_record(struct http_channel *c)
1074 struct http_session *s = locate_session(c);
1077 release_session(c,s);
1082 static void show_records(struct http_channel *c, struct http_session *s, int active)
1084 struct http_request *rq = c->request;
1085 struct http_response *rs = c->response;
1086 struct record_cluster **rl;
1087 struct reclist_sortparms *sp;
1088 const char *start = http_argbyname(rq, "start");
1089 const char *num = http_argbyname(rq, "num");
1090 const char *sort = http_argbyname(rq, "sort");
1091 int version = get_version(rq);
1097 Odr_int approx_hits;
1099 struct conf_service *service = 0;
1103 // We haven't counted clients yet if we're called on a block release
1105 active = session_active_clients(s->psession);
1108 startn = atoi(start);
1112 service = s->psession->service;
1114 sort = service->default_sort;
1116 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1118 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1124 rl = show_range_start(s->psession, sp, startn, &numn, &total,
1125 &total_hits, &approx_hits);
1128 show_range_stop(s->psession, rl);
1129 session_log(s->psession, YLOG_LOG,
1130 "Subset %d < %d retrieved for show", numn, i);
1131 if (!session_fetch_more(s->psession))
1132 session_log(s->psession, YLOG_LOG, "can not fetch more");
1135 session_log(s->psession, YLOG_LOG, "fetching more in progress");
1136 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1137 show_records_ready, c, c))
1138 session_log(s->psession, YLOG_WARN, "Ignoring show block");
1141 session_log(s->psession, YLOG_LOG, "session watch OK");
1145 rl = show_range_start(s->psession, sp, startn, &numn, &total,
1146 &total_hits, &approx_hits);
1149 response_open(c, "show");
1150 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
1151 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
1152 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
1154 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", approx_hits);
1156 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
1157 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
1159 for (i = 0; i < numn; i++)
1163 struct record_cluster *rec = rl[i];
1164 struct conf_service *service = s->psession->service;
1166 wrbuf_puts(c->wrbuf, "<hit>\n");
1167 write_metadata(c->wrbuf, service, rec->metadata, 0, 1);
1168 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
1169 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
1170 wrbuf_printf(c->wrbuf, " <count>%d</count>\n", ccount);
1171 if (strstr(sort, "relevance"))
1173 wrbuf_printf(c->wrbuf, " <relevance>%d</relevance>\n",
1174 rec->relevance_score);
1175 if (service->rank_debug)
1177 wrbuf_printf(c->wrbuf, " <relevance_info>\n");
1178 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain1));
1179 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain2));
1180 wrbuf_printf(c->wrbuf, " </relevance_info>\n");
1183 wrbuf_puts(c->wrbuf, " <recid>");
1184 wrbuf_xmlputs(c->wrbuf, rec->recid);
1185 wrbuf_puts(c->wrbuf, "</recid>\n");
1186 wrbuf_puts(c->wrbuf, "</hit>\n");
1189 show_range_stop(s->psession, rl);
1191 response_close(c, "show");
1194 static void show_records_ready(void *data)
1196 struct http_channel *c = (struct http_channel *) data;
1197 struct http_session *s = locate_session(c);
1199 yaz_log(c->http_sessions->log_level, "Session %u: show watch released", s->session_id);
1200 show_records(c, s, -1);
1203 /* some error message */
1205 release_session(c,s);
1208 static void cmd_show(struct http_channel *c)
1210 struct http_request *rq = c->request;
1211 struct http_response *rs = c->response;
1212 struct http_session *s = locate_session(c);
1213 const char *block = http_argbyname(rq, "block");
1214 const char *sort = http_argbyname(rq, "sort");
1215 const char *block_error = http_argbyname(rq, "report");
1216 struct conf_service *service = 0;
1218 struct reclist_sortparms *sp;
1220 int report_error = 0;
1221 if (block_error && !strcmp("1", block_error)) {
1227 service = s->psession->service;
1229 sort = service->default_sort;
1232 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1234 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1235 release_session(c, s);
1238 session_sort(s->psession, sp);
1240 status = session_active_clients(s->psession);
1244 if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0)
1246 // if there is already a watch/block. we do not block this one
1247 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1248 show_records_ready, c, c) == 0)
1250 yaz_log(c->http_sessions->log_level,
1251 "Session %u: Blocking on command show (preferred targets)", s->session_id);
1252 release_session(c, s);
1257 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on show (preferred targets) block. Not supported!",
1260 error(rs, PAZPAR2_ALREADY_BLOCKED, "show (preferred targets)");
1261 release_session(c, s);
1265 yaz_log(YLOG_WARN, "Session %u: Ignoring show(preferred) block. Returning current result.", s->session_id);
1272 // if there is already a watch/block. we do not block this one
1273 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1274 show_records_ready, c, c) != 0)
1276 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on show block. Not supported!", s->session_id);
1278 error(rs, PAZPAR2_ALREADY_BLOCKED, "show");
1279 release_session(c, s);
1283 yaz_log(YLOG_WARN, "Session %u: Ignoring show block. Returning current result.", s->session_id);
1288 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command show", s->session_id);
1289 release_session(c, s);
1294 show_records(c, s, status);
1295 release_session(c, s);
1298 static void cmd_ping(struct http_channel *c)
1300 struct http_session *s = locate_session(c);
1303 response_open(c, "ping");
1304 response_close(c, "ping");
1305 release_session(c, s);
1308 static void cmd_search(struct http_channel *c)
1310 struct http_request *rq = c->request;
1311 struct http_response *rs = c->response;
1312 struct http_session *s = locate_session(c);
1313 const char *query = http_argbyname(rq, "query");
1314 const char *filter = http_argbyname(rq, "filter");
1315 const char *maxrecs = http_argbyname(rq, "maxrecs");
1316 const char *startrecs = http_argbyname(rq, "startrecs");
1317 const char *limit = http_argbyname(rq, "limit");
1318 const char *sort = http_argbyname(rq, "sort");
1319 enum pazpar2_error_code code;
1320 const char *addinfo = 0;
1321 struct reclist_sortparms *sp;
1322 struct conf_service *service = 0;
1329 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1330 release_session(c, s);
1333 if (!yaz_utf8_check(query))
1335 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1336 release_session(c, s);
1339 service = s->psession->service;
1341 sort = service->default_sort;
1343 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1345 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1346 release_session(c, s);
1350 code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
1354 error(rs, code, addinfo);
1355 release_session(c, s);
1358 response_open(c, "search");
1359 response_close(c, "search");
1360 release_session(c, s);
1364 static void cmd_stat(struct http_channel *c)
1366 struct http_session *s = locate_session(c);
1367 struct statistics stat;
1375 clients = session_active_clients(s->psession);
1376 statistics(s->psession, &stat);
1378 if (stat.num_clients > 0)
1380 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1383 response_open_no_status(c, "stat");
1384 wrbuf_printf(c->wrbuf, "\n <activeclients>%d</activeclients>\n", clients);
1385 wrbuf_printf(c->wrbuf, " <hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1386 wrbuf_printf(c->wrbuf, " <records>%d</records>\n", stat.num_records);
1387 wrbuf_printf(c->wrbuf, " <clients>%d</clients>\n", stat.num_clients);
1388 wrbuf_printf(c->wrbuf, " <unconnected>%d</unconnected>\n", stat.num_no_connection);
1389 wrbuf_printf(c->wrbuf, " <connecting>%d</connecting>\n", stat.num_connecting);
1390 wrbuf_printf(c->wrbuf, " <working>%d</working>\n", stat.num_working);
1391 wrbuf_printf(c->wrbuf, " <idle>%d</idle>\n", stat.num_idle);
1392 wrbuf_printf(c->wrbuf, " <failed>%d</failed>\n", stat.num_failed);
1393 wrbuf_printf(c->wrbuf, " <error>%d</error>\n", stat.num_error);
1394 wrbuf_printf(c->wrbuf, " <progress>%.2f</progress>\n", progress);
1395 response_close(c, "stat");
1396 release_session(c, s);
1399 static void cmd_info(struct http_channel *c)
1401 char yaz_version_str[20];
1402 char yaz_sha1_str[42];
1404 response_open_no_status(c, "info");
1405 wrbuf_puts(c->wrbuf, "\n <version>\n");
1406 wrbuf_puts(c->wrbuf, " <pazpar2");
1407 #ifdef PAZPAR2_VERSION_SHA1
1408 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1410 wrbuf_puts(c->wrbuf, ">");
1411 wrbuf_xmlputs(c->wrbuf, VERSION);
1412 wrbuf_puts(c->wrbuf, "</pazpar2>\n");
1414 yaz_version(yaz_version_str, yaz_sha1_str);
1415 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1416 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1417 wrbuf_puts(c->wrbuf, "\" sha1=\"");
1418 wrbuf_xmlputs(c->wrbuf, yaz_sha1_str);
1419 wrbuf_puts(c->wrbuf, "\">");
1420 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1421 wrbuf_puts(c->wrbuf, "</yaz>\n");
1423 wrbuf_puts(c->wrbuf, " </version>\n");
1426 char hostname_str[64];
1427 if (gethostname(hostname_str, sizeof(hostname_str)) == 0)
1429 wrbuf_puts(c->wrbuf, " <host>");
1430 wrbuf_xmlputs(c->wrbuf, hostname_str);
1431 wrbuf_puts(c->wrbuf, "</host>\n");
1435 info_services(c->server, c->wrbuf);
1437 response_close(c, "info");
1442 void (*fun)(struct http_channel *c);
1444 { "init", cmd_init },
1445 { "settings", cmd_settings },
1446 { "stat", cmd_stat },
1447 { "bytarget", cmd_bytarget },
1448 { "show", cmd_show },
1449 { "search", cmd_search },
1450 { "termlist", cmd_termlist },
1451 { "exit", cmd_exit },
1452 { "session-status", cmd_session_status },
1453 { "server-status", cmd_server_status },
1454 { "ping", cmd_ping },
1455 { "record", cmd_record },
1456 { "info", cmd_info },
1460 void http_command(struct http_channel *c)
1462 const char *command = http_argbyname(c->request, "command");
1463 struct http_response *rs = http_create_response(c);
1468 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1469 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1473 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1476 for (i = 0; commands[i].name; i++)
1477 if (!strcmp(commands[i].name, command))
1479 (*commands[i].fun)(c);
1482 if (!commands[i].name)
1483 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1491 * c-file-style: "Stroustrup"
1492 * indent-tabs-mode: nil
1494 * vim: shiftwidth=4 tabstop=8 expandtab