1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2012 Index Data.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of Index Data nor the names of its contributors
13 * may be used to endorse or promote products derived from this
14 * software without specific prior written permission.
16 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 * \brief Header for SRW/SRU
38 #include <yaz/diagsrw.h>
39 #include <yaz/diagsru_update.h>
45 char *extraRecordData_buf;
46 int extraRecordData_len;
47 char *recordIdentifier;
53 #define Z_SRW_recordPacking_string 0
54 #define Z_SRW_recordPacking_XML 1
55 #define Z_SRW_recordPacking_URL 2
58 Odr_int *recordPosition;
69 #define Z_SRW_query_type_cql 1
70 #define Z_SRW_query_type_xcql 2
71 #define Z_SRW_query_type_pqf 3
79 #define Z_SRW_sort_type_none 1
80 #define Z_SRW_sort_type_sort 2
81 #define Z_SRW_sort_type_xSort 3
89 Odr_int *maximumRecords;
95 Odr_int *resultSetTTL;
96 Z_FacetList *facetList;
97 } Z_SRW_searchRetrieveRequest;
100 Odr_int *numberOfRecords;
102 Odr_int *resultSetIdleTime;
104 Z_SRW_record *records;
107 Z_SRW_diagnostic *diagnostics;
109 Odr_int *nextRecordPosition;
111 Z_SRW_extra_record **extra_records; /* of size num_records */
112 Z_FacetList *facetList;
114 } Z_SRW_searchRetrieveResponse;
120 } Z_SRW_explainRequest;
124 Z_SRW_diagnostic *diagnostics;
126 Z_SRW_extra_record *extra_record;
127 } Z_SRW_explainResponse;
136 Odr_int *responsePosition;
137 Odr_int *maximumTerms;
144 Odr_int *numberOfRecords;
150 Z_SRW_scanTerm *terms;
152 Z_SRW_diagnostic *diagnostics;
154 } Z_SRW_scanResponse;
160 } Z_SRW_recordVersion;
166 Z_SRW_recordVersion *recordVersions;
167 int num_recordVersions;
168 Z_SRW_record *record;
169 Z_SRW_extra_record *extra_record;
170 char *extraRequestData_buf;
171 int extraRequestData_len;
173 } Z_SRW_updateRequest;
175 typedef struct Z_SRW_extra_arg Z_SRW_extra_arg;
176 struct Z_SRW_extra_arg {
179 Z_SRW_extra_arg *next;
183 char *operationStatus;
185 Z_SRW_recordVersion *recordVersions;
186 int num_recordVersions;
187 Z_SRW_record *record;
188 Z_SRW_extra_record *extra_record;
189 char *extraResponseData_buf;
190 int extraResponseData_len;
191 Z_SRW_diagnostic *diagnostics;
193 } Z_SRW_updateResponse;
195 #define Z_SRW_searchRetrieve_request 1
196 #define Z_SRW_searchRetrieve_response 2
197 #define Z_SRW_explain_request 3
198 #define Z_SRW_explain_response 4
199 #define Z_SRW_scan_request 5
200 #define Z_SRW_scan_response 6
201 #define Z_SRW_update_request 7
202 #define Z_SRW_update_response 8
207 Z_SRW_searchRetrieveRequest *request;
208 Z_SRW_searchRetrieveResponse *response;
209 Z_SRW_explainRequest *explain_request;
210 Z_SRW_explainResponse *explain_response;
211 Z_SRW_scanRequest *scan_request;
212 Z_SRW_scanResponse *scan_response;
213 Z_SRW_updateRequest *update_request;
214 Z_SRW_updateResponse *update_response;
217 char *username; /* From HTTP header or request */
218 char *password; /* From HTTP header or request */
219 Z_SRW_extra_arg *extra_args; /* extraRequestData SRU GET/POST */
220 char *extraResponseData_buf;
221 int extraResponseData_len;
224 YAZ_EXPORT int yaz_srw_codec(ODR o, void * pptr,
225 Z_SRW_PDU **handler_data,
226 void *client_data, const char *ns);
227 YAZ_EXPORT int yaz_ucp_codec(ODR o, void * pptr,
228 Z_SRW_PDU **handler_data,
229 void *client_data, const char *ns);
230 YAZ_EXPORT Z_SRW_PDU *yaz_srw_get_core_v_1_1(ODR o);
231 YAZ_EXPORT Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version);
232 YAZ_EXPORT Z_SRW_PDU *yaz_srw_get(ODR o, int which);
233 YAZ_EXPORT Z_SRW_recordVersion *yaz_srw_get_record_versions(ODR o, int num);
234 YAZ_EXPORT Z_SRW_extra_record *yaz_srw_get_extra_record(ODR o);
235 YAZ_EXPORT Z_SRW_record *yaz_srw_get_record(ODR o);
236 YAZ_EXPORT Z_SRW_record *yaz_srw_get_records(ODR o, int num);
238 YAZ_EXPORT int yaz_diag_bib1_to_srw (int bib1_code);
240 YAZ_EXPORT int yaz_diag_srw_to_bib1(int srw_code);
242 YAZ_EXPORT const char *yaz_srw_pack_to_str(int pack);
243 YAZ_EXPORT int yaz_srw_str_to_pack(const char *str);
245 /** \brief deprecated */
246 YAZ_EXPORT char *yaz_uri_val(const char *path, const char *name, ODR o);
248 /** \brief deprecated */
249 YAZ_EXPORT void yaz_uri_val_int(const char *path, const char *name,
250 ODR o, Odr_int **intp);
252 YAZ_EXPORT int yaz_uri_to_array(const char *path, ODR o,
253 char ***name, char ***val);
254 YAZ_EXPORT void yaz_array_to_uri(char **path, ODR o,
255 char **name, char **value);
257 /** \brief encodes URI component
258 \param dst destination string (should be at least 3*strlen(uri)+1)
259 \param uri URI component C-string (source)
261 YAZ_EXPORT void yaz_encode_uri_component(char *dst, const char *uri);
263 /** \brief decodes URI component
264 \param dst destination string (should be at least strlen(uri)+1)
265 \param uri URI component buffer (source)
266 \param len number of bytes to decode from uri
268 YAZ_EXPORT void yaz_decode_uri_component(char *dst, const char *uri,
271 YAZ_EXPORT int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
272 Z_SOAP **soap_package, ODR decode, char **charset);
274 YAZ_EXPORT int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
275 Z_SOAP **soap_package, ODR decode,
277 Z_SRW_diagnostic **, int *num_diagnostic);
279 /** \brief decode SOLR response (HTTP)
280 \param o ODR for result
281 \param hres HTTP response to be decoded
282 \param pdup SRW response pointer (set if successful)
286 YAZ_EXPORT int yaz_solr_decode_response(ODR o, Z_HTTP_Response *hres,
290 YAZ_EXPORT void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
292 const char *addinfo);
294 YAZ_EXPORT void yaz_add_sru_update_diagnostic(ODR o, Z_SRW_diagnostic **d,
296 const char *addinfo);
298 YAZ_EXPORT void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d,
299 int code, const char *details);
301 YAZ_EXPORT void yaz_add_srw_diagnostic_uri(ODR o, Z_SRW_diagnostic **d,
302 int *num, const char *uri,
304 const char *details);
306 YAZ_EXPORT void yaz_mk_srw_diagnostic(ODR o, Z_SRW_diagnostic *d,
307 const char *uri, const char *message,
308 const char *details);
310 YAZ_EXPORT int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
311 ODR encode, const char *charset);
312 YAZ_EXPORT int yaz_sru_post_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
313 ODR encode, const char *charset);
314 YAZ_EXPORT int yaz_sru_soap_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
315 ODR odr, const char *charset);
317 /** \brief encode SOLR request (HTTP)
318 \param hreq HTTP request to be modified (with encoded request)
319 \param srw_pdu SRW request
320 \param encode ODR for result
321 \param charset character set for request (may be NULL)
325 YAZ_EXPORT int yaz_solr_encode_request(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
326 ODR encode, const char *charset);
328 YAZ_EXPORT char *yaz_negotiate_sru_version(char *input_ver);
331 void yaz_encode_sru_extra(Z_SRW_PDU *sr, ODR odr, const char *extra_args);
334 #define YAZ_XMLNS_SRU_v1_0 "http://www.loc.gov/zing/srw/v1.0/"
335 #define YAZ_XMLNS_SRU_v1_1 "http://www.loc.gov/zing/srw/"
336 #define YAZ_XMLNS_DIAG_v1_1 "http://www.loc.gov/zing/srw/diagnostic/"
337 #define YAZ_XMLNS_UPDATE_v0_9 "http://www.loc.gov/zing/srw/update/"
338 #define YAZ_XMLNS_SRU_v2_response "http://docs.oasis-open.org/ns/search-ws/sru*esponse"
341 int yaz_srw_check_content_type(Z_HTTP_Response *hres);
344 int sru_decode_surrogate_diagnostics(const char *buf, size_t len,
345 Z_SRW_diagnostic **diag,
349 void yaz_mk_sru_surrogate(ODR o, Z_SRW_record *record, int pos,
350 int code, const char *details);
352 /** \brief encode SRU database for HTTP path
353 \param out memory handle for resulting encoded database string
354 \param db source database
355 \returns encoded database path (includes leading /)
358 char *yaz_encode_sru_dbpath_odr(ODR out, const char *db);
360 /** \brief encode SRU database for HTTP path
361 \param dst destination buffer (should be at least strlen(db) +2 in size)
362 \param db source database
364 The resulting database (dst) includes a leading /
367 void yaz_encode_sru_dbpath_buf(char *dst, const char *db);
375 * c-file-style: "Stroustrup"
376 * indent-tabs-mode: nil
378 * vim: shiftwidth=4 tabstop=8 expandtab