Add <progress /> tag to support a progress bar. The value is between 0 ... 1
[pazpar2-moved-to-github.git] / src / http_command.c
index 087f53d..8ec3264 100644 (file)
@@ -1,7 +1,5 @@
-/* $Id: http_command.c,v 1.57 2007-07-16 17:01:46 adam Exp $
-   Copyright (c) 2006-2007, Index Data.
-
-This file is part of Pazpar2.
+/* This file is part of Pazpar2.
+   Copyright (C) 2006-2009 Index Data
 
 Pazpar2 is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
@@ -14,31 +12,27 @@ FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 for more details.
 
 You should have received a copy of the GNU General Public License
-along with Pazpar2; see the file LICENSE.  If not, write to the
-Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-02111-1307, USA.
- */
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
-/*
- * $Id: http_command.c,v 1.57 2007-07-16 17:01:46 adam Exp $
- */
+*/
 
+#if HAVE_CONFIG_H
+#include <config.h>
+#endif
 #include <stdio.h>
 #include <sys/types.h>
-#include <sys/uio.h>
+#if HAVE_UNISTD_H
 #include <unistd.h>
+#endif
 #include <stdlib.h>
-#include <strings.h>
-#include <ctype.h>
+#include <string.h>
+#if HAVE_SYS_TIME_H
 #include <sys/time.h>
-#include <yaz/snprintf.h>
-#if HAVE_CONFIG_H
-#include <cconfig.h>
 #endif
-
+#include <yaz/snprintf.h>
 #include <yaz/yaz-util.h>
 
-#include "config.h"
 #include "util.h"
 #include "eventl.h"
 #include "pazpar2.h"
@@ -68,7 +62,7 @@ static void session_timeout(IOCHAN i, int event)
     http_session_destroy(s);
 }
 
-struct http_session *http_session_create()
+struct http_session *http_session_create(void)
 {
     NMEM nmem = nmem_create();
     struct http_session *r = nmem_malloc(nmem, sizeof(*r));
@@ -139,24 +133,27 @@ static void error(struct http_response *rs,
                   const char *addinfo)
 {
     struct http_channel *c = rs->channel;
-    char text[1024];
+    WRBUF text = wrbuf_alloc();
     const char *http_status = "417";
     const char *msg = get_msg(code);
-
+    
     rs->msg = nmem_strdup(c->nmem, msg);
     strcpy(rs->code, http_status);
 
-    yaz_snprintf(text, sizeof(text),
-                 "<error code=\"%d\" msg=\"%s\">%s</error>", (int) code,
-                 msg, addinfo ? addinfo : "");
+    wrbuf_printf(text, "<error code=\"%d\" msg=\"%s\">", (int) code,
+               msg);
+    if (addinfo)
+        wrbuf_xmlputs(text, addinfo);
+    wrbuf_puts(text, "</error>");
 
     yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
             msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
-    rs->payload = nmem_strdup(c->nmem, text);
+    rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text));
+    wrbuf_destroy(text);
     http_send_response(c);
 }
 
-unsigned int make_sessionid()
+unsigned int make_sessionid(void)
 {
     static int seq = 0;
     unsigned int res;
@@ -166,6 +163,9 @@ unsigned int make_sessionid()
         res = seq;
     else
     {
+#ifdef WIN32
+        res = seq;
+#else
         struct timeval t;
 
         if (gettimeofday(&t, 0) < 0)
@@ -177,6 +177,7 @@ unsigned int make_sessionid()
            (long long would be more appropriate)*/
         res = t.tv_sec;
         res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
+#endif
     }
     return res;
 }
@@ -236,7 +237,7 @@ static int process_settings(struct session *se, struct http_request *rq,
 static void cmd_exit(struct http_channel *c)
 {
     yaz_log(YLOG_WARN, "exit");
-    exit(0);
+    http_close_server();
 }
 
 static void cmd_init(struct http_channel *c)
@@ -286,13 +287,13 @@ static int cmp_ht(const void *p1, const void *p2)
 }
 
 // This implements functionality somewhat similar to 'bytarget', but in a termlist form
-static void targets_termlist(WRBUF wrbuf, struct session *se, int num)
+static void targets_termlist(WRBUF wrbuf, struct session *se, int num,
+                             NMEM nmem)
 {
     struct hitsbytarget *ht;
     int count, i;
 
-    if (!(ht = hitsbytarget(se, &count)))
-        return;
+    ht = hitsbytarget(se, &count, nmem);
     qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
     for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
     {
@@ -367,7 +368,7 @@ static void cmd_termlist(struct http_channel *c)
         wrbuf_xmlputs(c->wrbuf, tname);
         wrbuf_puts(c->wrbuf, "\">\n");
         if (!strcmp(tname, "xtargets"))
-            targets_termlist(c->wrbuf, s->psession, num);
+            targets_termlist(c->wrbuf, s->psession, num, c->nmem);
         else
         {
             p = termlist(s->psession, tname, &len);
@@ -409,11 +410,7 @@ static void cmd_bytarget(struct http_channel *c)
 
     if (!s)
         return;
-    if (!(ht = hitsbytarget(s->psession, &count)))
-    {
-        error(rs, PAZPAR2_HITCOUNTS_FAILED, 0);
-        return;
-    }
+    ht = hitsbytarget(s->psession, &count, c->nmem);
     wrbuf_rewind(c->wrbuf);
     wrbuf_puts(c->wrbuf, "<bytarget><status>OK</status>");
 
@@ -425,6 +422,13 @@ static void cmd_bytarget(struct http_channel *c)
         wrbuf_xmlputs(c->wrbuf, ht[i].id);
         wrbuf_puts(c->wrbuf, "</id>\n");
 
+        if (ht[i].name && ht[i].name[0]) 
+        {
+            wrbuf_puts(c->wrbuf, "<name>");
+            wrbuf_xmlputs(c->wrbuf, ht[i].name);
+            wrbuf_puts(c->wrbuf, "</name>\n");
+        }
+
         wrbuf_printf(c->wrbuf, "<hits>%d</hits>\n", ht[i].hits);
         wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
         wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
@@ -459,7 +463,7 @@ static void write_metadata(WRBUF w, struct conf_service *service,
             switch (cmd->type)
             {
                 case Metadata_type_generic:
-                    wrbuf_xmlputs(w, md->data.text);
+                    wrbuf_xmlputs(w, md->data.text.disp);
                     break;
                 case Metadata_type_year:
                     wrbuf_printf(w, "%d", md->data.number.min);
@@ -477,7 +481,8 @@ static void write_metadata(WRBUF w, struct conf_service *service,
 static void write_subrecord(struct record *r, WRBUF w,
         struct conf_service *service, int show_details)
 {
-    char *name = session_setting_oneval(client_get_database(r->client), PZ_NAME);
+    const char *name = session_setting_oneval(
+        client_get_database(r->client), PZ_NAME);
 
     wrbuf_puts(w, "<location id=\"");
     wrbuf_xmlputs(w, client_get_database(r->client)->database->url);
@@ -487,8 +492,7 @@ static void write_subrecord(struct record *r, WRBUF w,
     wrbuf_xmlputs(w,  *name ? name : "Unknown");
     wrbuf_puts(w, "\">");
 
-    if (show_details)
-        write_metadata(w, service, r->metadata, 1);
+    write_metadata(w, service, r->metadata, show_details);
     wrbuf_puts(w, "</location>\n");
 }
 
@@ -516,12 +520,31 @@ static void show_raw_record_ok(void *data, const char *buf, size_t sz)
     http_send_response(c);
 }
 
-void show_raw_reset(void *data, struct http_channel *c)
+
+static void show_raw_record_ok_binary(void *data, const char *buf, size_t sz)
+{
+    http_channel_observer_t obs = data;
+    struct http_channel *c = http_channel_observer_chan(obs);
+    struct http_response *rs = c->response;
+
+    http_remove_observer(obs);
+
+    wrbuf_write(c->wrbuf, buf, sz);
+    rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
+
+    rs->content_type = "application/octet-stream";
+    http_send_response(c);
+}
+
+
+void show_raw_reset(void *data, struct http_channel *c, void *data2)
 {
-    struct client *client = data;
-    client_show_raw_reset(client);
+    //struct client *client = data;
+    //client_show_raw_remove(client, data2);
 }
 
+static void cmd_record_ready(void *data);
+
 static void cmd_record(struct http_channel *c)
 {
     struct http_response *rs = c->response;
@@ -532,6 +555,7 @@ static void cmd_record(struct http_channel *c)
     struct conf_service *service = global_parameters.server->service;
     const char *idstr = http_argbyname(rq, "id");
     const char *offsetstr = http_argbyname(rq, "offset");
+    const char *binarystr = http_argbyname(rq, "binary");
     
     if (!s)
         return;
@@ -543,7 +567,11 @@ static void cmd_record(struct http_channel *c)
     wrbuf_rewind(c->wrbuf);
     if (!(rec = show_single(s->psession, idstr)))
     {
-        error(rs, PAZPAR2_RECORD_MISSING, idstr);
+        if (session_set_watch(s->psession, SESSION_WATCH_RECORD,
+                              cmd_record_ready, c, c) != 0)
+        {
+            error(rs, PAZPAR2_RECORD_MISSING, idstr);
+        }
         return;
     }
     if (offsetstr)
@@ -553,6 +581,10 @@ static void cmd_record(struct http_channel *c)
         const char *esn = http_argbyname(rq, "esn");
         int i;
         struct record*r = rec->records;
+        int binary = 0;
+
+        if (binarystr && *binarystr != '0')
+            binary = 1;
 
         for (i = 0; i < offset && r; r = r->next, i++)
             ;
@@ -563,15 +595,22 @@ static void cmd_record(struct http_channel *c)
         }
         else
         {
+            void *data2;
             http_channel_observer_t obs =
                 http_add_observer(c, r->client, show_raw_reset);
-            if (client_show_raw_begin(r->client, r->position, syntax, esn, 
+            int ret = 
+                client_show_raw_begin(r->client, r->position, syntax, esn, 
                                       obs /* data */,
                                       show_raw_record_error,
-                                      show_raw_record_ok))
+                                      (binary ? 
+                                       show_raw_record_ok_binary : 
+                                       show_raw_record_ok),
+                                      &data2,
+                                      (binary ? 1 : 0));
+            if (ret == -1)
             {
                 http_remove_observer(obs);
-                error(rs, PAZPAR2_RECORD_FAIL, "invalid parameters");
+                error(rs, PAZPAR2_NO_SESSION, 0);
                 return;
             }
         }
@@ -579,7 +618,9 @@ static void cmd_record(struct http_channel *c)
     else
     {
         wrbuf_puts(c->wrbuf, "<record>\n");
-        wrbuf_printf(c->wrbuf, "<recid>%s</recid>\n", rec->recid);
+        wrbuf_puts(c->wrbuf, "<recid>");
+        wrbuf_xmlputs(c->wrbuf, rec->recid);
+        wrbuf_puts(c->wrbuf, "</recid>\n");
         write_metadata(c->wrbuf, service, rec->metadata, 1);
         for (r = rec->records; r; r = r->next)
             write_subrecord(r, c->wrbuf, service, 1);
@@ -589,6 +630,13 @@ static void cmd_record(struct http_channel *c)
     }
 }
 
+static void cmd_record_ready(void *data)
+{
+    struct http_channel *c = (struct http_channel *) data;
+
+    cmd_record(c);
+}
+
 static void show_records(struct http_channel *c, int active)
 {
     struct http_request *rq = c->request;
@@ -647,7 +695,9 @@ static void show_records(struct http_channel *c, int active)
             write_subrecord(p, c->wrbuf, service, 0); // subrecs w/o details
         if (ccount > 1)
             wrbuf_printf(c->wrbuf, "<count>%d</count>\n", ccount);
-        wrbuf_printf(c->wrbuf, "<recid>%s</recid>\n", rec->recid);
+        wrbuf_puts(c->wrbuf, "<recid>");
+        wrbuf_xmlputs(c->wrbuf, rec->recid);
+        wrbuf_puts(c->wrbuf, "</recid>\n");
         wrbuf_puts(c->wrbuf, "</hit>\n");
     }
 
@@ -681,13 +731,12 @@ static void cmd_show(struct http_channel *c)
         if (status && (!s->psession->reclist || !s->psession->reclist->num_records))
         {
             // if there is already a watch/block. we do not block this one
-            if (session_set_watch(s->psession,
-                                  SESSION_WATCH_RECORDS,
-                                  show_records_ready, c, c) == 0)
+            if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
+                                  show_records_ready, c, c) != 0)
             {
                 yaz_log(YLOG_DEBUG, "Blocking on cmd_show");
-                return;
             }
+            return;
         }
     }
 
@@ -771,12 +820,18 @@ static void cmd_stat(struct http_channel *c)
     struct statistics stat;
     int clients;
 
+    float progress = 0;
+
     if (!s)
         return;
 
     clients = session_active_clients(s->psession);
     statistics(s->psession, &stat);
 
+    if (stat.num_clients > 0) {
+       progress = (stat.num_clients  - clients) / (float)stat.num_clients;
+    }
+
     wrbuf_rewind(c->wrbuf);
     wrbuf_puts(c->wrbuf, "<stat>");
     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", clients);
@@ -785,12 +840,11 @@ static void cmd_stat(struct http_channel *c)
     wrbuf_printf(c->wrbuf, "<clients>%d</clients>\n", stat.num_clients);
     wrbuf_printf(c->wrbuf, "<unconnected>%d</unconnected>\n", stat.num_no_connection);
     wrbuf_printf(c->wrbuf, "<connecting>%d</connecting>\n", stat.num_connecting);
-    wrbuf_printf(c->wrbuf, "<initializing>%d</initializing>\n", stat.num_initializing);
-    wrbuf_printf(c->wrbuf, "<searching>%d</searching>\n", stat.num_searching);
-    wrbuf_printf(c->wrbuf, "<presenting>%d</presenting>\n", stat.num_presenting);
+    wrbuf_printf(c->wrbuf, "<working>%d</working>\n", stat.num_working);
     wrbuf_printf(c->wrbuf, "<idle>%d</idle>\n", stat.num_idle);
     wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
     wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
+    wrbuf_printf(c->wrbuf, "<progress>%.2f</progress>\n", progress);
     wrbuf_puts(c->wrbuf, "</stat>");
     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
     http_send_response(c);
@@ -872,7 +926,9 @@ void http_command(struct http_channel *c)
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab
  */
+