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"
46 void print_meminfo(WRBUF wrbuf) {
48 struct mallinfo minfo;
50 wrbuf_printf(wrbuf, " <memory>\n"
51 " <arena>%d</arena>\n"
52 " <uordblks>%d</uordblks>\n"
53 " <fordblks>%d</fordblks>\n"
54 " <ordblks>%d</ordblks>\n"
55 " <keepcost>%d</keepcost>\n"
56 " <hblks>%d</hblks>\n"
57 " <hblkhd>%d</hblkhd>\n"
59 " <virtuse>%d</virtuse>\n"
61 minfo.arena, minfo.uordblks, minfo.fordblks,minfo.ordblks, minfo.keepcost, minfo.hblks, minfo.hblkhd, minfo.arena + minfo.hblkhd, minfo.uordblks + minfo.hblkhd);
67 // Update this when the protocol changes
68 #define PAZPAR2_PROTOCOL_VERSION "1"
70 #define HTTP_COMMAND_RESPONSE_PREFIX "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
73 IOCHAN timeout_iochan; // NOTE: This is NOT associated with a socket
74 struct session *psession;
75 unsigned int session_id;
80 http_sessions_t http_sessions;
81 struct http_session *next;
84 struct http_sessions {
85 struct http_session *session_list;
90 static YAZ_MUTEX g_http_session_mutex = 0;
91 static int g_http_sessions = 0;
93 int http_session_use(int delta)
96 if (!g_http_session_mutex)
97 yaz_mutex_create(&g_http_session_mutex);
98 yaz_mutex_enter(g_http_session_mutex);
99 g_http_sessions += delta;
100 sessions = g_http_sessions;
101 yaz_mutex_leave(g_http_session_mutex);
102 yaz_log(YLOG_DEBUG, "%s sesions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), sessions);
107 http_sessions_t http_sessions_create(void)
109 http_sessions_t hs = xmalloc(sizeof(*hs));
110 hs->session_list = 0;
112 pazpar2_mutex_create(&hs->mutex, "http_sessions");
113 hs->log_level = yaz_log_module_level("HTTP");
117 void http_sessions_destroy(http_sessions_t hs)
121 struct http_session *s = hs->session_list;
124 struct http_session *s_next = s->next;
125 iochan_destroy(s->timeout_iochan);
126 destroy_session(s->psession);
127 nmem_destroy(s->nmem);
130 yaz_mutex_destroy(&hs->mutex);
135 void http_session_destroy(struct http_session *s);
137 static void session_timeout(IOCHAN i, int event)
139 struct http_session *s = iochan_getdata(i);
140 http_session_destroy(s);
143 struct http_session *http_session_create(struct conf_service *service,
144 http_sessions_t http_sessions,
147 NMEM nmem = nmem_create();
148 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
151 sprintf(tmp_str, "session#%u", sesid);
152 r->psession = new_session(nmem, service, sesid);
153 r->session_id = sesid;
156 r->destroy_counter = r->activity_counter = 0;
157 r->http_sessions = http_sessions;
159 yaz_mutex_enter(http_sessions->mutex);
160 r->next = http_sessions->session_list;
161 http_sessions->session_list = r;
162 yaz_mutex_leave(http_sessions->mutex);
164 r->timeout_iochan = iochan_create(-1, session_timeout, 0, "http_session_timeout");
165 iochan_setdata(r->timeout_iochan, r);
166 yaz_log(http_sessions->log_level, "%p Session %u created. timeout chan=%p timeout=%d", r, sesid, r->timeout_iochan, service->session_timeout);
167 iochan_settimeout(r->timeout_iochan, service->session_timeout);
169 iochan_add(service->server->iochan_man, r->timeout_iochan);
174 void http_session_destroy(struct http_session *s)
176 int must_destroy = 0;
178 http_sessions_t http_sessions = s->http_sessions;
180 yaz_log(http_sessions->log_level, "%p HTTP Session %u destroyed", s, s->session_id);
181 yaz_mutex_enter(http_sessions->mutex);
182 /* only if http_session has no active http sessions on it can be destroyed */
183 if (s->destroy_counter == s->activity_counter) {
184 struct http_session **p = 0;
186 for (p = &http_sessions->session_list; *p; p = &(*p)->next)
193 yaz_mutex_leave(http_sessions->mutex);
195 { /* destroying for real */
196 yaz_log(http_sessions->log_level, "%p HTTP Session %u destroyed", s, s->session_id);
197 iochan_destroy(s->timeout_iochan);
198 destroy_session(s->psession);
199 http_session_use(-1);
200 nmem_destroy(s->nmem);
203 yaz_log(http_sessions->log_level, "%p HTTP Session %u destroyed delayed. Active clients (%d-%d). Waiting for new timeout.",
204 s, s->session_id, s->activity_counter, s->destroy_counter);
209 static const char *get_msg(enum pazpar2_error_code code)
211 struct pazpar2_error_msg {
212 enum pazpar2_error_code code;
215 static const struct pazpar2_error_msg ar[] = {
216 { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
217 { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
218 { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
219 { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
220 { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
221 { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
222 { PAZPAR2_RECORD_MISSING, "Record missing"},
223 { PAZPAR2_NO_TARGETS, "No targets"},
224 { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
225 { PAZPAR2_RECORD_FAIL, "Record command failed"},
226 { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
227 { PAZPAR2_NO_SERVICE, "No service"},
228 { PAZPAR2_LAST_ERROR, "Last error"},
234 if (code == ar[i].code)
241 static void error(struct http_response *rs,
242 enum pazpar2_error_code code,
245 struct http_channel *c = rs->channel;
246 WRBUF text = wrbuf_alloc();
247 const char *http_status = "417";
248 const char *msg = get_msg(code);
250 rs->msg = nmem_strdup(c->nmem, msg);
251 strcpy(rs->code, http_status);
253 wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX "<error code=\"%d\" msg=\"%s\">", (int) code,
256 wrbuf_xmlputs(text, addinfo);
257 wrbuf_puts(text, "</error>");
259 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
260 msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
261 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
263 http_send_response(c);
266 unsigned int make_sessionid(void)
268 static int seq = 0; /* thread pr */
272 if (global_parameters.predictable_sessions)
281 if (gettimeofday(&t, 0) < 0)
283 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
286 /* at most 256 sessions per second ..
287 (long long would be more appropriate)*/
289 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
295 static struct http_session *locate_session(struct http_channel *c)
297 struct http_response *rs = c->response;
298 struct http_request *rq = c->request;
299 struct http_session *p;
300 const char *session = http_argbyname(rq, "session");
301 http_sessions_t http_sessions = c->http_sessions;
306 error(rs, PAZPAR2_MISSING_PARAMETER, "session");
310 yaz_mutex_enter(http_sessions->mutex);
311 for (p = http_sessions->session_list; p; p = p->next)
312 if (id == p->session_id)
315 p->activity_counter++;
316 yaz_mutex_leave(http_sessions->mutex);
318 iochan_activity(p->timeout_iochan);
320 error(rs, PAZPAR2_NO_SESSION, session);
324 // Call after use of locate_session, in order to increment the destroy_counter
325 static void release_session(struct http_channel *c, struct http_session *session) {
326 http_sessions_t http_sessions = c->http_sessions;
327 yaz_mutex_enter(http_sessions->mutex);
329 session->destroy_counter++;
330 yaz_mutex_leave(http_sessions->mutex);
333 // Decode settings parameters and apply to session
334 // Syntax: setting[target]=value
335 static int process_settings(struct session *se, struct http_request *rq,
336 struct http_response *rs)
338 struct http_argument *a;
340 for (a = rq->arguments; a; a = a->next)
341 if (strchr(a->name, '['))
348 // Nmem_strsplit *rules*!!!
349 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
352 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
357 session_apply_setting(se, dbname, setting,
358 nmem_strdup(se->session_nmem, a->value));
363 static void cmd_exit(struct http_channel *c)
366 struct http_response *rs = c->response;
367 yaz_log(YLOG_WARN, "exit");
368 sprintf(buf, HTTP_COMMAND_RESPONSE_PREFIX "<exit><status>OK</status></exit>");
369 rs->payload = nmem_strdup(c->nmem, buf);
370 http_send_response(c);
371 http_close_server(c->server);
374 static void cmd_init(struct http_channel *c)
377 struct http_request *r = c->request;
378 const char *clear = http_argbyname(r, "clear");
379 const char *content_type = http_lookup_header(r->headers, "Content-Type");
381 struct http_session *s;
382 struct http_response *rs = c->response;
383 struct conf_service *service = 0; /* no service (yet) */
385 if (r->content_len && content_type &&
386 !yaz_strcmp_del("text/xml", content_type, "; "))
388 xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
392 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
395 root_n = xmlDocGetRootElement(doc);
396 service = service_create(c->server, root_n);
400 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
407 const char *service_name = http_argbyname(c->request, "service");
408 service = locate_service(c->server, service_name);
411 error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
415 sesid = make_sessionid();
416 s = http_session_create(service, c->http_sessions, sesid);
418 yaz_log(c->http_sessions->log_level, "%p Session init %u ", s, sesid);
419 if (!clear || *clear == '0')
420 session_init_databases(s->psession);
422 yaz_log(YLOG_LOG, "HTTP Session %u init: No databases preloaded", sesid);
424 if (process_settings(s->psession, c->request, c->response) < 0)
427 sprintf(buf, HTTP_COMMAND_RESPONSE_PREFIX
428 "<init><status>OK</status><session>%d", sesid);
429 if (c->server->server_id)
432 strcat(buf, c->server->server_id);
434 strcat(buf, "</session>"
435 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol></init>");
436 rs->payload = nmem_strdup(c->nmem, buf);
437 http_send_response(c);
440 static void apply_local_setting(void *client_data,
443 struct session *se = (struct session *) client_data;
445 session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
446 nmem_strdup(se->session_nmem, set->name),
447 nmem_strdup(se->session_nmem, set->value));
450 static void cmd_settings(struct http_channel *c)
452 struct http_response *rs = c->response;
453 struct http_request *rq = c->request;
454 struct http_session *s = locate_session(c);
455 const char *content_type = http_lookup_header(rq->headers, "Content-Type");
460 if (rq->content_len && content_type &&
461 !yaz_strcmp_del("text/xml", content_type, "; "))
463 xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
467 error(rs, PAZPAR2_MALFORMED_SETTING, 0);
470 root_n = xmlDocGetRootElement(doc);
472 settings_read_node_x(root_n, s->psession, apply_local_setting);
476 if (process_settings(s->psession, rq, rs) < 0) {
477 release_session(c,s);
480 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<settings><status>OK</status></settings>";
481 http_send_response(c);
482 release_session(c,s);
485 // Compares two hitsbytarget nodes by hitcount
486 static int cmp_ht(const void *p1, const void *p2)
488 const struct hitsbytarget *h1 = p1;
489 const struct hitsbytarget *h2 = p2;
490 return h2->hits - h1->hits;
493 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
494 static int targets_termlist(WRBUF wrbuf, struct session *se, int num,
497 struct hitsbytarget *ht;
500 ht = hitsbytarget(se, &count, nmem);
501 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
502 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
505 // do only print terms which have display names
507 wrbuf_puts(wrbuf, "<term>\n");
509 wrbuf_puts(wrbuf, "<id>");
510 wrbuf_xmlputs(wrbuf, ht[i].id);
511 wrbuf_puts(wrbuf, "</id>\n");
513 wrbuf_puts(wrbuf, "<name>");
514 if (!ht[i].name || !ht[i].name[0])
515 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
517 wrbuf_xmlputs(wrbuf, ht[i].name);
518 wrbuf_puts(wrbuf, "</name>\n");
520 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
523 wrbuf_puts(wrbuf, "<state>");
524 wrbuf_xmlputs(wrbuf, ht[i].state);
525 wrbuf_puts(wrbuf, "</state>\n");
527 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
529 wrbuf_puts(wrbuf, "</term>\n");
534 static void cmd_termlist(struct http_channel *c)
536 struct http_response *rs = c->response;
537 struct http_request *rq = c->request;
538 struct http_session *s = locate_session(c);
539 struct termlist_score **p;
542 const char *name = http_argbyname(rq, "name");
543 const char *nums = http_argbyname(rq, "num");
546 WRBUF debug_log = wrbuf_alloc();
551 status = session_active_clients(s->psession);
555 if (strlen(name) > 255)
560 wrbuf_rewind(c->wrbuf);
562 wrbuf_puts(c->wrbuf, "<termlist>\n");
563 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
569 if (!(tp = strchr(name, ',')))
570 tp = name + strlen(name);
571 strncpy(tname, name, tp - name);
572 tname[tp - name] = '\0';
573 wrbuf_puts(c->wrbuf, "<list name=\"");
574 wrbuf_xmlputs(c->wrbuf, tname);
575 wrbuf_puts(c->wrbuf, "\">\n");
576 if (!strcmp(tname, "xtargets")) {
577 int targets = targets_termlist(c->wrbuf, s->psession, num, c->nmem);
578 wrbuf_printf(debug_log, " xtargets: %d", targets);
582 p = termlist(s->psession, tname, &len);
584 wrbuf_printf(debug_log, " %s: %d", tname, len);
586 for (i = 0; i < len && i < num; i++){
587 // prevnt sending empty term elements
588 if (!p[i]->term || !p[i]->term[0])
591 wrbuf_puts(c->wrbuf, "<term>");
592 wrbuf_puts(c->wrbuf, "<name>");
593 wrbuf_xmlputs(c->wrbuf, p[i]->term);
594 wrbuf_puts(c->wrbuf, "</name>");
596 wrbuf_printf(c->wrbuf,
597 "<frequency>%d</frequency>",
599 wrbuf_puts(c->wrbuf, "</term>\n");
603 wrbuf_puts(c->wrbuf, "</list>\n");
608 wrbuf_puts(c->wrbuf, "</termlist>\n");
609 yaz_log(YLOG_DEBUG, "termlist response: %s ", wrbuf_cstr(debug_log));
610 wrbuf_destroy(debug_log);
611 rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
612 http_send_response(c);
613 release_session(c,s);
616 size_t session_get_memory_status(struct session *session);
618 static void session_status(struct http_channel *c, struct http_session *s)
621 wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
622 wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
623 session_nmem = session_get_memory_status(s->psession);
624 wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
627 static void cmd_session_status(struct http_channel *c) {
628 struct http_response *rs = c->response;
629 struct http_session *s = locate_session(c);
633 wrbuf_rewind(c->wrbuf);
634 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<sessionstatus><status>OK</status>\n");
635 session_status(c, s);
636 wrbuf_puts(c->wrbuf, "</sessionstatus>\n");
637 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
638 http_send_response(c);
639 release_session(c,s);
643 int sessions_count(void);
644 int clients_count(void);
645 #ifdef HAVE_RESULTSETS_COUNT
646 int resultsets_count(void);
648 #define resultsets_count() 0
651 static void cmd_server_status(struct http_channel *c)
653 struct http_response *rs = c->response;
654 int sessions = sessions_count();
655 int clients = clients_count();
656 int resultsets = resultsets_count();
657 wrbuf_rewind(c->wrbuf);
658 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<server-status>\n");
659 wrbuf_printf(c->wrbuf, " <sessions>%u</sessions>\n", sessions);
660 wrbuf_printf(c->wrbuf, " <clients>%u</clients>\n", clients);
661 /* Only works if yaz has been compiled with enabling of this */
662 wrbuf_printf(c->wrbuf, " <resultsets>%u</resultsets>\n",resultsets);
663 print_meminfo(c->wrbuf);
665 /* TODO add all sessions status */
666 /* http_sessions_t http_sessions = c->http_sessions; */
667 /* struct http_session *p; */
669 yaz_mutex_enter(http_sessions->mutex);
670 for (p = http_sessions->session_list; p; p = p->next) {
671 p->activity_counter++;
672 wrbuf_puts(c->wrbuf, "<session-status>\n");
673 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
674 yaz_mutex_leave(http_sessions->mutex);
675 session_status(c, p);
676 wrbuf_puts(c->wrbuf, "</session-status>\n");
677 yaz_mutex_enter(http_sessions->mutex);
678 p->activity_counter--;
680 yaz_mutex_leave(http_sessions->mutex);
682 wrbuf_puts(c->wrbuf, "</server-status>\n");
683 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
684 http_send_response(c);
689 static void cmd_bytarget(struct http_channel *c)
691 struct http_response *rs = c->response;
692 struct http_request *rq = c->request;
693 struct http_session *s = locate_session(c);
694 struct hitsbytarget *ht;
695 const char *settings = http_argbyname(rq, "settings");
700 ht = hitsbytarget(s->psession, &count, c->nmem);
701 wrbuf_rewind(c->wrbuf);
702 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<bytarget><status>OK</status>");
704 for (i = 0; i < count; i++)
706 wrbuf_puts(c->wrbuf, "\n<target>");
708 wrbuf_puts(c->wrbuf, "<id>");
709 wrbuf_xmlputs(c->wrbuf, ht[i].id);
710 wrbuf_puts(c->wrbuf, "</id>\n");
712 if (ht[i].name && ht[i].name[0])
714 wrbuf_puts(c->wrbuf, "<name>");
715 wrbuf_xmlputs(c->wrbuf, ht[i].name);
716 wrbuf_puts(c->wrbuf, "</name>\n");
719 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
720 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
721 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
723 wrbuf_puts(c->wrbuf, "<state>");
724 wrbuf_xmlputs(c->wrbuf, ht[i].state);
725 wrbuf_puts(c->wrbuf, "</state>\n");
726 if (settings && *settings == '1')
728 wrbuf_puts(c->wrbuf, "<settings>\n");
729 wrbuf_puts(c->wrbuf, ht[i].settings_xml);
730 wrbuf_puts(c->wrbuf, "</settings>\n");
732 wrbuf_puts(c->wrbuf, "</target>");
735 wrbuf_puts(c->wrbuf, "</bytarget>");
736 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
737 http_send_response(c);
738 release_session(c,s);
741 static void write_metadata(WRBUF w, struct conf_service *service,
742 struct record_metadata **ml, int full)
746 for (imeta = 0; imeta < service->num_metadata; imeta++)
748 struct conf_metadata *cmd = &service->metadata[imeta];
749 struct record_metadata *md;
750 if (!cmd->brief && !full)
752 for (md = ml[imeta]; md; md = md->next)
754 struct record_metadata_attr *attr = md->attributes;
755 wrbuf_printf(w, "\n<md-%s", cmd->name);
757 for (; attr; attr = attr->next)
759 wrbuf_printf(w, " %s=\"", attr->name);
760 wrbuf_xmlputs(w, attr->value);
766 case Metadata_type_generic:
767 wrbuf_xmlputs(w, md->data.text.disp);
769 case Metadata_type_year:
770 wrbuf_printf(w, "%d", md->data.number.min);
771 if (md->data.number.min != md->data.number.max)
772 wrbuf_printf(w, "-%d", md->data.number.max);
775 wrbuf_puts(w, "[can't represent]");
777 wrbuf_printf(w, "</md-%s>", cmd->name);
782 static void write_subrecord(struct record *r, WRBUF w,
783 struct conf_service *service, int show_details)
785 const char *name = session_setting_oneval(
786 client_get_database(r->client), PZ_NAME);
788 wrbuf_puts(w, "<location id=\"");
789 wrbuf_xmlputs(w, client_get_database(r->client)->database->url);
790 wrbuf_puts(w, "\" ");
792 wrbuf_puts(w, "name=\"");
793 wrbuf_xmlputs(w, *name ? name : "Unknown");
794 wrbuf_puts(w, "\">");
796 write_metadata(w, service, r->metadata, show_details);
797 wrbuf_puts(w, "</location>\n");
800 static void show_raw_record_error(void *data, const char *addinfo)
802 http_channel_observer_t obs = data;
803 struct http_channel *c = http_channel_observer_chan(obs);
804 struct http_response *rs = c->response;
806 http_remove_observer(obs);
808 error(rs, PAZPAR2_RECORD_FAIL, addinfo);
811 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
813 http_channel_observer_t obs = data;
814 struct http_channel *c = http_channel_observer_chan(obs);
815 struct http_response *rs = c->response;
817 http_remove_observer(obs);
819 wrbuf_write(c->wrbuf, buf, sz);
820 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
821 http_send_response(c);
825 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
827 http_channel_observer_t obs = data;
828 struct http_channel *c = http_channel_observer_chan(obs);
829 struct http_response *rs = c->response;
831 http_remove_observer(obs);
833 wrbuf_write(c->wrbuf, buf, sz);
834 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
836 rs->content_type = "application/octet-stream";
837 http_send_response(c);
841 void show_raw_reset(void *data, struct http_channel *c, void *data2)
843 //struct client *client = data;
844 //client_show_raw_remove(client, data2);
847 static void cmd_record_ready(void *data);
849 static void cmd_record(struct http_channel *c)
851 struct http_response *rs = c->response;
852 struct http_request *rq = c->request;
853 struct http_session *s = locate_session(c);
854 struct record_cluster *rec, *prev_r, *next_r;
856 struct conf_service *service;
857 const char *idstr = http_argbyname(rq, "id");
858 const char *offsetstr = http_argbyname(rq, "offset");
859 const char *binarystr = http_argbyname(rq, "binary");
863 service = s->psession->service;
866 error(rs, PAZPAR2_MISSING_PARAMETER, "id");
869 wrbuf_rewind(c->wrbuf);
870 if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
872 if (session_active_clients(s->psession) == 0)
874 error(rs, PAZPAR2_RECORD_MISSING, idstr);
876 else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
877 cmd_record_ready, c, c) != 0)
879 error(rs, PAZPAR2_RECORD_MISSING, idstr);
881 release_session(c, s);
886 int offset = atoi(offsetstr);
887 const char *syntax = http_argbyname(rq, "syntax");
888 const char *esn = http_argbyname(rq, "esn");
890 struct record*r = rec->records;
893 if (binarystr && *binarystr != '0')
896 for (i = 0; i < offset && r; r = r->next, i++)
900 error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
904 http_channel_observer_t obs =
905 http_add_observer(c, r->client, show_raw_reset);
906 int ret = client_show_raw_begin(r->client, r->position,
909 show_raw_record_error,
911 show_raw_record_ok_binary :
916 http_remove_observer(obs);
917 error(rs, PAZPAR2_NO_SESSION, 0);
923 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<record>\n");
924 wrbuf_puts(c->wrbuf, "<recid>");
925 wrbuf_xmlputs(c->wrbuf, rec->recid);
926 wrbuf_puts(c->wrbuf, "</recid>\n");
929 wrbuf_puts(c->wrbuf, "<prevrecid>");
930 wrbuf_xmlputs(c->wrbuf, prev_r->recid);
931 wrbuf_puts(c->wrbuf, "</prevrecid>\n");
935 wrbuf_puts(c->wrbuf, "<nextrecid>");
936 wrbuf_xmlputs(c->wrbuf, next_r->recid);
937 wrbuf_puts(c->wrbuf, "</nextrecid>\n");
939 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n",
940 session_active_clients(s->psession));
941 write_metadata(c->wrbuf, service, rec->metadata, 1);
942 for (r = rec->records; r; r = r->next)
943 write_subrecord(r, c->wrbuf, service, 1);
944 wrbuf_puts(c->wrbuf, "</record>\n");
945 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
946 http_send_response(c);
948 show_single_stop(s->psession, rec);
949 release_session(c, s);
952 static void cmd_record_ready(void *data)
954 struct http_channel *c = (struct http_channel *) data;
959 static void show_records(struct http_channel *c, int active)
961 struct http_request *rq = c->request;
962 struct http_response *rs = c->response;
963 struct http_session *s = locate_session(c);
964 struct record_cluster **rl;
965 struct reclist_sortparms *sp;
966 const char *start = http_argbyname(rq, "start");
967 const char *num = http_argbyname(rq, "num");
968 const char *sort = http_argbyname(rq, "sort");
978 // We haven't counted clients yet if we're called on a block release
980 active = session_active_clients(s->psession);
983 startn = atoi(start);
988 if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
990 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
991 release_session(c, s);
996 rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits);
998 wrbuf_rewind(c->wrbuf);
999 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<show>\n<status>OK</status>\n");
1000 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
1001 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
1002 wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
1003 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
1004 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
1006 for (i = 0; i < numn; i++)
1010 struct record_cluster *rec = rl[i];
1011 struct conf_service *service = s->psession->service;
1013 wrbuf_puts(c->wrbuf, "<hit>\n");
1014 write_metadata(c->wrbuf, service, rec->metadata, 0);
1015 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
1016 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
1018 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
1019 if (strstr(sort, "relevance"))
1020 wrbuf_printf(c->wrbuf, "<relevance>%d</relevance>\n",
1021 rec->relevance_score);
1022 wrbuf_puts(c->wrbuf, "<recid>");
1023 wrbuf_xmlputs(c->wrbuf, rec->recid);
1024 wrbuf_puts(c->wrbuf, "</recid>\n");
1025 wrbuf_puts(c->wrbuf, "</hit>\n");
1028 show_range_stop(s->psession, rl);
1030 wrbuf_puts(c->wrbuf, "</show>\n");
1031 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1032 http_send_response(c);
1033 release_session(c, s);
1036 static void show_records_ready(void *data)
1038 struct http_channel *c = (struct http_channel *) data;
1040 show_records(c, -1);
1043 static void cmd_show(struct http_channel *c)
1045 struct http_request *rq = c->request;
1046 struct http_session *s = locate_session(c);
1047 const char *block = http_argbyname(rq, "block");
1053 status = session_active_clients(s->psession);
1057 if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0) {
1058 // if there is already a watch/block. we do not block this one
1059 if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1060 show_records_ready, c, c) != 0)
1062 yaz_log(c->http_sessions->log_level,
1063 "%p Session %u: Blocking on cmd_show. Waiting for preferred targets", s, s->session_id);
1065 release_session(c,s);
1069 else if (status && reclist_get_num_records(s->psession->reclist) == 0)
1071 // if there is already a watch/block. we do not block this one
1072 if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1073 show_records_ready, c, c) != 0)
1075 yaz_log(c->http_sessions->log_level, "%p Session %u: Blocking on cmd_show", s, s->session_id);
1077 release_session(c,s);
1081 show_records(c, status);
1082 release_session(c,s);
1085 static void cmd_ping(struct http_channel *c)
1087 struct http_response *rs = c->response;
1088 struct http_session *s = locate_session(c);
1091 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<ping><status>OK</status></ping>";
1092 http_send_response(c);
1093 release_session(c, s);
1096 static int utf_8_valid(const char *str)
1098 yaz_iconv_t cd = yaz_iconv_open("utf-8", "utf-8");
1101 /* check that query is UTF-8 encoded */
1102 char *inbuf = (char *) str; /* we know iconv does not alter this */
1103 size_t inbytesleft = strlen(inbuf);
1105 size_t outbytesleft = strlen(inbuf) + 10;
1106 char *out = xmalloc(outbytesleft);
1108 size_t r = yaz_iconv(cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft);
1110 /* if OK, try flushing the rest */
1111 if (r != (size_t) (-1))
1112 r = yaz_iconv(cd, 0, 0, &outbuf, &outbytesleft);
1113 yaz_iconv_close(cd);
1115 if (r == (size_t) (-1))
1121 static void cmd_search(struct http_channel *c)
1123 struct http_request *rq = c->request;
1124 struct http_response *rs = c->response;
1125 struct http_session *s = locate_session(c);
1126 const char *query = http_argbyname(rq, "query");
1127 const char *filter = http_argbyname(rq, "filter");
1128 const char *maxrecs = http_argbyname(rq, "maxrecs");
1129 const char *startrecs = http_argbyname(rq, "startrecs");
1130 enum pazpar2_error_code code;
1131 const char *addinfo = 0;
1137 error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1138 release_session(c,s);
1141 if (!utf_8_valid(query))
1143 error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1144 release_session(c,s);
1147 code = search(s->psession, query, startrecs, maxrecs, filter, &addinfo);
1150 error(rs, code, addinfo);
1151 release_session(c,s);
1154 rs->payload = HTTP_COMMAND_RESPONSE_PREFIX "<search><status>OK</status></search>";
1155 http_send_response(c);
1156 release_session(c,s);
1160 static void cmd_stat(struct http_channel *c)
1162 struct http_response *rs = c->response;
1163 struct http_session *s = locate_session(c);
1164 struct statistics stat;
1172 clients = session_active_clients(s->psession);
1173 statistics(s->psession, &stat);
1175 if (stat.num_clients > 0) {
1176 progress = (stat.num_clients - clients) / (float)stat.num_clients;
1179 wrbuf_rewind(c->wrbuf);
1180 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<stat>");
1181 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
1182 wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1183 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
1184 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
1185 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
1186 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
1187 wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
1188 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
1189 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
1190 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
1191 wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
1192 wrbuf_puts(c->wrbuf, "</stat>");
1193 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1194 http_send_response(c);
1195 release_session(c,s);
1198 static void cmd_info(struct http_channel *c)
1200 char yaz_version_str[20];
1201 struct http_response *rs = c->response;
1203 wrbuf_rewind(c->wrbuf);
1204 wrbuf_puts(c->wrbuf, HTTP_COMMAND_RESPONSE_PREFIX "<info>\n");
1205 wrbuf_puts(c->wrbuf, " <version>\n");
1206 wrbuf_puts(c->wrbuf, " <pazpar2");
1207 #ifdef PAZPAR2_VERSION_SHA1
1208 wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1210 wrbuf_puts(c->wrbuf, ">");
1211 wrbuf_xmlputs(c->wrbuf, VERSION);
1212 wrbuf_puts(c->wrbuf, "</pazpar2>");
1215 yaz_version(yaz_version_str, 0);
1216 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
1217 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1218 wrbuf_puts(c->wrbuf, "\">");
1219 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1220 wrbuf_puts(c->wrbuf, "</yaz>\n");
1222 wrbuf_puts(c->wrbuf, " </version>\n");
1224 info_services(c->server, c->wrbuf);
1226 wrbuf_puts(c->wrbuf, "</info>");
1227 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
1228 http_send_response(c);
1233 void (*fun)(struct http_channel *c);
1235 { "init", cmd_init },
1236 { "settings", cmd_settings },
1237 { "stat", cmd_stat },
1238 { "bytarget", cmd_bytarget },
1239 { "show", cmd_show },
1240 { "search", cmd_search },
1241 { "termlist", cmd_termlist },
1242 { "exit", cmd_exit },
1243 { "session-status", cmd_session_status },
1244 { "server-status", cmd_server_status },
1245 { "ping", cmd_ping },
1246 { "record", cmd_record },
1247 { "info", cmd_info },
1251 void http_command(struct http_channel *c)
1253 const char *command = http_argbyname(c->request, "command");
1254 struct http_response *rs = http_create_response(c);
1259 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1260 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1264 error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1267 for (i = 0; commands[i].name; i++)
1268 if (!strcmp(commands[i].name, command))
1270 (*commands[i].fun)(c);
1273 if (!commands[i].name)
1274 error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1282 * c-file-style: "Stroustrup"
1283 * indent-tabs-mode: nil
1285 * vim: shiftwidth=4 tabstop=8 expandtab