/*
- * Copyright (c) 2002-2004, Index Data.
+ * Copyright (C) 1995-2005, Index Data ApS
* See the file LICENSE for details.
*
- * $Id: srwutil.c,v 1.9 2004-01-09 19:54:05 adam Exp $
+ * $Id: srwutil.c,v 1.43 2006-06-05 18:13:01 adam Exp $
+ */
+/**
+ * \file srwutil.c
+ * \brief Implements SRW/SRU utilities.
*/
+#include <stdlib.h>
#include <yaz/srw.h>
#include <yaz/yaz-iconv.h>
return 0;
}
+void encode_uri_char(char *dst, char ch)
+{
+ if (ch == ' ')
+ strcpy(dst, "+");
+ else if ((ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z') ||
+ (ch >= '0' && ch <= '9'))
+ {
+ dst[0] = ch;
+ dst[1] = '\0';
+ }
+ else
+ {
+ dst[0] = '%';
+ sprintf(dst+1, "%02X", (unsigned char ) ch);
+ }
+}
+
+void yaz_array_to_uri(char **path, ODR o, char **name, char **value)
+{
+ size_t i, szp = 0, sz = 0;
+ for(i = 0; name[i]; i++)
+ sz += strlen(name[i]) + 3 + strlen(value[i]) * 3;
+ *path = 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_array(const char *path, ODR o, char ***name, char ***val)
{
int no = 2;
const char *cp;
*name = 0;
- if (*path != '?')
- return no;
- path++;
+ if (*path == '?')
+ path++;
+ if (!*path)
+ return 0;
cp = path;
while ((cp = strchr(cp, '&')))
{
- cp++;
- no++;
+ cp++;
+ no++;
}
- *name = odr_malloc(o, no * sizeof(char**));
- *val = odr_malloc(o, no * sizeof(char**));
+ *name = odr_malloc(o, no * sizeof(char*));
+ *val = odr_malloc(o, no * sizeof(char*));
for (no = 0; *path; no++)
{
const char *p1 = strchr(path, '=');
- size_t i = 0;
- char *ret;
+ size_t i = 0;
+ char *ret;
if (!p1)
break;
- (*name)[no] = odr_malloc(o, (p1-path)+1);
- memcpy((*name)[no], path, p1-path);
- (*name)[no][p1-path] = '\0';
-
- path = p1 + 1;
- p1 = strchr(path, '&');
- if (!p1)
- p1 = strlen(path) + path;
- (*val)[no] = ret = odr_malloc(o, p1 - path + 1);
- while (*path && *path != '&')
- {
- if (*path == '+')
- {
- ret[i++] = ' ';
- path++;
- }
- else if (*path == '%' && path[1] && path[2])
- {
- ret[i++] = hex_digit (path[1])*16 + hex_digit (path[2]);
- path = path + 3;
- }
- else
- ret[i++] = *path++;
- }
- ret[i] = '\0';
-
- if (*path)
- path++;
+ (*name)[no] = odr_malloc(o, (p1-path)+1);
+ memcpy((*name)[no], path, p1-path);
+ (*name)[no][p1-path] = '\0';
+
+ path = p1 + 1;
+ p1 = strchr(path, '&');
+ if (!p1)
+ p1 = strlen(path) + path;
+ (*val)[no] = ret = odr_malloc(o, p1 - path + 1);
+ while (*path && *path != '&')
+ {
+ if (*path == '+')
+ {
+ ret[i++] = ' ';
+ path++;
+ }
+ else if (*path == '%' && path[1] && path[2])
+ {
+ ret[i++] = hex_digit (path[1])*16 + hex_digit (path[2]);
+ path = path + 3;
+ }
+ else
+ ret[i++] = *path++;
+ }
+ ret[i] = '\0';
+
+ if (*path)
+ path++;
}
(*name)[no] = 0;
(*val)[no] = 0;
p1 = strchr(path, '&');
if (!p1)
p1 = strlen(path) + path;
- ret = odr_malloc(o, p1 - path + 1);
+ ret = (char *) odr_malloc(o, p1 - path + 1);
while (*path && *path != '&')
{
if (*path == '+')
return 0;
}
+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;
+}
+
+/**
+ * Look for authentication tokens in HTTP Basic parameters or in x-username/x-password
+ * parameters. Added by SH.
+ */
+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);
+ }
+}
+
void yaz_uri_val_int(const char *path, const char *name, ODR o, int **intp)
{
const char *v = yaz_uri_val(path, name, o);
*intp = odr_intdup(o, atoi(v));
}
-void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
- int *num, int code, const char *addinfo)
+void yaz_mk_srw_diagnostic(ODR o, Z_SRW_diagnostic *d,
+ const char *uri, const char *message,
+ const char *details)
+{
+ 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_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));
if (*num)
- memcpy (d_new, *d, *num *sizeof(**d));
+ memcpy (d_new, *d, *num *sizeof(**d));
*d = d_new;
- (*d + *num)->code = odr_intdup(o, code);
- if (addinfo)
- (*d + *num)->details = odr_strdup(o, addinfo);
- else
- (*d + *num)->details = 0;
+
+ 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);
+}
+
int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
- Z_SOAP **soap_package, ODR decode, char **charset)
+ Z_SOAP **soap_package, ODR decode, char **charset)
{
if (!strcmp(hreq->method, "POST"))
{
- const char *content_type = z_HTTP_header_lookup(hreq->headers,
- "Content-Type");
- if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
- {
- char *db = "Default";
- const char *p0 = hreq->path, *p1;
+ const char *content_type = z_HTTP_header_lookup(hreq->headers,
+ "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] = {
+
+ static Z_SOAP_Handler soap_handlers[4] = {
#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},
+ {"http://www.loc.gov/zing/srw/update/", 0,
+ (Z_SOAP_fun) yaz_ucp_codec},
#endif
{0, 0, 0}
};
-
- if (*p0 == '/')
- p0++;
- p1 = strchr(p0, '?');
- if (!p1)
- p1 = p0 + strlen(p0);
- if (p1 != p0)
- {
- db = (char*) odr_malloc(decode, p1 - p0 + 1);
- memcpy (db, p0, p1 - p0);
- db[p1 - p0] = '\0';
- }
+
+ if (*p0 == '/')
+ p0++;
+ p1 = strchr(p0, '?');
+ if (!p1)
+ p1 = p0 + strlen(p0);
+ if (p1 != p0)
+ {
+ db = (char*) odr_malloc(decode, p1 - p0 + 1);
+ memcpy (db, p0, p1 - p0);
+ db[p1 - p0] = '\0';
+ }
if (charset && (charset_p = strstr(content_type, "; charset=")))
{
ret = z_soap_codec(decode, soap_package,
&hreq->content_buf, &hreq->content_len,
soap_handlers);
- if (ret == 0 && (*soap_package)->which == Z_SOAP_generic)
- {
- *srw_pdu = (Z_SRW_PDU*) (*soap_package)->u.generic->p;
-
- if ((*srw_pdu)->which == Z_SRW_searchRetrieve_request &&
- (*srw_pdu)->u.request->database == 0)
- (*srw_pdu)->u.request->database = db;
-
- if ((*srw_pdu)->which == Z_SRW_explain_request &&
- (*srw_pdu)->u.explain_request->database == 0)
- (*srw_pdu)->u.explain_request->database = db;
-
- if ((*srw_pdu)->which == Z_SRW_scan_request &&
- (*srw_pdu)->u.scan_request->database == 0)
- (*srw_pdu)->u.scan_request->database = db;
-
- return 0;
- }
- return 1;
- }
+ if (ret == 0 && (*soap_package)->which == Z_SOAP_generic)
+ {
+ *srw_pdu = (Z_SRW_PDU*) (*soap_package)->u.generic->p;
+
+ if ((*srw_pdu)->which == Z_SRW_searchRetrieve_request &&
+ (*srw_pdu)->u.request->database == 0)
+ (*srw_pdu)->u.request->database = db;
+
+ if ((*srw_pdu)->which == Z_SRW_explain_request &&
+ (*srw_pdu)->u.explain_request->database == 0)
+ (*srw_pdu)->u.explain_request->database = db;
+
+ if ((*srw_pdu)->which == Z_SRW_scan_request &&
+ (*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;
+ }
}
return 2;
}
+static int yaz_sru_integer_decode(ODR odr, const char *pname,
+ const char *valstr, int **valp,
+ Z_SRW_diagnostic **diag, int *num_diag)
+
+{
+ 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;
+ }
+ *valp = odr_intdup(odr, ival);
+ return 1;
+}
+/**
+ http://www.loc.gov/z3950/agency/zing/srw/service.html
+*/
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)
+ Z_SOAP **soap_package, ODR decode, char **charset,
+ Z_SRW_diagnostic **diag, int *num_diag)
{
#if HAVE_XML2
static Z_SOAP_Handler soap_handlers[2] = {
- {"http://www.loc.gov/zing/srw/", 0,
- (Z_SOAP_fun) yaz_srw_codec},
- {0, 0, 0}
+ {"http://www.loc.gov/zing/srw/", 0,
+ (Z_SOAP_fun) yaz_srw_codec},
+ {0, 0, 0}
};
#endif
- if (!strcmp(hreq->method, "GET"))
+ const char *content_type = z_HTTP_header_lookup(hreq->headers,
+ "Content-Type");
+ /*
+ SRU GET: allow any 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;
- const char *operation = 0;
- char *version = 0;
- char *query = 0;
- char *pQuery = 0;
- char *sortKeys = 0;
- char *stylesheet = 0;
- char *scanClause = 0;
- char *recordXPath = 0;
- char *recordSchema = 0;
- char *recordPacking = "xml";
- char *maximumRecords = 0;
- char *startRecord = 0;
- char **uri_name;
- char **uri_val;
-
- if (charset)
- *charset = 0;
+#if 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;
+ char *pScanClause = 0;
+ char *recordXPath = 0;
+ char *recordSchema = 0;
+ char *recordPacking = "xml"; /* xml packing is default for SRU */
+ char *maximumRecords = 0;
+ char *startRecord = 0;
+ char *maximumTerms = 0;
+ char *responsePosition = 0;
+ char *extraRequestData = 0;
+#endif
+ char **uri_name;
+ char **uri_val;
+
+ if (charset)
+ *charset = 0;
if (*p0 == '/')
p0++;
p1 = strchr(p0, '?');
memcpy (db, p0, p1 - p0);
db[p1 - p0] = '\0';
}
- yaz_uri_array(p1, decode, &uri_name, &uri_val);
+ if (!strcmp(hreq->method, "POST"))
+ p1 = hreq->content_buf;
+ yaz_uri_array(p1, decode, &uri_name, &uri_val);
#if HAVE_XML2
- if (uri_name)
- {
- int i;
- for (i = 0; uri_name[i]; i++)
- {
- char *n = uri_name[i];
- char *v = uri_val[i];
- if (!strcmp(n, "query"))
- query = v;
- else if (!strcmp(n, "x-pquery"))
- pQuery = v;
- else if (!strcmp(n, "operation"))
- operation = v;
- else if (!strcmp(n, "stylesheet"))
- stylesheet = v;
- else if (!strcmp(n, "sortKeys"))
- sortKeys = v;
- else if (!strcmp(n, "recordXPath"))
- recordXPath = v;
- else if (!strcmp(n, "recordSchema"))
- recordSchema = v;
- else if (!strcmp(n, "recordPacking"))
- recordPacking = v;
- else if (!strcmp(n, "version"))
- version = v;
- else if (!strcmp(n, "scanClause"))
- scanClause = v;
- else if (!strcmp(n, "maximumRecords"))
- maximumRecords = v;
- else if (!strcmp(n, "startRecord"))
- startRecord = v;
- else
- yaz_add_srw_diagnostic(decode, diag, num_diag, 9, n);
- }
- }
- if (!version)
- yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "version");
- else if (version && strcmp(version, "1.1"))
- yaz_add_srw_diagnostic(decode, diag, num_diag, 5, "1.1");
- if (!operation)
- {
- yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "operation");
- operation = "explain";
- }
+ if (uri_name)
+ {
+ int i;
+ for (i = 0; uri_name[i]; i++)
+ {
+ char *n = uri_name[i];
+ char *v = uri_val[i];
+ if (!strcmp(n, "query"))
+ 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"))
+ stylesheet = v;
+ else if (!strcmp(n, "sortKeys"))
+ sortKeys = v;
+ else if (!strcmp(n, "recordXPath"))
+ recordXPath = v;
+ else if (!strcmp(n, "recordSchema"))
+ recordSchema = v;
+ else if (!strcmp(n, "recordPacking"))
+ recordPacking = v;
+ else if (!strcmp(n, "version"))
+ version = v;
+ else if (!strcmp(n, "scanClause"))
+ scanClause = v;
+ else if (!strcmp(n, "x-pScanClause"))
+ pScanClause = v;
+ else if (!strcmp(n, "maximumRecords"))
+ maximumRecords = v;
+ else if (!strcmp(n, "startRecord"))
+ startRecord = v;
+ else if (!strcmp(n, "maximumTerms"))
+ maximumTerms = v;
+ else if (!strcmp(n, "responsePosition"))
+ responsePosition = v;
+ else if (!strcmp(n, "extraRequestData"))
+ extraRequestData = v;
+ else
+ 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,
+ YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "version");
+ version = "1.1";
+ }
+ if (strcmp(version, "1.1"))
+ yaz_add_srw_diagnostic(decode, diag, num_diag,
+ YAZ_SRW_UNSUPP_VERSION, "1.1");
+ if (!operation)
+ {
+ if (uri_name)
+ yaz_add_srw_diagnostic(
+ decode, diag, num_diag,
+ YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "operation");
+ operation = "explain";
+ }
if (!strcmp(operation, "searchRetrieve"))
{
Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_searchRetrieve_request);
- sr->srw_version = version;
- *srw_pdu = sr;
+ sr->srw_version = version;
+ *srw_pdu = sr;
+ yaz_srw_decodeauth(sr, hreq, username, password, decode);
if (query)
{
sr->u.request->query_type = Z_SRW_query_type_cql;
sr->u.request->query_type = Z_SRW_query_type_pqf;
sr->u.request->query.pqf = pQuery;
}
- else
- yaz_add_srw_diagnostic(decode, diag, num_diag, 7, "query");
+ else
+ yaz_add_srw_diagnostic(
+ decode, diag, num_diag,
+ YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "query");
if (sortKeys)
{
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_integer_decode(decode, "maximumRecords", maximumRecords,
+ &sr->u.request->maximumRecords,
+ diag, num_diag);
+
+ yaz_sru_integer_decode(decode, "startRecord", startRecord,
+ &sr->u.request->startRecord,
+ diag, num_diag);
sr->u.request->database = db;
- (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
- (*soap_package)->which = Z_SOAP_generic;
-
- (*soap_package)->u.generic =
- odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
-
- (*soap_package)->u.generic->p = sr;
- (*soap_package)->u.generic->ns = soap_handlers[0].ns;
- (*soap_package)->u.generic->no = 0;
-
- (*soap_package)->ns = "SRU";
+ (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
+ (*soap_package)->which = Z_SOAP_generic;
+
+ (*soap_package)->u.generic =
+ odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
+
+ (*soap_package)->u.generic->p = sr;
+ (*soap_package)->u.generic->ns = soap_handlers[0].ns;
+ (*soap_package)->u.generic->no = 0;
+
+ (*soap_package)->ns = "SRU";
- return 0;
+ return 0;
}
- else if (!strcmp(operation, "explain"))
- {
+ else if (!strcmp(operation, "explain"))
+ {
+ /* Transfer SRU explain parameters to common struct */
+ /* http://www.loc.gov/z3950/agency/zing/srw/explain.html */
Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request);
- sr->srw_version = version;
- *srw_pdu = sr;
+ sr->srw_version = version;
+ 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->database = db;
sr->u.explain_request->stylesheet = stylesheet;
- (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
- (*soap_package)->which = Z_SOAP_generic;
-
- (*soap_package)->u.generic =
- odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
-
- (*soap_package)->u.generic->p = sr;
- (*soap_package)->u.generic->ns = soap_handlers[0].ns;
- (*soap_package)->u.generic->no = 0;
-
- (*soap_package)->ns = "SRU";
+ (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
+ (*soap_package)->which = Z_SOAP_generic;
+
+ (*soap_package)->u.generic =
+ odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
+
+ (*soap_package)->u.generic->p = sr;
+ (*soap_package)->u.generic->ns = soap_handlers[0].ns;
+ (*soap_package)->u.generic->no = 0;
+
+ (*soap_package)->ns = "SRU";
- return 0;
- }
- else if (!strcmp(operation, "scan"))
- {
+ return 0;
+ }
+ else if (!strcmp(operation, "scan"))
+ {
+ /* Transfer SRU scan parameters to common struct */
+ /* http://www.loc.gov/z3950/agency/zing/srw/scan.html */
Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_scan_request);
- if (!scanClause)
- yaz_add_srw_diagnostic(decode, diag, num_diag, 7,
- "scanClause");
- sr->srw_version = version;
- *srw_pdu = sr;
- sr->u.scan_request->scanClause = scanClause;
- sr->u.scan_request->database = db;
+ sr->srw_version = version;
+ *srw_pdu = sr;
+ yaz_srw_decodeauth(sr, hreq, username, password, decode);
+
+ if (scanClause)
+ {
+ sr->u.scan_request->query_type = Z_SRW_query_type_cql;
+ sr->u.scan_request->scanClause.cql = scanClause;
+ }
+ else if (pScanClause)
+ {
+ sr->u.scan_request->query_type = Z_SRW_query_type_pqf;
+ sr->u.scan_request->scanClause.pqf = pScanClause;
+ }
+ else
+ yaz_add_srw_diagnostic(
+ decode, diag, num_diag,
+ YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "scanClause");
+ sr->u.scan_request->database = db;
+
+ yaz_sru_integer_decode(decode, "maximumTerms",
+ maximumTerms,
+ &sr->u.scan_request->maximumTerms,
+ diag, num_diag);
+
+ yaz_sru_integer_decode(decode, "responsePosition",
+ responsePosition,
+ &sr->u.scan_request->responsePosition,
+ diag, num_diag);
+
sr->u.scan_request->stylesheet = stylesheet;
- (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
- (*soap_package)->which = Z_SOAP_generic;
-
- (*soap_package)->u.generic =
- odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
-
- (*soap_package)->u.generic->p = sr;
- (*soap_package)->u.generic->ns = soap_handlers[0].ns;
- (*soap_package)->u.generic->no = 0;
-
- (*soap_package)->ns = "SRU";
+ (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
+ (*soap_package)->which = Z_SOAP_generic;
+
+ (*soap_package)->u.generic =
+ odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
+
+ (*soap_package)->u.generic->p = sr;
+ (*soap_package)->u.generic->ns = soap_handlers[0].ns;
+ (*soap_package)->u.generic->no = 0;
+
+ (*soap_package)->ns = "SRU";
- return 0;
- }
- else
- {
- /* unsupported operation ... */
- /* Act as if we received a explain request and throw diagnostic. */
+ return 0;
+ }
+ else
+ {
+ /* unsupported operation ... */
+ /* Act as if we received a explain request and throw diagnostic. */
Z_SRW_PDU *sr = yaz_srw_get(decode, Z_SRW_explain_request);
- sr->srw_version = version;
- *srw_pdu = sr;
+ sr->srw_version = version;
+ *srw_pdu = sr;
sr->u.explain_request->recordPacking = recordPacking;
- sr->u.explain_request->database = db;
+ sr->u.explain_request->database = db;
sr->u.explain_request->stylesheet = stylesheet;
- (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
- (*soap_package)->which = Z_SOAP_generic;
-
- (*soap_package)->u.generic =
- odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
-
- (*soap_package)->u.generic->p = sr;
- (*soap_package)->u.generic->ns = soap_handlers[0].ns;
- (*soap_package)->u.generic->no = 0;
-
- (*soap_package)->ns = "SRU";
-
- yaz_add_srw_diagnostic(decode, diag, num_diag, 4, operation);
- return 0;
- }
+ (*soap_package) = odr_malloc(decode, sizeof(**soap_package));
+ (*soap_package)->which = Z_SOAP_generic;
+
+ (*soap_package)->u.generic =
+ odr_malloc(decode, sizeof(*(*soap_package)->u.generic));
+
+ (*soap_package)->u.generic->p = sr;
+ (*soap_package)->u.generic->ns = soap_handlers[0].ns;
+ (*soap_package)->u.generic->no = 0;
+
+ (*soap_package)->ns = "SRU";
+
+ yaz_add_srw_diagnostic(decode, diag, num_diag,
+ YAZ_SRW_UNSUPP_OPERATION, operation);
+ return 0;
+ }
#endif
- return 1;
+ return 1;
}
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->type = 1;
+ res->recordReviewCode = 0;
+ res->recordReviewNote = 0;
+ res->recordId = 0;
+ res->nonDupRecordId = 0;
+ res->recordLockStatus = 0;
+ res->recordOldVersion = 0;
+ return res;
+}
+
Z_SRW_PDU *yaz_srw_get(ODR o, int which)
{
- Z_SRW_PDU *sr = odr_malloc(o, sizeof(*o));
+ Z_SRW_PDU *sr = (Z_SRW_PDU *) odr_malloc(o, sizeof(*o));
+ sr->username = 0;
+ sr->password = 0;
sr->srw_version = odr_strdup(o, "1.1");
sr->which = which;
switch(which)
sr->u.request->recordSchema = 0;
sr->u.request->recordPacking = 0;
sr->u.request->recordXPath = 0;
- sr->u.request->database = 0;
- sr->u.request->resultSetTTL = 0;
- sr->u.request->stylesheet = 0;
+ sr->u.request->database = 0;
+ sr->u.request->resultSetTTL = 0;
+ sr->u.request->stylesheet = 0;
break;
case Z_SRW_searchRetrieve_response:
sr->u.response = (Z_SRW_searchRetrieveResponse *)
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 *)
odr_malloc(o, sizeof(*sr->u.explain_request));
sr->u.explain_request->recordPacking = 0;
- sr->u.explain_request->database = 0;
- sr->u.explain_request->stylesheet = 0;
+ sr->u.explain_request->database = 0;
+ sr->u.explain_request->stylesheet = 0;
break;
case Z_SRW_explain_response:
sr->u.explain_response = (Z_SRW_explainResponse *)
odr_malloc(o, sizeof(*sr->u.explain_response));
- sr->u.explain_response->record.recordData_buf = 0;
- sr->u.explain_response->record.recordData_len = 0;
- sr->u.explain_response->record.recordSchema = 0;
- sr->u.explain_response->record.recordPosition = 0;
- sr->u.explain_response->record.recordPacking =
- Z_SRW_recordPacking_string;
- sr->u.explain_response->diagnostics = 0;
- sr->u.explain_response->num_diagnostics = 0;
- break;
+ sr->u.explain_response->record.recordData_buf = 0;
+ sr->u.explain_response->record.recordData_len = 0;
+ sr->u.explain_response->record.recordSchema = 0;
+ sr->u.explain_response->record.recordPosition = 0;
+ sr->u.explain_response->record.recordPacking =
+ 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 *)
odr_malloc(o, sizeof(*sr->u.scan_request));
- sr->u.scan_request->database = 0;
- sr->u.scan_request->stylesheet = 0;
- sr->u.scan_request->maximumTerms = 0;
- sr->u.scan_request->responsePosition = 0;
- sr->u.scan_request->scanClause = 0;
+ sr->u.scan_request->database = 0;
+ sr->u.scan_request->stylesheet = 0;
+ sr->u.scan_request->maximumTerms = 0;
+ sr->u.scan_request->responsePosition = 0;
+ sr->u.scan_request->query_type = Z_SRW_query_type_cql;
+ sr->u.scan_request->scanClause.cql = 0;
break;
case Z_SRW_scan_response:
sr->u.scan_response = (Z_SRW_scanResponse *)
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.recordSchema = 0;
+ sr->u.update_request->record.recordPacking = Z_SRW_recordPacking_XML;
+ sr->u.update_request->recordId = 0;
+ sr->u.update_request->recordVersion = 0;
+ sr->u.update_request->recordOldVersion = 0;
+ sr->u.update_request->record.recordData_buf = 0;
+ sr->u.update_request->record.recordData_len = 0;
+ sr->u.update_request->extra_record = 0;
+ sr->u.update_request->extraRequestData = 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->recordVersion = 0;
+ sr->u.update_response->recordChecksum = 0;
+ sr->u.update_response->record.recordData_buf = 0;
+ sr->u.update_response->record.recordData_len = 0;
+ sr->u.update_response->record.recordSchema = 0;
+ sr->u.update_response->record.recordPacking =
+ Z_SRW_recordPacking_XML;
+ sr->u.update_response->extra_record = 0;
+ sr->u.update_response->extraResponseData = 0;
+ sr->u.update_response->diagnostics = 0;
+ sr->u.update_response->num_diagnostics = 0;
}
return sr;
}
-
-static struct {
- int code;
- const char *msg;
-} yaz_srw_codes [] = {
-{1, "Permanent system error"},
-{2, "System temporarily unavailable"},
-{3, "Authentication error"},
-{4, "Unsupported operation"},
-{5, "Unsupported version"},
-{6, "Unsupported parameter value"},
-{7, "Mandatory parameter not supplied"},
-{8, "Unknown database"},
-{9, "Unknown parameter type"},
-/* Diagnostics Relating to CQL */
-{10, "Query syntax error"},
-{11, "Unsupported query type"},
-{12, "Too many characters in query"},
-{13, "Invalid or unsupported use of parentheses"},
-{14, "Invalid or unsupported use of quotes"},
-{15, "Unsupported context context set"},
-{16, "Unsupported index"},
-{17, "Unsupported combination of index and context set"},
-{18, "Unsupported combination of indexes"},
-{19, "Unsupported relation"},
-{20, "Unsupported relation modifier"},
-{21, "Unsupported combination of relation modifers"},
-{22, "Unsupported combination of relation and index"},
-{23, "Too many characters in term"},
-{24, "Unsupported combination of relation and term"},
-{25, "Special characters not quoted in term"},
-{26, "Non special character escaped in term"},
-{27, "Empty term unsupported"},
-{28, "Masking character not supported"},
-{29, "Masked words too short"},
-{30, "Too many masking characters in term"},
-{31, "Anchoring character not supported"},
-{32, "Anchoring character in unsupported position"},
-{33, "Combination of proximity/adjacency and masking characters not supported"},
-{34, "Combination of proximity/adjacency and anchoring characters not supported"},
-{35, "Terms only exclusion stopwords"},
-{36, "Term in invalid format for index or relation"},
-{37, "Unsupported boolean operator"},
-{38, "Too many boolean operators in query"},
-{39, "Proximity not supported"},
-{40, "Unsupported proximity relation"},
-{41, "Unsupported proximity distance"},
-{42, "Unsupported proximity unit"},
-{43, "Unsupported proximity ordering"},
-{44, "Unsupported combination of proximity modifiers"},
-{45, "context set name (prefix) assigned to multiple identifiers"},
-/* Diagnostics Relating to Result Sets */
-{50, "Result sets not supported"},
-{51, "Result set does not exist"},
-{52, "Result set temporarily unavailable"},
-{53, "Result sets only supported for retrieval"},
-{54, "Retrieval may only occur from an existing result set"},
-{55, "Combination of result sets with search terms not supported"},
-{56, "Only combination of single result set with search terms supported"},
-{57, "Result set created but no records available"},
-{58, "Result set created with unpredictable partial results available"},
-{59, "Result set created with valid partial results available"},
-/* Diagnostics Relating to Records */
-{60, "Result set no created: too many records retrieved"},
-{61, "First record position out of range"},
-{62, "Negative number of records requested"},
-{63, "System error in retrieving records"},
-{64, "Record temporarily unavailable"},
-{65, "Record does not exist"},
-{66, "Unknown schema for retrieval"},
-{67, "Record not available in this schema"},
-{68, "Not authorised to send record"},
-{69, "Not authorised to send record in this schema"},
-{70, "Record too large to send"},
-{71, "Unsupported record packing"},
-{72, "XPath retrieval unsupported"},
-{73, "XPath expression contains unsupported feature"},
-{74, "Unable to evaluate XPath expression"},
-/* Diagnostics Relating to Sorting */
-{80, "Sort not supported"},
-{81, "Unsupported sort type"},
-{82, "Unsupported sort sequence"},
-{83, "Too many records to sort"},
-{84, "Too many sort keys to sort"},
-{85, "Duplicate sort keys"},
-{86, "Cannot sort: incompatible record formats"},
-{87, "Unsupported schema for sort"},
-{88, "Unsupported path for sort"},
-{89, "Path unsupported for schema"},
-{90, "Unsupported direction value"},
-{91, "Unsupported case value"},
-{92, "Unsupported missing value action"},
-/* Diagnostics Relating to Explain */
-{100, "Explain not supported"},
-{101, "Explain request type not supported (SOAP vs GET)"},
-{102, "Explain record temporarily unavailable"},
-/* Diagnostics Relating to Stylesheets */
-{110, "Stylesheets not supported"},
-{111, "Unsupported stylesheet"},
-/* Diagnostics relating to Scan */
-{120, "Response position out of range"},
-{0, 0}
-};
-
-const char *yaz_diag_srw_str (int code)
-{
- int i;
- for (i = 0; yaz_srw_codes[i].code; i++)
- if (yaz_srw_codes[i].code == code)
- return yaz_srw_codes[i].msg;
- return 0;
-}
-
-
/* bib1:srw */
static int srw_bib1_map[] = {
1, 1,
108, 27,
108, 45,
- 109, 9,
+ 109, 2,
110, 37,
111, 1,
112, 58,
115, 16,
116, 16,
117, 19,
+ 117, 20,
118, 22,
119, 32,
119, 31,
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 */
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] = 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 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;
+ }
+ 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;
+
+ if (yaz_get_sru_parms(srw_pdu, encode, name, value))
+ return -1;
+ yaz_array_to_uri(&uri_args, encode, name, value);
+
+ hreq->method = "GET";
+
+ path = odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 3);
+ 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;
+
+ if (yaz_get_sru_parms(srw_pdu, encode, name, value))
+ 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[2] = {
+ {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
+ {0, 0, 0}
+ };
+ Z_SOAP *p = (Z_SOAP*) odr_malloc(odr, sizeof(*p));
+ 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/";
+
+ return z_soap_codec_enc(odr, &p,
+ &hreq->content_buf,
+ &hreq->content_len, handlers,
+ charset);
+}
+
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+