X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fhttp_command.c;h=24928d95c1705ca4c0069592c4418a8ed867dcf6;hb=f89a08d579f270d78b6e48a04ec63cef23539c88;hp=578f8ab47761ba05ea933a4462754f7939d4c4d0;hpb=3cfce35cc4b28d41a06ef6cf5efcfcf1e118500a;p=pazpar2-moved-to-github.git diff --git a/src/http_command.c b/src/http_command.c index 578f8ab..24928d9 100644 --- a/src/http_command.c +++ b/src/http_command.c @@ -1,7 +1,5 @@ -/* $Id: http_command.c,v 1.36 2007-04-16 20:34:17 quinn Exp $ - Copyright (c) 2006-2007, Index Data. - -This file is part of Pazpar2. +/* This file is part of Pazpar2. + Copyright (C) 2006-2008 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,13 +12,13 @@ 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.36 2007-04-16 20:34:17 quinn Exp $ + * $Id: http_command.c,v 1.66 2007-10-28 18:55:26 adam Exp $ */ #include @@ -31,23 +29,23 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA #include #include #include - +#include #if HAVE_CONFIG_H -#include +#include #endif #include -#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 @@ -59,7 +57,6 @@ struct http_session { }; static struct http_session *session_list = 0; - void http_session_destroy(struct http_session *s); static void session_timeout(IOCHAN i, int event) @@ -82,8 +79,8 @@ struct http_session *http_session_create() 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; } @@ -97,36 +94,90 @@ 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); nmem_destroy(s->nmem); } -static void error(struct http_response *rs, char *code, char *msg, char *txt) +static const char *get_msg(enum pazpar2_error_code code) { - struct http_channel *c = rs->channel; - char tmp[1024]; + 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"}, + { PAZPAR2_RECORD_FAIL, "Record command failed"}, + { PAZPAR2_NOT_IMPLEMENTED, "Not implemented"}, + { PAZPAR2_LAST_ERROR, "Last error"}, + { 0, 0 } + }; + int i = 0; + while (ar[i].msg) + { + if (code == ar[i].code) + return ar[i].msg; + i++; + } + return "No error"; +} - if (!txt) - txt = msg; +static void error(struct http_response *rs, + enum pazpar2_error_code code, + const char *addinfo) +{ + struct http_channel *c = rs->channel; + 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, code); - sprintf(tmp, "%s", txt); - rs->payload = nmem_strdup(c->nmem, tmp); + strcpy(rs->code, http_status); + + wrbuf_printf(text, "", (int) code, + msg); + if (addinfo) + wrbuf_xmlputs(text, addinfo); + wrbuf_puts(text, ""); + + yaz_log(YLOG_WARN, "HTTP %s %s%s%s", http_status, + msg, addinfo ? ": " : "" , addinfo ? addinfo : ""); + rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(text)); + wrbuf_destroy(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; } @@ -138,7 +189,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); @@ -148,7 +199,7 @@ 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; } @@ -171,8 +222,7 @@ static int process_settings(struct session *se, struct http_request *rq, 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); + error(rs, PAZPAR2_MALFORMED_SETTING, a->name); return -1; } setting = res[0]; @@ -193,15 +243,21 @@ static void cmd_init(struct http_channel *c) { unsigned int sesid; char buf[1024]; + const char *clear = http_argbyname(c->request, "clear"); struct http_session *s = http_session_create(); struct http_response *rs = c->response; yaz_log(YLOG_DEBUG, "HTTP Session init"); + if (!clear || *clear == '0') + session_init_databases(s->psession); + else + yaz_log(YLOG_LOG, "No databases preloaded"); sesid = make_sessionid(); s->session_id = sesid; if (process_settings(s->psession, c->request, c->response) < 0) return; - sprintf(buf, "OK%u", sesid); + sprintf(buf, "OK%u" + "" PAZPAR2_PROTOCOL_VERSION "", sesid); rs->payload = nmem_strdup(c->nmem, buf); http_send_response(c); } @@ -230,23 +286,41 @@ 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++) { - wrbuf_puts(wrbuf, "\n\n"); - wrbuf_printf(wrbuf, "%s\n", ht[i].id); - wrbuf_printf(wrbuf, "%s\n", ht[i].name); + + // do only print terms which have display names + + wrbuf_puts(wrbuf, "\n"); + + wrbuf_puts(wrbuf, ""); + wrbuf_xmlputs(wrbuf, ht[i].id); + wrbuf_puts(wrbuf, "\n"); + + wrbuf_puts(wrbuf, ""); + if (!ht[i].name || !ht[i].name[0]) + wrbuf_xmlputs(wrbuf, "NO TARGET NAME"); + else + wrbuf_xmlputs(wrbuf, ht[i].name); + wrbuf_puts(wrbuf, "\n"); + wrbuf_printf(wrbuf, "%d\n", ht[i].hits); - wrbuf_printf(wrbuf, "%s\n", ht[i].state); - wrbuf_printf(wrbuf, "%d\n", ht[i].diagnostic); - wrbuf_puts(wrbuf, "\n\n"); + + wrbuf_puts(wrbuf, ""); + wrbuf_xmlputs(wrbuf, ht[i].state); + wrbuf_puts(wrbuf, "\n"); + + wrbuf_printf(wrbuf, "%d\n", + ht[i].diagnostic); + wrbuf_puts(wrbuf, "\n"); } } @@ -277,8 +351,8 @@ static void cmd_termlist(struct http_channel *c) wrbuf_rewind(c->wrbuf); - wrbuf_puts(c->wrbuf, ""); - wrbuf_printf(c->wrbuf, "\n%d", status); + wrbuf_puts(c->wrbuf, "\n"); + wrbuf_printf(c->wrbuf, "%d\n", status); while (*name) { char tname[256]; @@ -289,27 +363,37 @@ static void cmd_termlist(struct http_channel *c) strncpy(tname, name, tp - name); tname[tp - name] = '\0'; - wrbuf_printf(c->wrbuf, "\n\n", tname); + wrbuf_puts(c->wrbuf, "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); if (p) - for (i = 0; i < len && i < num; i++) - { - wrbuf_puts(c->wrbuf, "\n"); - wrbuf_printf(c->wrbuf, "%s", p[i]->term); - wrbuf_printf(c->wrbuf, "%d", p[i]->frequency); - wrbuf_puts(c->wrbuf, ""); - } + 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, ""); + wrbuf_puts(c->wrbuf, ""); + wrbuf_xmlputs(c->wrbuf, p[i]->term); + wrbuf_puts(c->wrbuf, ""); + + wrbuf_printf(c->wrbuf, + "%d", + p[i]->frequency); + wrbuf_puts(c->wrbuf, "\n"); + } } - wrbuf_puts(c->wrbuf, "\n"); + wrbuf_puts(c->wrbuf, "\n"); name = tp; if (*name == ',') name++; } - wrbuf_puts(c->wrbuf, ""); + wrbuf_puts(c->wrbuf, "\n"); rs->payload = nmem_strdup(rq->channel->nmem, wrbuf_cstr(c->wrbuf)); http_send_response(c); } @@ -325,22 +409,26 @@ static void cmd_bytarget(struct http_channel *c) if (!s) return; - if (!(ht = hitsbytarget(s->psession, &count))) - { - error(rs, "500", "Failed to retrieve hitcounts", 0); - return; - } + ht = hitsbytarget(s->psession, &count, c->nmem); wrbuf_rewind(c->wrbuf); wrbuf_puts(c->wrbuf, "OK"); for (i = 0; i < count; i++) { wrbuf_puts(c->wrbuf, "\n"); - wrbuf_printf(c->wrbuf, "%s\n", ht[i].id); + + wrbuf_puts(c->wrbuf, ""); + wrbuf_xmlputs(c->wrbuf, ht[i].id); + wrbuf_puts(c->wrbuf, "\n"); + wrbuf_printf(c->wrbuf, "%d\n", ht[i].hits); wrbuf_printf(c->wrbuf, "%d\n", ht[i].diagnostic); wrbuf_printf(c->wrbuf, "%d\n", ht[i].records); - wrbuf_printf(c->wrbuf, "%s\n", ht[i].state); + + wrbuf_puts(c->wrbuf, ""); + wrbuf_xmlputs(c->wrbuf, ht[i].state); + wrbuf_puts(c->wrbuf, "\n"); + wrbuf_puts(c->wrbuf, ""); } @@ -363,10 +451,11 @@ static void write_metadata(WRBUF w, struct conf_service *service, for (md = ml[imeta]; md; md = md->next) { wrbuf_printf(w, "\n", cmd->name); + switch (cmd->type) { case Metadata_type_generic: - wrbuf_puts(w, md->data.text); + wrbuf_xmlputs(w, md->data.text.disp); break; case Metadata_type_year: wrbuf_printf(w, "%d", md->data.number.min); @@ -384,16 +473,71 @@ 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(r->client->database, PZ_NAME); + const char *name = session_setting_oneval( + client_get_database(r->client), PZ_NAME); + + wrbuf_puts(w, "client)->database->url); + wrbuf_puts(w, "\" "); + + wrbuf_puts(w, "name=\""); + wrbuf_xmlputs(w, *name ? name : "Unknown"); + wrbuf_puts(w, "\">"); - wrbuf_printf(w, "", - r->client->database->database->url, - *name ? name : "Unknown"); if (show_details) write_metadata(w, service, r->metadata, 1); wrbuf_puts(w, "\n"); } +static void show_raw_record_error(void *data, const char *addinfo) +{ + 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); + + error(rs, PAZPAR2_RECORD_FAIL, addinfo); +} + +static void show_raw_record_ok(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)); + http_send_response(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_remove(client, data2); +} + +static void cmd_record_ready(void *data); + static void cmd_record(struct http_channel *c) { struct http_response *rs = c->response; @@ -402,31 +546,86 @@ static void cmd_record(struct http_channel *c) struct record_cluster *rec; struct record *r; struct conf_service *service = global_parameters.server->service; - char *idstr = http_argbyname(rq, "id"); - int id; - + const char *idstr = http_argbyname(rq, "id"); + const char *offsetstr = http_argbyname(rq, "offset"); + const char *binarystr = http_argbyname(rq, "binary"); + if (!s) 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))) + if (!(rec = show_single(s->psession, idstr))) { - error(rs, "500", "Record missing", 0); + if (session_set_watch(s->psession, SESSION_WATCH_RECORD, + cmd_record_ready, c, c) != 0) + { + error(rs, PAZPAR2_RECORD_MISSING, idstr); + } return; } - wrbuf_puts(c->wrbuf, "\n"); - wrbuf_printf(c->wrbuf, "%d", 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, "\n"); - rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf)); - http_send_response(c); + if (offsetstr) + { + 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; + + if (binarystr && *binarystr != '0') + binary = 1; + + for (i = 0; i < offset && r; r = r->next, i++) + ; + if (!r) + { + error(rs, PAZPAR2_RECORD_FAIL, "no record at offset given"); + return; + } + else + { + void *data2; + 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 : + show_raw_record_ok), + &data2, + (binary ? 1 : 0)); + if (ret == -1) + { + http_remove_observer(obs); + error(rs, PAZPAR2_NO_SESSION, 0); + return; + } + } + } + else + { + wrbuf_puts(c->wrbuf, "\n"); + wrbuf_printf(c->wrbuf, "%s\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, 1); + wrbuf_puts(c->wrbuf, "\n"); + rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf)); + http_send_response(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) @@ -460,7 +659,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; } @@ -487,7 +686,7 @@ 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, "%d\n", ccount); - wrbuf_printf(c->wrbuf, "%d\n", rec->recid); + wrbuf_printf(c->wrbuf, "%s\n", rec->recid); wrbuf_puts(c->wrbuf, "\n"); } @@ -520,8 +719,12 @@ static void cmd_show(struct http_channel *c) { if (status && (!s->psession->reclist || !s->psession->reclist->num_records)) { - session_set_watch(s->psession, SESSION_WATCH_RECORDS, show_records_ready, c); - yaz_log(YLOG_DEBUG, "Blocking on cmd_show"); + // 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) + { + yaz_log(YLOG_DEBUG, "Blocking on cmd_show"); + } return; } } @@ -540,6 +743,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; @@ -547,19 +775,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 = "OK"; @@ -607,13 +841,20 @@ static void cmd_info(struct http_channel *c) wrbuf_rewind(c->wrbuf); wrbuf_puts(c->wrbuf, "\n"); - wrbuf_printf(c->wrbuf, " \n"); - wrbuf_printf(c->wrbuf, " %s\n", VERSION); + wrbuf_puts(c->wrbuf, " \n"); + wrbuf_puts(c->wrbuf, ""); + wrbuf_xmlputs(c->wrbuf, VERSION); + wrbuf_puts(c->wrbuf, ""); + yaz_version(yaz_version_str, 0); - wrbuf_printf(c->wrbuf, " %s\n", - YAZ_VERSION, yaz_version_str); - wrbuf_printf(c->wrbuf, " \n"); + wrbuf_puts(c->wrbuf, " wrbuf, YAZ_VERSION); + wrbuf_puts(c->wrbuf, "\">"); + wrbuf_xmlputs(c->wrbuf, yaz_version_str); + wrbuf_puts(c->wrbuf, "\n"); + + wrbuf_puts(c->wrbuf, " \n"); wrbuf_puts(c->wrbuf, ""); rs->payload = nmem_strdup(c->nmem, wrbuf_cstr(c->wrbuf)); @@ -651,7 +892,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++) @@ -661,7 +902,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; }