Header for SRW/SRU. More...

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

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_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_DIAG_v2 "http://docs.oasis-open.org/ns/search-ws/diagnostic"
#define	YAZ_XMLNS_UPDATE_v0_9 "http://www.loc.gov/zing/srw/update/"
#define	YAZ_XMLNS_SRU_v2_mask "http://docs.oasis-open.org/ns/search-ws/*"
#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_2_0 (ODR o)
Z_SRW_PDU *	yaz_srw_get_pdu (ODR o, int which, const char *version)
Z_SRW_PDU *	yaz_srw_get_pdu_e (ODR o, int which, Z_SRW_PDU *req)
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)
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)
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

◆ YAZ_XMLNS_DIAG_v1_1

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

Definition at line 329 of file srw.h.

Referenced by yaz_srw_diagnostics(), and yaz_ucp_codec().

◆ YAZ_XMLNS_DIAG_v2

#define YAZ_XMLNS_DIAG_v2 "http://docs.oasis-open.org/ns/search-ws/diagnostic"

Definition at line 330 of file srw.h.

Referenced by yaz_srw_diagnostics().

◆ YAZ_XMLNS_SRU_v1_0

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

Definition at line 327 of file srw.h.

Referenced by process_http_request(), and yaz_srw_decode().

◆ YAZ_XMLNS_SRU_v1_1

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

Definition at line 328 of file srw.h.

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

◆ YAZ_XMLNS_SRU_v1_response

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

Definition at line 333 of file srw.h.

Referenced by ZOOM_handle_sru().

◆ YAZ_XMLNS_SRU_v2_mask

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

Definition at line 332 of file srw.h.

Referenced by yaz_srw_decode(), and ZOOM_handle_sru().

◆ YAZ_XMLNS_UPDATE_v0_9

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

Definition at line 331 of file srw.h.

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

◆ Z_SRW_explain_request

#define Z_SRW_explain_request 3

Definition at line 193 of file srw.h.

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

◆ Z_SRW_explain_response

#define Z_SRW_explain_response 4

Definition at line 194 of file srw.h.

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

◆ Z_SRW_recordPacking_string

#define Z_SRW_recordPacking_string 0

Definition at line 54 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().

◆ Z_SRW_recordPacking_URL

#define Z_SRW_recordPacking_URL 2

Definition at line 56 of file srw.h.

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

◆ Z_SRW_recordPacking_XML

#define Z_SRW_recordPacking_XML 1

Definition at line 55 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().

◆ Z_SRW_scan_request

#define Z_SRW_scan_request 5

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_scan().

◆ Z_SRW_scan_response

#define Z_SRW_scan_response 6

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().

◆ Z_SRW_searchRetrieve_request

#define Z_SRW_searchRetrieve_request 1

Definition at line 191 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(), yaz_srw_get_pdu_e(), and ZOOM_connection_srw_send_search().

◆ Z_SRW_searchRetrieve_response

#define Z_SRW_searchRetrieve_response 2

Definition at line 192 of file srw.h.

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

◆ Z_SRW_sort_type_none

#define Z_SRW_sort_type_none 1

Definition at line 74 of file srw.h.

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

◆ Z_SRW_sort_type_sort

#define Z_SRW_sort_type_sort 2

Definition at line 75 of file srw.h.

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

◆ Z_SRW_sort_type_xSort

#define Z_SRW_sort_type_xSort 3

Definition at line 76 of file srw.h.

Referenced by yaz_srw_codec().

◆ Z_SRW_update_request

#define Z_SRW_update_request 7

Definition at line 197 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().

◆ Z_SRW_update_response

#define Z_SRW_update_response 8

Definition at line 198 of file srw.h.

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

Typedef Documentation

◆ Z_SRW_extra_arg

typedef struct Z_SRW_extra_arg Z_SRW_extra_arg

Definition at line 171 of file srw.h.

Function Documentation

◆ sru_decode_surrogate_diagnostics()

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

Definition at line 411 of file srw.c.

References yaz_srw_decode_diagnostics().

Referenced by handle_srw_response().

◆ yaz_add_sru_update_diagnostic()

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

Definition at line 194 of file srwutil.c.

References yaz_add_srw_diagnostic_uri(), and yaz_snprintf().

Referenced by srw_bend_update().

◆ yaz_add_srw_diagnostic()

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

Definition at line 184 of file srwutil.c.

References yaz_add_srw_diagnostic_uri(), and yaz_snprintf().

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

◆ yaz_add_srw_diagnostic_uri()

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 170 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().

◆ yaz_array_to_uri()

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

Definition at line 99 of file uri.c.

References name, odr_malloc(), and yaz_encode_uri_component().

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

◆ yaz_decode_uri_component()

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 87 of file uri.c.

References decode_uri_char().

◆ yaz_diag_bib1_to_srw()

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().

◆ yaz_diag_srw_to_bib1()

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().

◆ yaz_encode_sru_dbpath_buf()

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 57 of file srwutil.c.

Referenced by yaz_encode_sru_dbpath_odr().

◆ 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 64 of file srwutil.c.

References odr_malloc(), and yaz_encode_sru_dbpath_buf().

◆ yaz_encode_sru_extra()

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

Definition at line 1233 of file srwutil.c.

References append_extra_arg(), Z_SRW_PDU::extra_args, name, and yaz_uri_to_array().

Referenced by ZOOM_connection_srw_send_scan(), and ZOOM_connection_srw_send_search().

◆ yaz_encode_uri_component()

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 46 of file uri.c.

References encode_uri_char().

Referenced by rdf_lookup_node(), and yaz_array_to_uri().

◆ yaz_mk_sru_surrogate()

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

Definition at line 204 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, yaz_diag_srw_str(), and yaz_snprintf().

Referenced by srw_bend_fetch().

◆ yaz_mk_srw_diagnostic()

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

Definition at line 146 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().

◆ yaz_mk_std_diagnostic()

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

Definition at line 161 of file srwutil.c.

References yaz_mk_srw_diagnostic(), and yaz_snprintf().

◆ yaz_solr_decode_response()

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

Definition at line 338 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_error(), 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().

◆ yaz_solr_encode_request()

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 486 of file solr.c.

References Z_SRW_PDU::extra_args, Z_HTTP_Request::headers, 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::query, Z_SRW_scanRequest::queryType, Z_SRW_PDU::request, Z_SRW_PDU::scan_request, Z_SRW_scanRequest::scanClause, Z_SRW_searchRetrieveRequest::sort, Z_SRW_searchRetrieveRequest::sort_type, Z_SRW_searchRetrieveRequest::sortKeys, yaz_facet_attr::start, 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_SRW_scan_request, Z_SRW_searchRetrieve_request, Z_SRW_sort_type_none, and Z_SRW_sort_type_sort.

Referenced by send_srw().

◆ yaz_sru_decode()

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 )