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_no_status(struct http_channel *c, const char *command)
292 wrbuf_rewind(c->wrbuf);
293 wrbuf_printf(c->wrbuf, "%s<%s>",
294 HTTP_COMMAND_RESPONSE_PREFIX, command);
297 static void response_open(struct http_channel *c, const char *command)
299 response_open_no_status(c, command);
300 wrbuf_puts(c->wrbuf, "<status>OK</status>");
303 static void response_close(struct http_channel *c, const char *command)
305 struct http_response *rs = c->response;
307 wrbuf_printf(c->wrbuf, "</%s>", command);
308 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
309 http_send_response(c);
312 unsigned int make_sessionid(void)
314 static int seq = 0; /* thread pr */
318 if (global_parameters.predictable_sessions)
327 if (gettimeofday(&t, 0) < 0)
329 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
332 /* at most 256 sessions per second ..
333 (long long would be more appropriate)*/
335 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
341 static struct http_session *locate_session(struct http_channel *c)
343 struct http_request *rq = c->request;
344 struct http_response *rs = c->response;
345 struct http_session *p;
346 const char *session = http_argbyname(rq, "session");
347 http_sessions_t http_sessions = c->http_sessions;
352 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
356 yaz_mutex_enter(http_sessions->mutex);
357 for (p = http_sessions->session_list; p; p = p->next)
358 if (id == p->session_id)
361 p->activity_counter++;
362 yaz_mutex_leave(http_sessions->mutex);
364 iochan_activity(p->timeout_iochan);
366 error(rs, PAZPAR2_NO_SESSION, session);
370 // Call after use of locate_session, in order to increment the destroy_counter
371 static void release_session(struct http_channel *c,
372 struct http_session *session)
374 http_sessions_t http_sessions = c->http_sessions;
375 yaz_mutex_enter(http_sessions->mutex);
377 session->destroy_counter++;
378 yaz_mutex_leave(http_sessions->mutex);
381 // Decode settings parameters and apply to session
382 // Syntax: setting[target]=value
383 static int process_settings(struct session *se, struct http_request *rq,
384 struct http_response *rs)
386 struct http_argument *a;
388 for (a = rq->arguments; a; a = a->next)
389 if (strchr(a->name, '['))
396 // Nmem_strsplit *rules*!!!
397 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
400 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
405 session_apply_setting(se, dbname, setting,
406 nmem_strdup(se->session_nmem, a->value));
411 static void cmd_exit(struct http_channel *c)
413 yaz_log(YLOG_WARN, "exit");
415 response_open(c, "exit");
416 response_close(c, "exit");
417 if (global_parameters.debug_mode)
418 http_close_server(c->server);
421 static void cmd_init(struct http_channel *c)
423 struct http_request *r = c->request;
424 const char *clear = http_argbyname(r, "clear");
425 const char *content_type = http_lookup_header(r->headers, "Content-Type");
427 struct http_session *s;
428 struct http_response *rs = c->response;
429 struct conf_service *service = 0; /* no service (yet) */
431 if (r->content_len && content_type &&
432 !yaz_strcmp_del("text/xml", content_type, "; "))
434 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
438 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
441 root_n = xmlDocGetRootElement(doc);
442 service = service_create(c->server, root_n);
446 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
453 const char *service_name = http_argbyname(c->request, "service");
454 service = locate_service(c->server, service_name);
457 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
461 sesid = make_sessionid();
462 s = http_session_create(service, c->http_sessions, sesid);
464 if (!clear || *clear == '0')
465 session_init_databases(s->psession);
467 session_log(s->psession, YLOG_LOG, "No databases preloaded");
469 if (process_settings(s->psession, c->request, c->response) < 0)
472 response_open(c, "init");
473 wrbuf_printf(c->wrbuf, "<session>%d", sesid);
474 if (c->server->server_id)
476 wrbuf_puts(c->wrbuf, ".");
477 wrbuf_puts(c->wrbuf, c->server->server_id);
479 wrbuf_puts(c->wrbuf, "</session>"
480 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol>");
482 wrbuf_printf(c->wrbuf, "<keepAlive>%d</keepAlive>\n", 1000 * ((s->psession->service->session_timeout >= 20) ?
483 (s->psession->service->session_timeout - 10) : 50));
484 response_close(c, "init");
487 static void apply_local_setting(void *client_data,
490 struct session *se = (struct session *) client_data;
492 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
493 nmem_strdup(se->session_nmem, set->name),
494 nmem_strdup(se->session_nmem, set->value));
497 static void cmd_settings(struct http_channel *c)
499 struct http_response *rs = c->response;
500 struct http_request *rq = c->request;
501 struct http_session *s = locate_session(c);
502 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
507 if (rq->content_len && content_type &&
508 !yaz_strcmp_del("text/xml", content_type, "; "))
510 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
515 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
516 release_session(c,s);
519 root_n = xmlDocGetRootElement(doc);
520 ret = settings_read_node_x(root_n, s->psession, apply_local_setting);
524 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
525 release_session(c,s);
529 if (process_settings(s->psession, rq, rs) < 0)
531 release_session(c, s);
534 response_open(c, "settings");
535 response_close(c, "settings");
536 release_session(c, s);
539 static void termlist_response(struct http_channel *c, struct http_session *s, const char *cmd_status)
541 struct http_request *rq = c->request;
542 const char *name = http_argbyname(rq, "name");
543 const char *nums = http_argbyname(rq, "num");
544 int version = get_version(rq);
551 status = session_active_clients(s->psession);
553 response_open_no_status(c, "termlist");
554 /* new protocol add a status to response. Triggered by a status parameter */
556 wrbuf_printf(c->wrbuf, "<status>%s</status>\n", cmd_status);
557 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
559 perform_termlist(c, s->psession, name, num, version);
561 response_close(c, "termlist");
564 static void termlist_result_ready(void *data)
566 struct http_channel *c = (struct http_channel *) data;
567 struct http_request *rq = c->request;
568 const char *report = http_argbyname(rq, "report");
569 const char *status = 0;
570 struct http_session *s = locate_session(c);
571 if (report && !strcmp("status", report))
575 session_log(s->psession, c->http_sessions->log_level,
576 "termlist watch released");
577 termlist_response(c, s, status);
578 release_session(c,s);
582 static void cmd_termlist(struct http_channel *c)
584 struct http_request *rq = c->request;
585 struct http_response *rs = c->response;
586 struct http_session *s = locate_session(c);
587 const char *block = http_argbyname(rq, "block");
588 const char *report = http_argbyname(rq, "report");
589 int report_status = 0;
590 int report_error = 0;
591 const char *status_message = 0;
594 if (report && !strcmp("error", report))
597 status_message = "OK";
599 if (report && !strcmp("status", report))
602 status_message = "OK";
607 active_clients = session_active_clients(s->psession);
608 if (block && !strcmp("1", block) && active_clients)
610 // if there is already a watch/block. we do not block this one
611 if (session_set_watch(s->psession, SESSION_WATCH_TERMLIST,
612 termlist_result_ready, c, c) != 0)
614 session_log(s->psession, YLOG_WARN, "Attempt to block "
615 "multiple times on termlist block. Not supported!");
617 error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
618 release_session(c, s);
621 else if (report_status)
622 status_message = "WARNING (Already blocked on termlist)";
624 session_log(s->psession, YLOG_WARN,
625 "Ignoring termlist block. Return current result");
629 session_log(s->psession, c->http_sessions->log_level,
630 "Blocking on command termlist");
631 release_session(c, s);
636 termlist_response(c, s, status_message);
637 release_session(c, s);
640 size_t session_get_memory_status(struct session *session);
642 static void session_status(struct http_channel *c, struct http_session *s)
645 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
646 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
647 session_nmem = session_get_memory_status(s->psession);
648 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
651 static void cmd_session_status(struct http_channel *c)
653 struct http_session *s = locate_session(c);
657 response_open(c, "session-status");
658 session_status(c, s);
659 response_close(c, "session-status");
660 release_session(c, s);
663 int sessions_count(void);
664 int clients_count(void);
665 #ifdef HAVE_RESULTSETS_COUNT
666 int resultsets_count(void);
668 #define resultsets_count() 0
671 static void cmd_server_status(struct http_channel *c)
673 int sessions = sessions_count();
674 int clients = clients_count();
675 int resultsets = resultsets_count();
677 response_open(c, "server-status");
678 wrbuf_printf(c->wrbuf, "\n <sessions>%u</sessions>\n", sessions);
679 wrbuf_printf(c->wrbuf, " <clients>%u</clients>\n", clients);
680 /* Only works if yaz has been compiled with enabling of this */
681 wrbuf_printf(c->wrbuf, " <resultsets>%u</resultsets>\n",resultsets);
682 print_meminfo(c->wrbuf);
684 /* TODO add all sessions status */
685 /* http_sessions_t http_sessions = c->http_sessions; */
686 /* struct http_session *p; */
688 yaz_mutex_enter(http_sessions->mutex);
689 for (p = http_sessions->session_list; p; p = p->next)
691 p->activity_counter++;
692 wrbuf_puts(c->wrbuf, "<session-status>\n");
693 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
694 yaz_mutex_leave(http_sessions->mutex);
695 session_status(c, p);
696 wrbuf_puts(c->wrbuf, "</session-status>\n");
697 yaz_mutex_enter(http_sessions->mutex);
698 p->activity_counter--;
700 yaz_mutex_leave(http_sessions->mutex);
702 response_close(c, "server-status");
706 static void bytarget_response(struct http_channel *c, struct http_session *s, const char *cmd_status) {
708 struct hitsbytarget *ht;
709 struct http_request *rq = c->request;
710 const char *settings = http_argbyname(rq, "settings");
711 int version = get_version(rq);
712 ht = get_hitsbytarget(s->psession, &count, c->nmem);
714 /* Old protocol, always ok */
715 response_open(c, "bytarget");
717 /* New protocol, OK or WARNING (...)*/
718 response_open_no_status(c, "bytarget");
719 wrbuf_printf(c->wrbuf, "<status>%s</status>", cmd_status);
723 session_log(s->psession, YLOG_WARN,
724 "Empty bytarget Response. No targets found!");
725 for (i = 0; i < count; i++)
727 wrbuf_puts(c->wrbuf, "\n<target>");
729 wrbuf_puts(c->wrbuf, "<id>");
730 wrbuf_xmlputs(c->wrbuf, ht[i].id);
731 wrbuf_puts(c->wrbuf, "</id>\n");
733 if (ht[i].name && ht[i].name[0])
735 wrbuf_puts(c->wrbuf, "<name>");
736 wrbuf_xmlputs(c->wrbuf, ht[i].name);
737 wrbuf_puts(c->wrbuf, "</name>\n");
740 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
741 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
742 if (ht[i].diagnostic)
744 wrbuf_puts(c->wrbuf, "<message>");
745 wrbuf_xmlputs(c->wrbuf, ht[i].message);
746 wrbuf_puts(c->wrbuf, "</message>\n");
747 wrbuf_puts(c->wrbuf, "<addinfo>");
749 wrbuf_xmlputs(c->wrbuf, ht[i].addinfo);
750 wrbuf_puts(c->wrbuf, "</addinfo>\n");
753 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
755 wrbuf_printf(c->wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
756 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
758 wrbuf_puts(c->wrbuf, "<state>");
759 wrbuf_xmlputs(c->wrbuf, ht[i].state);
760 wrbuf_puts(c->wrbuf, "</state>\n");
761 if (settings && *settings == '1')
763 wrbuf_puts(c->wrbuf, "<settings>\n");
764 wrbuf_puts(c->wrbuf, ht[i].settings_xml);
765 wrbuf_puts(c->wrbuf, "</settings>\n");
767 if (ht[i].suggestions_xml && ht[i].suggestions_xml[0]) {
768 wrbuf_puts(c->wrbuf, "<suggestions>");
769 wrbuf_puts(c->wrbuf, ht[i].suggestions_xml);
770 wrbuf_puts(c->wrbuf, "</suggestions>");
772 wrbuf_puts(c->wrbuf, "</target>");
774 response_close(c, "bytarget");
777 static void bytarget_result_ready(void *data)
779 struct http_channel *c = (struct http_channel *) data;
780 struct http_session *s = locate_session(c);
781 const char *status_message = "OK";
784 session_log(s->psession, c->http_sessions->log_level,
785 "bytarget watch released");
786 bytarget_response(c, s, status_message);
787 release_session(c, s);
790 yaz_log(c->http_sessions->log_level,
791 "No Session found for released bytarget watch");
795 static void cmd_bytarget(struct http_channel *c)
797 struct http_request *rq = c->request;
798 struct http_response *rs = c->response;
799 struct http_session *s = locate_session(c);
800 const char *block = http_argbyname(rq, "block");
801 const char *report = http_argbyname(rq, "report");
802 int report_error = 0;
803 int report_status = 0;
804 const char *status_message = "OK";
807 if (report && !strcmp("error", report))
809 if (report && !strcmp("status", report))
815 no_active = session_active_clients(s->psession);
816 if (block && !strcmp("1", block) && no_active)
818 // if there is already a watch/block. we do not block this one
819 if (session_set_watch(s->psession, SESSION_WATCH_BYTARGET,
820 bytarget_result_ready, c, c) != 0)
822 session_log(s->psession, YLOG_WARN, "Attempt to block "
823 "multiple times on bytarget block. Not supported!");
826 error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget");
827 release_session(c, s);
830 else if (report_status)
831 status_message = "WARNING (Already blocked on bytarget)";
833 session_log(s->psession, YLOG_WARN, "Ignoring bytarget block."
834 " Return current result.");
839 session_log(s->psession, c->http_sessions->log_level,
840 "Blocking on command bytarget");
841 release_session(c, s);
845 bytarget_response(c, s, status_message);
846 release_session(c, s);
849 static void write_metadata(WRBUF w, struct conf_service *service,
850 struct record_metadata **ml, int full, int indent)
854 for (imeta = 0; imeta < service->num_metadata; imeta++)
856 struct conf_metadata *cmd = &service->metadata[imeta];
857 struct record_metadata *md;
858 if (!cmd->brief && !full)
860 for (md = ml[imeta]; md; md = md->next)
862 struct record_metadata_attr *attr = md->attributes;
864 for (i = 0; i < indent; i++)
866 wrbuf_printf(w, "<md-%s", cmd->name);
868 for (; attr; attr = attr->next)
870 wrbuf_printf(w, " %s=\"", attr->name);
871 wrbuf_xmlputs(w, attr->value);
877 case Metadata_type_generic:
878 wrbuf_xmlputs(w, md->data.text.disp);
880 case Metadata_type_year:
881 wrbuf_printf(w, "%d", md->data.number.min);
882 if (md->data.number.min != md->data.number.max)
883 wrbuf_printf(w, "-%d", md->data.number.max);
886 wrbuf_puts(w, "[can't represent]");
889 wrbuf_printf(w, "</md-%s>\n", cmd->name);
894 static void write_subrecord(struct record *r, WRBUF w,
895 struct conf_service *service, int show_details)
897 const char *name = session_setting_oneval(
898 client_get_database(r->client), PZ_NAME);
900 wrbuf_puts(w, " <location id=\"");
901 wrbuf_xmlputs(w, client_get_id(r->client));
902 wrbuf_puts(w, "\"\n");
904 wrbuf_puts(w, " name=\"");
905 wrbuf_xmlputs(w, *name ? name : "Unknown");
906 wrbuf_puts(w, "\" ");
908 wrbuf_puts(w, "checksum=\"");
909 wrbuf_printf(w, "%u", r->checksum);
910 wrbuf_puts(w, "\">\n");
912 write_metadata(w, service, r->metadata, show_details, 2);
913 wrbuf_puts(w, " </location>\n");
916 static void show_raw_record_error(void *data, const char *addinfo)
918 http_channel_observer_t obs = data;
919 struct http_channel *c = http_channel_observer_chan(obs);
920 struct http_response *rs = c->response;
922 http_remove_observer(obs);
924 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
927 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
929 http_channel_observer_t obs = data;
930 struct http_channel *c = http_channel_observer_chan(obs);
931 struct http_response *rs = c->response;
933 http_remove_observer(obs);
935 wrbuf_write(c->wrbuf, buf, sz);
936 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
937 http_send_response(c);
941 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
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 wrbuf_write(c->wrbuf, buf, sz);
950 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
952 rs->content_type = "application/octet-stream";
953 http_send_response(c);
957 void show_raw_reset(void *data, struct http_channel *c, void *data2)
959 //struct client *client = data;
960 //client_show_raw_remove(client, data2);
963 static void cmd_record_ready(void *data);
965 static void show_record(struct http_channel *c, struct http_session *s)
967 struct http_response *rs = c->response;
968 struct http_request *rq = c->request;
969 struct record_cluster *rec, *prev_r, *next_r;
970 struct conf_service *service;
971 const char *idstr = http_argbyname(rq, "id");
972 const char *offsetstr = http_argbyname(rq, "offset");
973 const char *binarystr = http_argbyname(rq, "binary");
974 const char *checksumstr = http_argbyname(rq, "checksum");
978 service = s->psession->service;
981 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
984 wrbuf_rewind(c->wrbuf);
985 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
987 if (session_active_clients(s->psession) == 0)
989 error(rs, PAZPAR2_RECORD_MISSING, idstr);
991 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
992 cmd_record_ready, c, c) != 0)
994 error(rs, PAZPAR2_RECORD_MISSING, idstr);
998 if (offsetstr || checksumstr)
1000 const char *syntax = http_argbyname(rq, "syntax");
1001 const char *esn = http_argbyname(rq, "esn");
1003 struct record*r = rec->records;
1005 const char *nativesyntax = http_argbyname(rq, "nativesyntax");
1007 if (binarystr && *binarystr != '0')
1012 long v = atol(checksumstr);
1013 for (i = 0; r; r = r->next)
1014 if (v == r->checksum)
1017 error(rs, PAZPAR2_RECORD_FAIL, "no record");
1021 int offset = atoi(offsetstr);
1022 for (i = 0; i < offset && r; r = r->next, i++)
1025 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
1029 http_channel_observer_t obs =
1030 http_add_observer(c, r->client, show_raw_reset);
1031 int ret = client_show_raw_begin(r->client, r->position,
1034 show_raw_record_error,
1036 show_raw_record_ok_binary :
1037 show_raw_record_ok),
1042 http_remove_observer(obs);
1043 error(rs, PAZPAR2_NO_SESSION, 0);
1050 response_open_no_status(c, "record");
1051 wrbuf_puts(c->wrbuf, "\n <recid>");
1052 wrbuf_xmlputs(c->wrbuf, rec->recid);
1053 wrbuf_puts(c->wrbuf, "</recid>\n");
1056 wrbuf_puts(c->wrbuf, " <prevrecid>");
1057 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
1058 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
1062 wrbuf_puts(c->wrbuf, " <nextrecid>");
1063 wrbuf_xmlputs(c->wrbuf, next_r->recid);
1064 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
1066 wrbuf_printf(c->wrbuf, " <activeclients>%d</activeclients>\n",
1067 session_active_clients(s->psession));
1068 write_metadata(c->wrbuf, service, rec->metadata, 1, 1);
1069 for (r = rec->records; r; r = r->next)
1070 write_subrecord(r, c->wrbuf, service, 2);
1071 response_close(c, "record");
1073 show_single_stop(s->psession, rec);
1076 static void cmd_record_ready(void *data)
1078 struct http_channel *c = (struct http_channel *) data;
1079 struct http_session *s = locate_session(c);
1082 session_log(s->psession, c->http_sessions->log_level,
1083 "record watch released");
1085 release_session(c,s);
1089 static void cmd_record(struct http_channel *c)
1091 struct http_session *s = locate_session(c);
1094 release_session(c,s);
1099 static void show_records(struct http_channel *c, struct http_session *s, int active)
1101 struct http_request *rq = c->request;
1102 struct http_response *rs = c->response;
1103 struct record_cluster **rl;
1104 struct reclist_sortparms *sp;
1105 const char *start = http_argbyname(rq, "start");
1106 const char *num = http_argbyname(rq, "num");
1107 const char *sort = http_argbyname(rq, "sort");
1108 int version = get_version(rq);
1114 Odr_int approx_hits;
1116 struct conf_service *service = 0;
1120 // We haven't counted clients yet if we're called on a block release
1122 active = session_active_clients(s->psession);
1125 startn = atoi(start);
1129 service = s->psession->service;
1131 sort = service->default_sort;
1133 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1135 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1140 rl = show_range_start(s->psession, sp, startn, &numn, &total,
1141 &total_hits, &approx_hits, show_records_ready, c);
1145 response_open(c, "show");
1146 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
1147 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
1148 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
1150 wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", approx_hits);
1152 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
1153 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
1155 for (i = 0; i < numn; i++)
1159 struct record_cluster *rec = rl[i];
1160 struct conf_service *service = s->psession->service;
1162 wrbuf_puts(c->wrbuf, "<hit>\n");
1163 write_metadata(c->wrbuf, service, rec->metadata, 0, 1);
1164 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
1165 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
1166 wrbuf_printf(c->wrbuf, " <count>%d</count>\n", ccount);
1167 if (strstr(sort, "relevance"))
1169 wrbuf_printf(c->wrbuf, " <relevance>%d</relevance>\n",
1170 rec->relevance_score);
1171 if (service->rank_debug)
1173 wrbuf_printf(c->wrbuf, " <relevance_info>\n");
1174 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain1));
1175 wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain2));
1176 wrbuf_printf(c->wrbuf, " </relevance_info>\n");
1179 wrbuf_puts(c->wrbuf, " <recid>");
1180 wrbuf_xmlputs(c->wrbuf, rec->recid);
1181 wrbuf_puts(c->wrbuf, "</recid>\n");
1182 wrbuf_puts(c->wrbuf, "</hit>\n");
1185 show_range_stop(s->psession, rl);
1187 response_close(c, "show");
1190 static void show_records_ready(void *data)
1192 struct http_channel *c = (struct http_channel *) data;
1193 struct http_session *s = locate_session(c);
1196 session_log(s->psession, c->http_sessions->log_level,
1197 "show watch released");
1198 show_records(c, s, -1);
1201 /* some error message */
1203 release_session(c,s);
1206 static void cmd_show(struct http_channel *c)
1208 struct http_request *rq = c->request;
1209 struct http_response *rs = c->response;
1210 struct http_session *s = locate_session(c);
1211 const char *block = http_argbyname(rq, "block");
1212 const char *sort = http_argbyname(rq, "sort");
1213 const char *block_error = http_argbyname(rq, "report");
1214 struct conf_service *service = 0;
1216 struct reclist_sortparms *sp;
1218 int report_error = 0;
1219 if (block_error && !strcmp("1", block_error)) {
1225 service = s->psession->service;
1227 sort = service->default_sort;
1230 if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
1232 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1233 release_session(c, s);
1236 session_sort(s->psession, sp);
1238 status = session_active_clients(s->psession);
1242 if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0)
1244 // if there is already a watch/block. we do not block this one
1245 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1246 show_records_ready, c, c) == 0)
1248 session_log(s->psession, c->http_sessions->log_level,
1249 "Blocking on command show (preferred targets)");
1250 release_session(c, s);
1255 session_log(s->psession, YLOG_WARN, "Attempt to block"
1256 " multiple times on show (preferred targets) block."
1260 error(rs, PAZPAR2_ALREADY_BLOCKED,
1261 "show (preferred targets)");
1262 release_session(c, s);
1266 session_log(s->psession, YLOG_WARN,
1267 "Ignoring show(preferred) block."
1268 " Returning current result");
1274 // if there is already a watch/block. we do not block this one
1275 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1276 show_records_ready, c, c) != 0)
1278 session_log(s->psession, YLOG_WARN, "Attempt to block"
1279 " multiple times on show block. Not supported!");
1282 error(rs, PAZPAR2_ALREADY_BLOCKED, "show");
1283 release_session(c, s);
1287 session_log(s->psession, YLOG_WARN, "Ignoring show block."
1288 " Returning current result");
1292 session_log(s->psession, c->http_sessions->log_level,
1293 "Blocking on command show");
1294 release_session(c, s);
1299 show_records(c, s, status);
1300 release_session(c, s);
1303 static void cmd_ping(struct http_channel *c)
1305 struct http_session *s = locate_session(c);
1308 response_open(c, "ping");
1309 response_close(c, "ping");
1310 release_session(c, s);
1313 static void cmd_search(struct http_channel *c)
1315 struct http_request *rq = c->request;
1316 struct http_response *rs = c->response;
1317 struct http_session *s = locate_session(c);
1318 const char *query = http_argbyname(rq, "query");
1319 const char *filter = http_argbyname(rq, "filter");
1320 const char *maxrecs = http_argbyname(rq, "maxrecs");
1321 const char *startrecs = http_argbyname(rq, "startrecs");
1322 const char *limit = http_argbyname(rq, "limit");
1323 const char *sort = http_argbyname(rq, "sort");
1324 enum pazpar2_error_code code;
1325 const char *addinfo = 0;
1326 struct reclist_sortparms *sp;
1327 struct conf_service *service = 0;
1334 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1335 release_session(c, s);
1338 if (!yaz_utf8_check(query))
1340 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1341 release_session(c, s);
1344 service = s->psession->service;
1346 sort = service->default_sort;
1348 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1350 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1351 release_session(c, s);
1355 code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
1359 error(rs, code, addinfo);
1360 release_session(c, s);
1363 response_open(c, "search");
1364 response_close(c, "search");
1365 release_session(c, s);
1369 static void cmd_stat(struct http_channel *c)
1371 struct http_session *s = locate_session(c);
1372 struct statistics stat;
1380 clients = session_active_clients(s->psession);
1381 statistics(s->psession, &stat);
1383 if (stat.num_clients > 0)
1385 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1388 response_open_no_status(c, "stat");
1389 wrbuf_printf(c->wrbuf, "\n <activeclients>%d</activeclients>\n", clients);
1390 wrbuf_printf(c->wrbuf, " <hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1391 wrbuf_printf(c->wrbuf, " <records>%d</records>\n", stat.num_records);
1392 wrbuf_printf(c->wrbuf, " <clients>%d</clients>\n", stat.num_clients);
1393 wrbuf_printf(c->wrbuf, " <unconnected>%d</unconnected>\n", stat.num_no_connection);
1394 wrbuf_printf(c->wrbuf, " <connecting>%d</connecting>\n", stat.num_connecting);
1395 wrbuf_printf(c->wrbuf, " <working>%d</working>\n", stat.num_working);
1396 wrbuf_printf(c->wrbuf, " <idle>%d</idle>\n", stat.num_idle);
1397 wrbuf_printf(c->wrbuf, " <failed>%d</failed>\n", stat.num_failed);
1398 wrbuf_printf(c->wrbuf, " <error>%d</error>\n", stat.num_error);
1399 wrbuf_printf(c->wrbuf, " <progress>%.2f</progress>\n", progress);
1400 response_close(c, "stat");
1401 release_session(c, s);
1404 static void cmd_info(struct http_channel *c)
1406 char yaz_version_str[20];
1407 char yaz_sha1_str[42];
1409 response_open_no_status(c, "info");
1410 wrbuf_puts(c->wrbuf, "\n <version>\n");
1411 wrbuf_puts(c->wrbuf, " <pazpar2");
1412 #ifdef PAZPAR2_VERSION_SHA1
1413 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1415 wrbuf_puts(c->wrbuf, ">");
1416 wrbuf_xmlputs(c->wrbuf, VERSION);
1417 wrbuf_puts(c->wrbuf, "</pazpar2>\n");
1419 yaz_version(yaz_version_str, yaz_sha1_str);
1420 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1421 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1422 wrbuf_puts(c->wrbuf, "\" sha1=\"");
1423 wrbuf_xmlputs(c->wrbuf, yaz_sha1_str);
1424 wrbuf_puts(c->wrbuf, "\">");
1425 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1426 wrbuf_puts(c->wrbuf, "</yaz>\n");
1428 wrbuf_puts(c->wrbuf, " </version>\n");
1431 char hostname_str[64];
1432 if (gethostname(hostname_str, sizeof(hostname_str)) == 0)
1434 wrbuf_puts(c->wrbuf, " <host>");
1435 wrbuf_xmlputs(c->wrbuf, hostname_str);
1436 wrbuf_puts(c->wrbuf, "</host>\n");
1440 info_services(c->server, c->wrbuf);
1442 response_close(c, "info");
1447 void (*fun)(struct http_channel *c);
1449 { "init", cmd_init },
1450 { "settings", cmd_settings },
1451 { "stat", cmd_stat },
1452 { "bytarget", cmd_bytarget },
1453 { "show", cmd_show },
1454 { "search", cmd_search },
1455 { "termlist", cmd_termlist },
1456 { "exit", cmd_exit },
1457 { "session-status", cmd_session_status },
1458 { "server-status", cmd_server_status },
1459 { "ping", cmd_ping },
1460 { "record", cmd_record },
1461 { "info", cmd_info },
1465 void http_command(struct http_channel *c)
1467 const char *command = http_argbyname(c->request, "command");
1468 struct http_response *rs = http_create_response(c);
1473 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1474 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1478 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1481 for (i = 0; commands[i].name; i++)
1482 if (!strcmp(commands[i].name, command))
1484 (*commands[i].fun)(c);
1487 if (!commands[i].name)
1488 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1496 * c-file-style: "Stroustrup"
1497 * indent-tabs-mode: nil
1499 * vim: shiftwidth=4 tabstop=8 expandtab