src/gateway/osrf_json_gateway.c

   1 #include "apachetools.h"
   2 #include "opensrf/osrf_app_session.h"
   3 #include "opensrf/osrf_system.h"
   4 #include "objson/object.h"
   5 #include "objson/json2xml.h"
   6 #include <sys/time.h>
   7 #include <sys/resource.h>
   8
   9
  10 #define MODULE_NAME "osrf_json_gateway_module"
  11 #define GATEWAY_CONFIG "OSRFGatewayConfig"
  12 #define CONFIG_CONTEXT "gateway"
  13
  14 #define GATEWAY_DEFAULT_CONFIG "/openils/conf/opensrf_core.xml"
  15
  16
  17 /* our config structure */
  18 typedef struct {
  19         char* configfile;  /* our bootstrap config file */
  20 } osrf_json_gateway_config;
  21
  22 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module;
  23
  24 char* osrf_json_gateway_config_file = NULL;
  25 int bootstrapped = 0;
  26 int numserved = 0;
  27
  28 static const char* osrf_json_gateway_set_config(cmd_parms *parms, void *config, const char *arg) {
  29         osrf_json_gateway_config  *cfg;
  30         cfg = ap_get_module_config(parms->server->module_config, &osrf_json_gateway_module);
  31         cfg->configfile = (char*) arg;
  32         osrf_json_gateway_config_file = (char*) arg;
  33         return NULL;
  34 }
  35
  36 /* tell apache about our commands */
  37 static const command_rec osrf_json_gateway_cmds[] = {
  38         AP_INIT_TAKE1( GATEWAY_CONFIG, osrf_json_gateway_set_config,
  39                         NULL, RSRC_CONF, "osrf json gateway config file"),
  40         {NULL}
  41 };
  42
  43 /* build the config object */
  44 static void* osrf_json_gateway_create_config( apr_pool_t* p, server_rec* s) {
  45         osrf_json_gateway_config* cfg = (osrf_json_gateway_config*)
  46                         apr_palloc(p, sizeof(osrf_json_gateway_config));
  47         cfg->configfile = GATEWAY_DEFAULT_CONFIG;
  48         return (void*) cfg;
  49 }
  50
  51
  52 static void osrf_json_gateway_child_init(apr_pool_t *p, server_rec *s) {
  53
  54         char* cfg = osrf_json_gateway_config_file;
  55         if( ! osrf_system_bootstrap_client( cfg, CONFIG_CONTEXT) ) {
  56                 ap_log_error( APLOG_MARK, APLOG_ERR, 0, s,
  57                         "Unable to Bootstrap OpenSRF Client with config %s..", cfg);
  58                 return;
  59         }
  60         bootstrapped = 1;
  61         osrfLogInfo(OSRF_LOG_MARK, "Bootstrapping gateway child for requests");
  62
  63
  64 #ifdef OSRF_GATEWAY_ENABLE_RLIMIT /* emergency measures only */
  65         struct rlimit lim = { 536870912, 536870912 }; /* 512MB */
  66         setrlimit(RLIMIT_AS, &lim);
  67         setrlimit(RLIMIT_MEMLOCK,&lim);
  68         setrlimit(RLIMIT_STACK, &lim);
  69         setrlimit(RLIMIT_DATA,&lim);
  70
  71         struct rlimit lim2;
  72         getrlimit(RLIMIT_DATA, &lim2);
  73         osrfLogDebug(OSRF_LOG_MARK, "rlimit for data set to %d", lim2.rlim_cur);
  74 #endif
  75
  76 }
  77
  78 static int osrf_json_gateway_method_handler (request_rec *r) {
  79
  80         /* make sure we're needed first thing*/
  81         if (strcmp(r->handler, MODULE_NAME )) return DECLINED;
  82
  83         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: entered request handler");
  84
  85         /* verify we are connected */
  86         if( !bootstrapped || !osrf_system_get_transport_client()) {
  87                 ap_log_rerror( APLOG_MARK, APLOG_ERR, 0, r, "Cannot process request "
  88                                 "because the OpenSRF JSON gateway has not been bootstrapped...");
  89                 return HTTP_INTERNAL_SERVER_ERROR;
  90         }
  91
  92         osrfLogSetAppname("osrf_json_gw");
  93
  94         char* service           = NULL; /* service to connect to */
  95         char* method            = NULL; /* method to perform */
  96         char* format            = NULL; /* method to perform */
  97         char* a_l                       = NULL; /* request api level */
  98         int   isXML                     = 0;
  99         int   api_level = 1;
 100
 101         r->allowed |= (AP_METHOD_BIT << M_GET);
 102         r->allowed |= (AP_METHOD_BIT << M_POST);
 103
 104         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: parsing URL params");
 105         string_array* mparams   = NULL;
 106         string_array* params            = apacheParseParms(r); /* free me */
 107         service         = apacheGetFirstParamValue( params, "service" );
 108         method          = apacheGetFirstParamValue( params, "method" );
 109         format          = apacheGetFirstParamValue( params, "format" );
 110         a_l                     = apacheGetFirstParamValue( params, "api_level" );
 111         mparams         = apacheGetParamValues( params, "param" ); /* free me */
 112
 113         if (a_l)
 114                 api_level = atoi(a_l);
 115
 116         if (format && !strcasecmp(format, "xml" )) {
 117                 isXML = 1;
 118                 ap_set_content_type(r, "application/xml");
 119         } else {
 120                 ap_set_content_type(r, "text/plain");
 121         }
 122
 123
 124         if( service && method ) {
 125
 126                 osrfLogInfo( OSRF_LOG_MARK,  "service=%s, method=%s", service, method );
 127                 osrfAppSession* session = osrf_app_client_session_init(service);
 128                 int req_id = osrf_app_session_make_req( session, NULL, method, api_level, mparams );
 129                 osrf_message* omsg = NULL;
 130
 131                 int statuscode = 200;
 132
 133                 /* kick off the object */
 134                 if (isXML)
 135                         ap_rputs("<response xmlns=\"http://opensrf.org/-/namespaces/gateway/v1\"><payload>", r);
 136                 else
 137                         ap_rputs("{\"payload\":[", r);
 138
 139                 int morethan1           = 0;
 140                 char* statusname        = NULL;
 141                 char* statustext        = NULL;
 142                 char* output            = NULL;
 143
 144                 while((omsg = osrfAppSessionRequestRecv( session, req_id, 60 ))) {
 145
 146                         statuscode = omsg->status_code;
 147                         jsonObject* res;
 148
 149                         if( ( res = osrfMessageGetResult(omsg)) ) {
 150
 151                                 if (isXML) {
 152                                         output = jsonObjectToXML( res );
 153                                 } else {
 154                                         output = jsonObjectToJSON( res );
 155                                         if( morethan1 ) ap_rputs(",", r); /* comma between JSON array items */
 156                                 }
 157                                 ap_rputs(output, r);
 158                                 free(output);
 159                                 morethan1 = 1;
 160
 161                         } else {
 162
 163                                 if( statuscode > 299 ) { /* the request returned a low level error */
 164                                         statusname = omsg->status_name ? strdup(omsg->status_name) : strdup("Unknown Error");
 165                                         statustext = omsg->status_text ? strdup(omsg->status_text) : strdup("No Error Message");
 166                                         osrfLogError( OSRF_LOG_MARK,  "Gateway received error: %s", statustext );
 167                                 }
 168                         }
 169
 170                         osrf_message_free(omsg);
 171                         if(statusname) break;
 172                 }
 173
 174                 if (isXML)
 175                         ap_rputs("</payload>", r);
 176                 else
 177                         ap_rputs("]",r); /* finish off the payload array */
 178
 179                 if(statusname) {
 180
 181                         /* add a debug field if the request died */
 182                         ap_log_rerror( APLOG_MARK, APLOG_INFO, 0, r,
 183                                         "OpenSRF JSON Request returned error: %s -> %s", statusname, statustext );
 184                         int l = strlen(statusname) + strlen(statustext) + 32;
 185                         char buf[l];
 186                         bzero(buf,l);
 187
 188                         if (isXML)
 189                                 snprintf( buf, l, "<debug>\"%s : %s\"</debug>", statusname, statustext );
 190
 191                         else {
 192                                 char bb[l];
 193                                 bzero(bb, l);
 194                                 snprintf(bb, l,  "%s : %s", statusname, statustext);
 195                                 jsonObject* tmp = jsonNewObject(bb);
 196                                 char* j = jsonObjectToJSON(tmp);
 197                                 snprintf( buf, l, ",\"debug\": %s", j);
 198                                 free(j);
 199                                 jsonObjectFree(tmp);
 200                         }
 201
 202                         ap_rputs(buf, r);
 203
 204                         free(statusname);
 205                         free(statustext);
 206                 }
 207
 208                 /* insert the status code */
 209                 char buf[32];
 210                 bzero(buf,32);
 211
 212                 if (isXML)
 213                         snprintf(buf, 32, "<status>%d</status>", statuscode );
 214                 else
 215                         snprintf(buf, 32, ",\"status\":%d", statuscode );
 216
 217                 ap_rputs( buf, r );
 218
 219                 if (isXML)
 220                         ap_rputs("</response>", r);
 221                 else
 222                         ap_rputs( "}", r ); /* finish off the object */
 223
 224                 osrf_app_session_destroy(session);
 225         }
 226
 227         osrfLogInfo(OSRF_LOG_MARK, "Completed processing service=%s, method=%s", service, method);
 228         string_array_destroy(params);
 229         string_array_destroy(mparams);
 230
 231         osrfLogDebug(OSRF_LOG_MARK, "Gateway served %d requests", ++numserved);
 232
 233         return OK;
 234 }
 235
 236
 237 /* --------------------------------------------------------------------- */
 238 /* DEBUG HOOKS */
 239 static int osrf_dbg_pre_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp){
 240         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_pre_config hook");
 241         return OK;
 242 }
 243 static int osrf_dbg_post_config(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s) {
 244         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_post_config hook");
 245         return OK;
 246 }
 247 static int osrf_dbg_open_logs(apr_pool_t *pconf, apr_pool_t *plog, apr_pool_t *ptemp, server_rec *s) {
 248         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_open_logs hook");
 249         return OK;
 250 }
 251 static int osrf_dbg_quick_handler(request_rec *r, int lookup_uri) {
 252         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_quick_handler hook");
 253         return DECLINED;
 254 }
 255 static int osrf_dbg_pre_connection(conn_rec *c, void *csd) {
 256         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_pre_connection hook");
 257         return OK;
 258 }
 259 static int osrf_dbg_process_connection(conn_rec *c) {
 260         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_process_connection hook");
 261         return DECLINED;
 262 }
 263 static int osrf_dbg_post_read_request(request_rec *r) {
 264         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_read_request hook");
 265         return DECLINED;
 266 }
 267 static int osrf_dbg_logger(request_rec *r) {
 268         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_dbg_logger hook");
 269         return DECLINED;
 270 }
 271 static int osrf_dbg_translate_handler(request_rec *r) {
 272         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_translate_handler hook");
 273         return DECLINED;
 274 }
 275 static int osrf_dbg_header_parser_handler(request_rec *r) {
 276         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_header_parser_handler hook");
 277         return DECLINED;
 278 }
 279 static int osrf_dbg_check_user_id(request_rec *r) {
 280         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_check_user_id hook");
 281         return DECLINED;
 282 }
 283 static int osrf_dbg_fixer_upper(request_rec *r) {
 284         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_fixer_upper hook");
 285         return OK;
 286 }
 287 static int osrf_dbg_type_checker(request_rec *r) {
 288         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_type_checker hook");
 289         return DECLINED;
 290 }
 291 static int osrf_dbg_access_checker(request_rec *r) {
 292         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_access_checker hook");
 293         return DECLINED;
 294 }
 295 static int osrf_dbg_auth_checker(request_rec *r) {
 296         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_auth_checker hook");
 297         return DECLINED;
 298 }
 299 static void osrf_dbg_insert_filter(request_rec *r) {
 300         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_insert_filter hook");
 301 }
 302 /* --------------------------------------------------------------------- */
 303
 304
 305 static void osrf_json_gateway_register_hooks (apr_pool_t *p) {
 306         ap_hook_handler(osrf_json_gateway_method_handler, NULL, NULL, APR_HOOK_MIDDLE);
 307         ap_hook_child_init(osrf_json_gateway_child_init,NULL,NULL,APR_HOOK_MIDDLE);
 308
 309 #ifdef OSRF_GATEWAY_NASTY_DEBUG
 310         ap_hook_pre_config(osrf_dbg_pre_config, NULL, NULL, APR_HOOK_MIDDLE);
 311         ap_hook_post_config(osrf_dbg_post_config, NULL, NULL, APR_HOOK_MIDDLE);
 312         ap_hook_open_logs(osrf_dbg_open_logs, NULL, NULL, APR_HOOK_MIDDLE);
 313         ap_hook_quick_handler(osrf_dbg_quick_handler, NULL, NULL, APR_HOOK_MIDDLE);
 314         ap_hook_pre_connection(osrf_dbg_pre_connection, NULL, NULL, APR_HOOK_MIDDLE);
 315         ap_hook_process_connection(osrf_dbg_process_connection, NULL, NULL, APR_HOOK_MIDDLE);
 316         ap_hook_post_read_request(osrf_dbg_post_read_request, NULL, NULL, APR_HOOK_MIDDLE);
 317         ap_hook_log_transaction(osrf_dbg_logger, NULL, NULL, APR_HOOK_MIDDLE);
 318         ap_hook_translate_name(osrf_dbg_translate_handler, NULL, NULL, APR_HOOK_MIDDLE);
 319         ap_hook_header_parser(osrf_dbg_header_parser_handler, NULL, NULL, APR_HOOK_MIDDLE);
 320         ap_hook_check_user_id(osrf_dbg_check_user_id, NULL, NULL, APR_HOOK_MIDDLE);
 321         ap_hook_fixups(osrf_dbg_fixer_upper, NULL, NULL, APR_HOOK_MIDDLE);
 322         ap_hook_type_checker(osrf_dbg_type_checker, NULL, NULL, APR_HOOK_MIDDLE);
 323         ap_hook_access_checker(osrf_dbg_access_checker, NULL, NULL, APR_HOOK_MIDDLE);
 324         ap_hook_auth_checker(osrf_dbg_auth_checker, NULL, NULL, APR_HOOK_MIDDLE);
 325         ap_hook_insert_filter(osrf_dbg_insert_filter, NULL, NULL, APR_HOOK_MIDDLE);
 326 #endif
 327 }
 328
 329
 330 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module = {
 331         STANDARD20_MODULE_STUFF,
 332         NULL,
 333         NULL,
 334         osrf_json_gateway_create_config,
 335         NULL,
 336         osrf_json_gateway_cmds,
 337         osrf_json_gateway_register_hooks,
 338 };
 339
 340
 341
 342