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 <opensrf/osrf_json.h>
   6 #include <opensrf/osrf_json_xml.h>
   7 #include <opensrf/osrf_legacy_json.h>
   8 #include <sys/time.h>
   9 #include <sys/resource.h>
  10 #include <unistd.h>
  11 #include <strings.h>
  12
  13
  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
  20
  21 #define GATEWAY_DEFAULT_CONFIG "/openils/conf/opensrf_core.xml"
  22
  23
  24 /* our config structure */
  25 typedef struct {
  26         char* configfile;  /* our bootstrap config file */
  27 } osrf_json_gateway_config;
  28
  29 typedef struct {
  30         int legacyJSON;
  31 } osrf_json_gateway_dir_config;
  32
  33
  34 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module;
  35
  36 char* osrf_json_default_locale = "en-US";
  37 char* osrf_json_gateway_config_file = NULL;
  38 int bootstrapped = 0;
  39 int numserved = 0;
  40 osrfStringArray* allowedServices = NULL;
  41
  42 static const char* osrf_json_gateway_set_default_locale(cmd_parms *parms, void *config, const char *arg) {
  43         osrf_json_default_locale = (char*) arg;
  44         return NULL;
  45 }
  46
  47 static const char* osrf_json_gateway_set_config(cmd_parms *parms, void *config, const char *arg) {
  48         osrf_json_gateway_config  *cfg;
  49         cfg = ap_get_module_config(parms->server->module_config, &osrf_json_gateway_module);
  50         cfg->configfile = (char*) arg;
  51         osrf_json_gateway_config_file = (char*) arg;
  52         return NULL;
  53 }
  54
  55 static const char* osrf_json_gateway_set_json_proto(cmd_parms *parms, void *config, const char *arg) {
  56         osrf_json_gateway_dir_config* cfg = (osrf_json_gateway_dir_config*) config;
  57         cfg->legacyJSON = (!strcasecmp((char*) arg, "false")) ? 0 : 1;
  58         return NULL;
  59 }
  60
  61 /* tell apache about our commands */
  62 static const command_rec osrf_json_gateway_cmds[] = {
  63         AP_INIT_TAKE1( GATEWAY_CONFIG, osrf_json_gateway_set_config,
  64                         NULL, RSRC_CONF, "osrf json gateway config file"),
  65         AP_INIT_TAKE1( DEFAULT_LOCALE, osrf_json_gateway_set_default_locale,
  66                         NULL, RSRC_CONF, "osrf json gateway default locale"),
  67         AP_INIT_TAKE1( JSON_PROTOCOL, osrf_json_gateway_set_json_proto,
  68                         NULL, ACCESS_CONF, "osrf json gateway config file"),
  69         {NULL}
  70 };
  71
  72 /* build the config object */
  73 static void* osrf_json_gateway_create_config( apr_pool_t* p, server_rec* s) {
  74         osrf_json_gateway_config* cfg = (osrf_json_gateway_config*)
  75                         apr_palloc(p, sizeof(osrf_json_gateway_config));
  76         cfg->configfile = GATEWAY_DEFAULT_CONFIG;
  77         return (void*) cfg;
  78 }
  79
  80 static void* osrf_json_gateway_create_dir_config( apr_pool_t* p, char* dir) {
  81         osrf_json_gateway_dir_config* cfg = (osrf_json_gateway_dir_config*)
  82                         apr_palloc(p, sizeof(osrf_json_gateway_dir_config));
  83         cfg->legacyJSON = GATEWAY_USE_LEGACY_JSON;
  84         return (void*) cfg;
  85 }
  86
  87
  88 static void osrf_json_gateway_child_init(apr_pool_t *p, server_rec *s) {
  89
  90         char* cfg = osrf_json_gateway_config_file;
  91         char buf[32];
  92         memset(buf, 0x0, 32);
  93         int t = time(NULL);
  94         snprintf(buf, 32, "%d", t);
  95
  96         if( ! osrfSystemBootstrapClientResc( cfg, CONFIG_CONTEXT, buf ) ) {
  97                 ap_log_error( APLOG_MARK, APLOG_ERR, 0, s,
  98                         "Unable to Bootstrap OpenSRF Client with config %s..", cfg);
  99                 return;
 100         }
 101
 102         bootstrapped = 1;
 103         allowedServices = osrfNewStringArray(8);
 104         osrfLogInfo(OSRF_LOG_MARK, "Bootstrapping gateway child for requests");
 105         osrfConfigGetValueList( NULL, allowedServices, "/services/service" );
 106
 107         int i;
 108         for( i = 0; i < allowedServices->size; i++ ) {
 109                 ap_log_error( APLOG_MARK, APLOG_DEBUG, 0, s,
 110                         "allowed service: %s\n", osrfStringArrayGetString(allowedServices, i));
 111         }
 112 }
 113
 114 static int osrf_json_gateway_method_handler (request_rec *r) {
 115
 116         /* make sure we're needed first thing*/
 117         if (strcmp(r->handler, MODULE_NAME )) return DECLINED;
 118
 119
 120         osrf_json_gateway_dir_config* dir_conf =
 121                 ap_get_module_config(r->per_dir_config, &osrf_json_gateway_module);
 122
 123
 124         /* provide 2 different JSON parsers and serializers to support legacy JSON */
 125         jsonObject* (*parseJSONFunc) (char*) = legacy_jsonParseString;
 126         char* (*jsonToStringFunc) (const jsonObject*) = legacy_jsonObjectToJSON;
 127
 128         if(dir_conf->legacyJSON) {
 129             ap_log_rerror( APLOG_MARK, APLOG_INFO, 0, r, "Using legacy JSON");
 130
 131     } else {
 132             ap_log_rerror( APLOG_MARK, APLOG_INFO, 0, r, "Not using legacy JSON");
 133                 parseJSONFunc = jsonParseString;
 134                 jsonToStringFunc = jsonObjectToJSON;
 135         }
 136
 137
 138         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: entered request handler");
 139
 140         /* verify we are connected */
 141         if( !bootstrapped || !osrf_system_get_transport_client()) {
 142                 ap_log_rerror( APLOG_MARK, APLOG_ERR, 0, r, "Cannot process request "
 143                                 "because the OpenSRF JSON gateway has not been bootstrapped...");
 144                 usleep( 100000 ); /* 100 milliseconds */
 145                 exit(1);
 146         }
 147
 148         osrfLogSetAppname("osrf_json_gw");
 149
 150         char* osrf_locale       = NULL;
 151         char* param_locale      = NULL; /* locale for this call */
 152         char* service           = NULL; /* service to connect to */
 153         char* method            = NULL; /* method to perform */
 154         char* format            = NULL; /* method to perform */
 155         char* a_l                       = NULL; /* request api level */
 156     char* input_format  = NULL; /* POST data format, defaults to 'format' */
 157         int   isXML                     = 0;
 158         int   api_level = 1;
 159
 160         r->allowed |= (AP_METHOD_BIT << M_GET);
 161         r->allowed |= (AP_METHOD_BIT << M_POST);
 162
 163         osrfLogDebug(OSRF_LOG_MARK, "osrf gateway: parsing URL params");
 164         string_array* mparams   = NULL;
 165         string_array* params            = apacheParseParms(r); /* free me */
 166         param_locale            = apacheGetFirstParamValue( params, "locale" );
 167         service         = apacheGetFirstParamValue( params, "service" );
 168         method          = apacheGetFirstParamValue( params, "method" );
 169         format          = apacheGetFirstParamValue( params, "format" );
 170         input_format = apacheGetFirstParamValue( params, "input_format" );
 171         a_l                     = apacheGetFirstParamValue( params, "api_level" );
 172         mparams         = apacheGetParamValues( params, "param" ); /* free me */
 173
 174     if(format == NULL)
 175         format = "json";
 176     if(input_format == NULL)
 177         input_format = format;
 178
 179    /* set the user defined timeout value */
 180    int timeout = 60;
 181    char* tout = apacheGetFirstParamValue( params, "timeout" ); /* request timeout in seconds */
 182    if( tout ) {
 183       timeout = atoi(tout);
 184       osrfLogDebug(OSRF_LOG_MARK, "Client supplied timeout of %d", timeout);
 185    }
 186
 187
 188         if (a_l)
 189                 api_level = atoi(a_l);
 190
 191         if (!strcasecmp(format, "xml")) {
 192                 isXML = 1;
 193                 ap_set_content_type(r, "application/xml");
 194         } else {
 195                 ap_set_content_type(r, "text/plain");
 196         }
 197
 198         int ret = OK;
 199
 200         /* ----------------------------------------------------------------- */
 201         /* Grab the requested locale using the Accept-Language header*/
 202
 203
 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") );
 209                 }
 210         }
 211
 212
 213         if (param_locale) {
 214                 growing_buffer* osrf_locale_buf = buffer_init(16);
 215                 if (index(param_locale, ',')) {
 216                         int ind = index(param_locale, ',') - param_locale;
 217                         int i;
 218                         for ( i = 0; i < ind - 1 && i < 128; i++ )
 219                                 buffer_add_char( osrf_locale_buf, param_locale[i] );
 220                 } else {
 221                         buffer_add( osrf_locale_buf, param_locale );
 222                 }
 223
 224                 free(param_locale);
 225                 osrf_locale = buffer_release( osrf_locale_buf );
 226         } else {
 227                 osrf_locale = strdup( osrf_json_default_locale );
 228         }
 229         /* ----------------------------------------------------------------- */
 230
 231
 232         if(!(service && method) ||
 233                 !osrfStringArrayContains(allowedServices, service)) {
 234
 235                 osrfLogError(OSRF_LOG_MARK,
 236                         "Service [%s] not found or not allowed", service);
 237                 ret = HTTP_NOT_FOUND;
 238
 239         } else {
 240
 241                 /* This will log all heaers to the apache error log
 242                 const apr_array_header_t* arr = apr_table_elts(r->headers_in);
 243                 const void* ptr;
 244
 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 );
 248                 }
 249                 fflush(stderr);
 250                 */
 251
 252                 osrfAppSession* session = osrf_app_client_session_init(service);
 253                 osrf_app_session_set_locale(session, osrf_locale);
 254
 255                 double starttime = get_timestamp_millis();
 256                 int req_id = -1;
 257
 258         if(!strcasecmp(input_format, "json")) {
 259             jsonObject * arr = jsonNewObject(NULL);
 260             char* str;
 261             int i = 0;
 262             while( (str = osrfStringArrayGetString(mparams, i++)) )
 263                 jsonObjectPush(arr, parseJSONFunc(str));
 264
 265                     req_id = osrf_app_session_make_req( session, arr, method, api_level, NULL );
 266
 267         } else {
 268
 269             /**
 270              * If we receive XML method params, convert each param to a JSON object
 271              * and pass the array of JSON object params to the method */
 272             if(!strcasecmp(input_format, "xml")) {
 273                 jsonObject* jsonParams = jsonNewObject(NULL);
 274
 275                 char* str;
 276                 int i = 0;
 277                 while( (str = osrfStringArrayGetString(mparams, i++)) ) {
 278                     jsonObjectPush(jsonParams, jsonXMLToJSONObject(str));
 279                 }
 280
 281                         req_id = osrf_app_session_make_req( session, jsonParams, method, api_level, NULL );
 282                 jsonObjectFree(jsonParams);
 283             }
 284         }
 285
 286
 287                 if( req_id == -1 ) {
 288                         osrfLogError(OSRF_LOG_MARK, "I am unable to communcate with opensrf..going away...");
 289                         /* we don't want to spawn an intense re-forking storm
 290                          * if there is no jabber server.. so give it some time before we die */
 291                         usleep( 100000 ); /* 100 milliseconds */
 292                         exit(1);
 293                 }
 294
 295
 296                 /* ----------------------------------------------------------------- */
 297                 /* log all requests to the activity log */
 298                 const char* authtoken = apr_table_get(r->headers_in, "X-OILS-Authtoken");
 299                 if(!authtoken) authtoken = "";
 300                 growing_buffer* act = buffer_init(128);
 301                 buffer_fadd(act, "[%s] [%s] %s %s", r->connection->remote_ip, authtoken, service, method );
 302                 char* str; int i = 0;
 303                 while( (str = osrfStringArrayGetString(mparams, i++)) ) {
 304                         if( i == 1 ) {
 305             OSRF_BUFFER_ADD(act, " ");
 306                                 OSRF_BUFFER_ADD(act, str);
 307                         } else {
 308                                 OSRF_BUFFER_ADD(act, ", ");
 309                                 OSRF_BUFFER_ADD(act, str);
 310                         }
 311                 }
 312
 313                 osrfLogActivity( OSRF_LOG_MARK, act->buf );
 314                 buffer_free(act);
 315                 /* ----------------------------------------------------------------- */
 316
 317
 318                 osrf_message* omsg = NULL;
 319
 320                 int statuscode = 200;
 321
 322                 /* kick off the object */
 323                 if (isXML)
 324                         ap_rputs("<response xmlns=\"http://opensrf.org/-/namespaces/gateway/v1\"><payload>", r);
 325                 else
 326                         ap_rputs("{\"payload\":[", r);
 327
 328                 int morethan1           = 0;
 329                 char* statusname        = NULL;
 330                 char* statustext        = NULL;
 331                 char* output            = NULL;
 332
 333                 while((omsg = osrfAppSessionRequestRecv( session, req_id, timeout ))) {
 334
 335                         statuscode = omsg->status_code;
 336                         jsonObject* res;
 337
 338                         if( ( res = osrfMessageGetResult(omsg)) ) {
 339
 340                                 if (isXML) {
 341                                         output = jsonObjectToXML( res );
 342                                 } else {
 343                     output = jsonToStringFunc( res );
 344                                         if( morethan1 ) ap_rputs(",", r); /* comma between JSON array items */
 345                                 }
 346                                 ap_rputs(output, r);
 347                                 free(output);
 348                                 morethan1 = 1;
 349
 350                         } else {
 351
 352                                 if( statuscode > 299 ) { /* the request returned a low level error */
 353                                         statusname = omsg->status_name ? strdup(omsg->status_name) : strdup("Unknown Error");
 354                                         statustext = omsg->status_text ? strdup(omsg->status_text) : strdup("No Error Message");
 355                                         osrfLogError( OSRF_LOG_MARK,  "Gateway received error: %s", statustext );
 356                                 }
 357                         }
 358
 359                         osrf_message_free(omsg);
 360                         if(statusname) break;
 361                 }
 362
 363                 double duration = get_timestamp_millis() - starttime;
 364                 osrfLogDebug(OSRF_LOG_MARK, "gateway request took %f seconds", duration);
 365
 366
 367                 if (isXML)
 368                         ap_rputs("</payload>", r);
 369                 else
 370                         ap_rputs("]",r); /* finish off the payload array */
 371
 372                 if(statusname) {
 373
 374                         /* add a debug field if the request died */
 375                         ap_log_rerror( APLOG_MARK, APLOG_INFO, 0, r,
 376                                         "OpenSRF JSON Request returned error: %s -> %s", statusname, statustext );
 377                         int l = strlen(statusname) + strlen(statustext) + 32;
 378                         char buf[l];
 379                         bzero(buf,l);
 380
 381                         if (isXML)
 382                                 snprintf( buf, l, "<debug>\"%s : %s\"</debug>", statusname, statustext );
 383
 384                         else {
 385                                 char bb[l];
 386                                 bzero(bb, l);
 387                                 snprintf(bb, l,  "%s : %s", statusname, statustext);
 388                                 jsonObject* tmp = jsonNewObject(bb);
 389                 char* j = jsonToStringFunc(tmp);
 390                                 snprintf( buf, l, ",\"debug\": %s", j);
 391                                 free(j);
 392                                 jsonObjectFree(tmp);
 393                         }
 394
 395                         ap_rputs(buf, r);
 396
 397                         free(statusname);
 398                         free(statustext);
 399                 }
 400
 401                 /* insert the status code */
 402                 char buf[32];
 403                 bzero(buf,32);
 404
 405                 if (isXML)
 406                         snprintf(buf, 32, "<status>%d</status>", statuscode );
 407                 else
 408                         snprintf(buf, 32, ",\"status\":%d", statuscode );
 409
 410                 ap_rputs( buf, r );
 411
 412                 if (isXML)
 413                         ap_rputs("</response>", r);
 414                 else
 415                         ap_rputs( "}", r ); /* finish off the object */
 416
 417                 osrf_app_session_destroy(session);
 418         }
 419
 420         osrfLogInfo(OSRF_LOG_MARK, "Completed processing service=%s, method=%s", service, method);
 421         free(osrf_locale);
 422         string_array_destroy(params);
 423         string_array_destroy(mparams);
 424
 425         osrfLogDebug(OSRF_LOG_MARK, "Gateway served %d requests", ++numserved);
 426    osrfLogClearXid();
 427
 428         return ret;
 429 }
 430
 431
 432
 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);
 436 }
 437
 438
 439 module AP_MODULE_DECLARE_DATA osrf_json_gateway_module = {
 440         STANDARD20_MODULE_STUFF,
 441         osrf_json_gateway_create_dir_config,
 442         NULL,
 443         osrf_json_gateway_create_config,
 444         NULL,
 445         osrf_json_gateway_cmds,
 446         osrf_json_gateway_register_hooks,
 447 };
 448
 449
 450
 451