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             destroy_session(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, "%p Session %u created. timeout chan=%p timeout=%d", r, 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, "%p HTTP Session %u destroyed", s, 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, "%p HTTP Session %u destroyed", s, s->session_id);
 201         iochan_destroy(s->timeout_iochan);
 202         destroy_session(s->psession);
 203         http_session_use(-1);
 204         nmem_destroy(s->nmem);
 205     }
 206     else {
 207         yaz_log(http_sessions->log_level, "%p HTTP Session %u destroyed delayed. Active clients (%d-%d). Waiting for new timeout.",
 208                 s, 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, "%p Session init %u ", s, sesid);
 445     if (!clear || *clear == '0')
 446         session_init_databases(s->psession);
 447     else
 448         yaz_log(YLOG_LOG, "HTTP 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             return;
 495         }
 496         root_n = xmlDocGetRootElement(doc);
 497
 498         settings_read_node_x(root_n, s->psession, apply_local_setting);
 499
 500         xmlFreeDoc(doc);
 501     }
 502     if (process_settings(s->psession, rq, rs) < 0)
 503     {
 504         release_session(c, s);
 505         return;
 506     }
 507     response_open(c, "settings");
 508     response_close(c, "settings");
 509     release_session(c, s);
 510 }
 511
 512 static void termlist_response(struct http_channel *c)
 513 {
 514     struct http_request *rq = c->request;
 515     struct http_session *s = locate_session(c);
 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     release_session(c, s);
 533 }
 534
 535 static void termlist_result_ready(void *data)
 536 {
 537     struct http_channel *c = (struct http_channel) data;
 538     termlist_response(c);
 539 }
 540
 541 static void cmd_termlist(struct http_channel *c)
 542 {
 543     struct http_request *rq = c->request;
 544     struct http_response *rs = c->response;
 545     struct http_session *s = locate_session(c);
 546     const char *block = http_argbyname(rq, "block");
 547     int active_clients;
 548     if (!s)
 549         return;
 550
 551     active_clients = session_active_clients(s->psession);
 552
 553     if (block && !strcmp("1", block) && active_clients)
 554     {
 555         // if there is already a watch/block. we do not block this one
 556         if (session_set_watch(s->psession, SESSION_WATCH_TERMLIST,
 557                               termlist_result_ready, c, c) != 0)
 558         {
 559             yaz_log(YLOG_WARN, "Attempt to block multiple times on termlist block. Not supported!");
 560             error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
 561         }
 562         else
 563         {
 564             yaz_log(c->http_sessions->log_level, "%p Session %u: Blocking on command termlist", s, s->session_id);
 565         }
 566         release_session(c, s);
 567         return;
 568     }
 569
 570     termlist_response(c);
 571     release_session(c, s);
 572 }
 573
 574 size_t session_get_memory_status(struct session *session);
 575
 576 static void session_status(struct http_channel *c, struct http_session *s)
 577 {
 578     size_t session_nmem;
 579     wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
 580     wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
 581     session_nmem = session_get_memory_status(s->psession);
 582     wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
 583 }
 584
 585 static void cmd_session_status(struct http_channel *c)
 586 {
 587     struct http_session *s = locate_session(c);
 588     if (!s)
 589         return;
 590
 591     response_open(c, "session-status");
 592     session_status(c, s);
 593     response_close(c, "session-status");
 594     release_session(c, s);
 595 }
 596
 597 int sessions_count(void);
 598 int clients_count(void);
 599 #ifdef HAVE_RESULTSETS_COUNT
 600 int resultsets_count(void);
 601 #else
 602 #define resultsets_count()      0
 603 #endif
 604
 605 static void cmd_server_status(struct http_channel *c)
 606 {
 607     int sessions   = sessions_count();
 608     int clients    = clients_count();
 609     int resultsets = resultsets_count();
 610
 611     response_open(c, "server-status");
 612     wrbuf_printf(c->wrbuf, "\n  <sessions>%u</sessions>\n", sessions);
 613     wrbuf_printf(c->wrbuf, "  <clients>%u</clients>\n",   clients);
 614     /* Only works if yaz has been compiled with enabling of this */
 615     wrbuf_printf(c->wrbuf, "  <resultsets>%u</resultsets>\n",resultsets);
 616     print_meminfo(c->wrbuf);
 617
 618 /* TODO add all sessions status                         */
 619 /*    http_sessions_t http_sessions = c->http_sessions; */
 620 /*    struct http_session *p;                           */
 621 /*
 622     yaz_mutex_enter(http_sessions->mutex);
 623     for (p = http_sessions->session_list; p; p = p->next)
 624     {
 625         p->activity_counter++;
 626         wrbuf_puts(c->wrbuf, "<session-status>\n");
 627         wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
 628         yaz_mutex_leave(http_sessions->mutex);
 629         session_status(c, p);
 630         wrbuf_puts(c->wrbuf, "</session-status>\n");
 631         yaz_mutex_enter(http_sessions->mutex);
 632         p->activity_counter--;
 633     }
 634     yaz_mutex_leave(http_sessions->mutex);
 635 */
 636     response_close(c, "server-status");
 637     xmalloc_trav(0);
 638 }
 639
 640 static void bytarget_response(struct http_channel *c) {
 641     int count, i;
 642     struct hitsbytarget *ht;
 643     struct http_request *rq = c->request;
 644     const char *settings = http_argbyname(rq, "settings");
 645     struct http_session *s = locate_session(c);
 646
 647     ht = get_hitsbytarget(s->psession, &count, c->nmem);
 648     response_open(c, "bytarget");
 649     if (count == 0)
 650         yaz_log(YLOG_WARN, "Empty bytarget Response. No targets found!");
 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, ht[i].settings_xml);
 677             wrbuf_puts(c->wrbuf, "</settings>\n");
 678         }
 679         if (ht[i].suggestions_xml && ht[i].suggestions_xml[0]) {
 680             wrbuf_puts(c->wrbuf, "<suggestions>");
 681             wrbuf_puts(c->wrbuf, ht[i].suggestions_xml);
 682             wrbuf_puts(c->wrbuf, "</suggestions>");
 683         }
 684         wrbuf_puts(c->wrbuf, "</target>");
 685     }
 686     response_close(c, "bytarget");
 687     release_session(c, s);
 688 }
 689
 690 static void bytarget_result_ready(void *data)
 691 {
 692     struct http_channel *c = (struct http_channel *) data;
 693     yaz_log(c->http_sessions->log_level, "bytarget watch released");
 694     bytarget_response(c);
 695 }
 696
 697
 698 static void cmd_bytarget(struct http_channel *c)
 699 {
 700     struct http_request *rq = c->request;
 701     struct http_response *rs = c->response;
 702     struct http_session *s = locate_session(c);
 703     const char *block = http_argbyname(rq, "block");
 704     int no_active;
 705
 706     if (!s)
 707         return;
 708
 709     no_active = session_active_clients(s->psession);
 710
 711     if (block && !strcmp("1",block) && no_active)
 712     {
 713         // if there is already a watch/block. we do not block this one
 714         if (session_set_watch(s->psession, SESSION_WATCH_BYTARGET,
 715                               bytarget_result_ready, c, c) != 0)
 716         {
 717             yaz_log(YLOG_WARN, "Attempt to block multiple times on bytarget block. Not supported!");
 718             error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget");
 719         }
 720         else
 721         {
 722             yaz_log(c->http_sessions->log_level, "%p Session %u: Blocking on command bytarget", s, s->session_id);
 723         }
 724         release_session(c, s);
 725         return;
 726     }
 727     bytarget_response(c);
 728     release_session(c, s);
 729 }
 730
 731 static void write_metadata(WRBUF w, struct conf_service *service,
 732         struct record_metadata **ml, int full)
 733 {
 734     int imeta;
 735
 736     for (imeta = 0; imeta < service->num_metadata; imeta++)
 737     {
 738         struct conf_metadata *cmd = &service->metadata[imeta];
 739         struct record_metadata *md;
 740         if (!cmd->brief && !full)
 741             continue;
 742         for (md = ml[imeta]; md; md = md->next)
 743         {
 744             struct record_metadata_attr *attr = md->attributes;
 745             wrbuf_printf(w, "\n<md-%s", cmd->name);
 746
 747             for (; attr; attr = attr->next)
 748             {
 749                 wrbuf_printf(w, " %s=\"", attr->name);
 750                 wrbuf_xmlputs(w, attr->value);
 751                 wrbuf_puts(w, "\"");
 752             }
 753             wrbuf_puts(w, ">");
 754             switch (cmd->type)
 755             {
 756                 case Metadata_type_generic:
 757                     wrbuf_xmlputs(w, md->data.text.disp);
 758                     break;
 759                 case Metadata_type_year:
 760                     wrbuf_printf(w, "%d", md->data.number.min);
 761                     if (md->data.number.min != md->data.number.max)
 762                         wrbuf_printf(w, "-%d", md->data.number.max);
 763                     break;
 764                 default:
 765                     wrbuf_puts(w, "[can't represent]");
 766             }
 767             wrbuf_printf(w, "</md-%s>", cmd->name);
 768         }
 769     }
 770 }
 771
 772 static void write_subrecord(struct record *r, WRBUF w,
 773         struct conf_service *service, int show_details)
 774 {
 775     const char *name = session_setting_oneval(
 776         client_get_database(r->client), PZ_NAME);
 777
 778     wrbuf_puts(w, "<location id=\"");
 779     wrbuf_xmlputs(w, client_get_id(r->client));
 780     wrbuf_puts(w, "\" ");
 781
 782     wrbuf_puts(w, "name=\"");
 783     wrbuf_xmlputs(w,  *name ? name : "Unknown");
 784     wrbuf_puts(w, "\">");
 785
 786     write_metadata(w, service, r->metadata, show_details);
 787     wrbuf_puts(w, "</location>\n");
 788 }
 789
 790 static void show_raw_record_error(void *data, const char *addinfo)
 791 {
 792     http_channel_observer_t obs = data;
 793     struct http_channel *c = http_channel_observer_chan(obs);
 794     struct http_response *rs = c->response;
 795
 796     http_remove_observer(obs);
 797
 798     error(rs, PAZPAR2_RECORD_FAIL, addinfo);
 799 }
 800
 801 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
 802 {
 803     http_channel_observer_t obs = data;
 804     struct http_channel *c = http_channel_observer_chan(obs);
 805     struct http_response *rs = c->response;
 806
 807     http_remove_observer(obs);
 808
 809     wrbuf_write(c->wrbuf, buf, sz);
 810     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 811     http_send_response(c);
 812 }
 813
 814
 815 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
 816 {
 817     http_channel_observer_t obs = data;
 818     struct http_channel *c = http_channel_observer_chan(obs);
 819     struct http_response *rs = c->response;
 820
 821     http_remove_observer(obs);
 822
 823     wrbuf_write(c->wrbuf, buf, sz);
 824     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 825
 826     rs->content_type = "application/octet-stream";
 827     http_send_response(c);
 828 }
 829
 830
 831 void show_raw_reset(void *data, struct http_channel *c, void *data2)
 832 {
 833     //struct client *client = data;
 834     //client_show_raw_remove(client, data2);
 835 }
 836
 837 static void cmd_record_ready(void *data);
 838
 839 static void cmd_record(struct http_channel *c)
 840 {
 841     struct http_response *rs = c->response;
 842     struct http_request *rq = c->request;
 843     struct http_session *s = locate_session(c);
 844     struct record_cluster *rec, *prev_r, *next_r;
 845     struct record *r;
 846     struct conf_service *service;
 847     const char *idstr = http_argbyname(rq, "id");
 848     const char *offsetstr = http_argbyname(rq, "offset");
 849     const char *binarystr = http_argbyname(rq, "binary");
 850
 851     if (!s)
 852         return;
 853     service = s->psession->service;
 854     if (!idstr)
 855     {
 856         error(rs, PAZPAR2_MISSING_PARAMETER, "id");
 857         return;
 858     }
 859     wrbuf_rewind(c->wrbuf);
 860     if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
 861     {
 862         if (session_active_clients(s->psession) == 0)
 863         {
 864             error(rs, PAZPAR2_RECORD_MISSING, idstr);
 865         }
 866         else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
 867                               cmd_record_ready, c, c) != 0)
 868         {
 869             error(rs, PAZPAR2_RECORD_MISSING, idstr);
 870         }
 871         release_session(c, s);
 872         return;
 873     }
 874     if (offsetstr)
 875     {
 876         int offset = atoi(offsetstr);
 877         const char *syntax = http_argbyname(rq, "syntax");
 878         const char *esn = http_argbyname(rq, "esn");
 879         int i;
 880         struct record*r = rec->records;
 881         int binary = 0;
 882
 883         if (binarystr && *binarystr != '0')
 884             binary = 1;
 885
 886         for (i = 0; i < offset && r; r = r->next, i++)
 887             ;
 888         if (!r)
 889         {
 890             error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
 891         }
 892         else
 893         {
 894             http_channel_observer_t obs =
 895                 http_add_observer(c, r->client, show_raw_reset);
 896             int ret = client_show_raw_begin(r->client, r->position,
 897                                         syntax, esn,
 898                                         obs /* data */,
 899                                         show_raw_record_error,
 900                                         (binary ?
 901                                          show_raw_record_ok_binary :
 902                                          show_raw_record_ok),
 903                                         (binary ? 1 : 0));
 904             if (ret == -1)
 905             {
 906                 http_remove_observer(obs);
 907                 error(rs, PAZPAR2_NO_SESSION, 0);
 908             }
 909         }
 910     }
 911     else
 912     {
 913         response_open_no_status(c, "record");
 914         wrbuf_puts(c->wrbuf, "\n<recid>");
 915         wrbuf_xmlputs(c->wrbuf, rec->recid);
 916         wrbuf_puts(c->wrbuf, "</recid>\n");
 917         if (prev_r)
 918         {
 919             wrbuf_puts(c->wrbuf, "<prevrecid>");
 920             wrbuf_xmlputs(c->wrbuf, prev_r->recid);
 921             wrbuf_puts(c->wrbuf, "</prevrecid>\n");
 922         }
 923         if (next_r)
 924         {
 925             wrbuf_puts(c->wrbuf, "<nextrecid>");
 926             wrbuf_xmlputs(c->wrbuf, next_r->recid);
 927             wrbuf_puts(c->wrbuf, "</nextrecid>\n");
 928         }
 929         wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n",
 930                      session_active_clients(s->psession));
 931         write_metadata(c->wrbuf, service, rec->metadata, 1);
 932         for (r = rec->records; r; r = r->next)
 933             write_subrecord(r, c->wrbuf, service, 1);
 934         response_close(c, "record");
 935     }
 936     show_single_stop(s->psession, rec);
 937     release_session(c, s);
 938 }
 939
 940 static void cmd_record_ready(void *data)
 941 {
 942     struct http_channel *c = (struct http_channel *) data;
 943
 944     cmd_record(c);
 945 }
 946
 947 static void show_records(struct http_channel *c, int active)
 948 {
 949     struct http_request *rq = c->request;
 950     struct http_response *rs = c->response;
 951     struct http_session *s = locate_session(c);
 952     struct record_cluster **rl;
 953     struct reclist_sortparms *sp;
 954     const char *start = http_argbyname(rq, "start");
 955     const char *num = http_argbyname(rq, "num");
 956     const char *sort = http_argbyname(rq, "sort");
 957     int startn = 0;
 958     int numn = 20;
 959     int total;
 960     Odr_int total_hits;
 961     int i;
 962
 963     if (!s)
 964         return;
 965
 966     // We haven't counted clients yet if we're called on a block release
 967     if (active < 0)
 968         active = session_active_clients(s->psession);
 969
 970     if (start)
 971         startn = atoi(start);
 972     if (num)
 973         numn = atoi(num);
 974     if (!sort)
 975         sort = "relevance";
 976     if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
 977     {
 978         error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
 979         release_session(c, s);
 980         return;
 981
 982     }
 983
 984
 985     rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits);
 986
 987     response_open(c, "show");
 988     wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
 989     wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
 990     wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
 991     wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
 992     wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
 993
 994     for (i = 0; i < numn; i++)
 995     {
 996         int ccount;
 997         struct record *p;
 998         struct record_cluster *rec = rl[i];
 999         struct conf_service *service = s->psession->service;
1000
1001         wrbuf_puts(c->wrbuf, "<hit>\n");
1002         write_metadata(c->wrbuf, service, rec->metadata, 0);
1003         for (ccount = 0, p = rl[i]->records; p;  p = p->next, ccount++)
1004             write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
1005         if (ccount > 1)
1006             wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
1007         if (strstr(sort, "relevance"))
1008             wrbuf_printf(c->wrbuf, "<relevance>%d</relevance>\n",
1009                          rec->relevance_score);
1010         wrbuf_puts(c->wrbuf, "<recid>");
1011         wrbuf_xmlputs(c->wrbuf, rec->recid);
1012         wrbuf_puts(c->wrbuf, "</recid>\n");
1013         wrbuf_puts(c->wrbuf, "</hit>\n");
1014     }
1015
1016     show_range_stop(s->psession, rl);
1017
1018     response_close(c, "show");
1019     release_session(c, s);
1020 }
1021
1022 static void show_records_ready(void *data)
1023 {
1024     struct http_channel *c = (struct http_channel *) data;
1025
1026     show_records(c, -1);
1027 }
1028
1029 static void cmd_show(struct http_channel *c)
1030 {
1031     struct http_request  *rq = c->request;
1032     struct http_response *rs = c->response;
1033     struct http_session *s = locate_session(c);
1034     const char *block = http_argbyname(rq, "block");
1035     const char *sort = http_argbyname(rq, "sort");
1036     struct reclist_sortparms *sp;
1037     int status;
1038
1039     if (!s)
1040         return;
1041
1042     if (!sort)
1043         sort = "relevance";
1044
1045     if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
1046     {
1047         error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
1048         release_session(c, s);
1049         return;
1050     }
1051     session_sort(s->psession, sp->name, sp->increasing);
1052
1053     status = session_active_clients(s->psession);
1054
1055     if (block)
1056     {
1057         if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0)
1058         {
1059             // if there is already a watch/block. we do not block this one
1060             if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
1061                                   show_records_ready, c, c) == 0)
1062             {
1063                 yaz_log(c->http_sessions->log_level,
1064                         "%p Session %u: Blocking on command show (preferred targets)", s, s->session_id);
1065             }
1066             else
1067             {
1068                 yaz_log(YLOG_WARN, "Attempt to block multiple times on show (preferred targets) block. Not supported!");
1069                 error(rs, PAZPAR2_ALREADY_BLOCKED, "show (preferred targets)");
1070             }
1071             release_session(c, s);
1072             return;
1073
1074         }
1075         else if (status)
1076         {
1077             // if there is already a watch/block. we do not block this one
1078             if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
1079                                   show_records_ready, c, c) != 0)
1080             {
1081                 yaz_log(YLOG_WARN, "Attempt to block multiple times on show block. Not supported!");
1082                 error(rs, PAZPAR2_ALREADY_BLOCKED, "show");
1083             }
1084             else
1085             {
1086                 yaz_log(c->http_sessions->log_level, "%p Session %u: Blocking on command show", s, s->session_id);
1087             }
1088             release_session(c, s);
1089             return;
1090         }
1091     }
1092     show_records(c, status);
1093     release_session(c, s);
1094 }
1095
1096 static void cmd_ping(struct http_channel *c)
1097 {
1098     struct http_session *s = locate_session(c);
1099     if (!s)
1100         return;
1101     response_open(c, "ping");
1102     response_close(c, "ping");
1103     release_session(c, s);
1104 }
1105
1106 static void cmd_search(struct http_channel *c)
1107 {
1108     struct http_request *rq = c->request;
1109     struct http_response *rs = c->response;
1110     struct http_session *s = locate_session(c);
1111     const char *query = http_argbyname(rq, "query");
1112     const char *filter = http_argbyname(rq, "filter");
1113     const char *maxrecs = http_argbyname(rq, "maxrecs");
1114     const char *startrecs = http_argbyname(rq, "startrecs");
1115     const char *limit = http_argbyname(rq, "limit");
1116     enum pazpar2_error_code code;
1117     const char *addinfo = 0;
1118
1119     if (!s)
1120         return;
1121     if (!query)
1122     {
1123         error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1124         release_session(c, s);
1125         return;
1126     }
1127     if (!yaz_utf8_check(query))
1128     {
1129         error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1130         release_session(c, s);
1131         return;
1132     }
1133     code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
1134                           &addinfo, "relevance", 0);
1135     if (code)
1136     {
1137         error(rs, code, addinfo);
1138         release_session(c, s);
1139         return;
1140     }
1141     response_open(c, "search");
1142     response_close(c, "search");
1143     release_session(c, s);
1144 }
1145
1146
1147 static void cmd_stat(struct http_channel *c)
1148 {
1149     struct http_session *s = locate_session(c);
1150     struct statistics stat;
1151     int clients;
1152
1153     float progress = 0;
1154
1155     if (!s)
1156         return;
1157
1158     clients = session_active_clients(s->psession);
1159     statistics(s->psession, &stat);
1160
1161     if (stat.num_clients > 0)
1162     {
1163         progress = (stat.num_clients  - clients) / (float)stat.num_clients;
1164     }
1165
1166     response_open_no_status(c, "stat");
1167     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
1168     wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1169     wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
1170     wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
1171     wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
1172     wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
1173     wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
1174     wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
1175     wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
1176     wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
1177     wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
1178     response_close(c, "stat");
1179     release_session(c, s);
1180 }
1181
1182 static void cmd_info(struct http_channel *c)
1183 {
1184     char yaz_version_str[20];
1185
1186     response_open_no_status(c, "info");
1187     wrbuf_puts(c->wrbuf, " <version>\n");
1188     wrbuf_puts(c->wrbuf, "  <pazpar2");
1189 #ifdef PAZPAR2_VERSION_SHA1
1190     wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1191 #endif
1192     wrbuf_puts(c->wrbuf, ">");
1193     wrbuf_xmlputs(c->wrbuf, VERSION);
1194     wrbuf_puts(c->wrbuf, "</pazpar2>");
1195
1196     yaz_version(yaz_version_str, 0);
1197     wrbuf_puts(c->wrbuf, "  <yaz compiled=\"");
1198     wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1199     wrbuf_puts(c->wrbuf, "\">");
1200     wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1201     wrbuf_puts(c->wrbuf, "</yaz>\n");
1202
1203     wrbuf_puts(c->wrbuf, " </version>\n");
1204
1205     info_services(c->server, c->wrbuf);
1206
1207     response_close(c, "info");
1208 }
1209
1210 struct {
1211     char *name;
1212     void (*fun)(struct http_channel *c);
1213 } commands[] = {
1214     { "init", cmd_init },
1215     { "settings", cmd_settings },
1216     { "stat", cmd_stat },
1217     { "bytarget", cmd_bytarget },
1218     { "show", cmd_show },
1219     { "search", cmd_search },
1220     { "termlist", cmd_termlist },
1221     { "exit", cmd_exit },
1222     { "session-status", cmd_session_status },
1223     { "server-status", cmd_server_status },
1224     { "ping", cmd_ping },
1225     { "record", cmd_record },
1226     { "info", cmd_info },
1227     {0,0}
1228 };
1229
1230 void http_command(struct http_channel *c)
1231 {
1232     const char *command = http_argbyname(c->request, "command");
1233     struct http_response *rs = http_create_response(c);
1234     int i;
1235
1236     c->response = rs;
1237
1238     http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1239     http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1240
1241     if (!command)
1242     {
1243         error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1244         return;
1245     }
1246     for (i = 0; commands[i].name; i++)
1247         if (!strcmp(commands[i].name, command))
1248         {
1249             (*commands[i].fun)(c);
1250             break;
1251         }
1252     if (!commands[i].name)
1253         error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1254
1255     return;
1256 }
1257
1258 /*
1259  * Local variables:
1260  * c-basic-offset: 4
1261  * c-file-style: "Stroustrup"
1262  * indent-tabs-mode: nil
1263  * End:
1264  * vim: shiftwidth=4 tabstop=8 expandtab
1265  */
1266