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_LAST_ERROR, "Last error"},
 233         { 0, 0 }
 234     };
 235     int i = 0;
 236     while (ar[i].msg)
 237     {
 238         if (code == ar[i].code)
 239             return ar[i].msg;
 240         i++;
 241     }
 242     return "No error";
 243 }
 244
 245 static void error(struct http_response *rs,
 246                   enum pazpar2_error_code code,
 247                   const char *addinfo)
 248 {
 249     struct http_channel *c = rs->channel;
 250     WRBUF text = wrbuf_alloc();
 251     const char *http_status = "417";
 252     const char *msg = get_msg(code);
 253
 254     rs->msg = nmem_strdup(c->nmem, msg);
 255     strcpy(rs->code, http_status);
 256
 257     wrbuf_printf(text, HTTP_COMMAND_RESPONSE_PREFIX "<error code=\"%d\" msg=\"%s\">", (int) code,
 258                msg);
 259     if (addinfo)
 260         wrbuf_xmlputs(text, addinfo);
 261     wrbuf_puts(text, "</error>");
 262
 263     yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
 264             msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
 265     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
 266     wrbuf_destroy(text);
 267     http_send_response(c);
 268 }
 269
 270 static void response_open_no_status(struct http_channel *c, const char *command)
 271 {
 272     wrbuf_rewind(c->wrbuf);
 273     wrbuf_printf(c->wrbuf, "%s<%s>",
 274                  HTTP_COMMAND_RESPONSE_PREFIX, command);
 275 }
 276
 277 static void response_open(struct http_channel *c, const char *command)
 278 {
 279     response_open_no_status(c, command);
 280     wrbuf_puts(c->wrbuf, "<status>OK</status>");
 281 }
 282
 283 static void response_close(struct http_channel *c, const char *command)
 284 {
 285     struct http_response *rs = c->response;
 286
 287     wrbuf_printf(c->wrbuf, "</%s>", command);
 288     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 289     http_send_response(c);
 290 }
 291
 292 unsigned int make_sessionid(void)
 293 {
 294     static int seq = 0; /* thread pr */
 295     unsigned int res;
 296
 297     seq++;
 298     if (global_parameters.predictable_sessions)
 299         res = seq;
 300     else
 301     {
 302 #ifdef WIN32
 303         res = seq;
 304 #else
 305         struct timeval t;
 306
 307         if (gettimeofday(&t, 0) < 0)
 308         {
 309             yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
 310             exit(1);
 311         }
 312         /* at most 256 sessions per second ..
 313            (long long would be more appropriate)*/
 314         res = t.tv_sec;
 315         res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
 316 #endif
 317     }
 318     return res;
 319 }
 320
 321 static struct http_session *locate_session(struct http_channel *c)
 322 {
 323     struct http_response *rs = c->response;
 324     struct http_request *rq = c->request;
 325     struct http_session *p;
 326     const char *session = http_argbyname(rq, "session");
 327     http_sessions_t http_sessions = c->http_sessions;
 328     unsigned int id;
 329
 330     if (!session)
 331     {
 332         error(rs, PAZPAR2_MISSING_PARAMETER, "session");
 333         return 0;
 334     }
 335     id = atoi(session);
 336     yaz_mutex_enter(http_sessions->mutex);
 337     for (p = http_sessions->session_list; p; p = p->next)
 338         if (id == p->session_id)
 339             break;
 340     if (p)
 341         p->activity_counter++;
 342     yaz_mutex_leave(http_sessions->mutex);
 343     if (p)
 344         iochan_activity(p->timeout_iochan);
 345     else
 346         error(rs, PAZPAR2_NO_SESSION, session);
 347     return p;
 348 }
 349
 350 // Call after use of locate_session, in order to increment the destroy_counter
 351 static void release_session(struct http_channel *c,
 352                             struct http_session *session)
 353 {
 354     http_sessions_t http_sessions = c->http_sessions;
 355     yaz_mutex_enter(http_sessions->mutex);
 356     if (session)
 357         session->destroy_counter++;
 358     yaz_mutex_leave(http_sessions->mutex);
 359 }
 360
 361 // Decode settings parameters and apply to session
 362 // Syntax: setting[target]=value
 363 static int process_settings(struct session *se, struct http_request *rq,
 364                             struct http_response *rs)
 365 {
 366     struct http_argument *a;
 367
 368     for (a = rq->arguments; a; a = a->next)
 369         if (strchr(a->name, '['))
 370         {
 371             char **res;
 372             int num;
 373             char *dbname;
 374             char *setting;
 375
 376             // Nmem_strsplit *rules*!!!
 377             nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
 378             if (num != 2)
 379             {
 380                 error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
 381                 return -1;
 382             }
 383             setting = res[0];
 384             dbname = res[1];
 385             session_apply_setting(se, dbname, setting,
 386                     nmem_strdup(se->session_nmem, a->value));
 387         }
 388     return 0;
 389 }
 390
 391 static void cmd_exit(struct http_channel *c)
 392 {
 393     yaz_log(YLOG_WARN, "exit");
 394
 395     response_open(c, "exit");
 396     response_close(c, "exit");
 397     http_close_server(c->server);
 398 }
 399
 400 static void cmd_init(struct http_channel *c)
 401 {
 402     struct http_request *r = c->request;
 403     const char *clear = http_argbyname(r, "clear");
 404     const char *content_type = http_lookup_header(r->headers, "Content-Type");
 405     unsigned int sesid;
 406     struct http_session *s;
 407     struct http_response *rs = c->response;
 408     struct conf_service *service = 0; /* no service (yet) */
 409
 410     if (r->content_len && content_type &&
 411         !yaz_strcmp_del("text/xml", content_type, "; "))
 412     {
 413         xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
 414         xmlNode *root_n;
 415         if (!doc)
 416         {
 417             error(rs, PAZPAR2_MALFORMED_SETTING, 0);
 418             return;
 419         }
 420         root_n = xmlDocGetRootElement(doc);
 421         service = service_create(c->server, root_n);
 422         xmlFreeDoc(doc);
 423         if (!service)
 424         {
 425             error(rs, PAZPAR2_MALFORMED_SETTING, 0);
 426             return;
 427         }
 428     }
 429
 430     if (!service)
 431     {
 432         const char *service_name = http_argbyname(c->request, "service");
 433         service = locate_service(c->server, service_name);
 434         if (!service)
 435         {
 436             error(rs, PAZPAR2_NO_SERVICE, service_name ? service_name : "unnamed");
 437             return;
 438         }
 439     }
 440     sesid = make_sessionid();
 441     s = http_session_create(service, c->http_sessions, sesid);
 442
 443     yaz_log(c->http_sessions->log_level, "%p Session init %u ", s, sesid);
 444     if (!clear || *clear == '0')
 445         session_init_databases(s->psession);
 446     else
 447         yaz_log(YLOG_LOG, "HTTP Session %u init: No databases preloaded", sesid);
 448
 449     if (process_settings(s->psession, c->request, c->response) < 0)
 450         return;
 451
 452     response_open(c, "init");
 453     wrbuf_printf(c->wrbuf, "<session>%d", sesid);
 454     if (c->server->server_id)
 455     {
 456         wrbuf_puts(c->wrbuf, ".");
 457         wrbuf_puts(c->wrbuf, c->server->server_id);
 458     }
 459     wrbuf_puts(c->wrbuf, "</session>"
 460                "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol>");
 461
 462     response_close(c, "init");
 463 }
 464
 465 static void apply_local_setting(void *client_data,
 466                                 struct setting *set)
 467 {
 468     struct session *se =  (struct session *) client_data;
 469
 470     session_apply_setting(se, nmem_strdup(se->session_nmem, set->target),
 471                           nmem_strdup(se->session_nmem, set->name),
 472                           nmem_strdup(se->session_nmem, set->value));
 473 }
 474
 475 static void cmd_settings(struct http_channel *c)
 476 {
 477     struct http_response *rs = c->response;
 478     struct http_request *rq = c->request;
 479     struct http_session *s = locate_session(c);
 480     const char *content_type = http_lookup_header(rq->headers, "Content-Type");
 481
 482     if (!s)
 483         return;
 484
 485     if (rq->content_len && content_type &&
 486         !yaz_strcmp_del("text/xml", content_type, "; "))
 487     {
 488         xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
 489         xmlNode *root_n;
 490         if (!doc)
 491         {
 492             error(rs, PAZPAR2_MALFORMED_SETTING, 0);
 493             return;
 494         }
 495         root_n = xmlDocGetRootElement(doc);
 496
 497         settings_read_node_x(root_n, s->psession, apply_local_setting);
 498
 499         xmlFreeDoc(doc);
 500     }
 501     if (process_settings(s->psession, rq, rs) < 0)
 502     {
 503         release_session(c, s);
 504         return;
 505     }
 506     response_open(c, "settings");
 507     response_close(c, "settings");
 508     release_session(c, s);
 509 }
 510
 511 static void cmd_termlist(struct http_channel *c)
 512 {
 513     struct http_request *rq = c->request;
 514     struct http_session *s = locate_session(c);
 515     const char *name = http_argbyname(rq, "name");
 516     const char *nums = http_argbyname(rq, "num");
 517     int num = 15;
 518     int status;
 519
 520     if (!s)
 521         return;
 522
 523     status = session_active_clients(s->psession);
 524
 525     if (nums)
 526         num = atoi(nums);
 527
 528     response_open_no_status(c, "termlist");
 529     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
 530
 531     perform_termlist(c, s->psession, name, num);
 532
 533     response_close(c, "termlist");
 534     release_session(c, s);
 535 }
 536
 537 size_t session_get_memory_status(struct session *session);
 538
 539 static void session_status(struct http_channel *c, struct http_session *s)
 540 {
 541     size_t session_nmem;
 542     wrbuf_printf(c->wrbuf, "<http_count>%u</http_count>\n", s->activity_counter);
 543     wrbuf_printf(c->wrbuf, "<http_nmem>%zu</http_nmem>\n", nmem_total(s->nmem) );
 544     session_nmem = session_get_memory_status(s->psession);
 545     wrbuf_printf(c->wrbuf, "<session_nmem>%zu</session_nmem>\n", session_nmem);
 546 }
 547
 548 static void cmd_session_status(struct http_channel *c)
 549 {
 550     struct http_session *s = locate_session(c);
 551     if (!s)
 552         return;
 553
 554     response_open(c, "session-status");
 555     session_status(c, s);
 556     response_close(c, "session-status");
 557     release_session(c, s);
 558 }
 559
 560 int sessions_count(void);
 561 int clients_count(void);
 562 #ifdef HAVE_RESULTSETS_COUNT
 563 int resultsets_count(void);
 564 #else
 565 #define resultsets_count()      0
 566 #endif
 567
 568 static void cmd_server_status(struct http_channel *c)
 569 {
 570     int sessions   = sessions_count();
 571     int clients    = clients_count();
 572     int resultsets = resultsets_count();
 573
 574     response_open(c, "server-status");
 575     wrbuf_printf(c->wrbuf, "\n  <sessions>%u</sessions>\n", sessions);
 576     wrbuf_printf(c->wrbuf, "  <clients>%u</clients>\n",   clients);
 577     /* Only works if yaz has been compiled with enabling of this */
 578     wrbuf_printf(c->wrbuf, "  <resultsets>%u</resultsets>\n",resultsets);
 579     print_meminfo(c->wrbuf);
 580
 581 /* TODO add all sessions status                         */
 582 /*    http_sessions_t http_sessions = c->http_sessions; */
 583 /*    struct http_session *p;                           */
 584 /*
 585     yaz_mutex_enter(http_sessions->mutex);
 586     for (p = http_sessions->session_list; p; p = p->next)
 587     {
 588         p->activity_counter++;
 589         wrbuf_puts(c->wrbuf, "<session-status>\n");
 590         wrbuf_printf(c->wrbuf, "<id>%s</id>\n", p->session_id);
 591         yaz_mutex_leave(http_sessions->mutex);
 592         session_status(c, p);
 593         wrbuf_puts(c->wrbuf, "</session-status>\n");
 594         yaz_mutex_enter(http_sessions->mutex);
 595         p->activity_counter--;
 596     }
 597     yaz_mutex_leave(http_sessions->mutex);
 598 */
 599     response_close(c, "server-status");
 600     xmalloc_trav(0);
 601 }
 602
 603
 604 static void cmd_bytarget(struct http_channel *c)
 605 {
 606     struct http_request *rq = c->request;
 607     struct http_session *s = locate_session(c);
 608     struct hitsbytarget *ht;
 609     const char *settings = http_argbyname(rq, "settings");
 610     int count, i;
 611
 612     if (!s)
 613         return;
 614     ht = get_hitsbytarget(s->psession, &count, c->nmem);
 615     response_open(c, "bytarget");
 616
 617     for (i = 0; i < count; i++)
 618     {
 619         wrbuf_puts(c->wrbuf, "\n<target>");
 620
 621         wrbuf_puts(c->wrbuf, "<id>");
 622         wrbuf_xmlputs(c->wrbuf, ht[i].id);
 623         wrbuf_puts(c->wrbuf, "</id>\n");
 624
 625         if (ht[i].name && ht[i].name[0])
 626         {
 627             wrbuf_puts(c->wrbuf, "<name>");
 628             wrbuf_xmlputs(c->wrbuf, ht[i].name);
 629             wrbuf_puts(c->wrbuf, "</name>\n");
 630         }
 631
 632         wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", ht[i].hits);
 633         wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
 634         wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
 635
 636         wrbuf_puts(c->wrbuf, "<state>");
 637         wrbuf_xmlputs(c->wrbuf, ht[i].state);
 638         wrbuf_puts(c->wrbuf, "</state>\n");
 639         if (settings && *settings == '1')
 640         {
 641             wrbuf_puts(c->wrbuf, "<settings>\n");
 642             wrbuf_puts(c->wrbuf, ht[i].settings_xml);
 643             wrbuf_puts(c->wrbuf, "</settings>\n");
 644         }
 645         if (ht[i].suggestions_xml)
 646             wrbuf_puts(c->wrbuf, ht[i].suggestions_xml);
 647         wrbuf_puts(c->wrbuf, "</target>");
 648     }
 649     response_close(c, "bytarget");
 650     release_session(c, s);
 651 }
 652
 653 static void write_metadata(WRBUF w, struct conf_service *service,
 654         struct record_metadata **ml, int full)
 655 {
 656     int imeta;
 657
 658     for (imeta = 0; imeta < service->num_metadata; imeta++)
 659     {
 660         struct conf_metadata *cmd = &service->metadata[imeta];
 661         struct record_metadata *md;
 662         if (!cmd->brief && !full)
 663             continue;
 664         for (md = ml[imeta]; md; md = md->next)
 665         {
 666             struct record_metadata_attr *attr = md->attributes;
 667             wrbuf_printf(w, "\n<md-%s", cmd->name);
 668
 669             for (; attr; attr = attr->next)
 670             {
 671                 wrbuf_printf(w, " %s=\"", attr->name);
 672                 wrbuf_xmlputs(w, attr->value);
 673                 wrbuf_puts(w, "\"");
 674             }
 675             wrbuf_puts(w, ">");
 676             switch (cmd->type)
 677             {
 678                 case Metadata_type_generic:
 679                     wrbuf_xmlputs(w, md->data.text.disp);
 680                     break;
 681                 case Metadata_type_year:
 682                     wrbuf_printf(w, "%d", md->data.number.min);
 683                     if (md->data.number.min != md->data.number.max)
 684                         wrbuf_printf(w, "-%d", md->data.number.max);
 685                     break;
 686                 default:
 687                     wrbuf_puts(w, "[can't represent]");
 688             }
 689             wrbuf_printf(w, "</md-%s>", cmd->name);
 690         }
 691     }
 692 }
 693
 694 static void write_subrecord(struct record *r, WRBUF w,
 695         struct conf_service *service, int show_details)
 696 {
 697     const char *name = session_setting_oneval(
 698         client_get_database(r->client), PZ_NAME);
 699
 700     wrbuf_puts(w, "<location id=\"");
 701     wrbuf_xmlputs(w, client_get_id(r->client));
 702     wrbuf_puts(w, "\" ");
 703
 704     wrbuf_puts(w, "name=\"");
 705     wrbuf_xmlputs(w,  *name ? name : "Unknown");
 706     wrbuf_puts(w, "\">");
 707
 708     write_metadata(w, service, r->metadata, show_details);
 709     wrbuf_puts(w, "</location>\n");
 710 }
 711
 712 static void show_raw_record_error(void *data, const char *addinfo)
 713 {
 714     http_channel_observer_t obs = data;
 715     struct http_channel *c = http_channel_observer_chan(obs);
 716     struct http_response *rs = c->response;
 717
 718     http_remove_observer(obs);
 719
 720     error(rs, PAZPAR2_RECORD_FAIL, addinfo);
 721 }
 722
 723 static void show_raw_record_ok(void *data, const char *buf, size_t sz)
 724 {
 725     http_channel_observer_t obs = data;
 726     struct http_channel *c = http_channel_observer_chan(obs);
 727     struct http_response *rs = c->response;
 728
 729     http_remove_observer(obs);
 730
 731     wrbuf_write(c->wrbuf, buf, sz);
 732     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 733     http_send_response(c);
 734 }
 735
 736
 737 static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
 738 {
 739     http_channel_observer_t obs = data;
 740     struct http_channel *c = http_channel_observer_chan(obs);
 741     struct http_response *rs = c->response;
 742
 743     http_remove_observer(obs);
 744
 745     wrbuf_write(c->wrbuf, buf, sz);
 746     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
 747
 748     rs->content_type = "application/octet-stream";
 749     http_send_response(c);
 750 }
 751
 752
 753 void show_raw_reset(void *data, struct http_channel *c, void *data2)
 754 {
 755     //struct client *client = data;
 756     //client_show_raw_remove(client, data2);
 757 }
 758
 759 static void cmd_record_ready(void *data);
 760
 761 static void cmd_record(struct http_channel *c)
 762 {
 763     struct http_response *rs = c->response;
 764     struct http_request *rq = c->request;
 765     struct http_session *s = locate_session(c);
 766     struct record_cluster *rec, *prev_r, *next_r;
 767     struct record *r;
 768     struct conf_service *service;
 769     const char *idstr = http_argbyname(rq, "id");
 770     const char *offsetstr = http_argbyname(rq, "offset");
 771     const char *binarystr = http_argbyname(rq, "binary");
 772
 773     if (!s)
 774         return;
 775     service = s->psession->service;
 776     if (!idstr)
 777     {
 778         error(rs, PAZPAR2_MISSING_PARAMETER, "id");
 779         return;
 780     }
 781     wrbuf_rewind(c->wrbuf);
 782     if (!(rec = show_single_start(s->psession, idstr, &prev_r, &next_r)))
 783     {
 784         if (session_active_clients(s->psession) == 0)
 785         {
 786             error(rs, PAZPAR2_RECORD_MISSING, idstr);
 787         }
 788         else if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
 789                               cmd_record_ready, c, c) != 0)
 790         {
 791             error(rs, PAZPAR2_RECORD_MISSING, idstr);
 792         }
 793         release_session(c, s);
 794         return;
 795     }
 796     if (offsetstr)
 797     {
 798         int offset = atoi(offsetstr);
 799         const char *syntax = http_argbyname(rq, "syntax");
 800         const char *esn = http_argbyname(rq, "esn");
 801         int i;
 802         struct record*r = rec->records;
 803         int binary = 0;
 804
 805         if (binarystr && *binarystr != '0')
 806             binary = 1;
 807
 808         for (i = 0; i < offset && r; r = r->next, i++)
 809             ;
 810         if (!r)
 811         {
 812             error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
 813         }
 814         else
 815         {
 816             http_channel_observer_t obs =
 817                 http_add_observer(c, r->client, show_raw_reset);
 818             int ret = client_show_raw_begin(r->client, r->position,
 819                                         syntax, esn,
 820                                         obs /* data */,
 821                                         show_raw_record_error,
 822                                         (binary ?
 823                                          show_raw_record_ok_binary :
 824                                          show_raw_record_ok),
 825                                         (binary ? 1 : 0));
 826             if (ret == -1)
 827             {
 828                 http_remove_observer(obs);
 829                 error(rs, PAZPAR2_NO_SESSION, 0);
 830             }
 831         }
 832     }
 833     else
 834     {
 835         response_open_no_status(c, "record");
 836         wrbuf_puts(c->wrbuf, "\n<recid>");
 837         wrbuf_xmlputs(c->wrbuf, rec->recid);
 838         wrbuf_puts(c->wrbuf, "</recid>\n");
 839         if (prev_r)
 840         {
 841             wrbuf_puts(c->wrbuf, "<prevrecid>");
 842             wrbuf_xmlputs(c->wrbuf, prev_r->recid);
 843             wrbuf_puts(c->wrbuf, "</prevrecid>\n");
 844         }
 845         if (next_r)
 846         {
 847             wrbuf_puts(c->wrbuf, "<nextrecid>");
 848             wrbuf_xmlputs(c->wrbuf, next_r->recid);
 849             wrbuf_puts(c->wrbuf, "</nextrecid>\n");
 850         }
 851         wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n",
 852                      session_active_clients(s->psession));
 853         write_metadata(c->wrbuf, service, rec->metadata, 1);
 854         for (r = rec->records; r; r = r->next)
 855             write_subrecord(r, c->wrbuf, service, 1);
 856         response_close(c, "record");
 857     }
 858     show_single_stop(s->psession, rec);
 859     release_session(c, s);
 860 }
 861
 862 static void cmd_record_ready(void *data)
 863 {
 864     struct http_channel *c = (struct http_channel *) data;
 865
 866     cmd_record(c);
 867 }
 868
 869 static void show_records(struct http_channel *c, int active)
 870 {
 871     struct http_request *rq = c->request;
 872     struct http_response *rs = c->response;
 873     struct http_session *s = locate_session(c);
 874     struct record_cluster **rl;
 875     struct reclist_sortparms *sp;
 876     const char *start = http_argbyname(rq, "start");
 877     const char *num = http_argbyname(rq, "num");
 878     const char *sort = http_argbyname(rq, "sort");
 879     int startn = 0;
 880     int numn = 20;
 881     int total;
 882     Odr_int total_hits;
 883     int i;
 884
 885     if (!s)
 886         return;
 887
 888     // We haven't counted clients yet if we're called on a block release
 889     if (active < 0)
 890         active = session_active_clients(s->psession);
 891
 892     if (start)
 893         startn = atoi(start);
 894     if (num)
 895         numn = atoi(num);
 896     if (!sort)
 897         sort = "relevance";
 898     if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
 899     {
 900         error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
 901         release_session(c, s);
 902         return;
 903
 904     }
 905
 906
 907     rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits);
 908
 909     response_open(c, "show");
 910     wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
 911     wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
 912     wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
 913     wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
 914     wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
 915
 916     for (i = 0; i < numn; i++)
 917     {
 918         int ccount;
 919         struct record *p;
 920         struct record_cluster *rec = rl[i];
 921         struct conf_service *service = s->psession->service;
 922
 923         wrbuf_puts(c->wrbuf, "<hit>\n");
 924         write_metadata(c->wrbuf, service, rec->metadata, 0);
 925         for (ccount = 0, p = rl[i]->records; p;  p = p->next, ccount++)
 926             write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
 927         if (ccount > 1)
 928             wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
 929         if (strstr(sort, "relevance"))
 930             wrbuf_printf(c->wrbuf, "<relevance>%d</relevance>\n",
 931                          rec->relevance_score);
 932         wrbuf_puts(c->wrbuf, "<recid>");
 933         wrbuf_xmlputs(c->wrbuf, rec->recid);
 934         wrbuf_puts(c->wrbuf, "</recid>\n");
 935         wrbuf_puts(c->wrbuf, "</hit>\n");
 936     }
 937
 938     show_range_stop(s->psession, rl);
 939
 940     response_close(c, "show");
 941     release_session(c, s);
 942 }
 943
 944 static void show_records_ready(void *data)
 945 {
 946     struct http_channel *c = (struct http_channel *) data;
 947
 948     show_records(c, -1);
 949 }
 950
 951 static void cmd_show(struct http_channel *c)
 952 {
 953     struct http_request *rq = c->request;
 954     struct http_session *s = locate_session(c);
 955     const char *block = http_argbyname(rq, "block");
 956     const char *sort = http_argbyname(rq, "sort");
 957     struct reclist_sortparms *sp;
 958     int status;
 959
 960     if (!s)
 961         return;
 962
 963     if (!sort)
 964         sort = "relevance";
 965
 966     if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
 967     {
 968         error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
 969         release_session(c, s);
 970         return;
 971     }
 972     session_sort(s->psession, sp->name, sp->increasing);
 973
 974     status = session_active_clients(s->psession);
 975
 976     if (block)
 977     {
 978         if (!strcmp(block, "preferred") && !session_is_preferred_clients_ready(s->psession) && reclist_get_num_records(s->psession->reclist) == 0)
 979         {
 980             // if there is already a watch/block. we do not block this one
 981             if (session_set_watch(s->psession, SESSION_WATCH_SHOW_PREF,
 982                                   show_records_ready, c, c) != 0)
 983             {
 984                 yaz_log(c->http_sessions->log_level,
 985                         "%p Session %u: Blocking on cmd_show. Waiting for preferred targets", s, s->session_id);
 986             }
 987             release_session(c, s);
 988             return;
 989
 990         }
 991         else if (status)
 992         {
 993             // if there is already a watch/block. we do not block this one
 994             if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
 995                                   show_records_ready, c, c) != 0)
 996             {
 997                 yaz_log(c->http_sessions->log_level, "%p Session %u: Blocking on cmd_show", s, s->session_id);
 998             }
 999             release_session(c, s);
1000             return;
1001         }
1002     }
1003     show_records(c, status);
1004     release_session(c, s);
1005 }
1006
1007 static void cmd_ping(struct http_channel *c)
1008 {
1009     struct http_session *s = locate_session(c);
1010     if (!s)
1011         return;
1012     response_open(c, "ping");
1013     response_close(c, "ping");
1014     release_session(c, s);
1015 }
1016
1017 static void cmd_search(struct http_channel *c)
1018 {
1019     struct http_request *rq = c->request;
1020     struct http_response *rs = c->response;
1021     struct http_session *s = locate_session(c);
1022     const char *query = http_argbyname(rq, "query");
1023     const char *filter = http_argbyname(rq, "filter");
1024     const char *maxrecs = http_argbyname(rq, "maxrecs");
1025     const char *startrecs = http_argbyname(rq, "startrecs");
1026     const char *limit = http_argbyname(rq, "limit");
1027     enum pazpar2_error_code code;
1028     const char *addinfo = 0;
1029
1030     if (!s)
1031         return;
1032     if (!query)
1033     {
1034         error(rs, PAZPAR2_MISSING_PARAMETER, "query");
1035         release_session(c, s);
1036         return;
1037     }
1038     if (!yaz_utf8_check(query))
1039     {
1040         error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
1041         release_session(c, s);
1042         return;
1043     }
1044     code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
1045                           &addinfo, "relevance", 0);
1046     if (code)
1047     {
1048         error(rs, code, addinfo);
1049         release_session(c, s);
1050         return;
1051     }
1052     response_open(c, "search");
1053     response_close(c, "search");
1054     release_session(c, s);
1055 }
1056
1057
1058 static void cmd_stat(struct http_channel *c)
1059 {
1060     struct http_session *s = locate_session(c);
1061     struct statistics stat;
1062     int clients;
1063
1064     float progress = 0;
1065
1066     if (!s)
1067         return;
1068
1069     clients = session_active_clients(s->psession);
1070     statistics(s->psession, &stat);
1071
1072     if (stat.num_clients > 0)
1073     {
1074         progress = (stat.num_clients  - clients) / (float)stat.num_clients;
1075     }
1076
1077     response_open_no_status(c, "stat");
1078     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
1079     wrbuf_printf(c->wrbuf, "<hits>" ODR_INT_PRINTF "</hits>\n", stat.num_hits);
1080     wrbuf_printf(c->wrbuf, "<records>%d</records>\n", stat.num_records);
1081     wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
1082     wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
1083     wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
1084     wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
1085     wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
1086     wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
1087     wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
1088     wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
1089     response_close(c, "stat");
1090     release_session(c, s);
1091 }
1092
1093 static void cmd_info(struct http_channel *c)
1094 {
1095     char yaz_version_str[20];
1096
1097     response_open_no_status(c, "info");
1098     wrbuf_puts(c->wrbuf, " <version>\n");
1099     wrbuf_puts(c->wrbuf, "  <pazpar2");
1100 #ifdef PAZPAR2_VERSION_SHA1
1101     wrbuf_printf(c->wrbuf, " sha1=\"%s\"", PAZPAR2_VERSION_SHA1);
1102 #endif
1103     wrbuf_puts(c->wrbuf, ">");
1104     wrbuf_xmlputs(c->wrbuf, VERSION);
1105     wrbuf_puts(c->wrbuf, "</pazpar2>");
1106
1107     yaz_version(yaz_version_str, 0);
1108     wrbuf_puts(c->wrbuf, "  <yaz compiled=\"");
1109     wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
1110     wrbuf_puts(c->wrbuf, "\">");
1111     wrbuf_xmlputs(c->wrbuf, yaz_version_str);
1112     wrbuf_puts(c->wrbuf, "</yaz>\n");
1113
1114     wrbuf_puts(c->wrbuf, " </version>\n");
1115
1116     info_services(c->server, c->wrbuf);
1117
1118     response_close(c, "info");
1119 }
1120
1121 struct {
1122     char *name;
1123     void (*fun)(struct http_channel *c);
1124 } commands[] = {
1125     { "init", cmd_init },
1126     { "settings", cmd_settings },
1127     { "stat", cmd_stat },
1128     { "bytarget", cmd_bytarget },
1129     { "show", cmd_show },
1130     { "search", cmd_search },
1131     { "termlist", cmd_termlist },
1132     { "exit", cmd_exit },
1133     { "session-status", cmd_session_status },
1134     { "server-status", cmd_server_status },
1135     { "ping", cmd_ping },
1136     { "record", cmd_record },
1137     { "info", cmd_info },
1138     {0,0}
1139 };
1140
1141 void http_command(struct http_channel *c)
1142 {
1143     const char *command = http_argbyname(c->request, "command");
1144     struct http_response *rs = http_create_response(c);
1145     int i;
1146
1147     c->response = rs;
1148
1149     http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
1150     http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
1151
1152     if (!command)
1153     {
1154         error(rs, PAZPAR2_MISSING_PARAMETER, "command");
1155         return;
1156     }
1157     for (i = 0; commands[i].name; i++)
1158         if (!strcmp(commands[i].name, command))
1159         {
1160             (*commands[i].fun)(c);
1161             break;
1162         }
1163     if (!commands[i].name)
1164         error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
1165
1166     return;
1167 }
1168
1169 /*
1170  * Local variables:
1171  * c-basic-offset: 4
1172  * c-file-style: "Stroustrup"
1173  * indent-tabs-mode: nil
1174  * End:
1175  * vim: shiftwidth=4 tabstop=8 expandtab
1176  */
1177