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>
12 #define MODULE_NAME "osrf_json_gateway_module"
13 #define GATEWAY_CONFIG "OSRFGatewayConfig"
14 #define CONFIG_CONTEXT "gateway"
16 #define GATEWAY_DEFAULT_CONFIG "/openils/conf/opensrf_core.xml"
19 /* our config structure */
21 char* configfile; /* our bootstrap config file */
22 } osrf_json_gateway_config;
24 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module;
26 char* osrf_json_gateway_config_file = NULL;
29 osrfStringArray* allowedServices = NULL;
31 static const char* osrf_json_gateway_set_config(cmd_parms *parms, void *config, const char *arg) {
32 osrf_json_gateway_config *cfg;
33 cfg = ap_get_module_config(parms->server->module_config, &osrf_json_gateway_module);
34 cfg->configfile = (char*) arg;
35 osrf_json_gateway_config_file = (char*) arg;
39 /* tell apache about our commands */
40 static const command_rec osrf_json_gateway_cmds[] = {
41 AP_INIT_TAKE1( GATEWAY_CONFIG, osrf_json_gateway_set_config,
42 NULL, RSRC_CONF, "osrf json gateway config file"),
46 /* build the config object */
47 static void* osrf_json_gateway_create_config( apr_pool_t* p, server_rec* s) {
48 osrf_json_gateway_config* cfg = (osrf_json_gateway_config*)
49 apr_palloc(p, sizeof(osrf_json_gateway_config));
50 cfg->configfile = GATEWAY_DEFAULT_CONFIG;
55 static void osrf_json_gateway_child_init(apr_pool_t *p, server_rec *s) {
57 char* cfg = osrf_json_gateway_config_file;
61 snprintf(buf, 32, "%d", t);
63 if( ! osrfSystemBootstrapClientResc( cfg, CONFIG_CONTEXT, buf ) ) {
64 ap_log_error( APLOG_MARK, APLOG_ERR, 0, s,
65 "Unable to Bootstrap OpenSRF Client with config %s..", cfg);
70 allowedServices = osrfNewStringArray(8);
71 osrfLogInfo(OSRF_LOG_MARK, "Bootstrapping gateway child for requests");
72 osrfConfigGetValueList( NULL, allowedServices, "/services/service" );
75 for( i = 0; i < allowedServices->size; i++ ) {
76 ap_log_error( APLOG_MARK, APLOG_DEBUG, 0, s,
77 "allowed service: %s\n", osrfStringArrayGetString(allowedServices, i));
81 static int osrf_json_gateway_method_handler (request_rec *r) {
83 /* make sure we're needed first thing*/
84 if (strcmp(r->handler, MODULE_NAME )) return DECLINED;
86 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: entered request handler");
88 /* verify we are connected */
89 if( !bootstrapped || !osrf_system_get_transport_client()) {
90 ap_log_rerror( APLOG_MARK, APLOG_ERR, 0, r, "Cannot process request "
91 "because the OpenSRF JSON gateway has not been bootstrapped...");
92 usleep( 100000 ); /* 100 milliseconds */
96 osrfLogSetAppname("osrf_json_gw");
98 char* service = NULL; /* service to connect to */
99 char* method = NULL; /* method to perform */
100 char* format = NULL; /* method to perform */
101 char* a_l = NULL; /* request api level */
105 r->allowed |= (AP_METHOD_BIT << M_GET);
106 r->allowed |= (AP_METHOD_BIT << M_POST);
108 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: parsing URL params");
109 string_array* mparams = NULL;
110 string_array* params = apacheParseParms(r); /* free me */
111 service = apacheGetFirstParamValue( params, "service" );
112 method = apacheGetFirstParamValue( params, "method" );
113 format = apacheGetFirstParamValue( params, "format" );
114 a_l = apacheGetFirstParamValue( params, "api_level" );
115 mparams = apacheGetParamValues( params, "param" ); /* free me */
117 /* set the user defined timeout value */
119 char* tout = apacheGetFirstParamValue( params, "timeout" ); /* request timeout in seconds */
121 timeout = atoi(tout);
122 osrfLogDebug(OSRF_LOG_MARK, "Client supplied timeout of %d", timeout);
127 api_level = atoi(a_l);
129 if (format && !strcasecmp(format, "xml" )) {
131 ap_set_content_type(r, "application/xml");
133 ap_set_content_type(r, "text/plain");
138 if(!(service && method) ||
139 !osrfStringArrayContains(allowedServices, service)) {
141 osrfLogError(OSRF_LOG_MARK,
142 "Service [%s] not found or not allowed", service);
143 ret = HTTP_NOT_FOUND;
147 /* This will log all heaers to the apache error log
148 const apr_array_header_t* arr = apr_table_elts(r->headers_in);
151 while( (ptr = apr_array_pop(arr)) ) {
152 apr_table_entry_t* e = (apr_table_entry_t*) ptr;
153 fprintf(stderr, "Table entry: %s : %s\n", e->key, e->val );
158 osrfAppSession* session = osrf_app_client_session_init(service);
160 double starttime = get_timestamp_millis();
161 int req_id = osrf_app_session_make_req( session, NULL, method, api_level, mparams );
165 osrfLogError(OSRF_LOG_MARK, "I am unable to communcate with opensrf..going away...");
166 /* we don't want to spawn an intense re-forking storm
167 * if there is no jabber server.. so give it some time before we die */
168 usleep( 100000 ); /* 100 milliseconds */
173 /* ----------------------------------------------------------------- */
174 /* log all requests to the activity log */
175 const char* authtoken = apr_table_get(r->headers_in, "X-OILS-Authtoken");
176 if(!authtoken) authtoken = "";
177 growing_buffer* act = buffer_init(128);
178 buffer_fadd(act, "[%s] [%s] %s %s", r->connection->remote_ip, authtoken, service, method );
179 char* str; int i = 0;
180 while( (str = osrfStringArrayGetString(mparams, i++)) ) {
182 OSRF_BUFFER_ADD(act, " ");
183 OSRF_BUFFER_ADD(act, str);
185 OSRF_BUFFER_ADD(act, ", ");
186 OSRF_BUFFER_ADD(act, str);
190 osrfLogActivity( OSRF_LOG_MARK, act->buf );
192 /* ----------------------------------------------------------------- */
195 osrf_message* omsg = NULL;
197 int statuscode = 200;
199 /* kick off the object */
201 ap_rputs("<response xmlns=\"http://opensrf.org/-/namespaces/gateway/v1\"><payload>", r);
203 ap_rputs("{\"payload\":[", r);
206 char* statusname = NULL;
207 char* statustext = NULL;
210 while((omsg = osrfAppSessionRequestRecv( session, req_id, timeout ))) {
212 statuscode = omsg->status_code;
215 if( ( res = osrfMessageGetResult(omsg)) ) {
218 output = jsonObjectToXML( res );
220 output = jsonObjectToJSON( res );
221 if( morethan1 ) ap_rputs(",", r); /* comma between JSON array items */
229 if( statuscode > 299 ) { /* the request returned a low level error */
230 statusname = omsg->status_name ? strdup(omsg->status_name) : strdup("Unknown Error");
231 statustext = omsg->status_text ? strdup(omsg->status_text) : strdup("No Error Message");
232 osrfLogError( OSRF_LOG_MARK, "Gateway received error: %s", statustext );
236 osrf_message_free(omsg);
237 if(statusname) break;
240 double duration = get_timestamp_millis() - starttime;
241 osrfLogDebug(OSRF_LOG_MARK, "gateway request took %lf seconds", duration);
245 ap_rputs("</payload>", r);
247 ap_rputs("]",r); /* finish off the payload array */
251 /* add a debug field if the request died */
252 ap_log_rerror( APLOG_MARK, APLOG_INFO, 0, r,
253 "OpenSRF JSON Request returned error: %s -> %s", statusname, statustext );
254 int l = strlen(statusname) + strlen(statustext) + 32;
259 snprintf( buf, l, "<debug>\"%s : %s\"</debug>", statusname, statustext );
264 snprintf(bb, l, "%s : %s", statusname, statustext);
265 jsonObject* tmp = jsonNewObject(bb);
266 char* j = jsonObjectToJSON(tmp);
267 snprintf( buf, l, ",\"debug\": %s", j);
278 /* insert the status code */
283 snprintf(buf, 32, "<status>%d</status>", statuscode );
285 snprintf(buf, 32, ",\"status\":%d", statuscode );
290 ap_rputs("</response>", r);
292 ap_rputs( "}", r ); /* finish off the object */
294 osrf_app_session_destroy(session);
297 osrfLogInfo(OSRF_LOG_MARK, "Completed processing service=%s, method=%s", service, method);
298 string_array_destroy(params);
299 string_array_destroy(mparams);
301 osrfLogDebug(OSRF_LOG_MARK, "Gateway served %d requests", ++numserved);
309 static void osrf_json_gateway_register_hooks (apr_pool_t *p) {
310 ap_hook_handler(osrf_json_gateway_method_handler, NULL, NULL, APR_HOOK_MIDDLE);
311 ap_hook_child_init(osrf_json_gateway_child_init,NULL,NULL,APR_HOOK_MIDDLE);
315 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module = {
316 STANDARD20_MODULE_STUFF,
319 osrf_json_gateway_create_config,
321 osrf_json_gateway_cmds,
322 osrf_json_gateway_register_hooks,