Added locaton info to the output of the show command.
[pazpar2-moved-to-github.git] / src / http_command.c
1 /* $Id: http_command.c,v 1.35 2007-04-15 03:26:47 quinn Exp $
2    Copyright (c) 2006-2007, Index Data.
3
4 This file is part of Pazpar2.
5
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
9 version.
10
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
14 for more details.
15
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
19 02111-1307, USA.
20  */
21
22 /*
23  * $Id: http_command.c,v 1.35 2007-04-15 03:26:47 quinn Exp $
24  */
25
26 #include <stdio.h>
27 #include <sys/types.h>
28 #include <sys/uio.h>
29 #include <unistd.h>
30 #include <stdlib.h>
31 #include <strings.h>
32 #include <ctype.h>
33 #include <sys/time.h>
34
35 #if HAVE_CONFIG_H
36 #include <cconfig.h>
37 #endif
38
39 #include <yaz/yaz-util.h>
40
41 #include "config.h"
42 #include "util.h"
43 #include "eventl.h"
44 #include "pazpar2.h"
45 #include "http.h"
46 #include "http_command.h"
47 #include "settings.h"
48
49 extern struct parameters global_parameters;
50 extern IOCHAN channel_list;
51
52 struct http_session {
53     IOCHAN timeout_iochan;     // NOTE: This is NOT associated with a socket
54     struct session *psession;
55     unsigned int session_id;
56     int timestamp;
57     NMEM nmem;
58     struct http_session *next;
59 };
60
61 static struct http_session *session_list = 0;
62
63 void http_session_destroy(struct http_session *s);
64
65 static void session_timeout(IOCHAN i, int event)
66 {
67     struct http_session *s = iochan_getdata(i);
68     http_session_destroy(s);
69 }
70
71 struct http_session *http_session_create()
72 {
73     NMEM nmem = nmem_create();
74     struct http_session *r = nmem_malloc(nmem, sizeof(*r));
75
76     r->psession = new_session(nmem);
77     r->session_id = 0;
78     r->timestamp = 0;
79     r->nmem = nmem;
80     r->next = session_list;
81     session_list = r;
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);
85     r->timeout_iochan->next = channel_list;
86     channel_list = r->timeout_iochan;
87     return r;
88 }
89
90 void http_session_destroy(struct http_session *s)
91 {
92     struct http_session **p;
93
94     for (p = &session_list; *p; p = &(*p)->next)
95         if (*p == s)
96         {
97             *p = (*p)->next;
98             break;
99         }
100     iochan_destroy(s->timeout_iochan);
101     destroy_session(s->psession);
102     nmem_destroy(s->nmem);
103 }
104
105 static void error(struct http_response *rs, char *code, char *msg, char *txt)
106 {
107     struct http_channel *c = rs->channel;
108     char tmp[1024];
109
110     if (!txt)
111         txt = msg;
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);
117 }
118
119 unsigned int make_sessionid()
120 {
121     struct timeval t;
122     unsigned int res;
123     static int seq = 0;
124
125     seq++;
126     if (gettimeofday(&t, 0) < 0)
127         abort();
128     res = t.tv_sec;
129     res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
130     return res;
131 }
132
133 static struct http_session *locate_session(struct http_request *rq, struct http_response *rs)
134 {
135     struct http_session *p;
136     char *session = http_argbyname(rq, "session");
137     unsigned int id;
138
139     if (!session)
140     {
141         error(rs, "417", "Must supply session", 0);
142         return 0;
143     }
144     id = atoi(session);
145     for (p = session_list; p; p = p->next)
146         if (id == p->session_id)
147         {
148             iochan_activity(p->timeout_iochan);
149             return p;
150         }
151     error(rs, "417", "Session does not exist, or it has expired", 0);
152     return 0;
153 }
154
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)
159 {
160     struct http_argument *a;
161
162     for (a = rq->arguments; a; a = a->next)
163         if (strchr(a->name, '['))
164         {
165             char **res;
166             int num;
167             char *dbname;
168             char *setting;
169
170             // Nmem_strsplit *rules*!!!
171             nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
172             if (num != 2)
173             {
174                 error(rs, "417", "Malformed setting argument", 0);
175                 yaz_log(YLOG_WARN, "Malformed setting: %s", a->name);
176                 return -1;
177             }
178             setting = res[0];
179             dbname = res[1];
180             session_apply_setting(se, dbname, setting,
181                     nmem_strdup(se->session_nmem, a->value));
182         }
183     return 0;
184 }
185
186 static void cmd_exit(struct http_channel *c)
187 {
188     yaz_log(YLOG_WARN, "exit");
189     exit(0);
190 }
191
192 static void cmd_init(struct http_channel *c)
193 {
194     unsigned int sesid;
195     char buf[1024];
196     struct http_session *s = http_session_create();
197     struct http_response *rs = c->response;
198
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)
203         return;
204     sprintf(buf, "<init><status>OK</status><session>%u</session></init>", sesid);
205     rs->payload = nmem_strdup(c->nmem, buf);
206     http_send_response(c);
207 }
208
209 static void cmd_settings(struct http_channel *c)
210 {
211     struct http_response *rs = c->response;
212     struct http_request *rq = c->request;
213     struct http_session *s = locate_session(rq, rs);
214
215     if (!s)
216         return;
217
218     if (process_settings(s->psession, rq, rs) < 0)
219         return;
220     rs->payload = "<settings><status>OK</status></settings>";
221     http_send_response(c);
222 }
223
224 // Compares two hitsbytarget nodes by hitcount
225 static int cmp_ht(const void *p1, const void *p2)
226 {
227     const struct hitsbytarget *h1 = p1;
228     const struct hitsbytarget *h2 = p2;
229     return h2->hits - h1->hits;
230 }
231
232 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
233 static void targets_termlist(WRBUF wrbuf, struct session *se, int num)
234 {
235     struct hitsbytarget *ht;
236     int count, i;
237
238     if (!(ht = hitsbytarget(se, &count)))
239         return;
240     qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
241     for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
242     {
243         wrbuf_puts(wrbuf, "\n<term>\n");
244         wrbuf_printf(wrbuf, "<id>%s</id>\n", ht[i].id);
245         wrbuf_printf(wrbuf, "<name>%s</name>\n", ht[i].name);
246         wrbuf_printf(wrbuf, "<frequency>%d</frequency>\n", ht[i].hits);
247         wrbuf_printf(wrbuf, "<state>%s</state>\n", ht[i].state);
248         wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
249         wrbuf_puts(wrbuf, "\n</term>\n");
250     }
251 }
252
253 static void cmd_termlist(struct http_channel *c)
254 {
255     struct http_response *rs = c->response;
256     struct http_request *rq = c->request;
257     struct http_session *s = locate_session(rq, rs);
258     struct termlist_score **p;
259     int len;
260     int i;
261     char *name = http_argbyname(rq, "name");
262     char *nums = http_argbyname(rq, "num");
263     int num = 15;
264     int status;
265
266     if (!s)
267         return;
268
269     status = session_active_clients(s->psession);
270
271     if (!name)
272         name = "subject";
273     if (strlen(name) > 255)
274         return;
275     if (nums)
276         num = atoi(nums);
277
278     wrbuf_rewind(c->wrbuf);
279
280     wrbuf_puts(c->wrbuf, "<termlist>");
281     wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>", status);
282     while (*name)
283     {
284         char tname[256];
285         char *tp;
286
287         if (!(tp = strchr(name, ',')))
288             tp = name + strlen(name);
289         strncpy(tname, name, tp - name);
290         tname[tp - name] = '\0';
291
292         wrbuf_printf(c->wrbuf, "\n<list name=\"%s\">\n", tname);
293         if (!strcmp(tname, "xtargets"))
294             targets_termlist(c->wrbuf, s->psession, num);
295         else
296         {
297             p = termlist(s->psession, tname, &len);
298             if (p)
299                 for (i = 0; i < len && i < num; i++)
300                 {
301                     wrbuf_puts(c->wrbuf, "\n<term>");
302                     wrbuf_printf(c->wrbuf, "<name>%s</name>", p[i]->term);
303                     wrbuf_printf(c->wrbuf, "<frequency>%d</frequency>", p[i]->frequency);
304                     wrbuf_puts(c->wrbuf, "</term>");
305                 }
306         }
307         wrbuf_puts(c->wrbuf, "\n</list>");
308         name = tp;
309         if (*name == ',')
310             name++;
311     }
312     wrbuf_puts(c->wrbuf, "</termlist>");
313     rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
314     http_send_response(c);
315 }
316
317
318 static void cmd_bytarget(struct http_channel *c)
319 {
320     struct http_response *rs = c->response;
321     struct http_request *rq = c->request;
322     struct http_session *s = locate_session(rq, rs);
323     struct hitsbytarget *ht;
324     int count, i;
325
326     if (!s)
327         return;
328     if (!(ht = hitsbytarget(s->psession, &count)))
329     {
330         error(rs, "500", "Failed to retrieve hitcounts", 0);
331         return;
332     }
333     wrbuf_rewind(c->wrbuf);
334     wrbuf_puts(c->wrbuf, "<bytarget><status>OK</status>");
335
336     for (i = 0; i < count; i++)
337     {
338         wrbuf_puts(c->wrbuf, "\n<target>");
339         wrbuf_printf(c->wrbuf, "<id>%s</id>\n", ht[i].id);
340         wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", ht[i].hits);
341         wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
342         wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
343         wrbuf_printf(c->wrbuf, "<state>%s</state>\n", ht[i].state);
344         wrbuf_puts(c->wrbuf, "</target>");
345     }
346
347     wrbuf_puts(c->wrbuf, "</bytarget>");
348     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
349     http_send_response(c);
350 }
351
352 static void write_metadata(WRBUF w, struct conf_service *service,
353         struct record_metadata **ml, int full)
354 {
355     int imeta;
356
357     for (imeta = 0; imeta < service->num_metadata; imeta++)
358     {
359         struct conf_metadata *cmd = &service->metadata[imeta];
360         struct record_metadata *md;
361         if (!cmd->brief && !full)
362             continue;
363         for (md = ml[imeta]; md; md = md->next)
364         {
365             wrbuf_printf(w, "<md-%s>", cmd->name);
366             switch (cmd->type)
367             {
368                 case Metadata_type_generic:
369                     wrbuf_puts(w, md->data.text);
370                     break;
371                 case Metadata_type_year:
372                     wrbuf_printf(w, "%d", md->data.number.min);
373                     if (md->data.number.min != md->data.number.max)
374                         wrbuf_printf(w, "-%d", md->data.number.max);
375                     break;
376                 default:
377                     wrbuf_puts(w, "[can't represent]");
378             }
379             wrbuf_printf(w, "</md-%s>", cmd->name);
380         }
381     }
382 }
383
384 static void write_subrecord(struct record *r, WRBUF w,
385         struct conf_service *service, int show_details)
386 {
387     char *name = session_setting_oneval(r->client->database, PZ_NAME);
388
389     wrbuf_printf(w, "<location id=\"%s\" name=\"%s\">\n",
390             r->client->database->database->url,
391             *name ? name : "Unknown");
392     if (show_details)
393         write_metadata(w, service, r->metadata, 1);
394     wrbuf_puts(w, "</location>\n");
395 }
396
397 static void cmd_record(struct http_channel *c)
398 {
399     struct http_response *rs = c->response;
400     struct http_request *rq = c->request;
401     struct http_session *s = locate_session(rq, rs);
402     struct record_cluster *rec;
403     struct record *r;
404     struct conf_service *service = global_parameters.server->service;
405     char *idstr = http_argbyname(rq, "id");
406     int id;
407
408     if (!s)
409         return;
410     if (!idstr)
411     {
412         error(rs, "417", "Must supply id", 0);
413         return;
414     }
415     wrbuf_rewind(c->wrbuf);
416     id = atoi(idstr);
417     if (!(rec = show_single(s->psession, id)))
418     {
419         error(rs, "500", "Record missing", 0);
420         return;
421     }
422     wrbuf_puts(c->wrbuf, "<record>\n");
423     wrbuf_printf(c->wrbuf, "<recid>%d</recid>", rec->recid);
424     write_metadata(c->wrbuf, service, rec->metadata, 1);
425     for (r = rec->records; r; r = r->next)
426         write_subrecord(r, c->wrbuf, service, 1);
427     wrbuf_puts(c->wrbuf, "</record>\n");
428     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
429     http_send_response(c);
430 }
431
432 static void show_records(struct http_channel *c, int active)
433 {
434     struct http_request *rq = c->request;
435     struct http_response *rs = c->response;
436     struct http_session *s = locate_session(rq, rs);
437     struct record_cluster **rl;
438     struct reclist_sortparms *sp;
439     char *start = http_argbyname(rq, "start");
440     char *num = http_argbyname(rq, "num");
441     char *sort = http_argbyname(rq, "sort");
442     int startn = 0;
443     int numn = 20;
444     int total;
445     int total_hits;
446     int i;
447
448     if (!s)
449         return;
450
451     // We haven't counted clients yet if we're called on a block release
452     if (active < 0)
453         active = session_active_clients(s->psession);
454
455     if (start)
456         startn = atoi(start);
457     if (num)
458         numn = atoi(num);
459     if (!sort)
460         sort = "relevance";
461     if (!(sp = reclist_parse_sortparms(c->nmem, sort)))
462     {
463         error(rs, "500", "Bad sort parameters", 0);
464         return;
465     }
466
467     rl = show(s->psession, sp, startn, &numn, &total, &total_hits, c->nmem);
468
469     wrbuf_rewind(c->wrbuf);
470     wrbuf_puts(c->wrbuf, "<show>\n<status>OK</status>\n");
471     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
472     wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
473     wrbuf_printf(c->wrbuf, "<total>%d</total>\n", total_hits);
474     wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
475     wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
476
477     for (i = 0; i < numn; i++)
478     {
479         int ccount;
480         struct record *p;
481         struct record_cluster *rec = rl[i];
482         struct conf_service *service = global_parameters.server->service;
483
484         wrbuf_puts(c->wrbuf, "<hit>\n");
485         write_metadata(c->wrbuf, service, rec->metadata, 0);
486         for (ccount = 0, p = rl[i]->records; p;  p = p->next, ccount++)
487             write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
488         if (ccount > 1)
489             wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
490         wrbuf_printf(c->wrbuf, "<recid>%d</recid>\n", rec->recid);
491         wrbuf_puts(c->wrbuf, "</hit>\n");
492     }
493
494     wrbuf_puts(c->wrbuf, "</show>\n");
495     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
496     http_send_response(c);
497 }
498
499 static void show_records_ready(void *data)
500 {
501     struct http_channel *c = (struct http_channel *) data;
502
503     show_records(c, -1);
504 }
505
506 static void cmd_show(struct http_channel *c)
507 {
508     struct http_request *rq = c->request;
509     struct http_response *rs = c->response;
510     struct http_session *s = locate_session(rq, rs);
511     char *block = http_argbyname(rq, "block");
512     int status;
513
514     if (!s)
515         return;
516
517     status = session_active_clients(s->psession);
518
519     if (block)
520     {
521         if (status && (!s->psession->reclist || !s->psession->reclist->num_records))
522         {
523             session_set_watch(s->psession, SESSION_WATCH_RECORDS, show_records_ready, c);
524             yaz_log(YLOG_DEBUG, "Blocking on cmd_show");
525             return;
526         }
527     }
528
529     show_records(c, status);
530 }
531
532 static void cmd_ping(struct http_channel *c)
533 {
534     struct http_request *rq = c->request;
535     struct http_response *rs = c->response;
536     struct http_session *s = locate_session(rq, rs);
537     if (!s)
538         return;
539     rs->payload = "<ping><status>OK</status></ping>";
540     http_send_response(c);
541 }
542
543 static void cmd_search(struct http_channel *c)
544 {
545     struct http_request *rq = c->request;
546     struct http_response *rs = c->response;
547     struct http_session *s = locate_session(rq, rs);
548     char *query = http_argbyname(rq, "query");
549     char *filter = http_argbyname(rq, "filter");
550     char *res;
551
552     if (!s)
553         return;
554     if (!query)
555     {
556         error(rs, "417", "Must supply query", 0);
557         return;
558     }
559     res = search(s->psession, query, filter);
560     if (res)
561     {
562         error(rs, "417", res, res);
563         return;
564     }
565     rs->payload = "<search><status>OK</status></search>";
566     http_send_response(c);
567 }
568
569
570 static void cmd_stat(struct http_channel *c)
571 {
572     struct http_request *rq = c->request;
573     struct http_response *rs = c->response;
574     struct http_session *s = locate_session(rq, rs);
575     struct statistics stat;
576     int clients;
577
578     if (!s)
579         return;
580
581     clients = session_active_clients(s->psession);
582     statistics(s->psession, &stat);
583
584     wrbuf_rewind(c->wrbuf);
585     wrbuf_puts(c->wrbuf, "<stat>");
586     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
587     wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", stat.num_hits);
588     wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
589     wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
590     wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
591     wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
592     wrbuf_printf(c->wrbuf, "<initializing>%d</initializing>\n", stat.num_initializing);
593     wrbuf_printf(c->wrbuf, "<searching>%d</searching>\n", stat.num_searching);
594     wrbuf_printf(c->wrbuf, "<presenting>%d</presenting>\n", stat.num_presenting);
595     wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
596     wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
597     wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
598     wrbuf_puts(c->wrbuf, "</stat>");
599     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
600     http_send_response(c);
601 }
602
603 static void cmd_info(struct http_channel *c)
604 {
605     char yaz_version_str[20];
606     struct http_response *rs = c->response;
607
608     wrbuf_rewind(c->wrbuf);
609     wrbuf_puts(c->wrbuf, "<info>\n");
610     wrbuf_printf(c->wrbuf, " <version>\n");
611     wrbuf_printf(c->wrbuf, "  <pazpar2>%s</pazpar2>\n", VERSION);
612
613     yaz_version(yaz_version_str, 0);
614     wrbuf_printf(c->wrbuf, "  <yaz compiled=\"%s\">%s</yaz>\n",
615                  YAZ_VERSION, yaz_version_str);
616     wrbuf_printf(c->wrbuf, " </version>\n");
617     
618     wrbuf_puts(c->wrbuf, "</info>");
619     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
620     http_send_response(c);
621 }
622
623 struct {
624     char *name;
625     void (*fun)(struct http_channel *c);
626 } commands[] = {
627     { "init", cmd_init },
628     { "settings", cmd_settings },
629     { "stat", cmd_stat },
630     { "bytarget", cmd_bytarget },
631     { "show", cmd_show },
632     { "search", cmd_search },
633     { "termlist", cmd_termlist },
634     { "exit", cmd_exit },
635     { "ping", cmd_ping },
636     { "record", cmd_record },
637     { "info", cmd_info },
638     {0,0}
639 };
640
641 void http_command(struct http_channel *c)
642 {
643     char *command = http_argbyname(c->request, "command");
644     struct http_response *rs = http_create_response(c);
645     int i;
646
647     c->response = rs;
648
649     http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
650     http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
651
652     if (!command)
653     {
654         error(rs, "417", "Must supply command", 0);
655         return;
656     }
657     for (i = 0; commands[i].name; i++)
658         if (!strcmp(commands[i].name, command))
659         {
660             (*commands[i].fun)(c);
661             break;
662         }
663     if (!commands[i].name)
664         error(rs, "417", "Unknown command", 0);
665
666     return;
667 }
668
669 /*
670  * Local variables:
671  * c-basic-offset: 4
672  * indent-tabs-mode: nil
673  * End:
674  * vim: shiftwidth=4 tabstop=8 expandtab
675  */