src/http_command.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2009 Index Data
   3
   4 Pazpar2 is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 */
  19
  20 #if HAVE_CONFIG_H
  21 #include <config.h>
  22 #endif
  23 #include <stdio.h>
  24 #include <sys/types.h>
  25 #if HAVE_UNISTD_H
  26 #include <unistd.h>
  27 #endif
  28 #include <stdlib.h>
  29 #include <string.h>
  30 #if HAVE_SYS_TIME_H
  31 #include <sys/time.h>
  32 #endif
  33 #include <yaz/snprintf.h>
  34 #include <yaz/yaz-util.h>
  35
  36 #include "util.h"
  37 #include "eventl.h"
  38 #include "pazpar2.h"
  39 #include "http.h"
  40 #include "settings.h"
  41 #include "client.h"
  42
  43 // Update this when the protocol changes
  44 #define PAZPAR2_PROTOCOL_VERSION "1"
  45
  46 struct http_session {
  47     IOCHAN timeout_iochan;     // NOTE: This is NOT associated with a socket
  48     struct session *psession;
  49     unsigned int session_id;
  50     int timestamp;
  51     NMEM nmem;
  52     struct http_session *next;
  53 };
  54
  55 static struct http_session *session_list = 0; /* thread pr */
  56
  57 void http_session_destroy(struct http_session *s);
  58
  59 static void session_timeout(IOCHAN i, int event)
  60 {
  61     struct http_session *s = iochan_getdata(i);
  62     http_session_destroy(s);
  63 }
  64
  65 struct http_session *http_session_create(struct conf_service *service)
  66 {
  67     NMEM nmem = nmem_create();
  68     struct http_session *r = nmem_malloc(nmem, sizeof(*r));
  69
  70     r->psession = new_session(nmem, service);
  71     r->session_id = 0;
  72     r->timestamp = 0;
  73     r->nmem = nmem;
  74     r->next = session_list;
  75     session_list = r;
  76     r->timeout_iochan = iochan_create(-1, session_timeout, 0);
  77     iochan_setdata(r->timeout_iochan, r);
  78     iochan_settimeout(r->timeout_iochan, service->session_timeout);
  79
  80     pazpar2_add_channel(r->timeout_iochan);
  81     return r;
  82 }
  83
  84 void http_session_destroy(struct http_session *s)
  85 {
  86     struct http_session **p;
  87
  88     for (p = &session_list; *p; p = &(*p)->next)
  89         if (*p == s)
  90         {
  91             *p = (*p)->next;
  92             break;
  93         }
  94     yaz_log(YLOG_LOG, "Destroying session %u", s->session_id);
  95     iochan_destroy(s->timeout_iochan);
  96     destroy_session(s->psession);
  97     nmem_destroy(s->nmem);
  98 }
  99
 100 static const char *get_msg(enum pazpar2_error_code code)
 101 {
 102     struct pazpar2_error_msg {
 103         enum pazpar2_error_code code;
 104         const char *msg;
 105     };
 106     static const struct pazpar2_error_msg ar[] = {
 107         { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
 108         { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
 109         { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
 110         { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
 111         { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
 112         { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
 113         { PAZPAR2_RECORD_MISSING, "Record missing"},
 114         { PAZPAR2_NO_TARGETS, "No targets"},
 115         { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
 116         { PAZPAR2_RECORD_FAIL, "Record command failed"},
 117         { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"},
 118         { PAZPAR2_LAST_ERROR, "Last error"},
 119         { 0, 0 }
 120     };
 121     int i = 0;
 122     while (ar[i].msg)
 123     {
 124         if (code == ar[i].code)
 125             return ar[i].msg;
 126         i++;
 127     }
 128     return "No error";
 129 }
 130
 131 static void error(struct http_response *rs,
 132                   enum pazpar2_error_code code,
 133                   const char *addinfo)
 134 {
 135     struct http_channel *c = rs->channel;
 136     WRBUF text = wrbuf_alloc();
 137     const char *http_status = "417";
 138     const char *msg = get_msg(code);
 139
 140     rs->msg = nmem_strdup(c->nmem, msg);
 141     strcpy(rs->code, http_status);
 142
 143     wrbuf_printf(text, "<error code=\"%d\" msg=\"%s\">", (int) code,
 144                msg);
 145     if (addinfo)
 146         wrbuf_xmlputs(text, addinfo);
 147     wrbuf_puts(text, "</error>");
 148
 149     yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
 150             msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
 151     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
 152     wrbuf_destroy(text);
 153     http_send_response(c);
 154 }
 155
 156 unsigned int make_sessionid(void)
 157 {
 158     static int seq = 0; /* thread pr */
 159     unsigned int res;
 160
 161     seq++;
 162     if (global_parameters.debug_mode)
 163         res = seq;
 164     else
 165     {
 166 #ifdef WIN32
 167         res = seq;
 168 #else
 169         struct timeval t;
 170
 171         if (gettimeofday(&t, 0) < 0)
 172         {
 173             yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
 174             exit(1);
 175         }
 176         /* at most 256 sessions per second ..
 177            (long long would be more appropriate)*/
 178         res = t.tv_sec;
 179         res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
 180 #endif
 181     }
 182     return res;
 183 }
 184
 185 static struct http_session *locate_session(struct http_request *rq, struct http_response *rs)
 186 {
 187     struct http_session *p;
 188     const char *session = http_argbyname(rq, "session");
 189     unsigned int id;
 190
 191     if (!session)
 192     {
 193         error(rs, PAZPAR2_MISSING_PARAMETER, "session");
 194         return 0;
 195     }
 196     id = atoi(session);
 197     for (p = session_list; p; p = p->next)
 198         if (id == p->session_id)
 199         {
 200             iochan_activity(p->timeout_iochan);
 201             return p;
 202         }
 203     error(rs, PAZPAR2_NO_SESSION, session);
 204     return 0;
 205 }
 206
 207 // Decode settings parameters and apply to session
 208 // Syntax: setting[target]=value
 209 static int process_settings(struct session *se, struct http_request *rq,
 210         struct http_response *rs)
 211 {
 212     struct http_argument *a;
 213
 214     for (a = rq->arguments; a; a = a->next)
 215         if (strchr(a->name, '['))
 216         {
 217             char **res;
 218             int num;
 219             char *dbname;
 220             char *setting;
 221
 222             // Nmem_strsplit *rules*!!!
 223             nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
 224             if (num != 2)
 225             {
 226                 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
 227                 return -1;
 228             }
 229             setting = res[0];
 230             dbname = res[1];
 231             session_apply_setting(se, dbname, setting,
 232                     nmem_strdup(se->session_nmem, a->value));
 233         }
 234     return 0;
 235 }
 236
 237 static void cmd_exit(struct http_channel *c)
 238 {
 239     yaz_log(YLOG_WARN, "exit");
 240     http_close_server(c->server);
 241 }
 242
 243 static void cmd_init(struct http_channel *c)
 244 {
 245     unsigned int sesid;
 246     char buf[1024];
 247     const char *clear = http_argbyname(c->request, "clear");
 248     const char *service_name = http_argbyname(c->request, "service");
 249     struct conf_service *service = locate_service(c->server,
 250                                                   service_name);
 251     struct http_session *s = http_session_create(service);
 252     struct http_response *rs = c->response;
 253
 254     if (!service)
 255     {
 256         error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "service");
 257         return;
 258     }
 259
 260     yaz_log(YLOG_DEBUG, "HTTP Session init");
 261     if (!clear || *clear == '0')
 262         session_init_databases(s->psession);
 263     else
 264         yaz_log(YLOG_LOG, "No databases preloaded");
 265     sesid = make_sessionid();
 266     s->session_id = sesid;
 267     if (process_settings(s->psession, c->request, c->response) < 0)
 268         return;
 269     sprintf(buf, "<init><status>OK</status><session>%u</session>"
 270             "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol></init>", sesid);
 271     rs->payload = nmem_strdup(c->nmem, buf);
 272     http_send_response(c);
 273 }
 274
 275 static void cmd_settings(struct http_channel *c)
 276 {
 277     struct http_response *rs = c->response;
 278     struct http_request *rq = c->request;
 279     struct http_session *s = locate_session(rq, rs);
 280
 281     if (!s)
 282         return;
 283
 284     if (process_settings(s->psession, rq, rs) < 0)
 285         return;
 286     rs->payload = "<settings><status>OK</status></settings>";
 287     http_send_response(c);
 288 }
 289
 290 // Compares two hitsbytarget nodes by hitcount
 291 static int cmp_ht(const void *p1, const void *p2)
 292 {
 293     const struct hitsbytarget *h1 = p1;
 294     const struct hitsbytarget *h2 = p2;
 295     return h2->hits - h1->hits;
 296 }
 297
 298 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
 299 static void targets_termlist(WRBUF wrbuf, struct session *se, int num,
 300                              NMEM nmem)
 301 {
 302     struct hitsbytarget *ht;
 303     int count, i;
 304
 305     ht = hitsbytarget(se, &count, nmem);
 306     qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
 307     for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
 308     {
 309
 310         // do only print terms which have display names
 311
 312         wrbuf_puts(wrbuf, "<term>\n");
 313
 314         wrbuf_puts(wrbuf, "<id>");
 315         wrbuf_xmlputs(wrbuf, ht[i].id);
 316         wrbuf_puts(wrbuf, "</id>\n");
 317
 318         wrbuf_puts(wrbuf, "<name>");
 319         if (!ht[i].name || !ht[i].name[0])
 320             wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
 321         else
 322             wrbuf_xmlputs(wrbuf, ht[i].name);
 323         wrbuf_puts(wrbuf, "</name>\n");
 324
 325         wrbuf_printf(wrbuf, "<frequency>%d</frequency>\n", ht[i].hits);
 326
 327         wrbuf_puts(wrbuf, "<state>");
 328         wrbuf_xmlputs(wrbuf, ht[i].state);
 329         wrbuf_puts(wrbuf, "</state>\n");
 330
 331         wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
 332                      ht[i].diagnostic);
 333         wrbuf_puts(wrbuf, "</term>\n");
 334     }
 335 }
 336
 337 static void cmd_termlist(struct http_channel *c)
 338 {
 339     struct http_response *rs = c->response;
 340     struct http_request *rq = c->request;
 341     struct http_session *s = locate_session(rq, rs);
 342     struct termlist_score **p;
 343     int len;
 344     int i;
 345     const char *name = http_argbyname(rq, "name");
 346     const char *nums = http_argbyname(rq, "num");
 347     int num = 15;
 348     int status;
 349
 350     if (!s)
 351         return;
 352
 353     status = session_active_clients(s->psession);
 354
 355     if (!name)
 356         name = "subject";
 357     if (strlen(name) > 255)
 358         return;
 359     if (nums)
 360         num = atoi(nums);
 361
 362     wrbuf_rewind(c->wrbuf);
 363
 364     wrbuf_puts(c->wrbuf, "<termlist>\n");
 365     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
 366     while (*name)
 367     {
 368         char tname[256];
 369         const char *tp;
 370
 371         if (!(tp = strchr(name, ',')))
 372             tp = name + strlen(name);
 373         strncpy(tname, name, tp - name);
 374         tname[tp - name] = '\0';
 375
 376         wrbuf_puts(c->wrbuf, "<list name=\"");
 377         wrbuf_xmlputs(c->wrbuf, tname);
 378         wrbuf_puts(c->wrbuf, "\">\n");
 379         if (!strcmp(tname, "xtargets"))
 380             targets_termlist(c->wrbuf, s->psession, num, c->nmem);
 381         else
 382         {
 383             p = termlist(s->psession, tname, &len);
 384             if (p)
 385                 for (i = 0; i < len && i < num; i++){
 386                     // prevnt sending empty term elements
 387                     if (!p[i]->term || !p[i]->term[0])
 388                         continue;
 389
 390                     wrbuf_puts(c->wrbuf, "<term>");
 391                     wrbuf_puts(c->wrbuf, "<name>");
 392                     wrbuf_xmlputs(c->wrbuf, p[i]->term);
 393                     wrbuf_puts(c->wrbuf, "</name>");
 394
 395                     wrbuf_printf(c->wrbuf,
 396                                  "<frequency>%d</frequency>",
 397                                  p[i]->frequency);
 398                     wrbuf_puts(c->wrbuf, "</term>\n");
 399                }
 400         }
 401         wrbuf_puts(c->wrbuf, "</list>\n");
 402         name = tp;
 403         if (*name == ',')
 404             name++;
 405     }
 406     wrbuf_puts(c->wrbuf, "</termlist>\n");
 407     rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
 408     http_send_response(c);
 409 }
 410
 411
 412 static void cmd_bytarget(struct http_channel *c)
 413 {
 414     struct http_response *rs = c->response;
 415     struct http_request *rq = c->request;
 416     struct http_session *s = locate_session(rq, rs);
 417     struct hitsbytarget *ht;
 418     int count, i;
 419
 420     if (!s)
 421         return;
 422     ht = hitsbytarget(s->psession, &count, c->nmem);
 423     wrbuf_rewind(c->wrbuf);
 424     wrbuf_puts(c->wrbuf, "<bytarget><status>OK</status>");
 425
 426     for (i = 0; i < count; i++)
 427     {
 428         wrbuf_puts(c->wrbuf, "\n<target>");
 429
 430         wrbuf_puts(c->wrbuf, "<id>");
 431         wrbuf_xmlputs(c->wrbuf, ht[i].id);
 432         wrbuf_puts(c->wrbuf, "</id>\n");
 433
 434         if (ht[i].name && ht[i].name[0])
 435         {
 436             wrbuf_puts(c->wrbuf, "<name>");
 437             wrbuf_xmlputs(c->wrbuf, ht[i].name);
 438             wrbuf_puts(c->wrbuf, "</name>\n");
 439         }
 440
 441         wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", ht[i].hits);
 442         wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
 443         wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
 444
 445         wrbuf_puts(c->wrbuf, "<state>");
 446         wrbuf_xmlputs(c->wrbuf, ht[i].state);
 447         wrbuf_puts(c->wrbuf, "</state>\n");
 448
 449         wrbuf_puts(c->wrbuf, "</target>");
 450     }
 451
 452     wrbuf_puts(c->wrbuf, "</bytarget>");
 453     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 454     http_send_response(c);
 455 }
 456
 457 static void write_metadata(WRBUF w, struct conf_service *service,
 458         struct record_metadata **ml, int full)
 459 {
 460     int imeta;
 461
 462     for (imeta = 0; imeta < service->num_metadata; imeta++)
 463     {
 464         struct conf_metadata *cmd = &service->metadata[imeta];
 465         struct record_metadata *md;
 466         if (!cmd->brief && !full)
 467             continue;
 468         for (md = ml[imeta]; md; md = md->next)
 469         {
 470             wrbuf_printf(w, "\n<md-%s>", cmd->name);
 471
 472             switch (cmd->type)
 473             {
 474                 case Metadata_type_generic:
 475                     wrbuf_xmlputs(w, md->data.text.disp);
 476                     break;
 477                 case Metadata_type_year:
 478                     wrbuf_printf(w, "%d", md->data.number.min);
 479                     if (md->data.number.min != md->data.number.max)
 480                         wrbuf_printf(w, "-%d", md->data.number.max);
 481                     break;
 482                 default:
 483                     wrbuf_puts(w, "[can't represent]");
 484             }
 485             wrbuf_printf(w, "</md-%s>", cmd->name);
 486         }
 487     }
 488 }
 489
 490 static void write_subrecord(struct record *r, WRBUF w,
 491         struct conf_service *service, int show_details)
 492 {
 493     const char *name = session_setting_oneval(
 494         client_get_database(r->client), PZ_NAME);
 495
 496     wrbuf_puts(w, "<location id=\"");
 497     wrbuf_xmlputs(w, client_get_database(r->client)->database->url);
 498     wrbuf_puts(w, "\" ");
 499
 500     wrbuf_puts(w, "name=\"");
 501     wrbuf_xmlputs(w,  *name ? name : "Unknown");
 502     wrbuf_puts(w, "\">");
 503
 504     write_metadata(w, service, r->metadata, show_details);
 505     wrbuf_puts(w, "</location>\n");
 506 }
 507
 508 static void show_raw_record_error(void *data, const char *addinfo)
 509 {
 510     http_channel_observer_t obs = data;
 511     struct http_channel *c = http_channel_observer_chan(obs);
 512     struct http_response *rs = c->response;
 513
 514     http_remove_observer(obs);
 515
 516     error(rs, PAZPAR2_RECORD_FAIL, addinfo);
 517 }
 518
 519 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
 520 {
 521     http_channel_observer_t obs = data;
 522     struct http_channel *c = http_channel_observer_chan(obs);
 523     struct http_response *rs = c->response;
 524
 525     http_remove_observer(obs);
 526
 527     wrbuf_write(c->wrbuf, buf, sz);
 528     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 529     http_send_response(c);
 530 }
 531
 532
 533 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
 534 {
 535     http_channel_observer_t obs = data;
 536     struct http_channel *c = http_channel_observer_chan(obs);
 537     struct http_response *rs = c->response;
 538
 539     http_remove_observer(obs);
 540
 541     wrbuf_write(c->wrbuf, buf, sz);
 542     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 543
 544     rs->content_type = "application/octet-stream";
 545     http_send_response(c);
 546 }
 547
 548
 549 void show_raw_reset(void *data, struct http_channel *c, void *data2)
 550 {
 551     //struct client *client = data;
 552     //client_show_raw_remove(client, data2);
 553 }
 554
 555 static void cmd_record_ready(void *data);
 556
 557 static void cmd_record(struct http_channel *c)
 558 {
 559     struct http_response *rs = c->response;
 560     struct http_request *rq = c->request;
 561     struct http_session *s = locate_session(rq, rs);
 562     struct record_cluster *rec, *prev_r, *next_r;
 563     struct record *r;
 564     struct conf_service *service;
 565     const char *idstr = http_argbyname(rq, "id");
 566     const char *offsetstr = http_argbyname(rq, "offset");
 567     const char *binarystr = http_argbyname(rq, "binary");
 568
 569     if (!s)
 570         return;
 571     service = s->psession->service;
 572     if (!idstr)
 573     {
 574         error(rs, PAZPAR2_MISSING_PARAMETER, "id");
 575         return;
 576     }
 577     wrbuf_rewind(c->wrbuf);
 578     if (!(rec = show_single(s->psession, idstr, &prev_r, &next_r)))
 579     {
 580         if (session_active_clients(s->psession) == 0)
 581         {
 582             error(rs, PAZPAR2_RECORD_MISSING, idstr);
 583         }
 584         else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
 585                               cmd_record_ready, c, c) != 0)
 586         {
 587             error(rs, PAZPAR2_RECORD_MISSING, idstr);
 588         }
 589         return;
 590     }
 591     if (offsetstr)
 592     {
 593         int offset = atoi(offsetstr);
 594         const char *syntax = http_argbyname(rq, "syntax");
 595         const char *esn = http_argbyname(rq, "esn");
 596         int i;
 597         struct record*r = rec->records;
 598         int binary = 0;
 599
 600         if (binarystr && *binarystr != '0')
 601             binary = 1;
 602
 603         for (i = 0; i < offset && r; r = r->next, i++)
 604             ;
 605         if (!r)
 606         {
 607             error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
 608             return;
 609         }
 610         else
 611         {
 612             http_channel_observer_t obs =
 613                 http_add_observer(c, r->client, show_raw_reset);
 614             int ret = client_show_raw_begin(r->client, r->position,
 615                                         syntax, esn,
 616                                         obs /* data */,
 617                                         show_raw_record_error,
 618                                         (binary ?
 619                                          show_raw_record_ok_binary :
 620                                          show_raw_record_ok),
 621                                         (binary ? 1 : 0));
 622             if (ret == -1)
 623             {
 624                 http_remove_observer(obs);
 625                 error(rs, PAZPAR2_NO_SESSION, 0);
 626             }
 627         }
 628     }
 629     else
 630     {
 631         wrbuf_puts(c->wrbuf, "<record>\n");
 632         wrbuf_puts(c->wrbuf, "<recid>");
 633         wrbuf_xmlputs(c->wrbuf, rec->recid);
 634         wrbuf_puts(c->wrbuf, "</recid>\n");
 635         if (prev_r)
 636         {
 637             wrbuf_puts(c->wrbuf, "<prevrecid>");
 638             wrbuf_xmlputs(c->wrbuf, prev_r->recid);
 639             wrbuf_puts(c->wrbuf, "</prevrecid>\n");
 640         }
 641         if (next_r)
 642         {
 643             wrbuf_puts(c->wrbuf, "<nextrecid>");
 644             wrbuf_xmlputs(c->wrbuf, next_r->recid);
 645             wrbuf_puts(c->wrbuf, "</nextrecid>\n");
 646         }
 647         wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n",
 648                      session_active_clients(s->psession));
 649         write_metadata(c->wrbuf, service, rec->metadata, 1);
 650         for (r = rec->records; r; r = r->next)
 651             write_subrecord(r, c->wrbuf, service, 1);
 652         wrbuf_puts(c->wrbuf, "</record>\n");
 653         rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 654         http_send_response(c);
 655     }
 656 }
 657
 658 static void cmd_record_ready(void *data)
 659 {
 660     struct http_channel *c = (struct http_channel *) data;
 661
 662     cmd_record(c);
 663 }
 664
 665 static void show_records(struct http_channel *c, int active)
 666 {
 667     struct http_request *rq = c->request;
 668     struct http_response *rs = c->response;
 669     struct http_session *s = locate_session(rq, rs);
 670     struct record_cluster **rl;
 671     struct reclist_sortparms *sp;
 672     const char *start = http_argbyname(rq, "start");
 673     const char *num = http_argbyname(rq, "num");
 674     const char *sort = http_argbyname(rq, "sort");
 675     int startn = 0;
 676     int numn = 20;
 677     int total;
 678     int total_hits;
 679     int i;
 680
 681     if (!s)
 682         return;
 683
 684     // We haven't counted clients yet if we're called on a block release
 685     if (active < 0)
 686         active = session_active_clients(s->psession);
 687
 688     if (start)
 689         startn = atoi(start);
 690     if (num)
 691         numn = atoi(num);
 692     if (!sort)
 693         sort = "relevance";
 694     if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
 695     {
 696         error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
 697         return;
 698     }
 699
 700     rl = show(s->psession, sp, startn, &numn, &total, &total_hits, c->nmem);
 701
 702     wrbuf_rewind(c->wrbuf);
 703     wrbuf_puts(c->wrbuf, "<show>\n<status>OK</status>\n");
 704     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", active);
 705     wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
 706     wrbuf_printf(c->wrbuf, "<total>%d</total>\n", total_hits);
 707     wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
 708     wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
 709
 710     for (i = 0; i < numn; i++)
 711     {
 712         int ccount;
 713         struct record *p;
 714         struct record_cluster *rec = rl[i];
 715         struct conf_service *service = s->psession->service;
 716
 717         wrbuf_puts(c->wrbuf, "<hit>\n");
 718         write_metadata(c->wrbuf, service, rec->metadata, 0);
 719         for (ccount = 0, p = rl[i]->records; p;  p = p->next, ccount++)
 720             write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
 721         if (ccount > 1)
 722             wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
 723         wrbuf_puts(c->wrbuf, "<recid>");
 724         wrbuf_xmlputs(c->wrbuf, rec->recid);
 725         wrbuf_puts(c->wrbuf, "</recid>\n");
 726         wrbuf_puts(c->wrbuf, "</hit>\n");
 727     }
 728
 729     wrbuf_puts(c->wrbuf, "</show>\n");
 730     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 731     http_send_response(c);
 732 }
 733
 734 static void show_records_ready(void *data)
 735 {
 736     struct http_channel *c = (struct http_channel *) data;
 737
 738     show_records(c, -1);
 739 }
 740
 741 static void cmd_show(struct http_channel *c)
 742 {
 743     struct http_request *rq = c->request;
 744     struct http_response *rs = c->response;
 745     struct http_session *s = locate_session(rq, rs);
 746     const char *block = http_argbyname(rq, "block");
 747     int status;
 748
 749     if (!s)
 750         return;
 751
 752     status = session_active_clients(s->psession);
 753
 754     if (block)
 755     {
 756         if (status && (!s->psession->reclist || !s->psession->reclist->num_records))
 757         {
 758             // if there is already a watch/block. we do not block this one
 759             if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
 760                                   show_records_ready, c, c) != 0)
 761             {
 762                 yaz_log(YLOG_DEBUG, "Blocking on cmd_show");
 763             }
 764             return;
 765         }
 766     }
 767
 768     show_records(c, status);
 769 }
 770
 771 static void cmd_ping(struct http_channel *c)
 772 {
 773     struct http_request *rq = c->request;
 774     struct http_response *rs = c->response;
 775     struct http_session *s = locate_session(rq, rs);
 776     if (!s)
 777         return;
 778     rs->payload = "<ping><status>OK</status></ping>";
 779     http_send_response(c);
 780 }
 781
 782 static int utf_8_valid(const char *str)
 783 {
 784     yaz_iconv_t cd = yaz_iconv_open("utf-8", "utf-8");
 785     if (cd)
 786     {
 787         /* check that query is UTF-8 encoded */
 788         char *inbuf = (char *) str; /* we know iconv does not alter this */
 789         size_t inbytesleft = strlen(inbuf);
 790
 791         size_t outbytesleft = strlen(inbuf) + 10;
 792         char *out = xmalloc(outbytesleft);
 793         char *outbuf = out;
 794         size_t r = yaz_iconv(cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft);
 795
 796         /* if OK, try flushing the rest  */
 797         if (r != (size_t) (-1))
 798             r = yaz_iconv(cd, 0, 0, &outbuf, &outbytesleft);
 799         yaz_iconv_close(cd);
 800         xfree(out);
 801         if (r == (size_t) (-1))
 802             return 0;
 803     }
 804     return 1;
 805 }
 806
 807 static void cmd_search(struct http_channel *c)
 808 {
 809     struct http_request *rq = c->request;
 810     struct http_response *rs = c->response;
 811     struct http_session *s = locate_session(rq, rs);
 812     const char *query = http_argbyname(rq, "query");
 813     const char *filter = http_argbyname(rq, "filter");
 814     enum pazpar2_error_code code;
 815     const char *addinfo = 0;
 816
 817     if (!s)
 818         return;
 819     if (!query)
 820     {
 821         error(rs, PAZPAR2_MISSING_PARAMETER, "query");
 822         return;
 823     }
 824     if (!utf_8_valid(query))
 825     {
 826         error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
 827         return;
 828     }
 829     code = search(s->psession, query, filter, &addinfo);
 830     if (code)
 831     {
 832         error(rs, code, addinfo);
 833         return;
 834     }
 835     rs->payload = "<search><status>OK</status></search>";
 836     http_send_response(c);
 837 }
 838
 839
 840 static void cmd_stat(struct http_channel *c)
 841 {
 842     struct http_request *rq = c->request;
 843     struct http_response *rs = c->response;
 844     struct http_session *s = locate_session(rq, rs);
 845     struct statistics stat;
 846     int clients;
 847
 848     float progress = 0;
 849
 850     if (!s)
 851         return;
 852
 853     clients = session_active_clients(s->psession);
 854     statistics(s->psession, &stat);
 855
 856     if (stat.num_clients > 0) {
 857         progress = (stat.num_clients  - clients) / (float)stat.num_clients;
 858     }
 859
 860     wrbuf_rewind(c->wrbuf);
 861     wrbuf_puts(c->wrbuf, "<stat>");
 862     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
 863     wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", stat.num_hits);
 864     wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
 865     wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
 866     wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
 867     wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
 868     wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
 869     wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
 870     wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
 871     wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
 872     wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
 873     wrbuf_puts(c->wrbuf, "</stat>");
 874     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 875     http_send_response(c);
 876 }
 877
 878 static void cmd_info(struct http_channel *c)
 879 {
 880     char yaz_version_str[20];
 881     struct http_response *rs = c->response;
 882
 883     wrbuf_rewind(c->wrbuf);
 884     wrbuf_puts(c->wrbuf, "<info>\n");
 885     wrbuf_puts(c->wrbuf, " <version>\n");
 886     wrbuf_puts(c->wrbuf, "<pazpar2");
 887 #ifdef PAZPAR2_VERSION_SHA1
 888     wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
 889 #endif
 890     wrbuf_puts(c->wrbuf, ">");
 891     wrbuf_xmlputs(c->wrbuf, VERSION);
 892     wrbuf_puts(c->wrbuf, "</pazpar2>");
 893
 894
 895     yaz_version(yaz_version_str, 0);
 896     wrbuf_puts(c->wrbuf, "  <yaz compiled=\"");
 897     wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
 898     wrbuf_puts(c->wrbuf, "\">");
 899     wrbuf_xmlputs(c->wrbuf, yaz_version_str);
 900     wrbuf_puts(c->wrbuf, "</yaz>\n");
 901
 902     wrbuf_puts(c->wrbuf, " </version>\n");
 903
 904     wrbuf_puts(c->wrbuf, "</info>");
 905     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 906     http_send_response(c);
 907 }
 908
 909 struct {
 910     char *name;
 911     void (*fun)(struct http_channel *c);
 912 } commands[] = {
 913     { "init", cmd_init },
 914     { "settings", cmd_settings },
 915     { "stat", cmd_stat },
 916     { "bytarget", cmd_bytarget },
 917     { "show", cmd_show },
 918     { "search", cmd_search },
 919     { "termlist", cmd_termlist },
 920     { "exit", cmd_exit },
 921     { "ping", cmd_ping },
 922     { "record", cmd_record },
 923     { "info", cmd_info },
 924     {0,0}
 925 };
 926
 927 void http_command(struct http_channel *c)
 928 {
 929     const char *command = http_argbyname(c->request, "command");
 930     struct http_response *rs = http_create_response(c);
 931     int i;
 932
 933     c->response = rs;
 934
 935     http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
 936     http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
 937
 938     if (!command)
 939     {
 940         error(rs, PAZPAR2_MISSING_PARAMETER, "command");
 941         return;
 942     }
 943     for (i = 0; commands[i].name; i++)
 944         if (!strcmp(commands[i].name, command))
 945         {
 946             (*commands[i].fun)(c);
 947             break;
 948         }
 949     if (!commands[i].name)
 950         error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
 951
 952     return;
 953 }
 954
 955 /*
 956  * Local variables:
 957  * c-basic-offset: 4
 958  * c-file-style: "Stroustrup"
 959  * indent-tabs-mode: nil
 960  * End:
 961  * vim: shiftwidth=4 tabstop=8 expandtab
 962  */
 963