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