Regression test, test_http.sh, moved to sub directory test. The test
[pazpar2-moved-to-github.git] / src / http_command.c
index 8f4b9b8..879159d 100644 (file)
@@ -1,5 +1,26 @@
+/* $Id: http_command.c,v 1.42 2007-05-15 15:50:48 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.13 2007-01-09 18:06:28 quinn Exp $
+ * $Id: http_command.c,v 1.42 2007-05-15 15:50:48 adam Exp $
  */
 
 #include <stdio.h>
 
 #include <yaz/yaz-util.h>
 
+#include "config.h"
 #include "util.h"
 #include "eventl.h"
 #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;
 };
 
@@ -46,17 +71,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, 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;
 }
 
@@ -72,7 +100,7 @@ void http_session_destroy(struct http_session *s)
         }
     iochan_destroy(s->timeout_iochan);
     destroy_session(s->psession);
-    xfree(s);
+    nmem_destroy(s->nmem);
 }
 
 static void error(struct http_response *rs, char *code, char *msg, char *txt)
@@ -91,16 +119,20 @@ static void error(struct http_response *rs, char *code, char *msg, char *txt)
 
 unsigned int make_sessionid()
 {
+    static int seq = 0;
+#if 1
+    return ++seq;
+#else
     struct timeval t;
     unsigned int res;
-    static int seq = 0;
 
     seq++;
     if (gettimeofday(&t, 0) < 0)
         abort();
     res = t.tv_sec;
-    res = ((res << 8) | (seq & 0xff)) & ((unsigned int) (1 << 31) - 1);
+    res = ((res << 8) | (seq & 0xff)) & ((1U << 31) - 1);
     return res;
+#endif
 }
 
 static struct http_session *locate_session(struct http_request *rq, struct http_response *rs)
@@ -125,13 +157,43 @@ static struct http_session *locate_session(struct http_request *rq, struct http_
     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, "417", "Malformed setting argument", 0);
+                yaz_log(YLOG_WARN, "Malformed setting: %s", 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;
+}
+
 static void cmd_exit(struct http_channel *c)
 {
     yaz_log(YLOG_WARN, "exit");
     exit(0);
 }
 
-
 static void cmd_init(struct http_channel *c)
 {
     unsigned int sesid;
@@ -142,11 +204,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)
 {
@@ -156,7 +236,7 @@ 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)
+static void targets_termlist(WRBUF wrbuf, struct session *se, int num)
 {
     struct hitsbytarget *ht;
     int count, i;
@@ -164,10 +244,11 @@ static void targets_termlist(WRBUF wrbuf, struct session *se)
     if (!(ht = hitsbytarget(se, &count)))
         return;
     qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
-    for (i = 0; i < count && i < 15; i++)
+    for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
     {
         wrbuf_puts(wrbuf, "\n<term>\n");
-        wrbuf_printf(wrbuf, "<name>%s</name>\n", ht[i].id);
+        wrbuf_printf(wrbuf, "<id>%s</id>\n", ht[i].id);
+        wrbuf_printf(wrbuf, "<name>%s</name>\n", ht[i].name);
         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);
@@ -184,6 +265,8 @@ static void cmd_termlist(struct http_channel *c)
     int len;
     int i;
     char *name = http_argbyname(rq, "name");
+    char *nums = http_argbyname(rq, "num");
+    int num = 15;
     int status;
 
     if (!s)
@@ -195,6 +278,8 @@ static void cmd_termlist(struct http_channel *c)
         name = "subject";
     if (strlen(name) > 255)
         return;
+    if (nums)
+        num = atoi(nums);
 
     wrbuf_rewind(c->wrbuf);
 
@@ -212,12 +297,12 @@ static void cmd_termlist(struct http_channel *c)
 
         wrbuf_printf(c->wrbuf, "\n<list name=\"%s\">\n", tname);
         if (!strcmp(tname, "xtargets"))
-            targets_termlist(c->wrbuf, s->psession);
+            targets_termlist(c->wrbuf, s->psession, num);
         else
         {
             p = termlist(s->psession, tname, &len);
             if (p)
-                for (i = 0; i < len; i++)
+                for (i = 0; i < len && i < num; i++)
                 {
                     wrbuf_puts(c->wrbuf, "\n<term>");
                     wrbuf_printf(c->wrbuf, "<name>%s</name>", p[i]->term);
@@ -231,7 +316,7 @@ static void cmd_termlist(struct http_channel *c)
             name++;
     }
     wrbuf_puts(c->wrbuf, "</termlist>");
-    rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_buf(c->wrbuf));
+    rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf));
     http_send_response(c);
 }
 
@@ -266,7 +351,87 @@ static void cmd_bytarget(struct http_channel *c)
     }
 
     wrbuf_puts(c->wrbuf, "</bytarget>");
-    rs->payload = nmem_strdup(c->nmem, wrbuf_buf(c->wrbuf));
+    rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
+    http_send_response(c);
+}
+
+static void write_metadata(WRBUF w, struct conf_service *service,
+        struct record_metadata **ml, int full)
+{
+    int imeta;
+
+    for (imeta = 0; imeta < service->num_metadata; imeta++)
+    {
+        struct conf_metadata *cmd = &service->metadata[imeta];
+        struct record_metadata *md;
+        if (!cmd->brief && !full)
+            continue;
+        for (md = ml[imeta]; md; md = md->next)
+        {
+            wrbuf_printf(w, "\n<md-%s>", cmd->name);
+            switch (cmd->type)
+            {
+                case Metadata_type_generic:
+                    wrbuf_puts(w, md->data.text);
+                    break;
+                case Metadata_type_year:
+                    wrbuf_printf(w, "%d", md->data.number.min);
+                    if (md->data.number.min != md->data.number.max)
+                        wrbuf_printf(w, "-%d", md->data.number.max);
+                    break;
+                default:
+                    wrbuf_puts(w, "[can't represent]");
+            }
+            wrbuf_printf(w, "</md-%s>", cmd->name);
+        }
+    }
+}
+
+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);
+
+    wrbuf_printf(w, "<location id=\"%s\" name=\"%s\">",
+            client_get_database(r->client)->database->url,
+            *name ? name : "Unknown");
+    if (show_details)
+        write_metadata(w, service, r->metadata, 1);
+    wrbuf_puts(w, "</location>\n");
+}
+
+static void cmd_record(struct http_channel *c)
+{
+    struct http_response *rs = c->response;
+    struct http_request *rq = c->request;
+    struct http_session *s = locate_session(rq, rs);
+    struct record_cluster *rec;
+    struct record *r;
+    struct conf_service *service = global_parameters.server->service;
+    char *idstr = http_argbyname(rq, "id");
+    int id;
+
+    if (!s)
+        return;
+    if (!idstr)
+    {
+        error(rs, "417", "Must supply id", 0);
+        return;
+    }
+    wrbuf_rewind(c->wrbuf);
+    id = atoi(idstr);
+    if (!(rec = show_single(s->psession, id)))
+    {
+        error(rs, "500", "Record missing", 0);
+        return;
+    }
+    wrbuf_puts(c->wrbuf, "<record>\n");
+    wrbuf_printf(c->wrbuf, "<recid>%d</recid>", rec->recid);
+    write_metadata(c->wrbuf, service, rec->metadata, 1);
+    for (r = rec->records; r; r = r->next)
+        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);
 }
 
@@ -276,9 +441,10 @@ static void show_records(struct http_channel *c, int active)
     struct http_response *rs = c->response;
     struct http_session *s = locate_session(rq, rs);
     struct record_cluster **rl;
-    NMEM nmem_show;
+    struct reclist_sortparms *sp;
     char *start = http_argbyname(rq, "start");
     char *num = http_argbyname(rq, "num");
+    char *sort = http_argbyname(rq, "sort");
     int startn = 0;
     int numn = 20;
     int total;
@@ -296,9 +462,15 @@ static void show_records(struct http_channel *c, int active)
         startn = atoi(start);
     if (num)
         numn = atoi(num);
+    if (!sort)
+        sort = "relevance";
+    if (!(sp = reclist_parse_sortparms(c->nmem, sort)))
+    {
+        error(rs, "500", "Bad sort parameters", 0);
+        return;
+    }
 
-    nmem_show = nmem_create();
-    rl = show(s->psession, startn, &numn, &total, &total_hits, nmem_show);
+    rl = show(s->psession, sp, startn, &numn, &total, &total_hits, c->nmem);
 
     wrbuf_rewind(c->wrbuf);
     wrbuf_puts(c->wrbuf, "<show>\n<status>OK</status>\n");
@@ -314,47 +486,20 @@ static void show_records(struct http_channel *c, int active)
         struct record *p;
         struct record_cluster *rec = rl[i];
         struct conf_service *service = global_parameters.server->service;
-        int imeta;
 
         wrbuf_puts(c->wrbuf, "<hit>\n");
-        for (imeta = 0; imeta < service->num_metadata; imeta++)
-        {
-            struct conf_metadata *cmd = &service->metadata[imeta];
-            struct record_metadata *md;
-            if (!rec->metadata[imeta])
-                continue;
-            if (!cmd->brief)
-                continue;
-            for (md = rec->metadata[imeta]; md; md = md->next)
-            {
-                wrbuf_printf(c->wrbuf, "<md-%s>", cmd->name);
-                switch (cmd->type)
-                {
-                    case Metadata_type_generic:
-                        wrbuf_puts(c->wrbuf, md->data.text);
-                        break;
-                    case Metadata_type_year:
-                        wrbuf_printf(c->wrbuf, "%d", md->data.year.year1);
-                        if (md->data.year.year1 != md->data.year.year2)
-                            wrbuf_printf(c->wrbuf, "-%d", md->data.year.year2);
-                        break;
-                    default:
-                        wrbuf_puts(c->wrbuf, "[Can't represent]");
-                }
-                wrbuf_printf(c->wrbuf, "</md-%s>", cmd->name);
-            }
-        }
+        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);
         wrbuf_puts(c->wrbuf, "</hit>\n");
     }
 
     wrbuf_puts(c->wrbuf, "</show>\n");
-    rs->payload = nmem_strdup(c->nmem, wrbuf_buf(c->wrbuf));
+    rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
     http_send_response(c);
-    nmem_destroy(nmem_show);
 }
 
 static void show_records_ready(void *data)
@@ -407,6 +552,7 @@ static void cmd_search(struct http_channel *c)
     struct http_response *rs = c->response;
     struct http_session *s = locate_session(rq, rs);
     char *query = http_argbyname(rq, "query");
+    char *filter = http_argbyname(rq, "filter");
     char *res;
 
     if (!s)
@@ -416,7 +562,7 @@ static void cmd_search(struct http_channel *c)
         error(rs, "417", "Must supply query", 0);
         return;
     }
-    res = search(s->psession, query);
+    res = search(s->psession, query, filter);
     if (res)
     {
         error(rs, "417", res, res);
@@ -456,16 +602,36 @@ static void cmd_stat(struct http_channel *c)
     wrbuf_printf(c->wrbuf, "<failed>%d</failed>\n", stat.num_failed);
     wrbuf_printf(c->wrbuf, "<error>%d</error>\n", stat.num_error);
     wrbuf_puts(c->wrbuf, "</stat>");
-    rs->payload = nmem_strdup(c->nmem, wrbuf_buf(c->wrbuf));
+    rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
     http_send_response(c);
 }
 
+static void cmd_info(struct http_channel *c)
+{
+    char yaz_version_str[20];
+    struct http_response *rs = c->response;
+
+    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);
+
+    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, "</info>");
+    rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf));
+    http_send_response(c);
+}
 
 struct {
     char *name;
     void (*fun)(struct http_channel *c);
 } commands[] = {
     { "init", cmd_init },
+    { "settings", cmd_settings },
     { "stat", cmd_stat },
     { "bytarget", cmd_bytarget },
     { "show", cmd_show },
@@ -473,6 +639,8 @@ struct {
     { "termlist", cmd_termlist },
     { "exit", cmd_exit },
     { "ping", cmd_ping },
+    { "record", cmd_record },
+    { "info", cmd_info },
     {0,0}
 };
 
@@ -483,6 +651,10 @@ void http_command(struct http_channel *c)
     int i;
 
     c->response = rs;
+
+    http_addheader(rs, "Expires", "Thu, 19 Nov 1981 08:52:00 GMT");
+    http_addheader(rs, "Cache-Control", "no-store, no-cache, must-revalidate, post-check=0, pre-check=0");
+
     if (!command)
     {
         error(rs, "417", "Must supply command", 0);