srw.h File Reference

Header for SRW/SRU. More...

#include <yaz/soap.h>
#include <yaz/zgdu.h>
#include <yaz/diagsrw.h>
#include <yaz/diagsru_update.h>
#include "facet.h"

Go to the source code of this file.

Data Structures
struct	Z_SRW_extra_record
struct	Z_SRW_record
struct	Z_SRW_diagnostic
struct	Z_SRW_searchRetrieveRequest
struct	Z_SRW_searchRetrieveResponse
struct	Z_SRW_explainRequest
struct	Z_SRW_explainResponse
struct	Z_SRW_scanRequest
struct	Z_SRW_scanTerm
struct	Z_SRW_scanResponse
struct	Z_SRW_recordVersion
struct	Z_SRW_updateRequest
struct	Z_SRW_extra_arg
struct	Z_SRW_updateResponse
struct	Z_SRW_PDU

Macros
#define	Z_SRW_recordPacking_string   0
#define	Z_SRW_recordPacking_XML   1
#define	Z_SRW_recordPacking_URL   2
#define	Z_SRW_query_type_cql   1
#define	Z_SRW_query_type_xcql   2
#define	Z_SRW_query_type_pqf   3
#define	Z_SRW_sort_type_none   1
#define	Z_SRW_sort_type_sort   2
#define	Z_SRW_sort_type_xSort   3
#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
#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_response   "http://docs.oasis-open.org/ns/search-ws/sru*esponse"
#define	YAZ_XMLNS_SRU_v1_response   "http://www.loc.gov/*"

Typedefs
typedef struct Z_SRW_extra_arg	Z_SRW_extra_arg

Functions
int	yaz_srw_codec (ODR o, void *pptr, Z_SRW_PDU **handler_data, void *client_data, const char *ns)
int	yaz_ucp_codec (ODR o, void *pptr, Z_SRW_PDU **handler_data, void *client_data, const char *ns)
Z_SRW_PDU *	yaz_srw_get_core_v_1_1 (ODR o)
Z_SRW_PDU *	yaz_srw_get_pdu (ODR o, int which, const char *version)
Z_SRW_PDU *	yaz_srw_get (ODR o, int which)
Z_SRW_recordVersion *	yaz_srw_get_record_versions (ODR o, int num)
Z_SRW_extra_record *	yaz_srw_get_extra_record (ODR o)
Z_SRW_record *	yaz_srw_get_record (ODR o)
Z_SRW_record *	yaz_srw_get_records (ODR o, int num)
int	yaz_diag_bib1_to_srw (int bib1_code)
int	yaz_diag_srw_to_bib1 (int srw_code)
const char *	yaz_srw_pack_to_str (int pack)
int	yaz_srw_str_to_pack (const char *str)
char *	yaz_uri_val (const char *path, const char *name, ODR o)
	deprecated
void	yaz_uri_val_int (const char *path, const char *name, ODR o, Odr_int **intp)
	deprecated
int	yaz_uri_to_array (const char *path, ODR o, char ***name, char ***val)
void	yaz_array_to_uri (char **path, ODR o, char **name, char **value)
void	yaz_encode_uri_component (char *dst, const char *uri)
	encodes URI component
void	yaz_decode_uri_component (char *dst, const char *uri, size_t len)
	decodes URI component
int	yaz_srw_decode (Z_HTTP_Request *hreq, Z_SRW_PDU **srw_pdu, Z_SOAP **soap_package, ODR decode, char **charset)
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)
int	yaz_solr_decode_response (ODR o, Z_HTTP_Response *hres, Z_SRW_PDU **pdup)
	decode SOLR response (HTTP)
void	yaz_add_srw_diagnostic (ODR o, Z_SRW_diagnostic **d, int *num, int code, const char *addinfo)
void	yaz_add_sru_update_diagnostic (ODR o, Z_SRW_diagnostic **d, int *num, int code, const char *addinfo)
void	yaz_mk_std_diagnostic (ODR o, Z_SRW_diagnostic *d, int code, const char *details)
void	yaz_add_srw_diagnostic_uri (ODR o, Z_SRW_diagnostic **d, int *num, const char *uri, const char *message, const char *details)
void	yaz_mk_srw_diagnostic (ODR o, Z_SRW_diagnostic *d, const char *uri, const char *message, const char *details)
int	yaz_sru_get_encode (Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu, ODR encode, const char *charset)
int	yaz_sru_post_encode (Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu, ODR encode, const char *charset)
int	yaz_sru_soap_encode (Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu, ODR odr, const char *charset)
int	yaz_solr_encode_request (Z_HTTP_Request *hreq, Z_SRW_PDU *srw_pdu, ODR encode, const char *charset)
	encode SOLR request (HTTP)
char *	yaz_negotiate_sru_version (char *input_ver)
void	yaz_encode_sru_extra (Z_SRW_PDU *sr, ODR odr, const char *extra_args)
int	yaz_srw_check_content_type (Z_HTTP_Response *hres)
int	sru_decode_surrogate_diagnostics (const char *buf, size_t len, Z_SRW_diagnostic **diag, int *num, ODR odr)
void	yaz_mk_sru_surrogate (ODR o, Z_SRW_record *record, int pos, int code, const char *details)
char *	yaz_encode_sru_dbpath_odr (ODR out, const char *db)
	encode SRU database for HTTP path
void	yaz_encode_sru_dbpath_buf (char *dst, const char *db)
	encode SRU database for HTTP path

Detailed Description

Header for SRW/SRU.

Definition in file srw.h.

Macro Definition Documentation

#define YAZ_XMLNS_DIAG_v1_1   "http://www.loc.gov/zing/srw/diagnostic/"

Definition at line 336 of file srw.h.

Referenced by yaz_srw_diagnostics(), and yaz_ucp_codec().

#define YAZ_XMLNS_SRU_v1_0   "http://www.loc.gov/zing/srw/v1.0/"

Definition at line 334 of file srw.h.

Referenced by process_http_request(), and yaz_srw_decode().

#define YAZ_XMLNS_SRU_v1_1   "http://www.loc.gov/zing/srw/"

Definition at line 335 of file srw.h.

Referenced by process_http_request(), yaz_sru_decode(), yaz_sru_soap_encode(), yaz_srw_decode(), and yaz_ucp_codec().

#define YAZ_XMLNS_SRU_v1_response   "http://www.loc.gov/*"

Definition at line 339 of file srw.h.

Referenced by ZOOM_handle_sru().

#define YAZ_XMLNS_SRU_v2_response   "http://docs.oasis-open.org/ns/search-ws/sru*esponse"

Definition at line 338 of file srw.h.

Referenced by ZOOM_handle_sru().

#define YAZ_XMLNS_UPDATE_v0_9   "http://www.loc.gov/zing/srw/update/"

Definition at line 337 of file srw.h.

Referenced by process_http_request(), yaz_sru_soap_encode(), and yaz_srw_decode().

#define Z_SRW_explain_request   3

Definition at line 197 of file srw.h.

Referenced by process_http_request(), yaz_get_sru_parms(), yaz_sru_decode(), yaz_srw_codec(), yaz_srw_decode(), and yaz_srw_get_pdu().

#define Z_SRW_explain_response   4

Definition at line 198 of file srw.h.

Referenced by process_http_request(), yaz_srw_codec(), and yaz_srw_get_pdu().

#define Z_SRW_query_type_cql   1

Definition at line 69 of file srw.h.

Referenced by srw_bend_scan(), srw_bend_search(), yaz_get_sru_parms(), yaz_solr_encode_request(), yaz_sru_decode(), yaz_srw_codec(), yaz_srw_get_pdu(), ZOOM_connection_srw_send_scan(), and ZOOM_connection_srw_send_search().

#define Z_SRW_query_type_pqf   3

Definition at line 71 of file srw.h.

Referenced by srw_bend_scan(), srw_bend_search(), yaz_get_sru_parms(), yaz_solr_encode_request(), yaz_sru_decode(), yaz_srw_codec(), ZOOM_connection_srw_send_scan(), and ZOOM_connection_srw_send_search().

#define Z_SRW_query_type_xcql   2

Definition at line 70 of file srw.h.

Referenced by yaz_get_sru_parms(), and yaz_srw_codec().

#define Z_SRW_recordPacking_string   0

Definition at line 53 of file srw.h.

Referenced by srw_bend_explain(), srw_bend_search(), srw_bend_update(), yaz_srw_get_pdu(), yaz_srw_get_records(), yaz_srw_pack_to_str(), yaz_srw_record(), and yaz_srw_str_to_pack().

#define Z_SRW_recordPacking_URL   2

Definition at line 55 of file srw.h.

Referenced by yaz_srw_pack_to_str(), yaz_srw_record(), and yaz_srw_str_to_pack().

#define Z_SRW_recordPacking_XML   1

Definition at line 54 of file srw.h.

Referenced by yaz_solr_decode_result_docs(), yaz_srw_pack_to_str(), yaz_srw_record(), and yaz_srw_str_to_pack().

#define Z_SRW_scan_request   5

Definition at line 199 of file srw.h.

Referenced by process_http_request(), yaz_get_sru_parms(), yaz_solr_encode_request(), yaz_sru_decode(), yaz_srw_codec(), yaz_srw_decode(), yaz_srw_get_pdu(), and ZOOM_connection_srw_send_scan().

#define Z_SRW_scan_response   6

Definition at line 200 of file srw.h.

Referenced by process_http_request(), yaz_solr_decode_response(), yaz_srw_codec(), yaz_srw_get_pdu(), and ZOOM_handle_sru().

#define Z_SRW_searchRetrieve_request   1

Definition at line 195 of file srw.h.

Referenced by process_http_request(), yaz_get_sru_parms(), yaz_solr_encode_request(), yaz_sru_decode(), yaz_srw_codec(), yaz_srw_decode(), yaz_srw_get_pdu(), and ZOOM_connection_srw_send_search().

#define Z_SRW_searchRetrieve_response   2

Definition at line 196 of file srw.h.

Referenced by process_http_request(), yaz_solr_decode_response(), yaz_srw_codec(), yaz_srw_get_pdu(), and ZOOM_handle_sru().

#define Z_SRW_sort_type_none   1

Definition at line 79 of file srw.h.

Referenced by yaz_get_sru_parms(), yaz_solr_encode_request(), yaz_srw_codec(), and yaz_srw_get_pdu().

#define Z_SRW_sort_type_sort   2

Definition at line 80 of file srw.h.

Referenced by yaz_get_sru_parms(), yaz_solr_encode_request(), yaz_sru_decode(), yaz_srw_codec(), and ZOOM_connection_srw_send_search().

#define Z_SRW_sort_type_xSort   3

Definition at line 81 of file srw.h.

Referenced by yaz_srw_codec().

#define Z_SRW_update_request   7

Definition at line 201 of file srw.h.

Referenced by process_http_request(), yaz_get_sru_parms(), yaz_sru_soap_encode(), yaz_srw_decode(), yaz_srw_get_pdu(), and yaz_ucp_codec().

#define Z_SRW_update_response   8

Definition at line 202 of file srw.h.

Referenced by process_http_request(), yaz_sru_soap_encode(), yaz_srw_get_pdu(), and yaz_ucp_codec().

Typedef Documentation

typedef struct Z_SRW_extra_arg Z_SRW_extra_arg

Definition at line 175 of file srw.h.

Function Documentation

int sru_decode_surrogate_diagnostics	(	const char *	buf,
		size_t	len,
		Z_SRW_diagnostic **	diag,
		int *	num,
		ODR	odr
	)

Definition at line 591 of file srw.c.

References yaz_srw_decode_diagnostics().

Referenced by handle_srw_response().

void yaz_add_sru_update_diagnostic	(	ODR	o,
		Z_SRW_diagnostic **	d,
		int *	num,
		int	code,
		const char *	addinfo
	)

Definition at line 199 of file srwutil.c.

References yaz_add_srw_diagnostic_uri().

Referenced by srw_bend_update().

void yaz_add_srw_diagnostic	(	ODR	o,
		Z_SRW_diagnostic **	d,
		int *	num,
		int	code,
		const char *	addinfo
	)

Definition at line 189 of file srwutil.c.

References yaz_add_srw_diagnostic_uri().

Referenced by srw_bend_init(), srw_bend_scan(), srw_bend_search(), yaz_sru_decode(), and yaz_sru_decode_integer().

void yaz_add_srw_diagnostic_uri	(	ODR	o,
		Z_SRW_diagnostic **	d,
		int *	num,
		const char *	uri,
		const char *	message,
		const char *	details
	)

Definition at line 175 of file srwutil.c.

References odr_malloc(), and yaz_mk_srw_diagnostic().

Referenced by srw_bend_update(), yaz_add_sru_update_diagnostic(), and yaz_add_srw_diagnostic().

void yaz_array_to_uri	(	char **	path,
		ODR	o,
		char **	name,
		char **	value
	)

Definition at line 98 of file uri.c.

References odr_malloc(), and yaz_encode_uri_component().

Referenced by yaz_solr_encode_request(), yaz_sru_get_encode(), and yaz_sru_post_encode().

void yaz_decode_uri_component	(	char *	dst,
		const char *	uri,
		size_t	len
	)

decodes URI component

Parameters

dst	destination string (should be at least strlen(uri)+1)
uri	URI component buffer (source)
len	number of bytes to decode from uri

Definition at line 86 of file uri.c.

References decode_uri_char().

int yaz_diag_bib1_to_srw

(

int

bib1_code

)

Definition at line 203 of file diag_map.c.

References bib1_srw_map.

Referenced by srw_bend_fetch(), srw_bend_init(), srw_bend_scan(), and srw_bend_search().

int yaz_diag_srw_to_bib1

(

int

srw_code

)

Definition at line 215 of file diag_map.c.

References bib1_srw_map, and srw_bib1_map.

Referenced by process_searchRequest().

void yaz_encode_sru_dbpath_buf	(	char *	dst,
		const char *	db
	)

encode SRU database for HTTP path

Parameters

dst	destination buffer (should be at least strlen(db) +2 in size)
db	source database

The resulting database (dst) includes a leading /

Definition at line 28 of file srwutil.c.

Referenced by yaz_encode_sru_dbpath_odr().

char* yaz_encode_sru_dbpath_odr	(	ODR	out,
		const char *	db
	)

encode SRU database for HTTP path

Parameters

out	memory handle for resulting encoded database string
db	source database

Returns

encoded database path (includes leading /)

Definition at line 35 of file srwutil.c.

References odr_malloc(), and yaz_encode_sru_dbpath_buf().

void yaz_encode_sru_extra	(	Z_SRW_PDU *	sr,
		ODR	odr,
		const char *	extra_args
	)

Definition at line 1094 of file srwutil.c.

References Z_SRW_PDU::extra_args, name, Z_SRW_extra_arg::next, odr_malloc(), and yaz_uri_to_array().

Referenced by ZOOM_connection_srw_send_scan(), and ZOOM_connection_srw_send_search().

void yaz_encode_uri_component	(	char *	dst,
		const char *	uri
	)

encodes URI component

Parameters

dst	destination string (should be at least 3*strlen(uri)+1)
uri	URI component C-string (source)

Definition at line 45 of file uri.c.

References encode_uri_char().

Referenced by yaz_array_to_uri().

void yaz_mk_sru_surrogate	(	ODR	o,
		Z_SRW_record *	record,
		int	pos,
		int	code,
		const char *	details
	)

Definition at line 209 of file srwutil.c.

References odr_intdup(), odr_malloc(), Z_SRW_record::recordData_buf, Z_SRW_record::recordData_len, Z_SRW_record::recordPosition, Z_SRW_record::recordSchema, and yaz_diag_srw_str().

Referenced by srw_bend_fetch().

void yaz_mk_srw_diagnostic	(	ODR	o,
		Z_SRW_diagnostic *	d,
		const char *	uri,
		const char *	message,
		const char *	details
	)

Definition at line 151 of file srwutil.c.

References Z_SRW_diagnostic::details, Z_SRW_diagnostic::message, odr_strdup(), and Z_SRW_diagnostic::uri.

Referenced by yaz_add_srw_diagnostic_uri(), and yaz_mk_std_diagnostic().

void yaz_mk_std_diagnostic	(	ODR	o,
		Z_SRW_diagnostic *	d,
		int	code,
		const char *	details
	)

Definition at line 166 of file srwutil.c.

References yaz_mk_srw_diagnostic().

char* yaz_negotiate_sru_version

(

char *

input_ver

)

Definition at line 220 of file srw.c.

Referenced by yaz_sru_decode(), and yaz_srw_codec().

int yaz_solr_decode_response	(	ODR	o,
		Z_HTTP_Response *	hres,
		Z_SRW_PDU **	pdup
	)

decode SOLR response (HTTP)

Parameters

o	ODR for result
hres	HTTP response to be decoded
pdup	SRW response pointer (set if successful)

Return values

-1	fail
0	OK

look for result (required) and facets node (optional)

Definition at line 321 of file solr.c.

References Z_HTTP_Response::content_buf, Z_HTTP_Response::content_len, match_xml_node_attribute(), Z_SRW_searchRetrieveResponse::numberOfRecords, Z_SRW_PDU::response, Z_SRW_PDU::scan_response, Z_SRW_PDU::u, yaz_solr_decode_facet_counts(), yaz_solr_decode_result(), yaz_solr_decode_scan_result(), yaz_solr_decode_spellcheck(), yaz_srw_get(), Z_SRW_scan_response, and Z_SRW_searchRetrieve_response.

Referenced by ZOOM_handle_sru().

int yaz_solr_encode_request	(	Z_HTTP_Request *	hreq,
		Z_SRW_PDU *	srw_pdu,
		ODR	encode,
		const char *	charset
	)

encode SOLR request (HTTP)

Parameters

hreq	HTTP request to be modified (with encoded request)
srw_pdu	SRW request
encode	ODR for result
charset	character set for request (may be NULL)

Return values

-1	fail
0	OK

Definition at line 445 of file solr.c.

References Z_SRW_searchRetrieveRequest::cql, Z_SRW_scanRequest::cql, Z_SRW_PDU::extra_args, Z_SRW_searchRetrieveRequest::facetList, Z_HTTP_Request::headers, Z_SRW_searchRetrieveRequest::maximumRecords, Z_SRW_scanRequest::maximumTerms, Z_HTTP_Request::method, name, Z_SRW_extra_arg::name, Z_SRW_extra_arg::next, odr_malloc(), odr_strdup(), Z_SRW_PDU::password, Z_HTTP_Request::path, Z_SRW_searchRetrieveRequest::pqf, Z_SRW_scanRequest::pqf, Z_SRW_searchRetrieveRequest::query, Z_SRW_searchRetrieveRequest::query_type, Z_SRW_scanRequest::query_type, Z_SRW_searchRetrieveRequest::recordSchema, Z_SRW_PDU::request, Z_SRW_PDU::scan_request, Z_SRW_scanRequest::scanClause, SOLR_MAX_PARAMETERS, Z_SRW_searchRetrieveRequest::sort, Z_SRW_searchRetrieveRequest::sort_type, Z_SRW_searchRetrieveRequest::sortKeys, Z_SRW_searchRetrieveRequest::startRecord, Z_SRW_PDU::u, Z_SRW_PDU::username, Z_SRW_extra_arg::value, Z_SRW_PDU::which, yaz_add_name_value_int(), yaz_add_name_value_str(), yaz_array_to_uri(), yaz_solr_encode_facet_list(), z_HTTP_header_add_basic_auth(), z_HTTP_header_add_content_type(), Z_SRW_query_type_cql, Z_SRW_query_type_pqf, Z_SRW_scan_request, Z_SRW_searchRetrieve_request, Z_SRW_sort_type_none, and Z_SRW_sort_type_sort.

Referenced by send_srw().

int yaz_sru_decode	(	Z_HTTP_Request *	hreq,
		Z_SRW_PDU **	srw_pdu,
		Z_SOAP **	soap_package,
		ODR	decode,
		char **	charset,
		Z_SRW_diagnostic **	diag,
		int *	num_diag
	)

http://www.loc.gov/z3950/agency/zing/srw/service.html

Definition at line 351 of file srwutil.c.

References Z_HTTP_Request::content_buf, Z_SRW_searchRetrieveRequest::cql, Z_SRW_scanRequest::cql, Z_SRW_searchRetrieveRequest::database, Z_SRW_explainRequest::database, Z_SRW_scanRequest::database, Z_SRW_PDU::explain_request, Z_SRW_PDU::extra_args, grab_charset(), Z_HTTP_Request::headers, Z_SRW_searchRetrieveRequest::maximumRecords, Z_SRW_scanRequest::maximumTerms, Z_HTTP_Request::method, Z_SRW_extra_arg::next, Z_SOAP_Handler::ns, odr_malloc(), odr_strdup(), Z_HTTP_Request::path, Z_SRW_searchRetrieveRequest::pqf, Z_SRW_scanRequest::pqf, Z_SRW_searchRetrieveRequest::query, Z_SRW_searchRetrieveRequest::query_type, Z_SRW_scanRequest::query_type, Z_SRW_searchRetrieveRequest::recordPacking, Z_SRW_explainRequest::recordPacking, Z_SRW_searchRetrieveRequest::recordSchema, Z_SRW_searchRetrieveRequest::recordXPath, Z_SRW_PDU::request, Z_SRW_scanRequest::responsePosition, Z_SRW_PDU::scan_request, Z_SRW_scanRequest::scanClause, Z_SRW_searchRetrieveRequest::sort, Z_SRW_searchRetrieveRequest::sort_type, Z_SRW_searchRetrieveRequest::sortKeys, Z_SRW_PDU::srw_version, Z_SRW_searchRetrieveRequest::startRecord, Z_SRW_searchRetrieveRequest::stylesheet, Z_SRW_explainRequest::stylesheet, Z_SRW_scanRequest::stylesheet, Z_SRW_PDU::u, yaz_add_srw_diagnostic(), yaz_decode_sru_dbpath_odr(), yaz_negotiate_sru_version(), yaz_sru_decode_integer(), yaz_srw_codec(), yaz_srw_decodeauth(), yaz_srw_get(), YAZ_SRW_MANDATORY_PARAMETER_NOT_SUPPLIED, YAZ_SRW_UNSUPP_OPERATION, YAZ_SRW_UNSUPP_PARAMETER, YAZ_SRW_UNSUPP_VERSION, yaz_strcmp_del(), yaz_uri_to_array(), YAZ_XMLNS_SRU_v1_1, z_HTTP_header_lookup(), Z_SOAP_generic, Z_SRW_explain_request, Z_SRW_query_type_cql, Z_SRW_query_type_pqf, Z_SRW_scan_request, Z_SRW_searchRetrieve_request, and Z_SRW_sort_type_sort.

Referenced by process_http_request().

int yaz_sru_get_encode	(	Z_HTTP_Request *	hreq,
		Z_SRW_PDU *	srw_pdu,
		ODR	encode,
		const char *	charset
	)

Definition at line 967 of file srwutil.c.

References Z_HTTP_Request::headers, MAX_SRU_PARAMETERS, Z_HTTP_Request::method, name, odr_malloc(), Z_SRW_PDU::password, Z_HTTP_Request::path, Z_SRW_PDU::username, yaz_array_to_uri(), yaz_get_sru_parms(), yaz_log(), YLOG_DEBUG, z_HTTP_header_add_basic_auth(), and z_HTTP_header_add_content_type().

Referenced by send_srw().

int yaz_sru_post_encode	(	Z_HTTP_Request *	hreq,
		Z_SRW_PDU *	srw_pdu,
		ODR	encode,
		const char *	charset
	)

Definition at line 994 of file srwutil.c.

References Z_HTTP_Request::content_buf, Z_HTTP_Request::content_len, Z_HTTP_Request::headers, MAX_SRU_PARAMETERS, Z_HTTP_Request::method, name, Z_SRW_PDU::password, Z_SRW_PDU::username, yaz_array_to_uri(), yaz_get_sru_parms(), z_HTTP_header_add_basic_auth(), and z_HTTP_header_add_content_type().

Referenced by send_srw().

int yaz_sru_soap_encode	(	Z_HTTP_Request *	hreq,
		Z_SRW_PDU *	srw_pdu,
		ODR	odr,
		const char *	charset
	)

Definition at line 1018 of file srwutil.c.

References Z_HTTP_Request::content_buf, Z_HTTP_Request::content_len, Z_SOAP::generic, Z_HTTP_Request::headers, Z_SOAP_Generic::no, Z_SOAP_Generic::ns, Z_SOAP::ns, odr_malloc(), Z_SOAP_Generic::p, Z_SRW_PDU::password, Z_SOAP::u, Z_SRW_PDU::username, Z_SOAP::which, Z_SRW_PDU::which, yaz_srw_codec(), yaz_ucp_codec(), YAZ_XMLNS_SRU_v1_1, YAZ_XMLNS_UPDATE_v0_9, z_HTTP_header_add(), z_HTTP_header_add_basic_auth(), z_HTTP_header_add_content_type(), z_soap_codec_enc(), Z_SOAP_generic, Z_SRW_update_request, and Z_SRW_update_response.

Referenced by send_srw().

int yaz_srw_check_content_type

(

Z_HTTP_Response *

hres

)

Definition at line 89 of file srwutil.c.

References Z_HTTP_Response::headers, yaz_strcmp_del(), and z_HTTP_header_lookup().

Referenced by ZOOM_handle_sru().

int yaz_srw_codec	(	ODR	o,
		void *	pptr,
		Z_SRW_PDU **	handler_data,
		void *	client_data,
		const char *	ns
	)

Definition at line 728 of file srw.c.

References add_XML_n(), add_xsd_integer(), add_xsd_string(), Z_SRW_searchRetrieveRequest::cql, Z_SRW_scanRequest::cql, Z_SRW_searchRetrieveRequest::database, Z_SRW_explainRequest::database, Z_SRW_scanRequest::database, Z_SRW_searchRetrieveResponse::diagnostics, Z_SRW_explainResponse::diagnostics, Z_SRW_scanResponse::diagnostics, odr::direction, Z_SRW_explainResponse::extra_record, Z_SRW_searchRetrieveResponse::extra_records, Z_SRW_searchRetrieveResponse::facetList, match_element(), match_xsd_integer(), match_xsd_string(), match_xsd_XML_n(), Z_SRW_searchRetrieveRequest::maximumRecords, Z_SRW_scanRequest::maximumTerms, Z_SRW_searchRetrieveResponse::nextRecordPosition, Z_SRW_searchRetrieveRequest::none, Z_SRW_searchRetrieveResponse::num_diagnostics, Z_SRW_explainResponse::num_diagnostics, Z_SRW_scanResponse::num_diagnostics, Z_SRW_searchRetrieveResponse::num_records, Z_SRW_scanResponse::num_terms, Z_SRW_searchRetrieveResponse::numberOfRecords, ODR_DECODE, ODR_ENCODE, odr_malloc(), Z_SRW_searchRetrieveRequest::pqf, Z_SRW_scanRequest::pqf, Z_SRW_searchRetrieveRequest::query, Z_SRW_searchRetrieveRequest::query_type, Z_SRW_scanRequest::query_type, Z_SRW_explainResponse::record, Z_SRW_record::recordData_buf, Z_SRW_record::recordData_len, Z_SRW_searchRetrieveRequest::recordPacking, Z_SRW_explainRequest::recordPacking, Z_SRW_record::recordPosition, Z_SRW_searchRetrieveResponse::records, Z_SRW_record::recordSchema, Z_SRW_searchRetrieveRequest::recordSchema, Z_SRW_searchRetrieveRequest::recordXPath, Z_SRW_scanRequest::responsePosition, Z_SRW_searchRetrieveResponse::resultSetId, Z_SRW_searchRetrieveResponse::resultSetIdleTime, Z_SRW_searchRetrieveRequest::resultSetTTL, Z_SRW_scanRequest::scanClause, Z_SRW_searchRetrieveRequest::sort, Z_SRW_searchRetrieveRequest::sort_type, Z_SRW_searchRetrieveRequest::sortKeys, Z_SRW_searchRetrieveRequest::startRecord, Z_SRW_searchRetrieveRequest::stylesheet, Z_SRW_explainRequest::stylesheet, Z_SRW_scanRequest::stylesheet, Z_SRW_searchRetrieveResponse::suggestions, Z_SRW_scanResponse::terms, Z_SRW_searchRetrieveRequest::xcql, Z_SRW_searchRetrieveRequest::xSortKeys, yaz_negotiate_sru_version(), yaz_sru_proxy_decode_facets(), yaz_srw_diagnostics(), yaz_srw_get_core_v_1_1(), yaz_srw_record(), yaz_srw_records(), yaz_srw_terms(), Z_SRW_explain_request, Z_SRW_explain_response, Z_SRW_query_type_cql, Z_SRW_query_type_pqf, Z_SRW_query_type_xcql, Z_SRW_scan_request, Z_SRW_scan_response, Z_SRW_searchRetrieve_request, Z_SRW_searchRetrieve_response, Z_SRW_sort_type_none, Z_SRW_sort_type_sort, and Z_SRW_sort_type_xSort.

Referenced by process_http_request(), yaz_sru_decode(), yaz_sru_soap_encode(), yaz_srw_decode(), and ZOOM_handle_sru().

int yaz_srw_decode	(	Z_HTTP_Request *	hreq,
		Z_SRW_PDU **	srw_pdu,
		Z_SOAP **	soap_package,
		ODR	decode,
		char **	charset
	)

Definition at line 256 of file srwutil.c.

References Z_HTTP_Request::content_buf, Z_HTTP_Request::content_len, grab_charset(), Z_HTTP_Request::headers, Z_HTTP_Request::method, Z_HTTP_Request::path, Z_SRW_PDU::u, yaz_decode_sru_dbpath_odr(), yaz_srw_codec(), yaz_srw_decodeauth(), yaz_strcmp_del(), yaz_ucp_codec(), YAZ_XMLNS_SRU_v1_0, YAZ_XMLNS_SRU_v1_1, YAZ_XMLNS_UPDATE_v0_9, z_HTTP_header_lookup(), z_soap_codec(), Z_SOAP_generic, Z_SRW_explain_request, Z_SRW_scan_request, Z_SRW_searchRetrieve_request, and Z_SRW_update_request.

Referenced by process_http_request().

Z_SRW_PDU* yaz_srw_get	(	ODR	o,
		int	which
	)

Definition at line 731 of file srwutil.c.

References yaz_srw_get_pdu().

Referenced by yaz_solr_decode_response(), and yaz_sru_decode().

Z_SRW_PDU* yaz_srw_get_core_v_1_1

(

ODR

o

)

Definition at line 726 of file srwutil.c.

References yaz_srw_get_core_ver().

Referenced by yaz_srw_codec(), and yaz_ucp_codec().

Z_SRW_extra_record* yaz_srw_get_extra_record

(

ODR

o

)

Definition at line 681 of file srwutil.c.

References Z_SRW_extra_record::extraRecordData_buf, Z_SRW_extra_record::extraRecordData_len, odr_malloc(), and Z_SRW_extra_record::recordIdentifier.

Referenced by srw_bend_update().

Z_SRW_PDU* yaz_srw_get_pdu	(	ODR	o,
		int	which,
		const char *	version
	)

Definition at line 736 of file srwutil.c.

References Z_SRW_searchRetrieveRequest::cql, Z_SRW_scanRequest::cql, Z_SRW_searchRetrieveRequest::database, Z_SRW_explainRequest::database, Z_SRW_scanRequest::database, Z_SRW_updateRequest::database, Z_SRW_searchRetrieveResponse::diagnostics, Z_SRW_explainResponse::diagnostics, Z_SRW_scanResponse::diagnostics, Z_SRW_updateResponse::diagnostics, Z_SRW_PDU::explain_request, Z_SRW_PDU::explain_response, Z_SRW_explainResponse::extra_record, Z_SRW_updateRequest::extra_record, Z_SRW_updateResponse::extra_record, Z_SRW_searchRetrieveResponse::extra_records, Z_SRW_updateRequest::extraRequestData_buf, Z_SRW_updateRequest::extraRequestData_len, Z_SRW_updateResponse::extraResponseData_buf, Z_SRW_updateResponse::extraResponseData_len, Z_SRW_searchRetrieveRequest::facetList, Z_SRW_searchRetrieveResponse::facetList, Z_SRW_searchRetrieveRequest::maximumRecords, Z_SRW_scanRequest::maximumTerms, Z_SRW_searchRetrieveResponse::nextRecordPosition, Z_SRW_searchRetrieveRequest::none, Z_SRW_searchRetrieveResponse::num_diagnostics, Z_SRW_explainResponse::num_diagnostics, Z_SRW_scanResponse::num_diagnostics, Z_SRW_updateResponse::num_diagnostics, Z_SRW_searchRetrieveResponse::num_records, Z_SRW_updateRequest::num_recordVersions, Z_SRW_updateResponse::num_recordVersions, Z_SRW_scanResponse::num_terms, Z_SRW_searchRetrieveResponse::numberOfRecords, odr_malloc(), Z_SRW_updateResponse::operationStatus, Z_SRW_searchRetrieveRequest::query, Z_SRW_searchRetrieveRequest::query_type, Z_SRW_scanRequest::query_type, Z_SRW_explainResponse::record, Z_SRW_updateRequest::record, Z_SRW_updateResponse::record, Z_SRW_record::recordData_buf, Z_SRW_record::recordData_len, Z_SRW_updateRequest::recordId, Z_SRW_updateResponse::recordId, Z_SRW_record::recordPacking, Z_SRW_searchRetrieveRequest::recordPacking, Z_SRW_explainRequest::recordPacking, Z_SRW_record::recordPosition, Z_SRW_searchRetrieveResponse::records, Z_SRW_record::recordSchema, Z_SRW_searchRetrieveRequest::recordSchema, Z_SRW_updateRequest::recordVersions, Z_SRW_updateResponse::recordVersions, Z_SRW_searchRetrieveRequest::recordXPath, Z_SRW_PDU::request, Z_SRW_PDU::response, Z_SRW_scanRequest::responsePosition, Z_SRW_searchRetrieveResponse::resultSetId, Z_SRW_searchRetrieveResponse::resultSetIdleTime, Z_SRW_searchRetrieveRequest::resultSetTTL, Z_SRW_PDU::scan_request, Z_SRW_PDU::scan_response, Z_SRW_scanRequest::scanClause, Z_SRW_searchRetrieveRequest::sort, Z_SRW_searchRetrieveRequest::sort_type, Z_SRW_searchRetrieveRequest::startRecord, Z_SRW_searchRetrieveRequest::stylesheet, Z_SRW_explainRequest::stylesheet, Z_SRW_scanRequest::stylesheet, Z_SRW_updateRequest::stylesheet, Z_SRW_searchRetrieveResponse::suggestions, Z_SRW_scanResponse::terms, Z_SRW_PDU::u, Z_SRW_PDU::update_request, Z_SRW_PDU::update_response, Z_SRW_PDU::which, yaz_srw_get_core_ver(), Z_SRW_explain_request, Z_SRW_explain_response, Z_SRW_query_type_cql, Z_SRW_recordPacking_string, Z_SRW_scan_request, Z_SRW_scan_response, Z_SRW_searchRetrieve_request, Z_SRW_searchRetrieve_response, Z_SRW_sort_type_none, Z_SRW_update_request, and Z_SRW_update_response.

Referenced by process_http_request(), yaz_srw_get(), and ZOOM_srw_get_pdu().

Z_SRW_record* yaz_srw_get_record

(

ODR

o

)

Definition at line 709 of file srwutil.c.

References yaz_srw_get_records().

Referenced by srw_bend_update(), and yaz_ucp_codec().

Z_SRW_recordVersion* yaz_srw_get_record_versions	(	ODR	o,
		int	num
	)

Definition at line 1056 of file srwutil.c.

References odr_malloc(), Z_SRW_recordVersion::versionType, and Z_SRW_recordVersion::versionValue.

Z_SRW_record* yaz_srw_get_records	(	ODR	o,
		int	num
	)

Definition at line 693 of file srwutil.c.

References odr_malloc(), Z_SRW_record::recordData_buf, Z_SRW_record::recordData_len, Z_SRW_record::recordPacking, Z_SRW_record::recordPosition, Z_SRW_record::recordSchema, and Z_SRW_recordPacking_string.

Referenced by yaz_srw_get_record().

const char* yaz_srw_pack_to_str

(

int

pack

)

Definition at line 1069 of file srwutil.c.

References Z_SRW_recordPacking_string, Z_SRW_recordPacking_URL, and Z_SRW_recordPacking_XML.

Referenced by srw_bend_update(), and yaz_srw_record().

int yaz_srw_str_to_pack

(

const char *

str

)

Definition at line 1083 of file srwutil.c.

References yaz_matchstr(), Z_SRW_recordPacking_string, Z_SRW_recordPacking_URL, and Z_SRW_recordPacking_XML.

Referenced by srw_bend_explain(), srw_bend_search(), and srw_bend_update().

int yaz_ucp_codec	(	ODR	o,
		void *	pptr,
		Z_SRW_PDU **	handler_data,
		void *	client_data,
		const char *	ns
	)

Definition at line 1186 of file srw.c.

References add_XML_n(), add_xsd_string(), add_xsd_string_ns(), Z_SRW_updateRequest::database, Z_SRW_updateResponse::diagnostics, odr::direction, Z_SRW_updateRequest::extra_record, Z_SRW_updateResponse::extra_record, Z_SRW_updateRequest::extraRequestData_buf, Z_SRW_updateRequest::extraRequestData_len, Z_SRW_updateResponse::extraResponseData_buf, Z_SRW_updateResponse::extraResponseData_len, match_element(), match_xsd_string(), Z_SRW_updateResponse::num_diagnostics, Z_SRW_updateRequest::num_recordVersions, Z_SRW_updateResponse::num_recordVersions, ODR_DECODE, ODR_ENCODE, odr_malloc(), Z_SRW_updateRequest::operation, Z_SRW_updateResponse::operationStatus, Z_SRW_updateRequest::record, Z_SRW_updateResponse::record, Z_SRW_record::recordData_len, Z_SRW_updateRequest::recordId, Z_SRW_updateResponse::recordId, Z_SRW_updateRequest::recordVersions, Z_SRW_updateResponse::recordVersions, Z_SRW_updateRequest::stylesheet, yaz_srw_diagnostics(), yaz_srw_get_core_v_1_1(), yaz_srw_get_record(), yaz_srw_record(), yaz_srw_versions(), YAZ_XMLNS_DIAG_v1_1, YAZ_XMLNS_SRU_v1_1, Z_SRW_update_request, and Z_SRW_update_response.

Referenced by process_http_request(), yaz_sru_soap_encode(), and yaz_srw_decode().

int yaz_uri_to_array	(	const char *	path,
		ODR	o,
		char ***	name,
		char ***	val
	)

Definition at line 121 of file uri.c.

References decode_uri_char(), odr_malloc(), and odr_strdup().

Referenced by yaz_encode_sru_extra(), yaz_sru_decode(), and ztest_search().

char* yaz_uri_val	(	const char *	path,
		const char *	name,
		ODR	o
	)

deprecated

Definition at line 185 of file uri.c.

References decode_uri_char(), and odr_malloc().

Referenced by yaz_uri_val_int().

void yaz_uri_val_int	(	const char *	path,
		const char *	name,
		ODR	o,
		Odr_int **	intp
	)

deprecated

Definition at line 144 of file srwutil.c.

References odr_intdup(), and yaz_uri_val().