X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=src%2Fsrwutil.c;h=25a85e12506f240ea1b2285ed45e23960ebb4511;hp=e1e7d3161447b719fb716495d3cf26c9699e4cdf;hb=a679666e56f9f6ea19e4c22e36089ccb3716dd0f;hpb=5009ac245dc8618eb45f4214b59c472c90869136 diff --git a/src/srwutil.c b/src/srwutil.c index e1e7d31..25a85e1 100644 --- a/src/srwutil.c +++ b/src/srwutil.c @@ -1,8 +1,6 @@ -/* - * Copyright (C) 1995-2005, Index Data ApS +/* This file is part of the YAZ toolkit. + * Copyright (C) 1995-2008 Index Data * See the file LICENSE for details. - * - * $Id: srwutil.c,v 1.30 2005-09-12 09:14:57 adam Exp $ */ /** * \file srwutil.c @@ -11,6 +9,7 @@ #include #include +#include #include static int hex_digit (int ch) @@ -24,7 +23,54 @@ static int hex_digit (int ch) return 0; } -int yaz_uri_array(const char *path, ODR o, char ***name, char ***val) +void encode_uri_char(char *dst, char ch) +{ + if (ch == ' ') + strcpy(dst, "+"); + /* mark = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")" */ + else if ((ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z') || + (ch >= '0' && ch <= '9') || strchr("-_.!~*'(|)", ch)) + { + dst[0] = ch; + dst[1] = '\0'; + } + else + { + dst[0] = '%'; + sprintf(dst+1, "%02X", (unsigned char ) ch); + } +} + +static void yaz_array_to_uri(char **path, ODR o, char **name, char **value) +{ + size_t i, szp = 0, sz = 1; + for(i = 0; name[i]; i++) + sz += strlen(name[i]) + 3 + strlen(value[i]) * 3; + *path = (char *) odr_malloc(o, sz); + + for(i = 0; name[i]; i++) + { + size_t j, ilen; + if (i) + (*path)[szp++] = '&'; + ilen = strlen(name[i]); + memcpy(*path+szp, name[i], ilen); + szp += ilen; + (*path)[szp++] = '='; + for (j = 0; value[i][j]; j++) + { + size_t vlen; + char vstr[5]; + encode_uri_char(vstr, value[i][j]); + vlen = strlen(vstr); + memcpy(*path+szp, vstr, vlen); + szp += vlen; + } + } + (*path)[szp] = '\0'; +} + +int yaz_uri_to_array(const char *path, ODR o, char ***name, char ***val) { int no = 2; const char *cp; @@ -32,15 +78,15 @@ int yaz_uri_array(const char *path, ODR o, char ***name, char ***val) if (*path == '?') path++; if (!*path) - return no; + return 0; cp = path; while ((cp = strchr(cp, '&'))) { cp++; no++; } - *name = odr_malloc(o, no * sizeof(char*)); - *val = odr_malloc(o, no * sizeof(char*)); + *name = (char **) odr_malloc(o, no * sizeof(char*)); + *val = (char **) odr_malloc(o, no * sizeof(char*)); for (no = 0; *path; no++) { @@ -50,7 +96,7 @@ int yaz_uri_array(const char *path, ODR o, char ***name, char ***val) if (!p1) break; - (*name)[no] = odr_malloc(o, (p1-path)+1); + (*name)[no] = (char *) odr_malloc(o, (p1-path)+1); memcpy((*name)[no], path, p1-path); (*name)[no][p1-path] = '\0'; @@ -58,7 +104,7 @@ int yaz_uri_array(const char *path, ODR o, char ***name, char ***val) p1 = strchr(path, '&'); if (!p1) p1 = strlen(path) + path; - (*val)[no] = ret = odr_malloc(o, p1 - path + 1); + (*val)[no] = ret = (char *) odr_malloc(o, p1 - path + 1); while (*path && *path != '&') { if (*path == '+') @@ -130,6 +176,109 @@ char *yaz_uri_val(const char *path, const char *name, ODR o) return 0; } +#if YAZ_HAVE_XML2 +static int yaz_base64decode(const char *in, char *out) +{ + const char *map = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" + "abcdefghijklmnopqrstuvwxyz0123456789+/"; + int olen = 0; + int len = strlen(in); + + while (len >= 4) + { + char i0, i1, i2, i3; + char *p; + + if (!(p = strchr(map, in[0]))) + return 0; + i0 = p - map; + len--; + if (!(p = strchr(map, in[1]))) + return 0; + i1 = p - map; + len--; + *(out++) = i0 << 2 | i1 >> 4; + olen++; + if (in[2] == '=') + break; + if (!(p = strchr(map, in[2]))) + return 0; + i2 = p - map; + len--; + *(out++) = i1 << 4 | i2 >> 2; + olen++; + if (in[3] == '=') + break; + if (!(p = strchr(map, in[3]))) + return 0; + i3 = p - map; + len--; + *(out++) = i2 << 6 | i3; + olen++; + + in += 4; + } + + *out = '\0'; + return olen; +} +#endif + +int yaz_srw_check_content_type(Z_HTTP_Response *hres) +{ + const char *content_type = z_HTTP_header_lookup(hres->headers, + "Content-Type"); + if (content_type) + { + if (!yaz_strcmp_del("text/xml", content_type, "; ")) + return 1; + if (!yaz_strcmp_del("application/xml", content_type, "; ")) + return 1; + } + return 0; +} + +/** + * Look for authentication tokens in HTTP Basic parameters or in x-username/x-password + * parameters. Added by SH. + */ +#if YAZ_HAVE_XML2 +static void yaz_srw_decodeauth(Z_SRW_PDU *sr, Z_HTTP_Request *hreq, + char *username, char *password, ODR decode) +{ + const char *basic = z_HTTP_header_lookup(hreq->headers, "Authorization"); + + if (username) + sr->username = username; + if (password) + sr->password = password; + + if (basic) { + int len, olen; + char out[256]; + char ubuf[256] = "", pbuf[256] = "", *p; + if (strncmp(basic, "Basic ", 6)) + return; + basic += 6; + len = strlen(basic); + if (!len || len > 256) + return; + olen = yaz_base64decode(basic, out); + /* Format of out should be username:password at this point */ + strcpy(ubuf, out); + if ((p = strchr(ubuf, ':'))) { + *(p++) = '\0'; + if (*p) + strcpy(pbuf, p); + } + if (*ubuf) + sr->username = odr_strdup(decode, ubuf); + if (*pbuf) + sr->password = odr_strdup(decode, pbuf); + } +} +#endif + void yaz_uri_val_int(const char *path, const char *name, ODR o, int **intp) { const char *v = yaz_uri_val(path, name, o); @@ -137,20 +286,33 @@ void yaz_uri_val_int(const char *path, const char *name, ODR o, int **intp) *intp = odr_intdup(o, atoi(v)); } -void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d, - int code, const char *details) +void yaz_mk_srw_diagnostic(ODR o, Z_SRW_diagnostic *d, + const char *uri, const char *message, + const char *details) { - d->uri = (char *) odr_malloc(o, 50); - sprintf(d->uri, "info:srw/diagnostic/1/%d", code); - d->message = 0; + d->uri = odr_strdup(o, uri); + if (message) + d->message = odr_strdup(o, message); + else + d->message = 0; if (details) d->details = odr_strdup(o, details); else d->details = 0; } -void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d, - int *num, int code, const char *addinfo) +void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d, + int code, const char *details) +{ + char uri[40]; + + sprintf(uri, "info:srw/diagnostic/1/%d", code); + yaz_mk_srw_diagnostic(o, d, uri, 0, details); +} + +void yaz_add_srw_diagnostic_uri(ODR o, Z_SRW_diagnostic **d, + int *num, const char *uri, + const char *message, const char *details) { Z_SRW_diagnostic *d_new; d_new = (Z_SRW_diagnostic *) odr_malloc (o, (*num + 1)* sizeof(**d)); @@ -158,10 +320,77 @@ void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d, memcpy (d_new, *d, *num *sizeof(**d)); *d = d_new; - yaz_mk_std_diagnostic(o, *d + *num, code, addinfo); + yaz_mk_srw_diagnostic(o, *d + *num, uri, message, details); (*num)++; } +void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d, + int *num, int code, const char *addinfo) +{ + char uri[40]; + + sprintf(uri, "info:srw/diagnostic/1/%d", code); + yaz_add_srw_diagnostic_uri(o, d, num, uri, 0, addinfo); +} + + +void yaz_add_sru_update_diagnostic(ODR o, Z_SRW_diagnostic **d, + int *num, int code, const char *addinfo) +{ + char uri[40]; + + sprintf(uri, "info:srw/diagnostic/12/%d", code); + yaz_add_srw_diagnostic_uri(o, d, num, uri, 0, addinfo); +} + + +void yaz_mk_sru_surrogate(ODR o, Z_SRW_record *record, int pos, + int code, const char *details) +{ + const char *message = yaz_diag_srw_str(code); + int len = 200; + if (message) + len += strlen(message); + if (details) + len += strlen(details); + + record->recordData_buf = (char *) odr_malloc(o, len); + + sprintf(record->recordData_buf, "\n" + " info:srw/diagnostic/1/%d\n", code); + if (details) + sprintf(record->recordData_buf + strlen(record->recordData_buf), + "
%s
\n", details); + if (message) + sprintf(record->recordData_buf + strlen(record->recordData_buf), + " %s\n", message); + sprintf(record->recordData_buf + strlen(record->recordData_buf), + "\n"); + record->recordData_len = strlen(record->recordData_buf); + record->recordPosition = odr_intdup(o, pos); + record->recordSchema = "info:srw/schema/1/diagnostics-v1.1"; +} + +static void grab_charset(ODR o, const char *content_type, char **charset) +{ + if (charset) + { + const char *charset_p = 0; + if (content_type && (charset_p = strstr(content_type, "; charset="))) + { + int i = 0; + charset_p += 10; + while (i < 20 && charset_p[i] && + !strchr("; \n\r", charset_p[i])) + i++; + *charset = (char*) odr_malloc(o, i+1); + memcpy(*charset, charset_p, i); + (*charset)[i] = '\0'; + } + } +} + int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, Z_SOAP **soap_package, ODR decode, char **charset) { @@ -171,19 +400,18 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, "Content-Type"); if (content_type && (!yaz_strcmp_del("text/xml", content_type, "; ") || + !yaz_strcmp_del("application/soap+xml", content_type, "; ") || !yaz_strcmp_del("text/plain", content_type, "; "))) { char *db = "Default"; const char *p0 = hreq->path, *p1; int ret = -1; - const char *charset_p = 0; - static Z_SOAP_Handler soap_handlers[3] = { -#if HAVE_XML2 - {"http://www.loc.gov/zing/srw/", 0, - (Z_SOAP_fun) yaz_srw_codec}, - {"http://www.loc.gov/zing/srw/v1.0/", 0, - (Z_SOAP_fun) yaz_srw_codec}, + static Z_SOAP_Handler soap_handlers[4] = { +#if YAZ_HAVE_XML2 + { YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec }, + { YAZ_XMLNS_SRU_v1_0, 0, (Z_SOAP_fun) yaz_srw_codec }, + { YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec }, #endif {0, 0, 0} }; @@ -200,17 +428,8 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, db[p1 - p0] = '\0'; } - if (charset && (charset_p = strstr(content_type, "; charset="))) - { - int i = 0; - charset_p += 10; - while (i < 20 && charset_p[i] && - !strchr("; \n\r", charset_p[i])) - i++; - *charset = (char*) odr_malloc(decode, i+1); - memcpy(*charset, charset_p, i); - (*charset)[i] = '\0'; - } + grab_charset(decode, content_type, charset); + ret = z_soap_codec(decode, soap_package, &hreq->content_buf, &hreq->content_len, soap_handlers); @@ -230,6 +449,10 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, (*srw_pdu)->u.scan_request->database == 0) (*srw_pdu)->u.scan_request->database = db; + if ((*srw_pdu)->which == Z_SRW_update_request && + (*srw_pdu)->u.update_request->database == 0) + (*srw_pdu)->u.update_request->database = db; + return 0; } return 1; @@ -238,6 +461,32 @@ int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, return 2; } +#if YAZ_HAVE_XML2 +static int yaz_sru_decode_integer(ODR odr, const char *pname, + const char *valstr, int **valp, + Z_SRW_diagnostic **diag, int *num_diag, + int min_value) +{ + int ival; + if (!valstr) + return 0; + if (sscanf(valstr, "%d", &ival) != 1) + { + yaz_add_srw_diagnostic(odr, diag, num_diag, + YAZ_SRW_UNSUPP_PARAMETER_VALUE, pname); + return 0; + } + if (min_value >= 0 && ival < min_value) + { + yaz_add_srw_diagnostic(odr, diag, num_diag, + YAZ_SRW_UNSUPP_PARAMETER_VALUE, pname); + return 0; + } + *valp = odr_intdup(odr, ival); + return 1; +} +#endif + /** http://www.loc.gov/z3950/agency/zing/srw/service.html */ @@ -245,23 +494,35 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, Z_SOAP **soap_package, ODR decode, char **charset, Z_SRW_diagnostic **diag, int *num_diag) { -#if HAVE_XML2 +#if YAZ_HAVE_XML2 static Z_SOAP_Handler soap_handlers[2] = { - {"http://www.loc.gov/zing/srw/", 0, - (Z_SOAP_fun) yaz_srw_codec}, + {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec}, {0, 0, 0} }; #endif - if (!strcmp(hreq->method, "GET") || - !strcmp(hreq->method, "POST") ) + const char *content_type = z_HTTP_header_lookup(hreq->headers, + "Content-Type"); + + /* + SRU GET: ignore content type. + SRU POST: we support "application/x-www-form-urlencoded"; + not "multipart/form-data" . + */ + if (!strcmp(hreq->method, "GET") + || + (!strcmp(hreq->method, "POST") && content_type && + !yaz_strcmp_del("application/x-www-form-urlencoded", + content_type, "; "))) { char *db = "Default"; const char *p0 = hreq->path, *p1; -#if HAVE_XML2 +#if YAZ_HAVE_XML2 const char *operation = 0; char *version = 0; char *query = 0; char *pQuery = 0; + char *username = 0; + char *password = 0; char *sortKeys = 0; char *stylesheet = 0; char *scanClause = 0; @@ -274,12 +535,15 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, char *maximumTerms = 0; char *responsePosition = 0; char *extraRequestData = 0; + Z_SRW_extra_arg *extra_args = 0; #endif char **uri_name; char **uri_val; - if (charset) - *charset = 0; + grab_charset(decode, content_type, charset); + if (charset && *charset == 0 && !strcmp(hreq->method, "GET")) + *charset = "UTF-8"; + if (*p0 == '/') p0++; p1 = strchr(p0, '?'); @@ -293,8 +557,8 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, } if (!strcmp(hreq->method, "POST")) p1 = hreq->content_buf; - yaz_uri_array(p1, decode, &uri_name, &uri_val); -#if HAVE_XML2 + yaz_uri_to_array(p1, decode, &uri_name, &uri_val); +#if YAZ_HAVE_XML2 if (uri_name) { int i; @@ -306,6 +570,10 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, query = v; else if (!strcmp(n, "x-pquery")) pQuery = v; + else if (!strcmp(n, "x-username")) + username = v; + else if (!strcmp(n, "x-password")) + password = v; else if (!strcmp(n, "operation")) operation = v; else if (!strcmp(n, "stylesheet")) @@ -334,22 +602,45 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, responsePosition = v; else if (!strcmp(n, "extraRequestData")) extraRequestData = v; + else if (n[0] == 'x' && n[1] == '-') + { + Z_SRW_extra_arg **l = &extra_args; + while (*l) + l = &(*l)->next; + *l = (Z_SRW_extra_arg *) odr_malloc(decode, sizeof(**l)); + (*l)->name = odr_strdup(decode, n); + (*l)->value = odr_strdup(decode, v); + (*l)->next = 0; + } else - yaz_add_srw_diagnostic(decode, diag, num_diag, 8, n); + yaz_add_srw_diagnostic(decode, diag, num_diag, + YAZ_SRW_UNSUPP_PARAMETER, n); } } if (!version) { if (uri_name) - yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "version"); + yaz_add_srw_diagnostic( + decode, diag, num_diag, + YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "version"); version = "1.1"; } - if (strcmp(version, "1.1")) - yaz_add_srw_diagnostic(decode, diag, num_diag, 5, "1.1"); + + version = yaz_negotiate_sru_version(version); + + if (!version) + { /* negotiation failed. */ + yaz_add_srw_diagnostic(decode, diag, num_diag, + YAZ_SRW_UNSUPP_VERSION, "1.2"); + version = "1.2"; + } + if (!operation) { if (uri_name) - yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "operation"); + yaz_add_srw_diagnostic( + decode, diag, num_diag, + YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "operation"); operation = "explain"; } if (!strcmp(operation, "searchRetrieve")) @@ -357,7 +648,9 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_searchRetrieve_request); sr->srw_version = version; + sr->extra_args = extra_args; *srw_pdu = sr; + yaz_srw_decodeauth(sr, hreq, username, password, decode); if (query) { sr->u.request->query_type = Z_SRW_query_type_cql; @@ -369,7 +662,9 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, sr->u.request->query.pqf = pQuery; } else - yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "query"); + yaz_add_srw_diagnostic( + decode, diag, num_diag, + YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "query"); if (sortKeys) { @@ -381,19 +676,21 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, sr->u.request->recordPacking = recordPacking; sr->u.request->stylesheet = stylesheet; - if (maximumRecords) - sr->u.request->maximumRecords = - odr_intdup(decode, atoi(maximumRecords)); - if (startRecord) - sr->u.request->startRecord = - odr_intdup(decode, atoi(startRecord)); + yaz_sru_decode_integer(decode, "maximumRecords", maximumRecords, + &sr->u.request->maximumRecords, + diag, num_diag, 0); + + yaz_sru_decode_integer(decode, "startRecord", startRecord, + &sr->u.request->startRecord, + diag, num_diag, 1); sr->u.request->database = db; - (*soap_package) = odr_malloc(decode, sizeof(**soap_package)); + (*soap_package) = (Z_SOAP *) + odr_malloc(decode, sizeof(**soap_package)); (*soap_package)->which = Z_SOAP_generic; - (*soap_package)->u.generic = + (*soap_package)->u.generic = (Z_SOAP_Generic *) odr_malloc(decode, sizeof(*(*soap_package)->u.generic)); (*soap_package)->u.generic->p = sr; @@ -411,16 +708,19 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request); sr->srw_version = version; + sr->extra_args = extra_args; + yaz_srw_decodeauth(sr, hreq, username, password, decode); *srw_pdu = sr; sr->u.explain_request->recordPacking = recordPacking; sr->u.explain_request->database = db; sr->u.explain_request->stylesheet = stylesheet; - (*soap_package) = odr_malloc(decode, sizeof(**soap_package)); + (*soap_package) = (Z_SOAP *) + odr_malloc(decode, sizeof(**soap_package)); (*soap_package)->which = Z_SOAP_generic; - (*soap_package)->u.generic = + (*soap_package)->u.generic = (Z_SOAP_Generic *) odr_malloc(decode, sizeof(*(*soap_package)->u.generic)); (*soap_package)->u.generic->p = sr; @@ -438,7 +738,9 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_scan_request); sr->srw_version = version; + sr->extra_args = extra_args; *srw_pdu = sr; + yaz_srw_decodeauth(sr, hreq, username, password, decode); if (scanClause) { @@ -451,23 +753,28 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, sr->u.scan_request->scanClause.pqf = pScanClause; } else - yaz_add_srw_diagnostic(decode, diag, num_diag, 7, - "scanClause"); + yaz_add_srw_diagnostic( + decode, diag, num_diag, + YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "scanClause"); sr->u.scan_request->database = db; - - if (maximumTerms) - sr->u.scan_request->maximumTerms = - odr_intdup(decode, atoi(maximumTerms)); - if (responsePosition) - sr->u.scan_request->responsePosition = - odr_intdup(decode, atoi(responsePosition)); + + yaz_sru_decode_integer(decode, "maximumTerms", + maximumTerms, + &sr->u.scan_request->maximumTerms, + diag, num_diag, 0); + + yaz_sru_decode_integer(decode, "responsePosition", + responsePosition, + &sr->u.scan_request->responsePosition, + diag, num_diag, 0); sr->u.scan_request->stylesheet = stylesheet; - (*soap_package) = odr_malloc(decode, sizeof(**soap_package)); + (*soap_package) = (Z_SOAP *) + odr_malloc(decode, sizeof(**soap_package)); (*soap_package)->which = Z_SOAP_generic; - (*soap_package)->u.generic = + (*soap_package)->u.generic = (Z_SOAP_Generic *) odr_malloc(decode, sizeof(*(*soap_package)->u.generic)); (*soap_package)->u.generic->p = sr; @@ -492,10 +799,11 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, sr->u.explain_request->stylesheet = stylesheet; - (*soap_package) = odr_malloc(decode, sizeof(**soap_package)); + (*soap_package) = (Z_SOAP *) + odr_malloc(decode, sizeof(**soap_package)); (*soap_package)->which = Z_SOAP_generic; - (*soap_package)->u.generic = + (*soap_package)->u.generic = (Z_SOAP_Generic *) odr_malloc(decode, sizeof(*(*soap_package)->u.generic)); (*soap_package)->u.generic->p = sr; @@ -504,7 +812,8 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, (*soap_package)->ns = "SRU"; - yaz_add_srw_diagnostic(decode, diag, num_diag, 4, operation); + yaz_add_srw_diagnostic(decode, diag, num_diag, + YAZ_SRW_UNSUPP_OPERATION, operation); return 0; } #endif @@ -513,11 +822,63 @@ int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, return 2; } +Z_SRW_extra_record *yaz_srw_get_extra_record(ODR o) +{ + Z_SRW_extra_record *res = (Z_SRW_extra_record *) + odr_malloc(o, sizeof(*res)); + + res->extraRecordData_buf = 0; + res->extraRecordData_len = 0; + res->recordIdentifier = 0; + return res; +} + + +Z_SRW_record *yaz_srw_get_records(ODR o, int n) +{ + Z_SRW_record *res = (Z_SRW_record *) odr_malloc(o, n * sizeof(*res)); + int i; + + for (i = 0; isrw_version = odr_strdup(o, version); + p->username = 0; + p->password = 0; + p->extra_args = 0; + return p; +} + +Z_SRW_PDU *yaz_srw_get_core_v_1_1(ODR o) +{ + return yaz_srw_get_core_ver(o, "1.1"); +} + Z_SRW_PDU *yaz_srw_get(ODR o, int which) { - Z_SRW_PDU *sr = (Z_SRW_PDU *) odr_malloc(o, sizeof(*o)); + return yaz_srw_get_pdu(o, which, "1.1"); +} + +Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version) +{ + Z_SRW_PDU *sr = yaz_srw_get_core_ver(o, version); - sr->srw_version = odr_strdup(o, "1.1"); sr->which = which; switch(which) { @@ -548,6 +909,7 @@ Z_SRW_PDU *yaz_srw_get(ODR o, int which) sr->u.response->diagnostics = 0; sr->u.response->num_diagnostics = 0; sr->u.response->nextRecordPosition = 0; + sr->u.response->extra_records = 0; break; case Z_SRW_explain_request: sr->u.explain_request = (Z_SRW_explainRequest *) @@ -567,6 +929,7 @@ Z_SRW_PDU *yaz_srw_get(ODR o, int which) Z_SRW_recordPacking_string; sr->u.explain_response->diagnostics = 0; sr->u.explain_response->num_diagnostics = 0; + sr->u.explain_response->extra_record = 0; break; case Z_SRW_scan_request: sr->u.scan_request = (Z_SRW_scanRequest *) @@ -581,18 +944,44 @@ Z_SRW_PDU *yaz_srw_get(ODR o, int which) case Z_SRW_scan_response: sr->u.scan_response = (Z_SRW_scanResponse *) odr_malloc(o, sizeof(*sr->u.scan_response)); - sr->u.scan_response->terms = 0; - sr->u.scan_response->num_terms = 0; - sr->u.scan_response->diagnostics = 0; - sr->u.scan_response->num_diagnostics = 0; + sr->u.scan_response->terms = 0; + sr->u.scan_response->num_terms = 0; + sr->u.scan_response->diagnostics = 0; + sr->u.scan_response->num_diagnostics = 0; + break; + case Z_SRW_update_request: + sr->u.update_request = (Z_SRW_updateRequest *) + odr_malloc(o, sizeof(*sr->u.update_request)); + sr->u.update_request->database = 0; + sr->u.update_request->stylesheet = 0; + sr->u.update_request->record = 0; + sr->u.update_request->recordId = 0; + sr->u.update_request->recordVersions = 0; + sr->u.update_request->num_recordVersions = 0; + sr->u.update_request->extra_record = 0; + sr->u.update_request->extraRequestData_buf = 0; + sr->u.update_request->extraRequestData_len = 0; + sr->u.request->database = 0; + break; + case Z_SRW_update_response: + sr->u.update_response = (Z_SRW_updateResponse *) + odr_malloc(o, sizeof(*sr->u.update_response)); + sr->u.update_response->operationStatus = 0; + sr->u.update_response->recordId = 0; + sr->u.update_response->recordVersions = 0; + sr->u.update_response->num_recordVersions = 0; + sr->u.update_response->record = 0; + sr->u.update_response->extra_record = 0; + sr->u.update_response->extraResponseData_buf = 0; + sr->u.update_response->extraResponseData_len = 0; + sr->u.update_response->diagnostics = 0; + sr->u.update_response->num_diagnostics = 0; } return sr; } - - /* bib1:srw */ -static int srw_bib1_map[] = { +static int bib1_srw_map[] = { 1, 1, 2, 2, 3, 11, @@ -698,7 +1087,7 @@ static int srw_bib1_map[] = { 219, 1, /* bad map */ 220, 1, /* bad map */ 221, 1, /* bad map */ - 222, 1, /* bad map */ + 222, 3, 223, 1, /* bad map */ 224, 1, /* bad map */ 225, 1, /* bad map */ @@ -761,9 +1150,21 @@ static int srw_bib1_map[] = { 0 }; +/* + * This array contains overrides for when the first occurrence of a + * particular SRW error in the array above does not correspond with + * the best back-translation of that SRW error. + */ +static int srw_bib1_map[] = { + 66, 238, + /* No doubt there are many more */ + 0 +}; + + int yaz_diag_bib1_to_srw (int code) { - const int *p = srw_bib1_map; + const int *p = bib1_srw_map; while (*p) { if (code == p[0]) @@ -775,9 +1176,19 @@ int yaz_diag_bib1_to_srw (int code) int yaz_diag_srw_to_bib1(int code) { + /* Check explicit reverse-map first */ const int *p = srw_bib1_map; while (*p) { + if (code == p[0]) + return p[1]; + p += 2; + } + + /* Fall back on reverse lookup in main map */ + p = bib1_srw_map; + while (*p) + { if (code == p[1]) return p[0]; p += 2; @@ -785,6 +1196,278 @@ int yaz_diag_srw_to_bib1(int code) return 1; } +static void add_val_int(ODR o, char **name, char **value, int *i, + char *a_name, int *val) +{ + if (val) + { + name[*i] = a_name; + value[*i] = (char *) odr_malloc(o, 30); + sprintf(value[*i], "%d", *val); + (*i)++; + } +} + +static void add_val_str(ODR o, char **name, char **value, int *i, + char *a_name, char *val) +{ + if (val) + { + name[*i] = a_name; + value[*i] = val; + (*i)++; + } +} + +static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode, + char **name, char **value, int max_names) +{ + int i = 0; + add_val_str(encode, name, value, &i, "version", srw_pdu->srw_version); + name[i] = "operation"; + switch(srw_pdu->which) + { + case Z_SRW_searchRetrieve_request: + value[i++] = "searchRetrieve"; + switch(srw_pdu->u.request->query_type) + { + case Z_SRW_query_type_cql: + add_val_str(encode, name, value, &i, "query", + srw_pdu->u.request->query.cql); + break; + case Z_SRW_query_type_pqf: + add_val_str(encode, name, value, &i, "x-pquery", + srw_pdu->u.request->query.pqf); + break; + case Z_SRW_query_type_xcql: + add_val_str(encode, name, value, &i, "x-cql", + srw_pdu->u.request->query.xcql); + break; + } + switch(srw_pdu->u.request->sort_type) + { + case Z_SRW_sort_type_none: + break; + case Z_SRW_sort_type_sort: + add_val_str(encode, name, value, &i, "sortKeys", + srw_pdu->u.request->sort.sortKeys); + break; + } + add_val_int(encode, name, value, &i, "startRecord", + srw_pdu->u.request->startRecord); + add_val_int(encode, name, value, &i, "maximumRecords", + srw_pdu->u.request->maximumRecords); + add_val_str(encode, name, value, &i, "recordSchema", + srw_pdu->u.request->recordSchema); + add_val_str(encode, name, value, &i, "recordPacking", + srw_pdu->u.request->recordPacking); + add_val_str(encode, name, value, &i, "recordXPath", + srw_pdu->u.request->recordXPath); + add_val_str(encode, name, value, &i, "stylesheet", + srw_pdu->u.request->stylesheet); + add_val_int(encode, name, value, &i, "resultSetTTL", + srw_pdu->u.request->resultSetTTL); + break; + case Z_SRW_explain_request: + value[i++] = "explain"; + add_val_str(encode, name, value, &i, "stylesheet", + srw_pdu->u.explain_request->stylesheet); + break; + case Z_SRW_scan_request: + value[i++] = "scan"; + + switch(srw_pdu->u.scan_request->query_type) + { + case Z_SRW_query_type_cql: + add_val_str(encode, name, value, &i, "scanClause", + srw_pdu->u.scan_request->scanClause.cql); + break; + case Z_SRW_query_type_pqf: + add_val_str(encode, name, value, &i, "x-pScanClause", + srw_pdu->u.scan_request->scanClause.pqf); + break; + case Z_SRW_query_type_xcql: + add_val_str(encode, name, value, &i, "x-cqlScanClause", + srw_pdu->u.scan_request->scanClause.xcql); + break; + } + add_val_int(encode, name, value, &i, "responsePosition", + srw_pdu->u.scan_request->responsePosition); + add_val_int(encode, name, value, &i, "maximumTerms", + srw_pdu->u.scan_request->maximumTerms); + add_val_str(encode, name, value, &i, "stylesheet", + srw_pdu->u.scan_request->stylesheet); + break; + case Z_SRW_update_request: + value[i++] = "update"; + break; + default: + return -1; + } + if (srw_pdu->extra_args) + { + Z_SRW_extra_arg *ea = srw_pdu->extra_args; + for (; ea && i < max_names-1; ea = ea->next) + { + name[i] = ea->name; + value[i] = ea->value; + i++; + } + } + name[i++] = 0; + + return 0; +} + +int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu, + ODR encode, const char *charset) +{ + char *name[30], *value[30]; /* definite upper limit for SRU params */ + char *uri_args; + char *path; + + z_HTTP_header_add_basic_auth(encode, &hreq->headers, + srw_pdu->username, srw_pdu->password); + if (yaz_get_sru_parms(srw_pdu, encode, name, value, 30)) + return -1; + yaz_array_to_uri(&uri_args, encode, name, value); + + hreq->method = "GET"; + + path = (char *) + odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 4); + + sprintf(path, "%s?%s", hreq->path, uri_args); + hreq->path = path; + + z_HTTP_header_add_content_type(encode, &hreq->headers, + "text/xml", charset); + return 0; +} + +int yaz_sru_post_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu, + ODR encode, const char *charset) +{ + char *name[30], *value[30]; /* definite upper limit for SRU params */ + char *uri_args; + + z_HTTP_header_add_basic_auth(encode, &hreq->headers, + srw_pdu->username, srw_pdu->password); + if (yaz_get_sru_parms(srw_pdu, encode, name, value, 30)) + return -1; + + yaz_array_to_uri(&uri_args, encode, name, value); + + hreq->method = "POST"; + + hreq->content_buf = uri_args; + hreq->content_len = strlen(uri_args); + + z_HTTP_header_add_content_type(encode, &hreq->headers, + "application/x-www-form-urlencoded", + charset); + return 0; +} + +int yaz_sru_soap_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu, + ODR odr, const char *charset) +{ + Z_SOAP_Handler handlers[3] = { +#if YAZ_HAVE_XML2 + {YAZ_XMLNS_SRU_v1_1, 0, (Z_SOAP_fun) yaz_srw_codec}, + {YAZ_XMLNS_UPDATE_v0_9, 0, (Z_SOAP_fun) yaz_ucp_codec}, +#endif + {0, 0, 0} + }; + Z_SOAP *p = (Z_SOAP*) odr_malloc(odr, sizeof(*p)); + + z_HTTP_header_add_basic_auth(odr, &hreq->headers, + srw_pdu->username, srw_pdu->password); + z_HTTP_header_add_content_type(odr, + &hreq->headers, + "text/xml", charset); + + z_HTTP_header_add(odr, &hreq->headers, + "SOAPAction", "\"\""); + p->which = Z_SOAP_generic; + p->u.generic = (Z_SOAP_Generic *) odr_malloc(odr, sizeof(*p->u.generic)); + p->u.generic->no = 0; + p->u.generic->ns = 0; + p->u.generic->p = srw_pdu; + p->ns = "http://schemas.xmlsoap.org/soap/envelope/"; + +#if YAZ_HAVE_XML2 + if (srw_pdu->which == Z_SRW_update_request || + srw_pdu->which == Z_SRW_update_response) + p->u.generic->no = 1; /* second handler */ +#endif + return z_soap_codec_enc(odr, &p, + &hreq->content_buf, + &hreq->content_len, handlers, + charset); +} + +Z_SRW_recordVersion *yaz_srw_get_record_versions(ODR odr, int num ) +{ + Z_SRW_recordVersion *ver + = (Z_SRW_recordVersion *) odr_malloc( odr, num * sizeof(*ver) ); + int i; + for ( i=0; i < num; ++i ){ + ver[i].versionType = 0; + ver[i].versionValue = 0; + } + return ver; +} + +const char *yaz_srw_pack_to_str(int pack) +{ + switch(pack) + { + case Z_SRW_recordPacking_string: + return "string"; + case Z_SRW_recordPacking_XML: + return "xml"; + case Z_SRW_recordPacking_URL: + return "url"; + } + return 0; +} + +int yaz_srw_str_to_pack(const char *str) +{ + if (!yaz_matchstr(str, "string")) + return Z_SRW_recordPacking_string; + if (!yaz_matchstr(str, "xml")) + return Z_SRW_recordPacking_XML; + if (!yaz_matchstr(str, "url")) + return Z_SRW_recordPacking_URL; + return -1; +} + +void yaz_encode_sru_extra(Z_SRW_PDU *sr, ODR odr, const char *extra_args) +{ + if (extra_args) + { + char **name; + char **val; + Z_SRW_extra_arg **ea = &sr->extra_args; + yaz_uri_to_array(extra_args, odr, &name, &val); + + while (*name) + { + *ea = (Z_SRW_extra_arg *) odr_malloc(odr, sizeof(**ea)); + (*ea)->name = *name; + (*ea)->value = *val; + ea = &(*ea)->next; + val++; + name++; + } + *ea = 0; + } +} + + + /* * Local variables: * c-basic-offset: 4