X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=src%2Fhttp_command.c;h=3128fec4f0d19a311c88ccf9dd77fb1d3e3fb7aa;hb=bc04e18bcab36d307a8e4c820c7d309e71cf6d69;hp=4d6c35504f47a87ab59c05ad7321835c24c7cf6e;hpb=235995289021a11b33312c91a55ccfbca605348b;p=pazpar2-moved-to-github.git

diff --git a/src/http_command.c b/src/http_command.c
index 4d6c355..3128fec 100644
--- a/src/http_command.c
+++ b/src/http_command.c
@@ -1,5 +1,26 @@
+/* $Id: http_command.c,v 1.52 2007-06-13 13:04:34 adam Exp $
+   Copyright (c) 2006-2007, Index Data.
+
+This file is part of Pazpar2.
+
+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
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+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.
+ */
+
 /*
- * $Id: http_command.c,v 1.29 2007-03-28 12:05:18 marc Exp $
+ * $Id: http_command.c,v 1.52 2007-06-13 13:04:34 adam Exp $
  */
 
 #include <stdio.h>
@@ -10,7 +31,7 @@
 #include <strings.h>
 #include <ctype.h>
 #include <sys/time.h>
-
+#include <yaz/snprintf.h>
 #if HAVE_CONFIG_H
 #include <cconfig.h>
 #endif
@@ -23,20 +44,22 @@
 #include "pazpar2.h"
 #include "http.h"
 #include "http_command.h"
+#include "settings.h"
+#include "client.h"
 
-extern struct parameters global_parameters;
-extern IOCHAN channel_list;
+// Update this when the protocol changes
+#define PAZPAR2_PROTOCOL_VERSION "1"
 
 struct http_session {
     IOCHAN timeout_iochan;     // NOTE: This is NOT associated with a socket
     struct session *psession;
     unsigned int session_id;
     int timestamp;
+    NMEM nmem;
     struct http_session *next;
 };
 
 static struct http_session *session_list = 0;
-
 void http_session_destroy(struct http_session *s);
 
 static void session_timeout(IOCHAN i, int event)
@@ -47,17 +70,20 @@ static void session_timeout(IOCHAN i, int event)
 
 struct http_session *http_session_create()
 {
-    struct http_session *r = xmalloc(sizeof(*r));
-    r->psession = new_session();
+    NMEM nmem = nmem_create();
+    struct http_session *r = nmem_malloc(nmem, sizeof(*r));
+
+    r->psession = new_session(nmem);
     r->session_id = 0;
     r->timestamp = 0;
+    r->nmem = nmem;
     r->next = session_list;
     session_list = r;
-    r->timeout_iochan = iochan_create(-1, 0, session_timeout, 0);
+    r->timeout_iochan = iochan_create(-1, session_timeout, 0);
     iochan_setdata(r->timeout_iochan, r);
     iochan_settimeout(r->timeout_iochan, global_parameters.session_timeout);
-    r->timeout_iochan->next = channel_list;
-    channel_list = r->timeout_iochan;
+
+    pazpar2_add_channel(r->timeout_iochan);
     return r;
 }
 
@@ -71,36 +97,84 @@ void http_session_destroy(struct http_session *s)
             *p = (*p)->next;
             break;
         }
+    yaz_log(YLOG_LOG, "Destroying session %u", s->session_id);
     iochan_destroy(s->timeout_iochan);
     destroy_session(s->psession);
-    xfree(s);
+    nmem_destroy(s->nmem);
+}
+
+static const char *get_msg(enum pazpar2_error_code code)
+{
+    struct pazpar2_error_msg {
+        enum pazpar2_error_code code;
+        const char *msg;
+    };
+    static const struct pazpar2_error_msg ar[] = {
+        { PAZPAR2_NO_SESSION, "Session does not exist or it has expired"},
+        { PAZPAR2_MISSING_PARAMETER, "Missing parameter"},
+        { PAZPAR2_MALFORMED_PARAMETER_VALUE, "Malformed parameter value"},
+        { PAZPAR2_MALFORMED_PARAMETER_ENCODING, "Malformed parameter encoding"},
+        { PAZPAR2_MALFORMED_SETTING, "Malformed setting argument"},
+        { PAZPAR2_HITCOUNTS_FAILED, "Failed to retrieve hitcounts"},
+        { PAZPAR2_RECORD_MISSING, "Record missing"},
+        { PAZPAR2_NO_TARGETS, "No targets"},
+        { PAZPAR2_CONFIG_TARGET, "Target cannot be configured"},
+        { 0, 0 }
+    };
+    int i = 0;
+    while (ar[i].msg)
+    {
+        if (code == ar[i].code)
+            return ar[i].msg;
+        i++;
+    }
+    return "No error";
 }
 
-static void error(struct http_response *rs, char *code, char *msg, char *txt)
+static void error(struct http_response *rs, 
+                  enum pazpar2_error_code code,
+                  const char *addinfo)
 {
     struct http_channel *c = rs->channel;
-    char tmp[1024];
+    char text[1024];
+    const char *http_status = "417";
+    const char *msg = get_msg(code);
 
-    if (!txt)
-        txt = msg;
     rs->msg = nmem_strdup(c->nmem, msg);
-    strcpy(rs->code, code);
-    sprintf(tmp, "<error code=\"general\">%s</error>", txt);
-    rs->payload = nmem_strdup(c->nmem, tmp);
+    strcpy(rs->code, http_status);
+
+    yaz_snprintf(text, sizeof(text),
+                 "<error code=\"%d\" msg=\"%s\">%s</error>", (int) code,
+                 msg, addinfo ? addinfo : "");
+
+    yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status,
+            msg, addinfo ? ": " : "" , addinfo ? addinfo : "");
+    rs->payload = nmem_strdup(c->nmem, text);
     http_send_response(c);
 }
 
 unsigned int make_sessionid()
 {
-    struct timeval t;
-    unsigned int res;
     static int seq = 0;
+    unsigned int res;
 
     seq++;
-    if (gettimeofday(&t, 0) < 0)
-        abort();
-    res = t.tv_sec;
-    res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
+    if (global_parameters.debug_mode)
+        res = seq;
+    else
+    {
+        struct timeval t;
+
+        if (gettimeofday(&t, 0) < 0)
+        {
+            yaz_log(YLOG_WARN|YLOG_ERRNO, "gettimeofday");
+            exit(1);
+        }
+        /* at most 256 sessions per second .. 
+           (long long would be more appropriate)*/
+        res = t.tv_sec;
+        res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
+    }
     return res;
 }
 
@@ -112,7 +186,7 @@ static struct http_session *locate_session(struct http_request *rq, struct http_
 
     if (!session)
     {
-        error(rs, "417", "Must supply session", 0);
+        error(rs, PAZPAR2_MISSING_PARAMETER, "session");
         return 0;
     }
     id = atoi(session);
@@ -122,7 +196,37 @@ static struct http_session *locate_session(struct http_request *rq, struct http_
             iochan_activity(p->timeout_iochan);
             return p;
         }
-    error(rs, "417", "Session does not exist, or it has expired", 0);
+    error(rs, PAZPAR2_NO_SESSION, session);
+    return 0;
+}
+
+// Decode settings parameters and apply to session
+// Syntax: setting[target]=value
+static int process_settings(struct session *se, struct http_request *rq,
+        struct http_response *rs)
+{
+    struct http_argument *a;
+
+    for (a = rq->arguments; a; a = a->next)
+        if (strchr(a->name, '['))
+        {
+            char **res;
+            int num;
+            char *dbname;
+            char *setting;
+
+            // Nmem_strsplit *rules*!!!
+            nmem_strsplit(se->session_nmem, "[]", a->name, &res, &num);
+            if (num != 2)
+            {
+                error(rs, PAZPAR2_MALFORMED_SETTING, a->name);
+                return -1;
+            }
+            setting = res[0];
+            dbname = res[1];
+            session_apply_setting(se, dbname, setting,
+                    nmem_strdup(se->session_nmem, a->value));
+        }
     return 0;
 }
 
@@ -132,7 +236,6 @@ static void cmd_exit(struct http_channel *c)
     exit(0);
 }
 
-
 static void cmd_init(struct http_channel *c)
 {
     unsigned int sesid;
@@ -143,11 +246,29 @@ static void cmd_init(struct http_channel *c)
     yaz_log(YLOG_DEBUG, "HTTP Session init");
     sesid = make_sessionid();
     s->session_id = sesid;
-    sprintf(buf, "<init><status>OK</status><session>%u</session></init>", sesid);
+    if (process_settings(s->psession, c->request, c->response) < 0)
+        return;
+    sprintf(buf, "<init><status>OK</status><session>%u</session>"
+            "<protocol>" PAZPAR2_PROTOCOL_VERSION "</protocol></init>", sesid);
     rs->payload = nmem_strdup(c->nmem, buf);
     http_send_response(c);
 }
 
+static void cmd_settings(struct http_channel *c)
+{
+    struct http_response *rs = c->response;
+    struct http_request *rq = c->request;
+    struct http_session *s = locate_session(rq, rs);
+
+    if (!s)
+        return;
+
+    if (process_settings(s->psession, rq, rs) < 0)
+        return;
+    rs->payload = "<settings><status>OK</status></settings>";
+    http_send_response(c);
+}
+
 // Compares two hitsbytarget nodes by hitcount
 static int cmp_ht(const void *p1, const void *p2)
 {
@@ -167,13 +288,31 @@ static void targets_termlist(WRBUF wrbuf, struct session *se, int num)
     qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
     for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
     {
-        wrbuf_puts(wrbuf, "\n<term>\n");
-        wrbuf_printf(wrbuf, "<id>%s</id>\n", ht[i].id);
-        wrbuf_printf(wrbuf, "<name>%s</name>\n", ht[i].name);
+
+        // do only print terms which have display names
+    
+        wrbuf_puts(wrbuf, "<term>\n");
+
+        wrbuf_puts(wrbuf, "<id>");
+        wrbuf_xmlputs(wrbuf, ht[i].id);
+        wrbuf_puts(wrbuf, "</id>\n");
+        
+        wrbuf_puts(wrbuf, "<name>");
+        if (!ht[i].name || !ht[i].name[0])
+            wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
+        else
+            wrbuf_xmlputs(wrbuf, ht[i].name);
+        wrbuf_puts(wrbuf, "</name>\n");
+        
         wrbuf_printf(wrbuf, "<frequency>%d</frequency>\n", ht[i].hits);
-        wrbuf_printf(wrbuf, "<state>%s</state>\n", ht[i].state);
-        wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n", ht[i].diagnostic);
-        wrbuf_puts(wrbuf, "\n</term>\n");
+        
+        wrbuf_puts(wrbuf, "<state>");
+        wrbuf_xmlputs(wrbuf, ht[i].state);
+        wrbuf_puts(wrbuf, "</state>\n");
+        
+        wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n", 
+                     ht[i].diagnostic);
+        wrbuf_puts(wrbuf, "</term>\n");
     }
 }
 
@@ -204,8 +343,8 @@ static void cmd_termlist(struct http_channel *c)
 
     wrbuf_rewind(c->wrbuf);
 
-    wrbuf_puts(c->wrbuf, "<termlist>");
-    wrbuf_printf(c->wrbuf, "\n<activeclients>%d</activeclients>", status);
+    wrbuf_puts(c->wrbuf, "<termlist>\n");
+    wrbuf_printf(c->wrbuf, "<activeclients>%d</activeclients>\n", status);
     while (*name)
     {
         char tname[256];
@@ -216,27 +355,37 @@ static void cmd_termlist(struct http_channel *c)
         strncpy(tname, name, tp - name);
         tname[tp - name] = '\0';
 
-        wrbuf_printf(c->wrbuf, "\n<list name=\"%s\">\n", tname);
+        wrbuf_puts(c->wrbuf, "<list name=\"");
+        wrbuf_xmlputs(c->wrbuf, tname);
+        wrbuf_puts(c->wrbuf, "\">\n");
         if (!strcmp(tname, "xtargets"))
             targets_termlist(c->wrbuf, s->psession, num);
         else
         {
             p = termlist(s->psession, tname, &len);
             if (p)
-                for (i = 0; i < len && i < num; i++)
-                {
-                    wrbuf_puts(c->wrbuf, "\n<term>");
-                    wrbuf_printf(c->wrbuf, "<name>%s</name>", p[i]->term);
-                    wrbuf_printf(c->wrbuf, "<frequency>%d</frequency>", p[i]->frequency);
-                    wrbuf_puts(c->wrbuf, "</term>");
-                }
+                for (i = 0; i < len && i < num; i++){
+                    // prevnt sending empty term elements
+                    if (!p[i]->term || !p[i]->term[0])
+                        continue;
+
+                    wrbuf_puts(c->wrbuf, "<term>");
+                    wrbuf_puts(c->wrbuf, "<name>");
+                    wrbuf_xmlputs(c->wrbuf, p[i]->term);
+                    wrbuf_puts(c->wrbuf, "</name>");
+                        
+                    wrbuf_printf(c->wrbuf, 
+                                 "<frequency>%d</frequency>", 
+                                 p[i]->frequency);
+                    wrbuf_puts(c->wrbuf, "</term>\n");
+               }
         }
-        wrbuf_puts(c->wrbuf, "\n</list>");
+        wrbuf_puts(c->wrbuf, "</list>\n");
         name = tp;
         if (*name == ',')
             name++;
     }
-    wrbuf_puts(c->wrbuf, "</termlist>");
+    wrbuf_puts(c->wrbuf, "</termlist>\n");
     rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
     http_send_response(c);
 }
@@ -254,7 +403,7 @@ static void cmd_bytarget(struct http_channel *c)
         return;
     if (!(ht = hitsbytarget(s->psession, &count)))
     {
-        error(rs, "500", "Failed to retrieve hitcounts", 0);
+        error(rs, PAZPAR2_HITCOUNTS_FAILED, 0);
         return;
     }
     wrbuf_rewind(c->wrbuf);
@@ -263,11 +412,19 @@ static void cmd_bytarget(struct http_channel *c)
     for (i = 0; i < count; i++)
     {
         wrbuf_puts(c->wrbuf, "\n<target>");
-        wrbuf_printf(c->wrbuf, "<id>%s</id>\n", ht[i].id);
+
+        wrbuf_puts(c->wrbuf, "<id>");
+        wrbuf_xmlputs(c->wrbuf, ht[i].id);
+        wrbuf_puts(c->wrbuf, "</id>\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);
-        wrbuf_printf(c->wrbuf, "<state>%s</state>\n", ht[i].state);
+
+        wrbuf_puts(c->wrbuf, "<state>");
+        wrbuf_xmlputs(c->wrbuf, ht[i].state);
+        wrbuf_puts(c->wrbuf, "</state>\n");
+
         wrbuf_puts(c->wrbuf, "</target>");
     }
 
@@ -289,11 +446,12 @@ static void write_metadata(WRBUF w, struct conf_service *service,
             continue;
         for (md = ml[imeta]; md; md = md->next)
         {
-            wrbuf_printf(w, "<md-%s>", cmd->name);
+            wrbuf_printf(w, "\n<md-%s>", cmd->name);
+
             switch (cmd->type)
             {
                 case Metadata_type_generic:
-                    wrbuf_puts(w, md->data.text);
+                    wrbuf_xmlputs(w, md->data.text);
                     break;
                 case Metadata_type_year:
                     wrbuf_printf(w, "%d", md->data.number.min);
@@ -308,12 +466,21 @@ static void write_metadata(WRBUF w, struct conf_service *service,
     }
 }
 
-static void write_subrecord(struct record *r, WRBUF w, struct conf_service *service)
+static void write_subrecord(struct record *r, WRBUF w,
+        struct conf_service *service, int show_details)
 {
-    wrbuf_printf(w, "<location id=\"%s\" name=\"%s\">\n",
-            r->client->database->url,
-            r->client->database->name ? r->client->database->name : "");
-    write_metadata(w, service, r->metadata, 1);
+    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);
+    wrbuf_puts(w, "\" ");
+
+    wrbuf_puts(w, "name=\"");
+    wrbuf_xmlputs(w,  *name ? name : "Unknown");
+    wrbuf_puts(w, "\">");
+
+    if (show_details)
+        write_metadata(w, service, r->metadata, 1);
     wrbuf_puts(w, "</location>\n");
 }
 
@@ -332,21 +499,21 @@ static void cmd_record(struct http_channel *c)
         return;
     if (!idstr)
     {
-        error(rs, "417", "Must supply id", 0);
+        error(rs, PAZPAR2_MISSING_PARAMETER, "id");
         return;
     }
     wrbuf_rewind(c->wrbuf);
     id = atoi(idstr);
     if (!(rec = show_single(s->psession, id)))
     {
-        error(rs, "500", "Record missing", 0);
+        error(rs, PAZPAR2_RECORD_MISSING, idstr);
         return;
     }
     wrbuf_puts(c->wrbuf, "<record>\n");
-    wrbuf_printf(c->wrbuf, "<recid>%d</recid>", rec->recid);
+    wrbuf_printf(c->wrbuf, "<recid>%d</recid>\n", rec->recid);
     write_metadata(c->wrbuf, service, rec->metadata, 1);
     for (r = rec->records; r; r = r->next)
-        write_subrecord(r, c->wrbuf, service);
+        write_subrecord(r, c->wrbuf, service, 1);
     wrbuf_puts(c->wrbuf, "</record>\n");
     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
     http_send_response(c);
@@ -383,7 +550,7 @@ static void show_records(struct http_channel *c, int active)
         sort = "relevance";
     if (!(sp = reclist_parse_sortparms(c->nmem, sort)))
     {
-        error(rs, "500", "Bad sort parameters", 0);
+        error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "sort");
         return;
     }
 
@@ -407,7 +574,7 @@ static void show_records(struct http_channel *c, int active)
         wrbuf_puts(c->wrbuf, "<hit>\n");
         write_metadata(c->wrbuf, service, rec->metadata, 0);
         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, "<recid>%d</recid>\n", rec->recid);
@@ -463,6 +630,31 @@ static void cmd_ping(struct http_channel *c)
     http_send_response(c);
 }
 
+static int utf_8_valid(const char *str)
+{
+    yaz_iconv_t cd = yaz_iconv_open("utf-8", "utf-8");
+    if (cd)
+    {
+        /* check that query is UTF-8 encoded */
+        char *inbuf = (char *) str; /* we know iconv does not alter this */
+        size_t inbytesleft = strlen(inbuf);
+
+        size_t outbytesleft = strlen(inbuf) + 10;
+        char *out = xmalloc(outbytesleft);
+        char *outbuf = out;
+        size_t r = yaz_iconv(cd, &inbuf, &inbytesleft, &outbuf, &outbytesleft);
+
+        /* if OK, try flushing the rest  */
+        if (r != (size_t) (-1))
+            r = yaz_iconv(cd, 0, 0, &outbuf, &outbytesleft);
+        yaz_iconv_close(cd);
+        xfree(out);
+        if (r == (size_t) (-1))
+            return 0;
+    }
+    return 1;
+}
+
 static void cmd_search(struct http_channel *c)
 {
     struct http_request *rq = c->request;
@@ -470,19 +662,25 @@ static void cmd_search(struct http_channel *c)
     struct http_session *s = locate_session(rq, rs);
     char *query = http_argbyname(rq, "query");
     char *filter = http_argbyname(rq, "filter");
-    char *res;
+    enum pazpar2_error_code code;
+    const char *addinfo = 0;
 
     if (!s)
         return;
     if (!query)
     {
-        error(rs, "417", "Must supply query", 0);
+        error(rs, PAZPAR2_MISSING_PARAMETER, "query");
+        return;
+    }
+    if (!utf_8_valid(query))
+    {
+        error(rs, PAZPAR2_MALFORMED_PARAMETER_ENCODING, "query");
         return;
     }
-    res = search(s->psession, query, filter);
-    if (res)
+    code = search(s->psession, query, filter, &addinfo);
+    if (code)
     {
-        error(rs, "417", res, res);
+        error(rs, code, addinfo);
         return;
     }
     rs->payload = "<search><status>OK</status></search>";
@@ -530,13 +728,20 @@ static void cmd_info(struct http_channel *c)
 
     wrbuf_rewind(c->wrbuf);
     wrbuf_puts(c->wrbuf, "<info>\n");
-    wrbuf_printf(c->wrbuf, " <version>\n");
-    wrbuf_printf(c->wrbuf, "  <pazpar2>%s</pazpar2>\n", VERSION);
+    wrbuf_puts(c->wrbuf, " <version>\n");
+    wrbuf_puts(c->wrbuf, "<pazpar2>");
+    wrbuf_xmlputs(c->wrbuf, VERSION);
+    wrbuf_puts(c->wrbuf, "</pazpar2>");
+
 
     yaz_version(yaz_version_str, 0);
-    wrbuf_printf(c->wrbuf, "  <yaz compiled=\"%s\">%s</yaz>\n",
-                 YAZ_VERSION, yaz_version_str);
-    wrbuf_printf(c->wrbuf, " </version>\n");
+    wrbuf_puts(c->wrbuf, "  <yaz compiled=\"");
+    wrbuf_xmlputs(c->wrbuf, YAZ_VERSION);
+    wrbuf_puts(c->wrbuf, "\">");
+    wrbuf_xmlputs(c->wrbuf, yaz_version_str);
+    wrbuf_puts(c->wrbuf, "</yaz>\n");
+
+    wrbuf_puts(c->wrbuf, " </version>\n");
     
     wrbuf_puts(c->wrbuf, "</info>");
     rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
@@ -548,6 +753,7 @@ struct {
     void (*fun)(struct http_channel *c);
 } commands[] = {
     { "init", cmd_init },
+    { "settings", cmd_settings },
     { "stat", cmd_stat },
     { "bytarget", cmd_bytarget },
     { "show", cmd_show },
@@ -573,7 +779,7 @@ void http_command(struct http_channel *c)
 
     if (!command)
     {
-        error(rs, "417", "Must supply command", 0);
+        error(rs, PAZPAR2_MISSING_PARAMETER, "command");
         return;
     }
     for (i = 0; commands[i].name; i++)
@@ -583,7 +789,7 @@ void http_command(struct http_channel *c)
             break;
         }
     if (!commands[i].name)
-        error(rs, "417", "Unknown command", 0);
+        error(rs, PAZPAR2_MALFORMED_PARAMETER_VALUE, "command");
 
     return;
 }