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 http_session_use(int delta)
99 if (!g_http_session_mutex)
100 yaz_mutex_create(&g_http_session_mutex);
101 yaz_mutex_enter(g_http_session_mutex);
102 g_http_sessions += delta;
103 sessions = g_http_sessions;
104 yaz_mutex_leave(g_http_session_mutex);
105 yaz_log(YLOG_DEBUG, "%s sessions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), sessions);
110 http_sessions_t http_sessions_create(void)
112 http_sessions_t hs = xmalloc(sizeof(*hs));
113 hs->session_list = 0;
115 pazpar2_mutex_create(&hs->mutex, "http_sessions");
116 hs->log_level = yaz_log_module_level("HTTP");
120 void http_sessions_destroy(http_sessions_t hs)
124 struct http_session *s = hs->session_list;
127 struct http_session *s_next = s->next;
128 iochan_destroy(s->timeout_iochan);
129 session_destroy(s->psession);
130 nmem_destroy(s->nmem);
133 yaz_mutex_destroy(&hs->mutex);
138 void http_session_destroy(struct http_session *s);
140 static void session_timeout(IOCHAN i, int event)
142 struct http_session *s = iochan_getdata(i);
143 http_session_destroy(s);
146 struct http_session *http_session_create(struct conf_service *service,
147 http_sessions_t http_sessions,
150 NMEM nmem = nmem_create();
151 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
154 sprintf(tmp_str, "session#%u", sesid);
155 r->psession = new_session(nmem, service, sesid);
156 r->session_id = sesid;
159 r->destroy_counter = r->activity_counter = 0;
160 r->http_sessions = http_sessions;
162 yaz_mutex_enter(http_sessions->mutex);
163 r->next = http_sessions->session_list;
164 http_sessions->session_list = r;
165 yaz_mutex_leave(http_sessions->mutex);
167 r->timeout_iochan = iochan_create(-1, session_timeout, 0, "http_session_timeout");
168 iochan_setdata(r->timeout_iochan, r);
169 yaz_log(http_sessions->log_level, "Session %u created. timeout chan=%p timeout=%d", sesid, r->timeout_iochan, service->session_timeout);
170 iochan_settimeout(r->timeout_iochan, service->session_timeout);
172 iochan_add(service->server->iochan_man, r->timeout_iochan);
177 void http_session_destroy(struct http_session *s)
179 int must_destroy = 0;
181 http_sessions_t http_sessions = s->http_sessions;
183 yaz_log(http_sessions->log_level, "Session %u destroy", s->session_id);
184 yaz_mutex_enter(http_sessions->mutex);
185 /* only if http_session has no active http sessions on it can be destroyed */
186 if (s->destroy_counter == s->activity_counter)
188 struct http_session **p = 0;
190 for (p = &http_sessions->session_list; *p; p = &(*p)->next)
197 yaz_mutex_leave(http_sessions->mutex);
199 { /* destroying for real */
200 yaz_log(http_sessions->log_level, "Session %u destroyed", s->session_id);
201 iochan_destroy(s->timeout_iochan);
202 session_destroy(s->psession);
203 http_session_use(-1);
204 nmem_destroy(s->nmem);
207 yaz_log(http_sessions->log_level, "Session %u destroying delayed. Active clients (%d-%d). Waiting for new timeout.",
208 s->session_id, s->activity_counter, s->destroy_counter);
213 static const char *get_msg(enum pazpar2_error_code code)
215 struct pazpar2_error_msg {
216 enum pazpar2_error_code code;
219 static const struct pazpar2_error_msg ar[] = {
220 { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
221 { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
222 { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
223 { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
224 { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
225 { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
226 { PAZPAR2_RECORD_MISSING, "Record missing"},
227 { PAZPAR2_NO_TARGETS, "No targets"},
228 { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
229 { PAZPAR2_RECORD_FAIL, "Record command failed"},
230 { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
231 { PAZPAR2_NO_SERVICE, "No service"},
232 { PAZPAR2_ALREADY_BLOCKED, "Already blocked in session on: "},
233 { PAZPAR2_LAST_ERROR, "Last error"},
239 if (code == ar[i].code)
246 static void error(struct http_response *rs,
247 enum pazpar2_error_code code,
250 struct http_channel *c = rs->channel;
251 WRBUF text = wrbuf_alloc();
252 const char *http_status = "417";
253 const char *msg = get_msg(code);
255 rs->msg = nmem_strdup(c->nmem, msg);
256 strcpy(rs->code, http_status);
258 wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX "<error code=\"%d\" msg=\"%s\">", (int) code,
261 wrbuf_xmlputs(text, addinfo);
262 wrbuf_puts(text, "</error>");
264 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
265 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
266 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
268 http_send_response(c);
271 static void response_open_no_status(struct http_channel *c, const char *command)
273 wrbuf_rewind(c->wrbuf);
274 wrbuf_printf(c->wrbuf, "%s<%s>",
275 HTTP_COMMAND_RESPONSE_PREFIX, command);
278 static void response_open(struct http_channel *c, const char *command)
280 response_open_no_status(c, command);
281 wrbuf_puts(c->wrbuf, "<status>OK</status>");
284 static void response_close(struct http_channel *c, const char *command)
286 struct http_response *rs = c->response;
288 wrbuf_printf(c->wrbuf, "</%s>", command);
289 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
290 http_send_response(c);
293 unsigned int make_sessionid(void)
295 static int seq = 0; /* thread pr */
299 if (global_parameters.predictable_sessions)
308 if (gettimeofday(&t, 0) < 0)
310 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
313 /* at most 256 sessions per second ..
314 (long long would be more appropriate)*/
316 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
322 static struct http_session *locate_session(struct http_channel *c)
324 struct http_request *rq = c->request;
325 struct http_response *rs = c->response;
326 struct http_session *p;
327 const char *session = http_argbyname(rq, "session");
328 http_sessions_t http_sessions = c->http_sessions;
333 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
337 yaz_mutex_enter(http_sessions->mutex);
338 for (p = http_sessions->session_list; p; p = p->next)
339 if (id == p->session_id)
342 p->activity_counter++;
343 yaz_mutex_leave(http_sessions->mutex);
345 iochan_activity(p->timeout_iochan);
347 error(rs, PAZPAR2_NO_SESSION, session);
351 // Call after use of locate_session, in order to increment the destroy_counter
352 static void release_session(struct http_channel *c,
353 struct http_session *session)
355 http_sessions_t http_sessions = c->http_sessions;
356 yaz_mutex_enter(http_sessions->mutex);
358 session->destroy_counter++;
359 yaz_mutex_leave(http_sessions->mutex);
362 // Decode settings parameters and apply to session
363 // Syntax: setting[target]=value
364 static int process_settings(struct session *se, struct http_request *rq,
365 struct http_response *rs)
367 struct http_argument *a;
369 for (a = rq->arguments; a; a = a->next)
370 if (strchr(a->name, '['))
377 // Nmem_strsplit *rules*!!!
378 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
381 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
386 session_apply_setting(se, dbname, setting,
387 nmem_strdup(se->session_nmem, a->value));
392 static void cmd_exit(struct http_channel *c)
394 yaz_log(YLOG_WARN, "exit");
396 response_open(c, "exit");
397 response_close(c, "exit");
398 http_close_server(c->server);
401 static void cmd_init(struct http_channel *c)
403 struct http_request *r = c->request;
404 const char *clear = http_argbyname(r, "clear");
405 const char *content_type = http_lookup_header(r->headers, "Content-Type");
407 struct http_session *s;
408 struct http_response *rs = c->response;
409 struct conf_service *service = 0; /* no service (yet) */
411 if (r->content_len && content_type &&
412 !yaz_strcmp_del("text/xml", content_type, "; "))
414 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
418 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
421 root_n = xmlDocGetRootElement(doc);
422 service = service_create(c->server, root_n);
426 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
433 const char *service_name = http_argbyname(c->request, "service");
434 service = locate_service(c->server, service_name);
437 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
441 sesid = make_sessionid();
442 s = http_session_create(service, c->http_sessions, sesid);
444 yaz_log(c->http_sessions->log_level, "Session init %u ", sesid);
445 if (!clear || *clear == '0')
446 session_init_databases(s->psession);
448 yaz_log(YLOG_LOG, "Session %u init: No databases preloaded", sesid);
450 if (process_settings(s->psession, c->request, c->response) < 0)
453 response_open(c, "init");
454 wrbuf_printf(c->wrbuf, "<session>%d", sesid);
455 if (c->server->server_id)
457 wrbuf_puts(c->wrbuf, ".");
458 wrbuf_puts(c->wrbuf, c->server->server_id);
460 wrbuf_puts(c->wrbuf, "</session>"
461 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol>");
463 response_close(c, "init");
466 static void apply_local_setting(void *client_data,
469 struct session *se = (struct session *) client_data;
471 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
472 nmem_strdup(se->session_nmem, set->name),
473 nmem_strdup(se->session_nmem, set->value));
476 static void cmd_settings(struct http_channel *c)
478 struct http_response *rs = c->response;
479 struct http_request *rq = c->request;
480 struct http_session *s = locate_session(c);
481 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
486 if (rq->content_len && content_type &&
487 !yaz_strcmp_del("text/xml", content_type, "; "))
489 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
493 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
494 release_session(c,s);
497 root_n = xmlDocGetRootElement(doc);
499 settings_read_node_x(root_n, s->psession, apply_local_setting);
503 if (process_settings(s->psession, rq, rs) < 0)
505 release_session(c, s);
508 response_open(c, "settings");
509 response_close(c, "settings");
510 release_session(c, s);
513 static void termlist_response(struct http_channel *c, struct http_session *s, const char *cmd_status)
515 struct http_request *rq = c->request;
516 const char *name = http_argbyname(rq, "name");
517 const char *nums = http_argbyname(rq, "num");
524 status = session_active_clients(s->psession);
526 response_open_no_status(c, "termlist");
527 /* new protocol add a status to response. Triggered by a status parameter */
528 if (cmd_status != 0) {
529 wrbuf_printf(c->wrbuf, "<status>%s</status>\n", cmd_status);
531 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
533 perform_termlist(c, s->psession, name, num);
535 response_close(c, "termlist");
538 static void termlist_result_ready(void *data)
540 struct http_channel *c = (struct http_channel *) data;
541 struct http_request *rq = c->request;
542 const char *report = http_argbyname(rq, "report");
543 const char *status = 0;
544 if (report && !strcmp("status", report))
546 struct http_session *s = locate_session(c);
548 yaz_log(c->http_sessions->log_level, "Session %u termlist watch released", s->session_id);
549 termlist_response(c, s, status);
550 release_session(c,s);
554 static void cmd_termlist(struct http_channel *c)
556 struct http_request *rq = c->request;
557 struct http_response *rs = c->response;
558 struct http_session *s = locate_session(c);
559 const char *block = http_argbyname(rq, "block");
560 const char *report = http_argbyname(rq, "report");
561 int report_status = 0;
562 int report_error = 0;
563 const char *status_message = 0;
565 if (report && !strcmp("error", report)) {
567 status_message = "OK";
569 if (report && !strcmp("status", report)) {
571 status_message = "OK";
576 active_clients = session_active_clients(s->psession);
577 if (block && !strcmp("1", block) && active_clients)
579 // if there is already a watch/block. we do not block this one
580 if (session_set_watch(s->psession, SESSION_WATCH_TERMLIST,
581 termlist_result_ready, c, c) != 0)
583 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on termlist block. Not supported!", s->session_id);
585 error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
586 release_session(c, s);
590 status_message = "WARNING (Already blocked on termlist)";
595 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command termlist", s->session_id);
596 release_session(c, s);
601 termlist_response(c, s, status_message);
602 release_session(c, s);
605 size_t session_get_memory_status(struct session *session);
607 static void session_status(struct http_channel *c, struct http_session *s)
610 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
611 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
612 session_nmem = session_get_memory_status(s->psession);
613 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
616 static void cmd_session_status(struct http_channel *c)
618 struct http_session *s = locate_session(c);
622 response_open(c, "session-status");
623 session_status(c, s);
624 response_close(c, "session-status");
625 release_session(c, s);
628 int sessions_count(void);
629 int clients_count(void);
630 #ifdef HAVE_RESULTSETS_COUNT
631 int resultsets_count(void);
633 #define resultsets_count() 0
636 static void cmd_server_status(struct http_channel *c)
638 int sessions = sessions_count();
639 int clients = clients_count();
640 int resultsets = resultsets_count();
642 response_open(c, "server-status");
643 wrbuf_printf(c->wrbuf, "\n <sessions>%u</sessions>\n", sessions);
644 wrbuf_printf(c->wrbuf, " <clients>%u</clients>\n", clients);
645 /* Only works if yaz has been compiled with enabling of this */
646 wrbuf_printf(c->wrbuf, " <resultsets>%u</resultsets>\n",resultsets);
647 print_meminfo(c->wrbuf);
649 /* TODO add all sessions status */
650 /* http_sessions_t http_sessions = c->http_sessions; */
651 /* struct http_session *p; */
653 yaz_mutex_enter(http_sessions->mutex);
654 for (p = http_sessions->session_list; p; p = p->next)
656 p->activity_counter++;
657 wrbuf_puts(c->wrbuf, "<session-status>\n");
658 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
659 yaz_mutex_leave(http_sessions->mutex);
660 session_status(c, p);
661 wrbuf_puts(c->wrbuf, "</session-status>\n");
662 yaz_mutex_enter(http_sessions->mutex);
663 p->activity_counter--;
665 yaz_mutex_leave(http_sessions->mutex);
667 response_close(c, "server-status");
671 static void bytarget_response(struct http_channel *c, struct http_session *s, const char *cmd_status) {
673 struct hitsbytarget *ht;
674 struct http_request *rq = c->request;
675 const char *settings = http_argbyname(rq, "settings");
677 ht = get_hitsbytarget(s->psession, &count, c->nmem);
679 /* Old protocol, always ok */
680 response_open(c, "bytarget");
682 /* New protocol, OK or WARNING (...)*/
683 response_open_no_status(c, "bytarget");
684 wrbuf_printf(c->wrbuf, "<status>%s</status>", cmd_status);
688 yaz_log(YLOG_WARN, "Empty bytarget Response. No targets found!");
689 for (i = 0; i < count; i++)
691 wrbuf_puts(c->wrbuf, "\n<target>");
693 wrbuf_puts(c->wrbuf, "<id>");
694 wrbuf_xmlputs(c->wrbuf, ht[i].id);
695 wrbuf_puts(c->wrbuf, "</id>\n");
697 if (ht[i].name && ht[i].name[0])
699 wrbuf_puts(c->wrbuf, "<name>");
700 wrbuf_xmlputs(c->wrbuf, ht[i].name);
701 wrbuf_puts(c->wrbuf, "</name>\n");
704 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
705 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
706 if (ht[i].diagnostic)
708 wrbuf_puts(c->wrbuf, "<addinfo>");
710 wrbuf_xmlputs(c->wrbuf, ht[i].addinfo);
711 wrbuf_puts(c->wrbuf, "</addinfo>\n");
714 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
716 wrbuf_puts(c->wrbuf, "<state>");
717 wrbuf_xmlputs(c->wrbuf, ht[i].state);
718 wrbuf_puts(c->wrbuf, "</state>\n");
719 if (settings && *settings == '1')
721 wrbuf_puts(c->wrbuf, "<settings>\n");
722 wrbuf_puts(c->wrbuf, ht[i].settings_xml);
723 wrbuf_puts(c->wrbuf, "</settings>\n");
725 if (ht[i].suggestions_xml && ht[i].suggestions_xml[0]) {
726 wrbuf_puts(c->wrbuf, "<suggestions>");
727 wrbuf_puts(c->wrbuf, ht[i].suggestions_xml);
728 wrbuf_puts(c->wrbuf, "</suggestions>");
730 wrbuf_puts(c->wrbuf, "</target>");
732 response_close(c, "bytarget");
735 static void bytarget_result_ready(void *data)
737 struct http_channel *c = (struct http_channel *) data;
738 struct http_session *s = locate_session(c);
739 const char *status_message = "OK";
741 yaz_log(c->http_sessions->log_level, "Session %u: bytarget watch released", s->session_id);
742 bytarget_response(c, s, status_message);
743 release_session(c, s);
746 yaz_log(c->http_sessions->log_level, "No Session found for released bytarget watch");
751 static void cmd_bytarget(struct http_channel *c)
753 struct http_request *rq = c->request;
754 struct http_response *rs = c->response;
755 struct http_session *s = locate_session(c);
756 const char *block = http_argbyname(rq, "block");
757 const char *report = http_argbyname(rq, "report");
759 int report_status = 0;
760 const char *status_message = "OK";
761 if (report && !strcmp("error", report)) {
764 if (report && !strcmp("status", report)) {
773 no_active = session_active_clients(s->psession);
774 if (block && !strcmp("1",block) && no_active)
776 // if there is already a watch/block. we do not block this one
777 if (session_set_watch(s->psession, SESSION_WATCH_BYTARGET,
778 bytarget_result_ready, c, c) != 0)
780 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on bytarget block. Not supported!", s->session_id);
782 error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget");
783 release_session(c, s);
787 status_message = "WARNING (Already blocked on bytarget)";
792 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command bytarget", s->session_id);
793 release_session(c, s);
797 bytarget_response(c, s, status_message);
798 release_session(c, s);
801 static void write_metadata(WRBUF w, struct conf_service *service,
802 struct record_metadata **ml, int full)
806 for (imeta = 0; imeta < service->num_metadata; imeta++)
808 struct conf_metadata *cmd = &service->metadata[imeta];
809 struct record_metadata *md;
810 if (!cmd->brief && !full)
812 for (md = ml[imeta]; md; md = md->next)
814 struct record_metadata_attr *attr = md->attributes;
815 wrbuf_printf(w, "\n<md-%s", cmd->name);
817 for (; attr; attr = attr->next)
819 wrbuf_printf(w, " %s=\"", attr->name);
820 wrbuf_xmlputs(w, attr->value);
826 case Metadata_type_generic:
827 wrbuf_xmlputs(w, md->data.text.disp);
829 case Metadata_type_year:
830 wrbuf_printf(w, "%d", md->data.number.min);
831 if (md->data.number.min != md->data.number.max)
832 wrbuf_printf(w, "-%d", md->data.number.max);
835 wrbuf_puts(w, "[can't represent]");
838 wrbuf_printf(w, "</md-%s>", cmd->name);
843 static void write_subrecord(struct record *r, WRBUF w,
844 struct conf_service *service, int show_details)
846 const char *name = session_setting_oneval(
847 client_get_database(r->client), PZ_NAME);
849 wrbuf_puts(w, "<location id=\"");
850 wrbuf_xmlputs(w, client_get_id(r->client));
851 wrbuf_puts(w, "\" ");
853 wrbuf_puts(w, "name=\"");
854 wrbuf_xmlputs(w, *name ? name : "Unknown");
855 wrbuf_puts(w, "\">");
857 write_metadata(w, service, r->metadata, show_details);
858 wrbuf_puts(w, "</location>\n");
861 static void show_raw_record_error(void *data, const char *addinfo)
863 http_channel_observer_t obs = data;
864 struct http_channel *c = http_channel_observer_chan(obs);
865 struct http_response *rs = c->response;
867 http_remove_observer(obs);
869 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
872 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
874 http_channel_observer_t obs = data;
875 struct http_channel *c = http_channel_observer_chan(obs);
876 struct http_response *rs = c->response;
878 http_remove_observer(obs);
880 wrbuf_write(c->wrbuf, buf, sz);
881 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
882 http_send_response(c);
886 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
888 http_channel_observer_t obs = data;
889 struct http_channel *c = http_channel_observer_chan(obs);
890 struct http_response *rs = c->response;
892 http_remove_observer(obs);
894 wrbuf_write(c->wrbuf, buf, sz);
895 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
897 rs->content_type = "application/octet-stream";
898 http_send_response(c);
902 void show_raw_reset(void *data, struct http_channel *c, void *data2)
904 //struct client *client = data;
905 //client_show_raw_remove(client, data2);
908 static void cmd_record_ready(void *data);
910 static void show_record(struct http_channel *c, struct http_session *s)
912 struct http_response *rs = c->response;
913 struct http_request *rq = c->request;
914 struct record_cluster *rec, *prev_r, *next_r;
916 struct conf_service *service;
917 const char *idstr = http_argbyname(rq, "id");
918 const char *offsetstr = http_argbyname(rq, "offset");
919 const char *binarystr = http_argbyname(rq, "binary");
923 service = s->psession->service;
926 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
929 wrbuf_rewind(c->wrbuf);
930 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
932 if (session_active_clients(s->psession) == 0)
934 error(rs, PAZPAR2_RECORD_MISSING, idstr);
936 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
937 cmd_record_ready, c, c) != 0)
939 error(rs, PAZPAR2_RECORD_MISSING, idstr);
945 int offset = atoi(offsetstr);
946 const char *syntax = http_argbyname(rq, "syntax");
947 const char *esn = http_argbyname(rq, "esn");
949 struct record*r = rec->records;
951 const char *nativesyntax = http_argbyname(rq, "nativesyntax");
953 if (binarystr && *binarystr != '0')
956 for (i = 0; i < offset && r; r = r->next, i++)
960 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
964 http_channel_observer_t obs =
965 http_add_observer(c, r->client, show_raw_reset);
966 int ret = client_show_raw_begin(r->client, r->position,
969 show_raw_record_error,
971 show_raw_record_ok_binary :
977 http_remove_observer(obs);
978 error(rs, PAZPAR2_NO_SESSION, 0);
984 response_open_no_status(c, "record");
985 wrbuf_puts(c->wrbuf, "\n<recid>");
986 wrbuf_xmlputs(c->wrbuf, rec->recid);
987 wrbuf_puts(c->wrbuf, "</recid>\n");
990 wrbuf_puts(c->wrbuf, "<prevrecid>");
991 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
992 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
996 wrbuf_puts(c->wrbuf, "<nextrecid>");
997 wrbuf_xmlputs(c->wrbuf, next_r->recid);
998 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
1000 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n",
1001 session_active_clients(s->psession));
1002 write_metadata(c->wrbuf, service, rec->metadata, 1);
1003 for (r = rec->records; r; r = r->next)
1004 write_subrecord(r, c->wrbuf, service, 1);
1005 response_close(c, "record");
1007 show_single_stop(s->psession, rec);
1010 static void cmd_record_ready(void *data)
1012 struct http_channel *c = (struct http_channel *) data;
1013 struct http_session *s = locate_session(c);
1015 yaz_log(c->http_sessions->log_level, "Session %u: record watch released", s->session_id);
1017 release_session(c,s);
1021 static void cmd_record(struct http_channel *c)
1023 struct http_session *s = locate_session(c);
1026 release_session(c,s);
1031 static void show_records(struct http_channel *c, struct http_session *s, int active)
1033 struct http_request *rq = c->request;
1034 struct http_response *rs = c->response;
1035 struct record_cluster **rl;
1036 struct reclist_sortparms *sp;
1037 const char *start = http_argbyname(rq, "start");
1038 const char *num = http_argbyname(rq, "num");
1039 const char *sort = http_argbyname(rq, "sort");
1049 // We haven't counted clients yet if we're called on a block release
1051 active = session_active_clients(s->psession);
1054 startn = atoi(start);
1059 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1061 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1066 rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits);
1068 response_open(c, "show");
1069 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
1070 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
1071 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
1072 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
1073 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
1075 for (i = 0; i < numn; i++)
1079 struct record_cluster *rec = rl[i];
1080 struct conf_service *service = s->psession->service;
1082 wrbuf_puts(c->wrbuf, "<hit>\n");
1083 write_metadata(c->wrbuf, service, rec->metadata, 0);
1084 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
1085 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
1087 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
1088 if (strstr(sort, "relevance"))
1089 wrbuf_printf(c->wrbuf, "<relevance>%d</relevance>\n",
1090 rec->relevance_score);
1091 wrbuf_puts(c->wrbuf, "<recid>");
1092 wrbuf_xmlputs(c->wrbuf, rec->recid);
1093 wrbuf_puts(c->wrbuf, "</recid>\n");
1094 wrbuf_puts(c->wrbuf, "</hit>\n");
1097 show_range_stop(s->psession, rl);
1099 response_close(c, "show");
1102 static void show_records_ready(void *data)
1104 struct http_channel *c = (struct http_channel *) data;
1105 struct http_session *s = locate_session(c);
1107 yaz_log(c->http_sessions->log_level, "Session %u: show watch released", s->session_id);
1108 show_records(c, s, -1);
1111 /* some error message */
1113 release_session(c,s);
1116 static void cmd_show(struct http_channel *c)
1118 struct http_request *rq = c->request;
1119 struct http_response *rs = c->response;
1120 struct http_session *s = locate_session(c);
1121 const char *block = http_argbyname(rq, "block");
1122 const char *sort = http_argbyname(rq, "sort");
1123 const char *block_error = http_argbyname(rq, "error");
1124 struct reclist_sortparms *sp;
1133 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1135 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1136 release_session(c, s);
1139 session_sort(s->psession, sp->name, sp->increasing);
1141 status = session_active_clients(s->psession);
1145 if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0)
1147 // if there is already a watch/block. we do not block this one
1148 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1149 show_records_ready, c, c) == 0)
1151 yaz_log(c->http_sessions->log_level,
1152 "Session %u: Blocking on command show (preferred targets)", s->session_id);
1153 release_session(c, s);
1158 yaz_log(YLOG_WARN, "Attempt to block multiple times on show (preferred targets) block. Not supported!");
1159 if (block_error && !strcmp("1", block_error)) {
1160 error(rs, PAZPAR2_ALREADY_BLOCKED, "show (preferred targets)");
1161 release_session(c, s);
1169 // if there is already a watch/block. we do not block this one
1170 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1171 show_records_ready, c, c) != 0)
1173 yaz_log(YLOG_WARN, "Attempt to block multiple times on show block. Not supported!");
1174 if (block_error && !strcmp("1", block_error)) {
1175 error(rs, PAZPAR2_ALREADY_BLOCKED, "show");
1176 release_session(c, s);
1182 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command show", s->session_id);
1183 release_session(c, s);
1188 show_records(c, s, status);
1189 release_session(c, s);
1192 static void cmd_ping(struct http_channel *c)
1194 struct http_session *s = locate_session(c);
1197 response_open(c, "ping");
1198 response_close(c, "ping");
1199 release_session(c, s);
1202 static void cmd_search(struct http_channel *c)
1204 struct http_request *rq = c->request;
1205 struct http_response *rs = c->response;
1206 struct http_session *s = locate_session(c);
1207 const char *query = http_argbyname(rq, "query");
1208 const char *filter = http_argbyname(rq, "filter");
1209 const char *maxrecs = http_argbyname(rq, "maxrecs");
1210 const char *startrecs = http_argbyname(rq, "startrecs");
1211 const char *limit = http_argbyname(rq, "limit");
1212 enum pazpar2_error_code code;
1213 const char *addinfo = 0;
1219 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1220 release_session(c, s);
1223 if (!yaz_utf8_check(query))
1225 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1226 release_session(c, s);
1229 code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
1230 &addinfo, "relevance", 0);
1233 error(rs, code, addinfo);
1234 release_session(c, s);
1237 response_open(c, "search");
1238 response_close(c, "search");
1239 release_session(c, s);
1243 static void cmd_stat(struct http_channel *c)
1245 struct http_session *s = locate_session(c);
1246 struct statistics stat;
1254 clients = session_active_clients(s->psession);
1255 statistics(s->psession, &stat);
1257 if (stat.num_clients > 0)
1259 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1262 response_open_no_status(c, "stat");
1263 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
1264 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1265 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
1266 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
1267 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
1268 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
1269 wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
1270 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
1271 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
1272 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
1273 wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
1274 response_close(c, "stat");
1275 release_session(c, s);
1278 static void cmd_info(struct http_channel *c)
1280 char yaz_version_str[20];
1282 response_open_no_status(c, "info");
1283 wrbuf_puts(c->wrbuf, " <version>\n");
1284 wrbuf_puts(c->wrbuf, " <pazpar2");
1285 #ifdef PAZPAR2_VERSION_SHA1
1286 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1288 wrbuf_puts(c->wrbuf, ">");
1289 wrbuf_xmlputs(c->wrbuf, VERSION);
1290 wrbuf_puts(c->wrbuf, "</pazpar2>");
1292 yaz_version(yaz_version_str, 0);
1293 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1294 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1295 wrbuf_puts(c->wrbuf, "\">");
1296 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1297 wrbuf_puts(c->wrbuf, "</yaz>\n");
1299 wrbuf_puts(c->wrbuf, " </version>\n");
1301 info_services(c->server, c->wrbuf);
1303 response_close(c, "info");
1308 void (*fun)(struct http_channel *c);
1310 { "init", cmd_init },
1311 { "settings", cmd_settings },
1312 { "stat", cmd_stat },
1313 { "bytarget", cmd_bytarget },
1314 { "show", cmd_show },
1315 { "search", cmd_search },
1316 { "termlist", cmd_termlist },
1317 { "exit", cmd_exit },
1318 { "session-status", cmd_session_status },
1319 { "server-status", cmd_server_status },
1320 { "ping", cmd_ping },
1321 { "record", cmd_record },
1322 { "info", cmd_info },
1326 void http_command(struct http_channel *c)
1328 const char *command = http_argbyname(c->request, "command");
1329 struct http_response *rs = http_create_response(c);
1334 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1335 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1339 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1342 for (i = 0; commands[i].name; i++)
1343 if (!strcmp(commands[i].name, command))
1345 (*commands[i].fun)(c);
1348 if (!commands[i].name)
1349 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1357 * c-file-style: "Stroustrup"
1358 * indent-tabs-mode: nil
1360 * vim: shiftwidth=4 tabstop=8 expandtab