1 #include "apachetools.h"
2 #include "opensrf/osrf_app_session.h"
3 #include "opensrf/osrf_system.h"
4 #include "opensrf/osrfConfig.h"
5 #include "objson/object.h"
6 #include "objson/json2xml.h"
8 #include <sys/resource.h>
11 #define MODULE_NAME "osrf_json_gateway_module"
12 #define GATEWAY_CONFIG "OSRFGatewayConfig"
13 #define CONFIG_CONTEXT "gateway"
15 #define GATEWAY_DEFAULT_CONFIG "/openils/conf/opensrf_core.xml"
18 /* our config structure */
20 char* configfile; /* our bootstrap config file */
21 } osrf_json_gateway_config;
23 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module;
25 char* osrf_json_gateway_config_file = NULL;
28 osrfStringArray* allowedServices = NULL;
30 static const char* osrf_json_gateway_set_config(cmd_parms *parms, void *config, const char *arg) {
31 osrf_json_gateway_config *cfg;
32 cfg = ap_get_module_config(parms->server->module_config, &osrf_json_gateway_module);
33 cfg->configfile = (char*) arg;
34 osrf_json_gateway_config_file = (char*) arg;
38 /* tell apache about our commands */
39 static const command_rec osrf_json_gateway_cmds[] = {
40 AP_INIT_TAKE1( GATEWAY_CONFIG, osrf_json_gateway_set_config,
41 NULL, RSRC_CONF, "osrf json gateway config file"),
45 /* build the config object */
46 static void* osrf_json_gateway_create_config( apr_pool_t* p, server_rec* s) {
47 osrf_json_gateway_config* cfg = (osrf_json_gateway_config*)
48 apr_palloc(p, sizeof(osrf_json_gateway_config));
49 cfg->configfile = GATEWAY_DEFAULT_CONFIG;
54 static void osrf_json_gateway_child_init(apr_pool_t *p, server_rec *s) {
56 char* cfg = osrf_json_gateway_config_file;
57 if( ! osrf_system_bootstrap_client( cfg, CONFIG_CONTEXT ) ) {
58 ap_log_error( APLOG_MARK, APLOG_ERR, 0, s,
59 "Unable to Bootstrap OpenSRF Client with config %s..", cfg);
64 allowedServices = osrfNewStringArray(8);
65 osrfLogInfo(OSRF_LOG_MARK, "Bootstrapping gateway child for requests");
66 osrfConfigGetValueList( NULL, allowedServices, "/services/service" );
69 for( i = 0; i < allowedServices->size; i++ ) {
70 fprintf(stderr, "allowed service: %s\n",
71 osrfStringArrayGetString(allowedServices, i));
75 #ifdef OSRF_GATEWAY_ENABLE_RLIMIT /* emergency test measures only */
76 struct rlimit lim = { 536870912, 536870912 }; /* 512MB */
77 setrlimit(RLIMIT_AS, &lim);
78 setrlimit(RLIMIT_MEMLOCK,&lim);
79 setrlimit(RLIMIT_STACK, &lim);
80 setrlimit(RLIMIT_DATA,&lim);
83 getrlimit(RLIMIT_DATA, &lim2);
84 osrfLogDebug(OSRF_LOG_MARK, "rlimit for data set to %d", lim2.rlim_cur);
89 static int osrf_json_gateway_method_handler (request_rec *r) {
91 /* make sure we're needed first thing*/
92 if (strcmp(r->handler, MODULE_NAME )) return DECLINED;
94 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: entered request handler");
96 /* verify we are connected */
97 if( !bootstrapped || !osrf_system_get_transport_client()) {
98 ap_log_rerror( APLOG_MARK, APLOG_ERR, 0, r, "Cannot process request "
99 "because the OpenSRF JSON gateway has not been bootstrapped...");
100 return HTTP_INTERNAL_SERVER_ERROR;
103 osrfLogSetAppname("osrf_json_gw");
105 char* service = NULL; /* service to connect to */
106 char* method = NULL; /* method to perform */
107 char* format = NULL; /* method to perform */
108 char* a_l = NULL; /* request api level */
112 r->allowed |= (AP_METHOD_BIT << M_GET);
113 r->allowed |= (AP_METHOD_BIT << M_POST);
115 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: parsing URL params");
116 string_array* mparams = NULL;
117 string_array* params = apacheParseParms(r); /* free me */
118 service = apacheGetFirstParamValue( params, "service" );
119 method = apacheGetFirstParamValue( params, "method" );
120 format = apacheGetFirstParamValue( params, "format" );
121 a_l = apacheGetFirstParamValue( params, "api_level" );
122 mparams = apacheGetParamValues( params, "param" ); /* free me */
125 api_level = atoi(a_l);
127 if (format && !strcasecmp(format, "xml" )) {
129 ap_set_content_type(r, "application/xml");
131 ap_set_content_type(r, "text/plain");
136 if(!(service && method) ||
137 !osrfStringArrayContains(allowedServices, service)) {
139 osrfLogError(OSRF_LOG_MARK,
140 "Service [%s] not found or not allowed", service);
141 ret = HTTP_NOT_FOUND;
145 osrfLogInfo( OSRF_LOG_MARK, "service=%s, method=%s", service, method );
146 osrfAppSession* session = osrf_app_client_session_init(service);
147 int req_id = osrf_app_session_make_req( session, NULL, method, api_level, mparams );
148 osrf_message* omsg = NULL;
150 int statuscode = 200;
152 /* kick off the object */
154 ap_rputs("<response xmlns=\"http://opensrf.org/-/namespaces/gateway/v1\"><payload>", r);
156 ap_rputs("{\"payload\":[", r);
159 char* statusname = NULL;
160 char* statustext = NULL;
163 while((omsg = osrfAppSessionRequestRecv( session, req_id, 60 ))) {
165 statuscode = omsg->status_code;
168 if( ( res = osrfMessageGetResult(omsg)) ) {
171 output = jsonObjectToXML( res );
173 output = jsonObjectToJSON( res );
174 if( morethan1 ) ap_rputs(",", r); /* comma between JSON array items */
182 if( statuscode > 299 ) { /* the request returned a low level error */
183 statusname = omsg->status_name ? strdup(omsg->status_name) : strdup("Unknown Error");
184 statustext = omsg->status_text ? strdup(omsg->status_text) : strdup("No Error Message");
185 osrfLogError( OSRF_LOG_MARK, "Gateway received error: %s", statustext );
189 osrf_message_free(omsg);
190 if(statusname) break;
194 ap_rputs("</payload>", r);
196 ap_rputs("]",r); /* finish off the payload array */
200 /* add a debug field if the request died */
201 ap_log_rerror( APLOG_MARK, APLOG_INFO, 0, r,
202 "OpenSRF JSON Request returned error: %s -> %s", statusname, statustext );
203 int l = strlen(statusname) + strlen(statustext) + 32;
208 snprintf( buf, l, "<debug>\"%s : %s\"</debug>", statusname, statustext );
213 snprintf(bb, l, "%s : %s", statusname, statustext);
214 jsonObject* tmp = jsonNewObject(bb);
215 char* j = jsonObjectToJSON(tmp);
216 snprintf( buf, l, ",\"debug\": %s", j);
227 /* insert the status code */
232 snprintf(buf, 32, "<status>%d</status>", statuscode );
234 snprintf(buf, 32, ",\"status\":%d", statuscode );
239 ap_rputs("</response>", r);
241 ap_rputs( "}", r ); /* finish off the object */
243 osrf_app_session_destroy(session);
246 osrfLogInfo(OSRF_LOG_MARK, "Completed processing service=%s, method=%s", service, method);
247 string_array_destroy(params);
248 string_array_destroy(mparams);
250 osrfLogDebug(OSRF_LOG_MARK, "Gateway served %d requests", ++numserved);
256 #ifdef OSRF_GATEWAY_NASTY_DEBUG
257 /* --------------------------------------------------------------------- */
259 static int osrf_dbg_pre_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp){
260 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_pre_config hook");
263 static int osrf_dbg_post_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s) {
264 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_post_config hook");
267 static int osrf_dbg_open_logs(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s) {
268 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_open_logs hook");
271 static int osrf_dbg_quick_handler(request_rec *r, int lookup_uri) {
272 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_quick_handler hook");
275 static int osrf_dbg_pre_connection(conn_rec *c, void *csd) {
276 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_pre_connection hook");
279 static int osrf_dbg_process_connection(conn_rec *c) {
280 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_process_connection hook");
283 static int osrf_dbg_post_read_request(request_rec *r) {
284 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_read_request hook");
287 static int osrf_dbg_logger(request_rec *r) {
288 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_dbg_logger hook");
291 static int osrf_dbg_translate_handler(request_rec *r) {
292 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_translate_handler hook");
295 static int osrf_dbg_header_parser_handler(request_rec *r) {
296 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_header_parser_handler hook");
299 static int osrf_dbg_check_user_id(request_rec *r) {
300 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_check_user_id hook");
303 static int osrf_dbg_fixer_upper(request_rec *r) {
304 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_fixer_upper hook");
307 static int osrf_dbg_type_checker(request_rec *r) {
308 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_type_checker hook");
311 static int osrf_dbg_access_checker(request_rec *r) {
312 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_access_checker hook");
315 static int osrf_dbg_auth_checker(request_rec *r) {
316 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_auth_checker hook");
319 static void osrf_dbg_insert_filter(request_rec *r) {
320 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_insert_filter hook");
322 /* --------------------------------------------------------------------- */
326 static void osrf_json_gateway_register_hooks (apr_pool_t *p) {
327 ap_hook_handler(osrf_json_gateway_method_handler, NULL, NULL, APR_HOOK_MIDDLE);
328 ap_hook_child_init(osrf_json_gateway_child_init,NULL,NULL,APR_HOOK_MIDDLE);
330 #ifdef OSRF_GATEWAY_NASTY_DEBUG
331 ap_hook_pre_config(osrf_dbg_pre_config, NULL, NULL, APR_HOOK_MIDDLE);
332 ap_hook_post_config(osrf_dbg_post_config, NULL, NULL, APR_HOOK_MIDDLE);
333 ap_hook_open_logs(osrf_dbg_open_logs, NULL, NULL, APR_HOOK_MIDDLE);
334 ap_hook_quick_handler(osrf_dbg_quick_handler, NULL, NULL, APR_HOOK_MIDDLE);
335 ap_hook_pre_connection(osrf_dbg_pre_connection, NULL, NULL, APR_HOOK_MIDDLE);
336 ap_hook_process_connection(osrf_dbg_process_connection, NULL, NULL, APR_HOOK_MIDDLE);
337 ap_hook_post_read_request(osrf_dbg_post_read_request, NULL, NULL, APR_HOOK_MIDDLE);
338 ap_hook_log_transaction(osrf_dbg_logger, NULL, NULL, APR_HOOK_MIDDLE);
339 ap_hook_translate_name(osrf_dbg_translate_handler, NULL, NULL, APR_HOOK_MIDDLE);
340 ap_hook_header_parser(osrf_dbg_header_parser_handler, NULL, NULL, APR_HOOK_MIDDLE);
341 ap_hook_check_user_id(osrf_dbg_check_user_id, NULL, NULL, APR_HOOK_MIDDLE);
342 ap_hook_fixups(osrf_dbg_fixer_upper, NULL, NULL, APR_HOOK_MIDDLE);
343 ap_hook_type_checker(osrf_dbg_type_checker, NULL, NULL, APR_HOOK_MIDDLE);
344 ap_hook_access_checker(osrf_dbg_access_checker, NULL, NULL, APR_HOOK_MIDDLE);
345 ap_hook_auth_checker(osrf_dbg_auth_checker, NULL, NULL, APR_HOOK_MIDDLE);
346 ap_hook_insert_filter(osrf_dbg_insert_filter, NULL, NULL, APR_HOOK_MIDDLE);
351 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module = {
352 STANDARD20_MODULE_STUFF,
355 osrf_json_gateway_create_config,
357 osrf_json_gateway_cmds,
358 osrf_json_gateway_register_hooks,