http_command.c File Reference

#include <stdio.h>
#include <sys/types.h>
#include <stdlib.h>
#include <string.h>
#include <yaz/snprintf.h>
#include <yaz/yaz-util.h>
#include "ppmutex.h"
#include "eventl.h"
#include "parameters.h"
#include "session.h"
#include "http.h"
#include "settings.h"
#include "client.h"

Go to the source code of this file.

Data Structures
struct	http_session
struct	http_sessions

Macros
#define	print_meminfo(x)
#define	PAZPAR2_PROTOCOL_VERSION   "1"
#define	HTTP_COMMAND_RESPONSE_PREFIX   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
#define	resultsets_count()   0

Functions
static void	show_records_ready (void *data)
int	get_version (struct http_request *rq)
int	http_session_use (int delta)
http_sessions_t	http_sessions_create (void)
void	http_sessions_destroy (http_sessions_t hs)
void	http_session_destroy (struct http_session *s)
static void	session_timeout (IOCHAN i, int event)
struct http_session *	http_session_create (struct conf_service *service, http_sessions_t http_sessions, unsigned int sesid)
static const char *	get_msg (enum pazpar2_error_code code)
static void	error (struct http_response *rs, enum pazpar2_error_code code, const char *addinfo)
static void	response_open_no_status (struct http_channel *c, const char *command)
static void	response_open (struct http_channel *c, const char *command)
static void	response_close (struct http_channel *c, const char *command)
unsigned int	make_sessionid (void)
static struct http_session *	locate_session (struct http_channel *c)
static void	release_session (struct http_channel *c, struct http_session *session)
static int	process_settings (struct session *se, struct http_request *rq, struct http_response *rs)
static void	cmd_exit (struct http_channel *c)
static void	cmd_init (struct http_channel *c)
static void	apply_local_setting (void *client_data, struct setting *set)
static void	cmd_settings (struct http_channel *c)
static void	termlist_response (struct http_channel *c, struct http_session *s, const char *cmd_status)
static void	termlist_result_ready (void *data)
static void	cmd_termlist (struct http_channel *c)
size_t	session_get_memory_status (struct session *session)
static void	session_status (struct http_channel *c, struct http_session *s)
static void	cmd_session_status (struct http_channel *c)
int	sessions_count (void)
int	clients_count (void)
static void	cmd_server_status (struct http_channel *c)
static void	bytarget_response (struct http_channel *c, struct http_session *s, const char *cmd_status)
static void	bytarget_result_ready (void *data)
static void	cmd_bytarget (struct http_channel *c)
static void	write_metadata (WRBUF w, struct conf_service *service, struct record_metadata **ml, int full, int indent)
static void	write_subrecord (struct record *r, WRBUF w, struct conf_service *service, int show_details)
static void	show_raw_record_error (void *data, const char *addinfo)
static void	show_raw_record_ok (void *data, const char *buf, size_t sz)
static void	show_raw_record_ok_binary (void *data, const char *buf, size_t sz)
void	show_raw_reset (void *data, struct http_channel *c, void *data2)
static void	cmd_record_ready (void *data)
static void	show_record (struct http_channel *c, struct http_session *s)
static void	cmd_record (struct http_channel *c)
static void	show_records (struct http_channel *c, struct http_session *s, int active)
static void	cmd_show (struct http_channel *c)
static void	cmd_ping (struct http_channel *c)
static void	cmd_search (struct http_channel *c)
static void	cmd_stat (struct http_channel *c)
static void	cmd_info (struct http_channel *c)
void	http_command (struct http_channel *c)

Variables
static YAZ_MUTEX	g_http_session_mutex = 0
static int	g_http_sessions = 0
struct {
char *   name
void(*   fun )(struct http_channel *c)
}	commands []

Macro Definition Documentation

#define HTTP_COMMAND_RESPONSE_PREFIX   "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"

Definition at line 73 of file http_command.c.

Referenced by error(), and response_open_no_status().

#define PAZPAR2_PROTOCOL_VERSION   "1"

Definition at line 71 of file http_command.c.

Referenced by cmd_init().

#define print_meminfo

(

x

)

Definition at line 66 of file http_command.c.

Referenced by cmd_server_status().

#define resultsets_count

(

)

0

Definition at line 668 of file http_command.c.

Referenced by cmd_server_status().

Function Documentation

static void apply_local_setting ( void *  client_data, struct setting *  set  )

static

Definition at line 487 of file http_command.c.

References session_apply_setting(), and session::session_nmem.

Referenced by cmd_settings().

static void bytarget_response ( struct http_channel *  c, struct http_session *  s, const char *  cmd_status  )

static

Definition at line 706 of file http_command.c.

References hitsbytarget::addinfo, hitsbytarget::approximation, hitsbytarget::diagnostic, hitsbytarget::filtered, get_hitsbytarget(), get_version(), hitsbytarget::hits, http_argbyname(), hitsbytarget::id, hitsbytarget::message, hitsbytarget::name, name, http_channel::nmem, http_session::psession, hitsbytarget::records, http_channel::request, response_close(), response_open(), response_open_no_status(), session_log(), hitsbytarget::settings_xml, hitsbytarget::state, hitsbytarget::suggestions_xml, and http_channel::wrbuf.

Referenced by bytarget_result_ready(), and cmd_bytarget().

static void bytarget_result_ready ( void *  data )

static

Definition at line 777 of file http_command.c.

References bytarget_response(), http_channel::http_sessions, locate_session(), http_sessions::log_level, http_session::psession, release_session(), and session_log().

Referenced by cmd_bytarget().

int clients_count

(

void

)

Definition at line 94 of file client.c.

References client_use().

Referenced by cmd_server_status().

static void cmd_bytarget ( struct http_channel *  c )

static

Definition at line 795 of file http_command.c.

References bytarget_response(), bytarget_result_ready(), error(), http_argbyname(), http_channel::http_sessions, locate_session(), http_sessions::log_level, PAZPAR2_ALREADY_BLOCKED, http_session::psession, release_session(), http_channel::request, http_channel::response, session_active_clients(), session_log(), session_set_watch(), and SESSION_WATCH_BYTARGET.

static void cmd_exit ( struct http_channel *  c )

static

Definition at line 411 of file http_command.c.

References parameters::debug_mode, global_parameters, http_close_server(), response_close(), response_open(), and http_channel::server.

static void cmd_info ( struct http_channel *  c )

static

Definition at line 1404 of file http_command.c.

References info_services(), PAZPAR2_VERSION_SHA1, response_close(), response_open_no_status(), http_channel::server, VERSION, and http_channel::wrbuf.

static void cmd_init ( struct http_channel *  c )

static

Definition at line 421 of file http_command.c.

References http_request::content_buf, http_request::content_len, error(), http_request::headers, http_argbyname(), http_lookup_header(), http_session_create(), http_channel::http_sessions, locate_service(), make_sessionid(), PAZPAR2_MALFORMED_SETTING, PAZPAR2_NO_SERVICE, PAZPAR2_PROTOCOL_VERSION, process_settings(), http_session::psession, http_channel::request, http_channel::response, response_close(), response_open(), http_channel::server, conf_server::server_id, session::service, service_create(), session_init_databases(), session_log(), conf_service::session_timeout, and http_channel::wrbuf.

static void cmd_ping ( struct http_channel *  c )

static

Definition at line 1303 of file http_command.c.

References locate_session(), release_session(), response_close(), and response_open().

static void cmd_record ( struct http_channel *  c )

static

Definition at line 1089 of file http_command.c.

References locate_session(), release_session(), and show_record().

static void cmd_record_ready ( void *  data )

static

Definition at line 1076 of file http_command.c.

References http_channel::http_sessions, locate_session(), http_sessions::log_level, http_session::psession, release_session(), session_log(), and show_record().

Referenced by show_record().

static void cmd_search ( struct http_channel *  c )

static

Definition at line 1313 of file http_command.c.

References conf_service::default_sort, error(), http_argbyname(), locate_session(), http_channel::nmem, PAZPAR2_MALFORMED_PARAMETER_ENCODING, PAZPAR2_MALFORMED_PARAMETER_VALUE, PAZPAR2_MISSING_PARAMETER, http_session::psession, reclist_parse_sortparms(), release_session(), http_channel::request, http_channel::response, response_close(), response_open(), session::service, and session_search().

static void cmd_server_status ( struct http_channel *  c )

static

Definition at line 671 of file http_command.c.

References clients_count(), print_meminfo, response_close(), response_open(), resultsets_count, sessions_count(), and http_channel::wrbuf.

static void cmd_session_status ( struct http_channel *  c )

static

Definition at line 651 of file http_command.c.

References locate_session(), release_session(), response_close(), response_open(), and session_status().

static void cmd_settings ( struct http_channel *  c )

static

Definition at line 497 of file http_command.c.

References apply_local_setting(), http_request::content_buf, http_request::content_len, error(), http_request::headers, http_lookup_header(), locate_session(), PAZPAR2_MALFORMED_SETTING, process_settings(), http_session::psession, release_session(), http_channel::request, http_channel::response, response_close(), response_open(), and settings_read_node_x().

static void cmd_show ( struct http_channel *  c )

static

Definition at line 1206 of file http_command.c.

References conf_service::default_sort, error(), http_argbyname(), http_channel::http_sessions, locate_session(), http_sessions::log_level, http_channel::nmem, PAZPAR2_ALREADY_BLOCKED, PAZPAR2_MALFORMED_PARAMETER_VALUE, http_session::psession, session::reclist, reclist_get_num_records(), reclist_parse_sortparms(), release_session(), http_channel::request, http_channel::response, session::service, session_active_clients(), session_is_preferred_clients_ready(), session_log(), session_set_watch(), session_sort(), SESSION_WATCH_SHOW, SESSION_WATCH_SHOW_PREF, show_records(), and show_records_ready().

static void cmd_stat ( struct http_channel *  c )

static

Definition at line 1369 of file http_command.c.

References locate_session(), statistics::num_clients, statistics::num_connecting, statistics::num_error, statistics::num_failed, statistics::num_hits, statistics::num_idle, statistics::num_no_connection, statistics::num_records, statistics::num_working, http_session::psession, release_session(), response_close(), response_open_no_status(), session_active_clients(), statistics(), and http_channel::wrbuf.

static void cmd_termlist ( struct http_channel *  c )

static

Definition at line 582 of file http_command.c.

References error(), http_argbyname(), http_channel::http_sessions, locate_session(), http_sessions::log_level, PAZPAR2_ALREADY_BLOCKED, http_session::psession, release_session(), http_channel::request, http_channel::response, session_active_clients(), session_log(), session_set_watch(), SESSION_WATCH_TERMLIST, termlist_response(), and termlist_result_ready().

static void error ( struct http_response *  rs, enum pazpar2_error_code  code, const char *  addinfo  )

static

Definition at line 265 of file http_command.c.

References http_response::channel, http_response::code, get_msg(), HTTP_COMMAND_RESPONSE_PREFIX, http_send_response(), http_response::msg, http_channel::nmem, and http_response::payload.

Referenced by client_record_response(), client_search_response(), cmd_bytarget(), cmd_init(), cmd_search(), cmd_settings(), cmd_show(), cmd_termlist(), http_command(), http_init(), locate_session(), non_block_events(), perform_getaddrinfo(), process_settings(), show_raw_record_error(), show_record(), and show_records().

static const char* get_msg ( enum pazpar2_error_code  code )

static

Definition at line 232 of file http_command.c.

References PAZPAR2_ALREADY_BLOCKED, PAZPAR2_CONFIG_TARGET, PAZPAR2_HITCOUNTS_FAILED, PAZPAR2_LAST_ERROR, PAZPAR2_MALFORMED_PARAMETER_ENCODING, PAZPAR2_MALFORMED_PARAMETER_VALUE, PAZPAR2_MALFORMED_SETTING, PAZPAR2_MISSING_PARAMETER, PAZPAR2_NO_SERVICE, PAZPAR2_NO_SESSION, PAZPAR2_NO_TARGETS, PAZPAR2_NOT_IMPLEMENTED, PAZPAR2_RECORD_FAIL, and PAZPAR2_RECORD_MISSING.

Referenced by error().

int get_version

(

struct http_request *

rq

)

Definition at line 98 of file http_command.c.

References http_argbyname().

Referenced by bytarget_response(), show_records(), and termlist_response().

void http_command

(

struct http_channel *

c

)

Definition at line 1465 of file http_command.c.

References commands, error(), http_addheader(), http_argbyname(), http_create_response(), name, PAZPAR2_MALFORMED_PARAMETER_VALUE, PAZPAR2_MISSING_PARAMETER, http_channel::request, and http_channel::response.

Referenced by http_io().

struct http_session* http_session_create ( struct conf_service *  service, http_sessions_t  http_sessions, unsigned int  sesid  )

read

Definition at line 158 of file http_command.c.

References http_session::activity_counter, http_session::destroy_counter, http_session_use(), http_session::http_sessions, iochan_add(), iochan_create(), conf_server::iochan_man, iochan_setdata, iochan_settimeout, http_sessions::log_level, http_sessions::mutex, new_session(), http_session::next, http_session::nmem, http_session::psession, conf_service::server, http_session::session_id, http_sessions::session_list, session_log(), conf_service::session_timeout, session_timeout(), http_session::timeout_iochan, and http_session::timestamp.

Referenced by cmd_init().

void http_session_destroy

(

struct http_session *

s

)

Definition at line 193 of file http_command.c.

References http_session::activity_counter, http_session::destroy_counter, http_session_use(), http_session::http_sessions, iochan_destroy, http_sessions::log_level, http_sessions::mutex, http_session::next, http_session::nmem, http_session::psession, session_destroy(), http_sessions::session_list, session_log(), and http_session::timeout_iochan.

Referenced by session_timeout().

int http_session_use

(

int

delta

)

Definition at line 108 of file http_command.c.

References g_http_session_mutex, and g_http_sessions.

Referenced by http_session_create(), and http_session_destroy().

http_sessions_t http_sessions_create

(

void

)

Definition at line 122 of file http_command.c.

References http_sessions::log_level, http_sessions::mutex, pazpar2_mutex_create(), and http_sessions::session_list.

Referenced by http_mutex_init().

void http_sessions_destroy

(

http_sessions_t

hs

)

Definition at line 132 of file http_command.c.

References iochan_destroy, http_sessions::mutex, http_session::next, http_session::nmem, http_session::psession, session_destroy(), http_sessions::session_list, and http_session::timeout_iochan.

Referenced by http_server_destroy().

static struct http_session* locate_session ( struct http_channel *  c )

staticread

Definition at line 341 of file http_command.c.

References http_session::activity_counter, error(), http_argbyname(), http_channel::http_sessions, iochan_activity, http_sessions::mutex, http_session::next, PAZPAR2_MISSING_PARAMETER, PAZPAR2_NO_SESSION, http_channel::request, http_channel::response, http_session::session_id, http_sessions::session_list, and http_session::timeout_iochan.

Referenced by bytarget_result_ready(), cmd_bytarget(), cmd_ping(), cmd_record(), cmd_record_ready(), cmd_search(), cmd_session_status(), cmd_settings(), cmd_show(), cmd_stat(), cmd_termlist(), show_records_ready(), and termlist_result_ready().

unsigned int make_sessionid

(

void

)

Definition at line 312 of file http_command.c.

References global_parameters, and parameters::predictable_sessions.

Referenced by cmd_init().

static int process_settings ( struct session *  se, struct http_request *  rq, struct http_response *  rs  )

static

Definition at line 383 of file http_command.c.

References http_request::arguments, error(), http_argument::name, http_argument::next, PAZPAR2_MALFORMED_SETTING, session_apply_setting(), session::session_nmem, and http_argument::value.

Referenced by cmd_init(), and cmd_settings().

static void release_session ( struct http_channel *  c, struct http_session *  session  )

static

Definition at line 371 of file http_command.c.

References http_session::destroy_counter, http_channel::http_sessions, and http_sessions::mutex.

Referenced by bytarget_result_ready(), cmd_bytarget(), cmd_ping(), cmd_record(), cmd_record_ready(), cmd_search(), cmd_session_status(), cmd_settings(), cmd_show(), cmd_stat(), cmd_termlist(), show_records_ready(), and termlist_result_ready().

static void response_close ( struct http_channel *  c, const char *  command  )

static

Definition at line 303 of file http_command.c.

References http_send_response(), http_channel::nmem, http_response::payload, http_channel::response, and http_channel::wrbuf.

Referenced by bytarget_response(), cmd_exit(), cmd_info(), cmd_init(), cmd_ping(), cmd_search(), cmd_server_status(), cmd_session_status(), cmd_settings(), cmd_stat(), show_record(), show_records(), and termlist_response().

static void response_open ( struct http_channel *  c, const char *  command  )

static

Definition at line 297 of file http_command.c.

References response_open_no_status(), and http_channel::wrbuf.

Referenced by bytarget_response(), cmd_exit(), cmd_init(), cmd_ping(), cmd_search(), cmd_server_status(), cmd_session_status(), cmd_settings(), and show_records().

static void response_open_no_status ( struct http_channel *  c, const char *  command  )

static

Definition at line 290 of file http_command.c.

References HTTP_COMMAND_RESPONSE_PREFIX, and http_channel::wrbuf.

Referenced by bytarget_response(), cmd_info(), cmd_stat(), response_open(), show_record(), and termlist_response().

size_t session_get_memory_status

(

struct session *

session

)

Definition at line 938 of file session.c.

References session::nmem, session_enter(), and session_leave().

Referenced by session_status().

static void session_status ( struct http_channel *  c, struct http_session *  s  )

static

Definition at line 642 of file http_command.c.

References http_session::activity_counter, http_session::nmem, http_session::psession, session_get_memory_status(), and http_channel::wrbuf.

Referenced by cmd_session_status().

static void session_timeout ( IOCHAN  i, int  event  )

static

Definition at line 152 of file http_command.c.

References http_session_destroy(), and iochan_getdata.

Referenced by client_prep_connection(), connection_create(), and http_session_create().

int sessions_count

(

void

)

Definition at line 117 of file session.c.

References session_use().

Referenced by cmd_server_status().

static void show_raw_record_error ( void *  data, const char *  addinfo  )

static

Definition at line 916 of file http_command.c.

References error(), http_channel_observer_chan(), http_remove_observer(), PAZPAR2_RECORD_FAIL, and http_channel::response.

Referenced by show_record().

static void show_raw_record_ok ( void *  data, const char *  buf, size_t  sz  )

static

Definition at line 927 of file http_command.c.

References http_channel_observer_chan(), http_remove_observer(), http_send_response(), http_channel::nmem, http_response::payload, http_channel::response, and http_channel::wrbuf.

Referenced by show_record().

static void show_raw_record_ok_binary ( void *  data, const char *  buf, size_t  sz  )

static

Definition at line 941 of file http_command.c.

References http_response::content_type, http_channel_observer_chan(), http_remove_observer(), http_send_response(), http_channel::nmem, http_response::payload, http_channel::response, and http_channel::wrbuf.

Referenced by show_record().

void show_raw_reset	(	void *	data,
		struct http_channel *	c,
		void *	data2
	)

Definition at line 957 of file http_command.c.

Referenced by show_record().

static void show_record ( struct http_channel *  c, struct http_session *  s  )

static

Definition at line 965 of file http_command.c.

References record::checksum, record::client, client_show_raw_begin(), cmd_record_ready(), error(), http_add_observer(), http_argbyname(), http_remove_observer(), record_cluster::metadata, record::next, PAZPAR2_MISSING_PARAMETER, PAZPAR2_NO_SESSION, PAZPAR2_RECORD_FAIL, PAZPAR2_RECORD_MISSING, record::position, http_session::psession, record_cluster::recid, record_cluster::records, http_channel::request, http_channel::response, response_close(), response_open_no_status(), session::service, session_active_clients(), session_set_watch(), SESSION_WATCH_RECORD, show_raw_record_error(), show_raw_record_ok(), show_raw_record_ok_binary(), show_raw_reset(), show_single_start(), show_single_stop(), http_channel::wrbuf, write_metadata(), and write_subrecord().

Referenced by cmd_record(), and cmd_record_ready().

static void show_records ( struct http_channel *  c, struct http_session *  s, int  active  )

static

Definition at line 1099 of file http_command.c.

References conf_service::default_sort, error(), get_version(), http_argbyname(), record_cluster::metadata, record::next, http_channel::nmem, PAZPAR2_MALFORMED_PARAMETER_VALUE, http_session::psession, conf_service::rank_debug, record_cluster::recid, reclist_parse_sortparms(), record_cluster::relevance_explain1, record_cluster::relevance_explain2, record_cluster::relevance_score, http_channel::request, http_channel::response, response_close(), response_open(), session::service, session_active_clients(), show_range_start(), show_range_stop(), show_records_ready(), http_channel::wrbuf, write_metadata(), and write_subrecord().

Referenced by cmd_show(), and show_records_ready().

static void show_records_ready ( void *  data )

static

Definition at line 1190 of file http_command.c.

References http_channel::http_sessions, locate_session(), http_sessions::log_level, http_session::psession, release_session(), session_log(), and show_records().

Referenced by cmd_show(), show_range_start(), and show_records().

static void termlist_response ( struct http_channel *  c, struct http_session *  s, const char *  cmd_status  )

static

Definition at line 539 of file http_command.c.

References get_version(), http_argbyname(), name, perform_termlist(), http_session::psession, http_channel::request, response_close(), response_open_no_status(), session_active_clients(), and http_channel::wrbuf.

Referenced by cmd_termlist(), and termlist_result_ready().

static void termlist_result_ready ( void *  data )

static

Definition at line 564 of file http_command.c.

References http_argbyname(), http_channel::http_sessions, locate_session(), http_sessions::log_level, http_session::psession, release_session(), http_channel::request, session_log(), and termlist_response().

Referenced by cmd_termlist().

static void write_metadata ( WRBUF  w, struct conf_service *  service, struct record_metadata **  ml, int  full, int  indent  )

static

Definition at line 849 of file http_command.c.

References record_metadata::attributes, conf_metadata::brief, record_metadata::data, data_types::disp, data_types::max, conf_service::metadata, Metadata_type_generic, Metadata_type_year, data_types::min, record_metadata_attr::name, conf_metadata::name, record_metadata_attr::next, record_metadata::next, conf_service::num_metadata, data_types::number, data_types::text, conf_metadata::type, and record_metadata_attr::value.

Referenced by show_record(), show_records(), and write_subrecord().

static void write_subrecord ( struct record *  r, WRBUF  w, struct conf_service *  service, int  show_details  )

static

Definition at line 894 of file http_command.c.

References record::checksum, record::client, client_get_database(), client_get_id(), record::metadata, name, PZ_NAME, session_setting_oneval(), and write_metadata().

Referenced by show_record(), and show_records().

Variable Documentation

struct { ... } commands[]

Referenced by http_command().

void(* fun)(struct http_channel *c)

Definition at line 1447 of file http_command.c.

Referenced by read_settings(), read_settings_file(), session_alert_watch(), and session_set_watch().

YAZ_MUTEX g_http_session_mutex = 0

static

Definition at line 93 of file http_command.c.

Referenced by http_session_use().

int g_http_sessions = 0

static

Definition at line 94 of file http_command.c.

Referenced by http_session_use().

char* name

Definition at line 1446 of file http_command.c.

Referenced by apply_limit(), bytarget_response(), check_limit_local(), client_get_facet_limit_local(), hitsbytarget_nb(), http_command(), initialize_soft_settings(), record_create(), service_create_static(), session_check_cluster_limit(), settings_index_lookup(), settings_read_node_x(), targets_termlist_nb(), termlist_response(), and write_subrecord().