1 /* $Id: http_command.c,v 1.40 2007-04-19 16:07:20 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.40 2007-04-19 16:07:20 adam Exp $
27 #include <sys/types.h>
39 #include <yaz/yaz-util.h>
46 #include "http_command.h"
49 // Update this when the protocol changes
50 #define PAZPAR2_PROTOCOL_VERSION "1"
53 IOCHAN timeout_iochan; // NOTE: This is NOT associated with a socket
54 struct session *psession;
55 unsigned int session_id;
58 struct http_session *next;
61 static struct http_session *session_list = 0;
63 void http_session_destroy(struct http_session *s);
65 static void session_timeout(IOCHAN i, int event)
67 struct http_session *s = iochan_getdata(i);
68 http_session_destroy(s);
71 struct http_session *http_session_create()
73 NMEM nmem = nmem_create();
74 struct http_session *r = nmem_malloc(nmem, sizeof(*r));
76 r->psession = new_session(nmem);
80 r->next = session_list;
82 r->timeout_iochan = iochan_create(-1, session_timeout, 0);
83 iochan_setdata(r->timeout_iochan, r);
84 iochan_settimeout(r->timeout_iochan, global_parameters.session_timeout);
86 pazpar2_add_channel(r->timeout_iochan);
90 void http_session_destroy(struct http_session *s)
92 struct http_session **p;
94 for (p = &session_list; *p; p = &(*p)->next)
100 iochan_destroy(s->timeout_iochan);
101 destroy_session(s->psession);
102 nmem_destroy(s->nmem);
105 static void error(struct http_response *rs, char *code, char *msg, char *txt)
107 struct http_channel *c = rs->channel;
112 rs->msg = nmem_strdup(c->nmem, msg);
113 strcpy(rs->code, code);
114 sprintf(tmp, "<error code=\"general\">%s</error>", txt);
115 rs->payload = nmem_strdup(c->nmem, tmp);
116 http_send_response(c);
119 unsigned int make_sessionid()
126 if (gettimeofday(&t, 0) < 0)
129 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
133 static struct http_session *locate_session(struct http_request *rq, struct http_response *rs)
135 struct http_session *p;
136 char *session = http_argbyname(rq, "session");
141 error(rs, "417", "Must supply session", 0);
145 for (p = session_list; p; p = p->next)
146 if (id == p->session_id)
148 iochan_activity(p->timeout_iochan);
151 error(rs, "417", "Session does not exist, or it has expired", 0);
155 // Decode settings parameters and apply to session
156 // Syntax: setting[target]=value
157 static int process_settings(struct session *se, struct http_request *rq,
158 struct http_response *rs)
160 struct http_argument *a;
162 for (a = rq->arguments; a; a = a->next)
163 if (strchr(a->name, '['))
170 // Nmem_strsplit *rules*!!!
171 nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
174 error(rs, "417", "Malformed setting argument", 0);
175 yaz_log(YLOG_WARN, "Malformed setting: %s", a->name);
180 session_apply_setting(se, dbname, setting,
181 nmem_strdup(se->session_nmem, a->value));
186 static void cmd_exit(struct http_channel *c)
188 yaz_log(YLOG_WARN, "exit");
192 static void cmd_init(struct http_channel *c)
196 struct http_session *s = http_session_create();
197 struct http_response *rs = c->response;
199 yaz_log(YLOG_DEBUG, "HTTP Session init");
200 sesid = make_sessionid();
201 s->session_id = sesid;
202 if (process_settings(s->psession, c->request, c->response) < 0)
204 sprintf(buf, "<init><status>OK</status><session>%u</session>"
205 "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol></init>", sesid);
206 rs->payload = nmem_strdup(c->nmem, buf);
207 http_send_response(c);
210 static void cmd_settings(struct http_channel *c)
212 struct http_response *rs = c->response;
213 struct http_request *rq = c->request;
214 struct http_session *s = locate_session(rq, rs);
219 if (process_settings(s->psession, rq, rs) < 0)
221 rs->payload = "<settings><status>OK</status></settings>";
222 http_send_response(c);
225 // Compares two hitsbytarget nodes by hitcount
226 static int cmp_ht(const void *p1, const void *p2)
228 const struct hitsbytarget *h1 = p1;
229 const struct hitsbytarget *h2 = p2;
230 return h2->hits - h1->hits;
233 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
234 static void targets_termlist(WRBUF wrbuf, struct session *se, int num)
236 struct hitsbytarget *ht;
239 if (!(ht = hitsbytarget(se, &count)))
241 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
242 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
244 wrbuf_puts(wrbuf, "\n<term>\n");
245 wrbuf_printf(wrbuf, "<id>%s</id>\n", ht[i].id);
246 wrbuf_printf(wrbuf, "<name>%s</name>\n", ht[i].name);
247 wrbuf_printf(wrbuf, "<frequency>%d</frequency>\n", ht[i].hits);
248 wrbuf_printf(wrbuf, "<state>%s</state>\n", ht[i].state);
249 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
250 wrbuf_puts(wrbuf, "\n</term>\n");
254 static void cmd_termlist(struct http_channel *c)
256 struct http_response *rs = c->response;
257 struct http_request *rq = c->request;
258 struct http_session *s = locate_session(rq, rs);
259 struct termlist_score **p;
262 char *name = http_argbyname(rq, "name");
263 char *nums = http_argbyname(rq, "num");
270 status = session_active_clients(s->psession);
274 if (strlen(name) > 255)
279 wrbuf_rewind(c->wrbuf);
281 wrbuf_puts(c->wrbuf, "<termlist>");
282 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>", status);
288 if (!(tp = strchr(name, ',')))
289 tp = name + strlen(name);
290 strncpy(tname, name, tp - name);
291 tname[tp - name] = '\0';
293 wrbuf_printf(c->wrbuf, "\n<list name=\"%s\">\n", tname);
294 if (!strcmp(tname, "xtargets"))
295 targets_termlist(c->wrbuf, s->psession, num);
298 p = termlist(s->psession, tname, &len);
300 for (i = 0; i < len && i < num; i++)
302 wrbuf_puts(c->wrbuf, "\n<term>");
303 wrbuf_printf(c->wrbuf, "<name>%s</name>", p[i]->term);
304 wrbuf_printf(c->wrbuf, "<frequency>%d</frequency>", p[i]->frequency);
305 wrbuf_puts(c->wrbuf, "</term>");
308 wrbuf_puts(c->wrbuf, "\n</list>");
313 wrbuf_puts(c->wrbuf, "</termlist>");
314 rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
315 http_send_response(c);
319 static void cmd_bytarget(struct http_channel *c)
321 struct http_response *rs = c->response;
322 struct http_request *rq = c->request;
323 struct http_session *s = locate_session(rq, rs);
324 struct hitsbytarget *ht;
329 if (!(ht = hitsbytarget(s->psession, &count)))
331 error(rs, "500", "Failed to retrieve hitcounts", 0);
334 wrbuf_rewind(c->wrbuf);
335 wrbuf_puts(c->wrbuf, "<bytarget><status>OK</status>");
337 for (i = 0; i < count; i++)
339 wrbuf_puts(c->wrbuf, "\n<target>");
340 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", ht[i].id);
341 wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", ht[i].hits);
342 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
343 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
344 wrbuf_printf(c->wrbuf, "<state>%s</state>\n", ht[i].state);
345 wrbuf_puts(c->wrbuf, "</target>");
348 wrbuf_puts(c->wrbuf, "</bytarget>");
349 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
350 http_send_response(c);
353 static void write_metadata(WRBUF w, struct conf_service *service,
354 struct record_metadata **ml, int full)
358 for (imeta = 0; imeta < service->num_metadata; imeta++)
360 struct conf_metadata *cmd = &service->metadata[imeta];
361 struct record_metadata *md;
362 if (!cmd->brief && !full)
364 for (md = ml[imeta]; md; md = md->next)
366 wrbuf_printf(w, "\n<md-%s>", cmd->name);
369 case Metadata_type_generic:
370 wrbuf_puts(w, md->data.text);
372 case Metadata_type_year:
373 wrbuf_printf(w, "%d", md->data.number.min);
374 if (md->data.number.min != md->data.number.max)
375 wrbuf_printf(w, "-%d", md->data.number.max);
378 wrbuf_puts(w, "[can't represent]");
380 wrbuf_printf(w, "</md-%s>", cmd->name);
385 static void write_subrecord(struct record *r, WRBUF w,
386 struct conf_service *service, int show_details)
388 char *name = session_setting_oneval(r->client->database, PZ_NAME);
390 wrbuf_printf(w, "<location id=\"%s\" name=\"%s\">",
391 r->client->database->database->url,
392 *name ? name : "Unknown");
394 write_metadata(w, service, r->metadata, 1);
395 wrbuf_puts(w, "</location>\n");
398 static void cmd_record(struct http_channel *c)
400 struct http_response *rs = c->response;
401 struct http_request *rq = c->request;
402 struct http_session *s = locate_session(rq, rs);
403 struct record_cluster *rec;
405 struct conf_service *service = global_parameters.server->service;
406 char *idstr = http_argbyname(rq, "id");
413 error(rs, "417", "Must supply id", 0);
416 wrbuf_rewind(c->wrbuf);
418 if (!(rec = show_single(s->psession, id)))
420 error(rs, "500", "Record missing", 0);
423 wrbuf_puts(c->wrbuf, "<record>\n");
424 wrbuf_printf(c->wrbuf, "<recid>%d</recid>", rec->recid);
425 write_metadata(c->wrbuf, service, rec->metadata, 1);
426 for (r = rec->records; r; r = r->next)
427 write_subrecord(r, c->wrbuf, service, 1);
428 wrbuf_puts(c->wrbuf, "</record>\n");
429 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
430 http_send_response(c);
433 static void show_records(struct http_channel *c, int active)
435 struct http_request *rq = c->request;
436 struct http_response *rs = c->response;
437 struct http_session *s = locate_session(rq, rs);
438 struct record_cluster **rl;
439 struct reclist_sortparms *sp;
440 char *start = http_argbyname(rq, "start");
441 char *num = http_argbyname(rq, "num");
442 char *sort = http_argbyname(rq, "sort");
452 // We haven't counted clients yet if we're called on a block release
454 active = session_active_clients(s->psession);
457 startn = atoi(start);
462 if (!(sp = reclist_parse_sortparms(c->nmem, sort)))
464 error(rs, "500", "Bad sort parameters", 0);
468 rl = show(s->psession, sp, startn, &numn, &total, &total_hits, c->nmem);
470 wrbuf_rewind(c->wrbuf);
471 wrbuf_puts(c->wrbuf, "<show>\n<status>OK</status>\n");
472 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
473 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
474 wrbuf_printf(c->wrbuf, "<total>%d</total>\n", total_hits);
475 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
476 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
478 for (i = 0; i < numn; i++)
482 struct record_cluster *rec = rl[i];
483 struct conf_service *service = global_parameters.server->service;
485 wrbuf_puts(c->wrbuf, "<hit>\n");
486 write_metadata(c->wrbuf, service, rec->metadata, 0);
487 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
488 write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
490 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
491 wrbuf_printf(c->wrbuf, "<recid>%d</recid>\n", rec->recid);
492 wrbuf_puts(c->wrbuf, "</hit>\n");
495 wrbuf_puts(c->wrbuf, "</show>\n");
496 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
497 http_send_response(c);
500 static void show_records_ready(void *data)
502 struct http_channel *c = (struct http_channel *) data;
507 static void cmd_show(struct http_channel *c)
509 struct http_request *rq = c->request;
510 struct http_response *rs = c->response;
511 struct http_session *s = locate_session(rq, rs);
512 char *block = http_argbyname(rq, "block");
518 status = session_active_clients(s->psession);
522 if (status && (!s->psession->reclist || !s->psession->reclist->num_records))
524 session_set_watch(s->psession, SESSION_WATCH_RECORDS, show_records_ready, c);
525 yaz_log(YLOG_DEBUG, "Blocking on cmd_show");
530 show_records(c, status);
533 static void cmd_ping(struct http_channel *c)
535 struct http_request *rq = c->request;
536 struct http_response *rs = c->response;
537 struct http_session *s = locate_session(rq, rs);
540 rs->payload = "<ping><status>OK</status></ping>";
541 http_send_response(c);
544 static void cmd_search(struct http_channel *c)
546 struct http_request *rq = c->request;
547 struct http_response *rs = c->response;
548 struct http_session *s = locate_session(rq, rs);
549 char *query = http_argbyname(rq, "query");
550 char *filter = http_argbyname(rq, "filter");
557 error(rs, "417", "Must supply query", 0);
560 res = search(s->psession, query, filter);
563 error(rs, "417", res, res);
566 rs->payload = "<search><status>OK</status></search>";
567 http_send_response(c);
571 static void cmd_stat(struct http_channel *c)
573 struct http_request *rq = c->request;
574 struct http_response *rs = c->response;
575 struct http_session *s = locate_session(rq, rs);
576 struct statistics stat;
582 clients = session_active_clients(s->psession);
583 statistics(s->psession, &stat);
585 wrbuf_rewind(c->wrbuf);
586 wrbuf_puts(c->wrbuf, "<stat>");
587 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
588 wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", stat.num_hits);
589 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
590 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
591 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
592 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
593 wrbuf_printf(c->wrbuf, "<initializing>%d</initializing>\n", stat.num_initializing);
594 wrbuf_printf(c->wrbuf, "<searching>%d</searching>\n", stat.num_searching);
595 wrbuf_printf(c->wrbuf, "<presenting>%d</presenting>\n", stat.num_presenting);
596 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
597 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
598 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
599 wrbuf_puts(c->wrbuf, "</stat>");
600 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
601 http_send_response(c);
604 static void cmd_info(struct http_channel *c)
606 char yaz_version_str[20];
607 struct http_response *rs = c->response;
609 wrbuf_rewind(c->wrbuf);
610 wrbuf_puts(c->wrbuf, "<info>\n");
611 wrbuf_printf(c->wrbuf, " <version>\n");
612 wrbuf_printf(c->wrbuf, " <pazpar2>%s</pazpar2>\n", VERSION);
614 yaz_version(yaz_version_str, 0);
615 wrbuf_printf(c->wrbuf, " <yaz compiled=\"%s\">%s</yaz>\n",
616 YAZ_VERSION, yaz_version_str);
617 wrbuf_printf(c->wrbuf, " </version>\n");
619 wrbuf_puts(c->wrbuf, "</info>");
620 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
621 http_send_response(c);
626 void (*fun)(struct http_channel *c);
628 { "init", cmd_init },
629 { "settings", cmd_settings },
630 { "stat", cmd_stat },
631 { "bytarget", cmd_bytarget },
632 { "show", cmd_show },
633 { "search", cmd_search },
634 { "termlist", cmd_termlist },
635 { "exit", cmd_exit },
636 { "ping", cmd_ping },
637 { "record", cmd_record },
638 { "info", cmd_info },
642 void http_command(struct http_channel *c)
644 char *command = http_argbyname(c->request, "command");
645 struct http_response *rs = http_create_response(c);
650 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
651 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
655 error(rs, "417", "Must supply command", 0);
658 for (i = 0; commands[i].name; i++)
659 if (!strcmp(commands[i].name, command))
661 (*commands[i].fun)(c);
664 if (!commands[i].name)
665 error(rs, "417", "Unknown command", 0);
673 * indent-tabs-mode: nil
675 * vim: shiftwidth=4 tabstop=8 expandtab