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 "opensrf/osrfConfig.h"
   5 #include "objson/object.h"
   6 #include "objson/json2xml.h"
   7 #include <sys/time.h>
   8 #include <sys/resource.h>
   9
  10
  11 #define MODULE_NAME "osrf_json_gateway_module"
  12 #define GATEWAY_CONFIG "OSRFGatewayConfig"
  13 #define CONFIG_CONTEXT "gateway"
  14
  15 #define GATEWAY_DEFAULT_CONFIG "/openils/conf/opensrf_core.xml"
  16
  17
  18 /* our config structure */
  19 typedef struct {
  20         char* configfile;  /* our bootstrap config file */
  21 } osrf_json_gateway_config;
  22
  23 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module;
  24
  25 char* osrf_json_gateway_config_file = NULL;
  26 int bootstrapped = 0;
  27 int numserved = 0;
  28 osrfStringArray* allowedServices = NULL;
  29
  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;
  35         return NULL;
  36 }
  37
  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"),
  42         {NULL}
  43 };
  44
  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;
  50         return (void*) cfg;
  51 }
  52
  53
  54 static void osrf_json_gateway_child_init(apr_pool_t *p, server_rec *s) {
  55
  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);
  60                 return;
  61         }
  62
  63         bootstrapped = 1;
  64         allowedServices = osrfNewStringArray(8);
  65         osrfLogInfo(OSRF_LOG_MARK, "Bootstrapping gateway child for requests");
  66         osrfConfigGetValueList( NULL, allowedServices, "/services/service" );
  67
  68         int i;
  69         for( i = 0; i < allowedServices->size; i++ ) {
  70                 fprintf(stderr, "allowed service: %s\n",
  71                         osrfStringArrayGetString(allowedServices, i));
  72         }
  73
  74
  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);
  81
  82         struct rlimit lim2;
  83         getrlimit(RLIMIT_DATA, &lim2);
  84         osrfLogDebug(OSRF_LOG_MARK, "rlimit for data set to %d", lim2.rlim_cur);
  85 #endif
  86
  87 }
  88
  89 static int osrf_json_gateway_method_handler (request_rec *r) {
  90
  91         /* make sure we're needed first thing*/
  92         if (strcmp(r->handler, MODULE_NAME )) return DECLINED;
  93
  94         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: entered request handler");
  95
  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;
 101         }
 102
 103         osrfLogSetAppname("osrf_json_gw");
 104
 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 */
 109         int   isXML                     = 0;
 110         int   api_level = 1;
 111
 112         r->allowed |= (AP_METHOD_BIT << M_GET);
 113         r->allowed |= (AP_METHOD_BIT << M_POST);
 114
 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 */
 123
 124         if (a_l)
 125                 api_level = atoi(a_l);
 126
 127         if (format && !strcasecmp(format, "xml" )) {
 128                 isXML = 1;
 129                 ap_set_content_type(r, "application/xml");
 130         } else {
 131                 ap_set_content_type(r, "text/plain");
 132         }
 133
 134         int ret = OK;
 135
 136         if(!(service && method) ||
 137                 !osrfStringArrayContains(allowedServices, service)) {
 138
 139                 osrfLogError(OSRF_LOG_MARK,
 140                         "Service [%s] not found or not allowed", service);
 141                 ret = HTTP_NOT_FOUND;
 142
 143         } else {
 144
 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;
 149
 150                 int statuscode = 200;
 151
 152                 /* kick off the object */
 153                 if (isXML)
 154                         ap_rputs("<response xmlns=\"http://opensrf.org/-/namespaces/gateway/v1\"><payload>", r);
 155                 else
 156                         ap_rputs("{\"payload\":[", r);
 157
 158                 int morethan1           = 0;
 159                 char* statusname        = NULL;
 160                 char* statustext        = NULL;
 161                 char* output            = NULL;
 162
 163                 while((omsg = osrfAppSessionRequestRecv( session, req_id, 60 ))) {
 164
 165                         statuscode = omsg->status_code;
 166                         jsonObject* res;
 167
 168                         if( ( res = osrfMessageGetResult(omsg)) ) {
 169
 170                                 if (isXML) {
 171                                         output = jsonObjectToXML( res );
 172                                 } else {
 173                                         output = jsonObjectToJSON( res );
 174                                         if( morethan1 ) ap_rputs(",", r); /* comma between JSON array items */
 175                                 }
 176                                 ap_rputs(output, r);
 177                                 free(output);
 178                                 morethan1 = 1;
 179
 180                         } else {
 181
 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 );
 186                                 }
 187                         }
 188
 189                         osrf_message_free(omsg);
 190                         if(statusname) break;
 191                 }
 192
 193                 if (isXML)
 194                         ap_rputs("</payload>", r);
 195                 else
 196                         ap_rputs("]",r); /* finish off the payload array */
 197
 198                 if(statusname) {
 199
 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;
 204                         char buf[l];
 205                         bzero(buf,l);
 206
 207                         if (isXML)
 208                                 snprintf( buf, l, "<debug>\"%s : %s\"</debug>", statusname, statustext );
 209
 210                         else {
 211                                 char bb[l];
 212                                 bzero(bb, l);
 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);
 217                                 free(j);
 218                                 jsonObjectFree(tmp);
 219                         }
 220
 221                         ap_rputs(buf, r);
 222
 223                         free(statusname);
 224                         free(statustext);
 225                 }
 226
 227                 /* insert the status code */
 228                 char buf[32];
 229                 bzero(buf,32);
 230
 231                 if (isXML)
 232                         snprintf(buf, 32, "<status>%d</status>", statuscode );
 233                 else
 234                         snprintf(buf, 32, ",\"status\":%d", statuscode );
 235
 236                 ap_rputs( buf, r );
 237
 238                 if (isXML)
 239                         ap_rputs("</response>", r);
 240                 else
 241                         ap_rputs( "}", r ); /* finish off the object */
 242
 243                 osrf_app_session_destroy(session);
 244         }
 245
 246         osrfLogInfo(OSRF_LOG_MARK, "Completed processing service=%s, method=%s", service, method);
 247         string_array_destroy(params);
 248         string_array_destroy(mparams);
 249
 250         osrfLogDebug(OSRF_LOG_MARK, "Gateway served %d requests", ++numserved);
 251
 252         return ret;
 253 }
 254
 255
 256 #ifdef OSRF_GATEWAY_NASTY_DEBUG
 257 /* --------------------------------------------------------------------- */
 258 /* DEBUG HOOKS */
 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");
 261         return OK;
 262 }
 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");
 265         return OK;
 266 }
 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");
 269         return OK;
 270 }
 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");
 273         return DECLINED;
 274 }
 275 static int osrf_dbg_pre_connection(conn_rec *c, void *csd) {
 276         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_pre_connection hook");
 277         return OK;
 278 }
 279 static int osrf_dbg_process_connection(conn_rec *c) {
 280         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_process_connection hook");
 281         return DECLINED;
 282 }
 283 static int osrf_dbg_post_read_request(request_rec *r) {
 284         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_read_request hook");
 285         return DECLINED;
 286 }
 287 static int osrf_dbg_logger(request_rec *r) {
 288         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_dbg_logger hook");
 289         return DECLINED;
 290 }
 291 static int osrf_dbg_translate_handler(request_rec *r) {
 292         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_translate_handler hook");
 293         return DECLINED;
 294 }
 295 static int osrf_dbg_header_parser_handler(request_rec *r) {
 296         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_header_parser_handler hook");
 297         return DECLINED;
 298 }
 299 static int osrf_dbg_check_user_id(request_rec *r) {
 300         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_check_user_id hook");
 301         return DECLINED;
 302 }
 303 static int osrf_dbg_fixer_upper(request_rec *r) {
 304         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_fixer_upper hook");
 305         return OK;
 306 }
 307 static int osrf_dbg_type_checker(request_rec *r) {
 308         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_type_checker hook");
 309         return DECLINED;
 310 }
 311 static int osrf_dbg_access_checker(request_rec *r) {
 312         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_access_checker hook");
 313         return DECLINED;
 314 }
 315 static int osrf_dbg_auth_checker(request_rec *r) {
 316         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_auth_checker hook");
 317         return DECLINED;
 318 }
 319 static void osrf_dbg_insert_filter(request_rec *r) {
 320         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: osrf_dbg_insert_filter hook");
 321 }
 322 /* --------------------------------------------------------------------- */
 323 #endif
 324
 325
 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);
 329
 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);
 347 #endif
 348 }
 349
 350
 351 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module = {
 352         STANDARD20_MODULE_STUFF,
 353         NULL,
 354         NULL,
 355         osrf_json_gateway_create_config,
 356         NULL,
 357         osrf_json_gateway_cmds,
 358         osrf_json_gateway_register_hooks,
 359 };
 360
 361
 362
 363