src/http_command.c

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