1 /* This file is part of the YAZ toolkit.
2 * Copyright (C) 1995-2008 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>
44 char *extraRecordData_buf;
45 int extraRecordData_len;
46 char *recordIdentifier;
52 #define Z_SRW_recordPacking_string 0
53 #define Z_SRW_recordPacking_XML 1
54 #define Z_SRW_recordPacking_URL 2
68 #define Z_SRW_query_type_cql 1
69 #define Z_SRW_query_type_xcql 2
70 #define Z_SRW_query_type_pqf 3
78 #define Z_SRW_sort_type_none 1
79 #define Z_SRW_sort_type_sort 2
80 #define Z_SRW_sort_type_xSort 3
95 } Z_SRW_searchRetrieveRequest;
98 int * numberOfRecords;
100 int * resultSetIdleTime;
102 Z_SRW_record *records;
105 Z_SRW_diagnostic *diagnostics;
107 int *nextRecordPosition;
109 Z_SRW_extra_record **extra_records; /* of size num_records */
110 } Z_SRW_searchRetrieveResponse;
116 } Z_SRW_explainRequest;
120 Z_SRW_diagnostic *diagnostics;
122 Z_SRW_extra_record *extra_record;
123 } Z_SRW_explainResponse;
132 int *responsePosition;
140 int *numberOfRecords;
146 Z_SRW_scanTerm *terms;
148 Z_SRW_diagnostic *diagnostics;
150 } Z_SRW_scanResponse;
156 } Z_SRW_recordVersion;
162 Z_SRW_recordVersion *recordVersions;
163 int num_recordVersions;
164 Z_SRW_record *record;
165 Z_SRW_extra_record *extra_record;
166 char *extraRequestData_buf;
167 int extraRequestData_len;
169 } Z_SRW_updateRequest;
171 typedef struct Z_SRW_extra_arg Z_SRW_extra_arg;
172 struct Z_SRW_extra_arg {
175 Z_SRW_extra_arg *next;
179 char *operationStatus;
181 Z_SRW_recordVersion *recordVersions;
182 int num_recordVersions;
183 Z_SRW_record *record;
184 Z_SRW_extra_record *extra_record;
185 char *extraResponseData_buf;
186 int extraResponseData_len;
187 Z_SRW_diagnostic *diagnostics;
189 } Z_SRW_updateResponse;
191 #define Z_SRW_searchRetrieve_request 1
192 #define Z_SRW_searchRetrieve_response 2
193 #define Z_SRW_explain_request 3
194 #define Z_SRW_explain_response 4
195 #define Z_SRW_scan_request 5
196 #define Z_SRW_scan_response 6
197 #define Z_SRW_update_request 7
198 #define Z_SRW_update_response 8
203 Z_SRW_searchRetrieveRequest *request;
204 Z_SRW_searchRetrieveResponse *response;
205 Z_SRW_explainRequest *explain_request;
206 Z_SRW_explainResponse *explain_response;
207 Z_SRW_scanRequest *scan_request;
208 Z_SRW_scanResponse *scan_response;
209 Z_SRW_updateRequest *update_request;
210 Z_SRW_updateResponse *update_response;
213 char *username; /* From HTTP header or request */
214 char *password; /* From HTTP header or request */
215 Z_SRW_extra_arg *extra_args; /* only used for SRU GET/POST */
218 YAZ_EXPORT int yaz_srw_codec(ODR o, void * pptr,
219 Z_SRW_PDU **handler_data,
220 void *client_data, const char *ns);
221 YAZ_EXPORT int yaz_ucp_codec(ODR o, void * pptr,
222 Z_SRW_PDU **handler_data,
223 void *client_data, const char *ns);
224 YAZ_EXPORT Z_SRW_PDU *yaz_srw_get_core_v_1_1(ODR o);
225 YAZ_EXPORT Z_SRW_PDU *yaz_srw_get_pdu(ODR o, int which, const char *version);
226 YAZ_EXPORT Z_SRW_PDU *yaz_srw_get(ODR o, int which);
227 YAZ_EXPORT Z_SRW_recordVersion *yaz_srw_get_record_versions(ODR o, int num);
228 YAZ_EXPORT Z_SRW_extra_record *yaz_srw_get_extra_record(ODR o);
229 YAZ_EXPORT Z_SRW_record *yaz_srw_get_record(ODR o);
230 YAZ_EXPORT Z_SRW_record *yaz_srw_get_records(ODR o, int num);
232 YAZ_EXPORT int yaz_diag_bib1_to_srw (int bib1_code);
234 YAZ_EXPORT int yaz_diag_srw_to_bib1(int srw_code);
236 YAZ_EXPORT const char *yaz_srw_pack_to_str(int pack);
237 YAZ_EXPORT int yaz_srw_str_to_pack(const char *str);
239 YAZ_EXPORT char *yaz_uri_val(const char *path, const char *name, ODR o);
240 YAZ_EXPORT void yaz_uri_val_int(const char *path, const char *name,
242 YAZ_EXPORT int yaz_srw_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
243 Z_SOAP **soap_package, ODR decode, char **charset);
244 YAZ_EXPORT int yaz_sru_decode(Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu,
245 Z_SOAP **soap_package, ODR decode,
247 Z_SRW_diagnostic **, int *num_diagnostic);
249 YAZ_EXPORT void yaz_add_srw_diagnostic(ODR o, Z_SRW_diagnostic **d,
251 const char *addinfo);
253 YAZ_EXPORT void yaz_add_sru_update_diagnostic(ODR o, Z_SRW_diagnostic **d,
255 const char *addinfo);
257 YAZ_EXPORT void yaz_mk_std_diagnostic(ODR o, Z_SRW_diagnostic *d,
258 int code, const char *details);
260 YAZ_EXPORT void yaz_add_srw_diagnostic_uri(ODR o, Z_SRW_diagnostic **d,
261 int *num, const char *uri,
263 const char *details);
265 YAZ_EXPORT void yaz_mk_srw_diagnostic(ODR o, Z_SRW_diagnostic *d,
266 const char *uri, const char *message,
267 const char *details);
269 YAZ_EXPORT int yaz_sru_get_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
270 ODR encode, const char *charset);
271 YAZ_EXPORT int yaz_sru_post_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
272 ODR encode, const char *charset);
273 YAZ_EXPORT int yaz_sru_soap_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu,
274 ODR odr, const char *charset);
276 YAZ_EXPORT char *yaz_negotiate_sru_version(char *input_ver);
279 void yaz_encode_sru_extra(Z_SRW_PDU *sr, ODR odr, const char *extra_args);
282 #define YAZ_XMLNS_SRU_v1_0 "http://www.loc.gov/zing/srw/v1.0/"
283 #define YAZ_XMLNS_SRU_v1_1 "http://www.loc.gov/zing/srw/"
284 #define YAZ_XMLNS_DIAG_v1_1 "http://www.loc.gov/zing/srw/diagnostic/"
285 #define YAZ_XMLNS_UPDATE_v0_9 "http://www.loc.gov/zing/srw/update/"
288 int yaz_srw_check_content_type(Z_HTTP_Response *hres);
291 int sru_decode_surrogate_diagnostics(const char *buf, size_t len,
292 Z_SRW_diagnostic **diag,
296 void yaz_mk_sru_surrogate(ODR o, Z_SRW_record *record, int pos,
297 int code, const char *details);
306 * indent-tabs-mode: nil
308 * vim: shiftwidth=4 tabstop=8 expandtab