/usr/include/yaz/srw.h is in libyaz4-dev 4.2.30-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 | /* This file is part of the YAZ toolkit.
* Copyright (C) 1995-2012 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.
*
* 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
*/
#ifndef YAZ_SRW_H
#define YAZ_SRW_H
#include <yaz/soap.h>
#include <yaz/zgdu.h>
#include <yaz/diagsrw.h>
#include <yaz/diagsru_update.h>
#include "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;
#define Z_SRW_recordPacking_string 0
#define Z_SRW_recordPacking_XML 1
#define Z_SRW_recordPacking_URL 2
char *recordData_buf;
int recordData_len;
Odr_int *recordPosition;
} Z_SRW_record;
typedef struct {
char *uri;
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;
#define Z_SRW_sort_type_none 1
#define Z_SRW_sort_type_sort 2
#define Z_SRW_sort_type_xSort 3
int sort_type;
union {
char *none;
char *sortKeys;
char *xSortKeys;
} sort;
Odr_int *startRecord;
Odr_int *maximumRecords;
char *recordSchema;
char *recordPacking;
char *recordXPath;
char *database;
char *stylesheet;
Odr_int *resultSetTTL;
Z_FacetList *facetList;
} Z_SRW_searchRetrieveRequest;
typedef struct {
Odr_int *numberOfRecords;
char * resultSetId;
Odr_int *resultSetIdleTime;
Z_SRW_record *records;
int num_records;
Z_SRW_diagnostic *diagnostics;
int num_diagnostics;
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 *database;
char *stylesheet;
} Z_SRW_explainRequest;
typedef struct {
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;
Odr_int *responsePosition;
Odr_int *maximumTerms;
char *stylesheet;
char *database;
} Z_SRW_scanRequest;
typedef struct {
char *value;
Odr_int *numberOfRecords;
char *displayTerm;
char *whereInList;
} Z_SRW_scanTerm;
typedef struct {
Z_SRW_scanTerm *terms;
int num_terms;
Z_SRW_diagnostic *diagnostics;
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;
union {
Z_SRW_searchRetrieveRequest *request;
Z_SRW_searchRetrieveResponse *response;
Z_SRW_explainRequest *explain_request;
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_1_1(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 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, 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);
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);
/** \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_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 char *yaz_negotiate_sru_version(char *input_ver);
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/"
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
*/
|