1 /* $Id: http_command.c,v 1.47 2007-06-05 14:09:10 marc Exp $
2 Copyright (c) 2006-2007, Index Data.
4 This file is part of Pazpar2.
6 Pazpar2 is free software; you can redistribute it and/or modify it under
7 the terms of the GNU General Public License as published by the Free
8 Software Foundation; either version 2, or (at your option) any later
11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with Pazpar2; see the file LICENSE. If not, write to the
18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
23 * $Id: http_command.c,v 1.47 2007-06-05 14:09:10 marc Exp $
27 #include <sys/types.h>
34 #include <yaz/snprintf.h>
39 #include <yaz/yaz-util.h>
46 #include "http_command.h"
50 // Update this when the protocol changes
51 #define PAZPAR2_PROTOCOL_VERSION "1"
54 IOCHAN timeout_iochan; // NOTE: This is NOT associated with a socket
55 struct session *psession;
56 unsigned int session_id;
59 struct http_session *next;
62 static struct http_session *session_list = 0;
64 void http_session_destroy(struct http_session *s);
66 static void session_timeout(IOCHAN i, int event)
68 struct http_session *s = iochan_getdata(i);
69 http_session_destroy(s);
72 struct http_session *http_session_create()
74 NMEM nmem = nmem_create();
75 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
77 r->psession = new_session(nmem);
81 r->next = session_list;
83 r->timeout_iochan = iochan_create(-1, session_timeout, 0);
84 iochan_setdata(r->timeout_iochan, r);
85 iochan_settimeout(r->timeout_iochan, global_parameters.session_timeout);
87 pazpar2_add_channel(r->timeout_iochan);
91 void http_session_destroy(struct http_session *s)
93 struct http_session **p;
95 for (p = &session_list; *p; p = &(*p)->next)
101 iochan_destroy(s->timeout_iochan);
102 destroy_session(s->psession);
103 nmem_destroy(s->nmem);
106 static void error(struct http_response *rs,
107 const char *code, const char *msg, const char *extra)
109 struct http_channel *c = rs->channel;
111 char *sep = extra ? ": " : "";
113 rs->msg = nmem_strdup(c->nmem, msg);
114 strcpy(rs->code, code);
116 yaz_snprintf(text, sizeof(text),
117 "<error code=\"general\">%s%s%s</error>", msg, sep,
120 yaz_log(YLOG_WARN, "HTTP %s %s%s%s", code, msg, sep,
122 rs->payload = nmem_strdup(c->nmem, text);
123 http_send_response(c);
126 unsigned int make_sessionid()
132 if (global_parameters.debug_mode)
138 if (gettimeofday(&t, 0) < 0)
140 yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
143 /* at most 256 sessions per second ..
144 (long long would be more appropriate)*/
146 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
151 static struct http_session *locate_session(struct http_request *rq, struct http_response *rs)
153 struct http_session *p;
154 char *session = http_argbyname(rq, "session");
159 error(rs, "417", "Must supply session", 0);
163 for (p = session_list; p; p = p->next)
164 if (id == p->session_id)
166 iochan_activity(p->timeout_iochan);
169 error(rs, "417", "Session does not exist, or it has expired", 0);
173 // Decode settings parameters and apply to session
174 // Syntax: setting[target]=value
175 static int process_settings(struct session *se, struct http_request *rq,
176 struct http_response *rs)
178 struct http_argument *a;
180 for (a = rq->arguments; a; a = a->next)
181 if (strchr(a->name, '['))
188 // Nmem_strsplit *rules*!!!
189 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
192 error(rs, "417", "Malformed setting argument", a->name);
197 session_apply_setting(se, dbname, setting,
198 nmem_strdup(se->session_nmem, a->value));
203 static void cmd_exit(struct http_channel *c)
205 yaz_log(YLOG_WARN, "exit");
209 static void cmd_init(struct http_channel *c)
213 struct http_session *s = http_session_create();
214 struct http_response *rs = c->response;
216 yaz_log(YLOG_DEBUG, "HTTP Session init");
217 sesid = make_sessionid();
218 s->session_id = sesid;
219 if (process_settings(s->psession, c->request, c->response) < 0)
221 sprintf(buf, "<init><status>OK</status><session>%u</session>"
222 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol></init>", sesid);
223 rs->payload = nmem_strdup(c->nmem, buf);
224 http_send_response(c);
227 static void cmd_settings(struct http_channel *c)
229 struct http_response *rs = c->response;
230 struct http_request *rq = c->request;
231 struct http_session *s = locate_session(rq, rs);
236 if (process_settings(s->psession, rq, rs) < 0)
238 rs->payload = "<settings><status>OK</status></settings>";
239 http_send_response(c);
242 // Compares two hitsbytarget nodes by hitcount
243 static int cmp_ht(const void *p1, const void *p2)
245 const struct hitsbytarget *h1 = p1;
246 const struct hitsbytarget *h2 = p2;
247 return h2->hits - h1->hits;
250 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
251 static void targets_termlist(WRBUF wrbuf, struct session *se, int num)
253 struct hitsbytarget *ht;
256 if (!(ht = hitsbytarget(se, &count)))
258 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
259 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
262 // do only print terms which have display names
264 wrbuf_puts(wrbuf, "<term>\n");
266 //wrbuf_printf(wrbuf, "<id>%s</id>\n", ht[i].id);
267 wrbuf_puts(wrbuf, "<id>");
268 wrbuf_xmlputs(wrbuf, ht[i].id);
269 wrbuf_puts(wrbuf, "</id>\n");
271 wrbuf_puts(wrbuf, "<name>");
272 if (!ht[i].name || !ht[i].name[0])
273 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
275 wrbuf_xmlputs(wrbuf, ht[i].name);
276 wrbuf_puts(wrbuf, "</name>\n");
278 wrbuf_printf(wrbuf, "<frequency>%d</frequency>\n", ht[i].hits);
280 //wrbuf_printf(wrbuf, "<state>%s</state>\n", ht[i].state);
281 wrbuf_puts(wrbuf, "<state>");
282 wrbuf_xmlputs(wrbuf, ht[i].state);
283 wrbuf_puts(wrbuf, "</state>\n");
285 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
287 wrbuf_puts(wrbuf, "</term>\n");
291 static void cmd_termlist(struct http_channel *c)
293 struct http_response *rs = c->response;
294 struct http_request *rq = c->request;
295 struct http_session *s = locate_session(rq, rs);
296 struct termlist_score **p;
299 char *name = http_argbyname(rq, "name");
300 char *nums = http_argbyname(rq, "num");
307 status = session_active_clients(s->psession);
311 if (strlen(name) > 255)
316 wrbuf_rewind(c->wrbuf);
318 wrbuf_puts(c->wrbuf, "<termlist>\n");
319 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
325 if (!(tp = strchr(name, ',')))
326 tp = name + strlen(name);
327 strncpy(tname, name, tp - name);
328 tname[tp - name] = '\0';
330 wrbuf_puts(c->wrbuf, "<list name=\"");
331 wrbuf_xmlputs(c->wrbuf, tname);
332 wrbuf_puts(c->wrbuf, "\">\n");
333 if (!strcmp(tname, "xtargets"))
334 targets_termlist(c->wrbuf, s->psession, num);
337 p = termlist(s->psession, tname, &len);
339 for (i = 0; i < len && i < num; i++){
340 // prevnt sending empty term elements
341 if (!p[i]->term || !p[i]->term[0])
344 wrbuf_puts(c->wrbuf, "<term>");
345 wrbuf_puts(c->wrbuf, "<name>");
346 wrbuf_xmlputs(c->wrbuf, p[i]->term);
347 wrbuf_puts(c->wrbuf, "</name>");
349 wrbuf_printf(c->wrbuf,
350 "<frequency>%d</frequency>",
352 wrbuf_puts(c->wrbuf, "</term>\n");
355 wrbuf_puts(c->wrbuf, "</list>\n");
360 wrbuf_puts(c->wrbuf, "</termlist>\n");
361 rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
362 http_send_response(c);
366 static void cmd_bytarget(struct http_channel *c)
368 struct http_response *rs = c->response;
369 struct http_request *rq = c->request;
370 struct http_session *s = locate_session(rq, rs);
371 struct hitsbytarget *ht;
376 if (!(ht = hitsbytarget(s->psession, &count)))
378 error(rs, "500", "Failed to retrieve hitcounts", 0);
381 wrbuf_rewind(c->wrbuf);
382 wrbuf_puts(c->wrbuf, "<bytarget><status>OK</status>");
384 for (i = 0; i < count; i++)
386 wrbuf_puts(c->wrbuf, "\n<target>");
388 //wrbuf_printf(c->wrbuf, "<id>%s</id>\n", ht[i].id);
389 wrbuf_puts(c->wrbuf, "<id>");
390 wrbuf_xmlputs(c->wrbuf, ht[i].id);
391 wrbuf_puts(c->wrbuf, "</id>\n");
393 wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", ht[i].hits);
394 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
395 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
397 //wrbuf_printf(c->wrbuf, "<state>%s</state>\n", ht[i].state);
398 wrbuf_puts(c->wrbuf, "<state>");
399 wrbuf_xmlputs(c->wrbuf, ht[i].state);
400 wrbuf_puts(c->wrbuf, "</state\n");
402 wrbuf_puts(c->wrbuf, "</target>");
405 wrbuf_puts(c->wrbuf, "</bytarget>");
406 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
407 http_send_response(c);
410 static void write_metadata(WRBUF w, struct conf_service *service,
411 struct record_metadata **ml, int full)
415 for (imeta = 0; imeta < service->num_metadata; imeta++)
417 struct conf_metadata *cmd = &service->metadata[imeta];
418 struct record_metadata *md;
419 if (!cmd->brief && !full)
421 for (md = ml[imeta]; md; md = md->next)
423 wrbuf_printf(w, "\n<md-%s>", cmd->name);
427 case Metadata_type_generic:
428 wrbuf_puts(w, md->data.text);
430 case Metadata_type_year:
431 wrbuf_printf(w, "%d", md->data.number.min);
432 if (md->data.number.min != md->data.number.max)
433 wrbuf_printf(w, "-%d", md->data.number.max);
436 wrbuf_puts(w, "[can't represent]");
438 wrbuf_printf(w, "</md-%s>", cmd->name);
443 static void write_subrecord(struct record *r, WRBUF w,
444 struct conf_service *service, int show_details)
446 char *name = session_setting_oneval(client_get_database(r->client), PZ_NAME);
448 wrbuf_puts(w, "<location id=\"");
449 wrbuf_xmlputs(w, client_get_database(r->client)->database->url);
450 wrbuf_puts(w, "\" ");
452 wrbuf_puts(w, "name=\"");
453 wrbuf_xmlputs(w, *name ? name : "Unknown");
454 wrbuf_puts(w, "\">");
457 write_metadata(w, service, r->metadata, 1);
458 wrbuf_puts(w, "</location>\n");
461 static void cmd_record(struct http_channel *c)
463 struct http_response *rs = c->response;
464 struct http_request *rq = c->request;
465 struct http_session *s = locate_session(rq, rs);
466 struct record_cluster *rec;
468 struct conf_service *service = global_parameters.server->service;
469 char *idstr = http_argbyname(rq, "id");
476 error(rs, "417", "Must supply id", 0);
479 wrbuf_rewind(c->wrbuf);
481 if (!(rec = show_single(s->psession, id)))
483 error(rs, "500", "Record missing", 0);
486 wrbuf_puts(c->wrbuf, "<record>\n");
487 wrbuf_printf(c->wrbuf, "<recid>%d</recid>\n", rec->recid);
488 write_metadata(c->wrbuf, service, rec->metadata, 1);
489 for (r = rec->records; r; r = r->next)
490 write_subrecord(r, c->wrbuf, service, 1);
491 wrbuf_puts(c->wrbuf, "</record>\n");
492 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
493 http_send_response(c);
496 static void show_records(struct http_channel *c, int active)
498 struct http_request *rq = c->request;
499 struct http_response *rs = c->response;
500 struct http_session *s = locate_session(rq, rs);
501 struct record_cluster **rl;
502 struct reclist_sortparms *sp;
503 char *start = http_argbyname(rq, "start");
504 char *num = http_argbyname(rq, "num");
505 char *sort = http_argbyname(rq, "sort");
515 // We haven't counted clients yet if we're called on a block release
517 active = session_active_clients(s->psession);
520 startn = atoi(start);
525 if (!(sp = reclist_parse_sortparms(c->nmem, sort)))
527 error(rs, "500", "Bad sort parameters", 0);
531 rl = show(s->psession, sp, startn, &numn, &total, &total_hits, c->nmem);
533 wrbuf_rewind(c->wrbuf);
534 wrbuf_puts(c->wrbuf, "<show>\n<status>OK</status>\n");
535 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
536 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
537 wrbuf_printf(c->wrbuf, "<total>%d</total>\n", total_hits);
538 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
539 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
541 for (i = 0; i < numn; i++)
545 struct record_cluster *rec = rl[i];
546 struct conf_service *service = global_parameters.server->service;
548 wrbuf_puts(c->wrbuf, "<hit>\n");
549 write_metadata(c->wrbuf, service, rec->metadata, 0);
550 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
551 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
553 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
554 wrbuf_printf(c->wrbuf, "<recid>%d</recid>\n", rec->recid);
555 wrbuf_puts(c->wrbuf, "</hit>\n");
558 wrbuf_puts(c->wrbuf, "</show>\n");
559 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
560 http_send_response(c);
563 static void show_records_ready(void *data)
565 struct http_channel *c = (struct http_channel *) data;
570 static void cmd_show(struct http_channel *c)
572 struct http_request *rq = c->request;
573 struct http_response *rs = c->response;
574 struct http_session *s = locate_session(rq, rs);
575 char *block = http_argbyname(rq, "block");
581 status = session_active_clients(s->psession);
585 if (status && (!s->psession->reclist || !s->psession->reclist->num_records))
587 session_set_watch(s->psession, SESSION_WATCH_RECORDS, show_records_ready, c);
588 yaz_log(YLOG_DEBUG, "Blocking on cmd_show");
593 show_records(c, status);
596 static void cmd_ping(struct http_channel *c)
598 struct http_request *rq = c->request;
599 struct http_response *rs = c->response;
600 struct http_session *s = locate_session(rq, rs);
603 rs->payload = "<ping><status>OK</status></ping>";
604 http_send_response(c);
607 static int utf_8_valid(const char *str)
609 yaz_iconv_t cd = yaz_iconv_open("utf-8", "utf-8");
612 /* check that query is UTF-8 encoded */
613 char *inbuf = (char *) str; /* we know iconv does not alter this */
614 size_t inbytesleft = strlen(inbuf);
616 size_t outbytesleft = strlen(inbuf) + 10;
617 char *out = xmalloc(outbytesleft);
619 size_t r = yaz_iconv(cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft);
621 /* if OK, try flushing the rest */
622 if (r != (size_t) (-1))
623 r = yaz_iconv(cd, 0, 0, &outbuf, &outbytesleft);
626 if (r == (size_t) (-1))
632 static void cmd_search(struct http_channel *c)
634 struct http_request *rq = c->request;
635 struct http_response *rs = c->response;
636 struct http_session *s = locate_session(rq, rs);
637 char *query = http_argbyname(rq, "query");
638 char *filter = http_argbyname(rq, "filter");
645 error(rs, "417", "Must supply query", 0);
648 if (!utf_8_valid(query))
650 error(rs, "417", "Query not UTF-8 encoded", 0);
653 res = search(s->psession, query, filter);
656 error(rs, "417", res, 0);
659 rs->payload = "<search><status>OK</status></search>";
660 http_send_response(c);
664 static void cmd_stat(struct http_channel *c)
666 struct http_request *rq = c->request;
667 struct http_response *rs = c->response;
668 struct http_session *s = locate_session(rq, rs);
669 struct statistics stat;
675 clients = session_active_clients(s->psession);
676 statistics(s->psession, &stat);
678 wrbuf_rewind(c->wrbuf);
679 wrbuf_puts(c->wrbuf, "<stat>");
680 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
681 wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", stat.num_hits);
682 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
683 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
684 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
685 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
686 wrbuf_printf(c->wrbuf, "<initializing>%d</initializing>\n", stat.num_initializing);
687 wrbuf_printf(c->wrbuf, "<searching>%d</searching>\n", stat.num_searching);
688 wrbuf_printf(c->wrbuf, "<presenting>%d</presenting>\n", stat.num_presenting);
689 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
690 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
691 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
692 wrbuf_puts(c->wrbuf, "</stat>");
693 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
694 http_send_response(c);
697 static void cmd_info(struct http_channel *c)
699 char yaz_version_str[20];
700 struct http_response *rs = c->response;
702 wrbuf_rewind(c->wrbuf);
703 wrbuf_puts(c->wrbuf, "<info>\n");
704 wrbuf_puts(c->wrbuf, " <version>\n");
705 //wrbuf_printf(c->wrbuf, " <pazpar2>%s</pazpar2>\n", VERSION);
706 wrbuf_puts(c->wrbuf, "<pazpar2>");
707 wrbuf_xmlputs(c->wrbuf, VERSION);
708 wrbuf_puts(c->wrbuf, "</pazpar2>");
711 yaz_version(yaz_version_str, 0);
712 //wrbuf_printf(c->wrbuf, " <yaz compiled=\"%s\">%s</yaz>\n",
713 // YAZ_VERSION, yaz_version_str);
714 wrbuf_puts(c->wrbuf, " <yaz compiled=\"");
715 wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
716 wrbuf_puts(c->wrbuf, "\">");
717 wrbuf_xmlputs(c->wrbuf, yaz_version_str);
718 wrbuf_puts(c->wrbuf, "</yaz>\n");
720 wrbuf_puts(c->wrbuf, " </version>\n");
722 wrbuf_puts(c->wrbuf, "</info>");
723 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
724 http_send_response(c);
729 void (*fun)(struct http_channel *c);
731 { "init", cmd_init },
732 { "settings", cmd_settings },
733 { "stat", cmd_stat },
734 { "bytarget", cmd_bytarget },
735 { "show", cmd_show },
736 { "search", cmd_search },
737 { "termlist", cmd_termlist },
738 { "exit", cmd_exit },
739 { "ping", cmd_ping },
740 { "record", cmd_record },
741 { "info", cmd_info },
745 void http_command(struct http_channel *c)
747 char *command = http_argbyname(c->request, "command");
748 struct http_response *rs = http_create_response(c);
753 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
754 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
758 error(rs, "417", "Must supply command", 0);
761 for (i = 0; commands[i].name; i++)
762 if (!strcmp(commands[i].name, command))
764 (*commands[i].fun)(c);
767 if (!commands[i].name)
768 error(rs, "417", "Unknown command", command);
776 * indent-tabs-mode: nil
778 * vim: shiftwidth=4 tabstop=8 expandtab