src/http_command.c

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