1 /* $Id: http_command.c,v 1.43 2007-05-23 09:57:54 adam 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.43 2007-05-23 09:57:54 adam 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()
136 if (gettimeofday(&t, 0) < 0)
139 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
144 static struct http_session *locate_session(struct http_request *rq, struct http_response *rs)
146 struct http_session *p;
147 char *session = http_argbyname(rq, "session");
152 error(rs, "417", "Must supply session", 0);
156 for (p = session_list; p; p = p->next)
157 if (id == p->session_id)
159 iochan_activity(p->timeout_iochan);
162 error(rs, "417", "Session does not exist, or it has expired", 0);
166 // Decode settings parameters and apply to session
167 // Syntax: setting[target]=value
168 static int process_settings(struct session *se, struct http_request *rq,
169 struct http_response *rs)
171 struct http_argument *a;
173 for (a = rq->arguments; a; a = a->next)
174 if (strchr(a->name, '['))
181 // Nmem_strsplit *rules*!!!
182 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
185 error(rs, "417", "Malformed setting argument", a->name);
190 session_apply_setting(se, dbname, setting,
191 nmem_strdup(se->session_nmem, a->value));
196 static void cmd_exit(struct http_channel *c)
198 yaz_log(YLOG_WARN, "exit");
202 static void cmd_init(struct http_channel *c)
206 struct http_session *s = http_session_create();
207 struct http_response *rs = c->response;
209 yaz_log(YLOG_DEBUG, "HTTP Session init");
210 sesid = make_sessionid();
211 s->session_id = sesid;
212 if (process_settings(s->psession, c->request, c->response) < 0)
214 sprintf(buf, "<init><status>OK</status><session>%u</session>"
215 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol></init>", sesid);
216 rs->payload = nmem_strdup(c->nmem, buf);
217 http_send_response(c);
220 static void cmd_settings(struct http_channel *c)
222 struct http_response *rs = c->response;
223 struct http_request *rq = c->request;
224 struct http_session *s = locate_session(rq, rs);
229 if (process_settings(s->psession, rq, rs) < 0)
231 rs->payload = "<settings><status>OK</status></settings>";
232 http_send_response(c);
235 // Compares two hitsbytarget nodes by hitcount
236 static int cmp_ht(const void *p1, const void *p2)
238 const struct hitsbytarget *h1 = p1;
239 const struct hitsbytarget *h2 = p2;
240 return h2->hits - h1->hits;
243 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
244 static void targets_termlist(WRBUF wrbuf, struct session *se, int num)
246 struct hitsbytarget *ht;
249 if (!(ht = hitsbytarget(se, &count)))
251 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
252 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
254 wrbuf_puts(wrbuf, "\n<term>\n");
255 wrbuf_printf(wrbuf, "<id>%s</id>\n", ht[i].id);
256 wrbuf_printf(wrbuf, "<name>%s</name>\n", ht[i].name);
257 wrbuf_printf(wrbuf, "<frequency>%d</frequency>\n", ht[i].hits);
258 wrbuf_printf(wrbuf, "<state>%s</state>\n", ht[i].state);
259 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
260 wrbuf_puts(wrbuf, "\n</term>\n");
264 static void cmd_termlist(struct http_channel *c)
266 struct http_response *rs = c->response;
267 struct http_request *rq = c->request;
268 struct http_session *s = locate_session(rq, rs);
269 struct termlist_score **p;
272 char *name = http_argbyname(rq, "name");
273 char *nums = http_argbyname(rq, "num");
280 status = session_active_clients(s->psession);
284 if (strlen(name) > 255)
289 wrbuf_rewind(c->wrbuf);
291 wrbuf_puts(c->wrbuf, "<termlist>");
292 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>", status);
298 if (!(tp = strchr(name, ',')))
299 tp = name + strlen(name);
300 strncpy(tname, name, tp - name);
301 tname[tp - name] = '\0';
303 wrbuf_printf(c->wrbuf, "\n<list name=\"%s\">\n", tname);
304 if (!strcmp(tname, "xtargets"))
305 targets_termlist(c->wrbuf, s->psession, num);
308 p = termlist(s->psession, tname, &len);
310 for (i = 0; i < len && i < num; i++)
312 wrbuf_puts(c->wrbuf, "\n<term>");
313 wrbuf_printf(c->wrbuf, "<name>%s</name>", p[i]->term);
314 wrbuf_printf(c->wrbuf, "<frequency>%d</frequency>", p[i]->frequency);
315 wrbuf_puts(c->wrbuf, "</term>");
318 wrbuf_puts(c->wrbuf, "\n</list>");
323 wrbuf_puts(c->wrbuf, "</termlist>");
324 rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
325 http_send_response(c);
329 static void cmd_bytarget(struct http_channel *c)
331 struct http_response *rs = c->response;
332 struct http_request *rq = c->request;
333 struct http_session *s = locate_session(rq, rs);
334 struct hitsbytarget *ht;
339 if (!(ht = hitsbytarget(s->psession, &count)))
341 error(rs, "500", "Failed to retrieve hitcounts", 0);
344 wrbuf_rewind(c->wrbuf);
345 wrbuf_puts(c->wrbuf, "<bytarget><status>OK</status>");
347 for (i = 0; i < count; i++)
349 wrbuf_puts(c->wrbuf, "\n<target>");
350 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", ht[i].id);
351 wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", ht[i].hits);
352 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
353 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
354 wrbuf_printf(c->wrbuf, "<state>%s</state>\n", ht[i].state);
355 wrbuf_puts(c->wrbuf, "</target>");
358 wrbuf_puts(c->wrbuf, "</bytarget>");
359 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
360 http_send_response(c);
363 static void write_metadata(WRBUF w, struct conf_service *service,
364 struct record_metadata **ml, int full)
368 for (imeta = 0; imeta < service->num_metadata; imeta++)
370 struct conf_metadata *cmd = &service->metadata[imeta];
371 struct record_metadata *md;
372 if (!cmd->brief && !full)
374 for (md = ml[imeta]; md; md = md->next)
376 wrbuf_printf(w, "\n<md-%s>", cmd->name);
379 case Metadata_type_generic:
380 wrbuf_puts(w, md->data.text);
382 case Metadata_type_year:
383 wrbuf_printf(w, "%d", md->data.number.min);
384 if (md->data.number.min != md->data.number.max)
385 wrbuf_printf(w, "-%d", md->data.number.max);
388 wrbuf_puts(w, "[can't represent]");
390 wrbuf_printf(w, "</md-%s>", cmd->name);
395 static void write_subrecord(struct record *r, WRBUF w,
396 struct conf_service *service, int show_details)
398 char *name = session_setting_oneval(client_get_database(r->client), PZ_NAME);
400 wrbuf_printf(w, "<location id=\"%s\" name=\"%s\">",
401 client_get_database(r->client)->database->url,
402 *name ? name : "Unknown");
404 write_metadata(w, service, r->metadata, 1);
405 wrbuf_puts(w, "</location>\n");
408 static void cmd_record(struct http_channel *c)
410 struct http_response *rs = c->response;
411 struct http_request *rq = c->request;
412 struct http_session *s = locate_session(rq, rs);
413 struct record_cluster *rec;
415 struct conf_service *service = global_parameters.server->service;
416 char *idstr = http_argbyname(rq, "id");
423 error(rs, "417", "Must supply id", 0);
426 wrbuf_rewind(c->wrbuf);
428 if (!(rec = show_single(s->psession, id)))
430 error(rs, "500", "Record missing", 0);
433 wrbuf_puts(c->wrbuf, "<record>\n");
434 wrbuf_printf(c->wrbuf, "<recid>%d</recid>", rec->recid);
435 write_metadata(c->wrbuf, service, rec->metadata, 1);
436 for (r = rec->records; r; r = r->next)
437 write_subrecord(r, c->wrbuf, service, 1);
438 wrbuf_puts(c->wrbuf, "</record>\n");
439 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
440 http_send_response(c);
443 static void show_records(struct http_channel *c, int active)
445 struct http_request *rq = c->request;
446 struct http_response *rs = c->response;
447 struct http_session *s = locate_session(rq, rs);
448 struct record_cluster **rl;
449 struct reclist_sortparms *sp;
450 char *start = http_argbyname(rq, "start");
451 char *num = http_argbyname(rq, "num");
452 char *sort = http_argbyname(rq, "sort");
462 // We haven't counted clients yet if we're called on a block release
464 active = session_active_clients(s->psession);
467 startn = atoi(start);
472 if (!(sp = reclist_parse_sortparms(c->nmem, sort)))
474 error(rs, "500", "Bad sort parameters", 0);
478 rl = show(s->psession, sp, startn, &numn, &total, &total_hits, c->nmem);
480 wrbuf_rewind(c->wrbuf);
481 wrbuf_puts(c->wrbuf, "<show>\n<status>OK</status>\n");
482 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
483 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
484 wrbuf_printf(c->wrbuf, "<total>%d</total>\n", total_hits);
485 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
486 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
488 for (i = 0; i < numn; i++)
492 struct record_cluster *rec = rl[i];
493 struct conf_service *service = global_parameters.server->service;
495 wrbuf_puts(c->wrbuf, "<hit>\n");
496 write_metadata(c->wrbuf, service, rec->metadata, 0);
497 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
498 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
500 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
501 wrbuf_printf(c->wrbuf, "<recid>%d</recid>\n", rec->recid);
502 wrbuf_puts(c->wrbuf, "</hit>\n");
505 wrbuf_puts(c->wrbuf, "</show>\n");
506 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
507 http_send_response(c);
510 static void show_records_ready(void *data)
512 struct http_channel *c = (struct http_channel *) data;
517 static void cmd_show(struct http_channel *c)
519 struct http_request *rq = c->request;
520 struct http_response *rs = c->response;
521 struct http_session *s = locate_session(rq, rs);
522 char *block = http_argbyname(rq, "block");
528 status = session_active_clients(s->psession);
532 if (status && (!s->psession->reclist || !s->psession->reclist->num_records))
534 session_set_watch(s->psession, SESSION_WATCH_RECORDS, show_records_ready, c);
535 yaz_log(YLOG_DEBUG, "Blocking on cmd_show");
540 show_records(c, status);
543 static void cmd_ping(struct http_channel *c)
545 struct http_request *rq = c->request;
546 struct http_response *rs = c->response;
547 struct http_session *s = locate_session(rq, rs);
550 rs->payload = "<ping><status>OK</status></ping>";
551 http_send_response(c);
554 static int utf_8_valid(const char *str)
556 yaz_iconv_t cd = yaz_iconv_open("utf-8", "utf-8");
559 /* check that query is UTF-8 encoded */
560 char *inbuf = (char *) str; /* we know iconv does not alter this */
561 size_t inbytesleft = strlen(inbuf);
563 size_t outbytesleft = strlen(inbuf) + 10;
564 char *out = xmalloc(outbytesleft);
566 size_t r = yaz_iconv(cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft);
568 /* if OK, try flushing the rest */
569 if (r != (size_t) (-1))
570 r = yaz_iconv(cd, 0, 0, &outbuf, &outbytesleft);
573 if (r == (size_t) (-1))
579 static void cmd_search(struct http_channel *c)
581 struct http_request *rq = c->request;
582 struct http_response *rs = c->response;
583 struct http_session *s = locate_session(rq, rs);
584 char *query = http_argbyname(rq, "query");
585 char *filter = http_argbyname(rq, "filter");
592 error(rs, "417", "Must supply query", 0);
595 if (!utf_8_valid(query))
597 error(rs, "417", "Query not UTF-8 encoded", 0);
600 res = search(s->psession, query, filter);
603 error(rs, "417", res, 0);
606 rs->payload = "<search><status>OK</status></search>";
607 http_send_response(c);
611 static void cmd_stat(struct http_channel *c)
613 struct http_request *rq = c->request;
614 struct http_response *rs = c->response;
615 struct http_session *s = locate_session(rq, rs);
616 struct statistics stat;
622 clients = session_active_clients(s->psession);
623 statistics(s->psession, &stat);
625 wrbuf_rewind(c->wrbuf);
626 wrbuf_puts(c->wrbuf, "<stat>");
627 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
628 wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", stat.num_hits);
629 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
630 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
631 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
632 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
633 wrbuf_printf(c->wrbuf, "<initializing>%d</initializing>\n", stat.num_initializing);
634 wrbuf_printf(c->wrbuf, "<searching>%d</searching>\n", stat.num_searching);
635 wrbuf_printf(c->wrbuf, "<presenting>%d</presenting>\n", stat.num_presenting);
636 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
637 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
638 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
639 wrbuf_puts(c->wrbuf, "</stat>");
640 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
641 http_send_response(c);
644 static void cmd_info(struct http_channel *c)
646 char yaz_version_str[20];
647 struct http_response *rs = c->response;
649 wrbuf_rewind(c->wrbuf);
650 wrbuf_puts(c->wrbuf, "<info>\n");
651 wrbuf_printf(c->wrbuf, " <version>\n");
652 wrbuf_printf(c->wrbuf, " <pazpar2>%s</pazpar2>\n", VERSION);
654 yaz_version(yaz_version_str, 0);
655 wrbuf_printf(c->wrbuf, " <yaz compiled=\"%s\">%s</yaz>\n",
656 YAZ_VERSION, yaz_version_str);
657 wrbuf_printf(c->wrbuf, " </version>\n");
659 wrbuf_puts(c->wrbuf, "</info>");
660 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
661 http_send_response(c);
666 void (*fun)(struct http_channel *c);
668 { "init", cmd_init },
669 { "settings", cmd_settings },
670 { "stat", cmd_stat },
671 { "bytarget", cmd_bytarget },
672 { "show", cmd_show },
673 { "search", cmd_search },
674 { "termlist", cmd_termlist },
675 { "exit", cmd_exit },
676 { "ping", cmd_ping },
677 { "record", cmd_record },
678 { "info", cmd_info },
682 void http_command(struct http_channel *c)
684 char *command = http_argbyname(c->request, "command");
685 struct http_response *rs = http_create_response(c);
690 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
691 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
695 error(rs, "417", "Must supply command", 0);
698 for (i = 0; commands[i].name; i++)
699 if (!strcmp(commands[i].name, command))
701 (*commands[i].fun)(c);
704 if (!commands[i].name)
705 error(rs, "417", "Unknown command", command);
713 * indent-tabs-mode: nil
715 * vim: shiftwidth=4 tabstop=8 expandtab