1 #include "apachetools.h"
2 #include "opensrf/osrf_app_session.h"
3 #include "opensrf/osrf_system.h"
4 #include "opensrf/osrfConfig.h"
5 #include <opensrf/osrf_json.h>
6 #include <opensrf/osrf_json_xml.h>
7 #include <opensrf/osrf_legacy_json.h>
9 #include <sys/resource.h>
14 #define MODULE_NAME "osrf_json_gateway_module"
15 #define GATEWAY_CONFIG "OSRFGatewayConfig"
16 #define DEFAULT_LOCALE "OSRFDefaultLocale"
17 #define CONFIG_CONTEXT "gateway"
18 #define JSON_PROTOCOL "OSRFGatewayLegacyJSON"
19 #define GATEWAY_USE_LEGACY_JSON 1
21 #define GATEWAY_DEFAULT_CONFIG "/openils/conf/opensrf_core.xml"
24 /* our config structure */
26 char* configfile; /* our bootstrap config file */
27 } osrf_json_gateway_config;
31 } osrf_json_gateway_dir_config;
34 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module;
36 char* osrf_json_default_locale = "en-US";
37 char* osrf_json_gateway_config_file = NULL;
40 osrfStringArray* allowedServices = NULL;
42 static const char* osrf_json_gateway_set_default_locale(cmd_parms *parms, void *config, const char *arg) {
44 osrf_json_default_locale = (char*) arg;
48 static const char* osrf_json_gateway_set_config(cmd_parms *parms, void *config, const char *arg) {
49 osrf_json_gateway_config *cfg;
50 cfg = ap_get_module_config(parms->server->module_config, &osrf_json_gateway_module);
51 cfg->configfile = (char*) arg;
52 osrf_json_gateway_config_file = (char*) arg;
56 static const char* osrf_json_gateway_set_json_proto(cmd_parms *parms, void *config, const char *arg) {
57 osrf_json_gateway_dir_config* cfg = (osrf_json_gateway_dir_config*) config;
58 cfg->legacyJSON = (!strcasecmp((char*) arg, "false")) ? 0 : 1;
62 /* tell apache about our commands */
63 static const command_rec osrf_json_gateway_cmds[] = {
64 AP_INIT_TAKE1( GATEWAY_CONFIG, osrf_json_gateway_set_config,
65 NULL, RSRC_CONF, "osrf json gateway config file"),
66 AP_INIT_TAKE1( DEFAULT_LOCALE, osrf_json_gateway_set_default_locale,
67 NULL, RSRC_CONF, "osrf json gateway default locale"),
68 AP_INIT_TAKE1( JSON_PROTOCOL, osrf_json_gateway_set_json_proto,
69 NULL, ACCESS_CONF, "osrf json gateway config file"),
73 /* build the config object */
74 static void* osrf_json_gateway_create_config( apr_pool_t* p, server_rec* s) {
75 osrf_json_gateway_config* cfg = (osrf_json_gateway_config*)
76 apr_palloc(p, sizeof(osrf_json_gateway_config));
77 cfg->configfile = GATEWAY_DEFAULT_CONFIG;
81 static void* osrf_json_gateway_create_dir_config( apr_pool_t* p, char* dir) {
82 osrf_json_gateway_dir_config* cfg = (osrf_json_gateway_dir_config*)
83 apr_palloc(p, sizeof(osrf_json_gateway_dir_config));
84 cfg->legacyJSON = GATEWAY_USE_LEGACY_JSON;
89 static void osrf_json_gateway_child_init(apr_pool_t *p, server_rec *s) {
91 char* cfg = osrf_json_gateway_config_file;
95 snprintf(buf, 32, "%d", t);
97 if( ! osrfSystemBootstrapClientResc( cfg, CONFIG_CONTEXT, buf ) ) {
98 ap_log_error( APLOG_MARK, APLOG_ERR, 0, s,
99 "Unable to Bootstrap OpenSRF Client with config %s..", cfg);
104 allowedServices = osrfNewStringArray(8);
105 osrfLogInfo(OSRF_LOG_MARK, "Bootstrapping gateway child for requests");
106 osrfConfigGetValueList( NULL, allowedServices, "/services/service" );
109 for( i = 0; i < allowedServices->size; i++ ) {
110 ap_log_error( APLOG_MARK, APLOG_DEBUG, 0, s,
111 "allowed service: %s\n", osrfStringArrayGetString(allowedServices, i));
115 static int osrf_json_gateway_method_handler (request_rec *r) {
117 /* make sure we're needed first thing*/
118 if (strcmp(r->handler, MODULE_NAME )) return DECLINED;
121 osrf_json_gateway_dir_config* dir_conf =
122 ap_get_module_config(r->per_dir_config, &osrf_json_gateway_module);
125 /* provide 2 different JSON parsers and serializers to support legacy JSON */
126 jsonObject* (*parseJSONFunc) (char*) = legacy_jsonParseString;
127 char* (*jsonToStringFunc) (const jsonObject*) = legacy_jsonObjectToJSON;
129 if(dir_conf->legacyJSON) {
130 ap_log_rerror( APLOG_MARK, APLOG_INFO, 0, r, "Using legacy JSON");
133 ap_log_rerror( APLOG_MARK, APLOG_INFO, 0, r, "Not using legacy JSON");
134 parseJSONFunc = jsonParseString;
135 jsonToStringFunc = jsonObjectToJSON;
139 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: entered request handler");
141 /* verify we are connected */
142 if( !bootstrapped || !osrf_system_get_transport_client()) {
143 ap_log_rerror( APLOG_MARK, APLOG_ERR, 0, r, "Cannot process request "
144 "because the OpenSRF JSON gateway has not been bootstrapped...");
145 usleep( 100000 ); /* 100 milliseconds */
149 osrfLogSetAppname("osrf_json_gw");
151 char* osrf_locale = NULL;
152 char* param_locale = NULL; /* locale for this call */
153 char* service = NULL; /* service to connect to */
154 char* method = NULL; /* method to perform */
155 char* format = NULL; /* method to perform */
156 char* a_l = NULL; /* request api level */
157 char* input_format = NULL; /* POST data format, defaults to 'format' */
161 r->allowed |= (AP_METHOD_BIT << M_GET);
162 r->allowed |= (AP_METHOD_BIT << M_POST);
164 osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: parsing URL params");
165 string_array* mparams = NULL;
166 string_array* params = apacheParseParms(r); /* free me */
167 param_locale = apacheGetFirstParamValue( params, "locale" );
168 service = apacheGetFirstParamValue( params, "service" );
169 method = apacheGetFirstParamValue( params, "method" );
170 format = apacheGetFirstParamValue( params, "format" );
171 input_format = apacheGetFirstParamValue( params, "input_format" );
172 a_l = apacheGetFirstParamValue( params, "api_level" );
173 mparams = apacheGetParamValues( params, "param" ); /* free me */
177 if(input_format == NULL)
178 input_format = format;
180 /* set the user defined timeout value */
182 char* tout = apacheGetFirstParamValue( params, "timeout" ); /* request timeout in seconds */
184 timeout = atoi(tout);
185 osrfLogDebug(OSRF_LOG_MARK, "Client supplied timeout of %d", timeout);
189 api_level = atoi(a_l);
191 if (!strcasecmp(format, "xml")) {
193 ap_set_content_type(r, "application/xml");
195 ap_set_content_type(r, "text/plain");
200 /* ----------------------------------------------------------------- */
201 /* Grab the requested locale using the Accept-Language header*/
204 if ( !param_locale ) {
205 if ( apr_table_get(r->headers_in, "X-OpenSRF-Language") ) {
206 param_locale = strdup( apr_table_get(r->headers_in, "X-OpenSRF-Language") );
207 } else if ( apr_table_get(r->headers_in, "Accept-Language") ) {
208 param_locale = strdup( apr_table_get(r->headers_in, "Accept-Language") );
214 growing_buffer* osrf_locale_buf = buffer_init(16);
215 if (index(param_locale, ',')) {
216 int ind = index(param_locale, ',') - param_locale;
218 for ( i = 0; i < ind && i < 128; i++ )
219 buffer_add_char( osrf_locale_buf, param_locale[i] );
221 buffer_add( osrf_locale_buf, param_locale );
225 osrf_locale = buffer_release( osrf_locale_buf );
227 osrf_locale = strdup( osrf_json_default_locale );
229 /* ----------------------------------------------------------------- */
232 if(!(service && method) ||
233 !osrfStringArrayContains(allowedServices, service)) {
235 osrfLogError(OSRF_LOG_MARK,
236 "Service [%s] not found or not allowed", service);
237 ret = HTTP_NOT_FOUND;
241 /* This will log all heaers to the apache error log
242 const apr_array_header_t* arr = apr_table_elts(r->headers_in);
245 while( (ptr = apr_array_pop(arr)) ) {
246 apr_table_entry_t* e = (apr_table_entry_t*) ptr;
247 fprintf(stderr, "Table entry: %s : %s\n", e->key, e->val );
252 osrfAppSession* session = osrf_app_client_session_init(service);
253 osrf_app_session_set_locale(session, osrf_locale);
255 double starttime = get_timestamp_millis();
258 if(!strcasecmp(input_format, "json")) {
259 jsonObject * arr = jsonNewObject(NULL);
264 while( (str = osrfStringArrayGetString(mparams, i++)) )
265 jsonObjectPush(arr, parseJSONFunc(str));
267 req_id = osrf_app_session_make_req( session, arr, method, api_level, NULL );
271 * If we receive XML method params, convert each param to a JSON object
272 * and pass the array of JSON object params to the method */
273 if(!strcasecmp(input_format, "xml")) {
274 jsonObject* jsonParams = jsonNewObject(NULL);
278 while( (str = osrfStringArrayGetString(mparams, i++)) ) {
279 jsonObjectPush(jsonParams, jsonXMLToJSONObject(str));
282 req_id = osrf_app_session_make_req( session, jsonParams, method, api_level, NULL );
283 jsonObjectFree(jsonParams);
289 osrfLogError(OSRF_LOG_MARK, "I am unable to communcate with opensrf..going away...");
290 /* we don't want to spawn an intense re-forking storm
291 * if there is no jabber server.. so give it some time before we die */
292 usleep( 100000 ); /* 100 milliseconds */
297 /* ----------------------------------------------------------------- */
298 /* log all requests to the activity log */
299 const char* authtoken = apr_table_get(r->headers_in, "X-OILS-Authtoken");
300 if(!authtoken) authtoken = "";
301 growing_buffer* act = buffer_init(128);
302 buffer_fadd(act, "[%s] [%s] %s %s", r->connection->remote_ip, authtoken, service, method );
303 char* str; int i = 0;
304 while( (str = osrfStringArrayGetString(mparams, i++)) ) {
306 OSRF_BUFFER_ADD(act, " ");
307 OSRF_BUFFER_ADD(act, str);
309 OSRF_BUFFER_ADD(act, ", ");
310 OSRF_BUFFER_ADD(act, str);
314 osrfLogActivity( OSRF_LOG_MARK, act->buf );
316 /* ----------------------------------------------------------------- */
319 osrf_message* omsg = NULL;
321 int statuscode = 200;
323 /* kick off the object */
325 ap_rputs("<response xmlns=\"http://opensrf.org/-/namespaces/gateway/v1\"><payload>", r);
327 ap_rputs("{\"payload\":[", r);
330 char* statusname = NULL;
331 char* statustext = NULL;
334 while((omsg = osrfAppSessionRequestRecv( session, req_id, timeout ))) {
336 statuscode = omsg->status_code;
339 if( ( res = osrfMessageGetResult(omsg)) ) {
342 output = jsonObjectToXML( res );
344 output = jsonToStringFunc( res );
345 if( morethan1 ) ap_rputs(",", r); /* comma between JSON array items */
353 if( statuscode > 299 ) { /* the request returned a low level error */
354 statusname = omsg->status_name ? strdup(omsg->status_name) : strdup("Unknown Error");
355 statustext = omsg->status_text ? strdup(omsg->status_text) : strdup("No Error Message");
356 osrfLogError( OSRF_LOG_MARK, "Gateway received error: %s", statustext );
360 osrf_message_free(omsg);
361 if(statusname) break;
364 double duration = get_timestamp_millis() - starttime;
365 osrfLogDebug(OSRF_LOG_MARK, "gateway request took %f seconds", duration);
369 ap_rputs("</payload>", r);
371 ap_rputs("]",r); /* finish off the payload array */
375 /* add a debug field if the request died */
376 ap_log_rerror( APLOG_MARK, APLOG_INFO, 0, r,
377 "OpenSRF JSON Request returned error: %s -> %s", statusname, statustext );
378 int l = strlen(statusname) + strlen(statustext) + 32;
383 snprintf( buf, l, "<debug>\"%s : %s\"</debug>", statusname, statustext );
388 snprintf(bb, l, "%s : %s", statusname, statustext);
389 jsonObject* tmp = jsonNewObject(bb);
390 char* j = jsonToStringFunc(tmp);
391 snprintf( buf, l, ",\"debug\": %s", j);
402 /* insert the status code */
407 snprintf(buf, 32, "<status>%d</status>", statuscode );
409 snprintf(buf, 32, ",\"status\":%d", statuscode );
414 ap_rputs("</response>", r);
416 ap_rputs( "}", r ); /* finish off the object */
418 osrf_app_session_destroy(session);
421 osrfLogInfo(OSRF_LOG_MARK, "Completed processing service=%s, method=%s", service, method);
422 string_array_destroy(params);
423 string_array_destroy(mparams);
425 osrfLogDebug(OSRF_LOG_MARK, "Gateway served %d requests", ++numserved);
433 static void osrf_json_gateway_register_hooks (apr_pool_t *p) {
434 ap_hook_handler(osrf_json_gateway_method_handler, NULL, NULL, APR_HOOK_MIDDLE);
435 ap_hook_child_init(osrf_json_gateway_child_init,NULL,NULL,APR_HOOK_MIDDLE);
439 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module = {
440 STANDARD20_MODULE_STUFF,
441 osrf_json_gateway_create_dir_config,
443 osrf_json_gateway_create_config,
445 osrf_json_gateway_cmds,
446 osrf_json_gateway_register_hooks,