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