src/gateway/osrf_http_translator.c

   1 #include <sys/time.h>
   2 #include <sys/resource.h>
   3 #include <unistd.h>
   4 #include <strings.h>
   5 #include "apachetools.h"
   6 #include <opensrf/osrf_app_session.h>
   7 #include <opensrf/osrf_system.h>
   8 #include <opensrf/osrfConfig.h>
   9 #include <opensrf/osrf_json.h>
  10 #include <opensrf/osrf_cache.h>
  11
  12 #define MODULE_NAME "osrf_http_translator_module"
  13 #define OSRF_TRANSLATOR_CONFIG_FILE "OSRFTranslatorConfig"
  14 #define OSRF_TRANSLATOR_CONFIG_CTX "OSRFTranslatorConfigContext"
  15 #define OSRF_TRANSLATOR_CACHE_SERVER "OSRFTranslatorCacheServer"
  16
  17 #define DEFAULT_TRANSLATOR_CONFIG_CTX "gateway"
  18 #define DEFAULT_TRANSLATOR_CONFIG_FILE "/openils/conf/opensrf_core.xml"
  19 #define DEFAULT_TRANSLATOR_TIMEOUT 1200
  20 #define DEFAULT_TRANSLATOR_CACHE_SERVERS "127.0.0.1:11211"
  21
  22 #define MULTIPART_CONTENT_TYPE "multipart/x-mixed-replace;boundary=\"%s\""
  23 #define JSON_CONTENT_TYPE "text/plain"
  24 #define MAX_MSGS_PER_PACKET 256
  25 #define CACHE_TIME 300
  26
  27 #define OSRF_HTTP_HEADER_TO "X-OpenSRF-to"
  28 #define OSRF_HTTP_HEADER_XID "X-OpenSRF-xid"
  29 #define OSRF_HTTP_HEADER_FROM "X-OpenSRF-from"
  30 #define OSRF_HTTP_HEADER_THREAD "X-OpenSRF-thread"
  31 #define OSRF_HTTP_HEADER_TIMEOUT "X-OpenSRF-timeout"
  32 #define OSRF_HTTP_HEADER_SERVICE "X-OpenSRF-service"
  33 #define OSRF_HTTP_HEADER_MULTIPART "X-OpenSRF-multipart"
  34
  35 char* configFile = DEFAULT_TRANSLATOR_CONFIG_FILE;
  36 char* configCtx = DEFAULT_TRANSLATOR_CONFIG_CTX;
  37 char* cacheServers = DEFAULT_TRANSLATOR_CACHE_SERVERS;
  38
  39 char* routerName = NULL;
  40 char* domainName = NULL;
  41 int osrfConnected = 0;
  42 char recipientBuf[128];
  43 char contentTypeBuf[80];
  44
  45 // for development only, writes to apache error log
  46 static void _dbg(char* s, ...) {
  47     VA_LIST_TO_STRING(s);
  48     fprintf(stderr, "%s\n", VA_BUF);
  49     fflush(stderr);
  50 }
  51
  52 // Translator struct
  53 typedef struct {
  54     request_rec* apreq;
  55     transport_client* handle;
  56     osrfList* messages;
  57     char* body;
  58     char* delim;
  59     const char* recipient;
  60     const char* service;
  61     const char* thread;
  62     const char* remoteHost;
  63     int complete;
  64     int timeout;
  65     int multipart;
  66     int connectOnly; // there is only 1 message, a CONNECT
  67     int disconnectOnly; // there is only 1 message, a DISCONNECT
  68     int connecting; // there is a connect message in this batch
  69     int disconnecting; // there is a connect message in this batch
  70     int localXid;
  71 } osrfHttpTranslator;
  72
  73
  74 static const char* osrfHttpTranslatorGetConfigFile(cmd_parms *parms, void *config, const char *arg) {
  75     configFile = (char*) arg;
  76         return NULL;
  77 }
  78 static const char* osrfHttpTranslatorGetConfigFileCtx(cmd_parms *parms, void *config, const char *arg) {
  79     configCtx = (char*) arg;
  80         return NULL;
  81 }
  82 static const char* osrfHttpTranslatorGetCacheServer(cmd_parms *parms, void *config, const char *arg) {
  83     cacheServers = (char*) arg;
  84         return NULL;
  85 }
  86
  87 /** set up the configuratoin handlers */
  88 static const command_rec osrf_json_gateway_cmds[] = {
  89         AP_INIT_TAKE1( OSRF_TRANSLATOR_CONFIG_FILE, osrfHttpTranslatorGetConfigFile,
  90                         NULL, RSRC_CONF, "osrf translator config file"),
  91         AP_INIT_TAKE1( OSRF_TRANSLATOR_CONFIG_CTX, osrfHttpTranslatorGetConfigFileCtx,
  92                         NULL, RSRC_CONF, "osrf translator config file context"),
  93         AP_INIT_TAKE1( OSRF_TRANSLATOR_CACHE_SERVER, osrfHttpTranslatorGetCacheServer,
  94                         NULL, RSRC_CONF, "osrf translator cache server"),
  95     {NULL}
  96 };
  97
  98
  99 // there can only be one, so use a global static one
 100 static osrfHttpTranslator globalTranslator;
 101
 102 /*
 103  * Constructs a new translator object based on the current apache
 104  * request_rec.  Reads the request body and headers.
 105  */
 106 static osrfHttpTranslator* osrfNewHttpTranslator(request_rec* apreq) {
 107     osrfHttpTranslator* trans = &globalTranslator;
 108     trans->apreq = apreq;
 109     trans->complete = 0;
 110     trans->connectOnly = 0;
 111     trans->disconnectOnly = 0;
 112     trans->connecting = 0;
 113     trans->disconnecting = 0;
 114     trans->remoteHost = apreq->connection->remote_ip;
 115     trans->messages = NULL;
 116
 117     /* load the message body */
 118         osrfStringArray* params = apacheParseParms(apreq);
 119     trans->body = apacheGetFirstParamValue(params, "osrf-msg");
 120     osrfStringArrayFree(params);
 121
 122     /* load the request headers */
 123     if (apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_XID)) // force our log xid to match the caller
 124             osrfLogForceXid(strdup(apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_XID)));
 125
 126     trans->handle = osrfSystemGetTransportClient();
 127     trans->recipient = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_TO);
 128     trans->service = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_SERVICE);
 129     trans->thread = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_THREAD); /* XXX create thread if necessary */
 130
 131     const char* timeout = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_TIMEOUT);
 132     if(timeout)
 133         trans->timeout = atoi(timeout);
 134     else
 135         trans->timeout = DEFAULT_TRANSLATOR_TIMEOUT;
 136
 137     const char* multipart = apr_table_get(apreq->headers_in, OSRF_HTTP_HEADER_MULTIPART);
 138     if(multipart && !strcasecmp(multipart, "true"))
 139         trans->multipart = 1;
 140     else
 141         trans->multipart = 0;
 142
 143     char buf[32];
 144     snprintf(buf, sizeof(buf), "%d%ld", getpid(), time(NULL));
 145     trans->delim = md5sum(buf);
 146
 147     return trans;
 148 }
 149
 150 static void osrfHttpTranslatorFree(osrfHttpTranslator* trans) {
 151     if(!trans) return;
 152     if(trans->body)
 153         free(trans->body);
 154     if(trans->delim)
 155         free(trans->delim);
 156     osrfListFree(trans->messages);
 157 }
 158
 159 static void osrfHttpTranslatorDebug(osrfHttpTranslator* trans) {
 160     _dbg("-----------------------------------");
 161     _dbg("body = %s", trans->body);
 162     _dbg("service = %s", trans->service);
 163     _dbg("thread = %s", trans->thread);
 164     _dbg("multipart = %d", trans->multipart);
 165     _dbg("recipient = %s", trans->recipient);
 166 }
 167
 168 /**
 169  * Determines the correct recipient address based on the requested
 170  * service or recipient address.
 171  */
 172 static int osrfHttpTranslatorSetTo(osrfHttpTranslator* trans) {
 173     int stat = 0;
 174     jsonObject* sessionCache = NULL;
 175
 176     if(trans->service) {
 177         if(trans->recipient) {
 178             osrfLogError(OSRF_LOG_MARK, "Specifying both SERVICE and TO are not allowed");
 179
 180         } else {
 181             // service is specified, build a recipient address
 182             // from the router, domain, and service
 183             int size = snprintf(recipientBuf, 128, "%s@%s/%s", routerName, domainName, trans->service);
 184             recipientBuf[size] = '\0';
 185             osrfLogDebug(OSRF_LOG_MARK, "Set recipient to %s", recipientBuf);
 186             trans->recipient = recipientBuf;
 187             stat = 1;
 188         }
 189
 190     } else {
 191
 192         if(trans->recipient) {
 193             sessionCache = osrfCacheGetObject(trans->thread);
 194
 195             if(sessionCache) {
 196                 char* ipAddr = jsonObjectGetString(jsonObjectGetKey(sessionCache, "ip"));
 197                 char* recipient = jsonObjectGetString(jsonObjectGetKey(sessionCache, "jid"));
 198
 199                 // choosing a specific recipient address requires that the recipient and
 200                 // thread be cached on the server (so drone processes cannot be hijacked)
 201                 if(!strcmp(ipAddr, trans->remoteHost) && !strcmp(recipient, trans->recipient)) {
 202                     osrfLogDebug(OSRF_LOG_MARK, "Found cached session from host %s and recipient %s",
 203                         trans->remoteHost, trans->recipient);
 204                     stat = 1;
 205                     trans->service = jsonObjectGetString(jsonObjectGetKey(sessionCache, "service"));
 206
 207                 } else {
 208                     osrfLogError(OSRF_LOG_MARK,
 209                         "Session cache for thread %s does not match request", trans->thread);
 210                 }
 211             }  else {
 212                 osrfLogError(OSRF_LOG_MARK,
 213                     "attempt to send directly to %s without a session", trans->recipient);
 214             }
 215         } else {
 216             osrfLogError(OSRF_LOG_MARK, "No SERVICE or RECIPIENT defined");
 217         }
 218     }
 219
 220     jsonObjectFree(sessionCache);
 221     return stat;
 222 }
 223
 224 /**
 225  * Parses the request body and logs any REQUEST messages to the activity log
 226  */
 227 static int osrfHttpTranslatorParseRequest(osrfHttpTranslator* trans) {
 228     osrfMessage* msg;
 229     osrfMessage* msgList[MAX_MSGS_PER_PACKET];
 230     int numMsgs = osrf_message_deserialize(trans->body, msgList, MAX_MSGS_PER_PACKET);
 231     osrfLogDebug(OSRF_LOG_MARK, "parsed %d opensrf messages in this packet", numMsgs);
 232
 233     if(numMsgs == 0)
 234         return 0;
 235
 236     if(numMsgs == 1) {
 237         msg = msgList[0];
 238         if(msg->m_type == CONNECT) {
 239             trans->connectOnly = 1;
 240             return 1;
 241         }
 242         if(msg->m_type == DISCONNECT) {
 243             trans->disconnectOnly = 1;
 244             return 1;
 245         }
 246     }
 247
 248     // log request messages to the activity log
 249     int i;
 250     for(i = 0; i < numMsgs; i++) {
 251         msg = msgList[i];
 252
 253         switch(msg->m_type) {
 254
 255             case REQUEST:
 256                 jsonObject* params = msg->_params;
 257                 growing_buffer* act = buffer_init(128);
 258                 buffer_fadd(act, "[%s] [%s] %s %s", trans->remoteHost, "", trans->service, msg->method_name);
 259
 260                 char* str;
 261                 int i = 0;
 262                 while((str = jsonObjectGetString(jsonObjectGetIndex(params, i++)))) {
 263                     if( i == 1 )
 264                         OSRF_BUFFER_ADD(act, " ");
 265                     else
 266                         OSRF_BUFFER_ADD(act, ", ");
 267                     OSRF_BUFFER_ADD(act, str);
 268                 }
 269                 osrfLogActivity(OSRF_LOG_MARK, act->buf);
 270                 buffer_free(act);
 271                 break;
 272
 273             case CONNECT:
 274                 trans->connecting = 1;
 275                 break;
 276
 277             case DISCONNECT:
 278                 trans->disconnecting = 1;
 279                 break;
 280         }
 281     }
 282
 283     return 1;
 284 }
 285
 286 static int osrfHttpTranslatorCheckStatus(osrfHttpTranslator* trans, transport_message* msg) {
 287     osrfMessage* omsgList[MAX_MSGS_PER_PACKET];
 288     int numMsgs = osrf_message_deserialize(msg->body, omsgList, MAX_MSGS_PER_PACKET);
 289     osrfLogDebug(OSRF_LOG_MARK, "parsed %d response messages", numMsgs);
 290     if(numMsgs == 0) return 0;
 291
 292     osrfMessage* last = omsgList[numMsgs-1];
 293     if(last->m_type == STATUS) {
 294         if(last->status_code == OSRF_STATUS_TIMEOUT) {
 295             osrfLogDebug(OSRF_LOG_MARK, "removing cached session on request timeout");
 296             osrfCacheRemove(trans->thread);
 297             return 0;
 298         }
 299         // XXX hm, check for explicit status=COMPLETE message instead??
 300         if(last->status_code != OSRF_STATUS_CONTINUE)
 301             trans->complete = 1;
 302     }
 303
 304     return 1;
 305 }
 306
 307 static void osrfHttpTranslatorInitHeaders(osrfHttpTranslator* trans, transport_message* msg) {
 308     apr_table_set(trans->apreq->headers_out, OSRF_HTTP_HEADER_FROM, msg->sender);
 309     apr_table_set(trans->apreq->headers_out, OSRF_HTTP_HEADER_THREAD, trans->thread);
 310     if(trans->multipart) {
 311         sprintf(contentTypeBuf, MULTIPART_CONTENT_TYPE, trans->delim);
 312         contentTypeBuf[79] = '\0';
 313         osrfLogDebug(OSRF_LOG_MARK, "content type %s : %s : %s", MULTIPART_CONTENT_TYPE, trans->delim, contentTypeBuf);
 314             ap_set_content_type(trans->apreq, contentTypeBuf);
 315         ap_rprintf(trans->apreq, "--%s\n", trans->delim);
 316     } else {
 317             ap_set_content_type(trans->apreq, JSON_CONTENT_TYPE);
 318     }
 319 }
 320
 321 /**
 322  * Cache the transaction with the JID of the backend process we are talking to
 323  */
 324 static void osrfHttpTranslatorCacheSession(osrfHttpTranslator* trans, const char* jid) {
 325     jsonObject* cacheObj = jsonNewObject(NULL);
 326     jsonObjectSetKey(cacheObj, "ip", jsonNewObject(trans->remoteHost));
 327     jsonObjectSetKey(cacheObj, "jid", jsonNewObject(jid));
 328     jsonObjectSetKey(cacheObj, "service", jsonNewObject(trans->service));
 329     osrfCachePutObject((char*) trans->thread, cacheObj, CACHE_TIME);
 330 }
 331
 332
 333 /**
 334  * Writes a single chunk of multipart/x-mixed-replace content
 335  */
 336 static void osrfHttpTranslatorWriteChunk(osrfHttpTranslator* trans, transport_message* msg) {
 337     osrfLogInternal(OSRF_LOG_MARK, "sending multipart chunk %s", msg->body);
 338     ap_rprintf(trans->apreq,
 339         "Content-type: %s\n\n%s\n\n", JSON_CONTENT_TYPE, msg->body);
 340     //osrfLogInternal(OSRF_LOG_MARK, "Apache sending data: Content-type: %s\n\n%s\n\n", JSON_CONTENT_TYPE, msg->body);
 341     if(trans->complete) {
 342         ap_rprintf(trans->apreq, "--%s--\n", trans->delim);
 343         //osrfLogInternal(OSRF_LOG_MARK, "Apache sending data: --%s--\n", trans->delim);
 344     } else {
 345         ap_rprintf(trans->apreq, "--%s\n", trans->delim);
 346         //osrfLogInternal(OSRF_LOG_MARK, "Apache sending data: --%s\n", trans->delim);
 347     }
 348     ap_rflush(trans->apreq);
 349 }
 350
 351 static int osrfHttpTranslatorProcess(osrfHttpTranslator* trans) {
 352     if(trans->body == NULL)
 353         return HTTP_BAD_REQUEST;
 354
 355     if(!osrfHttpTranslatorSetTo(trans))
 356         return HTTP_BAD_REQUEST;
 357
 358     if(!osrfHttpTranslatorParseRequest(trans))
 359         return HTTP_BAD_REQUEST;
 360
 361     while(client_recv(trans->handle, 0))
 362         continue; // discard any old status messages in the recv queue
 363
 364     // send the message to the recipient
 365     transport_message* tmsg = message_init(
 366         trans->body, NULL, trans->thread, trans->recipient, NULL);
 367     message_set_osrf_xid(tmsg, osrfLogGetXid());
 368     client_send_message(trans->handle, tmsg);
 369     message_free(tmsg);
 370
 371     if(trans->disconnectOnly) {
 372         osrfLogDebug(OSRF_LOG_MARK, "exiting early on disconnect");
 373         osrfCacheRemove(trans->thread);
 374         return OK;
 375     }
 376
 377     // process the response from the opensrf service
 378     int firstWrite = 1;
 379     while(!trans->complete) {
 380         transport_message* msg = client_recv(trans->handle, trans->timeout);
 381
 382         if(trans->handle->error) {
 383             osrfLogError(OSRF_LOG_MARK, "Transport error");
 384             osrfCacheRemove(trans->thread);
 385             return HTTP_INTERNAL_SERVER_ERROR;
 386         }
 387
 388         if(msg == NULL)
 389             return HTTP_GATEWAY_TIME_OUT;
 390
 391         if(msg->is_error) {
 392             osrfLogError(OSRF_LOG_MARK, "XMPP message resulted in error code %d", msg->error_code);
 393             osrfCacheRemove(trans->thread);
 394             return HTTP_NOT_FOUND;
 395         }
 396
 397         if(!osrfHttpTranslatorCheckStatus(trans, msg))
 398             continue;
 399
 400         if(firstWrite) {
 401             osrfHttpTranslatorInitHeaders(trans, msg);
 402             if(trans->connecting)
 403                 osrfHttpTranslatorCacheSession(trans, msg->sender);
 404             firstWrite = 0;
 405         }
 406
 407         if(trans->multipart) {
 408             osrfHttpTranslatorWriteChunk(trans, msg);
 409             if(trans->connectOnly)
 410                 break;
 411         } else {
 412             if(!trans->messages)
 413                 trans->messages = osrfNewList();
 414             osrfListPush(trans->messages, msg->body);
 415
 416             if(trans->complete || trans->connectOnly) {
 417                 growing_buffer* buf = buffer_init(128);
 418                 int i;
 419                 OSRF_BUFFER_ADD(buf, osrfListGetIndex(trans->messages, 0));
 420                 for(i = 1; i < trans->messages->size; i++) {
 421                     buffer_chomp(buf); // chomp off the closing array bracket
 422                     char* body = osrfListGetIndex(trans->messages, i);
 423                     char newbuf[strlen(body)];
 424                     sprintf(newbuf, body+1); // chomp off the opening array bracket
 425                     OSRF_BUFFER_ADD_CHAR(buf, ',');
 426                     OSRF_BUFFER_ADD(buf, newbuf);
 427                 }
 428
 429                 ap_rputs(buf->buf, trans->apreq);
 430                 buffer_free(buf);
 431             }
 432         }
 433     }
 434
 435     if(trans->disconnecting) // DISCONNECT within a multi-message batch
 436         osrfCacheRemove(trans->thread);
 437
 438     return OK;
 439 }
 440
 441 static void testConnection(request_rec* r) {
 442         if(!osrfConnected || !osrfSystemGetTransportClient()) {
 443         osrfLogError(OSRF_LOG_MARK, "We're not connected to OpenSRF");
 444                 ap_log_rerror(APLOG_MARK, APLOG_ERR, 0, r, "We're not connected to OpenSRF");
 445                 usleep(100000); // .1 second to prevent process die/start overload
 446                 exit(1);
 447         }
 448 }
 449
 450 // it's dead, Jim
 451 static apr_status_t childExit(void* data) {
 452     osrf_system_shutdown();
 453     return OK;
 454 }
 455
 456 static void childInit(apr_pool_t *p, server_rec *s) {
 457         if(!osrfSystemBootstrapClientResc(configFile, configCtx, "translator")) {
 458                 ap_log_error( APLOG_MARK, APLOG_ERR, 0, s,
 459                         "Unable to Bootstrap OpenSRF Client with config %s..", configFile);
 460                 return;
 461         }
 462
 463     routerName = osrfConfigGetValue(NULL, "/router_name");
 464     domainName = osrfConfigGetValue(NULL, "/domain");
 465     const char* servers[] = {cacheServers};
 466     osrfCacheInit(servers, 1, 86400);
 467         osrfConnected = 1;
 468
 469     // at pool destroy time (= child exit time), cleanup
 470     // XXX causes us to disconnect even for clone()'d process cleanup (as in mod_cgi)
 471     //apr_pool_cleanup_register(p, NULL, childExit, apr_pool_cleanup_null);
 472 }
 473
 474 static int handler(request_rec *r) {
 475     int stat = OK;
 476         if(strcmp(r->handler, MODULE_NAME)) return DECLINED;
 477     if(r->header_only) return stat;
 478
 479         r->allowed |= (AP_METHOD_BIT << M_GET);
 480         r->allowed |= (AP_METHOD_BIT << M_POST);
 481
 482         osrfLogSetAppname("osrf_http_translator");
 483     testConnection(r);
 484
 485     osrfHttpTranslator* trans = osrfNewHttpTranslator(r);
 486         osrfLogMkXid();
 487     if(trans->body) {
 488         stat = osrfHttpTranslatorProcess(trans);
 489         //osrfHttpTranslatorDebug(trans);
 490         osrfLogInfo(OSRF_LOG_MARK, "translator resulted in status %d", stat);
 491     } else {
 492         osrfLogWarning(OSRF_LOG_MARK, "no message body to process");
 493     }
 494     osrfHttpTranslatorFree(trans);
 495         return stat;
 496 }
 497
 498
 499 static void registerHooks (apr_pool_t *p) {
 500         ap_hook_handler(handler, NULL, NULL, APR_HOOK_MIDDLE);
 501         ap_hook_child_init(childInit, NULL, NULL, APR_HOOK_MIDDLE);
 502 }
 503
 504
 505 module AP_MODULE_DECLARE_DATA osrf_http_translator_module = {
 506         STANDARD20_MODULE_STUFF,
 507     NULL,
 508         NULL,
 509     NULL,
 510         NULL,
 511     NULL,
 512         registerHooks,
 513 };
 514
 515
 516
 517