1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2012 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 int get_version(struct http_request *rq) {
97 const char *version = http_argbyname(rq, "version");
99 if (version && strcmp(version, "")) {
100 version_no = atoi(version);
106 int http_session_use(int delta)
109 if (!g_http_session_mutex)
110 yaz_mutex_create(&g_http_session_mutex);
111 yaz_mutex_enter(g_http_session_mutex);
112 g_http_sessions += delta;
113 sessions = g_http_sessions;
114 yaz_mutex_leave(g_http_session_mutex);
115 yaz_log(YLOG_DEBUG, "%s sessions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), sessions);
120 http_sessions_t http_sessions_create(void)
122 http_sessions_t hs = xmalloc(sizeof(*hs));
123 hs->session_list = 0;
125 pazpar2_mutex_create(&hs->mutex, "http_sessions");
126 hs->log_level = yaz_log_module_level("HTTP");
130 void http_sessions_destroy(http_sessions_t hs)
134 struct http_session *s = hs->session_list;
137 struct http_session *s_next = s->next;
138 iochan_destroy(s->timeout_iochan);
139 session_destroy(s->psession);
140 nmem_destroy(s->nmem);
143 yaz_mutex_destroy(&hs->mutex);
148 void http_session_destroy(struct http_session *s);
150 static void session_timeout(IOCHAN i, int event)
152 struct http_session *s = iochan_getdata(i);
153 http_session_destroy(s);
156 struct http_session *http_session_create(struct conf_service *service,
157 http_sessions_t http_sessions,
160 NMEM nmem = nmem_create();
161 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
164 sprintf(tmp_str, "session#%u", sesid);
165 r->psession = new_session(nmem, service, sesid);
166 r->session_id = sesid;
169 r->destroy_counter = r->activity_counter = 0;
170 r->http_sessions = http_sessions;
172 yaz_mutex_enter(http_sessions->mutex);
173 r->next = http_sessions->session_list;
174 http_sessions->session_list = r;
175 yaz_mutex_leave(http_sessions->mutex);
177 r->timeout_iochan = iochan_create(-1, session_timeout, 0, "http_session_timeout");
178 iochan_setdata(r->timeout_iochan, r);
179 yaz_log(http_sessions->log_level, "Session %u created. timeout chan=%p timeout=%d", sesid, r->timeout_iochan, service->session_timeout);
180 iochan_settimeout(r->timeout_iochan, service->session_timeout);
182 iochan_add(service->server->iochan_man, r->timeout_iochan);
187 void http_session_destroy(struct http_session *s)
189 int must_destroy = 0;
191 http_sessions_t http_sessions = s->http_sessions;
193 yaz_log(http_sessions->log_level, "Session %u destroy", s->session_id);
194 yaz_mutex_enter(http_sessions->mutex);
195 /* only if http_session has no active http sessions on it can be destroyed */
196 if (s->destroy_counter == s->activity_counter)
198 struct http_session **p = 0;
200 for (p = &http_sessions->session_list; *p; p = &(*p)->next)
207 yaz_mutex_leave(http_sessions->mutex);
209 { /* destroying for real */
210 yaz_log(http_sessions->log_level, "Session %u destroyed", s->session_id);
211 iochan_destroy(s->timeout_iochan);
212 session_destroy(s->psession);
213 http_session_use(-1);
214 nmem_destroy(s->nmem);
217 yaz_log(http_sessions->log_level, "Session %u destroying delayed. Active clients (%d-%d). Waiting for new timeout.",
218 s->session_id, s->activity_counter, s->destroy_counter);
223 static const char *get_msg(enum pazpar2_error_code code)
225 struct pazpar2_error_msg {
226 enum pazpar2_error_code code;
229 static const struct pazpar2_error_msg ar[] = {
230 { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
231 { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
232 { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
233 { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
234 { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
235 { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
236 { PAZPAR2_RECORD_MISSING, "Record missing"},
237 { PAZPAR2_NO_TARGETS, "No targets"},
238 { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
239 { PAZPAR2_RECORD_FAIL, "Record command failed"},
240 { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
241 { PAZPAR2_NO_SERVICE, "No service"},
242 { PAZPAR2_ALREADY_BLOCKED, "Already blocked in session on: "},
243 { PAZPAR2_LAST_ERROR, "Last error"},
249 if (code == ar[i].code)
256 static void error(struct http_response *rs,
257 enum pazpar2_error_code code,
260 struct http_channel *c = rs->channel;
261 WRBUF text = wrbuf_alloc();
262 const char *http_status = "417";
263 const char *msg = get_msg(code);
265 rs->msg = nmem_strdup(c->nmem, msg);
266 strcpy(rs->code, http_status);
268 wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX "<error code=\"%d\" msg=\"%s\">", (int) code,
271 wrbuf_xmlputs(text, addinfo);
272 wrbuf_puts(text, "</error>");
274 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
275 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
276 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
278 http_send_response(c);
281 static void response_open_no_status(struct http_channel *c, const char *command)
283 wrbuf_rewind(c->wrbuf);
284 wrbuf_printf(c->wrbuf, "%s<%s>",
285 HTTP_COMMAND_RESPONSE_PREFIX, command);
288 static void response_open(struct http_channel *c, const char *command)
290 response_open_no_status(c, command);
291 wrbuf_puts(c->wrbuf, "<status>OK</status>");
294 static void response_close(struct http_channel *c, const char *command)
296 struct http_response *rs = c->response;
298 wrbuf_printf(c->wrbuf, "</%s>", command);
299 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
300 http_send_response(c);
303 unsigned int make_sessionid(void)
305 static int seq = 0; /* thread pr */
309 if (global_parameters.predictable_sessions)
318 if (gettimeofday(&t, 0) < 0)
320 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
323 /* at most 256 sessions per second ..
324 (long long would be more appropriate)*/
326 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
332 static struct http_session *locate_session(struct http_channel *c)
334 struct http_request *rq = c->request;
335 struct http_response *rs = c->response;
336 struct http_session *p;
337 const char *session = http_argbyname(rq, "session");
338 http_sessions_t http_sessions = c->http_sessions;
343 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
347 yaz_mutex_enter(http_sessions->mutex);
348 for (p = http_sessions->session_list; p; p = p->next)
349 if (id == p->session_id)
352 p->activity_counter++;
353 yaz_mutex_leave(http_sessions->mutex);
355 iochan_activity(p->timeout_iochan);
357 error(rs, PAZPAR2_NO_SESSION, session);
361 // Call after use of locate_session, in order to increment the destroy_counter
362 static void release_session(struct http_channel *c,
363 struct http_session *session)
365 http_sessions_t http_sessions = c->http_sessions;
366 yaz_mutex_enter(http_sessions->mutex);
368 session->destroy_counter++;
369 yaz_mutex_leave(http_sessions->mutex);
372 // Decode settings parameters and apply to session
373 // Syntax: setting[target]=value
374 static int process_settings(struct session *se, struct http_request *rq,
375 struct http_response *rs)
377 struct http_argument *a;
379 for (a = rq->arguments; a; a = a->next)
380 if (strchr(a->name, '['))
387 // Nmem_strsplit *rules*!!!
388 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
391 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
396 session_apply_setting(se, dbname, setting,
397 nmem_strdup(se->session_nmem, a->value));
402 static void cmd_exit(struct http_channel *c)
404 yaz_log(YLOG_WARN, "exit");
406 response_open(c, "exit");
407 response_close(c, "exit");
408 http_close_server(c->server);
411 static void cmd_init(struct http_channel *c)
413 struct http_request *r = c->request;
414 const char *clear = http_argbyname(r, "clear");
415 const char *content_type = http_lookup_header(r->headers, "Content-Type");
417 struct http_session *s;
418 struct http_response *rs = c->response;
419 struct conf_service *service = 0; /* no service (yet) */
421 if (r->content_len && content_type &&
422 !yaz_strcmp_del("text/xml", content_type, "; "))
424 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
428 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
431 root_n = xmlDocGetRootElement(doc);
432 service = service_create(c->server, root_n);
436 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
443 const char *service_name = http_argbyname(c->request, "service");
444 service = locate_service(c->server, service_name);
447 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
451 sesid = make_sessionid();
452 s = http_session_create(service, c->http_sessions, sesid);
454 yaz_log(c->http_sessions->log_level, "Session init %u ", sesid);
455 if (!clear || *clear == '0')
456 session_init_databases(s->psession);
458 yaz_log(YLOG_LOG, "Session %u init: No databases preloaded", sesid);
460 if (process_settings(s->psession, c->request, c->response) < 0)
463 response_open(c, "init");
464 wrbuf_printf(c->wrbuf, "<session>%d", sesid);
465 if (c->server->server_id)
467 wrbuf_puts(c->wrbuf, ".");
468 wrbuf_puts(c->wrbuf, c->server->server_id);
470 wrbuf_puts(c->wrbuf, "</session>"
471 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol>");
473 wrbuf_printf(c->wrbuf, "<keepAlive>%d</keepAlive>\n", 1000 * ((s->psession->service->session_timeout >= 20) ?
474 (s->psession->service->session_timeout - 10) : 50));
475 response_close(c, "init");
478 static void apply_local_setting(void *client_data,
481 struct session *se = (struct session *) client_data;
483 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
484 nmem_strdup(se->session_nmem, set->name),
485 nmem_strdup(se->session_nmem, set->value));
488 static void cmd_settings(struct http_channel *c)
490 struct http_response *rs = c->response;
491 struct http_request *rq = c->request;
492 struct http_session *s = locate_session(c);
493 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
498 if (rq->content_len && content_type &&
499 !yaz_strcmp_del("text/xml", content_type, "; "))
501 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
506 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
507 release_session(c,s);
510 root_n = xmlDocGetRootElement(doc);
511 ret = settings_read_node_x(root_n, s->psession, apply_local_setting);
515 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
516 release_session(c,s);
520 if (process_settings(s->psession, rq, rs) < 0)
522 release_session(c, s);
525 response_open(c, "settings");
526 response_close(c, "settings");
527 release_session(c, s);
530 static void termlist_response(struct http_channel *c, struct http_session *s, const char *cmd_status)
532 struct http_request *rq = c->request;
533 const char *name = http_argbyname(rq, "name");
534 const char *nums = http_argbyname(rq, "num");
535 int version = get_version(rq);
542 status = session_active_clients(s->psession);
544 response_open_no_status(c, "termlist");
545 /* new protocol add a status to response. Triggered by a status parameter */
546 if (cmd_status != 0) {
547 wrbuf_printf(c->wrbuf, "<status>%s</status>\n", cmd_status);
549 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
551 perform_termlist(c, s->psession, name, num, version);
553 response_close(c, "termlist");
556 static void termlist_result_ready(void *data)
558 struct http_channel *c = (struct http_channel *) data;
559 struct http_request *rq = c->request;
560 const char *report = http_argbyname(rq, "report");
561 const char *status = 0;
562 struct http_session *s = locate_session(c);
563 if (report && !strcmp("status", report))
566 yaz_log(c->http_sessions->log_level, "Session %u termlist watch released", s->session_id);
567 termlist_response(c, s, status);
568 release_session(c,s);
572 static void cmd_termlist(struct http_channel *c)
574 struct http_request *rq = c->request;
575 struct http_response *rs = c->response;
576 struct http_session *s = locate_session(c);
577 const char *block = http_argbyname(rq, "block");
578 const char *report = http_argbyname(rq, "report");
579 int report_status = 0;
580 int report_error = 0;
581 const char *status_message = 0;
583 if (report && !strcmp("error", report)) {
585 status_message = "OK";
587 if (report && !strcmp("status", report)) {
589 status_message = "OK";
594 active_clients = session_active_clients(s->psession);
595 if (block && !strcmp("1", block) && active_clients)
597 // if there is already a watch/block. we do not block this one
598 if (session_set_watch(s->psession, SESSION_WATCH_TERMLIST,
599 termlist_result_ready, c, c) != 0)
601 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on termlist block. Not supported!", s->session_id);
603 error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
604 release_session(c, s);
607 else if (report_status) {
608 status_message = "WARNING (Already blocked on termlist)";
611 yaz_log(YLOG_WARN, "Session %u: Ignoring termlist block. Return current result", s->session_id);
616 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command termlist", s->session_id);
617 release_session(c, s);
622 termlist_response(c, s, status_message);
623 release_session(c, s);
626 size_t session_get_memory_status(struct session *session);
628 static void session_status(struct http_channel *c, struct http_session *s)
631 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
632 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
633 session_nmem = session_get_memory_status(s->psession);
634 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
637 static void cmd_session_status(struct http_channel *c)
639 struct http_session *s = locate_session(c);
643 response_open(c, "session-status");
644 session_status(c, s);
645 response_close(c, "session-status");
646 release_session(c, s);
649 int sessions_count(void);
650 int clients_count(void);
651 #ifdef HAVE_RESULTSETS_COUNT
652 int resultsets_count(void);
654 #define resultsets_count() 0
657 static void cmd_server_status(struct http_channel *c)
659 int sessions = sessions_count();
660 int clients = clients_count();
661 int resultsets = resultsets_count();
663 response_open(c, "server-status");
664 wrbuf_printf(c->wrbuf, "\n <sessions>%u</sessions>\n", sessions);
665 wrbuf_printf(c->wrbuf, " <clients>%u</clients>\n", clients);
666 /* Only works if yaz has been compiled with enabling of this */
667 wrbuf_printf(c->wrbuf, " <resultsets>%u</resultsets>\n",resultsets);
668 print_meminfo(c->wrbuf);
670 /* TODO add all sessions status */
671 /* http_sessions_t http_sessions = c->http_sessions; */
672 /* struct http_session *p; */
674 yaz_mutex_enter(http_sessions->mutex);
675 for (p = http_sessions->session_list; p; p = p->next)
677 p->activity_counter++;
678 wrbuf_puts(c->wrbuf, "<session-status>\n");
679 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
680 yaz_mutex_leave(http_sessions->mutex);
681 session_status(c, p);
682 wrbuf_puts(c->wrbuf, "</session-status>\n");
683 yaz_mutex_enter(http_sessions->mutex);
684 p->activity_counter--;
686 yaz_mutex_leave(http_sessions->mutex);
688 response_close(c, "server-status");
692 static void bytarget_response(struct http_channel *c, struct http_session *s, const char *cmd_status) {
694 struct hitsbytarget *ht;
695 struct http_request *rq = c->request;
696 const char *settings = http_argbyname(rq, "settings");
697 int version = get_version(rq);
698 ht = get_hitsbytarget(s->psession, &count, c->nmem);
700 /* Old protocol, always ok */
701 response_open(c, "bytarget");
703 /* New protocol, OK or WARNING (...)*/
704 response_open_no_status(c, "bytarget");
705 wrbuf_printf(c->wrbuf, "<status>%s</status>", cmd_status);
709 yaz_log(YLOG_WARN, "Empty bytarget Response. No targets found!");
710 for (i = 0; i < count; i++)
712 wrbuf_puts(c->wrbuf, "\n<target>");
714 wrbuf_puts(c->wrbuf, "<id>");
715 wrbuf_xmlputs(c->wrbuf, ht[i].id);
716 wrbuf_puts(c->wrbuf, "</id>\n");
718 if (ht[i].name && ht[i].name[0])
720 wrbuf_puts(c->wrbuf, "<name>");
721 wrbuf_xmlputs(c->wrbuf, ht[i].name);
722 wrbuf_puts(c->wrbuf, "</name>\n");
725 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
726 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
727 if (ht[i].diagnostic)
729 wrbuf_puts(c->wrbuf, "<addinfo>");
731 wrbuf_xmlputs(c->wrbuf, ht[i].addinfo);
732 wrbuf_puts(c->wrbuf, "</addinfo>\n");
735 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
737 wrbuf_printf(c->wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
738 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
740 wrbuf_puts(c->wrbuf, "<state>");
741 wrbuf_xmlputs(c->wrbuf, ht[i].state);
742 wrbuf_puts(c->wrbuf, "</state>\n");
743 if (settings && *settings == '1')
745 wrbuf_puts(c->wrbuf, "<settings>\n");
746 wrbuf_puts(c->wrbuf, ht[i].settings_xml);
747 wrbuf_puts(c->wrbuf, "</settings>\n");
749 if (ht[i].suggestions_xml && ht[i].suggestions_xml[0]) {
750 wrbuf_puts(c->wrbuf, "<suggestions>");
751 wrbuf_puts(c->wrbuf, ht[i].suggestions_xml);
752 wrbuf_puts(c->wrbuf, "</suggestions>");
754 wrbuf_puts(c->wrbuf, "</target>");
756 response_close(c, "bytarget");
759 static void bytarget_result_ready(void *data)
761 struct http_channel *c = (struct http_channel *) data;
762 struct http_session *s = locate_session(c);
763 const char *status_message = "OK";
765 yaz_log(c->http_sessions->log_level, "Session %u: bytarget watch released", s->session_id);
766 bytarget_response(c, s, status_message);
767 release_session(c, s);
770 yaz_log(c->http_sessions->log_level, "No Session found for released bytarget watch");
775 static void cmd_bytarget(struct http_channel *c)
777 struct http_request *rq = c->request;
778 struct http_response *rs = c->response;
779 struct http_session *s = locate_session(c);
780 const char *block = http_argbyname(rq, "block");
781 const char *report = http_argbyname(rq, "report");
782 int report_error = 0;
783 int report_status = 0;
784 const char *status_message = "OK";
787 if (report && !strcmp("error", report)) {
790 if (report && !strcmp("status", report)) {
797 no_active = session_active_clients(s->psession);
798 if (block && !strcmp("1",block) && no_active)
800 // if there is already a watch/block. we do not block this one
801 if (session_set_watch(s->psession, SESSION_WATCH_BYTARGET,
802 bytarget_result_ready, c, c) != 0)
804 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on bytarget block. Not supported!", s->session_id);
806 error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget");
807 release_session(c, s);
810 else if (report_status) {
811 status_message = "WARNING (Already blocked on bytarget)";
814 yaz_log(YLOG_WARN, "Session %u: Ignoring bytarget block. Return current result.", s->session_id);
819 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command bytarget", s->session_id);
820 release_session(c, s);
824 bytarget_response(c, s, status_message);
825 release_session(c, s);
828 static void write_metadata(WRBUF w, struct conf_service *service,
829 struct record_metadata **ml, int full, int indent)
833 for (imeta = 0; imeta < service->num_metadata; imeta++)
835 struct conf_metadata *cmd = &service->metadata[imeta];
836 struct record_metadata *md;
837 if (!cmd->brief && !full)
839 for (md = ml[imeta]; md; md = md->next)
841 struct record_metadata_attr *attr = md->attributes;
843 for (i = 0; i < indent; i++)
845 wrbuf_printf(w, "<md-%s", cmd->name);
847 for (; attr; attr = attr->next)
849 wrbuf_printf(w, " %s=\"", attr->name);
850 wrbuf_xmlputs(w, attr->value);
856 case Metadata_type_generic:
857 wrbuf_xmlputs(w, md->data.text.disp);
859 case Metadata_type_year:
860 wrbuf_printf(w, "%d", md->data.number.min);
861 if (md->data.number.min != md->data.number.max)
862 wrbuf_printf(w, "-%d", md->data.number.max);
865 wrbuf_puts(w, "[can't represent]");
868 wrbuf_printf(w, "</md-%s>\n", cmd->name);
873 static void write_subrecord(struct record *r, WRBUF w,
874 struct conf_service *service, int show_details)
876 const char *name = session_setting_oneval(
877 client_get_database(r->client), PZ_NAME);
879 wrbuf_puts(w, " <location id=\"");
880 wrbuf_xmlputs(w, client_get_id(r->client));
881 wrbuf_puts(w, "\"\n");
883 wrbuf_puts(w, " name=\"");
884 wrbuf_xmlputs(w, *name ? name : "Unknown");
885 wrbuf_puts(w, "\" ");
887 wrbuf_puts(w, "checksum=\"");
888 wrbuf_printf(w, "%u", r->checksum);
889 wrbuf_puts(w, "\">\n");
891 write_metadata(w, service, r->metadata, show_details, 2);
892 wrbuf_puts(w, " </location>\n");
895 static void show_raw_record_error(void *data, const char *addinfo)
897 http_channel_observer_t obs = data;
898 struct http_channel *c = http_channel_observer_chan(obs);
899 struct http_response *rs = c->response;
901 http_remove_observer(obs);
903 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
906 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
908 http_channel_observer_t obs = data;
909 struct http_channel *c = http_channel_observer_chan(obs);
910 struct http_response *rs = c->response;
912 http_remove_observer(obs);
914 wrbuf_write(c->wrbuf, buf, sz);
915 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
916 http_send_response(c);
920 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
922 http_channel_observer_t obs = data;
923 struct http_channel *c = http_channel_observer_chan(obs);
924 struct http_response *rs = c->response;
926 http_remove_observer(obs);
928 wrbuf_write(c->wrbuf, buf, sz);
929 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
931 rs->content_type = "application/octet-stream";
932 http_send_response(c);
936 void show_raw_reset(void *data, struct http_channel *c, void *data2)
938 //struct client *client = data;
939 //client_show_raw_remove(client, data2);
942 static void cmd_record_ready(void *data);
944 static void show_record(struct http_channel *c, struct http_session *s)
946 struct http_response *rs = c->response;
947 struct http_request *rq = c->request;
948 struct record_cluster *rec, *prev_r, *next_r;
949 struct conf_service *service;
950 const char *idstr = http_argbyname(rq, "id");
951 const char *offsetstr = http_argbyname(rq, "offset");
952 const char *binarystr = http_argbyname(rq, "binary");
953 const char *checksumstr = http_argbyname(rq, "checksum");
957 service = s->psession->service;
960 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
963 wrbuf_rewind(c->wrbuf);
964 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
966 if (session_active_clients(s->psession) == 0)
968 error(rs, PAZPAR2_RECORD_MISSING, idstr);
970 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
971 cmd_record_ready, c, c) != 0)
973 error(rs, PAZPAR2_RECORD_MISSING, idstr);
977 if (offsetstr || checksumstr)
979 const char *syntax = http_argbyname(rq, "syntax");
980 const char *esn = http_argbyname(rq, "esn");
982 struct record*r = rec->records;
984 const char *nativesyntax = http_argbyname(rq, "nativesyntax");
986 if (binarystr && *binarystr != '0')
991 long v = atol(checksumstr);
992 for (i = 0; r; r = r->next)
993 if (v == r->checksum)
996 error(rs, PAZPAR2_RECORD_FAIL, "no record");
1000 int offset = atoi(offsetstr);
1001 for (i = 0; i < offset && r; r = r->next, i++)
1004 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
1008 http_channel_observer_t obs =
1009 http_add_observer(c, r->client, show_raw_reset);
1010 int ret = client_show_raw_begin(r->client, r->position,
1013 show_raw_record_error,
1015 show_raw_record_ok_binary :
1016 show_raw_record_ok),
1021 http_remove_observer(obs);
1022 error(rs, PAZPAR2_NO_SESSION, 0);
1029 response_open_no_status(c, "record");
1030 wrbuf_puts(c->wrbuf, "\n <recid>");
1031 wrbuf_xmlputs(c->wrbuf, rec->recid);
1032 wrbuf_puts(c->wrbuf, "</recid>\n");
1035 wrbuf_puts(c->wrbuf, " <prevrecid>");
1036 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
1037 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
1041 wrbuf_puts(c->wrbuf, " <nextrecid>");
1042 wrbuf_xmlputs(c->wrbuf, next_r->recid);
1043 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
1045 wrbuf_printf(c->wrbuf, " <activeclients>%d</activeclients>\n",
1046 session_active_clients(s->psession));
1047 write_metadata(c->wrbuf, service, rec->metadata, 1, 1);
1048 for (r = rec->records; r; r = r->next)
1049 write_subrecord(r, c->wrbuf, service, 2);
1050 response_close(c, "record");
1052 show_single_stop(s->psession, rec);
1055 static void cmd_record_ready(void *data)
1057 struct http_channel *c = (struct http_channel *) data;
1058 struct http_session *s = locate_session(c);
1060 yaz_log(c->http_sessions->log_level, "Session %u: record watch released", s->session_id);
1062 release_session(c,s);
1066 static void cmd_record(struct http_channel *c)
1068 struct http_session *s = locate_session(c);
1071 release_session(c,s);
1076 static void show_records(struct http_channel *c, struct http_session *s, int active)
1078 struct http_request *rq = c->request;
1079 struct http_response *rs = c->response;
1080 struct record_cluster **rl;
1081 struct reclist_sortparms *sp;
1082 const char *start = http_argbyname(rq, "start");
1083 const char *num = http_argbyname(rq, "num");
1084 const char *sort = http_argbyname(rq, "sort");
1085 int version = get_version(rq);
1091 Odr_int approx_hits;
1093 struct conf_service *service = 0;
1097 // We haven't counted clients yet if we're called on a block release
1099 active = session_active_clients(s->psession);
1102 startn = atoi(start);
1106 service = s->psession->service;
1108 sort = service->default_sort;
1110 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1112 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1117 rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits, &approx_hits);
1119 response_open(c, "show");
1120 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
1121 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
1122 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
1124 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", approx_hits);
1126 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
1127 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
1129 for (i = 0; i < numn; i++)
1133 struct record_cluster *rec = rl[i];
1134 struct conf_service *service = s->psession->service;
1136 wrbuf_puts(c->wrbuf, "<hit>\n");
1137 write_metadata(c->wrbuf, service, rec->metadata, 0, 1);
1138 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
1139 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
1140 wrbuf_printf(c->wrbuf, " <count>%d</count>\n", ccount);
1141 if (strstr(sort, "relevance"))
1143 wrbuf_printf(c->wrbuf, " <relevance>%d</relevance>\n",
1144 rec->relevance_score);
1145 if (service->rank_debug)
1147 wrbuf_printf(c->wrbuf, " <relevance_info>\n");
1148 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain1));
1149 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain2));
1150 wrbuf_printf(c->wrbuf, " </relevance_info>\n");
1153 wrbuf_puts(c->wrbuf, " <recid>");
1154 wrbuf_xmlputs(c->wrbuf, rec->recid);
1155 wrbuf_puts(c->wrbuf, "</recid>\n");
1156 wrbuf_puts(c->wrbuf, "</hit>\n");
1159 show_range_stop(s->psession, rl);
1161 response_close(c, "show");
1164 static void show_records_ready(void *data)
1166 struct http_channel *c = (struct http_channel *) data;
1167 struct http_session *s = locate_session(c);
1169 yaz_log(c->http_sessions->log_level, "Session %u: show watch released", s->session_id);
1170 show_records(c, s, -1);
1173 /* some error message */
1175 release_session(c,s);
1178 static void cmd_show(struct http_channel *c)
1180 struct http_request *rq = c->request;
1181 struct http_response *rs = c->response;
1182 struct http_session *s = locate_session(c);
1183 const char *block = http_argbyname(rq, "block");
1184 const char *sort = http_argbyname(rq, "sort");
1185 const char *block_error = http_argbyname(rq, "report");
1186 struct conf_service *service = 0;
1188 struct reclist_sortparms *sp;
1190 int report_error = 0;
1191 if (block_error && !strcmp("1", block_error)) {
1197 service = s->psession->service;
1199 sort = service->default_sort;
1202 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1204 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1205 release_session(c, s);
1208 session_sort(s->psession, sp->name, sp->increasing, sp->type == Metadata_sortkey_position);
1210 status = session_active_clients(s->psession);
1214 if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0)
1216 // if there is already a watch/block. we do not block this one
1217 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1218 show_records_ready, c, c) == 0)
1220 yaz_log(c->http_sessions->log_level,
1221 "Session %u: Blocking on command show (preferred targets)", s->session_id);
1222 release_session(c, s);
1227 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on show (preferred targets) block. Not supported!",
1230 error(rs, PAZPAR2_ALREADY_BLOCKED, "show (preferred targets)");
1231 release_session(c, s);
1235 yaz_log(YLOG_WARN, "Session %u: Ignoring show(preferred) block. Returning current result.", s->session_id);
1242 // if there is already a watch/block. we do not block this one
1243 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1244 show_records_ready, c, c) != 0)
1246 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on show block. Not supported!", s->session_id);
1248 error(rs, PAZPAR2_ALREADY_BLOCKED, "show");
1249 release_session(c, s);
1253 yaz_log(YLOG_WARN, "Session %u: Ignoring show block. Returning current result.", s->session_id);
1258 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command show", s->session_id);
1259 release_session(c, s);
1264 show_records(c, s, status);
1265 release_session(c, s);
1268 static void cmd_ping(struct http_channel *c)
1270 struct http_session *s = locate_session(c);
1273 response_open(c, "ping");
1274 response_close(c, "ping");
1275 release_session(c, s);
1278 static void cmd_search(struct http_channel *c)
1280 struct http_request *rq = c->request;
1281 struct http_response *rs = c->response;
1282 struct http_session *s = locate_session(c);
1283 const char *query = http_argbyname(rq, "query");
1284 const char *filter = http_argbyname(rq, "filter");
1285 const char *maxrecs = http_argbyname(rq, "maxrecs");
1286 const char *startrecs = http_argbyname(rq, "startrecs");
1287 const char *limit = http_argbyname(rq, "limit");
1288 const char *sort = http_argbyname(rq, "sort");
1289 enum pazpar2_error_code code;
1290 const char *addinfo = 0;
1291 struct reclist_sortparms *sp;
1292 struct conf_service *service = 0;
1299 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1300 release_session(c, s);
1303 if (!yaz_utf8_check(query))
1305 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1306 release_session(c, s);
1309 service = s->psession->service;
1311 sort = service->default_sort;
1313 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1315 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1316 release_session(c, s);
1320 code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
1324 error(rs, code, addinfo);
1325 release_session(c, s);
1328 response_open(c, "search");
1329 response_close(c, "search");
1330 release_session(c, s);
1334 static void cmd_stat(struct http_channel *c)
1336 struct http_session *s = locate_session(c);
1337 struct statistics stat;
1345 clients = session_active_clients(s->psession);
1346 statistics(s->psession, &stat);
1348 if (stat.num_clients > 0)
1350 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1353 response_open_no_status(c, "stat");
1354 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
1355 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1356 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
1357 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
1358 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
1359 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
1360 wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
1361 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
1362 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
1363 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
1364 wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
1365 response_close(c, "stat");
1366 release_session(c, s);
1369 static void cmd_info(struct http_channel *c)
1371 char yaz_version_str[20];
1373 response_open_no_status(c, "info");
1374 wrbuf_puts(c->wrbuf, " <version>\n");
1375 wrbuf_puts(c->wrbuf, " <pazpar2");
1376 #ifdef PAZPAR2_VERSION_SHA1
1377 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1379 wrbuf_puts(c->wrbuf, ">");
1380 wrbuf_xmlputs(c->wrbuf, VERSION);
1381 wrbuf_puts(c->wrbuf, "</pazpar2>");
1383 yaz_version(yaz_version_str, 0);
1384 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1385 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1386 wrbuf_puts(c->wrbuf, "\">");
1387 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1388 wrbuf_puts(c->wrbuf, "</yaz>\n");
1390 wrbuf_puts(c->wrbuf, " </version>\n");
1392 info_services(c->server, c->wrbuf);
1394 response_close(c, "info");
1399 void (*fun)(struct http_channel *c);
1401 { "init", cmd_init },
1402 { "settings", cmd_settings },
1403 { "stat", cmd_stat },
1404 { "bytarget", cmd_bytarget },
1405 { "show", cmd_show },
1406 { "search", cmd_search },
1407 { "termlist", cmd_termlist },
1408 { "exit", cmd_exit },
1409 { "session-status", cmd_session_status },
1410 { "server-status", cmd_server_status },
1411 { "ping", cmd_ping },
1412 { "record", cmd_record },
1413 { "info", cmd_info },
1417 void http_command(struct http_channel *c)
1419 const char *command = http_argbyname(c->request, "command");
1420 struct http_response *rs = http_create_response(c);
1425 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1426 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1430 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1433 for (i = 0; commands[i].name; i++)
1434 if (!strcmp(commands[i].name, command))
1436 (*commands[i].fun)(c);
1439 if (!commands[i].name)
1440 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1448 * c-file-style: "Stroustrup"
1449 * indent-tabs-mode: nil
1451 * vim: shiftwidth=4 tabstop=8 expandtab