src/http_command.c

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