-/*
- * Copyright (C) 1995-2006, Index Data ApS
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2009 Index Data
* See the file LICENSE for details.
- *
- * $Id: srwutil.c,v 1.52 2006-10-24 09:18:34 adam Exp $
*/
/**
* \file srwutil.c
#include <stdlib.h>
#include <yaz/srw.h>
+#include <yaz/matchstr.h>
#include <yaz/yaz-iconv.h>
static int hex_digit (int ch)
{
if (ch == ' ')
strcpy(dst, "+");
+ /* mark = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")" */
else if ((ch >= 'A' && ch <= 'Z') || (ch >= 'a' && ch <= 'z') ||
- (ch >= '0' && ch <= '9'))
+ (ch >= '0' && ch <= '9') || strchr("-_.!~*'(|)", ch))
{
dst[0] = ch;
dst[1] = '\0';
}
}
-static void yaz_array_to_uri_ex(char **path, ODR o, char **name, char **value,
- const char *extra_args)
+static void yaz_array_to_uri(char **path, ODR o, char **name, char **value)
{
- size_t i, szp = 0, sz = extra_args ? 1+strlen(extra_args) : 1;
+ size_t i, szp = 0, sz = 1;
for(i = 0; name[i]; i++)
sz += strlen(name[i]) + 3 + strlen(value[i]) * 3;
- *path = odr_malloc(o, sz);
+ *path = (char *) odr_malloc(o, sz);
for(i = 0; name[i]; i++)
{
szp += vlen;
}
}
- if (extra_args)
- {
- if (i)
- (*path)[szp++] = '&';
- memcpy(*path + szp, extra_args, strlen(extra_args));
- szp += strlen(extra_args);
- }
(*path)[szp] = '\0';
}
-void yaz_array_to_uri(char **path, ODR o, char **name, char **value)
-{
- yaz_array_to_uri_ex(path, o, name, value, 0);
-}
-
-int yaz_uri_array(const char *path, ODR o, char ***name, char ***val)
+int yaz_uri_to_array(const char *path, ODR o, char ***name, char ***val)
{
int no = 2;
const char *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++)
{
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';
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 == '+')
return 0;
}
+#if YAZ_HAVE_XML2
static int yaz_base64decode(const char *in, char *out)
{
const char *map = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
*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)
{
sr->password = odr_strdup(decode, pbuf);
}
}
+#endif
void yaz_uri_val_int(const char *path, const char *name, ODR o, int **intp)
{
}
+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, "<diagnostic "
+ "xmlns=\"http://www.loc.gov/zing/srw/diagnostic/\">\n"
+ " <uri>info:srw/diagnostic/1/%d</uri>\n", code);
+ if (details)
+ sprintf(record->recordData_buf + strlen(record->recordData_buf),
+ " <details>%s</details>\n", details);
+ if (message)
+ sprintf(record->recordData_buf + strlen(record->recordData_buf),
+ " <message>%s</message>\n", message);
+ sprintf(record->recordData_buf + strlen(record->recordData_buf),
+ "</diagnostic>\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)
static Z_SOAP_Handler soap_handlers[4] = {
#if YAZ_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},
+ { 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}
};
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,
*valp = odr_intdup(odr, ival);
return 1;
}
+#endif
/**
http://www.loc.gov/z3950/agency/zing/srw/service.html
{
#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
char *maximumTerms = 0;
char *responsePosition = 0;
char *extraRequestData = 0;
+ Z_SRW_extra_arg *extra_args = 0;
#endif
char **uri_name;
char **uri_val;
}
if (!strcmp(hreq->method, "POST"))
p1 = hreq->content_buf;
- yaz_uri_array(p1, decode, &uri_name, &uri_val);
+ yaz_uri_to_array(p1, decode, &uri_name, &uri_val);
#if YAZ_HAVE_XML2
if (uri_name)
{
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,
YAZ_SRW_UNSUPP_PARAMETER, n);
YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, "version");
version = "1.1";
}
- if (strcmp(version, "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.1");
+ YAZ_SRW_UNSUPP_VERSION, "1.2");
+ version = "1.2";
+ }
+
if (!operation)
{
if (uri_name)
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->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;
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->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;
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);
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;
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;
{
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;
+
+ res->extraRecordData_buf = 0;
+ res->extraRecordData_len = 0;
+ res->recordIdentifier = 0;
return res;
}
-Z_SRW_PDU *yaz_srw_get_core_v_1_1(ODR o)
+
+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; i<n; i++)
+ {
+ res[i].recordSchema = 0;
+ res[i].recordPacking = Z_SRW_recordPacking_string;
+ res[i].recordData_buf = 0;
+ res[i].recordData_len = 0;
+ res[i].recordPosition = 0;
+ }
+ return res;
+}
+
+Z_SRW_record *yaz_srw_get_record(ODR o)
+{
+ return yaz_srw_get_records(o, 1);
+}
+
+static Z_SRW_PDU *yaz_srw_get_core_ver(ODR o, const char *version)
{
Z_SRW_PDU *p = (Z_SRW_PDU *) odr_malloc(o, sizeof(*p));
- p->srw_version = odr_strdup(o, "1.1");
+ p->srw_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 = yaz_srw_get_core_v_1_1(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->which = which;
switch(which)
{
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->record = 0;
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->recordVersions = 0;
+ sr->u.update_request->num_recordVersions = 0;
sr->u.update_request->extra_record = 0;
- sr->u.update_request->extraRequestData = 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:
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->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 = 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;
}
}
/* bib1:srw */
-static int srw_bib1_map[] = {
+static int bib1_srw_map[] = {
1, 1,
2, 2,
3, 11,
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])
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;
if (val)
{
name[*i] = a_name;
- value[*i] = odr_malloc(o, 30);
+ value[*i] = (char *) odr_malloc(o, 30);
sprintf(value[*i], "%d", *val);
(*i)++;
}
}
static int yaz_get_sru_parms(const Z_SRW_PDU *srw_pdu, ODR encode,
- char **name, char **value)
+ char **name, char **value, int max_names)
{
int i = 0;
add_val_str(encode, name, value, &i, "version", srw_pdu->srw_version);
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;
}
char *uri_args;
char *path;
- if (yaz_get_sru_parms(srw_pdu, encode, name, value))
+ 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_ex(&uri_args, encode, name, value, srw_pdu->extra_args);
+ yaz_array_to_uri(&uri_args, encode, name, value);
hreq->method = "GET";
- path = odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 4
- +(srw_pdu->extra_args ? strlen(srw_pdu->extra_args) : 0)
- );
+ path = (char *)
+ odr_malloc(encode, strlen(hreq->path) + strlen(uri_args) + 4);
+
sprintf(path, "%s?%s", hreq->path, uri_args);
hreq->path = path;
char *name[30], *value[30]; /* definite upper limit for SRU params */
char *uri_args;
- if (yaz_get_sru_parms(srw_pdu, encode, name, value))
+ 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_ex(&uri_args, encode, name, value, srw_pdu->extra_args);
+ yaz_array_to_uri(&uri_args, encode, name, value);
hreq->method = "POST";
int yaz_sru_soap_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
ODR odr, const char *charset)
{
- Z_SOAP_Handler handlers[2] = {
+ Z_SOAP_Handler handlers[3] = {
#if YAZ_HAVE_XML2
- {"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},
+ {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);
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
+ * c-file-style: "Stroustrup"
* indent-tabs-mode: nil
* End:
* vim: shiftwidth=4 tabstop=8 expandtab