X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=include%2Fyaz%2Fsrw.h;h=981097a76cf6b58807f820c8d0df5b10de2a6c20;hp=f8caeabbca8066bc8bd9f7cb398bb29d7b5a3dde;hb=96e65728eefb6d7efef6e2f74a3b0d64f92b3c23;hpb=6b76baf0fb5d0d437caedd8076f77f372d775758 diff --git a/include/yaz/srw.h b/include/yaz/srw.h index f8caeab..981097a 100644 --- a/include/yaz/srw.h +++ b/include/yaz/srw.h @@ -1,5 +1,5 @@ /* This file is part of the YAZ toolkit. - * Copyright (C) 1995-2009 Index Data. + * Copyright (C) 1995-2010 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: @@ -54,7 +54,7 @@ typedef struct { #define Z_SRW_recordPacking_URL 2 char *recordData_buf; int recordData_len; - odr_int_t *recordPosition; + Odr_int *recordPosition; } Z_SRW_record; typedef struct { @@ -84,27 +84,27 @@ typedef struct { char *sortKeys; char *xSortKeys; } sort; - odr_int_t *startRecord; - odr_int_t *maximumRecords; + Odr_int *startRecord; + Odr_int *maximumRecords; char *recordSchema; char *recordPacking; char *recordXPath; char *database; char *stylesheet; - odr_int_t *resultSetTTL; + Odr_int *resultSetTTL; } Z_SRW_searchRetrieveRequest; typedef struct { - odr_int_t *numberOfRecords; + Odr_int *numberOfRecords; char * resultSetId; - odr_int_t *resultSetIdleTime; + Odr_int *resultSetIdleTime; Z_SRW_record *records; int num_records; Z_SRW_diagnostic *diagnostics; int num_diagnostics; - odr_int_t *nextRecordPosition; + Odr_int *nextRecordPosition; Z_SRW_extra_record **extra_records; /* of size num_records */ } Z_SRW_searchRetrieveResponse; @@ -129,15 +129,15 @@ typedef struct { char *xcql; char *pqf; } scanClause; - odr_int_t *responsePosition; - odr_int_t *maximumTerms; + Odr_int *responsePosition; + Odr_int *maximumTerms; char *stylesheet; char *database; } Z_SRW_scanRequest; typedef struct { char *value; - odr_int_t *numberOfRecords; + Odr_int *numberOfRecords; char *displayTerm; char *whereInList; } Z_SRW_scanTerm; @@ -212,7 +212,9 @@ typedef struct { char *srw_version; char *username; /* From HTTP header or request */ char *password; /* From HTTP header or request */ - Z_SRW_extra_arg *extra_args; /* only used for SRU GET/POST */ + 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, @@ -236,16 +238,51 @@ 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_t **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); + 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); @@ -272,6 +309,8 @@ 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); +YAZ_EXPORT int yaz_solr_encode(Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu, + ODR encode, const char *charset); YAZ_EXPORT char *yaz_negotiate_sru_version(char *input_ver); @@ -295,7 +334,23 @@ int sru_decode_surrogate_diagnostics(const char *buf, size_t len, 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