2 * $Id: http_command.c,v 1.30 2007-04-08 23:04:20 adam Exp $
18 #include <yaz/yaz-util.h>
25 #include "http_command.h"
27 extern struct parameters global_parameters;
28 extern IOCHAN channel_list;
31 IOCHAN timeout_iochan; // NOTE: This is NOT associated with a socket
32 struct session *psession;
33 unsigned int session_id;
35 struct http_session *next;
38 static struct http_session *session_list = 0;
40 void http_session_destroy(struct http_session *s);
42 static void session_timeout(IOCHAN i, int event)
44 struct http_session *s = iochan_getdata(i);
45 http_session_destroy(s);
48 struct http_session *http_session_create()
50 struct http_session *r = xmalloc(sizeof(*r));
51 r->psession = new_session();
54 r->next = session_list;
56 r->timeout_iochan = iochan_create(-1, session_timeout, 0);
57 iochan_setdata(r->timeout_iochan, r);
58 iochan_settimeout(r->timeout_iochan, global_parameters.session_timeout);
59 r->timeout_iochan->next = channel_list;
60 channel_list = r->timeout_iochan;
64 void http_session_destroy(struct http_session *s)
66 struct http_session **p;
68 for (p = &session_list; *p; p = &(*p)->next)
74 iochan_destroy(s->timeout_iochan);
75 destroy_session(s->psession);
79 static void error(struct http_response *rs, char *code, char *msg, char *txt)
81 struct http_channel *c = rs->channel;
86 rs->msg = nmem_strdup(c->nmem, msg);
87 strcpy(rs->code, code);
88 sprintf(tmp, "<error code=\"general\">%s</error>", txt);
89 rs->payload = nmem_strdup(c->nmem, tmp);
90 http_send_response(c);
93 unsigned int make_sessionid()
100 if (gettimeofday(&t, 0) < 0)
103 res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
107 static struct http_session *locate_session(struct http_request *rq, struct http_response *rs)
109 struct http_session *p;
110 char *session = http_argbyname(rq, "session");
115 error(rs, "417", "Must supply session", 0);
119 for (p = session_list; p; p = p->next)
120 if (id == p->session_id)
122 iochan_activity(p->timeout_iochan);
125 error(rs, "417", "Session does not exist, or it has expired", 0);
129 static void cmd_exit(struct http_channel *c)
131 yaz_log(YLOG_WARN, "exit");
136 static void cmd_init(struct http_channel *c)
140 struct http_session *s = http_session_create();
141 struct http_response *rs = c->response;
143 yaz_log(YLOG_DEBUG, "HTTP Session init");
144 sesid = make_sessionid();
145 s->session_id = sesid;
146 sprintf(buf, "<init><status>OK</status><session>%u</session></init>", sesid);
147 rs->payload = nmem_strdup(c->nmem, buf);
148 http_send_response(c);
151 // Compares two hitsbytarget nodes by hitcount
152 static int cmp_ht(const void *p1, const void *p2)
154 const struct hitsbytarget *h1 = p1;
155 const struct hitsbytarget *h2 = p2;
156 return h2->hits - h1->hits;
159 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
160 static void targets_termlist(WRBUF wrbuf, struct session *se, int num)
162 struct hitsbytarget *ht;
165 if (!(ht = hitsbytarget(se, &count)))
167 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
168 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
170 wrbuf_puts(wrbuf, "\n<term>\n");
171 wrbuf_printf(wrbuf, "<id>%s</id>\n", ht[i].id);
172 wrbuf_printf(wrbuf, "<name>%s</name>\n", ht[i].name);
173 wrbuf_printf(wrbuf, "<frequency>%d</frequency>\n", ht[i].hits);
174 wrbuf_printf(wrbuf, "<state>%s</state>\n", ht[i].state);
175 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
176 wrbuf_puts(wrbuf, "\n</term>\n");
180 static void cmd_termlist(struct http_channel *c)
182 struct http_response *rs = c->response;
183 struct http_request *rq = c->request;
184 struct http_session *s = locate_session(rq, rs);
185 struct termlist_score **p;
188 char *name = http_argbyname(rq, "name");
189 char *nums = http_argbyname(rq, "num");
196 status = session_active_clients(s->psession);
200 if (strlen(name) > 255)
205 wrbuf_rewind(c->wrbuf);
207 wrbuf_puts(c->wrbuf, "<termlist>");
208 wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>", status);
214 if (!(tp = strchr(name, ',')))
215 tp = name + strlen(name);
216 strncpy(tname, name, tp - name);
217 tname[tp - name] = '\0';
219 wrbuf_printf(c->wrbuf, "\n<list name=\"%s\">\n", tname);
220 if (!strcmp(tname, "xtargets"))
221 targets_termlist(c->wrbuf, s->psession, num);
224 p = termlist(s->psession, tname, &len);
226 for (i = 0; i < len && i < num; i++)
228 wrbuf_puts(c->wrbuf, "\n<term>");
229 wrbuf_printf(c->wrbuf, "<name>%s</name>", p[i]->term);
230 wrbuf_printf(c->wrbuf, "<frequency>%d</frequency>", p[i]->frequency);
231 wrbuf_puts(c->wrbuf, "</term>");
234 wrbuf_puts(c->wrbuf, "\n</list>");
239 wrbuf_puts(c->wrbuf, "</termlist>");
240 rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
241 http_send_response(c);
245 static void cmd_bytarget(struct http_channel *c)
247 struct http_response *rs = c->response;
248 struct http_request *rq = c->request;
249 struct http_session *s = locate_session(rq, rs);
250 struct hitsbytarget *ht;
255 if (!(ht = hitsbytarget(s->psession, &count)))
257 error(rs, "500", "Failed to retrieve hitcounts", 0);
260 wrbuf_rewind(c->wrbuf);
261 wrbuf_puts(c->wrbuf, "<bytarget><status>OK</status>");
263 for (i = 0; i < count; i++)
265 wrbuf_puts(c->wrbuf, "\n<target>");
266 wrbuf_printf(c->wrbuf, "<id>%s</id>\n", ht[i].id);
267 wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", ht[i].hits);
268 wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
269 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
270 wrbuf_printf(c->wrbuf, "<state>%s</state>\n", ht[i].state);
271 wrbuf_puts(c->wrbuf, "</target>");
274 wrbuf_puts(c->wrbuf, "</bytarget>");
275 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
276 http_send_response(c);
279 static void write_metadata(WRBUF w, struct conf_service *service,
280 struct record_metadata **ml, int full)
284 for (imeta = 0; imeta < service->num_metadata; imeta++)
286 struct conf_metadata *cmd = &service->metadata[imeta];
287 struct record_metadata *md;
288 if (!cmd->brief && !full)
290 for (md = ml[imeta]; md; md = md->next)
292 wrbuf_printf(w, "<md-%s>", cmd->name);
295 case Metadata_type_generic:
296 wrbuf_puts(w, md->data.text);
298 case Metadata_type_year:
299 wrbuf_printf(w, "%d", md->data.number.min);
300 if (md->data.number.min != md->data.number.max)
301 wrbuf_printf(w, "-%d", md->data.number.max);
304 wrbuf_puts(w, "[can't represent]");
306 wrbuf_printf(w, "</md-%s>", cmd->name);
311 static void write_subrecord(struct record *r, WRBUF w, struct conf_service *service)
313 wrbuf_printf(w, "<location id=\"%s\" name=\"%s\">\n",
314 r->client->database->url,
315 r->client->database->name ? r->client->database->name : "");
316 write_metadata(w, service, r->metadata, 1);
317 wrbuf_puts(w, "</location>\n");
320 static void cmd_record(struct http_channel *c)
322 struct http_response *rs = c->response;
323 struct http_request *rq = c->request;
324 struct http_session *s = locate_session(rq, rs);
325 struct record_cluster *rec;
327 struct conf_service *service = global_parameters.server->service;
328 char *idstr = http_argbyname(rq, "id");
335 error(rs, "417", "Must supply id", 0);
338 wrbuf_rewind(c->wrbuf);
340 if (!(rec = show_single(s->psession, id)))
342 error(rs, "500", "Record missing", 0);
345 wrbuf_puts(c->wrbuf, "<record>\n");
346 wrbuf_printf(c->wrbuf, "<recid>%d</recid>", rec->recid);
347 write_metadata(c->wrbuf, service, rec->metadata, 1);
348 for (r = rec->records; r; r = r->next)
349 write_subrecord(r, c->wrbuf, service);
350 wrbuf_puts(c->wrbuf, "</record>\n");
351 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
352 http_send_response(c);
355 static void show_records(struct http_channel *c, int active)
357 struct http_request *rq = c->request;
358 struct http_response *rs = c->response;
359 struct http_session *s = locate_session(rq, rs);
360 struct record_cluster **rl;
361 struct reclist_sortparms *sp;
362 char *start = http_argbyname(rq, "start");
363 char *num = http_argbyname(rq, "num");
364 char *sort = http_argbyname(rq, "sort");
374 // We haven't counted clients yet if we're called on a block release
376 active = session_active_clients(s->psession);
379 startn = atoi(start);
384 if (!(sp = reclist_parse_sortparms(c->nmem, sort)))
386 error(rs, "500", "Bad sort parameters", 0);
390 rl = show(s->psession, sp, startn, &numn, &total, &total_hits, c->nmem);
392 wrbuf_rewind(c->wrbuf);
393 wrbuf_puts(c->wrbuf, "<show>\n<status>OK</status>\n");
394 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
395 wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
396 wrbuf_printf(c->wrbuf, "<total>%d</total>\n", total_hits);
397 wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
398 wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
400 for (i = 0; i < numn; i++)
404 struct record_cluster *rec = rl[i];
405 struct conf_service *service = global_parameters.server->service;
407 wrbuf_puts(c->wrbuf, "<hit>\n");
408 write_metadata(c->wrbuf, service, rec->metadata, 0);
409 for (ccount = 0, p = rl[i]->records; p; p = p->next, ccount++)
412 wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
413 wrbuf_printf(c->wrbuf, "<recid>%d</recid>\n", rec->recid);
414 wrbuf_puts(c->wrbuf, "</hit>\n");
417 wrbuf_puts(c->wrbuf, "</show>\n");
418 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
419 http_send_response(c);
422 static void show_records_ready(void *data)
424 struct http_channel *c = (struct http_channel *) data;
429 static void cmd_show(struct http_channel *c)
431 struct http_request *rq = c->request;
432 struct http_response *rs = c->response;
433 struct http_session *s = locate_session(rq, rs);
434 char *block = http_argbyname(rq, "block");
440 status = session_active_clients(s->psession);
444 if (status && (!s->psession->reclist || !s->psession->reclist->num_records))
446 session_set_watch(s->psession, SESSION_WATCH_RECORDS, show_records_ready, c);
447 yaz_log(YLOG_DEBUG, "Blocking on cmd_show");
452 show_records(c, status);
455 static void cmd_ping(struct http_channel *c)
457 struct http_request *rq = c->request;
458 struct http_response *rs = c->response;
459 struct http_session *s = locate_session(rq, rs);
462 rs->payload = "<ping><status>OK</status></ping>";
463 http_send_response(c);
466 static void cmd_search(struct http_channel *c)
468 struct http_request *rq = c->request;
469 struct http_response *rs = c->response;
470 struct http_session *s = locate_session(rq, rs);
471 char *query = http_argbyname(rq, "query");
472 char *filter = http_argbyname(rq, "filter");
479 error(rs, "417", "Must supply query", 0);
482 res = search(s->psession, query, filter);
485 error(rs, "417", res, res);
488 rs->payload = "<search><status>OK</status></search>";
489 http_send_response(c);
493 static void cmd_stat(struct http_channel *c)
495 struct http_request *rq = c->request;
496 struct http_response *rs = c->response;
497 struct http_session *s = locate_session(rq, rs);
498 struct statistics stat;
504 clients = session_active_clients(s->psession);
505 statistics(s->psession, &stat);
507 wrbuf_rewind(c->wrbuf);
508 wrbuf_puts(c->wrbuf, "<stat>");
509 wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
510 wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", stat.num_hits);
511 wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
512 wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
513 wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
514 wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
515 wrbuf_printf(c->wrbuf, "<initializing>%d</initializing>\n", stat.num_initializing);
516 wrbuf_printf(c->wrbuf, "<searching>%d</searching>\n", stat.num_searching);
517 wrbuf_printf(c->wrbuf, "<presenting>%d</presenting>\n", stat.num_presenting);
518 wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
519 wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
520 wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
521 wrbuf_puts(c->wrbuf, "</stat>");
522 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
523 http_send_response(c);
526 static void cmd_info(struct http_channel *c)
528 char yaz_version_str[20];
529 struct http_response *rs = c->response;
531 wrbuf_rewind(c->wrbuf);
532 wrbuf_puts(c->wrbuf, "<info>\n");
533 wrbuf_printf(c->wrbuf, " <version>\n");
534 wrbuf_printf(c->wrbuf, " <pazpar2>%s</pazpar2>\n", VERSION);
536 yaz_version(yaz_version_str, 0);
537 wrbuf_printf(c->wrbuf, " <yaz compiled=\"%s\">%s</yaz>\n",
538 YAZ_VERSION, yaz_version_str);
539 wrbuf_printf(c->wrbuf, " </version>\n");
541 wrbuf_puts(c->wrbuf, "</info>");
542 rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
543 http_send_response(c);
548 void (*fun)(struct http_channel *c);
550 { "init", cmd_init },
551 { "stat", cmd_stat },
552 { "bytarget", cmd_bytarget },
553 { "show", cmd_show },
554 { "search", cmd_search },
555 { "termlist", cmd_termlist },
556 { "exit", cmd_exit },
557 { "ping", cmd_ping },
558 { "record", cmd_record },
559 { "info", cmd_info },
563 void http_command(struct http_channel *c)
565 char *command = http_argbyname(c->request, "command");
566 struct http_response *rs = http_create_response(c);
571 http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
572 http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
576 error(rs, "417", "Must supply command", 0);
579 for (i = 0; commands[i].name; i++)
580 if (!strcmp(commands[i].name, command))
582 (*commands[i].fun)(c);
585 if (!commands[i].name)
586 error(rs, "417", "Unknown command", 0);
594 * indent-tabs-mode: nil
596 * vim: shiftwidth=4 tabstop=8 expandtab