approximation on bytarget response if version 2 and above
[pazpar2-moved-to-github.git] / src / http_command.c
index 52869a3..d4b4a77 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Pazpar2.
-   Copyright (C) 2006-2011 Index Data
+   Copyright (C) 2006-2012 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
@@ -93,6 +93,16 @@ struct http_sessions {
 static YAZ_MUTEX g_http_session_mutex = 0;
 static int g_http_sessions = 0;
 
+int get_version(struct http_request *rq) {
+    const char *version = http_argbyname(rq, "version");
+    int version_no = 0;
+    if (version && strcmp(version, "")) {
+        version_no = atoi(version);
+    }
+    return version_no;
+}
+
+
 int http_session_use(int delta)
 {
     int sessions;
@@ -510,11 +520,12 @@ static void cmd_settings(struct http_channel *c)
     release_session(c, s);
 }
 
-static void termlist_response(struct http_channel *c, struct http_session *s)
+static void termlist_response(struct http_channel *c, struct http_session *s, const char *cmd_status)
 {
     struct http_request *rq = c->request;
-    const char *name = http_argbyname(rq, "name");
-    const char *nums = http_argbyname(rq, "num");
+    const char *name    = http_argbyname(rq, "name");
+    const char *nums    = http_argbyname(rq, "num");
+    int version = get_version(rq);
     int num = 15;
     int status;
 
@@ -524,9 +535,13 @@ static void termlist_response(struct http_channel *c, struct http_session *s)
     status = session_active_clients(s->psession);
 
     response_open_no_status(c, "termlist");
+    /* new protocol add a status to response. Triggered by a status parameter */
+    if (cmd_status != 0) {
+        wrbuf_printf(c->wrbuf, "<status>%s</status>\n", cmd_status);
+    }
     wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
 
-    perform_termlist(c, s->psession, name, num);
+    perform_termlist(c, s->psession, name, num, version);
 
     response_close(c, "termlist");
 }
@@ -534,10 +549,15 @@ static void termlist_response(struct http_channel *c, struct http_session *s)
 static void termlist_result_ready(void *data)
 {
     struct http_channel *c = (struct http_channel *) data;
+    struct http_request *rq = c->request;
+    const char *report = http_argbyname(rq, "report");
+    const char *status = 0;
     struct http_session *s = locate_session(c);
+    if (report && !strcmp("status", report))
+        status = "OK";
     if (s) {
         yaz_log(c->http_sessions->log_level, "Session %u termlist watch released", s->session_id);
-        termlist_response(c, s);
+        termlist_response(c, s, status);
         release_session(c,s);
     }
 }
@@ -548,12 +568,23 @@ static void cmd_termlist(struct http_channel *c)
     struct http_response *rs = c->response;
     struct http_session *s = locate_session(c);
     const char *block = http_argbyname(rq, "block");
+    const char *report = http_argbyname(rq, "report");
+    int report_status = 0;
+    int report_error = 0;
+    const char *status_message = 0;
     int active_clients;
+    if (report  && !strcmp("error", report)) {
+        report_error = 1;
+        status_message = "OK";
+    }
+    if (report  && !strcmp("status", report)) {
+        report_status = 1;
+        status_message = "OK";
+    }
     if (!s)
         return;
 
     active_clients = session_active_clients(s->psession);
-
     if (block && !strcmp("1", block) && active_clients)
     {
         // if there is already a watch/block. we do not block this one
@@ -561,17 +592,27 @@ static void cmd_termlist(struct http_channel *c)
                               termlist_result_ready, c, c) != 0)
         {
             yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on termlist block. Not supported!", s->session_id);
-            error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
+            if (report_error) {
+                error(rs, PAZPAR2_ALREADY_BLOCKED, "termlist");
+                release_session(c, s);
+                return;
+            }
+            else if (report_status) {
+                status_message = "WARNING (Already blocked on termlist)";
+            }
+            else {
+                yaz_log(YLOG_WARN, "Session %u: Ignoring termlist block. Return current result", s->session_id);
+            }
         }
         else
         {
             yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command termlist", s->session_id);
+            release_session(c, s);
+            return;
         }
-        release_session(c, s);
-        return;
     }
 
-    termlist_response(c, s);
+    termlist_response(c, s, status_message);
     release_session(c, s);
 }
 
@@ -641,14 +682,22 @@ static void cmd_server_status(struct http_channel *c)
     xmalloc_trav(0);
 }
 
-static void bytarget_response(struct http_channel *c, struct http_session *s) {
+static void bytarget_response(struct http_channel *c, struct http_session *s, const char *cmd_status) {
     int count, i;
     struct hitsbytarget *ht;
     struct http_request *rq = c->request;
     const char *settings = http_argbyname(rq, "settings");
-
+    int version = get_version(rq);
     ht = get_hitsbytarget(s->psession, &count, c->nmem);
-    response_open(c, "bytarget");
+    if (!cmd_status)
+        /* Old protocol, always ok */
+        response_open(c, "bytarget");
+    else {
+        /* New protocol, OK or WARNING (...)*/
+        response_open_no_status(c, "bytarget");
+        wrbuf_printf(c->wrbuf, "<status>%s</status>", cmd_status);
+    }
+
     if (count == 0)
         yaz_log(YLOG_WARN, "Empty bytarget Response. No targets found!");
     for (i = 0; i < count; i++)
@@ -676,8 +725,11 @@ static void bytarget_response(struct http_channel *c, struct http_session *s) {
             wrbuf_puts(c->wrbuf, "</addinfo>\n");
         }
 
-        wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records);
-
+        wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
+        if (version >= 2) {
+            wrbuf_printf(c->wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
+            wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
+        }
         wrbuf_puts(c->wrbuf, "<state>");
         wrbuf_xmlputs(c->wrbuf, ht[i].state);
         wrbuf_puts(c->wrbuf, "</state>\n");
@@ -701,9 +753,10 @@ static void bytarget_result_ready(void *data)
 {
     struct http_channel *c = (struct http_channel *) data;
     struct http_session *s = locate_session(c);
+    const char *status_message = "OK";
     if (s) {
         yaz_log(c->http_sessions->log_level, "Session %u: bytarget watch released", s->session_id);
-        bytarget_response(c, s);
+        bytarget_response(c, s, status_message);
         release_session(c, s);
     }
     else {
@@ -718,13 +771,23 @@ static void cmd_bytarget(struct http_channel *c)
     struct http_response *rs = c->response;
     struct http_session *s = locate_session(c);
     const char *block = http_argbyname(rq, "block");
+    const char *report = http_argbyname(rq, "report");
+    int report_error = 0;
+    int report_status = 0;
+    const char *status_message = "OK";
     int no_active;
 
+    if (report && !strcmp("error", report)) {
+        report_error = 1;
+    }
+    if (report && !strcmp("status", report)) {
+        report_status = 1;
+    }
+
     if (!s)
         return;
 
     no_active = session_active_clients(s->psession);
-
     if (block && !strcmp("1",block) && no_active)
     {
         // if there is already a watch/block. we do not block this one
@@ -732,16 +795,26 @@ static void cmd_bytarget(struct http_channel *c)
                               bytarget_result_ready, c, c) != 0)
         {
             yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on bytarget block. Not supported!", s->session_id);
-            error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget"); 
+            if (report_error) {
+                error(rs, PAZPAR2_ALREADY_BLOCKED, "bytarget");
+                release_session(c, s);
+                return;
+            }
+            else if (report_status) {
+                status_message = "WARNING (Already blocked on bytarget)";
+            }
+            else {
+                yaz_log(YLOG_WARN, "Session %u: Ignoring bytarget block. Return current result.", s->session_id);
+            }
         }
         else
         {
             yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command bytarget", s->session_id);
+            release_session(c, s);
+            return;
         }
-        release_session(c, s);
-        return;
     }
-    bytarget_response(c, s);
+    bytarget_response(c, s, status_message);
     release_session(c, s);
 }
 
@@ -984,10 +1057,13 @@ static void show_records(struct http_channel *c, struct http_session *s, int act
     const char *start = http_argbyname(rq, "start");
     const char *num = http_argbyname(rq, "num");
     const char *sort = http_argbyname(rq, "sort");
+    int version = get_version(rq);
+
     int startn = 0;
     int numn = 20;
     int total;
     Odr_int total_hits;
+    Odr_int approx_hits;
     int i;
 
     if (!s)
@@ -1010,12 +1086,15 @@ static void show_records(struct http_channel *c, struct http_session *s, int act
 
     }
     
-    rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits);
+    rl = show_range_start(s->psession, sp, startn, &numn, &total, &total_hits, &approx_hits);
 
     response_open(c, "show");
     wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>\n", active);
     wrbuf_printf(c->wrbuf, "<merged>%d</merged>\n", total);
     wrbuf_printf(c->wrbuf, "<total>" ODR_INT_PRINTF "</total>\n", total_hits);
+    if (version >= 2) {
+        wrbuf_printf(c->wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", approx_hits);
+    }
     wrbuf_printf(c->wrbuf, "<start>%d</start>\n", startn);
     wrbuf_printf(c->wrbuf, "<num>%d</num>\n", numn);
 
@@ -1067,9 +1146,14 @@ static void cmd_show(struct http_channel *c)
     struct http_session *s = locate_session(c);
     const char *block = http_argbyname(rq, "block");
     const char *sort = http_argbyname(rq, "sort");
+    const char *block_error = http_argbyname(rq, "report");
+
     struct reclist_sortparms *sp;
     int status;
-
+    int report_error = 0;
+    if (block_error && !strcmp("1", block_error)) {
+        report_error = 1;
+    }    
     if (!s)
         return;
 
@@ -1096,32 +1180,46 @@ static void cmd_show(struct http_channel *c)
             {
                 yaz_log(c->http_sessions->log_level,
                         "Session %u: Blocking on command show (preferred targets)", s->session_id);
+                release_session(c, s);
+                return;
             }
             else
             {
-                yaz_log(YLOG_WARN, "Attempt to block multiple times on show (preferred targets) block. Not supported!");
-                error(rs, PAZPAR2_ALREADY_BLOCKED, "show (preferred targets)"); 
+                yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on show (preferred targets) block. Not supported!", 
+                    s->session_id);
+                if (report_error) {
+                    error(rs, PAZPAR2_ALREADY_BLOCKED, "show (preferred targets)");
+                    release_session(c, s);
+                    return;
+                }
+                else {
+                    yaz_log(YLOG_WARN, "Session %u: Ignoring show(preferred) block. Returning current result.", s->session_id);
+                }
             }
-            release_session(c, s);
-            return;
 
         }
         else if (status)
         {
             // if there is already a watch/block. we do not block this one
             if (session_set_watch(s->psession, SESSION_WATCH_SHOW,
-                                  show_records_ready, c, c) != 0
-                )
+                                  show_records_ready, c, c) != 0)
             {
-                yaz_log(YLOG_WARN, "Attempt to block multiple times on show block. Not supported!");
-                error(rs, PAZPAR2_ALREADY_BLOCKED, "show"); 
+                yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on show block. Not supported!", s->session_id);
+                if (report_error) {
+                    error(rs, PAZPAR2_ALREADY_BLOCKED, "show");
+                    release_session(c, s);
+                    return;
+                }
+                else {
+                    yaz_log(YLOG_WARN, "Session %u: Ignoring show block. Returning current result.", s->session_id);
+                }
             }
             else
             {
                 yaz_log(c->http_sessions->log_level, "Session %u: Blocking on command show", s->session_id);
+                release_session(c, s);
+                return;
             }
-            release_session(c, s);
-            return;
         }
     }
     show_records(c, s, status);