src/http_command.c

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