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,
180 "http_session_timeout");
181 iochan_setdata(r->timeout_iochan, r);
183 session_log(r->psession, http_sessions->log_level,
184 "HTTP session create. timeout chan=%p ses=%d",
185 r->timeout_iochan, service->session_timeout);
186 iochan_settimeout(r->timeout_iochan, service->session_timeout);
188 iochan_add(service->server->iochan_man, r->timeout_iochan);
193 void http_session_destroy(struct http_session *s)
195 int must_destroy = 0;
197 http_sessions_t http_sessions = s->http_sessions;
199 session_log(s->psession, http_sessions->log_level,
200 "HTTP session destroy");
201 yaz_mutex_enter(http_sessions->mutex);
202 /* only if http_session has no active http sessions on it can be destroyed */
203 if (s->destroy_counter == s->activity_counter)
205 struct http_session **p = 0;
207 for (p = &http_sessions->session_list; *p; p = &(*p)->next)
214 yaz_mutex_leave(http_sessions->mutex);
216 { /* destroying for real */
217 session_log(s->psession, http_sessions->log_level, "About to destroyd");
218 iochan_destroy(s->timeout_iochan);
219 session_destroy(s->psession);
220 http_session_use(-1);
221 nmem_destroy(s->nmem);
225 session_log(s->psession, http_sessions->log_level,
226 "Destroy delayed. Active clients (%d-%d)",
227 s->activity_counter, s->destroy_counter);
232 static const char *get_msg(enum pazpar2_error_code code)
234 struct pazpar2_error_msg {
235 enum pazpar2_error_code code;
238 static const struct pazpar2_error_msg ar[] = {
239 { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
240 { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
241 { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
242 { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
243 { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
244 { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
245 { PAZPAR2_RECORD_MISSING, "Record missing"},
246 { PAZPAR2_NO_TARGETS, "No targets"},
247 { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
248 { PAZPAR2_RECORD_FAIL, "Record command failed"},
249 { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
250 { PAZPAR2_NO_SERVICE, "No service"},
251 { PAZPAR2_ALREADY_BLOCKED, "Already blocked in session on: "},
252 { PAZPAR2_LAST_ERROR, "Last error"},
258 if (code == ar[i].code)
265 static void error(struct http_response *rs,
266 enum pazpar2_error_code code,
269 struct http_channel *c = rs->channel;
270 WRBUF text = wrbuf_alloc();
271 const char *http_status = "417";
272 const char *msg = get_msg(code);
274 rs->msg = nmem_strdup(c->nmem, msg);
275 strcpy(rs->code, http_status);
277 wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX "<error code=\"%d\" msg=\"%s\">", (int) code,
280 wrbuf_xmlputs(text, addinfo);
281 wrbuf_puts(text, "</error>");
283 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
284 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
285 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
287 http_send_response(c);
290 static void response_open_command(struct http_channel *c, const char *command)
292 wrbuf_rewind(c->wrbuf);
293 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX);
295 wrbuf_printf(c->wrbuf, "<%s>", command);
298 static void response_open_ok(struct http_channel *c, const char *command)
300 response_open_command(c, command);
301 wrbuf_puts(c->wrbuf, "<status>OK</status>");
304 static void response_close(struct http_channel *c, const char *command)
306 struct http_response *rs = c->response;
309 wrbuf_printf(c->wrbuf, "</%s>", command);
310 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
311 http_send_response(c);
314 unsigned int make_sessionid(void)
316 static int seq = 0; /* thread pr */
320 if (global_parameters.predictable_sessions)
329 if (gettimeofday(&t, 0) < 0)
331 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
334 /* at most 256 sessions per second ..
335 (long long would be more appropriate)*/
337 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
343 static struct http_session *locate_session(struct http_channel *c)
345 struct http_request *rq = c->request;
346 struct http_response *rs = c->response;
347 struct http_session *p;
348 const char *session = http_argbyname(rq, "session");
349 http_sessions_t http_sessions = c->http_sessions;
354 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
358 yaz_mutex_enter(http_sessions->mutex);
359 for (p = http_sessions->session_list; p; p = p->next)
360 if (id == p->session_id)
363 p->activity_counter++;
364 yaz_mutex_leave(http_sessions->mutex);
366 iochan_activity(p->timeout_iochan);
368 error(rs, PAZPAR2_NO_SESSION, session);
372 // Call after use of locate_session, in order to increment the destroy_counter
373 static void release_session(struct http_channel *c,
374 struct http_session *session)
376 http_sessions_t http_sessions = c->http_sessions;
377 yaz_mutex_enter(http_sessions->mutex);
379 session->destroy_counter++;
380 yaz_mutex_leave(http_sessions->mutex);
383 // Decode settings parameters and apply to session
384 // Syntax: setting[target]=value
385 static int process_settings(struct session *se, struct http_request *rq,
386 struct http_response *rs)
388 struct http_argument *a;
390 for (a = rq->arguments; a; a = a->next)
391 if (strchr(a->name, '['))
398 // Nmem_strsplit *rules*!!!
399 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
402 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
407 session_apply_setting(se, dbname, setting,
408 nmem_strdup(se->session_nmem, a->value));
413 static void cmd_exit(struct http_channel *c)
415 yaz_log(YLOG_WARN, "exit");
417 response_open_ok(c, "exit");
418 response_close(c, "exit");
419 if (global_parameters.debug_mode)
420 http_close_server(c->server);
423 static void cmd_init(struct http_channel *c)
425 struct http_request *r = c->request;
426 const char *clear = http_argbyname(r, "clear");
427 const char *content_type = http_lookup_header(r->headers, "Content-Type");
429 struct http_session *s;
430 struct http_response *rs = c->response;
431 struct conf_service *service = 0; /* no service (yet) */
433 if (r->content_len && content_type &&
434 !yaz_strcmp_del("text/xml", content_type, "; "))
436 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
440 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
443 root_n = xmlDocGetRootElement(doc);
444 service = service_create(c->server, root_n);
448 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
455 const char *service_name = http_argbyname(c->request, "service");
456 service = locate_service(c->server, service_name);
459 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
463 sesid = make_sessionid();
464 s = http_session_create(service, c->http_sessions, sesid);
466 if (!clear || *clear == '0')
467 session_init_databases(s->psession);
469 session_log(s->psession, YLOG_LOG, "No databases preloaded");
471 if (process_settings(s->psession, c->request, c->response) < 0)
474 response_open_ok(c, "init");
475 wrbuf_printf(c->wrbuf, "<session>%d", sesid);
476 if (c->server->server_id)
478 wrbuf_puts(c->wrbuf, ".");
479 wrbuf_puts(c->wrbuf, c->server->server_id);
481 wrbuf_puts(c->wrbuf, "</session>"
482 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol>");
484 wrbuf_printf(c->wrbuf, "<keepAlive>%d</keepAlive>\n", 1000 * ((s->psession->service->session_timeout >= 20) ?
485 (s->psession->service->session_timeout - 10) : 50));
486 response_close(c, "init");
489 static void apply_local_setting(void *client_data,
492 struct session *se = (struct session *) client_data;
494 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
495 nmem_strdup(se->session_nmem, set->name),
496 nmem_strdup(se->session_nmem, set->value));
499 static void cmd_settings(struct http_channel *c)
501 struct http_response *rs = c->response;
502 struct http_request *rq = c->request;
503 struct http_session *s = locate_session(c);
504 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
509 if (rq->content_len && content_type &&
510 !yaz_strcmp_del("text/xml", content_type, "; "))
512 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
517 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
518 release_session(c,s);
521 root_n = xmlDocGetRootElement(doc);
522 ret = settings_read_node_x(root_n, s->psession, apply_local_setting);
526 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
527 release_session(c,s);
531 if (process_settings(s->psession, rq, rs) < 0)
533 release_session(c, s);
536 response_open_ok(c, "settings");
537 response_close(c, "settings");
538 release_session(c, s);
541 static void termlist_response(struct http_channel *c, struct http_session *s, const char *cmd_status)
543 struct http_request *rq = c->request;
544 const char *name = http_argbyname(rq, "name");
545 const char *nums = http_argbyname(rq, "num");
546 int version = get_version(rq);
553 status = session_active_clients(s->psession);
555 response_open_command(c, "termlist");
556 /* new protocol add a status to response. Triggered by a status parameter */
558 wrbuf_printf(c->wrbuf, "<status>%s</status>\n", cmd_status);
559 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
561 perform_termlist(c, s->psession, name, num, version);
563 response_close(c, "termlist");
566 static void termlist_result_ready(void *data)
568 struct http_channel *c = (struct http_channel *) data;
569 struct http_request *rq = c->request;
570 const char *report = http_argbyname(rq, "report");
571 const char *status = 0;
572 struct http_session *s = locate_session(c);
573 if (report && !strcmp("status", report))
577 session_log(s->psession, c->http_sessions->log_level,
578 "termlist watch released");
579 termlist_response(c, s, status);
580 release_session(c,s);
584 static void cmd_termlist(struct http_channel *c)
586 struct http_request *rq = c->request;
587 struct http_response *rs = c->response;
588 struct http_session *s = locate_session(c);
589 const char *block = http_argbyname(rq, "block");
590 const char *report = http_argbyname(rq, "report");
591 int report_status = 0;
592 int report_error = 0;
593 const char *status_message = 0;
596 if (report && !strcmp("error", report))
599 status_message = "OK";
601 if (report && !strcmp("status", report))
604 status_message = "OK";
609 active_clients = session_active_clients(s->psession);
610 if (block && !strcmp("1", block) && active_clients)
612 // if there is already a watch/block. we do not block this one
613 if (session_set_watch(s->psession, SESSION_WATCH_TERMLIST,
614 termlist_result_ready, c, c) != 0)
616 session_log(s->psession, YLOG_WARN, "Attempt to block "
617 "multiple times on termlist block. Not supported!");
619 error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
620 release_session(c, s);
623 else if (report_status)
624 status_message = "WARNING (Already blocked on termlist)";
626 session_log(s->psession, YLOG_WARN,
627 "Ignoring termlist block. Return current result");
631 session_log(s->psession, c->http_sessions->log_level,
632 "Blocking on command termlist");
633 release_session(c, s);
638 termlist_response(c, s, status_message);
639 release_session(c, s);
642 size_t session_get_memory_status(struct session *session);
644 static void session_status(struct http_channel *c, struct http_session *s)
647 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
648 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
649 session_nmem = session_get_memory_status(s->psession);
650 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
653 static void cmd_service(struct http_channel *c)
655 struct http_session *s = locate_session(c);
660 response_open_command(c, 0);
661 xml_node = s->psession->service->xml_node;
664 xmlNode *tmp = xmlCopyNode(xml_node, 1);
665 xmlBufferPtr buf = xmlBufferCreate();
667 xmlNodeDump(buf, tmp->doc, tmp, 0, 0);
669 wrbuf_write(c->wrbuf, (const char *) buf->content, buf->use);
674 response_close(c, 0);
675 release_session(c, s);
678 static void cmd_session_status(struct http_channel *c)
680 struct http_session *s = locate_session(c);
684 response_open_ok(c, "session-status");
685 session_status(c, s);
686 response_close(c, "session-status");
687 release_session(c, s);
690 #ifdef HAVE_RESULTSETS_COUNT
691 int resultsets_count(void);
693 #define resultsets_count() 0
696 static void cmd_server_status(struct http_channel *c)
698 int sessions = sessions_count();
699 int clients = clients_count();
700 int resultsets = resultsets_count();
702 response_open_ok(c, "server-status");
703 wrbuf_printf(c->wrbuf, "\n <sessions>%u</sessions>\n", sessions);
704 wrbuf_printf(c->wrbuf, " <clients>%u</clients>\n", clients);
705 /* Only works if yaz has been compiled with enabling of this */
706 wrbuf_printf(c->wrbuf, " <resultsets>%u</resultsets>\n",resultsets);
707 print_meminfo(c->wrbuf);
709 /* TODO add all sessions status */
710 /* http_sessions_t http_sessions = c->http_sessions; */
711 /* struct http_session *p; */
713 yaz_mutex_enter(http_sessions->mutex);
714 for (p = http_sessions->session_list; p; p = p->next)
716 p->activity_counter++;
717 wrbuf_puts(c->wrbuf, "<session-status>\n");
718 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
719 yaz_mutex_leave(http_sessions->mutex);
720 session_status(c, p);
721 wrbuf_puts(c->wrbuf, "</session-status>\n");
722 yaz_mutex_enter(http_sessions->mutex);
723 p->activity_counter--;
725 yaz_mutex_leave(http_sessions->mutex);
727 response_close(c, "server-status");
731 static void bytarget_response(struct http_channel *c, struct http_session *s, const char *cmd_status) {
733 struct hitsbytarget *ht;
734 struct http_request *rq = c->request;
735 const char *settings = http_argbyname(rq, "settings");
736 int version = get_version(rq);
737 ht = get_hitsbytarget(s->psession, &count, c->nmem);
739 /* Old protocol, always ok */
740 response_open_ok(c, "bytarget");
742 /* New protocol, OK or WARNING (...)*/
743 response_open_command(c, "bytarget");
744 wrbuf_printf(c->wrbuf, "<status>%s</status>", cmd_status);
748 session_log(s->psession, YLOG_WARN,
749 "Empty bytarget Response. No targets found!");
750 for (i = 0; i < count; i++)
752 wrbuf_puts(c->wrbuf, "\n<target>");
754 wrbuf_puts(c->wrbuf, "<id>");
755 wrbuf_xmlputs(c->wrbuf, ht[i].id);
756 wrbuf_puts(c->wrbuf, "</id>\n");
758 if (ht[i].name && ht[i].name[0])
760 wrbuf_puts(c->wrbuf, "<name>");
761 wrbuf_xmlputs(c->wrbuf, ht[i].name);
762 wrbuf_puts(c->wrbuf, "</name>\n");
765 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
766 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
767 if (ht[i].diagnostic)
769 wrbuf_puts(c->wrbuf, "<message>");
770 wrbuf_xmlputs(c->wrbuf, ht[i].message);
771 wrbuf_puts(c->wrbuf, "</message>\n");
772 wrbuf_puts(c->wrbuf, "<addinfo>");
774 wrbuf_xmlputs(c->wrbuf, ht[i].addinfo);
775 wrbuf_puts(c->wrbuf, "</addinfo>\n");
778 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
780 wrbuf_printf(c->wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
781 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
783 wrbuf_puts(c->wrbuf, "<state>");
784 wrbuf_xmlputs(c->wrbuf, ht[i].state);
785 wrbuf_puts(c->wrbuf, "</state>\n");
786 if (settings && *settings == '1')
788 wrbuf_puts(c->wrbuf, "<settings>\n");
789 wrbuf_puts(c->wrbuf, ht[i].settings_xml);
790 wrbuf_puts(c->wrbuf, "</settings>\n");
792 if (ht[i].suggestions_xml && ht[i].suggestions_xml[0]) {
793 wrbuf_puts(c->wrbuf, "<suggestions>");
794 wrbuf_puts(c->wrbuf, ht[i].suggestions_xml);
795 wrbuf_puts(c->wrbuf, "</suggestions>");
797 wrbuf_puts(c->wrbuf, "</target>");
799 response_close(c, "bytarget");
802 static void bytarget_result_ready(void *data)
804 struct http_channel *c = (struct http_channel *) data;
805 struct http_session *s = locate_session(c);
806 const char *status_message = "OK";
809 session_log(s->psession, c->http_sessions->log_level,
810 "bytarget watch released");
811 bytarget_response(c, s, status_message);
812 release_session(c, s);
815 yaz_log(c->http_sessions->log_level,
816 "No Session found for released bytarget watch");
820 static void cmd_bytarget(struct http_channel *c)
822 struct http_request *rq = c->request;
823 struct http_response *rs = c->response;
824 struct http_session *s = locate_session(c);
825 const char *block = http_argbyname(rq, "block");
826 const char *report = http_argbyname(rq, "report");
827 int report_error = 0;
828 int report_status = 0;
829 const char *status_message = "OK";
832 if (report && !strcmp("error", report))
834 if (report && !strcmp("status", report))
840 no_active = session_active_clients(s->psession);
841 if (block && !strcmp("1", block) && no_active)
843 // if there is already a watch/block. we do not block this one
844 if (session_set_watch(s->psession, SESSION_WATCH_BYTARGET,
845 bytarget_result_ready, c, c) != 0)
847 session_log(s->psession, YLOG_WARN, "Attempt to block "
848 "multiple times on bytarget block. Not supported!");
851 error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget");
852 release_session(c, s);
855 else if (report_status)
856 status_message = "WARNING (Already blocked on bytarget)";
858 session_log(s->psession, YLOG_WARN, "Ignoring bytarget block."
859 " Return current result.");
864 session_log(s->psession, c->http_sessions->log_level,
865 "Blocking on command bytarget");
866 release_session(c, s);
870 bytarget_response(c, s, status_message);
871 release_session(c, s);
874 static void write_metadata(WRBUF w, struct conf_service *service,
875 struct record_metadata **ml, int full, int indent)
879 for (imeta = 0; imeta < service->num_metadata; imeta++)
881 struct conf_metadata *cmd = &service->metadata[imeta];
882 struct record_metadata *md;
883 if (!cmd->brief && !full)
885 for (md = ml[imeta]; md; md = md->next)
887 struct record_metadata_attr *attr = md->attributes;
889 for (i = 0; i < indent; i++)
891 wrbuf_printf(w, "<md-%s", cmd->name);
893 for (; attr; attr = attr->next)
895 wrbuf_printf(w, " %s=\"", attr->name);
896 wrbuf_xmlputs(w, attr->value);
902 case Metadata_type_generic:
903 wrbuf_xmlputs(w, md->data.text.disp);
905 case Metadata_type_year:
906 wrbuf_printf(w, "%d", md->data.number.min);
907 if (md->data.number.min != md->data.number.max)
908 wrbuf_printf(w, "-%d", md->data.number.max);
911 wrbuf_puts(w, "[can't represent]");
914 wrbuf_printf(w, "</md-%s>\n", cmd->name);
919 static void write_subrecord(struct record *r, WRBUF w,
920 struct conf_service *service, int show_details)
922 const char *name = session_setting_oneval(
923 client_get_database(r->client), PZ_NAME);
925 wrbuf_puts(w, " <location id=\"");
926 wrbuf_xmlputs(w, client_get_id(r->client));
927 wrbuf_puts(w, "\"\n");
929 wrbuf_puts(w, " name=\"");
930 wrbuf_xmlputs(w, *name ? name : "Unknown");
931 wrbuf_puts(w, "\" ");
933 wrbuf_puts(w, "checksum=\"");
934 wrbuf_printf(w, "%u", r->checksum);
935 wrbuf_puts(w, "\">\n");
937 write_metadata(w, service, r->metadata, show_details, 2);
938 wrbuf_puts(w, " </location>\n");
941 static void show_raw_record_error(void *data, const char *addinfo)
943 http_channel_observer_t obs = data;
944 struct http_channel *c = http_channel_observer_chan(obs);
945 struct http_response *rs = c->response;
947 http_remove_observer(obs);
949 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
952 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
954 http_channel_observer_t obs = data;
955 struct http_channel *c = http_channel_observer_chan(obs);
956 struct http_response *rs = c->response;
958 http_remove_observer(obs);
960 wrbuf_write(c->wrbuf, buf, sz);
961 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
962 http_send_response(c);
966 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
968 http_channel_observer_t obs = data;
969 struct http_channel *c = http_channel_observer_chan(obs);
970 struct http_response *rs = c->response;
972 http_remove_observer(obs);
974 wrbuf_write(c->wrbuf, buf, sz);
975 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
977 rs->content_type = "application/octet-stream";
978 http_send_response(c);
982 void show_raw_reset(void *data, struct http_channel *c, void *data2)
984 //struct client *client = data;
985 //client_show_raw_remove(client, data2);
988 static void cmd_record_ready(void *data);
990 static void show_record(struct http_channel *c, struct http_session *s)
992 struct http_response *rs = c->response;
993 struct http_request *rq = c->request;
994 struct record_cluster *rec, *prev_r, *next_r;
995 struct conf_service *service;
996 const char *idstr = http_argbyname(rq, "id");
997 const char *offsetstr = http_argbyname(rq, "offset");
998 const char *binarystr = http_argbyname(rq, "binary");
999 const char *checksumstr = http_argbyname(rq, "checksum");
1003 service = s->psession->service;
1006 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
1009 wrbuf_rewind(c->wrbuf);
1010 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
1012 if (session_active_clients(s->psession) == 0)
1014 error(rs, PAZPAR2_RECORD_MISSING, idstr);
1016 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
1017 cmd_record_ready, c, c) != 0)
1019 error(rs, PAZPAR2_RECORD_MISSING, idstr);
1023 if (offsetstr || checksumstr)
1025 const char *syntax = http_argbyname(rq, "syntax");
1026 const char *esn = http_argbyname(rq, "esn");
1028 struct record*r = rec->records;
1030 const char *nativesyntax = http_argbyname(rq, "nativesyntax");
1032 if (binarystr && *binarystr != '0')
1037 unsigned v = strtoul(checksumstr, 0, 10);
1038 for (i = 0; r; r = r->next)
1039 if (v == r->checksum)
1042 error(rs, PAZPAR2_RECORD_FAIL, "no record");
1046 int offset = atoi(offsetstr);
1047 for (i = 0; i < offset && r; r = r->next, i++)
1050 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
1054 http_channel_observer_t obs =
1055 http_add_observer(c, r->client, show_raw_reset);
1056 int ret = client_show_raw_begin(r->client, r->position,
1059 show_raw_record_error,
1061 show_raw_record_ok_binary :
1062 show_raw_record_ok),
1067 http_remove_observer(obs);
1068 error(rs, PAZPAR2_NO_SESSION, 0);
1075 response_open_command(c, "record");
1076 wrbuf_puts(c->wrbuf, "\n <recid>");
1077 wrbuf_xmlputs(c->wrbuf, rec->recid);
1078 wrbuf_puts(c->wrbuf, "</recid>\n");
1081 wrbuf_puts(c->wrbuf, " <prevrecid>");
1082 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
1083 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
1087 wrbuf_puts(c->wrbuf, " <nextrecid>");
1088 wrbuf_xmlputs(c->wrbuf, next_r->recid);
1089 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
1091 wrbuf_printf(c->wrbuf, " <activeclients>%d</activeclients>\n",
1092 session_active_clients(s->psession));
1093 write_metadata(c->wrbuf, service, rec->metadata, 1, 1);
1094 for (r = rec->records; r; r = r->next)
1095 write_subrecord(r, c->wrbuf, service, 2);
1096 response_close(c, "record");
1098 show_single_stop(s->psession, rec);
1101 static void cmd_record_ready(void *data)
1103 struct http_channel *c = (struct http_channel *) data;
1104 struct http_session *s = locate_session(c);
1107 session_log(s->psession, c->http_sessions->log_level,
1108 "record watch released");
1110 release_session(c,s);
1114 static void cmd_record(struct http_channel *c)
1116 struct http_session *s = locate_session(c);
1119 release_session(c,s);
1124 static void show_records(struct http_channel *c, struct http_session *s, int active)
1126 struct http_request *rq = c->request;
1127 struct http_response *rs = c->response;
1128 struct record_cluster **rl;
1129 struct reclist_sortparms *sp;
1130 const char *start = http_argbyname(rq, "start");
1131 const char *num = http_argbyname(rq, "num");
1132 const char *sort = http_argbyname(rq, "sort");
1133 int version = get_version(rq);
1139 Odr_int approx_hits;
1141 struct conf_service *service = 0;
1145 // We haven't counted clients yet if we're called on a block release
1147 active = session_active_clients(s->psession);
1150 startn = atoi(start);
1154 service = s->psession->service;
1156 sort = service->default_sort;
1158 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1160 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1165 rl = show_range_start(s->psession, sp, startn, &numn, &total,
1166 &total_hits, &approx_hits, show_records_ready, c);
1170 response_open_ok(c, "show");
1171 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
1172 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
1173 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
1175 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", approx_hits);
1177 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
1178 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
1180 for (i = 0; i < numn; i++)
1184 struct record_cluster *rec = rl[i];
1185 struct conf_service *service = s->psession->service;
1187 wrbuf_puts(c->wrbuf, "<hit>\n");
1188 write_metadata(c->wrbuf, service, rec->metadata, 0, 1);
1189 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
1190 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
1191 wrbuf_printf(c->wrbuf, " <count>%d</count>\n", ccount);
1192 if (strstr(sort, "relevance"))
1194 wrbuf_printf(c->wrbuf, " <relevance>%d</relevance>\n",
1195 rec->relevance_score);
1196 if (service->rank_debug)
1198 wrbuf_printf(c->wrbuf, " <relevance_info>\n");
1199 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain1));
1200 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain2));
1201 wrbuf_printf(c->wrbuf, " </relevance_info>\n");
1204 wrbuf_puts(c->wrbuf, " <recid>");
1205 wrbuf_xmlputs(c->wrbuf, rec->recid);
1206 wrbuf_puts(c->wrbuf, "</recid>\n");
1207 wrbuf_puts(c->wrbuf, "</hit>\n");
1210 show_range_stop(s->psession, rl);
1212 response_close(c, "show");
1215 static void show_records_ready(void *data)
1217 struct http_channel *c = (struct http_channel *) data;
1218 struct http_session *s = locate_session(c);
1221 session_log(s->psession, c->http_sessions->log_level,
1222 "show watch released");
1223 show_records(c, s, -1);
1226 /* some error message */
1228 release_session(c,s);
1231 static void cmd_show(struct http_channel *c)
1233 struct http_request *rq = c->request;
1234 struct http_response *rs = c->response;
1235 struct http_session *s = locate_session(c);
1236 const char *block = http_argbyname(rq, "block");
1237 const char *sort = http_argbyname(rq, "sort");
1238 const char *block_error = http_argbyname(rq, "report");
1239 const char *mergekey = http_argbyname(rq, "mergekey");
1240 const char *rank = http_argbyname(rq, "rank");
1241 struct conf_service *service = 0;
1243 struct reclist_sortparms *sp;
1245 int report_error = 0;
1246 if (block_error && !strcmp("1", block_error)) {
1252 service = s->psession->service;
1254 sort = service->default_sort;
1257 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1259 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1260 release_session(c, s);
1263 session_sort(s->psession, sp, mergekey, rank);
1265 status = session_active_clients(s->psession);
1269 if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0)
1271 // if there is already a watch/block. we do not block this one
1272 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1273 show_records_ready, c, c) == 0)
1275 session_log(s->psession, c->http_sessions->log_level,
1276 "Blocking on command show (preferred targets)");
1277 release_session(c, s);
1282 session_log(s->psession, YLOG_WARN, "Attempt to block"
1283 " multiple times on show (preferred targets) block."
1287 error(rs, PAZPAR2_ALREADY_BLOCKED,
1288 "show (preferred targets)");
1289 release_session(c, s);
1293 session_log(s->psession, YLOG_WARN,
1294 "Ignoring show(preferred) block."
1295 " Returning current result");
1301 // if there is already a watch/block. we do not block this one
1302 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1303 show_records_ready, c, c) != 0)
1305 session_log(s->psession, YLOG_WARN, "Attempt to block"
1306 " multiple times on show block. Not supported!");
1309 error(rs, PAZPAR2_ALREADY_BLOCKED, "show");
1310 release_session(c, s);
1314 session_log(s->psession, YLOG_WARN, "Ignoring show block."
1315 " Returning current result");
1319 session_log(s->psession, c->http_sessions->log_level,
1320 "Blocking on command show");
1321 release_session(c, s);
1326 show_records(c, s, status);
1327 release_session(c, s);
1330 static void cmd_ping(struct http_channel *c)
1332 struct http_session *s = locate_session(c);
1335 response_open_ok(c, "ping");
1336 response_close(c, "ping");
1337 release_session(c, s);
1340 static void cmd_search(struct http_channel *c)
1342 struct http_request *rq = c->request;
1343 struct http_response *rs = c->response;
1344 struct http_session *s = locate_session(c);
1345 const char *query = http_argbyname(rq, "query");
1346 const char *filter = http_argbyname(rq, "filter");
1347 const char *maxrecs = http_argbyname(rq, "maxrecs");
1348 const char *startrecs = http_argbyname(rq, "startrecs");
1349 const char *limit = http_argbyname(rq, "limit");
1350 const char *sort = http_argbyname(rq, "sort");
1351 const char *mergekey = http_argbyname(rq, "mergekey");
1352 const char *rank = http_argbyname(rq, "rank");
1353 enum pazpar2_error_code code;
1354 const char *addinfo = 0;
1355 struct reclist_sortparms *sp;
1356 struct conf_service *service = 0;
1363 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1364 release_session(c, s);
1367 if (!yaz_utf8_check(query))
1369 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1370 release_session(c, s);
1373 service = s->psession->service;
1375 sort = service->default_sort;
1377 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1379 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1380 release_session(c, s);
1384 code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
1385 &addinfo, sp, mergekey, rank);
1388 error(rs, code, addinfo);
1389 release_session(c, s);
1392 response_open_ok(c, "search");
1393 response_close(c, "search");
1394 release_session(c, s);
1398 static void cmd_stat(struct http_channel *c)
1400 struct http_session *s = locate_session(c);
1401 struct statistics stat;
1409 clients = session_active_clients(s->psession);
1410 statistics(s->psession, &stat);
1412 if (stat.num_clients > 0)
1414 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1417 response_open_command(c, "stat");
1418 wrbuf_printf(c->wrbuf, "\n <activeclients>%d</activeclients>\n", clients);
1419 wrbuf_printf(c->wrbuf, " <hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1420 wrbuf_printf(c->wrbuf, " <records>%d</records>\n", stat.num_records);
1421 wrbuf_printf(c->wrbuf, " <clients>%d</clients>\n", stat.num_clients);
1422 wrbuf_printf(c->wrbuf, " <unconnected>%d</unconnected>\n", stat.num_no_connection);
1423 wrbuf_printf(c->wrbuf, " <connecting>%d</connecting>\n", stat.num_connecting);
1424 wrbuf_printf(c->wrbuf, " <working>%d</working>\n", stat.num_working);
1425 wrbuf_printf(c->wrbuf, " <idle>%d</idle>\n", stat.num_idle);
1426 wrbuf_printf(c->wrbuf, " <failed>%d</failed>\n", stat.num_failed);
1427 wrbuf_printf(c->wrbuf, " <error>%d</error>\n", stat.num_error);
1428 wrbuf_printf(c->wrbuf, " <progress>%.2f</progress>\n", progress);
1429 response_close(c, "stat");
1430 release_session(c, s);
1433 static void cmd_info(struct http_channel *c)
1435 char yaz_version_str[20];
1436 char yaz_sha1_str[42];
1438 response_open_command(c, "info");
1439 wrbuf_puts(c->wrbuf, "\n <version>\n");
1440 wrbuf_puts(c->wrbuf, " <pazpar2");
1441 #ifdef PAZPAR2_VERSION_SHA1
1442 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1444 wrbuf_puts(c->wrbuf, ">");
1445 wrbuf_xmlputs(c->wrbuf, VERSION);
1446 wrbuf_puts(c->wrbuf, "</pazpar2>\n");
1448 yaz_version(yaz_version_str, yaz_sha1_str);
1449 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1450 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1451 wrbuf_puts(c->wrbuf, "\" sha1=\"");
1452 wrbuf_xmlputs(c->wrbuf, yaz_sha1_str);
1453 wrbuf_puts(c->wrbuf, "\">");
1454 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1455 wrbuf_puts(c->wrbuf, "</yaz>\n");
1457 wrbuf_puts(c->wrbuf, " </version>\n");
1460 char hostname_str[64];
1461 if (gethostname(hostname_str, sizeof(hostname_str)) == 0)
1463 wrbuf_puts(c->wrbuf, " <host>");
1464 wrbuf_xmlputs(c->wrbuf, hostname_str);
1465 wrbuf_puts(c->wrbuf, "</host>\n");
1469 info_services(c->server, c->wrbuf);
1471 response_close(c, "info");
1476 void (*fun)(struct http_channel *c);
1478 { "init", cmd_init },
1479 { "settings", cmd_settings },
1480 { "stat", cmd_stat },
1481 { "bytarget", cmd_bytarget },
1482 { "show", cmd_show },
1483 { "search", cmd_search },
1484 { "termlist", cmd_termlist },
1485 { "exit", cmd_exit },
1486 { "session-status", cmd_session_status },
1487 { "server-status", cmd_server_status },
1488 { "service", cmd_service },
1489 { "ping", cmd_ping },
1490 { "record", cmd_record },
1491 { "info", cmd_info },
1495 void http_command(struct http_channel *c)
1497 const char *command = http_argbyname(c->request, "command");
1498 struct http_response *rs = http_create_response(c);
1503 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1504 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1508 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1511 for (i = 0; commands[i].name; i++)
1512 if (!strcmp(commands[i].name, command))
1514 (*commands[i].fun)(c);
1517 if (!commands[i].name)
1518 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1526 * c-file-style: "Stroustrup"
1527 * indent-tabs-mode: nil
1529 * vim: shiftwidth=4 tabstop=8 expandtab