Removed command.c (telnet-style interface)
[pazpar2-moved-to-github.git] / src / http_command.c
1 /*
2  * $Id: http_command.c,v 1.7 2007-01-06 04:54:58 quinn Exp $
3  */
4
5 #include <stdio.h>
6 #include <sys/types.h>
7 #include <sys/uio.h>
8 #include <unistd.h>
9 #include <stdlib.h>
10 #include <strings.h>
11 #include <ctype.h>
12 #include <sys/time.h>
13
14 #include <yaz/yaz-util.h>
15
16 #include "util.h"
17 #include "eventl.h"
18 #include "pazpar2.h"
19 #include "http.h"
20 #include "http_command.h"
21
22 extern struct parameters global_parameters;
23 extern IOCHAN channel_list;
24
25 struct http_session {
26     IOCHAN timeout_iochan;     // NOTE: This is NOT associated with a socket
27     struct session *psession;
28     unsigned int session_id;
29     int timestamp;
30     struct http_session *next;
31 };
32
33 static struct http_session *session_list = 0;
34
35 void http_session_destroy(struct http_session *s);
36
37 static void session_timeout(IOCHAN i, int event)
38 {
39     struct http_session *s = iochan_getdata(i);
40     http_session_destroy(s);
41 }
42
43 struct http_session *http_session_create()
44 {
45     struct http_session *r = xmalloc(sizeof(*r));
46     r->psession = new_session();
47     r->session_id = 0;
48     r->timestamp = 0;
49     r->next = session_list;
50     session_list = r;
51     r->timeout_iochan = iochan_create(-1, session_timeout, 0);
52     iochan_setdata(r->timeout_iochan, r);
53     iochan_settimeout(r->timeout_iochan, global_parameters.session_timeout);
54     r->timeout_iochan->next = channel_list;
55     channel_list = r->timeout_iochan;
56     return r;
57 }
58
59 void http_session_destroy(struct http_session *s)
60 {
61     struct http_session **p;
62
63     for (p = &session_list; *p; p = &(*p)->next)
64         if (*p == s)
65         {
66             *p = (*p)->next;
67             break;
68         }
69     iochan_destroy(s->timeout_iochan);
70     destroy_session(s->psession);
71     xfree(s);
72 }
73
74 static void error(struct http_response *rs, char *code, char *msg, char *txt)
75 {
76     struct http_channel *c = rs->channel;
77     char tmp[1024];
78
79     if (!txt)
80         txt = msg;
81     rs->msg = nmem_strdup(c->nmem, msg);
82     strcpy(rs->code, code);
83     sprintf(tmp, "<error code=\"general\">%s</error>", txt);
84     rs->payload = nmem_strdup(c->nmem, tmp);
85     http_send_response(c);
86 }
87
88 unsigned int make_sessionid()
89 {
90     struct timeval t;
91     unsigned int res;
92     static int seq = 0;
93
94     seq++;
95     if (gettimeofday(&t, 0) < 0)
96         abort();
97     res = t.tv_sec;
98     res = ((res << 8) | (seq & 0xff)) & ((unsigned int) (1 << 31) - 1);
99     return res;
100 }
101
102 static struct http_session *locate_session(struct http_request *rq, struct http_response *rs)
103 {
104     struct http_session *p;
105     char *session = http_argbyname(rq, "session");
106     unsigned int id;
107
108     if (!session)
109     {
110         error(rs, "417", "Must supply session", 0);
111         return 0;
112     }
113     id = atoi(session);
114     for (p = session_list; p; p = p->next)
115         if (id == p->session_id)
116         {
117             iochan_activity(p->timeout_iochan);
118             return p;
119         }
120     error(rs, "417", "Session does not exist, or it has expired", 0);
121     return 0;
122 }
123
124 static void cmd_exit(struct http_channel *c)
125 {
126     yaz_log(YLOG_WARN, "exit");
127     exit(0);
128 }
129
130
131 static void cmd_init(struct http_channel *c)
132 {
133     unsigned int sesid;
134     char buf[1024];
135     struct http_session *s = http_session_create();
136     struct http_response *rs = c->response;
137
138     yaz_log(YLOG_DEBUG, "HTTP Session init");
139     sesid = make_sessionid();
140     s->session_id = sesid;
141     sprintf(buf, "<init><status>OK</status><session>%u</session></init>", sesid);
142     rs->payload = nmem_strdup(c->nmem, buf);
143     http_send_response(c);
144 }
145
146 // Compares two hitsbytarget nodes by hitcount
147 static int cmp_ht(const void *p1, const void *p2)
148 {
149     const struct hitsbytarget *h1 = p1;
150     const struct hitsbytarget *h2 = p2;
151     return h2->hits - h1->hits;
152 }
153
154 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
155 static void targets_termlist(WRBUF wrbuf, struct session *se)
156 {
157     struct hitsbytarget *ht;
158     int count, i;
159
160     if (!(ht = hitsbytarget(se, &count)))
161         return;
162     qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
163     for (i = 0; i < count && i < 15; i++)
164     {
165         wrbuf_puts(wrbuf, "\n<term>\n");
166         wrbuf_printf(wrbuf, "<name>%s</name>\n", ht[i].id);
167         wrbuf_printf(wrbuf, "<frequency>%d</frequency>\n", ht[i].hits);
168         wrbuf_printf(wrbuf, "<state>%s</state>\n", ht[i].state);
169         wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
170         wrbuf_puts(wrbuf, "\n</term>\n");
171     }
172 }
173
174 static void cmd_termlist(struct http_channel *c)
175 {
176     struct http_response *rs = c->response;
177     struct http_request *rq = c->request;
178     struct http_session *s = locate_session(rq, rs);
179     struct termlist_score **p;
180     int len;
181     int i;
182     char *name = http_argbyname(rq, "name");
183     int status = session_active_clients(s->psession);
184
185     if (!s)
186         return;
187
188     if (!name)
189         name = "subject";
190     if (strlen(name) > 255)
191         return;
192
193     wrbuf_rewind(c->wrbuf);
194
195     wrbuf_puts(c->wrbuf, "<termlist>");
196     wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>", status);
197     while (*name)
198     {
199         char tname[256];
200         char *tp;
201
202         if (!(tp = strchr(name, ',')))
203             tp = name + strlen(name);
204         strncpy(tname, name, tp - name);
205         tname[tp - name] = '\0';
206
207         wrbuf_printf(c->wrbuf, "\n<list name=\"%s\">\n", tname);
208         if (!strcmp(tname, "xtargets"))
209             targets_termlist(c->wrbuf, s->psession);
210         else
211         {
212             p = termlist(s->psession, tname, &len);
213             if (p)
214                 for (i = 0; i < len; i++)
215                 {
216                     wrbuf_puts(c->wrbuf, "\n<term>");
217                     wrbuf_printf(c->wrbuf, "<name>%s</name>", p[i]->term);
218                     wrbuf_printf(c->wrbuf, "<frequency>%d</frequency>", p[i]->frequency);
219                     wrbuf_puts(c->wrbuf, "</term>");
220                 }
221         }
222         wrbuf_puts(c->wrbuf, "\n</list>");
223         name = tp;
224         if (*name == ',')
225             name++;
226     }
227     wrbuf_puts(c->wrbuf, "</termlist>");
228     rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_buf(c->wrbuf));
229     http_send_response(c);
230 }
231
232
233 static void cmd_bytarget(struct http_channel *c)
234 {
235     struct http_response *rs = c->response;
236     struct http_request *rq = c->request;
237     struct http_session *s = locate_session(rq, rs);
238     struct hitsbytarget *ht;
239     int count, i;
240
241     if (!s)
242         return;
243     if (!(ht = hitsbytarget(s->psession, &count)))
244     {
245         error(rs, "500", "Failed to retrieve hitcounts", 0);
246         return;
247     }
248     wrbuf_rewind(c->wrbuf);
249     wrbuf_puts(c->wrbuf, "<bytarget><status>OK</status>");
250
251     for (i = 0; i < count; i++)
252     {
253         wrbuf_puts(c->wrbuf, "\n<target>");
254         wrbuf_printf(c->wrbuf, "<id>%s</id>\n", ht[i].id);
255         wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", ht[i].hits);
256         wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
257         wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
258         wrbuf_printf(c->wrbuf, "<state>%s</state>\n", ht[i].state);
259         wrbuf_puts(c->wrbuf, "</target>");
260     }
261
262     wrbuf_puts(c->wrbuf, "</bytarget>");
263     rs->payload = nmem_strdup(c->nmem, wrbuf_buf(c->wrbuf));
264     http_send_response(c);
265 }
266
267 static void show_records(struct http_channel *c, int active)
268 {
269     struct http_request *rq = c->request;
270     struct http_response *rs = c->response;
271     struct http_session *s = locate_session(rq, rs);
272     struct record **rl;
273     NMEM nmem_show;
274     char *start = http_argbyname(rq, "start");
275     char *num = http_argbyname(rq, "num");
276     int startn = 0;
277     int numn = 20;
278     int total;
279     int total_hits;
280     int i;
281
282     if (!s)
283         return;
284
285     // We haven't counted clients yet if we're called on a block release
286     if (active < 0)
287         active = session_active_clients(s->psession);
288
289     if (start)
290         startn = atoi(start);
291     if (num)
292         numn = atoi(num);
293
294     nmem_show = nmem_create();
295     rl = show(s->psession, startn, &numn, &total, &total_hits, nmem_show);
296
297     wrbuf_rewind(c->wrbuf);
298     wrbuf_puts(c->wrbuf, "<show>\n<status>OK</status>\n");
299     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
300     wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
301     wrbuf_printf(c->wrbuf, "<total>%d</total>\n", total_hits);
302     wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
303     wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
304
305     for (i = 0; i < numn; i++)
306     {
307         int ccount;
308         struct record *p;
309
310         wrbuf_puts(c->wrbuf, "<hit>\n");
311         wrbuf_printf(c->wrbuf, "<title>%s</title>\n", rl[i]->title);
312         for (ccount = 1, p = rl[i]->next_cluster; p;  p = p->next_cluster, ccount++)
313             ;
314         if (ccount > 1)
315             wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
316         wrbuf_puts(c->wrbuf, "</hit>\n");
317     }
318
319     wrbuf_puts(c->wrbuf, "</show>\n");
320     rs->payload = nmem_strdup(c->nmem, wrbuf_buf(c->wrbuf));
321     http_send_response(c);
322     nmem_destroy(nmem_show);
323 }
324
325 static void show_records_ready(void *data)
326 {
327     struct http_channel *c = (struct http_channel *) data;
328
329     show_records(c, -1);
330 }
331
332 static void cmd_show(struct http_channel *c)
333 {
334     struct http_request *rq = c->request;
335     struct http_response *rs = c->response;
336     struct http_session *s = locate_session(rq, rs);
337     char *block = http_argbyname(rq, "block");
338     int status = session_active_clients(s->psession);
339
340     if (!s)
341         return;
342
343     if (block)
344     {
345         if (status && (!s->psession->reclist || !s->psession->reclist->num_records))
346         {
347             session_set_watch(s->psession, SESSION_WATCH_RECORDS, show_records_ready, c);
348             yaz_log(YLOG_DEBUG, "Blocking on cmd_show");
349             return;
350         }
351     }
352
353     show_records(c, status);
354 }
355
356 static void cmd_ping(struct http_channel *c)
357 {
358     struct http_request *rq = c->request;
359     struct http_response *rs = c->response;
360     struct http_session *s = locate_session(rq, rs);
361     if (!s)
362         return;
363     rs->payload = "<ping><status>OK</status></ping>";
364     http_send_response(c);
365 }
366
367 static void cmd_search(struct http_channel *c)
368 {
369     struct http_request *rq = c->request;
370     struct http_response *rs = c->response;
371     struct http_session *s = locate_session(rq, rs);
372     char *query = http_argbyname(rq, "query");
373     char *res;
374
375     if (!s)
376         return;
377     if (!query)
378     {
379         error(rs, "417", "Must supply query", 0);
380         return;
381     }
382     res = search(s->psession, query);
383     if (res)
384     {
385         error(rs, "417", res, res);
386         return;
387     }
388     rs->payload = "<search><status>OK</status></search>";
389     http_send_response(c);
390 }
391
392
393 static void cmd_stat(struct http_channel *c)
394 {
395     struct http_request *rq = c->request;
396     struct http_response *rs = c->response;
397     struct http_session *s = locate_session(rq, rs);
398     struct statistics stat;
399     int clients = session_active_clients(s->psession);
400
401     if (!s)
402         return;
403
404     statistics(s->psession, &stat);
405
406     wrbuf_rewind(c->wrbuf);
407     wrbuf_puts(c->wrbuf, "<stat>");
408     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
409     wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", stat.num_hits);
410     wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
411     wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
412     wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
413     wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
414     wrbuf_printf(c->wrbuf, "<initializing>%d</initializing>\n", stat.num_initializing);
415     wrbuf_printf(c->wrbuf, "<searching>%d</searching>\n", stat.num_searching);
416     wrbuf_printf(c->wrbuf, "<presenting>%d</presenting>\n", stat.num_presenting);
417     wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
418     wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
419     wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
420     wrbuf_puts(c->wrbuf, "</stat>");
421     rs->payload = nmem_strdup(c->nmem, wrbuf_buf(c->wrbuf));
422     http_send_response(c);
423 }
424
425
426 struct {
427     char *name;
428     void (*fun)(struct http_channel *c);
429 } commands[] = {
430     { "init", cmd_init },
431     { "stat", cmd_stat },
432     { "bytarget", cmd_bytarget },
433     { "show", cmd_show },
434     { "search", cmd_search },
435     { "termlist", cmd_termlist },
436     { "exit", cmd_exit },
437     { "ping", cmd_ping },
438     {0,0}
439 };
440
441 void http_command(struct http_channel *c)
442 {
443     char *command = http_argbyname(c->request, "command");
444     struct http_response *rs = http_create_response(c);
445     int i;
446
447     c->response = rs;
448     if (!command)
449     {
450         error(rs, "417", "Must supply command", 0);
451         return;
452     }
453     for (i = 0; commands[i].name; i++)
454         if (!strcmp(commands[i].name, command))
455         {
456             (*commands[i].fun)(c);
457             break;
458         }
459     if (!commands[i].name)
460         error(rs, "417", "Unknown command", 0);
461
462     return;
463 }
464
465 /*
466  * Local variables:
467  * c-basic-offset: 4
468  * indent-tabs-mode: nil
469  * End:
470  * vim: shiftwidth=4 tabstop=8 expandtab
471  */