New element <message> in bytarget response
[pazpar2-moved-to-github.git] / src / http_command.c
index 0ab83ec..9fc50a8 100644 (file)
@@ -49,16 +49,16 @@ void print_meminfo(WRBUF wrbuf)
     struct mallinfo minfo;
     minfo = mallinfo();
     wrbuf_printf(wrbuf, "  <memory>\n"
-                        "   <arena>%d</arena>\n" 
+                        "   <arena>%d</arena>\n"
                         "   <uordblks>%d</uordblks>\n"
                         "   <fordblks>%d</fordblks>\n"
                         "   <ordblks>%d</ordblks>\n"
                         "   <keepcost>%d</keepcost>\n"
-                        "   <hblks>%d</hblks>\n" 
+                        "   <hblks>%d</hblks>\n"
                         "   <hblkhd>%d</hblkhd>\n"
                         "   <virt>%d</virt>\n"
                         "   <virtuse>%d</virtuse>\n"
-                        "  </memory>\n", 
+                        "  </memory>\n",
                  minfo.arena, minfo.uordblks, minfo.fordblks,minfo.ordblks, minfo.keepcost, minfo.hblks, minfo.hblkhd, minfo.arena + minfo.hblkhd, minfo.uordblks + minfo.hblkhd);
 
 }
@@ -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;
@@ -243,7 +253,7 @@ static const char *get_msg(enum pazpar2_error_code code)
     return "No error";
 }
 
-static void error(struct http_response *rs, 
+static void error(struct http_response *rs,
                   enum pazpar2_error_code code,
                   const char *addinfo)
 {
@@ -251,7 +261,7 @@ static void error(struct http_response *rs,
     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);
 
@@ -310,7 +320,7 @@ unsigned int make_sessionid(void)
             yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
             exit(1);
         }
-        /* at most 256 sessions per second .. 
+        /* at most 256 sessions per second ..
            (long long would be more appropriate)*/
         res = t.tv_sec;
         res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
@@ -407,8 +417,8 @@ static void cmd_init(struct http_channel *c)
     struct http_session *s;
     struct http_response *rs = c->response;
     struct conf_service *service = 0; /* no service (yet) */
-    
-    if (r->content_len && content_type && 
+
+    if (r->content_len && content_type &&
         !yaz_strcmp_del("text/xml", content_type, "; "))
     {
         xmlDoc *doc = xmlParseMemory(r->content_buf, r->content_len);
@@ -427,7 +437,7 @@ static void cmd_init(struct http_channel *c)
             return;
         }
     }
-    
+
     if (!service)
     {
         const char *service_name = http_argbyname(c->request, "service");
@@ -440,13 +450,13 @@ static void cmd_init(struct http_channel *c)
     }
     sesid = make_sessionid();
     s = http_session_create(service, c->http_sessions, sesid);
-    
+
     yaz_log(c->http_sessions->log_level, "Session init %u ", sesid);
     if (!clear || *clear == '0')
         session_init_databases(s->psession);
     else
         yaz_log(YLOG_LOG, "Session %u init: No databases preloaded", sesid);
-    
+
     if (process_settings(s->psession, c->request, c->response) < 0)
         return;
 
@@ -459,7 +469,9 @@ static void cmd_init(struct http_channel *c)
     }
     wrbuf_puts(c->wrbuf, "</session>"
                "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol>");
-    
+
+    wrbuf_printf(c->wrbuf, "<keepAlive>%d</keepAlive>\n", 1000 * ((s->psession->service->session_timeout >= 20) ?
+                                                                  (s->psession->service->session_timeout - 10) : 50));
     response_close(c, "init");
 }
 
@@ -483,11 +495,12 @@ static void cmd_settings(struct http_channel *c)
     if (!s)
         return;
 
-    if (rq->content_len && content_type && 
+    if (rq->content_len && content_type &&
         !yaz_strcmp_del("text/xml", content_type, "; "))
     {
         xmlDoc *doc = xmlParseMemory(rq->content_buf, rq->content_len);
         xmlNode *root_n;
+        int ret;
         if (!doc)
         {
             error(rs, PAZPAR2_MALFORMED_SETTING, 0);
@@ -495,10 +508,14 @@ static void cmd_settings(struct http_channel *c)
             return;
         }
         root_n = xmlDocGetRootElement(doc);
-
-        settings_read_node_x(root_n, s->psession, apply_local_setting);
-
+        ret = settings_read_node_x(root_n, s->psession, apply_local_setting);
         xmlFreeDoc(doc);
+        if (ret)
+        {
+            error(rs, PAZPAR2_MALFORMED_SETTING, 0);
+            release_session(c,s);
+            return;
+        }
     }
     if (process_settings(s->psession, rq, rs) < 0)
     {
@@ -513,8 +530,9 @@ static void cmd_settings(struct http_channel *c)
 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;
 
@@ -530,7 +548,7 @@ static void termlist_response(struct http_channel *c, struct http_session *s, co
     }
     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");
 }
@@ -676,11 +694,7 @@ static void bytarget_response(struct http_channel *c, struct http_session *s, co
     struct hitsbytarget *ht;
     struct http_request *rq = c->request;
     const char *settings = http_argbyname(rq, "settings");
-    const char *protocol_version = http_argbyname(rq, "version");
-    int version = 0;
-    if (protocol_version && strcmp(protocol_version,"")) {
-        version = atoi(protocol_version);
-    }
+    int version = get_version(rq);
     ht = get_hitsbytarget(s->psession, &count, c->nmem);
     if (!cmd_status)
         /* Old protocol, always ok */
@@ -701,7 +715,7 @@ static void bytarget_response(struct http_channel *c, struct http_session *s, co
         wrbuf_xmlputs(c->wrbuf, ht[i].id);
         wrbuf_puts(c->wrbuf, "</id>\n");
 
-        if (ht[i].name && ht[i].name[0]) 
+        if (ht[i].name && ht[i].name[0])
         {
             wrbuf_puts(c->wrbuf, "<name>");
             wrbuf_xmlputs(c->wrbuf, ht[i].name);
@@ -712,6 +726,9 @@ static void bytarget_response(struct http_channel *c, struct http_session *s, co
         wrbuf_printf(c->wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
         if (ht[i].diagnostic)
         {
+            wrbuf_puts(c->wrbuf, "<message>");
+            wrbuf_xmlputs(c->wrbuf, ht[i].message);
+            wrbuf_puts(c->wrbuf, "</message>\n");
             wrbuf_puts(c->wrbuf, "<addinfo>");
             if (ht[i].addinfo)
                 wrbuf_xmlputs(c->wrbuf, ht[i].addinfo);
@@ -719,8 +736,10 @@ static void bytarget_response(struct http_channel *c, struct http_session *s, co
         }
 
         wrbuf_printf(c->wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
-        if (version >= 2)
+        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");
@@ -810,7 +829,7 @@ static void cmd_bytarget(struct http_channel *c)
 }
 
 static void write_metadata(WRBUF w, struct conf_service *service,
-        struct record_metadata **ml, int full)
+                           struct record_metadata **ml, int full, int indent)
 {
     int imeta;
 
@@ -823,7 +842,10 @@ static void write_metadata(WRBUF w, struct conf_service *service,
         for (md = ml[imeta]; md; md = md->next)
         {
             struct record_metadata_attr *attr = md->attributes;
-            wrbuf_printf(w, "\n<md-%s", cmd->name);
+            int i;
+            for (i = 0; i < indent; i++)
+                wrbuf_putc(w, ' ');
+            wrbuf_printf(w, "<md-%s", cmd->name);
 
             for (; attr; attr = attr->next)
             {
@@ -846,7 +868,7 @@ static void write_metadata(WRBUF w, struct conf_service *service,
                     wrbuf_puts(w, "[can't represent]");
                     break;
             }
-            wrbuf_printf(w, "</md-%s>", cmd->name);
+            wrbuf_printf(w, "</md-%s>\n", cmd->name);
         }
     }
 }
@@ -857,16 +879,20 @@ static void write_subrecord(struct record *r, WRBUF w,
     const char *name = session_setting_oneval(
         client_get_database(r->client), PZ_NAME);
 
-    wrbuf_puts(w, "<location id=\"");
+    wrbuf_puts(w, " <location id=\"");
     wrbuf_xmlputs(w, client_get_id(r->client));
-    wrbuf_puts(w, "\" ");
+    wrbuf_puts(w, "\"\n");
 
-    wrbuf_puts(w, "name=\"");
+    wrbuf_puts(w, "    name=\"");
     wrbuf_xmlputs(w,  *name ? name : "Unknown");
-    wrbuf_puts(w, "\">");
+    wrbuf_puts(w, "\" ");
+
+    wrbuf_puts(w, "checksum=\"");
+    wrbuf_printf(w,  "%u", r->checksum);
+    wrbuf_puts(w, "\">\n");
 
-    write_metadata(w, service, r->metadata, show_details);
-    wrbuf_puts(w, "</location>\n");
+    write_metadata(w, service, r->metadata, show_details, 2);
+    wrbuf_puts(w, " </location>\n");
 }
 
 static void show_raw_record_error(void *data, const char *addinfo)
@@ -923,12 +949,12 @@ static void show_record(struct http_channel *c, struct http_session *s)
     struct http_response *rs = c->response;
     struct http_request *rq = c->request;
     struct record_cluster *rec, *prev_r, *next_r;
-    struct record *r;
     struct conf_service *service;
     const char *idstr = http_argbyname(rq, "id");
     const char *offsetstr = http_argbyname(rq, "offset");
     const char *binarystr = http_argbyname(rq, "binary");
-    
+    const char *checksumstr = http_argbyname(rq, "checksum");
+
     if (!s)
         return;
     service = s->psession->service;
@@ -951,35 +977,45 @@ static void show_record(struct http_channel *c, struct http_session *s)
         }
         return;
     }
-    if (offsetstr)
+    if (offsetstr || checksumstr)
     {
-        int offset = atoi(offsetstr);
         const char *syntax = http_argbyname(rq, "syntax");
         const char *esn = http_argbyname(rq, "esn");
         int i;
         struct record*r = rec->records;
         int binary = 0;
         const char *nativesyntax = http_argbyname(rq, "nativesyntax");
-        
+
         if (binarystr && *binarystr != '0')
             binary = 1;
 
-        for (i = 0; i < offset && r; r = r->next, i++)
-            ;
-        if (!r)
+        if (checksumstr)
         {
-            error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
+            long v = atol(checksumstr);
+            for (i = 0; r; r = r->next)
+                if (v == r->checksum)
+                    break;
+            if (!r)
+                error(rs, PAZPAR2_RECORD_FAIL, "no record");
         }
         else
         {
+            int offset = atoi(offsetstr);
+            for (i = 0; i < offset && r; r = r->next, i++)
+                ;
+            if (!r)
+                error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given");
+        }
+        if (r)
+        {
             http_channel_observer_t obs =
                 http_add_observer(c, r->client, show_raw_reset);
             int ret = client_show_raw_begin(r->client, r->position,
                                             syntax, esn,
                                             obs /* data */,
                                             show_raw_record_error,
-                                            (binary ? 
-                                             show_raw_record_ok_binary : 
+                                            (binary ?
+                                             show_raw_record_ok_binary :
                                              show_raw_record_ok),
                                             (binary ? 1 : 0),
                                             nativesyntax);
@@ -992,27 +1028,28 @@ static void show_record(struct http_channel *c, struct http_session *s)
     }
     else
     {
+        struct record *r;
         response_open_no_status(c, "record");
-        wrbuf_puts(c->wrbuf, "\n<recid>");
+        wrbuf_puts(c->wrbuf, "\n <recid>");
         wrbuf_xmlputs(c->wrbuf, rec->recid);
         wrbuf_puts(c->wrbuf, "</recid>\n");
         if (prev_r)
         {
-            wrbuf_puts(c->wrbuf, "<prevrecid>");
+            wrbuf_puts(c->wrbuf, " <prevrecid>");
             wrbuf_xmlputs(c->wrbuf, prev_r->recid);
             wrbuf_puts(c->wrbuf, "</prevrecid>\n");
         }
         if (next_r)
         {
-            wrbuf_puts(c->wrbuf, "<nextrecid>");
+            wrbuf_puts(c->wrbuf, " <nextrecid>");
             wrbuf_xmlputs(c->wrbuf, next_r->recid);
             wrbuf_puts(c->wrbuf, "</nextrecid>\n");
         }
-        wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", 
+        wrbuf_printf(c->wrbuf, " <activeclients>%d</activeclients>\n",
                      session_active_clients(s->psession));
-        write_metadata(c->wrbuf, service, rec->metadata, 1);
+        write_metadata(c->wrbuf, service, rec->metadata, 1, 1);
         for (r = rec->records; r; r = r->next)
-            write_subrecord(r, c->wrbuf, service, 1);
+            write_subrecord(r, c->wrbuf, service, 2);
         response_close(c, "record");
     }
     show_single_stop(s->psession, rec);
@@ -1048,12 +1085,15 @@ 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;
-
+    struct conf_service *service = 0;
     if (!s)
         return;
 
@@ -1065,21 +1105,27 @@ static void show_records(struct http_channel *c, struct http_session *s, int act
         startn = atoi(start);
     if (num)
         numn = atoi(num);
-    if (!sort)
-        sort = "relevance";
-    if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
+
+    service = s->psession->service;
+    if (!sort) {
+        sort = service->default_sort;
+    }
+    if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
     {
         error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
         return;
 
     }
-    
-    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);
 
@@ -1091,15 +1137,23 @@ static void show_records(struct http_channel *c, struct http_session *s, int act
         struct conf_service *service = s->psession->service;
 
         wrbuf_puts(c->wrbuf, "<hit>\n");
-        write_metadata(c->wrbuf, service, rec->metadata, 0);
+        write_metadata(c->wrbuf, service, rec->metadata, 0, 1);
         for (ccount = 0, p = rl[i]->records; p;  p = p->next, ccount++)
             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, " <count>%d</count>\n", ccount);
        if (strstr(sort, "relevance"))
-           wrbuf_printf(c->wrbuf, "<relevance>%d</relevance>\n",
+        {
+           wrbuf_printf(c->wrbuf, " <relevance>%d</relevance>\n",
                          rec->relevance_score);
-        wrbuf_puts(c->wrbuf, "<recid>");
+            if (service->rank_debug)
+            {
+                wrbuf_printf(c->wrbuf, " <relevance_info>\n");
+                wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain1));
+                wrbuf_xmlputs(c->wrbuf, wrbuf_cstr(rec->relevance_explain2));
+                wrbuf_printf(c->wrbuf, " </relevance_info>\n");
+            }
+        }
+        wrbuf_puts(c->wrbuf, " <recid>");
         wrbuf_xmlputs(c->wrbuf, rec->recid);
         wrbuf_puts(c->wrbuf, "</recid>\n");
         wrbuf_puts(c->wrbuf, "</hit>\n");
@@ -1132,25 +1186,29 @@ static void cmd_show(struct http_channel *c)
     const char *block = http_argbyname(rq, "block");
     const char *sort = http_argbyname(rq, "sort");
     const char *block_error = http_argbyname(rq, "report");
+    struct conf_service *service = 0;
+
     struct reclist_sortparms *sp;
     int status;
     int report_error = 0;
     if (block_error && !strcmp("1", block_error)) {
         report_error = 1;
-    }    
+    }
     if (!s)
         return;
 
-    if (!sort)
-        sort = "relevance";
-    
-    if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
+    service = s->psession->service;
+    if (!sort) {
+        sort = service->default_sort;
+    }
+
+    if (!(sp = reclist_parse_sortparms(c->nmem, sort, service)))
     {
         error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
         release_session(c, s);
         return;
     }
-    session_sort(s->psession, sp->name, sp->increasing);
+    session_sort(s->psession, sp);
 
     status = session_active_clients(s->psession);
 
@@ -1169,7 +1227,7 @@ static void cmd_show(struct http_channel *c)
             }
             else
             {
-                yaz_log(YLOG_WARN, "Session %u: Attempt to block multiple times on show (preferred targets) block. Not supported!", 
+                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)");
@@ -1230,11 +1288,15 @@ static void cmd_search(struct http_channel *c)
     const char *maxrecs = http_argbyname(rq, "maxrecs");
     const char *startrecs = http_argbyname(rq, "startrecs");
     const char *limit = http_argbyname(rq, "limit");
+    const char *sort = http_argbyname(rq, "sort");
     enum pazpar2_error_code code;
     const char *addinfo = 0;
+    struct reclist_sortparms *sp;
+    struct conf_service *service = 0;
 
     if (!s)
         return;
+
     if (!query)
     {
         error(rs, PAZPAR2_MISSING_PARAMETER, "query");
@@ -1247,8 +1309,19 @@ static void cmd_search(struct http_channel *c)
         release_session(c, s);
         return;
     }
+    service = s->psession->service;
+    if (!sort) {
+        sort = service->default_sort;
+    }
+    if (!(sp = reclist_parse_sortparms(c->nmem, sort, s->psession->service)))
+    {
+        error(c->response, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
+        release_session(c, s);
+        return;
+    }
+
     code = session_search(s->psession, query, startrecs, maxrecs, filter, limit,
-                          &addinfo, "relevance", 0);
+                          &addinfo, sp);
     if (code)
     {
         error(rs, code, addinfo);
@@ -1318,7 +1391,7 @@ static void cmd_info(struct http_channel *c)
     wrbuf_puts(c->wrbuf, "</yaz>\n");
 
     wrbuf_puts(c->wrbuf, " </version>\n");
-    
+
     info_services(c->server, c->wrbuf);
 
     response_close(c, "info");