-/*
- * Copyright (c) 2002-2005, Index Data.
- * See the file LICENSE for details.
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2013 Index Data.
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright
+ * notice, this list of conditions and the following disclaimer.
+ * * Redistributions in binary form must reproduce the above copyright
+ * notice, this list of conditions and the following disclaimer in the
+ * documentation and/or other materials provided with the distribution.
+ * * Neither the name of Index Data nor the names of its contributors
+ * may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
*
- * $Id: srw.h,v 1.19 2005-01-09 21:52:48 adam Exp $
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
+
/**
* \file srw.h
* \brief Header for SRW/SRU
#include <yaz/soap.h>
#include <yaz/zgdu.h>
+#include <yaz/diagsrw.h>
+#include <yaz/diagsru_update.h>
+#include <yaz/facet.h>
YAZ_BEGIN_CDECL
typedef struct {
+ char *extraRecordData_buf;
+ int extraRecordData_len;
+ char *recordIdentifier;
+} Z_SRW_extra_record;
+
+typedef struct {
char *recordSchema;
- int recordPacking;
+
+ int recordPacking; /* recordXMLEscaping in SRU 2.0 */
#define Z_SRW_recordPacking_string 0
#define Z_SRW_recordPacking_XML 1
+#define Z_SRW_recordPacking_URL 2
+
char *recordData_buf;
int recordData_len;
- int *recordPosition;
+ Odr_int *recordPosition;
} Z_SRW_record;
typedef struct {
char *details;
char *message;
} Z_SRW_diagnostic;
-
+
typedef struct {
-#define Z_SRW_query_type_cql 1
-#define Z_SRW_query_type_xcql 2
-#define Z_SRW_query_type_pqf 3
- int query_type;
- union {
- char *cql;
- char *xcql;
- char *pqf;
- } query;
+ char *queryType;
+ char *query;
#define Z_SRW_sort_type_none 1
#define Z_SRW_sort_type_sort 2
char *sortKeys;
char *xSortKeys;
} sort;
- int *startRecord;
- int *maximumRecords;
+ Odr_int *startRecord;
+ Odr_int *maximumRecords;
char *recordSchema;
- char *recordPacking;
+
+ char *recordPacking; /* recordXMLEscaping in SRU 2.0 */
+ char *packing; /* recordPacking in SRU 2.0 */
+
char *recordXPath;
char *database;
char *stylesheet;
- int *resultSetTTL;
+ Odr_int *resultSetTTL;
+ Z_FacetList *facetList;
} Z_SRW_searchRetrieveRequest;
typedef struct {
- int * numberOfRecords;
+ Odr_int *numberOfRecords;
+ char *resultCountPrecision;
char * resultSetId;
- int * resultSetIdleTime;
-
+ Odr_int *resultSetIdleTime;
+
Z_SRW_record *records;
int num_records;
Z_SRW_diagnostic *diagnostics;
int num_diagnostics;
- int *nextRecordPosition;
+ Odr_int *nextRecordPosition;
+
+ Z_SRW_extra_record **extra_records; /* of size num_records */
+ Z_FacetList *facetList;
+ char *suggestions;
} Z_SRW_searchRetrieveResponse;
typedef struct {
char *recordPacking;
+ char *packing;
char *database;
char *stylesheet;
} Z_SRW_explainRequest;
Z_SRW_record record;
Z_SRW_diagnostic *diagnostics;
int num_diagnostics;
+ Z_SRW_extra_record *extra_record;
} Z_SRW_explainResponse;
-
+
typedef struct {
- int query_type;
- union {
- char *cql;
- char *xcql;
- char *pqf;
- } scanClause;
- int *responsePosition;
- int *maximumTerms;
+ char *queryType;
+ char *scanClause;
+ Odr_int *responsePosition;
+ Odr_int *maximumTerms;
char *stylesheet;
char *database;
} Z_SRW_scanRequest;
typedef struct {
char *value;
- int *numberOfRecords;
+ Odr_int *numberOfRecords;
char *displayTerm;
char *whereInList;
} Z_SRW_scanTerm;
int num_diagnostics;
} Z_SRW_scanResponse;
+
+typedef struct {
+ char *versionType;
+ char *versionValue;
+} Z_SRW_recordVersion;
+
+typedef struct {
+ char *database;
+ char *operation;
+ char *recordId;
+ Z_SRW_recordVersion *recordVersions;
+ int num_recordVersions;
+ Z_SRW_record *record;
+ Z_SRW_extra_record *extra_record;
+ char *extraRequestData_buf;
+ int extraRequestData_len;
+ char *stylesheet;
+} Z_SRW_updateRequest;
+
+typedef struct Z_SRW_extra_arg Z_SRW_extra_arg;
+struct Z_SRW_extra_arg {
+ char *name;
+ char *value;
+ Z_SRW_extra_arg *next;
+};
+
+typedef struct {
+ char *operationStatus;
+ char *recordId;
+ Z_SRW_recordVersion *recordVersions;
+ int num_recordVersions;
+ Z_SRW_record *record;
+ Z_SRW_extra_record *extra_record;
+ char *extraResponseData_buf;
+ int extraResponseData_len;
+ Z_SRW_diagnostic *diagnostics;
+ int num_diagnostics;
+} Z_SRW_updateResponse;
+
#define Z_SRW_searchRetrieve_request 1
#define Z_SRW_searchRetrieve_response 2
#define Z_SRW_explain_request 3
#define Z_SRW_explain_response 4
#define Z_SRW_scan_request 5
#define Z_SRW_scan_response 6
+#define Z_SRW_update_request 7
+#define Z_SRW_update_response 8
typedef struct {
int which;
Z_SRW_explainResponse *explain_response;
Z_SRW_scanRequest *scan_request;
Z_SRW_scanResponse *scan_response;
+ Z_SRW_updateRequest *update_request;
+ Z_SRW_updateResponse *update_response;
} u;
char *srw_version;
+ char *username; /* From HTTP header or request */
+ char *password; /* From HTTP header or request */
+ Z_SRW_extra_arg *extra_args; /* extraRequestData SRU GET/POST */
+ char *extraResponseData_buf;
+ int extraResponseData_len;
} Z_SRW_PDU;
YAZ_EXPORT int yaz_srw_codec(ODR o, void * pptr,
Z_SRW_PDU **handler_data,
void *client_data, const char *ns);
+YAZ_EXPORT int yaz_ucp_codec(ODR o, void * pptr,
+ Z_SRW_PDU **handler_data,
+ void *client_data, const char *ns);
+YAZ_EXPORT Z_SRW_PDU *yaz_srw_get_core_v_2_0(ODR o);
+YAZ_EXPORT Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version);
YAZ_EXPORT Z_SRW_PDU *yaz_srw_get(ODR o, int which);
-
-YAZ_EXPORT const char *yaz_diag_srw_str (int code);
+YAZ_EXPORT Z_SRW_recordVersion *yaz_srw_get_record_versions(ODR o, int num);
+YAZ_EXPORT Z_SRW_extra_record *yaz_srw_get_extra_record(ODR o);
+YAZ_EXPORT Z_SRW_record *yaz_srw_get_record(ODR o);
+YAZ_EXPORT Z_SRW_record *yaz_srw_get_records(ODR o, int num);
YAZ_EXPORT int yaz_diag_bib1_to_srw (int bib1_code);
YAZ_EXPORT int yaz_diag_srw_to_bib1(int srw_code);
+YAZ_EXPORT const char *yaz_srw_pack_to_str(int pack);
+YAZ_EXPORT int yaz_srw_str_to_pack(const char *str);
+
+/** \brief deprecated */
YAZ_EXPORT char *yaz_uri_val(const char *path, const char *name, ODR o);
+
+/** \brief deprecated */
YAZ_EXPORT void yaz_uri_val_int(const char *path, const char *name,
- ODR o, int **intp);
+ ODR o, Odr_int **intp);
+
+YAZ_EXPORT int yaz_uri_to_array(const char *path, ODR o,
+ char ***name, char ***val);
+YAZ_EXPORT void yaz_array_to_uri(char **path, ODR o,
+ char **name, char **value);
+
+/** \brief encodes URI component
+ \param dst destination string (should be at least 3*strlen(uri)+1)
+ \param uri URI component C-string (source)
+*/
+YAZ_EXPORT void yaz_encode_uri_component(char *dst, const char *uri);
+
+/** \brief decodes URI component
+ \param dst destination string (should be at least strlen(uri)+1)
+ \param uri URI component buffer (source)
+ \param len number of bytes to decode from uri
+*/
+YAZ_EXPORT void yaz_decode_uri_component(char *dst, const char *uri,
+ size_t len);
+
YAZ_EXPORT 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);
+
YAZ_EXPORT int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
- Z_SOAP **soap_package, ODR decode,
- char **charset,
- Z_SRW_diagnostic **, int *num_diagnostic);
+ Z_SOAP **soap_package, ODR decode,
+ char **charset,
+ Z_SRW_diagnostic **, int *num_diagnostic);
+
+/** \brief decode SOLR response (HTTP)
+ \param o ODR for result
+ \param hres HTTP response to be decoded
+ \param pdup SRW response pointer (set if successful)
+ \retval -1 fail
+ \retval 0 OK
+*/
+YAZ_EXPORT int yaz_solr_decode_response(ODR o, Z_HTTP_Response *hres,
+ Z_SRW_PDU **pdup);
+
YAZ_EXPORT void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
- int *num, int code,
- const char *addinfo);
-
-YAZ_EXPORT void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d,
- int code, const char *details);
+ int *num, int code,
+ const char *addinfo);
+
+YAZ_EXPORT void yaz_add_sru_update_diagnostic(ODR o, Z_SRW_diagnostic **d,
+ int *num, int code,
+ const char *addinfo);
+
+YAZ_EXPORT void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d,
+ int code, const char *details);
+
+YAZ_EXPORT void yaz_add_srw_diagnostic_uri(ODR o, Z_SRW_diagnostic **d,
+ int *num, const char *uri,
+ const char *message,
+ const char *details);
+
+YAZ_EXPORT void yaz_mk_srw_diagnostic(ODR o, Z_SRW_diagnostic *d,
+ const char *uri, const char *message,
+ const char *details);
+
+YAZ_EXPORT int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
+ ODR encode, const char *charset);
+YAZ_EXPORT int yaz_sru_post_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
+ ODR encode, const char *charset);
+YAZ_EXPORT int yaz_sru_soap_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
+ ODR odr, const char *charset);
+
+/** \brief encode SOLR request (HTTP)
+ \param hreq HTTP request to be modified (with encoded request)
+ \param srw_pdu SRW request
+ \param encode ODR for result
+ \param charset character set for request (may be NULL)
+ \retval -1 fail
+ \retval 0 OK
+*/
+YAZ_EXPORT int yaz_solr_encode_request(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
+ ODR encode, const char *charset);
+
+YAZ_EXPORT
+void yaz_encode_sru_extra(Z_SRW_PDU *sr, ODR odr, const char *extra_args);
+
+
+#define YAZ_XMLNS_SRU_v1_0 "http://www.loc.gov/zing/srw/v1.0/"
+#define YAZ_XMLNS_SRU_v1_1 "http://www.loc.gov/zing/srw/"
+#define YAZ_XMLNS_DIAG_v1_1 "http://www.loc.gov/zing/srw/diagnostic/"
+#define YAZ_XMLNS_UPDATE_v0_9 "http://www.loc.gov/zing/srw/update/"
+#define YAZ_XMLNS_SRU_v2_mask "http://docs.oasis-open.org/ns/search-ws/*"
+#define YAZ_XMLNS_SRU_v1_response "http://www.loc.gov/*"
+
+YAZ_EXPORT
+int yaz_srw_check_content_type(Z_HTTP_Response *hres);
+
+YAZ_EXPORT
+int sru_decode_surrogate_diagnostics(const char *buf, size_t len,
+ Z_SRW_diagnostic **diag,
+ int *num, ODR odr);
+
+YAZ_EXPORT
+void yaz_mk_sru_surrogate(ODR o, Z_SRW_record *record, int pos,
+ int code, const char *details);
+
+/** \brief encode SRU database for HTTP path
+ \param out memory handle for resulting encoded database string
+ \param db source database
+ \returns encoded database path (includes leading /)
+*/
+YAZ_EXPORT
+char *yaz_encode_sru_dbpath_odr(ODR out, const char *db);
+
+/** \brief encode SRU database for HTTP path
+ \param dst destination buffer (should be at least strlen(db) +2 in size)
+ \param db source database
+
+ The resulting database (dst) includes a leading /
+*/
+YAZ_EXPORT
+void yaz_encode_sru_dbpath_buf(char *dst, const char *db);
+
YAZ_END_CDECL
#endif
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+
projects / yaz-moved-to-github.git / blobdiff