1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2011 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)
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 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
529 perform_termlist(c, s->psession, name, num);
531 response_close(c, "termlist");
534 static void termlist_result_ready(void *data)
536 struct http_channel *c = (struct http_channel *) data;
537 struct http_session *s = locate_session(c);
539 yaz_log(c->http_sessions->log_level, "Session %u termlist watch released", s->session_id);
540 termlist_response(c, s);
541 release_session(c,s);
545 static void cmd_termlist(struct http_channel *c)
547 struct http_request *rq = c->request;
548 struct http_response *rs = c->response;
549 struct http_session *s = locate_session(c);
550 const char *block = http_argbyname(rq, "block");
555 active_clients = session_active_clients(s->psession);
557 if (block && !strcmp("1", block) && active_clients)
559 // if there is already a watch/block. we do not block this one
560 if (session_set_watch(s->psession, SESSION_WATCH_TERMLIST,
561 termlist_result_ready, c, c) != 0)
563 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on termlist block. Not supported!", s->session_id);
564 error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
568 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command termlist", s->session_id);
570 release_session(c, s);
574 termlist_response(c, s);
575 release_session(c, s);
578 size_t session_get_memory_status(struct session *session);
580 static void session_status(struct http_channel *c, struct http_session *s)
583 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
584 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
585 session_nmem = session_get_memory_status(s->psession);
586 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
589 static void cmd_session_status(struct http_channel *c)
591 struct http_session *s = locate_session(c);
595 response_open(c, "session-status");
596 session_status(c, s);
597 response_close(c, "session-status");
598 release_session(c, s);
601 int sessions_count(void);
602 int clients_count(void);
603 #ifdef HAVE_RESULTSETS_COUNT
604 int resultsets_count(void);
606 #define resultsets_count() 0
609 static void cmd_server_status(struct http_channel *c)
611 int sessions = sessions_count();
612 int clients = clients_count();
613 int resultsets = resultsets_count();
615 response_open(c, "server-status");
616 wrbuf_printf(c->wrbuf, "\n <sessions>%u</sessions>\n", sessions);
617 wrbuf_printf(c->wrbuf, " <clients>%u</clients>\n", clients);
618 /* Only works if yaz has been compiled with enabling of this */
619 wrbuf_printf(c->wrbuf, " <resultsets>%u</resultsets>\n",resultsets);
620 print_meminfo(c->wrbuf);
622 /* TODO add all sessions status */
623 /* http_sessions_t http_sessions = c->http_sessions; */
624 /* struct http_session *p; */
626 yaz_mutex_enter(http_sessions->mutex);
627 for (p = http_sessions->session_list; p; p = p->next)
629 p->activity_counter++;
630 wrbuf_puts(c->wrbuf, "<session-status>\n");
631 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
632 yaz_mutex_leave(http_sessions->mutex);
633 session_status(c, p);
634 wrbuf_puts(c->wrbuf, "</session-status>\n");
635 yaz_mutex_enter(http_sessions->mutex);
636 p->activity_counter--;
638 yaz_mutex_leave(http_sessions->mutex);
640 response_close(c, "server-status");
644 static void bytarget_response(struct http_channel *c, struct http_session *s) {
646 struct hitsbytarget *ht;
647 struct http_request *rq = c->request;
648 const char *settings = http_argbyname(rq, "settings");
650 ht = get_hitsbytarget(s->psession, &count, c->nmem);
651 response_open(c, "bytarget");
653 yaz_log(YLOG_WARN, "Empty bytarget Response. No targets found!");
654 for (i = 0; i < count; i++)
656 wrbuf_puts(c->wrbuf, "\n<target>");
658 wrbuf_puts(c->wrbuf, "<id>");
659 wrbuf_xmlputs(c->wrbuf, ht[i].id);
660 wrbuf_puts(c->wrbuf, "</id>\n");
662 if (ht[i].name && ht[i].name[0])
664 wrbuf_puts(c->wrbuf, "<name>");
665 wrbuf_xmlputs(c->wrbuf, ht[i].name);
666 wrbuf_puts(c->wrbuf, "</name>\n");
669 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
670 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
671 if (ht[i].diagnostic)
673 wrbuf_puts(c->wrbuf, "<addinfo>");
675 wrbuf_xmlputs(c->wrbuf, ht[i].addinfo);
676 wrbuf_puts(c->wrbuf, "</addinfo>\n");
679 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
681 wrbuf_puts(c->wrbuf, "<state>");
682 wrbuf_xmlputs(c->wrbuf, ht[i].state);
683 wrbuf_puts(c->wrbuf, "</state>\n");
684 if (settings && *settings == '1')
686 wrbuf_puts(c->wrbuf, "<settings>\n");
687 wrbuf_puts(c->wrbuf, ht[i].settings_xml);
688 wrbuf_puts(c->wrbuf, "</settings>\n");
690 if (ht[i].suggestions_xml && ht[i].suggestions_xml[0]) {
691 wrbuf_puts(c->wrbuf, "<suggestions>");
692 wrbuf_puts(c->wrbuf, ht[i].suggestions_xml);
693 wrbuf_puts(c->wrbuf, "</suggestions>");
695 wrbuf_puts(c->wrbuf, "</target>");
697 response_close(c, "bytarget");
700 static void bytarget_result_ready(void *data)
702 struct http_channel *c = (struct http_channel *) data;
703 struct http_session *s = locate_session(c);
705 yaz_log(c->http_sessions->log_level, "Session %u: bytarget watch released", s->session_id);
706 bytarget_response(c, s);
707 release_session(c, s);
710 yaz_log(c->http_sessions->log_level, "No Session found for released bytarget watch");
715 static void cmd_bytarget(struct http_channel *c)
717 struct http_request *rq = c->request;
718 struct http_response *rs = c->response;
719 struct http_session *s = locate_session(c);
720 const char *block = http_argbyname(rq, "block");
726 no_active = session_active_clients(s->psession);
728 if (block && !strcmp("1",block) && no_active)
730 // if there is already a watch/block. we do not block this one
731 if (session_set_watch(s->psession, SESSION_WATCH_BYTARGET,
732 bytarget_result_ready, c, c) != 0)
734 yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on bytarget block. Not supported!", s->session_id);
735 error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget");
739 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command bytarget", s->session_id);
741 release_session(c, s);
744 bytarget_response(c, s);
745 release_session(c, s);
748 static void write_metadata(WRBUF w, struct conf_service *service,
749 struct record_metadata **ml, int full)
753 for (imeta = 0; imeta < service->num_metadata; imeta++)
755 struct conf_metadata *cmd = &service->metadata[imeta];
756 struct record_metadata *md;
757 if (!cmd->brief && !full)
759 for (md = ml[imeta]; md; md = md->next)
761 struct record_metadata_attr *attr = md->attributes;
762 wrbuf_printf(w, "\n<md-%s", cmd->name);
764 for (; attr; attr = attr->next)
766 wrbuf_printf(w, " %s=\"", attr->name);
767 wrbuf_xmlputs(w, attr->value);
773 case Metadata_type_generic:
774 wrbuf_xmlputs(w, md->data.text.disp);
776 case Metadata_type_year:
777 wrbuf_printf(w, "%d", md->data.number.min);
778 if (md->data.number.min != md->data.number.max)
779 wrbuf_printf(w, "-%d", md->data.number.max);
782 wrbuf_puts(w, "[can't represent]");
785 wrbuf_printf(w, "</md-%s>", cmd->name);
790 static void write_subrecord(struct record *r, WRBUF w,
791 struct conf_service *service, int show_details)
793 const char *name = session_setting_oneval(
794 client_get_database(r->client), PZ_NAME);
796 wrbuf_puts(w, "<location id=\"");
797 wrbuf_xmlputs(w, client_get_id(r->client));
798 wrbuf_puts(w, "\" ");
800 wrbuf_puts(w, "name=\"");
801 wrbuf_xmlputs(w, *name ? name : "Unknown");
802 wrbuf_puts(w, "\">");
804 write_metadata(w, service, r->metadata, show_details);
805 wrbuf_puts(w, "</location>\n");
808 static void show_raw_record_error(void *data, const char *addinfo)
810 http_channel_observer_t obs = data;
811 struct http_channel *c = http_channel_observer_chan(obs);
812 struct http_response *rs = c->response;
814 http_remove_observer(obs);
816 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
819 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
821 http_channel_observer_t obs = data;
822 struct http_channel *c = http_channel_observer_chan(obs);
823 struct http_response *rs = c->response;
825 http_remove_observer(obs);
827 wrbuf_write(c->wrbuf, buf, sz);
828 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
829 http_send_response(c);
833 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
835 http_channel_observer_t obs = data;
836 struct http_channel *c = http_channel_observer_chan(obs);
837 struct http_response *rs = c->response;
839 http_remove_observer(obs);
841 wrbuf_write(c->wrbuf, buf, sz);
842 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
844 rs->content_type = "application/octet-stream";
845 http_send_response(c);
849 void show_raw_reset(void *data, struct http_channel *c, void *data2)
851 //struct client *client = data;
852 //client_show_raw_remove(client, data2);
855 static void cmd_record_ready(void *data);
857 static void show_record(struct http_channel *c, struct http_session *s)
859 struct http_response *rs = c->response;
860 struct http_request *rq = c->request;
861 struct record_cluster *rec, *prev_r, *next_r;
863 struct conf_service *service;
864 const char *idstr = http_argbyname(rq, "id");
865 const char *offsetstr = http_argbyname(rq, "offset");
866 const char *binarystr = http_argbyname(rq, "binary");
870 service = s->psession->service;
873 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
876 wrbuf_rewind(c->wrbuf);
877 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
879 if (session_active_clients(s->psession) == 0)
881 error(rs, PAZPAR2_RECORD_MISSING, idstr);
883 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
884 cmd_record_ready, c, c) != 0)
886 error(rs, PAZPAR2_RECORD_MISSING, idstr);
892 int offset = atoi(offsetstr);
893 const char *syntax = http_argbyname(rq, "syntax");
894 const char *esn = http_argbyname(rq, "esn");
896 struct record*r = rec->records;
898 const char *nativesyntax = http_argbyname(rq, "nativesyntax");
900 if (binarystr && *binarystr != '0')
903 for (i = 0; i < offset && r; r = r->next, i++)
907 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
911 http_channel_observer_t obs =
912 http_add_observer(c, r->client, show_raw_reset);
913 int ret = client_show_raw_begin(r->client, r->position,
916 show_raw_record_error,
918 show_raw_record_ok_binary :
924 http_remove_observer(obs);
925 error(rs, PAZPAR2_NO_SESSION, 0);
931 response_open_no_status(c, "record");
932 wrbuf_puts(c->wrbuf, "\n<recid>");
933 wrbuf_xmlputs(c->wrbuf, rec->recid);
934 wrbuf_puts(c->wrbuf, "</recid>\n");
937 wrbuf_puts(c->wrbuf, "<prevrecid>");
938 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
939 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
943 wrbuf_puts(c->wrbuf, "<nextrecid>");
944 wrbuf_xmlputs(c->wrbuf, next_r->recid);
945 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
947 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n",
948 session_active_clients(s->psession));
949 write_metadata(c->wrbuf, service, rec->metadata, 1);
950 for (r = rec->records; r; r = r->next)
951 write_subrecord(r, c->wrbuf, service, 1);
952 response_close(c, "record");
954 show_single_stop(s->psession, rec);
957 static void cmd_record_ready(void *data)
959 struct http_channel *c = (struct http_channel *) data;
960 struct http_session *s = locate_session(c);
962 yaz_log(c->http_sessions->log_level, "Session %u: record watch released", s->session_id);
964 release_session(c,s);
968 static void cmd_record(struct http_channel *c)
970 struct http_session *s = locate_session(c);
973 release_session(c,s);
978 static void show_records(struct http_channel *c, struct http_session *s, int active)
980 struct http_request *rq = c->request;
981 struct http_response *rs = c->response;
982 struct record_cluster **rl;
983 struct reclist_sortparms *sp;
984 const char *start = http_argbyname(rq, "start");
985 const char *num = http_argbyname(rq, "num");
986 const char *sort = http_argbyname(rq, "sort");
996 // We haven't counted clients yet if we're called on a block release
998 active = session_active_clients(s->psession);
1001 startn = atoi(start);
1006 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1008 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1013 rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits);
1015 response_open(c, "show");
1016 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
1017 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
1018 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
1019 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
1020 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
1022 for (i = 0; i < numn; i++)
1026 struct record_cluster *rec = rl[i];
1027 struct conf_service *service = s->psession->service;
1029 wrbuf_puts(c->wrbuf, "<hit>\n");
1030 write_metadata(c->wrbuf, service, rec->metadata, 0);
1031 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
1032 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
1034 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
1035 if (strstr(sort, "relevance"))
1036 wrbuf_printf(c->wrbuf, "<relevance>%d</relevance>\n",
1037 rec->relevance_score);
1038 wrbuf_puts(c->wrbuf, "<recid>");
1039 wrbuf_xmlputs(c->wrbuf, rec->recid);
1040 wrbuf_puts(c->wrbuf, "</recid>\n");
1041 wrbuf_puts(c->wrbuf, "</hit>\n");
1044 show_range_stop(s->psession, rl);
1046 response_close(c, "show");
1049 static void show_records_ready(void *data)
1051 struct http_channel *c = (struct http_channel *) data;
1052 struct http_session *s = locate_session(c);
1054 yaz_log(c->http_sessions->log_level, "Session %u: show watch released", s->session_id);
1055 show_records(c, s, -1);
1058 /* some error message */
1060 release_session(c,s);
1063 static void cmd_show(struct http_channel *c)
1065 struct http_request *rq = c->request;
1066 struct http_response *rs = c->response;
1067 struct http_session *s = locate_session(c);
1068 const char *block = http_argbyname(rq, "block");
1069 const char *sort = http_argbyname(rq, "sort");
1070 struct reclist_sortparms *sp;
1079 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1081 error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1082 release_session(c, s);
1085 session_sort(s->psession, sp->name, sp->increasing);
1087 status = session_active_clients(s->psession);
1091 if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0)
1093 // if there is already a watch/block. we do not block this one
1094 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1095 show_records_ready, c, c) == 0)
1097 yaz_log(c->http_sessions->log_level,
1098 "Session %u: Blocking on command show (preferred targets)", s->session_id);
1102 yaz_log(YLOG_WARN, "Attempt to block multiple times on show (preferred targets) block. Not supported!");
1103 error(rs, PAZPAR2_ALREADY_BLOCKED, "show (preferred targets)");
1105 release_session(c, s);
1111 // if there is already a watch/block. we do not block this one
1112 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1113 show_records_ready, c, c) != 0
1116 yaz_log(YLOG_WARN, "Attempt to block multiple times on show block. Not supported!");
1117 error(rs, PAZPAR2_ALREADY_BLOCKED, "show");
1121 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command show", s->session_id);
1123 release_session(c, s);
1127 show_records(c, s, status);
1128 release_session(c, s);
1131 static void cmd_ping(struct http_channel *c)
1133 struct http_session *s = locate_session(c);
1136 response_open(c, "ping");
1137 response_close(c, "ping");
1138 release_session(c, s);
1141 static void cmd_search(struct http_channel *c)
1143 struct http_request *rq = c->request;
1144 struct http_response *rs = c->response;
1145 struct http_session *s = locate_session(c);
1146 const char *query = http_argbyname(rq, "query");
1147 const char *filter = http_argbyname(rq, "filter");
1148 const char *maxrecs = http_argbyname(rq, "maxrecs");
1149 const char *startrecs = http_argbyname(rq, "startrecs");
1150 const char *limit = http_argbyname(rq, "limit");
1151 enum pazpar2_error_code code;
1152 const char *addinfo = 0;
1158 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1159 release_session(c, s);
1162 if (!yaz_utf8_check(query))
1164 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1165 release_session(c, s);
1168 code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
1169 &addinfo, "relevance", 0);
1172 error(rs, code, addinfo);
1173 release_session(c, s);
1176 response_open(c, "search");
1177 response_close(c, "search");
1178 release_session(c, s);
1182 static void cmd_stat(struct http_channel *c)
1184 struct http_session *s = locate_session(c);
1185 struct statistics stat;
1193 clients = session_active_clients(s->psession);
1194 statistics(s->psession, &stat);
1196 if (stat.num_clients > 0)
1198 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1201 response_open_no_status(c, "stat");
1202 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
1203 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1204 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
1205 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
1206 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
1207 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
1208 wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
1209 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
1210 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
1211 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
1212 wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
1213 response_close(c, "stat");
1214 release_session(c, s);
1217 static void cmd_info(struct http_channel *c)
1219 char yaz_version_str[20];
1221 response_open_no_status(c, "info");
1222 wrbuf_puts(c->wrbuf, " <version>\n");
1223 wrbuf_puts(c->wrbuf, " <pazpar2");
1224 #ifdef PAZPAR2_VERSION_SHA1
1225 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1227 wrbuf_puts(c->wrbuf, ">");
1228 wrbuf_xmlputs(c->wrbuf, VERSION);
1229 wrbuf_puts(c->wrbuf, "</pazpar2>");
1231 yaz_version(yaz_version_str, 0);
1232 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1233 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1234 wrbuf_puts(c->wrbuf, "\">");
1235 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1236 wrbuf_puts(c->wrbuf, "</yaz>\n");
1238 wrbuf_puts(c->wrbuf, " </version>\n");
1240 info_services(c->server, c->wrbuf);
1242 response_close(c, "info");
1247 void (*fun)(struct http_channel *c);
1249 { "init", cmd_init },
1250 { "settings", cmd_settings },
1251 { "stat", cmd_stat },
1252 { "bytarget", cmd_bytarget },
1253 { "show", cmd_show },
1254 { "search", cmd_search },
1255 { "termlist", cmd_termlist },
1256 { "exit", cmd_exit },
1257 { "session-status", cmd_session_status },
1258 { "server-status", cmd_server_status },
1259 { "ping", cmd_ping },
1260 { "record", cmd_record },
1261 { "info", cmd_info },
1265 void http_command(struct http_channel *c)
1267 const char *command = http_argbyname(c->request, "command");
1268 struct http_response *rs = http_create_response(c);
1273 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1274 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1278 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1281 for (i = 0; commands[i].name; i++)
1282 if (!strcmp(commands[i].name, command))
1284 (*commands[i].fun)(c);
1287 if (!commands[i].name)
1288 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1296 * c-file-style: "Stroustrup"
1297 * indent-tabs-mode: nil
1299 * vim: shiftwidth=4 tabstop=8 expandtab